From 4e0898e244e162ed18db86cae3ab14e8995c33d3 Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Wed, 28 Mar 2018 10:16:39 -0700 Subject: [PATCH 01/55] Update docfx.json --- SP-Framework/docfx.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index d74575f9..2f155e0a 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -14,6 +14,7 @@ "LICENSE-CODE", "ThirdPartyNotices" ], + "src": ".", "dest": "api" } ], @@ -40,4 +41,4 @@ "template": [], "dest": "SP-Framework" } -} \ No newline at end of file +} From bc8d3df21c2113759ee93962975b9508a88a5537 Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Thu, 29 Mar 2018 14:23:31 -0700 Subject: [PATCH 02/55] Update docfx.json --- SP-Framework/docfx.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 2f155e0a..1c3545cb 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -14,6 +14,7 @@ "LICENSE-CODE", "ThirdPartyNotices" ], + "version": "sp-typescript-latest", "src": ".", "dest": "api" } @@ -28,6 +29,7 @@ "**/obj/**", "**/includes/**" ], + "version": "sp-typescript-latest", "dest": "api" } ], From bb529784be76ed48fe580004739494fa2b880a79 Mon Sep 17 00:00:00 2001 From: David Chesnut Date: Thu, 10 May 2018 09:44:47 -0700 Subject: [PATCH 03/55] added reporting metadata --- SP-Framework/docfx.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 1c3545cb..3d5d3df3 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -37,7 +37,13 @@ "externalReference": [], "globalMetadata": { "extendBreadcrumb": "true", - "breadcrumb_path":"/javascript/api/breadcrumb/toc.json" + "breadcrumb_path":"/javascript/api/breadcrumb/toc.json", + "ms.suite": "office365", + "ms.author": "spdevdocs", + "author": "spdevdocs", + "ms.topic": "reference", + "ms.prod": "sharepoint", + "ms.technology": "sharepoint-framework" }, "fileMetadata": {}, "template": [], From f66ebbb26b748f85e0aa5ee2f66cd5e2afb47a09 Mon Sep 17 00:00:00 2001 From: olprod Date: Wed, 16 May 2018 22:56:08 +0000 Subject: [PATCH 04/55] init commit From c5c2d7629bf6b0348e8a2ad6b07edddf4842f2ee Mon Sep 17 00:00:00 2001 From: olprod Date: Tue, 22 May 2018 10:31:05 +0000 Subject: [PATCH 05/55] init commit From e725fb319f2e88c444d2400c12d6a434f27f4f68 Mon Sep 17 00:00:00 2001 From: olprod Date: Tue, 22 May 2018 14:37:27 +0000 Subject: [PATCH 06/55] init commit From bf5e89fc6b9f6054f1657fb088ae5cfa8bfcf73b Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Fri, 25 May 2018 09:40:50 -0700 Subject: [PATCH 07/55] Update docfx.json --- SP-Framework/docfx.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 3d5d3df3..61037279 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -36,6 +36,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "apiPlatform": "javascript", "extendBreadcrumb": "true", "breadcrumb_path":"/javascript/api/breadcrumb/toc.json", "ms.suite": "office365", @@ -45,7 +46,12 @@ "ms.prod": "sharepoint", "ms.technology": "sharepoint-framework" }, - "fileMetadata": {}, + "fileMetadata": { + "monikers": + { + "/": [ "sp-typescript-latest" ] + }, + }, "template": [], "dest": "SP-Framework" } From 172a83a74035941e6d61ab6cf1b318d85ecba0d8 Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Fri, 25 May 2018 09:46:55 -0700 Subject: [PATCH 08/55] Update docfx.json --- SP-Framework/docfx.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 61037279..d490cbfb 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -50,7 +50,7 @@ "monikers": { "/": [ "sp-typescript-latest" ] - }, + } }, "template": [], "dest": "SP-Framework" From 50dea5dde0cc49813f44ffac95e40b18d532e262 Mon Sep 17 00:00:00 2001 From: olprod Date: Sun, 27 May 2018 18:13:35 +0000 Subject: [PATCH 09/55] init commit From 323d058b9dbbf9e91a4b1e05e43d8d15e3f2d30f Mon Sep 17 00:00:00 2001 From: olprod Date: Tue, 29 May 2018 12:22:28 +0000 Subject: [PATCH 10/55] init commit From ac45ad8f420115262bbad42d97b7d6257fab9583 Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Tue, 29 May 2018 11:12:10 -0700 Subject: [PATCH 11/55] Update docfx.json --- SP-Framework/docfx.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 3d5d3df3..2d0dfa88 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -45,7 +45,12 @@ "ms.prod": "sharepoint", "ms.technology": "sharepoint-framework" }, - "fileMetadata": {}, + "fileMetadata": { + "monikers": + { + ".": [ "sp-typescript-latest" ] + } + }, "template": [], "dest": "SP-Framework" } From 051f0e767d54639b2ff33267aedf9eabec5001b1 Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Tue, 29 May 2018 11:35:31 -0700 Subject: [PATCH 12/55] Update docfx.json --- SP-Framework/docfx.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 2d0dfa88..3a5f6e77 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -48,7 +48,7 @@ "fileMetadata": { "monikers": { - ".": [ "sp-typescript-latest" ] + "**/*.yml": [ "sp-typescript-latest" ] } }, "template": [], From 3bf0fa6e8af1a874a888f28b6051c40ef41a590f Mon Sep 17 00:00:00 2001 From: Den Delimarsky <1389609+dend@users.noreply.github.com> Date: Tue, 29 May 2018 11:37:59 -0700 Subject: [PATCH 13/55] Update docfx.json --- SP-Framework/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index 3a5f6e77..da17b88d 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -36,6 +36,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "apiPlatform":"javascript", "extendBreadcrumb": "true", "breadcrumb_path":"/javascript/api/breadcrumb/toc.json", "ms.suite": "office365", From 4593c6bbd04bb39a55b6a4466654ad64fa853ceb Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Mon, 4 Jun 2018 21:46:33 +0300 Subject: [PATCH 14/55] Updating API docs --- generate-docs/json/decorators.api.json | 4 +- generate-docs/json/recopy.bat | 23 +- .../json/sp-application-base.api.json | 104 +- generate-docs/json/sp-component-base.api.json | 1277 ++++++++++- generate-docs/json/sp-core-library.api.json | 1132 ++++++---- generate-docs/json/sp-dialog.api.json | 139 +- generate-docs/json/sp-dynamic-data.api.json | 571 +++++ generate-docs/json/sp-extension-base.api.json | 73 +- generate-docs/json/sp-http.api.json | 1899 ++++++++++++++--- .../json/sp-listview-extensibility.api.json | 243 ++- generate-docs/json/sp-odata-types.api.json | 402 +++- generate-docs/json/sp-page-context.api.json | 676 ++++-- generate-docs/json/sp-webpart-base.api.json | 1546 +++++++++++--- 13 files changed, 6679 insertions(+), 1410 deletions(-) create mode 100644 generate-docs/json/sp-dynamic-data.api.json diff --git a/generate-docs/json/decorators.api.json b/generate-docs/json/decorators.api.json index 3124965f..09ae6e01 100644 --- a/generate-docs/json/decorators.api.json +++ b/generate-docs/json/decorators.api.json @@ -16,7 +16,7 @@ "exports": { "override": { "kind": "function", - "signature": "export function override(target: Object, propertyKey: string | symbol,\r\n descriptor: TypedPropertyDescriptor): void;", + "signature": "export function override(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", "returnValue": { "type": "void", "description": [] @@ -82,7 +82,7 @@ }, "virtual": { "kind": "function", - "signature": "export function virtual(target: Object, propertyKey: string | symbol,\r\n descriptor: TypedPropertyDescriptor): void;", + "signature": "export function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", "returnValue": { "type": "void", "description": [] diff --git a/generate-docs/json/recopy.bat b/generate-docs/json/recopy.bat index aa60b521..54ec084e 100644 --- a/generate-docs/json/recopy.bat +++ b/generate-docs/json/recopy.bat @@ -1,15 +1,16 @@ @echo off -copy /y ..\..\..\spc2\spfx-core\sp-application-base\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-component-base\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-core-library\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-extension-base\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-http\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-odata-types\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-page-context\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\sp-webpart-base\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-core\decorators\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-application-base\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-component-base\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-core-library\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-extension-base\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-http\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-odata-types\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-page-context\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-webpart-base\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\decorators\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-libraries\sp-dialog\dist\*.api.json . -copy /y ..\..\..\spc2\spfx-libraries\sp-listview-extensibility\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-dialog\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\dist\*.api.json . pause diff --git a/generate-docs/json/sp-application-base.api.json b/generate-docs/json/sp-application-base.api.json index e7fad6d9..3862eac7 100644 --- a/generate-docs/json/sp-application-base.api.json +++ b/generate-docs/json/sp-application-base.api.json @@ -35,6 +35,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -102,11 +103,11 @@ }, "navigatedEvent": { "kind": "property", - "signature": "public readonly navigatedEvent: Event;", + "signature": "readonly navigatedEvent: SPEvent;", "isOptional": false, "isReadOnly": true, "isStatic": false, - "type": "Event", + "type": "SPEvent", "deprecatedMessage": [], "summary": [ { @@ -139,7 +140,10 @@ "text": " has navigated to a new page." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -184,10 +188,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "application": { "kind": "property", - "signature": "public readonly application: ApplicationAccessor;", + "signature": "readonly application: ApplicationAccessor;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -200,11 +205,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "placeholderProvider": { "kind": "property", - "signature": "public readonly placeholderProvider: PlaceholderProvider;", + "signature": "readonly placeholderProvider: PlaceholderProvider;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -217,7 +225,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -249,6 +260,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "context": { "kind": "property", @@ -270,7 +282,10 @@ "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -307,6 +322,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "onDispose": { "kind": "property", @@ -328,14 +344,17 @@ "text": "To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, "PlaceholderContent": { "kind": "class", "extends": "", - "implements": "", + "implements": "IDisposable", "typeParameters": [], "deprecatedMessage": [], "summary": [ @@ -377,11 +396,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "dispose": { "kind": "method", - "signature": "public dispose(): void;", - "accessModifier": "public", + "signature": "dispose(): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -421,11 +441,14 @@ "text": " callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "domElement": { "kind": "property", - "signature": "public readonly domElement: HTMLDivElement;", + "signature": "readonly domElement: HTMLDivElement;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -462,11 +485,29 @@ "text": " callback." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "name": { "kind": "property", - "signature": "public readonly name: PlaceholderName;", + "signature": "readonly name: PlaceholderName;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -484,7 +525,10 @@ "text": "Example: PlaceholderName.Top" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -642,14 +686,15 @@ } ], "isBeta": false, + "isSealed": false, "members": { "changedEvent": { "kind": "property", - "signature": "public readonly changedEvent: Event;", + "signature": "readonly changedEvent: SPEvent;", "isOptional": false, "isReadOnly": true, "isStatic": false, - "type": "Event", + "type": "SPEvent", "deprecatedMessage": [], "summary": [ { @@ -663,11 +708,14 @@ "text": "The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "placeholderNames": { "kind": "property", - "signature": "public readonly placeholderNames: ReadonlyArray;", + "signature": "readonly placeholderNames: ReadonlyArray;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -680,12 +728,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryCreateContent": { "kind": "method", - "signature": "public tryCreateContent(name: PlaceholderName,\r\n options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;", - "accessModifier": "public", + "signature": "tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -736,7 +787,10 @@ "text": "The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-component-base.api.json b/generate-docs/json/sp-component-base.api.json index ddb21460..d5b78fa2 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -17,7 +17,7 @@ "BaseComponent": { "kind": "class", "extends": "", - "implements": "IEventObserver", + "implements": "ISPEventObserver", "typeParameters": [], "deprecatedMessage": [], "summary": [ @@ -36,10 +36,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "componentId": { "kind": "property", - "signature": "public readonly componentId: string;", + "signature": "readonly componentId: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -57,7 +58,10 @@ "text": "Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "context": { "kind": "property", @@ -79,12 +83,15 @@ "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "dispose": { "kind": "method", - "signature": "public dispose(): void;", - "accessModifier": "public", + "signature": "dispose(): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -124,11 +131,14 @@ "text": " method." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "instanceId": { "kind": "property", - "signature": "public readonly instanceId: string;", + "signature": "readonly instanceId: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -146,11 +156,14 @@ "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isDisposed": { "kind": "property", - "signature": "public readonly isDisposed: boolean;", + "signature": "readonly isDisposed: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -163,11 +176,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manifest": { "kind": "property", - "signature": "public readonly manifest: IClientSideComponentManifest;", + "signature": "readonly manifest: IClientSideComponentManifest;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -185,11 +201,14 @@ "text": "Child classes can override this with more specialized manifest types." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onDispose": { "kind": "method", - "signature": "@virtual protected onDispose(): void;", + "signature": "protected onDispose(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -206,14 +225,17 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, "BaseComponentContext": { "kind": "class", "extends": "", - "implements": "", + "implements": "IDisposable", "typeParameters": [], "deprecatedMessage": [], "summary": [ @@ -236,10 +258,155 @@ } ], "isBeta": false, + "isSealed": false, "members": { + "aadClientFactory": { + "kind": "property", + "signature": "readonly aadClientFactory: AadHttpClientFactory;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AadHttpClientFactory", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of AadHttpClientFactory created for this instance of component" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "aadTokenFactory": { + "kind": "property", + "signature": "readonly aadTokenFactory: AadTokenProviderFactory;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AadTokenProviderFactory", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of AadTokenProviderFactory created for this instance of component" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the base component context." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataProvider": { + "kind": "property", + "signature": "readonly dynamicDataProvider: DynamicDataProvider;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "DynamicDataProvider", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Dynamic Data Provider associated with the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataSourceManager": { + "kind": "property", + "signature": "readonly dynamicDataSourceManager: DynamicDataSourceManager;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "DynamicDataSourceManager", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Dynamic Data Source Manager associated with the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "graphHttpClient": { + "kind": "property", + "signature": "readonly graphHttpClient: GraphHttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "GraphHttpClient", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of GraphHttpClient created for this instance of component" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "httpClient": { + "kind": "property", + "signature": "readonly httpClient: HttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HttpClient", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of HttpClient created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, "instanceId": { "kind": "property", - "signature": "public readonly instanceId: string;", + "signature": "readonly instanceId: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -257,11 +424,34 @@ "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the context is disposed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manifest": { "kind": "property", - "signature": "public readonly manifest: IClientSideComponentManifest;", + "signature": "readonly manifest: IClientSideComponentManifest;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -274,11 +464,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "pageContext": { "kind": "property", - "signature": "public readonly pageContext: PageContext;", + "signature": "readonly pageContext: PageContext;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -291,11 +484,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceScope": { "kind": "property", - "signature": "public readonly serviceScope: ServiceScope;", + "signature": "readonly serviceScope: ServiceScope;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -332,7 +528,1040 @@ "text": "A child service scope is created for each client-side component." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "spHttpClient": { + "kind": "property", + "signature": "readonly spHttpClient: SPHttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPHttpClient", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of SpHttpClient created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "DynamicDataProvider": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Dynamic Data Provider allows components to consume Dynamic Data. It allows data consumers to request Dynamic Data sources and register/unregister to those." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the Dynamic Data Provider." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getAvailableSources": { + "kind": "method", + "signature": "getAvailableSources(): ReadonlyArray;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ReadonlyArray", + "description": [ + { + "kind": "text", + "text": "Read-only array with all available sources." + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a list with all available Dynamic Data Sources." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the Dynamic Data Provider is disposed." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "registerAvailableSourcesChanged": { + "kind": "method", + "signature": "registerAvailableSourcesChanged(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to execute when the sources are updated." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "registerPropertyChanged": { + "kind": "method", + "signature": "registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "Id of the property of the source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to execute when the source updates its data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback for updates when a property is changed in a Dynamic Data source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "registerSourceChanged": { + "kind": "method", + "signature": "registerSourceChanged(sourceId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to execute when the source updates its data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetSource": { + "kind": "method", + "signature": "tryGetSource(id: string): IDynamicDataSource | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataSource | undefined", + "description": [] + }, + "parameters": { + "id": { + "name": "id", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregisterAvailableSourcesChanged": { + "kind": "method", + "signature": "unregisterAvailableSourcesChanged(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to remove from the registration. Must be the same it was registered with." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregisterPropertyChanged": { + "kind": "method", + "signature": "unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "Id of the property of the source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to remove from the registration. Must be the same it was registered with." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback for updates when a property is changed in a Dynamic Data source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregisterSourceChanged": { + "kind": "method", + "signature": "unregisterSourceChanged(sourceId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to remove from the registration. Must be the same it was registered with." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback for updates when a Dynamic Data source is changed." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "DynamicDataSourceManager": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Dynamic Data Source Manager allows components to expose data to other components through Dynamic Data. It allows data providers to update their metadata and notify when data has been updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the Dynamic Data Provider." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "initializeSource": { + "kind": "method", + "signature": "initializeSource(controller: IDynamicDataController): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "controller": { + "name": "controller", + "description": [ + { + "kind": "text", + "text": "Set of functions for the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IDynamicDataController" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Initializes a Dynamic Data Source for the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the Dynamic Data Provider is disposed." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "notifyPropertyChanged": { + "kind": "method", + "signature": "notifyPropertyChanged(propertyId: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "Id of the updated property in the source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies any Dynamic Data consumer that this source has updated a specific property." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "notifySourceChanged": { + "kind": "method", + "signature": "notifySourceChanged(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies any Dynamic Data consumer that this source has updated its data." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "updateMetadata": { + "kind": "method", + "signature": "updateMetadata(metadata: Partial): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "metadata": { + "name": "metadata", + "description": [ + { + "kind": "text", + "text": "Partial of the metadata." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Partial" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Updated the metadata of the Dynamic Data Source associated with the component. It allows to updated fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "DynamicProperty": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [ + "TValue" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Serializable object that simplifies usage of Dynamic Data." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is built for usage in Web Part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the dynamic data will re-render the web part automatically." + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(provider: DynamicDataProvider, callback?: () => void);", + "parameters": { + "provider": { + "name": "provider", + "description": [ + { + "kind": "text", + "text": "Dynamic Data Provider." + } + ], + "isOptional": false, + "isSpread": false, + "type": "DynamicDataProvider" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Optional. Default callback to be registered for updates in the Dynamic Data source." + } + ], + "isOptional": true, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create a new Dynamic Data object." + } + ], + "remarks": [] + }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This method is called to permanently dispose the object." + } + ], + "remarks": [ + { + "kind": "text", + "text": "After the object has been disposed, do not call its methods or access its properties." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "hasDefaultCallback": { + "kind": "method", + "signature": "hasDefaultCallback(): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the object has a default callback." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." + } + ], + "remarks": [ + { + "kind": "text", + "text": "After the object has been disposed, do not call its methods or access its properties." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "reference": { + "kind": "property", + "signature": "readonly reference: string | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "DynamicDataReference string that the Dynamic Data object points to. The reference is of the form ::." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the Dynamic Data object is set up with static data, this returns undefined." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "register": { + "kind": "method", + "signature": "register(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Callback function to register." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback function for updates on the associated Dynamic Data Source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "removeDefaultCallback": { + "kind": "method", + "signature": "removeDefaultCallback(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Removes the registration for the default callback." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This can be useful for advanced users who only want their custom callbacks." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "setReference": { + "kind": "method", + "signature": "setReference(reference: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "reference": { + "name": "reference", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Sets a Dynamic data id in the Dynamic Data object." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "setValue": { + "kind": "method", + "signature": "setValue(value: TValue): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "Value for the Dynamic Data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "TValue" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Sets a static value in the Dynamic Data object." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetSource": { + "kind": "method", + "signature": "tryGetSource(): IDynamicDataSource | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataSource | undefined", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Dynamic Data Source that the Dynamic Data object refers to. Returns undefined if the source doesn't exist." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetValue": { + "kind": "method", + "signature": "tryGetValue(): TValue | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "TValue | undefined", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the value of the Dynamic Data object. Returns undefined if the source or the data doesn't exist." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregister": { + "kind": "method", + "signature": "unregister(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Callback function to unregister." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback function for updates on the associated Dynamic Data Source. The callback function must be the same it was registered with." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index f7cd7913..13948bbd 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -68,10 +68,11 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "type": { "kind": "property", - "signature": "public static readonly type: EnvironmentType;", + "signature": "static readonly type: EnvironmentType;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -84,7 +85,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -93,7 +97,7 @@ "values": { "ClassicSharePoint": { "kind": "enum value", - "value": "", + "value": "3", "deprecatedMessage": [], "summary": [ { @@ -106,7 +110,7 @@ }, "Local": { "kind": "enum value", - "value": "", + "value": "1", "deprecatedMessage": [], "summary": [ { @@ -119,7 +123,7 @@ }, "SharePoint": { "kind": "enum value", - "value": "", + "value": "2", "deprecatedMessage": [], "summary": [ { @@ -132,7 +136,7 @@ }, "Test": { "kind": "enum value", - "value": "", + "value": "0", "deprecatedMessage": [], "summary": [ { @@ -178,185 +182,6 @@ ], "isBeta": false }, - "Event": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [ - "TEventArgs extends EventArgs" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a framework event that components can subscribe to." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Event class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the Event object, one for each kind of event. The Event object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an EventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the IEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component." - } - ], - "isBeta": false, - "members": { - "add": { - "kind": "method", - "signature": "public add(observer: IEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "observer": { - "name": "observer", - "description": [ - { - "kind": "text", - "text": "Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IEventObserver" - }, - "eventHandler": { - "name": "eventHandler", - "description": [ - { - "kind": "text", - "text": "A callback function that will be invoked whenever the event occurs" - } - ], - "isOptional": false, - "isSpread": false, - "type": "(eventArgs: TEventArgs) => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback that will be invoked whenever the event occurs." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The same object can add multiple event handlers to the same event. Since BaseComponent implements the IEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed." - } - ], - "isBeta": false - }, - "remove": { - "kind": "method", - "signature": "public remove(observer: IEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "observer": { - "name": "observer", - "description": [ - { - "kind": "text", - "text": "This must be the same observer that was passed to the add() function." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IEventObserver" - }, - "eventHandler": { - "name": "eventHandler", - "description": [ - { - "kind": "text", - "text": "The event handler to remove; this must be the same object instance that was passed to the add() function." - } - ], - "isOptional": false, - "isSpread": false, - "type": "(eventArgs: TEventArgs) => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Unregisters a callback that was registered using add()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the event handler has already been removed, or if it was never added, then this method has no effect." - } - ], - "isBeta": false - } - } - }, - "EventArgs": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for event arguments used with the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Event" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "Event", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If certain event types need to provide additional details, they will define a subclass of EventArgs." - } - ], - "isBeta": false - }, "Guid": { "kind": "class", "extends": "", @@ -397,10 +222,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "empty": { "kind": "property", - "signature": "public static readonly empty: Guid;", + "signature": "static readonly empty: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -413,12 +239,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "equals": { "kind": "method", - "signature": "public equals(guid: Guid): boolean;", - "accessModifier": "public", + "signature": "equals(guid: Guid): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -447,12 +276,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isValid": { "kind": "method", - "signature": "public static isValid(guid: string | undefined | null): boolean;", - "accessModifier": "public", + "signature": "static isValid(guid: string | undefined | null): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -486,12 +318,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "newGuid": { "kind": "method", - "signature": "public static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;", - "accessModifier": "public", + "signature": "static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -520,12 +355,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "parse": { "kind": "method", - "signature": "public static parse(guidString: string | undefined | null): Guid;", - "accessModifier": "public", + "signature": "static parse(guidString: string | undefined | null): Guid;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -559,12 +397,15 @@ "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "toString": { "kind": "method", - "signature": "public toString(): string;", - "accessModifier": "public", + "signature": "toString(): string;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -592,12 +433,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryParse": { "kind": "method", - "signature": "public static tryParse(guid: string | undefined | null): Guid | undefined;", - "accessModifier": "public", + "signature": "static tryParse(guid: string | undefined | null): Guid | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -636,7 +480,10 @@ "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -659,6 +506,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "dispose": { "kind": "method", @@ -684,7 +532,10 @@ "text": "After the object has been disposed, do not call its methods or access its properties." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isDisposed": { "kind": "property", @@ -706,92 +557,10 @@ "text": "After the object has been disposed, do not call its methods or access its properties." } ], - "isBeta": false - } - } - }, - "IEventObserver": { - "kind": "interface", - "extends": "IDisposable", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Used with the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Event" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "Event", - "memberName": "" - } - }, - { - "kind": "text", - "text": " system, this interface is implemented by components that can subscribe to events." - } - ], - "remarks": [ - { - "kind": "text", - "text": "IEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements." - } - ], - "isBeta": false, - "members": { - "componentId": { - "kind": "property", - "signature": "readonly componentId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The component identifier, from the component's manifest." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" - } - ], - "isBeta": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance identifier for the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" - } - ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -871,6 +640,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "generate": { "kind": "method", @@ -891,7 +661,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -914,6 +687,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "serviceScope": { "kind": "property", @@ -935,7 +709,102 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "ISPEventObserver": { + "kind": "interface", + "extends": "IDisposable", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Used with the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPEvent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "SPEvent", + "memberName": "" + } + }, + { + "kind": "text", + "text": " system, this interface is implemented by components that can subscribe to events." + } + ], + "remarks": [ + { + "kind": "text", + "text": "ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "componentId": { + "kind": "property", + "signature": "readonly componentId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The component identifier, from the component's manifest." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "instanceId": { + "kind": "property", + "signature": "readonly instanceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance identifier for the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1015,6 +884,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "getDate": { "kind": "method", @@ -1035,7 +905,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getTimestamp": { "kind": "method", @@ -1056,7 +929,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1079,11 +955,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "error": { "kind": "method", - "signature": "public static error(source: string, error: Error, scope?: ServiceScope): void;", - "accessModifier": "public", + "signature": "static error(source: string, error: Error, scope?: ServiceScope): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1136,12 +1013,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "info": { "kind": "method", - "signature": "public static info(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "public", + "signature": "static info(source: string, message: string, scope?: ServiceScope): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1194,12 +1074,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "verbose": { "kind": "method", - "signature": "public static verbose(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "public", + "signature": "static verbose(source: string, message: string, scope?: ServiceScope): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1252,12 +1135,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "warn": { "kind": "method", - "signature": "public static warn(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "public", + "signature": "static warn(source: string, message: string, scope?: ServiceScope): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1310,7 +1196,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1347,6 +1236,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -1390,8 +1280,8 @@ }, "generate": { "kind": "method", - "signature": "public generate(): number;", - "accessModifier": "public", + "signature": "generate(): number;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1407,11 +1297,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceKey": { "kind": "property", - "signature": "public static readonly serviceKey: ServiceKey;", + "signature": "static readonly serviceKey: ServiceKey;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1424,7 +1317,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1468,11 +1364,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "create": { "kind": "method", - "signature": "public static create < TKey >(name: string,\r\n serviceClass: { new (serviceScope: ServiceScope); }): ServiceKey;", - "accessModifier": "public", + "signature": "static create(name: string, serviceClass: {\n new (serviceScope: ServiceScope);\n }): ServiceKey;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1507,7 +1404,7 @@ ], "isOptional": false, "isSpread": false, - "type": "{ new (serviceScope: ServiceScope); }" + "type": "{\n new (serviceScope: ServiceScope);\n }" } }, "deprecatedMessage": [], @@ -1542,12 +1439,15 @@ "text": " instead." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "createCustom": { "kind": "method", - "signature": "public static createCustom < TKey >(name: string, defaultCreator: ServiceCreator): ServiceKey;", - "accessModifier": "public", + "signature": "static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1593,11 +1493,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "defaultCreator": { "kind": "property", - "signature": "public readonly defaultCreator: ServiceCreator;", + "signature": "readonly defaultCreator: ServiceCreator;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1610,11 +1513,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "id": { "kind": "property", - "signature": "public readonly id: string;", + "signature": "readonly id: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1632,11 +1538,14 @@ "text": "The identifier is a currently generated by incrementing an integer counter; however this may change in the future." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "name": { "kind": "property", - "signature": "public readonly name: string;", + "signature": "readonly name: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1680,7 +1589,10 @@ "text": " is used wherever a lookup key is needed." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1724,11 +1636,52 @@ } ], "isBeta": false, + "isSealed": false, "members": { + "__constructor": { + "kind": "constructor", + "signature": "protected constructor(parent: ServiceScope | undefined);", + "parameters": { + "parent": { + "name": "parent", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope | undefined" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, "consume": { "kind": "method", - "signature": "public consume < T >(serviceKey: ServiceKey): T;", - "accessModifier": "public", + "signature": "consume(serviceKey: ServiceKey): T;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1767,12 +1720,15 @@ "text": "Components should call this function to \"consume\" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "createAndProvide": { "kind": "method", - "signature": "public createAndProvide < T >(serviceKey: ServiceKey,\r\n simpleServiceClass: { new (serviceScope: ServiceScope); }): T;", - "accessModifier": "public", + "signature": "createAndProvide(serviceKey: ServiceKey, simpleServiceClass: {\n new (serviceScope: ServiceScope);\n }): T;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1807,7 +1763,7 @@ ], "isOptional": false, "isSpread": false, - "type": "{ new (serviceScope: ServiceScope); }" + "type": "{\n new (serviceScope: ServiceScope);\n }" } }, "deprecatedMessage": [], @@ -1818,12 +1774,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "createDefaultAndProvide": { "kind": "method", - "signature": "public createDefaultAndProvide < T >(serviceKey: ServiceKey): T;", - "accessModifier": "public", + "signature": "createDefaultAndProvide(serviceKey: ServiceKey): T;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1857,12 +1816,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "finish": { "kind": "method", - "signature": "public finish(): void;", - "accessModifier": "public", + "signature": "finish(): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1890,12 +1852,15 @@ "text": "This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getParent": { "kind": "method", - "signature": "public getParent(): ServiceScope | undefined;", - "accessModifier": "public", + "signature": "getParent(): ServiceScope | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1916,12 +1881,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "provide": { "kind": "method", - "signature": "public provide < T >(serviceKey: ServiceKey, service: T): T;", - "accessModifier": "public", + "signature": "provide(serviceKey: ServiceKey, service: T): T;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1972,12 +1940,15 @@ "text": "ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an \"unfinished\" state, i.e. before finish() has been called." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "startNewChild": { "kind": "method", - "signature": "public startNewChild(): ServiceScope;", - "accessModifier": "public", + "signature": "startNewChild(): ServiceScope;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2003,12 +1974,15 @@ "text": "The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "startNewRoot": { "kind": "method", - "signature": "public static startNewRoot(): ServiceScope;", - "accessModifier": "public", + "signature": "static startNewRoot(): ServiceScope;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2029,12 +2003,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "whenFinished": { "kind": "method", - "signature": "public whenFinished(callback: () => void): void;", - "accessModifier": "public", + "signature": "whenFinished(callback: () => void): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2094,7 +2071,10 @@ "text": "NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished()." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2112,10 +2092,11 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "applicationId": { "kind": "property", - "signature": "public static readonly applicationId: Guid;", + "signature": "static readonly applicationId: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -2133,11 +2114,14 @@ "text": "A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the duration of the client-side application instance, i.e. it begins with the server request that renders the page, and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "pageId": { "kind": "property", - "signature": "public static readonly pageId: Guid;", + "signature": "static readonly pageId: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -2188,10 +2172,200 @@ "text": "The concept of a page is subjective and defined by the router for a particular application." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "SPEvent": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [ + "TEventArgs extends SPEventArgs" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents a framework event that components can subscribe to." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPEvent class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "add": { + "kind": "method", + "signature": "add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "observer": { + "name": "observer", + "description": [ + { + "kind": "text", + "text": "Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception." + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPEventObserver" + }, + "eventHandler": { + "name": "eventHandler", + "description": [ + { + "kind": "text", + "text": "A callback function that will be invoked whenever the event occurs" + } + ], + "isOptional": false, + "isSpread": false, + "type": "(eventArgs: TEventArgs) => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback that will be invoked whenever the event occurs." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "remove": { + "kind": "method", + "signature": "remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "observer": { + "name": "observer", + "description": [ + { + "kind": "text", + "text": "This must be the same observer that was passed to the add() function." + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPEventObserver" + }, + "eventHandler": { + "name": "eventHandler", + "description": [ + { + "kind": "text", + "text": "The event handler to remove; this must be the same object instance that was passed to the add() function." + } + ], + "isOptional": false, + "isSpread": false, + "type": "(eventArgs: TEventArgs) => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback that was registered using add()." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the event handler has already been removed, or if it was never added, then this method has no effect." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, + "SPEventArgs": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for event arguments used with the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPEvent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "SPEvent", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If certain event types need to provide additional details, they will define a subclass of SPEventArgs." + } + ], + "isBeta": false, + "isSealed": false + }, "Text": { "kind": "class", "extends": "", @@ -2211,11 +2385,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "format": { "kind": "method", - "signature": "public static format(s: string, ...values: any[]): string;", - "accessModifier": "public", + "signature": "static format(s: string, ...values: any[]): string;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2265,7 +2440,10 @@ "text": "Text.format(\"hello {0}!\", \"world\") will return \"hello world!\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2302,6 +2480,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -2345,8 +2524,8 @@ }, "getDate": { "kind": "method", - "signature": "public getDate(): Date;", - "accessModifier": "public", + "signature": "getDate(): Date;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2362,12 +2541,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getTimestamp": { "kind": "method", - "signature": "public getTimestamp(): number;", - "accessModifier": "public", + "signature": "getTimestamp(): number;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2383,11 +2565,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceKey": { "kind": "property", - "signature": "public static readonly serviceKey: ServiceKey;", + "signature": "static readonly serviceKey: ServiceKey;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -2400,7 +2585,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2442,6 +2630,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -2490,8 +2679,8 @@ }, "getValue": { "kind": "method", - "signature": "public getValue(param: string): string | undefined;", - "accessModifier": "public", + "signature": "getValue(param: string): string | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2530,12 +2719,15 @@ "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValue('TEST') ---> 'done' getValue('debug') ---> 'false' getValue('lost') ---> undefined" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getValues": { "kind": "method", - "signature": "public getValues(param: string): (string | undefined)[] | undefined;", - "accessModifier": "public", + "signature": "getValues(param: string): (string | undefined)[] | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2574,7 +2766,10 @@ "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValues('TEST') ---> ['done', 'notdone'] getValues('debug') ---> ['false'] getValues('lost') ---> undefined" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2597,11 +2792,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "isNonemptyString": { "kind": "method", - "signature": "public static isNonemptyString(value: string | undefined | null, variableName: string): void;", - "accessModifier": "public", + "signature": "static isNonemptyString(value: string | undefined | null, variableName: string): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2642,12 +2838,64 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isNotDisposed": { + "kind": "method", + "signature": "static isNotDisposed(value: IDisposable, className: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "the value to check" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IDisposable" + }, + "className": { + "name": "className", + "description": [ + { + "kind": "text", + "text": "the class name, which will be mentioned in the error message" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Throws an exception if the specified object has been disposed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isNotNullOrUndefined": { "kind": "method", - "signature": "public static isNotNullOrUndefined(value: any, variableName: string): void;", - "accessModifier": "public", + "signature": "static isNotNullOrUndefined(value: any, variableName: string): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2688,12 +2936,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isTrue": { "kind": "method", - "signature": "public static isTrue(value: boolean | undefined | null, variableName: string): void;", - "accessModifier": "public", + "signature": "static isTrue(value: boolean | undefined | null, variableName: string): void;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2734,7 +2985,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2764,11 +3018,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "compare": { "kind": "method", - "signature": "public static compare(v1: Version, v2: Version): number;", - "accessModifier": "public", + "signature": "static compare(v1: Version, v2: Version): number;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2814,12 +3069,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "equals": { "kind": "method", - "signature": "public equals(compareWith: Version): boolean;", - "accessModifier": "public", + "signature": "equals(compareWith: Version): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2865,12 +3123,15 @@ "text": "1.0.0 equals 1.0.0 -> true; 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "greaterThan": { "kind": "method", - "signature": "public greaterThan(compareWith: Version): boolean;", - "accessModifier": "public", + "signature": "greaterThan(compareWith: Version): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2916,12 +3177,15 @@ "text": "1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isValid": { "kind": "method", - "signature": "public static isValid(versionString: string | undefined | null): boolean;", - "accessModifier": "public", + "signature": "static isValid(versionString: string | undefined | null): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2955,12 +3219,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "lessThan": { "kind": "method", - "signature": "public lessThan(compareWith: Version): boolean;", - "accessModifier": "public", + "signature": "lessThan(compareWith: Version): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -3006,11 +3273,14 @@ "text": "0.9.9 lessThan 1.0.0 -> true; 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "major": { "kind": "property", - "signature": "public readonly major: number;", + "signature": "readonly major: number;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3028,11 +3298,14 @@ "text": "Typically a change in the major version number indicates a compatibility break with previous versions." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "minor": { "kind": "property", - "signature": "public readonly minor: number;", + "signature": "readonly minor: number;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3050,12 +3323,15 @@ "text": "Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "parse": { "kind": "method", - "signature": "public static parse(versionString: string | undefined | null): Version;", - "accessModifier": "public", + "signature": "static parse(versionString: string | undefined | null): Version;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -3089,11 +3365,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "patch": { "kind": "property", - "signature": "public readonly patch: number | undefined;", + "signature": "readonly patch: number | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3111,11 +3390,14 @@ "text": "Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the \"build\" number." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "revision": { "kind": "property", - "signature": "public readonly revision: number | undefined;", + "signature": "readonly revision: number | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3133,12 +3415,15 @@ "text": "This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "satisfies": { "kind": "method", - "signature": "public satisfies(compareWith: Version): boolean;", - "accessModifier": "public", + "signature": "satisfies(compareWith: Version): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -3191,12 +3476,15 @@ "text": "1.0.0 satisfies 1.0.0 -> true; 1.1.0 satisfies 1.0.0 -> true; 2.0.0 satisfies 1.0.0 -> false; 1.0.0 satisfies 1.1.0 -> false" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "toString": { "kind": "method", - "signature": "public toString(): string;", - "accessModifier": "public", + "signature": "toString(): string;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -3217,12 +3505,15 @@ "text": "The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryParse": { "kind": "method", - "signature": "public static tryParse(versionString: string | undefined | null): Version | undefined;", - "accessModifier": "public", + "signature": "static tryParse(versionString: string | undefined | null): Version | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -3256,7 +3547,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-dialog.api.json b/generate-docs/json/sp-dialog.api.json index 5d02403a..25d58e8d 100644 --- a/generate-docs/json/sp-dialog.api.json +++ b/generate-docs/json/sp-dialog.api.json @@ -71,6 +71,7 @@ } ], "isBeta": true, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -105,8 +106,8 @@ }, "close": { "kind": "method", - "signature": "public close(): Promise;", - "accessModifier": "public", + "signature": "close(): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -127,7 +128,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "domElement": { "kind": "property", @@ -170,11 +174,14 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isHidden": { "kind": "property", - "signature": "public readonly isHidden: boolean;", + "signature": "readonly isHidden: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -187,11 +194,14 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isOpen": { "kind": "property", - "signature": "public readonly isOpen: boolean;", + "signature": "readonly isOpen: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -204,11 +214,14 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isSecondary": { "kind": "property", - "signature": "public readonly isSecondary: boolean;", + "signature": "readonly isSecondary: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -221,11 +234,14 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onAfterClose": { "kind": "method", - "signature": "@virtual protected onAfterClose(): void;", + "signature": "protected onAfterClose(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -242,11 +258,14 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onBeforeOpen": { "kind": "method", - "signature": "@virtual protected onBeforeOpen(): Promise;", + "signature": "protected onBeforeOpen(): Promise;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -273,7 +292,10 @@ "text": "All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "render": { "kind": "method", @@ -299,11 +321,14 @@ "text": "The render method is called once after the modal element is created and opened. It is recommended to use onBeforeOpen() for doing non-UI preperations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "secondaryDialogProvider": { "kind": "property", - "signature": "public readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;", + "signature": "readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -321,12 +346,15 @@ "text": "Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "show": { "kind": "method", - "signature": "public show(options?: IDialogShowOptions): Promise;", - "accessModifier": "public", + "signature": "show(options?: IDialogShowOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -379,7 +407,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -397,11 +428,12 @@ ], "remarks": [], "isBeta": true, + "isSealed": false, "members": { "alert": { "kind": "method", - "signature": "public static alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "public", + "signature": "static alert(message: string, options?: IAlertOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -442,12 +474,15 @@ "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "prompt": { "kind": "method", - "signature": "public static prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "public", + "signature": "static prompt(message: string, options?: IPromptOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -493,7 +528,10 @@ "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -510,7 +548,8 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false }, "IDialogConfiguration": { "kind": "interface", @@ -526,6 +565,7 @@ ], "remarks": [], "isBeta": true, + "isSealed": false, "members": { "isBlocking": { "kind": "property", @@ -542,7 +582,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -560,6 +603,7 @@ ], "remarks": [], "isBeta": true, + "isSealed": false, "members": { "confirmOpen": { "kind": "property", @@ -581,7 +625,10 @@ "text": "Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the framework. For example, you can check if a long time has passed since the request was made or the the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -599,6 +646,7 @@ ], "remarks": [], "isBeta": true, + "isSealed": false, "members": { "defaultValue": { "kind": "property", @@ -615,7 +663,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -664,11 +715,12 @@ } ], "isBeta": true, + "isSealed": false, "members": { "alert": { "kind": "method", - "signature": "public alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "public", + "signature": "alert(message: string, options?: IAlertOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -742,12 +794,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "prompt": { "kind": "method", - "signature": "public prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "public", + "signature": "prompt(message: string, options?: IPromptOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -821,12 +876,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "show": { "kind": "method", - "signature": "public show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;", - "accessModifier": "public", + "signature": "show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -900,7 +958,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-dynamic-data.api.json b/generate-docs/json/sp-dynamic-data.api.json new file mode 100644 index 00000000..70db8eae --- /dev/null +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -0,0 +1,571 @@ +{ + "kind": "package", + "name": "@microsoft/sp-dynamic-data", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for dynamic data bindings." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and implement components that use it." + } + ], + "exports": { + "DynamicDataReference": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The reference string is of the form : or ::" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Examples of references are: PageContext:user WebPart..:myComplexProperty:myArray[0].lastName" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(reference: string);", + "parameters": { + "reference": { + "name": "reference", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "DynamicDataReference" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dynamic-data", + "exportName": "DynamicDataReference", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "property": { + "kind": "property", + "signature": "readonly property: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the referred property of the Dynamic Data." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "propertyPath": { + "kind": "property", + "signature": "readonly propertyPath: string | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "reference": { + "kind": "property", + "signature": "readonly reference: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the full reference of the Dynamic Data object as a string." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "sourceId": { + "kind": "property", + "signature": "readonly sourceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the referred id of the Dynamic Data Source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IDynamicDataController": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "getPropertyDefinitions": { + "kind": "method", + "signature": "getPropertyDefinitions(): ReadonlyArray;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ReadonlyArray", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getPropertyValue": { + "kind": "method", + "signature": "getPropertyValue(propertyId: string): any;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "any", + "description": [] + }, + "parameters": { + "propertyId": { + "name": "propertyId", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IDynamicDataPropertyDefinition": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "User-friendly, localized description of the property. Example: \"Contains a list of ids with the files of the current user\"" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "id": { + "kind": "property", + "signature": "id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Id of the property. This can only contains letters, numbers, dashes and underscores." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The regular expression used to validate the constraints is /^[a-zA-Z0-9\\-_]+$/ Example: \"myFiles\"" + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "title": { + "kind": "property", + "signature": "title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "User-friendly, localized title of the property. Example: \"My files\" / \"Mis archivos\" (depending of current language)" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IDynamicDataSource": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "getPropertyDefinitions": { + "kind": "method", + "signature": "getPropertyDefinitions(): ReadonlyArray;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ReadonlyArray", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the definitions for all the properties exposed by the source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getPropertyValue": { + "kind": "method", + "signature": "getPropertyValue(propertyId: string): any;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "any", + "description": [] + }, + "parameters": { + "propertyId": { + "name": "propertyId", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "For a given property id, returns the value of the property. Throws an error if the property id doesn't exist in the source." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It returns a read-only copy of the property value, so modifying its value will not impact on the value in the data source." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Property values are JSON-serializable objects, so there are no functions that can be called inside." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "id": { + "kind": "property", + "signature": "id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "metadata": { + "kind": "property", + "signature": "metadata: IDynamicDataSourceMetadata;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IDynamicDataSourceMetadata", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Metadata of the Dynamic Data Source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IDynamicDataSourceMetadata": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "alias": { + "kind": "property", + "signature": "alias?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "componentId": { + "kind": "property", + "signature": "componentId?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "User-friendly, localized description of the Dynamic Data Source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "instanceId": { + "kind": "property", + "signature": "instanceId?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "title": { + "kind": "property", + "signature": "title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + } + } +} diff --git a/generate-docs/json/sp-extension-base.api.json b/generate-docs/json/sp-extension-base.api.json index 4305444c..a8b5e4ea 100644 --- a/generate-docs/json/sp-extension-base.api.json +++ b/generate-docs/json/sp-extension-base.api.json @@ -33,6 +33,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "context": { "kind": "property", @@ -54,11 +55,14 @@ "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onInit": { "kind": "method", - "signature": "@virtual protected onInit(): Promise;", + "signature": "protected onInit(): Promise;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -75,7 +79,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "properties": { "kind": "property", @@ -97,7 +104,10 @@ "text": "Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -123,59 +133,8 @@ } ], "isBeta": false, - "members": { - "graphHttpClient": { - "kind": "property", - "signature": "public readonly graphHttpClient: GraphHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of GraphHttpClient created for this instance of extension" - } - ], - "remarks": [], - "isBeta": false - }, - "httpClient": { - "kind": "property", - "signature": "public readonly httpClient: HttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of HttpClient created for this instance of extension" - } - ], - "remarks": [], - "isBeta": false - }, - "spHttpClient": { - "kind": "property", - "signature": "public readonly spHttpClient: SPHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of SpHttpClient created for this instance of extension" - } - ], - "remarks": [], - "isBeta": false - } - } + "isSealed": false, + "members": {} } } } diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index d73a9384..e5b736da 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -14,17 +14,691 @@ } ], "exports": { - "GraphHttpClient": { + "AadHttpClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "AadHttpClient is used to perform REST calls against an Azure AD Application." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClient class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For communicating with SharePoint, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead. For communicating with Microsoft Graph, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "GraphHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "GraphHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class." + } + ], + "isBeta": true, + "isSealed": true, + "members": { + "configurations": { + "kind": "property", + "signature": "static readonly configurations: IAadHttpClientConfigurations;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "IAadHttpClientConfigurations", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "fetch": { + "kind": "method", + "signature": "fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "a promise that will return the result" + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "AadHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Performs a REST service call." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "a promise that will return the result" + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "AadHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": true, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"GET\"." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "a promise that will return the result" + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "AadHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"POST\"." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "AadHttpClientConfiguration": { + "kind": "class", + "extends": "HttpClientConfiguration", + "implements": "IAadHttpClientConfiguration", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Configuration for HttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IAadHttpClientConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IAadHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ], + "remarks": [] + }, + "flags": { + "kind": "property", + "signature": "protected flags: IAadHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IAadHttpClientConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "overrideWith": { + "kind": "method", + "signature": "overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "AadHttpClientConfiguration", + "description": [] + }, + "parameters": { + "sourceFlags": { + "name": "sourceFlags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IAadHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + } + } + }, + "AadHttpClientFactory": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The will return a preinitialized version of the AadHttpClient for a given resource url. See more -> https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClientFactory class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "getExtendedClient": { + "kind": "method", + "signature": "getExtendedClient(resourceEndpoint: string): AadHttpClient | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "AadHttpClient | undefined", + "description": [] + }, + "parameters": { + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [ + { + "kind": "text", + "text": "The target AAD application's resource endpoint." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getStandardClient": { + "kind": "method", + "signature": "getStandardClient(resourceEndpoint: string): AadHttpClient | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "AadHttpClient | undefined", + "description": [] + }, + "parameters": { + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [ + { + "kind": "text", + "text": "The target AAD application's resource endpoint." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns an instance of the AadHttpClient that communicates with the preconfigured SharePoint Online Web Service Principal." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "AadTokenProvider": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class allows a developer to obtain OAuth2 tokens from Azure AD." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc." + } + ], + "remarks": [ + { + "kind": "text", + "text": "AadTokenProvider is replacing the /_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL." + } + ], + "isBeta": true, + "isSealed": true, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(configuration: IAadTokenProviderConfiguration);", + "parameters": { + "configuration": { + "name": "configuration", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IAadTokenProviderConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "AadTokenProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "AadTokenProvider", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "getToken": { + "kind": "method", + "signature": "getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that will be fullfiled with the token or that will reject with an error message" + } + ] + }, + "parameters": { + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [ + { + "kind": "text", + "text": "the resource for which the token should be obtained" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IAadTokenProviderConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "An example of a resourceEndpoint would be https://sdfpilot.outlook.com" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tokenAcquisitionEvent": { + "kind": "property", + "signature": "readonly tokenAcquisitionEvent: SPEvent;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies the developer when Token Acquistion requires user action." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "AadTokenProviderFactory": { "kind": "class", "extends": "", "implements": "", "typeParameters": [], - "deprecatedMessage": [ + "deprecatedMessage": [], + "summary": [ { "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + "text": "The will return a preinitialized version of the AadTokenProviderFactory." } ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "getExtendedProvider": { + "kind": "method", + "signature": "getExtendedProvider(): AadTokenProvider | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "AadTokenProvider | undefined", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "GraphHttpClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -76,6 +750,7 @@ } ], "isBeta": true, + "isSealed": true, "members": { "__constructor": { "kind": "constructor", @@ -89,12 +764,7 @@ "type": "ServiceScope" } }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -124,17 +794,12 @@ }, "configurations": { "kind": "property", - "signature": "public static readonly configurations: IGraphHttpClientConfigurations;", + "signature": "static readonly configurations: IGraphHttpClientConfigurations;", "isOptional": false, "isReadOnly": true, "isStatic": true, "type": "IGraphHttpClientConfigurations", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -142,12 +807,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fetch": { "kind": "method", - "signature": "public fetch(url: string,\r\n configuration: GraphHttpClientConfiguration,\r\n options: IGraphHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "fetch(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -197,12 +865,7 @@ "type": "IGraphHttpClientOptions" } }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -222,12 +885,15 @@ "text": "The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead): - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "get": { "kind": "method", - "signature": "public get(url: string, configuration: GraphHttpClientConfiguration,\r\n options?: IGraphHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "get(url: string, configuration: GraphHttpClientConfiguration, options?: IGraphHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -277,12 +943,7 @@ "type": "IGraphHttpClientOptions" } }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -290,12 +951,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "post": { "kind": "method", - "signature": "public post(url: string, configuration: GraphHttpClientConfiguration,\r\n options: IGraphHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "post(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -345,12 +1009,7 @@ "type": "IGraphHttpClientOptions" } }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -358,21 +1017,19 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceKey": { "kind": "property", - "signature": "public static readonly serviceKey: ServiceKey;", + "signature": "static readonly serviceKey: ServiceKey;", "isOptional": false, "isReadOnly": true, "isStatic": true, "type": "ServiceKey", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], + "deprecatedMessage": [], "summary": [ { "kind": "text", @@ -380,7 +1037,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -427,6 +1087,7 @@ } ], "isBeta": true, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -481,7 +1142,10 @@ ], "summary": [], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -509,10 +1173,11 @@ } ], "isBeta": true, + "isSealed": true, "members": { "__constructor": { "kind": "constructor", - "signature": "public constructor(response: Response);", + "signature": "constructor(response: Response);", "parameters": { "response": { "name": "response", @@ -557,8 +1222,8 @@ }, "clone": { "kind": "method", - "signature": "@override public clone(): GraphHttpClientResponse;", - "accessModifier": "public", + "signature": "clone(): GraphHttpClientResponse;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -574,7 +1239,35 @@ ], "summary": [], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "correlationId": { + "kind": "property", + "signature": "readonly correlationId: Guid | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid | undefined", + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Returns the Graph API correlation ID." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -616,6 +1309,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -659,7 +1353,7 @@ }, "configurations": { "kind": "property", - "signature": "public static readonly configurations: IHttpClientConfigurations;", + "signature": "static readonly configurations: IHttpClientConfigurations;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -672,12 +1366,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fetch": { "kind": "method", - "signature": "public fetch(url: string, configuration: HttpClientConfiguration,\r\n options: IHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -685,7 +1382,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -740,12 +1456,15 @@ "text": "Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "get": { "kind": "method", - "signature": "public get(url: string, configuration: HttpClientConfiguration,\r\n options?: IHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -753,7 +1472,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -803,12 +1541,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "post": { "kind": "method", - "signature": "public post(url: string, configuration: HttpClientConfiguration,\r\n options: IHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -816,7 +1557,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -866,11 +1626,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceKey": { "kind": "property", - "signature": "public static readonly serviceKey: ServiceKey;", + "signature": "static readonly serviceKey: ServiceKey;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -883,7 +1646,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -906,6 +1672,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -945,11 +1712,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "initializeFlags": { "kind": "method", - "signature": "@virtual protected initializeFlags(): void;", + "signature": "protected initializeFlags(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -966,12 +1736,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": true, + "isOverride": false }, "overrideWith": { "kind": "method", - "signature": "@virtual public overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;", - "accessModifier": "public", + "signature": "overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -995,7 +1768,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": true, + "isOverride": false } } }, @@ -1025,11 +1801,12 @@ } ], "isBeta": false, + "isSealed": false, "members": { "arrayBuffer": { "kind": "method", - "signature": "public arrayBuffer(): Promise;", - "accessModifier": "public", + "signature": "arrayBuffer(): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1045,12 +1822,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "blob": { "kind": "method", - "signature": "public blob(): Promise;", - "accessModifier": "public", + "signature": "blob(): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1066,11 +1846,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "bodyUsed": { "kind": "property", - "signature": "public readonly bodyUsed: boolean;", + "signature": "readonly bodyUsed: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1083,12 +1866,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "clone": { "kind": "method", - "signature": "@virtual public clone(): HttpClientResponse;", - "accessModifier": "public", + "signature": "clone(): HttpClientResponse;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1099,12 +1885,15 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": true, + "isOverride": false }, "formData": { "kind": "method", - "signature": "public formData(): Promise;", - "accessModifier": "public", + "signature": "formData(): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1120,11 +1909,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "headers": { "kind": "property", - "signature": "public readonly headers: Headers;", + "signature": "readonly headers: Headers;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1137,12 +1929,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "json": { "kind": "method", - "signature": "public json(): Promise;", - "accessModifier": "public", + "signature": "json(): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1154,129 +1949,330 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.json" + "text": "See documentation for whatwg-fetch:Body.json" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "nativeResponse": { + "kind": "property", + "signature": "protected nativeResponse: Response;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "Response", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "ok": { + "kind": "property", + "signature": "readonly ok: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.ok" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "status": { + "kind": "property", + "signature": "readonly status: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.status" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "statusText": { + "kind": "property", + "signature": "readonly statusText: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.statusText" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "text": { + "kind": "method", + "signature": "text(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.text" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "type": { + "kind": "property", + "signature": "readonly type: ResponseType;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ResponseType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.type" } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, - "nativeResponse": { + "url": { "kind": "property", - "signature": "protected nativeResponse: Response;", + "signature": "readonly url: string;", "isOptional": false, - "isReadOnly": false, + "isReadOnly": true, "isStatic": false, - "type": "Response", + "type": "string", "deprecatedMessage": [], - "summary": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.url" + } + ], "remarks": [], - "isBeta": false - }, - "ok": { + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IAadHttpClientConfiguration": { + "kind": "interface", + "extends": "IHttpClientConfiguration", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Flags interface for HttpClientConfiguration." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false + }, + "IAadHttpClientConfigurations": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard configurations for AadHttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "v1": { "kind": "property", - "signature": "public readonly ok: boolean;", + "signature": "readonly v1: AadHttpClientConfiguration;", "isOptional": false, "isReadOnly": true, "isStatic": false, - "type": "boolean", + "type": "AadHttpClientConfiguration", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.ok" + "text": "This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" } ], "remarks": [], - "isBeta": false - }, - "status": { + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IAadTokenProviderConfiguration": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Required strings for constructing an AadTokenProvider." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "aadInstanceUrl": { "kind": "property", - "signature": "public readonly status: number;", + "signature": "aadInstanceUrl: string;", "isOptional": false, - "isReadOnly": true, + "isReadOnly": false, "isStatic": false, - "type": "number", + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.status" + "text": "The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden." } ], "remarks": [], - "isBeta": false + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, - "statusText": { + "aadTenantId": { "kind": "property", - "signature": "public readonly statusText: string;", + "signature": "aadTenantId: string;", "isOptional": false, - "isReadOnly": true, + "isReadOnly": false, "isStatic": false, "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.statusText" + "text": "The Azure Active Directory's tenant id." } ], "remarks": [], - "isBeta": false + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, - "text": { - "kind": "method", - "signature": "public text(): Promise;", - "accessModifier": "public", - "isOptional": false, + "aadUserId": { + "kind": "property", + "signature": "aadUserId?: string;", + "isOptional": true, + "isReadOnly": false, "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.text" + "text": "The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user." } ], "remarks": [], - "isBeta": false + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, - "type": { + "redirectUri": { "kind": "property", - "signature": "public readonly type: ResponseType;", + "signature": "redirectUri: string;", "isOptional": false, - "isReadOnly": true, + "isReadOnly": false, "isStatic": false, - "type": "ResponseType", + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.type" + "text": "The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris." } ], "remarks": [], - "isBeta": false + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, - "url": { + "servicePrincipalId": { "kind": "property", - "signature": "public readonly url: string;", + "signature": "servicePrincipalId: string;", "isOptional": false, - "isReadOnly": true, + "isReadOnly": false, "isStatic": false, "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.url" + "text": "The client ID of the developer's Azure Active Directory application." } ], "remarks": [], - "isBeta": false + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1298,7 +2294,8 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false }, "IGraphHttpClientConfigurations": { "kind": "interface", @@ -1324,6 +2321,7 @@ } ], "isBeta": true, + "isSealed": false, "members": { "v1": { "kind": "property", @@ -1345,7 +2343,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1367,7 +2368,8 @@ "text": "This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" } ], - "isBeta": true + "isBeta": true, + "isSealed": false }, "IHttpClientConfiguration": { "kind": "interface", @@ -1382,7 +2384,8 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false }, "IHttpClientConfigurations": { "kind": "interface", @@ -1403,6 +2406,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "v1": { "kind": "property", @@ -1419,7 +2423,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1441,7 +2448,8 @@ "text": "This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/" } ], - "isBeta": false + "isBeta": false, + "isSealed": false }, "ISPHttpClientBatchConfiguration": { "kind": "interface", @@ -1456,7 +2464,8 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false }, "ISPHttpClientBatchConfigurations": { "kind": "interface", @@ -1477,6 +2486,7 @@ } ], "isBeta": true, + "isSealed": false, "members": { "v1": { "kind": "property", @@ -1493,7 +2503,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1511,6 +2524,7 @@ ], "remarks": [], "isBeta": true, + "isSealed": false, "members": { "webUrl": { "kind": "property", @@ -1527,7 +2541,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1544,7 +2561,8 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false }, "ISPHttpClientCommonConfiguration": { "kind": "interface", @@ -1560,6 +2578,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "jsonRequest": { "kind": "property", @@ -1602,7 +2621,10 @@ "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "jsonResponse": { "kind": "property", @@ -1645,7 +2667,10 @@ "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1663,6 +2688,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "defaultODataVersion": { "kind": "property", @@ -1691,7 +2717,10 @@ "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "defaultSameOriginCredentials": { "kind": "property", @@ -1727,7 +2756,10 @@ "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "requestDigest": { "kind": "property", @@ -1756,7 +2788,10 @@ "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1779,6 +2814,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "v1": { "kind": "property", @@ -1802,7 +2838,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1820,6 +2859,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "webUrl": { "kind": "property", @@ -1841,7 +2881,10 @@ "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be fetched using a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1859,11 +2902,12 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "toString": { "kind": "method", - "signature": "public toString(): string;", - "accessModifier": "public", + "signature": "toString(): string;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1879,12 +2923,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryParseFromHeaders": { "kind": "method", - "signature": "public static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;", - "accessModifier": "public", + "signature": "static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -1913,11 +2960,14 @@ "text": "If the \"OData-Version\" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "v3": { "kind": "property", - "signature": "public static v3: ODataVersion;", + "signature": "static v3: ODataVersion;", "isOptional": false, "isReadOnly": false, "isStatic": true, @@ -1930,11 +2980,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "v4": { "kind": "property", - "signature": "public static v4: ODataVersion;", + "signature": "static v4: ODataVersion;", "isOptional": false, "isReadOnly": false, "isStatic": true, @@ -1947,7 +3000,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1989,6 +3045,7 @@ } ], "isBeta": false, + "isSealed": true, "members": { "__constructor": { "kind": "constructor", @@ -2032,8 +3089,8 @@ }, "beginBatch": { "kind": "method", - "signature": "public beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;", - "accessModifier": "public", + "signature": "beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2041,7 +3098,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "An " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClientBatch" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClientBatch", + "memberName": "" + } + }, + { + "kind": "text", + "text": " object used to manage the batch operation." } ] }, @@ -2062,11 +3138,14 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "configurations": { "kind": "property", - "signature": "public static readonly configurations: ISPHttpClientConfigurations;", + "signature": "static readonly configurations: ISPHttpClientConfigurations;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -2079,12 +3158,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fetch": { "kind": "method", - "signature": "public fetch(url: string, configuration: SPHttpClientConfiguration,\r\n options: ISPHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2092,7 +3174,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -2182,12 +3283,15 @@ "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "get": { "kind": "method", - "signature": "public get(url: string, configuration: SPHttpClientConfiguration,\r\n options?: ISPHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2195,7 +3299,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -2245,12 +3368,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getWebUrlFromRequestUrl": { "kind": "method", - "signature": "public static getWebUrlFromRequestUrl(requestUrl: string): string;", - "accessModifier": "public", + "signature": "static getWebUrlFromRequestUrl(requestUrl: string): string;", + "accessModifier": "", "isOptional": false, "isStatic": true, "returnValue": { @@ -2303,12 +3429,15 @@ "text": "If the URL cannot be determined, an exception is thrown." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "post": { "kind": "method", - "signature": "public post(url: string, configuration: SPHttpClientConfiguration,\r\n options: ISPHttpClientOptions): Promise;", - "accessModifier": "public", + "signature": "post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2316,7 +3445,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -2366,11 +3514,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceKey": { "kind": "property", - "signature": "public static readonly serviceKey: ServiceKey;", + "signature": "static readonly serviceKey: ServiceKey;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -2383,7 +3534,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2416,10 +3570,11 @@ } ], "isBeta": true, + "isSealed": false, "members": { "configurations": { "kind": "property", - "signature": "public static readonly configurations: ISPHttpClientBatchConfigurations;", + "signature": "static readonly configurations: ISPHttpClientBatchConfigurations;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -2432,12 +3587,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "execute": { "kind": "method", - "signature": "public execute(): Promise;", - "accessModifier": "public", + "signature": "execute(): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2453,12 +3611,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fetch": { "kind": "method", - "signature": "public fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "public", + "signature": "fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2466,7 +3627,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -2512,11 +3692,27 @@ "summary": [ { "kind": "text", - "text": "Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed). The parameters for this function are basically the same as the WHATWG API standard documented here: https://fetch.spec.whatwg.org/" + "text": "Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed)." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The parameters for this function are basically the same as the WHATWG API standard documented here:" }, { "kind": "paragraph" }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://fetch.spec.whatwg.org/" + } + ], + "targetUrl": "https://fetch.spec.whatwg.org/" + }, { "kind": "text", "text": "However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details." @@ -2529,13 +3725,15 @@ "text": "When execute() is called, it will POST to a URL such as \"http://example.com/sites/sample/_api/$batch\". Typically SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly." } ], - "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "get": { "kind": "method", - "signature": "public get(url: string, configuration: SPHttpClientBatchConfiguration,\r\n options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "public", + "signature": "get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2543,7 +3741,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -2593,12 +3810,15 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "post": { "kind": "method", - "signature": "public post(url: string, configuration: SPHttpClientBatchConfiguration,\r\n options: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "public", + "signature": "post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2606,7 +3826,26 @@ "description": [ { "kind": "text", - "text": "a promise that will return the result" + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." } ] }, @@ -2656,7 +3895,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2679,6 +3921,7 @@ } ], "isBeta": true, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -2718,11 +3961,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "initializeFlags": { "kind": "method", - "signature": "@override protected initializeFlags(): void;", + "signature": "protected initializeFlags(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -2734,12 +3980,15 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": true }, "overrideWith": { "kind": "method", - "signature": "@override public overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;", - "accessModifier": "public", + "signature": "overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2758,7 +4007,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": true } } }, @@ -2776,6 +4028,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -2820,11 +4073,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "initializeFlags": { "kind": "method", - "signature": "@override protected initializeFlags(): void;", + "signature": "protected initializeFlags(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -2836,11 +4092,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true }, "jsonRequest": { "kind": "property", - "signature": "public readonly jsonRequest: boolean;", + "signature": "readonly jsonRequest: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -2879,11 +4138,14 @@ "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "jsonResponse": { "kind": "property", - "signature": "public readonly jsonResponse: boolean;", + "signature": "readonly jsonResponse: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -2922,12 +4184,15 @@ "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "overrideWith": { "kind": "method", - "signature": "@override public overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;", - "accessModifier": "public", + "signature": "overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -2946,7 +4211,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true } } }, @@ -2988,6 +4256,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -3019,7 +4288,7 @@ }, "defaultODataVersion": { "kind": "property", - "signature": "public readonly defaultODataVersion: ODataVersion;", + "signature": "readonly defaultODataVersion: ODataVersion;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3044,11 +4313,14 @@ "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "defaultSameOriginCredentials": { "kind": "property", - "signature": "public readonly defaultSameOriginCredentials: boolean;", + "signature": "readonly defaultSameOriginCredentials: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3080,7 +4352,10 @@ "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "flags": { "kind": "property", @@ -3092,11 +4367,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "initializeFlags": { "kind": "method", - "signature": "@override protected initializeFlags(): void;", + "signature": "protected initializeFlags(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -3108,12 +4386,15 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true }, "overrideWith": { "kind": "method", - "signature": "@override public overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;", - "accessModifier": "public", + "signature": "overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -3132,11 +4413,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true }, "requestDigest": { "kind": "property", - "signature": "public readonly requestDigest: boolean;", + "signature": "readonly requestDigest: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3161,7 +4445,10 @@ "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3184,10 +4471,11 @@ } ], "isBeta": false, + "isSealed": true, "members": { "__constructor": { "kind": "constructor", - "signature": "public constructor(response: Response);", + "signature": "constructor(response: Response);", "parameters": { "response": { "name": "response", @@ -3227,8 +4515,8 @@ }, "clone": { "kind": "method", - "signature": "@override public clone(): SPHttpClientResponse;", - "accessModifier": "public", + "signature": "clone(): SPHttpClientResponse;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -3239,11 +4527,14 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true }, "correlationId": { "kind": "property", - "signature": "public readonly correlationId: Guid | undefined;", + "signature": "readonly correlationId: Guid | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -3261,7 +4552,10 @@ "text": "The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the \"sprequestguid\" header." } ], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3270,7 +4564,7 @@ "values": { "SPRequestGuid": { "kind": "enum value", - "value": "'SPRequestGuid'", + "value": "\"SPRequestGuid\"", "deprecatedMessage": [], "summary": [ { @@ -3317,6 +4611,111 @@ ], "remarks": [], "isBeta": true + }, + "TokenAcquisitionEventArgs": { + "kind": "class", + "extends": "SPEventArgs", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents arguments used for raising a token acquisiton failure event." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(message: string, redirectUrl?: string);", + "parameters": { + "message": { + "name": "message", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "redirectUrl": { + "name": "redirectUrl", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "TokenAcquisitionEventArgs" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "TokenAcquisitionEventArgs", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "message": { + "kind": "property", + "signature": "message: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The message returned from ADAL fails to retrieve a token from Azure AD." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "redirectUrl": { + "kind": "property", + "signature": "redirectUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The url of the page for the end user to perform Multi Factor Authentication" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } } } } diff --git a/generate-docs/json/sp-listview-extensibility.api.json b/generate-docs/json/sp-listview-extensibility.api.json index 95251917..be848248 100644 --- a/generate-docs/json/sp-listview-extensibility.api.json +++ b/generate-docs/json/sp-listview-extensibility.api.json @@ -32,6 +32,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "context": { "kind": "property", @@ -53,12 +54,15 @@ "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onDisposeCell": { "kind": "method", - "signature": "@virtual public onDisposeCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "public", + "signature": "onDisposeCell(event: IFieldCustomizerCellEventParameters): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -77,12 +81,15 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onRenderCell": { "kind": "method", - "signature": "@virtual public onRenderCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "public", + "signature": "onRenderCell(event: IFieldCustomizerCellEventParameters): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -101,7 +108,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -133,10 +143,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "context": { "kind": "property", - "signature": "public readonly context: ListViewCommandSetContext;", + "signature": "readonly context: ListViewCommandSetContext;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -154,12 +165,15 @@ "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onExecute": { "kind": "method", - "signature": "@virtual public onExecute(event: IListViewCommandSetExecuteEventParameters): void;", - "accessModifier": "public", + "signature": "onExecute(event: IListViewCommandSetExecuteEventParameters): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -183,12 +197,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onListViewUpdated": { "kind": "method", - "signature": "@virtual public onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;", - "accessModifier": "public", + "signature": "onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -217,12 +234,15 @@ "text": "This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryGetCommand": { "kind": "method", - "signature": "public tryGetCommand(id: string): Command;", - "accessModifier": "public", + "signature": "tryGetCommand(id: string): Command;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -251,7 +271,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -288,10 +311,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "field": { "kind": "property", - "signature": "public readonly field: SPField;", + "signature": "readonly field: SPField;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -304,11 +328,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "visible": { "kind": "property", - "signature": "public readonly visible: boolean;", + "signature": "readonly visible: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -321,7 +348,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -363,10 +393,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "ariaLabel": { "kind": "property", - "signature": "public ariaLabel: string | undefined;", + "signature": "ariaLabel: string | undefined;", "isOptional": false, "isReadOnly": false, "isStatic": false, @@ -379,11 +410,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "iconImageUrl": { "kind": "property", - "signature": "public iconImageUrl: string | undefined;", + "signature": "iconImageUrl: string | undefined;", "isOptional": false, "isReadOnly": false, "isStatic": false, @@ -401,11 +435,14 @@ "text": "This must be a absolute URL." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "id": { "kind": "property", - "signature": "public id: string;", + "signature": "id: string;", "isOptional": false, "isReadOnly": false, "isStatic": false, @@ -418,11 +455,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "title": { "kind": "property", - "signature": "public title: string;", + "signature": "title: string;", "isOptional": false, "isReadOnly": false, "isStatic": false, @@ -447,11 +487,14 @@ "text": "Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "visible": { "kind": "property", - "signature": "public visible: boolean;", + "signature": "visible: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, @@ -464,7 +507,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -490,10 +536,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "field": { "kind": "property", - "signature": "public readonly field: SPField;", + "signature": "readonly field: SPField;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -506,12 +553,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryGetListView": { "kind": "method", - "signature": "public tryGetListView(): ListViewAccessor | undefined;", - "accessModifier": "public", + "signature": "tryGetListView(): ListViewAccessor | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -537,7 +587,10 @@ "text": "Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -555,6 +608,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "domElement": { "kind": "property", @@ -571,7 +625,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fieldValue": { "kind": "property", @@ -588,7 +645,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "listItem": { "kind": "property", @@ -605,7 +665,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "userData": { "kind": "property", @@ -627,7 +690,10 @@ "text": "For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -664,6 +730,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "itemId": { "kind": "property", @@ -680,7 +747,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "selectedRows": { "kind": "property", @@ -697,7 +767,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -734,6 +807,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "selectedRows": { "kind": "property", @@ -750,7 +824,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -787,10 +864,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "fields": { "kind": "property", - "signature": "public readonly fields: ReadonlyArray;", + "signature": "readonly fields: ReadonlyArray;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -808,12 +886,15 @@ "text": "The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getValue": { "kind": "method", - "signature": "public abstract getValue(field: SPField): any;", - "accessModifier": "public", + "signature": "abstract getValue(field: SPField): any;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -837,12 +918,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getValueByName": { "kind": "method", - "signature": "public abstract getValueByName(internalName: string): any;", - "accessModifier": "public", + "signature": "abstract getValueByName(internalName: string): any;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -866,7 +950,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -892,10 +979,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "columns": { "kind": "property", - "signature": "public readonly columns: ReadonlyArray;", + "signature": "readonly columns: ReadonlyArray;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -908,15 +996,18 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "selectedRowsChangedEvent": { "kind": "property", - "signature": "public readonly selectedRowsChangedEvent: Event;", + "signature": "readonly selectedRowsChangedEvent: SPEvent;", "isOptional": false, "isReadOnly": true, "isStatic": false, - "type": "Event", + "type": "SPEvent", "deprecatedMessage": [], "summary": [ { @@ -925,12 +1016,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "tryGetColumnByName": { "kind": "method", - "signature": "public abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;", - "accessModifier": "public", + "signature": "abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -954,7 +1048,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -980,10 +1077,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "listView": { "kind": "property", - "signature": "public readonly listView: ListViewAccessor;", + "signature": "readonly listView: ListViewAccessor;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -996,11 +1094,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manifest": { "kind": "property", - "signature": "public readonly manifest: ICommandSetExtensionManifest;", + "signature": "readonly manifest: ICommandSetExtensionManifest;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1013,7 +1114,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1050,11 +1154,12 @@ } ], "isBeta": false, + "isSealed": false, "members": {} }, "SelectedRowsChangedEventArgs": { "kind": "class", - "extends": "EventArgs", + "extends": "SPEventArgs", "implements": "", "typeParameters": [], "deprecatedMessage": [], @@ -1066,10 +1171,11 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "selectedRows": { "kind": "property", - "signature": "public selectedRows: ReadonlyArray;", + "signature": "selectedRows: ReadonlyArray;", "isOptional": false, "isReadOnly": false, "isStatic": false, @@ -1082,7 +1188,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-odata-types.api.json b/generate-docs/json/sp-odata-types.api.json index 14476774..0803efa8 100644 --- a/generate-docs/json/sp-odata-types.api.json +++ b/generate-docs/json/sp-odata-types.api.json @@ -28,6 +28,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "High": { "kind": "property", @@ -39,7 +40,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Low": { "kind": "property", @@ -51,7 +55,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -83,6 +90,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "StringValue": { "kind": "property", @@ -99,7 +107,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -131,6 +142,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "FormDigestTimeoutSeconds": { "kind": "property", @@ -147,7 +159,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "FormDigestValue": { "kind": "property", @@ -164,7 +179,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "LibraryVersion": { "kind": "property", @@ -181,7 +199,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "SiteFullUrl": { "kind": "property", @@ -198,7 +219,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "SupportedSchemaVersions": { "kind": "property", @@ -215,7 +239,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "WebFullUrl": { "kind": "property", @@ -232,7 +259,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -250,6 +280,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "BaseTemplate": { "kind": "property", @@ -266,7 +297,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Created": { "kind": "property", @@ -283,7 +317,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "CurrentChangeToken": { "kind": "property", @@ -300,7 +337,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Description": { "kind": "property", @@ -317,7 +357,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "EntityTypeName": { "kind": "property", @@ -334,7 +377,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Hidden": { "kind": "property", @@ -351,7 +397,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Id": { "kind": "property", @@ -368,7 +417,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "LastItemDeletedDate": { "kind": "property", @@ -385,7 +437,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "LastItemModifiedDate": { "kind": "property", @@ -402,7 +457,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ListItemEntityTypeFullName": { "kind": "property", @@ -419,7 +477,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ParentWebUrl": { "kind": "property", @@ -436,7 +497,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "TemplateFeatureId": { "kind": "property", @@ -453,7 +517,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Title": { "kind": "property", @@ -470,7 +537,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -488,6 +558,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "ContentTypeId": { "kind": "property", @@ -495,7 +566,7 @@ "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "{ StringValue: string }", + "type": "{\n StringValue: string;\n }", "deprecatedMessage": [], "summary": [ { @@ -504,7 +575,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ID": { "kind": "property", @@ -516,7 +590,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Title": { "kind": "property", @@ -533,7 +610,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "UniqueId": { "kind": "property", @@ -550,7 +630,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -568,6 +651,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "Children": { "kind": "property", @@ -584,7 +668,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Id": { "kind": "property", @@ -601,7 +688,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "IsDocLib": { "kind": "property", @@ -613,7 +703,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "IsExternal": { "kind": "property", @@ -630,7 +723,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "IsVisible": { "kind": "property", @@ -647,7 +743,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Title": { "kind": "property", @@ -664,7 +763,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Url": { "kind": "property", @@ -681,7 +783,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -699,6 +804,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "quickLaunch": { "kind": "property", @@ -715,7 +821,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "topNav": { "kind": "property", @@ -732,7 +841,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -750,6 +862,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "Email": { "kind": "property", @@ -766,7 +879,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Id": { "kind": "property", @@ -778,7 +894,10 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "IsSiteAdmin": { "kind": "property", @@ -795,7 +914,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "LoginName": { "kind": "property", @@ -812,7 +934,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "PrincipalType": { "kind": "property", @@ -876,7 +1001,10 @@ "text": "All: 15" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Title": { "kind": "property", @@ -893,7 +1021,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "UserId": { "kind": "property", @@ -910,7 +1041,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -928,6 +1062,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "ClientSideComponentId": { "kind": "property", @@ -949,7 +1084,10 @@ "text": "Example: \"359af2a7-b73c-4aac-874c-60a865da0be7\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ClientSideComponentProperties": { "kind": "property", @@ -978,7 +1116,10 @@ "text": "Example: \"{ \\\"maxItemsToShow\\\": 123 }\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "CommandUIExtension": { "kind": "property", @@ -995,7 +1136,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Description": { "kind": "property", @@ -1012,7 +1156,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Group": { "kind": "property", @@ -1029,7 +1176,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Id": { "kind": "property", @@ -1046,7 +1196,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ImageUrl": { "kind": "property", @@ -1063,7 +1216,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Location": { "kind": "property", @@ -1085,7 +1241,10 @@ "text": "Example: \"ClientSide.Application\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "RegistrationId": { "kind": "property", @@ -1102,7 +1261,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "RegistrationType": { "kind": "property", @@ -1124,7 +1286,10 @@ "text": "Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Rights": { "kind": "property", @@ -1141,7 +1306,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Scope": { "kind": "property", @@ -1158,7 +1326,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ScriptBlock": { "kind": "property", @@ -1175,7 +1346,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ScriptSrc": { "kind": "property", @@ -1192,7 +1366,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Sequence": { "kind": "property", @@ -1209,7 +1386,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Title": { "kind": "property", @@ -1226,7 +1406,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Url": { "kind": "property", @@ -1243,7 +1426,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "VersionOfUserCustomAction": { "kind": "property", @@ -1265,7 +1451,10 @@ "text": "Example: \"16.0.1.0\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1283,6 +1472,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "Created": { "kind": "property", @@ -1299,7 +1489,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "CurrentChangeToken": { "kind": "property", @@ -1316,7 +1509,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "CustomMasterUrl": { "kind": "property", @@ -1333,7 +1529,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Description": { "kind": "property", @@ -1350,7 +1549,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Id": { "kind": "property", @@ -1367,7 +1569,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "IsMultilingual": { "kind": "property", @@ -1384,7 +1589,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Language": { "kind": "property", @@ -1401,7 +1609,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "LastItemModifiedDate": { "kind": "property", @@ -1418,7 +1629,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "MasterUrl": { "kind": "property", @@ -1435,7 +1649,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "NoCrawl": { "kind": "property", @@ -1452,7 +1669,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "QuickLaunchEnabled": { "kind": "property", @@ -1469,7 +1689,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "RecycleBinEnabled": { "kind": "property", @@ -1486,7 +1709,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ServerRelativeUrl": { "kind": "property", @@ -1503,7 +1729,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "SiteLogoUrl": { "kind": "property", @@ -1520,7 +1749,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Title": { "kind": "property", @@ -1537,7 +1769,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "UIVersion": { "kind": "property", @@ -1554,7 +1789,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "Url": { "kind": "property", @@ -1571,7 +1809,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "WebTemplate": { "kind": "property", @@ -1588,7 +1829,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-page-context.api.json b/generate-docs/json/sp-page-context.api.json index e4614196..1ab595e2 100644 --- a/generate-docs/json/sp-page-context.api.json +++ b/generate-docs/json/sp-page-context.api.json @@ -36,10 +36,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "currentCultureName": { "kind": "property", - "signature": "public readonly currentCultureName: string;", + "signature": "readonly currentCultureName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -64,11 +65,14 @@ "text": "Example: If the currentCultureName is \"en-AU\" then the application could use this information to display the date as 1/8 instead of 8/1." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "currentUICultureName": { "kind": "property", - "signature": "public readonly currentUICultureName: string;", + "signature": "readonly currentUICultureName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -93,11 +97,14 @@ "text": "Example: If the currentUICultureName is \"es-MX\", then the application could use this information to translate the word \"hello\" to \"hola\"." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isRightToLeft": { "kind": "property", - "signature": "public readonly isRightToLeft: boolean;", + "signature": "readonly isRightToLeft: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -110,7 +117,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -128,6 +138,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -169,9 +180,29 @@ ], "remarks": [] }, + "aadInfo": { + "kind": "property", + "signature": "readonly aadInfo: AzureActiveDirectoryInfo | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AzureActiveDirectoryInfo | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, "cultureInfo": { "kind": "property", - "signature": "public readonly cultureInfo: CultureInfo;", + "signature": "readonly cultureInfo: CultureInfo;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -184,11 +215,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isInitialized": { "kind": "property", - "signature": "public readonly isInitialized: boolean;", + "signature": "readonly isInitialized: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -201,11 +235,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "legacyPageContext": { "kind": "property", - "signature": "public readonly legacyPageContext: any;", + "signature": "readonly legacyPageContext: any;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -230,11 +267,14 @@ "text": "NOTE: If certain functionality is exposed in the legacyPageContext but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the legacyPageContext object." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "list": { "kind": "property", - "signature": "public readonly list: SPList | undefined;", + "signature": "readonly list: SPList | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -247,11 +287,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "listItem": { "kind": "property", - "signature": "public readonly listItem: SPListItem | undefined;", + "signature": "readonly listItem: SPListItem | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -264,11 +307,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serviceKey": { "kind": "property", - "signature": "public static readonly serviceKey: ServiceKey;", + "signature": "static readonly serviceKey: ServiceKey;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -281,11 +327,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "site": { "kind": "property", - "signature": "public readonly site: SPSite;", + "signature": "readonly site: SPSite;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -298,11 +347,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "user": { "kind": "property", - "signature": "public readonly user: SPUser;", + "signature": "readonly user: SPUser;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -315,11 +367,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "web": { "kind": "property", - "signature": "public readonly web: SPWeb;", + "signature": "readonly web: SPWeb;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -332,7 +387,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -358,10 +416,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "clientSideComponentId": { "kind": "property", - "signature": "public readonly clientSideComponentId: Guid | undefined;", + "signature": "readonly clientSideComponentId: Guid | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -374,11 +433,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "clientSideComponentProperties": { "kind": "property", - "signature": "public readonly clientSideComponentProperties: string;", + "signature": "readonly clientSideComponentProperties: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -391,11 +453,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "displayName": { "kind": "property", - "signature": "public readonly displayName: string;", + "signature": "readonly displayName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -408,11 +473,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fieldType": { "kind": "property", - "signature": "public readonly fieldType: string;", + "signature": "readonly fieldType: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -425,11 +493,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "id": { "kind": "property", - "signature": "public readonly id: Guid;", + "signature": "readonly id: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -442,11 +513,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "internalName": { "kind": "property", - "signature": "public readonly internalName: string;", + "signature": "readonly internalName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -459,11 +533,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isRequired": { "kind": "property", - "signature": "public readonly isRequired: boolean;", + "signature": "readonly isRequired: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -476,7 +553,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -502,10 +582,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "id": { "kind": "property", - "signature": "public readonly id: Guid;", + "signature": "readonly id: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -518,11 +599,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "permissions": { "kind": "property", - "signature": "public readonly permissions: SPPermission;", + "signature": "readonly permissions: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -535,11 +619,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serverRelativeUrl": { "kind": "property", - "signature": "public readonly serverRelativeUrl: string;", + "signature": "readonly serverRelativeUrl: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -557,11 +644,14 @@ "text": "Example: \"/sites/PubSite\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "title": { "kind": "property", - "signature": "public readonly title: string;", + "signature": "readonly title: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -574,7 +664,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -600,10 +693,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "id": { "kind": "property", - "signature": "public readonly id: number;", + "signature": "readonly id: number;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -616,7 +710,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -646,6 +743,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -689,7 +787,7 @@ }, "addAndCustomizePages": { "kind": "property", - "signature": "public static readonly addAndCustomizePages: SPPermission;", + "signature": "static readonly addAndCustomizePages: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -702,11 +800,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "addDelPrivateWebParts": { "kind": "property", - "signature": "public static readonly addDelPrivateWebParts: SPPermission;", + "signature": "static readonly addDelPrivateWebParts: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -719,11 +820,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "addListItems": { "kind": "property", - "signature": "public static readonly addListItems: SPPermission;", + "signature": "static readonly addListItems: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -736,11 +840,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "applyStyleSheets": { "kind": "property", - "signature": "public static readonly applyStyleSheets: SPPermission;", + "signature": "static readonly applyStyleSheets: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -753,11 +860,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "applyThemeAndBorder": { "kind": "property", - "signature": "public static readonly applyThemeAndBorder: SPPermission;", + "signature": "static readonly applyThemeAndBorder: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -770,11 +880,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "approveItems": { "kind": "property", - "signature": "public static readonly approveItems: SPPermission;", + "signature": "static readonly approveItems: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -787,11 +900,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "browseDirectories": { "kind": "property", - "signature": "public static readonly browseDirectories: SPPermission;", + "signature": "static readonly browseDirectories: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -804,11 +920,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "browserUserInfo": { "kind": "property", - "signature": "public static readonly browserUserInfo: SPPermission;", + "signature": "static readonly browserUserInfo: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -821,11 +940,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "cancelCheckout": { "kind": "property", - "signature": "public static readonly cancelCheckout: SPPermission;", + "signature": "static readonly cancelCheckout: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -838,11 +960,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "createAlerts": { "kind": "property", - "signature": "public static readonly createAlerts: SPPermission;", + "signature": "static readonly createAlerts: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -855,11 +980,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "createGroups": { "kind": "property", - "signature": "public static readonly createGroups: SPPermission;", + "signature": "static readonly createGroups: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -872,11 +1000,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "createSSCSite": { "kind": "property", - "signature": "public static readonly createSSCSite: SPPermission;", + "signature": "static readonly createSSCSite: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -889,11 +1020,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "deleteListItems": { "kind": "property", - "signature": "public static readonly deleteListItems: SPPermission;", + "signature": "static readonly deleteListItems: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -906,11 +1040,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "deleteVersions": { "kind": "property", - "signature": "public static readonly deleteVersions: SPPermission;", + "signature": "static readonly deleteVersions: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -923,11 +1060,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "editListItems": { "kind": "property", - "signature": "public static readonly editListItems: SPPermission;", + "signature": "static readonly editListItems: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -940,11 +1080,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "editMyUserInfo": { "kind": "property", - "signature": "public static readonly editMyUserInfo: SPPermission;", + "signature": "static readonly editMyUserInfo: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -957,11 +1100,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "emptyMask": { "kind": "property", - "signature": "public static readonly emptyMask: SPPermission;", + "signature": "static readonly emptyMask: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -974,11 +1120,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "enumeratePermissions": { "kind": "property", - "signature": "public static readonly enumeratePermissions: SPPermission;", + "signature": "static readonly enumeratePermissions: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -991,11 +1140,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "fullMask": { "kind": "property", - "signature": "public static readonly fullMask: SPPermission;", + "signature": "static readonly fullMask: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1008,12 +1160,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "hasAllPermissions": { "kind": "method", - "signature": "public hasAllPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "public", + "signature": "hasAllPermissions(...requestedPerms: SPPermission[]): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1042,12 +1197,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "hasAnyPermissions": { "kind": "method", - "signature": "public hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "public", + "signature": "hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1076,12 +1234,15 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "hasPermission": { "kind": "method", - "signature": "public hasPermission(requestedPerm: SPPermission): boolean;", - "accessModifier": "public", + "signature": "hasPermission(requestedPerm: SPPermission): boolean;", + "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { @@ -1110,11 +1271,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "layoutsPage": { "kind": "property", - "signature": "public static readonly layoutsPage: SPPermission;", + "signature": "static readonly layoutsPage: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1127,11 +1291,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manageAlerts": { "kind": "property", - "signature": "public static readonly manageAlerts: SPPermission;", + "signature": "static readonly manageAlerts: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1144,11 +1311,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manageLists": { "kind": "property", - "signature": "public static readonly manageLists: SPPermission;", + "signature": "static readonly manageLists: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1161,11 +1331,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "managePermissions": { "kind": "property", - "signature": "public static readonly managePermissions: SPPermission;", + "signature": "static readonly managePermissions: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1178,11 +1351,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "managePersonalViews": { "kind": "property", - "signature": "public static readonly managePersonalViews: SPPermission;", + "signature": "static readonly managePersonalViews: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1195,11 +1371,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manageSubwebs": { "kind": "property", - "signature": "public static readonly manageSubwebs: SPPermission;", + "signature": "static readonly manageSubwebs: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1212,11 +1391,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manageWeb": { "kind": "property", - "signature": "public static readonly manageWeb: SPPermission;", + "signature": "static readonly manageWeb: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1234,11 +1416,14 @@ "text": "Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "open": { "kind": "property", - "signature": "public static readonly open: SPPermission;", + "signature": "static readonly open: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1251,11 +1436,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "openItems": { "kind": "property", - "signature": "public static readonly openItems: SPPermission;", + "signature": "static readonly openItems: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1268,11 +1456,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "updatePersonalWebParts": { "kind": "property", - "signature": "public static readonly updatePersonalWebParts: SPPermission;", + "signature": "static readonly updatePersonalWebParts: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1285,11 +1476,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "useClientIntegration": { "kind": "property", - "signature": "public static readonly useClientIntegration: SPPermission;", + "signature": "static readonly useClientIntegration: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1302,11 +1496,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "useRemoteAPIs": { "kind": "property", - "signature": "public static readonly useRemoteAPIs: SPPermission;", + "signature": "static readonly useRemoteAPIs: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1319,11 +1516,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "value": { "kind": "property", - "signature": "public readonly value: IODataBasePermission;", + "signature": "readonly value: IODataBasePermission;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1336,11 +1536,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "viewFormPages": { "kind": "property", - "signature": "public static readonly viewFormPages: SPPermission;", + "signature": "static readonly viewFormPages: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1353,11 +1556,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "viewListItems": { "kind": "property", - "signature": "public static readonly viewListItems: SPPermission;", + "signature": "static readonly viewListItems: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1370,11 +1576,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "viewPages": { "kind": "property", - "signature": "public static readonly viewPages: SPPermission;", + "signature": "static readonly viewPages: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1387,11 +1596,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "viewUsageData": { "kind": "property", - "signature": "public static readonly viewUsageData: SPPermission;", + "signature": "static readonly viewUsageData: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1404,11 +1616,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "viewVersions": { "kind": "property", - "signature": "public static readonly viewVersions: SPPermission;", + "signature": "static readonly viewVersions: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": true, @@ -1421,7 +1636,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1447,10 +1665,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "absoluteUrl": { "kind": "property", - "signature": "public readonly absoluteUrl: string;", + "signature": "readonly absoluteUrl: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1468,11 +1687,14 @@ "text": "Example: \"https://example.com/sites/PubSite\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "cdnPrefix": { "kind": "property", - "signature": "public readonly cdnPrefix: string;", + "signature": "readonly cdnPrefix: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1485,11 +1707,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "classification": { "kind": "property", - "signature": "public readonly classification: string;", + "signature": "readonly classification: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1502,11 +1727,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "correlationId": { "kind": "property", - "signature": "public readonly correlationId: Guid;", + "signature": "readonly correlationId: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1519,11 +1747,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "group": { "kind": "property", - "signature": "public readonly group: O365GroupAssociation | undefined;", + "signature": "readonly group: O365GroupAssociation | undefined;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1536,11 +1767,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "id": { "kind": "property", - "signature": "public readonly id: Guid;", + "signature": "readonly id: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1553,11 +1787,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isNoScriptEnabled": { "kind": "property", - "signature": "public readonly isNoScriptEnabled: boolean;", + "signature": "readonly isNoScriptEnabled: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1570,11 +1807,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "recycleBinItemCount": { "kind": "property", - "signature": "public readonly recycleBinItemCount: number;", + "signature": "readonly recycleBinItemCount: number;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1583,15 +1823,18 @@ "summary": [ { "kind": "text", - "text": "The amount of items in the recyle bin." + "text": "The amount of items in the recycle bin." } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serverRelativeUrl": { "kind": "property", - "signature": "public readonly serverRelativeUrl: string;", + "signature": "readonly serverRelativeUrl: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1609,11 +1852,14 @@ "text": "Example: \"/sites/PubSite\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serverRequestPath": { "kind": "property", - "signature": "public readonly serverRequestPath: string;", + "signature": "readonly serverRequestPath: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1631,11 +1877,14 @@ "text": "Example: \"/teams/SPClientTest/SitePages/Home.aspx\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "sitePagesEnabled": { "kind": "property", - "signature": "public readonly sitePagesEnabled: boolean;", + "signature": "readonly sitePagesEnabled: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1648,7 +1897,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1674,10 +1926,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "displayName": { "kind": "property", - "signature": "public readonly displayName: string;", + "signature": "readonly displayName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1695,11 +1948,14 @@ "text": "Example: \"John Doe\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "email": { "kind": "property", - "signature": "public readonly email: string;", + "signature": "readonly email: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1717,11 +1973,14 @@ "text": "Example: \"example@contoso.com\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isAnonymousGuestUser": { "kind": "property", - "signature": "public readonly isAnonymousGuestUser: boolean;", + "signature": "readonly isAnonymousGuestUser: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1734,11 +1993,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isExternalGuestUser": { "kind": "property", - "signature": "public readonly isExternalGuestUser: boolean;", + "signature": "readonly isExternalGuestUser: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1751,11 +2013,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "loginName": { "kind": "property", - "signature": "public readonly loginName: string;", + "signature": "readonly loginName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1770,14 +2035,17 @@ "remarks": [ { "kind": "text", - "text": "Example: \"i:0#.w|domain\\user\"" + "text": "Example: on-premise user: \"domain\\user\", online user: \"user@domain.com\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "preferUserTimeZone": { "kind": "property", - "signature": "public readonly preferUserTimeZone: boolean;", + "signature": "readonly preferUserTimeZone: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1790,7 +2058,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1816,10 +2087,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "absoluteUrl": { "kind": "property", - "signature": "public readonly absoluteUrl: string;", + "signature": "readonly absoluteUrl: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1832,11 +2104,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "description": { "kind": "property", - "signature": "public readonly description: string;", + "signature": "readonly description: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1849,11 +2124,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "id": { "kind": "property", - "signature": "public readonly id: Guid;", + "signature": "readonly id: Guid;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1866,11 +2144,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isAppWeb": { "kind": "property", - "signature": "public readonly isAppWeb: boolean;", + "signature": "readonly isAppWeb: boolean;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1883,11 +2164,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "language": { "kind": "property", - "signature": "public readonly language: number;", + "signature": "readonly language: number;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1905,11 +2189,14 @@ "text": "Example: 1033 represents the locale identifier for en-US." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "logoUrl": { "kind": "property", - "signature": "public readonly logoUrl: string;", + "signature": "readonly logoUrl: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1927,11 +2214,14 @@ "text": "Example: https://example.com/sites/PubSite/SubWeb/logo.jpg" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "permissions": { "kind": "property", - "signature": "public readonly permissions: SPPermission;", + "signature": "readonly permissions: SPPermission;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1944,11 +2234,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serverRelativeUrl": { "kind": "property", - "signature": "public readonly serverRelativeUrl: string;", + "signature": "readonly serverRelativeUrl: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1966,11 +2259,14 @@ "text": "Example: \"/sites/PubSite/SubWeb\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "templateName": { "kind": "property", - "signature": "public readonly templateName: string;", + "signature": "readonly templateName: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -1988,11 +2284,14 @@ "text": "Example: \"1\" represents the team site template when creating a new site on SharePoint." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "title": { "kind": "property", - "signature": "public readonly title: string;", + "signature": "readonly title: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -2005,7 +2304,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index a7ad252c..0df9af61 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -49,6 +49,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__constructor": { "kind": "constructor", @@ -90,7 +91,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "canOpenPopupOnRender": { "kind": "property", @@ -112,7 +116,10 @@ "text": "In some environments the host re-renders the web parts frequently, and therefor, opening popups during render will cause popups to open repeatedly and hence poor user experience. As an example, the classic SharePoint pages perform postbacks and hence page re-render on all button clicks. If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "clearError": { "kind": "method", @@ -133,7 +140,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "context": { "kind": "property", @@ -155,7 +165,10 @@ "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "dataVersion": { "kind": "property", @@ -172,7 +185,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "description": { "kind": "property", @@ -189,7 +205,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disableReactivePropertyChanges": { "kind": "property", @@ -225,7 +244,10 @@ "text": "NonReactive implies that the configuration changes are transmitted to the web part only after \"Apply\" PropertyPane button is clicked." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "displayMode": { "kind": "property", @@ -242,7 +264,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "domElement": { "kind": "property", @@ -259,11 +284,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "getPropertyPaneConfiguration": { "kind": "method", - "signature": "@virtual protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;", + "signature": "protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -281,13 +309,23 @@ { "kind": "paragraph" }, + { + "kind": "text", + "text": "This API is not invoked until the 'loadPropertyPaneResources' promise is resolved." + }, + { + "kind": "paragraph" + }, { "kind": "text", "text": "See IPropertyPane and other PropertyPane integration wiki documentation for more details." } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isRenderAsync": { "kind": "property", @@ -304,11 +342,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onAfterDeserialize": { "kind": "method", - "signature": "@virtual protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;", + "signature": "protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -367,11 +408,14 @@ "text": "An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use onAfterDeserialize to check the dataVersion and fix the property bag." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onAfterPropertyPaneChangesApplied": { "kind": "method", - "signature": "@virtual protected onAfterPropertyPaneChangesApplied(): void;", + "signature": "protected onAfterPropertyPaneChangesApplied(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -388,11 +432,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onBeforeSerialize": { "kind": "method", - "signature": "@virtual protected onBeforeSerialize(): void;", + "signature": "protected onBeforeSerialize(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -414,11 +461,14 @@ "text": "The default implementation is a no-op. The serialization process serializes the web part property bag i.e. this.properties. This API gives the web part a chance to update it's property bag before the serialization happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onDisplayModeChanged": { "kind": "method", - "signature": "@virtual protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", + "signature": "protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -453,11 +503,14 @@ "text": "The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onDispose": { "kind": "method", - "signature": "@virtual protected onDispose(): void;", + "signature": "protected onDispose(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -479,11 +532,14 @@ "text": "This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onInit": { "kind": "method", - "signature": "@virtual protected onInit(): Promise;", + "signature": "protected onInit(): Promise;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -500,11 +556,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onPropertyPaneConfigurationComplete": { "kind": "method", - "signature": "@virtual protected onPropertyPaneConfigurationComplete(): void;", + "signature": "protected onPropertyPaneConfigurationComplete(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -554,11 +613,14 @@ "text": "- When the user switches web parts then the current web part gets this event." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onPropertyPaneConfigurationStart": { "kind": "method", - "signature": "@virtual protected onPropertyPaneConfigurationStart(): void;", + "signature": "protected onPropertyPaneConfigurationStart(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -594,11 +656,14 @@ "text": "- When the user switches web parts then the new web part gets this event." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onPropertyPaneFieldChanged": { "kind": "method", - "signature": "@virtual protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;", + "signature": "protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -652,11 +717,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onPropertyPaneRendered": { "kind": "method", - "signature": "@virtual protected onPropertyPaneRendered(): void;", + "signature": "protected onPropertyPaneRendered(): void;", "accessModifier": "protected", "isOptional": false, "isStatic": false, @@ -673,7 +741,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "previewImageUrl": { "kind": "property", @@ -690,7 +761,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "properties": { "kind": "property", @@ -707,7 +781,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "propertiesMetadata": { "kind": "property", @@ -729,7 +806,25 @@ "text": "See IWebPartPropertiesMetadata for more information about how to define metadata" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "propertyPaneRenderedByWebPart": { + "kind": "property", + "signature": "protected propertyPaneRenderedByWebPart: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "render": { "kind": "method", @@ -750,7 +845,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "renderCompleted": { "kind": "method", @@ -771,7 +869,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "renderedFromPersistedData": { "kind": "property", @@ -793,7 +894,10 @@ "text": "Example: When web part is added for the first time using toolbox then the value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "renderedOnce": { "kind": "property", @@ -810,7 +914,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "renderError": { "kind": "method", @@ -844,7 +951,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "title": { "kind": "property", @@ -861,7 +971,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -879,6 +992,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "clearError": { "kind": "method", @@ -912,7 +1026,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "clearLoadingIndicator": { "kind": "method", @@ -946,7 +1063,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "displayLoadingIndicator": { "kind": "method", @@ -1004,7 +1124,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "renderError": { "kind": "method", @@ -1050,7 +1173,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1068,6 +1194,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "hideSpinner": { "kind": "property", @@ -1084,7 +1211,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "label": { "kind": "property", @@ -1101,7 +1231,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1119,6 +1252,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "isPropertyPaneOpen": { "kind": "method", @@ -1139,7 +1273,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isRenderedByWebPart": { "kind": "method", @@ -1165,7 +1302,10 @@ "text": "For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "open": { "kind": "method", @@ -1186,7 +1326,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "refresh": { "kind": "method", @@ -1212,7 +1355,10 @@ "text": "This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1230,6 +1376,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "ariaDescription": { "kind": "property", @@ -1253,7 +1400,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "ariaLabel": { "kind": "property", @@ -1270,7 +1420,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "buttonType": { "kind": "property", @@ -1287,7 +1440,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "description": { "kind": "property", @@ -1304,7 +1460,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -1321,7 +1480,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "icon": { "kind": "property", @@ -1338,7 +1500,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onClick": { "kind": "property", @@ -1355,7 +1520,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "text": { "kind": "property", @@ -1372,7 +1540,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1390,6 +1561,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "checked": { "kind": "property", @@ -1411,7 +1583,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -1428,7 +1603,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "text": { "kind": "property", @@ -1445,7 +1623,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1463,6 +1644,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "checked": { "kind": "property", @@ -1486,7 +1668,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -1503,7 +1688,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "iconProps": { "kind": "property", @@ -1520,7 +1708,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "imageSize": { "kind": "property", @@ -1528,7 +1719,7 @@ "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "{ width: number, height: number }", + "type": "{\n width: number;\n height: number;\n }", "deprecatedMessage": [], "summary": [ { @@ -1537,7 +1728,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "imageSrc": { "kind": "property", @@ -1554,7 +1748,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "key": { "kind": "property", @@ -1571,7 +1768,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "selectedImageSrc": { "kind": "property", @@ -1588,7 +1788,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "text": { "kind": "property", @@ -1605,7 +1808,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1623,6 +1829,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "officeFabricIconFontName": { "kind": "property", @@ -1639,7 +1846,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1657,6 +1867,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "label": { "kind": "property", @@ -1673,7 +1884,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "options": { "kind": "property", @@ -1690,7 +1904,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1708,6 +1925,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "currentPage": { "kind": "property", @@ -1724,7 +1942,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "loadingIndicatorDelayTime": { "kind": "property", @@ -1746,7 +1967,10 @@ "text": "The default value is 500." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "pages": { "kind": "property", @@ -1763,7 +1987,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "showLoadingIndicator": { "kind": "property", @@ -1792,7 +2019,10 @@ "text": "The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1810,6 +2040,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "context": { "kind": "property", @@ -1826,7 +2057,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "key": { "kind": "property", @@ -1871,7 +2105,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onDispose": { "kind": "property", @@ -1888,15 +2125,18 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onRender": { "kind": "property", - "signature": "onRender: (\r\n domElement: HTMLElement,\r\n context?: any,\r\n changeCallback?: (targetProperty?: string, newValue?: any) => void) => void;", + "signature": "onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void;", "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "(\r\n domElement: HTMLElement,\r\n context?: any,\r\n changeCallback?: (targetProperty?: string, newValue?: any) => void) => void", + "type": "(domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void", "deprecatedMessage": [], "summary": [ { @@ -1905,7 +2145,48 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IPropertyPaneDropdownCalloutProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane dropdown callout properties." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "calloutMaxHeight": { + "kind": "property", + "signature": "calloutMaxHeight?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Set max height of callout When not set the callout will expand with contents up to the bottom of the screen" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -1923,6 +2204,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "index": { "kind": "property", @@ -1939,7 +2221,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "key": { "kind": "property", @@ -1956,7 +2241,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "text": { "kind": "property", @@ -1973,7 +2261,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "type": { "kind": "property", @@ -1990,7 +2281,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2008,6 +2302,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "ariaLabel": { "kind": "property", @@ -2024,7 +2319,70 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "ariaPositionInSet": { + "kind": "property", + "signature": "ariaPositionInSet?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "ariaSetSize": { + "kind": "property", + "signature": "ariaSetSize?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defines the number of items in the current set of controls. Maps to native aria-setsize attribute." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "calloutProps": { + "kind": "property", + "signature": "calloutProps?: IPropertyPaneDropdownCalloutProps;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneDropdownCalloutProps", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Custom properties for Dropdown's Callout used to render options." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -2041,7 +2399,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "label": { "kind": "property", @@ -2058,7 +2419,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "options": { "kind": "property", @@ -2075,7 +2439,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "selectedKey": { "kind": "property", @@ -2092,7 +2459,290 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IPropertyPaneDynamicTextFieldProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneDynamicData component props." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Aria Label for text field, if any." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The text field input description." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane text field is enabled or not." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "errorMessage": { + "kind": "property", + "signature": "errorMessage?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If set, this will be displayed as an error message." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "So, make sure to set this only if you want to see an error message displayed for the text field." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "label": { + "kind": "property", + "signature": "label?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label for the text field." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onGetErrorMessage": { + "kind": "property", + "signature": "onGetErrorMessage?: (value: string) => string | Promise;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "(value: string) => string | Promise", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The method is used to get the validation error message and determine whether the input value is valid or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When it returns string:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- If valid, it returns empty string." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When it returns Promise:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The resolved value is display as error message." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The rejected, the value is thrown away." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "placeholder": { + "kind": "property", + "signature": "placeholder?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "placeholder text to be displayed in the text field." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "validateOnFocusIn": { + "kind": "property", + "signature": "validateOnFocusIn?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Run validation when the PropertyPaneTextField is focused." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "validateOnFocusOut": { + "kind": "property", + "signature": "validateOnFocusOut?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "value": { + "kind": "property", + "signature": "value?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2112,6 +2762,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "properties": { "kind": "property", @@ -2133,7 +2784,10 @@ "text": "Example: Checkbox has ICheckboxProps, TextField has ITextField props." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "shouldFocus": { "kind": "property", @@ -2155,7 +2809,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "targetProperty": { "kind": "property", @@ -2172,7 +2829,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "type": { "kind": "property", @@ -2189,7 +2849,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2207,6 +2870,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "groupFields": { "kind": "property", @@ -2223,7 +2887,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "groupName": { "kind": "property", @@ -2245,7 +2912,10 @@ "text": "For performance reasons, it's highly recommended to keep this name unique within the property pane page." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "isCollapsed": { "kind": "property", @@ -2267,7 +2937,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2285,6 +2958,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "required": { "kind": "property", @@ -2306,7 +2980,10 @@ "text": "If true, a red asterisk is displayed to the right of the label. Default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "text": { "kind": "property", @@ -2323,7 +3000,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2341,6 +3021,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "disabled": { "kind": "property", @@ -2357,7 +3038,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "href": { "kind": "property", @@ -2374,7 +3058,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "popupWindowProps": { "kind": "property", @@ -2391,7 +3078,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "target": { "kind": "property", @@ -2441,7 +3131,10 @@ "text": "_top - Load the response into the original window." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "text": { "kind": "property", @@ -2458,7 +3151,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2476,6 +3172,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "displayGroupsAsAccordion": { "kind": "property", @@ -2492,7 +3189,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "groups": { "kind": "property", @@ -2509,7 +3209,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "header": { "kind": "property", @@ -2526,7 +3229,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2544,6 +3250,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "description": { "kind": "property", @@ -2560,7 +3267,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "image": { "kind": "property", @@ -2577,7 +3287,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2595,6 +3308,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "ariaLabel": { "kind": "property", @@ -2611,7 +3325,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -2628,7 +3345,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "label": { "kind": "property", @@ -2645,7 +3365,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "max": { "kind": "property", @@ -2662,7 +3385,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "min": { "kind": "property", @@ -2679,7 +3405,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "showValue": { "kind": "property", @@ -2701,7 +3430,10 @@ "text": "If you want to show the value by yourself, you may want to set this value to false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "step": { "kind": "property", @@ -2718,7 +3450,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "value": { "kind": "property", @@ -2742,7 +3477,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -2760,6 +3498,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "ariaLabel": { "kind": "property", @@ -2776,7 +3515,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "deferredValidationTime": { "kind": "property", @@ -2798,7 +3540,10 @@ "text": "The default value is 200." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "description": { "kind": "property", @@ -2815,7 +3560,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -2832,7 +3580,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "errorMessage": { "kind": "property", @@ -2861,7 +3612,10 @@ "text": "So, make sure to set this only if you want to see an error message displayed for the text field." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "label": { "kind": "property", @@ -2878,7 +3632,35 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "logName": { + "kind": "property", + "signature": "logName?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n moduleName: string;\n controlName: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Engagement name to log PropertyPaneTextField value change." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It will be logged format as .. E.g. {moduleName: 'ImageWebPart', controlName: 'OverlayText'}, it will log: 1. action type, including 'Add', 'Clear' and 'Edit'. Clear: reset the content of caption element to initial/unset state. Add: change from initial/unset state to customized content. (first edit) Edit: any edition that changes the content apart from add and clear 2. text length after each edit." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "maxLength": { "kind": "property", @@ -2900,7 +3682,10 @@ "text": "If the value is set to a negative number, an exception will be thrown." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "multiline": { "kind": "property", @@ -2922,7 +3707,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onGetErrorMessage": { "kind": "property", @@ -2979,7 +3767,10 @@ "text": "- The rejected, the value is thrown away." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "placeholder": { "kind": "property", @@ -2996,7 +3787,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "resizable": { "kind": "property", @@ -3018,7 +3812,10 @@ "text": "The default value is true." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "rows": { "kind": "property", @@ -3040,7 +3837,10 @@ "text": "This prop is used only when the multiline prop is set to true." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "underlined": { "kind": "property", @@ -3062,7 +3862,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "validateOnFocusIn": { "kind": "property", @@ -3084,7 +3887,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "validateOnFocusOut": { "kind": "property", @@ -3106,7 +3912,10 @@ "text": "The default value is false." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "value": { "kind": "property", @@ -3123,7 +3932,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3141,6 +3953,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "checked": { "kind": "property", @@ -3162,7 +3975,10 @@ "text": "If you are maintaining state yourself, use this property." } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "disabled": { "kind": "property", @@ -3179,7 +3995,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "key": { "kind": "property", @@ -3196,7 +4015,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "label": { "kind": "property", @@ -3213,7 +4035,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "offAriaLabel": { "kind": "property", @@ -3230,7 +4055,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "offText": { "kind": "property", @@ -3247,7 +4075,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onAriaLabel": { "kind": "property", @@ -3264,7 +4095,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "onText": { "kind": "property", @@ -3281,7 +4115,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3299,6 +4136,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "htmlStrings": { "kind": "property", @@ -3306,7 +4144,7 @@ "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "{ [key: string]: string }", + "type": "{\n [key: string]: string;\n }", "deprecatedMessage": [], "summary": [ { @@ -3327,7 +4165,10 @@ "text": "Example: { 'myRichDescription': '
Some standard HTML contentA Link
' 'anotherRichText':
Some red text
}" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "imageSources": { "kind": "property", @@ -3335,7 +4176,7 @@ "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "{ [key: string]: string }", + "type": "{\n [key: string]: string;\n }", "deprecatedMessage": [], "summary": [ { @@ -3356,7 +4197,10 @@ "text": "Example: { 'myImage1': 'http://res.contoso.com/path/to/file' 'myImage2': 'https://res.contoso.com/someName.jpg' }" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "links": { "kind": "property", @@ -3364,7 +4208,7 @@ "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "{ [key: string]: string }", + "type": "{\n [key: string]: string;\n }", "deprecatedMessage": [], "summary": [ { @@ -3385,7 +4229,10 @@ "text": "Example: { 'myWebURL': 'http://contoso.com' 'myFileLink': 'https://res.contoso.com/file.docx' }" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "searchablePlainTexts": { "kind": "property", @@ -3393,7 +4240,7 @@ "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "{ [key: string]: string }", + "type": "{\n [key: string]: string;\n }", "deprecatedMessage": [], "summary": [ { @@ -3414,7 +4261,10 @@ "text": "Example: { 'justSomeText': 'This is some plain text', 'anotherText': 'Can have characters here: \"<>&\\'' }" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3432,6 +4282,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "dataVersion": { "kind": "property", @@ -3460,7 +4311,64 @@ "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: Version Supported values: MAJOR.MINOR Example: \"1.0\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataPaths": { + "kind": "property", + "signature": "dynamicDataPaths?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataValues": { + "kind": "property", + "signature": "dynamicDataValues?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: any;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "properties": { "kind": "property", @@ -3482,7 +4390,10 @@ "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serverProcessedContent": { "kind": "property", @@ -3499,7 +4410,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3546,6 +4460,7 @@ } ], "isBeta": false, + "isSealed": false, "members": { "domElement": { "kind": "property", @@ -3586,7 +4501,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "graphHttpClient": { "kind": "property", @@ -3627,7 +4545,10 @@ } ], "remarks": [], - "isBeta": true + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "httpClient": { "kind": "property", @@ -3668,7 +4589,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "instanceId": { "kind": "property", @@ -3709,7 +4633,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manifest": { "kind": "property", @@ -3750,7 +4677,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "pageContext": { "kind": "property", @@ -3791,7 +4721,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "propertyPane": { "kind": "property", @@ -3832,7 +4765,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "spHttpClient": { "kind": "property", @@ -3873,7 +4809,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "statusRenderer": { "kind": "property", @@ -3914,7 +4853,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "webPartTag": { "kind": "property", @@ -3955,7 +4897,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -3973,6 +4918,7 @@ ], "remarks": [], "isBeta": false, + "isSealed": false, "members": { "dataVersion": { "kind": "property", @@ -4001,7 +4947,10 @@ "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: string Supported values: MAJOR.MINOR Example: \"1.0\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "description": { "kind": "property", @@ -4023,7 +4972,64 @@ "text": "Usage: display the description of the web part. Required: no Type: string Supported values: string with the description. Example: \"Text\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataPaths": { + "kind": "property", + "signature": "dynamicDataPaths?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataValues": { + "kind": "property", + "signature": "dynamicDataValues?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: any;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "id": { "kind": "property", @@ -4045,7 +5051,10 @@ "text": "Usage: uniquely identify a web part. Required: yes Type: GUID Supported values: any GUID Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "instanceId": { "kind": "property", @@ -4067,7 +5076,10 @@ "text": "how used: used by the framework to uniquely identify an instance of a web part. mandatory: yes type: string supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: [\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"] experimental: yes" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "properties": { "kind": "property", @@ -4089,7 +5101,10 @@ "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "serverProcessedContent": { "kind": "property", @@ -4106,7 +5121,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "title": { "kind": "property", @@ -4128,7 +5146,10 @@ "text": "Usage: display the name of the web part in the toolbox, web part gallery and the page. Required: yes Type: string Supported values: string less than 100 characters Example: \"Text\"" } ], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -4200,10 +5221,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "__index": { "kind": "method", - "signature": "[ key: string ]: IWebPartPropertyMetadata;", + "signature": "[key: string]: IWebPartPropertyMetadata;", "accessModifier": "", "isOptional": false, "isStatic": false, @@ -4223,13 +5245,16 @@ "deprecatedMessage": [], "summary": [], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, "PropertyPaneButton": { "kind": "function", - "signature": "export function PropertyPaneButton(targetProperty: string,\r\n properties: IPropertyPaneButtonProps): IPropertyPaneField;", + "signature": "export function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4275,7 +5300,7 @@ "values": { "Command": { "kind": "enum value", - "value": "", + "value": "4", "deprecatedMessage": [], "summary": [ { @@ -4293,7 +5318,7 @@ }, "Compound": { "kind": "enum value", - "value": "", + "value": "3", "deprecatedMessage": [], "summary": [ { @@ -4311,7 +5336,7 @@ }, "Hero": { "kind": "enum value", - "value": "", + "value": "2", "deprecatedMessage": [], "summary": [ { @@ -4324,7 +5349,7 @@ }, "Icon": { "kind": "enum value", - "value": "", + "value": "5", "deprecatedMessage": [], "summary": [ { @@ -4342,7 +5367,7 @@ }, "Normal": { "kind": "enum value", - "value": "", + "value": "0", "deprecatedMessage": [], "summary": [ { @@ -4360,7 +5385,7 @@ }, "Primary": { "kind": "enum value", - "value": "", + "value": "1", "deprecatedMessage": [], "summary": [ { @@ -4389,7 +5414,7 @@ }, "PropertyPaneCheckbox": { "kind": "function", - "signature": "export function PropertyPaneCheckbox(targetProperty: string,\r\n properties: IPropertyPaneCheckboxProps): IPropertyPaneField;", + "signature": "export function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4432,7 +5457,7 @@ }, "PropertyPaneChoiceGroup": { "kind": "function", - "signature": "export function PropertyPaneChoiceGroup(targetProperty: string,\r\n properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;", + "signature": "export function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4511,7 +5536,7 @@ }, "PropertyPaneDropdown": { "kind": "function", - "signature": "export function PropertyPaneDropdown(targetProperty: string,\r\n properties: IPropertyPaneDropdownProps): IPropertyPaneField;", + "signature": "export function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4624,6 +5649,49 @@ "remarks": [], "isBeta": false }, + "PropertyPaneDynamicTextField": { + "kind": "function", + "signature": "export function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the dynamic textfield is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Properties of the PropertyPaneDynamicTextField." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneDynamicTextFieldProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Dynamic TextField on the PropertyPane." + } + ], + "remarks": [], + "isBeta": true + }, "PropertyPaneFieldType": { "kind": "enum", "values": { @@ -4692,6 +5760,19 @@ "remarks": [], "isBeta": false }, + "DynamicTextField": { + "kind": "enum value", + "value": "15", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Dynamic Text Field" + } + ], + "remarks": [], + "isBeta": true + }, "Heading": { "kind": "enum value", "value": "9", @@ -4821,7 +5902,7 @@ }, "PropertyPaneLabel": { "kind": "function", - "signature": "export function PropertyPaneLabel(targetProperty: string,\r\n properties: IPropertyPaneLabelProps): IPropertyPaneField;", + "signature": "export function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4864,7 +5945,7 @@ }, "PropertyPaneLink": { "kind": "function", - "signature": "export function PropertyPaneLink(targetProperty: string,\r\n properties: IPropertyPaneLinkProps): IPropertyPaneField;", + "signature": "export function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4907,7 +5988,7 @@ }, "PropertyPaneSlider": { "kind": "function", - "signature": "export function PropertyPaneSlider(targetProperty: string,\r\n properties: IPropertyPaneSliderProps): IPropertyPaneField;", + "signature": "export function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4950,7 +6031,7 @@ }, "PropertyPaneTextField": { "kind": "function", - "signature": "export function PropertyPaneTextField(targetProperty: string,\r\n properties: IPropertyPaneTextFieldProps): IPropertyPaneField;", + "signature": "export function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -4993,7 +6074,7 @@ }, "PropertyPaneToggle": { "kind": "function", - "signature": "export function PropertyPaneToggle(targetProperty: string,\r\n properties: IPropertyPaneToggleProps): IPropertyPaneField;", + "signature": "export function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField;", "returnValue": { "type": "IPropertyPaneField", "description": [] @@ -5056,10 +6137,11 @@ } ], "isBeta": false, + "isSealed": false, "members": { "domElement": { "kind": "property", - "signature": "public readonly domElement: HTMLElement;", + "signature": "readonly domElement: HTMLElement;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -5072,45 +6154,14 @@ } ], "remarks": [], - "isBeta": false - }, - "graphHttpClient": { - "kind": "property", - "signature": "public readonly graphHttpClient: GraphHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "GraphHttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": true - }, - "httpClient": { - "kind": "property", - "signature": "public readonly httpClient: HttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "HttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "manifest": { "kind": "property", - "signature": "public readonly manifest: IClientSideWebPartManifestInstance;", + "signature": "readonly manifest: IClientSideWebPartManifestInstance;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -5123,11 +6174,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "propertyPane": { "kind": "property", - "signature": "public readonly propertyPane: IPropertyPaneAccessor;", + "signature": "readonly propertyPane: IPropertyPaneAccessor;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -5140,28 +6194,14 @@ } ], "remarks": [], - "isBeta": false - }, - "spHttpClient": { - "kind": "property", - "signature": "public readonly spHttpClient: SPHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "SPHttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "statusRenderer": { "kind": "property", - "signature": "public readonly statusRenderer: IClientSideWebPartStatusRenderer;", + "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -5174,11 +6214,14 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "webPartTag": { "kind": "property", - "signature": "public readonly webPartTag: string;", + "signature": "readonly webPartTag: string;", "isOptional": false, "isReadOnly": true, "isStatic": false, @@ -5191,7 +6234,10 @@ } ], "remarks": [], - "isBeta": false + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } } From a67f1944a054c60bf09e3261d67fdcaf90ba7785 Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Mon, 4 Jun 2018 21:47:18 +0300 Subject: [PATCH 15/55] Updating API docs --- SP-Framework/decorators.yml | 8 +- .../applicationaccessor.yml | 4 +- .../applicationcustomizercontext.yml | 4 +- .../sp-application-base/class/readme.txt | 1 - .../placeholdercontent.yml | 20 +- .../placeholderprovider.yml | 10 +- SP-Framework/sp-component-base.yml | 9 + .../sp-component-base/basecomponent.yml | 14 +- .../basecomponentcontext.yml | 133 +++++++++- .../sp-component-base/dynamicdataprovider.yml | 226 +++++++++++++++++ .../dynamicdatasourcemanager.yml | 122 +++++++++ .../sp-component-base/dynamicproperty.yml | 232 ++++++++++++++++++ SP-Framework/sp-core-library.yml | 18 +- SP-Framework/sp-core-library/environment.yml | 2 +- .../sp-core-library/environmenttype.yml | 4 + SP-Framework/sp-core-library/guid.yml | 12 +- ...eventobserver.yml => ispeventobserver.yml} | 96 ++++---- SP-Framework/sp-core-library/log.yml | 8 +- .../sp-core-library/randomnumbergenerator.yml | 4 +- SP-Framework/sp-core-library/servicekey.yml | 18 +- SP-Framework/sp-core-library/servicescope.yml | 41 +++- SP-Framework/sp-core-library/session.yml | 4 +- .../{event.yml => spevent.yml} | 170 ++++++------- .../{eventargs.yml => speventargs.yml} | 22 +- SP-Framework/sp-core-library/text.yml | 2 +- SP-Framework/sp-core-library/timeprovider.yml | 6 +- .../urlqueryparametercollection.yml | 4 +- SP-Framework/sp-core-library/validate.yml | 29 ++- SP-Framework/sp-core-library/version.yml | 24 +- SP-Framework/sp-dialog/basedialog.yml | 16 +- SP-Framework/sp-dialog/dialog.yml | 4 +- .../sp-dialog/secondarydialogprovider.yml | 6 +- SP-Framework/sp-dynamic-data.yml | 29 +++ .../sp-dynamic-data/dynamicdatareference.yml | 93 +++++++ .../idynamicdatacontroller.yml | 53 ++++ .../idynamicdatapropertydefinition.yml | 61 +++++ .../sp-dynamic-data/idynamicdatasource.yml | 85 +++++++ .../idynamicdatasourcemetadata.yml | 91 +++++++ .../sp-extension-base/baseextension.yml | 2 +- .../sp-extension-base/extensioncontext.yml | 40 --- SP-Framework/sp-http.yml | 27 ++ SP-Framework/sp-http/aadhttpclient.yml | 136 ++++++++++ .../sp-http/aadhttpclientconfiguration.yml | 73 ++++++ SP-Framework/sp-http/aadhttpclientfactory.yml | 61 +++++ SP-Framework/sp-http/aadtokenprovider.yml | 82 +++++++ .../sp-http/aadtokenproviderfactory.yml | 29 +++ SP-Framework/sp-http/graphhttpclient.yml | 33 ++- .../sp-http/graphhttpclientresponse.yml | 25 +- SP-Framework/sp-http/httpclient.yml | 34 ++- .../sp-http/httpclientconfiguration.yml | 8 +- SP-Framework/sp-http/httpclientresponse.yml | 28 ++- .../sp-http/iaadhttpclientconfiguration.yml | 12 + .../sp-http/iaadhttpclientconfigurations.yml | 32 +++ .../iaadtokenproviderconfiguration.yml | 86 +++++++ SP-Framework/sp-http/odataversion.yml | 6 +- SP-Framework/sp-http/sphttpclient.yml | 45 +++- SP-Framework/sp-http/sphttpclientbatch.yml | 41 +++- .../sphttpclientbatchconfiguration.yml | 8 +- .../sphttpclientcommonconfiguration.yml | 12 +- .../sp-http/sphttpclientconfiguration.yml | 14 +- SP-Framework/sp-http/sphttpclientresponse.yml | 13 +- SP-Framework/sp-http/sphttpheader.yml | 2 +- .../sp-http/tokenacquisitioneventargs.yml | 61 +++++ .../basefieldcustomizer.yml | 4 +- .../baselistviewcommandset.yml | 8 +- .../columnaccessor.yml | 4 +- .../sp-listview-extensibility/command.yml | 10 +- .../fieldcustomizercontext.yml | 4 +- .../listitemaccessor.yml | 6 +- .../listviewaccessor.yml | 8 +- .../listviewcommandsetcontext.yml | 4 +- .../selectedrowschangedeventargs.yml | 4 +- .../sp-odata-types/iodatalistitem.yml | 5 +- SP-Framework/sp-page-context/cultureinfo.yml | 6 +- SP-Framework/sp-page-context/pagecontext.yml | 33 ++- SP-Framework/sp-page-context/spfield.yml | 14 +- SP-Framework/sp-page-context/splist.yml | 8 +- SP-Framework/sp-page-context/splistitem.yml | 2 +- SP-Framework/sp-page-context/sppermission.yml | 80 +++--- SP-Framework/sp-page-context/spsite.yml | 24 +- SP-Framework/sp-page-context/spuser.yml | 14 +- SP-Framework/sp-page-context/spweb.yml | 20 +- SP-Framework/sp-webpart-base.yml | 68 ++++- .../sp-webpart-base/baseclientsidewebpart.yml | 37 ++- .../ipropertypanechoicegroupoption.yml | 6 +- .../ipropertypanecustomfieldprops.yml | 8 +- .../ipropertypanedropdowncalloutprops.yml | 24 ++ .../ipropertypanedropdownprops.yml | 41 ++++ .../ipropertypanedynamictextfieldprops.yml | 174 +++++++++++++ .../ipropertypanetextfieldprops.yml | 22 ++ .../iserializedserverprocesseddata.yml | 20 +- .../iserializedwebpartdata.yml | 47 ++++ SP-Framework/sp-webpart-base/iwebpartdata.yml | 47 ++++ .../iwebpartpropertiesmetadata.yml | 2 +- .../propertypanebuttontype.yml | 6 + .../sp-webpart-base/propertypanefieldtype.yml | 10 + .../sp-webpart-base/webpartcontext.yml | 50 +--- SP-Framework/spfx-toc/toc.yml | 53 +++- 98 files changed, 2898 insertions(+), 570 deletions(-) delete mode 100644 SP-Framework/sp-application-base/class/readme.txt create mode 100644 SP-Framework/sp-component-base/dynamicdataprovider.yml create mode 100644 SP-Framework/sp-component-base/dynamicdatasourcemanager.yml create mode 100644 SP-Framework/sp-component-base/dynamicproperty.yml rename SP-Framework/sp-core-library/{ieventobserver.yml => ispeventobserver.yml} (64%) rename SP-Framework/sp-core-library/{event.yml => spevent.yml} (63%) rename SP-Framework/sp-core-library/{eventargs.yml => speventargs.yml} (54%) create mode 100644 SP-Framework/sp-dynamic-data.yml create mode 100644 SP-Framework/sp-dynamic-data/dynamicdatareference.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatasource.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml create mode 100644 SP-Framework/sp-http/aadhttpclient.yml create mode 100644 SP-Framework/sp-http/aadhttpclientconfiguration.yml create mode 100644 SP-Framework/sp-http/aadhttpclientfactory.yml create mode 100644 SP-Framework/sp-http/aadtokenprovider.yml create mode 100644 SP-Framework/sp-http/aadtokenproviderfactory.yml create mode 100644 SP-Framework/sp-http/iaadhttpclientconfiguration.yml create mode 100644 SP-Framework/sp-http/iaadhttpclientconfigurations.yml create mode 100644 SP-Framework/sp-http/iaadtokenproviderconfiguration.yml create mode 100644 SP-Framework/sp-http/tokenacquisitioneventargs.yml create mode 100644 SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml create mode 100644 SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 8df82eb3..19c4b3e9 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -26,7 +26,9 @@ items: - typeScript type: function syntax: - content: "export function override(target: Object, propertyKey: string | symbol,\r\n descriptor: TypedPropertyDescriptor): void;" + content: >- + export function override(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; return: type: - void @@ -77,7 +79,9 @@ items: - typeScript type: function syntax: - content: "export function virtual(target: Object, propertyKey: string | symbol,\r\n descriptor: TypedPropertyDescriptor): void;" + content: >- + export function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): + void; return: type: - void diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 228e9ead..d9fcff4d 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -52,7 +52,7 @@ items: - typeScript type: property syntax: - content: 'public readonly navigatedEvent: Event;' + content: 'readonly navigatedEvent: SPEvent;' return: type: - - Event + - SPEvent diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 04df38f0..3c0bbb75 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -24,7 +24,7 @@ items: - typeScript type: property syntax: - content: 'public readonly application: ApplicationAccessor;' + content: 'readonly application: ApplicationAccessor;' return: type: - ApplicationAccessor @@ -36,7 +36,7 @@ items: - typeScript type: property syntax: - content: 'public readonly placeholderProvider: PlaceholderProvider;' + content: 'readonly placeholderProvider: PlaceholderProvider;' return: type: - PlaceholderProvider diff --git a/SP-Framework/sp-application-base/class/readme.txt b/SP-Framework/sp-application-base/class/readme.txt deleted file mode 100644 index d9fc9794..00000000 --- a/SP-Framework/sp-application-base/class/readme.txt +++ /dev/null @@ -1 +0,0 @@ -placeholder folder to catch redirects to this location \ No newline at end of file diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index d0e0f1de..fd99b7d1 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -15,10 +15,13 @@ items: langs: - typeScript type: class + implements: + - IDisposable package: sp-application-base children: - sp-application-base.PlaceholderContent.dispose - sp-application-base.PlaceholderContent.domElement + - sp-application-base.PlaceholderContent.isDisposed - sp-application-base.PlaceholderContent.name - uid: sp-application-base.PlaceholderContent.dispose summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. @@ -33,7 +36,7 @@ items: - typeScript type: method syntax: - content: 'public dispose(): void;' + content: 'dispose(): void;' return: type: - void @@ -50,10 +53,21 @@ items: - typeScript type: property syntax: - content: 'public readonly domElement: HTMLDivElement;' + content: 'readonly domElement: HTMLDivElement;' return: type: - HTMLDivElement + - uid: sp-application-base.PlaceholderContent.isDisposed + name: isDisposed + fullName: sp-application-base.PlaceholderContent.isDisposed + langs: + - typeScript + type: property + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: + - boolean - uid: sp-application-base.PlaceholderContent.name summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' @@ -63,7 +77,7 @@ items: - typeScript type: property syntax: - content: 'public readonly name: PlaceholderName;' + content: 'readonly name: PlaceholderName;' return: type: - PlaceholderName diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 5df6e50d..c170ddb3 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -42,10 +42,10 @@ items: - typeScript type: property syntax: - content: 'public readonly changedEvent: Event;' + content: 'readonly changedEvent: SPEvent;' return: type: - - Event + - SPEvent - uid: sp-application-base.PlaceholderProvider.placeholderNames summary: Returns the names of the currently available placeholders. name: placeholderNames @@ -54,7 +54,7 @@ items: - typeScript type: property syntax: - content: 'public readonly placeholderNames: ReadonlyArray;' + content: 'readonly placeholderNames: ReadonlyArray;' return: type: - ReadonlyArray @@ -72,7 +72,9 @@ items: - typeScript type: method syntax: - content: "public tryCreateContent(name: PlaceholderName,\r\n options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;" + content: >- + tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | + undefined; return: type: - PlaceholderContent | undefined diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 2d85d124..6e390645 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -14,8 +14,17 @@ items: children: - sp-component-base.BaseComponent - sp-component-base.BaseComponentContext + - sp-component-base.DynamicDataProvider + - sp-component-base.DynamicDataSourceManager + - sp-component-base.DynamicProperty references: - uid: sp-component-base.BaseComponent name: BaseComponent - uid: sp-component-base.BaseComponentContext name: BaseComponentContext + - uid: sp-component-base.DynamicDataProvider + name: DynamicDataProvider + - uid: sp-component-base.DynamicDataSourceManager + name: DynamicDataSourceManager + - uid: sp-component-base.DynamicProperty + name: DynamicProperty diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index f93ec1a1..b3f80804 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -11,7 +11,7 @@ items: - typeScript type: class implements: - - IEventObserver + - ISPEventObserver package: sp-component-base children: - sp-component-base.BaseComponent.componentId @@ -33,7 +33,7 @@ items: - typeScript type: property syntax: - content: 'public readonly componentId: string;' + content: 'readonly componentId: string;' return: type: - string @@ -65,7 +65,7 @@ items: - typeScript type: method syntax: - content: 'public dispose(): void;' + content: 'dispose(): void;' return: type: - void @@ -82,7 +82,7 @@ items: - typeScript type: property syntax: - content: 'public readonly instanceId: string;' + content: 'readonly instanceId: string;' return: type: - string @@ -94,7 +94,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isDisposed: boolean;' + content: 'readonly isDisposed: boolean;' return: type: - boolean @@ -107,7 +107,7 @@ items: - typeScript type: property syntax: - content: 'public readonly manifest: IClientSideComponentManifest;' + content: 'readonly manifest: IClientSideComponentManifest;' return: type: - IClientSideComponentManifest @@ -121,7 +121,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onDispose(): void;' + content: 'protected onDispose(): void;' return: type: - void diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index ce3a9d16..429a136e 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -15,12 +15,113 @@ items: langs: - typeScript type: class + implements: + - IDisposable package: sp-component-base children: + - sp-component-base.BaseComponentContext.aadClientFactory + - sp-component-base.BaseComponentContext.aadTokenFactory + - sp-component-base.BaseComponentContext.dispose + - sp-component-base.BaseComponentContext.dynamicDataProvider + - sp-component-base.BaseComponentContext.dynamicDataSourceManager + - sp-component-base.BaseComponentContext.graphHttpClient + - sp-component-base.BaseComponentContext.httpClient - sp-component-base.BaseComponentContext.instanceId + - sp-component-base.BaseComponentContext.isDisposed - sp-component-base.BaseComponentContext.manifest - sp-component-base.BaseComponentContext.pageContext - sp-component-base.BaseComponentContext.serviceScope + - sp-component-base.BaseComponentContext.spHttpClient + - uid: sp-component-base.BaseComponentContext.aadClientFactory + summary: The instance of AadHttpClientFactory created for this instance of component + isPreview: true + name: aadClientFactory + fullName: sp-component-base.BaseComponentContext.aadClientFactory + langs: + - typeScript + type: property + syntax: + content: 'readonly aadClientFactory: AadHttpClientFactory;' + return: + type: + - AadHttpClientFactory + - uid: sp-component-base.BaseComponentContext.aadTokenFactory + summary: The instance of AadTokenProviderFactory created for this instance of component + isPreview: true + name: aadTokenFactory + fullName: sp-component-base.BaseComponentContext.aadTokenFactory + langs: + - typeScript + type: property + syntax: + content: 'readonly aadTokenFactory: AadTokenProviderFactory;' + return: + type: + - AadTokenProviderFactory + - uid: sp-component-base.BaseComponentContext.dispose + summary: Disposes the base component context. + name: dispose() + fullName: sp-component-base.BaseComponentContext.dispose + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: sp-component-base.BaseComponentContext.dynamicDataProvider + summary: Returns the Dynamic Data Provider associated with the component. + isPreview: true + name: dynamicDataProvider + fullName: sp-component-base.BaseComponentContext.dynamicDataProvider + langs: + - typeScript + type: property + syntax: + content: 'readonly dynamicDataProvider: DynamicDataProvider;' + return: + type: + - DynamicDataProvider + - uid: sp-component-base.BaseComponentContext.dynamicDataSourceManager + summary: Returns the Dynamic Data Source Manager associated with the component. + isPreview: true + name: dynamicDataSourceManager + fullName: sp-component-base.BaseComponentContext.dynamicDataSourceManager + langs: + - typeScript + type: property + syntax: + content: 'readonly dynamicDataSourceManager: DynamicDataSourceManager;' + return: + type: + - DynamicDataSourceManager + - uid: sp-component-base.BaseComponentContext.graphHttpClient + summary: The instance of GraphHttpClient created for this instance of component + isPreview: true + name: graphHttpClient + fullName: sp-component-base.BaseComponentContext.graphHttpClient + langs: + - typeScript + type: property + syntax: + content: 'readonly graphHttpClient: GraphHttpClient;' + return: + type: + - GraphHttpClient + - uid: sp-component-base.BaseComponentContext.httpClient + summary: The instance of HttpClient created for this instance of component + name: httpClient + fullName: sp-component-base.BaseComponentContext.httpClient + langs: + - typeScript + type: property + syntax: + content: 'readonly httpClient: HttpClient;' + return: + type: + - HttpClient - uid: sp-component-base.BaseComponentContext.instanceId summary: A unique identifier for the instance of the component. remarks: >- @@ -33,10 +134,22 @@ items: - typeScript type: property syntax: - content: 'public readonly instanceId: string;' + content: 'readonly instanceId: string;' return: type: - string + - uid: sp-component-base.BaseComponentContext.isDisposed + summary: Returns true if the context is disposed. + name: isDisposed + fullName: sp-component-base.BaseComponentContext.isDisposed + langs: + - typeScript + type: property + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: + - boolean - uid: sp-component-base.BaseComponentContext.manifest summary: Manifest for the client side component. name: manifest @@ -45,7 +158,7 @@ items: - typeScript type: property syntax: - content: 'public readonly manifest: IClientSideComponentManifest;' + content: 'readonly manifest: IClientSideComponentManifest;' return: type: - IClientSideComponentManifest @@ -59,7 +172,7 @@ items: - typeScript type: property syntax: - content: 'public readonly pageContext: PageContext;' + content: 'readonly pageContext: PageContext;' return: type: - PageContext @@ -72,7 +185,19 @@ items: - typeScript type: property syntax: - content: 'public readonly serviceScope: ServiceScope;' + content: 'readonly serviceScope: ServiceScope;' return: type: - ServiceScope + - uid: sp-component-base.BaseComponentContext.spHttpClient + summary: The instance of SpHttpClient created for this instance of component + name: spHttpClient + fullName: sp-component-base.BaseComponentContext.spHttpClient + langs: + - typeScript + type: property + syntax: + content: 'readonly spHttpClient: SPHttpClient;' + return: + type: + - SPHttpClient diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml new file mode 100644 index 00000000..3266baa0 --- /dev/null +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -0,0 +1,226 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.DynamicDataProvider + summary: >- + The Dynamic Data Provider allows components to consume Dynamic Data. It allows data consumers to request Dynamic + Data sources and register/unregister to those. + isPreview: true + name: DynamicDataProvider + fullName: sp-component-base.DynamicDataProvider + langs: + - typeScript + type: class + implements: + - IDisposable + package: sp-component-base + children: + - sp-component-base.DynamicDataProvider.dispose + - sp-component-base.DynamicDataProvider.getAvailableSources + - sp-component-base.DynamicDataProvider.isDisposed + - sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged + - sp-component-base.DynamicDataProvider.registerPropertyChanged + - sp-component-base.DynamicDataProvider.registerSourceChanged + - sp-component-base.DynamicDataProvider.tryGetSource + - sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged + - sp-component-base.DynamicDataProvider.unregisterPropertyChanged + - sp-component-base.DynamicDataProvider.unregisterSourceChanged + - uid: sp-component-base.DynamicDataProvider.dispose + summary: Disposes the Dynamic Data Provider. + isPreview: true + name: dispose() + fullName: sp-component-base.DynamicDataProvider.dispose + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: sp-component-base.DynamicDataProvider.getAvailableSources + summary: Returns a list with all available Dynamic Data Sources. + isPreview: true + name: getAvailableSources() + fullName: sp-component-base.DynamicDataProvider.getAvailableSources + langs: + - typeScript + type: method + syntax: + content: 'getAvailableSources(): ReadonlyArray;' + return: + type: + - ReadonlyArray + description: Read-only array with all available sources. + - uid: sp-component-base.DynamicDataProvider.isDisposed + summary: Returns true if the Dynamic Data Provider is disposed. + isPreview: true + name: isDisposed + fullName: sp-component-base.DynamicDataProvider.isDisposed + langs: + - typeScript + type: property + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: + - boolean + - uid: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged + summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. + isPreview: true + name: registerAvailableSourcesChanged(callback) + fullName: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged + langs: + - typeScript + type: method + syntax: + content: 'registerAvailableSourcesChanged(callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: callback + description: Function to execute when the sources are updated. + type: + - () => void + - uid: sp-component-base.DynamicDataProvider.registerPropertyChanged + summary: Registers a callback for updates when a property is changed in a Dynamic Data source. + isPreview: true + name: 'registerPropertyChanged(sourceId, propertyId, callback)' + fullName: sp-component-base.DynamicDataProvider.registerPropertyChanged + langs: + - typeScript + type: method + syntax: + content: 'registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: + - string + - id: propertyId + description: Id of the property of the source. + type: + - string + - id: callback + description: Function to execute when the source updates its data. + type: + - () => void + - uid: sp-component-base.DynamicDataProvider.registerSourceChanged + summary: >- + Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated + within the source. + isPreview: true + name: 'registerSourceChanged(sourceId, callback)' + fullName: sp-component-base.DynamicDataProvider.registerSourceChanged + langs: + - typeScript + type: method + syntax: + content: 'registerSourceChanged(sourceId: string, callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: + - string + - id: callback + description: Function to execute when the source updates its data. + type: + - () => void + - uid: sp-component-base.DynamicDataProvider.tryGetSource + summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' + isPreview: true + name: tryGetSource(id) + fullName: sp-component-base.DynamicDataProvider.tryGetSource + langs: + - typeScript + type: method + syntax: + content: 'tryGetSource(id: string): IDynamicDataSource | undefined;' + return: + type: + - IDynamicDataSource | undefined + description: '' + parameters: + - id: id + description: Id of the Dynamic Data Source. + type: + - string + - uid: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged + summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. + isPreview: true + name: unregisterAvailableSourcesChanged(callback) + fullName: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged + langs: + - typeScript + type: method + syntax: + content: 'unregisterAvailableSourcesChanged(callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + type: + - () => void + - uid: sp-component-base.DynamicDataProvider.unregisterPropertyChanged + summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. + isPreview: true + name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + fullName: sp-component-base.DynamicDataProvider.unregisterPropertyChanged + langs: + - typeScript + type: method + syntax: + content: 'unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: + - string + - id: propertyId + description: Id of the property of the source. + type: + - string + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + type: + - () => void + - uid: sp-component-base.DynamicDataProvider.unregisterSourceChanged + summary: Unregisters a callback for updates when a Dynamic Data source is changed. + isPreview: true + name: 'unregisterSourceChanged(sourceId, callback)' + fullName: sp-component-base.DynamicDataProvider.unregisterSourceChanged + langs: + - typeScript + type: method + syntax: + content: 'unregisterSourceChanged(sourceId: string, callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: + - string + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + type: + - () => void diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml new file mode 100644 index 00000000..510e95b1 --- /dev/null +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -0,0 +1,122 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.DynamicDataSourceManager + summary: >- + The Dynamic Data Source Manager allows components to expose data to other components through Dynamic Data. It + allows data providers to update their metadata and notify when data has been updated. + isPreview: true + name: DynamicDataSourceManager + fullName: sp-component-base.DynamicDataSourceManager + langs: + - typeScript + type: class + implements: + - IDisposable + package: sp-component-base + children: + - sp-component-base.DynamicDataSourceManager.dispose + - sp-component-base.DynamicDataSourceManager.initializeSource + - sp-component-base.DynamicDataSourceManager.isDisposed + - sp-component-base.DynamicDataSourceManager.notifyPropertyChanged + - sp-component-base.DynamicDataSourceManager.notifySourceChanged + - sp-component-base.DynamicDataSourceManager.updateMetadata + - uid: sp-component-base.DynamicDataSourceManager.dispose + summary: Disposes the Dynamic Data Provider. + isPreview: true + name: dispose() + fullName: sp-component-base.DynamicDataSourceManager.dispose + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: sp-component-base.DynamicDataSourceManager.initializeSource + summary: Initializes a Dynamic Data Source for the component. + isPreview: true + name: initializeSource(controller) + fullName: sp-component-base.DynamicDataSourceManager.initializeSource + langs: + - typeScript + type: method + syntax: + content: 'initializeSource(controller: IDynamicDataController): void;' + return: + type: + - void + description: '' + parameters: + - id: controller + description: Set of functions for the Dynamic Data Source. + type: + - IDynamicDataController + - uid: sp-component-base.DynamicDataSourceManager.isDisposed + summary: Returns true if the Dynamic Data Provider is disposed. + isPreview: true + name: isDisposed + fullName: sp-component-base.DynamicDataSourceManager.isDisposed + langs: + - typeScript + type: property + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: + - boolean + - uid: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged + summary: Notifies any Dynamic Data consumer that this source has updated a specific property. + isPreview: true + name: notifyPropertyChanged(propertyId) + fullName: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged + langs: + - typeScript + type: method + syntax: + content: 'notifyPropertyChanged(propertyId: string): void;' + return: + type: + - void + description: '' + parameters: + - id: propertyId + description: Id of the updated property in the source. + type: + - string + - uid: sp-component-base.DynamicDataSourceManager.notifySourceChanged + summary: Notifies any Dynamic Data consumer that this source has updated its data. + isPreview: true + name: notifySourceChanged() + fullName: sp-component-base.DynamicDataSourceManager.notifySourceChanged + langs: + - typeScript + type: method + syntax: + content: 'notifySourceChanged(): void;' + return: + type: + - void + description: '' + - uid: sp-component-base.DynamicDataSourceManager.updateMetadata + summary: >- + Updated the metadata of the Dynamic Data Source associated with the component. It allows to updated fields like + title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. + isPreview: true + name: updateMetadata(metadata) + fullName: sp-component-base.DynamicDataSourceManager.updateMetadata + langs: + - typeScript + type: method + syntax: + content: 'updateMetadata(metadata: Partial): void;' + return: + type: + - void + description: '' + parameters: + - id: metadata + description: Partial of the metadata. + type: + - Partial diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml new file mode 100644 index 00000000..af2f525d --- /dev/null +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -0,0 +1,232 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.DynamicProperty + summary: Serializable object that simplifies usage of Dynamic Data. + remarks: >- + This is built for usage in Web Part properties, and modified through the property pane. Can be initialized with a + default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change + in the dynamic data will re-render the web part automatically. + isPreview: true + name: DynamicProperty + fullName: sp-component-base.DynamicProperty + langs: + - typeScript + type: class + implements: + - IDisposable + package: sp-component-base + children: + - sp-component-base.DynamicProperty.constructor + - sp-component-base.DynamicProperty.dispose + - sp-component-base.DynamicProperty.hasDefaultCallback + - sp-component-base.DynamicProperty.isDisposed + - sp-component-base.DynamicProperty.reference + - sp-component-base.DynamicProperty.register + - sp-component-base.DynamicProperty.removeDefaultCallback + - sp-component-base.DynamicProperty.setReference + - sp-component-base.DynamicProperty.setValue + - sp-component-base.DynamicProperty.tryGetSource + - sp-component-base.DynamicProperty.tryGetValue + - sp-component-base.DynamicProperty.unregister + - uid: sp-component-base.DynamicProperty.constructor + summary: Create a new Dynamic Data object. + name: 'constructor(provider, callback)' + fullName: sp-component-base.DynamicProperty.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' + parameters: + - id: provider + description: Dynamic Data Provider. + type: + - DynamicDataProvider + - id: callback + description: Optional. Default callback to be registered for updates in the Dynamic Data source. + type: + - () => void + - uid: sp-component-base.DynamicProperty.dispose + summary: This method is called to permanently dispose the object. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + isPreview: true + name: dispose() + fullName: sp-component-base.DynamicProperty.dispose + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: sp-component-base.DynamicProperty.hasDefaultCallback + summary: Returns true if the object has a default callback. + isPreview: true + name: hasDefaultCallback() + fullName: sp-component-base.DynamicProperty.hasDefaultCallback + langs: + - typeScript + type: method + syntax: + content: 'hasDefaultCallback(): boolean;' + return: + type: + - boolean + description: '' + - uid: sp-component-base.DynamicProperty.isDisposed + summary: >- + Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state + permanently. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + isPreview: true + name: isDisposed + fullName: sp-component-base.DynamicProperty.isDisposed + langs: + - typeScript + type: property + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: + - boolean + - uid: sp-component-base.DynamicProperty.reference + summary: >- + DynamicDataReference string that the Dynamic Data object points to. The reference is of the form + <source>:<property>:<path>. + remarks: 'If the Dynamic Data object is set up with static data, this returns undefined.' + isPreview: true + name: reference + fullName: sp-component-base.DynamicProperty.reference + langs: + - typeScript + type: property + syntax: + content: 'readonly reference: string | undefined;' + return: + type: + - string | undefined + - uid: sp-component-base.DynamicProperty.register + summary: Registers a callback function for updates on the associated Dynamic Data Source. + isPreview: true + name: register(callback) + fullName: sp-component-base.DynamicProperty.register + langs: + - typeScript + type: method + syntax: + content: 'register(callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: callback + description: Callback function to register. + type: + - () => void + - uid: sp-component-base.DynamicProperty.removeDefaultCallback + summary: Removes the registration for the default callback. + remarks: This can be useful for advanced users who only want their custom callbacks. + isPreview: true + name: removeDefaultCallback() + fullName: sp-component-base.DynamicProperty.removeDefaultCallback + langs: + - typeScript + type: method + syntax: + content: 'removeDefaultCallback(): void;' + return: + type: + - void + description: '' + - uid: sp-component-base.DynamicProperty.setReference + summary: Sets a Dynamic data id in the Dynamic Data object. + isPreview: true + name: setReference(reference) + fullName: sp-component-base.DynamicProperty.setReference + langs: + - typeScript + type: method + syntax: + content: 'setReference(reference: string): void;' + return: + type: + - void + description: '' + parameters: + - id: reference + description: Id of the Dynamic Data. + type: + - string + - uid: sp-component-base.DynamicProperty.setValue + summary: Sets a static value in the Dynamic Data object. + isPreview: true + name: setValue(value) + fullName: sp-component-base.DynamicProperty.setValue + langs: + - typeScript + type: method + syntax: + content: 'setValue(value: TValue): void;' + return: + type: + - void + description: '' + parameters: + - id: value + description: Value for the Dynamic Data. + type: + - TValue + - uid: sp-component-base.DynamicProperty.tryGetSource + summary: >- + Returns the Dynamic Data Source that the Dynamic Data object refers to. Returns undefined if the source doesn't + exist. + isPreview: true + name: tryGetSource() + fullName: sp-component-base.DynamicProperty.tryGetSource + langs: + - typeScript + type: method + syntax: + content: 'tryGetSource(): IDynamicDataSource | undefined;' + return: + type: + - IDynamicDataSource | undefined + description: '' + - uid: sp-component-base.DynamicProperty.tryGetValue + summary: Returns the value of the Dynamic Data object. Returns undefined if the source or the data doesn't exist. + isPreview: true + name: tryGetValue() + fullName: sp-component-base.DynamicProperty.tryGetValue + langs: + - typeScript + type: method + syntax: + content: 'tryGetValue(): TValue | undefined;' + return: + type: + - TValue | undefined + description: '' + - uid: sp-component-base.DynamicProperty.unregister + summary: >- + Unregisters a callback function for updates on the associated Dynamic Data Source. The callback function must be + the same it was registered with. + isPreview: true + name: unregister(callback) + fullName: sp-component-base.DynamicProperty.unregister + langs: + - typeScript + type: method + syntax: + content: 'unregister(callback: () => void): void;' + return: + type: + - void + description: '' + parameters: + - id: callback + description: Callback function to unregister. + type: + - () => void diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index 391869b3..f0d4d772 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -15,19 +15,19 @@ items: - sp-core-library.DisplayMode - sp-core-library.Environment - sp-core-library.EnvironmentType - - sp-core-library.Event - - sp-core-library.EventArgs - sp-core-library.Guid - sp-core-library.IDisposable - - sp-core-library.IEventObserver - sp-core-library.IRandomNumberGenerator - sp-core-library.IServiceCollection + - sp-core-library.ISPEventObserver - sp-core-library.ITimeProvider - sp-core-library.Log - sp-core-library.RandomNumberGenerator - sp-core-library.ServiceKey - sp-core-library.ServiceScope - sp-core-library.Session + - sp-core-library.SPEvent + - sp-core-library.SPEventArgs - sp-core-library.Text - sp-core-library.TimeProvider - sp-core-library.UrlQueryParameterCollection @@ -40,20 +40,16 @@ references: name: Environment - uid: sp-core-library.EnvironmentType name: EnvironmentType - - uid: sp-core-library.Event - name: Event - - uid: sp-core-library.EventArgs - name: EventArgs - uid: sp-core-library.Guid name: Guid - uid: sp-core-library.IDisposable name: IDisposable - - uid: sp-core-library.IEventObserver - name: IEventObserver - uid: sp-core-library.IRandomNumberGenerator name: IRandomNumberGenerator - uid: sp-core-library.IServiceCollection name: IServiceCollection + - uid: sp-core-library.ISPEventObserver + name: ISPEventObserver - uid: sp-core-library.ITimeProvider name: ITimeProvider - uid: sp-core-library.Log @@ -66,6 +62,10 @@ references: name: ServiceScope - uid: sp-core-library.Session name: Session + - uid: sp-core-library.SPEvent + name: SPEvent + - uid: sp-core-library.SPEventArgs + name: SPEventArgs - uid: sp-core-library.Text name: Text - uid: sp-core-library.TimeProvider diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index d329fb05..2b9ee831 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -18,7 +18,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly type: EnvironmentType;' + content: 'static readonly type: EnvironmentType;' return: type: - EnvironmentType diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index c827622f..d6aa340f 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -25,6 +25,7 @@ items: langs: - typeScript type: field + numericValue: '3' - uid: sp-core-library.EnvironmentType.Local summary: >- Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the @@ -36,6 +37,7 @@ items: langs: - typeScript type: field + numericValue: '1' - uid: sp-core-library.EnvironmentType.SharePoint summary: >- Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework @@ -45,6 +47,7 @@ items: langs: - typeScript type: field + numericValue: '2' - uid: sp-core-library.EnvironmentType.Test summary: >- Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user @@ -54,3 +57,4 @@ items: langs: - typeScript type: field + numericValue: '0' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index c90ac793..b308b4a7 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -31,7 +31,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly empty: Guid;' + content: 'static readonly empty: Guid;' return: type: - Guid @@ -43,7 +43,7 @@ items: - typeScript type: method syntax: - content: 'public equals(guid: Guid): boolean;' + content: 'equals(guid: Guid): boolean;' return: type: - boolean @@ -63,7 +63,7 @@ items: - typeScript type: method syntax: - content: 'public static isValid(guid: string | undefined | null): boolean;' + content: 'static isValid(guid: string | undefined | null): boolean;' return: type: - boolean @@ -83,7 +83,7 @@ items: - typeScript type: method syntax: - content: 'public static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' + content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' return: type: - Guid @@ -104,7 +104,7 @@ items: - typeScript type: method syntax: - content: 'public static parse(guidString: string | undefined | null): Guid;' + content: 'static parse(guidString: string | undefined | null): Guid;' return: type: - Guid @@ -127,7 +127,7 @@ items: - typeScript type: method syntax: - content: 'public static tryParse(guid: string | undefined | null): Guid | undefined;' + content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' return: type: - Guid | undefined diff --git a/SP-Framework/sp-core-library/ieventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml similarity index 64% rename from SP-Framework/sp-core-library/ieventobserver.yml rename to SP-Framework/sp-core-library/ispeventobserver.yml index f7091e00..d29dad34 100644 --- a/SP-Framework/sp-core-library/ieventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -1,48 +1,48 @@ -### YamlMime:UniversalReference -items: - - uid: sp-core-library.IEventObserver - summary: >- - Used with the [Event](xref:sp-core-library.Event) system, this interface is implemented by components that can - subscribe to events. - remarks: >- - IEventObserver is an abstraction of the key features that a component must have in order to subscribe to a - SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it - must have a way to notify the event system when the component is disposed, so that its handlers can be - automatically removed. Other objects may implement this contract, as long as they meet these requirements. - name: IEventObserver - fullName: sp-core-library.IEventObserver - langs: - - typeScript - type: interface - extends: - - IDisposable - package: sp-core-library - children: - - sp-core-library.IEventObserver.componentId - - sp-core-library.IEventObserver.instanceId - - uid: sp-core-library.IEventObserver.componentId - summary: 'The component identifier, from the component''s manifest.' - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - name: componentId - fullName: sp-core-library.IEventObserver.componentId - langs: - - typeScript - type: property - syntax: - content: 'readonly componentId: string;' - return: - type: - - string - - uid: sp-core-library.IEventObserver.instanceId - summary: The instance identifier for the component. - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - name: instanceId - fullName: sp-core-library.IEventObserver.instanceId - langs: - - typeScript - type: property - syntax: - content: 'readonly instanceId: string;' - return: - type: - - string +### YamlMime:UniversalReference +items: + - uid: sp-core-library.ISPEventObserver + summary: >- + Used with the [SPEvent](xref:sp-core-library.SPEvent) system, this interface is implemented by components that can + subscribe to events. + remarks: >- + ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a + SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it + must have a way to notify the event system when the component is disposed, so that its handlers can be + automatically removed. Other objects may implement this contract, as long as they meet these requirements. + name: ISPEventObserver + fullName: sp-core-library.ISPEventObserver + langs: + - typeScript + type: interface + extends: + - IDisposable + package: sp-core-library + children: + - sp-core-library.ISPEventObserver.componentId + - sp-core-library.ISPEventObserver.instanceId + - uid: sp-core-library.ISPEventObserver.componentId + summary: 'The component identifier, from the component''s manifest.' + remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + name: componentId + fullName: sp-core-library.ISPEventObserver.componentId + langs: + - typeScript + type: property + syntax: + content: 'readonly componentId: string;' + return: + type: + - string + - uid: sp-core-library.ISPEventObserver.instanceId + summary: The instance identifier for the component. + remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + name: instanceId + fullName: sp-core-library.ISPEventObserver.instanceId + langs: + - typeScript + type: property + syntax: + content: 'readonly instanceId: string;' + return: + type: + - string diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index 5eba0943..7356d389 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -26,7 +26,7 @@ items: - typeScript type: method syntax: - content: 'public static error(source: string, error: Error, scope?: ServiceScope): void;' + content: 'static error(source: string, error: Error, scope?: ServiceScope): void;' return: type: - void @@ -56,7 +56,7 @@ items: - typeScript type: method syntax: - content: 'public static info(source: string, message: string, scope?: ServiceScope): void;' + content: 'static info(source: string, message: string, scope?: ServiceScope): void;' return: type: - void @@ -86,7 +86,7 @@ items: - typeScript type: method syntax: - content: 'public static verbose(source: string, message: string, scope?: ServiceScope): void;' + content: 'static verbose(source: string, message: string, scope?: ServiceScope): void;' return: type: - void @@ -116,7 +116,7 @@ items: - typeScript type: method syntax: - content: 'public static warn(source: string, message: string, scope?: ServiceScope): void;' + content: 'static warn(source: string, message: string, scope?: ServiceScope): void;' return: type: - void diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index a6c87fbd..f6763572 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -38,7 +38,7 @@ items: - typeScript type: method syntax: - content: 'public generate(): number;' + content: 'generate(): number;' return: type: - number @@ -51,7 +51,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - ServiceKey diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 19717585..409f9fae 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -34,7 +34,10 @@ items: - typeScript type: method syntax: - content: "public static create < TKey >(name: string,\r\n serviceClass: { new (serviceScope: ServiceScope); }): ServiceKey;" + content: |- + static create(name: string, serviceClass: { + new (serviceScope: ServiceScope); + }): ServiceKey; return: type: - ServiceKey @@ -47,7 +50,10 @@ items: - id: serviceClass description: the TypeScript class that implements the service. type: - - '{ new (serviceScope: ServiceScope); }' + - |- + { + new (serviceScope: ServiceScope); + } - uid: sp-core-library.ServiceKey.createCustom summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. name: 'createCustom(name, defaultCreator)' @@ -56,7 +62,7 @@ items: - typeScript type: method syntax: - content: 'public static createCustom < TKey >(name: string, defaultCreator: ServiceCreator): ServiceKey;' + content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' return: type: - ServiceKey @@ -78,7 +84,7 @@ items: - typeScript type: property syntax: - content: 'public readonly defaultCreator: ServiceCreator;' + content: 'readonly defaultCreator: ServiceCreator;' return: type: - ServiceCreator @@ -91,7 +97,7 @@ items: - typeScript type: property syntax: - content: 'public readonly id: string;' + content: 'readonly id: string;' return: type: - string @@ -110,7 +116,7 @@ items: - typeScript type: property syntax: - content: 'public readonly name: string;' + content: 'readonly name: string;' return: type: - string diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 9af28b4a..988c5d19 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -51,6 +51,7 @@ items: type: class package: sp-core-library children: + - sp-core-library.ServiceScope.constructor - sp-core-library.ServiceScope.consume - sp-core-library.ServiceScope.createAndProvide - sp-core-library.ServiceScope.createDefaultAndProvide @@ -60,6 +61,20 @@ items: - sp-core-library.ServiceScope.startNewChild - sp-core-library.ServiceScope.startNewRoot - sp-core-library.ServiceScope.whenFinished + - uid: sp-core-library.ServiceScope.constructor + summary: 'Constructs a new instance of the [ServiceScope](xref:sp-core-library.ServiceScope) class' + name: constructor(parent) + fullName: sp-core-library.ServiceScope.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'protected constructor(parent: ServiceScope | undefined);' + parameters: + - id: parent + description: '' + type: + - ServiceScope | undefined - uid: sp-core-library.ServiceScope.consume summary: Consumes a service from the service scope. remarks: >- @@ -72,7 +87,7 @@ items: - typeScript type: method syntax: - content: 'public consume < T >(serviceKey: ServiceKey): T;' + content: 'consume(serviceKey: ServiceKey): T;' return: type: - T @@ -92,7 +107,10 @@ items: - typeScript type: method syntax: - content: "public createAndProvide < T >(serviceKey: ServiceKey,\r\n simpleServiceClass: { new (serviceScope: ServiceScope); }): T;" + content: |- + createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { + new (serviceScope: ServiceScope); + }): T; return: type: - T @@ -105,7 +123,10 @@ items: - id: simpleServiceClass description: the TypeScript class to be constructed type: - - '{ new (serviceScope: ServiceScope); }' + - |- + { + new (serviceScope: ServiceScope); + } - uid: sp-core-library.ServiceScope.createDefaultAndProvide summary: >- This is a shorthand function that constructs the default implementation of the specified serviceKey, and then @@ -116,7 +137,7 @@ items: - typeScript type: method syntax: - content: 'public createDefaultAndProvide < T >(serviceKey: ServiceKey): T;' + content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' return: type: - T @@ -144,7 +165,7 @@ items: - typeScript type: method syntax: - content: 'public finish(): void;' + content: 'finish(): void;' return: type: - void @@ -157,7 +178,7 @@ items: - typeScript type: method syntax: - content: 'public getParent(): ServiceScope | undefined;' + content: 'getParent(): ServiceScope | undefined;' return: type: - ServiceScope | undefined @@ -173,7 +194,7 @@ items: - typeScript type: method syntax: - content: 'public provide < T >(serviceKey: ServiceKey, service: T): T;' + content: 'provide(serviceKey: ServiceKey, service: T): T;' return: type: - T @@ -198,7 +219,7 @@ items: - typeScript type: method syntax: - content: 'public startNewChild(): ServiceScope;' + content: 'startNewChild(): ServiceScope;' return: type: - ServiceScope @@ -213,7 +234,7 @@ items: - typeScript type: method syntax: - content: 'public static startNewRoot(): ServiceScope;' + content: 'static startNewRoot(): ServiceScope;' return: type: - ServiceScope @@ -236,7 +257,7 @@ items: - typeScript type: method syntax: - content: 'public whenFinished(callback: () => void): void;' + content: 'whenFinished(callback: () => void): void;' return: type: - void diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index f10605ec..845d131d 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -25,7 +25,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly applicationId: Guid;' + content: 'static readonly applicationId: Guid;' return: type: - Guid @@ -51,7 +51,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly pageId: Guid;' + content: 'static readonly pageId: Guid;' return: type: - Guid diff --git a/SP-Framework/sp-core-library/event.yml b/SP-Framework/sp-core-library/spevent.yml similarity index 63% rename from SP-Framework/sp-core-library/event.yml rename to SP-Framework/sp-core-library/spevent.yml index fc5346f3..86568d6e 100644 --- a/SP-Framework/sp-core-library/event.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -1,85 +1,85 @@ -### YamlMime:UniversalReference -items: - - uid: sp-core-library.Event - summary: Represents a framework event that components can subscribe to. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the Event class. - - - Examples of events in a web application might include: the user clicking a button, the system navigating to - another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents - events using instances of the Event object, one for each kind of event. The Event object is typically exposed as a - property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, - it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler - receives an EventArgs parameter that may provide additional details about what happened. This is analogous to the - browser's Document Object Model (DOM) events. The main difference is the IEventObserver feature, which tracks - which component subscribed to each event, and automatically unsubscribes the handler when the component is - disposed. - - - When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is - unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught - exception will not prevent other handlers from executing, but it will be reported as a problem with the associated - component. - name: Event - fullName: sp-core-library.Event - langs: - - typeScript - type: class - package: sp-core-library - children: - - sp-core-library.Event.add - - sp-core-library.Event.remove - - uid: sp-core-library.Event.add - summary: Registers a callback that will be invoked whenever the event occurs. - remarks: >- - The same object can add multiple event handlers to the same event. Since BaseComponent implements the - IEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event - handler to be automatically unsubscribed when the web part or extension is disposed. - name: 'add(observer, eventHandler)' - fullName: sp-core-library.Event.add - langs: - - typeScript - type: method - syntax: - content: 'public add(observer: IEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' - return: - type: - - void - description: '' - parameters: - - id: observer - description: >- - Indicates the object that is subscribing to the event: When the object is disposed, the event handler will - be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event - handler failed to catch an exception. - type: - - IEventObserver - - id: eventHandler - description: A callback function that will be invoked whenever the event occurs - type: - - '(eventArgs: TEventArgs) => void' - - uid: sp-core-library.Event.remove - summary: Unregisters a callback that was registered using add(). - remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - name: 'remove(observer, eventHandler)' - fullName: sp-core-library.Event.remove - langs: - - typeScript - type: method - syntax: - content: 'public remove(observer: IEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' - return: - type: - - void - description: '' - parameters: - - id: observer - description: This must be the same observer that was passed to the add() function. - type: - - IEventObserver - - id: eventHandler - description: The event handler to remove; this must be the same object instance that was passed to the add() function. - type: - - '(eventArgs: TEventArgs) => void' +### YamlMime:UniversalReference +items: + - uid: sp-core-library.SPEvent + summary: Represents a framework event that components can subscribe to. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the SPEvent class. + + + Examples of events in a web application might include: the user clicking a button, the system navigating to + another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents + events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed + as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an + event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The + handler receives an SPEventArgs parameter that may provide additional details about what happened. This is + analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver + feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when + the component is disposed. + + + When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is + unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught + exception will not prevent other handlers from executing, but it will be reported as a problem with the associated + component. + name: SPEvent + fullName: sp-core-library.SPEvent + langs: + - typeScript + type: class + package: sp-core-library + children: + - sp-core-library.SPEvent.add + - sp-core-library.SPEvent.remove + - uid: sp-core-library.SPEvent.add + summary: Registers a callback that will be invoked whenever the event occurs. + remarks: >- + The same object can add multiple event handlers to the same event. Since BaseComponent implements the + ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event + handler to be automatically unsubscribed when the web part or extension is disposed. + name: 'add(observer, eventHandler)' + fullName: sp-core-library.SPEvent.add + langs: + - typeScript + type: method + syntax: + content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + return: + type: + - void + description: '' + parameters: + - id: observer + description: >- + Indicates the object that is subscribing to the event: When the object is disposed, the event handler will + be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event + handler failed to catch an exception. + type: + - ISPEventObserver + - id: eventHandler + description: A callback function that will be invoked whenever the event occurs + type: + - '(eventArgs: TEventArgs) => void' + - uid: sp-core-library.SPEvent.remove + summary: Unregisters a callback that was registered using add(). + remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' + name: 'remove(observer, eventHandler)' + fullName: sp-core-library.SPEvent.remove + langs: + - typeScript + type: method + syntax: + content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + return: + type: + - void + description: '' + parameters: + - id: observer + description: This must be the same observer that was passed to the add() function. + type: + - ISPEventObserver + - id: eventHandler + description: The event handler to remove; this must be the same object instance that was passed to the add() function. + type: + - '(eventArgs: TEventArgs) => void' diff --git a/SP-Framework/sp-core-library/eventargs.yml b/SP-Framework/sp-core-library/speventargs.yml similarity index 54% rename from SP-Framework/sp-core-library/eventargs.yml rename to SP-Framework/sp-core-library/speventargs.yml index dcac4325..5894316d 100644 --- a/SP-Framework/sp-core-library/eventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -1,11 +1,11 @@ -### YamlMime:UniversalReference -items: - - uid: sp-core-library.EventArgs - summary: 'The base class for event arguments used with the [Event](xref:sp-core-library.Event) class.' - remarks: 'If certain event types need to provide additional details, they will define a subclass of EventArgs.' - name: EventArgs - fullName: sp-core-library.EventArgs - langs: - - typeScript - type: class - package: sp-core-library +### YamlMime:UniversalReference +items: + - uid: sp-core-library.SPEventArgs + summary: 'The base class for event arguments used with the [SPEvent](xref:sp-core-library.SPEvent) class.' + remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' + name: SPEventArgs + fullName: sp-core-library.SPEventArgs + langs: + - typeScript + type: class + package: sp-core-library diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index dbc2fa1b..06256ed6 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -29,7 +29,7 @@ items: - typeScript type: method syntax: - content: 'public static format(s: string, ...values: any[]): string;' + content: 'static format(s: string, ...values: any[]): string;' return: type: - string diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index be440ce1..91016174 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -39,7 +39,7 @@ items: - typeScript type: method syntax: - content: 'public getDate(): Date;' + content: 'getDate(): Date;' return: type: - Date @@ -52,7 +52,7 @@ items: - typeScript type: method syntax: - content: 'public getTimestamp(): number;' + content: 'getTimestamp(): number;' return: type: - number @@ -65,7 +65,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - ServiceKey diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index e3445ace..c8489f22 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -58,7 +58,7 @@ items: - typeScript type: method syntax: - content: 'public getValue(param: string): string | undefined;' + content: 'getValue(param: string): string | undefined;' return: type: - string | undefined @@ -82,7 +82,7 @@ items: - typeScript type: method syntax: - content: 'public getValues(param: string): (string | undefined)[] | undefined;' + content: 'getValues(param: string): (string | undefined)[] | undefined;' return: type: - '(string | undefined)[] | undefined' diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 013e82c6..6d636198 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -14,6 +14,7 @@ items: package: sp-core-library children: - sp-core-library.Validate.isNonemptyString + - sp-core-library.Validate.isNotDisposed - sp-core-library.Validate.isNotNullOrUndefined - sp-core-library.Validate.isTrue - uid: sp-core-library.Validate.isNonemptyString @@ -24,7 +25,7 @@ items: - typeScript type: method syntax: - content: 'public static isNonemptyString(value: string | undefined | null, variableName: string): void;' + content: 'static isNonemptyString(value: string | undefined | null, variableName: string): void;' return: type: - void @@ -38,6 +39,28 @@ items: description: 'the program variable name, which will be mentioned in the error message' type: - string + - uid: sp-core-library.Validate.isNotDisposed + summary: Throws an exception if the specified object has been disposed. + name: 'isNotDisposed(value, className)' + fullName: sp-core-library.Validate.isNotDisposed + langs: + - typeScript + type: method + syntax: + content: 'static isNotDisposed(value: IDisposable, className: string): void;' + return: + type: + - void + description: '' + parameters: + - id: value + description: the value to check + type: + - IDisposable + - id: className + description: 'the class name, which will be mentioned in the error message' + type: + - string - uid: sp-core-library.Validate.isNotNullOrUndefined summary: Throws an exception if the specified value is null or undefined. name: 'isNotNullOrUndefined(value, variableName)' @@ -46,7 +69,7 @@ items: - typeScript type: method syntax: - content: 'public static isNotNullOrUndefined(value: any, variableName: string): void;' + content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' return: type: - void @@ -68,7 +91,7 @@ items: - typeScript type: method syntax: - content: 'public static isTrue(value: boolean | undefined | null, variableName: string): void;' + content: 'static isTrue(value: boolean | undefined | null, variableName: string): void;' return: type: - void diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 1dd4dbb2..bf1a2990 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -36,7 +36,7 @@ items: - typeScript type: method syntax: - content: 'public static compare(v1: Version, v2: Version): number;' + content: 'static compare(v1: Version, v2: Version): number;' return: type: - number @@ -66,7 +66,7 @@ items: - typeScript type: method syntax: - content: 'public equals(compareWith: Version): boolean;' + content: 'equals(compareWith: Version): boolean;' return: type: - boolean @@ -88,7 +88,7 @@ items: - typeScript type: method syntax: - content: 'public greaterThan(compareWith: Version): boolean;' + content: 'greaterThan(compareWith: Version): boolean;' return: type: - boolean @@ -106,7 +106,7 @@ items: - typeScript type: method syntax: - content: 'public static isValid(versionString: string | undefined | null): boolean;' + content: 'static isValid(versionString: string | undefined | null): boolean;' return: type: - boolean @@ -130,7 +130,7 @@ items: - typeScript type: method syntax: - content: 'public lessThan(compareWith: Version): boolean;' + content: 'lessThan(compareWith: Version): boolean;' return: type: - boolean @@ -149,7 +149,7 @@ items: - typeScript type: property syntax: - content: 'public readonly major: number;' + content: 'readonly major: number;' return: type: - number @@ -164,7 +164,7 @@ items: - typeScript type: property syntax: - content: 'public readonly minor: number;' + content: 'readonly minor: number;' return: type: - number @@ -176,7 +176,7 @@ items: - typeScript type: method syntax: - content: 'public static parse(versionString: string | undefined | null): Version;' + content: 'static parse(versionString: string | undefined | null): Version;' return: type: - Version @@ -197,7 +197,7 @@ items: - typeScript type: property syntax: - content: 'public readonly patch: number | undefined;' + content: 'readonly patch: number | undefined;' return: type: - number | undefined @@ -212,7 +212,7 @@ items: - typeScript type: property syntax: - content: 'public readonly revision: number | undefined;' + content: 'readonly revision: number | undefined;' return: type: - number | undefined @@ -236,7 +236,7 @@ items: - typeScript type: method syntax: - content: 'public satisfies(compareWith: Version): boolean;' + content: 'satisfies(compareWith: Version): boolean;' return: type: - boolean @@ -256,7 +256,7 @@ items: - typeScript type: method syntax: - content: 'public static tryParse(versionString: string | undefined | null): Version | undefined;' + content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' return: type: - Version | undefined diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 86e1e7db..0a90a0b4 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -71,7 +71,7 @@ items: - typeScript type: method syntax: - content: 'public close(): Promise;' + content: 'close(): Promise;' return: type: - Promise @@ -104,7 +104,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isHidden: boolean;' + content: 'readonly isHidden: boolean;' return: type: - boolean @@ -119,7 +119,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isOpen: boolean;' + content: 'readonly isOpen: boolean;' return: type: - boolean @@ -132,7 +132,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isSecondary: boolean;' + content: 'readonly isSecondary: boolean;' return: type: - boolean @@ -150,7 +150,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onAfterClose(): void;' + content: 'protected onAfterClose(): void;' return: type: - void @@ -167,7 +167,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onBeforeOpen(): Promise;' + content: 'protected onBeforeOpen(): Promise;' return: type: - Promise @@ -213,7 +213,7 @@ items: - typeScript type: property syntax: - content: 'public readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;' + content: 'readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;' return: type: - SecondaryDialogProvider | undefined @@ -226,7 +226,7 @@ items: - typeScript type: method syntax: - content: 'public show(options?: IDialogShowOptions): Promise;' + content: 'show(options?: IDialogShowOptions): Promise;' return: type: - Promise diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index a789e3c3..1c8d2888 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -27,7 +27,7 @@ items: - typeScript type: method syntax: - content: 'public static alert(message: string, options?: IAlertOptions): Promise;' + content: 'static alert(message: string, options?: IAlertOptions): Promise;' return: type: - Promise @@ -56,7 +56,7 @@ items: - typeScript type: method syntax: - content: 'public static prompt(message: string, options?: IPromptOptions): Promise;' + content: 'static prompt(message: string, options?: IPromptOptions): Promise;' return: type: - Promise diff --git a/SP-Framework/sp-dialog/secondarydialogprovider.yml b/SP-Framework/sp-dialog/secondarydialogprovider.yml index e44e63e7..154ed044 100644 --- a/SP-Framework/sp-dialog/secondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/secondarydialogprovider.yml @@ -34,7 +34,7 @@ items: - typeScript type: method syntax: - content: 'public alert(message: string, options?: IAlertOptions): Promise;' + content: 'alert(message: string, options?: IAlertOptions): Promise;' return: type: - Promise @@ -59,7 +59,7 @@ items: - typeScript type: method syntax: - content: 'public prompt(message: string, options?: IPromptOptions): Promise;' + content: 'prompt(message: string, options?: IPromptOptions): Promise;' return: type: - Promise @@ -86,7 +86,7 @@ items: - typeScript type: method syntax: - content: 'public show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' + content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' return: type: - Promise diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml new file mode 100644 index 00000000..7fd97e7a --- /dev/null +++ b/SP-Framework/sp-dynamic-data.yml @@ -0,0 +1,29 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data + summary: SharePoint Framework support for dynamic data bindings. + remarks: >- + This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and + implement components that use it. + name: '@microsoft/sp-dynamic-data' + fullName: sp-dynamic-data + langs: + - typeScript + type: package + children: + - sp-dynamic-data.DynamicDataReference + - sp-dynamic-data.IDynamicDataController + - sp-dynamic-data.IDynamicDataPropertyDefinition + - sp-dynamic-data.IDynamicDataSource + - sp-dynamic-data.IDynamicDataSourceMetadata +references: + - uid: sp-dynamic-data.DynamicDataReference + name: DynamicDataReference + - uid: sp-dynamic-data.IDynamicDataController + name: IDynamicDataController + - uid: sp-dynamic-data.IDynamicDataPropertyDefinition + name: IDynamicDataPropertyDefinition + - uid: sp-dynamic-data.IDynamicDataSource + name: IDynamicDataSource + - uid: sp-dynamic-data.IDynamicDataSourceMetadata + name: IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml new file mode 100644 index 00000000..580a8d07 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -0,0 +1,93 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.DynamicDataReference + summary: >- + Class that contains the Dynamic Data reference. This includes the source, property, and property path (if + applicable) of Dynamic Data + + + The reference string is of the form <sourceId>:<property> or + <sourceId>:<property>:<propertyPath> + + + Examples of references are: PageContext:user + WebPart.<componentId>.<instanceId>:myComplexProperty:myArray\[0\].lastName + isPreview: true + name: DynamicDataReference + fullName: sp-dynamic-data.DynamicDataReference + langs: + - typeScript + type: class + package: sp-dynamic-data + children: + - sp-dynamic-data.DynamicDataReference.constructor + - sp-dynamic-data.DynamicDataReference.property + - sp-dynamic-data.DynamicDataReference.propertyPath + - sp-dynamic-data.DynamicDataReference.reference + - sp-dynamic-data.DynamicDataReference.sourceId + - uid: sp-dynamic-data.DynamicDataReference.constructor + summary: 'Constructs a new instance of the [DynamicDataReference](xref:sp-dynamic-data.DynamicDataReference) class' + name: constructor(reference) + fullName: sp-dynamic-data.DynamicDataReference.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(reference: string);' + parameters: + - id: reference + description: '' + type: + - string + - uid: sp-dynamic-data.DynamicDataReference.property + summary: Returns the referred property of the Dynamic Data. + isPreview: true + name: property + fullName: sp-dynamic-data.DynamicDataReference.property + langs: + - typeScript + type: property + syntax: + content: 'readonly property: string;' + return: + type: + - string + - uid: sp-dynamic-data.DynamicDataReference.propertyPath + summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. + isPreview: true + name: propertyPath + fullName: sp-dynamic-data.DynamicDataReference.propertyPath + langs: + - typeScript + type: property + syntax: + content: 'readonly propertyPath: string | undefined;' + return: + type: + - string | undefined + - uid: sp-dynamic-data.DynamicDataReference.reference + summary: Returns the full reference of the Dynamic Data object as a string. + isPreview: true + name: reference + fullName: sp-dynamic-data.DynamicDataReference.reference + langs: + - typeScript + type: property + syntax: + content: 'readonly reference: string;' + return: + type: + - string + - uid: sp-dynamic-data.DynamicDataReference.sourceId + summary: Returns the referred id of the Dynamic Data Source. + isPreview: true + name: sourceId + fullName: sp-dynamic-data.DynamicDataReference.sourceId + langs: + - typeScript + type: property + syntax: + content: 'readonly sourceId: string;' + return: + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml b/SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml new file mode 100644 index 00000000..61160798 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml @@ -0,0 +1,53 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataController + summary: >- + Interface for components to implement in order to be dynamic data sources. This can be implemented as an object + with state, or a set of loose functions that returns the data. + isPreview: true + name: IDynamicDataController + fullName: sp-dynamic-data.IDynamicDataController + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataController.getPropertyDefinitions + - sp-dynamic-data.IDynamicDataController.getPropertyValue + - uid: sp-dynamic-data.IDynamicDataController.getPropertyDefinitions + summary: >- + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. + isPreview: true + name: getPropertyDefinitions() + fullName: sp-dynamic-data.IDynamicDataController.getPropertyDefinitions + langs: + - typeScript + type: method + syntax: + content: 'getPropertyDefinitions(): ReadonlyArray;' + return: + type: + - ReadonlyArray + description: '' + - uid: sp-dynamic-data.IDynamicDataController.getPropertyValue + summary: >- + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. + isPreview: true + name: getPropertyValue(propertyId) + fullName: sp-dynamic-data.IDynamicDataController.getPropertyValue + langs: + - typeScript + type: method + syntax: + content: 'getPropertyValue(propertyId: string): any;' + return: + type: + - any + description: '' + parameters: + - id: propertyId + description: '' + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml new file mode 100644 index 00000000..5b0df465 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -0,0 +1,61 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataPropertyDefinition + summary: >- + Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, + localized title and description to be seen and used by end users. + isPreview: true + name: IDynamicDataPropertyDefinition + fullName: sp-dynamic-data.IDynamicDataPropertyDefinition + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataPropertyDefinition.description + - sp-dynamic-data.IDynamicDataPropertyDefinition.id + - sp-dynamic-data.IDynamicDataPropertyDefinition.title + - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.description + summary: >- + User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the + current user" + isPreview: true + name: description + fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.id + summary: 'Id of the property. This can only contains letters, numbers, dashes and underscores.' + remarks: 'The regular expression used to validate the constraints is /^\[a-zA-Z0-9\\-\_\]+$/ Example: "myFiles"' + isPreview: true + name: id + fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.id + langs: + - typeScript + type: property + syntax: + content: 'id: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.title + summary: >- + User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current + language) + isPreview: true + name: title + fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.title + langs: + - typeScript + type: property + syntax: + content: 'title: string;' + return: + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml new file mode 100644 index 00000000..59e3f83e --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -0,0 +1,85 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataSource + summary: >- + Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API + to get the data. + isPreview: true + name: IDynamicDataSource + fullName: sp-dynamic-data.IDynamicDataSource + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions + - sp-dynamic-data.IDynamicDataSource.getPropertyValue + - sp-dynamic-data.IDynamicDataSource.id + - sp-dynamic-data.IDynamicDataSource.metadata + - uid: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions + summary: Returns the definitions for all the properties exposed by the source. + isPreview: true + name: getPropertyDefinitions() + fullName: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions + langs: + - typeScript + type: method + syntax: + content: 'getPropertyDefinitions(): ReadonlyArray;' + return: + type: + - ReadonlyArray + description: '' + - uid: sp-dynamic-data.IDynamicDataSource.getPropertyValue + summary: >- + For a given property id, returns the value of the property. Throws an error if the property id doesn't exist in + the source. + remarks: >- + It returns a read-only copy of the property value, so modifying its value will not impact on the value in the data + source. + + + Property values are JSON-serializable objects, so there are no functions that can be called inside. + isPreview: true + name: getPropertyValue(propertyId) + fullName: sp-dynamic-data.IDynamicDataSource.getPropertyValue + langs: + - typeScript + type: method + syntax: + content: 'getPropertyValue(propertyId: string): any;' + return: + type: + - any + description: '' + parameters: + - id: propertyId + description: '' + type: + - string + - uid: sp-dynamic-data.IDynamicDataSource.id + summary: Id of the Dynamic Data Source. + isPreview: true + name: id + fullName: sp-dynamic-data.IDynamicDataSource.id + langs: + - typeScript + type: property + syntax: + content: 'id: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataSource.metadata + summary: Metadata of the Dynamic Data Source. + isPreview: true + name: metadata + fullName: sp-dynamic-data.IDynamicDataSource.metadata + langs: + - typeScript + type: property + syntax: + content: 'metadata: IDynamicDataSourceMetadata;' + return: + type: + - IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml new file mode 100644 index 00000000..3daa0d10 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -0,0 +1,91 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataSourceMetadata + summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. + isPreview: true + name: IDynamicDataSourceMetadata + fullName: sp-dynamic-data.IDynamicDataSourceMetadata + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataSourceMetadata.alias + - sp-dynamic-data.IDynamicDataSourceMetadata.componentId + - sp-dynamic-data.IDynamicDataSourceMetadata.description + - sp-dynamic-data.IDynamicDataSourceMetadata.instanceId + - sp-dynamic-data.IDynamicDataSourceMetadata.title + - uid: sp-dynamic-data.IDynamicDataSourceMetadata.alias + summary: >- + Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come + from a component, for example framework level data sources. + isPreview: true + name: alias + fullName: sp-dynamic-data.IDynamicDataSourceMetadata.alias + langs: + - typeScript + type: property + syntax: + content: 'alias?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataSourceMetadata.componentId + summary: >- + Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from + a component, for example framework level data sources. + isPreview: true + name: componentId + fullName: sp-dynamic-data.IDynamicDataSourceMetadata.componentId + langs: + - typeScript + type: property + syntax: + content: 'componentId?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataSourceMetadata.description + summary: 'User-friendly, localized description of the Dynamic Data Source.' + isPreview: true + name: description + fullName: sp-dynamic-data.IDynamicDataSourceMetadata.description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataSourceMetadata.instanceId + summary: >- + Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for + example, between two web parts with the same type. It can be undefined when the sources doesn't come from a + component, for example framework level data sources. + isPreview: true + name: instanceId + fullName: sp-dynamic-data.IDynamicDataSourceMetadata.instanceId + langs: + - typeScript + type: property + syntax: + content: 'instanceId?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataSourceMetadata.title + summary: >- + User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. + By default it's the alias of the component. + isPreview: true + name: title + fullName: sp-dynamic-data.IDynamicDataSourceMetadata.title + langs: + - typeScript + type: property + syntax: + content: 'title: string;' + return: + type: + - string diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 9f2c491d..e35e4b7d 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -41,7 +41,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onInit(): Promise;' + content: 'protected onInit(): Promise;' return: type: - Promise diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index c4b6b0d7..5f464632 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -13,43 +13,3 @@ items: extends: - BaseComponentContext package: sp-extension-base - children: - - sp-extension-base.ExtensionContext.graphHttpClient - - sp-extension-base.ExtensionContext.httpClient - - sp-extension-base.ExtensionContext.spHttpClient - - uid: sp-extension-base.ExtensionContext.graphHttpClient - summary: The instance of GraphHttpClient created for this instance of extension - name: graphHttpClient - fullName: sp-extension-base.ExtensionContext.graphHttpClient - langs: - - typeScript - type: property - syntax: - content: 'public readonly graphHttpClient: GraphHttpClient;' - return: - type: - - GraphHttpClient - - uid: sp-extension-base.ExtensionContext.httpClient - summary: The instance of HttpClient created for this instance of extension - name: httpClient - fullName: sp-extension-base.ExtensionContext.httpClient - langs: - - typeScript - type: property - syntax: - content: 'public readonly httpClient: HttpClient;' - return: - type: - - HttpClient - - uid: sp-extension-base.ExtensionContext.spHttpClient - summary: The instance of SpHttpClient created for this instance of extension - name: spHttpClient - fullName: sp-extension-base.ExtensionContext.spHttpClient - langs: - - typeScript - type: property - syntax: - content: 'public readonly spHttpClient: SPHttpClient;' - return: - type: - - SPHttpClient diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index cc7713be..2061dcd8 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -12,12 +12,20 @@ items: - typeScript type: package children: + - sp-http.AadHttpClient + - sp-http.AadHttpClientConfiguration + - sp-http.AadHttpClientFactory + - sp-http.AadTokenProvider + - sp-http.AadTokenProviderFactory - sp-http.GraphHttpClient - sp-http.GraphHttpClientConfiguration - sp-http.GraphHttpClientResponse - sp-http.HttpClient - sp-http.HttpClientConfiguration - sp-http.HttpClientResponse + - sp-http.IAadHttpClientConfiguration + - sp-http.IAadHttpClientConfigurations + - sp-http.IAadTokenProviderConfiguration - sp-http.IGraphHttpClientConfiguration - sp-http.IGraphHttpClientConfigurations - sp-http.IGraphHttpClientOptions @@ -40,7 +48,18 @@ items: - sp-http.SPHttpClientConfiguration - sp-http.SPHttpClientResponse - sp-http.SPHttpHeader + - sp-http.TokenAcquisitionEventArgs references: + - uid: sp-http.AadHttpClient + name: AadHttpClient + - uid: sp-http.AadHttpClientConfiguration + name: AadHttpClientConfiguration + - uid: sp-http.AadHttpClientFactory + name: AadHttpClientFactory + - uid: sp-http.AadTokenProvider + name: AadTokenProvider + - uid: sp-http.AadTokenProviderFactory + name: AadTokenProviderFactory - uid: sp-http.GraphHttpClient name: GraphHttpClient - uid: sp-http.GraphHttpClientConfiguration @@ -53,6 +72,12 @@ references: name: HttpClientConfiguration - uid: sp-http.HttpClientResponse name: HttpClientResponse + - uid: sp-http.IAadHttpClientConfiguration + name: IAadHttpClientConfiguration + - uid: sp-http.IAadHttpClientConfigurations + name: IAadHttpClientConfigurations + - uid: sp-http.IAadTokenProviderConfiguration + name: IAadTokenProviderConfiguration - uid: sp-http.IGraphHttpClientConfiguration name: IGraphHttpClientConfiguration - uid: sp-http.IGraphHttpClientConfigurations @@ -97,3 +122,5 @@ references: name: SPHttpClientResponse - uid: sp-http.SPHttpHeader name: SPHttpHeader + - uid: sp-http.TokenAcquisitionEventArgs + name: TokenAcquisitionEventArgs diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml new file mode 100644 index 00000000..0873c2d1 --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -0,0 +1,136 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.AadHttpClient + summary: AadHttpClient is used to perform REST calls against an Azure AD Application. + remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the AadHttpClient class. + + + For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For + communicating with Microsoft Graph, use the [GraphHttpClient](xref:sp-http.GraphHttpClient) class. + isPreview: true + name: AadHttpClient + fullName: sp-http.AadHttpClient + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.AadHttpClient.configurations + - sp-http.AadHttpClient.fetch + - sp-http.AadHttpClient.get + - sp-http.AadHttpClient.post + - uid: sp-http.AadHttpClient.configurations + summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. + isPreview: true + name: configurations + fullName: sp-http.AadHttpClient.configurations + langs: + - typeScript + type: property + syntax: + content: 'static readonly configurations: IAadHttpClientConfigurations;' + return: + type: + - IAadHttpClientConfigurations + - uid: sp-http.AadHttpClient.fetch + summary: Performs a REST service call. + remarks: >- + Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for + HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: + https://fetch.spec.whatwg.org/ + isPreview: true + name: 'fetch(url, configuration, options)' + fullName: sp-http.AadHttpClient.fetch + langs: + - typeScript + type: method + syntax: + content: >- + fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): + Promise; + return: + type: + - Promise + description: a promise that will return the result + parameters: + - id: url + description: the URL to fetch + type: + - string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations + type: + - AadHttpClientConfiguration + - id: options + description: additional options that affect the request + type: + - IHttpClientOptions + - uid: sp-http.AadHttpClient.get + summary: 'Calls fetch(), but sets the method to "GET".' + isPreview: true + name: 'get(url, configuration, options)' + fullName: sp-http.AadHttpClient.get + langs: + - typeScript + type: method + syntax: + content: >- + get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): + Promise; + return: + type: + - Promise + description: a promise that will return the result + parameters: + - id: url + description: the URL to fetch + type: + - string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations + type: + - AadHttpClientConfiguration + - id: options + description: additional options that affect the request + type: + - IHttpClientOptions + - uid: sp-http.AadHttpClient.post + summary: 'Calls fetch(), but sets the method to "POST".' + isPreview: true + name: 'post(url, configuration, options)' + fullName: sp-http.AadHttpClient.post + langs: + - typeScript + type: method + syntax: + content: >- + post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): + Promise; + return: + type: + - Promise + description: a promise that will return the result + parameters: + - id: url + description: the URL to fetch + type: + - string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations + type: + - AadHttpClientConfiguration + - id: options + description: additional options that affect the request + type: + - IHttpClientOptions diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml new file mode 100644 index 00000000..44bf3289 --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -0,0 +1,73 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.AadHttpClientConfiguration + summary: Configuration for HttpClient. + remarks: >- + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. + name: AadHttpClientConfiguration + fullName: sp-http.AadHttpClientConfiguration + langs: + - typeScript + type: class + extends: + - HttpClientConfiguration + implements: + - IAadHttpClientConfiguration + package: sp-http + children: + - sp-http.AadHttpClientConfiguration.constructor + - sp-http.AadHttpClientConfiguration.flags + - sp-http.AadHttpClientConfiguration.overrideWith + - uid: sp-http.AadHttpClientConfiguration.constructor + summary: >- + Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for + any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. + name: 'constructor(flags, overrideFlags)' + fullName: sp-http.AadHttpClientConfiguration.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' + parameters: + - id: flags + description: '' + type: + - IAadHttpClientConfiguration + - id: overrideFlags + description: '' + type: + - IAadHttpClientConfiguration + - uid: sp-http.AadHttpClientConfiguration.flags + name: flags + fullName: sp-http.AadHttpClientConfiguration.flags + langs: + - typeScript + type: property + syntax: + content: 'protected flags: IAadHttpClientConfiguration;' + return: + type: + - IAadHttpClientConfiguration + - uid: sp-http.AadHttpClientConfiguration.overrideWith + name: overrideWith(sourceFlags) + fullName: sp-http.AadHttpClientConfiguration.overrideWith + langs: + - typeScript + type: method + syntax: + content: |- + /** @override */ + overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; + return: + type: + - AadHttpClientConfiguration + description: '' + parameters: + - id: sourceFlags + description: '' + type: + - IAadHttpClientConfiguration diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml new file mode 100644 index 00000000..33cd78ba --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -0,0 +1,61 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.AadHttpClientFactory + summary: >- + The will return a preinitialized version of the AadHttpClient for a given resource url. See more -> + https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the AadHttpClientFactory class. + isPreview: true + name: AadHttpClientFactory + fullName: sp-http.AadHttpClientFactory + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.AadHttpClientFactory.getExtendedClient + - sp-http.AadHttpClientFactory.getStandardClient + - uid: sp-http.AadHttpClientFactory.getExtendedClient + summary: >- + Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service + Principal. + isPreview: true + name: getExtendedClient(resourceEndpoint) + fullName: sp-http.AadHttpClientFactory.getExtendedClient + langs: + - typeScript + type: method + syntax: + content: 'getExtendedClient(resourceEndpoint: string): AadHttpClient | undefined;' + return: + type: + - AadHttpClient | undefined + description: '' + parameters: + - id: resourceEndpoint + description: The target AAD application's resource endpoint. + type: + - string + - uid: sp-http.AadHttpClientFactory.getStandardClient + summary: >- + Returns an instance of the AadHttpClient that communicates with the preconfigured SharePoint Online Web Service + Principal. + isPreview: true + name: getStandardClient(resourceEndpoint) + fullName: sp-http.AadHttpClientFactory.getStandardClient + langs: + - typeScript + type: method + syntax: + content: 'getStandardClient(resourceEndpoint: string): AadHttpClient | undefined;' + return: + type: + - AadHttpClient | undefined + description: '' + parameters: + - id: resourceEndpoint + description: The target AAD application's resource endpoint. + type: + - string diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml new file mode 100644 index 00000000..766128bb --- /dev/null +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -0,0 +1,82 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.AadTokenProvider + summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. + + + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. + remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some + point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will + switch to MSAL. + isPreview: true + name: AadTokenProvider + fullName: sp-http.AadTokenProvider + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.AadTokenProvider.constructor + - sp-http.AadTokenProvider.getToken + - sp-http.AadTokenProvider.tokenAcquisitionEvent + - uid: sp-http.AadTokenProvider.constructor + summary: 'Constructs a new instance of the [AadTokenProvider](xref:sp-http.AadTokenProvider) class' + name: constructor(configuration) + fullName: sp-http.AadTokenProvider.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(configuration: IAadTokenProviderConfiguration);' + parameters: + - id: configuration + description: '' + type: + - IAadTokenProviderConfiguration + - uid: sp-http.AadTokenProvider.getToken + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + + The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. + + An example of a resourceEndpoint would be https://sdfpilot.outlook.com + isPreview: true + name: 'getToken(resourceEndpoint, configuration)' + fullName: sp-http.AadTokenProvider.getToken + langs: + - typeScript + type: method + syntax: + content: 'getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;' + return: + type: + - Promise + description: A promise that will be fullfiled with the token or that will reject with an error message + parameters: + - id: resourceEndpoint + description: the resource for which the token should be obtained + type: + - string + - id: configuration + description: '' + type: + - IAadTokenProviderConfiguration + - uid: sp-http.AadTokenProvider.tokenAcquisitionEvent + summary: Notifies the developer when Token Acquistion requires user action. + isPreview: true + name: tokenAcquisitionEvent + fullName: sp-http.AadTokenProvider.tokenAcquisitionEvent + langs: + - typeScript + type: property + syntax: + content: 'readonly tokenAcquisitionEvent: SPEvent;' + return: + type: + - SPEvent diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml new file mode 100644 index 00000000..b3ae577d --- /dev/null +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -0,0 +1,29 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.AadTokenProviderFactory + summary: The will return a preinitialized version of the AadTokenProviderFactory. + isPreview: true + name: AadTokenProviderFactory + fullName: sp-http.AadTokenProviderFactory + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.AadTokenProviderFactory.getExtendedProvider + - uid: sp-http.AadTokenProviderFactory.getExtendedProvider + summary: >- + Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service + Principal. + isPreview: true + name: getExtendedProvider() + fullName: sp-http.AadTokenProviderFactory.getExtendedProvider + langs: + - typeScript + type: method + syntax: + content: 'getExtendedProvider(): AadTokenProvider | undefined;' + return: + type: + - AadTokenProvider | undefined + description: '' diff --git a/SP-Framework/sp-http/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml index 94953c78..d94ed36a 100644 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ b/SP-Framework/sp-http/graphhttpclient.yml @@ -6,10 +6,11 @@ items: telemetry that helps the service to monitor the performance of an application. https://developer.microsoft.com/en-us/graph/ remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class instead. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: GraphHttpClient fullName: sp-http.GraphHttpClient @@ -26,8 +27,6 @@ items: - sp-http.GraphHttpClient.serviceKey - uid: sp-http.GraphHttpClient.constructor summary: 'Constructs a new instance of the [GraphHttpClient](xref:sp-http.GraphHttpClient) class' - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. name: constructor(serviceScope) fullName: sp-http.GraphHttpClient.constructor langs: @@ -42,8 +41,6 @@ items: - ServiceScope - uid: sp-http.GraphHttpClient.configurations summary: The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: configurations fullName: sp-http.GraphHttpClient.configurations @@ -51,7 +48,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly configurations: IGraphHttpClientConfigurations;' + content: 'static readonly configurations: IGraphHttpClientConfigurations;' return: type: - IGraphHttpClientConfigurations @@ -65,8 +62,6 @@ items: The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead): - Default "Accept" and "Content-Type" headers are added if not explicitly specified. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: 'fetch(url, configuration, options)' fullName: sp-http.GraphHttpClient.fetch @@ -74,7 +69,9 @@ items: - typeScript type: method syntax: - content: "public fetch(url: string,\r\n configuration: GraphHttpClientConfiguration,\r\n options: IGraphHttpClientOptions): Promise;" + content: >- + fetch(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): + Promise; return: type: - Promise @@ -98,8 +95,6 @@ items: - IGraphHttpClientOptions - uid: sp-http.GraphHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: 'get(url, configuration, options)' fullName: sp-http.GraphHttpClient.get @@ -107,7 +102,9 @@ items: - typeScript type: method syntax: - content: "public get(url: string, configuration: GraphHttpClientConfiguration,\r\n options?: IGraphHttpClientOptions): Promise;" + content: >- + get(url: string, configuration: GraphHttpClientConfiguration, options?: IGraphHttpClientOptions): + Promise; return: type: - Promise @@ -129,8 +126,6 @@ items: - IGraphHttpClientOptions - uid: sp-http.GraphHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: 'post(url, configuration, options)' fullName: sp-http.GraphHttpClient.post @@ -138,7 +133,9 @@ items: - typeScript type: method syntax: - content: "public post(url: string, configuration: GraphHttpClientConfiguration,\r\n options: IGraphHttpClientOptions): Promise;" + content: >- + post(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): + Promise; return: type: - Promise @@ -160,8 +157,6 @@ items: - IGraphHttpClientOptions - uid: sp-http.GraphHttpClient.serviceKey summary: The service key for GraphHttpClient. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: serviceKey fullName: sp-http.GraphHttpClient.serviceKey @@ -169,7 +164,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - ServiceKey diff --git a/SP-Framework/sp-http/graphhttpclientresponse.yml b/SP-Framework/sp-http/graphhttpclientresponse.yml index a8c41bfd..792e83e7 100644 --- a/SP-Framework/sp-http/graphhttpclientresponse.yml +++ b/SP-Framework/sp-http/graphhttpclientresponse.yml @@ -3,6 +3,9 @@ items: - uid: sp-http.GraphHttpClientResponse summary: The Response subclass returned by methods such as GraphHttpClient.fetch(). remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + This is a placeholder. In the future, additional GraphHttpClient-specific functionality may be added to this class. deprecated: @@ -19,6 +22,7 @@ items: children: - sp-http.GraphHttpClientResponse.constructor - sp-http.GraphHttpClientResponse.clone + - sp-http.GraphHttpClientResponse.correlationId - uid: sp-http.GraphHttpClientResponse.constructor summary: 'Constructs a new instance of the [GraphHttpClientResponse](xref:sp-http.GraphHttpClientResponse) class' deprecated: @@ -29,7 +33,7 @@ items: - typeScript type: constructor syntax: - content: 'public constructor(response: Response);' + content: 'constructor(response: Response);' parameters: - id: response description: '' @@ -45,8 +49,25 @@ items: - typeScript type: method syntax: - content: '@override public clone(): GraphHttpClientResponse;' + content: |- + /** @override */ + clone(): GraphHttpClientResponse; return: type: - GraphHttpClientResponse description: '' + - uid: sp-http.GraphHttpClientResponse.correlationId + summary: Returns the Graph API correlation ID. + deprecated: + content: The GraphHttpClient class has been superceded by the MSGraphClient class. + isPreview: true + name: correlationId + fullName: sp-http.GraphHttpClientResponse.correlationId + langs: + - typeScript + type: property + syntax: + content: 'readonly correlationId: Guid | undefined;' + return: + type: + - Guid | undefined diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index fe3d2351..20b10abf 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -38,7 +38,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly configurations: IHttpClientConfigurations;' + content: 'static readonly configurations: IHttpClientConfigurations;' return: type: - IHttpClientConfigurations @@ -54,11 +54,17 @@ items: - typeScript type: method syntax: - content: "public fetch(url: string, configuration: HttpClientConfiguration,\r\n options: IHttpClientOptions): Promise;" + content: >- + fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -82,11 +88,17 @@ items: - typeScript type: method syntax: - content: "public get(url: string, configuration: HttpClientConfiguration,\r\n options?: IHttpClientOptions): Promise;" + content: >- + get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -110,11 +122,17 @@ items: - typeScript type: method syntax: - content: "public post(url: string, configuration: HttpClientConfiguration,\r\n options: IHttpClientOptions): Promise;" + content: >- + post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -138,7 +156,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - ServiceKey diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index 0fe70629..a520445c 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -59,7 +59,9 @@ items: - typeScript type: method syntax: - content: '@virtual protected initializeFlags(): void;' + content: |- + /** @virtual */ + protected initializeFlags(): void; return: type: - void @@ -72,7 +74,9 @@ items: - typeScript type: method syntax: - content: '@virtual public overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;' + content: |- + /** @virtual */ + overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; return: type: - HttpClientConfiguration diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index bcd06405..1b993e66 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -39,7 +39,7 @@ items: - typeScript type: method syntax: - content: 'public arrayBuffer(): Promise;' + content: 'arrayBuffer(): Promise;' return: type: - Promise @@ -52,7 +52,7 @@ items: - typeScript type: method syntax: - content: 'public blob(): Promise;' + content: 'blob(): Promise;' return: type: - Promise @@ -65,7 +65,7 @@ items: - typeScript type: property syntax: - content: 'public readonly bodyUsed: boolean;' + content: 'readonly bodyUsed: boolean;' return: type: - boolean @@ -76,7 +76,9 @@ items: - typeScript type: method syntax: - content: '@virtual public clone(): HttpClientResponse;' + content: |- + /** @virtual */ + clone(): HttpClientResponse; return: type: - HttpClientResponse @@ -89,7 +91,7 @@ items: - typeScript type: method syntax: - content: 'public formData(): Promise;' + content: 'formData(): Promise;' return: type: - Promise @@ -102,7 +104,7 @@ items: - typeScript type: property syntax: - content: 'public readonly headers: Headers;' + content: 'readonly headers: Headers;' return: type: - Headers @@ -114,7 +116,7 @@ items: - typeScript type: method syntax: - content: 'public json(): Promise;' + content: 'json(): Promise;' return: type: - Promise @@ -138,7 +140,7 @@ items: - typeScript type: property syntax: - content: 'public readonly ok: boolean;' + content: 'readonly ok: boolean;' return: type: - boolean @@ -150,7 +152,7 @@ items: - typeScript type: property syntax: - content: 'public readonly status: number;' + content: 'readonly status: number;' return: type: - number @@ -162,7 +164,7 @@ items: - typeScript type: property syntax: - content: 'public readonly statusText: string;' + content: 'readonly statusText: string;' return: type: - string @@ -174,7 +176,7 @@ items: - typeScript type: method syntax: - content: 'public text(): Promise;' + content: 'text(): Promise;' return: type: - Promise @@ -187,7 +189,7 @@ items: - typeScript type: property syntax: - content: 'public readonly type: ResponseType;' + content: 'readonly type: ResponseType;' return: type: - ResponseType @@ -199,7 +201,7 @@ items: - typeScript type: property syntax: - content: 'public readonly url: string;' + content: 'readonly url: string;' return: type: - string diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml new file mode 100644 index 00000000..32fa938c --- /dev/null +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -0,0 +1,12 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadHttpClientConfiguration + summary: Flags interface for HttpClientConfiguration. + name: IAadHttpClientConfiguration + fullName: sp-http.IAadHttpClientConfiguration + langs: + - typeScript + type: interface + extends: + - IHttpClientConfiguration + package: sp-http diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml new file mode 100644 index 00000000..62369e4f --- /dev/null +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -0,0 +1,32 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadHttpClientConfigurations + summary: Standard configurations for AadHttpClient. + remarks: >- + This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient + class. In general, clients should choose the latest available version number, which enables all the switches that + are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was + tested.) + name: IAadHttpClientConfigurations + fullName: sp-http.IAadHttpClientConfigurations + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IAadHttpClientConfigurations.v1 + - uid: sp-http.IAadHttpClientConfigurations.v1 + summary: >- + This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially + identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ + name: v1 + fullName: sp-http.IAadHttpClientConfigurations.v1 + langs: + - typeScript + type: property + syntax: + content: 'readonly v1: AadHttpClientConfiguration;' + return: + type: + - AadHttpClientConfiguration diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml new file mode 100644 index 00000000..84a0ecf3 --- /dev/null +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -0,0 +1,86 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadTokenProviderConfiguration + summary: Required strings for constructing an AadTokenProvider. + isPreview: true + name: IAadTokenProviderConfiguration + fullName: sp-http.IAadTokenProviderConfiguration + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IAadTokenProviderConfiguration.aadInstanceUrl + - sp-http.IAadTokenProviderConfiguration.aadTenantId + - sp-http.IAadTokenProviderConfiguration.aadUserId + - sp-http.IAadTokenProviderConfiguration.redirectUri + - sp-http.IAadTokenProviderConfiguration.servicePrincipalId + - uid: sp-http.IAadTokenProviderConfiguration.aadInstanceUrl + summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. + isPreview: true + name: aadInstanceUrl + fullName: sp-http.IAadTokenProviderConfiguration.aadInstanceUrl + langs: + - typeScript + type: property + syntax: + content: 'aadInstanceUrl: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.aadTenantId + summary: The Azure Active Directory's tenant id. + isPreview: true + name: aadTenantId + fullName: sp-http.IAadTokenProviderConfiguration.aadTenantId + langs: + - typeScript + type: property + syntax: + content: 'aadTenantId: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.aadUserId + summary: >- + The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current + user. + isPreview: true + name: aadUserId + fullName: sp-http.IAadTokenProviderConfiguration.aadUserId + langs: + - typeScript + type: property + syntax: + content: 'aadUserId?: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.redirectUri + summary: >- + The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's + application redirect uris. + isPreview: true + name: redirectUri + fullName: sp-http.IAadTokenProviderConfiguration.redirectUri + langs: + - typeScript + type: property + syntax: + content: 'redirectUri: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.servicePrincipalId + summary: The client ID of the developer's Azure Active Directory application. + isPreview: true + name: servicePrincipalId + fullName: sp-http.IAadTokenProviderConfiguration.servicePrincipalId + langs: + - typeScript + type: property + syntax: + content: 'servicePrincipalId: string;' + return: + type: + - string diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 16b9b2ef..0446ad22 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -23,7 +23,7 @@ items: - typeScript type: method syntax: - content: 'public static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' + content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' return: type: - ODataVersion | undefined @@ -41,7 +41,7 @@ items: - typeScript type: property syntax: - content: 'public static v3: ODataVersion;' + content: 'static v3: ODataVersion;' return: type: - ODataVersion @@ -53,7 +53,7 @@ items: - typeScript type: property syntax: - content: 'public static v4: ODataVersion;' + content: 'static v4: ODataVersion;' return: type: - ODataVersion diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index b5ba5680..8eca7c01 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -4,7 +4,10 @@ items: summary: >- SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application. - remarks: 'For communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class.' + remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + For communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class. name: SPHttpClient fullName: sp-http.SPHttpClient langs: @@ -43,11 +46,11 @@ items: - typeScript type: method syntax: - content: 'public beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' + content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' return: type: - SPHttpClientBatch - description: a promise that will return the result + description: 'An [SPHttpClientBatch](xref:sp-http.SPHttpClientBatch) object used to manage the batch operation.' parameters: - id: batchCreationOptions description: '' @@ -61,7 +64,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly configurations: ISPHttpClientConfigurations;' + content: 'static readonly configurations: ISPHttpClientConfigurations;' return: type: - ISPHttpClientConfigurations @@ -95,11 +98,17 @@ items: - typeScript type: method syntax: - content: "public fetch(url: string, configuration: SPHttpClientConfiguration,\r\n options: ISPHttpClientOptions): Promise;" + content: >- + fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -123,11 +132,17 @@ items: - typeScript type: method syntax: - content: "public get(url: string, configuration: SPHttpClientConfiguration,\r\n options?: ISPHttpClientOptions): Promise;" + content: >- + get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -163,7 +178,7 @@ items: - typeScript type: method syntax: - content: 'public static getWebUrlFromRequestUrl(requestUrl: string): string;' + content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' return: type: - string @@ -181,11 +196,17 @@ items: - typeScript type: method syntax: - content: "public post(url: string, configuration: SPHttpClientConfiguration,\r\n options: ISPHttpClientOptions): Promise;" + content: >- + post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -209,7 +230,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - ServiceKey diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 37cf7588..c65720b1 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -35,7 +35,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly configurations: ISPHttpClientBatchConfigurations;' + content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: type: - ISPHttpClientBatchConfigurations @@ -48,7 +48,7 @@ items: - typeScript type: method syntax: - content: 'public execute(): Promise;' + content: 'execute(): Promise;' return: type: - Promise @@ -56,12 +56,13 @@ items: - uid: sp-http.SPHttpClientBatch.fetch summary: >- Queues a new request, and returns a promise that can be used to access the server response (after execute() has - completed). The parameters for this function are basically the same as the WHATWG API standard documented here: - https://fetch.spec.whatwg.org/ + completed). + remarks: >- + The parameters for this function are basically the same as the WHATWG API standard documented here: - However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation - for details. + [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/)However, be aware that certain REST + headers are ignored or not allowed inside a batch. See the ODATA documentation for details. When execute() is called, it will POST to a URL such as "http://example.com/sites/sample/\_api/$batch". Typically @@ -76,12 +77,16 @@ items: type: method syntax: content: >- - public fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): + fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -106,11 +111,17 @@ items: - typeScript type: method syntax: - content: "public get(url: string, configuration: SPHttpClientBatchConfiguration,\r\n options?: ISPHttpClientBatchOptions): Promise;" + content: >- + get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch @@ -135,11 +146,17 @@ items: - typeScript type: method syntax: - content: "public post(url: string, configuration: SPHttpClientBatchConfiguration,\r\n options: ISPHttpClientBatchOptions): Promise;" + content: >- + post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): + Promise; return: type: - Promise - description: a promise that will return the result + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP + 404 or 500. The promise will only reject for network failures or other errors that prevent communication with + the server. parameters: - id: url description: the URL to fetch diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 77e77358..29035010 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -63,7 +63,9 @@ items: - typeScript type: method syntax: - content: '@override protected initializeFlags(): void;' + content: |- + /** @override */ + protected initializeFlags(): void; return: type: - void @@ -76,7 +78,9 @@ items: - typeScript type: method syntax: - content: '@override public overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;' + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; return: type: - SPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 49818d8b..252b96b2 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -58,7 +58,9 @@ items: - typeScript type: method syntax: - content: '@override protected initializeFlags(): void;' + content: |- + /** @override */ + protected initializeFlags(): void; return: type: - void @@ -83,7 +85,7 @@ items: - typeScript type: property syntax: - content: 'public readonly jsonRequest: boolean;' + content: 'readonly jsonRequest: boolean;' return: type: - boolean @@ -103,7 +105,7 @@ items: - typeScript type: property syntax: - content: 'public readonly jsonResponse: boolean;' + content: 'readonly jsonResponse: boolean;' return: type: - boolean @@ -114,7 +116,9 @@ items: - typeScript type: method syntax: - content: '@override public overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;' + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; return: type: - SPHttpClientCommonConfiguration diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index d3b16968..78e93ac9 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -60,7 +60,7 @@ items: - typeScript type: property syntax: - content: 'public readonly defaultODataVersion: ODataVersion;' + content: 'readonly defaultODataVersion: ODataVersion;' return: type: - ODataVersion @@ -81,7 +81,7 @@ items: - typeScript type: property syntax: - content: 'public readonly defaultSameOriginCredentials: boolean;' + content: 'readonly defaultSameOriginCredentials: boolean;' return: type: - boolean @@ -103,7 +103,9 @@ items: - typeScript type: method syntax: - content: '@override protected initializeFlags(): void;' + content: |- + /** @override */ + protected initializeFlags(): void; return: type: - void @@ -115,7 +117,9 @@ items: - typeScript type: method syntax: - content: '@override public overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;' + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; return: type: - SPHttpClientConfiguration @@ -140,7 +144,7 @@ items: - typeScript type: property syntax: - content: 'public readonly requestDigest: boolean;' + content: 'readonly requestDigest: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index 5287c3a7..e37ddf31 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -2,7 +2,10 @@ items: - uid: sp-http.SPHttpClientResponse summary: The Response subclass returned by methods such as SPHttpClient.fetch(). - remarks: 'This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class.' + remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. name: SPHttpClientResponse fullName: sp-http.SPHttpClientResponse langs: @@ -23,7 +26,7 @@ items: - typeScript type: constructor syntax: - content: 'public constructor(response: Response);' + content: 'constructor(response: Response);' parameters: - id: response description: '' @@ -36,7 +39,9 @@ items: - typeScript type: method syntax: - content: '@override public clone(): SPHttpClientResponse;' + content: |- + /** @override */ + clone(): SPHttpClientResponse; return: type: - SPHttpClientResponse @@ -54,7 +59,7 @@ items: - typeScript type: property syntax: - content: 'public readonly correlationId: Guid | undefined;' + content: 'readonly correlationId: Guid | undefined;' return: type: - Guid | undefined diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index bef65fa7..1f148208 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -22,4 +22,4 @@ items: langs: - typeScript type: field - numericValue: '''SPRequestGuid''' + numericValue: '"SPRequestGuid"' diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml new file mode 100644 index 00000000..a75892c2 --- /dev/null +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -0,0 +1,61 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.TokenAcquisitionEventArgs + summary: Represents arguments used for raising a token acquisiton failure event. + isPreview: true + name: TokenAcquisitionEventArgs + fullName: sp-http.TokenAcquisitionEventArgs + langs: + - typeScript + type: class + extends: + - SPEventArgs + package: sp-http + children: + - sp-http.TokenAcquisitionEventArgs.constructor + - sp-http.TokenAcquisitionEventArgs.message + - sp-http.TokenAcquisitionEventArgs.redirectUrl + - uid: sp-http.TokenAcquisitionEventArgs.constructor + summary: 'Constructs a new instance of the [TokenAcquisitionEventArgs](xref:sp-http.TokenAcquisitionEventArgs) class' + name: 'constructor(message, redirectUrl)' + fullName: sp-http.TokenAcquisitionEventArgs.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(message: string, redirectUrl?: string);' + parameters: + - id: message + description: '' + type: + - string + - id: redirectUrl + description: '' + type: + - string + - uid: sp-http.TokenAcquisitionEventArgs.message + summary: The message returned from ADAL fails to retrieve a token from Azure AD. + isPreview: true + name: message + fullName: sp-http.TokenAcquisitionEventArgs.message + langs: + - typeScript + type: property + syntax: + content: 'message: string;' + return: + type: + - string + - uid: sp-http.TokenAcquisitionEventArgs.redirectUrl + summary: The url of the page for the end user to perform Multi Factor Authentication + isPreview: true + name: redirectUrl + fullName: sp-http.TokenAcquisitionEventArgs.redirectUrl + langs: + - typeScript + type: property + syntax: + content: 'redirectUrl?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index f12e19b8..0a5e39dd 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -42,7 +42,7 @@ items: - typeScript type: method syntax: - content: '@virtual public onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' + content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' return: type: - void @@ -59,7 +59,7 @@ items: - typeScript type: method syntax: - content: '@virtual public onRenderCell(event: IFieldCustomizerCellEventParameters): void;' + content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' return: type: - void diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index e501348e..c4d7d6ad 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -35,7 +35,7 @@ items: - typeScript type: property syntax: - content: 'public readonly context: ListViewCommandSetContext;' + content: 'readonly context: ListViewCommandSetContext;' return: type: - ListViewCommandSetContext @@ -47,7 +47,7 @@ items: - typeScript type: method syntax: - content: '@virtual public onExecute(event: IListViewCommandSetExecuteEventParameters): void;' + content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' return: type: - void @@ -68,7 +68,7 @@ items: - typeScript type: method syntax: - content: '@virtual public onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' + content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' return: type: - void @@ -86,7 +86,7 @@ items: - typeScript type: method syntax: - content: 'public tryGetCommand(id: string): Command;' + content: 'tryGetCommand(id: string): Command;' return: type: - Command diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 141c9338..aa99ff4e 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -29,7 +29,7 @@ items: - typeScript type: property syntax: - content: 'public readonly field: SPField;' + content: 'readonly field: SPField;' return: type: - SPField @@ -41,7 +41,7 @@ items: - typeScript type: property syntax: - content: 'public readonly visible: boolean;' + content: 'readonly visible: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index d6394398..e6ff38c3 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -31,7 +31,7 @@ items: - typeScript type: property syntax: - content: 'public ariaLabel: string | undefined;' + content: 'ariaLabel: string | undefined;' return: type: - string | undefined @@ -46,7 +46,7 @@ items: - typeScript type: property syntax: - content: 'public iconImageUrl: string | undefined;' + content: 'iconImageUrl: string | undefined;' return: type: - string | undefined @@ -58,7 +58,7 @@ items: - typeScript type: property syntax: - content: 'public id: string;' + content: 'id: string;' return: type: - string @@ -78,7 +78,7 @@ items: - typeScript type: property syntax: - content: 'public title: string;' + content: 'title: string;' return: type: - string @@ -90,7 +90,7 @@ items: - typeScript type: property syntax: - content: 'public visible: boolean;' + content: 'visible: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 00839787..be01b550 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -24,7 +24,7 @@ items: - typeScript type: property syntax: - content: 'public readonly field: SPField;' + content: 'readonly field: SPField;' return: type: - SPField @@ -41,7 +41,7 @@ items: - typeScript type: method syntax: - content: 'public tryGetListView(): ListViewAccessor | undefined;' + content: 'tryGetListView(): ListViewAccessor | undefined;' return: type: - ListViewAccessor | undefined diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 451365be..77eb964c 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -39,7 +39,7 @@ items: - typeScript type: property syntax: - content: 'public readonly fields: ReadonlyArray;' + content: 'readonly fields: ReadonlyArray;' return: type: - ReadonlyArray @@ -53,7 +53,7 @@ items: - typeScript type: method syntax: - content: 'public abstract getValue(field: SPField): any;' + content: 'abstract getValue(field: SPField): any;' return: type: - any @@ -73,7 +73,7 @@ items: - typeScript type: method syntax: - content: 'public abstract getValueByName(internalName: string): any;' + content: 'abstract getValueByName(internalName: string): any;' return: type: - any diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index c3d9d5f7..ae59dba1 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -23,7 +23,7 @@ items: - typeScript type: property syntax: - content: 'public readonly columns: ReadonlyArray;' + content: 'readonly columns: ReadonlyArray;' return: type: - ReadonlyArray @@ -35,10 +35,10 @@ items: - typeScript type: property syntax: - content: 'public readonly selectedRowsChangedEvent: Event;' + content: 'readonly selectedRowsChangedEvent: SPEvent;' return: type: - - Event + - SPEvent - uid: sp-listview-extensibility.ListViewAccessor.tryGetColumnByName summary: >- Returns the list view column corresponding to the field with the specified internal name, or undefined if none is @@ -49,7 +49,7 @@ items: - typeScript type: method syntax: - content: 'public abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' + content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' return: type: - ColumnAccessor | undefined diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index 2dad026f..6fb90282 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -24,7 +24,7 @@ items: - typeScript type: property syntax: - content: 'public readonly listView: ListViewAccessor;' + content: 'readonly listView: ListViewAccessor;' return: type: - ListViewAccessor @@ -36,7 +36,7 @@ items: - typeScript type: property syntax: - content: 'public readonly manifest: ICommandSetExtensionManifest;' + content: 'readonly manifest: ICommandSetExtensionManifest;' return: type: - ICommandSetExtensionManifest diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 6211057d..448e2771 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -8,7 +8,7 @@ items: - typeScript type: class extends: - - EventArgs + - SPEventArgs package: sp-listview-extensibility children: - sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows @@ -20,7 +20,7 @@ items: - typeScript type: property syntax: - content: 'public selectedRows: ReadonlyArray;' + content: 'selectedRows: ReadonlyArray;' return: type: - ReadonlyArray diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index ed71bb26..5432f925 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -26,7 +26,10 @@ items: content: 'ContentTypeId:' return: type: - - '{ StringValue: string }' + - |- + { + StringValue: string; + } - uid: sp-odata-types.IODataListItem.ID name: ID fullName: sp-odata-types.IODataListItem.ID diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 1aa7b7b4..7bee5ff3 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -33,7 +33,7 @@ items: - typeScript type: property syntax: - content: 'public readonly currentCultureName: string;' + content: 'readonly currentCultureName: string;' return: type: - string @@ -51,7 +51,7 @@ items: - typeScript type: property syntax: - content: 'public readonly currentUICultureName: string;' + content: 'readonly currentUICultureName: string;' return: type: - string @@ -63,7 +63,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isRightToLeft: boolean;' + content: 'readonly isRightToLeft: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index dfbd40d3..ac74cd9d 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -14,6 +14,7 @@ items: package: sp-page-context children: - sp-page-context.PageContext.constructor + - sp-page-context.PageContext.aadInfo - sp-page-context.PageContext.cultureInfo - sp-page-context.PageContext.isInitialized - sp-page-context.PageContext.legacyPageContext @@ -37,6 +38,20 @@ items: description: '' type: - ServiceScope + - uid: sp-page-context.PageContext.aadInfo + summary: >- + Contextual information for communicating with Azure Active Directory. If the current page doesn't have an + associated Azure Active Directory tenant, this property will be undefined. + name: aadInfo + fullName: sp-page-context.PageContext.aadInfo + langs: + - typeScript + type: property + syntax: + content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' + return: + type: + - AzureActiveDirectoryInfo | undefined - uid: sp-page-context.PageContext.cultureInfo summary: >- It provides culture info for the current user of the application. This class is primarily used with the @@ -47,7 +62,7 @@ items: - typeScript type: property syntax: - content: 'public readonly cultureInfo: CultureInfo;' + content: 'readonly cultureInfo: CultureInfo;' return: type: - CultureInfo @@ -59,7 +74,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isInitialized: boolean;' + content: 'readonly isInitialized: boolean;' return: type: - boolean @@ -82,7 +97,7 @@ items: - typeScript type: property syntax: - content: 'public readonly legacyPageContext: any;' + content: 'readonly legacyPageContext: any;' return: type: - any @@ -96,7 +111,7 @@ items: - typeScript type: property syntax: - content: 'public readonly list: SPList | undefined;' + content: 'readonly list: SPList | undefined;' return: type: - SPList | undefined @@ -110,7 +125,7 @@ items: - typeScript type: property syntax: - content: 'public readonly listItem: SPListItem | undefined;' + content: 'readonly listItem: SPListItem | undefined;' return: type: - SPListItem | undefined @@ -122,7 +137,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - ServiceKey @@ -134,7 +149,7 @@ items: - typeScript type: property syntax: - content: 'public readonly site: SPSite;' + content: 'readonly site: SPSite;' return: type: - SPSite @@ -148,7 +163,7 @@ items: - typeScript type: property syntax: - content: 'public readonly user: SPUser;' + content: 'readonly user: SPUser;' return: type: - SPUser @@ -160,7 +175,7 @@ items: - typeScript type: property syntax: - content: 'public readonly web: SPWeb;' + content: 'readonly web: SPWeb;' return: type: - SPWeb diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 9d71e90f..2ad6ca8b 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -29,7 +29,7 @@ items: - typeScript type: property syntax: - content: 'public readonly clientSideComponentId: Guid | undefined;' + content: 'readonly clientSideComponentId: Guid | undefined;' return: type: - Guid | undefined @@ -44,7 +44,7 @@ items: - typeScript type: property syntax: - content: 'public readonly clientSideComponentProperties: string;' + content: 'readonly clientSideComponentProperties: string;' return: type: - string @@ -56,7 +56,7 @@ items: - typeScript type: property syntax: - content: 'public readonly displayName: string;' + content: 'readonly displayName: string;' return: type: - string @@ -68,7 +68,7 @@ items: - typeScript type: property syntax: - content: 'public readonly fieldType: string;' + content: 'readonly fieldType: string;' return: type: - string @@ -80,7 +80,7 @@ items: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - Guid @@ -92,7 +92,7 @@ items: - typeScript type: property syntax: - content: 'public readonly internalName: string;' + content: 'readonly internalName: string;' return: type: - string @@ -104,7 +104,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isRequired: boolean;' + content: 'readonly isRequired: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 708c1fe5..334810c1 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -28,7 +28,7 @@ items: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - Guid @@ -42,7 +42,7 @@ items: - typeScript type: property syntax: - content: 'public readonly permissions: SPPermission;' + content: 'readonly permissions: SPPermission;' return: type: - SPPermission @@ -55,7 +55,7 @@ items: - typeScript type: property syntax: - content: 'public readonly serverRelativeUrl: string;' + content: 'readonly serverRelativeUrl: string;' return: type: - string @@ -67,7 +67,7 @@ items: - typeScript type: property syntax: - content: 'public readonly title: string;' + content: 'readonly title: string;' return: type: - string diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 59d21dda..f1f8d8f4 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -23,7 +23,7 @@ items: - typeScript type: property syntax: - content: 'public readonly id: number;' + content: 'readonly id: number;' return: type: - number diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 65eef097..ef98d4c0 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -78,7 +78,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly addAndCustomizePages: SPPermission;' + content: 'static readonly addAndCustomizePages: SPPermission;' return: type: - SPPermission @@ -90,7 +90,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly addDelPrivateWebParts: SPPermission;' + content: 'static readonly addDelPrivateWebParts: SPPermission;' return: type: - SPPermission @@ -102,7 +102,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly addListItems: SPPermission;' + content: 'static readonly addListItems: SPPermission;' return: type: - SPPermission @@ -114,7 +114,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly applyStyleSheets: SPPermission;' + content: 'static readonly applyStyleSheets: SPPermission;' return: type: - SPPermission @@ -126,7 +126,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly applyThemeAndBorder: SPPermission;' + content: 'static readonly applyThemeAndBorder: SPPermission;' return: type: - SPPermission @@ -138,7 +138,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly approveItems: SPPermission;' + content: 'static readonly approveItems: SPPermission;' return: type: - SPPermission @@ -150,7 +150,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly browseDirectories: SPPermission;' + content: 'static readonly browseDirectories: SPPermission;' return: type: - SPPermission @@ -162,7 +162,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly browserUserInfo: SPPermission;' + content: 'static readonly browserUserInfo: SPPermission;' return: type: - SPPermission @@ -174,7 +174,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly cancelCheckout: SPPermission;' + content: 'static readonly cancelCheckout: SPPermission;' return: type: - SPPermission @@ -186,7 +186,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly createAlerts: SPPermission;' + content: 'static readonly createAlerts: SPPermission;' return: type: - SPPermission @@ -198,7 +198,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly createGroups: SPPermission;' + content: 'static readonly createGroups: SPPermission;' return: type: - SPPermission @@ -210,7 +210,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly createSSCSite: SPPermission;' + content: 'static readonly createSSCSite: SPPermission;' return: type: - SPPermission @@ -222,7 +222,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly deleteListItems: SPPermission;' + content: 'static readonly deleteListItems: SPPermission;' return: type: - SPPermission @@ -234,7 +234,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly deleteVersions: SPPermission;' + content: 'static readonly deleteVersions: SPPermission;' return: type: - SPPermission @@ -248,7 +248,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly editListItems: SPPermission;' + content: 'static readonly editListItems: SPPermission;' return: type: - SPPermission @@ -260,7 +260,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly editMyUserInfo: SPPermission;' + content: 'static readonly editMyUserInfo: SPPermission;' return: type: - SPPermission @@ -272,7 +272,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly emptyMask: SPPermission;' + content: 'static readonly emptyMask: SPPermission;' return: type: - SPPermission @@ -284,7 +284,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly enumeratePermissions: SPPermission;' + content: 'static readonly enumeratePermissions: SPPermission;' return: type: - SPPermission @@ -296,7 +296,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly fullMask: SPPermission;' + content: 'static readonly fullMask: SPPermission;' return: type: - SPPermission @@ -308,7 +308,7 @@ items: - typeScript type: method syntax: - content: 'public hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' + content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' return: type: - boolean @@ -326,7 +326,7 @@ items: - typeScript type: method syntax: - content: 'public hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' + content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' return: type: - boolean @@ -344,7 +344,7 @@ items: - typeScript type: method syntax: - content: 'public hasPermission(requestedPerm: SPPermission): boolean;' + content: 'hasPermission(requestedPerm: SPPermission): boolean;' return: type: - boolean @@ -362,7 +362,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly layoutsPage: SPPermission;' + content: 'static readonly layoutsPage: SPPermission;' return: type: - SPPermission @@ -374,7 +374,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly manageAlerts: SPPermission;' + content: 'static readonly manageAlerts: SPPermission;' return: type: - SPPermission @@ -386,7 +386,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly manageLists: SPPermission;' + content: 'static readonly manageLists: SPPermission;' return: type: - SPPermission @@ -398,7 +398,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly managePermissions: SPPermission;' + content: 'static readonly managePermissions: SPPermission;' return: type: - SPPermission @@ -410,7 +410,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly managePersonalViews: SPPermission;' + content: 'static readonly managePersonalViews: SPPermission;' return: type: - SPPermission @@ -422,7 +422,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly manageSubwebs: SPPermission;' + content: 'static readonly manageSubwebs: SPPermission;' return: type: - SPPermission @@ -440,7 +440,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly manageWeb: SPPermission;' + content: 'static readonly manageWeb: SPPermission;' return: type: - SPPermission @@ -452,7 +452,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly open: SPPermission;' + content: 'static readonly open: SPPermission;' return: type: - SPPermission @@ -464,7 +464,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly openItems: SPPermission;' + content: 'static readonly openItems: SPPermission;' return: type: - SPPermission @@ -476,7 +476,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly updatePersonalWebParts: SPPermission;' + content: 'static readonly updatePersonalWebParts: SPPermission;' return: type: - SPPermission @@ -488,7 +488,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly useClientIntegration: SPPermission;' + content: 'static readonly useClientIntegration: SPPermission;' return: type: - SPPermission @@ -500,7 +500,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly useRemoteAPIs: SPPermission;' + content: 'static readonly useRemoteAPIs: SPPermission;' return: type: - SPPermission @@ -512,7 +512,7 @@ items: - typeScript type: property syntax: - content: 'public readonly value: IODataBasePermission;' + content: 'readonly value: IODataBasePermission;' return: type: - IODataBasePermission @@ -524,7 +524,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly viewFormPages: SPPermission;' + content: 'static readonly viewFormPages: SPPermission;' return: type: - SPPermission @@ -536,7 +536,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly viewListItems: SPPermission;' + content: 'static readonly viewListItems: SPPermission;' return: type: - SPPermission @@ -548,7 +548,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly viewPages: SPPermission;' + content: 'static readonly viewPages: SPPermission;' return: type: - SPPermission @@ -560,7 +560,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly viewUsageData: SPPermission;' + content: 'static readonly viewUsageData: SPPermission;' return: type: - SPPermission @@ -572,7 +572,7 @@ items: - typeScript type: property syntax: - content: 'public static readonly viewVersions: SPPermission;' + content: 'static readonly viewVersions: SPPermission;' return: type: - SPPermission diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index 134332e6..b4d095fb 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -34,7 +34,7 @@ items: - typeScript type: property syntax: - content: 'public readonly absoluteUrl: string;' + content: 'readonly absoluteUrl: string;' return: type: - string @@ -46,7 +46,7 @@ items: - typeScript type: property syntax: - content: 'public readonly cdnPrefix: string;' + content: 'readonly cdnPrefix: string;' return: type: - string @@ -58,7 +58,7 @@ items: - typeScript type: property syntax: - content: 'public readonly classification: string;' + content: 'readonly classification: string;' return: type: - string @@ -70,7 +70,7 @@ items: - typeScript type: property syntax: - content: 'public readonly correlationId: Guid;' + content: 'readonly correlationId: Guid;' return: type: - Guid @@ -84,7 +84,7 @@ items: - typeScript type: property syntax: - content: 'public readonly group: O365GroupAssociation | undefined;' + content: 'readonly group: O365GroupAssociation | undefined;' return: type: - O365GroupAssociation | undefined @@ -96,7 +96,7 @@ items: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - Guid @@ -108,19 +108,19 @@ items: - typeScript type: property syntax: - content: 'public readonly isNoScriptEnabled: boolean;' + content: 'readonly isNoScriptEnabled: boolean;' return: type: - boolean - uid: sp-page-context.SPSite.recycleBinItemCount - summary: The amount of items in the recyle bin. + summary: The amount of items in the recycle bin. name: recycleBinItemCount fullName: sp-page-context.SPSite.recycleBinItemCount langs: - typeScript type: property syntax: - content: 'public readonly recycleBinItemCount: number;' + content: 'readonly recycleBinItemCount: number;' return: type: - number @@ -133,7 +133,7 @@ items: - typeScript type: property syntax: - content: 'public readonly serverRelativeUrl: string;' + content: 'readonly serverRelativeUrl: string;' return: type: - string @@ -146,7 +146,7 @@ items: - typeScript type: property syntax: - content: 'public readonly serverRequestPath: string;' + content: 'readonly serverRequestPath: string;' return: type: - string @@ -158,7 +158,7 @@ items: - typeScript type: property syntax: - content: 'public readonly sitePagesEnabled: boolean;' + content: 'readonly sitePagesEnabled: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 74097c0c..ba85f45c 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -29,7 +29,7 @@ items: - typeScript type: property syntax: - content: 'public readonly displayName: string;' + content: 'readonly displayName: string;' return: type: - string @@ -42,7 +42,7 @@ items: - typeScript type: property syntax: - content: 'public readonly email: string;' + content: 'readonly email: string;' return: type: - string @@ -54,7 +54,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isAnonymousGuestUser: boolean;' + content: 'readonly isAnonymousGuestUser: boolean;' return: type: - boolean @@ -66,20 +66,20 @@ items: - typeScript type: property syntax: - content: 'public readonly isExternalGuestUser: boolean;' + content: 'readonly isExternalGuestUser: boolean;' return: type: - boolean - uid: sp-page-context.SPUser.loginName summary: The login name for current user. - remarks: 'Example: "i:0\#.w\|domain\\user"' + remarks: 'Example: on-premise user: "domain\\user", online user: "user@domain.com"' name: loginName fullName: sp-page-context.SPUser.loginName langs: - typeScript type: property syntax: - content: 'public readonly loginName: string;' + content: 'readonly loginName: string;' return: type: - string @@ -91,7 +91,7 @@ items: - typeScript type: property syntax: - content: 'public readonly preferUserTimeZone: boolean;' + content: 'readonly preferUserTimeZone: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 3989b577..f6765411 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -32,7 +32,7 @@ items: - typeScript type: property syntax: - content: 'public readonly absoluteUrl: string;' + content: 'readonly absoluteUrl: string;' return: type: - string @@ -44,7 +44,7 @@ items: - typeScript type: property syntax: - content: 'public readonly description: string;' + content: 'readonly description: string;' return: type: - string @@ -56,7 +56,7 @@ items: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - Guid @@ -68,7 +68,7 @@ items: - typeScript type: property syntax: - content: 'public readonly isAppWeb: boolean;' + content: 'readonly isAppWeb: boolean;' return: type: - boolean @@ -81,7 +81,7 @@ items: - typeScript type: property syntax: - content: 'public readonly language: number;' + content: 'readonly language: number;' return: type: - number @@ -94,7 +94,7 @@ items: - typeScript type: property syntax: - content: 'public readonly logoUrl: string;' + content: 'readonly logoUrl: string;' return: type: - string @@ -108,7 +108,7 @@ items: - typeScript type: property syntax: - content: 'public readonly permissions: SPPermission;' + content: 'readonly permissions: SPPermission;' return: type: - SPPermission @@ -121,7 +121,7 @@ items: - typeScript type: property syntax: - content: 'public readonly serverRelativeUrl: string;' + content: 'readonly serverRelativeUrl: string;' return: type: - string @@ -136,7 +136,7 @@ items: - typeScript type: property syntax: - content: 'public readonly templateName: string;' + content: 'readonly templateName: string;' return: type: - string @@ -148,7 +148,7 @@ items: - typeScript type: property syntax: - content: 'public readonly title: string;' + content: 'readonly title: string;' return: type: - string diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 2531378d..74d819f9 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -23,8 +23,10 @@ items: - sp-webpart-base.IPropertyPaneChoiceGroupProps - sp-webpart-base.IPropertyPaneConfiguration - sp-webpart-base.IPropertyPaneCustomFieldProps + - sp-webpart-base.IPropertyPaneDropdownCalloutProps - sp-webpart-base.IPropertyPaneDropdownOption - sp-webpart-base.IPropertyPaneDropdownProps + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps - sp-webpart-base.IPropertyPaneField - sp-webpart-base.IPropertyPaneGroup - sp-webpart-base.IPropertyPaneLabelProps @@ -46,6 +48,7 @@ items: - sp-webpart-base.PropertyPaneCustomField - sp-webpart-base.PropertyPaneDropdown - sp-webpart-base.PropertyPaneDropdownOptionType + - sp-webpart-base.PropertyPaneDynamicTextField - sp-webpart-base.PropertyPaneFieldType - sp-webpart-base.PropertyPaneHorizontalRule - sp-webpart-base.PropertyPaneLabel @@ -62,7 +65,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneButton(targetProperty: string,\r\n properties: IPropertyPaneButtonProps): IPropertyPaneField;" + content: >- + export function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -84,7 +89,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneCheckbox(targetProperty: string,\r\n properties: IPropertyPaneCheckboxProps): IPropertyPaneField;" + content: >- + export function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -106,7 +113,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneChoiceGroup(targetProperty: string,\r\n properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;" + content: >- + export function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -154,7 +163,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneDropdown(targetProperty: string,\r\n properties: IPropertyPaneDropdownProps): IPropertyPaneField;" + content: >- + export function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -168,6 +179,31 @@ items: description: Strongly typed Dropdown properties. type: - IPropertyPaneDropdownProps + - uid: sp-webpart-base.PropertyPaneDynamicTextField + summary: Helper method to create a Dynamic TextField on the PropertyPane. + isPreview: true + name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + fullName: sp-webpart-base.PropertyPaneDynamicTextField + langs: + - typeScript + type: function + syntax: + content: >- + export function PropertyPaneDynamicTextField(targetProperty: string, properties: + IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; + return: + type: + - IPropertyPaneField + description: '' + parameters: + - id: targetProperty + description: Target property the dynamic textfield is associated to. + type: + - string + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + type: + - IPropertyPaneDynamicTextFieldProps - uid: sp-webpart-base.PropertyPaneHorizontalRule summary: Helper method to create a Horizontal Rule on the PropertyPane. name: PropertyPaneHorizontalRule() @@ -189,7 +225,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneLabel(targetProperty: string,\r\n properties: IPropertyPaneLabelProps): IPropertyPaneField;" + content: >- + export function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -211,7 +249,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneLink(targetProperty: string,\r\n properties: IPropertyPaneLinkProps): IPropertyPaneField;" + content: >- + export function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -233,7 +273,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneSlider(targetProperty: string,\r\n properties: IPropertyPaneSliderProps): IPropertyPaneField;" + content: >- + export function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -255,7 +297,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneTextField(targetProperty: string,\r\n properties: IPropertyPaneTextFieldProps): IPropertyPaneField;" + content: >- + export function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -277,7 +321,9 @@ items: - typeScript type: function syntax: - content: "export function PropertyPaneToggle(targetProperty: string,\r\n properties: IPropertyPaneToggleProps): IPropertyPaneField;" + content: >- + export function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + IPropertyPaneField; return: type: - IPropertyPaneField @@ -314,10 +360,14 @@ references: name: IPropertyPaneConfiguration - uid: sp-webpart-base.IPropertyPaneCustomFieldProps name: IPropertyPaneCustomFieldProps + - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps + name: IPropertyPaneDropdownCalloutProps - uid: sp-webpart-base.IPropertyPaneDropdownOption name: IPropertyPaneDropdownOption - uid: sp-webpart-base.IPropertyPaneDropdownProps name: IPropertyPaneDropdownProps + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + name: IPropertyPaneDynamicTextFieldProps - uid: sp-webpart-base.IPropertyPaneField name: IPropertyPaneField - uid: sp-webpart-base.IPropertyPaneGroup diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index cf59ecdb..3828ad35 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -51,6 +51,7 @@ items: - sp-webpart-base.BaseClientSideWebPart.previewImageUrl - sp-webpart-base.BaseClientSideWebPart.properties - sp-webpart-base.BaseClientSideWebPart.propertiesMetadata + - sp-webpart-base.BaseClientSideWebPart.propertyPaneRenderedByWebPart - sp-webpart-base.BaseClientSideWebPart.render - sp-webpart-base.BaseClientSideWebPart.renderCompleted - sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData @@ -219,6 +220,9 @@ items: configuration for the PropertyPane. + This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. + + See IPropertyPane and other PropertyPane integration wiki documentation for more details. name: getPropertyPaneConfiguration() fullName: sp-webpart-base.BaseClientSideWebPart.getPropertyPaneConfiguration @@ -226,7 +230,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' + content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: type: - IPropertyPaneConfiguration @@ -263,7 +267,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' + content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' return: type: - TProperties @@ -293,7 +297,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onAfterPropertyPaneChangesApplied(): void;' + content: 'protected onAfterPropertyPaneChangesApplied(): void;' return: type: - void @@ -313,7 +317,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onBeforeSerialize(): void;' + content: 'protected onBeforeSerialize(): void;' return: type: - void @@ -330,7 +334,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' + content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' return: type: - void @@ -353,7 +357,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onDispose(): void;' + content: 'protected onDispose(): void;' return: type: - void @@ -369,7 +373,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onInit(): Promise;' + content: 'protected onInit(): Promise;' return: type: - Promise @@ -392,7 +396,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onPropertyPaneConfigurationComplete(): void;' + content: 'protected onPropertyPaneConfigurationComplete(): void;' return: type: - void @@ -411,7 +415,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onPropertyPaneConfigurationStart(): void;' + content: 'protected onPropertyPaneConfigurationStart(): void;' return: type: - void @@ -426,7 +430,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' + content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' return: type: - void @@ -455,7 +459,7 @@ items: - typeScript type: method syntax: - content: '@virtual protected onPropertyPaneRendered(): void;' + content: 'protected onPropertyPaneRendered(): void;' return: type: - void @@ -502,6 +506,17 @@ items: return: type: - IWebPartPropertiesMetadata | undefined + - uid: sp-webpart-base.BaseClientSideWebPart.propertyPaneRenderedByWebPart + name: propertyPaneRenderedByWebPart + fullName: sp-webpart-base.BaseClientSideWebPart.propertyPaneRenderedByWebPart + langs: + - typeScript + type: property + syntax: + content: 'protected propertyPaneRenderedByWebPart: boolean;' + return: + type: + - boolean - uid: sp-webpart-base.BaseClientSideWebPart.render summary: >- This API is called to render the web part. There is no base implementation of this API and the web part is diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index d32246fc..a3b56fae 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -67,7 +67,11 @@ items: content: 'imageSize?:' return: type: - - '{ width: number, height: number }' + - |- + { + width: number; + height: number; + } - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSrc summary: The src of image for choice field. name: imageSrc diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index aecbbc79..0a609f36 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -69,7 +69,11 @@ items: - typeScript type: property syntax: - content: "onRender: (\r\n domElement: HTMLElement,\r\n context?: any,\r\n changeCallback?: (targetProperty?: string, newValue?: any) => void) => void;" + content: >- + onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => + void) => void; return: type: - - "(\r\n domElement: HTMLElement,\r\n context?: any,\r\n changeCallback?: (targetProperty?: string, newValue?: any) => void) => void" + - >- + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) + => void diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml new file mode 100644 index 00000000..550d84cf --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -0,0 +1,24 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps + summary: PropertyPane dropdown callout properties. + name: IPropertyPaneDropdownCalloutProps + fullName: sp-webpart-base.IPropertyPaneDropdownCalloutProps + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight + - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight + summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen + name: calloutMaxHeight + fullName: sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight + langs: + - typeScript + type: property + syntax: + content: 'calloutMaxHeight?: number;' + return: + type: + - number diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 3717b9b6..87f05a3d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -10,6 +10,9 @@ items: package: sp-webpart-base children: - sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel + - sp-webpart-base.IPropertyPaneDropdownProps.ariaPositionInSet + - sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize + - sp-webpart-base.IPropertyPaneDropdownProps.calloutProps - sp-webpart-base.IPropertyPaneDropdownProps.disabled - sp-webpart-base.IPropertyPaneDropdownProps.label - sp-webpart-base.IPropertyPaneDropdownProps.options @@ -26,6 +29,44 @@ items: return: type: - string + - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaPositionInSet + summary: >- + Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It + starts from 1. + name: ariaPositionInSet + fullName: sp-webpart-base.IPropertyPaneDropdownProps.ariaPositionInSet + langs: + - typeScript + type: property + syntax: + content: 'ariaPositionInSet?: number;' + return: + type: + - number + - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize + summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. + name: ariaSetSize + fullName: sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize + langs: + - typeScript + type: property + syntax: + content: 'ariaSetSize?: number;' + return: + type: + - number + - uid: sp-webpart-base.IPropertyPaneDropdownProps.calloutProps + summary: Custom properties for Dropdown's Callout used to render options. + name: calloutProps + fullName: sp-webpart-base.IPropertyPaneDropdownProps.calloutProps + langs: + - typeScript + type: property + syntax: + content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' + return: + type: + - IPropertyPaneDropdownCalloutProps - uid: sp-webpart-base.IPropertyPaneDropdownProps.disabled summary: Whether the property pane dropdown option is disabled or not. name: disabled diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml new file mode 100644 index 00000000..d16ccae4 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -0,0 +1,174 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + summary: PropertyPaneDynamicData component props. + isPreview: true + name: IPropertyPaneDynamicTextFieldProps + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel + summary: 'Aria Label for text field, if any.' + isPreview: true + name: ariaLabel + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description + summary: The text field input description. + isPreview: true + name: description + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled + summary: Whether the property pane text field is enabled or not. + isPreview: true + name: disabled + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage + summary: 'If set, this will be displayed as an error message.' + remarks: >- + When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the + error message. + + + So, make sure to set this only if you want to see an error message displayed for the text field. + isPreview: true + name: errorMessage + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage + langs: + - typeScript + type: property + syntax: + content: 'errorMessage?: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label + summary: Label for the text field. + isPreview: true + name: label + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label + langs: + - typeScript + type: property + syntax: + content: 'label?: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage + summary: The method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- + When it returns string: + + - If valid, it returns empty string. + + - If invalid, it returns the error message string and an error message is displayed below the text field. + + When it returns Promise<string>: + + - The resolved value is display as error message. + + - The rejected, the value is thrown away. + isPreview: true + name: onGetErrorMessage + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage + langs: + - typeScript + type: property + syntax: + content: 'onGetErrorMessage?: (value: string) => string | Promise;' + return: + type: + - '(value: string) => string | Promise' + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder + summary: placeholder text to be displayed in the text field. + isPreview: true + name: placeholder + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder + langs: + - typeScript + type: property + syntax: + content: 'placeholder?: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn + summary: Run validation when the PropertyPaneTextField is focused. + remarks: The default value is false. + isPreview: true + name: validateOnFocusIn + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn + langs: + - typeScript + type: property + syntax: + content: 'validateOnFocusIn?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut + summary: Run validation when the PropertyPaneTextField is out of focus or on blur. + remarks: The default value is false. + isPreview: true + name: validateOnFocusOut + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut + langs: + - typeScript + type: property + syntax: + content: 'validateOnFocusOut?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value + summary: >- + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. + isPreview: true + name: value + fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value + langs: + - typeScript + type: property + syntax: + content: 'value?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 544a0d10..322ca94f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -15,6 +15,7 @@ items: - sp-webpart-base.IPropertyPaneTextFieldProps.disabled - sp-webpart-base.IPropertyPaneTextFieldProps.errorMessage - sp-webpart-base.IPropertyPaneTextFieldProps.label + - sp-webpart-base.IPropertyPaneTextFieldProps.logName - sp-webpart-base.IPropertyPaneTextFieldProps.maxLength - sp-webpart-base.IPropertyPaneTextFieldProps.multiline - sp-webpart-base.IPropertyPaneTextFieldProps.onGetErrorMessage @@ -104,6 +105,27 @@ items: return: type: - string + - uid: sp-webpart-base.IPropertyPaneTextFieldProps.logName + summary: Engagement name to log PropertyPaneTextField value change. + remarks: >- + It will be logged format as <moduleName>.<controlName>. E.g. {moduleName: 'ImageWebPart', controlName: + 'OverlayText'}, it will log: 1. action type, including 'Add', 'Clear' and 'Edit'. Clear: reset the content of + caption element to initial/unset state. Add: change from initial/unset state to customized content. (first edit) + Edit: any edition that changes the content apart from add and clear 2. text length after each edit. + name: logName + fullName: sp-webpart-base.IPropertyPaneTextFieldProps.logName + langs: + - typeScript + type: property + syntax: + content: 'logName?:' + return: + type: + - |- + { + moduleName: string; + controlName: string; + } - uid: sp-webpart-base.IPropertyPaneTextFieldProps.maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' diff --git a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index b5a38569..d99e1c2b 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -32,7 +32,10 @@ items: content: 'htmlStrings?:' return: type: - - '{ [key: string]: string }' + - |- + { + [key: string]: string; + } - uid: sp-webpart-base.ISerializedServerProcessedData.imageSources summary: A key-value map where keys are string identifiers and values are image sources. remarks: |- @@ -48,7 +51,10 @@ items: content: 'imageSources?:' return: type: - - '{ [key: string]: string }' + - |- + { + [key: string]: string; + } - uid: sp-webpart-base.ISerializedServerProcessedData.links summary: A key-value map where keys are string identifiers and values are links. remarks: |- @@ -64,7 +70,10 @@ items: content: 'links?:' return: type: - - '{ [key: string]: string }' + - |- + { + [key: string]: string; + } - uid: sp-webpart-base.ISerializedServerProcessedData.searchablePlainTexts summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. remarks: >- @@ -83,4 +92,7 @@ items: content: 'searchablePlainTexts?:' return: type: - - '{ [key: string]: string }' + - |- + { + [key: string]: string; + } diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index df675c45..96e7f2bb 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -12,6 +12,8 @@ items: package: sp-webpart-base children: - sp-webpart-base.ISerializedWebPartData.dataVersion + - sp-webpart-base.ISerializedWebPartData.dynamicDataPaths + - sp-webpart-base.ISerializedWebPartData.dynamicDataValues - sp-webpart-base.ISerializedWebPartData.properties - sp-webpart-base.ISerializedWebPartData.serverProcessedContent - uid: sp-webpart-base.ISerializedWebPartData.dataVersion @@ -34,6 +36,51 @@ items: return: type: - Version + - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths + summary: >- + Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. + The key is the path within the web part properties, and the value is the dynamic data internal id. + + + Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } + isPreview: true + name: dynamicDataPaths + fullName: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths + langs: + - typeScript + type: property + syntax: + content: 'dynamicDataPaths?:' + return: + type: + - |- + { + [path: string]: string; + } + - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataValues + summary: >- + Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the + web part. The key is the path within the web part properties, and the value is the dynamic data static value. + + + Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true } + isPreview: true + name: dynamicDataValues + fullName: sp-webpart-base.ISerializedWebPartData.dynamicDataValues + langs: + - typeScript + type: property + syntax: + content: 'dynamicDataValues?:' + return: + type: + - |- + { + [path: string]: any; + } - uid: sp-webpart-base.ISerializedWebPartData.properties summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index f7f2fc9c..3c1d19e7 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -14,6 +14,8 @@ items: children: - sp-webpart-base.IWebPartData.dataVersion - sp-webpart-base.IWebPartData.description + - sp-webpart-base.IWebPartData.dynamicDataPaths + - sp-webpart-base.IWebPartData.dynamicDataValues - sp-webpart-base.IWebPartData.id - sp-webpart-base.IWebPartData.instanceId - sp-webpart-base.IWebPartData.properties @@ -54,6 +56,51 @@ items: return: type: - string + - uid: sp-webpart-base.IWebPartData.dynamicDataPaths + summary: >- + Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. + The key is the path within the web part properties, and the value is the dynamic data internal id. + + + Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } + isPreview: true + name: dynamicDataPaths + fullName: sp-webpart-base.IWebPartData.dynamicDataPaths + langs: + - typeScript + type: property + syntax: + content: 'dynamicDataPaths?:' + return: + type: + - |- + { + [path: string]: string; + } + - uid: sp-webpart-base.IWebPartData.dynamicDataValues + summary: >- + Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web + part. The key is the path within the web part properties, and the value is the dynamic data static value. + + + Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true } + isPreview: true + name: dynamicDataValues + fullName: sp-webpart-base.IWebPartData.dynamicDataValues + langs: + - typeScript + type: property + syntax: + content: 'dynamicDataValues?:' + return: + type: + - |- + { + [path: string]: any; + } - uid: sp-webpart-base.IWebPartData.id summary: Universally unique web part Type id. remarks: >- diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 7d6ea7ad..05794a2d 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -46,7 +46,7 @@ items: - typeScript type: method syntax: - content: '[ key: string ]: IWebPartPropertyMetadata;' + content: '[key: string]: IWebPartPropertyMetadata;' return: type: - IWebPartPropertyMetadata diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 73071316..d5a8d1f7 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -25,6 +25,7 @@ items: langs: - typeScript type: field + numericValue: '4' - uid: sp-webpart-base.PropertyPaneButtonType.Compound summary: Always used as a set with both Standard and Primary compound buttons. remarks: >- @@ -35,6 +36,7 @@ items: langs: - typeScript type: field + numericValue: '3' - uid: sp-webpart-base.PropertyPaneButtonType.Hero summary: Hero button. name: Hero @@ -42,6 +44,7 @@ items: langs: - typeScript type: field + numericValue: '2' - uid: sp-webpart-base.PropertyPaneButtonType.Icon summary: >- Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within @@ -57,6 +60,7 @@ items: langs: - typeScript type: field + numericValue: '5' - uid: sp-webpart-base.PropertyPaneButtonType.Normal summary: Optional completion action. remarks: >- @@ -68,6 +72,7 @@ items: langs: - typeScript type: field + numericValue: '0' - uid: sp-webpart-base.PropertyPaneButtonType.Primary summary: Preferred completion action when paired with a Standard button. remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' @@ -76,3 +81,4 @@ items: langs: - typeScript type: field + numericValue: '1' diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 17fb21aa..ca2d4291 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -17,6 +17,7 @@ items: - sp-webpart-base.PropertyPaneFieldType.ChoiceGroup - sp-webpart-base.PropertyPaneFieldType.Custom - sp-webpart-base.PropertyPaneFieldType.Dropdown + - sp-webpart-base.PropertyPaneFieldType.DynamicTextField - sp-webpart-base.PropertyPaneFieldType.Heading - sp-webpart-base.PropertyPaneFieldType.HorizontalRule - sp-webpart-base.PropertyPaneFieldType.Label @@ -64,6 +65,15 @@ items: - typeScript type: field numericValue: '6' + - uid: sp-webpart-base.PropertyPaneFieldType.DynamicTextField + summary: Dynamic Text Field + isPreview: true + name: DynamicTextField + fullName: sp-webpart-base.PropertyPaneFieldType.DynamicTextField + langs: + - typeScript + type: field + numericValue: '15' - uid: sp-webpart-base.PropertyPaneFieldType.Heading summary: Heading field. name: Heading diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index be0f00e4..1b5e1ac7 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -17,11 +17,8 @@ items: package: sp-webpart-base children: - sp-webpart-base.WebPartContext.domElement - - sp-webpart-base.WebPartContext.graphHttpClient - - sp-webpart-base.WebPartContext.httpClient - sp-webpart-base.WebPartContext.manifest - sp-webpart-base.WebPartContext.propertyPane - - sp-webpart-base.WebPartContext.spHttpClient - sp-webpart-base.WebPartContext.statusRenderer - sp-webpart-base.WebPartContext.webPartTag - uid: sp-webpart-base.WebPartContext.domElement @@ -32,35 +29,10 @@ items: - typeScript type: property syntax: - content: 'public readonly domElement: HTMLElement;' + content: 'readonly domElement: HTMLElement;' return: type: - HTMLElement - - uid: sp-webpart-base.WebPartContext.graphHttpClient - summary: GraphHttpClient instance scoped to this web part. - isPreview: true - name: graphHttpClient - fullName: sp-webpart-base.WebPartContext.graphHttpClient - langs: - - typeScript - type: property - syntax: - content: 'public readonly graphHttpClient: GraphHttpClient;' - return: - type: - - GraphHttpClient - - uid: sp-webpart-base.WebPartContext.httpClient - summary: HttpClient instance scoped to this web part. - name: httpClient - fullName: sp-webpart-base.WebPartContext.httpClient - langs: - - typeScript - type: property - syntax: - content: 'public readonly httpClient: HttpClient;' - return: - type: - - HttpClient - uid: sp-webpart-base.WebPartContext.manifest summary: Manifest for the client side component. name: manifest @@ -69,7 +41,7 @@ items: - typeScript type: property syntax: - content: 'public readonly manifest: IClientSideWebPartManifestInstance;' + content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: type: - IClientSideWebPartManifestInstance @@ -81,22 +53,10 @@ items: - typeScript type: property syntax: - content: 'public readonly propertyPane: IPropertyPaneAccessor;' + content: 'readonly propertyPane: IPropertyPaneAccessor;' return: type: - IPropertyPaneAccessor - - uid: sp-webpart-base.WebPartContext.spHttpClient - summary: SPHttpClient instance scoped to this web part. - name: spHttpClient - fullName: sp-webpart-base.WebPartContext.spHttpClient - langs: - - typeScript - type: property - syntax: - content: 'public readonly spHttpClient: SPHttpClient;' - return: - type: - - SPHttpClient - uid: sp-webpart-base.WebPartContext.statusRenderer summary: Web part status renderer. name: statusRenderer @@ -105,7 +65,7 @@ items: - typeScript type: property syntax: - content: 'public readonly statusRenderer: IClientSideWebPartStatusRenderer;' + content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: type: - IClientSideWebPartStatusRenderer @@ -117,7 +77,7 @@ items: - typeScript type: property syntax: - content: 'public readonly webPartTag: string;' + content: 'readonly webPartTag: string;' return: type: - string diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index b905966b..c7dd5a4c 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -27,6 +27,12 @@ uid: sp-component-base.BaseComponent - name: BaseComponentContext uid: sp-component-base.BaseComponentContext + - name: DynamicDataProvider + uid: sp-component-base.DynamicDataProvider + - name: DynamicDataSourceManager + uid: sp-component-base.DynamicDataSourceManager + - name: DynamicProperty + uid: sp-component-base.DynamicProperty - name: sp-core-library uid: sp-core-library items: @@ -36,20 +42,16 @@ uid: sp-core-library.Environment - name: EnvironmentType uid: sp-core-library.EnvironmentType - - name: Event - uid: sp-core-library.Event - - name: EventArgs - uid: sp-core-library.EventArgs - name: Guid uid: sp-core-library.Guid - name: IDisposable uid: sp-core-library.IDisposable - - name: IEventObserver - uid: sp-core-library.IEventObserver - name: IRandomNumberGenerator uid: sp-core-library.IRandomNumberGenerator - name: IServiceCollection uid: sp-core-library.IServiceCollection + - name: ISPEventObserver + uid: sp-core-library.ISPEventObserver - name: ITimeProvider uid: sp-core-library.ITimeProvider - name: Log @@ -62,6 +64,10 @@ uid: sp-core-library.ServiceScope - name: Session uid: sp-core-library.Session + - name: SPEvent + uid: sp-core-library.SPEvent + - name: SPEventArgs + uid: sp-core-library.SPEventArgs - name: Text uid: sp-core-library.Text - name: TimeProvider @@ -89,6 +95,19 @@ uid: sp-dialog.IPromptOptions - name: SecondaryDialogProvider uid: sp-dialog.SecondaryDialogProvider + - name: sp-dynamic-data + uid: sp-dynamic-data + items: + - name: DynamicDataReference + uid: sp-dynamic-data.DynamicDataReference + - name: IDynamicDataController + uid: sp-dynamic-data.IDynamicDataController + - name: IDynamicDataPropertyDefinition + uid: sp-dynamic-data.IDynamicDataPropertyDefinition + - name: IDynamicDataSource + uid: sp-dynamic-data.IDynamicDataSource + - name: IDynamicDataSourceMetadata + uid: sp-dynamic-data.IDynamicDataSourceMetadata - name: sp-extension-base uid: sp-extension-base items: @@ -99,6 +118,16 @@ - name: sp-http uid: sp-http items: + - name: AadHttpClient + uid: sp-http.AadHttpClient + - name: AadHttpClientConfiguration + uid: sp-http.AadHttpClientConfiguration + - name: AadHttpClientFactory + uid: sp-http.AadHttpClientFactory + - name: AadTokenProvider + uid: sp-http.AadTokenProvider + - name: AadTokenProviderFactory + uid: sp-http.AadTokenProviderFactory - name: GraphHttpClient uid: sp-http.GraphHttpClient - name: GraphHttpClientConfiguration @@ -111,6 +140,12 @@ uid: sp-http.HttpClientConfiguration - name: HttpClientResponse uid: sp-http.HttpClientResponse + - name: IAadHttpClientConfiguration + uid: sp-http.IAadHttpClientConfiguration + - name: IAadHttpClientConfigurations + uid: sp-http.IAadHttpClientConfigurations + - name: IAadTokenProviderConfiguration + uid: sp-http.IAadTokenProviderConfiguration - name: IGraphHttpClientConfiguration uid: sp-http.IGraphHttpClientConfiguration - name: IGraphHttpClientConfigurations @@ -155,6 +190,8 @@ uid: sp-http.SPHttpClientResponse - name: SPHttpHeader uid: sp-http.SPHttpHeader + - name: TokenAcquisitionEventArgs + uid: sp-http.TokenAcquisitionEventArgs - name: sp-listview-extensibility uid: sp-listview-extensibility items: @@ -253,10 +290,14 @@ uid: sp-webpart-base.IPropertyPaneConfiguration - name: IPropertyPaneCustomFieldProps uid: sp-webpart-base.IPropertyPaneCustomFieldProps + - name: IPropertyPaneDropdownCalloutProps + uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps - name: IPropertyPaneDropdownOption uid: sp-webpart-base.IPropertyPaneDropdownOption - name: IPropertyPaneDropdownProps uid: sp-webpart-base.IPropertyPaneDropdownProps + - name: IPropertyPaneDynamicTextFieldProps + uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps - name: IPropertyPaneField uid: sp-webpart-base.IPropertyPaneField - name: IPropertyPaneGroup From 31685efd2e39406236051e00ab5ec4648d7896c9 Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Tue, 5 Jun 2018 13:57:45 +0300 Subject: [PATCH 16/55] Updated API docs for 1.5 release --- SP-Framework/sp-diagnostics.yml | 11 ++ SP-Framework/spfx-toc/toc.yml | 4 + generate-docs/json/recopy.bat | 2 + generate-docs/json/sp-diagnostics.api.json | 12 ++ generate-docs/json/sp-dynamic-data.api.json | 8 +- generate-docs/json/sp-http.api.json | 127 ++++++++++++++++++-- 6 files changed, 152 insertions(+), 12 deletions(-) create mode 100644 SP-Framework/sp-diagnostics.yml create mode 100644 generate-docs/json/sp-diagnostics.api.json diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml new file mode 100644 index 00000000..b9ca7c6a --- /dev/null +++ b/SP-Framework/sp-diagnostics.yml @@ -0,0 +1,11 @@ +### YamlMime:UniversalReference +items: + - uid: sp-diagnostics + summary: >- + This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, + user engagement and performance logging. + name: '@microsoft/sp-diagnostics' + fullName: sp-diagnostics + langs: + - typeScript + type: package diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index c7dd5a4c..ad726b46 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -78,6 +78,8 @@ uid: sp-core-library.Validate - name: Version uid: sp-core-library.Version + - name: sp-diagnostics + uid: sp-diagnostics - name: sp-dialog uid: sp-dialog items: @@ -144,6 +146,8 @@ uid: sp-http.IAadHttpClientConfiguration - name: IAadHttpClientConfigurations uid: sp-http.IAadHttpClientConfigurations + - name: IAadTokenProvider + uid: sp-http.IAadTokenProvider - name: IAadTokenProviderConfiguration uid: sp-http.IAadTokenProviderConfiguration - name: IGraphHttpClientConfiguration diff --git a/generate-docs/json/recopy.bat b/generate-docs/json/recopy.bat index 54ec084e..eceb00bf 100644 --- a/generate-docs/json/recopy.bat +++ b/generate-docs/json/recopy.bat @@ -12,5 +12,7 @@ copy /y ..\..\..\sp-client\spfx-core\decorators\dist\*.api.json . copy /y ..\..\..\sp-client\spfx-core\sp-dialog\dist\*.api.json . copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\dist\*.api.json . copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-diagnostics\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-property-pane\dist\*.api.json . pause diff --git a/generate-docs/json/sp-diagnostics.api.json b/generate-docs/json/sp-diagnostics.api.json new file mode 100644 index 00000000..b13df3c7 --- /dev/null +++ b/generate-docs/json/sp-diagnostics.api.json @@ -0,0 +1,12 @@ +{ + "kind": "package", + "name": "@microsoft/sp-diagnostics", + "summary": [ + { + "kind": "text", + "text": "This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user engagement and performance logging." + } + ], + "remarks": [], + "exports": {} +} diff --git a/generate-docs/json/sp-dynamic-data.api.json b/generate-docs/json/sp-dynamic-data.api.json index 70db8eae..453646db 100644 --- a/generate-docs/json/sp-dynamic-data.api.json +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -24,10 +24,9 @@ { "kind": "text", "text": "Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data" - }, - { - "kind": "paragraph" - }, + } + ], + "remarks": [ { "kind": "text", "text": "The reference string is of the form : or ::" @@ -40,7 +39,6 @@ "text": "Examples of references are: PageContext:user WebPart..:myComplexProperty:myArray[0].lastName" } ], - "remarks": [], "isBeta": true, "isSealed": false, "members": { diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index e5b736da..ee8a5253 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -424,12 +424,12 @@ "members": { "getExtendedClient": { "kind": "method", - "signature": "getExtendedClient(resourceEndpoint: string): AadHttpClient | undefined;", + "signature": "getExtendedClient(resourceEndpoint: string): AadHttpClient;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { - "type": "AadHttpClient | undefined", + "type": "AadHttpClient", "description": [] }, "parameters": { @@ -461,12 +461,12 @@ }, "getStandardClient": { "kind": "method", - "signature": "getStandardClient(resourceEndpoint: string): AadHttpClient | undefined;", + "signature": "getStandardClient(resourceEndpoint: string): AadHttpClient;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { - "type": "AadHttpClient | undefined", + "type": "AadHttpClient", "description": [] }, "parameters": { @@ -501,7 +501,7 @@ "AadTokenProvider": { "kind": "class", "extends": "", - "implements": "", + "implements": "IAadTokenProvider", "typeParameters": [], "deprecatedMessage": [], "summary": [ @@ -669,12 +669,12 @@ "members": { "getExtendedProvider": { "kind": "method", - "signature": "getExtendedProvider(): AadTokenProvider | undefined;", + "signature": "getExtendedProvider(): IAadTokenProvider;", "accessModifier": "", "isOptional": false, "isStatic": false, "returnValue": { - "type": "AadTokenProvider | undefined", + "type": "IAadTokenProvider", "description": [] }, "parameters": {}, @@ -2158,6 +2158,119 @@ } } }, + "IAadTokenProvider": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class allows a developer to obtain OAuth2 tokens from Azure AD." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc." + } + ], + "remarks": [ + { + "kind": "text", + "text": "AadTokenProvider is replacing the /_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL." + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "getToken": { + "kind": "method", + "signature": "getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that will be fullfiled with the token or that will reject with an error message" + } + ] + }, + "parameters": { + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [ + { + "kind": "text", + "text": "the resource for which the token should be obtained" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IAadTokenProviderConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "An example of a resourceEndpoint would be https://sdfpilot.outlook.com" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tokenAcquisitionEvent": { + "kind": "property", + "signature": "tokenAcquisitionEvent: SPEvent;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies the developer when Token Acquistion requires user action." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, "IAadTokenProviderConfiguration": { "kind": "interface", "extends": "", From 836759faccc1842b4a0aad7c19b4a6118a177df9 Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Tue, 5 Jun 2018 14:02:08 +0300 Subject: [PATCH 17/55] Updated API descriptions --- .../sp-dynamic-data/dynamicdatareference.yml | 3 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 8 +-- SP-Framework/sp-http/aadtokenprovider.yml | 2 + .../sp-http/aadtokenproviderfactory.yml | 4 +- SP-Framework/sp-http/iaadtokenprovider.yml | 64 +++++++++++++++++++ 5 files changed, 73 insertions(+), 8 deletions(-) create mode 100644 SP-Framework/sp-http/iaadtokenprovider.yml diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 580a8d07..07d12a91 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -4,8 +4,7 @@ items: summary: >- Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data - - + remarks: >- The reference string is of the form <sourceId>:<property> or <sourceId>:<property>:<propertyPath> diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 33cd78ba..afb01c40 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -28,10 +28,10 @@ items: - typeScript type: method syntax: - content: 'getExtendedClient(resourceEndpoint: string): AadHttpClient | undefined;' + content: 'getExtendedClient(resourceEndpoint: string): AadHttpClient;' return: type: - - AadHttpClient | undefined + - AadHttpClient description: '' parameters: - id: resourceEndpoint @@ -49,10 +49,10 @@ items: - typeScript type: method syntax: - content: 'getStandardClient(resourceEndpoint: string): AadHttpClient | undefined;' + content: 'getStandardClient(resourceEndpoint: string): AadHttpClient;' return: type: - - AadHttpClient | undefined + - AadHttpClient description: '' parameters: - id: resourceEndpoint diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 766128bb..f3dfa0fc 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -20,6 +20,8 @@ items: langs: - typeScript type: class + implements: + - IAadTokenProvider package: sp-http children: - sp-http.AadTokenProvider.constructor diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index b3ae577d..c8df67e9 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -22,8 +22,8 @@ items: - typeScript type: method syntax: - content: 'getExtendedProvider(): AadTokenProvider | undefined;' + content: 'getExtendedProvider(): IAadTokenProvider;' return: type: - - AadTokenProvider | undefined + - IAadTokenProvider description: '' diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml new file mode 100644 index 00000000..d9e369d1 --- /dev/null +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -0,0 +1,64 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadTokenProvider + summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. + + + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. + remarks: >- + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some + point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will + switch to MSAL. + isPreview: true + name: IAadTokenProvider + fullName: sp-http.IAadTokenProvider + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IAadTokenProvider.getToken + - sp-http.IAadTokenProvider.tokenAcquisitionEvent + - uid: sp-http.IAadTokenProvider.getToken + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + + The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. + + An example of a resourceEndpoint would be https://sdfpilot.outlook.com + isPreview: true + name: 'getToken(resourceEndpoint, configuration)' + fullName: sp-http.IAadTokenProvider.getToken + langs: + - typeScript + type: method + syntax: + content: 'getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;' + return: + type: + - Promise + description: A promise that will be fullfiled with the token or that will reject with an error message + parameters: + - id: resourceEndpoint + description: the resource for which the token should be obtained + type: + - string + - id: configuration + description: '' + type: + - IAadTokenProviderConfiguration + - uid: sp-http.IAadTokenProvider.tokenAcquisitionEvent + summary: Notifies the developer when Token Acquistion requires user action. + isPreview: true + name: tokenAcquisitionEvent + fullName: sp-http.IAadTokenProvider.tokenAcquisitionEvent + langs: + - typeScript + type: property + syntax: + content: 'tokenAcquisitionEvent: SPEvent;' + return: + type: + - SPEvent From fb917fad6463f5864e282951889ed0c6e72cbcfa Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 15 Jun 2018 14:24:32 -0700 Subject: [PATCH 18/55] Try UID types --- SP-Framework/sp-core-library/servicescope.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 988c5d19..749abfd1 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -181,7 +181,7 @@ items: content: 'getParent(): ServiceScope | undefined;' return: type: - - ServiceScope | undefined + - sp-core-library.ServiceKey description: the parent service scope - uid: sp-core-library.ServiceScope.provide summary: Add a new service to a service scope. @@ -203,7 +203,7 @@ items: - id: serviceKey description: the key that will later be used to consume the service type: - - ServiceKey + - sp-core-library.ServiceKey - id: service description: the service instance that is being registered type: From d9f57c2fc9e87d4917dcda5f4534c21e473cb580 Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 5 Oct 2018 15:57:52 -0700 Subject: [PATCH 19/55] Regenerate documentation based on 10/3/2018 master branch of sp-client --- .../applicationaccessor.yml | 2 +- .../placeholderprovider.yml | 2 +- .../basecomponentcontext.yml | 37 +- .../sp-component-base/dynamicdataprovider.yml | 4 +- .../dynamicdatasourcemanager.yml | 41 +- .../sp-component-base/dynamicproperty.yml | 2 +- SP-Framework/sp-core-library/servicekey.yml | 14 +- SP-Framework/sp-core-library/servicescope.yml | 4 +- SP-Framework/sp-core-library/text.yml | 28 + SP-Framework/sp-dialog.yml | 6 +- SP-Framework/sp-dialog/basedialog.yml | 15 +- SP-Framework/sp-dialog/dialog.yml | 3 - SP-Framework/sp-dialog/ialertoptions.yml | 1 - .../sp-dialog/idialogconfiguration.yml | 2 - SP-Framework/sp-dialog/idialogshowoptions.yml | 2 - SP-Framework/sp-dialog/ipromptoptions.yml | 2 - ...vider.yml => isecondarydialogprovider.yml} | 204 +- SP-Framework/sp-dynamic-data.yml | 9 +- ...ntroller.yml => idynamicdatacallables.yml} | 18 +- .../idynamicdatapropertydefinition.yml | 34 +- .../idynamicdatapropertymetadata.yml | 44 + .../sp-dynamic-data/idynamicdatasource.yml | 14 +- SP-Framework/sp-http.yml | 21 +- SP-Framework/sp-http/aadhttpclient.yml | 64 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 43 +- SP-Framework/sp-http/aadtokenprovider.yml | 43 +- .../sp-http/aadtokenproviderfactory.yml | 29 +- SP-Framework/sp-http/digestcache.yml | 141 + SP-Framework/sp-http/graphhttpclient.yml | 14 + SP-Framework/sp-http/graphrequest.yml | 568 + .../sp-http/iaadhttpclientoptions.yml | 35 + SP-Framework/sp-http/iaadtokenprovider.yml | 64 - .../iaadtokenproviderconfiguration.yml | 86 - SP-Framework/sp-http/idigestcache.yml | 111 + SP-Framework/sp-http/msgraphclient.yml | 54 + SP-Framework/sp-http/msgraphclientfactory.yml | 45 + .../sp-http/tokenacquisitioneventargs.yml | 5 +- .../listviewaccessor.yml | 2 +- .../iodatacontextwebinformation.yml | 26 - SP-Framework/sp-page-context.yml | 12 + .../sp-page-context/ispsystemtime.yml | 116 + .../sp-page-context/isptimezonedata.yml | 103 + SP-Framework/sp-page-context/spdayofweek.yml | 75 + SP-Framework/sp-page-context/sptimezone.yml | 124 + SP-Framework/sp-page-context/spuser.yml | 28 + SP-Framework/sp-page-context/spweb.yml | 28 + SP-Framework/sp-property-pane.yml | 10 + SP-Framework/sp-webpart-base.yml | 9 + .../sp-webpart-base/baseclientsidewebpart.yml | 359 +- SP-Framework/sp-webpart-base/basewebpart.yml | 439 + .../sp-webpart-base/basewebpartcontext.yml | 60 + .../iclientsidewebpartstatusrenderer.yml | 4 +- .../sp-webpart-base/ipropertypanepage.yml | 4 +- .../iwebpartpropertymetadata.yml | 106 + .../sp-webpart-base/webpartcontext.yml | 41 +- SP-Framework/spfx-toc/toc.yml | 42 +- generate-docs/json/decorators.api.json | 248 +- .../json/sp-application-base.api.json | 1606 +- generate-docs/json/sp-component-base.api.json | 3199 ++-- generate-docs/json/sp-core-library.api.json | 7206 ++++----- generate-docs/json/sp-dialog.api.json | 1946 +-- generate-docs/json/sp-dynamic-data.api.json | 114 +- generate-docs/json/sp-extension-base.api.json | 282 +- generate-docs/json/sp-http.api.json | 11126 +++++++------ .../json/sp-listview-extensibility.api.json | 2421 +-- generate-docs/json/sp-odata-types.api.json | 3716 ++--- generate-docs/json/sp-page-context.api.json | 5329 ++++--- generate-docs/json/sp-webpart-base.api.json | 12952 ++++++++-------- 68 files changed, 29000 insertions(+), 24544 deletions(-) rename SP-Framework/sp-dialog/{secondarydialogprovider.yml => isecondarydialogprovider.yml} (77%) rename SP-Framework/sp-dynamic-data/{idynamicdatacontroller.yml => idynamicdatacallables.yml} (70%) create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml create mode 100644 SP-Framework/sp-http/digestcache.yml create mode 100644 SP-Framework/sp-http/graphrequest.yml create mode 100644 SP-Framework/sp-http/iaadhttpclientoptions.yml delete mode 100644 SP-Framework/sp-http/iaadtokenprovider.yml delete mode 100644 SP-Framework/sp-http/iaadtokenproviderconfiguration.yml create mode 100644 SP-Framework/sp-http/idigestcache.yml create mode 100644 SP-Framework/sp-http/msgraphclient.yml create mode 100644 SP-Framework/sp-http/msgraphclientfactory.yml create mode 100644 SP-Framework/sp-page-context/ispsystemtime.yml create mode 100644 SP-Framework/sp-page-context/isptimezonedata.yml create mode 100644 SP-Framework/sp-page-context/spdayofweek.yml create mode 100644 SP-Framework/sp-page-context/sptimezone.yml create mode 100644 SP-Framework/sp-property-pane.yml create mode 100644 SP-Framework/sp-webpart-base/basewebpart.yml create mode 100644 SP-Framework/sp-webpart-base/basewebpartcontext.yml create mode 100644 SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index d9fcff4d..c3939493 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -50,7 +50,7 @@ items: fullName: sp-application-base.ApplicationAccessor.navigatedEvent langs: - typeScript - type: property + type: event syntax: content: 'readonly navigatedEvent: SPEvent;' return: diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index c170ddb3..891f7a1a 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -40,7 +40,7 @@ items: fullName: sp-application-base.PlaceholderProvider.changedEvent langs: - typeScript - type: property + type: event syntax: content: 'readonly changedEvent: SPEvent;' return: diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 429a136e..ac32ac5c 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -19,8 +19,8 @@ items: - IDisposable package: sp-component-base children: - - sp-component-base.BaseComponentContext.aadClientFactory - - sp-component-base.BaseComponentContext.aadTokenFactory + - sp-component-base.BaseComponentContext.aadHttpClientFactory + - sp-component-base.BaseComponentContext.aadTokenProviderFactory - sp-component-base.BaseComponentContext.dispose - sp-component-base.BaseComponentContext.dynamicDataProvider - sp-component-base.BaseComponentContext.dynamicDataSourceManager @@ -29,32 +29,31 @@ items: - sp-component-base.BaseComponentContext.instanceId - sp-component-base.BaseComponentContext.isDisposed - sp-component-base.BaseComponentContext.manifest + - sp-component-base.BaseComponentContext.msGraphClientFactory - sp-component-base.BaseComponentContext.pageContext - sp-component-base.BaseComponentContext.serviceScope - sp-component-base.BaseComponentContext.spHttpClient - - uid: sp-component-base.BaseComponentContext.aadClientFactory + - uid: sp-component-base.BaseComponentContext.aadHttpClientFactory summary: The instance of AadHttpClientFactory created for this instance of component - isPreview: true - name: aadClientFactory - fullName: sp-component-base.BaseComponentContext.aadClientFactory + name: aadHttpClientFactory + fullName: sp-component-base.BaseComponentContext.aadHttpClientFactory langs: - typeScript type: property syntax: - content: 'readonly aadClientFactory: AadHttpClientFactory;' + content: 'readonly aadHttpClientFactory: AadHttpClientFactory;' return: type: - AadHttpClientFactory - - uid: sp-component-base.BaseComponentContext.aadTokenFactory + - uid: sp-component-base.BaseComponentContext.aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component - isPreview: true - name: aadTokenFactory - fullName: sp-component-base.BaseComponentContext.aadTokenFactory + name: aadTokenProviderFactory + fullName: sp-component-base.BaseComponentContext.aadTokenProviderFactory langs: - typeScript type: property syntax: - content: 'readonly aadTokenFactory: AadTokenProviderFactory;' + content: 'readonly aadTokenProviderFactory: AadTokenProviderFactory;' return: type: - AadTokenProviderFactory @@ -99,6 +98,8 @@ items: - DynamicDataSourceManager - uid: sp-component-base.BaseComponentContext.graphHttpClient summary: The instance of GraphHttpClient created for this instance of component + deprecated: + content: '' isPreview: true name: graphHttpClient fullName: sp-component-base.BaseComponentContext.graphHttpClient @@ -162,6 +163,18 @@ items: return: type: - IClientSideComponentManifest + - uid: sp-component-base.BaseComponentContext.msGraphClientFactory + summary: The instance of MSGraphClientFactory created for this instance of component + name: msGraphClientFactory + fullName: sp-component-base.BaseComponentContext.msGraphClientFactory + langs: + - typeScript + type: property + syntax: + content: 'readonly msGraphClientFactory: MSGraphClientFactory;' + return: + type: + - MSGraphClientFactory - uid: sp-component-base.BaseComponentContext.pageContext summary: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 3266baa0..90c3043b 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -2,8 +2,8 @@ items: - uid: sp-component-base.DynamicDataProvider summary: >- - The Dynamic Data Provider allows components to consume Dynamic Data. It allows data consumers to request Dynamic - Data sources and register/unregister to those. + The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data + sources and register/unregister to those. isPreview: true name: DynamicDataProvider fullName: sp-component-base.DynamicDataProvider diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 510e95b1..876f187e 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -2,8 +2,9 @@ items: - uid: sp-component-base.DynamicDataSourceManager summary: >- - The Dynamic Data Source Manager allows components to expose data to other components through Dynamic Data. It - allows data providers to update their metadata and notify when data has been updated. + The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing + initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify + when data has been updated. isPreview: true name: DynamicDataSourceManager fullName: sp-component-base.DynamicDataSourceManager @@ -21,7 +22,7 @@ items: - sp-component-base.DynamicDataSourceManager.notifySourceChanged - sp-component-base.DynamicDataSourceManager.updateMetadata - uid: sp-component-base.DynamicDataSourceManager.dispose - summary: Disposes the Dynamic Data Provider. + summary: Disposes the resources held by the Dynamic Data source. isPreview: true name: dispose() fullName: sp-component-base.DynamicDataSourceManager.dispose @@ -35,26 +36,28 @@ items: - void description: '' - uid: sp-component-base.DynamicDataSourceManager.initializeSource - summary: Initializes a Dynamic Data Source for the component. + summary: Initializes the Dynamic Data Source for the component. isPreview: true - name: initializeSource(controller) + name: initializeSource(callableFunctions) fullName: sp-component-base.DynamicDataSourceManager.initializeSource langs: - typeScript type: method syntax: - content: 'initializeSource(controller: IDynamicDataController): void;' + content: 'initializeSource(callableFunctions: IDynamicDataCallables): void;' return: type: - void description: '' parameters: - - id: controller - description: Set of functions for the Dynamic Data Source. + - id: callableFunctions + description: >- + Set of methods exposed by the Dynamic Data Source to get the data. These apis are called by the consumer to + retrieve properties, their values etc., type: - - IDynamicDataController + - IDynamicDataCallables - uid: sp-component-base.DynamicDataSourceManager.isDisposed - summary: Returns true if the Dynamic Data Provider is disposed. + summary: Returns true if the DynamicDataSourceManager is disposed. isPreview: true name: isDisposed fullName: sp-component-base.DynamicDataSourceManager.isDisposed @@ -67,7 +70,12 @@ items: type: - boolean - uid: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged - summary: Notifies any Dynamic Data consumer that this source has updated a specific property. + summary: >- + Notifies that this source has updated a specific property. + + + When invoked, it enables to broadcast the notification to all the consumers who have registered to this + notification from this source. isPreview: true name: notifyPropertyChanged(propertyId) fullName: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged @@ -86,7 +94,12 @@ items: type: - string - uid: sp-component-base.DynamicDataSourceManager.notifySourceChanged - summary: Notifies any Dynamic Data consumer that this source has updated its data. + summary: >- + Notifies that this source has updated its data. + + + When invoked, it enables to broadcast the notification to all the consumers who have registered to this + notification from this source. isPreview: true name: notifySourceChanged() fullName: sp-component-base.DynamicDataSourceManager.notifySourceChanged @@ -101,8 +114,8 @@ items: description: '' - uid: sp-component-base.DynamicDataSourceManager.updateMetadata summary: >- - Updated the metadata of the Dynamic Data Source associated with the component. It allows to updated fields like - title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. + Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. + Auto-generated fields like alias, componentId or instanceId cannot be updated. isPreview: true name: updateMetadata(metadata) fullName: sp-component-base.DynamicDataSourceManager.updateMetadata diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index af2f525d..bb630f9c 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -29,7 +29,7 @@ items: - sp-component-base.DynamicProperty.tryGetValue - sp-component-base.DynamicProperty.unregister - uid: sp-component-base.DynamicProperty.constructor - summary: Create a new Dynamic Data object. + summary: Create a new Dynamic Property object. name: 'constructor(provider, callback)' fullName: sp-component-base.DynamicProperty.constructor langs: diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 409f9fae..b5e798b0 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -89,8 +89,18 @@ items: type: - ServiceCreator - uid: sp-core-library.ServiceKey.id - summary: A unique identifier for this service. - remarks: The identifier is a currently generated by incrementing an integer counter; however this may change in the future. + summary: A unique identifier for this service key. + remarks: >- + This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers + should not make assumptions about the formatting of this string. It is currently based on a global counter, but + this may change in the future. + + + The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant + to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name + was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a + different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in + which libraries are loaded should never affect the resulting tree of scopes. name: id fullName: sp-core-library.ServiceKey.id langs: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 749abfd1..988c5d19 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -181,7 +181,7 @@ items: content: 'getParent(): ServiceScope | undefined;' return: type: - - sp-core-library.ServiceKey + - ServiceScope | undefined description: the parent service scope - uid: sp-core-library.ServiceScope.provide summary: Add a new service to a service scope. @@ -203,7 +203,7 @@ items: - id: serviceKey description: the key that will later be used to consume the service type: - - sp-core-library.ServiceKey + - ServiceKey - id: service description: the service instance that is being registered type: diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index 06256ed6..0a52130b 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -11,6 +11,7 @@ items: package: sp-core-library children: - sp-core-library.Text.format + - sp-core-library.Text.replaceAll - uid: sp-core-library.Text.format summary: Format a string by substituting parameters. remarks: >- @@ -43,3 +44,30 @@ items: description: '' type: - 'any[]' + - uid: sp-core-library.Text.replaceAll + summary: 'Returns the input string, with all instances of searchValue replaced by replaceValue.' + remarks: 'Note that JavaScript''s string.replace() only replaces the first match, unless a global RegExp is provided.' + name: 'replaceAll(input, searchValue, replaceValue)' + fullName: sp-core-library.Text.replaceAll + langs: + - typeScript + type: method + syntax: + content: 'static replaceAll(input: string, searchValue: string, replaceValue: string): string;' + return: + type: + - string + description: '' + parameters: + - id: input + description: The string to be modified + type: + - string + - id: searchValue + description: The value to search for + type: + - string + - id: replaceValue + description: The replacement text + type: + - string diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index 1583228a..0f8d5e50 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -18,7 +18,7 @@ items: - sp-dialog.IDialogConfiguration - sp-dialog.IDialogShowOptions - sp-dialog.IPromptOptions - - sp-dialog.SecondaryDialogProvider + - sp-dialog.ISecondaryDialogProvider references: - uid: sp-dialog.BaseDialog name: BaseDialog @@ -32,5 +32,5 @@ references: name: IDialogShowOptions - uid: sp-dialog.IPromptOptions name: IPromptOptions - - uid: sp-dialog.SecondaryDialogProvider - name: SecondaryDialogProvider + - uid: sp-dialog.ISecondaryDialogProvider + name: ISecondaryDialogProvider diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 0a90a0b4..a9eaf410 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -11,7 +11,6 @@ items: how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class. - isPreview: true name: BaseDialog fullName: sp-dialog.BaseDialog langs: @@ -64,7 +63,6 @@ items: Close the dialog. This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - isPreview: true name: close() fullName: sp-dialog.BaseDialog.close langs: @@ -81,7 +79,6 @@ items: Use this property to access the container element provided by the framework for rendering. See [BaseDialog.render](xref:sp-dialog.BaseDialog.render) for more information on rendering. - isPreview: true name: domElement fullName: sp-dialog.BaseDialog.domElement langs: @@ -97,7 +94,6 @@ items: If the dialog is visually hidden. This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - isPreview: true name: isHidden fullName: sp-dialog.BaseDialog.isHidden langs: @@ -112,7 +108,6 @@ items: summary: >- If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. - isPreview: true name: isOpen fullName: sp-dialog.BaseDialog.isOpen langs: @@ -125,7 +120,6 @@ items: - boolean - uid: sp-dialog.BaseDialog.isSecondary summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. - isPreview: true name: isSecondary fullName: sp-dialog.BaseDialog.isSecondary langs: @@ -143,7 +137,6 @@ items: may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - isPreview: true name: onAfterClose() fullName: sp-dialog.BaseDialog.onAfterClose langs: @@ -160,7 +153,6 @@ items: This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. remarks: All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak. - isPreview: true name: onBeforeOpen() fullName: sp-dialog.BaseDialog.onBeforeOpen langs: @@ -186,7 +178,6 @@ items: you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. - isPreview: true name: render() fullName: sp-dialog.BaseDialog.render langs: @@ -206,20 +197,18 @@ items: Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - isPreview: true name: secondaryDialogProvider fullName: sp-dialog.BaseDialog.secondaryDialogProvider langs: - typeScript type: property syntax: - content: 'readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;' + content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' return: type: - - SecondaryDialogProvider | undefined + - ISecondaryDialogProvider | undefined - uid: sp-dialog.BaseDialog.show summary: Request the framework to show this dialog. - isPreview: true name: show(options) fullName: sp-dialog.BaseDialog.show langs: diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 1c8d2888..a07f183a 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -2,7 +2,6 @@ items: - uid: sp-dialog.Dialog summary: A static class for showing stock dialogs such as an alert or prompt. - isPreview: true name: Dialog fullName: sp-dialog.Dialog langs: @@ -20,7 +19,6 @@ items: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - isPreview: true name: 'alert(message, options)' fullName: sp-dialog.Dialog.alert langs: @@ -49,7 +47,6 @@ items: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - isPreview: true name: 'prompt(message, options)' fullName: sp-dialog.Dialog.prompt langs: diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index 21fc8eef..0e3f25f3 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -2,7 +2,6 @@ items: - uid: sp-dialog.IAlertOptions summary: Options for showing an alert dialog - isPreview: true name: IAlertOptions fullName: sp-dialog.IAlertOptions langs: diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 3655d71a..31bccc57 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -2,7 +2,6 @@ items: - uid: sp-dialog.IDialogConfiguration summary: The interface for dialog configuration - isPreview: true name: IDialogConfiguration fullName: sp-dialog.IDialogConfiguration langs: @@ -13,7 +12,6 @@ items: - sp-dialog.IDialogConfiguration.isBlocking - uid: sp-dialog.IDialogConfiguration.isBlocking summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). - isPreview: true name: isBlocking fullName: sp-dialog.IDialogConfiguration.isBlocking langs: diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 9ec3de1d..decb9748 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -2,7 +2,6 @@ items: - uid: sp-dialog.IDialogShowOptions summary: Options for showing a dialog - isPreview: true name: IDialogShowOptions fullName: sp-dialog.IDialogShowOptions langs: @@ -19,7 +18,6 @@ items: requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. - isPreview: true name: confirmOpen fullName: sp-dialog.IDialogShowOptions.confirmOpen langs: diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 4c114848..837142a8 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -2,7 +2,6 @@ items: - uid: sp-dialog.IPromptOptions summary: Options for showing a prompt dialog - isPreview: true name: IPromptOptions fullName: sp-dialog.IPromptOptions langs: @@ -15,7 +14,6 @@ items: - sp-dialog.IPromptOptions.defaultValue - uid: sp-dialog.IPromptOptions.defaultValue summary: The default value for the input text field of prompt dialog - isPreview: true name: defaultValue fullName: sp-dialog.IPromptOptions.defaultValue langs: diff --git a/SP-Framework/sp-dialog/secondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml similarity index 77% rename from SP-Framework/sp-dialog/secondarydialogprovider.yml rename to SP-Framework/sp-dialog/isecondarydialogprovider.yml index 154ed044..570d9d9c 100644 --- a/SP-Framework/sp-dialog/secondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -1,104 +1,100 @@ -### YamlMime:UniversalReference -items: - - uid: sp-dialog.SecondaryDialogProvider - summary: >- - This class handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider - inside a dialog. - remarks: >- - Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has - permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide - until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to - show more secondary dialogs are rejected. - - - See [BaseDialog.secondaryDialogProvider](xref:sp-dialog.BaseDialog.secondaryDialogProvider) for how to use this. - isPreview: true - name: SecondaryDialogProvider - fullName: sp-dialog.SecondaryDialogProvider - langs: - - typeScript - type: class - package: sp-dialog - children: - - sp-dialog.SecondaryDialogProvider.alert - - sp-dialog.SecondaryDialogProvider.prompt - - sp-dialog.SecondaryDialogProvider.show - - uid: sp-dialog.SecondaryDialogProvider.alert - summary: >- - Similar to [Dialog.alert](xref:sp-dialog.Dialog.alert). The only difference is that the dialog is - immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - isPreview: true - name: 'alert(message, options)' - fullName: sp-dialog.SecondaryDialogProvider.alert - langs: - - typeScript - type: method - syntax: - content: 'alert(message: string, options?: IAlertOptions): Promise;' - return: - type: - - Promise - description: '' - parameters: - - id: message - description: '' - type: - - string - - id: options - description: 'Dialog showing options. See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' - type: - - IAlertOptions - - uid: sp-dialog.SecondaryDialogProvider.prompt - summary: >- - Similar to [Dialog.prompt](xref:sp-dialog.Dialog.prompt). The only difference is that the dialog is - immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - isPreview: true - name: 'prompt(message, options)' - fullName: sp-dialog.SecondaryDialogProvider.prompt - langs: - - typeScript - type: method - syntax: - content: 'prompt(message: string, options?: IPromptOptions): Promise;' - return: - type: - - Promise - description: '' - parameters: - - id: message - description: '' - type: - - string - - id: options - description: >- - Dialog showing options. The confirmOpen option will be ignored. - See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. - type: - - IPromptOptions - - uid: sp-dialog.SecondaryDialogProvider.show - summary: >- - Similar to [BaseDialog.show](xref:sp-dialog.BaseDialog.show). The dialog to show is passed in as parameter - and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - isPreview: true - name: 'show(dialog, options)' - fullName: sp-dialog.SecondaryDialogProvider.show - langs: - - typeScript - type: method - syntax: - content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' - return: - type: - - Promise - description: '' - parameters: - - id: dialog - description: '' - type: - - BaseDialog - - id: options - description: >- - Dialog showing options. The confirmOpen option will be ignored. - See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. - type: - - IDialogShowOptions +### YamlMime:UniversalReference +items: + - uid: sp-dialog.ISecondaryDialogProvider + summary: >- + This interface handles calls to show a secondary dialog. It's only available by calling + this.secondaryManagerProvider inside a dialog. + remarks: >- + Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has + permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide + until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to + show more secondary dialogs are rejected. + + + See [BaseDialog.secondaryDialogProvider](xref:sp-dialog.BaseDialog.secondaryDialogProvider) for how to use this. + name: ISecondaryDialogProvider + fullName: sp-dialog.ISecondaryDialogProvider + langs: + - typeScript + type: interface + package: sp-dialog + children: + - sp-dialog.ISecondaryDialogProvider.alert + - sp-dialog.ISecondaryDialogProvider.prompt + - sp-dialog.ISecondaryDialogProvider.show + - uid: sp-dialog.ISecondaryDialogProvider.alert + summary: >- + Similar to [Dialog.alert](xref:sp-dialog.Dialog.alert). The only difference is that the dialog is + immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + name: 'alert(message, options)' + fullName: sp-dialog.ISecondaryDialogProvider.alert + langs: + - typeScript + type: method + syntax: + content: 'alert(message: string, options?: IAlertOptions): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: message + description: '' + type: + - string + - id: options + description: 'Dialog showing options. See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' + type: + - IAlertOptions + - uid: sp-dialog.ISecondaryDialogProvider.prompt + summary: >- + Similar to [Dialog.prompt](xref:sp-dialog.Dialog.prompt). The only difference is that the dialog is + immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + name: 'prompt(message, options)' + fullName: sp-dialog.ISecondaryDialogProvider.prompt + langs: + - typeScript + type: method + syntax: + content: 'prompt(message: string, options?: IPromptOptions): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: message + description: '' + type: + - string + - id: options + description: >- + Dialog showing options. The confirmOpen option will be ignored. + See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. + type: + - IPromptOptions + - uid: sp-dialog.ISecondaryDialogProvider.show + summary: >- + Similar to [BaseDialog.show](xref:sp-dialog.BaseDialog.show). The dialog to show is passed in as parameter + and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + name: 'show(dialog, options)' + fullName: sp-dialog.ISecondaryDialogProvider.show + langs: + - typeScript + type: method + syntax: + content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: dialog + description: '' + type: + - BaseDialog + - id: options + description: >- + Dialog showing options. The confirmOpen option will be ignored. + See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. + type: + - IDialogShowOptions diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index 7fd97e7a..577ec9ca 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -12,17 +12,20 @@ items: type: package children: - sp-dynamic-data.DynamicDataReference - - sp-dynamic-data.IDynamicDataController + - sp-dynamic-data.IDynamicDataCallables - sp-dynamic-data.IDynamicDataPropertyDefinition + - sp-dynamic-data.IDynamicDataPropertyMetadata - sp-dynamic-data.IDynamicDataSource - sp-dynamic-data.IDynamicDataSourceMetadata references: - uid: sp-dynamic-data.DynamicDataReference name: DynamicDataReference - - uid: sp-dynamic-data.IDynamicDataController - name: IDynamicDataController + - uid: sp-dynamic-data.IDynamicDataCallables + name: IDynamicDataCallables - uid: sp-dynamic-data.IDynamicDataPropertyDefinition name: IDynamicDataPropertyDefinition + - uid: sp-dynamic-data.IDynamicDataPropertyMetadata + name: IDynamicDataPropertyMetadata - uid: sp-dynamic-data.IDynamicDataSource name: IDynamicDataSource - uid: sp-dynamic-data.IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml similarity index 70% rename from SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml rename to SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 61160798..20d0b10e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacontroller.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -1,26 +1,26 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataController + - uid: sp-dynamic-data.IDynamicDataCallables summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. isPreview: true - name: IDynamicDataController - fullName: sp-dynamic-data.IDynamicDataController + name: IDynamicDataCallables + fullName: sp-dynamic-data.IDynamicDataCallables langs: - typeScript type: interface package: sp-dynamic-data children: - - sp-dynamic-data.IDynamicDataController.getPropertyDefinitions - - sp-dynamic-data.IDynamicDataController.getPropertyValue - - uid: sp-dynamic-data.IDynamicDataController.getPropertyDefinitions + - sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions + - sp-dynamic-data.IDynamicDataCallables.getPropertyValue + - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions summary: >- Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. isPreview: true name: getPropertyDefinitions() - fullName: sp-dynamic-data.IDynamicDataController.getPropertyDefinitions + fullName: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions langs: - typeScript type: method @@ -30,13 +30,13 @@ items: type: - ReadonlyArray description: '' - - uid: sp-dynamic-data.IDynamicDataController.getPropertyValue + - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyValue summary: >- Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. isPreview: true name: getPropertyValue(propertyId) - fullName: sp-dynamic-data.IDynamicDataController.getPropertyValue + fullName: sp-dynamic-data.IDynamicDataCallables.getPropertyValue langs: - typeScript type: method diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 5b0df465..d158accb 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -10,26 +10,11 @@ items: langs: - typeScript type: interface + extends: + - IDynamicDataPropertyMetadata package: sp-dynamic-data children: - - sp-dynamic-data.IDynamicDataPropertyDefinition.description - sp-dynamic-data.IDynamicDataPropertyDefinition.id - - sp-dynamic-data.IDynamicDataPropertyDefinition.title - - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.description - summary: >- - User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the - current user" - isPreview: true - name: description - fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.description - langs: - - typeScript - type: property - syntax: - content: 'description?: string;' - return: - type: - - string - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.id summary: 'Id of the property. This can only contains letters, numbers, dashes and underscores.' remarks: 'The regular expression used to validate the constraints is /^\[a-zA-Z0-9\\-\_\]+$/ Example: "myFiles"' @@ -44,18 +29,3 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.title - summary: >- - User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current - language) - isPreview: true - name: title - fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.title - langs: - - typeScript - type: property - syntax: - content: 'title: string;' - return: - type: - - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml new file mode 100644 index 00000000..16f017aa --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -0,0 +1,44 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataPropertyMetadata + summary: Metadata of a property + isPreview: true + name: IDynamicDataPropertyMetadata + fullName: sp-dynamic-data.IDynamicDataPropertyMetadata + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataPropertyMetadata.description + - sp-dynamic-data.IDynamicDataPropertyMetadata.title + - uid: sp-dynamic-data.IDynamicDataPropertyMetadata.description + summary: >- + User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the + current user" + isPreview: true + name: description + fullName: sp-dynamic-data.IDynamicDataPropertyMetadata.description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataPropertyMetadata.title + summary: >- + User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current + language) + isPreview: true + name: title + fullName: sp-dynamic-data.IDynamicDataPropertyMetadata.title + langs: + - typeScript + type: property + syntax: + content: 'title: string;' + return: + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 59e3f83e..bb82a5c9 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -17,7 +17,9 @@ items: - sp-dynamic-data.IDynamicDataSource.id - sp-dynamic-data.IDynamicDataSource.metadata - uid: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions - summary: Returns the definitions for all the properties exposed by the source. + summary: >- + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. isPreview: true name: getPropertyDefinitions() fullName: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions @@ -32,14 +34,8 @@ items: description: '' - uid: sp-dynamic-data.IDynamicDataSource.getPropertyValue summary: >- - For a given property id, returns the value of the property. Throws an error if the property id doesn't exist in - the source. - remarks: >- - It returns a read-only copy of the property value, so modifying its value will not impact on the value in the data - source. - - - Property values are JSON-serializable objects, so there are no functions that can be called inside. + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. isPreview: true name: getPropertyValue(propertyId) fullName: sp-dynamic-data.IDynamicDataSource.getPropertyValue diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 2061dcd8..8f880f55 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -17,15 +17,18 @@ items: - sp-http.AadHttpClientFactory - sp-http.AadTokenProvider - sp-http.AadTokenProviderFactory + - sp-http.DigestCache - sp-http.GraphHttpClient - sp-http.GraphHttpClientConfiguration - sp-http.GraphHttpClientResponse + - sp-http.GraphRequest - sp-http.HttpClient - sp-http.HttpClientConfiguration - sp-http.HttpClientResponse - sp-http.IAadHttpClientConfiguration - sp-http.IAadHttpClientConfigurations - - sp-http.IAadTokenProviderConfiguration + - sp-http.IAadHttpClientOptions + - sp-http.IDigestCache - sp-http.IGraphHttpClientConfiguration - sp-http.IGraphHttpClientConfigurations - sp-http.IGraphHttpClientOptions @@ -40,6 +43,8 @@ items: - sp-http.ISPHttpClientConfiguration - sp-http.ISPHttpClientConfigurations - sp-http.ISPHttpClientOptions + - sp-http.MSGraphClient + - sp-http.MSGraphClientFactory - sp-http.ODataVersion - sp-http.SPHttpClient - sp-http.SPHttpClientBatch @@ -60,12 +65,16 @@ references: name: AadTokenProvider - uid: sp-http.AadTokenProviderFactory name: AadTokenProviderFactory + - uid: sp-http.DigestCache + name: DigestCache - uid: sp-http.GraphHttpClient name: GraphHttpClient - uid: sp-http.GraphHttpClientConfiguration name: GraphHttpClientConfiguration - uid: sp-http.GraphHttpClientResponse name: GraphHttpClientResponse + - uid: sp-http.GraphRequest + name: GraphRequest - uid: sp-http.HttpClient name: HttpClient - uid: sp-http.HttpClientConfiguration @@ -76,8 +85,10 @@ references: name: IAadHttpClientConfiguration - uid: sp-http.IAadHttpClientConfigurations name: IAadHttpClientConfigurations - - uid: sp-http.IAadTokenProviderConfiguration - name: IAadTokenProviderConfiguration + - uid: sp-http.IAadHttpClientOptions + name: IAadHttpClientOptions + - uid: sp-http.IDigestCache + name: IDigestCache - uid: sp-http.IGraphHttpClientConfiguration name: IGraphHttpClientConfiguration - uid: sp-http.IGraphHttpClientConfigurations @@ -106,6 +117,10 @@ references: name: ISPHttpClientConfigurations - uid: sp-http.ISPHttpClientOptions name: ISPHttpClientOptions + - uid: sp-http.MSGraphClient + name: MSGraphClient + - uid: sp-http.MSGraphClientFactory + name: MSGraphClientFactory - uid: sp-http.ODataVersion name: ODataVersion - uid: sp-http.SPHttpClient diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 0873c2d1..eba953c1 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -6,13 +6,8 @@ items: This class is marked as `@sealed`. Subclasses should not extend it. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the AadHttpClient class. - - For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For - communicating with Microsoft Graph, use the [GraphHttpClient](xref:sp-http.GraphHttpClient) class. - isPreview: true + communicating with Microsoft Graph, use the [MSGraphClient](xref:sp-http.MSGraphClient) class. name: AadHttpClient fullName: sp-http.AadHttpClient langs: @@ -20,13 +15,35 @@ items: type: class package: sp-http children: + - sp-http.AadHttpClient.constructor - sp-http.AadHttpClient.configurations - sp-http.AadHttpClient.fetch - sp-http.AadHttpClient.get - sp-http.AadHttpClient.post + - uid: sp-http.AadHttpClient.constructor + summary: 'Constructs a new instance of the [AadHttpClient](xref:sp-http.AadHttpClient) class' + name: 'constructor(serviceScope, resourceEndpoint, options)' + fullName: sp-http.AadHttpClient.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);' + parameters: + - id: serviceScope + description: The service scope is needed to retrieve some of the class's internal components. + type: + - ServiceScope + - id: resourceEndpoint + description: '' + type: + - string + - id: options + description: Configuration options for the request to get an access token. + type: + - IAadHttpClientOptions - uid: sp-http.AadHttpClient.configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. - isPreview: true name: configurations fullName: sp-http.AadHttpClient.configurations langs: @@ -43,7 +60,6 @@ items: Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - isPreview: true name: 'fetch(url, configuration, options)' fullName: sp-http.AadHttpClient.fetch langs: @@ -56,25 +72,24 @@ items: return: type: - Promise - description: a promise that will return the result + description: A promise that will return the result. parameters: - id: url - description: the URL to fetch + description: The endpoint URL that fetch will be called on. type: - string - id: configuration description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. type: - AadHttpClientConfiguration - id: options - description: additional options that affect the request + description: Additional options that affect the request. type: - IHttpClientOptions - uid: sp-http.AadHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' - isPreview: true name: 'get(url, configuration, options)' fullName: sp-http.AadHttpClient.get langs: @@ -87,25 +102,24 @@ items: return: type: - Promise - description: a promise that will return the result + description: A promise that will return the result. parameters: - id: url - description: the URL to fetch + description: The endpoint URL that fetch will be called on. type: - string - id: configuration description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. type: - AadHttpClientConfiguration - id: options - description: additional options that affect the request + description: Additional options that affect the request. type: - IHttpClientOptions - uid: sp-http.AadHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' - isPreview: true name: 'post(url, configuration, options)' fullName: sp-http.AadHttpClient.post langs: @@ -118,19 +132,19 @@ items: return: type: - Promise - description: a promise that will return the result + description: A promise that will return the result. parameters: - id: url - description: the URL to fetch + description: The endpoint URL that fetch will be called on. type: - string - id: configuration description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. type: - AadHttpClientConfiguration - id: options - description: additional options that affect the request + description: Additional options that affect the request. type: - IHttpClientOptions diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index afb01c40..027ec763 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -2,12 +2,11 @@ items: - uid: sp-http.AadHttpClientFactory summary: >- - The will return a preinitialized version of the AadHttpClient for a given resource url. See more -> - https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient + Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClientFactory class. - isPreview: true name: AadHttpClientFactory fullName: sp-http.AadHttpClientFactory langs: @@ -15,47 +14,37 @@ items: type: class package: sp-http children: - - sp-http.AadHttpClientFactory.getExtendedClient - - sp-http.AadHttpClientFactory.getStandardClient - - uid: sp-http.AadHttpClientFactory.getExtendedClient + - sp-http.AadHttpClientFactory.getClient + - sp-http.AadHttpClientFactory.serviceKey + - uid: sp-http.AadHttpClientFactory.getClient summary: >- Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. - isPreview: true - name: getExtendedClient(resourceEndpoint) - fullName: sp-http.AadHttpClientFactory.getExtendedClient + name: getClient(resourceEndpoint) + fullName: sp-http.AadHttpClientFactory.getClient langs: - typeScript type: method syntax: - content: 'getExtendedClient(resourceEndpoint: string): AadHttpClient;' + content: 'getClient(resourceEndpoint: string): Promise;' return: type: - - AadHttpClient + - Promise description: '' parameters: - id: resourceEndpoint description: The target AAD application's resource endpoint. type: - string - - uid: sp-http.AadHttpClientFactory.getStandardClient - summary: >- - Returns an instance of the AadHttpClient that communicates with the preconfigured SharePoint Online Web Service - Principal. - isPreview: true - name: getStandardClient(resourceEndpoint) - fullName: sp-http.AadHttpClientFactory.getStandardClient + - uid: sp-http.AadHttpClientFactory.serviceKey + summary: The service key for AadHttpClientFactory. + name: serviceKey + fullName: sp-http.AadHttpClientFactory.serviceKey langs: - typeScript - type: method + type: property syntax: - content: 'getStandardClient(resourceEndpoint: string): AadHttpClient;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - - AadHttpClient - description: '' - parameters: - - id: resourceEndpoint - description: The target AAD application's resource endpoint. - type: - - string + - ServiceKey diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index f3dfa0fc..cc14ab57 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -11,10 +11,8 @@ items: This class is marked as `@sealed`. Subclasses should not extend it. - AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some - point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will - switch to MSAL. - isPreview: true + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the AadTokenProvider class. name: AadTokenProvider fullName: sp-http.AadTokenProvider langs: @@ -24,59 +22,38 @@ items: - IAadTokenProvider package: sp-http children: - - sp-http.AadTokenProvider.constructor - sp-http.AadTokenProvider.getToken - sp-http.AadTokenProvider.tokenAcquisitionEvent - - uid: sp-http.AadTokenProvider.constructor - summary: 'Constructs a new instance of the [AadTokenProvider](xref:sp-http.AadTokenProvider) class' - name: constructor(configuration) - fullName: sp-http.AadTokenProvider.constructor - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(configuration: IAadTokenProviderConfiguration);' - parameters: - - id: configuration - description: '' - type: - - IAadTokenProviderConfiguration - uid: sp-http.AadTokenProvider.getToken summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. - The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. - - An example of a resourceEndpoint would be https://sdfpilot.outlook.com - isPreview: true - name: 'getToken(resourceEndpoint, configuration)' + The OAuth2 token should not be cached by the caller since it is already cached by the method itself. + name: getToken(resourceEndpoint) fullName: sp-http.AadTokenProvider.getToken langs: - typeScript type: method syntax: - content: 'getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;' + content: 'getToken(resourceEndpoint: string): Promise;' return: type: - Promise description: A promise that will be fullfiled with the token or that will reject with an error message parameters: - id: resourceEndpoint - description: the resource for which the token should be obtained + description: >- + the resource for which the token should be obtained An example of a resourceEndpoint would be + https://graph.microsoft.com type: - string - - id: configuration - description: '' - type: - - IAadTokenProviderConfiguration - uid: sp-http.AadTokenProvider.tokenAcquisitionEvent - summary: Notifies the developer when Token Acquistion requires user action. - isPreview: true + summary: Notifies the developer when Token Acquisition requires user action. name: tokenAcquisitionEvent fullName: sp-http.AadTokenProvider.tokenAcquisitionEvent langs: - typeScript - type: property + type: event syntax: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index c8df67e9..47e4ab7e 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -1,8 +1,7 @@ ### YamlMime:UniversalReference items: - uid: sp-http.AadTokenProviderFactory - summary: The will return a preinitialized version of the AadTokenProviderFactory. - isPreview: true + summary: Returns a preinitialized version of the AadTokenProviderFactory. name: AadTokenProviderFactory fullName: sp-http.AadTokenProviderFactory langs: @@ -10,20 +9,32 @@ items: type: class package: sp-http children: - - sp-http.AadTokenProviderFactory.getExtendedProvider - - uid: sp-http.AadTokenProviderFactory.getExtendedProvider + - sp-http.AadTokenProviderFactory.getTokenProvider + - sp-http.AadTokenProviderFactory.serviceKey + - uid: sp-http.AadTokenProviderFactory.getTokenProvider summary: >- Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. - isPreview: true - name: getExtendedProvider() - fullName: sp-http.AadTokenProviderFactory.getExtendedProvider + name: getTokenProvider() + fullName: sp-http.AadTokenProviderFactory.getTokenProvider langs: - typeScript type: method syntax: - content: 'getExtendedProvider(): IAadTokenProvider;' + content: 'getTokenProvider(): Promise;' return: type: - - IAadTokenProvider + - Promise description: '' + - uid: sp-http.AadTokenProviderFactory.serviceKey + summary: The service key for AadTokenProviderFactory. + name: serviceKey + fullName: sp-http.AadTokenProviderFactory.serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - ServiceKey diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml new file mode 100644 index 00000000..95acca79 --- /dev/null +++ b/SP-Framework/sp-http/digestcache.yml @@ -0,0 +1,141 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.DigestCache + summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb + URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, + specified via the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, + and expires after a server configurable amount of time. + + + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + name: DigestCache + fullName: sp-http.DigestCache + langs: + - typeScript + type: class + implements: + - IDigestCache + package: sp-http + children: + - sp-http.DigestCache.constructor + - sp-http.DigestCache.addDigestToCache + - sp-http.DigestCache.clearAllDigests + - sp-http.DigestCache.clearDigest + - sp-http.DigestCache.fetchDigest + - sp-http.DigestCache.serviceKey + - uid: sp-http.DigestCache.constructor + summary: 'Constructs a new instance of the [DigestCache](xref:sp-http.DigestCache) class' + name: constructor(serviceScope) + fullName: sp-http.DigestCache.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: + - ServiceScope + - uid: sp-http.DigestCache.addDigestToCache + summary: >- + Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will + automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios + addDigestToCache() can be used to avoid the overhead of the REST call. + name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + fullName: sp-http.DigestCache.addDigestToCache + langs: + - typeScript + type: method + syntax: + content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' + return: + type: + - void + description: '' + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: + - string + - id: digestValue + description: >- + The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look + something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + type: + - string + - id: expirationTimestamp + description: >- + A future point in time, as measured by performance.now(), after which the digest value will no longer be + valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for + example, to specify an expiration "5 seconds from right now", use performance.now()+5000. + type: + - number + - uid: sp-http.DigestCache.clearAllDigests + summary: Clears all values from the cache. + name: clearAllDigests() + fullName: sp-http.DigestCache.clearAllDigests + langs: + - typeScript + type: method + syntax: + content: 'clearAllDigests(): void;' + return: + type: + - void + description: '' + - uid: sp-http.DigestCache.clearDigest + summary: >- + Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a + digest was invalidated prior to its expiration time. + name: clearDigest(webUrl) + fullName: sp-http.DigestCache.clearDigest + langs: + - typeScript + type: method + syntax: + content: 'clearDigest(webUrl: string): boolean;' + return: + type: + - boolean + description: Returns true if a cache entry was found and deleted; false otherwise. + parameters: + - id: webUrl + description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. + type: + - string + - uid: sp-http.DigestCache.fetchDigest + summary: >- + Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is + fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the + digest, which will be added to the cache. + name: fetchDigest(webUrl) + fullName: sp-http.DigestCache.fetchDigest + langs: + - typeScript + type: method + syntax: + content: 'fetchDigest(webUrl: string): Promise;' + return: + type: + - Promise + description: A promise that is fulfilled with the digest value. + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: + - string + - uid: sp-http.DigestCache.serviceKey + summary: The service key for IDigestCache. + name: serviceKey + fullName: sp-http.DigestCache.serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - ServiceKey diff --git a/SP-Framework/sp-http/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml index d94ed36a..1d5fca12 100644 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ b/SP-Framework/sp-http/graphhttpclient.yml @@ -11,6 +11,8 @@ items: For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class instead. + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: GraphHttpClient fullName: sp-http.GraphHttpClient @@ -27,6 +29,8 @@ items: - sp-http.GraphHttpClient.serviceKey - uid: sp-http.GraphHttpClient.constructor summary: 'Constructs a new instance of the [GraphHttpClient](xref:sp-http.GraphHttpClient) class' + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. name: constructor(serviceScope) fullName: sp-http.GraphHttpClient.constructor langs: @@ -41,6 +45,8 @@ items: - ServiceScope - uid: sp-http.GraphHttpClient.configurations summary: The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class. + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: configurations fullName: sp-http.GraphHttpClient.configurations @@ -62,6 +68,8 @@ items: The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead): - Default "Accept" and "Content-Type" headers are added if not explicitly specified. + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: 'fetch(url, configuration, options)' fullName: sp-http.GraphHttpClient.fetch @@ -95,6 +103,8 @@ items: - IGraphHttpClientOptions - uid: sp-http.GraphHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: 'get(url, configuration, options)' fullName: sp-http.GraphHttpClient.get @@ -126,6 +136,8 @@ items: - IGraphHttpClientOptions - uid: sp-http.GraphHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: 'post(url, configuration, options)' fullName: sp-http.GraphHttpClient.post @@ -157,6 +169,8 @@ items: - IGraphHttpClientOptions - uid: sp-http.GraphHttpClient.serviceKey summary: The service key for GraphHttpClient. + deprecated: + content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: serviceKey fullName: sp-http.GraphHttpClient.serviceKey diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml new file mode 100644 index 00000000..f35c13fd --- /dev/null +++ b/SP-Framework/sp-http/graphrequest.yml @@ -0,0 +1,568 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.GraphRequest + summary: >- + Typings for the GraphRequest Object For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + name: GraphRequest + fullName: sp-http.GraphRequest + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.GraphRequest.constructor + - sp-http.GraphRequest._headers + - sp-http.GraphRequest._responseType + - sp-http.GraphRequest.buildFullUrl + - sp-http.GraphRequest.config + - sp-http.GraphRequest.count + - sp-http.GraphRequest.create + - sp-http.GraphRequest.del + - sp-http.GraphRequest.delete + - sp-http.GraphRequest.expand + - sp-http.GraphRequest.filter + - sp-http.GraphRequest.get + - sp-http.GraphRequest.getStream + - sp-http.GraphRequest.header + - sp-http.GraphRequest.headers + - sp-http.GraphRequest.orderby + - sp-http.GraphRequest.parsePath + - sp-http.GraphRequest.patch + - sp-http.GraphRequest.post + - sp-http.GraphRequest.put + - sp-http.GraphRequest.putStream + - sp-http.GraphRequest.query + - sp-http.GraphRequest.responseType + - sp-http.GraphRequest.select + - sp-http.GraphRequest.skip + - sp-http.GraphRequest.skipToken + - sp-http.GraphRequest.top + - sp-http.GraphRequest.update + - sp-http.GraphRequest.urlComponents + - sp-http.GraphRequest.version + - uid: sp-http.GraphRequest.constructor + summary: 'Constructs a new instance of the [GraphRequest](xref:sp-http.GraphRequest) class' + name: 'constructor(config, path)' + fullName: sp-http.GraphRequest.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(config: Options, path: string);' + parameters: + - id: config + description: '' + type: + - Options + - id: path + description: '' + type: + - string + - uid: sp-http.GraphRequest._headers + name: _headers + fullName: sp-http.GraphRequest._headers + langs: + - typeScript + type: property + syntax: + content: '_headers:' + return: + type: + - |- + { + [key: string]: string | number; + } + - uid: sp-http.GraphRequest._responseType + name: _responseType + fullName: sp-http.GraphRequest._responseType + langs: + - typeScript + type: property + syntax: + content: '_responseType: string;' + return: + type: + - string + - uid: sp-http.GraphRequest.buildFullUrl + name: buildFullUrl() + fullName: sp-http.GraphRequest.buildFullUrl + langs: + - typeScript + type: method + syntax: + content: 'buildFullUrl(): string;' + return: + type: + - string + description: '' + - uid: sp-http.GraphRequest.config + name: config + fullName: sp-http.GraphRequest.config + langs: + - typeScript + type: property + syntax: + content: 'config: Options;' + return: + type: + - Options + - uid: sp-http.GraphRequest.count + name: count(count) + fullName: sp-http.GraphRequest.count + langs: + - typeScript + type: method + syntax: + content: 'count(count: boolean): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: count + description: '' + type: + - boolean + - uid: sp-http.GraphRequest.create + name: 'create(content, callback)' + fullName: sp-http.GraphRequest.create + langs: + - typeScript + type: method + syntax: + content: 'create(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: content + description: '' + type: + - any + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.del + name: del(callback) + fullName: sp-http.GraphRequest.del + langs: + - typeScript + type: method + syntax: + content: 'del(callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.delete + name: delete(callback) + fullName: sp-http.GraphRequest.delete + langs: + - typeScript + type: method + syntax: + content: 'delete(callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.expand + name: expand(properties) + fullName: sp-http.GraphRequest.expand + langs: + - typeScript + type: method + syntax: + content: 'expand(properties: string | string[]): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: properties + description: '' + type: + - 'string | string[]' + - uid: sp-http.GraphRequest.filter + name: filter(filterStr) + fullName: sp-http.GraphRequest.filter + langs: + - typeScript + type: method + syntax: + content: 'filter(filterStr: string): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: filterStr + description: '' + type: + - string + - uid: sp-http.GraphRequest.get + name: get(callback) + fullName: sp-http.GraphRequest.get + langs: + - typeScript + type: method + syntax: + content: 'get(callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.getStream + name: getStream(callback) + fullName: sp-http.GraphRequest.getStream + langs: + - typeScript + type: method + syntax: + content: 'getStream(callback: GraphRequestCallback): void;' + return: + type: + - void + description: '' + parameters: + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.header + name: 'header(headerKey, headerValue)' + fullName: sp-http.GraphRequest.header + langs: + - typeScript + type: method + syntax: + content: 'header(headerKey: string, headerValue: string): this;' + return: + type: + - this + description: '' + parameters: + - id: headerKey + description: '' + type: + - string + - id: headerValue + description: '' + type: + - string + - uid: sp-http.GraphRequest.headers + name: headers(headers) + fullName: sp-http.GraphRequest.headers + langs: + - typeScript + type: method + syntax: + content: |- + headers(headers: { + [key: string]: string | number; + }): this; + return: + type: + - this + description: '' + parameters: + - id: headers + description: '' + type: + - |- + { + [key: string]: string | number; + } + - uid: sp-http.GraphRequest.orderby + name: orderby(properties) + fullName: sp-http.GraphRequest.orderby + langs: + - typeScript + type: method + syntax: + content: 'orderby(properties: string | string[]): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: properties + description: '' + type: + - 'string | string[]' + - uid: sp-http.GraphRequest.parsePath + name: parsePath(rawPath) + fullName: sp-http.GraphRequest.parsePath + langs: + - typeScript + type: method + syntax: + content: 'parsePath(rawPath: string): void;' + return: + type: + - void + description: '' + parameters: + - id: rawPath + description: '' + type: + - string + - uid: sp-http.GraphRequest.patch + name: 'patch(content, callback)' + fullName: sp-http.GraphRequest.patch + langs: + - typeScript + type: method + syntax: + content: 'patch(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: content + description: '' + type: + - any + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.post + name: 'post(content, callback)' + fullName: sp-http.GraphRequest.post + langs: + - typeScript + type: method + syntax: + content: 'post(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: content + description: '' + type: + - any + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.put + name: 'put(content, callback)' + fullName: sp-http.GraphRequest.put + langs: + - typeScript + type: method + syntax: + content: 'put(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: content + description: '' + type: + - any + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.putStream + name: 'putStream(stream, callback)' + fullName: sp-http.GraphRequest.putStream + langs: + - typeScript + type: method + syntax: + content: 'putStream(stream: any, callback: GraphRequestCallback): void;' + return: + type: + - void + description: '' + parameters: + - id: stream + description: '' + type: + - any + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.query + name: query(queryDictionaryOrString) + fullName: sp-http.GraphRequest.query + langs: + - typeScript + type: method + syntax: + content: |- + query(queryDictionaryOrString: string | { + [key: string]: string | number; + }): GraphRequest; + return: + type: + - GraphRequest + description: '' + parameters: + - id: queryDictionaryOrString + description: '' + type: + - |- + string | { + [key: string]: string | number; + } + - uid: sp-http.GraphRequest.responseType + name: responseType(responseType) + fullName: sp-http.GraphRequest.responseType + langs: + - typeScript + type: method + syntax: + content: 'responseType(responseType: string): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: responseType + description: '' + type: + - string + - uid: sp-http.GraphRequest.select + name: select(properties) + fullName: sp-http.GraphRequest.select + langs: + - typeScript + type: method + syntax: + content: 'select(properties: string | string[]): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: properties + description: '' + type: + - 'string | string[]' + - uid: sp-http.GraphRequest.skip + name: skip(n) + fullName: sp-http.GraphRequest.skip + langs: + - typeScript + type: method + syntax: + content: 'skip(n: number): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: 'n' + description: '' + type: + - number + - uid: sp-http.GraphRequest.skipToken + name: skipToken(token) + fullName: sp-http.GraphRequest.skipToken + langs: + - typeScript + type: method + syntax: + content: 'skipToken(token: string): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: token + description: '' + type: + - string + - uid: sp-http.GraphRequest.top + name: top(n) + fullName: sp-http.GraphRequest.top + langs: + - typeScript + type: method + syntax: + content: 'top(n: number): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: 'n' + description: '' + type: + - number + - uid: sp-http.GraphRequest.update + name: 'update(content, callback)' + fullName: sp-http.GraphRequest.update + langs: + - typeScript + type: method + syntax: + content: 'update(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - Promise + description: '' + parameters: + - id: content + description: '' + type: + - any + - id: callback + description: '' + type: + - GraphRequestCallback + - uid: sp-http.GraphRequest.urlComponents + name: urlComponents + fullName: sp-http.GraphRequest.urlComponents + langs: + - typeScript + type: property + syntax: + content: 'urlComponents: URLComponents;' + return: + type: + - URLComponents + - uid: sp-http.GraphRequest.version + name: version(v) + fullName: sp-http.GraphRequest.version + langs: + - typeScript + type: method + syntax: + content: 'version(v: string): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: v + description: '' + type: + - string diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml new file mode 100644 index 00000000..e8b8e770 --- /dev/null +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -0,0 +1,35 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadHttpClientOptions + summary: Interface for overriding the default behavior of AadHttpClient. + name: IAadHttpClientOptions + fullName: sp-http.IAadHttpClientOptions + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IAadHttpClientOptions.configuration + - sp-http.IAadHttpClientOptions.tokenProvider + - uid: sp-http.IAadHttpClientOptions.configuration + name: configuration + fullName: sp-http.IAadHttpClientOptions.configuration + langs: + - typeScript + type: property + syntax: + content: 'configuration?: IAadTokenProviderConfiguration;' + return: + type: + - IAadTokenProviderConfiguration + - uid: sp-http.IAadHttpClientOptions.tokenProvider + name: tokenProvider + fullName: sp-http.IAadHttpClientOptions.tokenProvider + langs: + - typeScript + type: property + syntax: + content: 'tokenProvider?: IAadTokenProvider;' + return: + type: + - IAadTokenProvider diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml deleted file mode 100644 index d9e369d1..00000000 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ /dev/null @@ -1,64 +0,0 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.IAadTokenProvider - summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. - - - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. - remarks: >- - AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some - point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will - switch to MSAL. - isPreview: true - name: IAadTokenProvider - fullName: sp-http.IAadTokenProvider - langs: - - typeScript - type: interface - package: sp-http - children: - - sp-http.IAadTokenProvider.getToken - - sp-http.IAadTokenProvider.tokenAcquisitionEvent - - uid: sp-http.IAadTokenProvider.getToken - summary: |- - Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. - - The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. - - An example of a resourceEndpoint would be https://sdfpilot.outlook.com - isPreview: true - name: 'getToken(resourceEndpoint, configuration)' - fullName: sp-http.IAadTokenProvider.getToken - langs: - - typeScript - type: method - syntax: - content: 'getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;' - return: - type: - - Promise - description: A promise that will be fullfiled with the token or that will reject with an error message - parameters: - - id: resourceEndpoint - description: the resource for which the token should be obtained - type: - - string - - id: configuration - description: '' - type: - - IAadTokenProviderConfiguration - - uid: sp-http.IAadTokenProvider.tokenAcquisitionEvent - summary: Notifies the developer when Token Acquistion requires user action. - isPreview: true - name: tokenAcquisitionEvent - fullName: sp-http.IAadTokenProvider.tokenAcquisitionEvent - langs: - - typeScript - type: property - syntax: - content: 'tokenAcquisitionEvent: SPEvent;' - return: - type: - - SPEvent diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml deleted file mode 100644 index 84a0ecf3..00000000 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ /dev/null @@ -1,86 +0,0 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.IAadTokenProviderConfiguration - summary: Required strings for constructing an AadTokenProvider. - isPreview: true - name: IAadTokenProviderConfiguration - fullName: sp-http.IAadTokenProviderConfiguration - langs: - - typeScript - type: interface - package: sp-http - children: - - sp-http.IAadTokenProviderConfiguration.aadInstanceUrl - - sp-http.IAadTokenProviderConfiguration.aadTenantId - - sp-http.IAadTokenProviderConfiguration.aadUserId - - sp-http.IAadTokenProviderConfiguration.redirectUri - - sp-http.IAadTokenProviderConfiguration.servicePrincipalId - - uid: sp-http.IAadTokenProviderConfiguration.aadInstanceUrl - summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. - isPreview: true - name: aadInstanceUrl - fullName: sp-http.IAadTokenProviderConfiguration.aadInstanceUrl - langs: - - typeScript - type: property - syntax: - content: 'aadInstanceUrl: string;' - return: - type: - - string - - uid: sp-http.IAadTokenProviderConfiguration.aadTenantId - summary: The Azure Active Directory's tenant id. - isPreview: true - name: aadTenantId - fullName: sp-http.IAadTokenProviderConfiguration.aadTenantId - langs: - - typeScript - type: property - syntax: - content: 'aadTenantId: string;' - return: - type: - - string - - uid: sp-http.IAadTokenProviderConfiguration.aadUserId - summary: >- - The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current - user. - isPreview: true - name: aadUserId - fullName: sp-http.IAadTokenProviderConfiguration.aadUserId - langs: - - typeScript - type: property - syntax: - content: 'aadUserId?: string;' - return: - type: - - string - - uid: sp-http.IAadTokenProviderConfiguration.redirectUri - summary: >- - The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's - application redirect uris. - isPreview: true - name: redirectUri - fullName: sp-http.IAadTokenProviderConfiguration.redirectUri - langs: - - typeScript - type: property - syntax: - content: 'redirectUri: string;' - return: - type: - - string - - uid: sp-http.IAadTokenProviderConfiguration.servicePrincipalId - summary: The client ID of the developer's Azure Active Directory application. - isPreview: true - name: servicePrincipalId - fullName: sp-http.IAadTokenProviderConfiguration.servicePrincipalId - langs: - - typeScript - type: property - syntax: - content: 'servicePrincipalId: string;' - return: - type: - - string diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml new file mode 100644 index 00000000..98b6624f --- /dev/null +++ b/SP-Framework/sp-http/idigestcache.yml @@ -0,0 +1,111 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IDigestCache + summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb + URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, + specified via the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, + and expires after a server configurable amount of time. + + + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + name: IDigestCache + fullName: sp-http.IDigestCache + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IDigestCache.addDigestToCache + - sp-http.IDigestCache.clearAllDigests + - sp-http.IDigestCache.clearDigest + - sp-http.IDigestCache.fetchDigest + - uid: sp-http.IDigestCache.addDigestToCache + summary: >- + Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will + automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios + addDigestToCache() can be used to avoid the overhead of the REST call. + name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + fullName: sp-http.IDigestCache.addDigestToCache + langs: + - typeScript + type: method + syntax: + content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' + return: + type: + - void + description: '' + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: + - string + - id: digestValue + description: >- + The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look + something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + type: + - string + - id: expirationTimestamp + description: >- + A future point in time, as measured by performance.now(), after which the digest value will no longer be + valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for + example, to specify an expiration "5 seconds from right now", use performance.now()+5000. + type: + - number + - uid: sp-http.IDigestCache.clearAllDigests + summary: Clears all values from the cache. + name: clearAllDigests() + fullName: sp-http.IDigestCache.clearAllDigests + langs: + - typeScript + type: method + syntax: + content: 'clearAllDigests(): void;' + return: + type: + - void + description: '' + - uid: sp-http.IDigestCache.clearDigest + summary: >- + Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a + digest was invalidated prior to its expiration time. + name: clearDigest(webUrl) + fullName: sp-http.IDigestCache.clearDigest + langs: + - typeScript + type: method + syntax: + content: 'clearDigest(webUrl: string): boolean;' + return: + type: + - boolean + description: Returns true if a cache entry was found and deleted; false otherwise. + parameters: + - id: webUrl + description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. + type: + - string + - uid: sp-http.IDigestCache.fetchDigest + summary: >- + Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is + fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the + digest, which will be added to the cache. + name: fetchDigest(webUrl) + fullName: sp-http.IDigestCache.fetchDigest + langs: + - typeScript + type: method + syntax: + content: 'fetchDigest(webUrl: string): Promise;' + return: + type: + - Promise + description: A promise that is fulfilled with the digest value. + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: + - string diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml new file mode 100644 index 00000000..1b65dc62 --- /dev/null +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -0,0 +1,54 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.MSGraphClient + summary: MSGraphClient is used to perform REST calls against Microsoft Graph. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the MSGraphClient class. + + + The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class + allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client + library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that + custom configuration for every request. + + + For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + name: MSGraphClient + fullName: sp-http.MSGraphClient + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.MSGraphClient.api + - uid: sp-http.MSGraphClient.api + summary: All calls to Microsoft Graph are chained together starting with the api function. + remarks: >- + Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* + https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship') + + + The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See + the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript + name: 'api(path, config)' + fullName: sp-http.MSGraphClient.api + langs: + - typeScript + type: method + syntax: + content: 'api(path: string, config?: Options): GraphRequest;' + return: + type: + - GraphRequest + description: '' + parameters: + - id: path + description: The path for the request to MSGraph. + type: + - string + - id: config + description: Sets the configuration for this request. + type: + - Options diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml new file mode 100644 index 00000000..0cd49ea8 --- /dev/null +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -0,0 +1,45 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.MSGraphClientFactory + summary: >- + Returns a preinitialized version of the MSGraphClient. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the MSGraphClientFactory class. + name: MSGraphClientFactory + fullName: sp-http.MSGraphClientFactory + langs: + - typeScript + type: class + package: sp-http + children: + - sp-http.MSGraphClientFactory.getClient + - sp-http.MSGraphClientFactory.serviceKey + - uid: sp-http.MSGraphClientFactory.getClient + summary: >- + Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service + Principal. + name: getClient() + fullName: sp-http.MSGraphClientFactory.getClient + langs: + - typeScript + type: method + syntax: + content: 'getClient(): Promise;' + return: + type: + - Promise + description: '' + - uid: sp-http.MSGraphClientFactory.serviceKey + summary: The service key for MSGraphClientFactory. + name: serviceKey + fullName: sp-http.MSGraphClientFactory.serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - ServiceKey diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index a75892c2..45ecf423 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -1,8 +1,7 @@ ### YamlMime:UniversalReference items: - uid: sp-http.TokenAcquisitionEventArgs - summary: Represents arguments used for raising a token acquisiton failure event. - isPreview: true + summary: Arguments for a token acquisition failure event. name: TokenAcquisitionEventArgs fullName: sp-http.TokenAcquisitionEventArgs langs: @@ -35,7 +34,6 @@ items: - string - uid: sp-http.TokenAcquisitionEventArgs.message summary: The message returned from ADAL fails to retrieve a token from Azure AD. - isPreview: true name: message fullName: sp-http.TokenAcquisitionEventArgs.message langs: @@ -48,7 +46,6 @@ items: - string - uid: sp-http.TokenAcquisitionEventArgs.redirectUrl summary: The url of the page for the end user to perform Multi Factor Authentication - isPreview: true name: redirectUrl fullName: sp-http.TokenAcquisitionEventArgs.redirectUrl langs: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index ae59dba1..05b13a38 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -33,7 +33,7 @@ items: fullName: sp-listview-extensibility.ListViewAccessor.selectedRowsChangedEvent langs: - typeScript - type: property + type: event syntax: content: 'readonly selectedRowsChangedEvent: SPEvent;' return: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index c9094cc3..6e002eab 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -11,36 +11,10 @@ items: type: interface package: sp-odata-types children: - - sp-odata-types.IODataContextWebInformation.FormDigestTimeoutSeconds - - sp-odata-types.IODataContextWebInformation.FormDigestValue - sp-odata-types.IODataContextWebInformation.LibraryVersion - sp-odata-types.IODataContextWebInformation.SiteFullUrl - sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions - sp-odata-types.IODataContextWebInformation.WebFullUrl - - uid: sp-odata-types.IODataContextWebInformation.FormDigestTimeoutSeconds - summary: 'Example: 1800' - name: FormDigestTimeoutSeconds - fullName: sp-odata-types.IODataContextWebInformation.FormDigestTimeoutSeconds - langs: - - typeScript - type: property - syntax: - content: 'FormDigestTimeoutSeconds: number;' - return: - type: - - number - - uid: sp-odata-types.IODataContextWebInformation.FormDigestValue - summary: 'Example: "0x61B31CBF4C76C...B0,20 Jan 2016 02:24:43 -0000"' - name: FormDigestValue - fullName: sp-odata-types.IODataContextWebInformation.FormDigestValue - langs: - - typeScript - type: property - syntax: - content: 'FormDigestValue: string;' - return: - type: - - string - uid: sp-odata-types.IODataContextWebInformation.LibraryVersion summary: 'Example: "16.0.4919.3000"' name: LibraryVersion diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index f45a2de0..9f4eac1a 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -12,19 +12,29 @@ items: type: package children: - sp-page-context.CultureInfo + - sp-page-context.ISPSystemTime + - sp-page-context.ISPTimeZoneData - sp-page-context.PageContext + - sp-page-context.SPDayOfWeek - sp-page-context.SPField - sp-page-context.SPList - sp-page-context.SPListItem - sp-page-context.SPPermission - sp-page-context.SPSite + - sp-page-context.SPTimeZone - sp-page-context.SPUser - sp-page-context.SPWeb references: - uid: sp-page-context.CultureInfo name: CultureInfo + - uid: sp-page-context.ISPSystemTime + name: ISPSystemTime + - uid: sp-page-context.ISPTimeZoneData + name: ISPTimeZoneData - uid: sp-page-context.PageContext name: PageContext + - uid: sp-page-context.SPDayOfWeek + name: SPDayOfWeek - uid: sp-page-context.SPField name: SPField - uid: sp-page-context.SPList @@ -35,6 +45,8 @@ references: name: SPPermission - uid: sp-page-context.SPSite name: SPSite + - uid: sp-page-context.SPTimeZone + name: SPTimeZone - uid: sp-page-context.SPUser name: SPUser - uid: sp-page-context.SPWeb diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml new file mode 100644 index 00000000..69ebfba2 --- /dev/null +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -0,0 +1,116 @@ +### YamlMime:UniversalReference +items: + - uid: sp-page-context.ISPSystemTime + summary: Interface that represents a SPSystemTime structure. + isPreview: true + name: ISPSystemTime + fullName: sp-page-context.ISPSystemTime + langs: + - typeScript + type: interface + package: sp-page-context + children: + - sp-page-context.ISPSystemTime.Day + - sp-page-context.ISPSystemTime.DayOfWeek + - sp-page-context.ISPSystemTime.Hour + - sp-page-context.ISPSystemTime.Milliseconds + - sp-page-context.ISPSystemTime.Minute + - sp-page-context.ISPSystemTime.Month + - sp-page-context.ISPSystemTime.Second + - sp-page-context.ISPSystemTime.Year + - uid: sp-page-context.ISPSystemTime.Day + isPreview: true + name: Day + fullName: sp-page-context.ISPSystemTime.Day + langs: + - typeScript + type: property + syntax: + content: 'Day: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.DayOfWeek + isPreview: true + name: DayOfWeek + fullName: sp-page-context.ISPSystemTime.DayOfWeek + langs: + - typeScript + type: property + syntax: + content: 'DayOfWeek: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.Hour + isPreview: true + name: Hour + fullName: sp-page-context.ISPSystemTime.Hour + langs: + - typeScript + type: property + syntax: + content: 'Hour: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.Milliseconds + isPreview: true + name: Milliseconds + fullName: sp-page-context.ISPSystemTime.Milliseconds + langs: + - typeScript + type: property + syntax: + content: 'Milliseconds: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.Minute + isPreview: true + name: Minute + fullName: sp-page-context.ISPSystemTime.Minute + langs: + - typeScript + type: property + syntax: + content: 'Minute: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.Month + isPreview: true + name: Month + fullName: sp-page-context.ISPSystemTime.Month + langs: + - typeScript + type: property + syntax: + content: 'Month: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.Second + isPreview: true + name: Second + fullName: sp-page-context.ISPSystemTime.Second + langs: + - typeScript + type: property + syntax: + content: 'Second: number;' + return: + type: + - number + - uid: sp-page-context.ISPSystemTime.Year + isPreview: true + name: Year + fullName: sp-page-context.ISPSystemTime.Year + langs: + - typeScript + type: property + syntax: + content: 'Year: number;' + return: + type: + - number diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml new file mode 100644 index 00000000..5b91ed3c --- /dev/null +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -0,0 +1,103 @@ +### YamlMime:UniversalReference +items: + - uid: sp-page-context.ISPTimeZoneData + summary: Interface that represents the data neccesary to build an TimeZone object. + isPreview: true + name: ISPTimeZoneData + fullName: sp-page-context.ISPTimeZoneData + langs: + - typeScript + type: interface + package: sp-page-context + children: + - sp-page-context.ISPTimeZoneData.daylightDate + - sp-page-context.ISPTimeZoneData.daylightOffset + - sp-page-context.ISPTimeZoneData.description + - sp-page-context.ISPTimeZoneData.id + - sp-page-context.ISPTimeZoneData.offset + - sp-page-context.ISPTimeZoneData.standardDate + - sp-page-context.ISPTimeZoneData.standardOffset + - uid: sp-page-context.ISPTimeZoneData.daylightDate + isPreview: true + name: daylightDate + fullName: sp-page-context.ISPTimeZoneData.daylightDate + langs: + - typeScript + type: property + syntax: + content: 'daylightDate: ISPSystemTime;' + return: + type: + - ISPSystemTime + - uid: sp-page-context.ISPTimeZoneData.daylightOffset + isPreview: true + name: daylightOffset + fullName: sp-page-context.ISPTimeZoneData.daylightOffset + langs: + - typeScript + type: property + syntax: + content: 'daylightOffset: number;' + return: + type: + - number + - uid: sp-page-context.ISPTimeZoneData.description + isPreview: true + name: description + fullName: sp-page-context.ISPTimeZoneData.description + langs: + - typeScript + type: property + syntax: + content: 'description: string;' + return: + type: + - string + - uid: sp-page-context.ISPTimeZoneData.id + isPreview: true + name: id + fullName: sp-page-context.ISPTimeZoneData.id + langs: + - typeScript + type: property + syntax: + content: 'id: number;' + return: + type: + - number + - uid: sp-page-context.ISPTimeZoneData.offset + isPreview: true + name: offset + fullName: sp-page-context.ISPTimeZoneData.offset + langs: + - typeScript + type: property + syntax: + content: 'offset: number;' + return: + type: + - number + - uid: sp-page-context.ISPTimeZoneData.standardDate + isPreview: true + name: standardDate + fullName: sp-page-context.ISPTimeZoneData.standardDate + langs: + - typeScript + type: property + syntax: + content: 'standardDate: ISPSystemTime;' + return: + type: + - ISPSystemTime + - uid: sp-page-context.ISPTimeZoneData.standardOffset + isPreview: true + name: standardOffset + fullName: sp-page-context.ISPTimeZoneData.standardOffset + langs: + - typeScript + type: property + syntax: + content: 'standardOffset: number;' + return: + type: + - number diff --git a/SP-Framework/sp-page-context/spdayofweek.yml b/SP-Framework/sp-page-context/spdayofweek.yml new file mode 100644 index 00000000..71b50a06 --- /dev/null +++ b/SP-Framework/sp-page-context/spdayofweek.yml @@ -0,0 +1,75 @@ +### YamlMime:UniversalReference +items: + - uid: sp-page-context.SPDayOfWeek + summary: The enum members represent the seven days of a week. + isPreview: true + name: SPDayOfWeek + fullName: sp-page-context.SPDayOfWeek + langs: + - typeScript + type: enum + package: sp-page-context + children: + - sp-page-context.SPDayOfWeek.Friday + - sp-page-context.SPDayOfWeek.Monday + - sp-page-context.SPDayOfWeek.Saturday + - sp-page-context.SPDayOfWeek.Sunday + - sp-page-context.SPDayOfWeek.Thursday + - sp-page-context.SPDayOfWeek.Tuesday + - sp-page-context.SPDayOfWeek.Wednesday + - uid: sp-page-context.SPDayOfWeek.Friday + isPreview: true + name: Friday + fullName: sp-page-context.SPDayOfWeek.Friday + langs: + - typeScript + type: field + numericValue: '5' + - uid: sp-page-context.SPDayOfWeek.Monday + isPreview: true + name: Monday + fullName: sp-page-context.SPDayOfWeek.Monday + langs: + - typeScript + type: field + numericValue: '1' + - uid: sp-page-context.SPDayOfWeek.Saturday + isPreview: true + name: Saturday + fullName: sp-page-context.SPDayOfWeek.Saturday + langs: + - typeScript + type: field + numericValue: '6' + - uid: sp-page-context.SPDayOfWeek.Sunday + isPreview: true + name: Sunday + fullName: sp-page-context.SPDayOfWeek.Sunday + langs: + - typeScript + type: field + numericValue: '0' + - uid: sp-page-context.SPDayOfWeek.Thursday + isPreview: true + name: Thursday + fullName: sp-page-context.SPDayOfWeek.Thursday + langs: + - typeScript + type: field + numericValue: '4' + - uid: sp-page-context.SPDayOfWeek.Tuesday + isPreview: true + name: Tuesday + fullName: sp-page-context.SPDayOfWeek.Tuesday + langs: + - typeScript + type: field + numericValue: '2' + - uid: sp-page-context.SPDayOfWeek.Wednesday + isPreview: true + name: Wednesday + fullName: sp-page-context.SPDayOfWeek.Wednesday + langs: + - typeScript + type: field + numericValue: '3' diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml new file mode 100644 index 00000000..6ac24759 --- /dev/null +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -0,0 +1,124 @@ +### YamlMime:UniversalReference +items: + - uid: sp-page-context.SPTimeZone + summary: >- + It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using + the following formula. + + + isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate LocalTime = UTCTime - + Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) June 11, 2 A.M. PST = June 11, 9 A.M. - (480 + minutes) - (-60 minutes) + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the SPTimeZone class. + isPreview: true + name: SPTimeZone + fullName: sp-page-context.SPTimeZone + langs: + - typeScript + type: class + package: sp-page-context + children: + - sp-page-context.SPTimeZone.daylightDate + - sp-page-context.SPTimeZone.daylightOffset + - sp-page-context.SPTimeZone.description + - sp-page-context.SPTimeZone.id + - sp-page-context.SPTimeZone.offset + - sp-page-context.SPTimeZone.standardDate + - sp-page-context.SPTimeZone.standardOffset + - uid: sp-page-context.SPTimeZone.daylightDate + summary: Gets the date on which daylight time begins for the time zone. + isPreview: true + name: daylightDate + fullName: sp-page-context.SPTimeZone.daylightDate + langs: + - typeScript + type: property + syntax: + content: 'readonly daylightDate: ISPSystemTime;' + return: + type: + - ISPSystemTime + - uid: sp-page-context.SPTimeZone.daylightOffset + summary: >- + Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal + Time (UTC). + isPreview: true + name: daylightOffset + fullName: sp-page-context.SPTimeZone.daylightOffset + langs: + - typeScript + type: property + syntax: + content: 'readonly daylightOffset: number;' + return: + type: + - number + - uid: sp-page-context.SPTimeZone.description + summary: Gets the description for the time zone. + isPreview: true + name: description + fullName: sp-page-context.SPTimeZone.description + langs: + - typeScript + type: property + syntax: + content: 'readonly description: string;' + return: + type: + - string + - uid: sp-page-context.SPTimeZone.id + summary: Gets the ID of the time zone. + isPreview: true + name: id + fullName: sp-page-context.SPTimeZone.id + langs: + - typeScript + type: property + syntax: + content: 'readonly id: number;' + return: + type: + - number + - uid: sp-page-context.SPTimeZone.offset + summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). + isPreview: true + name: offset + fullName: sp-page-context.SPTimeZone.offset + langs: + - typeScript + type: property + syntax: + content: 'readonly offset: number;' + return: + type: + - number + - uid: sp-page-context.SPTimeZone.standardDate + summary: Gets the date on which standard time begins for the time zone. + isPreview: true + name: standardDate + fullName: sp-page-context.SPTimeZone.standardDate + langs: + - typeScript + type: property + syntax: + content: 'readonly standardDate: ISPSystemTime;' + return: + type: + - ISPSystemTime + - uid: sp-page-context.SPTimeZone.standardOffset + summary: >- + Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal + time (UTC). + isPreview: true + name: standardOffset + fullName: sp-page-context.SPTimeZone.standardOffset + langs: + - typeScript + type: property + syntax: + content: 'readonly standardOffset: number;' + return: + type: + - number diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index ba85f45c..9d46f2b4 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -16,10 +16,12 @@ items: children: - sp-page-context.SPUser.displayName - sp-page-context.SPUser.email + - sp-page-context.SPUser.firstDayOfWeek - sp-page-context.SPUser.isAnonymousGuestUser - sp-page-context.SPUser.isExternalGuestUser - sp-page-context.SPUser.loginName - sp-page-context.SPUser.preferUserTimeZone + - sp-page-context.SPUser.timeZoneInfo - uid: sp-page-context.SPUser.displayName summary: The display name for the current user. remarks: 'Example: "John Doe"' @@ -46,6 +48,19 @@ items: return: type: - string + - uid: sp-page-context.SPUser.firstDayOfWeek + summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. + isPreview: true + name: firstDayOfWeek + fullName: sp-page-context.SPUser.firstDayOfWeek + langs: + - typeScript + type: property + syntax: + content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' + return: + type: + - SPDayOfWeek | undefined - uid: sp-page-context.SPUser.isAnonymousGuestUser summary: Returns if the current user is an anonymous guest. name: isAnonymousGuestUser @@ -95,3 +110,16 @@ items: return: type: - boolean + - uid: sp-page-context.SPUser.timeZoneInfo + summary: Returns the user's regional timezone settings or undefined if they haven't been set. + isPreview: true + name: timeZoneInfo + fullName: sp-page-context.SPUser.timeZoneInfo + langs: + - typeScript + type: property + syntax: + content: 'readonly timeZoneInfo: SPTimeZone | undefined;' + return: + type: + - SPTimeZone | undefined diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index f6765411..30cdf7db 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -16,6 +16,7 @@ items: children: - sp-page-context.SPWeb.absoluteUrl - sp-page-context.SPWeb.description + - sp-page-context.SPWeb.firstDayOfWeek - sp-page-context.SPWeb.id - sp-page-context.SPWeb.isAppWeb - sp-page-context.SPWeb.language @@ -23,6 +24,7 @@ items: - sp-page-context.SPWeb.permissions - sp-page-context.SPWeb.serverRelativeUrl - sp-page-context.SPWeb.templateName + - sp-page-context.SPWeb.timeZoneInfo - sp-page-context.SPWeb.title - uid: sp-page-context.SPWeb.absoluteUrl summary: 'Returns the absolute URL for this SPWeb. Example: "https://example.com/sites/PubSite/SubWeb"' @@ -48,6 +50,19 @@ items: return: type: - string + - uid: sp-page-context.SPWeb.firstDayOfWeek + summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. + isPreview: true + name: firstDayOfWeek + fullName: sp-page-context.SPWeb.firstDayOfWeek + langs: + - typeScript + type: property + syntax: + content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' + return: + type: + - SPDayOfWeek | undefined - uid: sp-page-context.SPWeb.id summary: The GUID that identifies the SPWeb on the server. name: id @@ -140,6 +155,19 @@ items: return: type: - string + - uid: sp-page-context.SPWeb.timeZoneInfo + summary: Returns the web's regional timezone settings or undefined if they haven't been set. + isPreview: true + name: timeZoneInfo + fullName: sp-page-context.SPWeb.timeZoneInfo + langs: + - typeScript + type: property + syntax: + content: 'readonly timeZoneInfo: SPTimeZone | undefined;' + return: + type: + - SPTimeZone | undefined - uid: sp-page-context.SPWeb.title summary: Returns the title of the current SPWeb. name: title diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml new file mode 100644 index 00000000..a0e8c669 --- /dev/null +++ b/SP-Framework/sp-property-pane.yml @@ -0,0 +1,10 @@ +### YamlMime:UniversalReference +items: + - uid: sp-property-pane + summary: SharePoint Framework property pane. + remarks: 'Helps create the property pane for the SharePoint components such as web parts, canvas etc.,' + name: '@microsoft/sp-property-pane' + fullName: sp-property-pane + langs: + - typeScript + type: package diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 74d819f9..a26b1ec4 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -13,6 +13,8 @@ items: type: package children: - sp-webpart-base.BaseClientSideWebPart + - sp-webpart-base.BaseWebPart + - sp-webpart-base.BaseWebPartContext - sp-webpart-base.IClientSideWebPartStatusRenderer - sp-webpart-base.IPlaceholderSpinnerProps - sp-webpart-base.IPropertyPaneAccessor @@ -41,6 +43,7 @@ items: - sp-webpart-base.IWebPartContext - sp-webpart-base.IWebPartData - sp-webpart-base.IWebPartPropertiesMetadata + - sp-webpart-base.IWebPartPropertyMetadata - sp-webpart-base.PropertyPaneButton - sp-webpart-base.PropertyPaneButtonType - sp-webpart-base.PropertyPaneCheckbox @@ -340,6 +343,10 @@ items: references: - uid: sp-webpart-base.BaseClientSideWebPart name: BaseClientSideWebPart + - uid: sp-webpart-base.BaseWebPart + name: BaseWebPart + - uid: sp-webpart-base.BaseWebPartContext + name: BaseWebPartContext - uid: sp-webpart-base.IClientSideWebPartStatusRenderer name: IClientSideWebPartStatusRenderer - uid: sp-webpart-base.IPlaceholderSpinnerProps @@ -396,6 +403,8 @@ references: name: IWebPartData - uid: sp-webpart-base.IWebPartPropertiesMetadata name: IWebPartPropertiesMetadata + - uid: sp-webpart-base.IWebPartPropertyMetadata + name: IWebPartPropertyMetadata - uid: sp-webpart-base.PropertyPaneButtonType name: PropertyPaneButtonType - uid: sp-webpart-base.PropertyPaneDropdownOptionType diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 3828ad35..99b99219 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -23,41 +23,22 @@ items: - typeScript type: class extends: - - BaseComponent + - BaseWebPart package: sp-webpart-base children: - sp-webpart-base.BaseClientSideWebPart.constructor - - sp-webpart-base.BaseClientSideWebPart.accessibleTitle - sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender - sp-webpart-base.BaseClientSideWebPart.clearError - sp-webpart-base.BaseClientSideWebPart.context - - sp-webpart-base.BaseClientSideWebPart.dataVersion - - sp-webpart-base.BaseClientSideWebPart.description - - sp-webpart-base.BaseClientSideWebPart.disableReactivePropertyChanges - - sp-webpart-base.BaseClientSideWebPart.displayMode - sp-webpart-base.BaseClientSideWebPart.domElement - - sp-webpart-base.BaseClientSideWebPart.getPropertyPaneConfiguration - sp-webpart-base.BaseClientSideWebPart.isRenderAsync - - sp-webpart-base.BaseClientSideWebPart.onAfterDeserialize - - sp-webpart-base.BaseClientSideWebPart.onAfterPropertyPaneChangesApplied - - sp-webpart-base.BaseClientSideWebPart.onBeforeSerialize - sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged - sp-webpart-base.BaseClientSideWebPart.onDispose - - sp-webpart-base.BaseClientSideWebPart.onInit - - sp-webpart-base.BaseClientSideWebPart.onPropertyPaneConfigurationComplete - - sp-webpart-base.BaseClientSideWebPart.onPropertyPaneConfigurationStart - - sp-webpart-base.BaseClientSideWebPart.onPropertyPaneFieldChanged - - sp-webpart-base.BaseClientSideWebPart.onPropertyPaneRendered - - sp-webpart-base.BaseClientSideWebPart.previewImageUrl - - sp-webpart-base.BaseClientSideWebPart.properties - - sp-webpart-base.BaseClientSideWebPart.propertiesMetadata - - sp-webpart-base.BaseClientSideWebPart.propertyPaneRenderedByWebPart - sp-webpart-base.BaseClientSideWebPart.render - sp-webpart-base.BaseClientSideWebPart.renderCompleted - sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData - sp-webpart-base.BaseClientSideWebPart.renderedOnce - sp-webpart-base.BaseClientSideWebPart.renderError - - sp-webpart-base.BaseClientSideWebPart.title - uid: sp-webpart-base.BaseClientSideWebPart.constructor summary: Constructor for the BaseClientSideWebPart class. remarks: >- @@ -75,21 +56,6 @@ items: type: constructor syntax: content: constructor(); - - uid: sp-webpart-base.BaseClientSideWebPart.accessibleTitle - summary: >- - This property points to the accessible title of web part made available to screen readers. The base implementation - returns that default title in the manifest. Web parts that want to provide more descriptive title containing - contextual information need to override this API. - name: accessibleTitle - fullName: sp-webpart-base.BaseClientSideWebPart.accessibleTitle - langs: - - typeScript - type: property - syntax: - content: 'protected accessibleTitle: string;' - return: - type: - - string - uid: sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender summary: This property indicates whether a web part can open a popup on initial render. remarks: >- @@ -138,67 +104,6 @@ items: return: type: - WebPartContext - - uid: sp-webpart-base.BaseClientSideWebPart.dataVersion - summary: >- - The value of this property is stored in the serialized data of the web part to allow developers to manage - versioning of their web part. The default version is 1.0 - name: dataVersion - fullName: sp-webpart-base.BaseClientSideWebPart.dataVersion - langs: - - typeScript - type: property - syntax: - content: 'protected readonly dataVersion: Version;' - return: - type: - - Version - - uid: sp-webpart-base.BaseClientSideWebPart.description - summary: Description of the WebPart - name: description - fullName: sp-webpart-base.BaseClientSideWebPart.description - langs: - - typeScript - type: property - syntax: - content: 'protected readonly description: string;' - return: - type: - - string - - uid: sp-webpart-base.BaseClientSideWebPart.disableReactivePropertyChanges - summary: This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive. - remarks: >- - The default behavior is Reactive. - - - Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can - see instant updates. This helps the page creator get instant feedback and decide if they should keep the new - configuration changes or not. - - - NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane - button is clicked. - name: disableReactivePropertyChanges - fullName: sp-webpart-base.BaseClientSideWebPart.disableReactivePropertyChanges - langs: - - typeScript - type: property - syntax: - content: 'protected readonly disableReactivePropertyChanges: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.BaseClientSideWebPart.displayMode - summary: This property is the current display mode of the web part. - name: displayMode - fullName: sp-webpart-base.BaseClientSideWebPart.displayMode - langs: - - typeScript - type: property - syntax: - content: 'protected readonly displayMode: DisplayMode;' - return: - type: - - DisplayMode - uid: sp-webpart-base.BaseClientSideWebPart.domElement summary: >- This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole @@ -213,28 +118,6 @@ items: return: type: - HTMLElement - - uid: sp-webpart-base.BaseClientSideWebPart.getPropertyPaneConfiguration - summary: >- - This API is used to ger the configuration to build the property pane for the web part. If the web part wants to - use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the - configuration for the PropertyPane. - - - This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. - - - See IPropertyPane and other PropertyPane integration wiki documentation for more details. - name: getPropertyPaneConfiguration() - fullName: sp-webpart-base.BaseClientSideWebPart.getPropertyPaneConfiguration - langs: - - typeScript - type: method - syntax: - content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' - return: - type: - - IPropertyPaneConfiguration - description: '' - uid: sp-webpart-base.BaseClientSideWebPart.isRenderAsync summary: >- Indicates whether the web part is rendering in Async mode. Default value is false. If the web part overrides this @@ -249,79 +132,6 @@ items: return: type: - boolean - - uid: sp-webpart-base.BaseClientSideWebPart.onAfterDeserialize - summary: 'This API is called after the web part is deserialized to an object, right before the property bag is populated.' - remarks: >- - The default implementation is a no-op. A web part developer can override this API if the deserialized object does - not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate - the property bag right after the data is deserialized to an object. - - - An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized - by an older version of the web part that supported a different schema of the property bag, resulting the - deserialized object to be incosistent with the current schema of the property bag. The developer can use - onAfterDeserialize to check the dataVersion and fix the property bag. - name: 'onAfterDeserialize(deserializedObject, dataVersion)' - fullName: sp-webpart-base.BaseClientSideWebPart.onAfterDeserialize - langs: - - typeScript - type: method - syntax: - content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' - return: - type: - - TProperties - description: The property bag of the web part - parameters: - - id: deserializedObject - description: >- - The object deserialized from the stored data. Note that the schema of this object is not necessarily - consistent with the current property bag, because the serialization could have been done by an older version - of the web part - type: - - any - - id: dataVersion - description: >- - The data version of the stored data being deserialized. You can use this value to determine if the data was - serialized by an older web part. Web parts can define their data version by overriding the dataVersion - property. - type: - - Version - - uid: sp-webpart-base.BaseClientSideWebPart.onAfterPropertyPaneChangesApplied - summary: >- - This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in - Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. - name: onAfterPropertyPaneChangesApplied() - fullName: sp-webpart-base.BaseClientSideWebPart.onAfterPropertyPaneChangesApplied - langs: - - typeScript - type: method - syntax: - content: 'protected onAfterPropertyPaneChangesApplied(): void;' - return: - type: - - void - description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.onBeforeSerialize - summary: This event method is called before the web part is serialized. - remarks: >- - The default implementation is a no-op. The serialization process serializes the web part property bag i.e. - this.properties. This API gives the web part a chance to update it's property bag before the serialization - happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist - some of that state, it needs to override this API and update the web part property bag to the latest state. If a - web part updates the property bag with invalid property values, those will get persisted. So that should be - avoided. The web part property bag should always contain valid property values. - name: onBeforeSerialize() - fullName: sp-webpart-base.BaseClientSideWebPart.onBeforeSerialize - langs: - - typeScript - type: method - syntax: - content: 'protected onBeforeSerialize(): void;' - return: - type: - - void - description: '' - uid: sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged summary: This event method is called when the display mode of a web part is changed. remarks: >- @@ -362,161 +172,6 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.onInit - summary: >- - This API should be overridden to perform long running operations e.g. data fetching from a remote service before - the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This - API is called only once during the lifecycle of a web part. - name: onInit() - fullName: sp-webpart-base.BaseClientSideWebPart.onInit - langs: - - typeScript - type: method - syntax: - content: 'protected onInit(): Promise;' - return: - type: - - Promise - description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneConfigurationComplete - summary: This API is invoked when the configuration is completed on the PropertyPane. - remarks: |- - This event method is invoked in the following cases: - - - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. - - - When user clicks 'x'(close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - - When user clciks 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - - When the user switches web parts then the current web part gets this event. - name: onPropertyPaneConfigurationComplete() - fullName: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneConfigurationComplete - langs: - - typeScript - type: method - syntax: - content: 'protected onPropertyPaneConfigurationComplete(): void;' - return: - type: - - void - description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneConfigurationStart - summary: This event method is invoked when the configuration starts on the PropertyPane. - remarks: |- - This event method is invoked in the following cases: - - - When the PropertyPane is opened. - - - When the user switches web parts then the new web part gets this event. - name: onPropertyPaneConfigurationStart() - fullName: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneConfigurationStart - langs: - - typeScript - type: method - syntax: - content: 'protected onPropertyPaneConfigurationStart(): void;' - return: - type: - - void - description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneFieldChanged - summary: >- - This API is invoked after updating the new value of the property in the property bag when the PropertyPane is - being used in Reactive mode. - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - fullName: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneFieldChanged - langs: - - typeScript - type: method - syntax: - content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' - return: - type: - - void - description: '' - parameters: - - id: propertyPath - description: >- - JSON path of the property in the property bag. In the case of custom field, if no target property is - provided then a custom value is assigned, which will be in the form of '\_\_CustomField\_<key provided - when the custom field is created>'. - type: - - string - - id: oldValue - description: Old value of the property. This value could be undefined/empty in the case of custom field. - type: - - any - - id: newValue - description: New value of the property. This value could be undefined/empty in the case of custom field. - type: - - any - - uid: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneRendered - summary: This API is invoked when the PropertyPane is rendered. - name: onPropertyPaneRendered() - fullName: sp-webpart-base.BaseClientSideWebPart.onPropertyPaneRendered - langs: - - typeScript - type: method - syntax: - content: 'protected onPropertyPaneRendered(): void;' - return: - type: - - void - description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.previewImageUrl - summary: >- - This property points to the preview image for the web part. The base implementation returns undefined. Web parts - that want to provide a valid preview image url need to override this API. The preview image url can be used to - create a preview of the web part or of the page on which the web part is present. - name: previewImageUrl - fullName: sp-webpart-base.BaseClientSideWebPart.previewImageUrl - langs: - - typeScript - type: property - syntax: - content: 'protected previewImageUrl: string | undefined;' - return: - type: - - string | undefined - - uid: sp-webpart-base.BaseClientSideWebPart.properties - summary: This property is the pointer to the custom property bag of the web part. - name: properties - fullName: sp-webpart-base.BaseClientSideWebPart.properties - langs: - - typeScript - type: property - syntax: - content: 'protected readonly properties: TProperties;' - return: - type: - - TProperties - - uid: sp-webpart-base.BaseClientSideWebPart.propertiesMetadata - summary: >- - This property defines metadata for the web part property bag. The metadata can help SharePoint understand the - content of the properties better and perform relevant services on the data. - remarks: See IWebPartPropertiesMetadata for more information about how to define metadata - name: propertiesMetadata - fullName: sp-webpart-base.BaseClientSideWebPart.propertiesMetadata - langs: - - typeScript - type: property - syntax: - content: 'protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;' - return: - type: - - IWebPartPropertiesMetadata | undefined - - uid: sp-webpart-base.BaseClientSideWebPart.propertyPaneRenderedByWebPart - name: propertyPaneRenderedByWebPart - fullName: sp-webpart-base.BaseClientSideWebPart.propertyPaneRenderedByWebPart - langs: - - typeScript - type: property - syntax: - content: 'protected propertyPaneRenderedByWebPart: boolean;' - return: - type: - - boolean - uid: sp-webpart-base.BaseClientSideWebPart.render summary: >- This API is called to render the web part. There is no base implementation of this API and the web part is @@ -598,15 +253,3 @@ items: description: An error object containing the error message to render. type: - Error - - uid: sp-webpart-base.BaseClientSideWebPart.title - summary: Title of the WebPart - name: title - fullName: sp-webpart-base.BaseClientSideWebPart.title - langs: - - typeScript - type: property - syntax: - content: 'protected readonly title: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml new file mode 100644 index 00000000..e09b42de --- /dev/null +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -0,0 +1,439 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.BaseWebPart + summary: >- + This abstract class implements the UI-agnostic base functionality for a client side web part. The purpose is to + allow a common core between 2D and MR WebParts. + name: BaseWebPart + fullName: sp-webpart-base.BaseWebPart + langs: + - typeScript + type: class + extends: + - BaseComponent + implements: + - IPropertyPaneConsumer + package: sp-webpart-base + children: + - sp-webpart-base.BaseWebPart.constructor + - sp-webpart-base.BaseWebPart.accessibleTitle + - sp-webpart-base.BaseWebPart.context + - sp-webpart-base.BaseWebPart.dataVersion + - sp-webpart-base.BaseWebPart.description + - sp-webpart-base.BaseWebPart.disableReactivePropertyChanges + - sp-webpart-base.BaseWebPart.displayMode + - sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration + - sp-webpart-base.BaseWebPart.onAfterDeserialize + - sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied + - sp-webpart-base.BaseWebPart.onBeforeSerialize + - sp-webpart-base.BaseWebPart.onDisplayModeChanged + - sp-webpart-base.BaseWebPart.onDispose + - sp-webpart-base.BaseWebPart.onInit + - sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationComplete + - sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationStart + - sp-webpart-base.BaseWebPart.onPropertyPaneFieldChanged + - sp-webpart-base.BaseWebPart.onPropertyPaneRendered + - sp-webpart-base.BaseWebPart.previewImageUrl + - sp-webpart-base.BaseWebPart.properties + - sp-webpart-base.BaseWebPart.propertiesMetadata + - sp-webpart-base.BaseWebPart.title + - uid: sp-webpart-base.BaseWebPart.constructor + summary: Constructor for the BaseWebPart class. + remarks: >- + If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is + highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of + the web part features like this.context and this.properties are not available to be used before the the onInit + part of the web part loading lifecycle. + + + e.g. constructor() { super(); . . class specific constructor code .. } + name: constructor() + fullName: sp-webpart-base.BaseWebPart.constructor + langs: + - typeScript + type: constructor + syntax: + content: constructor(); + - uid: sp-webpart-base.BaseWebPart.accessibleTitle + summary: >- + This property points to the accessible title of web part made available to screen readers. The base implementation + returns that default title in the manifest. Web parts that want to provide more descriptive title containing + contextual information need to override this API. + name: accessibleTitle + fullName: sp-webpart-base.BaseWebPart.accessibleTitle + langs: + - typeScript + type: property + syntax: + content: 'protected readonly accessibleTitle: string;' + return: + type: + - string + - uid: sp-webpart-base.BaseWebPart.context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + name: context + fullName: sp-webpart-base.BaseWebPart.context + langs: + - typeScript + type: property + syntax: + content: 'protected readonly context: BaseWebPartContext;' + return: + type: + - BaseWebPartContext + - uid: sp-webpart-base.BaseWebPart.dataVersion + summary: >- + The value of this property is stored in the serialized data of the web part to allow developers to manage + versioning of their web part. The default version is 1.0 + name: dataVersion + fullName: sp-webpart-base.BaseWebPart.dataVersion + langs: + - typeScript + type: property + syntax: + content: 'protected readonly dataVersion: Version;' + return: + type: + - Version + - uid: sp-webpart-base.BaseWebPart.description + summary: Description of the WebPart + name: description + fullName: sp-webpart-base.BaseWebPart.description + langs: + - typeScript + type: property + syntax: + content: 'protected readonly description: string;' + return: + type: + - string + - uid: sp-webpart-base.BaseWebPart.disableReactivePropertyChanges + summary: This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive. + remarks: >- + The default behavior is Reactive. + + + Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can + see instant updates. This helps the page creator get instant feedback and decide if they should keep the new + configuration changes or not. + + + NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane + button is clicked. + name: disableReactivePropertyChanges + fullName: sp-webpart-base.BaseWebPart.disableReactivePropertyChanges + langs: + - typeScript + type: property + syntax: + content: 'protected readonly disableReactivePropertyChanges: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.BaseWebPart.displayMode + summary: This property is the current display mode of the web part. + name: displayMode + fullName: sp-webpart-base.BaseWebPart.displayMode + langs: + - typeScript + type: property + syntax: + content: 'protected readonly displayMode: DisplayMode;' + return: + type: + - DisplayMode + - uid: sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration + summary: >- + This API is used to ger the configuration to build the property pane for the web part. If the web part wants to + use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the + configuration for the PropertyPane. + + + This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. + + + See IPropertyPane and other PropertyPane integration wiki documentation for more details. + name: getPropertyPaneConfiguration() + fullName: sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration + langs: + - typeScript + type: method + syntax: + content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' + return: + type: + - IPropertyPaneConfiguration + description: '' + - uid: sp-webpart-base.BaseWebPart.onAfterDeserialize + summary: 'This API is called after the web part is deserialized to an object, right before the property bag is populated.' + remarks: >- + The default implementation is a no-op. A web part developer can override this API if the deserialized object does + not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate + the property bag right after the data is deserialized to an object. + + + An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized + by an older version of the web part that supported a different schema of the property bag, resulting the + deserialized object to be incosistent with the current schema of the property bag. The developer can use + onAfterDeserialize to check the dataVersion and fix the property bag. + name: 'onAfterDeserialize(deserializedObject, dataVersion)' + fullName: sp-webpart-base.BaseWebPart.onAfterDeserialize + langs: + - typeScript + type: method + syntax: + content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' + return: + type: + - TProperties + description: The property bag of the web part + parameters: + - id: deserializedObject + description: >- + The object deserialized from the stored data. Note that the schema of this object is not necessarily + consistent with the current property bag, because the serialization could have been done by an older version + of the web part + type: + - any + - id: dataVersion + description: >- + The data version of the stored data being deserialized. You can use this value to determine if the data was + serialized by an older web part. Web parts can define their data version by overriding the dataVersion + property. + type: + - Version + - uid: sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied + summary: >- + This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in + Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. + name: onAfterPropertyPaneChangesApplied() + fullName: sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied + langs: + - typeScript + type: method + syntax: + content: 'protected onAfterPropertyPaneChangesApplied(): void;' + return: + type: + - void + description: '' + - uid: sp-webpart-base.BaseWebPart.onBeforeSerialize + summary: This event method is called before the web part is serialized. + remarks: >- + The default implementation is a no-op. The serialization process serializes the web part property bag i.e. + this.properties. This API gives the web part a chance to update it's property bag before the serialization + happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist + some of that state, it needs to override this API and update the web part property bag to the latest state. If a + web part updates the property bag with invalid property values, those will get persisted. So that should be + avoided. The web part property bag should always contain valid property values. + name: onBeforeSerialize() + fullName: sp-webpart-base.BaseWebPart.onBeforeSerialize + langs: + - typeScript + type: method + syntax: + content: 'protected onBeforeSerialize(): void;' + return: + type: + - void + description: '' + - uid: sp-webpart-base.BaseWebPart.onDisplayModeChanged + summary: This event method is called when the display mode of a web part is changed. + remarks: >- + The default implementation of this API calls the web part render method to re-render the web part with the new + display mode. If a web part developer does not want a full re-render to happen on display mode change, they can + override this API and perform specific updates to the web part DOM to switch its display mode. + name: onDisplayModeChanged(oldDisplayMode) + fullName: sp-webpart-base.BaseWebPart.onDisplayModeChanged + langs: + - typeScript + type: method + syntax: + content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' + return: + type: + - void + description: '' + parameters: + - id: oldDisplayMode + description: The old display mode. + type: + - DisplayMode + - uid: sp-webpart-base.BaseWebPart.onDispose + summary: This API should be used to refresh the contents of the PropertyPane. + remarks: >- + This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local + resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being + transitioned out. + name: onDispose() + fullName: sp-webpart-base.BaseWebPart.onDispose + langs: + - typeScript + type: method + syntax: + content: 'protected onDispose(): void;' + return: + type: + - void + description: '' + - uid: sp-webpart-base.BaseWebPart.onInit + summary: >- + This API should be overridden to perform long running operations e.g. data fetching from a remote service before + the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This + API is called only once during the lifecycle of a web part. + name: onInit() + fullName: sp-webpart-base.BaseWebPart.onInit + langs: + - typeScript + type: method + syntax: + content: 'protected onInit(): Promise;' + return: + type: + - Promise + description: '' + - uid: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationComplete + summary: This API is invoked when the configuration is completed on the PropertyPane. + remarks: |- + This event method is invoked in the following cases: + + - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. + + - When user clicks 'x'(close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + + - When user clciks 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + + - When the user switches web parts then the current web part gets this event. + name: onPropertyPaneConfigurationComplete() + fullName: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationComplete + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneConfigurationComplete(): void;' + return: + type: + - void + description: '' + - uid: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationStart + summary: This event method is invoked when the configuration starts on the PropertyPane. + remarks: |- + This event method is invoked in the following cases: + + - When the PropertyPane is opened. + + - When the user switches web parts then the new web part gets this event. + name: onPropertyPaneConfigurationStart() + fullName: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationStart + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneConfigurationStart(): void;' + return: + type: + - void + description: '' + - uid: sp-webpart-base.BaseWebPart.onPropertyPaneFieldChanged + summary: >- + This API is invoked after updating the new value of the property in the property bag when the PropertyPane is + being used in Reactive mode. + name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + fullName: sp-webpart-base.BaseWebPart.onPropertyPaneFieldChanged + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' + return: + type: + - void + description: '' + parameters: + - id: propertyPath + description: >- + JSON path of the property in the property bag. In the case of custom field, if no target property is + provided then a custom value is assigned, which will be in the form of '\_\_CustomField\_<key provided + when the custom field is created>'. + type: + - string + - id: oldValue + description: Old value of the property. This value could be undefined/empty in the case of custom field. + type: + - any + - id: newValue + description: New value of the property. This value could be undefined/empty in the case of custom field. + type: + - any + - uid: sp-webpart-base.BaseWebPart.onPropertyPaneRendered + summary: This API is invoked when the PropertyPane is rendered. + name: onPropertyPaneRendered() + fullName: sp-webpart-base.BaseWebPart.onPropertyPaneRendered + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneRendered(): void;' + return: + type: + - void + description: '' + - uid: sp-webpart-base.BaseWebPart.previewImageUrl + summary: >- + This property points to the preview image for the web part. The base implementation returns undefined. Web parts + that want to provide a valid preview image url need to override this API. The preview image url can be used to + create a preview of the web part or of the page on which the web part is present. + name: previewImageUrl + fullName: sp-webpart-base.BaseWebPart.previewImageUrl + langs: + - typeScript + type: property + syntax: + content: 'protected readonly previewImageUrl: string | undefined;' + return: + type: + - string | undefined + - uid: sp-webpart-base.BaseWebPart.properties + summary: This property is the pointer to the custom property bag of the web part. + name: properties + fullName: sp-webpart-base.BaseWebPart.properties + langs: + - typeScript + type: property + syntax: + content: 'protected readonly properties: TProperties;' + return: + type: + - TProperties + - uid: sp-webpart-base.BaseWebPart.propertiesMetadata + summary: >- + This property defines metadata for the web part property bag. The metadata can help SharePoint understand the + content of the properties better and perform relevant services on the data. + remarks: See IWebPartPropertiesMetadata for more information about how to define metadata + name: propertiesMetadata + fullName: sp-webpart-base.BaseWebPart.propertiesMetadata + langs: + - typeScript + type: property + syntax: + content: 'protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;' + return: + type: + - IWebPartPropertiesMetadata | undefined + - uid: sp-webpart-base.BaseWebPart.title + summary: Title of the WebPart + name: title + fullName: sp-webpart-base.BaseWebPart.title + langs: + - typeScript + type: property + syntax: + content: 'protected readonly title: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml new file mode 100644 index 00000000..83fc49c9 --- /dev/null +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -0,0 +1,60 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.BaseWebPartContext + summary: >- + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. + + + This base is to be extended by UI-specific WebPart's base. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the BaseWebPartContext class. + name: BaseWebPartContext + fullName: sp-webpart-base.BaseWebPartContext + langs: + - typeScript + type: class + extends: + - BaseComponentContext + package: sp-webpart-base + children: + - sp-webpart-base.BaseWebPartContext.manifest + - sp-webpart-base.BaseWebPartContext.propertyPane + - sp-webpart-base.BaseWebPartContext.webPartTag + - uid: sp-webpart-base.BaseWebPartContext.manifest + summary: Manifest for the client side component. + name: manifest + fullName: sp-webpart-base.BaseWebPartContext.manifest + langs: + - typeScript + type: property + syntax: + content: 'readonly manifest: IClientSideWebPartManifestInstance;' + return: + type: + - IClientSideWebPartManifestInstance + - uid: sp-webpart-base.BaseWebPartContext.propertyPane + summary: Accessor for common web part property pane operations. + name: propertyPane + fullName: sp-webpart-base.BaseWebPartContext.propertyPane + langs: + - typeScript + type: property + syntax: + content: 'readonly propertyPane: IPropertyPaneAccessor;' + return: + type: + - IPropertyPaneAccessor + - uid: sp-webpart-base.BaseWebPartContext.webPartTag + summary: Web part tag to be used for logging and telemetry. + name: webPartTag + fullName: sp-webpart-base.BaseWebPartContext.webPartTag + langs: + - typeScript + type: property + syntax: + content: 'readonly webPartTag: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 1d69c198..cdf04959 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -66,7 +66,7 @@ items: description: '' parameters: - id: domElement - description: the webpart container div. + description: the web part container div. type: - Element - id: loadingMessage @@ -74,7 +74,7 @@ items: type: - string - id: timeout - description: timeout to render the loading indicator. Default is 900ms. + description: timeout to render the loading indicator. Default is 1500ms. type: - number - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.renderError diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index 269d00b1..33d4236a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -32,10 +32,10 @@ items: - typeScript type: property syntax: - content: 'groups: IPropertyPaneGroup[];' + content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' return: type: - - 'IPropertyPaneGroup[]' + - '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' - uid: sp-webpart-base.IPropertyPanePage.header summary: PropertyPane page header. name: header diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml new file mode 100644 index 00000000..3b0fc632 --- /dev/null +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -0,0 +1,106 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IWebPartPropertyMetadata + summary: This is the structure used for map values in IWebPartPropertiesMetadata + name: IWebPartPropertyMetadata + fullName: sp-webpart-base.IWebPartPropertyMetadata + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IWebPartPropertyMetadata.isHtmlString + - sp-webpart-base.IWebPartPropertyMetadata.isImageSource + - sp-webpart-base.IWebPartPropertyMetadata.isLink + - sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText + - sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist + - uid: sp-webpart-base.IWebPartPropertyMetadata.isHtmlString + summary: Indicates whether the property should be serialized as HTML. + remarks: >- + This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on + it: - normalizing HTML encodings - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) - search + indexing - SharePoint link fix-up + + + Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, + SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply + needs to be exposed to the search index (without any rewriting), use the isSearchablePlainText flag instead. + name: isHtmlString + fullName: sp-webpart-base.IWebPartPropertyMetadata.isHtmlString + langs: + - typeScript + type: property + syntax: + content: 'isHtmlString?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IWebPartPropertyMetadata.isImageSource + summary: >- + Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform + services like link fix-up, search indexing, loading from CDN, etc. + name: isImageSource + fullName: sp-webpart-base.IWebPartPropertyMetadata.isImageSource + langs: + - typeScript + type: property + syntax: + content: 'isImageSource?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IWebPartPropertyMetadata.isLink + summary: >- + Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform + services like search indexing, link fix-up, loading from CDN, etc. + name: isLink + fullName: sp-webpart-base.IWebPartPropertyMetadata.isLink + langs: + - typeScript + type: property + syntax: + content: 'isLink?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText + summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. + remarks: >- + This flag instructs the framework to store the property in a representation that supports search indexing. The + content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML + characters may be stored encoded and appear in search results. If your string contains HTML markup, use the + isHtmlString setting instead. Security note: For security reasons, never assign a plain text string to + Element.innerHTML. + name: isSearchablePlainText + fullName: sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText + langs: + - typeScript + type: property + syntax: + content: 'isSearchablePlainText?: boolean;' + return: + type: + - boolean + - uid: sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist + summary: >- + Indicates if the framework should persist the property on the server. Use this for properties that are only + important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data + of the web part and optimize the webpart load time. The property value will be removed from the serialized data + sent to the server, but this has no effect on the run-time property bag. The property value will still be + available in onBeforeSerialize() method, and the value will not be cleared from the run-time property bag. The + initial render of your web part should not depend on the value of the property. Setting a default value for the + property can be done in onInit() method. + + + Note that if the property path refers to a property that has a complex object as the value, the whole object will + be removed from the persisted data. + name: shouldNotPersist + fullName: sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist + langs: + - typeScript + type: property + syntax: + content: 'shouldNotPersist?: boolean;' + return: + type: + - boolean diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 1b5e1ac7..f5282a65 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -13,14 +13,11 @@ items: - typeScript type: class extends: - - BaseComponentContext + - BaseWebPartContext package: sp-webpart-base children: - sp-webpart-base.WebPartContext.domElement - - sp-webpart-base.WebPartContext.manifest - - sp-webpart-base.WebPartContext.propertyPane - sp-webpart-base.WebPartContext.statusRenderer - - sp-webpart-base.WebPartContext.webPartTag - uid: sp-webpart-base.WebPartContext.domElement summary: Reference to the DOM element that hosts this client side component. name: domElement @@ -33,30 +30,6 @@ items: return: type: - HTMLElement - - uid: sp-webpart-base.WebPartContext.manifest - summary: Manifest for the client side component. - name: manifest - fullName: sp-webpart-base.WebPartContext.manifest - langs: - - typeScript - type: property - syntax: - content: 'readonly manifest: IClientSideWebPartManifestInstance;' - return: - type: - - IClientSideWebPartManifestInstance - - uid: sp-webpart-base.WebPartContext.propertyPane - summary: Accessor for common web part property pane operations. - name: propertyPane - fullName: sp-webpart-base.WebPartContext.propertyPane - langs: - - typeScript - type: property - syntax: - content: 'readonly propertyPane: IPropertyPaneAccessor;' - return: - type: - - IPropertyPaneAccessor - uid: sp-webpart-base.WebPartContext.statusRenderer summary: Web part status renderer. name: statusRenderer @@ -69,15 +42,3 @@ items: return: type: - IClientSideWebPartStatusRenderer - - uid: sp-webpart-base.WebPartContext.webPartTag - summary: Web part tag to be used for logging and telemetry. - name: webPartTag - fullName: sp-webpart-base.WebPartContext.webPartTag - langs: - - typeScript - type: property - syntax: - content: 'readonly webPartTag: string;' - return: - type: - - string diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index ad726b46..a1721862 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -95,17 +95,19 @@ uid: sp-dialog.IDialogShowOptions - name: IPromptOptions uid: sp-dialog.IPromptOptions - - name: SecondaryDialogProvider - uid: sp-dialog.SecondaryDialogProvider + - name: ISecondaryDialogProvider + uid: sp-dialog.ISecondaryDialogProvider - name: sp-dynamic-data uid: sp-dynamic-data items: - name: DynamicDataReference uid: sp-dynamic-data.DynamicDataReference - - name: IDynamicDataController - uid: sp-dynamic-data.IDynamicDataController + - name: IDynamicDataCallables + uid: sp-dynamic-data.IDynamicDataCallables - name: IDynamicDataPropertyDefinition uid: sp-dynamic-data.IDynamicDataPropertyDefinition + - name: IDynamicDataPropertyMetadata + uid: sp-dynamic-data.IDynamicDataPropertyMetadata - name: IDynamicDataSource uid: sp-dynamic-data.IDynamicDataSource - name: IDynamicDataSourceMetadata @@ -130,12 +132,16 @@ uid: sp-http.AadTokenProvider - name: AadTokenProviderFactory uid: sp-http.AadTokenProviderFactory + - name: DigestCache + uid: sp-http.DigestCache - name: GraphHttpClient uid: sp-http.GraphHttpClient - name: GraphHttpClientConfiguration uid: sp-http.GraphHttpClientConfiguration - name: GraphHttpClientResponse uid: sp-http.GraphHttpClientResponse + - name: GraphRequest + uid: sp-http.GraphRequest - name: HttpClient uid: sp-http.HttpClient - name: HttpClientConfiguration @@ -146,10 +152,10 @@ uid: sp-http.IAadHttpClientConfiguration - name: IAadHttpClientConfigurations uid: sp-http.IAadHttpClientConfigurations - - name: IAadTokenProvider - uid: sp-http.IAadTokenProvider - - name: IAadTokenProviderConfiguration - uid: sp-http.IAadTokenProviderConfiguration + - name: IAadHttpClientOptions + uid: sp-http.IAadHttpClientOptions + - name: IDigestCache + uid: sp-http.IDigestCache - name: IGraphHttpClientConfiguration uid: sp-http.IGraphHttpClientConfiguration - name: IGraphHttpClientConfigurations @@ -178,6 +184,10 @@ uid: sp-http.ISPHttpClientConfigurations - name: ISPHttpClientOptions uid: sp-http.ISPHttpClientOptions + - name: MSGraphClient + uid: sp-http.MSGraphClient + - name: MSGraphClientFactory + uid: sp-http.MSGraphClientFactory - name: ODataVersion uid: sp-http.ODataVersion - name: SPHttpClient @@ -253,8 +263,14 @@ items: - name: CultureInfo uid: sp-page-context.CultureInfo + - name: ISPSystemTime + uid: sp-page-context.ISPSystemTime + - name: ISPTimeZoneData + uid: sp-page-context.ISPTimeZoneData - name: PageContext uid: sp-page-context.PageContext + - name: SPDayOfWeek + uid: sp-page-context.SPDayOfWeek - name: SPField uid: sp-page-context.SPField - name: SPList @@ -265,15 +281,23 @@ uid: sp-page-context.SPPermission - name: SPSite uid: sp-page-context.SPSite + - name: SPTimeZone + uid: sp-page-context.SPTimeZone - name: SPUser uid: sp-page-context.SPUser - name: SPWeb uid: sp-page-context.SPWeb + - name: sp-property-pane + uid: sp-property-pane - name: sp-webpart-base uid: sp-webpart-base items: - name: BaseClientSideWebPart uid: sp-webpart-base.BaseClientSideWebPart + - name: BaseWebPart + uid: sp-webpart-base.BaseWebPart + - name: BaseWebPartContext + uid: sp-webpart-base.BaseWebPartContext - name: IClientSideWebPartStatusRenderer uid: sp-webpart-base.IClientSideWebPartStatusRenderer - name: IPlaceholderSpinnerProps @@ -330,6 +354,8 @@ uid: sp-webpart-base.IWebPartData - name: IWebPartPropertiesMetadata uid: sp-webpart-base.IWebPartPropertiesMetadata + - name: IWebPartPropertyMetadata + uid: sp-webpart-base.IWebPartPropertyMetadata - name: PropertyPaneButtonType uid: sp-webpart-base.PropertyPaneButtonType - name: PropertyPaneDropdownOptionType diff --git a/generate-docs/json/decorators.api.json b/generate-docs/json/decorators.api.json index 09ae6e01..4f29e5b5 100644 --- a/generate-docs/json/decorators.api.json +++ b/generate-docs/json/decorators.api.json @@ -1,124 +1,124 @@ -{ - "kind": "package", - "name": "@microsoft/decorators", - "summary": [ - { - "kind": "text", - "text": "A conservative set of decorators intended for use in both NodeJS and web browser projects." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package provides a small set of decorators that enable more rigorous specification of API contracts when using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This package is not intended to be a general toolkit of language extensions or helpful macros." - } - ], - "exports": { - "override": { - "kind": "function", - "signature": "export function override(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "target": { - "name": "target", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Object" - }, - "propertyKey": { - "name": "propertyKey", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | symbol" - }, - "descriptor": { - "name": "descriptor", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "TypedPropertyDescriptor" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." - } - ], - "remarks": [], - "isBeta": false - }, - "sealed": { - "kind": "function", - "signature": "export function sealed(target: Function): void;", - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "target": { - "name": "target", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Function" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." - } - ], - "remarks": [], - "isBeta": false - }, - "virtual": { - "kind": "function", - "signature": "export function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "target": { - "name": "target", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Object" - }, - "propertyKey": { - "name": "propertyKey", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | symbol" - }, - "descriptor": { - "name": "descriptor", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "TypedPropertyDescriptor" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." - } - ], - "remarks": [], - "isBeta": false - } - } -} +{ + "kind": "package", + "name": "@microsoft/decorators", + "summary": [ + { + "kind": "text", + "text": "A conservative set of decorators intended for use in both NodeJS and web browser projects." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package provides a small set of decorators that enable more rigorous specification of API contracts when using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This package is not intended to be a general toolkit of language extensions or helpful macros." + } + ], + "exports": { + "override": { + "kind": "function", + "signature": "export function override(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "target": { + "name": "target", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Object" + }, + "propertyKey": { + "name": "propertyKey", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | symbol" + }, + "descriptor": { + "name": "descriptor", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "TypedPropertyDescriptor" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." + } + ], + "remarks": [], + "isBeta": false + }, + "sealed": { + "kind": "function", + "signature": "export function sealed(target: Function): void;", + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "target": { + "name": "target", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Function" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." + } + ], + "remarks": [], + "isBeta": false + }, + "virtual": { + "kind": "function", + "signature": "export function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "target": { + "name": "target", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Object" + }, + "propertyKey": { + "name": "propertyKey", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | symbol" + }, + "descriptor": { + "name": "descriptor", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "TypedPropertyDescriptor" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." + } + ], + "remarks": [], + "isBeta": false + } + } +} diff --git a/generate-docs/json/sp-application-base.api.json b/generate-docs/json/sp-application-base.api.json index 3862eac7..c1d173a8 100644 --- a/generate-docs/json/sp-application-base.api.json +++ b/generate-docs/json/sp-application-base.api.json @@ -1,798 +1,808 @@ -{ - "kind": "package", - "name": "@microsoft/sp-application-base", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework support for building and extending client-side applications." - } - ], - "remarks": [], - "exports": { - "ApplicationAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the client-side application that is currently running." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The client-side application determines the user experience for an entire web page. (It is a client-side component with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different application." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ApplicationAccessor" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "ApplicationAccessor", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseApplicationCustomizer.context" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "BaseApplicationCustomizer", - "memberName": "context" - } - }, - { - "kind": "text", - "text": "." - } - ] - }, - "navigatedEvent": { - "kind": "property", - "signature": "readonly navigatedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An event that is fired when the application's top-level page context navigates to a new page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This event fires after the top-level " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "@microsoft/sp-page-context:PageContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-page-context", - "exportName": "PageContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " has navigated to a new page." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ApplicationCustomizerContext": { - "kind": "class", - "extends": "ExtensionContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The component context for " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseApplicationCustomizer" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "BaseApplicationCustomizer", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ApplicationCustomizerContext class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "application": { - "kind": "property", - "signature": "readonly application: ApplicationAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ApplicationAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the client-side application that is currently running." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "placeholderProvider": { - "kind": "property", - "signature": "readonly placeholderProvider: PlaceholderProvider;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PlaceholderProvider", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Exposes a collection of content placeholders for use by third parties." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "BaseApplicationCustomizer": { - "kind": "class", - "extends": "BaseExtension", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\"." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "protected readonly context: ApplicationCustomizerContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ApplicationCustomizerContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPlaceholderCreateContentOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PlaceholderProvider.tryCreateContent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "tryCreateContent" - } - }, - { - "kind": "text", - "text": " method." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "onDispose": { - "kind": "property", - "signature": "onDispose?: (placeholderContent: PlaceholderContent) => void;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(placeholderContent: PlaceholderContent) => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An optional callback that will be invoked when the PlaceholderContent object is disposed." - } - ], - "remarks": [ - { - "kind": "text", - "text": "To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "PlaceholderContent": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents custom content that is rendered inside a placeholder on a SharePoint page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderContent class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This object is returned by " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PlaceholderProvider.tryCreateContent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "tryCreateContent" - } - }, - { - "kind": "text", - "text": ". It provides access to a Document Object Model (DOM) element where the owner can render its custom content." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disposes the PlaceholderContent object and removes its attached DOM element from the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the application when the containing placeholder is disposed. Calling dispose() invokes the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IPlaceholderCreateContentOptions.onDispose" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "IPlaceholderCreateContentOptions", - "memberName": "onDispose" - } - }, - { - "kind": "text", - "text": " callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLDivElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLDivElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Document Object Model (DOM) element where the owner should render its custom content." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the caller needs to be notified when the DOM element is disposed, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IPlaceholderCreateContentOptions.onDispose" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "IPlaceholderCreateContentOptions", - "memberName": "onDispose" - } - }, - { - "kind": "text", - "text": " callback." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "name": { - "kind": "property", - "signature": "readonly name: PlaceholderName;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PlaceholderName", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Identifies the placeholder that this content was added to." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: PlaceholderName.Top" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "PlaceholderName": { - "kind": "enum", - "values": { - "Bottom": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A region at the bottom of the page." - } - ], - "remarks": [], - "isBeta": false - }, - "Top": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A region at the top of the page." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The identifier for a content placeholder, which is a region on the page where third-party extensibility components can render custom content." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For more information about placeholders, see " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PlaceholderProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "isBeta": false - }, - "PlaceholderProvider": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderProvider class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Placeholders are designated regions on the page, identified by one of the predefined " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PlaceholderName" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderName", - "memberName": "" - } - }, - { - "kind": "text", - "text": " constants. Different applications and pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, for example via in-place navigation. Third-party components should not assume that a given placeholder will always be available." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Use " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PlaceholderProvider.tryCreateContent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "tryCreateContent" - } - }, - { - "kind": "text", - "text": " to test whether a placeholder is available and add content to it. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PlaceholderProvider.changedEvent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "changedEvent" - } - }, - { - "kind": "text", - "text": " event to discover when new placeholders appear." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "changedEvent": { - "kind": "property", - "signature": "readonly changedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event is raised when the list of currently available placeholders is changed." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "placeholderNames": { - "kind": "property", - "signature": "readonly placeholderNames: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the names of the currently available placeholders." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryCreateContent": { - "kind": "method", - "signature": "tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "PlaceholderContent | undefined", - "description": [ - { - "kind": "text", - "text": "A new PlaceholderContent object, or undefined if the requested placeholder does not exist." - } - ] - }, - "parameters": { - "name": { - "name": "name", - "description": [ - { - "kind": "text", - "text": "The requested placeholder" - } - ], - "isOptional": false, - "isSpread": false, - "type": "PlaceholderName" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Additional options, for example to detect when the placeholder is disposed." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IPlaceholderCreateContentOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-application-base", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for building and extending client-side applications." + } + ], + "remarks": [], + "exports": { + "ApplicationAccessor": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to the client-side application that is currently running." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The client-side application determines the user experience for an entire web page. (It is a client-side component with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different application." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ApplicationAccessor" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "ApplicationAccessor", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseApplicationCustomizer.context" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "BaseApplicationCustomizer", + "memberName": "context" + } + }, + { + "kind": "text", + "text": "." + } + ] + }, + "navigatedEvent": { + "kind": "property", + "signature": "readonly navigatedEvent: SPEvent;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An event that is fired when the application's top-level page context navigates to a new page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This event fires after the top-level " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "@microsoft/sp-page-context:PageContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-page-context", + "exportName": "PageContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " has navigated to a new page." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": true + } + } + }, + "ApplicationCustomizerContext": { + "kind": "class", + "extends": "ExtensionContext", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The component context for " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseApplicationCustomizer" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "BaseApplicationCustomizer", + "memberName": "" + } + }, + { + "kind": "text", + "text": "." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ApplicationCustomizerContext class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "application": { + "kind": "property", + "signature": "readonly application: ApplicationAccessor;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ApplicationAccessor", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to the client-side application that is currently running." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "placeholderProvider": { + "kind": "property", + "signature": "readonly placeholderProvider: PlaceholderProvider;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "PlaceholderProvider", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Exposes a collection of content placeholders for use by third parties." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "BaseApplicationCustomizer": { + "kind": "class", + "extends": "BaseExtension", + "implements": "", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\"." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "context": { + "kind": "property", + "signature": "protected readonly context: ApplicationCustomizerContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ApplicationCustomizerContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPlaceholderCreateContentOptions": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Options for the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PlaceholderProvider.tryCreateContent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "PlaceholderProvider", + "memberName": "tryCreateContent" + } + }, + { + "kind": "text", + "text": " method." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "onDispose": { + "kind": "property", + "signature": "onDispose?: (placeholderContent: PlaceholderContent) => void;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "(placeholderContent: PlaceholderContent) => void", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An optional callback that will be invoked when the PlaceholderContent object is disposed." + } + ], + "remarks": [ + { + "kind": "text", + "text": "To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "PlaceholderContent": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents custom content that is rendered inside a placeholder on a SharePoint page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderContent class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This object is returned by " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PlaceholderProvider.tryCreateContent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "PlaceholderProvider", + "memberName": "tryCreateContent" + } + }, + { + "kind": "text", + "text": ". It provides access to a Document Object Model (DOM) element where the owner can render its custom content." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the PlaceholderContent object and removes its attached DOM element from the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the application when the containing placeholder is disposed. Calling dispose() invokes the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IPlaceholderCreateContentOptions.onDispose" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "IPlaceholderCreateContentOptions", + "memberName": "onDispose" + } + }, + { + "kind": "text", + "text": " callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "domElement": { + "kind": "property", + "signature": "readonly domElement: HTMLDivElement;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HTMLDivElement", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Document Object Model (DOM) element where the owner should render its custom content." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the caller needs to be notified when the DOM element is disposed, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IPlaceholderCreateContentOptions.onDispose" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "IPlaceholderCreateContentOptions", + "memberName": "onDispose" + } + }, + { + "kind": "text", + "text": " callback." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "name": { + "kind": "property", + "signature": "readonly name: PlaceholderName;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "PlaceholderName", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Identifies the placeholder that this content was added to." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: PlaceholderName.Top" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "PlaceholderName": { + "kind": "enum", + "values": { + "Bottom": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A region at the bottom of the page." + } + ], + "remarks": [], + "isBeta": false + }, + "Top": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A region at the top of the page." + } + ], + "remarks": [], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The identifier for a content placeholder, which is a region on the page where third-party extensibility components can render custom content." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For more information about placeholders, see " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PlaceholderProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "PlaceholderProvider", + "memberName": "" + } + }, + { + "kind": "text", + "text": "." + } + ], + "isBeta": false + }, + "PlaceholderProvider": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderProvider class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Placeholders are designated regions on the page, identified by one of the predefined " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PlaceholderName" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "PlaceholderName", + "memberName": "" + } + }, + { + "kind": "text", + "text": " constants. Different applications and pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, for example via in-place navigation. Third-party components should not assume that a given placeholder will always be available." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Use " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PlaceholderProvider.tryCreateContent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "PlaceholderProvider", + "memberName": "tryCreateContent" + } + }, + { + "kind": "text", + "text": " to test whether a placeholder is available and add content to it. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PlaceholderProvider.changedEvent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-application-base", + "exportName": "PlaceholderProvider", + "memberName": "changedEvent" + } + }, + { + "kind": "text", + "text": " event to discover when new placeholders appear." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "changedEvent": { + "kind": "property", + "signature": "readonly changedEvent: SPEvent;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event is raised when the list of currently available placeholders is changed." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": true + }, + "placeholderNames": { + "kind": "property", + "signature": "readonly placeholderNames: ReadonlyArray;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ReadonlyArray", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the names of the currently available placeholders." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tryCreateContent": { + "kind": "method", + "signature": "tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "PlaceholderContent | undefined", + "description": [ + { + "kind": "text", + "text": "A new PlaceholderContent object, or undefined if the requested placeholder does not exist." + } + ] + }, + "parameters": { + "name": { + "name": "name", + "description": [ + { + "kind": "text", + "text": "The requested placeholder" + } + ], + "isOptional": false, + "isSpread": false, + "type": "PlaceholderName" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Additional options, for example to detect when the placeholder is disposed." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IPlaceholderCreateContentOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + } + } +} diff --git a/generate-docs/json/sp-component-base.api.json b/generate-docs/json/sp-component-base.api.json index d5b78fa2..86ac333a 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -1,1569 +1,1630 @@ -{ - "kind": "package", - "name": "@microsoft/sp-component-base", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework support for building client-side components" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package supports development of client-side components (e.g. web parts, client-side extensions, and applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types." - } - ], - "exports": { - "BaseComponent": { - "kind": "class", - "extends": "", - "implements": "ISPEventObserver", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for client-side components such as BaseClientSideWebPart or BaseExtension." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponent class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "componentId": { - "kind": "property", - "signature": "readonly componentId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the component identifier as defined in the component’s associated manifest." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "context": { - "kind": "property", - "signature": "protected context: BaseComponentContext;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "BaseComponentContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disposes the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseComponent.onDispose" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "BaseComponent", - "memberName": "onDispose" - } - }, - { - "kind": "text", - "text": " method." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the instance of the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the component has been already disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideComponentManifest;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideComponentManifest", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the manifest for the client-side component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes can override this with more specialized manifest types." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDispose": { - "kind": "method", - "signature": "protected onDispose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "BaseComponentContext": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for context objects for client-side components." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponentContext class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A \"context\" object is a collection of well-known services and other objects that are likely to be needed by business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "aadClientFactory": { - "kind": "property", - "signature": "readonly aadClientFactory: AadHttpClientFactory;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AadHttpClientFactory", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of AadHttpClientFactory created for this instance of component" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "aadTokenFactory": { - "kind": "property", - "signature": "readonly aadTokenFactory: AadTokenProviderFactory;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AadTokenProviderFactory", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of AadTokenProviderFactory created for this instance of component" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disposes the base component context." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataProvider": { - "kind": "property", - "signature": "readonly dynamicDataProvider: DynamicDataProvider;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "DynamicDataProvider", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the Dynamic Data Provider associated with the component." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataSourceManager": { - "kind": "property", - "signature": "readonly dynamicDataSourceManager: DynamicDataSourceManager;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "DynamicDataSourceManager", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the Dynamic Data Source Manager associated with the component." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "graphHttpClient": { - "kind": "property", - "signature": "readonly graphHttpClient: GraphHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of GraphHttpClient created for this instance of component" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "httpClient": { - "kind": "property", - "signature": "readonly httpClient: HttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of HttpClient created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the instance of the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the context is disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideComponentManifest;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideComponentManifest", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "pageContext": { - "kind": "property", - "signature": "readonly pageContext: PageContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PageContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceScope": { - "kind": "property", - "signature": "readonly serviceScope: ServiceScope;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ServiceScope", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The associated " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "@microsoft/sp-core-library:ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": " for this component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A child service scope is created for each client-side component." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "spHttpClient": { - "kind": "property", - "signature": "readonly spHttpClient: SPHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of SpHttpClient created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "DynamicDataProvider": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Dynamic Data Provider allows components to consume Dynamic Data. It allows data consumers to request Dynamic Data sources and register/unregister to those." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disposes the Dynamic Data Provider." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getAvailableSources": { - "kind": "method", - "signature": "getAvailableSources(): ReadonlyArray;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ReadonlyArray", - "description": [ - { - "kind": "text", - "text": "Read-only array with all available sources." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a list with all available Dynamic Data Sources." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the Dynamic Data Provider is disposed." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "registerAvailableSourcesChanged": { - "kind": "method", - "signature": "registerAvailableSourcesChanged(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Function to execute when the sources are updated." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "registerPropertyChanged": { - "kind": "method", - "signature": "registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ - { - "kind": "text", - "text": "Id of the Dynamic Data Source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "propertyId": { - "name": "propertyId", - "description": [ - { - "kind": "text", - "text": "Id of the property of the source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Function to execute when the source updates its data." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback for updates when a property is changed in a Dynamic Data source." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "registerSourceChanged": { - "kind": "method", - "signature": "registerSourceChanged(sourceId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ - { - "kind": "text", - "text": "Id of the Dynamic Data Source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Function to execute when the source updates its data." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetSource": { - "kind": "method", - "signature": "tryGetSource(id: string): IDynamicDataSource | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataSource | undefined", - "description": [] - }, - "parameters": { - "id": { - "name": "id", - "description": [ - { - "kind": "text", - "text": "Id of the Dynamic Data Source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregisterAvailableSourcesChanged": { - "kind": "method", - "signature": "unregisterAvailableSourcesChanged(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Function to remove from the registration. Must be the same it was registered with." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregisterPropertyChanged": { - "kind": "method", - "signature": "unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ - { - "kind": "text", - "text": "Id of the Dynamic Data Source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "propertyId": { - "name": "propertyId", - "description": [ - { - "kind": "text", - "text": "Id of the property of the source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Function to remove from the registration. Must be the same it was registered with." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Unregisters a callback for updates when a property is changed in a Dynamic Data source." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregisterSourceChanged": { - "kind": "method", - "signature": "unregisterSourceChanged(sourceId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ - { - "kind": "text", - "text": "Id of the Dynamic Data Source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Function to remove from the registration. Must be the same it was registered with." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Unregisters a callback for updates when a Dynamic Data source is changed." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "DynamicDataSourceManager": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Dynamic Data Source Manager allows components to expose data to other components through Dynamic Data. It allows data providers to update their metadata and notify when data has been updated." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disposes the Dynamic Data Provider." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "initializeSource": { - "kind": "method", - "signature": "initializeSource(controller: IDynamicDataController): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "controller": { - "name": "controller", - "description": [ - { - "kind": "text", - "text": "Set of functions for the Dynamic Data Source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IDynamicDataController" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Initializes a Dynamic Data Source for the component." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the Dynamic Data Provider is disposed." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "notifyPropertyChanged": { - "kind": "method", - "signature": "notifyPropertyChanged(propertyId: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "propertyId": { - "name": "propertyId", - "description": [ - { - "kind": "text", - "text": "Id of the updated property in the source." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies any Dynamic Data consumer that this source has updated a specific property." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "notifySourceChanged": { - "kind": "method", - "signature": "notifySourceChanged(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies any Dynamic Data consumer that this source has updated its data." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "updateMetadata": { - "kind": "method", - "signature": "updateMetadata(metadata: Partial): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "metadata": { - "name": "metadata", - "description": [ - { - "kind": "text", - "text": "Partial of the metadata." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Partial" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Updated the metadata of the Dynamic Data Source associated with the component. It allows to updated fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "DynamicProperty": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [ - "TValue" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Serializable object that simplifies usage of Dynamic Data." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This is built for usage in Web Part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the dynamic data will re-render the web part automatically." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(provider: DynamicDataProvider, callback?: () => void);", - "parameters": { - "provider": { - "name": "provider", - "description": [ - { - "kind": "text", - "text": "Dynamic Data Provider." - } - ], - "isOptional": false, - "isSpread": false, - "type": "DynamicDataProvider" - }, - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Optional. Default callback to be registered for updates in the Dynamic Data source." - } - ], - "isOptional": true, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a new Dynamic Data object." - } - ], - "remarks": [] - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This method is called to permanently dispose the object." - } - ], - "remarks": [ - { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "hasDefaultCallback": { - "kind": "method", - "signature": "hasDefaultCallback(): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the object has a default callback." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." - } - ], - "remarks": [ - { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "reference": { - "kind": "property", - "signature": "readonly reference: string | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "DynamicDataReference string that the Dynamic Data object points to. The reference is of the form ::." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the Dynamic Data object is set up with static data, this returns undefined." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "register": { - "kind": "method", - "signature": "register(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Callback function to register." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback function for updates on the associated Dynamic Data Source." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "removeDefaultCallback": { - "kind": "method", - "signature": "removeDefaultCallback(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Removes the registration for the default callback." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This can be useful for advanced users who only want their custom callbacks." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "setReference": { - "kind": "method", - "signature": "setReference(reference: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "reference": { - "name": "reference", - "description": [ - { - "kind": "text", - "text": "Id of the Dynamic Data." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Sets a Dynamic data id in the Dynamic Data object." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "setValue": { - "kind": "method", - "signature": "setValue(value: TValue): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "Value for the Dynamic Data." - } - ], - "isOptional": false, - "isSpread": false, - "type": "TValue" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Sets a static value in the Dynamic Data object." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetSource": { - "kind": "method", - "signature": "tryGetSource(): IDynamicDataSource | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataSource | undefined", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the Dynamic Data Source that the Dynamic Data object refers to. Returns undefined if the source doesn't exist." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetValue": { - "kind": "method", - "signature": "tryGetValue(): TValue | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "TValue | undefined", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the value of the Dynamic Data object. Returns undefined if the source or the data doesn't exist." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregister": { - "kind": "method", - "signature": "unregister(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "Callback function to unregister." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Unregisters a callback function for updates on the associated Dynamic Data Source. The callback function must be the same it was registered with." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-component-base", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for building client-side components" + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package supports development of client-side components (e.g. web parts, client-side extensions, and applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types." + } + ], + "exports": { + "BaseComponent": { + "kind": "class", + "extends": "", + "implements": "ISPEventObserver", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for client-side components such as BaseClientSideWebPart or BaseExtension." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponent class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "componentId": { + "kind": "property", + "signature": "readonly componentId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the component identifier as defined in the component’s associated manifest." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "context": { + "kind": "property", + "signature": "protected context: BaseComponentContext;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "BaseComponentContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseComponent.onDispose" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-component-base", + "exportName": "BaseComponent", + "memberName": "onDispose" + } + }, + { + "kind": "text", + "text": " method." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "instanceId": { + "kind": "property", + "signature": "readonly instanceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the instance of the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the component has been already disposed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manifest": { + "kind": "property", + "signature": "readonly manifest: IClientSideComponentManifest;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IClientSideComponentManifest", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to the manifest for the client-side component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes can override this with more specialized manifest types." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onDispose": { + "kind": "method", + "signature": "protected onDispose(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "BaseComponentContext": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for context objects for client-side components." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponentContext class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A \"context\" object is a collection of well-known services and other objects that are likely to be needed by business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "aadHttpClientFactory": { + "kind": "property", + "signature": "readonly aadHttpClientFactory: AadHttpClientFactory;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AadHttpClientFactory", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of AadHttpClientFactory created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "aadTokenProviderFactory": { + "kind": "property", + "signature": "readonly aadTokenProviderFactory: AadTokenProviderFactory;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AadTokenProviderFactory", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of AadTokenProviderFactory created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the base component context." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "dynamicDataProvider": { + "kind": "property", + "signature": "readonly dynamicDataProvider: DynamicDataProvider;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "DynamicDataProvider", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Dynamic Data Provider associated with the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dynamicDataSourceManager": { + "kind": "property", + "signature": "readonly dynamicDataSourceManager: DynamicDataSourceManager;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "DynamicDataSourceManager", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Dynamic Data Source Manager associated with the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "graphHttpClient": { + "kind": "property", + "signature": "readonly graphHttpClient: GraphHttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "GraphHttpClient", + "deprecatedMessage": [ + { + "kind": "text", + "text": "" + } + ], + "summary": [ + { + "kind": "text", + "text": "The instance of GraphHttpClient created for this instance of component" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "httpClient": { + "kind": "property", + "signature": "readonly httpClient: HttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HttpClient", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of HttpClient created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "instanceId": { + "kind": "property", + "signature": "readonly instanceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the instance of the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the context is disposed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manifest": { + "kind": "property", + "signature": "readonly manifest: IClientSideComponentManifest;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IClientSideComponentManifest", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Manifest for the client side component." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "msGraphClientFactory": { + "kind": "property", + "signature": "readonly msGraphClientFactory: MSGraphClientFactory;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "MSGraphClientFactory", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of MSGraphClientFactory created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "pageContext": { + "kind": "property", + "signature": "readonly pageContext: PageContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "PageContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serviceScope": { + "kind": "property", + "signature": "readonly serviceScope: ServiceScope;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ServiceScope", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The associated " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "@microsoft/sp-core-library:ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": " for this component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "A child service scope is created for each client-side component." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "spHttpClient": { + "kind": "property", + "signature": "readonly spHttpClient: SPHttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPHttpClient", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance of SpHttpClient created for this instance of component" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "DynamicDataProvider": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the Dynamic Data Provider." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getAvailableSources": { + "kind": "method", + "signature": "getAvailableSources(): ReadonlyArray;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ReadonlyArray", + "description": [ + { + "kind": "text", + "text": "Read-only array with all available sources." + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a list with all available Dynamic Data Sources." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the Dynamic Data Provider is disposed." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "registerAvailableSourcesChanged": { + "kind": "method", + "signature": "registerAvailableSourcesChanged(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to execute when the sources are updated." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "registerPropertyChanged": { + "kind": "method", + "signature": "registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "Id of the property of the source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to execute when the source updates its data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback for updates when a property is changed in a Dynamic Data source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "registerSourceChanged": { + "kind": "method", + "signature": "registerSourceChanged(sourceId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to execute when the source updates its data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetSource": { + "kind": "method", + "signature": "tryGetSource(id: string): IDynamicDataSource | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataSource | undefined", + "description": [] + }, + "parameters": { + "id": { + "name": "id", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregisterAvailableSourcesChanged": { + "kind": "method", + "signature": "unregisterAvailableSourcesChanged(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to remove from the registration. Must be the same it was registered with." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregisterPropertyChanged": { + "kind": "method", + "signature": "unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "Id of the property of the source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to remove from the registration. Must be the same it was registered with." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback for updates when a property is changed in a Dynamic Data source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregisterSourceChanged": { + "kind": "method", + "signature": "unregisterSourceChanged(sourceId: string, callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "sourceId": { + "name": "sourceId", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data Source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Function to remove from the registration. Must be the same it was registered with." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback for updates when a Dynamic Data source is changed." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "DynamicDataSourceManager": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the resources held by the Dynamic Data source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "initializeSource": { + "kind": "method", + "signature": "initializeSource(callableFunctions: IDynamicDataCallables): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callableFunctions": { + "name": "callableFunctions", + "description": [ + { + "kind": "text", + "text": "Set of methods exposed by the Dynamic Data Source to get the data. These apis are called by the consumer to retrieve properties, their values etc.," + } + ], + "isOptional": false, + "isSpread": false, + "type": "IDynamicDataCallables" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Initializes the Dynamic Data Source for the component." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the DynamicDataSourceManager is disposed." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "notifyPropertyChanged": { + "kind": "method", + "signature": "notifyPropertyChanged(propertyId: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "Id of the updated property in the source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies that this source has updated a specific property." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "notifySourceChanged": { + "kind": "method", + "signature": "notifySourceChanged(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies that this source has updated its data." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "updateMetadata": { + "kind": "method", + "signature": "updateMetadata(metadata: Partial): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "metadata": { + "name": "metadata", + "description": [ + { + "kind": "text", + "text": "Partial of the metadata." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Partial" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "DynamicProperty": { + "kind": "class", + "extends": "", + "implements": "IDisposable", + "typeParameters": [ + "TValue" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Serializable object that simplifies usage of Dynamic Data." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is built for usage in Web Part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the dynamic data will re-render the web part automatically." + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(provider: DynamicDataProvider, callback?: () => void);", + "parameters": { + "provider": { + "name": "provider", + "description": [ + { + "kind": "text", + "text": "Dynamic Data Provider." + } + ], + "isOptional": false, + "isSpread": false, + "type": "DynamicDataProvider" + }, + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Optional. Default callback to be registered for updates in the Dynamic Data source." + } + ], + "isOptional": true, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create a new Dynamic Property object." + } + ], + "remarks": [] + }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This method is called to permanently dispose the object." + } + ], + "remarks": [ + { + "kind": "text", + "text": "After the object has been disposed, do not call its methods or access its properties." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "hasDefaultCallback": { + "kind": "method", + "signature": "hasDefaultCallback(): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the object has a default callback." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." + } + ], + "remarks": [ + { + "kind": "text", + "text": "After the object has been disposed, do not call its methods or access its properties." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "reference": { + "kind": "property", + "signature": "readonly reference: string | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "DynamicDataReference string that the Dynamic Data object points to. The reference is of the form ::." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the Dynamic Data object is set up with static data, this returns undefined." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "register": { + "kind": "method", + "signature": "register(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Callback function to register." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback function for updates on the associated Dynamic Data Source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "removeDefaultCallback": { + "kind": "method", + "signature": "removeDefaultCallback(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Removes the registration for the default callback." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This can be useful for advanced users who only want their custom callbacks." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "setReference": { + "kind": "method", + "signature": "setReference(reference: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "reference": { + "name": "reference", + "description": [ + { + "kind": "text", + "text": "Id of the Dynamic Data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Sets a Dynamic data id in the Dynamic Data object." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "setValue": { + "kind": "method", + "signature": "setValue(value: TValue): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "Value for the Dynamic Data." + } + ], + "isOptional": false, + "isSpread": false, + "type": "TValue" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Sets a static value in the Dynamic Data object." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetSource": { + "kind": "method", + "signature": "tryGetSource(): IDynamicDataSource | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataSource | undefined", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Dynamic Data Source that the Dynamic Data object refers to. Returns undefined if the source doesn't exist." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetValue": { + "kind": "method", + "signature": "tryGetValue(): TValue | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "TValue | undefined", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the value of the Dynamic Data object. Returns undefined if the source or the data doesn't exist." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "unregister": { + "kind": "method", + "signature": "unregister(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "Callback function to unregister." + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback function for updates on the associated Dynamic Data Source. The callback function must be the same it was registered with." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + } + } +} diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index 13948bbd..3f74ebd8 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -1,3558 +1,3648 @@ -{ - "kind": "package", - "name": "@microsoft/sp-core-library", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework core libraries." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package provides a foundation of core classes that ensure a consistent character across all the other SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes small code size and broad applicability, versus flexibility or richness of features." - } - ], - "exports": { - "DisplayMode": { - "kind": "enum", - "values": { - "Edit": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience." - } - ], - "remarks": [], - "isBeta": false - }, - "Read": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether a visual control should display itself for reading or for editing." - } - ], - "remarks": [], - "isBeta": false - }, - "Environment": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Information about the system environment where the SharePoint Framework is running." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "type": { - "kind": "property", - "signature": "static readonly type: EnvironmentType;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "EnvironmentType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates the general type of environment where the SharePoint Framework is running." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "EnvironmentType": { - "kind": "enum", - "values": { - "ClassicSharePoint": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported." - } - ], - "remarks": [], - "isBeta": false - }, - "Local": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the SharePoint Framework is running on a page from a \"localhost\" web server, for example the SharePoint Workbench when hosted via \"gulp serve\". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing." - } - ], - "remarks": [], - "isBeta": false - }, - "SharePoint": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario." - } - ], - "remarks": [], - "isBeta": false - }, - "Test": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates the general type of environment where the SharePoint Framework is running." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This enum is used by the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Environment.type" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "Environment", - "memberName": "type" - } - }, - { - "kind": "text", - "text": " property. It provides a way to distinguish environments where certain functionality may be limited or disabled." - } - ], - "isBeta": false - }, - "Guid": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class represents a globally unique identifier, as described by IETF RFC 4122." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's Math.random() function and may be not be suitable for some applications." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "See " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "RFC4122" - } - ], - "targetUrl": "https://www.ietf.org/rfc/rfc4122.txt" - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "empty": { - "kind": "property", - "signature": "static readonly empty: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a new empty Guid instance." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "equals": { - "kind": "method", - "signature": "equals(guid: Guid): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "True if this instance and the specified Guid object represent the same value." - } - ] - }, - "parameters": { - "guid": { - "name": "guid", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Guid" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Compare this instance to another Guid instance" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isValid": { - "kind": "method", - "signature": "static isValid(guid: string | undefined | null): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "true, if the Guid is valid." - } - ] - }, - "parameters": { - "guid": { - "name": "guid", - "description": [ - { - "kind": "text", - "text": "The input string." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by Guid.tryParse(). This function is cheaper than Guid.tryParse() because it does not construct a Guid object." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "newGuid": { - "kind": "method", - "signature": "static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Guid", - "description": [ - { - "kind": "text", - "text": "A new unique Guid object" - } - ] - }, - "parameters": { - "randomNumberGenerator": { - "name": "randomNumberGenerator", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IRandomNumberGenerator" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "parse": { - "kind": "method", - "signature": "static parse(guidString: string | undefined | null): Guid;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Guid", - "description": [ - { - "kind": "text", - "text": "A valid Guid object" - } - ] - }, - "parameters": { - "guidString": { - "name": "guidString", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "toString": { - "kind": "method", - "signature": "toString(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [ - { - "kind": "text", - "text": "The GUID value in lowercase hexadecimal without braces." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489'" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a string representation of the GUID" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryParse": { - "kind": "method", - "signature": "static tryParse(guid: string | undefined | null): Guid | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Guid | undefined", - "description": [ - { - "kind": "text", - "text": "The Guid object, or undefined if the string could not be parsed." - } - ] - }, - "parameters": { - "guid": { - "name": "guid", - "description": [ - { - "kind": "text", - "text": "The input string." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDisposable": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Implemented by an object that supports a disposal lifecycle." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The dispose event allows an object to free any resources that it allocated before its lifecycle ends." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This method is called to permanently dispose the object." - } - ], - "remarks": [ - { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "isDisposed: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." - } - ], - "remarks": [ - { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IRandomNumberGenerator": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": " contract for generating pseudorandom random numbers." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface abstracts the functionality of the system Math.random() API for usage with a " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": ". For example, a unit test might replace the default " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "RandomNumberGenerator" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "RandomNumberGenerator", - "memberName": "" - } - }, - { - "kind": "text", - "text": " service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "generate": { - "kind": "method", - "signature": "generate(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IServiceCollection": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release." - } - ], - "summary": [ - { - "kind": "text", - "text": "A shorthand pattern for extracting well-known services from a ServiceScope." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "serviceScope": { - "kind": "property", - "signature": "readonly serviceScope: ServiceScope;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ServiceScope", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release." - } - ], - "summary": [ - { - "kind": "text", - "text": "Returns the underlying ServiceScope that the members belong to." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISPEventObserver": { - "kind": "interface", - "extends": "IDisposable", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Used with the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPEvent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "SPEvent", - "memberName": "" - } - }, - { - "kind": "text", - "text": " system, this interface is implemented by components that can subscribe to events." - } - ], - "remarks": [ - { - "kind": "text", - "text": "ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "componentId": { - "kind": "property", - "signature": "readonly componentId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The component identifier, from the component's manifest." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance identifier for the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ITimeProvider": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": " contract for reading the system clock." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface abstracts the functionality of the system time APIs for usage with a " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": ". For example, a unit test might replace the default " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "TimeProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "TimeProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": " service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "getDate": { - "kind": "method", - "signature": "getDate(): Date;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Date", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the current date/time, similar to the Date class constructor." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getTimestamp": { - "kind": "method", - "signature": "getTimestamp(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Log": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A basic redirectable logging system." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "error": { - "kind": "method", - "signature": "static error(source: string, error: Error, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ - { - "kind": "text", - "text": "the source from where the error is logged, e.g., the class name. The source provides context information for the logged error. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "error": { - "name": "error", - "description": [ - { - "kind": "text", - "text": "the error to be logged" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Error" - }, - "scope": { - "name": "scope", - "description": [ - { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error." - } - ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Logs an error." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "info": { - "kind": "method", - "signature": "static info(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ - { - "kind": "text", - "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "scope": { - "name": "scope", - "description": [ - { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." - } - ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Logs a general informational message." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "verbose": { - "kind": "method", - "signature": "static verbose(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ - { - "kind": "text", - "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "scope": { - "name": "scope", - "description": [ - { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." - } - ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Logs a message which contains detailed information that is generally only needed for troubleshooting." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "warn": { - "kind": "method", - "signature": "static warn(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ - { - "kind": "text", - "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "scope": { - "name": "scope", - "description": [ - { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." - } - ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Logs a warning." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "RandomNumberGenerator": { - "kind": "class", - "extends": "", - "implements": "IRandomNumberGenerator", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the default implementation of " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IRandomNumberGenerator" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "IRandomNumberGenerator", - "memberName": "" - } - }, - { - "kind": "text", - "text": " that simply calls Math.random()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "RandomNumberGenerator" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "RandomNumberGenerator", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "generate": { - "kind": "method", - "signature": "generate(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for IRandomNumberGenerator." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ServiceKey": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [ - "T" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The ServiceKey is a lookup key that is used when calling " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope.consume" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "consume" - } - }, - { - "kind": "text", - "text": " to fetch a dependency." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "create": { - "kind": "method", - "signature": "static create(name: string, serviceClass: {\n new (serviceScope: ServiceScope);\n }): ServiceKey;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ServiceKey", - "description": [ - { - "kind": "text", - "text": "the newly created ServiceKey" - } - ] - }, - "parameters": { - "name": { - "name": "name", - "description": [ - { - "kind": "text", - "text": "A name such as \"my-package.IMyService\" which should be unique across packages." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "serviceClass": { - "name": "serviceClass", - "description": [ - { - "kind": "text", - "text": "the TypeScript class that implements the service." - } - ], - "isOptional": false, - "isSpread": false, - "type": "{\n new (serviceScope: ServiceScope);\n }" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If you want to specify custom constructor parameters, use " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceKey.createCustom" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceKey", - "memberName": "createCustom" - } - }, - { - "kind": "text", - "text": " instead." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createCustom": { - "kind": "method", - "signature": "static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ServiceKey", - "description": [ - { - "kind": "text", - "text": "the newly created service key" - } - ] - }, - "parameters": { - "name": { - "name": "name", - "description": [ - { - "kind": "text", - "text": "A name such as \"my-package.IMyService\" which should be unique across packages." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "defaultCreator": { - "name": "defaultCreator", - "description": [ - { - "kind": "text", - "text": "a callback that returns an object that implements the T interface" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ServiceCreator" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "defaultCreator": { - "kind": "property", - "signature": "readonly defaultCreator: ServiceCreator;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ServiceCreator", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A callback function that constructs the default instance of this service." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "readonly id: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this service." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The identifier is a currently generated by incrementing an integer counter; however this may change in the future." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "name": { - "kind": "property", - "signature": "readonly name: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The name of the service." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the package name, followed by a period, followed by the class or interface name." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The system does not assume that this string is unique. Instead, the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceKey.id" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceKey", - "memberName": "id" - } - }, - { - "kind": "text", - "text": " is used wherever a lookup key is needed." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ServiceScope": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service locator pattern used by the SharePoint Framework." - } - ], - "remarks": [ - { - "kind": "text", - "text": "ServiceScope provides a formalized way for components to register and consume dependencies (\"services\"), and to enable different implementations to be registered in different scopes. This improves modularity by decoupling components from their dependencies in an extensible way." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For example, suppose that various components need access to an IPageManager instance. We could simply make the PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter for each component that requires it, however then we immediately face the problem that any code that calls these constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with name like \"ApplicationContext\", and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, it still has a design problem that \"ApplicationContext\" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the popular \"service locator\" design pattern, familiar from the SPContext API in classic SharePoint." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components can assume that consume() will always return some object that implements the contract." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are initially in an \"unfinished\" state, during which provide() can be called to register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the same key, and does not depend on order of initialization. It also allows us to support circular dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished()." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "protected constructor(parent: ServiceScope | undefined);", - "parameters": { - "parent": { - "name": "parent", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope | undefined" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "consume": { - "kind": "method", - "signature": "consume(serviceKey: ServiceKey): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "the service instance" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ - { - "kind": "text", - "text": "the key that was used when provide() was called to register the service" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Consumes a service from the service scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Components should call this function to \"consume\" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createAndProvide": { - "kind": "method", - "signature": "createAndProvide(serviceKey: ServiceKey, simpleServiceClass: {\n new (serviceScope: ServiceScope);\n }): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "a newly constructed instance of simpleServiceClass" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ - { - "kind": "text", - "text": "the key that can be used later to consume the service" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" - }, - "simpleServiceClass": { - "name": "simpleServiceClass", - "description": [ - { - "kind": "text", - "text": "the TypeScript class to be constructed" - } - ], - "isOptional": false, - "isSpread": false, - "type": "{\n new (serviceScope: ServiceScope);\n }" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createDefaultAndProvide": { - "kind": "method", - "signature": "createDefaultAndProvide(serviceKey: ServiceKey): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "a service instance that was constructed using ServiceKey.defaultCreator" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ - { - "kind": "text", - "text": "the key that can be used later to consume the service" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "finish": { - "kind": "method", - "signature": "finish(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Completes the initialization sequence for a service scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When a ServiceScope is first started, it is in an \"unfinished\" state where provide() is allowed but consume() is disallowed. After calling finish(), then consume() is allowed but provide() is disallowed." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getParent": { - "kind": "method", - "signature": "getParent(): ServiceScope | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ServiceScope | undefined", - "description": [ - { - "kind": "text", - "text": "the parent service scope" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the parent of the current ServiceScope, or undefined if this is a root scope." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "provide": { - "kind": "method", - "signature": "provide(serviceKey: ServiceKey, service: T): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "the same object that was passed as the \"service\" parameter" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ - { - "kind": "text", - "text": "the key that will later be used to consume the service" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" - }, - "service": { - "name": "service", - "description": [ - { - "kind": "text", - "text": "the service instance that is being registered" - } - ], - "isOptional": false, - "isSpread": false, - "type": "T" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add a new service to a service scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an \"unfinished\" state, i.e. before finish() has been called." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "startNewChild": { - "kind": "method", - "signature": "startNewChild(): ServiceScope;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ServiceScope", - "description": [ - { - "kind": "text", - "text": "the newly created root ServiceScope" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new ServiceScope that is a child of the current scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "startNewRoot": { - "kind": "method", - "signature": "static startNewRoot(): ServiceScope;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ServiceScope", - "description": [ - { - "kind": "text", - "text": "the newly created root ServiceScope" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "whenFinished": { - "kind": "method", - "signature": "whenFinished(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "A block of code that needs to call ServiceScope.consume()" - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Defer an operation until after " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope.finish" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "finish" - } - }, - { - "kind": "text", - "text": " has completed." - } - ], - "remarks": [ - { - "kind": "text", - "text": "It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed later when the scope is finished." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished()." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Session": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the application's browser session and active page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "applicationId": { - "kind": "property", - "signature": "static readonly applicationId: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the current instance of the client-side application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the duration of the client-side application instance, i.e. it begins with the server request that renders the page, and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "pageId": { - "kind": "property", - "signature": "static readonly pageId: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the current page within the client-side application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A unique identifier used to correlate logging and other diagnostic information. Whereas the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Session.applicationId" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "Session", - "memberName": "applicationId" - } - }, - { - "kind": "text", - "text": " tracks the entire lifetime of the client-side application instance, the pageId tracks an individual \"page\" that is rendered." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA independently of PageB." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The concept of a page is subjective and defined by the router for a particular application." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPEvent": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [ - "TEventArgs extends SPEventArgs" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a framework event that components can subscribe to." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPEvent class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "add": { - "kind": "method", - "signature": "add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "observer": { - "name": "observer", - "description": [ - { - "kind": "text", - "text": "Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception." - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPEventObserver" - }, - "eventHandler": { - "name": "eventHandler", - "description": [ - { - "kind": "text", - "text": "A callback function that will be invoked whenever the event occurs" - } - ], - "isOptional": false, - "isSpread": false, - "type": "(eventArgs: TEventArgs) => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback that will be invoked whenever the event occurs." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "remove": { - "kind": "method", - "signature": "remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "observer": { - "name": "observer", - "description": [ - { - "kind": "text", - "text": "This must be the same observer that was passed to the add() function." - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPEventObserver" - }, - "eventHandler": { - "name": "eventHandler", - "description": [ - { - "kind": "text", - "text": "The event handler to remove; this must be the same object instance that was passed to the add() function." - } - ], - "isOptional": false, - "isSpread": false, - "type": "(eventArgs: TEventArgs) => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Unregisters a callback that was registered using add()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the event handler has already been removed, or if it was never added, then this method has no effect." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPEventArgs": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for event arguments used with the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPEvent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "SPEvent", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If certain event types need to provide additional details, they will define a subclass of SPEventArgs." - } - ], - "isBeta": false, - "isSealed": false - }, - "Text": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Operations for working with strings that contain text." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The utilities provided by this class are intended to be simple, small, and very broadly applicable." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "format": { - "kind": "method", - "signature": "static format(s: string, ...values: any[]): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": { - "s": { - "name": "s", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "values": { - "name": "values", - "description": [], - "isOptional": false, - "isSpread": true, - "type": "any[]" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Format a string by substituting parameters." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This function replaces template parameters such as \"{0}\" or \"{1}\" with the corresponding argument. If the value is null or undefined, it will be replaced by the word \"null\" or \"undefined\". The format string s must not be null or undefined." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Usage example:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Text.format(\"hello {0}!\", \"world\") will return \"hello world!\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "TimeProvider": { - "kind": "class", - "extends": "", - "implements": "ITimeProvider", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the default implementation of " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ITimeProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ITimeProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": " that simply calls the real browser APIs." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "TimeProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "TimeProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "getDate": { - "kind": "method", - "signature": "getDate(): Date;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Date", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the current date/time, similar to the Date class constructor." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getTimestamp": { - "kind": "method", - "signature": "getTimestamp(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for ITimeProvider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "UrlQueryParameterCollection": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Provides features for storing and retrieving URL query parameters." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with \"?\" to indicate the first query parameter and use \"&\" for all subsequent parameters. The class also supports fragments." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Edge case behavior:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(url: string);", - "parameters": { - "url": { - "name": "url", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "UrlQueryParameterCollection" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "UrlQueryParameterCollection", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "getValue": { - "kind": "method", - "signature": "getValue(param: string): string | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string | undefined", - "description": [] - }, - "parameters": { - "param": { - "name": "param", - "description": [ - { - "kind": "text", - "text": "the case insensitive key for the desired query parameter value." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Returns the value of the first matching query parameter or undefined if the key doesn't exist." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValue('TEST') ---> 'done' getValue('debug') ---> 'false' getValue('lost') ---> undefined" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getValues": { - "kind": "method", - "signature": "getValues(param: string): (string | undefined)[] | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "(string | undefined)[] | undefined", - "description": [] - }, - "parameters": { - "param": { - "name": "param", - "description": [ - { - "kind": "text", - "text": "the case insensitive key for the desired query parameter value." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Returns the values of all of the matching query parameters or undefined if the key doesn't exist." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValues('TEST') ---> ['done', 'notdone'] getValues('debug') ---> ['false'] getValues('lost') ---> undefined" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Validate": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Performs common validation tests for properties and function parameters." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "isNonemptyString": { - "kind": "method", - "signature": "static isNonemptyString(value: string | undefined | null, variableName: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - }, - "variableName": { - "name": "variableName", - "description": [ - { - "kind": "text", - "text": "the program variable name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Throws an exception if the specified string is null, undefined, or an empty string." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isNotDisposed": { - "kind": "method", - "signature": "static isNotDisposed(value: IDisposable, className: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IDisposable" - }, - "className": { - "name": "className", - "description": [ - { - "kind": "text", - "text": "the class name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Throws an exception if the specified object has been disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isNotNullOrUndefined": { - "kind": "method", - "signature": "static isNotNullOrUndefined(value: any, variableName: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "variableName": { - "name": "variableName", - "description": [ - { - "kind": "text", - "text": "the program variable name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Throws an exception if the specified value is null or undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isTrue": { - "kind": "method", - "signature": "static isTrue(value: boolean | undefined | null, variableName: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "boolean | undefined | null" - }, - "variableName": { - "name": "variableName", - "description": [ - { - "kind": "text", - "text": "the program variable name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Throws an exception if the specified value is not true." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Version": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a version number with two, three, or four parts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This class represents versions that follow the string format of MAJOR.MINOR[.PATCH[.REVISION]] where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Examples: 1.0, 1.0.0, 1.0.0.0, 1.01, 01.02.03, 001.002.003.004" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "compare": { - "kind": "method", - "signature": "static compare(v1: Version, v2: Version): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "number", - "description": [ - { - "kind": "text", - "text": "-1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if the first input is greater than the second input." - } - ] - }, - "parameters": { - "v1": { - "name": "v1", - "description": [ - { - "kind": "text", - "text": "The first version class for comparison" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - }, - "v2": { - "name": "v2", - "description": [ - { - "kind": "text", - "text": "The second version class for comparison" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Compares two Version objects to determine which version is newer." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "equals": { - "kind": "method", - "signature": "equals(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is equal to the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ - { - "kind": "text", - "text": "The version to compare with" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tests whether this version is equal to the input parameter." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1.0.0 equals 1.0.0 -> true; 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "greaterThan": { - "kind": "method", - "signature": "greaterThan(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is greater than the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ - { - "kind": "text", - "text": "The version to compare with" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tests whether this version is greater than (i.e. newer than) the input parameter." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isValid": { - "kind": "method", - "signature": "static isValid(versionString: string | undefined | null): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "true if the versionString is a valid version specifier" - } - ] - }, - "parameters": { - "versionString": { - "name": "versionString", - "description": [ - { - "kind": "text", - "text": "The version string" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Test whether a string is a valid version specifier." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "lessThan": { - "kind": "method", - "signature": "lessThan(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is less than the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ - { - "kind": "text", - "text": "The version to compare with" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tests whether this version is less than (i.e. older than) the input parameter." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "0.9.9 lessThan 1.0.0 -> true; 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "major": { - "kind": "property", - "signature": "readonly major: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the first component of the version string." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically a change in the major version number indicates a compatibility break with previous versions." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "minor": { - "kind": "property", - "signature": "readonly minor: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the second component of the version string." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "parse": { - "kind": "method", - "signature": "static parse(versionString: string | undefined | null): Version;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Version", - "description": [ - { - "kind": "text", - "text": "a new Version object" - } - ] - }, - "parameters": { - "versionString": { - "name": "versionString", - "description": [ - { - "kind": "text", - "text": "A version string" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "patch": { - "kind": "property", - "signature": "readonly patch: number | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The third number in the version string, or undefined if unspecified." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the \"build\" number." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "revision": { - "kind": "property", - "signature": "readonly revision: number | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The fourth number in the version string, or undefined if unspecified." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "satisfies": { - "kind": "method", - "signature": "satisfies(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is compatible with the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ - { - "kind": "text", - "text": "The version to compare with" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible." - } - ], - "remarks": [ - { - "kind": "text", - "text": "In order to satisfy the compatibility requirements, this object must have the same major version number as the input parameter, and it must NOT be older than the input parameter." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Examples:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1.0.0 satisfies 1.0.0 -> true; 1.1.0 satisfies 1.0.0 -> true; 2.0.0 satisfies 1.0.0 -> false; 1.0.0 satisfies 1.1.0 -> false" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "toString": { - "kind": "method", - "signature": "toString(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a string representation of the version." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryParse": { - "kind": "method", - "signature": "static tryParse(versionString: string | undefined | null): Version | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Version | undefined", - "description": [ - { - "kind": "text", - "text": "The Version object, or undefined if the string could not be parsed." - } - ] - }, - "parameters": { - "versionString": { - "name": "versionString", - "description": [ - { - "kind": "text", - "text": "A version string" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-core-library", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework core libraries." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package provides a foundation of core classes that ensure a consistent character across all the other SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes small code size and broad applicability, versus flexibility or richness of features." + } + ], + "exports": { + "DisplayMode": { + "kind": "enum", + "values": { + "Edit": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience." + } + ], + "remarks": [], + "isBeta": false + }, + "Read": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled." + } + ], + "remarks": [], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether a visual control should display itself for reading or for editing." + } + ], + "remarks": [], + "isBeta": false + }, + "Environment": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Information about the system environment where the SharePoint Framework is running." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "type": { + "kind": "property", + "signature": "static readonly type: EnvironmentType;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "EnvironmentType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates the general type of environment where the SharePoint Framework is running." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "EnvironmentType": { + "kind": "enum", + "values": { + "ClassicSharePoint": { + "kind": "enum value", + "value": "3", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported." + } + ], + "remarks": [], + "isBeta": false + }, + "Local": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that the SharePoint Framework is running on a page from a \"localhost\" web server, for example the SharePoint Workbench when hosted via \"gulp serve\". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing." + } + ], + "remarks": [], + "isBeta": false + }, + "SharePoint": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario." + } + ], + "remarks": [], + "isBeta": false + }, + "Test": { + "kind": "enum value", + "value": "0", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled." + } + ], + "remarks": [], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates the general type of environment where the SharePoint Framework is running." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This enum is used by the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "Environment.type" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "Environment", + "memberName": "type" + } + }, + { + "kind": "text", + "text": " property. It provides a way to distinguish environments where certain functionality may be limited or disabled." + } + ], + "isBeta": false + }, + "Guid": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class represents a globally unique identifier, as described by IETF RFC 4122." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's Math.random() function and may be not be suitable for some applications." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "See " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "RFC4122" + } + ], + "targetUrl": "https://www.ietf.org/rfc/rfc4122.txt" + }, + { + "kind": "text", + "text": " for more information." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "empty": { + "kind": "property", + "signature": "static readonly empty: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a new empty Guid instance." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "equals": { + "kind": "method", + "signature": "equals(guid: Guid): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "True if this instance and the specified Guid object represent the same value." + } + ] + }, + "parameters": { + "guid": { + "name": "guid", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Guid" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Compare this instance to another Guid instance" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isValid": { + "kind": "method", + "signature": "static isValid(guid: string | undefined | null): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "true, if the Guid is valid." + } + ] + }, + "parameters": { + "guid": { + "name": "guid", + "description": [ + { + "kind": "text", + "text": "The input string." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by Guid.tryParse(). This function is cheaper than Guid.tryParse() because it does not construct a Guid object." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "newGuid": { + "kind": "method", + "signature": "static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Guid", + "description": [ + { + "kind": "text", + "text": "A new unique Guid object" + } + ] + }, + "parameters": { + "randomNumberGenerator": { + "name": "randomNumberGenerator", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IRandomNumberGenerator" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "parse": { + "kind": "method", + "signature": "static parse(guidString: string | undefined | null): Guid;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Guid", + "description": [ + { + "kind": "text", + "text": "A valid Guid object" + } + ] + }, + "parameters": { + "guidString": { + "name": "guidString", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "toString": { + "kind": "method", + "signature": "toString(): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "string", + "description": [ + { + "kind": "text", + "text": "The GUID value in lowercase hexadecimal without braces." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489'" + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a string representation of the GUID" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryParse": { + "kind": "method", + "signature": "static tryParse(guid: string | undefined | null): Guid | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Guid | undefined", + "description": [ + { + "kind": "text", + "text": "The Guid object, or undefined if the string could not be parsed." + } + ] + }, + "parameters": { + "guid": { + "name": "guid", + "description": [ + { + "kind": "text", + "text": "The input string." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IDisposable": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Implemented by an object that supports a disposal lifecycle." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The dispose event allows an object to free any resources that it allocated before its lifecycle ends." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This method is called to permanently dispose the object." + } + ], + "remarks": [ + { + "kind": "text", + "text": "After the object has been disposed, do not call its methods or access its properties." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "isDisposed: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." + } + ], + "remarks": [ + { + "kind": "text", + "text": "After the object has been disposed, do not call its methods or access its properties." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IRandomNumberGenerator": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is a " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": " contract for generating pseudorandom random numbers." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface abstracts the functionality of the system Math.random() API for usage with a " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": ". For example, a unit test might replace the default " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "RandomNumberGenerator" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "RandomNumberGenerator", + "memberName": "" + } + }, + { + "kind": "text", + "text": " service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "generate": { + "kind": "method", + "signature": "generate(): number;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "number", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random()." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IServiceCollection": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release." + } + ], + "summary": [ + { + "kind": "text", + "text": "A shorthand pattern for extracting well-known services from a ServiceScope." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "serviceScope": { + "kind": "property", + "signature": "readonly serviceScope: ServiceScope;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ServiceScope", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release." + } + ], + "summary": [ + { + "kind": "text", + "text": "Returns the underlying ServiceScope that the members belong to." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPEventObserver": { + "kind": "interface", + "extends": "IDisposable", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Used with the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPEvent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "SPEvent", + "memberName": "" + } + }, + { + "kind": "text", + "text": " system, this interface is implemented by components that can subscribe to events." + } + ], + "remarks": [ + { + "kind": "text", + "text": "ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "componentId": { + "kind": "property", + "signature": "readonly componentId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The component identifier, from the component's manifest." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "instanceId": { + "kind": "property", + "signature": "readonly instanceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The instance identifier for the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ITimeProvider": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is a " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": " contract for reading the system clock." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface abstracts the functionality of the system time APIs for usage with a " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": ". For example, a unit test might replace the default " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "TimeProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "TimeProvider", + "memberName": "" + } + }, + { + "kind": "text", + "text": " service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "getDate": { + "kind": "method", + "signature": "getDate(): Date;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Date", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the current date/time, similar to the Date class constructor." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getTimestamp": { + "kind": "method", + "signature": "getTimestamp(): number;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "number", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "Log": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A basic redirectable logging system." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "error": { + "kind": "method", + "signature": "static error(source: string, error: Error, scope?: ServiceScope): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "source": { + "name": "source", + "description": [ + { + "kind": "text", + "text": "the source from where the error is logged, e.g., the class name. The source provides context information for the logged error. If the source's length is more than 20, only the first 20 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "error": { + "name": "error", + "description": [ + { + "kind": "text", + "text": "the error to be logged" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Error" + }, + "scope": { + "name": "scope", + "description": [ + { + "kind": "text", + "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error." + } + ], + "isOptional": true, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Logs an error." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "info": { + "kind": "method", + "signature": "static info(source: string, message: string, scope?: ServiceScope): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "source": { + "name": "source", + "description": [ + { + "kind": "text", + "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "message": { + "name": "message", + "description": [ + { + "kind": "text", + "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "scope": { + "name": "scope", + "description": [ + { + "kind": "text", + "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." + } + ], + "isOptional": true, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Logs a general informational message." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "verbose": { + "kind": "method", + "signature": "static verbose(source: string, message: string, scope?: ServiceScope): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "source": { + "name": "source", + "description": [ + { + "kind": "text", + "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "message": { + "name": "message", + "description": [ + { + "kind": "text", + "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "scope": { + "name": "scope", + "description": [ + { + "kind": "text", + "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." + } + ], + "isOptional": true, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Logs a message which contains detailed information that is generally only needed for troubleshooting." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "warn": { + "kind": "method", + "signature": "static warn(source: string, message: string, scope?: ServiceScope): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "source": { + "name": "source", + "description": [ + { + "kind": "text", + "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "message": { + "name": "message", + "description": [ + { + "kind": "text", + "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "scope": { + "name": "scope", + "description": [ + { + "kind": "text", + "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." + } + ], + "isOptional": true, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Logs a warning." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "RandomNumberGenerator": { + "kind": "class", + "extends": "", + "implements": "IRandomNumberGenerator", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the default implementation of " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IRandomNumberGenerator" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "IRandomNumberGenerator", + "memberName": "" + } + }, + { + "kind": "text", + "text": " that simply calls Math.random()." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "RandomNumberGenerator" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "RandomNumberGenerator", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "generate": { + "kind": "method", + "signature": "generate(): number;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "number", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random()." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for IRandomNumberGenerator." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ServiceKey": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [ + "T" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The ServiceKey is a lookup key that is used when calling " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope.consume" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "consume" + } + }, + { + "kind": "text", + "text": " to fetch a dependency." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "create": { + "kind": "method", + "signature": "static create(name: string, serviceClass: {\n new (serviceScope: ServiceScope);\n }): ServiceKey;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "ServiceKey", + "description": [ + { + "kind": "text", + "text": "the newly created ServiceKey" + } + ] + }, + "parameters": { + "name": { + "name": "name", + "description": [ + { + "kind": "text", + "text": "A name such as \"my-package.IMyService\" which should be unique across packages." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "serviceClass": { + "name": "serviceClass", + "description": [ + { + "kind": "text", + "text": "the TypeScript class that implements the service." + } + ], + "isOptional": false, + "isSpread": false, + "type": "{\n new (serviceScope: ServiceScope);\n }" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If you want to specify custom constructor parameters, use " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceKey.createCustom" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceKey", + "memberName": "createCustom" + } + }, + { + "kind": "text", + "text": " instead." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "createCustom": { + "kind": "method", + "signature": "static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "ServiceKey", + "description": [ + { + "kind": "text", + "text": "the newly created service key" + } + ] + }, + "parameters": { + "name": { + "name": "name", + "description": [ + { + "kind": "text", + "text": "A name such as \"my-package.IMyService\" which should be unique across packages." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "defaultCreator": { + "name": "defaultCreator", + "description": [ + { + "kind": "text", + "text": "a callback that returns an object that implements the T interface" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ServiceCreator" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "defaultCreator": { + "kind": "property", + "signature": "readonly defaultCreator: ServiceCreator;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ServiceCreator", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A callback function that constructs the default instance of this service." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "readonly id: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A unique identifier for this service key." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers should not make assumptions about the formatting of this string. It is currently based on a global counter, but this may change in the future." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "name": { + "kind": "property", + "signature": "readonly name: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The name of the service." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the package name, followed by a period, followed by the class or interface name." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The system does not assume that this string is unique. Instead, the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceKey.id" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceKey", + "memberName": "id" + } + }, + { + "kind": "text", + "text": " is used wherever a lookup key is needed." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ServiceScope": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service locator pattern used by the SharePoint Framework." + } + ], + "remarks": [ + { + "kind": "text", + "text": "ServiceScope provides a formalized way for components to register and consume dependencies (\"services\"), and to enable different implementations to be registered in different scopes. This improves modularity by decoupling components from their dependencies in an extensible way." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For example, suppose that various components need access to an IPageManager instance. We could simply make the PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter for each component that requires it, however then we immediately face the problem that any code that calls these constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with name like \"ApplicationContext\", and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, it still has a design problem that \"ApplicationContext\" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the popular \"service locator\" design pattern, familiar from the SPContext API in classic SharePoint." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components can assume that consume() will always return some object that implements the contract." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are initially in an \"unfinished\" state, during which provide() can be called to register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the same key, and does not depend on order of initialization. It also allows us to support circular dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished()." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "protected constructor(parent: ServiceScope | undefined);", + "parameters": { + "parent": { + "name": "parent", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope | undefined" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "consume": { + "kind": "method", + "signature": "consume(serviceKey: ServiceKey): T;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "T", + "description": [ + { + "kind": "text", + "text": "the service instance" + } + ] + }, + "parameters": { + "serviceKey": { + "name": "serviceKey", + "description": [ + { + "kind": "text", + "text": "the key that was used when provide() was called to register the service" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ServiceKey" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Consumes a service from the service scope." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Components should call this function to \"consume\" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "createAndProvide": { + "kind": "method", + "signature": "createAndProvide(serviceKey: ServiceKey, simpleServiceClass: {\n new (serviceScope: ServiceScope);\n }): T;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "T", + "description": [ + { + "kind": "text", + "text": "a newly constructed instance of simpleServiceClass" + } + ] + }, + "parameters": { + "serviceKey": { + "name": "serviceKey", + "description": [ + { + "kind": "text", + "text": "the key that can be used later to consume the service" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ServiceKey" + }, + "simpleServiceClass": { + "name": "simpleServiceClass", + "description": [ + { + "kind": "text", + "text": "the TypeScript class to be constructed" + } + ], + "isOptional": false, + "isSpread": false, + "type": "{\n new (serviceScope: ServiceScope);\n }" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide()." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "createDefaultAndProvide": { + "kind": "method", + "signature": "createDefaultAndProvide(serviceKey: ServiceKey): T;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "T", + "description": [ + { + "kind": "text", + "text": "a service instance that was constructed using ServiceKey.defaultCreator" + } + ] + }, + "parameters": { + "serviceKey": { + "name": "serviceKey", + "description": [ + { + "kind": "text", + "text": "the key that can be used later to consume the service" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ServiceKey" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide()." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "finish": { + "kind": "method", + "signature": "finish(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Completes the initialization sequence for a service scope." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When a ServiceScope is first started, it is in an \"unfinished\" state where provide() is allowed but consume() is disallowed. After calling finish(), then consume() is allowed but provide() is disallowed." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getParent": { + "kind": "method", + "signature": "getParent(): ServiceScope | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ServiceScope | undefined", + "description": [ + { + "kind": "text", + "text": "the parent service scope" + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the parent of the current ServiceScope, or undefined if this is a root scope." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "provide": { + "kind": "method", + "signature": "provide(serviceKey: ServiceKey, service: T): T;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "T", + "description": [ + { + "kind": "text", + "text": "the same object that was passed as the \"service\" parameter" + } + ] + }, + "parameters": { + "serviceKey": { + "name": "serviceKey", + "description": [ + { + "kind": "text", + "text": "the key that will later be used to consume the service" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ServiceKey" + }, + "service": { + "name": "service", + "description": [ + { + "kind": "text", + "text": "the service instance that is being registered" + } + ], + "isOptional": false, + "isSpread": false, + "type": "T" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Add a new service to a service scope." + } + ], + "remarks": [ + { + "kind": "text", + "text": "ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an \"unfinished\" state, i.e. before finish() has been called." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "startNewChild": { + "kind": "method", + "signature": "startNewChild(): ServiceScope;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ServiceScope", + "description": [ + { + "kind": "text", + "text": "the newly created root ServiceScope" + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new ServiceScope that is a child of the current scope." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "startNewRoot": { + "kind": "method", + "signature": "static startNewRoot(): ServiceScope;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "ServiceScope", + "description": [ + { + "kind": "text", + "text": "the newly created root ServiceScope" + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "whenFinished": { + "kind": "method", + "signature": "whenFinished(callback: () => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [ + { + "kind": "text", + "text": "A block of code that needs to call ServiceScope.consume()" + } + ], + "isOptional": false, + "isSpread": false, + "type": "() => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defer an operation until after " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ServiceScope.finish" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ServiceScope", + "memberName": "finish" + } + }, + { + "kind": "text", + "text": " has completed." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed later when the scope is finished." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished()." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "Session": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to the application's browser session and active page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "applicationId": { + "kind": "property", + "signature": "static readonly applicationId: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the current instance of the client-side application." + } + ], + "remarks": [ + { + "kind": "text", + "text": "A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the duration of the client-side application instance, i.e. it begins with the server request that renders the page, and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "pageId": { + "kind": "property", + "signature": "static readonly pageId: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the current page within the client-side application." + } + ], + "remarks": [ + { + "kind": "text", + "text": "A unique identifier used to correlate logging and other diagnostic information. Whereas the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "Session.applicationId" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "Session", + "memberName": "applicationId" + } + }, + { + "kind": "text", + "text": " tracks the entire lifetime of the client-side application instance, the pageId tracks an individual \"page\" that is rendered." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA independently of PageB." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The concept of a page is subjective and defined by the router for a particular application." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPEvent": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [ + "TEventArgs extends SPEventArgs" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents a framework event that components can subscribe to." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPEvent class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "add": { + "kind": "method", + "signature": "add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "observer": { + "name": "observer", + "description": [ + { + "kind": "text", + "text": "Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception." + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPEventObserver" + }, + "eventHandler": { + "name": "eventHandler", + "description": [ + { + "kind": "text", + "text": "A callback function that will be invoked whenever the event occurs" + } + ], + "isOptional": false, + "isSpread": false, + "type": "(eventArgs: TEventArgs) => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Registers a callback that will be invoked whenever the event occurs." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "remove": { + "kind": "method", + "signature": "remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "observer": { + "name": "observer", + "description": [ + { + "kind": "text", + "text": "This must be the same observer that was passed to the add() function." + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPEventObserver" + }, + "eventHandler": { + "name": "eventHandler", + "description": [ + { + "kind": "text", + "text": "The event handler to remove; this must be the same object instance that was passed to the add() function." + } + ], + "isOptional": false, + "isSpread": false, + "type": "(eventArgs: TEventArgs) => void" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Unregisters a callback that was registered using add()." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the event handler has already been removed, or if it was never added, then this method has no effect." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "SPEventArgs": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for event arguments used with the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPEvent" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "SPEvent", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If certain event types need to provide additional details, they will define a subclass of SPEventArgs." + } + ], + "isBeta": false, + "isSealed": false + }, + "Text": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Operations for working with strings that contain text." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The utilities provided by this class are intended to be simple, small, and very broadly applicable." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "format": { + "kind": "method", + "signature": "static format(s: string, ...values: any[]): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "string", + "description": [] + }, + "parameters": { + "s": { + "name": "s", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "values": { + "name": "values", + "description": [], + "isOptional": false, + "isSpread": true, + "type": "any[]" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Format a string by substituting parameters." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This function replaces template parameters such as \"{0}\" or \"{1}\" with the corresponding argument. If the value is null or undefined, it will be replaced by the word \"null\" or \"undefined\". The format string s must not be null or undefined." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage example:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Text.format(\"hello {0}!\", \"world\") will return \"hello world!\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "replaceAll": { + "kind": "method", + "signature": "static replaceAll(input: string, searchValue: string, replaceValue: string): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "string", + "description": [] + }, + "parameters": { + "input": { + "name": "input", + "description": [ + { + "kind": "text", + "text": "The string to be modified" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "searchValue": { + "name": "searchValue", + "description": [ + { + "kind": "text", + "text": "The value to search for" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "replaceValue": { + "name": "replaceValue", + "description": [ + { + "kind": "text", + "text": "The replacement text" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the input string, with all instances of searchValue replaced by replaceValue." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Note that JavaScript's string.replace() only replaces the first match, unless a global RegExp is provided." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "TimeProvider": { + "kind": "class", + "extends": "", + "implements": "ITimeProvider", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the default implementation of " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ITimeProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "ITimeProvider", + "memberName": "" + } + }, + { + "kind": "text", + "text": " that simply calls the real browser APIs." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "TimeProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "TimeProvider", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "getDate": { + "kind": "method", + "signature": "getDate(): Date;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Date", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the current date/time, similar to the Date class constructor." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getTimestamp": { + "kind": "method", + "signature": "getTimestamp(): number;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "number", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for ITimeProvider." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "UrlQueryParameterCollection": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." + } + ], + "summary": [ + { + "kind": "text", + "text": "Provides features for storing and retrieving URL query parameters." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with \"?\" to indicate the first query parameter and use \"&\" for all subsequent parameters. The class also supports fragments." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Edge case behavior:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(url: string);", + "parameters": { + "url": { + "name": "url", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." + } + ], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "UrlQueryParameterCollection" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-core-library", + "exportName": "UrlQueryParameterCollection", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "getValue": { + "kind": "method", + "signature": "getValue(param: string): string | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "string | undefined", + "description": [] + }, + "parameters": { + "param": { + "name": "param", + "description": [ + { + "kind": "text", + "text": "the case insensitive key for the desired query parameter value." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." + } + ], + "summary": [ + { + "kind": "text", + "text": "Returns the value of the first matching query parameter or undefined if the key doesn't exist." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValue('TEST') ---> 'done' getValue('debug') ---> 'false' getValue('lost') ---> undefined" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getValues": { + "kind": "method", + "signature": "getValues(param: string): (string | undefined)[] | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "(string | undefined)[] | undefined", + "description": [] + }, + "parameters": { + "param": { + "name": "param", + "description": [ + { + "kind": "text", + "text": "the case insensitive key for the desired query parameter value." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." + } + ], + "summary": [ + { + "kind": "text", + "text": "Returns the values of all of the matching query parameters or undefined if the key doesn't exist." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValues('TEST') ---> ['done', 'notdone'] getValues('debug') ---> ['false'] getValues('lost') ---> undefined" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "Validate": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Performs common validation tests for properties and function parameters." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "isNonemptyString": { + "kind": "method", + "signature": "static isNonemptyString(value: string | undefined | null, variableName: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "the value to check" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + }, + "variableName": { + "name": "variableName", + "description": [ + { + "kind": "text", + "text": "the program variable name, which will be mentioned in the error message" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Throws an exception if the specified string is null, undefined, or an empty string." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isNotDisposed": { + "kind": "method", + "signature": "static isNotDisposed(value: IDisposable, className: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "the value to check" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IDisposable" + }, + "className": { + "name": "className", + "description": [ + { + "kind": "text", + "text": "the class name, which will be mentioned in the error message" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Throws an exception if the specified object has been disposed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isNotNullOrUndefined": { + "kind": "method", + "signature": "static isNotNullOrUndefined(value: any, variableName: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "the value to check" + } + ], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "variableName": { + "name": "variableName", + "description": [ + { + "kind": "text", + "text": "the program variable name, which will be mentioned in the error message" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Throws an exception if the specified value is null or undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isTrue": { + "kind": "method", + "signature": "static isTrue(value: boolean | undefined | null, variableName: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "value": { + "name": "value", + "description": [ + { + "kind": "text", + "text": "the value to check" + } + ], + "isOptional": false, + "isSpread": false, + "type": "boolean | undefined | null" + }, + "variableName": { + "name": "variableName", + "description": [ + { + "kind": "text", + "text": "the program variable name, which will be mentioned in the error message" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Throws an exception if the specified value is not true." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "Version": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents a version number with two, three, or four parts." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This class represents versions that follow the string format of MAJOR.MINOR[.PATCH[.REVISION]] where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Examples: 1.0, 1.0.0, 1.0.0.0, 1.01, 01.02.03, 001.002.003.004" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "compare": { + "kind": "method", + "signature": "static compare(v1: Version, v2: Version): number;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "number", + "description": [ + { + "kind": "text", + "text": "-1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if the first input is greater than the second input." + } + ] + }, + "parameters": { + "v1": { + "name": "v1", + "description": [ + { + "kind": "text", + "text": "The first version class for comparison" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + }, + "v2": { + "name": "v2", + "description": [ + { + "kind": "text", + "text": "The second version class for comparison" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Compares two Version objects to determine which version is newer." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "equals": { + "kind": "method", + "signature": "equals(compareWith: Version): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "A boolean indicating if this version is equal to the input parameter" + } + ] + }, + "parameters": { + "compareWith": { + "name": "compareWith", + "description": [ + { + "kind": "text", + "text": "The version to compare with" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tests whether this version is equal to the input parameter." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Examples:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "1.0.0 equals 1.0.0 -> true; 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "greaterThan": { + "kind": "method", + "signature": "greaterThan(compareWith: Version): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "A boolean indicating if this version is greater than the input parameter" + } + ] + }, + "parameters": { + "compareWith": { + "name": "compareWith", + "description": [ + { + "kind": "text", + "text": "The version to compare with" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tests whether this version is greater than (i.e. newer than) the input parameter." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Examples:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isValid": { + "kind": "method", + "signature": "static isValid(versionString: string | undefined | null): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "true if the versionString is a valid version specifier" + } + ] + }, + "parameters": { + "versionString": { + "name": "versionString", + "description": [ + { + "kind": "text", + "text": "The version string" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Test whether a string is a valid version specifier." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "lessThan": { + "kind": "method", + "signature": "lessThan(compareWith: Version): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "A boolean indicating if this version is less than the input parameter" + } + ] + }, + "parameters": { + "compareWith": { + "name": "compareWith", + "description": [ + { + "kind": "text", + "text": "The version to compare with" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tests whether this version is less than (i.e. older than) the input parameter." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Examples:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "0.9.9 lessThan 1.0.0 -> true; 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "major": { + "kind": "property", + "signature": "readonly major: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the first component of the version string." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically a change in the major version number indicates a compatibility break with previous versions." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "minor": { + "kind": "property", + "signature": "readonly minor: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the second component of the version string." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "parse": { + "kind": "method", + "signature": "static parse(versionString: string | undefined | null): Version;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Version", + "description": [ + { + "kind": "text", + "text": "a new Version object" + } + ] + }, + "parameters": { + "versionString": { + "name": "versionString", + "description": [ + { + "kind": "text", + "text": "A version string" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "patch": { + "kind": "property", + "signature": "readonly patch: number | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The third number in the version string, or undefined if unspecified." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the \"build\" number." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "revision": { + "kind": "property", + "signature": "readonly revision: number | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The fourth number in the version string, or undefined if unspecified." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "satisfies": { + "kind": "method", + "signature": "satisfies(compareWith: Version): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "A boolean indicating if this version is compatible with the input parameter" + } + ] + }, + "parameters": { + "compareWith": { + "name": "compareWith", + "description": [ + { + "kind": "text", + "text": "The version to compare with" + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible." + } + ], + "remarks": [ + { + "kind": "text", + "text": "In order to satisfy the compatibility requirements, this object must have the same major version number as the input parameter, and it must NOT be older than the input parameter." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Examples:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "1.0.0 satisfies 1.0.0 -> true; 1.1.0 satisfies 1.0.0 -> true; 2.0.0 satisfies 1.0.0 -> false; 1.0.0 satisfies 1.1.0 -> false" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "toString": { + "kind": "method", + "signature": "toString(): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "string", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a string representation of the version." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryParse": { + "kind": "method", + "signature": "static tryParse(versionString: string | undefined | null): Version | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Version | undefined", + "description": [ + { + "kind": "text", + "text": "The Version object, or undefined if the string could not be parsed." + } + ] + }, + "parameters": { + "versionString": { + "name": "versionString", + "description": [ + { + "kind": "text", + "text": "A version string" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string | undefined | null" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + } + } +} diff --git a/generate-docs/json/sp-dialog.api.json b/generate-docs/json/sp-dialog.api.json index 25d58e8d..9dd4a9e6 100644 --- a/generate-docs/json/sp-dialog.api.json +++ b/generate-docs/json/sp-dialog.api.json @@ -1,969 +1,977 @@ -{ - "kind": "package", - "name": "@microsoft/sp-dialog", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework support for displaying pop-up dialog boxes." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This library provides simple stock dialogs such as " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Dialog.alert" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "alert" - } - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Dialog.prompt" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "prompt" - } - }, - { - "kind": "text", - "text": ", along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications." - } - ], - "exports": { - "BaseDialog": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to the user inside SharePoint Framework components." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(config?: IDialogConfiguration);", - "parameters": { - "config": { - "name": "config", - "description": [ - { - "kind": "text", - "text": "the dialog configuration that affects how the dialog is displayed Example: constructor(cacheReference: any) { super(); this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. this._cache.refresh(); // This is bad practice. // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() }" - } - ], - "isOptional": true, - "isSpread": false, - "type": "IDialogConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructor for the BaseDialog class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "It is important to keep the constructor lightweight. Use onBeforeOpen() for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric onBeforeOpen() and onAfterClose() events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose." - } - ] - }, - "close": { - "kind": "method", - "signature": "close(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that resolves when the dialog is visually closed, or if it was already closed" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Close the dialog. This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "domElement": { - "kind": "property", - "signature": "protected readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use this property to access the container element provided by the framework for rendering." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "See " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseDialog.render" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "BaseDialog", - "memberName": "render" - } - }, - { - "kind": "text", - "text": " for more information on rendering." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isHidden": { - "kind": "property", - "signature": "readonly isHidden: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If the dialog is visually hidden. This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isOpen": { - "kind": "property", - "signature": "readonly isOpen: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isSecondary": { - "kind": "property", - "signature": "readonly isSecondary: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onAfterClose": { - "kind": "method", - "signature": "protected onAfterClose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This method is called after the dialog is visually closed and gives an opportunity for doing clean up. The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onBeforeOpen": { - "kind": "method", - "signature": "protected onBeforeOpen(): Promise;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and onAfterClose() will not be called." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method." - } - ], - "remarks": [ - { - "kind": "text", - "text": "All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "render": { - "kind": "method", - "signature": "protected abstract render(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The render method must be implemented to render the content of the dialog in the conrainer element provided by the framework. Use this.domElement to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The render method is called once after the modal element is created and opened. It is recommended to use onBeforeOpen() for doing non-UI preperations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "secondaryDialogProvider": { - "kind": "property", - "signature": "readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SecondaryDialogProvider | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs are permitted." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "show": { - "kind": "method", - "signature": "show(options?: IDialogShowOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or aborted." - } - ] - }, - "parameters": { - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. See" - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" - } - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IDialogShowOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Request the framework to show this dialog." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Dialog": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A static class for showing stock dialogs such as an alert or prompt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "alert": { - "kind": "method", - "signature": "static alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "The message to alert" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "options": { - "name": "options", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IAlertOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog." - } - ], - "remarks": [ - { - "kind": "text", - "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "prompt": { - "kind": "method", - "signature": "static prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "The input string or undefined if the dialog was canceled" - } - ] - }, - "parameters": { - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "The message for prompt dialog" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "options": { - "name": "options", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IPromptOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog." - } - ], - "remarks": [ - { - "kind": "text", - "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IAlertOptions": { - "kind": "interface", - "extends": "IDialogShowOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing an alert dialog" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "IDialogConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The interface for dialog configuration" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "isBlocking": { - "kind": "property", - "signature": "isBlocking?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the dialog can be closed by clicking outside the dialog (on the overlay)." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDialogShowOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing a dialog" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "confirmOpen": { - "kind": "property", - "signature": "confirmOpen?: () => boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "() => boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A callback that is invoked immediately before the dialog receives focus." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the framework. For example, you can check if a long time has passed since the request was made or the the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPromptOptions": { - "kind": "interface", - "extends": "IDialogShowOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing a prompt dialog" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "defaultValue": { - "kind": "property", - "signature": "defaultValue?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default value for the input text field of prompt dialog" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SecondaryDialogProvider": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider inside a dialog." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more secondary dialogs are rejected." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "See " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseDialog.secondaryDialogProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "BaseDialog", - "memberName": "secondaryDialogProvider" - } - }, - { - "kind": "text", - "text": " for how to use this." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "alert": { - "kind": "method", - "signature": "alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "message": { - "name": "message", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. See" - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" - } - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IAlertOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Similar to " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Dialog.alert" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "alert" - } - }, - { - "kind": "text", - "text": ". The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "prompt": { - "kind": "method", - "signature": "prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "message": { - "name": "message", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. The confirmOpen option will be ignored. See" - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" - } - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IPromptOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Similar to " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Dialog.prompt" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "prompt" - } - }, - { - "kind": "text", - "text": ". The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "show": { - "kind": "method", - "signature": "show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "dialog": { - "name": "dialog", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "BaseDialog" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. The confirmOpen option will be ignored. See" - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" - } - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IDialogShowOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Similar to " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseDialog.show" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "BaseDialog", - "memberName": "show" - } - }, - { - "kind": "text", - "text": ". The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-dialog", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for displaying pop-up dialog boxes." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This library provides simple stock dialogs such as " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "Dialog.alert" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "Dialog", + "memberName": "alert" + } + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "Dialog.prompt" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "Dialog", + "memberName": "prompt" + } + }, + { + "kind": "text", + "text": ", along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications." + } + ], + "exports": { + "BaseDialog": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to the user inside SharePoint Framework components." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(config?: IDialogConfiguration);", + "parameters": { + "config": { + "name": "config", + "description": [ + { + "kind": "text", + "text": "the dialog configuration that affects how the dialog is displayed Example: constructor(cacheReference: any) { super(); this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. this._cache.refresh(); // This is bad practice. // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() }" + } + ], + "isOptional": true, + "isSpread": false, + "type": "IDialogConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructor for the BaseDialog class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It is important to keep the constructor lightweight. Use onBeforeOpen() for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric onBeforeOpen() and onAfterClose() events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose." + } + ] + }, + "close": { + "kind": "method", + "signature": "close(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that resolves when the dialog is visually closed, or if it was already closed" + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Close the dialog. This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "domElement": { + "kind": "property", + "signature": "protected readonly domElement: HTMLElement;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HTMLElement", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use this property to access the container element provided by the framework for rendering." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "See " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseDialog.render" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "BaseDialog", + "memberName": "render" + } + }, + { + "kind": "text", + "text": " for more information on rendering." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isHidden": { + "kind": "property", + "signature": "readonly isHidden: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If the dialog is visually hidden. This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isOpen": { + "kind": "property", + "signature": "readonly isOpen: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isSecondary": { + "kind": "property", + "signature": "readonly isSecondary: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onAfterClose": { + "kind": "method", + "signature": "protected onAfterClose(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This method is called after the dialog is visually closed and gives an opportunity for doing clean up. The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onBeforeOpen": { + "kind": "method", + "signature": "protected onBeforeOpen(): Promise;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and onAfterClose() will not be called." + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method." + } + ], + "remarks": [ + { + "kind": "text", + "text": "All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "render": { + "kind": "method", + "signature": "protected abstract render(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The render method must be implemented to render the content of the dialog in the conrainer element provided by the framework. Use this.domElement to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The render method is called once after the modal element is created and opened. It is recommended to use onBeforeOpen() for doing non-UI preperations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "secondaryDialogProvider": { + "kind": "property", + "signature": "readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ISecondaryDialogProvider | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs are permitted." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "show": { + "kind": "method", + "signature": "show(options?: IDialogShowOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or aborted." + } + ] + }, + "parameters": { + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Dialog showing options. See" + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IDialogShowOptions" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "IDialogShowOptions", + "memberName": "" + } + }, + { + "kind": "text", + "text": " for more information." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IDialogShowOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Request the framework to show this dialog." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "Dialog": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A static class for showing stock dialogs such as an alert or prompt." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "alert": { + "kind": "method", + "signature": "static alert(message: string, options?: IAlertOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "message": { + "name": "message", + "description": [ + { + "kind": "text", + "text": "The message to alert" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "options": { + "name": "options", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IAlertOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog." + } + ], + "remarks": [ + { + "kind": "text", + "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "prompt": { + "kind": "method", + "signature": "static prompt(message: string, options?: IPromptOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "The input string or undefined if the dialog was canceled" + } + ] + }, + "parameters": { + "message": { + "name": "message", + "description": [ + { + "kind": "text", + "text": "The message for prompt dialog" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "options": { + "name": "options", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IPromptOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog." + } + ], + "remarks": [ + { + "kind": "text", + "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IAlertOptions": { + "kind": "interface", + "extends": "IDialogShowOptions", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Options for showing an alert dialog" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false + }, + "IDialogConfiguration": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The interface for dialog configuration" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "isBlocking": { + "kind": "property", + "signature": "isBlocking?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the dialog can be closed by clicking outside the dialog (on the overlay)." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IDialogShowOptions": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Options for showing a dialog" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "confirmOpen": { + "kind": "property", + "signature": "confirmOpen?: () => boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "() => boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A callback that is invoked immediately before the dialog receives focus." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the framework. For example, you can check if a long time has passed since the request was made or the the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPromptOptions": { + "kind": "interface", + "extends": "IDialogShowOptions", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Options for showing a prompt dialog" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "defaultValue": { + "kind": "property", + "signature": "defaultValue?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default value for the input text field of prompt dialog" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISecondaryDialogProvider": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider inside a dialog." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more secondary dialogs are rejected." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "See " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseDialog.secondaryDialogProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "BaseDialog", + "memberName": "secondaryDialogProvider" + } + }, + { + "kind": "text", + "text": " for how to use this." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "alert": { + "kind": "method", + "signature": "alert(message: string, options?: IAlertOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "message": { + "name": "message", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Dialog showing options. See" + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IDialogShowOptions" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "IDialogShowOptions", + "memberName": "" + } + }, + { + "kind": "text", + "text": " for more information." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IAlertOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Similar to " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "Dialog.alert" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "Dialog", + "memberName": "alert" + } + }, + { + "kind": "text", + "text": ". The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "prompt": { + "kind": "method", + "signature": "prompt(message: string, options?: IPromptOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "message": { + "name": "message", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Dialog showing options. The confirmOpen option will be ignored. See" + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IDialogShowOptions" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "IDialogShowOptions", + "memberName": "" + } + }, + { + "kind": "text", + "text": " for more information." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IPromptOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Similar to " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "Dialog.prompt" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "Dialog", + "memberName": "prompt" + } + }, + { + "kind": "text", + "text": ". The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "show": { + "kind": "method", + "signature": "show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "dialog": { + "name": "dialog", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "BaseDialog" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Dialog showing options. The confirmOpen option will be ignored. See" + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IDialogShowOptions" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "IDialogShowOptions", + "memberName": "" + } + }, + { + "kind": "text", + "text": " for more information." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IDialogShowOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Similar to " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseDialog.show" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-dialog", + "exportName": "BaseDialog", + "memberName": "show" + } + }, + { + "kind": "text", + "text": ". The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + } + } +} diff --git a/generate-docs/json/sp-dynamic-data.api.json b/generate-docs/json/sp-dynamic-data.api.json index 453646db..35a4c103 100644 --- a/generate-docs/json/sp-dynamic-data.api.json +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -100,7 +100,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "propertyPath": { "kind": "property", @@ -120,7 +121,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "reference": { "kind": "property", @@ -140,7 +142,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "sourceId": { "kind": "property", @@ -160,11 +163,12 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false } } }, - "IDynamicDataController": { + "IDynamicDataCallables": { "kind": "interface", "extends": "", "implements": "", @@ -240,7 +244,7 @@ }, "IDynamicDataPropertyDefinition": { "kind": "interface", - "extends": "", + "extends": "IDynamicDataPropertyMetadata", "implements": "", "typeParameters": [], "deprecatedMessage": [], @@ -254,10 +258,10 @@ "isBeta": true, "isSealed": false, "members": { - "description": { + "id": { "kind": "property", - "signature": "description?: string;", - "isOptional": true, + "signature": "id: string;", + "isOptional": false, "isReadOnly": false, "isStatic": false, "type": "string", @@ -265,19 +269,43 @@ "summary": [ { "kind": "text", - "text": "User-friendly, localized description of the property. Example: \"Contains a list of ids with the files of the current user\"" + "text": "Id of the property. This can only contains letters, numbers, dashes and underscores." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The regular expression used to validate the constraints is /^[a-zA-Z0-9\\-_]+$/ Example: \"myFiles\"" } ], - "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false - }, - "id": { + "isOverride": false, + "isEventProperty": false + } + } + }, + "IDynamicDataPropertyMetadata": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Metadata of a property" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "description": { "kind": "property", - "signature": "id: string;", - "isOptional": false, + "signature": "description?: string;", + "isOptional": true, "isReadOnly": false, "isStatic": false, "type": "string", @@ -285,19 +313,15 @@ "summary": [ { "kind": "text", - "text": "Id of the property. This can only contains letters, numbers, dashes and underscores." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The regular expression used to validate the constraints is /^[a-zA-Z0-9\\-_]+$/ Example: \"myFiles\"" + "text": "User-friendly, localized description of the property. Example: \"Contains a list of ids with the files of the current user\"" } ], + "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "title": { "kind": "property", @@ -317,7 +341,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false } } }, @@ -352,7 +377,7 @@ "summary": [ { "kind": "text", - "text": "Returns the definitions for all the properties exposed by the source." + "text": "Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component." } ], "remarks": [], @@ -384,22 +409,10 @@ "summary": [ { "kind": "text", - "text": "For a given property id, returns the value of the property. Throws an error if the property id doesn't exist in the source." - } - ], - "remarks": [ - { - "kind": "text", - "text": "It returns a read-only copy of the property value, so modifying its value will not impact on the value in the data source." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Property values are JSON-serializable objects, so there are no functions that can be called inside." + "text": "Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component." } ], + "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, @@ -423,7 +436,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "metadata": { "kind": "property", @@ -443,7 +457,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false } } }, @@ -481,7 +496,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "componentId": { "kind": "property", @@ -501,7 +517,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "description": { "kind": "property", @@ -521,7 +538,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "instanceId": { "kind": "property", @@ -541,7 +559,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, "title": { "kind": "property", @@ -561,7 +580,8 @@ "isBeta": true, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false } } } diff --git a/generate-docs/json/sp-extension-base.api.json b/generate-docs/json/sp-extension-base.api.json index a8b5e4ea..91bbd13e 100644 --- a/generate-docs/json/sp-extension-base.api.json +++ b/generate-docs/json/sp-extension-base.api.json @@ -1,140 +1,142 @@ -{ - "kind": "package", - "name": "@microsoft/sp-extension-base", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework support for building client-side extensions." - } - ], - "remarks": [], - "exports": { - "BaseExtension": { - "kind": "class", - "extends": "BaseComponent", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for all client-side extensions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseExtension class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "protected readonly context: ExtensionContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ExtensionContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onInit": { - "kind": "method", - "signature": "protected onInit(): Promise;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called when the client-side extension is first activated on the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "properties": { - "kind": "property", - "signature": "protected readonly properties: TProperties;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "TProperties", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extension properties is a JavaScript object that are passed in by the application that initializes the extension." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ExtensionContext": { - "kind": "class", - "extends": "BaseComponentContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for context objects for client-side extensions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ExtensionContext class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": {} - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-extension-base", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for building client-side extensions." + } + ], + "remarks": [], + "exports": { + "BaseExtension": { + "kind": "class", + "extends": "BaseComponent", + "implements": "", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for all client-side extensions." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseExtension class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "context": { + "kind": "property", + "signature": "protected readonly context: ExtensionContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ExtensionContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onInit": { + "kind": "method", + "signature": "protected onInit(): Promise;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is called when the client-side extension is first activated on the page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "properties": { + "kind": "property", + "signature": "protected readonly properties: TProperties;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "TProperties", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extension properties is a JavaScript object that are passed in by the application that initializes the extension." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ExtensionContext": { + "kind": "class", + "extends": "BaseComponentContext", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The base class for context objects for client-side extensions." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ExtensionContext class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": {} + } + } +} diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index ee8a5253..254cb56c 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -1,4834 +1,6292 @@ -{ - "kind": "package", - "name": "@microsoft/sp-http", - "summary": [ - { - "kind": "text", - "text": "Base communication layer for the SharePoint Framework" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that follow the recommended best practices." - } - ], - "exports": { - "AadHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "AadHttpClient is used to perform REST calls against an Azure AD Application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClient class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For communicating with SharePoint, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead. For communicating with Microsoft Graph, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "isBeta": true, - "isSealed": true, - "members": { - "configurations": { - "kind": "property", - "signature": "static readonly configurations: IAadHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "IAadHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "AadHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Performs a REST service call." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "AadHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "AadHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "AadHttpClientConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "IAadHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for HttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IAadHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IAadHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "flags": { - "kind": "property", - "signature": "protected flags: IAadHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IAadHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "AadHttpClientConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IAadHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - } - } - }, - "AadHttpClientFactory": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The will return a preinitialized version of the AadHttpClient for a given resource url. See more -> https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClientFactory class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "getExtendedClient": { - "kind": "method", - "signature": "getExtendedClient(resourceEndpoint: string): AadHttpClient;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "AadHttpClient", - "description": [] - }, - "parameters": { - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [ - { - "kind": "text", - "text": "The target AAD application's resource endpoint." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getStandardClient": { - "kind": "method", - "signature": "getStandardClient(resourceEndpoint: string): AadHttpClient;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "AadHttpClient", - "description": [] - }, - "parameters": { - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [ - { - "kind": "text", - "text": "The target AAD application's resource endpoint." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns an instance of the AadHttpClient that communicates with the preconfigured SharePoint Online Web Service Principal." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "AadTokenProvider": { - "kind": "class", - "extends": "", - "implements": "IAadTokenProvider", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class allows a developer to obtain OAuth2 tokens from Azure AD." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc." - } - ], - "remarks": [ - { - "kind": "text", - "text": "AadTokenProvider is replacing the /_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL." - } - ], - "isBeta": true, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(configuration: IAadTokenProviderConfiguration);", - "parameters": { - "configuration": { - "name": "configuration", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IAadTokenProviderConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "AadTokenProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "AadTokenProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "getToken": { - "kind": "method", - "signature": "getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that will be fullfiled with the token or that will reject with an error message" - } - ] - }, - "parameters": { - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [ - { - "kind": "text", - "text": "the resource for which the token should be obtained" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IAadTokenProviderConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "An example of a resourceEndpoint would be https://sdfpilot.outlook.com" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tokenAcquisitionEvent": { - "kind": "property", - "signature": "readonly tokenAcquisitionEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies the developer when Token Acquistion requires user action." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "AadTokenProviderFactory": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The will return a preinitialized version of the AadTokenProviderFactory." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "getExtendedProvider": { - "kind": "method", - "signature": "getExtendedProvider(): IAadTokenProvider;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IAadTokenProvider", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "GraphHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds default headers and collects telemetry that helps the service to monitor the performance of an application. https://developer.microsoft.com/en-us/graph/" - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with SharePoint, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead. For communicating with other internet services, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "isBeta": true, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: IGraphHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "IGraphHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "The url string should be relative to the graph server. Good: 'v1.0/me/events' Bad: '/v1.0/me/events', 'https://graph.microsoft.com/v1.0/me/events'" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "GraphHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IGraphHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Perform a REST service call." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Generally, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead): - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: GraphHttpClientConfiguration, options?: IGraphHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "GraphHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "IGraphHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "GraphHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IGraphHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for GraphHttpClient." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "GraphHttpClientConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "IGraphHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Configuration for " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The GraphHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the GraphHttpClient class. Normally these switches are set (e.g. when calling GraphHttpClient.fetch()) by providing one of the predefined defaults from GraphHttpClientConfigurations, however switches can also be changed via the GraphHttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: IGraphHttpClientConfiguration, overrideFlags?: IGraphHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IGraphHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IGraphHttpClientConfiguration" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of GraphHttpClientCommonConfiguration with the specified flags." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ] - }, - "flags": { - "kind": "property", - "signature": "protected flags: IGraphHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IGraphHttpClientConfiguration", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "GraphHttpClientResponse": { - "kind": "class", - "extends": "HttpClientResponse", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "The Response subclass returned by methods such as GraphHttpClient.fetch()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This is a placeholder. In the future, additional GraphHttpClient-specific functionality may be added to this class." - } - ], - "isBeta": true, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(response: Response);", - "parameters": { - "response": { - "name": "response", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Response" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphHttpClientResponse" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClientResponse", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "clone": { - "kind": "method", - "signature": "clone(): GraphHttpClientResponse;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphHttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "correlationId": { - "kind": "property", - "signature": "readonly correlationId: Guid | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid | undefined", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Returns the Graph API correlation ID." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "HttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "HttpClient implements a basic set of features for performing REST operations against a generic service." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with SharePoint, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: IHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "IHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined HttpClientConfiguration objects for use with the HttpClient class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "HttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Performs a REST service call." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "HttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "HttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for HttpClient." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "HttpClientConfiguration": { - "kind": "class", - "extends": "", - "implements": "IHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for HttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "flags": { - "kind": "property", - "signature": "protected flags: IHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Child classes should override this method to initialize the flags object." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "HttpClientConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Child classes should override this method to construct the child class type, rather than the base class type." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - } - } - }, - "HttpClientResponse": { - "kind": "class", - "extends": "", - "implements": "Response", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Response subclass returned by methods such as HttpClient.fetch()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HttpClientResponse class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "arrayBuffer": { - "kind": "method", - "signature": "arrayBuffer(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.arrayBuffer" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "blob": { - "kind": "method", - "signature": "blob(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.blob" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "bodyUsed": { - "kind": "property", - "signature": "readonly bodyUsed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.bodyUsed" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clone": { - "kind": "method", - "signature": "clone(): HttpClientResponse;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "HttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - }, - "formData": { - "kind": "method", - "signature": "formData(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.formData" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "headers": { - "kind": "property", - "signature": "readonly headers: Headers;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Headers", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Response.headers" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "json": { - "kind": "method", - "signature": "json(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.json" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "nativeResponse": { - "kind": "property", - "signature": "protected nativeResponse: Response;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "Response", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ok": { - "kind": "property", - "signature": "readonly ok: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Response.ok" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "status": { - "kind": "property", - "signature": "readonly status: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Response.status" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "statusText": { - "kind": "property", - "signature": "readonly statusText: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Response.statusText" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "method", - "signature": "text(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.text" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "type": { - "kind": "property", - "signature": "readonly type: ResponseType;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ResponseType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Response.type" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "url": { - "kind": "property", - "signature": "readonly url: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Response.url" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IAadHttpClientConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for HttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false - }, - "IAadHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for AadHttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: AadHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AadHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IAadTokenProvider": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class allows a developer to obtain OAuth2 tokens from Azure AD." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc." - } - ], - "remarks": [ - { - "kind": "text", - "text": "AadTokenProvider is replacing the /_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "getToken": { - "kind": "method", - "signature": "getToken(resourceEndpoint: string, configuration?: IAadTokenProviderConfiguration): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that will be fullfiled with the token or that will reject with an error message" - } - ] - }, - "parameters": { - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [ - { - "kind": "text", - "text": "the resource for which the token should be obtained" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IAadTokenProviderConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "An example of a resourceEndpoint would be https://sdfpilot.outlook.com" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tokenAcquisitionEvent": { - "kind": "property", - "signature": "tokenAcquisitionEvent: SPEvent;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies the developer when Token Acquistion requires user action." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IAadTokenProviderConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Required strings for constructing an AadTokenProvider." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "aadInstanceUrl": { - "kind": "property", - "signature": "aadInstanceUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "aadTenantId": { - "kind": "property", - "signature": "aadTenantId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Azure Active Directory's tenant id." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "aadUserId": { - "kind": "property", - "signature": "aadUserId?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "redirectUri": { - "kind": "property", - "signature": "redirectUri: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "servicePrincipalId": { - "kind": "property", - "signature": "servicePrincipalId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The client ID of the developer's Azure Active Directory application." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IGraphHttpClientConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Flags interface for GraphHttpClientCommonConfiguration" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "IGraphHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for GraphHttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface provides standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: GraphHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClientConfiguration", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IGraphHttpClientOptions": { - "kind": "interface", - "extends": "IHttpClientOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for HttpClient" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": true, - "isSealed": false - }, - "IHttpClientConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for HttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false - }, - "IHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for HttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: HttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClientConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IHttpClientOptions": { - "kind": "interface", - "extends": "RequestInit", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for HttpClient" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": false, - "isSealed": false - }, - "ISPHttpClientBatchConfiguration": { - "kind": "interface", - "extends": "ISPHttpClientCommonConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientBatchConfiguration." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "ISPHttpClientBatchConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for SPHttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: SPHttpClientBatchConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClientBatchConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISPHttpClientBatchCreationOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "webUrl": { - "kind": "property", - "signature": "webUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "SPHttpClientBatch will need to perform its POST to an endpoint such as \"http://example.com/sites/sample/_api/$batch\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISPHttpClientBatchOptions": { - "kind": "interface", - "extends": "IHttpClientOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "ISPHttpClientCommonConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientCommonConfiguration" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "jsonRequest": { - "kind": "property", - "signature": "jsonRequest?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Content-Type\" header for a JSON payload." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\")." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "jsonResponse": { - "kind": "property", - "signature": "jsonResponse?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Accept\" header for a JSON payload." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json'." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISPHttpClientConfiguration": { - "kind": "interface", - "extends": "ISPHttpClientCommonConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "defaultODataVersion": { - "kind": "property", - "signature": "defaultODataVersion?: ODataVersion;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"OData-Version\" header." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "defaultSameOriginCredentials": { - "kind": "property", - "signature": "defaultSameOriginCredentials?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the RequestInit.credentials." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "requestDigest": { - "kind": "property", - "signature": "requestDigest?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically provide an \"X-RequestDigest\" header for authentication." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISPHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for SPHttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: SPHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Version 1 enables these switches:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISPHttpClientOptions": { - "kind": "interface", - "extends": "IHttpClientOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "webUrl": { - "kind": "property", - "signature": "webUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configure the SPWeb URL for authentication." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be fetched using a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ODataVersion": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents supported version of the \"OData-Version\" header, which is part of the Open Data Protocol standard." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "toString": { - "kind": "method", - "signature": "toString(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the \"OData-Version\" value, for example \"4.0\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryParseFromHeaders": { - "kind": "method", - "signature": "static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ODataVersion | undefined", - "description": [] - }, - "parameters": { - "headers": { - "name": "headers", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Headers" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Attempt to parse the \"OData-Version\" header." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the \"OData-Version\" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "v3": { - "kind": "property", - "signature": "static v3: ODataVersion;", - "isOptional": false, - "isReadOnly": false, - "isStatic": true, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents version 3.0 for the \"OData-Version\" header" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "v4": { - "kind": "property", - "signature": "static v4: ODataVersion;", - "isOptional": false, - "isReadOnly": false, - "isStatic": true, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents version 4.0 for the \"OData-Version\" header" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with other internet services, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "isBeta": false, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "beginBatch": { - "kind": "method", - "signature": "beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientBatch", - "description": [ - { - "kind": "text", - "text": "An " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClientBatch" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClientBatch", - "memberName": "" - } - }, - { - "kind": "text", - "text": " object used to manage the batch operation." - } - ] - }, - "parameters": { - "batchCreationOptions": { - "name": "batchCreationOptions", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchCreationOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: ISPHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ISPHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Perform a REST service call." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead):" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- For write operations, an \"X-RequestDigest\" header is automatically added" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- The request digest token is automatically fetched and stored in a cache, with support for preloading" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getWebUrlFromRequestUrl": { - "kind": "method", - "signature": "static getWebUrlFromRequestUrl(requestUrl: string): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "string", - "description": [ - { - "kind": "text", - "text": "the inferred SPWeb URL" - } - ] - }, - "parameters": { - "requestUrl": { - "name": "requestUrl", - "description": [ - { - "kind": "text", - "text": "The URL for a SharePoint REST service" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use a heuristic to infer the base URL for authentication." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path components such as \"_api\", \"_layouts\", or \"_vit_bin\". This is necessary for operations such as the X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a request." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For example, if the requestUrl is \"/sites/site/web/_api/service\", the returned URL would be \"/sites/site/web\". Or if the requestUrl is \"http://example.com/_layouts/service\", the returned URL would be \"http://example.com\"." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the URL cannot be determined, an exception is thrown." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for SPHttpClient." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPHttpClientBatch": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an SPHttpClientResponse object for that particular request." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPHttpClientBatch class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "configurations": { - "kind": "property", - "signature": "static readonly configurations: ISPHttpClientBatchConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ISPHttpClientBatchConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "execute": { - "kind": "method", - "signature": "execute(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Executes the batched queries that were queued using SPHttpClientBatch.fetch()." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientBatchConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed)." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The parameters for this function are basically the same as the WHATWG API standard documented here:" - }, - { - "kind": "paragraph" - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://fetch.spec.whatwg.org/" - } - ], - "targetUrl": "https://fetch.spec.whatwg.org/" - }, - { - "kind": "text", - "text": "However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When execute() is called, it will POST to a URL such as \"http://example.com/sites/sample/_api/$batch\". Typically SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientBatchConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to 'GET'." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientBatchConfiguration" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to 'POST'." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPHttpClientBatchConfiguration": { - "kind": "class", - "extends": "SPHttpClientCommonConfiguration", - "implements": "ISPHttpClientBatchConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for SPHttpClientBatch." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientBatchConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientBatchConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientBatchConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": true - } - } - }, - "SPHttpClientCommonConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "ISPHttpClientCommonConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ] - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientCommonConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientCommonConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "jsonRequest": { - "kind": "property", - "signature": "readonly jsonRequest: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Content-Type\" header for a JSON payload." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\")." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "jsonResponse": { - "kind": "property", - "signature": "readonly jsonResponse: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Accept\" header for a JSON payload." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json'." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientCommonConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - } - } - }, - "SPHttpClientConfiguration": { - "kind": "class", - "extends": "SPHttpClientCommonConfiguration", - "implements": "ISPHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "defaultODataVersion": { - "kind": "property", - "signature": "readonly defaultODataVersion: ODataVersion;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"OData-Version\" header." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "defaultSameOriginCredentials": { - "kind": "property", - "signature": "readonly defaultSameOriginCredentials: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the RequestInit.credentials." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "requestDigest": { - "kind": "property", - "signature": "readonly requestDigest: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically provide an \"X-RequestDigest\" header for authentication." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPHttpClientResponse": { - "kind": "class", - "extends": "HttpClientResponse", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Response subclass returned by methods such as SPHttpClient.fetch()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class." - } - ], - "isBeta": false, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(response: Response);", - "parameters": { - "response": { - "name": "response", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Response" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClientResponse" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClientResponse", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "clone": { - "kind": "method", - "signature": "clone(): SPHttpClientResponse;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "correlationId": { - "kind": "property", - "signature": "readonly correlationId: Guid | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the SharePoint correlation ID." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the \"sprequestguid\" header." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPHttpHeader": { - "kind": "enum", - "values": { - "SPRequestGuid": { - "kind": "enum value", - "value": "\"SPRequestGuid\"", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example value: \"9417279e-40e1-0000-2465-306ba786bfd7\"" - } - ], - "remarks": [], - "isBeta": true - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard HTTP headers used with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": "" - } - ], - "remarks": [], - "isBeta": true - }, - "TokenAcquisitionEventArgs": { - "kind": "class", - "extends": "SPEventArgs", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents arguments used for raising a token acquisiton failure event." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(message: string, redirectUrl?: string);", - "parameters": { - "message": { - "name": "message", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "redirectUrl": { - "name": "redirectUrl", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "TokenAcquisitionEventArgs" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "TokenAcquisitionEventArgs", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "message": { - "kind": "property", - "signature": "message: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The message returned from ADAL fails to retrieve a token from Azure AD." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "redirectUrl": { - "kind": "property", - "signature": "redirectUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The url of the page for the end user to perform Multi Factor Authentication" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-http", + "summary": [ + { + "kind": "text", + "text": "Base communication layer for the SharePoint Framework" + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that follow the recommended best practices." + } + ], + "exports": { + "AadHttpClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "AadHttpClient is used to perform REST calls against an Azure AD Application." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For communicating with SharePoint, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead. For communicating with Microsoft Graph, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "MSGraphClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "MSGraphClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class." + } + ], + "isBeta": false, + "isSealed": true, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [ + { + "kind": "text", + "text": "The service scope is needed to retrieve some of the class's internal components." + } + ], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + }, + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Configuration options for the request to get an access token." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IAadHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "AadHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "AadHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "configurations": { + "kind": "property", + "signature": "static readonly configurations: IAadHttpClientConfigurations;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "IAadHttpClientConfigurations", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fetch": { + "kind": "method", + "signature": "fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that will return the result." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "The endpoint URL that fetch will be called on." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations." + } + ], + "isOptional": false, + "isSpread": false, + "type": "AadHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Additional options that affect the request." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Performs a REST service call." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that will return the result." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "The endpoint URL that fetch will be called on." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations." + } + ], + "isOptional": false, + "isSpread": false, + "type": "AadHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Additional options that affect the request." + } + ], + "isOptional": true, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"GET\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that will return the result." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "The endpoint URL that fetch will be called on." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations." + } + ], + "isOptional": false, + "isSpread": false, + "type": "AadHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "Additional options that affect the request." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"POST\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "AadHttpClientConfiguration": { + "kind": "class", + "extends": "HttpClientConfiguration", + "implements": "IAadHttpClientConfiguration", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Configuration for HttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IAadHttpClientConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IAadHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ], + "remarks": [] + }, + "flags": { + "kind": "property", + "signature": "protected flags: IAadHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IAadHttpClientConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "overrideWith": { + "kind": "method", + "signature": "overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "AadHttpClientConfiguration", + "description": [] + }, + "parameters": { + "sourceFlags": { + "name": "sourceFlags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IAadHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + } + } + }, + "AadHttpClientFactory": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" + } + ], + "targetUrl": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClientFactory class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "getClient": { + "kind": "method", + "signature": "getClient(resourceEndpoint: string): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [ + { + "kind": "text", + "text": "The target AAD application's resource endpoint." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for AadHttpClientFactory." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "AadTokenProvider": { + "kind": "class", + "extends": "", + "implements": "IAadTokenProvider", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class allows a developer to obtain OAuth2 tokens from Azure AD." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadTokenProvider class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": true, + "members": { + "getToken": { + "kind": "method", + "signature": "getToken(resourceEndpoint: string): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that will be fullfiled with the token or that will reject with an error message" + } + ] + }, + "parameters": { + "resourceEndpoint": { + "name": "resourceEndpoint", + "description": [ + { + "kind": "text", + "text": "the resource for which the token should be obtained An example of a resourceEndpoint would be https://graph.microsoft.com" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The OAuth2 token should not be cached by the caller since it is already cached by the method itself." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tokenAcquisitionEvent": { + "kind": "property", + "signature": "readonly tokenAcquisitionEvent: SPEvent;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Notifies the developer when Token Acquisition requires user action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": true + } + } + }, + "AadTokenProviderFactory": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a preinitialized version of the AadTokenProviderFactory." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "getTokenProvider": { + "kind": "method", + "signature": "getTokenProvider(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for AadTokenProviderFactory." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "DigestCache": { + "kind": "class", + "extends": "", + "implements": "IDigestCache", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information, see the MSDN article " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "DigestCache" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "DigestCache", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "addDigestToCache": { + "kind": "method", + "signature": "addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "webUrl": { + "name": "webUrl", + "description": [ + { + "kind": "text", + "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "digestValue": { + "name": "digestValue", + "description": [ + { + "kind": "text", + "text": "The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "expirationTimestamp": { + "name": "expirationTimestamp", + "description": [ + { + "kind": "text", + "text": "A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000." + } + ], + "isOptional": false, + "isSpread": false, + "type": "number" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "clearAllDigests": { + "kind": "method", + "signature": "clearAllDigests(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Clears all values from the cache." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "clearDigest": { + "kind": "method", + "signature": "clearDigest(webUrl: string): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "Returns true if a cache entry was found and deleted; false otherwise." + } + ] + }, + "parameters": { + "webUrl": { + "name": "webUrl", + "description": [ + { + "kind": "text", + "text": "The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "fetchDigest": { + "kind": "method", + "signature": "fetchDigest(webUrl: string): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that is fulfilled with the digest value." + } + ] + }, + "parameters": { + "webUrl": { + "name": "webUrl", + "description": [ + { + "kind": "text", + "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for IDigestCache." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "GraphHttpClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds default headers and collects telemetry that helps the service to monitor the performance of an application. https://developer.microsoft.com/en-us/graph/" + } + ], + "remarks": [ + { + "kind": "text", + "text": "For communicating with SharePoint, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead. For communicating with other internet services, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "isBeta": true, + "isSealed": true, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "GraphHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "GraphHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "configurations": { + "kind": "property", + "signature": "static readonly configurations: IGraphHttpClientConfigurations;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "IGraphHttpClientConfigurations", + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fetch": { + "kind": "method", + "signature": "fetch(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "a promise that will return the result" + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "The url string should be relative to the graph server. Good: 'v1.0/me/events' Bad: '/v1.0/me/events', 'https://graph.microsoft.com/v1.0/me/events'" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "GraphHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IGraphHttpClientOptions" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Perform a REST service call." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Generally, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead): - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(url: string, configuration: GraphHttpClientConfiguration, options?: IGraphHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "a promise that will return the result" + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "GraphHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": true, + "isSpread": false, + "type": "IGraphHttpClientOptions" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"GET\"." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "a promise that will return the result" + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "GraphHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IGraphHttpClientOptions" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"POST\"." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "The service key for GraphHttpClient." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "GraphHttpClientConfiguration": { + "kind": "class", + "extends": "HttpClientConfiguration", + "implements": "IGraphHttpClientConfiguration", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Configuration for " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "GraphHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "GraphHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": "." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The GraphHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the GraphHttpClient class. Normally these switches are set (e.g. when calling GraphHttpClient.fetch()) by providing one of the predefined defaults from GraphHttpClientConfigurations, however switches can also be changed via the GraphHttpClientConfiguration.overrideWith() method." + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: IGraphHttpClientConfiguration, overrideFlags?: IGraphHttpClientConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IGraphHttpClientConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IGraphHttpClientConfiguration" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of GraphHttpClientCommonConfiguration with the specified flags." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ] + }, + "flags": { + "kind": "property", + "signature": "protected flags: IGraphHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IGraphHttpClientConfiguration", + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "GraphHttpClientResponse": { + "kind": "class", + "extends": "HttpClientResponse", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "The Response subclass returned by methods such as GraphHttpClient.fetch()." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is a placeholder. In the future, additional GraphHttpClient-specific functionality may be added to this class." + } + ], + "isBeta": true, + "isSealed": true, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(response: Response);", + "parameters": { + "response": { + "name": "response", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Response" + } + }, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "GraphHttpClientResponse" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "GraphHttpClientResponse", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "clone": { + "kind": "method", + "signature": "clone(): GraphHttpClientResponse;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphHttpClientResponse", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "correlationId": { + "kind": "property", + "signature": "readonly correlationId: Guid | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid | undefined", + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Returns the Graph API correlation ID." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "GraphRequest": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Typings for the GraphRequest Object For more information: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://github.com/microsoftgraph/msgraph-sdk-javascript" + } + ], + "targetUrl": "https://github.com/microsoftgraph/msgraph-sdk-javascript" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(config: Options, path: string);", + "parameters": { + "config": { + "name": "config", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Options" + }, + "path": { + "name": "path", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "GraphRequest" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "GraphRequest", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "_headers": { + "kind": "property", + "signature": "_headers:", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [key: string]: string | number;\n }", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "_responseType": { + "kind": "property", + "signature": "_responseType: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buildFullUrl": { + "kind": "method", + "signature": "buildFullUrl(): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "string", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "config": { + "kind": "property", + "signature": "config: Options;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "Options", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "count": { + "kind": "method", + "signature": "count(count: boolean): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "count": { + "name": "count", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "boolean" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "create": { + "kind": "method", + "signature": "create(content: any, callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "content": { + "name": "content", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "del": { + "kind": "method", + "signature": "del(callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "delete": { + "kind": "method", + "signature": "delete(callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "expand": { + "kind": "method", + "signature": "expand(properties: string | string[]): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "properties": { + "name": "properties", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | string[]" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "filter": { + "kind": "method", + "signature": "filter(filterStr: string): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "filterStr": { + "name": "filterStr", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getStream": { + "kind": "method", + "signature": "getStream(callback: GraphRequestCallback): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "callback": { + "name": "callback", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "header": { + "kind": "method", + "signature": "header(headerKey: string, headerValue: string): this;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "this", + "description": [] + }, + "parameters": { + "headerKey": { + "name": "headerKey", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "headerValue": { + "name": "headerValue", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "headers": { + "kind": "method", + "signature": "headers(headers: {\n [key: string]: string | number;\n }): this;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "this", + "description": [] + }, + "parameters": { + "headers": { + "name": "headers", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "{\n [key: string]: string | number;\n }" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "orderby": { + "kind": "method", + "signature": "orderby(properties: string | string[]): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "properties": { + "name": "properties", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | string[]" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "parsePath": { + "kind": "method", + "signature": "parsePath(rawPath: string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "rawPath": { + "name": "rawPath", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "patch": { + "kind": "method", + "signature": "patch(content: any, callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "content": { + "name": "content", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(content: any, callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "content": { + "name": "content", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "put": { + "kind": "method", + "signature": "put(content: any, callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "content": { + "name": "content", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "putStream": { + "kind": "method", + "signature": "putStream(stream: any, callback: GraphRequestCallback): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "stream": { + "name": "stream", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "callback": { + "name": "callback", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "query": { + "kind": "method", + "signature": "query(queryDictionaryOrString: string | {\n [key: string]: string | number;\n }): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "queryDictionaryOrString": { + "name": "queryDictionaryOrString", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | {\n [key: string]: string | number;\n }" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "responseType": { + "kind": "method", + "signature": "responseType(responseType: string): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "responseType": { + "name": "responseType", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "select": { + "kind": "method", + "signature": "select(properties: string | string[]): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "properties": { + "name": "properties", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string | string[]" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "skip": { + "kind": "method", + "signature": "skip(n: number): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "n": { + "name": "n", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "number" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "skipToken": { + "kind": "method", + "signature": "skipToken(token: string): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "token": { + "name": "token", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "top": { + "kind": "method", + "signature": "top(n: number): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "n": { + "name": "n", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "number" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "update": { + "kind": "method", + "signature": "update(content: any, callback?: GraphRequestCallback): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": { + "content": { + "name": "content", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "callback": { + "name": "callback", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "GraphRequestCallback" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "urlComponents": { + "kind": "property", + "signature": "urlComponents: URLComponents;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "URLComponents", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "version": { + "kind": "method", + "signature": "version(v: string): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "v": { + "name": "v", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "HttpClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "HttpClient implements a basic set of features for performing REST operations against a generic service." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For communicating with SharePoint, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "configurations": { + "kind": "property", + "signature": "static readonly configurations: IHttpClientConfigurations;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "IHttpClientConfigurations", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The standard predefined HttpClientConfiguration objects for use with the HttpClient class." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fetch": { + "kind": "method", + "signature": "fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "HttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Performs a REST service call." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "HttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": true, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"GET\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "HttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"POST\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for HttpClient." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "HttpClientConfiguration": { + "kind": "class", + "extends": "", + "implements": "IHttpClientConfiguration", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Configuration for HttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "IHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ], + "remarks": [] + }, + "flags": { + "kind": "property", + "signature": "protected flags: IHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IHttpClientConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "initializeFlags": { + "kind": "method", + "signature": "protected initializeFlags(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Child classes should override this method to initialize the flags object." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": true, + "isOverride": false + }, + "overrideWith": { + "kind": "method", + "signature": "overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "HttpClientConfiguration", + "description": [] + }, + "parameters": { + "sourceFlags": { + "name": "sourceFlags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Child classes should override this method to construct the child class type, rather than the base class type." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": true, + "isOverride": false + } + } + }, + "HttpClientResponse": { + "kind": "class", + "extends": "", + "implements": "Response", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Response subclass returned by methods such as HttpClient.fetch()." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HttpClientResponse class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "arrayBuffer": { + "kind": "method", + "signature": "arrayBuffer(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.arrayBuffer" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "blob": { + "kind": "method", + "signature": "blob(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.blob" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "bodyUsed": { + "kind": "property", + "signature": "readonly bodyUsed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.bodyUsed" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "clone": { + "kind": "method", + "signature": "clone(): HttpClientResponse;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "HttpClientResponse", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": true, + "isOverride": false + }, + "formData": { + "kind": "method", + "signature": "formData(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.formData" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "headers": { + "kind": "property", + "signature": "readonly headers: Headers;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Headers", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.headers" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "json": { + "kind": "method", + "signature": "json(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.json" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "nativeResponse": { + "kind": "property", + "signature": "protected nativeResponse: Response;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "Response", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ok": { + "kind": "property", + "signature": "readonly ok: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.ok" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "status": { + "kind": "property", + "signature": "readonly status: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.status" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "statusText": { + "kind": "property", + "signature": "readonly statusText: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.statusText" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "method", + "signature": "text(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Body.text" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "type": { + "kind": "property", + "signature": "readonly type: ResponseType;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ResponseType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.type" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "url": { + "kind": "property", + "signature": "readonly url: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "See documentation for whatwg-fetch:Response.url" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IAadHttpClientConfiguration": { + "kind": "interface", + "extends": "IHttpClientConfiguration", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Flags interface for HttpClientConfiguration." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false + }, + "IAadHttpClientConfigurations": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard configurations for AadHttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "v1": { + "kind": "property", + "signature": "readonly v1: AadHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AadHttpClientConfiguration", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IAadHttpClientOptions": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface for overriding the default behavior of AadHttpClient." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "configuration": { + "kind": "property", + "signature": "configuration?: IAadTokenProviderConfiguration;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IAadTokenProviderConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tokenProvider": { + "kind": "property", + "signature": "tokenProvider?: IAadTokenProvider;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IAadTokenProvider", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IDigestCache": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information, see the MSDN article " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "addDigestToCache": { + "kind": "method", + "signature": "addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "webUrl": { + "name": "webUrl", + "description": [ + { + "kind": "text", + "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "digestValue": { + "name": "digestValue", + "description": [ + { + "kind": "text", + "text": "The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "expirationTimestamp": { + "name": "expirationTimestamp", + "description": [ + { + "kind": "text", + "text": "A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000." + } + ], + "isOptional": false, + "isSpread": false, + "type": "number" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "clearAllDigests": { + "kind": "method", + "signature": "clearAllDigests(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Clears all values from the cache." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "clearDigest": { + "kind": "method", + "signature": "clearDigest(webUrl: string): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [ + { + "kind": "text", + "text": "Returns true if a cache entry was found and deleted; false otherwise." + } + ] + }, + "parameters": { + "webUrl": { + "name": "webUrl", + "description": [ + { + "kind": "text", + "text": "The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "fetchDigest": { + "kind": "method", + "signature": "fetchDigest(webUrl: string): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise that is fulfilled with the digest value." + } + ] + }, + "parameters": { + "webUrl": { + "name": "webUrl", + "description": [ + { + "kind": "text", + "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IGraphHttpClientConfiguration": { + "kind": "interface", + "extends": "IHttpClientConfiguration", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Flags interface for GraphHttpClientCommonConfiguration" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false + }, + "IGraphHttpClientConfigurations": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "Standard configurations for GraphHttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface provides standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "v1": { + "kind": "property", + "signature": "readonly v1: GraphHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "GraphHttpClientConfiguration", + "deprecatedMessage": [ + { + "kind": "text", + "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + } + ], + "summary": [ + { + "kind": "text", + "text": "This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IGraphHttpClientOptions": { + "kind": "interface", + "extends": "IHttpClientOptions", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Options for HttpClient" + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" + } + ], + "isBeta": true, + "isSealed": false + }, + "IHttpClientConfiguration": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Flags interface for HttpClientConfiguration." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false + }, + "IHttpClientConfigurations": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard configurations for HttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "v1": { + "kind": "property", + "signature": "readonly v1: HttpClientConfiguration;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HttpClientConfiguration", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IHttpClientOptions": { + "kind": "interface", + "extends": "RequestInit", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Options for HttpClient" + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/" + } + ], + "isBeta": false, + "isSealed": false + }, + "ISPHttpClientBatchConfiguration": { + "kind": "interface", + "extends": "ISPHttpClientCommonConfiguration", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Flags interface for SPHttpClientBatchConfiguration." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false + }, + "ISPHttpClientBatchConfigurations": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard configurations for SPHttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "v1": { + "kind": "property", + "signature": "readonly v1: SPHttpClientBatchConfiguration;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPHttpClientBatchConfiguration", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPHttpClientBatchCreationOptions": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "webUrl": { + "kind": "property", + "signature": "webUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "SPHttpClientBatch will need to perform its POST to an endpoint such as \"http://example.com/sites/sample/_api/$batch\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPHttpClientBatchOptions": { + "kind": "interface", + "extends": "IHttpClientOptions", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false + }, + "ISPHttpClientCommonConfiguration": { + "kind": "interface", + "extends": "IHttpClientConfiguration", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Flags interface for SPHttpClientCommonConfiguration" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "jsonRequest": { + "kind": "property", + "signature": "jsonRequest?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the \"Content-Type\" header for a JSON payload." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\")." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "jsonResponse": { + "kind": "property", + "signature": "jsonResponse?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the \"Accept\" header for a JSON payload." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 3.0, the value is 'application/json'." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPHttpClientConfiguration": { + "kind": "interface", + "extends": "ISPHttpClientCommonConfiguration", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Flags interface for SPHttpClientConfiguration." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "defaultODataVersion": { + "kind": "property", + "signature": "defaultODataVersion?: ODataVersion;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "ODataVersion", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the \"OData-Version\" header." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "defaultSameOriginCredentials": { + "kind": "property", + "signature": "defaultSameOriginCredentials?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the RequestInit.credentials." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "requestDigest": { + "kind": "property", + "signature": "requestDigest?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically provide an \"X-RequestDigest\" header for authentication." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPHttpClientConfigurations": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard configurations for SPHttpClient." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "v1": { + "kind": "property", + "signature": "readonly v1: SPHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPHttpClientConfiguration", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Version 1 enables these switches:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPHttpClientOptions": { + "kind": "interface", + "extends": "IHttpClientOptions", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "webUrl": { + "kind": "property", + "signature": "webUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Configure the SPWeb URL for authentication." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be fetched using a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "MSGraphClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "MSGraphClient is used to perform REST calls against Microsoft Graph." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MSGraphClient class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom configuration for every request." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://github.com/microsoftgraph/msgraph-sdk-javascript" + } + ], + "targetUrl": "https://github.com/microsoftgraph/msgraph-sdk-javascript" + }, + { + "kind": "text", + "text": "" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "api": { + "kind": "method", + "signature": "api(path: string, config?: Options): GraphRequest;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "GraphRequest", + "description": [] + }, + "parameters": { + "path": { + "name": "path", + "description": [ + { + "kind": "text", + "text": "The path for the request to MSGraph." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "config": { + "name": "config", + "description": [ + { + "kind": "text", + "text": "Sets the configuration for this request." + } + ], + "isOptional": true, + "isSpread": false, + "type": "Options" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "All calls to Microsoft Graph are chained together starting with the api function." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Path supports the following formats: * me * /me * https://graph.microsoft.com/v1.0/me * https://graph.microsoft.com/beta/me * me/events?$filter=startswith(subject, 'ship')" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "MSGraphClientFactory": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns a preinitialized version of the MSGraphClient. For more information: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph" + } + ], + "targetUrl": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MSGraphClientFactory class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "getClient": { + "kind": "method", + "signature": "getClient(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for MSGraphClientFactory." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ODataVersion": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents supported version of the \"OData-Version\" header, which is part of the Open Data Protocol standard." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "toString": { + "kind": "method", + "signature": "toString(): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "string", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the \"OData-Version\" value, for example \"4.0\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryParseFromHeaders": { + "kind": "method", + "signature": "static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "ODataVersion | undefined", + "description": [] + }, + "parameters": { + "headers": { + "name": "headers", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Headers" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Attempt to parse the \"OData-Version\" header." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the \"OData-Version\" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "v3": { + "kind": "property", + "signature": "static v3: ODataVersion;", + "isOptional": false, + "isReadOnly": false, + "isStatic": true, + "type": "ODataVersion", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents version 3.0 for the \"OData-Version\" header" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "v4": { + "kind": "property", + "signature": "static v4: ODataVersion;", + "isOptional": false, + "isReadOnly": false, + "isStatic": true, + "type": "ODataVersion", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents version 4.0 for the \"OData-Version\" header" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPHttpClient": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For communicating with other internet services, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class." + } + ], + "isBeta": false, + "isSealed": true, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "beginBatch": { + "kind": "method", + "signature": "beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "SPHttpClientBatch", + "description": [ + { + "kind": "text", + "text": "An " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClientBatch" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClientBatch", + "memberName": "" + } + }, + { + "kind": "text", + "text": " object used to manage the batch operation." + } + ] + }, + "parameters": { + "batchCreationOptions": { + "name": "batchCreationOptions", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientBatchCreationOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "configurations": { + "kind": "property", + "signature": "static readonly configurations: ISPHttpClientConfigurations;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ISPHttpClientConfigurations", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fetch": { + "kind": "method", + "signature": "fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Perform a REST service call." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead):" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- For write operations, an \"X-RequestDigest\" header is automatically added" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The request digest token is automatically fetched and stored in a cache, with support for preloading" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"GET\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getWebUrlFromRequestUrl": { + "kind": "method", + "signature": "static getWebUrlFromRequestUrl(requestUrl: string): string;", + "accessModifier": "", + "isOptional": false, + "isStatic": true, + "returnValue": { + "type": "string", + "description": [ + { + "kind": "text", + "text": "the inferred SPWeb URL" + } + ] + }, + "parameters": { + "requestUrl": { + "name": "requestUrl", + "description": [ + { + "kind": "text", + "text": "The URL for a SharePoint REST service" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use a heuristic to infer the base URL for authentication." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path components such as \"_api\", \"_layouts\", or \"_vit_bin\". This is necessary for operations such as the X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a request." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For example, if the requestUrl is \"/sites/site/web/_api/service\", the returned URL would be \"/sites/site/web\". Or if the requestUrl is \"http://example.com/_layouts/service\", the returned URL would be \"http://example.com\"." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the URL cannot be determined, an exception is thrown." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPHttpClientConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to \"POST\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for SPHttpClient." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPHttpClientBatch": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an SPHttpClientResponse object for that particular request." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPHttpClientBatch class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "configurations": { + "kind": "property", + "signature": "static readonly configurations: ISPHttpClientBatchConfigurations;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ISPHttpClientBatchConfigurations", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "execute": { + "kind": "method", + "signature": "execute(): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Executes the batched queries that were queued using SPHttpClientBatch.fetch()." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "fetch": { + "kind": "method", + "signature": "fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPHttpClientBatchConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientBatchOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed)." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The parameters for this function are basically the same as the WHATWG API standard documented here:" + }, + { + "kind": "paragraph" + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://fetch.spec.whatwg.org/" + } + ], + "targetUrl": "https://fetch.spec.whatwg.org/" + }, + { + "kind": "text", + "text": "However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When execute() is called, it will POST to a URL such as \"http://example.com/sites/sample/_api/$batch\". Typically SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "get": { + "kind": "method", + "signature": "get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPHttpClientBatchConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientBatchOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to 'GET'." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "post": { + "kind": "method", + "signature": "post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [ + { + "kind": "text", + "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "HttpClientResponse.ok" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "HttpClientResponse", + "memberName": "ok" + } + }, + { + "kind": "text", + "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." + } + ] + }, + "parameters": { + "url": { + "name": "url", + "description": [ + { + "kind": "text", + "text": "the URL to fetch" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "configuration": { + "name": "configuration", + "description": [ + { + "kind": "text", + "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPHttpClientBatchConfiguration" + }, + "options": { + "name": "options", + "description": [ + { + "kind": "text", + "text": "additional options that affect the request" + } + ], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientBatchOptions" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Calls fetch(), but sets the method to 'POST'." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "SPHttpClientBatchConfiguration": { + "kind": "class", + "extends": "SPHttpClientCommonConfiguration", + "implements": "ISPHttpClientBatchConfiguration", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Configuration for SPHttpClientBatch." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method." + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientBatchConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientBatchConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ], + "remarks": [] + }, + "flags": { + "kind": "property", + "signature": "protected flags: ISPHttpClientBatchConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ISPHttpClientBatchConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "initializeFlags": { + "kind": "method", + "signature": "protected initializeFlags(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "overrideWith": { + "kind": "method", + "signature": "overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "SPHttpClientBatchConfiguration", + "description": [] + }, + "parameters": { + "sourceFlags": { + "name": "sourceFlags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientBatchConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": true + } + } + }, + "SPHttpClientCommonConfiguration": { + "kind": "class", + "extends": "HttpClientConfiguration", + "implements": "ISPHttpClientCommonConfiguration", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientCommonConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientCommonConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ] + }, + "flags": { + "kind": "property", + "signature": "protected flags: ISPHttpClientCommonConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ISPHttpClientCommonConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "initializeFlags": { + "kind": "method", + "signature": "protected initializeFlags(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "jsonRequest": { + "kind": "property", + "signature": "readonly jsonRequest: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the \"Content-Type\" header for a JSON payload." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\")." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "jsonResponse": { + "kind": "property", + "signature": "readonly jsonResponse: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the \"Accept\" header for a JSON payload." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 3.0, the value is 'application/json'." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "overrideWith": { + "kind": "method", + "signature": "overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "SPHttpClientCommonConfiguration", + "description": [] + }, + "parameters": { + "sourceFlags": { + "name": "sourceFlags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientCommonConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + } + } + }, + "SPHttpClientConfiguration": { + "kind": "class", + "extends": "SPHttpClientCommonConfiguration", + "implements": "ISPHttpClientConfiguration", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Configuration for " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": "." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);", + "parameters": { + "flags": { + "name": "flags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientConfiguration" + }, + "overrideFlags": { + "name": "overrideFlags", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "ISPHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + } + ], + "remarks": [] + }, + "defaultODataVersion": { + "kind": "property", + "signature": "readonly defaultODataVersion: ODataVersion;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ODataVersion", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the \"OData-Version\" header." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "defaultSameOriginCredentials": { + "kind": "property", + "signature": "readonly defaultSameOriginCredentials: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically configure the RequestInit.credentials." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "flags": { + "kind": "property", + "signature": "protected flags: ISPHttpClientConfiguration;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ISPHttpClientConfiguration", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "initializeFlags": { + "kind": "method", + "signature": "protected initializeFlags(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "overrideWith": { + "kind": "method", + "signature": "overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "SPHttpClientConfiguration", + "description": [] + }, + "parameters": { + "sourceFlags": { + "name": "sourceFlags", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ISPHttpClientConfiguration" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "requestDigest": { + "kind": "property", + "signature": "readonly requestDigest: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Automatically provide an \"X-RequestDigest\" header for authentication." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When this switch is true:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPHttpClientResponse": { + "kind": "class", + "extends": "HttpClientResponse", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Response subclass returned by methods such as SPHttpClient.fetch()." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class." + } + ], + "isBeta": false, + "isSealed": true, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(response: Response);", + "parameters": { + "response": { + "name": "response", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "Response" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClientResponse" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClientResponse", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "clone": { + "kind": "method", + "signature": "clone(): SPHttpClientResponse;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "SPHttpClientResponse", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, + "correlationId": { + "kind": "property", + "signature": "readonly correlationId: Guid | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the SharePoint correlation ID." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the \"sprequestguid\" header." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPHttpHeader": { + "kind": "enum", + "values": { + "SPRequestGuid": { + "kind": "enum value", + "value": "\"SPRequestGuid\"", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example value: \"9417279e-40e1-0000-2465-306ba786bfd7\"" + } + ], + "remarks": [], + "isBeta": true + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard HTTP headers used with " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPHttpClient" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "SPHttpClient", + "memberName": "" + } + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": true + }, + "TokenAcquisitionEventArgs": { + "kind": "class", + "extends": "SPEventArgs", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Arguments for a token acquisition failure event." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(message: string, redirectUrl?: string);", + "parameters": { + "message": { + "name": "message", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "redirectUrl": { + "name": "redirectUrl", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "TokenAcquisitionEventArgs" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-http", + "exportName": "TokenAcquisitionEventArgs", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "message": { + "kind": "property", + "signature": "message: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The message returned from ADAL fails to retrieve a token from Azure AD." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "redirectUrl": { + "kind": "property", + "signature": "redirectUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The url of the page for the end user to perform Multi Factor Authentication" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + } + } +} diff --git a/generate-docs/json/sp-listview-extensibility.api.json b/generate-docs/json/sp-listview-extensibility.api.json index be848248..0ebf55bc 100644 --- a/generate-docs/json/sp-listview-extensibility.api.json +++ b/generate-docs/json/sp-listview-extensibility.api.json @@ -1,1199 +1,1222 @@ -{ - "kind": "package", - "name": "@microsoft/sp-listview-extensibility", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework support for customizing the list view." - } - ], - "remarks": [], - "exports": { - "BaseFieldCustomizer": { - "kind": "class", - "extends": "BaseExtension", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the base class that third parties should extend when implementing a client-side extension that customizes the appearance of fields in a SharePoint ListView." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"FieldCustomizer\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "protected readonly context: FieldCustomizerContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "FieldCustomizerContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDisposeCell": { - "kind": "method", - "signature": "onDisposeCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IFieldCustomizerCellEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onRenderCell": { - "kind": "method", - "signature": "onRenderCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IFieldCustomizerCellEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "BaseListViewCommandSet": { - "kind": "class", - "extends": "BaseExtension", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseListViewCommandSet class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"ListViewCommandSet\"." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "readonly context: ListViewCommandSetContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ListViewCommandSetContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onExecute": { - "kind": "method", - "signature": "onExecute(event: IListViewCommandSetExecuteEventParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IListViewCommandSetExecuteEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onListViewUpdated": { - "kind": "method", - "signature": "onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IListViewCommandSetListViewUpdatedParameters" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event occurs whenever the ListView state changes." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetCommand": { - "kind": "method", - "signature": "tryGetCommand(id: string): Command;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Command", - "description": [] - }, - "parameters": { - "id": { - "name": "id", - "description": [ - { - "kind": "text", - "text": "Id of the command" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the command with the given id. Returns undefined if there is not command with the given id." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ColumnAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to a ListView column, which is the visual presentation of a field." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ColumnAccessor class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A SharePoint \"field\" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a \"property\".)" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A \"column\" is the visual presentation of a field, when displayed by the ListView." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "field": { - "kind": "property", - "signature": "readonly field: SPField;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPField", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The server-side definition of the field. This property is read-only." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "visible": { - "kind": "property", - "signature": "readonly visible: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether to show this column in the list view. This property is read-only." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Command": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a command belonging to a command set." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseListViewCommandSet.tryGetCommand" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-listview-extensibility", - "exportName": "BaseListViewCommandSet", - "memberName": "tryGetCommand" - } - }, - { - "kind": "text", - "text": ". The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel: string | undefined;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "iconImageUrl": { - "kind": "property", - "signature": "iconImageUrl: string | undefined;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This must be a absolute URL." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the command." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "title": { - "kind": "property", - "signature": "title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A short label to be displayed by the associated button, menu item, etc." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"Show information\"" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "visible": { - "kind": "property", - "signature": "visible: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "True if the command is visible." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "FieldCustomizerContext": { - "kind": "class", - "extends": "ExtensionContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This object provides contextual information for BaseFieldCustomizer." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FieldCustomizerContext class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "field": { - "kind": "property", - "signature": "readonly field: SPField;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPField", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the SharePoint field that the customizer will operate on." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetListView": { - "kind": "method", - "signature": "tryGetListView(): ListViewAccessor | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ListViewAccessor | undefined", - "description": [ - { - "kind": "text", - "text": "the SharePoint list view, or undefined if there is none." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IFieldCustomizerCellEventParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event parameters for BaseFieldCustomizer.onRenderCell()" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLDivElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLDivElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The HTML \"div\" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fieldValue": { - "kind": "property", - "signature": "readonly fieldValue: any;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The value of the field being rendered." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "listItem": { - "kind": "property", - "signature": "readonly listItem: ListItemAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ListItemAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The list item being edited." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "userData": { - "kind": "property", - "signature": "userData: any;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An implementation defined storage property." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IListViewCommandSetExecuteEventParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Parameters for " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseListViewCommandSet.onExecute" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-listview-extensibility", - "exportName": "BaseListViewCommandSet", - "memberName": "onExecute" - } - }, - { - "kind": "text", - "text": "" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "itemId": { - "kind": "property", - "signature": "readonly itemId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "selectedRows": { - "kind": "property", - "signature": "readonly selectedRows: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The currently selected ListView rows, at the time when the event occurred." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IListViewCommandSetListViewUpdatedParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Parameters for " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "BaseListViewCommandSet.onListViewUpdated" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-listview-extensibility", - "exportName": "BaseListViewCommandSet", - "memberName": "onListViewUpdated" - } - }, - { - "kind": "text", - "text": "" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "selectedRows": { - "kind": "property", - "signature": "readonly selectedRows: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The currently selected ListView rows, at the time when the event occurred." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ListItemAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListItemAccessor class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and retrieve the current values for those fields. In the future, it may also support validation and editing operations." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "fields": { - "kind": "property", - "signature": "readonly fields: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The SharePoint fields that are currently available in the editor for this list item." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getValue": { - "kind": "method", - "signature": "abstract getValue(field: SPField): any;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "any", - "description": [] - }, - "parameters": { - "field": { - "name": "field", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "SPField" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getValueByName": { - "kind": "method", - "signature": "abstract getValueByName(internalName: string): any;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "any", - "description": [] - }, - "parameters": { - "internalName": { - "name": "internalName", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ListViewAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to a SharePoint ListView control." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewAccessor class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "columns": { - "kind": "property", - "signature": "readonly columns: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The columns in associated with this view, including hidden columns." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "selectedRowsChangedEvent": { - "kind": "property", - "signature": "readonly selectedRowsChangedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event that gets raised every time the selected items in the list view change." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetColumnByName": { - "kind": "method", - "signature": "abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ColumnAccessor | undefined", - "description": [] - }, - "parameters": { - "internalName": { - "name": "internalName", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ListViewCommandSetContext": { - "kind": "class", - "extends": "ExtensionContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This object provides contextual information for BaseListViewCommandSet." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewCommandSetContext class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "listView": { - "kind": "property", - "signature": "readonly listView: ListViewAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ListViewAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the ListView control that the customizer will operate on." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: ICommandSetExtensionManifest;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ICommandSetExtensionManifest", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "RowAccessor": { - "kind": "class", - "extends": "ListItemAccessor", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to a ListView row, which is the visual presentation of a SharePoint list item." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the RowAccessor class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A SharePoint \"list item\" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A \"row\" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns." - } - ], - "isBeta": false, - "isSealed": false, - "members": {} - }, - "SelectedRowsChangedEventArgs": { - "kind": "class", - "extends": "SPEventArgs", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Arguments for the selected rows changed event." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "selectedRows": { - "kind": "property", - "signature": "selectedRows: ReadonlyArray;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The list of rows that were selected in the list view at the time when the event was fired." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-listview-extensibility", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for customizing the list view." + } + ], + "remarks": [], + "exports": { + "BaseFieldCustomizer": { + "kind": "class", + "extends": "BaseExtension", + "implements": "", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the base class that third parties should extend when implementing a client-side extension that customizes the appearance of fields in a SharePoint ListView." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "In the component manifest, the \"extensionType\" should be set to \"FieldCustomizer\"." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "context": { + "kind": "property", + "signature": "protected readonly context: FieldCustomizerContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "FieldCustomizerContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onDisposeCell": { + "kind": "method", + "signature": "onDisposeCell(event: IFieldCustomizerCellEventParameters): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "event": { + "name": "event", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IFieldCustomizerCellEventParameters" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onRenderCell": { + "kind": "method", + "signature": "onRenderCell(event: IFieldCustomizerCellEventParameters): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "event": { + "name": "event", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IFieldCustomizerCellEventParameters" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "BaseListViewCommandSet": { + "kind": "class", + "extends": "BaseExtension", + "implements": "", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseListViewCommandSet class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "In the component manifest, the \"extensionType\" should be set to \"ListViewCommandSet\"." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "context": { + "kind": "property", + "signature": "readonly context: ListViewCommandSetContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ListViewCommandSetContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onExecute": { + "kind": "method", + "signature": "onExecute(event: IListViewCommandSetExecuteEventParameters): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "event": { + "name": "event", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IListViewCommandSetExecuteEventParameters" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onListViewUpdated": { + "kind": "method", + "signature": "onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "event": { + "name": "event", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IListViewCommandSetListViewUpdatedParameters" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event occurs whenever the ListView state changes." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetCommand": { + "kind": "method", + "signature": "tryGetCommand(id: string): Command;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Command", + "description": [] + }, + "parameters": { + "id": { + "name": "id", + "description": [ + { + "kind": "text", + "text": "Id of the command" + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the command with the given id. Returns undefined if there is not command with the given id." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "ColumnAccessor": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to a ListView column, which is the visual presentation of a field." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ColumnAccessor class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A SharePoint \"field\" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a \"property\".)" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A \"column\" is the visual presentation of a field, when displayed by the ListView." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "field": { + "kind": "property", + "signature": "readonly field: SPField;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPField", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The server-side definition of the field. This property is read-only." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "visible": { + "kind": "property", + "signature": "readonly visible: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether to show this column in the list view. This property is read-only." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "Command": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents a command belonging to a command set." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseListViewCommandSet.tryGetCommand" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-listview-extensibility", + "exportName": "BaseListViewCommandSet", + "memberName": "tryGetCommand" + } + }, + { + "kind": "text", + "text": ". The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel: string | undefined;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "iconImageUrl": { + "kind": "property", + "signature": "iconImageUrl: string | undefined;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This must be a absolute URL." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Id of the command." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "title": { + "kind": "property", + "signature": "title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A short label to be displayed by the associated button, menu item, etc." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"Show information\"" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "visible": { + "kind": "property", + "signature": "visible: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "True if the command is visible." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "FieldCustomizerContext": { + "kind": "class", + "extends": "ExtensionContext", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This object provides contextual information for BaseFieldCustomizer." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FieldCustomizerContext class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "field": { + "kind": "property", + "signature": "readonly field: SPField;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPField", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to the SharePoint field that the customizer will operate on." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tryGetListView": { + "kind": "method", + "signature": "tryGetListView(): ListViewAccessor | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ListViewAccessor | undefined", + "description": [ + { + "kind": "text", + "text": "the SharePoint list view, or undefined if there is none." + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IFieldCustomizerCellEventParameters": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Event parameters for BaseFieldCustomizer.onRenderCell()" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "domElement": { + "kind": "property", + "signature": "readonly domElement: HTMLDivElement;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HTMLDivElement", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The HTML \"div\" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fieldValue": { + "kind": "property", + "signature": "readonly fieldValue: any;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The value of the field being rendered." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listItem": { + "kind": "property", + "signature": "readonly listItem: ListItemAccessor;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ListItemAccessor", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The list item being edited." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "userData": { + "kind": "property", + "signature": "userData: any;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An implementation defined storage property." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IListViewCommandSetExecuteEventParameters": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Parameters for " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseListViewCommandSet.onExecute" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-listview-extensibility", + "exportName": "BaseListViewCommandSet", + "memberName": "onExecute" + } + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "itemId": { + "kind": "property", + "signature": "readonly itemId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "selectedRows": { + "kind": "property", + "signature": "readonly selectedRows: ReadonlyArray;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ReadonlyArray", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The currently selected ListView rows, at the time when the event occurred." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IListViewCommandSetListViewUpdatedParameters": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Parameters for " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseListViewCommandSet.onListViewUpdated" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-listview-extensibility", + "exportName": "BaseListViewCommandSet", + "memberName": "onListViewUpdated" + } + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "selectedRows": { + "kind": "property", + "signature": "readonly selectedRows: ReadonlyArray;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ReadonlyArray", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The currently selected ListView rows, at the time when the event occurred." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ListItemAccessor": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListItemAccessor class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and retrieve the current values for those fields. In the future, it may also support validation and editing operations." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "fields": { + "kind": "property", + "signature": "readonly fields: ReadonlyArray;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ReadonlyArray", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The SharePoint fields that are currently available in the editor for this list item." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "getValue": { + "kind": "method", + "signature": "abstract getValue(field: SPField): any;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "any", + "description": [] + }, + "parameters": { + "field": { + "name": "field", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "SPField" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getValueByName": { + "kind": "method", + "signature": "abstract getValueByName(internalName: string): any;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "any", + "description": [] + }, + "parameters": { + "internalName": { + "name": "internalName", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "ListViewAccessor": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to a SharePoint ListView control." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewAccessor class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "columns": { + "kind": "property", + "signature": "readonly columns: ReadonlyArray;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ReadonlyArray", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The columns in associated with this view, including hidden columns." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "selectedRowsChangedEvent": { + "kind": "property", + "signature": "readonly selectedRowsChangedEvent: SPEvent;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Event that gets raised every time the selected items in the list view change." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": true + }, + "tryGetColumnByName": { + "kind": "method", + "signature": "abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "ColumnAccessor | undefined", + "description": [] + }, + "parameters": { + "internalName": { + "name": "internalName", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "ListViewCommandSetContext": { + "kind": "class", + "extends": "ExtensionContext", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This object provides contextual information for BaseListViewCommandSet." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewCommandSetContext class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "listView": { + "kind": "property", + "signature": "readonly listView: ListViewAccessor;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ListViewAccessor", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to the ListView control that the customizer will operate on." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manifest": { + "kind": "property", + "signature": "readonly manifest: ICommandSetExtensionManifest;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ICommandSetExtensionManifest", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Manifest for the client side component." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "RowAccessor": { + "kind": "class", + "extends": "ListItemAccessor", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Provides access to a ListView row, which is the visual presentation of a SharePoint list item." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the RowAccessor class." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A SharePoint \"list item\" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A \"row\" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns." + } + ], + "isBeta": false, + "isSealed": false, + "members": {} + }, + "SelectedRowsChangedEventArgs": { + "kind": "class", + "extends": "SPEventArgs", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Arguments for the selected rows changed event." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "selectedRows": { + "kind": "property", + "signature": "selectedRows: ReadonlyArray;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ReadonlyArray", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The list of rows that were selected in the list view at the time when the event was fired." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + } + } +} diff --git a/generate-docs/json/sp-odata-types.api.json b/generate-docs/json/sp-odata-types.api.json index 0803efa8..dc4204e4 100644 --- a/generate-docs/json/sp-odata-types.api.json +++ b/generate-docs/json/sp-odata-types.api.json @@ -1,1840 +1,1876 @@ -{ - "kind": "package", - "name": "@microsoft/sp-odata-types", - "summary": [ - { - "kind": "text", - "text": "TypeScript interfaces for working with SharePoint REST APIs." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions." - } - ], - "exports": { - "IODataBasePermission": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Data used for creating a SPPermission object." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "High": { - "kind": "property", - "signature": "High: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Low": { - "kind": "property", - "signature": "Low: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataChangeToken": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.ChangeToken object. For more information about this object, see " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - }, - { - "kind": "text", - "text": "" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "StringValue": { - "kind": "property", - "signature": "StringValue: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: { StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataContextWebInformation": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.ContextWebInformation object. For more information about this object, see " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - }, - { - "kind": "text", - "text": "" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "FormDigestTimeoutSeconds": { - "kind": "property", - "signature": "FormDigestTimeoutSeconds: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: 1800" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "FormDigestValue": { - "kind": "property", - "signature": "FormDigestValue: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"0x61B31CBF4C76C...B0,20 Jan 2016 02:24:43 -0000\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "LibraryVersion": { - "kind": "property", - "signature": "LibraryVersion: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"16.0.4919.3000\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "SiteFullUrl": { - "kind": "property", - "signature": "SiteFullUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "SupportedSchemaVersions": { - "kind": "property", - "signature": "SupportedSchemaVersions: string[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: [ \"14.0.0.0\", \"15.0.0.0\" ]" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "WebFullUrl": { - "kind": "property", - "signature": "WebFullUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataList": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "BaseTemplate": { - "kind": "property", - "signature": "BaseTemplate: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The list definition type on which the list is based." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Created": { - "kind": "property", - "signature": "Created: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/Date(1453294804000)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "CurrentChangeToken": { - "kind": "property", - "signature": "CurrentChangeToken: IODataChangeToken;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataChangeToken", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The change token that will be used in logging the next change to the list." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Description": { - "kind": "property", - "signature": "Description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A description of the List." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "EntityTypeName": { - "kind": "property", - "signature": "EntityTypeName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"MyListTitleList\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Hidden": { - "kind": "property", - "signature": "Hidden: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Id": { - "kind": "property", - "signature": "Id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "LastItemDeletedDate": { - "kind": "property", - "signature": "LastItemDeletedDate: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/Date(1453294809000)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "LastItemModifiedDate": { - "kind": "property", - "signature": "LastItemModifiedDate: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/Date(1453294809000)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ListItemEntityTypeFullName": { - "kind": "property", - "signature": "ListItemEntityTypeFullName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"SP.Data.MyListTitleListItem\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ParentWebUrl": { - "kind": "property", - "signature": "ParentWebUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/sites/PubSite\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "TemplateFeatureId": { - "kind": "property", - "signature": "TemplateFeatureId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"Pages\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataListItem": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ContentTypeId": { - "kind": "property", - "signature": "ContentTypeId:", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "{\n StringValue: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: { StringValue: \"0x010100C5...\" }" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ID": { - "kind": "property", - "signature": "ID: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Title of the List Item" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "UniqueId": { - "kind": "property", - "signature": "UniqueId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataNavigationNode": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.NavigationNode object. https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "Children": { - "kind": "property", - "signature": "Children?: IODataNavigationNode[];", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IODataNavigationNode[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets an array of Navigation Nodes that are children to the current node." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Id": { - "kind": "property", - "signature": "Id?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the identifier for the navigation node." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "IsDocLib": { - "kind": "property", - "signature": "IsDocLib?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "IsExternal": { - "kind": "property", - "signature": "IsExternal?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "IsVisible": { - "kind": "property", - "signature": "IsVisible?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies if the node navigation link should be visible." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Title": { - "kind": "property", - "signature": "Title?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies the anchor text for the node navigation link." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Url": { - "kind": "property", - "signature": "Url?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataNavigationNodeCollection": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "quickLaunch": { - "kind": "property", - "signature": "quickLaunch: IODataNavigationNode[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataNavigationNode[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "topNav": { - "kind": "property", - "signature": "topNav: IODataNavigationNode[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataNavigationNode[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets an SPNavigationNode object that contains the nodes in the top link bar for the website." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataUser": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "Email": { - "kind": "property", - "signature": "Email: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"someone@example.com\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Id": { - "kind": "property", - "signature": "Id: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "IsSiteAdmin": { - "kind": "property", - "signature": "IsSiteAdmin: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Boolean value that specifies whether the user is a site collection administrator." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "LoginName": { - "kind": "property", - "signature": "LoginName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"i:0#.w|domain\\user\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "PrincipalType": { - "kind": "property", - "signature": "PrincipalType: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Values:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "None: 0" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "User: 1" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "DistributionList: 2" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "SecurityGroup: 4" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "SharePointGroup: 8" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "All: 15" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"DOMAIN\\user\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "UserId": { - "kind": "property", - "signature": "UserId: IODataUserId;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataUserId", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataUserCustomAction": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ClientSideComponentId": { - "kind": "property", - "signature": "ClientSideComponentId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the client-side component defined with SharePoint Framework" - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"359af2a7-b73c-4aac-874c-60a865da0be7\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ClientSideComponentProperties": { - "kind": "property", - "signature": "ClientSideComponentProperties: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom initialization properties for the client-side component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: \"{ \\\"maxItemsToShow\\\": 123 }\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "CommandUIExtension": { - "kind": "property", - "signature": "CommandUIExtension: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Description": { - "kind": "property", - "signature": "Description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the description of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Group": { - "kind": "property", - "signature": "Group: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Id": { - "kind": "property", - "signature": "Id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the identifier (GUID) of the custom action. Example: \"48309f28-53aa-43ed-b113-625120e5af6f\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ImageUrl": { - "kind": "property", - "signature": "ImageUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL of the image associated with the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Location": { - "kind": "property", - "signature": "Location: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the location of the custom action." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"ClientSide.Application\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "RegistrationId": { - "kind": "property", - "signature": "RegistrationId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the identifier of the object associated with the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "RegistrationType": { - "kind": "property", - "signature": "RegistrationType: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the type of object associated with the custom action." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Rights": { - "kind": "property", - "signature": "Rights: IODataBasePermission;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataBasePermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the permissions needed for the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Scope": { - "kind": "property", - "signature": "Scope: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the scope of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ScriptBlock": { - "kind": "property", - "signature": "ScriptBlock: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ScriptSrc": { - "kind": "property", - "signature": "ScriptSrc: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Sequence": { - "kind": "property", - "signature": "Sequence: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the display title of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Url": { - "kind": "property", - "signature": "Url: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "VersionOfUserCustomAction": { - "kind": "property", - "signature": "VersionOfUserCustomAction: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies an implementation specific version identifier." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"16.0.1.0\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IODataWeb": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "Created": { - "kind": "property", - "signature": "Created?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies when the site was created. Example: \"/Date(2016,0,20,12,58,7,0)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "CurrentChangeToken": { - "kind": "property", - "signature": "CurrentChangeToken?: IODataChangeToken;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IODataChangeToken", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents the unique sequential location of a change within the change log." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "CustomMasterUrl": { - "kind": "property", - "signature": "CustomMasterUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL for a custom master page file to apply to the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Description": { - "kind": "property", - "signature": "Description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the description for the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Id": { - "kind": "property", - "signature": "Id?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the site identifier for the site. Example: \"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "IsMultilingual": { - "kind": "property", - "signature": "IsMultilingual?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Value that represents if the web was" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Language": { - "kind": "property", - "signature": "Language?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the LCID for the language that is used on the site. Example: 1033" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "LastItemModifiedDate": { - "kind": "property", - "signature": "LastItemModifiedDate?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies when an item was last modified in the site. Example: \"/Date(1453618828000)/\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "MasterUrl": { - "kind": "property", - "signature": "MasterUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL of the master page that is used for the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "NoCrawl": { - "kind": "property", - "signature": "NoCrawl?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Determines if a particular web will be crawled by search or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "QuickLaunchEnabled": { - "kind": "property", - "signature": "QuickLaunchEnabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies whether the Quick Launch area is enabled on the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "RecycleBinEnabled": { - "kind": "property", - "signature": "RecycleBinEnabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that determines whether the recycle bin is enabled for the website." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ServerRelativeUrl": { - "kind": "property", - "signature": "ServerRelativeUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the server-relative URL for the Web site. Example: \"/sites/PubSite\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "SiteLogoUrl": { - "kind": "property", - "signature": "SiteLogoUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the url for the logo of this particular site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Title": { - "kind": "property", - "signature": "Title?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The title of the web." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "UIVersion": { - "kind": "property", - "signature": "UIVersion?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the user interface (UI) version of the Web site. Example: 15" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "Url": { - "kind": "property", - "signature": "Url?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the absolute URL for the website. Example: \"http://example.com/sites/PubSite\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "WebTemplate": { - "kind": "property", - "signature": "WebTemplate?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the name of the site definition or site template that was used to create the site. Example: \"BLANKINTERNET\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-odata-types", + "summary": [ + { + "kind": "text", + "text": "TypeScript interfaces for working with SharePoint REST APIs." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions." + } + ], + "exports": { + "IODataBasePermission": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Data used for creating a SPPermission object." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "High": { + "kind": "property", + "signature": "High: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Low": { + "kind": "property", + "signature": "Low: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataChangeToken": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.ChangeToken object. For more information about this object, see " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "StringValue": { + "kind": "property", + "signature": "StringValue: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: { StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataContextWebInformation": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.ContextWebInformation object. For more information about this object, see " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + }, + { + "kind": "text", + "text": "" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "LibraryVersion": { + "kind": "property", + "signature": "LibraryVersion: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"16.0.4919.3000\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "SiteFullUrl": { + "kind": "property", + "signature": "SiteFullUrl: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "SupportedSchemaVersions": { + "kind": "property", + "signature": "SupportedSchemaVersions: string[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: [ \"14.0.0.0\", \"15.0.0.0\" ]" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "WebFullUrl": { + "kind": "property", + "signature": "WebFullUrl: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataList": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "BaseTemplate": { + "kind": "property", + "signature": "BaseTemplate: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The list definition type on which the list is based." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Created": { + "kind": "property", + "signature": "Created: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/Date(1453294804000)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "CurrentChangeToken": { + "kind": "property", + "signature": "CurrentChangeToken: IODataChangeToken;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IODataChangeToken", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The change token that will be used in logging the next change to the list." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Description": { + "kind": "property", + "signature": "Description: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A description of the List." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "EntityTypeName": { + "kind": "property", + "signature": "EntityTypeName: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"MyListTitleList\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Hidden": { + "kind": "property", + "signature": "Hidden: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Id": { + "kind": "property", + "signature": "Id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "LastItemDeletedDate": { + "kind": "property", + "signature": "LastItemDeletedDate: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/Date(1453294809000)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "LastItemModifiedDate": { + "kind": "property", + "signature": "LastItemModifiedDate: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/Date(1453294809000)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ListItemEntityTypeFullName": { + "kind": "property", + "signature": "ListItemEntityTypeFullName: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"SP.Data.MyListTitleListItem\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ParentWebUrl": { + "kind": "property", + "signature": "ParentWebUrl: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/sites/PubSite\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "TemplateFeatureId": { + "kind": "property", + "signature": "TemplateFeatureId: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Title": { + "kind": "property", + "signature": "Title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"Pages\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataListItem": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ContentTypeId": { + "kind": "property", + "signature": "ContentTypeId:", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "{\n StringValue: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: { StringValue: \"0x010100C5...\" }" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ID": { + "kind": "property", + "signature": "ID: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Title": { + "kind": "property", + "signature": "Title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Title of the List Item" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "UniqueId": { + "kind": "property", + "signature": "UniqueId: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataNavigationNode": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.NavigationNode object. https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "Children": { + "kind": "property", + "signature": "Children?: IODataNavigationNode[];", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IODataNavigationNode[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets an array of Navigation Nodes that are children to the current node." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Id": { + "kind": "property", + "signature": "Id?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies the identifier for the navigation node." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "IsDocLib": { + "kind": "property", + "signature": "IsDocLib?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "IsExternal": { + "kind": "property", + "signature": "IsExternal?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "IsVisible": { + "kind": "property", + "signature": "IsVisible?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies if the node navigation link should be visible." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Title": { + "kind": "property", + "signature": "Title?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies the anchor text for the node navigation link." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Url": { + "kind": "property", + "signature": "Url?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataNavigationNodeCollection": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "quickLaunch": { + "kind": "property", + "signature": "quickLaunch: IODataNavigationNode[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IODataNavigationNode[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "topNav": { + "kind": "property", + "signature": "topNav: IODataNavigationNode[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IODataNavigationNode[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets an SPNavigationNode object that contains the nodes in the top link bar for the website." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataUser": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "Email": { + "kind": "property", + "signature": "Email: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"someone@example.com\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Id": { + "kind": "property", + "signature": "Id: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "IsSiteAdmin": { + "kind": "property", + "signature": "IsSiteAdmin: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Boolean value that specifies whether the user is a site collection administrator." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "LoginName": { + "kind": "property", + "signature": "LoginName: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"i:0#.w|domain\\user\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "PrincipalType": { + "kind": "property", + "signature": "PrincipalType: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Values:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "None: 0" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "User: 1" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "DistributionList: 2" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "SecurityGroup: 4" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "SharePointGroup: 8" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "All: 15" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Title": { + "kind": "property", + "signature": "Title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Example: \"DOMAIN\\user\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "UserId": { + "kind": "property", + "signature": "UserId: IODataUserId;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IODataUserId", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataUserCustomAction": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ClientSideComponentId": { + "kind": "property", + "signature": "ClientSideComponentId: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the client-side component defined with SharePoint Framework" + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"359af2a7-b73c-4aac-874c-60a865da0be7\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ClientSideComponentProperties": { + "kind": "property", + "signature": "ClientSideComponentProperties: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Custom initialization properties for the client-side component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: \"{ \\\"maxItemsToShow\\\": 123 }\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "CommandUIExtension": { + "kind": "property", + "signature": "CommandUIExtension: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Description": { + "kind": "property", + "signature": "Description: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the description of the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Group": { + "kind": "property", + "signature": "Group: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Id": { + "kind": "property", + "signature": "Id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies the identifier (GUID) of the custom action. Example: \"48309f28-53aa-43ed-b113-625120e5af6f\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ImageUrl": { + "kind": "property", + "signature": "ImageUrl: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the URL of the image associated with the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Location": { + "kind": "property", + "signature": "Location: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the location of the custom action." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"ClientSide.Application\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "RegistrationId": { + "kind": "property", + "signature": "RegistrationId: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the value that specifies the identifier of the object associated with the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "RegistrationType": { + "kind": "property", + "signature": "RegistrationType: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the value that specifies the type of object associated with the custom action." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Rights": { + "kind": "property", + "signature": "Rights: IODataBasePermission;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IODataBasePermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the value that specifies the permissions needed for the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Scope": { + "kind": "property", + "signature": "Scope: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies the scope of the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ScriptBlock": { + "kind": "property", + "signature": "ScriptBlock: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ScriptSrc": { + "kind": "property", + "signature": "ScriptSrc: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Sequence": { + "kind": "property", + "signature": "Sequence: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Title": { + "kind": "property", + "signature": "Title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the display title of the custom action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Url": { + "kind": "property", + "signature": "Url: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "VersionOfUserCustomAction": { + "kind": "property", + "signature": "VersionOfUserCustomAction: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies an implementation specific version identifier." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"16.0.1.0\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IODataWeb": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "Created": { + "kind": "property", + "signature": "Created?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies when the site was created. Example: \"/Date(2016,0,20,12,58,7,0)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "CurrentChangeToken": { + "kind": "property", + "signature": "CurrentChangeToken?: IODataChangeToken;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IODataChangeToken", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Represents the unique sequential location of a change within the change log." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "CustomMasterUrl": { + "kind": "property", + "signature": "CustomMasterUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the URL for a custom master page file to apply to the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Description": { + "kind": "property", + "signature": "Description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the description for the site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Id": { + "kind": "property", + "signature": "Id?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies the site identifier for the site. Example: \"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "IsMultilingual": { + "kind": "property", + "signature": "IsMultilingual?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Value that represents if the web was" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Language": { + "kind": "property", + "signature": "Language?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies the LCID for the language that is used on the site. Example: 1033" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "LastItemModifiedDate": { + "kind": "property", + "signature": "LastItemModifiedDate?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets a value that specifies when an item was last modified in the site. Example: \"/Date(1453618828000)/\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "MasterUrl": { + "kind": "property", + "signature": "MasterUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the URL of the master page that is used for the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "NoCrawl": { + "kind": "property", + "signature": "NoCrawl?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Determines if a particular web will be crawled by search or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "QuickLaunchEnabled": { + "kind": "property", + "signature": "QuickLaunchEnabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that specifies whether the Quick Launch area is enabled on the site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "RecycleBinEnabled": { + "kind": "property", + "signature": "RecycleBinEnabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets a value that determines whether the recycle bin is enabled for the website." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ServerRelativeUrl": { + "kind": "property", + "signature": "ServerRelativeUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the server-relative URL for the Web site. Example: \"/sites/PubSite\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "SiteLogoUrl": { + "kind": "property", + "signature": "SiteLogoUrl?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the url for the logo of this particular site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Title": { + "kind": "property", + "signature": "Title?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The title of the web." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "UIVersion": { + "kind": "property", + "signature": "UIVersion?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets or sets the user interface (UI) version of the Web site. Example: 15" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Url": { + "kind": "property", + "signature": "Url?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the absolute URL for the website. Example: \"http://example.com/sites/PubSite\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "WebTemplate": { + "kind": "property", + "signature": "WebTemplate?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the name of the site definition or site template that was used to create the site. Example: \"BLANKINTERNET\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + } + } +} diff --git a/generate-docs/json/sp-page-context.api.json b/generate-docs/json/sp-page-context.api.json index 1ab595e2..d8baccdc 100644 --- a/generate-docs/json/sp-page-context.api.json +++ b/generate-docs/json/sp-page-context.api.json @@ -1,2315 +1,3014 @@ -{ - "kind": "package", - "name": "@microsoft/sp-page-context", - "summary": [ - { - "kind": "text", - "text": "Page context services for the SharePoint Framework" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The page context allows an application and its web parts to share common data about the current page, such as its contents, URL, list, user, permissions, navigation menu, etc." - } - ], - "exports": { - "CultureInfo": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides culture info for the current user of the application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CultureInfo class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "currentCultureName": { - "kind": "property", - "signature": "readonly currentCultureName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This property may be an empty string, but it will never be undefined." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: If the currentCultureName is \"en-AU\" then the application could use this information to display the date as 1/8 instead of 8/1." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "currentUICultureName": { - "kind": "property", - "signature": "readonly currentUICultureName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This string determines the default user interface language. This used for localization and translation of text." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This property may have an empty string, but will never be undefined." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: If the currentUICultureName is \"es-MX\", then the application could use this information to translate the word \"hello\" to \"hola\"." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isRightToLeft": { - "kind": "property", - "signature": "readonly isRightToLeft: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This boolean represents the dominant direction of written text for the default user interface language." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "PageContext": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PageContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-page-context", - "exportName": "PageContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "aadInfo": { - "kind": "property", - "signature": "readonly aadInfo: AzureActiveDirectoryInfo | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AzureActiveDirectoryInfo | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "cultureInfo": { - "kind": "property", - "signature": "readonly cultureInfo: CultureInfo;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "CultureInfo", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "It provides culture info for the current user of the application. This class is primarily used with the PageContext class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isInitialized": { - "kind": "property", - "signature": "readonly isInitialized: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns whether the PageContext has been initialized." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "legacyPageContext": { - "kind": "property", - "signature": "readonly legacyPageContext: any;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An object providing classic SharePoint properties that may be required by certain legacy scripts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the _spPageContextInfo window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "NOTE: If certain functionality is exposed in the legacyPageContext but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the legacyPageContext object." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "list": { - "kind": "property", - "signature": "readonly list: SPList | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPList | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "listItem": { - "kind": "property", - "signature": "readonly listItem: SPListItem | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPListItem | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for PageContext." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "site": { - "kind": "property", - "signature": "readonly site: SPSite;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPSite", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint site collection (\"site\") that is hosting the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "user": { - "kind": "property", - "signature": "readonly user: SPUser;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPUser", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the PageContext class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "web": { - "kind": "property", - "signature": "readonly web: SPWeb;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPWeb", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint site (\"web\") that is hosting the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPField": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The client-side equivalent for SharePoint SPField class. Used in Fields property of SPList and SPListItem classes. A field represents the data model for a column in SharePoint list view." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPField class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "clientSideComponentId": { - "kind": "property", - "signature": "readonly clientSideComponentId: Guid | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the client-side component associated with the field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clientSideComponentProperties": { - "kind": "property", - "signature": "readonly clientSideComponentProperties: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "displayName": { - "kind": "property", - "signature": "readonly displayName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The display name of the field. This name is shown as column name in UI." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fieldType": { - "kind": "property", - "signature": "readonly fieldType: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The type of the field represented as a string" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID identifier for this field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "internalName": { - "kind": "property", - "signature": "readonly internalName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The internal name of the field. This name is usually used to find the field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isRequired": { - "kind": "property", - "signature": "readonly isRequired: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the field is required for each list item in the list" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPList": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPList class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "permissions": { - "kind": "property", - "signature": "readonly permissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "readonly serverRelativeUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the server-relative URL for this SPList." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"/sites/PubSite\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "title": { - "kind": "property", - "signature": "readonly title: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the title for this SPList." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPListItem": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list item that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPListItem class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "id": { - "kind": "property", - "signature": "readonly id: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The number that identifies the SPListItem on the server." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPPermission": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Used to test whether the current user has a requested set of permissions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Specifies the built-in permissions available in SharePoint Foundation" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information, see: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(value: IODataBasePermission);", - "parameters": { - "value": { - "name": "value", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IODataBasePermission" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPPermission" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-page-context", - "exportName": "SPPermission", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "addAndCustomizePages": { - "kind": "property", - "signature": "static readonly addAndCustomizePages: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "addDelPrivateWebParts": { - "kind": "property", - "signature": "static readonly addDelPrivateWebParts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add or remove personal web parts on a web part Page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "addListItems": { - "kind": "property", - "signature": "static readonly addListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add items to lists, add documents to document libraries, and add Web discussion comments." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "applyStyleSheets": { - "kind": "property", - "signature": "static readonly applyStyleSheets: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Apply a style sheet (.css file) to the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "applyThemeAndBorder": { - "kind": "property", - "signature": "static readonly applyThemeAndBorder: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Apply a theme or borders to the entire Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "approveItems": { - "kind": "property", - "signature": "static readonly approveItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Approve a minor version of a list item or document." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "browseDirectories": { - "kind": "property", - "signature": "static readonly browseDirectories: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "browserUserInfo": { - "kind": "property", - "signature": "static readonly browserUserInfo: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View information about users of the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "cancelCheckout": { - "kind": "property", - "signature": "static readonly cancelCheckout: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Discard or check in a document which is checked out to another user." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createAlerts": { - "kind": "property", - "signature": "static readonly createAlerts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create e-mail alerts." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createGroups": { - "kind": "property", - "signature": "static readonly createGroups: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a group of users that can be used anywhere within the site collection." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createSSCSite": { - "kind": "property", - "signature": "static readonly createSSCSite: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a Web site using Self-Service Site Creation." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "deleteListItems": { - "kind": "property", - "signature": "static readonly deleteListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Delete items from a list, documents from a document library, and Web discussion comments in documents." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "deleteVersions": { - "kind": "property", - "signature": "static readonly deleteVersions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Delete past versions of a list item or document." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "editListItems": { - "kind": "property", - "signature": "static readonly editListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "editMyUserInfo": { - "kind": "property", - "signature": "static readonly editMyUserInfo: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Allows a user to change his or her user information, such as adding a picture." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "emptyMask": { - "kind": "property", - "signature": "static readonly emptyMask: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Has no permissions on the Web site. Not available through the user interface." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "enumeratePermissions": { - "kind": "property", - "signature": "static readonly enumeratePermissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enumerate permissions on the Web site, list, folder, document, or list item." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fullMask": { - "kind": "property", - "signature": "static readonly fullMask: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Has all permissions on the Web site. Not available through the user interface." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "hasAllPermissions": { - "kind": "method", - "signature": "hasAllPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": { - "requestedPerms": { - "name": "requestedPerms", - "description": [ - { - "kind": "text", - "text": "Any number of SPPermission objects to be compared against the original" - } - ], - "isOptional": false, - "isSpread": true, - "type": "SPPermission[]" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Function for testing whether a given permission mask has all of the requested permissions." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "hasAnyPermissions": { - "kind": "method", - "signature": "hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": { - "requestedPerms": { - "name": "requestedPerms", - "description": [ - { - "kind": "text", - "text": "Any number of SPPermission objects to be compared against the original" - } - ], - "isOptional": false, - "isSpread": true, - "type": "SPPermission[]" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Function for testing whether a given permission mask has any of the requested permissions." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "hasPermission": { - "kind": "method", - "signature": "hasPermission(requestedPerm: SPPermission): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": { - "requestedPerm": { - "name": "requestedPerm", - "description": [ - { - "kind": "text", - "text": "The SPPermission object to be compared against the original" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPPermission" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Function for testing whether a given permission mask has the requested permission." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "layoutsPage": { - "kind": "property", - "signature": "static readonly layoutsPage: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View the layouts page?" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manageAlerts": { - "kind": "property", - "signature": "static readonly manageAlerts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manage alerts for all users of the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manageLists": { - "kind": "property", - "signature": "static readonly manageLists: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create and delete lists, add or remove columns in a list, and add or remove public views of a list." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "managePermissions": { - "kind": "property", - "signature": "static readonly managePermissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create and change permission levels on the Web site and assign permissions to users and groups." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "managePersonalViews": { - "kind": "property", - "signature": "static readonly managePersonalViews: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create, change, and delete personal views of lists." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manageSubwebs": { - "kind": "property", - "signature": "static readonly manageSubwebs: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manageWeb": { - "kind": "property", - "signature": "static readonly manageWeb: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Grant the ability to perform all administration tasks for the Web site as well as manage content." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "open": { - "kind": "property", - "signature": "static readonly open: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Allow users to open a Web site, list, or folder to access items inside that container." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "openItems": { - "kind": "property", - "signature": "static readonly openItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View the source of documents with server-side file handlers." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "updatePersonalWebParts": { - "kind": "property", - "signature": "static readonly updatePersonalWebParts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Update web parts to display personalized information." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "useClientIntegration": { - "kind": "property", - "signature": "static readonly useClientIntegration: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use features that launch client applications; otherwise, users must work on documents locally and upload changes." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "useRemoteAPIs": { - "kind": "property", - "signature": "static readonly useRemoteAPIs: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "value": { - "kind": "property", - "signature": "readonly value: IODataBasePermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IODataBasePermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the value of this SPPermission object" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "viewFormPages": { - "kind": "property", - "signature": "static readonly viewFormPages: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View forms, views, and application pages, and enumerate lists." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "viewListItems": { - "kind": "property", - "signature": "static readonly viewListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View items in lists, documents in document libraries, and view Web discussion comments." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "viewPages": { - "kind": "property", - "signature": "static readonly viewPages: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View pages in a Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "viewUsageData": { - "kind": "property", - "signature": "static readonly viewUsageData: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View reports on Web site usage." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "viewVersions": { - "kind": "property", - "signature": "static readonly viewVersions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View past versions of a list item or document." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPSite": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site collection (\"site\") that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPSite class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "absoluteUrl": { - "kind": "property", - "signature": "readonly absoluteUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the absolute URL for this SPSite." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"https://example.com/sites/PubSite\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "cdnPrefix": { - "kind": "property", - "signature": "readonly cdnPrefix: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the prefix of the application's specified cdn or an empty string if there isn't one." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "classification": { - "kind": "property", - "signature": "readonly classification: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the classification of the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "correlationId": { - "kind": "property", - "signature": "readonly correlationId: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the correlation id to the current server request." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "group": { - "kind": "property", - "signature": "readonly group: O365GroupAssociation | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "O365GroupAssociation | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID that identifies the SPSite on the server." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isNoScriptEnabled": { - "kind": "property", - "signature": "readonly isNoScriptEnabled: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if isNoScript has been enabled on the SPSite." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "recycleBinItemCount": { - "kind": "property", - "signature": "readonly recycleBinItemCount: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The amount of items in the recycle bin." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "readonly serverRelativeUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the server-relative URL for this SPSite." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"/sites/PubSite\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serverRequestPath": { - "kind": "property", - "signature": "readonly serverRequestPath: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns serverRelativeUrl of the original request." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"/teams/SPClientTest/SitePages/Home.aspx\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "sitePagesEnabled": { - "kind": "property", - "signature": "readonly sitePagesEnabled: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if SitePages are enabled on this SPSite." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPUser": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint user that is accessing the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPUser class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "displayName": { - "kind": "property", - "signature": "readonly displayName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The display name for the current user." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"John Doe\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "email": { - "kind": "property", - "signature": "readonly email: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The email address for the current user." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"example@contoso.com\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isAnonymousGuestUser": { - "kind": "property", - "signature": "readonly isAnonymousGuestUser: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns if the current user is an anonymous guest." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isExternalGuestUser": { - "kind": "property", - "signature": "readonly isExternalGuestUser: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the current user is an external guest." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "loginName": { - "kind": "property", - "signature": "readonly loginName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The login name for current user." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: on-premise user: \"domain\\user\", online user: \"user@domain.com\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "preferUserTimeZone": { - "kind": "property", - "signature": "readonly preferUserTimeZone: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This boolean represents if a the user or web's time zone settings should be used to display the current time." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPWeb": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site (\"web\") that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPWeb class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "absoluteUrl": { - "kind": "property", - "signature": "readonly absoluteUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the absolute URL for this SPWeb. Example: \"https://example.com/sites/PubSite/SubWeb\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "description": { - "kind": "property", - "signature": "readonly description: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the description of the current SPWeb." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID that identifies the SPWeb on the server." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isAppWeb": { - "kind": "property", - "signature": "readonly isAppWeb: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if this SPWeb the container web for an SPApp." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "language": { - "kind": "property", - "signature": "readonly language: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the locale identifier (LCID) for the default language of the website." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: 1033 represents the locale identifier for en-US." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "logoUrl": { - "kind": "property", - "signature": "readonly logoUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the absolute URL of the website logo." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: https://example.com/sites/PubSite/SubWeb/logo.jpg" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "permissions": { - "kind": "property", - "signature": "readonly permissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "readonly serverRelativeUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the server-relative URL for this SPWeb." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"/sites/PubSite/SubWeb\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "templateName": { - "kind": "property", - "signature": "readonly templateName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the string representing the numeric identifier for the site definition or site template that was used to create the site." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: \"1\" represents the team site template when creating a new site on SharePoint." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "title": { - "kind": "property", - "signature": "readonly title: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the title of the current SPWeb." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-page-context", + "summary": [ + { + "kind": "text", + "text": "Page context services for the SharePoint Framework" + } + ], + "remarks": [ + { + "kind": "text", + "text": "The page context allows an application and its web parts to share common data about the current page, such as its contents, URL, list, user, permissions, navigation menu, etc." + } + ], + "exports": { + "CultureInfo": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class is primarily used with the PageContext class. It provides culture info for the current user of the application." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CultureInfo class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "currentCultureName": { + "kind": "property", + "signature": "readonly currentCultureName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This property may be an empty string, but it will never be undefined." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: If the currentCultureName is \"en-AU\" then the application could use this information to display the date as 1/8 instead of 8/1." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "currentUICultureName": { + "kind": "property", + "signature": "readonly currentUICultureName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This string determines the default user interface language. This used for localization and translation of text." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This property may have an empty string, but will never be undefined." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: If the currentUICultureName is \"es-MX\", then the application could use this information to translate the word \"hello\" to \"hola\"." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isRightToLeft": { + "kind": "property", + "signature": "readonly isRightToLeft: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This boolean represents the dominant direction of written text for the default user interface language." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPSystemTime": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface that represents a SPSystemTime structure." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "Day": { + "kind": "property", + "signature": "Day: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "DayOfWeek": { + "kind": "property", + "signature": "DayOfWeek: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Hour": { + "kind": "property", + "signature": "Hour: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Milliseconds": { + "kind": "property", + "signature": "Milliseconds: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Minute": { + "kind": "property", + "signature": "Minute: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Month": { + "kind": "property", + "signature": "Month: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Second": { + "kind": "property", + "signature": "Second: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "Year": { + "kind": "property", + "signature": "Year: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISPTimeZoneData": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface that represents the data neccesary to build an TimeZone object." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "daylightDate": { + "kind": "property", + "signature": "daylightDate: ISPSystemTime;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ISPSystemTime", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "daylightOffset": { + "kind": "property", + "signature": "daylightOffset: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "description: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "id: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "offset": { + "kind": "property", + "signature": "offset: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "standardDate": { + "kind": "property", + "signature": "standardDate: ISPSystemTime;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ISPSystemTime", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "standardOffset": { + "kind": "property", + "signature": "standardOffset: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "PageContext": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PageContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-page-context", + "exportName": "PageContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "aadInfo": { + "kind": "property", + "signature": "readonly aadInfo: AzureActiveDirectoryInfo | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "AzureActiveDirectoryInfo | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "cultureInfo": { + "kind": "property", + "signature": "readonly cultureInfo: CultureInfo;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "CultureInfo", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "It provides culture info for the current user of the application. This class is primarily used with the PageContext class." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isInitialized": { + "kind": "property", + "signature": "readonly isInitialized: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns whether the PageContext has been initialized." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "legacyPageContext": { + "kind": "property", + "signature": "readonly legacyPageContext: any;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An object providing classic SharePoint properties that may be required by certain legacy scripts." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the _spPageContextInfo window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NOTE: If certain functionality is exposed in the legacyPageContext but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the legacyPageContext object." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "list": { + "kind": "property", + "signature": "readonly list: SPList | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPList | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listItem": { + "kind": "property", + "signature": "readonly listItem: SPListItem | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPListItem | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for PageContext." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "site": { + "kind": "property", + "signature": "readonly site: SPSite;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPSite", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information for the SharePoint site collection (\"site\") that is hosting the page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "user": { + "kind": "property", + "signature": "readonly user: SPUser;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPUser", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the PageContext class." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "web": { + "kind": "property", + "signature": "readonly web: SPWeb;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPWeb", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information for the SharePoint site (\"web\") that is hosting the page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPDayOfWeek": { + "kind": "enum", + "values": { + "Friday": { + "kind": "enum value", + "value": "5", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + }, + "Monday": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + }, + "Saturday": { + "kind": "enum value", + "value": "6", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + }, + "Sunday": { + "kind": "enum value", + "value": "0", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + }, + "Thursday": { + "kind": "enum value", + "value": "4", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + }, + "Tuesday": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + }, + "Wednesday": { + "kind": "enum value", + "value": "3", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": true + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The enum members represent the seven days of a week." + } + ], + "remarks": [], + "isBeta": true + }, + "SPField": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The client-side equivalent for SharePoint SPField class. Used in Fields property of SPList and SPListItem classes. A field represents the data model for a column in SharePoint list view." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPField class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "clientSideComponentId": { + "kind": "property", + "signature": "readonly clientSideComponentId: Guid | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the client-side component associated with the field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "clientSideComponentProperties": { + "kind": "property", + "signature": "readonly clientSideComponentProperties: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "displayName": { + "kind": "property", + "signature": "readonly displayName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The display name of the field. This name is shown as column name in UI." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fieldType": { + "kind": "property", + "signature": "readonly fieldType: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The type of the field represented as a string" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "readonly id: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The GUID identifier for this field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "internalName": { + "kind": "property", + "signature": "readonly internalName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The internal name of the field. This name is usually used to find the field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isRequired": { + "kind": "property", + "signature": "readonly isRequired: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the field is required for each list item in the list" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPList": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list that hosts the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPList class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "id": { + "kind": "property", + "signature": "readonly id: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "permissions": { + "kind": "property", + "signature": "readonly permissions: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serverRelativeUrl": { + "kind": "property", + "signature": "readonly serverRelativeUrl: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the server-relative URL for this SPList." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"/sites/PubSite\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "title": { + "kind": "property", + "signature": "readonly title: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the title for this SPList." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPListItem": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list item that hosts the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPListItem class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "id": { + "kind": "property", + "signature": "readonly id: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The number that identifies the SPListItem on the server." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPPermission": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Used to test whether the current user has a requested set of permissions." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Specifies the built-in permissions available in SharePoint Foundation" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information, see: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(value: IODataBasePermission);", + "parameters": { + "value": { + "name": "value", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IODataBasePermission" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "SPPermission" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-page-context", + "exportName": "SPPermission", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "addAndCustomizePages": { + "kind": "property", + "signature": "static readonly addAndCustomizePages: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "addDelPrivateWebParts": { + "kind": "property", + "signature": "static readonly addDelPrivateWebParts: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Add or remove personal web parts on a web part Page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "addListItems": { + "kind": "property", + "signature": "static readonly addListItems: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Add items to lists, add documents to document libraries, and add Web discussion comments." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "applyStyleSheets": { + "kind": "property", + "signature": "static readonly applyStyleSheets: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Apply a style sheet (.css file) to the Web site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "applyThemeAndBorder": { + "kind": "property", + "signature": "static readonly applyThemeAndBorder: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Apply a theme or borders to the entire Web site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "approveItems": { + "kind": "property", + "signature": "static readonly approveItems: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Approve a minor version of a list item or document." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "browseDirectories": { + "kind": "property", + "signature": "static readonly browseDirectories: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "browserUserInfo": { + "kind": "property", + "signature": "static readonly browserUserInfo: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View information about users of the Web site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "cancelCheckout": { + "kind": "property", + "signature": "static readonly cancelCheckout: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Discard or check in a document which is checked out to another user." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "createAlerts": { + "kind": "property", + "signature": "static readonly createAlerts: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create e-mail alerts." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "createGroups": { + "kind": "property", + "signature": "static readonly createGroups: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create a group of users that can be used anywhere within the site collection." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "createSSCSite": { + "kind": "property", + "signature": "static readonly createSSCSite: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create a Web site using Self-Service Site Creation." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "deleteListItems": { + "kind": "property", + "signature": "static readonly deleteListItems: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Delete items from a list, documents from a document library, and Web discussion comments in documents." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "deleteVersions": { + "kind": "property", + "signature": "static readonly deleteVersions: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Delete past versions of a list item or document." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "editListItems": { + "kind": "property", + "signature": "static readonly editListItems: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "editMyUserInfo": { + "kind": "property", + "signature": "static readonly editMyUserInfo: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Allows a user to change his or her user information, such as adding a picture." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "emptyMask": { + "kind": "property", + "signature": "static readonly emptyMask: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Has no permissions on the Web site. Not available through the user interface." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "enumeratePermissions": { + "kind": "property", + "signature": "static readonly enumeratePermissions: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Enumerate permissions on the Web site, list, folder, document, or list item." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fullMask": { + "kind": "property", + "signature": "static readonly fullMask: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Has all permissions on the Web site. Not available through the user interface." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "hasAllPermissions": { + "kind": "method", + "signature": "hasAllPermissions(...requestedPerms: SPPermission[]): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": { + "requestedPerms": { + "name": "requestedPerms", + "description": [ + { + "kind": "text", + "text": "Any number of SPPermission objects to be compared against the original" + } + ], + "isOptional": false, + "isSpread": true, + "type": "SPPermission[]" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Function for testing whether a given permission mask has all of the requested permissions." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "hasAnyPermissions": { + "kind": "method", + "signature": "hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": { + "requestedPerms": { + "name": "requestedPerms", + "description": [ + { + "kind": "text", + "text": "Any number of SPPermission objects to be compared against the original" + } + ], + "isOptional": false, + "isSpread": true, + "type": "SPPermission[]" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Function for testing whether a given permission mask has any of the requested permissions." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "hasPermission": { + "kind": "method", + "signature": "hasPermission(requestedPerm: SPPermission): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": { + "requestedPerm": { + "name": "requestedPerm", + "description": [ + { + "kind": "text", + "text": "The SPPermission object to be compared against the original" + } + ], + "isOptional": false, + "isSpread": false, + "type": "SPPermission" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Function for testing whether a given permission mask has the requested permission." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "layoutsPage": { + "kind": "property", + "signature": "static readonly layoutsPage: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View the layouts page?" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manageAlerts": { + "kind": "property", + "signature": "static readonly manageAlerts: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Manage alerts for all users of the Web site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manageLists": { + "kind": "property", + "signature": "static readonly manageLists: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create and delete lists, add or remove columns in a list, and add or remove public views of a list." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "managePermissions": { + "kind": "property", + "signature": "static readonly managePermissions: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create and change permission levels on the Web site and assign permissions to users and groups." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "managePersonalViews": { + "kind": "property", + "signature": "static readonly managePersonalViews: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create, change, and delete personal views of lists." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manageSubwebs": { + "kind": "property", + "signature": "static readonly manageSubwebs: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manageWeb": { + "kind": "property", + "signature": "static readonly manageWeb: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Grant the ability to perform all administration tasks for the Web site as well as manage content." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "open": { + "kind": "property", + "signature": "static readonly open: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Allow users to open a Web site, list, or folder to access items inside that container." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "openItems": { + "kind": "property", + "signature": "static readonly openItems: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View the source of documents with server-side file handlers." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "updatePersonalWebParts": { + "kind": "property", + "signature": "static readonly updatePersonalWebParts: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Update web parts to display personalized information." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "useClientIntegration": { + "kind": "property", + "signature": "static readonly useClientIntegration: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use features that launch client applications; otherwise, users must work on documents locally and upload changes." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "useRemoteAPIs": { + "kind": "property", + "signature": "static readonly useRemoteAPIs: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "value": { + "kind": "property", + "signature": "readonly value: IODataBasePermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IODataBasePermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the value of this SPPermission object" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "viewFormPages": { + "kind": "property", + "signature": "static readonly viewFormPages: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View forms, views, and application pages, and enumerate lists." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "viewListItems": { + "kind": "property", + "signature": "static readonly viewListItems: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View items in lists, documents in document libraries, and view Web discussion comments." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "viewPages": { + "kind": "property", + "signature": "static readonly viewPages: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View pages in a Web site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "viewUsageData": { + "kind": "property", + "signature": "static readonly viewUsageData: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View reports on Web site usage." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "viewVersions": { + "kind": "property", + "signature": "static readonly viewVersions: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "View past versions of a list item or document." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPSite": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site collection (\"site\") that hosts the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPSite class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "absoluteUrl": { + "kind": "property", + "signature": "readonly absoluteUrl: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the absolute URL for this SPSite." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"https://example.com/sites/PubSite\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "cdnPrefix": { + "kind": "property", + "signature": "readonly cdnPrefix: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the prefix of the application's specified cdn or an empty string if there isn't one." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "classification": { + "kind": "property", + "signature": "readonly classification: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the classification of the site." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "correlationId": { + "kind": "property", + "signature": "readonly correlationId: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the correlation id to the current server request." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "group": { + "kind": "property", + "signature": "readonly group: O365GroupAssociation | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "O365GroupAssociation | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "readonly id: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The GUID that identifies the SPSite on the server." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isNoScriptEnabled": { + "kind": "property", + "signature": "readonly isNoScriptEnabled: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if isNoScript has been enabled on the SPSite." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "recycleBinItemCount": { + "kind": "property", + "signature": "readonly recycleBinItemCount: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The amount of items in the recycle bin." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serverRelativeUrl": { + "kind": "property", + "signature": "readonly serverRelativeUrl: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the server-relative URL for this SPSite." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"/sites/PubSite\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serverRequestPath": { + "kind": "property", + "signature": "readonly serverRequestPath: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns serverRelativeUrl of the original request." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"/teams/SPClientTest/SitePages/Home.aspx\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "sitePagesEnabled": { + "kind": "property", + "signature": "readonly sitePagesEnabled: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if SitePages are enabled on this SPSite." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPTimeZone": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)" + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPTimeZone class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": true, + "isSealed": false, + "members": { + "daylightDate": { + "kind": "property", + "signature": "readonly daylightDate: ISPSystemTime;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ISPSystemTime", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the date on which daylight time begins for the time zone." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "daylightOffset": { + "kind": "property", + "signature": "readonly daylightOffset: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC)." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "readonly description: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the description for the time zone." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "readonly id: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the ID of the time zone." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "offset": { + "kind": "property", + "signature": "readonly offset: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC)." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "standardDate": { + "kind": "property", + "signature": "readonly standardDate: ISPSystemTime;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ISPSystemTime", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the date on which standard time begins for the time zone." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "standardOffset": { + "kind": "property", + "signature": "readonly standardOffset: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC)." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPUser": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint user that is accessing the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPUser class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "displayName": { + "kind": "property", + "signature": "readonly displayName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The display name for the current user." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"John Doe\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "email": { + "kind": "property", + "signature": "readonly email: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The email address for the current user." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"example@contoso.com\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "firstDayOfWeek": { + "kind": "property", + "signature": "readonly firstDayOfWeek: SPDayOfWeek | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPDayOfWeek | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the user's regional first day of week setting or undefined if it hasn't been set." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isAnonymousGuestUser": { + "kind": "property", + "signature": "readonly isAnonymousGuestUser: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns if the current user is an anonymous guest." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isExternalGuestUser": { + "kind": "property", + "signature": "readonly isExternalGuestUser: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the current user is an external guest." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "loginName": { + "kind": "property", + "signature": "readonly loginName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The login name for current user." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: on-premise user: \"domain\\user\", online user: \"user@domain.com\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "preferUserTimeZone": { + "kind": "property", + "signature": "readonly preferUserTimeZone: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This boolean represents if a the user or web's time zone settings should be used to display the current time." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "timeZoneInfo": { + "kind": "property", + "signature": "readonly timeZoneInfo: SPTimeZone | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPTimeZone | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the user's regional timezone settings or undefined if they haven't been set." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "SPWeb": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site (\"web\") that hosts the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPWeb class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "absoluteUrl": { + "kind": "property", + "signature": "readonly absoluteUrl: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the absolute URL for this SPWeb. Example: \"https://example.com/sites/PubSite/SubWeb\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "readonly description: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the description of the current SPWeb." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "firstDayOfWeek": { + "kind": "property", + "signature": "readonly firstDayOfWeek: SPDayOfWeek | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPDayOfWeek | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the web's regional first day of week setting or undefined if it hasn't been set." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "readonly id: Guid;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The GUID that identifies the SPWeb on the server." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isAppWeb": { + "kind": "property", + "signature": "readonly isAppWeb: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if this SPWeb the container web for an SPApp." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "language": { + "kind": "property", + "signature": "readonly language: number;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the locale identifier (LCID) for the default language of the website." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: 1033 represents the locale identifier for en-US." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "logoUrl": { + "kind": "property", + "signature": "readonly logoUrl: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the absolute URL of the website logo." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: https://example.com/sites/PubSite/SubWeb/logo.jpg" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "permissions": { + "kind": "property", + "signature": "readonly permissions: SPPermission;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPPermission", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serverRelativeUrl": { + "kind": "property", + "signature": "readonly serverRelativeUrl: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the server-relative URL for this SPWeb." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"/sites/PubSite/SubWeb\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "templateName": { + "kind": "property", + "signature": "readonly templateName: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the string representing the numeric identifier for the site definition or site template that was used to create the site." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: \"1\" represents the team site template when creating a new site on SharePoint." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "timeZoneInfo": { + "kind": "property", + "signature": "readonly timeZoneInfo: SPTimeZone | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPTimeZone | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the web's regional timezone settings or undefined if they haven't been set." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "title": { + "kind": "property", + "signature": "readonly title: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the title of the current SPWeb." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + } + } +} diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index 0df9af61..b3c55c0a 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -1,6245 +1,6707 @@ -{ - "kind": "package", - "name": "@microsoft/sp-webpart-base", - "summary": [ - { - "kind": "text", - "text": "SharePoint Framework support for building web parts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual object that a page author can add to their content, and customize using a property pane. Examples of web parts include an embedded video player, a map, a group calendar, a chart, etc." - } - ], - "exports": { - "BaseClientSideWebPart": { - "kind": "class", - "extends": "BaseComponent", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This abstract class implements the the base functionality for a client side web part. Every client side web part needs to inherit from this class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in two catagories." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API should be used to access contextual data relevant to this web part instance." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor();", - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructor for the BaseClientSideWebPart class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "e.g. constructor() { super(); . . class specific constructor code .. }" - } - ] - }, - "accessibleTitle": { - "kind": "property", - "signature": "protected accessibleTitle: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "canOpenPopupOnRender": { - "kind": "property", - "signature": "protected readonly canOpenPopupOnRender: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property indicates whether a web part can open a popup on initial render." - } - ], - "remarks": [ - { - "kind": "text", - "text": "In some environments the host re-renders the web parts frequently, and therefor, opening popups during render will cause popups to open repeatedly and hence poor user experience. As an example, the classic SharePoint pages perform postbacks and hence page re-render on all button clicks. If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clearError": { - "kind": "method", - "signature": "protected clearError(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to clear the error message from the web part display area." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "context": { - "kind": "property", - "signature": "protected readonly context: WebPartContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "WebPartContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dataVersion": { - "kind": "property", - "signature": "protected readonly dataVersion: Version;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Version", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "description": { - "kind": "property", - "signature": "protected readonly description: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Description of the WebPart" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disableReactivePropertyChanges": { - "kind": "property", - "signature": "protected readonly disableReactivePropertyChanges: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default behavior is Reactive." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can see instant updates. This helps the page creator get instant feedback and decide if they should keep the new configuration changes or not." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "NonReactive implies that the configuration changes are transmitted to the web part only after \"Apply\" PropertyPane button is clicked." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "displayMode": { - "kind": "property", - "signature": "protected readonly displayMode: DisplayMode;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "DisplayMode", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is the current display mode of the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "domElement": { - "kind": "property", - "signature": "protected readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getPropertyPaneConfiguration": { - "kind": "method", - "signature": "protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IPropertyPaneConfiguration", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the configuration for the PropertyPane." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This API is not invoked until the 'loadPropertyPaneResources' promise is resolved." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "See IPropertyPane and other PropertyPane integration wiki documentation for more details." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isRenderAsync": { - "kind": "property", - "signature": "protected readonly isRenderAsync: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the web part is rendering in Async mode. Default value is false. If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onAfterDeserialize": { - "kind": "method", - "signature": "protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "TProperties", - "description": [ - { - "kind": "text", - "text": "The property bag of the web part" - } - ] - }, - "parameters": { - "deserializedObject": { - "name": "deserializedObject", - "description": [ - { - "kind": "text", - "text": "The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the web part" - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "dataVersion": { - "name": "dataVersion", - "description": [ - { - "kind": "text", - "text": "The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older web part. Web parts can define their data version by overriding the dataVersion property." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is called after the web part is deserialized to an object, right before the property bag is populated." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default implementation is a no-op. A web part developer can override this API if the deserialized object does not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate the property bag right after the data is deserialized to an object." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use onAfterDeserialize to check the dataVersion and fix the property bag." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onAfterPropertyPaneChangesApplied": { - "kind": "method", - "signature": "protected onAfterPropertyPaneChangesApplied(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onBeforeSerialize": { - "kind": "method", - "signature": "protected onBeforeSerialize(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called before the web part is serialized." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default implementation is a no-op. The serialization process serializes the web part property bag i.e. this.properties. This API gives the web part a chance to update it's property bag before the serialization happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDisplayModeChanged": { - "kind": "method", - "signature": "protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "oldDisplayMode": { - "name": "oldDisplayMode", - "description": [ - { - "kind": "text", - "text": "The old display mode." - } - ], - "isOptional": false, - "isSpread": false, - "type": "DisplayMode" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called when the display mode of a web part is changed." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDispose": { - "kind": "method", - "signature": "protected onDispose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to refresh the contents of the PropertyPane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onInit": { - "kind": "method", - "signature": "protected onInit(): Promise;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneConfigurationComplete": { - "kind": "method", - "signature": "protected onPropertyPaneConfigurationComplete(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is invoked when the configuration is completed on the PropertyPane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This event method is invoked in the following cases:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- When the CONFIGURATION_COMPLETE_TIMEOUT((currently the value is 5 secs) elapses after the last change." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- When user clicks 'x'(close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- When user clciks 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- When the user switches web parts then the current web part gets this event." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneConfigurationStart": { - "kind": "method", - "signature": "protected onPropertyPaneConfigurationStart(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is invoked when the configuration starts on the PropertyPane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This event method is invoked in the following cases:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- When the PropertyPane is opened." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- When the user switches web parts then the new web part gets this event." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneFieldChanged": { - "kind": "method", - "signature": "protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "propertyPath": { - "name": "propertyPath", - "description": [ - { - "kind": "text", - "text": "JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of '__CustomField_'." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "oldValue": { - "name": "oldValue", - "description": [ - { - "kind": "text", - "text": "Old value of the property. This value could be undefined/empty in the case of custom field." - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "newValue": { - "name": "newValue", - "description": [ - { - "kind": "text", - "text": "New value of the property. This value could be undefined/empty in the case of custom field." - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneRendered": { - "kind": "method", - "signature": "protected onPropertyPaneRendered(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is invoked when the PropertyPane is rendered." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "previewImageUrl": { - "kind": "property", - "signature": "protected previewImageUrl: string | undefined;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property points to the preview image for the web part. The base implementation returns undefined. Web parts that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "properties": { - "kind": "property", - "signature": "protected readonly properties: TProperties;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "TProperties", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is the pointer to the custom property bag of the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "propertiesMetadata": { - "kind": "property", - "signature": "protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IWebPartPropertiesMetadata | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data." - } - ], - "remarks": [ - { - "kind": "text", - "text": "See IWebPartPropertiesMetadata for more information about how to define metadata" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "propertyPaneRenderedByWebPart": { - "kind": "property", - "signature": "protected propertyPaneRenderedByWebPart: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "render": { - "kind": "method", - "signature": "protected abstract render(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderCompleted": { - "kind": "method", - "signature": "protected renderCompleted(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the render() API but the actual rendering is complete only after the iframe loading completes." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderedFromPersistedData": { - "kind": "property", - "signature": "protected readonly renderedFromPersistedData: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: When web part is added for the first time using toolbox then the value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderedOnce": { - "kind": "property", - "signature": "protected readonly renderedOnce: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true. Till a full re-render of the web part happens." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderError": { - "kind": "method", - "signature": "protected renderError(error: Error): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "error": { - "name": "error", - "description": [ - { - "kind": "text", - "text": "An error object containing the error message to render." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Error" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "title": { - "kind": "property", - "signature": "protected readonly title: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Title of the WebPart" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IClientSideWebPartStatusRenderer": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Interface to be implemented by a component that should display the loading indicator and error messages for a web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "clearError": { - "kind": "method", - "signature": "clearError(domElement: HTMLElement): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "HTMLElement" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Clear the webpart error message." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clearLoadingIndicator": { - "kind": "method", - "signature": "clearLoadingIndicator(domElement: Element): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Element" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Clear the loading indicator." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "displayLoadingIndicator": { - "kind": "method", - "signature": "displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the webpart container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Element" - }, - "loadingMessage": { - "name": "loadingMessage", - "description": [ - { - "kind": "text", - "text": "the message to be displayed when the loading spinner id displayed." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "timeout": { - "name": "timeout", - "description": [ - { - "kind": "text", - "text": "timeout to render the loading indicator. Default is 900ms." - } - ], - "isOptional": true, - "isSpread": false, - "type": "number" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display a loading spinner." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderError": { - "kind": "method", - "signature": "renderError(domElement: HTMLElement, error: Error | string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "HTMLElement" - }, - "error": { - "name": "error", - "description": [ - { - "kind": "text", - "text": "the error message." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Error | string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render the provided error message in the webpart container div." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPlaceholderSpinnerProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Interface for properties used to display the loading spinner in the web part display area." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "hideSpinner": { - "kind": "property", - "signature": "hideSpinner?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label associated with the spinner." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneAccessor": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "isPropertyPaneOpen": { - "kind": "method", - "signature": "isPropertyPaneOpen(): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the PropertyPane is open." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isRenderedByWebPart": { - "kind": "method", - "signature": "isRenderedByWebPart(): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the PropertyPane was initially opened by the web part." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "open": { - "kind": "method", - "signature": "open(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to open the PropertyPane to help configure the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "refresh": { - "kind": "method", - "signature": "refresh(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to invoke the PropertyPane to help configure the web part." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneButtonProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane button props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaDescription": { - "kind": "property", - "signature": "ariaDescription?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Detailed description of the button for the benefit of screen readers." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Besides the compound button, other button types will need more information provided to screen reader." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The aria label of the button for the benefit of screen readers." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "buttonType": { - "kind": "property", - "signature": "buttonType?: PropertyPaneButtonType;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "PropertyPaneButtonType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The type of button to render. Default value is ButtonType.normal." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Description of the action this button takes. Only used for compound buttons." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the button is disabled." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "icon": { - "kind": "property", - "signature": "icon?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The button icon shown in command or hero type." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onClick": { - "kind": "property", - "signature": "onClick: (value: any) => any;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "(value: any) => any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display text of the element." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneCheckboxProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane CheckBox component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "checked": { - "kind": "property", - "signature": "checked?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane checkbox is checked or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane checkbox is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "property", - "signature": "text?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label to display next to the checkbox." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneChoiceGroupOption": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup option props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "checked": { - "kind": "property", - "signature": "checked?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane choice group option is checked or not." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Default value is false." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane choice group option is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "iconProps": { - "kind": "property", - "signature": "iconProps?: IPropertyPaneChoiceGroupOptionIconProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneChoiceGroupOptionIconProps", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Icon component props for choice field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "imageSize": { - "kind": "property", - "signature": "imageSize?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n width: number;\n height: number;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The width and height of the image in px for choice field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "imageSrc": { - "kind": "property", - "signature": "imageSrc?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The src of image for choice field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "key": { - "kind": "property", - "signature": "key: string | number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A required key to uniquely identify the option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "selectedImageSrc": { - "kind": "property", - "signature": "selectedImageSrc?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The src of image for choice field which is selected." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The text string for the option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneChoiceGroupOptionIconProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup icon props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "officeFabricIconFontName": { - "kind": "property", - "signature": "officeFabricIconFontName?: string | null;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string | null", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The name of the icon to use from the Office Fabric icon set." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneChoiceGroupProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Descriptive label for the choice group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "options": { - "kind": "property", - "signature": "options: IPropertyPaneChoiceGroupOption[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneChoiceGroupOption[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The options for the choice group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part configuration settings" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "currentPage": { - "kind": "property", - "signature": "currentPage?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Page to be displayed on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "loadingIndicatorDelayTime": { - "kind": "property", - "signature": "loadingIndicatorDelayTime?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Number of milliseconds to be delayed before the loading indicator is shown on the property pane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is 500." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "pages": { - "kind": "property", - "signature": "pages: IPropertyPanePage[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPanePage[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Total number of pages on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "showLoadingIndicator": { - "kind": "property", - "signature": "showLoadingIndicator?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the loading indicator should be displayed on top of the property pane or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator property)." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneCustomFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane CustomPropertyField props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "context?: any;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "key": { - "kind": "property", - "signature": "key: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An UNIQUE key indicates the identity of this contorl." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how to pick the value of the key." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information, see the " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "React documentation" - } - ], - "targetUrl": "https://facebook.github.io/react/docs/lists-and-keys.html#keys" - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDispose": { - "kind": "property", - "signature": "onDispose?: (domElement: HTMLElement, context?: any) => void;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(domElement: HTMLElement, context?: any) => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is called when the component is unmounted from the host element." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onRender": { - "kind": "property", - "signature": "onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "(domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API will be called once the custom field is mounted on the host element." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneDropdownCalloutProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane dropdown callout properties." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "calloutMaxHeight": { - "kind": "property", - "signature": "calloutMaxHeight?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Set max height of callout When not set the callout will expand with contents up to the bottom of the screen" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneDropdownOption": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane drop down options." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "index": { - "kind": "property", - "signature": "index?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Index for this option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "key": { - "kind": "property", - "signature": "key: string | number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key to uniquely identify this option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Text to render for this option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "type": { - "kind": "property", - "signature": "type?: PropertyPaneDropdownOptionType;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "PropertyPaneDropdownOptionType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneDropdownProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane drop down component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A description of the dropdown for the benefit of screen reader users." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ariaPositionInSet": { - "kind": "property", - "signature": "ariaPositionInSet?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "ariaSetSize": { - "kind": "property", - "signature": "ariaSetSize?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Defines the number of items in the current set of controls. Maps to native aria-setsize attribute." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "calloutProps": { - "kind": "property", - "signature": "calloutProps?: IPropertyPaneDropdownCalloutProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneDropdownCalloutProps", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom properties for Dropdown's Callout used to render options." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane dropdown option is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Descriptive label for the Dropdown." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "options": { - "kind": "property", - "signature": "options?: IPropertyPaneDropdownOption[];", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneDropdownOption[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Collection of options for this Dropdown." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "selectedKey": { - "kind": "property", - "signature": "selectedKey?: string | number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The key of the initially selected option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneDynamicTextFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneDynamicData component props." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Aria Label for text field, if any." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The text field input description." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane text field is enabled or not." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "errorMessage": { - "kind": "property", - "signature": "errorMessage?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If set, this will be displayed as an error message." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "So, make sure to set this only if you want to see an error message displayed for the text field." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label for the text field." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onGetErrorMessage": { - "kind": "property", - "signature": "onGetErrorMessage?: (value: string) => string | Promise;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(value: string) => string | Promise", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The method is used to get the validation error message and determine whether the input value is valid or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When it returns string:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- If valid, it returns empty string." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When it returns Promise:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- The resolved value is display as error message." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- The rejected, the value is thrown away." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "placeholder": { - "kind": "property", - "signature": "placeholder?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "placeholder text to be displayed in the text field." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "validateOnFocusIn": { - "kind": "property", - "signature": "validateOnFocusIn?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is focused." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "validateOnFocusOut": { - "kind": "property", - "signature": "validateOnFocusOut?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "value": { - "kind": "property", - "signature": "value?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneField": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "properties": { - "kind": "property", - "signature": "properties: TProperties;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "TProperties", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Strongly typed properties object. Specific to each field type." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: Checkbox has ICheckboxProps, TextField has ITextField props." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "shouldFocus": { - "kind": "property", - "signature": "shouldFocus?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether this control should be focused." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "targetProperty": { - "kind": "property", - "signature": "targetProperty: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Target property from the web part's property bag." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "type": { - "kind": "property", - "signature": "type: PropertyPaneFieldType;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "PropertyPaneFieldType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Type of the PropertyPane field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneGroup": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane group. Group is part of the PropertyPanePage." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "groupFields": { - "kind": "property", - "signature": "groupFields: IPropertyPaneField[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneField[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "List of PropertyPane fields." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "groupName": { - "kind": "property", - "signature": "groupName?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display name for the group." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For performance reasons, it's highly recommended to keep this name unique within the property pane page." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isCollapsed": { - "kind": "property", - "signature": "isCollapsed?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the PropertyPane group is collapsed or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneLabelProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneLabel component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "required": { - "kind": "property", - "signature": "required?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the associated form field is required or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If true, a red asterisk is displayed to the right of the label. Default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display text fot the label." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneLinkProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneLink component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane link is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "href": { - "kind": "property", - "signature": "href: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Location to which the link is targeted to." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "popupWindowProps": { - "kind": "property", - "signature": "popupWindowProps?: IPopupWindowProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPopupWindowProps", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The props of pop up window." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "target": { - "kind": "property", - "signature": "target?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This attribute specifies where to display the linked resource." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Following values can be used:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "_self - (default) Load the response in the current page." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "_blank - Load the response into a new unnamed tab." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same as \"_self\"" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "_top - Load the response into the original window." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display text for the link." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPanePage": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPanePage interface." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "displayGroupsAsAccordion": { - "kind": "property", - "signature": "displayGroupsAsAccordion?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the groups on the PropertyPanePage are displayed as accordion or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "groups": { - "kind": "property", - "signature": "groups: IPropertyPaneGroup[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneGroup[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "List of groups to be displayed on the PropertyPane page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "header": { - "kind": "property", - "signature": "header?: IPropertyPanePageHeader;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPanePageHeader", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane page header." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPanePageHeader": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane header. This header remains same for all the pages." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "description": { - "kind": "property", - "signature": "description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Header to display." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "image": { - "kind": "property", - "signature": "image?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Image url for the background image." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneSliderProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneSliderProps component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A description of the Slider for the benefit of screen readers." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the Slider is disabled." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Description label of the Slider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "max": { - "kind": "property", - "signature": "max: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The max value of the Slider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "min": { - "kind": "property", - "signature": "min: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The min value of the Slider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "showValue": { - "kind": "property", - "signature": "showValue?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether to show the value on the right of the Slider." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If you want to show the value by yourself, you may want to set this value to false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "step": { - "kind": "property", - "signature": "step?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The difference between the two adjacent values of the Slider. Defaults to 1." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "value": { - "kind": "property", - "signature": "value?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Defaults to min." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneTextFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneTextField component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Aria Label for text field, if any." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "deferredValidationTime": { - "kind": "property", - "signature": "deferredValidationTime?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is 200." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The text field input description." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane text field is enabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "errorMessage": { - "kind": "property", - "signature": "errorMessage?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If set, this will be displayed as an error message." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "So, make sure to set this only if you want to see an error message displayed for the text field." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label for the text field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "logName": { - "kind": "property", - "signature": "logName?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n moduleName: string;\n controlName: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Engagement name to log PropertyPaneTextField value change." - } - ], - "remarks": [ - { - "kind": "text", - "text": "It will be logged format as .. E.g. {moduleName: 'ImageWebPart', controlName: 'OverlayText'}, it will log: 1. action type, including 'Add', 'Clear' and 'Edit'. Clear: reset the content of caption element to initial/unset state. Add: change from initial/unset state to customized content. (first edit) Edit: any edition that changes the content apart from add and clear 2. text length after each edit." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "maxLength": { - "kind": "property", - "signature": "maxLength?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Maximum number of characters that the PropertyPaneTextField can have." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the value is set to a negative number, an exception will be thrown." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "multiline": { - "kind": "property", - "signature": "multiline?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the text field is a multiline text field." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onGetErrorMessage": { - "kind": "property", - "signature": "onGetErrorMessage?: (value: string) => string | Promise;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(value: string) => string | Promise", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The method is used to get the validation error message and determine whether the input value is valid or not." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When it returns string:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- If valid, it returns empty string." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When it returns Promise:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- The resolved value is display as error message." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- The rejected, the value is thrown away." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "placeholder": { - "kind": "property", - "signature": "placeholder?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "placeholder text to be displayed in the text field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "resizable": { - "kind": "property", - "signature": "resizable?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the multiline text field is resizable." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is true." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "rows": { - "kind": "property", - "signature": "rows?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Specifies the visible height of a text area(multiline text TextField), in lines." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This prop is used only when the multiline prop is set to true." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "underlined": { - "kind": "property", - "signature": "underlined?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the text field is underlined." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "validateOnFocusIn": { - "kind": "property", - "signature": "validateOnFocusIn?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is focused." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "validateOnFocusOut": { - "kind": "property", - "signature": "validateOnFocusOut?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "value": { - "kind": "property", - "signature": "value?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneToggleProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneToggle component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "checked": { - "kind": "property", - "signature": "checked?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Checked state of the toggle." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If you are maintaining state yourself, use this property." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional disabled flag." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "key": { - "kind": "property", - "signature": "key?: string | number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key to uniquely identify the field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A label for the toggle." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "offAriaLabel": { - "kind": "property", - "signature": "offAriaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "offText": { - "kind": "property", - "signature": "offText?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Test display when toggle is OFF." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onAriaLabel": { - "kind": "property", - "signature": "onAriaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onText": { - "kind": "property", - "signature": "onText?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Text to display when toggle is ON." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISerializedServerProcessedData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contains collections of data that can be processed by server side services like search index and link fixup" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "htmlStrings": { - "kind": "property", - "signature": "htmlStrings?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are rich text with HTML format." - } - ], - "remarks": [ - { - "kind": "text", - "text": "SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: { 'myRichDescription': '
Some standard HTML contentA Link
' 'anotherRichText':
Some red text
}" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "imageSources": { - "kind": "property", - "signature": "imageSources?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are image sources." - } - ], - "remarks": [ - { - "kind": "text", - "text": "SharePoint servers treat the values as image sources and run services like search index and link fixup on them." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: { 'myImage1': 'http://res.contoso.com/path/to/file' 'myImage2': 'https://res.contoso.com/someName.jpg' }" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "links": { - "kind": "property", - "signature": "links?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are links." - } - ], - "remarks": [ - { - "kind": "text", - "text": "SharePoint servers treat the values as links and run services like link fixup on them." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: { 'myWebURL': 'http://contoso.com' 'myFileLink': 'https://res.contoso.com/file.docx' }" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "searchablePlainTexts": { - "kind": "property", - "signature": "searchablePlainTexts?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are strings that should be search indexed." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, but are not treated as valid HTML. So, other services such as link fixup will not run on them." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: { 'justSomeText': 'This is some plain text', 'anotherText': 'Can have characters here: \"<>&\\'' }" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ISerializedWebPartData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "dataVersion": { - "kind": "property", - "signature": "dataVersion: Version;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "Version", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part data version." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: Version Supported values: MAJOR.MINOR Example: \"1.0\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataPaths": { - "kind": "property", - "signature": "dynamicDataPaths?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataValues": { - "kind": "property", - "signature": "dynamicDataValues?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: any;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "properties": { - "kind": "property", - "signature": "properties?: any;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part specific properties. The individual web part owns the definition of these properties." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serverProcessedContent": { - "kind": "property", - "signature": "serverProcessedContent?: ISerializedServerProcessedData;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "ISerializedServerProcessedData", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The collections of data that can be processed by server side services like search index and link fixup." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IWebPartContext": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "The base context interface for client-side web parts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A \"context\" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Reference to the DOM element that hosts this client side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "graphHttpClient": { - "kind": "property", - "signature": "readonly graphHttpClient: GraphHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "GraphHttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "httpClient": { - "kind": "property", - "signature": "readonly httpClient: HttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "HttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Web part instance id. This is a globally unique value." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideWebPartManifestInstance;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartManifestInstance", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client side web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "pageContext": { - "kind": "property", - "signature": "readonly pageContext: PageContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PageContext", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "SharePoint page context." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "propertyPane": { - "kind": "property", - "signature": "readonly propertyPane: IPropertyPaneAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IPropertyPaneAccessor", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Accessor for common web part property pane operations." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "spHttpClient": { - "kind": "property", - "signature": "readonly spHttpClient: SPHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "SPHttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "statusRenderer": { - "kind": "property", - "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartStatusRenderer", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Web part status renderer." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "webPartTag": { - "kind": "property", - "signature": "readonly webPartTag: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Web part tag to be used for logging and telemetry." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IWebPartData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This structure represents the serialized state of a web part. When the serialize() API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "dataVersion": { - "kind": "property", - "signature": "dataVersion: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part data version" - } - ], - "remarks": [ - { - "kind": "text", - "text": "Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: string Supported values: MAJOR.MINOR Example: \"1.0\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part description" - } - ], - "remarks": [ - { - "kind": "text", - "text": "Usage: display the description of the web part. Required: no Type: string Supported values: string with the description. Example: \"Text\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataPaths": { - "kind": "property", - "signature": "dynamicDataPaths?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataValues": { - "kind": "property", - "signature": "dynamicDataValues?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: any;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Universally unique web part Type id." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Usage: uniquely identify a web part. Required: yes Type: GUID Supported values: any GUID Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "instanceId": { - "kind": "property", - "signature": "instanceId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries." - } - ], - "remarks": [ - { - "kind": "text", - "text": "how used: used by the framework to uniquely identify an instance of a web part. mandatory: yes type: string supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: [\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"] experimental: yes" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "properties": { - "kind": "property", - "signature": "properties?: any;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part specific properties. The individual web part owns the definition of these properties." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serverProcessedContent": { - "kind": "property", - "signature": "serverProcessedContent?: ISerializedServerProcessedData;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "ISerializedServerProcessedData", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Definition: The collections of data that can be processed by server side services like search index and link fixup Required: no" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "title": { - "kind": "property", - "signature": "title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part title" - } - ], - "remarks": [ - { - "kind": "text", - "text": "Usage: display the name of the web part in the toolbox, web part gallery and the page. Required: yes Type: string Supported values: string less than 100 characters Example: \"Text\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IWebPartPropertiesMetadata": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This structure is used to define metadata for web part properties as a map of string to IWebPartPropertyMetadata" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The key should be a JSON path to the property in web part properties. The JSON path supports the following operators:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Dot . for selecting object members e.g. person.name" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Brackets [] for selecting array items e.g. person.photoURLs[0]" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Bracketed asterisk [*] for array elements wildcard e.g. person.websites[*]." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "You can make combinations of these operators e.g. person.websites[*].url Important Note: Only one wildcard per path is supported." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: Let's assume we have a web part with properties that have the following schema: { title: string; person: { name: string; bio: string; photoURLs: string[]; websites: { title: string; url: string; }[] } }" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "We can define the metadata for the desired properties as following: { 'person.bio': { isRichContent: true }, 'person.photoURLs[*]': { isImageSource: true }, 'person.websites[*].url': { isLink: true } }" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__index": { - "kind": "method", - "signature": "[key: string]: IWebPartPropertyMetadata;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IWebPartPropertyMetadata", - "description": [] - }, - "parameters": { - "key": { - "name": "key", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "PropertyPaneButton": { - "kind": "function", - "signature": "export function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the Button is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Button properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneButtonProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Button on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneButtonType": { - "kind": "enum", - "values": { - "Command": { - "kind": "enum value", - "value": "4", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional actions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts." - } - ], - "isBeta": false - }, - "Compound": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Always used as a set with both Standard and Primary compound buttons." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form" - } - ], - "isBeta": false - }, - "Hero": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Hero button." - } - ], - "remarks": [], - "isBeta": false - }, - "Icon": { - "kind": "enum value", - "value": "5", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range." - } - ], - "isBeta": false - }, - "Normal": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional completion action." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo an action. Examples: \"Done\" button which closes a container but doesn't make a server call or an \"Undo\" button when a user is uploading a file in OneDrive." - } - ], - "isBeta": false - }, - "Primary": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Preferred completion action when paired with a Standard button." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Typically used at the end of a task or form. Examples: \"Create\", \"Save\", \"Send\" which makes a server call." - } - ], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enum for all the supported button types." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneCheckbox": { - "kind": "function", - "signature": "export function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the checkbox is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Checkbox properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneCheckboxProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Checkbox on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneChoiceGroup": { - "kind": "function", - "signature": "export function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the choice group is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Choice Group properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneChoiceGroupProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Choice Group on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneCustomField": { - "kind": "function", - "signature": "export function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Custom field properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneCustomFieldProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a custom field on the PropertyPane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap." - } - ], - "isBeta": true - }, - "PropertyPaneDropdown": { - "kind": "function", - "signature": "export function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the dropdown is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Dropdown properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneDropdownProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Dropdown on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneDropdownOptionType": { - "kind": "enum", - "values": { - "Divider": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render a divider." - } - ], - "remarks": [], - "isBeta": false - }, - "Header": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render menu item as a header." - } - ], - "remarks": [], - "isBeta": false - }, - "Normal": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render normal menu item." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Specifies the type of option in a dropdown menu rendered by " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "PropertyPaneDropdown" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "PropertyPaneDropdown", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneDynamicTextField": { - "kind": "function", - "signature": "export function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the dynamic textfield is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Properties of the PropertyPaneDynamicTextField." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneDynamicTextFieldProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Dynamic TextField on the PropertyPane." - } - ], - "remarks": [], - "isBeta": true - }, - "PropertyPaneFieldType": { - "kind": "enum", - "values": { - "Button": { - "kind": "enum value", - "value": "11", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Button field." - } - ], - "remarks": [], - "isBeta": false - }, - "CheckBox": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Checkbox field." - } - ], - "remarks": [], - "isBeta": false - }, - "ChoiceGroup": { - "kind": "enum value", - "value": "10", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Choice Group field." - } - ], - "remarks": [], - "isBeta": false - }, - "Custom": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom field." - } - ], - "remarks": [], - "isBeta": false - }, - "Dropdown": { - "kind": "enum value", - "value": "6", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Dropdown field." - } - ], - "remarks": [], - "isBeta": false - }, - "DynamicTextField": { - "kind": "enum value", - "value": "15", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Dynamic Text Field" - } - ], - "remarks": [], - "isBeta": true - }, - "Heading": { - "kind": "enum value", - "value": "9", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Heading field." - } - ], - "remarks": [], - "isBeta": false - }, - "HorizontalRule": { - "kind": "enum value", - "value": "12", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Horizontal Rule field." - } - ], - "remarks": [], - "isBeta": false - }, - "Label": { - "kind": "enum value", - "value": "7", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label field." - } - ], - "remarks": [], - "isBeta": false - }, - "Link": { - "kind": "enum value", - "value": "13", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Link field." - } - ], - "remarks": [], - "isBeta": false - }, - "Slider": { - "kind": "enum value", - "value": "8", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Slider field." - } - ], - "remarks": [], - "isBeta": false - }, - "TextField": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "TextField field." - } - ], - "remarks": [], - "isBeta": false - }, - "Toggle": { - "kind": "enum value", - "value": "5", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Toggle field." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enum for all the supported PropertyPane field types." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneHorizontalRule": { - "kind": "function", - "signature": "export function PropertyPaneHorizontalRule(): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Horizontal Rule on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneLabel": { - "kind": "function", - "signature": "export function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the label is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Label properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneLabelProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Label on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneLink": { - "kind": "function", - "signature": "export function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the Link is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Link properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneLinkProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Link on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneSlider": { - "kind": "function", - "signature": "export function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the slider is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Slider properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneSliderProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Slider on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneTextField": { - "kind": "function", - "signature": "export function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the textfield is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed TextField properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneTextFieldProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a TextField on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneToggle": { - "kind": "function", - "signature": "export function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the toggle is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Toggle properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneToggleProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Toggle on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "WebPartContext": { - "kind": "class", - "extends": "BaseComponentContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WebPartContext class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Reference to the DOM element that hosts this client side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideWebPartManifestInstance;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartManifestInstance", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "propertyPane": { - "kind": "property", - "signature": "readonly propertyPane: IPropertyPaneAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IPropertyPaneAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Accessor for common web part property pane operations." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "statusRenderer": { - "kind": "property", - "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartStatusRenderer", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part status renderer." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "webPartTag": { - "kind": "property", - "signature": "readonly webPartTag: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part tag to be used for logging and telemetry." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - } - } -} +{ + "kind": "package", + "name": "@microsoft/sp-webpart-base", + "summary": [ + { + "kind": "text", + "text": "SharePoint Framework support for building web parts." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual object that a page author can add to their content, and customize using a property pane. Examples of web parts include an embedded video player, a map, a group calendar, a chart, etc." + } + ], + "exports": { + "BaseClientSideWebPart": { + "kind": "class", + "extends": "BaseWebPart", + "implements": "", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This abstract class implements the the base functionality for a client side web part. Every client side web part needs to inherit from this class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in two catagories." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API should be used to access contextual data relevant to this web part instance." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor();", + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructor for the BaseClientSideWebPart class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "e.g. constructor() { super(); . . class specific constructor code .. }" + } + ] + }, + "canOpenPopupOnRender": { + "kind": "property", + "signature": "protected readonly canOpenPopupOnRender: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property indicates whether a web part can open a popup on initial render." + } + ], + "remarks": [ + { + "kind": "text", + "text": "In some environments the host re-renders the web parts frequently, and therefor, opening popups during render will cause popups to open repeatedly and hence poor user experience. As an example, the classic SharePoint pages perform postbacks and hence page re-render on all button clicks. If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "clearError": { + "kind": "method", + "signature": "protected clearError(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to clear the error message from the web part display area." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "context": { + "kind": "property", + "signature": "protected readonly context: WebPartContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "WebPartContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "domElement": { + "kind": "property", + "signature": "protected readonly domElement: HTMLElement;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HTMLElement", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isRenderAsync": { + "kind": "property", + "signature": "protected readonly isRenderAsync: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the web part is rendering in Async mode. Default value is false. If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onDisplayModeChanged": { + "kind": "method", + "signature": "protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "oldDisplayMode": { + "name": "oldDisplayMode", + "description": [ + { + "kind": "text", + "text": "The old display mode." + } + ], + "isOptional": false, + "isSpread": false, + "type": "DisplayMode" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is called when the display mode of a web part is changed." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onDispose": { + "kind": "method", + "signature": "protected onDispose(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to refresh the contents of the PropertyPane." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "render": { + "kind": "method", + "signature": "protected abstract render(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "renderCompleted": { + "kind": "method", + "signature": "protected renderCompleted(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the render() API but the actual rendering is complete only after the iframe loading completes." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "renderedFromPersistedData": { + "kind": "property", + "signature": "protected readonly renderedFromPersistedData: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: When web part is added for the first time using toolbox then the value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "renderedOnce": { + "kind": "property", + "signature": "protected readonly renderedOnce: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true. Till a full re-render of the web part happens." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "renderError": { + "kind": "method", + "signature": "protected renderError(error: Error): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "error": { + "name": "error", + "description": [ + { + "kind": "text", + "text": "An error object containing the error message to render." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Error" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "BaseWebPart": { + "kind": "class", + "extends": "BaseComponent", + "implements": "IPropertyPaneConsumer", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This abstract class implements the UI-agnostic base functionality for a client side web part. The purpose is to allow a common core between 2D and MR WebParts." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor();", + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructor for the BaseWebPart class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "e.g. constructor() { super(); . . class specific constructor code .. }" + } + ] + }, + "accessibleTitle": { + "kind": "property", + "signature": "protected readonly accessibleTitle: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "context": { + "kind": "property", + "signature": "protected readonly context: BaseWebPartContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "BaseWebPartContext", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Use the context object to access common services and state associated with the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dataVersion": { + "kind": "property", + "signature": "protected readonly dataVersion: Version;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Version", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "protected readonly description: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Description of the WebPart" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disableReactivePropertyChanges": { + "kind": "property", + "signature": "protected readonly disableReactivePropertyChanges: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default behavior is Reactive." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can see instant updates. This helps the page creator get instant feedback and decide if they should keep the new configuration changes or not." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NonReactive implies that the configuration changes are transmitted to the web part only after \"Apply\" PropertyPane button is clicked." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "displayMode": { + "kind": "property", + "signature": "protected readonly displayMode: DisplayMode;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "DisplayMode", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property is the current display mode of the web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "getPropertyPaneConfiguration": { + "kind": "method", + "signature": "protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IPropertyPaneConfiguration", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the configuration for the PropertyPane." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This API is not invoked until the 'loadPropertyPaneResources' promise is resolved." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "See IPropertyPane and other PropertyPane integration wiki documentation for more details." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onAfterDeserialize": { + "kind": "method", + "signature": "protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "TProperties", + "description": [ + { + "kind": "text", + "text": "The property bag of the web part" + } + ] + }, + "parameters": { + "deserializedObject": { + "name": "deserializedObject", + "description": [ + { + "kind": "text", + "text": "The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the web part" + } + ], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "dataVersion": { + "name": "dataVersion", + "description": [ + { + "kind": "text", + "text": "The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older web part. Web parts can define their data version by overriding the dataVersion property." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Version" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is called after the web part is deserialized to an object, right before the property bag is populated." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default implementation is a no-op. A web part developer can override this API if the deserialized object does not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate the property bag right after the data is deserialized to an object." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use onAfterDeserialize to check the dataVersion and fix the property bag." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onAfterPropertyPaneChangesApplied": { + "kind": "method", + "signature": "protected onAfterPropertyPaneChangesApplied(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onBeforeSerialize": { + "kind": "method", + "signature": "protected onBeforeSerialize(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is called before the web part is serialized." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default implementation is a no-op. The serialization process serializes the web part property bag i.e. this.properties. This API gives the web part a chance to update it's property bag before the serialization happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onDisplayModeChanged": { + "kind": "method", + "signature": "protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "oldDisplayMode": { + "name": "oldDisplayMode", + "description": [ + { + "kind": "text", + "text": "The old display mode." + } + ], + "isOptional": false, + "isSpread": false, + "type": "DisplayMode" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is called when the display mode of a web part is changed." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onDispose": { + "kind": "method", + "signature": "protected onDispose(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to refresh the contents of the PropertyPane." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onInit": { + "kind": "method", + "signature": "protected onInit(): Promise;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "Promise", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onPropertyPaneConfigurationComplete": { + "kind": "method", + "signature": "protected onPropertyPaneConfigurationComplete(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is invoked when the configuration is completed on the PropertyPane." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This event method is invoked in the following cases:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- When the CONFIGURATION_COMPLETE_TIMEOUT((currently the value is 5 secs) elapses after the last change." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- When user clicks 'x'(close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- When user clciks 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- When the user switches web parts then the current web part gets this event." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onPropertyPaneConfigurationStart": { + "kind": "method", + "signature": "protected onPropertyPaneConfigurationStart(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is invoked when the configuration starts on the PropertyPane." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This event method is invoked in the following cases:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- When the PropertyPane is opened." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- When the user switches web parts then the new web part gets this event." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onPropertyPaneFieldChanged": { + "kind": "method", + "signature": "protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "propertyPath": { + "name": "propertyPath", + "description": [ + { + "kind": "text", + "text": "JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of '__CustomField_'." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "oldValue": { + "name": "oldValue", + "description": [ + { + "kind": "text", + "text": "Old value of the property. This value could be undefined/empty in the case of custom field." + } + ], + "isOptional": false, + "isSpread": false, + "type": "any" + }, + "newValue": { + "name": "newValue", + "description": [ + { + "kind": "text", + "text": "New value of the property. This value could be undefined/empty in the case of custom field." + } + ], + "isOptional": false, + "isSpread": false, + "type": "any" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onPropertyPaneRendered": { + "kind": "method", + "signature": "protected onPropertyPaneRendered(): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is invoked when the PropertyPane is rendered." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "previewImageUrl": { + "kind": "property", + "signature": "protected readonly previewImageUrl: string | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property points to the preview image for the web part. The base implementation returns undefined. Web parts that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "properties": { + "kind": "property", + "signature": "protected readonly properties: TProperties;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "TProperties", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property is the pointer to the custom property bag of the web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "propertiesMetadata": { + "kind": "property", + "signature": "protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IWebPartPropertiesMetadata | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data." + } + ], + "remarks": [ + { + "kind": "text", + "text": "See IWebPartPropertiesMetadata for more information about how to define metadata" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "title": { + "kind": "property", + "signature": "protected readonly title: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Title of the WebPart" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "BaseWebPartContext": { + "kind": "class", + "extends": "BaseComponentContext", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This base is to be extended by UI-specific WebPart's base." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseWebPartContext class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "manifest": { + "kind": "property", + "signature": "readonly manifest: IClientSideWebPartManifestInstance;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IClientSideWebPartManifestInstance", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Manifest for the client side component." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "propertyPane": { + "kind": "property", + "signature": "readonly propertyPane: IPropertyPaneAccessor;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IPropertyPaneAccessor", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Accessor for common web part property pane operations." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "webPartTag": { + "kind": "property", + "signature": "readonly webPartTag: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part tag to be used for logging and telemetry." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IClientSideWebPartStatusRenderer": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface to be implemented by a component that should display the loading indicator and error messages for a web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "clearError": { + "kind": "method", + "signature": "clearError(domElement: HTMLElement): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "domElement": { + "name": "domElement", + "description": [ + { + "kind": "text", + "text": "the web part container div." + } + ], + "isOptional": false, + "isSpread": false, + "type": "HTMLElement" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Clear the webpart error message." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "clearLoadingIndicator": { + "kind": "method", + "signature": "clearLoadingIndicator(domElement: Element): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "domElement": { + "name": "domElement", + "description": [ + { + "kind": "text", + "text": "the web part container div." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Element" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Clear the loading indicator." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "displayLoadingIndicator": { + "kind": "method", + "signature": "displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "domElement": { + "name": "domElement", + "description": [ + { + "kind": "text", + "text": "the web part container div." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Element" + }, + "loadingMessage": { + "name": "loadingMessage", + "description": [ + { + "kind": "text", + "text": "the message to be displayed when the loading spinner id displayed." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "timeout": { + "name": "timeout", + "description": [ + { + "kind": "text", + "text": "timeout to render the loading indicator. Default is 1500ms." + } + ], + "isOptional": true, + "isSpread": false, + "type": "number" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Display a loading spinner." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "renderError": { + "kind": "method", + "signature": "renderError(domElement: HTMLElement, error: Error | string): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "domElement": { + "name": "domElement", + "description": [ + { + "kind": "text", + "text": "the web part container div." + } + ], + "isOptional": false, + "isSpread": false, + "type": "HTMLElement" + }, + "error": { + "name": "error", + "description": [ + { + "kind": "text", + "text": "the error message." + } + ], + "isOptional": false, + "isSpread": false, + "type": "Error | string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Render the provided error message in the webpart container div." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IPlaceholderSpinnerProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface for properties used to display the loading spinner in the web part display area." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "hideSpinner": { + "kind": "property", + "signature": "hideSpinner?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label associated with the spinner." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneAccessor": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "isPropertyPaneOpen": { + "kind": "method", + "signature": "isPropertyPaneOpen(): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the PropertyPane is open." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isRenderedByWebPart": { + "kind": "method", + "signature": "isRenderedByWebPart(): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the PropertyPane was initially opened by the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "open": { + "kind": "method", + "signature": "open(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to open the PropertyPane to help configure the web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "refresh": { + "kind": "method", + "signature": "refresh(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to invoke the PropertyPane to help configure the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IPropertyPaneButtonProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane button props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ariaDescription": { + "kind": "property", + "signature": "ariaDescription?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Detailed description of the button for the benefit of screen readers." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Besides the compound button, other button types will need more information provided to screen reader." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The aria label of the button for the benefit of screen readers." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonType": { + "kind": "property", + "signature": "buttonType?: PropertyPaneButtonType;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "PropertyPaneButtonType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The type of button to render. Default value is ButtonType.normal." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Description of the action this button takes. Only used for compound buttons." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the button is disabled." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "icon": { + "kind": "property", + "signature": "icon?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The button icon shown in command or hero type." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onClick": { + "kind": "property", + "signature": "onClick: (value: any) => any;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "(value: any) => any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Display text of the element." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneCheckboxProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane CheckBox component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "checked": { + "kind": "property", + "signature": "checked?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane checkbox is checked or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane checkbox is disabled or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label to display next to the checkbox." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneChoiceGroupOption": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane ChoiceGroup option props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "checked": { + "kind": "property", + "signature": "checked?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane choice group option is checked or not." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Default value is false." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane choice group option is disabled or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "iconProps": { + "kind": "property", + "signature": "iconProps?: IPropertyPaneChoiceGroupOptionIconProps;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneChoiceGroupOptionIconProps", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The Icon component props for choice field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "imageSize": { + "kind": "property", + "signature": "imageSize?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n width: number;\n height: number;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The width and height of the image in px for choice field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "imageSrc": { + "kind": "property", + "signature": "imageSrc?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The src of image for choice field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "key": { + "kind": "property", + "signature": "key: string | number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string | number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A required key to uniquely identify the option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "selectedImageSrc": { + "kind": "property", + "signature": "selectedImageSrc?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The src of image for choice field which is selected." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The text string for the option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneChoiceGroupOptionIconProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane ChoiceGroup icon props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "officeFabricIconFontName": { + "kind": "property", + "signature": "officeFabricIconFontName?: string | null;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string | null", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The name of the icon to use from the Office Fabric icon set." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneChoiceGroupProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane ChoiceGroup props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "label": { + "kind": "property", + "signature": "label?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Descriptive label for the choice group." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "options": { + "kind": "property", + "signature": "options: IPropertyPaneChoiceGroupOption[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneChoiceGroupOption[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The options for the choice group." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneConfiguration": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part configuration settings" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "currentPage": { + "kind": "property", + "signature": "currentPage?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Page to be displayed on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "loadingIndicatorDelayTime": { + "kind": "property", + "signature": "loadingIndicatorDelayTime?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Number of milliseconds to be delayed before the loading indicator is shown on the property pane." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is 500." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "pages": { + "kind": "property", + "signature": "pages: IPropertyPanePage[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPanePage[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Total number of pages on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "showLoadingIndicator": { + "kind": "property", + "signature": "showLoadingIndicator?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the loading indicator should be displayed on top of the property pane or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator property)." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneCustomFieldProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane CustomPropertyField props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "context": { + "kind": "property", + "signature": "context?: any;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "key": { + "kind": "property", + "signature": "key: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "An UNIQUE key indicates the identity of this contorl." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how to pick the value of the key." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For more information, see the " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "React documentation" + } + ], + "targetUrl": "https://facebook.github.io/react/docs/lists-and-keys.html#keys" + }, + { + "kind": "text", + "text": "." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onDispose": { + "kind": "property", + "signature": "onDispose?: (domElement: HTMLElement, context?: any) => void;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "(domElement: HTMLElement, context?: any) => void", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API is called when the component is unmounted from the host element." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onRender": { + "kind": "property", + "signature": "onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "(domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API will be called once the custom field is mounted on the host element." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneDropdownCalloutProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane dropdown callout properties." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "calloutMaxHeight": { + "kind": "property", + "signature": "calloutMaxHeight?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Set max height of callout When not set the callout will expand with contents up to the bottom of the screen" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneDropdownOption": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane drop down options." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "index": { + "kind": "property", + "signature": "index?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Index for this option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "key": { + "kind": "property", + "signature": "key: string | number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string | number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key to uniquely identify this option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Text to render for this option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "type": { + "kind": "property", + "signature": "type?: PropertyPaneDropdownOptionType;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "PropertyPaneDropdownOptionType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneDropdownProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane drop down component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A description of the dropdown for the benefit of screen reader users." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ariaPositionInSet": { + "kind": "property", + "signature": "ariaPositionInSet?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ariaSetSize": { + "kind": "property", + "signature": "ariaSetSize?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defines the number of items in the current set of controls. Maps to native aria-setsize attribute." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "calloutProps": { + "kind": "property", + "signature": "calloutProps?: IPropertyPaneDropdownCalloutProps;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneDropdownCalloutProps", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Custom properties for Dropdown's Callout used to render options." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane dropdown option is disabled or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Descriptive label for the Dropdown." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "options": { + "kind": "property", + "signature": "options?: IPropertyPaneDropdownOption[];", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneDropdownOption[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Collection of options for this Dropdown." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "selectedKey": { + "kind": "property", + "signature": "selectedKey?: string | number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string | number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The key of the initially selected option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneDynamicTextFieldProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneDynamicData component props." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Aria Label for text field, if any." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The text field input description." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane text field is enabled or not." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "errorMessage": { + "kind": "property", + "signature": "errorMessage?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If set, this will be displayed as an error message." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "So, make sure to set this only if you want to see an error message displayed for the text field." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label for the text field." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onGetErrorMessage": { + "kind": "property", + "signature": "onGetErrorMessage?: (value: string) => string | Promise;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "(value: string) => string | Promise", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The method is used to get the validation error message and determine whether the input value is valid or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When it returns string:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- If valid, it returns empty string." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When it returns Promise:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The resolved value is display as error message." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The rejected, the value is thrown away." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "placeholder": { + "kind": "property", + "signature": "placeholder?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "placeholder text to be displayed in the text field." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "validateOnFocusIn": { + "kind": "property", + "signature": "validateOnFocusIn?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Run validation when the PropertyPaneTextField is focused." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "validateOnFocusOut": { + "kind": "property", + "signature": "validateOnFocusOut?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "value": { + "kind": "property", + "signature": "value?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneField": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [ + "TProperties" + ], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "properties": { + "kind": "property", + "signature": "properties: TProperties;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "TProperties", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Strongly typed properties object. Specific to each field type." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Example: Checkbox has ICheckboxProps, TextField has ITextField props." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "shouldFocus": { + "kind": "property", + "signature": "shouldFocus?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether this control should be focused." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "targetProperty": { + "kind": "property", + "signature": "targetProperty: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Target property from the web part's property bag." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "type": { + "kind": "property", + "signature": "type: PropertyPaneFieldType;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "PropertyPaneFieldType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Type of the PropertyPane field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneGroup": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane group. Group is part of the PropertyPanePage." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "groupFields": { + "kind": "property", + "signature": "groupFields: IPropertyPaneField[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneField[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "List of PropertyPane fields." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "groupName": { + "kind": "property", + "signature": "groupName?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Display name for the group." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For performance reasons, it's highly recommended to keep this name unique within the property pane page." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isCollapsed": { + "kind": "property", + "signature": "isCollapsed?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the PropertyPane group is collapsed or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneLabelProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneLabel component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "required": { + "kind": "property", + "signature": "required?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the associated form field is required or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If true, a red asterisk is displayed to the right of the label. Default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Display text fot the label." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneLinkProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneLink component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane link is disabled or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "href": { + "kind": "property", + "signature": "href: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Location to which the link is targeted to." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "popupWindowProps": { + "kind": "property", + "signature": "popupWindowProps?: IPopupWindowProps;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPopupWindowProps", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The props of pop up window." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "target": { + "kind": "property", + "signature": "target?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This attribute specifies where to display the linked resource." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Following values can be used:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "_self - (default) Load the response in the current page." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "_blank - Load the response into a new unnamed tab." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same as \"_self\"" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "_top - Load the response into the original window." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Display text for the link." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPanePage": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPanePage interface." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "displayGroupsAsAccordion": { + "kind": "property", + "signature": "displayGroupsAsAccordion?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the groups on the PropertyPanePage are displayed as accordion or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "groups": { + "kind": "property", + "signature": "groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "List of groups to be displayed on the PropertyPane page." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "header": { + "kind": "property", + "signature": "header?: IPropertyPanePageHeader;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPanePageHeader", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane page header." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPanePageHeader": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane header. This header remains same for all the pages." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "description": { + "kind": "property", + "signature": "description: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Header to display." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "image": { + "kind": "property", + "signature": "image?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Image url for the background image." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneSliderProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneSliderProps component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A description of the Slider for the benefit of screen readers." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether or not the Slider is disabled." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Description label of the Slider." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "max": { + "kind": "property", + "signature": "max: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The max value of the Slider." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "min": { + "kind": "property", + "signature": "min: number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The min value of the Slider." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "showValue": { + "kind": "property", + "signature": "showValue?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether to show the value on the right of the Slider." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If you want to show the value by yourself, you may want to set this value to false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "step": { + "kind": "property", + "signature": "step?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The difference between the two adjacent values of the Slider. Defaults to 1." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "value": { + "kind": "property", + "signature": "value?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Defaults to min." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneTextFieldProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneTextField component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Aria Label for text field, if any." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "deferredValidationTime": { + "kind": "property", + "signature": "deferredValidationTime?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is 200." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The text field input description." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether the property pane text field is enabled or not." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "errorMessage": { + "kind": "property", + "signature": "errorMessage?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If set, this will be displayed as an error message." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "So, make sure to set this only if you want to see an error message displayed for the text field." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label for the text field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "logName": { + "kind": "property", + "signature": "logName?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n moduleName: string;\n controlName: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Engagement name to log PropertyPaneTextField value change." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It will be logged format as .. E.g. {moduleName: 'ImageWebPart', controlName: 'OverlayText'}, it will log: 1. action type, including 'Add', 'Clear' and 'Edit'. Clear: reset the content of caption element to initial/unset state. Add: change from initial/unset state to customized content. (first edit) Edit: any edition that changes the content apart from add and clear 2. text length after each edit." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "maxLength": { + "kind": "property", + "signature": "maxLength?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Maximum number of characters that the PropertyPaneTextField can have." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the value is set to a negative number, an exception will be thrown." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "multiline": { + "kind": "property", + "signature": "multiline?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether or not the text field is a multiline text field." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onGetErrorMessage": { + "kind": "property", + "signature": "onGetErrorMessage?: (value: string) => string | Promise;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "(value: string) => string | Promise", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The method is used to get the validation error message and determine whether the input value is valid or not." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When it returns string:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- If valid, it returns empty string." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When it returns Promise:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The resolved value is display as error message." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- The rejected, the value is thrown away." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "placeholder": { + "kind": "property", + "signature": "placeholder?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "placeholder text to be displayed in the text field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "resizable": { + "kind": "property", + "signature": "resizable?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether or not the multiline text field is resizable." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is true." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "rows": { + "kind": "property", + "signature": "rows?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Specifies the visible height of a text area(multiline text TextField), in lines." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This prop is used only when the multiline prop is set to true." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "underlined": { + "kind": "property", + "signature": "underlined?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Whether or not the text field is underlined." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "validateOnFocusIn": { + "kind": "property", + "signature": "validateOnFocusIn?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Run validation when the PropertyPaneTextField is focused." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "validateOnFocusOut": { + "kind": "property", + "signature": "validateOnFocusOut?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The default value is false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "value": { + "kind": "property", + "signature": "value?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneToggleProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPaneToggle component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "checked": { + "kind": "property", + "signature": "checked?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Checked state of the toggle." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If you are maintaining state yourself, use this property." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Optional disabled flag." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "key": { + "kind": "property", + "signature": "key?: string | number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string | number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key to uniquely identify the field." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A label for the toggle." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "offAriaLabel": { + "kind": "property", + "signature": "offAriaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "offText": { + "kind": "property", + "signature": "offText?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Test display when toggle is OFF." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onAriaLabel": { + "kind": "property", + "signature": "onAriaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "onText": { + "kind": "property", + "signature": "onText?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Text to display when toggle is ON." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISerializedServerProcessedData": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contains collections of data that can be processed by server side services like search index and link fixup" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "htmlStrings": { + "kind": "property", + "signature": "htmlStrings?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [key: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key-value map where keys are string identifiers and values are rich text with HTML format." + } + ], + "remarks": [ + { + "kind": "text", + "text": "SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: { 'myRichDescription': '
Some standard HTML contentA Link
' 'anotherRichText':
Some red text
}" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "imageSources": { + "kind": "property", + "signature": "imageSources?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [key: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key-value map where keys are string identifiers and values are image sources." + } + ], + "remarks": [ + { + "kind": "text", + "text": "SharePoint servers treat the values as image sources and run services like search index and link fixup on them." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: { 'myImage1': 'http://res.contoso.com/path/to/file' 'myImage2': 'https://res.contoso.com/someName.jpg' }" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "links": { + "kind": "property", + "signature": "links?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [key: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key-value map where keys are string identifiers and values are links." + } + ], + "remarks": [ + { + "kind": "text", + "text": "SharePoint servers treat the values as links and run services like link fixup on them." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: { 'myWebURL': 'http://contoso.com' 'myFileLink': 'https://res.contoso.com/file.docx' }" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "searchablePlainTexts": { + "kind": "property", + "signature": "searchablePlainTexts?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [key: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key-value map where keys are string identifiers and values are strings that should be search indexed." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, but are not treated as valid HTML. So, other services such as link fixup will not run on them." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: { 'justSomeText': 'This is some plain text', 'anotherText': 'Can have characters here: \"<>&\\'' }" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISerializedWebPartData": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "dataVersion": { + "kind": "property", + "signature": "dataVersion: Version;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "Version", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part data version." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: Version Supported values: MAJOR.MINOR Example: \"1.0\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dynamicDataPaths": { + "kind": "property", + "signature": "dynamicDataPaths?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dynamicDataValues": { + "kind": "property", + "signature": "dynamicDataValues?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: any;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "properties": { + "kind": "property", + "signature": "properties?: any;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part specific properties. The individual web part owns the definition of these properties." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serverProcessedContent": { + "kind": "property", + "signature": "serverProcessedContent?: ISerializedServerProcessedData;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "ISerializedServerProcessedData", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The collections of data that can be processed by server side services like search index and link fixup." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IWebPartContext": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "The base context interface for client-side web parts." + } + ], + "remarks": [ + { + "kind": "text", + "text": "A \"context\" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "domElement": { + "kind": "property", + "signature": "readonly domElement: HTMLElement;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HTMLElement", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Reference to the DOM element that hosts this client side component." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "graphHttpClient": { + "kind": "property", + "signature": "readonly graphHttpClient: GraphHttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "GraphHttpClient", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "GraphHttpClient instance scoped to this web part." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "httpClient": { + "kind": "property", + "signature": "readonly httpClient: HttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HttpClient", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "HttpClient instance scoped to this web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "instanceId": { + "kind": "property", + "signature": "readonly instanceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Web part instance id. This is a globally unique value." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "manifest": { + "kind": "property", + "signature": "readonly manifest: IClientSideWebPartManifestInstance;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IClientSideWebPartManifestInstance", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Manifest for the client side web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "pageContext": { + "kind": "property", + "signature": "readonly pageContext: PageContext;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "PageContext", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "SharePoint page context." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "propertyPane": { + "kind": "property", + "signature": "readonly propertyPane: IPropertyPaneAccessor;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IPropertyPaneAccessor", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Accessor for common web part property pane operations." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "spHttpClient": { + "kind": "property", + "signature": "readonly spHttpClient: SPHttpClient;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPHttpClient", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "SPHttpClient instance scoped to this web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "statusRenderer": { + "kind": "property", + "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IClientSideWebPartStatusRenderer", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Web part status renderer." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "webPartTag": { + "kind": "property", + "signature": "readonly webPartTag: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This interface will be removed in an upcoming release. Use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "WebPartContext" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "WebPartContext", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Web part tag to be used for logging and telemetry." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IWebPartData": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This structure represents the serialized state of a web part. When the serialize() API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "dataVersion": { + "kind": "property", + "signature": "dataVersion: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part data version" + } + ], + "remarks": [ + { + "kind": "text", + "text": "Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: string Supported values: MAJOR.MINOR Example: \"1.0\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "description": { + "kind": "property", + "signature": "description?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part description" + } + ], + "remarks": [ + { + "kind": "text", + "text": "Usage: display the description of the web part. Required: no Type: string Supported values: string with the description. Example: \"Text\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dynamicDataPaths": { + "kind": "property", + "signature": "dynamicDataPaths?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: string;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "dynamicDataValues": { + "kind": "property", + "signature": "dynamicDataValues?:", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "{\n [path: string]: any;\n }", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "id": { + "kind": "property", + "signature": "id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Universally unique web part Type id." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Usage: uniquely identify a web part. Required: yes Type: GUID Supported values: any GUID Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "instanceId": { + "kind": "property", + "signature": "instanceId: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries." + } + ], + "remarks": [ + { + "kind": "text", + "text": "how used: used by the framework to uniquely identify an instance of a web part. mandatory: yes type: string supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: [\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"] experimental: yes" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "properties": { + "kind": "property", + "signature": "properties?: any;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part specific properties. The individual web part owns the definition of these properties." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "serverProcessedContent": { + "kind": "property", + "signature": "serverProcessedContent?: ISerializedServerProcessedData;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "ISerializedServerProcessedData", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Definition: The collections of data that can be processed by server side services like search index and link fixup Required: no" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "title": { + "kind": "property", + "signature": "title: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part title" + } + ], + "remarks": [ + { + "kind": "text", + "text": "Usage: display the name of the web part in the toolbox, web part gallery and the page. Required: yes Type: string Supported values: string less than 100 characters Example: \"Text\"" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IWebPartPropertiesMetadata": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This structure is used to define metadata for web part properties as a map of string to IWebPartPropertyMetadata" + } + ], + "remarks": [ + { + "kind": "text", + "text": "The key should be a JSON path to the property in web part properties. The JSON path supports the following operators:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- Dot . for selecting object members e.g. person.name" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- Brackets [] for selecting array items e.g. person.photoURLs[0]" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- Bracketed asterisk [*] for array elements wildcard e.g. person.websites[*]." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "You can make combinations of these operators e.g. person.websites[*].url Important Note: Only one wildcard per path is supported." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: Let's assume we have a web part with properties that have the following schema: { title: string; person: { name: string; bio: string; photoURLs: string[]; websites: { title: string; url: string; }[] } }" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "We can define the metadata for the desired properties as following: { 'person.bio': { isRichContent: true }, 'person.photoURLs[*]': { isImageSource: true }, 'person.websites[*].url': { isLink: true } }" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated." + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__index": { + "kind": "method", + "signature": "[key: string]: IWebPartPropertyMetadata;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IWebPartPropertyMetadata", + "description": [] + }, + "parameters": { + "key": { + "name": "key", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IWebPartPropertyMetadata": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the structure used for map values in IWebPartPropertiesMetadata" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "isHtmlString": { + "kind": "property", + "signature": "isHtmlString?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the property should be serialized as HTML." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it: - normalizing HTML encodings - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) - search indexing - SharePoint link fix-up" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the isSearchablePlainText flag instead." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isImageSource": { + "kind": "property", + "signature": "isImageSource?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isLink": { + "kind": "property", + "signature": "isLink?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isSearchablePlainText": { + "kind": "property", + "signature": "isSearchablePlainText?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates if the property contains plain text that should be search-indexed by SharePoint." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the isHtmlString setting instead. Security note: For security reasons, never assign a plain text string to Element.innerHTML." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "shouldNotPersist": { + "kind": "property", + "signature": "shouldNotPersist?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates if the framework should persist the property on the server. Use this for properties that are only important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data of the web part and optimize the webpart load time. The property value will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. The property value will still be available in onBeforeSerialize() method, and the value will not be cleared from the run-time property bag. The initial render of your web part should not depend on the value of the property. Setting a default value for the property can be done in onInit() method." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "PropertyPaneButton": { + "kind": "function", + "signature": "export function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the Button is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Button properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneButtonProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Button on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneButtonType": { + "kind": "enum", + "values": { + "Command": { + "kind": "enum value", + "value": "4", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Optional actions." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts." + } + ], + "isBeta": false + }, + "Compound": { + "kind": "enum value", + "value": "3", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Always used as a set with both Standard and Primary compound buttons." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form" + } + ], + "isBeta": false + }, + "Hero": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Hero button." + } + ], + "remarks": [], + "isBeta": false + }, + "Icon": { + "kind": "enum value", + "value": "5", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range." + } + ], + "isBeta": false + }, + "Normal": { + "kind": "enum value", + "value": "0", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Optional completion action." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo an action. Examples: \"Done\" button which closes a container but doesn't make a server call or an \"Undo\" button when a user is uploading a file in OneDrive." + } + ], + "isBeta": false + }, + "Primary": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Preferred completion action when paired with a Standard button." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Typically used at the end of a task or form. Examples: \"Create\", \"Save\", \"Send\" which makes a server call." + } + ], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Enum for all the supported button types." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneCheckbox": { + "kind": "function", + "signature": "export function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the checkbox is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Checkbox properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneCheckboxProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Checkbox on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneChoiceGroup": { + "kind": "function", + "signature": "export function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the choice group is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Choice Group properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneChoiceGroupProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Choice Group on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneCustomField": { + "kind": "function", + "signature": "export function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Custom field properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneCustomFieldProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a custom field on the PropertyPane." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap." + } + ], + "isBeta": true + }, + "PropertyPaneDropdown": { + "kind": "function", + "signature": "export function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the dropdown is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Dropdown properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneDropdownProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Dropdown on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneDropdownOptionType": { + "kind": "enum", + "values": { + "Divider": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Render a divider." + } + ], + "remarks": [], + "isBeta": false + }, + "Header": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Render menu item as a header." + } + ], + "remarks": [], + "isBeta": false + }, + "Normal": { + "kind": "enum value", + "value": "0", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Render normal menu item." + } + ], + "remarks": [], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Specifies the type of option in a dropdown menu rendered by " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "PropertyPaneDropdown" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "PropertyPaneDropdown", + "memberName": "" + } + }, + { + "kind": "text", + "text": "." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneDynamicTextField": { + "kind": "function", + "signature": "export function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the dynamic textfield is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Properties of the PropertyPaneDynamicTextField." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneDynamicTextFieldProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Dynamic TextField on the PropertyPane." + } + ], + "remarks": [], + "isBeta": true + }, + "PropertyPaneFieldType": { + "kind": "enum", + "values": { + "Button": { + "kind": "enum value", + "value": "11", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Button field." + } + ], + "remarks": [], + "isBeta": false + }, + "CheckBox": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Checkbox field." + } + ], + "remarks": [], + "isBeta": false + }, + "ChoiceGroup": { + "kind": "enum value", + "value": "10", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Choice Group field." + } + ], + "remarks": [], + "isBeta": false + }, + "Custom": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Custom field." + } + ], + "remarks": [], + "isBeta": false + }, + "Dropdown": { + "kind": "enum value", + "value": "6", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Dropdown field." + } + ], + "remarks": [], + "isBeta": false + }, + "DynamicTextField": { + "kind": "enum value", + "value": "15", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Dynamic Text Field" + } + ], + "remarks": [], + "isBeta": true + }, + "Heading": { + "kind": "enum value", + "value": "9", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Heading field." + } + ], + "remarks": [], + "isBeta": false + }, + "HorizontalRule": { + "kind": "enum value", + "value": "12", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Horizontal Rule field." + } + ], + "remarks": [], + "isBeta": false + }, + "Label": { + "kind": "enum value", + "value": "7", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label field." + } + ], + "remarks": [], + "isBeta": false + }, + "Link": { + "kind": "enum value", + "value": "13", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Link field." + } + ], + "remarks": [], + "isBeta": false + }, + "Slider": { + "kind": "enum value", + "value": "8", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Slider field." + } + ], + "remarks": [], + "isBeta": false + }, + "TextField": { + "kind": "enum value", + "value": "3", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "TextField field." + } + ], + "remarks": [], + "isBeta": false + }, + "Toggle": { + "kind": "enum value", + "value": "5", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Toggle field." + } + ], + "remarks": [], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Enum for all the supported PropertyPane field types." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneHorizontalRule": { + "kind": "function", + "signature": "export function PropertyPaneHorizontalRule(): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Horizontal Rule on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneLabel": { + "kind": "function", + "signature": "export function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the label is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Label properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneLabelProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Label on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneLink": { + "kind": "function", + "signature": "export function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the Link is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Link properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneLinkProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Link on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneSlider": { + "kind": "function", + "signature": "export function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the slider is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Slider properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneSliderProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Slider on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneTextField": { + "kind": "function", + "signature": "export function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the textfield is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed TextField properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneTextFieldProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a TextField on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneToggle": { + "kind": "function", + "signature": "export function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the toggle is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Strongly typed Toggle properties." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneToggleProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Toggle on the PropertyPane." + } + ], + "remarks": [], + "isBeta": false + }, + "WebPartContext": { + "kind": "class", + "extends": "BaseWebPartContext", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WebPartContext class." + }, + { + "kind": "paragraph" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "domElement": { + "kind": "property", + "signature": "readonly domElement: HTMLElement;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "HTMLElement", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Reference to the DOM element that hosts this client side component." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "statusRenderer": { + "kind": "property", + "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "IClientSideWebPartStatusRenderer", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part status renderer." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + } + } +} From b377c35151be5271409c506c742361b8256f45f3 Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 5 Oct 2018 16:03:47 -0700 Subject: [PATCH 20/55] Remove sp-property-pane.api.json because that package has no public docs --- generate-docs/json/recopy.bat | 1 - 1 file changed, 1 deletion(-) diff --git a/generate-docs/json/recopy.bat b/generate-docs/json/recopy.bat index eceb00bf..2a76fe03 100644 --- a/generate-docs/json/recopy.bat +++ b/generate-docs/json/recopy.bat @@ -13,6 +13,5 @@ copy /y ..\..\..\sp-client\spfx-core\sp-dialog\dist\*.api.json . copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\dist\*.api.json . copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\dist\*.api.json . copy /y ..\..\..\sp-client\spfx-core\sp-diagnostics\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-property-pane\dist\*.api.json . pause From 6c1820666ca8b96467c0516fe723f3c32dbd48b3 Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 9 Nov 2018 06:08:28 -0800 Subject: [PATCH 21/55] Update JSON files based on prod/2018-10-26 branch for sp-client --- .../json/sp-application-base.api.json | 171 +- generate-docs/json/sp-component-base.api.json | 3690 ++++++++++++++++- generate-docs/json/sp-core-library.api.json | 306 +- generate-docs/json/sp-dialog.api.json | 157 +- generate-docs/json/sp-dynamic-data.api.json | 589 ++- generate-docs/json/sp-http.api.json | 227 +- .../json/sp-listview-extensibility.api.json | 10 +- generate-docs/json/sp-odata-types.api.json | 400 +- generate-docs/json/sp-page-context.api.json | 366 +- generate-docs/json/sp-webpart-base.api.json | 2224 ++++++++-- 10 files changed, 7533 insertions(+), 607 deletions(-) diff --git a/generate-docs/json/sp-application-base.api.json b/generate-docs/json/sp-application-base.api.json index c1d173a8..66c76289 100644 --- a/generate-docs/json/sp-application-base.api.json +++ b/generate-docs/json/sp-application-base.api.json @@ -125,7 +125,7 @@ "elements": [ { "kind": "text", - "text": "@microsoft/sp-page-context:PageContext" + "text": "PageContext" } ], "target": { @@ -212,6 +212,25 @@ "isOverride": false, "isEventProperty": false }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": true + }, "placeholderProvider": { "kind": "property", "signature": "readonly placeholderProvider: PlaceholderProvider;", @@ -247,16 +266,16 @@ { "kind": "text", "text": "This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting." + } + ], + "remarks": [ + { + "kind": "text", + "text": "In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\"." }, { "kind": "paragraph" }, - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\"." - } - ], - "remarks": [ { "kind": "text", "text": "Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period." @@ -290,6 +309,86 @@ "isVirtual": false, "isOverride": false, "isEventProperty": false + }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disposes the component." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseComponent.onDispose" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-component-base", + "exportName": "BaseComponent", + "memberName": "onDispose" + } + }, + { + "kind": "text", + "text": " method." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "onPlaceholdersChanged": { + "kind": "method", + "signature": "protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;", + "accessModifier": "protected", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "placeholderProvider": { + "name": "placeholderProvider", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "PlaceholderProvider" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This event method is called when the placeholders of the host application change, come into existence, or disappear." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -512,6 +611,27 @@ "isOverride": false, "isEventProperty": false }, + "isVisible": { + "kind": "property", + "signature": "readonly isVisible: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, "name": { "kind": "property", "signature": "readonly name: PlaceholderName;", @@ -607,7 +727,7 @@ "PlaceholderProvider": { "kind": "class", "extends": "", - "implements": "", + "implements": "IDisposable", "typeParameters": [], "deprecatedMessage": [], "summary": [ @@ -722,6 +842,41 @@ "isOverride": false, "isEventProperty": true }, + "dispose": { + "kind": "method", + "signature": "dispose(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isDisposed": { + "kind": "property", + "signature": "readonly isDisposed: boolean;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, "placeholderNames": { "kind": "property", "signature": "readonly placeholderNames: ReadonlyArray;", diff --git a/generate-docs/json/sp-component-base.api.json b/generate-docs/json/sp-component-base.api.json index 86ac333a..954a103e 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -346,7 +346,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -367,7 +367,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -383,7 +383,26 @@ "deprecatedMessage": [ { "kind": "text", - "text": "" + "text": "Use " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "BaseComponentContext.msGraphClientFactory" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-component-base", + "exportName": "BaseComponentContext", + "memberName": "msGraphClientFactory" + } + }, + { + "kind": "text", + "text": " instead" } ], "summary": [ @@ -478,7 +497,7 @@ "summary": [ { "kind": "text", - "text": "Manifest for the client side component." + "text": "Manifest for the client-side component." } ], "remarks": [], @@ -548,7 +567,7 @@ "elements": [ { "kind": "text", - "text": "@microsoft/sp-core-library:ServiceScope" + "text": "ServiceScope" } ], "target": { @@ -611,7 +630,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { "dispose": { @@ -633,7 +652,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -662,7 +681,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -682,7 +701,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -720,7 +739,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -781,7 +800,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -830,7 +849,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -867,7 +886,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -904,7 +923,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -965,7 +984,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1014,7 +1033,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1034,7 +1053,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { "dispose": { @@ -1056,7 +1075,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1077,7 +1096,7 @@ "description": [ { "kind": "text", - "text": "Set of methods exposed by the Dynamic Data Source to get the data. These apis are called by the consumer to retrieve properties, their values etc.," + "text": "Set of methods that are exposed through the Dynamic Data Source" } ], "isOptional": false, @@ -1093,7 +1112,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1113,7 +1132,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -1158,7 +1177,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1178,7 +1197,7 @@ "summary": [ { "kind": "text", - "text": "Notifies that this source has updated its data." + "text": "Notifies that this source has updated its properties." }, { "kind": "paragraph" @@ -1189,11 +1208,32 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false }, + "sourceId": { + "kind": "property", + "signature": "readonly sourceId: string;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the Id of the current DataSource." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, "updateMetadata": { "kind": "method", "signature": "updateMetadata(metadata: Partial): void;", @@ -1226,7 +1266,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1244,16 +1284,16 @@ "summary": [ { "kind": "text", - "text": "Serializable object that simplifies usage of Dynamic Data." + "text": "Serializable object that simplifies usage of a DynamicProperty." } ], "remarks": [ { "kind": "text", - "text": "This is built for usage in Web Part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the dynamic data will re-render the web part automatically." + "text": "This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically." } ], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { "__constructor": { @@ -1265,7 +1305,7 @@ "description": [ { "kind": "text", - "text": "Dynamic Data Provider." + "text": "DynamicDataProvider." } ], "isOptional": false, @@ -1277,7 +1317,7 @@ "description": [ { "kind": "text", - "text": "Optional. Default callback to be registered for updates in the Dynamic Data source." + "text": "Optional. Default callback to be registered for updates in the DynamicDataSource." } ], "isOptional": true, @@ -1289,7 +1329,7 @@ "summary": [ { "kind": "text", - "text": "Create a new Dynamic Property object." + "text": "Create a new DynamicProperty object." } ], "remarks": [] @@ -1318,7 +1358,7 @@ "text": "After the object has been disposed, do not call its methods or access its properties." } ], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1342,7 +1382,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1367,7 +1407,7 @@ "text": "After the object has been disposed, do not call its methods or access its properties." } ], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -1384,16 +1424,25 @@ "summary": [ { "kind": "text", - "text": "DynamicDataReference string that the Dynamic Data object points to. The reference is of the form ::." + "text": "DynamicDataReference string that the DynamicProperty object points to. The reference is of the form " + }, + { + "kind": "code", + "text": "::", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "remarks": [ { "kind": "text", - "text": "If the Dynamic Data object is set up with static data, this returns undefined." + "text": "If the DynamicProperty is set up with static data, this returns undefined." } ], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -1427,11 +1476,11 @@ "summary": [ { "kind": "text", - "text": "Registers a callback function for updates on the associated Dynamic Data Source." + "text": "Registers a callback function for updates on the associated DynamicDataSource." } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1460,7 +1509,7 @@ "text": "This can be useful for advanced users who only want their custom callbacks." } ], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1481,7 +1530,7 @@ "description": [ { "kind": "text", - "text": "Id of the Dynamic Data." + "text": "Id of the DynamicDataSource and property." } ], "isOptional": false, @@ -1493,11 +1542,20 @@ "summary": [ { "kind": "text", - "text": "Sets a Dynamic data id in the Dynamic Data object." + "text": "Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form " + }, + { + "kind": "code", + "text": "::", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1518,7 +1576,7 @@ "description": [ { "kind": "text", - "text": "Value for the Dynamic Data." + "text": "Value for the DynamicProperty." } ], "isOptional": false, @@ -1530,11 +1588,11 @@ "summary": [ { "kind": "text", - "text": "Sets a static value in the Dynamic Data object." + "text": "Sets a static value in the DynamicProperty." } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1554,11 +1612,11 @@ "summary": [ { "kind": "text", - "text": "Returns the Dynamic Data Source that the Dynamic Data object refers to. Returns undefined if the source doesn't exist." + "text": "Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist." } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1571,18 +1629,114 @@ "isStatic": false, "returnValue": { "type": "TValue | undefined", - "description": [] + "description": [ + { + "kind": "text", + "text": "the value associated with the dynamic property or undefined if the source or the data doesn't exist." + } + ] }, "parameters": {}, "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Returns the value of the Dynamic Data object. Returns undefined if the source or the data doesn't exist." + "text": "Returns the value of the object." } ], - "remarks": [], - "isBeta": true, + "remarks": [ + { + "kind": "text", + "text": "If the value is an array, then the first element of the array is returned; otherwise, the value itself is returned." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NOTE: This api will never return an array. To retrieve an array value, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "DynamicProperty.tryGetValues" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-component-base", + "exportName": "DynamicProperty", + "memberName": "tryGetValues" + } + }, + { + "kind": "text", + "text": " API." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "tryGetValues": { + "kind": "method", + "signature": "tryGetValues(): TValue[];", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "TValue[]", + "description": [ + { + "kind": "text", + "text": "the value associated with the dynamic property or an empty array if the source or the data doesn't exist." + } + ] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns the value of the object." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the value itself is returned. If the property is undefined or cannot be found, an empty array will be returned." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "DynamicProperty.tryGetValue" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-component-base", + "exportName": "DynamicProperty", + "memberName": "tryGetValue" + } + }, + { + "kind": "text", + "text": " API." + } + ], + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -1615,7 +1769,3437 @@ "summary": [ { "kind": "text", - "text": "Unregisters a callback function for updates on the associated Dynamic Data Source. The callback function must be the same it was registered with." + "text": "Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IFontStyles": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Font styles for different sizes." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "large": { + "kind": "property", + "signature": "large: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "medium": { + "kind": "property", + "signature": "medium: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Medium font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "mediumPlus": { + "kind": "property", + "signature": "mediumPlus: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Larger than medium but smaller than large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "mega": { + "kind": "property", + "signature": "mega: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Mega sized font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "small": { + "kind": "property", + "signature": "small: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Small font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "smallPlus": { + "kind": "property", + "signature": "smallPlus: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Larger than small but smaller than medium font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "superLarge": { + "kind": "property", + "signature": "superLarge: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Super large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tiny": { + "kind": "property", + "signature": "tiny: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tiny font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "xLarge": { + "kind": "property", + "signature": "xLarge: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extra large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "xSmall": { + "kind": "property", + "signature": "xSmall: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extra small font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "xxLarge": { + "kind": "property", + "signature": "xxLarge: IRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extra extra large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPalette": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color palette." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "accent": { + "kind": "property", + "signature": "accent: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for the accent." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "black": { + "kind": "property", + "signature": "black: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for the strongest color, which is black in the default theme. This is a very light color in inverted themes." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "blackTranslucent40": { + "kind": "property", + "signature": "blackTranslucent40: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for blackTranslucent40." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "blue": { + "kind": "property", + "signature": "blue: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for blue." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "blueDark": { + "kind": "property", + "signature": "blueDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for blueDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "blueLight": { + "kind": "property", + "signature": "blueLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for blueLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "blueMid": { + "kind": "property", + "signature": "blueMid: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for blueMid." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "green": { + "kind": "property", + "signature": "green: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for green." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "greenDark": { + "kind": "property", + "signature": "greenDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for greenDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "greenLight": { + "kind": "property", + "signature": "greenLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for greenLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "magenta": { + "kind": "property", + "signature": "magenta: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for magenta." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "magentaDark": { + "kind": "property", + "signature": "magentaDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for magentaDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "magentaLight": { + "kind": "property", + "signature": "magentaLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for magentaLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralDark": { + "kind": "property", + "signature": "neutralDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralLight": { + "kind": "property", + "signature": "neutralLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralLighter": { + "kind": "property", + "signature": "neutralLighter: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralLighter." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralLighterAlt": { + "kind": "property", + "signature": "neutralLighterAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralLighterAlt." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralPrimary": { + "kind": "property", + "signature": "neutralPrimary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralPrimary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralPrimaryAlt": { + "kind": "property", + "signature": "neutralPrimaryAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralPrimaryAlt." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralQuaternary": { + "kind": "property", + "signature": "neutralQuaternary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralQuaternary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralQuaternaryAlt": { + "kind": "property", + "signature": "neutralQuaternaryAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralQuaternaryAlt." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralSecondary": { + "kind": "property", + "signature": "neutralSecondary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralSecondary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralTertiary": { + "kind": "property", + "signature": "neutralTertiary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralTertiary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "neutralTertiaryAlt": { + "kind": "property", + "signature": "neutralTertiaryAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for neutralTertiaryAlt." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "orange": { + "kind": "property", + "signature": "orange: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for orange." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "orangeLight": { + "kind": "property", + "signature": "orangeLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for orangeLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "orangeLighter": { + "kind": "property", + "signature": "orangeLighter: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for orangeLighter." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "purple": { + "kind": "property", + "signature": "purple: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for purple." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "purpleDark": { + "kind": "property", + "signature": "purpleDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for purpleDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "purpleLight": { + "kind": "property", + "signature": "purpleLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for purpleLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "red": { + "kind": "property", + "signature": "red: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for red." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "redDark": { + "kind": "property", + "signature": "redDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for redDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "teal": { + "kind": "property", + "signature": "teal: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for teal." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tealDark": { + "kind": "property", + "signature": "tealDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for tealDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tealLight": { + "kind": "property", + "signature": "tealLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for tealLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeDark": { + "kind": "property", + "signature": "themeDark: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeDark." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeDarkAlt": { + "kind": "property", + "signature": "themeDarkAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeDarkAlt." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeDarker": { + "kind": "property", + "signature": "themeDarker: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeDarker." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeLight": { + "kind": "property", + "signature": "themeLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeLighter": { + "kind": "property", + "signature": "themeLighter: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeLighter." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeLighterAlt": { + "kind": "property", + "signature": "themeLighterAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeLighterAlt." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themePrimary": { + "kind": "property", + "signature": "themePrimary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themePrimary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeSecondary": { + "kind": "property", + "signature": "themeSecondary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeSecondary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeTertiary": { + "kind": "property", + "signature": "themeTertiary: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for themeTertiary." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "white": { + "kind": "property", + "signature": "white: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. This is the page background." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "whiteTranslucent40": { + "kind": "property", + "signature": "whiteTranslucent40: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for whiteTranslucent40" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "yellow": { + "kind": "property", + "signature": "yellow: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for yellow." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "yellowLight": { + "kind": "property", + "signature": "yellowLight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color code for yellowLight." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IReadonlyFontStyles": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Font styles for different sizes." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "large": { + "kind": "property", + "signature": "large: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "medium": { + "kind": "property", + "signature": "medium: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Medium font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "mediumPlus": { + "kind": "property", + "signature": "mediumPlus: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Larger than medium but smaller than large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "mega": { + "kind": "property", + "signature": "mega: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Mega sized font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "small": { + "kind": "property", + "signature": "small: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Small font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "smallPlus": { + "kind": "property", + "signature": "smallPlus: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Larger than small but smaller than medium font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "superLarge": { + "kind": "property", + "signature": "superLarge: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Super large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "tiny": { + "kind": "property", + "signature": "tiny: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Tiny font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "xLarge": { + "kind": "property", + "signature": "xLarge: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extra large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "xSmall": { + "kind": "property", + "signature": "xSmall: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extra small font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "xxLarge": { + "kind": "property", + "signature": "xxLarge: IReadonlyRawStyle;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IReadonlyRawStyle", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Extra extra large font style." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IReadonlyTheme": { + "kind": "interface", + "extends": "Readonly", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Immutable ITheme." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "fonts": { + "kind": "property", + "signature": "readonly fonts: Readonly;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Readonly", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Font styles for different sizes." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "palette": { + "kind": "property", + "signature": "readonly palette: Readonly;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Readonly", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color palette." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "semanticColors": { + "kind": "property", + "signature": "readonly semanticColors: Readonly;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "Readonly", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The collection of all semantic slots for colors used in themes." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ISemanticColors": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The collection of semantic slots for colors used in themes." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Naming Convention" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The name of a semantic slot can quickly tell you how it’s meant to be used. It generally follows this format:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "[category name][element name][checked state][hovered/pressed/disabled state] [category name] – The “family” that this slot belongs to. [element name] – The name of the thing being targeted, such as the background or border. [checked state] – Whether the thing is checked. We assume things are unchecked by default, so no need to specify the unchecked state. (We used “checked” to refer to anything that is on, selected, toggled, highlighted, emphasized, etc.) [hovered/pressed/disabled state] – One of these states, if applicable. Each of these states are mutually exclusive. Pressed styles overwrite hovered styles, and disabled elements cannot be hovered or pressed." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Base Slots" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A basic set of slots that provide many default body styles, such as text, subtext, disabled colors, and so on. If a category doesn't provide the slot you're looking for, use one from this category. For example, the placeholder text on a text input field has no corresponding slot in its category, so you'd use the bodySubtextColor from this category." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Invariants" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When color has meaning, we do not want to change the color much theme to theme. For example, we will always want errors to be some shade of red, but we will need to tweak the exact shade so it's legible depending on whether it's an inverted theme or not. Invariant colors should almost never be changed by the theme, the defaults should suffice." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Input Controls" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "This category contains input components commonly used to denote state, including radio buttons, check boxes, toggle switches, sliders, progress bars, and more." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Buttons" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Buttons! And all the flavors thereof." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Menus" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Any kind of popup menus uses this category." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "## Lists" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a large and complex interaction surface. This category covers all kinds of lists, whether they're typical one-item-per-row lists (like DetailsList) or ones with a tiled layout." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "actionLink": { + "kind": "property", + "signature": "actionLink: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Neutral colored links and links for action buttons." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "actionLinkHovered": { + "kind": "property", + "signature": "actionLinkHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Hover state for neutral colored links and links for action buttons." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "blockingBackground": { + "kind": "property", + "signature": "blockingBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background for blocking issues, which is more severe than a warning, but not as bad as an error." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyBackground": { + "kind": "property", + "signature": "bodyBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default color for backgrounds." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyDivider": { + "kind": "property", + "signature": "bodyDivider: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Divider lines; e.g. lines that separate sections in a menu, an " + }, + { + "kind": "html-tag", + "token": "
" + }, + { + "kind": "text", + "text": " element." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyFrameBackground": { + "kind": "property", + "signature": "bodyFrameBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the color of bodyBackground. See also: bodyFrameDivider" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyFrameDivider": { + "kind": "property", + "signature": "bodyFrameDivider: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually disappear. See also: bodyFrameBackground" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyStandoutBackground": { + "kind": "property", + "signature": "bodyStandoutBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in inverted themes." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodySubtext": { + "kind": "property", + "signature": "bodySubtext: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "De-emphasized text; e.g. metadata, captions, placeholder text." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyText": { + "kind": "property", + "signature": "bodyText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default color for text." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "bodyTextChecked": { + "kind": "property", + "signature": "bodyTextChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Checked text color, e.g. selected menu item text." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBackground": { + "kind": "property", + "signature": "buttonBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBackgroundChecked": { + "kind": "property", + "signature": "buttonBackgroundChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBackgroundCheckedHovered": { + "kind": "property", + "signature": "buttonBackgroundCheckedHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBackgroundHovered": { + "kind": "property", + "signature": "buttonBackgroundHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a hovered standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBackgroundPressed": { + "kind": "property", + "signature": "buttonBackgroundPressed: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a pressed standard button; i.e. currently being clicked by mouse" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBorder": { + "kind": "property", + "signature": "buttonBorder: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Border of a standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonBorderDisabled": { + "kind": "property", + "signature": "buttonBorderDisabled: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Border of a disabled standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonText": { + "kind": "property", + "signature": "buttonText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonTextChecked": { + "kind": "property", + "signature": "buttonTextChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a checked standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonTextCheckedHovered": { + "kind": "property", + "signature": "buttonTextCheckedHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a checked and hovered standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonTextDisabled": { + "kind": "property", + "signature": "buttonTextDisabled: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a disabled standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonTextHovered": { + "kind": "property", + "signature": "buttonTextHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a hovered standard button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "buttonTextPressed": { + "kind": "property", + "signature": "buttonTextPressed: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a pressed standard button; i.e. currently being clicked by mouse" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabledBackground": { + "kind": "property", + "signature": "disabledBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default color for backgrounds of disabled controls; e.g. disabled text field." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabledBodyText": { + "kind": "property", + "signature": "disabledBodyText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default color for disabled text on the default background (bodyBackground)." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabledSubtext": { + "kind": "property", + "signature": "disabledSubtext: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Disabled de-emphasized text, for use on disabledBackground." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabledText": { + "kind": "property", + "signature": "disabledText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled button text." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "errorBackground": { + "kind": "property", + "signature": "errorBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background for errors, if necessary, or highlighting the section of the page where the error is present." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "errorText": { + "kind": "property", + "signature": "errorText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default color of error text, used on bodyBackground." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "focusBorder": { + "kind": "property", + "signature": "focusBorder: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color of the outline around focused controls that don't already have a border; e.g. menu items" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputBackground": { + "kind": "property", + "signature": "inputBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color of an input, e.g. textbox background." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputBackgroundChecked": { + "kind": "property", + "signature": "inputBackgroundChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background of a checked control; e.g. checked radio button's dot, checked toggle's background." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputBackgroundCheckedHovered": { + "kind": "property", + "signature": "inputBackgroundCheckedHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background of a checked and hovered control; e.g. checked checkbox's background color on hover." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputBorder": { + "kind": "property", + "signature": "inputBorder: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The border of a large input control in its resting, state; e.g. the box of dropdown." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputBorderHovered": { + "kind": "property", + "signature": "inputBorderHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The border color of a large hovered input control, such as textbox." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputFocusBorderAlt": { + "kind": "property", + "signature": "inputFocusBorderAlt: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The alternate focus border color for elements that already have a border; e.g. text field borders on focus." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputForegroundChecked": { + "kind": "property", + "signature": "inputForegroundChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio button's background color around the dot." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "inputPlaceholderText": { + "kind": "property", + "signature": "inputPlaceholderText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color of placeholder text." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "link": { + "kind": "property", + "signature": "link: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color of a link." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "linkHovered": { + "kind": "property", + "signature": "linkHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color of a hovered link. Also used when the link is active." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listBackground": { + "kind": "property", + "signature": "listBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color for the entire list." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listHeaderBackgroundHovered": { + "kind": "property", + "signature": "listHeaderBackgroundHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color for a hovered list header." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listHeaderBackgroundPressed": { + "kind": "property", + "signature": "listHeaderBackgroundPressed: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color for a pressed list header." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listItemBackgroundChecked": { + "kind": "property", + "signature": "listItemBackgroundChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color of a checked list item." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listItemBackgroundCheckedHovered": { + "kind": "property", + "signature": "listItemBackgroundCheckedHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color of a checked and hovered list item." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listItemBackgroundHovered": { + "kind": "property", + "signature": "listItemBackgroundHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background color of a hovered list item." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listText": { + "kind": "property", + "signature": "listText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default text color for list item titles and text in column fields." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "listTextColor": { + "kind": "property", + "signature": "listTextColor: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [ + { + "kind": "text", + "text": "This slot was incorrectly named. Use listText instead." + } + ], + "summary": [ + { + "kind": "text", + "text": "Deprecated. Do not use." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "menuHeader": { + "kind": "property", + "signature": "menuHeader: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The headers in menus that denote title of a section." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "menuIcon": { + "kind": "property", + "signature": "menuIcon: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The default colors of icons in menus." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "menuItemBackgroundChecked": { + "kind": "property", + "signature": "menuItemBackgroundChecked: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [ + { + "kind": "text", + "text": "(Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item whose submenu is open, a selected dropdown item." + } + ], + "summary": [ + { + "kind": "text", + "text": "Deprecated. Do not use." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "menuItemBackgroundHovered": { + "kind": "property", + "signature": "menuItemBackgroundHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The background of a hovered menu item." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonBackground": { + "kind": "property", + "signature": "primaryButtonBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a primary button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonBackgroundHovered": { + "kind": "property", + "signature": "primaryButtonBackgroundHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a hovered primary button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonBackgroundPressed": { + "kind": "property", + "signature": "primaryButtonBackgroundPressed: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background of a pressed primary button; i.e. currently being clicked by mouse" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonBorder": { + "kind": "property", + "signature": "primaryButtonBorder: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Border of a primary button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonText": { + "kind": "property", + "signature": "primaryButtonText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a primary button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonTextHovered": { + "kind": "property", + "signature": "primaryButtonTextHovered: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a hovered primary button" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "primaryButtonTextPressed": { + "kind": "property", + "signature": "primaryButtonTextPressed: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color of text in a pressed primary button; i.e. currently being clicked by mouse" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "smallInputBorder": { + "kind": "property", + "signature": "smallInputBorder: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "successBackground": { + "kind": "property", + "signature": "successBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background for success" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "variantBorder": { + "kind": "property", + "signature": "variantBorder: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color of the border that provides contrast between an element, such as a card, and an emphasized background." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "warningBackground": { + "kind": "property", + "signature": "warningBackground: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Background for warning messages." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "warningHighlight": { + "kind": "property", + "signature": "warningHighlight: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Foreground color for warning highlights" + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "warningText": { + "kind": "property", + "signature": "warningText: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The color of text on errorBackground, warningBackground, blockingBackground, or successBackground." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ITheme": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Collection of theme values, which can be used to programatically style components." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "disableGlobalClassNames": { + "kind": "property", + "signature": "disableGlobalClassNames: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Diables global styles on Fabric components. This will prevent global overrides that might have been set by other Fabric users from applying to your components." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This has a vary narrow use case and most likely should be avoided." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "fonts": { + "kind": "property", + "signature": "fonts: IFontStyles;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IFontStyles", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Font styles for different sizes." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "isInverted": { + "kind": "property", + "signature": "isInverted: boolean;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the theme is inverted." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "palette": { + "kind": "property", + "signature": "palette: IPalette;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IPalette", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Color palette." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "semanticColors": { + "kind": "property", + "signature": "semanticColors: ISemanticColors;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "ISemanticColors", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The collection of all semantic slots for colors used in themes." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ThemeChangedEventArgs": { + "kind": "class", + "extends": "SPEventArgs", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The object passed when the IThemeProvider.themeChangedEvent is raised." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "theme": { + "kind": "property", + "signature": "readonly theme: ITheme | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "ITheme | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The new theme. If the value is undefined, then the theme was cleared." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "ThemeProvider": { + "kind": "class", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "members": { + "__constructor": { + "kind": "constructor", + "signature": "constructor(serviceScope: ServiceScope, theme?: ITheme);", + "parameters": { + "serviceScope": { + "name": "serviceScope", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "ServiceScope" + }, + "theme": { + "name": "theme", + "description": [], + "isOptional": true, + "isSpread": false, + "type": "ITheme" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Constructs a new instance of the " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "ThemeProvider" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-component-base", + "exportName": "ThemeProvider", + "memberName": "" + } + }, + { + "kind": "text", + "text": " class" + } + ], + "remarks": [] + }, + "serviceKey": { + "kind": "property", + "signature": "static readonly serviceKey: ServiceKey;", + "isOptional": false, + "isReadOnly": true, + "isStatic": true, + "type": "ServiceKey", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The service key for ThemeProvider." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "themeChangedEvent": { + "kind": "property", + "signature": "readonly themeChangedEvent: SPEvent;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "SPEvent", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Raised when the theme changes with the new theme as an argument." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": true + }, + "tryGetTheme": { + "kind": "method", + "signature": "tryGetTheme(): IReadonlyTheme | undefined;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IReadonlyTheme | undefined", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If set, get the current scoped theme." } ], "remarks": [], diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index 3f74ebd8..bdedc126 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -198,7 +198,16 @@ "remarks": [ { "kind": "text", - "text": "The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's Math.random() function and may be not be suitable for some applications." + "text": "The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's " + }, + { + "kind": "code", + "text": "Math.random()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " function and may be not be suitable for some applications." }, { "kind": "paragraph" @@ -212,7 +221,7 @@ "elements": [ { "kind": "text", - "text": "RFC4122" + "text": " RFC4122" } ], "targetUrl": "https://www.ietf.org/rfc/rfc4122.txt" @@ -316,7 +325,25 @@ "summary": [ { "kind": "text", - "text": "Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by Guid.tryParse(). This function is cheaper than Guid.tryParse() because it does not construct a Guid object." + "text": "Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by " + }, + { + "kind": "code", + "text": "Guid.tryParse()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ". This function is cheaper than " + }, + { + "kind": "code", + "text": "Guid.tryParse()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " because it does not construct a Guid object." } ], "remarks": [], @@ -396,7 +423,43 @@ "remarks": [ { "kind": "text", - "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" + "text": "Example syntaxes accepted by this function:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- " + }, + { + "kind": "code", + "text": "\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"", + "highlighter": "plain" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- " + }, + { + "kind": "code", + "text": "\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"", + "highlighter": "plain" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- " + }, + { + "kind": "code", + "text": "\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"", + "highlighter": "plain" } ], "isBeta": false, @@ -422,7 +485,12 @@ }, { "kind": "text", - "text": "Example: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489'" + "text": "Example: " + }, + { + "kind": "code", + "text": "'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'", + "highlighter": "plain" } ] }, @@ -479,7 +547,43 @@ "remarks": [ { "kind": "text", - "text": "Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)'" + "text": "Example syntaxes accepted by this function:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- " + }, + { + "kind": "code", + "text": "\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"", + "highlighter": "plain" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- " + }, + { + "kind": "code", + "text": "\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"", + "highlighter": "plain" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- " + }, + { + "kind": "code", + "text": "\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"", + "highlighter": "plain" } ], "isBeta": false, @@ -2442,7 +2546,43 @@ "remarks": [ { "kind": "text", - "text": "This function replaces template parameters such as \"{0}\" or \"{1}\" with the corresponding argument. If the value is null or undefined, it will be replaced by the word \"null\" or \"undefined\". The format string s must not be null or undefined." + "text": "This function replaces template parameters such as " + }, + { + "kind": "code", + "text": "\"{0}\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "\"{1}\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " with the corresponding argument. If the value is null or undefined, it will be replaced by the word " + }, + { + "kind": "code", + "text": "\"null\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "\"undefined\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ". The format string s must not be null or undefined." }, { "kind": "paragraph" @@ -2454,9 +2594,19 @@ { "kind": "paragraph" }, + { + "kind": "code", + "text": "Text.format(\"hello {0}!\", \"world\")", + "highlighter": "plain" + }, { "kind": "text", - "text": "Text.format(\"hello {0}!\", \"world\") will return \"hello world!\"" + "text": " will return " + }, + { + "kind": "code", + "text": "\"hello world!\"", + "highlighter": "plain" } ], "isBeta": false, @@ -2516,13 +2666,40 @@ "summary": [ { "kind": "text", - "text": "Returns the input string, with all instances of searchValue replaced by replaceValue." + "text": "Returns the input string, with all instances of " + }, + { + "kind": "code", + "text": "searchValue", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " replaced by " + }, + { + "kind": "code", + "text": "replaceValue", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "remarks": [ { "kind": "text", - "text": "Note that JavaScript's string.replace() only replaces the first match, unless a global RegExp is provided." + "text": "Note that JavaScript's " + }, + { + "kind": "code", + "text": "string.replace()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " only replaces the first match, unless a global RegExp is provided." } ], "isBeta": false, @@ -2802,7 +2979,12 @@ "remarks": [ { "kind": "text", - "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValue('TEST') ---> 'done' getValue('debug') ---> 'false' getValue('lost') ---> undefined" + "text": "Examples:" + }, + { + "kind": "code-box", + "text": "this._queryParameterList = [\n{key: TEST, value: done},\n{key: DEBUG, value: false},\n{key: TEST, value: notdone}]\n getValue('TEST') ---> 'done'\n getValue('debug') ---> 'false'\n getValue('lost') ---> undefined\n", + "highlighter": "plain" } ], "isBeta": false, @@ -2849,7 +3031,12 @@ "remarks": [ { "kind": "text", - "text": "Examples: this._queryParameterList = [ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: notdone}] getValues('TEST') ---> ['done', 'notdone'] getValues('debug') ---> ['false'] getValues('lost') ---> undefined" + "text": "Examples:" + }, + { + "kind": "code-box", + "text": "this._queryParameterList = [\n{key: TEST, value: done},\n{key: DEBUG, value: false},\n{key: TEST, value: notdone}]\n getValues('TEST') ---> ['done', 'notdone']\n getValues('debug') ---> ['false']\n getValues('lost') ---> undefined\n", + "highlighter": "plain" } ], "isBeta": false, @@ -3093,14 +3280,73 @@ "remarks": [ { "kind": "text", - "text": "This class represents versions that follow the string format of MAJOR.MINOR[.PATCH[.REVISION]] where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons." + "text": "This class represents versions that follow the string format of " + }, + { + "kind": "code", + "text": "MAJOR.MINOR[.PATCH[.REVISION]]", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons." }, { "kind": "paragraph" }, { "kind": "text", - "text": "Examples: 1.0, 1.0.0, 1.0.0.0, 1.01, 01.02.03, 001.002.003.004" + "text": "Examples: " + }, + { + "kind": "code", + "text": "1.0", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "1.0.0", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "1.0.0.0", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "1.01", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "01.02.03", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "001.002.003.004", + "highlighter": "plain" } ], "isBeta": false, @@ -3202,11 +3448,9 @@ "text": "Examples:" }, { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1.0.0 equals 1.0.0 -> true; 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true" + "kind": "code-box", + "text": "1.0.0 equals 1.0.0 -> true;\n2.0.1 equals 2.0.0 -> false;\n3.0 equals 3.0.0 -> true;\n04.01 equals 4.1 -> true\n", + "highlighter": "plain" } ], "isBeta": false, @@ -3256,11 +3500,9 @@ "text": "Examples:" }, { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true" + "kind": "code-box", + "text": "1.0.0 greaterThan 0.0.9 -> true;\n2.0 greaterThan 2.0.0 -> false;\n3.0.1 greaterThan 3.0 -> true\n", + "highlighter": "plain" } ], "isBeta": false, @@ -3352,11 +3594,9 @@ "text": "Examples:" }, { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "0.9.9 lessThan 1.0.0 -> true; 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false" + "kind": "code-box", + "text": "0.9.9 lessThan 1.0.0 -> true;\n2.0 lessThan 2.0.0 -> false;\n3.0 lessThan 3.0.1 -> true;\n04.01 lessThan 4.1 -> false\n", + "highlighter": "plain" } ], "isBeta": false, @@ -3559,11 +3799,9 @@ "text": "Examples:" }, { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1.0.0 satisfies 1.0.0 -> true; 1.1.0 satisfies 1.0.0 -> true; 2.0.0 satisfies 1.0.0 -> false; 1.0.0 satisfies 1.1.0 -> false" + "kind": "code-box", + "text": "1.0.0 satisfies 1.0.0 -> true;\n1.1.0 satisfies 1.0.0 -> true;\n2.0.0 satisfies 1.0.0 -> false;\n1.0.0 satisfies 1.1.0 -> false\n", + "highlighter": "plain" } ], "isBeta": false, diff --git a/generate-docs/json/sp-dialog.api.json b/generate-docs/json/sp-dialog.api.json index 9dd4a9e6..576b57c7 100644 --- a/generate-docs/json/sp-dialog.api.json +++ b/generate-docs/json/sp-dialog.api.json @@ -82,7 +82,7 @@ "description": [ { "kind": "text", - "text": "the dialog configuration that affects how the dialog is displayed Example: constructor(cacheReference: any) { super(); this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. this._cache.refresh(); // This is bad practice. // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() }" + "text": "the dialog configuration that affects how the dialog is displayed *" } ], "isOptional": true, @@ -94,13 +94,61 @@ "summary": [ { "kind": "text", - "text": "Constructor for the BaseDialog class." + "text": "Constructor for the " + }, + { + "kind": "code", + "text": "BaseDialog", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class." } ], "remarks": [ { "kind": "text", - "text": "It is important to keep the constructor lightweight. Use onBeforeOpen() for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric onBeforeOpen() and onAfterClose() events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose." + "text": "It is important to keep the constructor lightweight. Use " + }, + { + "kind": "code", + "text": "onBeforeOpen()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric " + }, + { + "kind": "code", + "text": "onBeforeOpen()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "onAfterClose()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example:" + }, + { + "kind": "code-box", + "text": " constructor(cacheReference: any) {\n super();\n\n this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache.\n this._cache.refresh(); // This is bad practice.\n // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen()\n }\n", + "highlighter": "plain" } ] }, @@ -124,10 +172,15 @@ "summary": [ { "kind": "text", - "text": "Close the dialog. This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show." + "text": "Close the dialog." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -145,10 +198,9 @@ { "kind": "text", "text": "Use this property to access the container element provided by the framework for rendering." - }, - { - "kind": "paragraph" - }, + } + ], + "remarks": [ { "kind": "text", "text": "See " @@ -173,7 +225,6 @@ "text": " for more information on rendering." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -191,10 +242,15 @@ "summary": [ { "kind": "text", - "text": "If the dialog is visually hidden. This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed." + "text": "If the dialog is visually hidden." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -258,10 +314,15 @@ "summary": [ { "kind": "text", - "text": "This method is called after the dialog is visually closed and gives an opportunity for doing clean up. The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor." + "text": "This method is called after the dialog is visually closed and gives an opportunity for doing clean up." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -278,7 +339,16 @@ "description": [ { "kind": "text", - "text": "A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and onAfterClose() will not be called." + "text": "A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and " + }, + { + "kind": "code", + "text": "onAfterClose()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " will not be called." } ] }, @@ -293,7 +363,16 @@ "remarks": [ { "kind": "text", - "text": "All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak." + "text": "All resource allocations in onBeforeOpen() should be properly disposed in " + }, + { + "kind": "code", + "text": "onAfterClose()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " to a avoid memory leak." } ], "isBeta": false, @@ -316,13 +395,47 @@ "summary": [ { "kind": "text", - "text": "The render method must be implemented to render the content of the dialog in the conrainer element provided by the framework. Use this.domElement to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay." + "text": "Renders the contents of the dialog." } ], "remarks": [ { "kind": "text", - "text": "The render method is called once after the modal element is created and opened. It is recommended to use onBeforeOpen() for doing non-UI preperations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice." + "text": "The " + }, + { + "kind": "code", + "text": "render", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " method must be implemented to render the content of the dialog in the container element provided by the framework. Use " + }, + { + "kind": "code", + "text": "this.domElement", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The render method is called once after the modal element is created and opened. It is recommended to use " + }, + { + "kind": "code", + "text": "onBeforeOpen()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " for doing non-UI operations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice." } ], "isBeta": false, @@ -377,7 +490,7 @@ "description": [ { "kind": "text", - "text": "Dialog showing options. See" + "text": "Dialog showing options. See " }, { "kind": "api-link", @@ -748,7 +861,7 @@ "description": [ { "kind": "text", - "text": "Dialog showing options. See" + "text": "Dialog showing options. See " }, { "kind": "api-link", @@ -830,7 +943,7 @@ "description": [ { "kind": "text", - "text": "Dialog showing options. The confirmOpen option will be ignored. See" + "text": "Dialog showing options. The confirmOpen option will be ignored. See " }, { "kind": "api-link", @@ -912,7 +1025,7 @@ "description": [ { "kind": "text", - "text": "Dialog showing options. The confirmOpen option will be ignored. See" + "text": "Dialog showing options. The confirmOpen option will be ignored. See " }, { "kind": "api-link", diff --git a/generate-docs/json/sp-dynamic-data.api.json b/generate-docs/json/sp-dynamic-data.api.json index 35a4c103..e0652a31 100644 --- a/generate-docs/json/sp-dynamic-data.api.json +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -29,17 +29,36 @@ "remarks": [ { "kind": "text", - "text": "The reference string is of the form : or ::" + "text": "The reference string is of the form " + }, + { + "kind": "code", + "text": ":", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "::", + "highlighter": "plain" }, { "kind": "paragraph" }, { "kind": "text", - "text": "Examples of references are: PageContext:user WebPart..:myComplexProperty:myArray[0].lastName" + "text": "Examples of references are: " + }, + { + "kind": "code", + "text": "WebPart..:myComplexProperty:myArray[0].lastName", + "highlighter": "plain" } ], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { "__constructor": { @@ -97,7 +116,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -118,7 +137,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -139,7 +158,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -160,7 +179,67 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IDynamicDataAnnotatedPropertyValue": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "metadata": { + "kind": "property", + "signature": "metadata?: IDynamicDataPropertyValueMetadataCollection;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IDynamicDataPropertyValueMetadataCollection", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Metadata describing the sample value of the property." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "sampleValue": { + "kind": "property", + "signature": "sampleValue: any;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "any", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Sample value of a property" + } + ], + "remarks": [], + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -181,9 +260,84 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { + "allowedEvents": { + "kind": "method", + "signature": "allowedEvents?(): ReadonlyArray;", + "accessModifier": "", + "isOptional": true, + "isStatic": false, + "returnValue": { + "type": "ReadonlyArray", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns list of allowed events on the dynamic data source." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When this function returns a non-empty result, then source must define 'sendEvent' api." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If this api is not defined or returns an empty array, then no consumer will be able to talk to this source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getAnnotatedPropertyValue": { + "kind": "method", + "signature": "getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;", + "accessModifier": "", + "isOptional": true, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataAnnotatedPropertyValue | undefined", + "description": [] + }, + "parameters": { + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "One of the property ids exposed from the dynamic data source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, "getPropertyDefinitions": { "kind": "method", "signature": "getPropertyDefinitions(): ReadonlyArray;", @@ -199,11 +353,11 @@ "summary": [ { "kind": "text", - "text": "Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component." + "text": "Returns all the property definitions that the DataSource will provide." } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -231,7 +385,68 @@ "summary": [ { "kind": "text", - "text": "Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component." + "text": "Given a property id, returns the value of the property." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It is assumed that when this function returns an array, it is homogeneous." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "sendEvent": { + "kind": "method", + "signature": "sendEvent?(eventName: string, data: any): void;", + "accessModifier": "", + "isOptional": true, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "eventName": { + "name": "eventName", + "description": [ + { + "kind": "text", + "text": "A case-sensitive string representing the name of the event." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "data": { + "name": "data", + "description": [ + { + "kind": "text", + "text": "Data to be sent to the dynamic data source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "any" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source." } ], "remarks": [], @@ -242,26 +457,33 @@ } } }, - "IDynamicDataPropertyDefinition": { + "IDynamicDataEventDefinition": { "kind": "interface", - "extends": "IDynamicDataPropertyMetadata", + "extends": "", "implements": "", "typeParameters": [], "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users." + "text": "Definition of an event which a dynamic data source accepts." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "It includes the name of the event and description to be seen and used by end users." } ], "remarks": [], "isBeta": true, "isSealed": false, "members": { - "id": { + "description": { "kind": "property", - "signature": "id: string;", - "isOptional": false, + "signature": "description?: string;", + "isOptional": true, "isReadOnly": false, "isStatic": false, "type": "string", @@ -269,15 +491,31 @@ "summary": [ { "kind": "text", - "text": "Id of the property. This can only contains letters, numbers, dashes and underscores." + "text": "User-friendly, localized description of the event." } ], - "remarks": [ + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "name": { + "kind": "property", + "signature": "name: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ { "kind": "text", - "text": "The regular expression used to validate the constraints is /^[a-zA-Z0-9\\-_]+$/ Example: \"myFiles\"" + "text": "Event name" } ], + "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, @@ -286,6 +524,45 @@ } } }, + "IDynamicDataPropertyDefinition": { + "kind": "interface", + "extends": "IDynamicDataPropertyMetadata", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "id": { + "kind": "property", + "signature": "id: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Id of the property. This can only contains letters, numbers, dashes and underscores. Example: \"myFiles\" or \"time_in_24-hour_clock\"" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, "IDynamicDataPropertyMetadata": { "kind": "interface", "extends": "", @@ -299,7 +576,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { "description": { @@ -317,7 +594,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -338,7 +615,46 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IDynamicDataPropertyValueMetadata": { + "kind": "interface", + "extends": "IDynamicDataPropertyMetadata", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Metadata describing the sample value of the property." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "metadata": { + "kind": "property", + "signature": "metadata?: IDynamicDataPropertyValueMetadataCollection;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IDynamicDataPropertyValueMetadataCollection", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Metadata describing the sample value of the property." + } + ], + "remarks": [], + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -346,6 +662,87 @@ } } }, + "IDynamicDataPropertyValueMetadataCollection": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Important note:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "1. Key in the metadata should match the key in the sample value object." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example for more details." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For example:" + }, + { + "kind": "code-box", + "text": "case 1: With simple values\n Sample Property Id value - {\n firstName: 'Bob',\n lastName: 'Smith',\n age: 30\n }\n\n MetadataCollection for the above object would be -\n metadataCollection: {\n 'firstName': { title: 'First Name' },\n 'lastName': { title: 'Last Name' },\n 'age': { title: 'Age' }\n }\n\nCase 2: With complex values\n Sample Property Id value - {\n person: {\n firstName: 'Bob',\n lastName: 'Smith',\n age: 30\n },\n visitedLocations: [\n {\n city: 'Redmond',\n state: 'WA'\n },\n {\n city: 'New York City',\n state: 'NY'\n }\n ]\n }\n\n MetadataCollection for the above object would be -\n metadataCollection: {\n 'person': {\n title: 'Person',\n metadataCollection: {\n 'firstName': { title: 'First Name' },\n 'lastName': { title: 'Last Name' },\n 'age': { title: 'Age' }\n }\n },\n 'vistedLocations': {\n title: 'Visted Locations',\n metadataCollection: {\n 'city': { title: 'City' },\n 'state': { title: 'State' }\n }\n }\n }\n", + "highlighter": "plain" + } + ], + "isBeta": false, + "isSealed": false, + "members": { + "__index": { + "kind": "method", + "signature": "[key: string]: IDynamicDataPropertyValueMetadata;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataPropertyValueMetadata", + "description": [] + }, + "parameters": { + "key": { + "name": "key", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, "IDynamicDataSource": { "kind": "interface", "extends": "", @@ -359,9 +756,77 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { + "allowedEvents": { + "kind": "method", + "signature": "allowedEvents?(): ReadonlyArray;", + "accessModifier": "", + "isOptional": true, + "isStatic": false, + "returnValue": { + "type": "ReadonlyArray", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source must define 'sendData' api." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If this api is not defined or returns an empty map, then no consumer will be able to talk to this source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "getAnnotatedPropertyValue": { + "kind": "method", + "signature": "getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "IDynamicDataAnnotatedPropertyValue", + "description": [] + }, + "parameters": { + "propertyId": { + "name": "propertyId", + "description": [ + { + "kind": "text", + "text": "One of the property ids exposed from the dynamic data source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, "getPropertyDefinitions": { "kind": "method", "signature": "getPropertyDefinitions(): ReadonlyArray;", @@ -381,7 +846,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -413,7 +878,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false @@ -433,7 +898,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -454,11 +919,67 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false + }, + "sendEvent": { + "kind": "method", + "signature": "sendEvent?(eventName: string, data: any): void;", + "accessModifier": "", + "isOptional": true, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": { + "eventName": { + "name": "eventName", + "description": [ + { + "kind": "text", + "text": "A case-sensitive string representing the name of the event." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "data": { + "name": "data", + "description": [ + { + "kind": "text", + "text": "Data to be sent to the dynamic data source." + } + ], + "isOptional": false, + "isSpread": false, + "type": "any" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source." + } + ], + "remarks": [], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false } } }, @@ -475,7 +996,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "members": { "alias": { @@ -493,7 +1014,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -514,7 +1035,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -535,7 +1056,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -556,7 +1077,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, @@ -577,7 +1098,7 @@ } ], "remarks": [], - "isBeta": true, + "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index 254cb56c..29ede74c 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -477,10 +477,6 @@ } ], "targetUrl": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" - }, - { - "kind": "text", - "text": "" } ], "remarks": [ @@ -744,14 +740,10 @@ "elements": [ { "kind": "text", - "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" + "text": " \"Complete basic operations using SharePoint 2013 REST endpoints\" " } ], "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -1627,10 +1619,6 @@ } ], "targetUrl": "https://github.com/microsoftgraph/msgraph-sdk-javascript" - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -3016,7 +3004,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.arrayBuffer" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Body" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3040,7 +3042,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.blob" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Body" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3060,7 +3076,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.bodyUsed" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Body" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3104,7 +3134,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.formData" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Body" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3124,7 +3168,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.headers" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Response" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3149,7 +3207,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.json" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Body" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3185,7 +3257,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.ok" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Response" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3206,7 +3292,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.status" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Response" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3227,7 +3327,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.statusText" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Response" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3252,7 +3366,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Body.text" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Body" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3272,7 +3400,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.type" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Response" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3293,7 +3435,21 @@ "summary": [ { "kind": "text", - "text": "See documentation for whatwg-fetch:Response.url" + "text": "See documentation for the browser's " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": " Response" + } + ], + "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + }, + { + "kind": "text", + "text": " API" } ], "remarks": [], @@ -3438,14 +3594,10 @@ "elements": [ { "kind": "text", - "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" + "text": " \"Complete basic operations using SharePoint 2013 REST endpoints\" " } ], "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -4286,10 +4438,6 @@ } ], "targetUrl": "https://github.com/microsoftgraph/msgraph-sdk-javascript" - }, - { - "kind": "text", - "text": "" } ], "isBeta": false, @@ -4378,10 +4526,6 @@ } ], "targetUrl": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph" - }, - { - "kind": "text", - "text": "" } ], "remarks": [ @@ -5273,6 +5417,9 @@ ], "targetUrl": "https://fetch.spec.whatwg.org/" }, + { + "kind": "paragraph" + }, { "kind": "text", "text": "However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details." @@ -6172,10 +6319,6 @@ "exportName": "SPHttpClient", "memberName": "" } - }, - { - "kind": "text", - "text": "" } ], "remarks": [], diff --git a/generate-docs/json/sp-listview-extensibility.api.json b/generate-docs/json/sp-listview-extensibility.api.json index 0ebf55bc..95e9f084 100644 --- a/generate-docs/json/sp-listview-extensibility.api.json +++ b/generate-docs/json/sp-listview-extensibility.api.json @@ -736,10 +736,6 @@ "exportName": "BaseListViewCommandSet", "memberName": "onExecute" } - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -815,10 +811,6 @@ "exportName": "BaseListViewCommandSet", "memberName": "onListViewUpdated" } - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -1131,7 +1123,7 @@ "summary": [ { "kind": "text", - "text": "Manifest for the client side component." + "text": "Manifest for the client-side component." } ], "remarks": [], diff --git a/generate-docs/json/sp-odata-types.api.json b/generate-docs/json/sp-odata-types.api.json index dc4204e4..344d6132 100644 --- a/generate-docs/json/sp-odata-types.api.json +++ b/generate-docs/json/sp-odata-types.api.json @@ -84,10 +84,6 @@ } ], "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -105,7 +101,12 @@ "summary": [ { "kind": "text", - "text": "Example: { StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }" + "text": "Example: " + }, + { + "kind": "code", + "text": "{ StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }", + "highlighter": "plain" } ], "remarks": [], @@ -137,10 +138,6 @@ } ], "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - }, - { - "kind": "text", - "text": "" } ], "remarks": [], @@ -158,7 +155,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"16.0.4919.3000\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"16.0.4919.3000\"", + "highlighter": "plain" } ], "remarks": [], @@ -179,7 +181,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"", + "highlighter": "plain" } ], "remarks": [], @@ -200,7 +207,12 @@ "summary": [ { "kind": "text", - "text": "Example: [ \"14.0.0.0\", \"15.0.0.0\" ]" + "text": "Example: " + }, + { + "kind": "code", + "text": "[ \"14.0.0.0\", \"15.0.0.0\" ]", + "highlighter": "plain" } ], "remarks": [], @@ -221,7 +233,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"", + "highlighter": "plain" } ], "remarks": [], @@ -242,7 +259,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + "text": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" } ], "remarks": [], @@ -281,7 +308,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/Date(1453294804000)/\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Date(1453294804000)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -344,7 +376,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"MyListTitleList\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"MyListTitleList\"", + "highlighter": "plain" } ], "remarks": [], @@ -386,7 +423,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -407,7 +449,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/Date(1453294809000)/\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Date(1453294809000)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -428,7 +475,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/Date(1453294809000)/\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Date(1453294809000)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -449,7 +501,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"SP.Data.MyListTitleListItem\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"SP.Data.MyListTitleListItem\"", + "highlighter": "plain" } ], "remarks": [], @@ -470,7 +527,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/sites/PubSite\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/sites/PubSite\"", + "highlighter": "plain" } ], "remarks": [], @@ -491,7 +553,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -512,7 +579,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"Pages\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"Pages\"", + "highlighter": "plain" } ], "remarks": [], @@ -533,7 +605,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + "text": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" } ], "remarks": [], @@ -551,7 +633,12 @@ "summary": [ { "kind": "text", - "text": "Example: { StringValue: \"0x010100C5...\" }" + "text": "Example: " + }, + { + "kind": "code", + "text": "{ StringValue: \"0x010100C5...\" }", + "highlighter": "plain" } ], "remarks": [], @@ -609,7 +696,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -630,7 +722,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData SP.NavigationNode object. https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" + "text": "Represents an OData SP.NavigationNode object. " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" } ], "remarks": [], @@ -790,7 +892,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" + "text": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" } ], "remarks": [], @@ -850,7 +962,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + "text": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" } ], "remarks": [], @@ -868,7 +990,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"someone@example.com\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"someone@example.com\"", + "highlighter": "plain" } ], "remarks": [], @@ -926,7 +1053,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"i:0#.w|domain\\user\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"i:0#.w|domain\\user\"", + "highlighter": "plain" } ], "remarks": [], @@ -1015,7 +1147,12 @@ "summary": [ { "kind": "text", - "text": "Example: \"DOMAIN\\user\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"DOMAIN\\user\"", + "highlighter": "plain" } ], "remarks": [], @@ -1057,7 +1194,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" + "text": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" } ], "remarks": [], @@ -1081,7 +1228,12 @@ "remarks": [ { "kind": "text", - "text": "Example: \"359af2a7-b73c-4aac-874c-60a865da0be7\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"359af2a7-b73c-4aac-874c-60a865da0be7\"", + "highlighter": "plain" } ], "isBeta": false, @@ -1114,7 +1266,12 @@ }, { "kind": "text", - "text": "Example: \"{ \\\"maxItemsToShow\\\": 123 }\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"{ \\\"maxItemsToShow\\\": 123 }\"", + "highlighter": "plain" } ], "isBeta": false, @@ -1197,7 +1354,12 @@ "summary": [ { "kind": "text", - "text": "Gets a value that specifies the identifier (GUID) of the custom action. Example: \"48309f28-53aa-43ed-b113-625120e5af6f\"" + "text": "Gets a value that specifies the identifier (GUID) of the custom action. Example: " + }, + { + "kind": "code", + "text": "\"48309f28-53aa-43ed-b113-625120e5af6f\"", + "highlighter": "plain" } ], "remarks": [], @@ -1245,7 +1407,12 @@ "remarks": [ { "kind": "text", - "text": "Example: \"ClientSide.Application\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"ClientSide.Application\"", + "highlighter": "plain" } ], "isBeta": false, @@ -1465,7 +1632,12 @@ "remarks": [ { "kind": "text", - "text": "Example: \"16.0.1.0\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"16.0.1.0\"", + "highlighter": "plain" } ], "isBeta": false, @@ -1485,7 +1657,17 @@ "summary": [ { "kind": "text", - "text": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + "text": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" } ], "remarks": [], @@ -1503,7 +1685,19 @@ "summary": [ { "kind": "text", - "text": "Gets a value that specifies when the site was created. Example: \"/Date(2016,0,20,12,58,7,0)/\"" + "text": "Gets a value that specifies when the site was created." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Date(2016,0,20,12,58,7,0)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -1545,7 +1739,19 @@ "summary": [ { "kind": "text", - "text": "Gets or sets the URL for a custom master page file to apply to the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\"" + "text": "Gets or sets the URL for a custom master page file to apply to the website." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/sites/PubSite/_catalogs/masterpage/seattle.master\"", + "highlighter": "plain" } ], "remarks": [], @@ -1587,7 +1793,19 @@ "summary": [ { "kind": "text", - "text": "Gets a value that specifies the site identifier for the site. Example: \"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"" + "text": "Gets a value that specifies the site identifier for the site." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -1629,7 +1847,19 @@ "summary": [ { "kind": "text", - "text": "Gets a value that specifies the LCID for the language that is used on the site. Example: 1033" + "text": "Gets a value that specifies the LCID for the language that is used on the site." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "1033", + "highlighter": "plain" } ], "remarks": [], @@ -1650,7 +1880,19 @@ "summary": [ { "kind": "text", - "text": "Gets a value that specifies when an item was last modified in the site. Example: \"/Date(1453618828000)/\"" + "text": "Gets a value that specifies when an item was last modified in the site." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/Date(1453618828000)/\"", + "highlighter": "plain" } ], "remarks": [], @@ -1671,7 +1913,19 @@ "summary": [ { "kind": "text", - "text": "Gets or sets the URL of the master page that is used for the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\"" + "text": "Gets or sets the URL of the master page that is used for the website." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/sites/PubSite/_catalogs/masterpage/seattle.master\"", + "highlighter": "plain" } ], "remarks": [], @@ -1755,7 +2009,19 @@ "summary": [ { "kind": "text", - "text": "Gets or sets the server-relative URL for the Web site. Example: \"/sites/PubSite\"" + "text": "Gets or sets the server-relative URL for the Web site." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/sites/PubSite\"", + "highlighter": "plain" } ], "remarks": [], @@ -1818,7 +2084,19 @@ "summary": [ { "kind": "text", - "text": "Gets or sets the user interface (UI) version of the Web site. Example: 15" + "text": "Gets or sets the user interface (UI) version of the Web site." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "15", + "highlighter": "plain" } ], "remarks": [], @@ -1839,7 +2117,19 @@ "summary": [ { "kind": "text", - "text": "Gets the absolute URL for the website. Example: \"http://example.com/sites/PubSite\"" + "text": "Gets the absolute URL for the website." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"http://example.com/sites/PubSite\"", + "highlighter": "plain" } ], "remarks": [], @@ -1860,7 +2150,19 @@ "summary": [ { "kind": "text", - "text": "Gets the name of the site definition or site template that was used to create the site. Example: \"BLANKINTERNET\"" + "text": "Gets the name of the site definition or site template that was used to create the site." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"BLANKINTERNET\"", + "highlighter": "plain" } ], "remarks": [], diff --git a/generate-docs/json/sp-page-context.api.json b/generate-docs/json/sp-page-context.api.json index d8baccdc..b10365ef 100644 --- a/generate-docs/json/sp-page-context.api.json +++ b/generate-docs/json/sp-page-context.api.json @@ -23,7 +23,16 @@ "summary": [ { "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides culture info for the current user of the application." + "text": "This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It provides culture info for the current user of the application." } ], "remarks": [ @@ -62,7 +71,16 @@ }, { "kind": "text", - "text": "Example: If the currentCultureName is \"en-AU\" then the application could use this information to display the date as 1/8 instead of 8/1." + "text": "Example: If the currentCultureName is " + }, + { + "kind": "code", + "text": "\"en-AU\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " then the application could use this information to display the date as 1/8 instead of 8/1." } ], "isBeta": false, @@ -95,7 +113,16 @@ }, { "kind": "text", - "text": "Example: If the currentUICultureName is \"es-MX\", then the application could use this information to translate the word \"hello\" to \"hola\"." + "text": "Example: If the currentUICultureName is " + }, + { + "kind": "code", + "text": "\"es-MX\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", then the application could use this information to translate the word \"hello\" to \"hola\"." } ], "isBeta": false, @@ -136,7 +163,16 @@ "summary": [ { "kind": "text", - "text": "Interface that represents a SPSystemTime structure." + "text": "Interface that represents a " + }, + { + "kind": "code", + "text": "SPSystemTime", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " structure." } ], "remarks": [], @@ -282,7 +318,16 @@ "summary": [ { "kind": "text", - "text": "Interface that represents the data neccesary to build an TimeZone object." + "text": "Interface that represents the data necessary to build an " + }, + { + "kind": "code", + "text": "TimeZone", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " object." } ], "remarks": [], @@ -410,12 +455,17 @@ "typeParameters": [], "deprecatedMessage": [], "summary": [ + { + "kind": "text", + "text": "The SharePoint page context object." + } + ], + "remarks": [ { "kind": "text", "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache." } ], - "remarks": [], "isBeta": false, "isSealed": false, "members": { @@ -491,7 +541,16 @@ "summary": [ { "kind": "text", - "text": "It provides culture info for the current user of the application. This class is primarily used with the PageContext class." + "text": "It provides culture info for the current user of the application. This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class." } ], "remarks": [], @@ -512,7 +571,16 @@ "summary": [ { "kind": "text", - "text": "Returns whether the PageContext has been initialized." + "text": "Returns whether the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " has been initialized." } ], "remarks": [], @@ -539,14 +607,41 @@ "remarks": [ { "kind": "text", - "text": "This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the _spPageContextInfo window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees." + "text": "This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the " + }, + { + "kind": "code", + "text": "_spPageContextInfo", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees." }, { "kind": "paragraph" }, { "kind": "text", - "text": "NOTE: If certain functionality is exposed in the legacyPageContext but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the legacyPageContext object." + "text": "NOTE: If certain functionality is exposed in the " + }, + { + "kind": "code", + "text": "legacyPageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the " + }, + { + "kind": "code", + "text": "legacyPageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " object." } ], "isBeta": false, @@ -629,7 +724,7 @@ "summary": [ { "kind": "text", - "text": "Contextual information for the SharePoint site collection (\"site\") that is hosting the page." + "text": "Contextual information for the SharePoint site collection (\"SPSite\") that is hosting the page." } ], "remarks": [], @@ -650,7 +745,16 @@ "summary": [ { "kind": "text", - "text": "It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the PageContext class." + "text": "It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class." } ], "remarks": [], @@ -671,7 +775,7 @@ "summary": [ { "kind": "text", - "text": "Contextual information for the SharePoint site (\"web\") that is hosting the page." + "text": "Contextual information for the SharePoint site (\"SPWeb\") that is hosting the page." } ], "remarks": [], @@ -762,7 +866,7 @@ "summary": [ { "kind": "text", - "text": "The client-side equivalent for SharePoint SPField class. Used in Fields property of SPList and SPListItem classes. A field represents the data model for a column in SharePoint list view." + "text": "A field represents the data model for a column in SharePoint list view." } ], "remarks": [ @@ -772,6 +876,28 @@ }, { "kind": "paragraph" + }, + { + "kind": "text", + "text": "This is the client-side equivalent for SharePoint " + }, + { + "kind": "code", + "text": "SPField", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It is used with the " + }, + { + "kind": "code", + "text": "@microsoft/sp-listview-extensibility", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " package." } ], "isBeta": false, @@ -809,10 +935,24 @@ "summary": [ { "kind": "text", - "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." + "text": "This property is only used when a " + }, + { + "kind": "code", + "text": "ClientSideComponentId", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " is specified. It is optional." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -935,7 +1075,16 @@ "summary": [ { "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list that hosts the page." + "text": "This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It provides contextual information for the SharePoint list that hosts the page." } ], "remarks": [ @@ -1003,7 +1152,16 @@ "summary": [ { "kind": "text", - "text": "Returns the server-relative URL for this SPList." + "text": "Returns the server-relative URL for this " + }, + { + "kind": "code", + "text": "SPList", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "remarks": [ @@ -1029,7 +1187,16 @@ "summary": [ { "kind": "text", - "text": "Returns the title for this SPList." + "text": "Returns the title for this " + }, + { + "kind": "code", + "text": "SPList", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "remarks": [], @@ -1050,7 +1217,16 @@ "summary": [ { "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list item that hosts the page." + "text": "This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It provides contextual information for the SharePoint list item that hosts the page." } ], "remarks": [ @@ -1076,7 +1252,16 @@ "summary": [ { "kind": "text", - "text": "The number that identifies the SPListItem on the server." + "text": "The number that identifies the " + }, + { + "kind": "code", + "text": "SPListItem", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " on the server." } ], "remarks": [], @@ -1110,7 +1295,17 @@ }, { "kind": "text", - "text": "For more information, see: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" + "text": "For more information, see: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" + } + ], + "targetUrl": "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" } ], "isBeta": false, @@ -2060,7 +2255,16 @@ "summary": [ { "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site collection (\"site\") that hosts the page." + "text": "This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It provides contextual information for the SharePoint site collection (\"SPSite\") that hosts the page." } ], "remarks": [ @@ -2333,13 +2537,6 @@ { "kind": "text", "text": "It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)" } ], "remarks": [ @@ -2349,6 +2546,11 @@ }, { "kind": "paragraph" + }, + { + "kind": "code-box", + "text": "isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate\nLocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset)\nJune 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)\n", + "highlighter": "plain" } ], "isBeta": true, @@ -2512,7 +2714,16 @@ "summary": [ { "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint user that is accessing the page." + "text": "This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It provides contextual information for the SharePoint user that is accessing the page." } ], "remarks": [ @@ -2544,7 +2755,12 @@ "remarks": [ { "kind": "text", - "text": "Example: \"John Doe\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"John Doe\"", + "highlighter": "plain" } ], "isBeta": false, @@ -2570,7 +2786,12 @@ "remarks": [ { "kind": "text", - "text": "Example: \"example@contoso.com\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"example@contoso.com\"", + "highlighter": "plain" } ], "isBeta": false, @@ -2659,7 +2880,21 @@ "remarks": [ { "kind": "text", - "text": "Example: on-premise user: \"domain\\user\", online user: \"user@domain.com\"" + "text": "Example: on-premise user: " + }, + { + "kind": "code", + "text": "\"domain\\user\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ", online user: " + }, + { + "kind": "code", + "text": "\"user@domain.com\"", + "highlighter": "plain" } ], "isBeta": false, @@ -2721,7 +2956,16 @@ "summary": [ { "kind": "text", - "text": "This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site (\"web\") that hosts the page." + "text": "This class is primarily used with the " + }, + { + "kind": "code", + "text": "PageContext", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " class. It provides contextual information for the SharePoint site (\"SPWeb\") that hosts the page." } ], "remarks": [ @@ -2747,7 +2991,12 @@ "summary": [ { "kind": "text", - "text": "Returns the absolute URL for this SPWeb. Example: \"https://example.com/sites/PubSite/SubWeb\"" + "text": "Returns the absolute URL for this SPWeb. Example: " + }, + { + "kind": "code", + "text": "\"https://example.com/sites/PubSite/SubWeb\"", + "highlighter": "plain" } ], "remarks": [], @@ -2831,7 +3080,25 @@ "summary": [ { "kind": "text", - "text": "Returns true if this SPWeb the container web for an SPApp." + "text": "Returns true if this " + }, + { + "kind": "code", + "text": "SPWeb", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " the container web for an " + }, + { + "kind": "code", + "text": "SPApp", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "remarks": [], @@ -2884,7 +3151,12 @@ "remarks": [ { "kind": "text", - "text": "Example: https://example.com/sites/PubSite/SubWeb/logo.jpg" + "text": "Example:" + }, + { + "kind": "code", + "text": " https://example.com/sites/PubSite/SubWeb/logo.jpg", + "highlighter": "plain" } ], "isBeta": false, @@ -2931,7 +3203,12 @@ "remarks": [ { "kind": "text", - "text": "Example: \"/sites/PubSite/SubWeb\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"/sites/PubSite/SubWeb\"", + "highlighter": "plain" } ], "isBeta": false, @@ -2957,7 +3234,16 @@ "remarks": [ { "kind": "text", - "text": "Example: \"1\" represents the team site template when creating a new site on SharePoint." + "text": "Example: " + }, + { + "kind": "code", + "text": "\"1\"", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " represents the team site template when creating a new site on SharePoint." } ], "isBeta": false, diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index b3c55c0a..de92414b 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -25,7 +25,7 @@ "summary": [ { "kind": "text", - "text": "This abstract class implements the the base functionality for a client side web part. Every client side web part needs to inherit from this class." + "text": "This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs to inherit from this class." } ], "remarks": [ @@ -65,14 +65,34 @@ "remarks": [ { "kind": "text", - "text": "If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." + "text": "It is highly recommended that the web part use the " }, { - "kind": "paragraph" + "kind": "code", + "text": "onInit()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " API to perform any web part specific initialization. Most of the web part features like this.context and " + }, + { + "kind": "code", + "text": "this.properties", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " are not available to be used before the the " + }, + { + "kind": "code", + "text": "onInit()", + "highlighter": "plain" }, { "kind": "text", - "text": "e.g. constructor() { super(); . . class specific constructor code .. }" + "text": " part of the web part loading lifecycle." } ] }, @@ -93,7 +113,14 @@ "remarks": [ { "kind": "text", - "text": "In some environments the host re-renders the web parts frequently, and therefor, opening popups during render will cause popups to open repeatedly and hence poor user experience. As an example, the classic SharePoint pages perform postbacks and hence page re-render on all button clicks. If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render." + "text": "In some environments the host re-renders the web parts frequently, and therefore opening popups during render will cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages perform postbacks causing the page to re-render on all button clicks." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render." } ], "isBeta": false, @@ -184,13 +211,25 @@ "summary": [ { "kind": "text", - "text": "Indicates whether the web part is rendering in Async mode. Default value is false. If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete." + "text": "Indicates whether the web part is rendering in Async mode." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The default value is false." } ], - "remarks": [], "isBeta": false, "isSealed": false, - "isVirtual": false, + "isVirtual": true, "isOverride": false, "isEventProperty": false }, @@ -233,7 +272,7 @@ ], "isBeta": false, "isSealed": false, - "isVirtual": false, + "isVirtual": true, "isOverride": false }, "onDispose": { @@ -262,7 +301,7 @@ ], "isBeta": false, "isSealed": false, - "isVirtual": false, + "isVirtual": true, "isOverride": false }, "render": { @@ -304,7 +343,16 @@ "summary": [ { "kind": "text", - "text": "This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the render() API but the actual rendering is complete only after the iframe loading completes." + "text": "This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the " + }, + { + "kind": "code", + "text": "render()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " API but the actual rendering is complete only after the iframe loading completes." } ], "remarks": [], @@ -350,7 +398,7 @@ "summary": [ { "kind": "text", - "text": "This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true. Till a full re-render of the web part happens." + "text": "This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens." } ], "remarks": [], @@ -410,7 +458,7 @@ "summary": [ { "kind": "text", - "text": "This abstract class implements the UI-agnostic base functionality for a client side web part. The purpose is to allow a common core between 2D and MR WebParts." + "text": "This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts." } ], "remarks": [], @@ -425,20 +473,22 @@ "summary": [ { "kind": "text", - "text": "Constructor for the BaseWebPart class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." + "text": "Constructor for the " }, { - "kind": "paragraph" + "kind": "code", + "text": "BaseWebPart", + "highlighter": "plain" }, { "kind": "text", - "text": "e.g. constructor() { super(); . . class specific constructor code .. }" + "text": " class." + } + ], + "remarks": [ + { + "kind": "text", + "text": "It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." } ] }, @@ -542,7 +592,7 @@ "summary": [ { "kind": "text", - "text": "This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive." + "text": "This property is used to change the web part's property pane interaction from Reactive to NonReactive." } ], "remarks": [ @@ -688,7 +738,16 @@ }, { "kind": "text", - "text": "An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use onAfterDeserialize to check the dataVersion and fix the property bag." + "text": "An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use " + }, + { + "kind": "code", + "text": "onAfterDeserialize", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " to check the dataVersion and fix the property bag." } ], "isBeta": false, @@ -833,12 +892,17 @@ "parameters": {}, "deprecatedMessage": [], "summary": [ + { + "kind": "text", + "text": "This event method is called when the web part is initialized." + } + ], + "remarks": [ { "kind": "text", "text": "This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -879,14 +943,14 @@ }, { "kind": "text", - "text": "- When user clicks 'x'(close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." + "text": "- When user clicks the \"X\" (close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." }, { "kind": "paragraph" }, { "kind": "text", - "text": "- When user clciks 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." + "text": "- When user clicks the 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." }, { "kind": "paragraph" @@ -960,7 +1024,16 @@ "description": [ { "kind": "text", - "text": "JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of '__CustomField_'." + "text": "JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of " + }, + { + "kind": "code", + "text": "__CustomField_", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "isOptional": false, @@ -1088,7 +1161,26 @@ "remarks": [ { "kind": "text", - "text": "See IWebPartPropertiesMetadata for more information about how to define metadata" + "text": "See " + }, + { + "kind": "api-link", + "elements": [ + { + "kind": "text", + "text": "IWebPartPropertiesMetadata" + } + ], + "target": { + "scopeName": "@microsoft", + "packageName": "sp-webpart-base", + "exportName": "IWebPartPropertiesMetadata", + "memberName": "" + } + }, + { + "kind": "text", + "text": " for more information about how to define metadata" } ], "isBeta": false, @@ -1151,6 +1243,32 @@ "isBeta": false, "isSealed": false, "members": { + "formFactor": { + "kind": "property", + "signature": "readonly formFactor: WebPartFormFactor;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "WebPartFormFactor", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Form factor of the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas." + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, "manifest": { "kind": "property", "signature": "readonly manifest: IClientSideWebPartManifestInstance;", @@ -1162,7 +1280,7 @@ "summary": [ { "kind": "text", - "text": "Manifest for the client side component." + "text": "Manifest for the client-side component." } ], "remarks": [], @@ -1216,6 +1334,59 @@ } } }, + "DynamicDataSharedDepth": { + "kind": "enum", + "values": { + "None": { + "kind": "enum value", + "value": "0", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that nothing is shared." + } + ], + "remarks": [], + "isBeta": false + }, + "Property": { + "kind": "enum value", + "value": "2", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that both the dynamic data source and the property are shared." + } + ], + "remarks": [], + "isBeta": false + }, + "Source": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates that the dynamic data source is shared." + } + ], + "remarks": [], + "isBeta": false + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Enum for the possible values of shared depth of the dynamic data reference." + } + ], + "remarks": [], + "isBeta": false + }, "IClientSideWebPartStatusRenderer": { "kind": "interface", "extends": "", @@ -1418,7 +1589,7 @@ } } }, - "IPlaceholderSpinnerProps": { + "IDynamicDataSharedPropertyConfiguration": { "kind": "interface", "extends": "", "implements": "", @@ -1427,25 +1598,25 @@ "summary": [ { "kind": "text", - "text": "Interface for properties used to display the loading spinner in the web part display area." + "text": "Configuration related to a shared property." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { - "hideSpinner": { + "filters": { "kind": "property", - "signature": "hideSpinner?: boolean;", + "signature": "filters?: IDynamicDataSharedPropertyFilters;", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "boolean", + "type": "IDynamicDataSharedPropertyFilters", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner" + "text": "Filters for the shared property." } ], "remarks": [], @@ -1454,11 +1625,29 @@ "isVirtual": false, "isOverride": false, "isEventProperty": false - }, - "label": { + } + } + }, + "IDynamicDataSharedPropertyFilters": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Property pane dynamic data property filters." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "propertyId": { "kind": "property", - "signature": "label: string;", - "isOptional": false, + "signature": "propertyId?: string;", + "isOptional": true, "isReadOnly": false, "isStatic": false, "type": "string", @@ -1466,10 +1655,29 @@ "summary": [ { "kind": "text", - "text": "Label associated with the spinner." + "text": "Property Id" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage: Use this filter when the author can only to connect to a specific property from the selected source." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the dynamic data widget." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -1478,7 +1686,7 @@ } } }, - "IPropertyPaneAccessor": { + "IDynamicDataSharedSourceConfiguration": { "kind": "interface", "extends": "", "implements": "", @@ -1487,89 +1695,364 @@ "summary": [ { "kind": "text", - "text": "Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane." + "text": "Configuration related to a shared source." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { - "isPropertyPaneOpen": { - "kind": "method", - "signature": "isPropertyPaneOpen(): boolean;", - "accessModifier": "", - "isOptional": false, + "filters": { + "kind": "property", + "signature": "filters?: IDynamicDataSharedSourceFilters;", + "isOptional": true, + "isReadOnly": false, "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, + "type": "IDynamicDataSharedSourceFilters", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Returns true if the PropertyPane is open." + "text": "Filters for the shared source." } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false }, - "isRenderedByWebPart": { - "kind": "method", - "signature": "isRenderedByWebPart(): boolean;", - "accessModifier": "", - "isOptional": false, + "sourcesLabel": { + "kind": "property", + "signature": "sourcesLabel?: string;", + "isOptional": true, + "isReadOnly": false, "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Indicates whether the PropertyPane was initially opened by the web part." - } - ], - "remarks": [ + "text": "User-friendly, localized label for the sources dropdown." + }, { - "kind": "text", - "text": "For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "open": { - "kind": "method", - "signature": "open(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "paragraph" + }, { "kind": "text", - "text": "This API should be used to open the PropertyPane to help configure the web part." + "text": "default value - 'Connect to source'" } ], "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, - "isOverride": false + "isOverride": false, + "isEventProperty": false + } + } + }, + "IDynamicDataSharedSourceFilters": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Property pane dynamic data source filters." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "componentId": { + "kind": "property", + "signature": "componentId?: Guid;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "Guid", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Component Id." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage: Use this filter when the author should only be able to connect to a specific type of source." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic data widget." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources matching the given component id." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "sourceId": { + "kind": "property", + "signature": "sourceId?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Source Id" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Usage: Use this filter, when the author can only to connect to a specific data source." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the dynamic data widget." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is pre-selected, the control will be disabled to ensure that authors can not change it." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "The source id for a web part will be of the form WebPart." + }, + { + "kind": "html-tag", + "token": "" + }, + { + "kind": "text", + "text": "." + }, + { + "kind": "html-tag", + "token": "" + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPlaceholderSpinnerProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Interface for properties used to display the loading spinner in the web part display area." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "hideSpinner": { + "kind": "property", + "signature": "hideSpinner?: boolean;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "boolean", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "label": { + "kind": "property", + "signature": "label: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Label associated with the spinner." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneAccessor": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "close": { + "kind": "method", + "signature": "close(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to close the PropertyPane to help configure the web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isPropertyPaneOpen": { + "kind": "method", + "signature": "isPropertyPaneOpen(): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Returns true if the PropertyPane is open." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "isRenderedByWebPart": { + "kind": "method", + "signature": "isRenderedByWebPart(): boolean;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "boolean", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Indicates whether the PropertyPane was initially opened by the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false." + } + ], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + }, + "open": { + "kind": "method", + "signature": "open(): void;", + "accessModifier": "", + "isOptional": false, + "isStatic": false, + "returnValue": { + "type": "void", + "description": [] + }, + "parameters": {}, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This API should be used to open the PropertyPane to help configure the web part." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false }, "refresh": { "kind": "method", @@ -2032,16 +2515,175 @@ }, "selectedImageSrc": { "kind": "property", - "signature": "selectedImageSrc?: string;", + "signature": "selectedImageSrc?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The src of image for choice field which is selected." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The text string for the option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneChoiceGroupOptionIconProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane ChoiceGroup icon props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "officeFabricIconFontName": { + "kind": "property", + "signature": "officeFabricIconFontName?: string | null;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string | null", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The name of the icon to use from the Office Fabric icon set." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneChoiceGroupProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane ChoiceGroup props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "label": { + "kind": "property", + "signature": "label?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Descriptive label for the choice group." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "options": { + "kind": "property", + "signature": "options: IPropertyPaneChoiceGroupOption[];", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneChoiceGroupOption[]", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The options for the choice group." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneConditionalGroup": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Property pane conditional group." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "onShowPrimaryGroup": { + "kind": "property", + "signature": "onShowPrimaryGroup?: () => void;", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "string", + "type": "() => void", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "The src of image for choice field which is selected." + "text": "Callback when user clicks to show primary group." } ], "remarks": [], @@ -2051,18 +2693,18 @@ "isOverride": false, "isEventProperty": false }, - "text": { + "onShowSecondaryGroup": { "kind": "property", - "signature": "text: string;", - "isOptional": false, + "signature": "onShowSecondaryGroup?: () => void;", + "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "string", + "type": "() => void", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "The text string for the option." + "text": "Callback when user clicks to show secondary group." } ], "remarks": [], @@ -2071,37 +2713,19 @@ "isVirtual": false, "isOverride": false, "isEventProperty": false - } - } - }, - "IPropertyPaneChoiceGroupOptionIconProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup icon props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "officeFabricIconFontName": { + }, + "primaryGroup": { "kind": "property", - "signature": "officeFabricIconFontName?: string | null;", - "isOptional": true, + "signature": "primaryGroup: IPropertyPaneGroup;", + "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "string | null", + "type": "IPropertyPaneGroup", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "The name of the icon to use from the Office Fabric icon set." + "text": "Primary group to show" } ], "remarks": [], @@ -2110,37 +2734,19 @@ "isVirtual": false, "isOverride": false, "isEventProperty": false - } - } - }, - "IPropertyPaneChoiceGroupProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "label": { + }, + "secondaryGroup": { "kind": "property", - "signature": "label?: string;", - "isOptional": true, + "signature": "secondaryGroup: IPropertyPaneGroup;", + "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "string", + "type": "IPropertyPaneGroup", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Descriptive label for the choice group." + "text": "Secondary group to show" } ], "remarks": [], @@ -2150,18 +2756,18 @@ "isOverride": false, "isEventProperty": false }, - "options": { + "showSecondaryGroup": { "kind": "property", - "signature": "options: IPropertyPaneChoiceGroupOption[];", + "signature": "showSecondaryGroup: boolean;", "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "IPropertyPaneChoiceGroupOption[]", + "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "The options for the choice group." + "text": "Indicating whether the property pane should show primary group or the secondary group." } ], "remarks": [], @@ -2361,7 +2967,7 @@ "elements": [ { "kind": "text", - "text": "React documentation" + "text": " React documentation" } ], "targetUrl": "https://facebook.github.io/react/docs/lists-and-keys.html#keys" @@ -2479,16 +3085,202 @@ "members": { "index": { "kind": "property", - "signature": "index?: number;", + "signature": "index?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Index for this option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "key": { + "kind": "property", + "signature": "key: string | number;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string | number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A key to uniquely identify this option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "text": { + "kind": "property", + "signature": "text: string;", + "isOptional": false, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Text to render for this option." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "type": { + "kind": "property", + "signature": "type?: PropertyPaneDropdownOptionType;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "PropertyPaneDropdownOptionType", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + } + } + }, + "IPropertyPaneDropdownProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane drop down component props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "ariaLabel": { + "kind": "property", + "signature": "ariaLabel?: string;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "string", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A description of the dropdown for the benefit of screen reader users." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ariaPositionInSet": { + "kind": "property", + "signature": "ariaPositionInSet?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "ariaSetSize": { + "kind": "property", + "signature": "ariaSetSize?: number;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "number", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Defines the number of items in the current set of controls. Maps to native aria-setsize attribute." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "calloutProps": { + "kind": "property", + "signature": "calloutProps?: IPropertyPaneDropdownCalloutProps;", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "IPropertyPaneDropdownCalloutProps", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Custom properties for Dropdown's Callout used to render options." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, + "disabled": { + "kind": "property", + "signature": "disabled?: boolean;", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "number", + "type": "boolean", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Index for this option." + "text": "Whether the property pane dropdown option is disabled or not." } ], "remarks": [], @@ -2498,18 +3290,18 @@ "isOverride": false, "isEventProperty": false }, - "key": { + "label": { "kind": "property", - "signature": "key: string | number;", + "signature": "label: string;", "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "string | number", + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "A key to uniquely identify this option." + "text": "Descriptive label for the Dropdown." } ], "remarks": [], @@ -2519,18 +3311,18 @@ "isOverride": false, "isEventProperty": false }, - "text": { + "options": { "kind": "property", - "signature": "text: string;", - "isOptional": false, + "signature": "options?: IPropertyPaneDropdownOption[];", + "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "string", + "type": "IPropertyPaneDropdownOption[]", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Text to render for this option." + "text": "Collection of options for this Dropdown." } ], "remarks": [], @@ -2540,18 +3332,18 @@ "isOverride": false, "isEventProperty": false }, - "type": { + "selectedKey": { "kind": "property", - "signature": "type?: PropertyPaneDropdownOptionType;", + "signature": "selectedKey?: string | number;", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "PropertyPaneDropdownOptionType", + "type": "string | number", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal" + "text": "The key of the initially selected option." } ], "remarks": [], @@ -2563,7 +3355,7 @@ } } }, - "IPropertyPaneDropdownProps": { + "IPropertyPaneDynamicFieldProps": { "kind": "interface", "extends": "", "implements": "", @@ -2572,25 +3364,25 @@ "summary": [ { "kind": "text", - "text": "PropertyPane drop down component props." + "text": "PropertyPaneDynamicField props." } ], "remarks": [], "isBeta": false, "isSealed": false, "members": { - "ariaLabel": { + "filters": { "kind": "property", - "signature": "ariaLabel?: string;", + "signature": "filters?: IPropertyPaneDynamicFieldFilters;", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "string", + "type": "IPropertyPaneDynamicFieldFilters", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "A description of the dropdown for the benefit of screen reader users." + "text": "Filters for the property pane dynamic field." } ], "remarks": [], @@ -2600,18 +3392,18 @@ "isOverride": false, "isEventProperty": false }, - "ariaPositionInSet": { + "label": { "kind": "property", - "signature": "ariaPositionInSet?: number;", - "isOptional": true, + "signature": "label: string;", + "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "number", + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1." + "text": "User-friendly, localized label to identify the field." } ], "remarks": [], @@ -2621,9 +3413,9 @@ "isOverride": false, "isEventProperty": false }, - "ariaSetSize": { + "propertyValueDepth": { "kind": "property", - "signature": "ariaSetSize?: number;", + "signature": "propertyValueDepth?: number;", "isOptional": true, "isReadOnly": false, "isStatic": false, @@ -2632,49 +3424,47 @@ "summary": [ { "kind": "text", - "text": "Defines the number of items in the current set of controls. Maps to native aria-setsize attribute." + "text": "Indicates to what depth of property values are shown on the property pane dynamic data widget." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "If not specified, then max of 2 levels of property value will be shown." } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "calloutProps": { - "kind": "property", - "signature": "calloutProps?: IPropertyPaneDropdownCalloutProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneDropdownCalloutProps", - "deprecatedMessage": [], - "summary": [ + "remarks": [ { "kind": "text", - "text": "Custom properties for Dropdown's Callout used to render options." + "text": "It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, "isOverride": false, "isEventProperty": false }, - "disabled": { + "sourcesLabel": { "kind": "property", - "signature": "disabled?: boolean;", + "signature": "sourcesLabel?: string;", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "boolean", + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Whether the property pane dropdown option is disabled or not." + "text": "User-friendly, localized label for the sources dropdown." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "default value - 'Connect to source'" } ], "remarks": [], @@ -2683,19 +3473,37 @@ "isVirtual": false, "isOverride": false, "isEventProperty": false - }, - "label": { + } + } + }, + "IPropertyPaneDynamicFieldSetProps": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "PropertyPane DynamicFieldSet props." + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "fields": { "kind": "property", - "signature": "label: string;", + "signature": "fields: IPropertyPaneField[];", "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "string", + "type": "IPropertyPaneField[]", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Descriptive label for the Dropdown." + "text": "List of property pane dynamic fields to be configured on the Dynamic Data Widget." } ], "remarks": [], @@ -2705,18 +3513,18 @@ "isOverride": false, "isEventProperty": false }, - "options": { + "label": { "kind": "property", - "signature": "options?: IPropertyPaneDropdownOption[];", - "isOptional": true, + "signature": "label: string;", + "isOptional": false, "isReadOnly": false, "isStatic": false, - "type": "IPropertyPaneDropdownOption[]", + "type": "string", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "Collection of options for this Dropdown." + "text": "User-friendly, localized label to identify the property." } ], "remarks": [], @@ -2726,18 +3534,18 @@ "isOverride": false, "isEventProperty": false }, - "selectedKey": { + "sharedConfiguration": { "kind": "property", - "signature": "selectedKey?: string | number;", + "signature": "sharedConfiguration?:", "isOptional": true, "isReadOnly": false, "isStatic": false, - "type": "string | number", + "type": "{\n /**\n * Indicates to what depth the dynamic reference is shared between the set of fields\n * of the dynamic field set.\n */\n depth: DynamicDataSharedDepth;\n /**\n * Shared source configuration\n */\n source?: IDynamicDataSharedSourceConfiguration;\n /**\n * Shared property configuration\n */\n property?: IDynamicDataSharedPropertyConfiguration;\n }", "deprecatedMessage": [], "summary": [ { "kind": "text", - "text": "The key of the initially selected option." + "text": "Configuration shared between all the entries of the set." } ], "remarks": [], @@ -2754,11 +3562,21 @@ "extends": "", "implements": "", "typeParameters": [], - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ + { + "kind": "code", + "text": "PropertyPaneDynamicData", + "highlighter": "plain" + }, { "kind": "text", - "text": "PropertyPaneDynamicData component props." + "text": " component props." } ], "remarks": [], @@ -2772,11 +3590,16 @@ "isReadOnly": false, "isStatic": false, "type": "string", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", - "text": "Aria Label for text field, if any." + "text": "ARIA Label for text field, if any." } ], "remarks": [], @@ -2793,7 +3616,12 @@ "isReadOnly": false, "isStatic": false, "type": "string", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", @@ -2814,7 +3642,12 @@ "isReadOnly": false, "isStatic": false, "type": "boolean", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", @@ -2835,7 +3668,12 @@ "isReadOnly": false, "isStatic": false, "type": "string", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", @@ -2845,14 +3683,23 @@ "remarks": [ { "kind": "text", - "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." + "text": "When " + }, + { + "kind": "code", + "text": "onGetErrorMessage", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " returns empty string, if this property has a value set then this will be displayed as the error message." }, { "kind": "paragraph" }, { "kind": "text", - "text": "So, make sure to set this only if you want to see an error message displayed for the text field." + "text": "Make sure to set this only if you want to see an error message displayed for the text field." } ], "isBeta": true, @@ -2868,7 +3715,12 @@ "isReadOnly": false, "isStatic": false, "type": "string", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", @@ -2889,11 +3741,16 @@ "isReadOnly": false, "isStatic": false, "type": "(value: string) => string | Promise", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", - "text": "The method is used to get the validation error message and determine whether the input value is valid or not." + "text": "This method is used to get the validation error message and determine whether the input value is valid or not." } ], "remarks": [ @@ -2920,7 +3777,16 @@ }, { "kind": "text", - "text": "When it returns Promise:" + "text": "When it returns " + }, + { + "kind": "code", + "text": "Promise", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ":" }, { "kind": "paragraph" @@ -2950,11 +3816,16 @@ "isReadOnly": false, "isStatic": false, "type": "string", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", - "text": "placeholder text to be displayed in the text field." + "text": "Placeholder text to be displayed in the text field." } ], "remarks": [], @@ -2971,7 +3842,12 @@ "isReadOnly": false, "isStatic": false, "type": "boolean", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", @@ -2997,11 +3873,25 @@ "isReadOnly": false, "isStatic": false, "type": "boolean", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", - "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." + "text": "Run validation when the " + }, + { + "kind": "code", + "text": "PropertyPaneTextField", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " is out of focus or on blur." } ], "remarks": [ @@ -3023,7 +3913,12 @@ "isReadOnly": false, "isStatic": false, "type": "string", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" + } + ], "summary": [ { "kind": "text", @@ -3852,7 +4747,16 @@ "summary": [ { "kind": "text", - "text": "Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds." + "text": "Text field will start to validate after users stop typing for " + }, + { + "kind": "code", + "text": "deferredValidationTime", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " milliseconds." } ], "remarks": [ @@ -3974,13 +4878,97 @@ "summary": [ { "kind": "text", - "text": "Engagement name to log PropertyPaneTextField value change." - } - ], - "remarks": [ + "text": "Name used to log " + }, + { + "kind": "code", + "text": "PropertyPaneTextField", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " value changes for engagement tracking." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The messages will be logged with a format such as " + }, + { + "kind": "code", + "text": ".", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "For example, if " + }, + { + "kind": "code", + "text": "{moduleName: 'ImageWebPart', controlName: 'OverlayText'}", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " is specified, the engagement log might contain:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "1. The action type:" + }, + { + "kind": "paragraph" + }, + { + "kind": "code", + "text": "Add", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ": change from initial/unset state to customized content. (first edit)" + }, + { + "kind": "paragraph" + }, + { + "kind": "code", + "text": "Clear", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ": reset the content of caption element to initial/unset state." + }, + { + "kind": "paragraph" + }, + { + "kind": "code", + "text": "Edit", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ": any edition that changes the content apart from add and clear" + }, + { + "kind": "paragraph" + }, { "kind": "text", - "text": "It will be logged format as .. E.g. {moduleName: 'ImageWebPart', controlName: 'OverlayText'}, it will log: 1. action type, including 'Add', 'Clear' and 'Edit'. Clear: reset the content of caption element to initial/unset state. Add: change from initial/unset state to customized content. (first edit) Edit: any edition that changes the content apart from add and clear 2. text length after each edit." + "text": "2. The text length after each edit" } ], "isBeta": false, @@ -4079,7 +5067,16 @@ }, { "kind": "text", - "text": "When it returns Promise:" + "text": "When it returns " + }, + { + "kind": "code", + "text": "Promise", + "highlighter": "plain" + }, + { + "kind": "text", + "text": ":" }, { "kind": "paragraph" @@ -4507,7 +5504,12 @@ }, { "kind": "text", - "text": "Example: { 'myRichDescription': '
Some standard HTML contentA Link
' 'anotherRichText':
Some red text
}" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'myRichDescription': '
Some standard HTML contentA Link
'\n 'anotherRichText':
Some red text
\n}\n", + "highlighter": "plain" } ], "isBeta": false, @@ -4540,7 +5542,12 @@ }, { "kind": "text", - "text": "Example: { 'myImage1': 'http://res.contoso.com/path/to/file' 'myImage2': 'https://res.contoso.com/someName.jpg' }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'myImage1': 'http://res.contoso.com/path/to/file'\n 'myImage2': 'https://res.contoso.com/someName.jpg'\n}\n", + "highlighter": "plain" } ], "isBeta": false, @@ -4573,7 +5580,12 @@ }, { "kind": "text", - "text": "Example: { 'myWebURL': 'http://contoso.com' 'myFileLink': 'https://res.contoso.com/file.docx' }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'myWebURL': 'http://contoso.com'\n 'myFileLink': 'https://res.contoso.com/file.docx'\n}\n", + "highlighter": "plain" } ], "isBeta": false, @@ -4606,7 +5618,12 @@ }, { "kind": "text", - "text": "Example: { 'justSomeText': 'This is some plain text', 'anotherText': 'Can have characters here: \"<>&\\'' }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'justSomeText': 'This is some plain text',\n 'anotherText': 'Can have characters here: \"<>&\\''\n}\n", + "highlighter": "plain" } ], "isBeta": false, @@ -4657,7 +5674,19 @@ }, { "kind": "text", - "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: Version Supported values: MAJOR.MINOR Example: \"1.0\"" + "text": "Supported values: MAJOR.MINOR" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"1.0\"", + "highlighter": "plain" } ], "isBeta": false, @@ -4677,17 +5706,27 @@ "summary": [ { "kind": "text", - "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The key is the path within the web part properties, and the value is the dynamic data internal id." }, { "kind": "paragraph" }, { "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'pageContextUser':\n 'PageContext:user',\n 'anotherWebPartProperty':\n 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n}\n", + "highlighter": "plain" } ], - "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, @@ -4705,17 +5744,27 @@ "summary": [ { "kind": "text", - "text": "Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." + "text": "Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The key is the path within the web part properties, and the value is the dynamic data static value." }, { "kind": "paragraph" }, { "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'aStringProperty': 'thisIsAString',\n 'aBooleanProperty': true\n}\n", + "highlighter": "plain" } ], - "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, @@ -4739,7 +5788,26 @@ "remarks": [ { "kind": "text", - "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" + "text": "Used by the web part to manage its internal metadata and config data. The framework code never touches these properties." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Supported values: any JSON stringifiable object hierarchy." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "{ 'value': 'text value' }", + "highlighter": "plain" } ], "isBeta": false, @@ -4851,7 +5919,7 @@ "summary": [ { "kind": "text", - "text": "Reference to the DOM element that hosts this client side component." + "text": "Reference to the DOM element that hosts this client-side component." } ], "remarks": [], @@ -5031,7 +6099,7 @@ "summary": [ { "kind": "text", - "text": "Manifest for the client side web part." + "text": "Manifest for the client-side web part." } ], "remarks": [], @@ -5277,10 +6345,24 @@ "summary": [ { "kind": "text", - "text": "This structure represents the serialized state of a web part. When the serialize() API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize." + "text": "This structure represents the serialized state of a web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "When the " + }, + { + "kind": "code", + "text": "serialize()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize." } ], - "remarks": [], "isBeta": false, "isSealed": false, "members": { @@ -5308,7 +6390,19 @@ }, { "kind": "text", - "text": "Usage: versioning and evolving the serialized data of the web part Required: yes Type: string Supported values: MAJOR.MINOR Example: \"1.0\"" + "text": "Supported values: MAJOR.MINOR" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"1.0\"", + "highlighter": "plain" } ], "isBeta": false, @@ -5334,7 +6428,26 @@ "remarks": [ { "kind": "text", - "text": "Usage: display the description of the web part. Required: no Type: string Supported values: string with the description. Example: \"Text\"" + "text": "Used to display the description of the web part." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Supported values: string with the description." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"Text\"", + "highlighter": "plain" } ], "isBeta": false, @@ -5354,17 +6467,27 @@ "summary": [ { "kind": "text", - "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + "text": "Paths for the dynamic data." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." }, { "kind": "paragraph" }, { "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'pageContextUser':\n 'PageContext:user',\n 'anotherWebPartProperty':\n 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n}\n", + "highlighter": "plain" } ], - "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, @@ -5382,17 +6505,27 @@ "summary": [ { "kind": "text", - "text": "Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data static value." + "text": "Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "The key is the path within the web part properties, and the value is the dynamic data static value." }, { "kind": "paragraph" }, { "kind": "text", - "text": "Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true }" + "text": "Example:" + }, + { + "kind": "code-box", + "text": "{\n 'aStringProperty': 'thisIsAString',\n 'aBooleanProperty': true\n}\n", + "highlighter": "plain" } ], - "remarks": [], "isBeta": true, "isSealed": false, "isVirtual": false, @@ -5416,7 +6549,12 @@ "remarks": [ { "kind": "text", - "text": "Usage: uniquely identify a web part. Required: yes Type: GUID Supported values: any GUID Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"" + "text": "Example: " + }, + { + "kind": "code", + "text": "\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"", + "highlighter": "plain" } ], "isBeta": false, @@ -5442,7 +6580,19 @@ "remarks": [ { "kind": "text", - "text": "how used: used by the framework to uniquely identify an instance of a web part. mandatory: yes type: string supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: [\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"] experimental: yes" + "text": "supported values: a unique string. Could be GUID or other uniquely identifiable formats." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "example: " + }, + { + "kind": "code", + "text": "[\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"]", + "highlighter": "plain" } ], "isBeta": false, @@ -5468,7 +6618,35 @@ "remarks": [ { "kind": "text", - "text": "Usage: used by the web part to manage its internal metadata and config data. The framework code never touches these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { 'value': 'text value' }" + "text": "Used by the web part to manage its internal metadata and config data. The framework code never touches these properties." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Supported values: any object hierarchy that can be serialized using " + }, + { + "kind": "code", + "text": "JSON.stringify()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "{ 'value': 'text value' }", + "highlighter": "plain" } ], "isBeta": false, @@ -5488,7 +6666,7 @@ "summary": [ { "kind": "text", - "text": "Definition: The collections of data that can be processed by server side services like search index and link fixup Required: no" + "text": "The collections of data that can be processed by server side services like search index and link fixup" } ], "remarks": [], @@ -5515,7 +6693,26 @@ "remarks": [ { "kind": "text", - "text": "Usage: display the name of the web part in the toolbox, web part gallery and the page. Required: yes Type: string Supported values: string less than 100 characters Example: \"Text\"" + "text": "Used to display the name of the web part in the toolbox, web part gallery and the page." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Supported values: string less than 100 characters" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Example: " + }, + { + "kind": "code", + "text": "\"Text\"", + "highlighter": "plain" } ], "isBeta": false, @@ -5535,7 +6732,12 @@ "summary": [ { "kind": "text", - "text": "This structure is used to define metadata for web part properties as a map of string to IWebPartPropertyMetadata" + "text": "This structure is used to define metadata for web part properties as a map of string to " + }, + { + "kind": "code", + "text": "IWebPartPropertyMetadata", + "highlighter": "plain" } ], "remarks": [ @@ -5548,46 +6750,108 @@ }, { "kind": "text", - "text": "- Dot . for selecting object members e.g. person.name" + "text": "- Dot " }, { - "kind": "paragraph" + "kind": "code", + "text": ".", + "highlighter": "plain" }, { "kind": "text", - "text": "- Brackets [] for selecting array items e.g. person.photoURLs[0]" + "text": " for selecting object members, for example " + }, + { + "kind": "code", + "text": "person.name", + "highlighter": "plain" }, { "kind": "paragraph" }, { "kind": "text", - "text": "- Bracketed asterisk [*] for array elements wildcard e.g. person.websites[*]." + "text": "- Brackets " + }, + { + "kind": "code", + "text": "[]", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " for selecting array items, for example " + }, + { + "kind": "code", + "text": "person.photoURLs[0]", + "highlighter": "plain" }, { "kind": "paragraph" }, { "kind": "text", - "text": "You can make combinations of these operators e.g. person.websites[*].url Important Note: Only one wildcard per path is supported." + "text": "- Bracketed asterisk " + }, + { + "kind": "code", + "text": "[*]", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " for array elements wildcard, for example " + }, + { + "kind": "code", + "text": "person.websites[*]", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." }, { "kind": "paragraph" }, { "kind": "text", - "text": "Example: Let's assume we have a web part with properties that have the following schema: { title: string; person: { name: string; bio: string; photoURLs: string[]; websites: { title: string; url: string; }[] } }" + "text": "You can make combinations of these operators, for example " + }, + { + "kind": "code", + "text": "person.websites[*].url", + "highlighter": "plain" }, { "kind": "paragraph" }, { "kind": "text", - "text": "We can define the metadata for the desired properties as following: { 'person.bio': { isRichContent: true }, 'person.photoURLs[*]': { isImageSource: true }, 'person.websites[*].url': { isLink: true } }" + "text": "Important Note: Only one wildcard per path is supported." }, { "kind": "paragraph" }, + { + "kind": "text", + "text": "Example: Let's assume we have a web part with properties that have the following schema:" + }, + { + "kind": "code-box", + "text": "{\n title: string;\n person: {\n name: string;\n bio: string;\n photoURLs: string[];\n websites: { title: string; url: string; }[]\n }\n}\n", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "We can define the metadata for the desired properties as following:" + }, + { + "kind": "code-box", + "text": "{\n 'person.bio': { isRichContent: true },\n 'person.photoURLs[*]': { isImageSource: true },\n 'person.websites[*].url': { isLink: true }\n}\n", + "highlighter": "plain" + }, { "kind": "text", "text": "This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated." @@ -5614,33 +6878,87 @@ "isSpread": false, "type": "string" } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], + }, + "deprecatedMessage": [], + "summary": [], + "remarks": [], + "isBeta": false, + "isSealed": false, + "isVirtual": false, + "isOverride": false + } + } + }, + "IWebPartPropertyMetadata": { + "kind": "interface", + "extends": "", + "implements": "", + "typeParameters": [], + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "This is the structure used for map values in " + }, + { + "kind": "code", + "text": "IWebPartPropertiesMetadata", + "highlighter": "plain" + } + ], + "remarks": [], + "isBeta": false, + "isSealed": false, + "members": { + "dynamicPropertyType": { + "kind": "property", + "signature": "dynamicPropertyType?: 'boolean' | 'number' | 'string' | 'array' | 'object';", + "isOptional": true, + "isReadOnly": false, + "isStatic": false, + "type": "'boolean' | 'number' | 'string' | 'array' | 'object'", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "If specified, indicates that the property is a dynamic property and the type of the dynamic property." + } + ], + "remarks": [ + { + "kind": "text", + "text": "If a web part has properties that are dynamically configurable, then use this flag to declare the property as a dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create the DynamicProperty themselves and assign it to the property." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "A web part can configure a default value for the property by specifying it in the properties section of the web part's manifest. This value will be used when a dynamic property is constructed for the property." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Note: Web parts should be able to type cast the resultant value from the " + }, + { + "kind": "code", + "text": "tryGetValue", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " to suit their needs." + } + ], "isBeta": false, "isSealed": false, "isVirtual": false, - "isOverride": false - } - } - }, - "IWebPartPropertyMetadata": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the structure used for map values in IWebPartPropertiesMetadata" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { + "isOverride": false, + "isEventProperty": false + }, "isHtmlString": { "kind": "property", "signature": "isHtmlString?: boolean;", @@ -5658,14 +6976,51 @@ "remarks": [ { "kind": "text", - "text": "This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it: - normalizing HTML encodings - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) - search indexing - SharePoint link fix-up" + "text": "This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it:" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- normalizing HTML encodings" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- stripping unsafe HTML tags (i.e. for usage with Element.innerHTML)" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- search indexing" + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "- SharePoint link fix-up" }, { "kind": "paragraph" }, { "kind": "text", - "text": "Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the isSearchablePlainText flag instead." + "text": "Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the " + }, + { + "kind": "code", + "text": "isSearchablePlainText", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " flag instead." } ], "isBeta": false, @@ -5733,7 +7088,23 @@ "remarks": [ { "kind": "text", - "text": "This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the isHtmlString setting instead. Security note: For security reasons, never assign a plain text string to Element.innerHTML." + "text": "This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the isHtmlString setting instead." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "Security note: For security reasons, never assign a plain text string to " + }, + { + "kind": "code", + "text": "Element.innerHTML", + "highlighter": "plain" + }, + { + "kind": "text", + "text": "." } ], "isBeta": false, @@ -5753,7 +7124,31 @@ "summary": [ { "kind": "text", - "text": "Indicates if the framework should persist the property on the server. Use this for properties that are only important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data of the web part and optimize the webpart load time. The property value will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. The property value will still be available in onBeforeSerialize() method, and the value will not be cleared from the run-time property bag. The initial render of your web part should not depend on the value of the property. Setting a default value for the property can be done in onInit() method." + "text": "Indicates if the framework should persist the property on the server." + } + ], + "remarks": [ + { + "kind": "text", + "text": "Use this for properties that are only important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data of the web part and optimize the web part load time. The property value will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. The property value will still be available in the " + }, + { + "kind": "code", + "text": "onBeforeSerialize()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " method, and the value will not be cleared from the run-time property bag. The initial render of your web part should not depend on the value of the property. Setting a default value for the property can be done in " + }, + { + "kind": "code", + "text": "onInit()", + "highlighter": "plain" + }, + { + "kind": "text", + "text": " method." }, { "kind": "paragraph" @@ -5763,7 +7158,6 @@ "text": "Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data." } ], - "remarks": [], "isBeta": false, "isSealed": false, "isVirtual": false, @@ -6169,6 +7563,82 @@ "remarks": [], "isBeta": false }, + "PropertyPaneDynamicField": { + "kind": "function", + "signature": "export function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "targetProperty": { + "name": "targetProperty", + "description": [ + { + "kind": "text", + "text": "Target property the Dynamic Data widget is associated to." + } + ], + "isOptional": false, + "isSpread": false, + "type": "string" + }, + "properties": { + "name": "properties", + "description": [], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneDynamicFieldProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field." + } + ], + "remarks": [], + "isBeta": false + }, + "PropertyPaneDynamicFieldSet": { + "kind": "function", + "signature": "export function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField;", + "returnValue": { + "type": "IPropertyPaneField", + "description": [] + }, + "parameters": { + "properties": { + "name": "properties", + "description": [ + { + "kind": "text", + "text": "Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields." + } + ], + "isOptional": false, + "isSpread": false, + "type": "IPropertyPaneDynamicFieldSetProps" + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source." + }, + { + "kind": "paragraph" + }, + { + "kind": "text", + "text": "These fields can possibly share the same property based on the associated filters." + } + ], + "remarks": [], + "isBeta": false + }, "PropertyPaneDynamicTextField": { "kind": "function", "signature": "export function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField;", @@ -6202,7 +7672,12 @@ "type": "IPropertyPaneDynamicTextFieldProps" } }, - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- This has been replaced by PropertyPaneDynamicField" + } + ], "summary": [ { "kind": "text", @@ -6280,10 +7755,41 @@ "remarks": [], "isBeta": false }, + "DynamicField": { + "kind": "enum value", + "value": "14", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Dynamic data field." + } + ], + "remarks": [], + "isBeta": false + }, + "DynamicFieldSet": { + "kind": "enum value", + "value": "16", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "A set of dynamic fields." + } + ], + "remarks": [], + "isBeta": false + }, "DynamicTextField": { "kind": "enum value", "value": "15", - "deprecatedMessage": [], + "deprecatedMessage": [ + { + "kind": "text", + "text": "- Please use DynamicField" + } + ], "summary": [ { "kind": "text", @@ -6670,7 +8176,7 @@ "summary": [ { "kind": "text", - "text": "Reference to the DOM element that hosts this client side component." + "text": "Reference to the DOM element that hosts this client-side component." } ], "remarks": [], @@ -6680,6 +8186,42 @@ "isOverride": false, "isEventProperty": false }, + "microsoftTeams": { + "kind": "property", + "signature": "readonly microsoftTeams: typeof microsoftTeams | undefined;", + "isOptional": false, + "isReadOnly": true, + "isStatic": false, + "type": "typeof microsoftTeams | undefined", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams." + } + ], + "remarks": [ + { + "kind": "text", + "text": "For more information, please see: " + }, + { + "kind": "web-link", + "elements": [ + { + "kind": "text", + "text": "https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest" + } + ], + "targetUrl": "https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest" + } + ], + "isBeta": true, + "isSealed": false, + "isVirtual": false, + "isOverride": false, + "isEventProperty": false + }, "statusRenderer": { "kind": "property", "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", @@ -6702,6 +8244,56 @@ "isEventProperty": false } } + }, + "WebPartFormFactor": { + "kind": "enum", + "values": { + "FullSize": { + "kind": "enum value", + "value": "1", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Full size form factor. This means the web part is rendered in full size, taking all space available in the page." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This is the case for Teams tabs or single web part App pages." + } + ], + "isBeta": true + }, + "Standard": { + "kind": "enum value", + "value": "0", + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height." + } + ], + "remarks": [], + "isBeta": true + } + }, + "deprecatedMessage": [], + "summary": [ + { + "kind": "text", + "text": "Form factor of the web part." + } + ], + "remarks": [ + { + "kind": "text", + "text": "This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor." + } + ], + "isBeta": true } } } From 01dae94db5137664eed74a50ddbb25b696ae3147 Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 9 Nov 2018 06:14:08 -0800 Subject: [PATCH 22/55] Regenerate docs using api-documenter@1.5.52 --- .../applicationaccessor.yml | 4 +- .../applicationcustomizercontext.yml | 15 + .../baseapplicationcustomizer.yml | 43 +- .../placeholdercontent.yml | 15 + .../placeholderprovider.yml | 27 + SP-Framework/sp-component-base.yml | 24 + .../basecomponentcontext.yml | 11 +- .../sp-component-base/dynamicdataprovider.yml | 11 - .../dynamicdatasourcemanager.yml | 26 +- .../sp-component-base/dynamicproperty.yml | 80 +- .../sp-component-base/ifontstyles.yml | 166 +++ SP-Framework/sp-component-base/ipalette.yml | 688 +++++++++++ .../sp-component-base/ireadonlyfontstyles.yml | 166 +++ .../sp-component-base/ireadonlytheme.yml | 56 + .../sp-component-base/isemanticcolors.yml | 1016 +++++++++++++++++ SP-Framework/sp-component-base/itheme.yml | 82 ++ .../themechangedeventargs.yml | 28 + .../sp-component-base/themeprovider.yml | 76 ++ SP-Framework/sp-core-library/guid.yml | 30 +- SP-Framework/sp-core-library/text.yml | 12 +- .../urlqueryparametercollection.yml | 32 +- SP-Framework/sp-core-library/version.yml | 49 +- SP-Framework/sp-dialog/basedialog.yml | 90 +- .../sp-dialog/isecondarydialogprovider.yml | 10 +- SP-Framework/sp-dynamic-data.yml | 12 + .../sp-dynamic-data/dynamicdatareference.yml | 14 +- .../idynamicdataannotatedpropertyvalue.yml | 39 + .../sp-dynamic-data/idynamicdatacallables.yml | 82 +- .../idynamicdataeventdefinition.yml | 43 + .../idynamicdatapropertydefinition.yml | 7 +- .../idynamicdatapropertymetadata.yml | 3 - .../idynamicdatapropertyvaluemetadata.yml | 26 + ...micdatapropertyvaluemetadatacollection.yml | 102 ++ .../sp-dynamic-data/idynamicdatasource.yml | 75 +- .../idynamicdatasourcemetadata.yml | 6 - SP-Framework/sp-http/digestcache.yml | 4 +- SP-Framework/sp-http/httpclientresponse.yml | 24 +- SP-Framework/sp-http/idigestcache.yml | 4 +- SP-Framework/sp-http/sphttpclientbatch.yml | 7 +- .../listviewcommandsetcontext.yml | 2 +- .../sp-odata-types/iodatachangetoken.yml | 2 +- .../iodatacontextwebinformation.yml | 8 +- SP-Framework/sp-odata-types/iodatalist.yml | 20 +- .../sp-odata-types/iodatalistitem.yml | 6 +- .../sp-odata-types/iodatanavigationnode.yml | 4 +- .../iodatanavigationnodecollection.yml | 2 +- SP-Framework/sp-odata-types/iodatauser.yml | 8 +- .../sp-odata-types/iodatausercustomaction.yml | 13 +- SP-Framework/sp-odata-types/iodataweb.yml | 58 +- SP-Framework/sp-page-context/cultureinfo.yml | 10 +- .../sp-page-context/ispsystemtime.yml | 2 +- .../sp-page-context/isptimezonedata.yml | 2 +- SP-Framework/sp-page-context/pagecontext.yml | 19 +- SP-Framework/sp-page-context/spfield.yml | 16 +- SP-Framework/sp-page-context/splist.yml | 6 +- SP-Framework/sp-page-context/splistitem.yml | 4 +- SP-Framework/sp-page-context/sppermission.yml | 6 +- SP-Framework/sp-page-context/spsite.yml | 4 +- SP-Framework/sp-page-context/sptimezone.yml | 17 +- SP-Framework/sp-page-context/spuser.yml | 8 +- SP-Framework/sp-page-context/spweb.yml | 14 +- SP-Framework/sp-property-pane.yml | 10 - SP-Framework/sp-webpart-base.yml | 83 ++ .../sp-webpart-base/baseclientsidewebpart.yml | 53 +- SP-Framework/sp-webpart-base/basewebpart.yml | 33 +- .../sp-webpart-base/basewebpartcontext.yml | 19 +- .../dynamicdatashareddepth.yml | 38 + ...dynamicdatasharedpropertyconfiguration.yml | 24 + .../idynamicdatasharedpropertyfilters.yml | 35 + .../idynamicdatasharedsourceconfiguration.yml | 40 + .../idynamicdatasharedsourcefilters.yml | 65 ++ .../sp-webpart-base/ipropertypaneaccessor.yml | 14 + .../ipropertypaneconditionalgroup.yml | 76 ++ .../ipropertypanecustomfieldprops.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 75 ++ .../ipropertypanedynamicfieldsetprops.yml | 65 ++ .../ipropertypanedynamictextfieldprops.yml | 38 +- .../ipropertypanetextfieldprops.yml | 30 +- .../iserializedserverprocesseddata.yml | 45 +- .../iserializedwebpartdata.yml | 46 +- .../sp-webpart-base/iwebpartcontext.yml | 4 +- SP-Framework/sp-webpart-base/iwebpartdata.yml | 96 +- .../iwebpartpropertiesmetadata.yml | 44 +- .../iwebpartpropertymetadata.yml | 68 +- .../sp-webpart-base/propertypanefieldtype.yml | 20 + .../sp-webpart-base/webpartcontext.yml | 21 +- .../sp-webpart-base/webpartformfactor.yml | 39 + SP-Framework/spfx-toc/toc.yml | 44 +- 88 files changed, 4115 insertions(+), 448 deletions(-) create mode 100644 SP-Framework/sp-component-base/ifontstyles.yml create mode 100644 SP-Framework/sp-component-base/ipalette.yml create mode 100644 SP-Framework/sp-component-base/ireadonlyfontstyles.yml create mode 100644 SP-Framework/sp-component-base/ireadonlytheme.yml create mode 100644 SP-Framework/sp-component-base/isemanticcolors.yml create mode 100644 SP-Framework/sp-component-base/itheme.yml create mode 100644 SP-Framework/sp-component-base/themechangedeventargs.yml create mode 100644 SP-Framework/sp-component-base/themeprovider.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml create mode 100644 SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml delete mode 100644 SP-Framework/sp-property-pane.yml create mode 100644 SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml create mode 100644 SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml create mode 100644 SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml create mode 100644 SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml create mode 100644 SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml create mode 100644 SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml create mode 100644 SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml create mode 100644 SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml create mode 100644 SP-Framework/sp-webpart-base/webpartformfactor.yml diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index c3939493..ff47b35b 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -43,9 +43,7 @@ items: - ServiceScope - uid: sp-application-base.ApplicationAccessor.navigatedEvent summary: An event that is fired when the application's top-level page context navigates to a new page. - remarks: >- - This event fires after the top-level [@microsoft/sp-page-context:PageContext](xref:sp-page-context.PageContext) - has navigated to a new page. + remarks: 'This event fires after the top-level [PageContext](xref:sp-page-context.PageContext) has navigated to a new page.' name: navigatedEvent fullName: sp-application-base.ApplicationAccessor.navigatedEvent langs: diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 3c0bbb75..9601a59d 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -15,6 +15,7 @@ items: package: sp-application-base children: - sp-application-base.ApplicationCustomizerContext.application + - sp-application-base.ApplicationCustomizerContext.dispose - sp-application-base.ApplicationCustomizerContext.placeholderProvider - uid: sp-application-base.ApplicationCustomizerContext.application summary: Provides access to the client-side application that is currently running. @@ -28,6 +29,20 @@ items: return: type: - ApplicationAccessor + - uid: sp-application-base.ApplicationCustomizerContext.dispose + name: dispose() + fullName: sp-application-base.ApplicationCustomizerContext.dispose + langs: + - typeScript + type: method + syntax: + content: |- + /** @override */ + dispose(): void; + return: + type: + - void + description: '' - uid: sp-application-base.ApplicationCustomizerContext.placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. name: placeholderProvider diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index 17800a68..d0384a65 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -4,10 +4,10 @@ items: summary: >- This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting. + remarks: >- + In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - remarks: >- Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. @@ -21,6 +21,8 @@ items: package: sp-application-base children: - sp-application-base.BaseApplicationCustomizer.context + - sp-application-base.BaseApplicationCustomizer.dispose + - sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged - uid: sp-application-base.BaseApplicationCustomizer.context summary: Use the context object to access common services and state associated with the component. remarks: >- @@ -37,3 +39,40 @@ items: return: type: - ApplicationCustomizerContext + - uid: sp-application-base.BaseApplicationCustomizer.dispose + summary: Disposes the component. + remarks: >- + Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends + for a web part or extension. To perform custom cleanup when your component is disposed, override the + [BaseComponent.onDispose](xref:sp-component-base.BaseComponent.onDispose) method. + name: dispose() + fullName: sp-application-base.BaseApplicationCustomizer.dispose + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged + summary: >- + This event method is called when the placeholders of the host application change, come into existence, or + disappear. + name: onPlaceholdersChanged(placeholderProvider) + fullName: sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged + langs: + - typeScript + type: method + syntax: + content: 'protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;' + return: + type: + - void + description: '' + parameters: + - id: placeholderProvider + description: '' + type: + - PlaceholderProvider diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index fd99b7d1..3f880bda 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -22,6 +22,7 @@ items: - sp-application-base.PlaceholderContent.dispose - sp-application-base.PlaceholderContent.domElement - sp-application-base.PlaceholderContent.isDisposed + - sp-application-base.PlaceholderContent.isVisible - sp-application-base.PlaceholderContent.name - uid: sp-application-base.PlaceholderContent.dispose summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. @@ -68,6 +69,20 @@ items: return: type: - boolean + - uid: sp-application-base.PlaceholderContent.isVisible + summary: >- + Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't + displaying it, this will return false. + name: isVisible + fullName: sp-application-base.PlaceholderContent.isVisible + langs: + - typeScript + type: property + syntax: + content: 'readonly isVisible: boolean;' + return: + type: + - boolean - uid: sp-application-base.PlaceholderContent.name summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 891f7a1a..66de669c 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -25,9 +25,13 @@ items: langs: - typeScript type: class + implements: + - IDisposable package: sp-application-base children: - sp-application-base.PlaceholderProvider.changedEvent + - sp-application-base.PlaceholderProvider.dispose + - sp-application-base.PlaceholderProvider.isDisposed - sp-application-base.PlaceholderProvider.placeholderNames - sp-application-base.PlaceholderProvider.tryCreateContent - uid: sp-application-base.PlaceholderProvider.changedEvent @@ -46,6 +50,29 @@ items: return: type: - SPEvent + - uid: sp-application-base.PlaceholderProvider.dispose + name: dispose() + fullName: sp-application-base.PlaceholderProvider.dispose + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: sp-application-base.PlaceholderProvider.isDisposed + name: isDisposed + fullName: sp-application-base.PlaceholderProvider.isDisposed + langs: + - typeScript + type: property + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: + - boolean - uid: sp-application-base.PlaceholderProvider.placeholderNames summary: Returns the names of the currently available placeholders. name: placeholderNames diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 6e390645..3e05b18e 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -17,6 +17,14 @@ items: - sp-component-base.DynamicDataProvider - sp-component-base.DynamicDataSourceManager - sp-component-base.DynamicProperty + - sp-component-base.IFontStyles + - sp-component-base.IPalette + - sp-component-base.IReadonlyFontStyles + - sp-component-base.IReadonlyTheme + - sp-component-base.ISemanticColors + - sp-component-base.ITheme + - sp-component-base.ThemeChangedEventArgs + - sp-component-base.ThemeProvider references: - uid: sp-component-base.BaseComponent name: BaseComponent @@ -28,3 +36,19 @@ references: name: DynamicDataSourceManager - uid: sp-component-base.DynamicProperty name: DynamicProperty + - uid: sp-component-base.IFontStyles + name: IFontStyles + - uid: sp-component-base.IPalette + name: IPalette + - uid: sp-component-base.IReadonlyFontStyles + name: IReadonlyFontStyles + - uid: sp-component-base.IReadonlyTheme + name: IReadonlyTheme + - uid: sp-component-base.ISemanticColors + name: ISemanticColors + - uid: sp-component-base.ITheme + name: ITheme + - uid: sp-component-base.ThemeChangedEventArgs + name: ThemeChangedEventArgs + - uid: sp-component-base.ThemeProvider + name: ThemeProvider diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index ac32ac5c..55cf04d5 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -72,7 +72,6 @@ items: description: '' - uid: sp-component-base.BaseComponentContext.dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. - isPreview: true name: dynamicDataProvider fullName: sp-component-base.BaseComponentContext.dynamicDataProvider langs: @@ -85,7 +84,6 @@ items: - DynamicDataProvider - uid: sp-component-base.BaseComponentContext.dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. - isPreview: true name: dynamicDataSourceManager fullName: sp-component-base.BaseComponentContext.dynamicDataSourceManager langs: @@ -99,7 +97,10 @@ items: - uid: sp-component-base.BaseComponentContext.graphHttpClient summary: The instance of GraphHttpClient created for this instance of component deprecated: - content: '' + content: >- + Use + [BaseComponentContext.msGraphClientFactory](xref:sp-component-base.BaseComponentContext.msGraphClientFactory) + instead isPreview: true name: graphHttpClient fullName: sp-component-base.BaseComponentContext.graphHttpClient @@ -152,7 +153,7 @@ items: type: - boolean - uid: sp-component-base.BaseComponentContext.manifest - summary: Manifest for the client side component. + summary: Manifest for the client-side component. name: manifest fullName: sp-component-base.BaseComponentContext.manifest langs: @@ -190,7 +191,7 @@ items: type: - PageContext - uid: sp-component-base.BaseComponentContext.serviceScope - summary: 'The associated [@microsoft/sp-core-library:ServiceScope](xref:sp-core-library.ServiceScope) for this component.' + summary: 'The associated [ServiceScope](xref:sp-core-library.ServiceScope) for this component.' remarks: A child service scope is created for each client-side component. name: serviceScope fullName: sp-component-base.BaseComponentContext.serviceScope diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 90c3043b..52c9d24d 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -4,7 +4,6 @@ items: summary: >- The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. - isPreview: true name: DynamicDataProvider fullName: sp-component-base.DynamicDataProvider langs: @@ -26,7 +25,6 @@ items: - sp-component-base.DynamicDataProvider.unregisterSourceChanged - uid: sp-component-base.DynamicDataProvider.dispose summary: Disposes the Dynamic Data Provider. - isPreview: true name: dispose() fullName: sp-component-base.DynamicDataProvider.dispose langs: @@ -40,7 +38,6 @@ items: description: '' - uid: sp-component-base.DynamicDataProvider.getAvailableSources summary: Returns a list with all available Dynamic Data Sources. - isPreview: true name: getAvailableSources() fullName: sp-component-base.DynamicDataProvider.getAvailableSources langs: @@ -54,7 +51,6 @@ items: description: Read-only array with all available sources. - uid: sp-component-base.DynamicDataProvider.isDisposed summary: Returns true if the Dynamic Data Provider is disposed. - isPreview: true name: isDisposed fullName: sp-component-base.DynamicDataProvider.isDisposed langs: @@ -67,7 +63,6 @@ items: - boolean - uid: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. - isPreview: true name: registerAvailableSourcesChanged(callback) fullName: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged langs: @@ -86,7 +81,6 @@ items: - () => void - uid: sp-component-base.DynamicDataProvider.registerPropertyChanged summary: Registers a callback for updates when a property is changed in a Dynamic Data source. - isPreview: true name: 'registerPropertyChanged(sourceId, propertyId, callback)' fullName: sp-component-base.DynamicDataProvider.registerPropertyChanged langs: @@ -115,7 +109,6 @@ items: summary: >- Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. - isPreview: true name: 'registerSourceChanged(sourceId, callback)' fullName: sp-component-base.DynamicDataProvider.registerSourceChanged langs: @@ -138,7 +131,6 @@ items: - () => void - uid: sp-component-base.DynamicDataProvider.tryGetSource summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' - isPreview: true name: tryGetSource(id) fullName: sp-component-base.DynamicDataProvider.tryGetSource langs: @@ -157,7 +149,6 @@ items: - string - uid: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. - isPreview: true name: unregisterAvailableSourcesChanged(callback) fullName: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged langs: @@ -176,7 +167,6 @@ items: - () => void - uid: sp-component-base.DynamicDataProvider.unregisterPropertyChanged summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. - isPreview: true name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' fullName: sp-component-base.DynamicDataProvider.unregisterPropertyChanged langs: @@ -203,7 +193,6 @@ items: - () => void - uid: sp-component-base.DynamicDataProvider.unregisterSourceChanged summary: Unregisters a callback for updates when a Dynamic Data source is changed. - isPreview: true name: 'unregisterSourceChanged(sourceId, callback)' fullName: sp-component-base.DynamicDataProvider.unregisterSourceChanged langs: diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 876f187e..5514310c 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -5,7 +5,6 @@ items: The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated. - isPreview: true name: DynamicDataSourceManager fullName: sp-component-base.DynamicDataSourceManager langs: @@ -20,10 +19,10 @@ items: - sp-component-base.DynamicDataSourceManager.isDisposed - sp-component-base.DynamicDataSourceManager.notifyPropertyChanged - sp-component-base.DynamicDataSourceManager.notifySourceChanged + - sp-component-base.DynamicDataSourceManager.sourceId - sp-component-base.DynamicDataSourceManager.updateMetadata - uid: sp-component-base.DynamicDataSourceManager.dispose summary: Disposes the resources held by the Dynamic Data source. - isPreview: true name: dispose() fullName: sp-component-base.DynamicDataSourceManager.dispose langs: @@ -37,7 +36,6 @@ items: description: '' - uid: sp-component-base.DynamicDataSourceManager.initializeSource summary: Initializes the Dynamic Data Source for the component. - isPreview: true name: initializeSource(callableFunctions) fullName: sp-component-base.DynamicDataSourceManager.initializeSource langs: @@ -51,14 +49,11 @@ items: description: '' parameters: - id: callableFunctions - description: >- - Set of methods exposed by the Dynamic Data Source to get the data. These apis are called by the consumer to - retrieve properties, their values etc., + description: Set of methods that are exposed through the Dynamic Data Source type: - IDynamicDataCallables - uid: sp-component-base.DynamicDataSourceManager.isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. - isPreview: true name: isDisposed fullName: sp-component-base.DynamicDataSourceManager.isDisposed langs: @@ -76,7 +71,6 @@ items: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. - isPreview: true name: notifyPropertyChanged(propertyId) fullName: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged langs: @@ -95,12 +89,11 @@ items: - string - uid: sp-component-base.DynamicDataSourceManager.notifySourceChanged summary: >- - Notifies that this source has updated its data. + Notifies that this source has updated its properties. When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. - isPreview: true name: notifySourceChanged() fullName: sp-component-base.DynamicDataSourceManager.notifySourceChanged langs: @@ -112,11 +105,22 @@ items: type: - void description: '' + - uid: sp-component-base.DynamicDataSourceManager.sourceId + summary: Returns the Id of the current DataSource. + name: sourceId + fullName: sp-component-base.DynamicDataSourceManager.sourceId + langs: + - typeScript + type: property + syntax: + content: 'readonly sourceId: string;' + return: + type: + - string - uid: sp-component-base.DynamicDataSourceManager.updateMetadata summary: >- Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. - isPreview: true name: updateMetadata(metadata) fullName: sp-component-base.DynamicDataSourceManager.updateMetadata langs: diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index bb630f9c..6c1f44a1 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -1,12 +1,11 @@ ### YamlMime:UniversalReference items: - uid: sp-component-base.DynamicProperty - summary: Serializable object that simplifies usage of Dynamic Data. + summary: Serializable object that simplifies usage of a DynamicProperty. remarks: >- - This is built for usage in Web Part properties, and modified through the property pane. Can be initialized with a + This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change - in the dynamic data will re-render the web part automatically. - isPreview: true + in the DynamicProperty will re-render the web part automatically. name: DynamicProperty fullName: sp-component-base.DynamicProperty langs: @@ -27,9 +26,10 @@ items: - sp-component-base.DynamicProperty.setValue - sp-component-base.DynamicProperty.tryGetSource - sp-component-base.DynamicProperty.tryGetValue + - sp-component-base.DynamicProperty.tryGetValues - sp-component-base.DynamicProperty.unregister - uid: sp-component-base.DynamicProperty.constructor - summary: Create a new Dynamic Property object. + summary: Create a new DynamicProperty object. name: 'constructor(provider, callback)' fullName: sp-component-base.DynamicProperty.constructor langs: @@ -39,17 +39,16 @@ items: content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' parameters: - id: provider - description: Dynamic Data Provider. + description: DynamicDataProvider. type: - DynamicDataProvider - id: callback - description: Optional. Default callback to be registered for updates in the Dynamic Data source. + description: Optional. Default callback to be registered for updates in the DynamicDataSource. type: - () => void - uid: sp-component-base.DynamicProperty.dispose summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - isPreview: true name: dispose() fullName: sp-component-base.DynamicProperty.dispose langs: @@ -63,7 +62,6 @@ items: description: '' - uid: sp-component-base.DynamicProperty.hasDefaultCallback summary: Returns true if the object has a default callback. - isPreview: true name: hasDefaultCallback() fullName: sp-component-base.DynamicProperty.hasDefaultCallback langs: @@ -80,7 +78,6 @@ items: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - isPreview: true name: isDisposed fullName: sp-component-base.DynamicProperty.isDisposed langs: @@ -93,10 +90,9 @@ items: - boolean - uid: sp-component-base.DynamicProperty.reference summary: >- - DynamicDataReference string that the Dynamic Data object points to. The reference is of the form - <source>:<property>:<path>. - remarks: 'If the Dynamic Data object is set up with static data, this returns undefined.' - isPreview: true + DynamicDataReference string that the DynamicProperty object points to. The reference is of the form + `::`. + remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' name: reference fullName: sp-component-base.DynamicProperty.reference langs: @@ -108,8 +104,7 @@ items: type: - string | undefined - uid: sp-component-base.DynamicProperty.register - summary: Registers a callback function for updates on the associated Dynamic Data Source. - isPreview: true + summary: Registers a callback function for updates on the associated DynamicDataSource. name: register(callback) fullName: sp-component-base.DynamicProperty.register langs: @@ -129,7 +124,6 @@ items: - uid: sp-component-base.DynamicProperty.removeDefaultCallback summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. - isPreview: true name: removeDefaultCallback() fullName: sp-component-base.DynamicProperty.removeDefaultCallback langs: @@ -142,8 +136,9 @@ items: - void description: '' - uid: sp-component-base.DynamicProperty.setReference - summary: Sets a Dynamic data id in the Dynamic Data object. - isPreview: true + summary: >- + Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is + of the form `::`. name: setReference(reference) fullName: sp-component-base.DynamicProperty.setReference langs: @@ -157,12 +152,11 @@ items: description: '' parameters: - id: reference - description: Id of the Dynamic Data. + description: Id of the DynamicDataSource and property. type: - string - uid: sp-component-base.DynamicProperty.setValue - summary: Sets a static value in the Dynamic Data object. - isPreview: true + summary: Sets a static value in the DynamicProperty. name: setValue(value) fullName: sp-component-base.DynamicProperty.setValue langs: @@ -176,14 +170,13 @@ items: description: '' parameters: - id: value - description: Value for the Dynamic Data. + description: Value for the DynamicProperty. type: - TValue - uid: sp-component-base.DynamicProperty.tryGetSource summary: >- - Returns the Dynamic Data Source that the Dynamic Data object refers to. Returns undefined if the source doesn't + Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. - isPreview: true name: tryGetSource() fullName: sp-component-base.DynamicProperty.tryGetSource langs: @@ -196,8 +189,14 @@ items: - IDynamicDataSource | undefined description: '' - uid: sp-component-base.DynamicProperty.tryGetValue - summary: Returns the value of the Dynamic Data object. Returns undefined if the source or the data doesn't exist. - isPreview: true + summary: Returns the value of the object. + remarks: >- + If the value is an array, then the first element of the array is returned; otherwise, the value itself is + returned. + + + NOTE: This api will never return an array. To retrieve an array value, use the + [DynamicProperty.tryGetValues](xref:sp-component-base.DynamicProperty.tryGetValues) API. name: tryGetValue() fullName: sp-component-base.DynamicProperty.tryGetValue langs: @@ -208,12 +207,31 @@ items: return: type: - TValue | undefined - description: '' + description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. + - uid: sp-component-base.DynamicProperty.tryGetValues + summary: Returns the value of the object. + remarks: >- + If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the + value itself is returned. If the property is undefined or cannot be found, an empty array will be returned. + + + NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array + value, use the [DynamicProperty.tryGetValue](xref:sp-component-base.DynamicProperty.tryGetValue) API. + name: tryGetValues() + fullName: sp-component-base.DynamicProperty.tryGetValues + langs: + - typeScript + type: method + syntax: + content: 'tryGetValues(): TValue[];' + return: + type: + - 'TValue[]' + description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - uid: sp-component-base.DynamicProperty.unregister summary: >- - Unregisters a callback function for updates on the associated Dynamic Data Source. The callback function must be - the same it was registered with. - isPreview: true + Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the + same it was registered with. name: unregister(callback) fullName: sp-component-base.DynamicProperty.unregister langs: diff --git a/SP-Framework/sp-component-base/ifontstyles.yml b/SP-Framework/sp-component-base/ifontstyles.yml new file mode 100644 index 00000000..265dc107 --- /dev/null +++ b/SP-Framework/sp-component-base/ifontstyles.yml @@ -0,0 +1,166 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.IFontStyles + summary: Font styles for different sizes. + isPreview: true + name: IFontStyles + fullName: sp-component-base.IFontStyles + langs: + - typeScript + type: interface + package: sp-component-base + children: + - sp-component-base.IFontStyles.large + - sp-component-base.IFontStyles.medium + - sp-component-base.IFontStyles.mediumPlus + - sp-component-base.IFontStyles.mega + - sp-component-base.IFontStyles.small + - sp-component-base.IFontStyles.smallPlus + - sp-component-base.IFontStyles.superLarge + - sp-component-base.IFontStyles.tiny + - sp-component-base.IFontStyles.xLarge + - sp-component-base.IFontStyles.xSmall + - sp-component-base.IFontStyles.xxLarge + - uid: sp-component-base.IFontStyles.large + summary: Large font style. + isPreview: true + name: large + fullName: sp-component-base.IFontStyles.large + langs: + - typeScript + type: property + syntax: + content: 'large: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.medium + summary: Medium font style. + isPreview: true + name: medium + fullName: sp-component-base.IFontStyles.medium + langs: + - typeScript + type: property + syntax: + content: 'medium: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.mediumPlus + summary: Larger than medium but smaller than large font style. + isPreview: true + name: mediumPlus + fullName: sp-component-base.IFontStyles.mediumPlus + langs: + - typeScript + type: property + syntax: + content: 'mediumPlus: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.mega + summary: Mega sized font style. + isPreview: true + name: mega + fullName: sp-component-base.IFontStyles.mega + langs: + - typeScript + type: property + syntax: + content: 'mega: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.small + summary: Small font style. + isPreview: true + name: small + fullName: sp-component-base.IFontStyles.small + langs: + - typeScript + type: property + syntax: + content: 'small: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.smallPlus + summary: Larger than small but smaller than medium font style. + isPreview: true + name: smallPlus + fullName: sp-component-base.IFontStyles.smallPlus + langs: + - typeScript + type: property + syntax: + content: 'smallPlus: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.superLarge + summary: Super large font style. + isPreview: true + name: superLarge + fullName: sp-component-base.IFontStyles.superLarge + langs: + - typeScript + type: property + syntax: + content: 'superLarge: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.tiny + summary: Tiny font style. + isPreview: true + name: tiny + fullName: sp-component-base.IFontStyles.tiny + langs: + - typeScript + type: property + syntax: + content: 'tiny: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.xLarge + summary: Extra large font style. + isPreview: true + name: xLarge + fullName: sp-component-base.IFontStyles.xLarge + langs: + - typeScript + type: property + syntax: + content: 'xLarge: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.xSmall + summary: Extra small font style. + isPreview: true + name: xSmall + fullName: sp-component-base.IFontStyles.xSmall + langs: + - typeScript + type: property + syntax: + content: 'xSmall: IRawStyle;' + return: + type: + - IRawStyle + - uid: sp-component-base.IFontStyles.xxLarge + summary: Extra extra large font style. + isPreview: true + name: xxLarge + fullName: sp-component-base.IFontStyles.xxLarge + langs: + - typeScript + type: property + syntax: + content: 'xxLarge: IRawStyle;' + return: + type: + - IRawStyle diff --git a/SP-Framework/sp-component-base/ipalette.yml b/SP-Framework/sp-component-base/ipalette.yml new file mode 100644 index 00000000..a73e53f6 --- /dev/null +++ b/SP-Framework/sp-component-base/ipalette.yml @@ -0,0 +1,688 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.IPalette + summary: Color palette. + isPreview: true + name: IPalette + fullName: sp-component-base.IPalette + langs: + - typeScript + type: interface + package: sp-component-base + children: + - sp-component-base.IPalette.accent + - sp-component-base.IPalette.black + - sp-component-base.IPalette.blackTranslucent40 + - sp-component-base.IPalette.blue + - sp-component-base.IPalette.blueDark + - sp-component-base.IPalette.blueLight + - sp-component-base.IPalette.blueMid + - sp-component-base.IPalette.green + - sp-component-base.IPalette.greenDark + - sp-component-base.IPalette.greenLight + - sp-component-base.IPalette.magenta + - sp-component-base.IPalette.magentaDark + - sp-component-base.IPalette.magentaLight + - sp-component-base.IPalette.neutralDark + - sp-component-base.IPalette.neutralLight + - sp-component-base.IPalette.neutralLighter + - sp-component-base.IPalette.neutralLighterAlt + - sp-component-base.IPalette.neutralPrimary + - sp-component-base.IPalette.neutralPrimaryAlt + - sp-component-base.IPalette.neutralQuaternary + - sp-component-base.IPalette.neutralQuaternaryAlt + - sp-component-base.IPalette.neutralSecondary + - sp-component-base.IPalette.neutralTertiary + - sp-component-base.IPalette.neutralTertiaryAlt + - sp-component-base.IPalette.orange + - sp-component-base.IPalette.orangeLight + - sp-component-base.IPalette.orangeLighter + - sp-component-base.IPalette.purple + - sp-component-base.IPalette.purpleDark + - sp-component-base.IPalette.purpleLight + - sp-component-base.IPalette.red + - sp-component-base.IPalette.redDark + - sp-component-base.IPalette.teal + - sp-component-base.IPalette.tealDark + - sp-component-base.IPalette.tealLight + - sp-component-base.IPalette.themeDark + - sp-component-base.IPalette.themeDarkAlt + - sp-component-base.IPalette.themeDarker + - sp-component-base.IPalette.themeLight + - sp-component-base.IPalette.themeLighter + - sp-component-base.IPalette.themeLighterAlt + - sp-component-base.IPalette.themePrimary + - sp-component-base.IPalette.themeSecondary + - sp-component-base.IPalette.themeTertiary + - sp-component-base.IPalette.white + - sp-component-base.IPalette.whiteTranslucent40 + - sp-component-base.IPalette.yellow + - sp-component-base.IPalette.yellowLight + - uid: sp-component-base.IPalette.accent + summary: Color code for the accent. + isPreview: true + name: accent + fullName: sp-component-base.IPalette.accent + langs: + - typeScript + type: property + syntax: + content: 'accent: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.black + summary: >- + Color code for the strongest color, which is black in the default theme. This is a very light color in inverted + themes. + isPreview: true + name: black + fullName: sp-component-base.IPalette.black + langs: + - typeScript + type: property + syntax: + content: 'black: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.blackTranslucent40 + summary: Color code for blackTranslucent40. + isPreview: true + name: blackTranslucent40 + fullName: sp-component-base.IPalette.blackTranslucent40 + langs: + - typeScript + type: property + syntax: + content: 'blackTranslucent40: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.blue + summary: Color code for blue. + isPreview: true + name: blue + fullName: sp-component-base.IPalette.blue + langs: + - typeScript + type: property + syntax: + content: 'blue: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.blueDark + summary: Color code for blueDark. + isPreview: true + name: blueDark + fullName: sp-component-base.IPalette.blueDark + langs: + - typeScript + type: property + syntax: + content: 'blueDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.blueLight + summary: Color code for blueLight. + isPreview: true + name: blueLight + fullName: sp-component-base.IPalette.blueLight + langs: + - typeScript + type: property + syntax: + content: 'blueLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.blueMid + summary: Color code for blueMid. + isPreview: true + name: blueMid + fullName: sp-component-base.IPalette.blueMid + langs: + - typeScript + type: property + syntax: + content: 'blueMid: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.green + summary: Color code for green. + isPreview: true + name: green + fullName: sp-component-base.IPalette.green + langs: + - typeScript + type: property + syntax: + content: 'green: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.greenDark + summary: Color code for greenDark. + isPreview: true + name: greenDark + fullName: sp-component-base.IPalette.greenDark + langs: + - typeScript + type: property + syntax: + content: 'greenDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.greenLight + summary: Color code for greenLight. + isPreview: true + name: greenLight + fullName: sp-component-base.IPalette.greenLight + langs: + - typeScript + type: property + syntax: + content: 'greenLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.magenta + summary: Color code for magenta. + isPreview: true + name: magenta + fullName: sp-component-base.IPalette.magenta + langs: + - typeScript + type: property + syntax: + content: 'magenta: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.magentaDark + summary: Color code for magentaDark. + isPreview: true + name: magentaDark + fullName: sp-component-base.IPalette.magentaDark + langs: + - typeScript + type: property + syntax: + content: 'magentaDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.magentaLight + summary: Color code for magentaLight. + isPreview: true + name: magentaLight + fullName: sp-component-base.IPalette.magentaLight + langs: + - typeScript + type: property + syntax: + content: 'magentaLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralDark + summary: Color code for neutralDark. + isPreview: true + name: neutralDark + fullName: sp-component-base.IPalette.neutralDark + langs: + - typeScript + type: property + syntax: + content: 'neutralDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralLight + summary: Color code for neutralLight. + isPreview: true + name: neutralLight + fullName: sp-component-base.IPalette.neutralLight + langs: + - typeScript + type: property + syntax: + content: 'neutralLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralLighter + summary: Color code for neutralLighter. + isPreview: true + name: neutralLighter + fullName: sp-component-base.IPalette.neutralLighter + langs: + - typeScript + type: property + syntax: + content: 'neutralLighter: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralLighterAlt + summary: Color code for neutralLighterAlt. + isPreview: true + name: neutralLighterAlt + fullName: sp-component-base.IPalette.neutralLighterAlt + langs: + - typeScript + type: property + syntax: + content: 'neutralLighterAlt: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralPrimary + summary: Color code for neutralPrimary. + isPreview: true + name: neutralPrimary + fullName: sp-component-base.IPalette.neutralPrimary + langs: + - typeScript + type: property + syntax: + content: 'neutralPrimary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralPrimaryAlt + summary: Color code for neutralPrimaryAlt. + isPreview: true + name: neutralPrimaryAlt + fullName: sp-component-base.IPalette.neutralPrimaryAlt + langs: + - typeScript + type: property + syntax: + content: 'neutralPrimaryAlt: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralQuaternary + summary: Color code for neutralQuaternary. + isPreview: true + name: neutralQuaternary + fullName: sp-component-base.IPalette.neutralQuaternary + langs: + - typeScript + type: property + syntax: + content: 'neutralQuaternary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralQuaternaryAlt + summary: Color code for neutralQuaternaryAlt. + isPreview: true + name: neutralQuaternaryAlt + fullName: sp-component-base.IPalette.neutralQuaternaryAlt + langs: + - typeScript + type: property + syntax: + content: 'neutralQuaternaryAlt: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralSecondary + summary: Color code for neutralSecondary. + isPreview: true + name: neutralSecondary + fullName: sp-component-base.IPalette.neutralSecondary + langs: + - typeScript + type: property + syntax: + content: 'neutralSecondary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralTertiary + summary: Color code for neutralTertiary. + isPreview: true + name: neutralTertiary + fullName: sp-component-base.IPalette.neutralTertiary + langs: + - typeScript + type: property + syntax: + content: 'neutralTertiary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.neutralTertiaryAlt + summary: Color code for neutralTertiaryAlt. + isPreview: true + name: neutralTertiaryAlt + fullName: sp-component-base.IPalette.neutralTertiaryAlt + langs: + - typeScript + type: property + syntax: + content: 'neutralTertiaryAlt: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.orange + summary: Color code for orange. + isPreview: true + name: orange + fullName: sp-component-base.IPalette.orange + langs: + - typeScript + type: property + syntax: + content: 'orange: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.orangeLight + summary: Color code for orangeLight. + isPreview: true + name: orangeLight + fullName: sp-component-base.IPalette.orangeLight + langs: + - typeScript + type: property + syntax: + content: 'orangeLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.orangeLighter + summary: Color code for orangeLighter. + isPreview: true + name: orangeLighter + fullName: sp-component-base.IPalette.orangeLighter + langs: + - typeScript + type: property + syntax: + content: 'orangeLighter: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.purple + summary: Color code for purple. + isPreview: true + name: purple + fullName: sp-component-base.IPalette.purple + langs: + - typeScript + type: property + syntax: + content: 'purple: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.purpleDark + summary: Color code for purpleDark. + isPreview: true + name: purpleDark + fullName: sp-component-base.IPalette.purpleDark + langs: + - typeScript + type: property + syntax: + content: 'purpleDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.purpleLight + summary: Color code for purpleLight. + isPreview: true + name: purpleLight + fullName: sp-component-base.IPalette.purpleLight + langs: + - typeScript + type: property + syntax: + content: 'purpleLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.red + summary: Color code for red. + isPreview: true + name: red + fullName: sp-component-base.IPalette.red + langs: + - typeScript + type: property + syntax: + content: 'red: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.redDark + summary: Color code for redDark. + isPreview: true + name: redDark + fullName: sp-component-base.IPalette.redDark + langs: + - typeScript + type: property + syntax: + content: 'redDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.teal + summary: Color code for teal. + isPreview: true + name: teal + fullName: sp-component-base.IPalette.teal + langs: + - typeScript + type: property + syntax: + content: 'teal: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.tealDark + summary: Color code for tealDark. + isPreview: true + name: tealDark + fullName: sp-component-base.IPalette.tealDark + langs: + - typeScript + type: property + syntax: + content: 'tealDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.tealLight + summary: Color code for tealLight. + isPreview: true + name: tealLight + fullName: sp-component-base.IPalette.tealLight + langs: + - typeScript + type: property + syntax: + content: 'tealLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeDark + summary: Color code for themeDark. + isPreview: true + name: themeDark + fullName: sp-component-base.IPalette.themeDark + langs: + - typeScript + type: property + syntax: + content: 'themeDark: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeDarkAlt + summary: Color code for themeDarkAlt. + isPreview: true + name: themeDarkAlt + fullName: sp-component-base.IPalette.themeDarkAlt + langs: + - typeScript + type: property + syntax: + content: 'themeDarkAlt: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeDarker + summary: Color code for themeDarker. + isPreview: true + name: themeDarker + fullName: sp-component-base.IPalette.themeDarker + langs: + - typeScript + type: property + syntax: + content: 'themeDarker: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeLight + summary: Color code for themeLight. + isPreview: true + name: themeLight + fullName: sp-component-base.IPalette.themeLight + langs: + - typeScript + type: property + syntax: + content: 'themeLight: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeLighter + summary: Color code for themeLighter. + isPreview: true + name: themeLighter + fullName: sp-component-base.IPalette.themeLighter + langs: + - typeScript + type: property + syntax: + content: 'themeLighter: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeLighterAlt + summary: Color code for themeLighterAlt. + isPreview: true + name: themeLighterAlt + fullName: sp-component-base.IPalette.themeLighterAlt + langs: + - typeScript + type: property + syntax: + content: 'themeLighterAlt: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themePrimary + summary: Color code for themePrimary. + isPreview: true + name: themePrimary + fullName: sp-component-base.IPalette.themePrimary + langs: + - typeScript + type: property + syntax: + content: 'themePrimary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeSecondary + summary: Color code for themeSecondary. + isPreview: true + name: themeSecondary + fullName: sp-component-base.IPalette.themeSecondary + langs: + - typeScript + type: property + syntax: + content: 'themeSecondary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.themeTertiary + summary: Color code for themeTertiary. + isPreview: true + name: themeTertiary + fullName: sp-component-base.IPalette.themeTertiary + langs: + - typeScript + type: property + syntax: + content: 'themeTertiary: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.white + summary: >- + Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. + This is the page background. + isPreview: true + name: white + fullName: sp-component-base.IPalette.white + langs: + - typeScript + type: property + syntax: + content: 'white: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.whiteTranslucent40 + summary: Color code for whiteTranslucent40 + isPreview: true + name: whiteTranslucent40 + fullName: sp-component-base.IPalette.whiteTranslucent40 + langs: + - typeScript + type: property + syntax: + content: 'whiteTranslucent40: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.yellow + summary: Color code for yellow. + isPreview: true + name: yellow + fullName: sp-component-base.IPalette.yellow + langs: + - typeScript + type: property + syntax: + content: 'yellow: string;' + return: + type: + - string + - uid: sp-component-base.IPalette.yellowLight + summary: Color code for yellowLight. + isPreview: true + name: yellowLight + fullName: sp-component-base.IPalette.yellowLight + langs: + - typeScript + type: property + syntax: + content: 'yellowLight: string;' + return: + type: + - string diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml new file mode 100644 index 00000000..751fae63 --- /dev/null +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -0,0 +1,166 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.IReadonlyFontStyles + summary: Font styles for different sizes. + isPreview: true + name: IReadonlyFontStyles + fullName: sp-component-base.IReadonlyFontStyles + langs: + - typeScript + type: interface + package: sp-component-base + children: + - sp-component-base.IReadonlyFontStyles.large + - sp-component-base.IReadonlyFontStyles.medium + - sp-component-base.IReadonlyFontStyles.mediumPlus + - sp-component-base.IReadonlyFontStyles.mega + - sp-component-base.IReadonlyFontStyles.small + - sp-component-base.IReadonlyFontStyles.smallPlus + - sp-component-base.IReadonlyFontStyles.superLarge + - sp-component-base.IReadonlyFontStyles.tiny + - sp-component-base.IReadonlyFontStyles.xLarge + - sp-component-base.IReadonlyFontStyles.xSmall + - sp-component-base.IReadonlyFontStyles.xxLarge + - uid: sp-component-base.IReadonlyFontStyles.large + summary: Large font style. + isPreview: true + name: large + fullName: sp-component-base.IReadonlyFontStyles.large + langs: + - typeScript + type: property + syntax: + content: 'large: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.medium + summary: Medium font style. + isPreview: true + name: medium + fullName: sp-component-base.IReadonlyFontStyles.medium + langs: + - typeScript + type: property + syntax: + content: 'medium: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.mediumPlus + summary: Larger than medium but smaller than large font style. + isPreview: true + name: mediumPlus + fullName: sp-component-base.IReadonlyFontStyles.mediumPlus + langs: + - typeScript + type: property + syntax: + content: 'mediumPlus: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.mega + summary: Mega sized font style. + isPreview: true + name: mega + fullName: sp-component-base.IReadonlyFontStyles.mega + langs: + - typeScript + type: property + syntax: + content: 'mega: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.small + summary: Small font style. + isPreview: true + name: small + fullName: sp-component-base.IReadonlyFontStyles.small + langs: + - typeScript + type: property + syntax: + content: 'small: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.smallPlus + summary: Larger than small but smaller than medium font style. + isPreview: true + name: smallPlus + fullName: sp-component-base.IReadonlyFontStyles.smallPlus + langs: + - typeScript + type: property + syntax: + content: 'smallPlus: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.superLarge + summary: Super large font style. + isPreview: true + name: superLarge + fullName: sp-component-base.IReadonlyFontStyles.superLarge + langs: + - typeScript + type: property + syntax: + content: 'superLarge: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.tiny + summary: Tiny font style. + isPreview: true + name: tiny + fullName: sp-component-base.IReadonlyFontStyles.tiny + langs: + - typeScript + type: property + syntax: + content: 'tiny: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.xLarge + summary: Extra large font style. + isPreview: true + name: xLarge + fullName: sp-component-base.IReadonlyFontStyles.xLarge + langs: + - typeScript + type: property + syntax: + content: 'xLarge: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.xSmall + summary: Extra small font style. + isPreview: true + name: xSmall + fullName: sp-component-base.IReadonlyFontStyles.xSmall + langs: + - typeScript + type: property + syntax: + content: 'xSmall: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle + - uid: sp-component-base.IReadonlyFontStyles.xxLarge + summary: Extra extra large font style. + isPreview: true + name: xxLarge + fullName: sp-component-base.IReadonlyFontStyles.xxLarge + langs: + - typeScript + type: property + syntax: + content: 'xxLarge: IReadonlyRawStyle;' + return: + type: + - IReadonlyRawStyle diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml new file mode 100644 index 00000000..65064e14 --- /dev/null +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -0,0 +1,56 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.IReadonlyTheme + summary: Immutable ITheme. + isPreview: true + name: IReadonlyTheme + fullName: sp-component-base.IReadonlyTheme + langs: + - typeScript + type: interface + extends: + - Readonly + package: sp-component-base + children: + - sp-component-base.IReadonlyTheme.fonts + - sp-component-base.IReadonlyTheme.palette + - sp-component-base.IReadonlyTheme.semanticColors + - uid: sp-component-base.IReadonlyTheme.fonts + summary: Font styles for different sizes. + isPreview: true + name: fonts + fullName: sp-component-base.IReadonlyTheme.fonts + langs: + - typeScript + type: property + syntax: + content: 'readonly fonts: Readonly;' + return: + type: + - Readonly + - uid: sp-component-base.IReadonlyTheme.palette + summary: Color palette. + isPreview: true + name: palette + fullName: sp-component-base.IReadonlyTheme.palette + langs: + - typeScript + type: property + syntax: + content: 'readonly palette: Readonly;' + return: + type: + - Readonly + - uid: sp-component-base.IReadonlyTheme.semanticColors + summary: The collection of all semantic slots for colors used in themes. + isPreview: true + name: semanticColors + fullName: sp-component-base.IReadonlyTheme.semanticColors + langs: + - typeScript + type: property + syntax: + content: 'readonly semanticColors: Readonly;' + return: + type: + - Readonly diff --git a/SP-Framework/sp-component-base/isemanticcolors.yml b/SP-Framework/sp-component-base/isemanticcolors.yml new file mode 100644 index 00000000..3038b554 --- /dev/null +++ b/SP-Framework/sp-component-base/isemanticcolors.yml @@ -0,0 +1,1016 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.ISemanticColors + summary: >- + The collection of semantic slots for colors used in themes. + + + \#\# Naming Convention + + + The name of a semantic slot can quickly tell you how it’s meant to be used. It generally follows this format: + + + \[category name\]\[element name\]\[checked state\]\[hovered/pressed/disabled state\] \[category name\] – The + “family” that this slot belongs to. \[element name\] – The name of the thing being targeted, such as the + background or border. \[checked state\] – Whether the thing is checked. We assume things are unchecked by default, + so no need to specify the unchecked state. (We used “checked” to refer to anything that is on, selected, toggled, + highlighted, emphasized, etc.) \[hovered/pressed/disabled state\] – One of these states, if applicable. Each of + these states are mutually exclusive. Pressed styles overwrite hovered styles, and disabled elements cannot be + hovered or pressed. + + + \#\# Base Slots + + + A basic set of slots that provide many default body styles, such as text, subtext, disabled colors, and so on. If + a category doesn't provide the slot you're looking for, use one from this category. For example, the placeholder + text on a text input field has no corresponding slot in its category, so you'd use the bodySubtextColor from this + category. + + + \#\# Invariants + + + When color has meaning, we do not want to change the color much theme to theme. For example, we will always want + errors to be some shade of red, but we will need to tweak the exact shade so it's legible depending on whether + it's an inverted theme or not. Invariant colors should almost never be changed by the theme, the defaults should + suffice. + + + \#\# Input Controls + + + This category contains input components commonly used to denote state, including radio buttons, check boxes, + toggle switches, sliders, progress bars, and more. + + + \#\# Buttons + + + Buttons! And all the flavors thereof. + + + \#\# Menus + + + Any kind of popup menus uses this category. + + + \#\# Lists + + + Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a + large and complex interaction surface. This category covers all kinds of lists, whether they're typical + one-item-per-row lists (like DetailsList) or ones with a tiled layout. + isPreview: true + name: ISemanticColors + fullName: sp-component-base.ISemanticColors + langs: + - typeScript + type: interface + package: sp-component-base + children: + - sp-component-base.ISemanticColors.actionLink + - sp-component-base.ISemanticColors.actionLinkHovered + - sp-component-base.ISemanticColors.blockingBackground + - sp-component-base.ISemanticColors.bodyBackground + - sp-component-base.ISemanticColors.bodyDivider + - sp-component-base.ISemanticColors.bodyFrameBackground + - sp-component-base.ISemanticColors.bodyFrameDivider + - sp-component-base.ISemanticColors.bodyStandoutBackground + - sp-component-base.ISemanticColors.bodySubtext + - sp-component-base.ISemanticColors.bodyText + - sp-component-base.ISemanticColors.bodyTextChecked + - sp-component-base.ISemanticColors.buttonBackground + - sp-component-base.ISemanticColors.buttonBackgroundChecked + - sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered + - sp-component-base.ISemanticColors.buttonBackgroundHovered + - sp-component-base.ISemanticColors.buttonBackgroundPressed + - sp-component-base.ISemanticColors.buttonBorder + - sp-component-base.ISemanticColors.buttonBorderDisabled + - sp-component-base.ISemanticColors.buttonText + - sp-component-base.ISemanticColors.buttonTextChecked + - sp-component-base.ISemanticColors.buttonTextCheckedHovered + - sp-component-base.ISemanticColors.buttonTextDisabled + - sp-component-base.ISemanticColors.buttonTextHovered + - sp-component-base.ISemanticColors.buttonTextPressed + - sp-component-base.ISemanticColors.disabledBackground + - sp-component-base.ISemanticColors.disabledBodyText + - sp-component-base.ISemanticColors.disabledSubtext + - sp-component-base.ISemanticColors.disabledText + - sp-component-base.ISemanticColors.errorBackground + - sp-component-base.ISemanticColors.errorText + - sp-component-base.ISemanticColors.focusBorder + - sp-component-base.ISemanticColors.inputBackground + - sp-component-base.ISemanticColors.inputBackgroundChecked + - sp-component-base.ISemanticColors.inputBackgroundCheckedHovered + - sp-component-base.ISemanticColors.inputBorder + - sp-component-base.ISemanticColors.inputBorderHovered + - sp-component-base.ISemanticColors.inputFocusBorderAlt + - sp-component-base.ISemanticColors.inputForegroundChecked + - sp-component-base.ISemanticColors.inputPlaceholderText + - sp-component-base.ISemanticColors.link + - sp-component-base.ISemanticColors.linkHovered + - sp-component-base.ISemanticColors.listBackground + - sp-component-base.ISemanticColors.listHeaderBackgroundHovered + - sp-component-base.ISemanticColors.listHeaderBackgroundPressed + - sp-component-base.ISemanticColors.listItemBackgroundChecked + - sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered + - sp-component-base.ISemanticColors.listItemBackgroundHovered + - sp-component-base.ISemanticColors.listText + - sp-component-base.ISemanticColors.listTextColor + - sp-component-base.ISemanticColors.menuHeader + - sp-component-base.ISemanticColors.menuIcon + - sp-component-base.ISemanticColors.menuItemBackgroundChecked + - sp-component-base.ISemanticColors.menuItemBackgroundHovered + - sp-component-base.ISemanticColors.primaryButtonBackground + - sp-component-base.ISemanticColors.primaryButtonBackgroundHovered + - sp-component-base.ISemanticColors.primaryButtonBackgroundPressed + - sp-component-base.ISemanticColors.primaryButtonBorder + - sp-component-base.ISemanticColors.primaryButtonText + - sp-component-base.ISemanticColors.primaryButtonTextHovered + - sp-component-base.ISemanticColors.primaryButtonTextPressed + - sp-component-base.ISemanticColors.smallInputBorder + - sp-component-base.ISemanticColors.successBackground + - sp-component-base.ISemanticColors.variantBorder + - sp-component-base.ISemanticColors.warningBackground + - sp-component-base.ISemanticColors.warningHighlight + - sp-component-base.ISemanticColors.warningText + - uid: sp-component-base.ISemanticColors.actionLink + summary: Neutral colored links and links for action buttons. + isPreview: true + name: actionLink + fullName: sp-component-base.ISemanticColors.actionLink + langs: + - typeScript + type: property + syntax: + content: 'actionLink: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.actionLinkHovered + summary: Hover state for neutral colored links and links for action buttons. + isPreview: true + name: actionLinkHovered + fullName: sp-component-base.ISemanticColors.actionLinkHovered + langs: + - typeScript + type: property + syntax: + content: 'actionLinkHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.blockingBackground + summary: 'Background for blocking issues, which is more severe than a warning, but not as bad as an error.' + isPreview: true + name: blockingBackground + fullName: sp-component-base.ISemanticColors.blockingBackground + langs: + - typeScript + type: property + syntax: + content: 'blockingBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyBackground + summary: The default color for backgrounds. + isPreview: true + name: bodyBackground + fullName: sp-component-base.ISemanticColors.bodyBackground + langs: + - typeScript + type: property + syntax: + content: 'bodyBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyDivider + summary: 'Divider lines; e.g. lines that separate sections in a menu, an
element.' + isPreview: true + name: bodyDivider + fullName: sp-component-base.ISemanticColors.bodyDivider + langs: + - typeScript + type: property + syntax: + content: 'bodyDivider: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyFrameBackground + summary: >- + The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of + zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the + color of bodyBackground. See also: bodyFrameDivider + isPreview: true + name: bodyFrameBackground + fullName: sp-component-base.ISemanticColors.bodyFrameBackground + langs: + - typeScript + type: property + syntax: + content: 'bodyFrameBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyFrameDivider + summary: >- + Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and + bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually + disappear. See also: bodyFrameBackground + isPreview: true + name: bodyFrameDivider + fullName: sp-component-base.ISemanticColors.bodyFrameDivider + langs: + - typeScript + type: property + syntax: + content: 'bodyFrameDivider: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyStandoutBackground + summary: >- + The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the + neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in + inverted themes. + isPreview: true + name: bodyStandoutBackground + fullName: sp-component-base.ISemanticColors.bodyStandoutBackground + langs: + - typeScript + type: property + syntax: + content: 'bodyStandoutBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodySubtext + summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' + isPreview: true + name: bodySubtext + fullName: sp-component-base.ISemanticColors.bodySubtext + langs: + - typeScript + type: property + syntax: + content: 'bodySubtext: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyText + summary: The default color for text. + isPreview: true + name: bodyText + fullName: sp-component-base.ISemanticColors.bodyText + langs: + - typeScript + type: property + syntax: + content: 'bodyText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.bodyTextChecked + summary: 'Checked text color, e.g. selected menu item text.' + isPreview: true + name: bodyTextChecked + fullName: sp-component-base.ISemanticColors.bodyTextChecked + langs: + - typeScript + type: property + syntax: + content: 'bodyTextChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBackground + summary: Background of a standard button + isPreview: true + name: buttonBackground + fullName: sp-component-base.ISemanticColors.buttonBackground + langs: + - typeScript + type: property + syntax: + content: 'buttonBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBackgroundChecked + summary: Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar + isPreview: true + name: buttonBackgroundChecked + fullName: sp-component-base.ISemanticColors.buttonBackgroundChecked + langs: + - typeScript + type: property + syntax: + content: 'buttonBackgroundChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered + summary: Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar + isPreview: true + name: buttonBackgroundCheckedHovered + fullName: sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered + langs: + - typeScript + type: property + syntax: + content: 'buttonBackgroundCheckedHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBackgroundHovered + summary: Background of a hovered standard button + isPreview: true + name: buttonBackgroundHovered + fullName: sp-component-base.ISemanticColors.buttonBackgroundHovered + langs: + - typeScript + type: property + syntax: + content: 'buttonBackgroundHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBackgroundPressed + summary: Background of a pressed standard button; i.e. currently being clicked by mouse + isPreview: true + name: buttonBackgroundPressed + fullName: sp-component-base.ISemanticColors.buttonBackgroundPressed + langs: + - typeScript + type: property + syntax: + content: 'buttonBackgroundPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBorder + summary: Border of a standard button + isPreview: true + name: buttonBorder + fullName: sp-component-base.ISemanticColors.buttonBorder + langs: + - typeScript + type: property + syntax: + content: 'buttonBorder: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonBorderDisabled + summary: Border of a disabled standard button + isPreview: true + name: buttonBorderDisabled + fullName: sp-component-base.ISemanticColors.buttonBorderDisabled + langs: + - typeScript + type: property + syntax: + content: 'buttonBorderDisabled: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonText + summary: Color of text in a standard button + isPreview: true + name: buttonText + fullName: sp-component-base.ISemanticColors.buttonText + langs: + - typeScript + type: property + syntax: + content: 'buttonText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonTextChecked + summary: Color of text in a checked standard button + isPreview: true + name: buttonTextChecked + fullName: sp-component-base.ISemanticColors.buttonTextChecked + langs: + - typeScript + type: property + syntax: + content: 'buttonTextChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonTextCheckedHovered + summary: Color of text in a checked and hovered standard button + isPreview: true + name: buttonTextCheckedHovered + fullName: sp-component-base.ISemanticColors.buttonTextCheckedHovered + langs: + - typeScript + type: property + syntax: + content: 'buttonTextCheckedHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonTextDisabled + summary: Color of text in a disabled standard button + isPreview: true + name: buttonTextDisabled + fullName: sp-component-base.ISemanticColors.buttonTextDisabled + langs: + - typeScript + type: property + syntax: + content: 'buttonTextDisabled: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonTextHovered + summary: Color of text in a hovered standard button + isPreview: true + name: buttonTextHovered + fullName: sp-component-base.ISemanticColors.buttonTextHovered + langs: + - typeScript + type: property + syntax: + content: 'buttonTextHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.buttonTextPressed + summary: Color of text in a pressed standard button; i.e. currently being clicked by mouse + isPreview: true + name: buttonTextPressed + fullName: sp-component-base.ISemanticColors.buttonTextPressed + langs: + - typeScript + type: property + syntax: + content: 'buttonTextPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.disabledBackground + summary: The default color for backgrounds of disabled controls; e.g. disabled text field. + isPreview: true + name: disabledBackground + fullName: sp-component-base.ISemanticColors.disabledBackground + langs: + - typeScript + type: property + syntax: + content: 'disabledBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.disabledBodyText + summary: The default color for disabled text on the default background (bodyBackground). + isPreview: true + name: disabledBodyText + fullName: sp-component-base.ISemanticColors.disabledBodyText + langs: + - typeScript + type: property + syntax: + content: 'disabledBodyText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.disabledSubtext + summary: 'Disabled de-emphasized text, for use on disabledBackground.' + isPreview: true + name: disabledSubtext + fullName: sp-component-base.ISemanticColors.disabledSubtext + langs: + - typeScript + type: property + syntax: + content: 'disabledSubtext: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.disabledText + summary: >- + The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled + button text. + isPreview: true + name: disabledText + fullName: sp-component-base.ISemanticColors.disabledText + langs: + - typeScript + type: property + syntax: + content: 'disabledText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.errorBackground + summary: 'The background for errors, if necessary, or highlighting the section of the page where the error is present.' + isPreview: true + name: errorBackground + fullName: sp-component-base.ISemanticColors.errorBackground + langs: + - typeScript + type: property + syntax: + content: 'errorBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.errorText + summary: 'The default color of error text, used on bodyBackground.' + isPreview: true + name: errorText + fullName: sp-component-base.ISemanticColors.errorText + langs: + - typeScript + type: property + syntax: + content: 'errorText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.focusBorder + summary: The color of the outline around focused controls that don't already have a border; e.g. menu items + isPreview: true + name: focusBorder + fullName: sp-component-base.ISemanticColors.focusBorder + langs: + - typeScript + type: property + syntax: + content: 'focusBorder: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputBackground + summary: 'The background color of an input, e.g. textbox background.' + isPreview: true + name: inputBackground + fullName: sp-component-base.ISemanticColors.inputBackground + langs: + - typeScript + type: property + syntax: + content: 'inputBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputBackgroundChecked + summary: 'The background of a checked control; e.g. checked radio button''s dot, checked toggle''s background.' + isPreview: true + name: inputBackgroundChecked + fullName: sp-component-base.ISemanticColors.inputBackgroundChecked + langs: + - typeScript + type: property + syntax: + content: 'inputBackgroundChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputBackgroundCheckedHovered + summary: The background of a checked and hovered control; e.g. checked checkbox's background color on hover. + isPreview: true + name: inputBackgroundCheckedHovered + fullName: sp-component-base.ISemanticColors.inputBackgroundCheckedHovered + langs: + - typeScript + type: property + syntax: + content: 'inputBackgroundCheckedHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputBorder + summary: 'The border of a large input control in its resting, state; e.g. the box of dropdown.' + isPreview: true + name: inputBorder + fullName: sp-component-base.ISemanticColors.inputBorder + langs: + - typeScript + type: property + syntax: + content: 'inputBorder: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputBorderHovered + summary: 'The border color of a large hovered input control, such as textbox.' + isPreview: true + name: inputBorderHovered + fullName: sp-component-base.ISemanticColors.inputBorderHovered + langs: + - typeScript + type: property + syntax: + content: 'inputBorderHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputFocusBorderAlt + summary: The alternate focus border color for elements that already have a border; e.g. text field borders on focus. + isPreview: true + name: inputFocusBorderAlt + fullName: sp-component-base.ISemanticColors.inputFocusBorderAlt + langs: + - typeScript + type: property + syntax: + content: 'inputFocusBorderAlt: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputForegroundChecked + summary: >- + The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio + button's background color around the dot. + isPreview: true + name: inputForegroundChecked + fullName: sp-component-base.ISemanticColors.inputForegroundChecked + langs: + - typeScript + type: property + syntax: + content: 'inputForegroundChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.inputPlaceholderText + summary: The color of placeholder text. + isPreview: true + name: inputPlaceholderText + fullName: sp-component-base.ISemanticColors.inputPlaceholderText + langs: + - typeScript + type: property + syntax: + content: 'inputPlaceholderText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.link + summary: The color of a link. + isPreview: true + name: link + fullName: sp-component-base.ISemanticColors.link + langs: + - typeScript + type: property + syntax: + content: 'link: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.linkHovered + summary: The color of a hovered link. Also used when the link is active. + isPreview: true + name: linkHovered + fullName: sp-component-base.ISemanticColors.linkHovered + langs: + - typeScript + type: property + syntax: + content: 'linkHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listBackground + summary: The background color for the entire list. + isPreview: true + name: listBackground + fullName: sp-component-base.ISemanticColors.listBackground + langs: + - typeScript + type: property + syntax: + content: 'listBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listHeaderBackgroundHovered + summary: The background color for a hovered list header. + isPreview: true + name: listHeaderBackgroundHovered + fullName: sp-component-base.ISemanticColors.listHeaderBackgroundHovered + langs: + - typeScript + type: property + syntax: + content: 'listHeaderBackgroundHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listHeaderBackgroundPressed + summary: The background color for a pressed list header. + isPreview: true + name: listHeaderBackgroundPressed + fullName: sp-component-base.ISemanticColors.listHeaderBackgroundPressed + langs: + - typeScript + type: property + syntax: + content: 'listHeaderBackgroundPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listItemBackgroundChecked + summary: The background color of a checked list item. + isPreview: true + name: listItemBackgroundChecked + fullName: sp-component-base.ISemanticColors.listItemBackgroundChecked + langs: + - typeScript + type: property + syntax: + content: 'listItemBackgroundChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered + summary: The background color of a checked and hovered list item. + isPreview: true + name: listItemBackgroundCheckedHovered + fullName: sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered + langs: + - typeScript + type: property + syntax: + content: 'listItemBackgroundCheckedHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listItemBackgroundHovered + summary: The background color of a hovered list item. + isPreview: true + name: listItemBackgroundHovered + fullName: sp-component-base.ISemanticColors.listItemBackgroundHovered + langs: + - typeScript + type: property + syntax: + content: 'listItemBackgroundHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listText + summary: The default text color for list item titles and text in column fields. + isPreview: true + name: listText + fullName: sp-component-base.ISemanticColors.listText + langs: + - typeScript + type: property + syntax: + content: 'listText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.listTextColor + summary: Deprecated. Do not use. + deprecated: + content: This slot was incorrectly named. Use listText instead. + isPreview: true + name: listTextColor + fullName: sp-component-base.ISemanticColors.listTextColor + langs: + - typeScript + type: property + syntax: + content: 'listTextColor: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.menuHeader + summary: The headers in menus that denote title of a section. + isPreview: true + name: menuHeader + fullName: sp-component-base.ISemanticColors.menuHeader + langs: + - typeScript + type: property + syntax: + content: 'menuHeader: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.menuIcon + summary: The default colors of icons in menus. + isPreview: true + name: menuIcon + fullName: sp-component-base.ISemanticColors.menuIcon + langs: + - typeScript + type: property + syntax: + content: 'menuIcon: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.menuItemBackgroundChecked + summary: Deprecated. Do not use. + deprecated: + content: >- + (Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item + whose submenu is open, a selected dropdown item. + isPreview: true + name: menuItemBackgroundChecked + fullName: sp-component-base.ISemanticColors.menuItemBackgroundChecked + langs: + - typeScript + type: property + syntax: + content: 'menuItemBackgroundChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.menuItemBackgroundHovered + summary: The background of a hovered menu item. + isPreview: true + name: menuItemBackgroundHovered + fullName: sp-component-base.ISemanticColors.menuItemBackgroundHovered + langs: + - typeScript + type: property + syntax: + content: 'menuItemBackgroundHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonBackground + summary: Background of a primary button + isPreview: true + name: primaryButtonBackground + fullName: sp-component-base.ISemanticColors.primaryButtonBackground + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundHovered + summary: Background of a hovered primary button + isPreview: true + name: primaryButtonBackgroundHovered + fullName: sp-component-base.ISemanticColors.primaryButtonBackgroundHovered + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonBackgroundHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundPressed + summary: Background of a pressed primary button; i.e. currently being clicked by mouse + isPreview: true + name: primaryButtonBackgroundPressed + fullName: sp-component-base.ISemanticColors.primaryButtonBackgroundPressed + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonBackgroundPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonBorder + summary: Border of a primary button + isPreview: true + name: primaryButtonBorder + fullName: sp-component-base.ISemanticColors.primaryButtonBorder + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonBorder: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonText + summary: Color of text in a primary button + isPreview: true + name: primaryButtonText + fullName: sp-component-base.ISemanticColors.primaryButtonText + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonTextHovered + summary: Color of text in a hovered primary button + isPreview: true + name: primaryButtonTextHovered + fullName: sp-component-base.ISemanticColors.primaryButtonTextHovered + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonTextHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonTextPressed + summary: Color of text in a pressed primary button; i.e. currently being clicked by mouse + isPreview: true + name: primaryButtonTextPressed + fullName: sp-component-base.ISemanticColors.primaryButtonTextPressed + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonTextPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.smallInputBorder + summary: The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox. + isPreview: true + name: smallInputBorder + fullName: sp-component-base.ISemanticColors.smallInputBorder + langs: + - typeScript + type: property + syntax: + content: 'smallInputBorder: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.successBackground + summary: Background for success + isPreview: true + name: successBackground + fullName: sp-component-base.ISemanticColors.successBackground + langs: + - typeScript + type: property + syntax: + content: 'successBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.variantBorder + summary: 'The color of the border that provides contrast between an element, such as a card, and an emphasized background.' + isPreview: true + name: variantBorder + fullName: sp-component-base.ISemanticColors.variantBorder + langs: + - typeScript + type: property + syntax: + content: 'variantBorder: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.warningBackground + summary: Background for warning messages. + isPreview: true + name: warningBackground + fullName: sp-component-base.ISemanticColors.warningBackground + langs: + - typeScript + type: property + syntax: + content: 'warningBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.warningHighlight + summary: Foreground color for warning highlights + isPreview: true + name: warningHighlight + fullName: sp-component-base.ISemanticColors.warningHighlight + langs: + - typeScript + type: property + syntax: + content: 'warningHighlight: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.warningText + summary: 'The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.' + isPreview: true + name: warningText + fullName: sp-component-base.ISemanticColors.warningText + langs: + - typeScript + type: property + syntax: + content: 'warningText: string;' + return: + type: + - string diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml new file mode 100644 index 00000000..b9af6c42 --- /dev/null +++ b/SP-Framework/sp-component-base/itheme.yml @@ -0,0 +1,82 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.ITheme + summary: 'Collection of theme values, which can be used to programatically style components.' + isPreview: true + name: ITheme + fullName: sp-component-base.ITheme + langs: + - typeScript + type: interface + package: sp-component-base + children: + - sp-component-base.ITheme.disableGlobalClassNames + - sp-component-base.ITheme.fonts + - sp-component-base.ITheme.isInverted + - sp-component-base.ITheme.palette + - sp-component-base.ITheme.semanticColors + - uid: sp-component-base.ITheme.disableGlobalClassNames + summary: >- + Diables global styles on Fabric components. This will prevent global overrides that might have been set by other + Fabric users from applying to your components. + remarks: This has a vary narrow use case and most likely should be avoided. + isPreview: true + name: disableGlobalClassNames + fullName: sp-component-base.ITheme.disableGlobalClassNames + langs: + - typeScript + type: property + syntax: + content: 'disableGlobalClassNames: boolean;' + return: + type: + - boolean + - uid: sp-component-base.ITheme.fonts + summary: Font styles for different sizes. + name: fonts + fullName: sp-component-base.ITheme.fonts + langs: + - typeScript + type: property + syntax: + content: 'fonts: IFontStyles;' + return: + type: + - IFontStyles + - uid: sp-component-base.ITheme.isInverted + summary: Indicates whether the theme is inverted. + isPreview: true + name: isInverted + fullName: sp-component-base.ITheme.isInverted + langs: + - typeScript + type: property + syntax: + content: 'isInverted: boolean;' + return: + type: + - boolean + - uid: sp-component-base.ITheme.palette + summary: Color palette. + name: palette + fullName: sp-component-base.ITheme.palette + langs: + - typeScript + type: property + syntax: + content: 'palette: IPalette;' + return: + type: + - IPalette + - uid: sp-component-base.ITheme.semanticColors + summary: The collection of all semantic slots for colors used in themes. + name: semanticColors + fullName: sp-component-base.ITheme.semanticColors + langs: + - typeScript + type: property + syntax: + content: 'semanticColors: ISemanticColors;' + return: + type: + - ISemanticColors diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml new file mode 100644 index 00000000..17c1b969 --- /dev/null +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -0,0 +1,28 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.ThemeChangedEventArgs + summary: The object passed when the IThemeProvider.themeChangedEvent is raised. + isPreview: true + name: ThemeChangedEventArgs + fullName: sp-component-base.ThemeChangedEventArgs + langs: + - typeScript + type: class + extends: + - SPEventArgs + package: sp-component-base + children: + - sp-component-base.ThemeChangedEventArgs.theme + - uid: sp-component-base.ThemeChangedEventArgs.theme + summary: 'The new theme. If the value is undefined, then the theme was cleared.' + isPreview: true + name: theme + fullName: sp-component-base.ThemeChangedEventArgs.theme + langs: + - typeScript + type: property + syntax: + content: 'readonly theme: ITheme | undefined;' + return: + type: + - ITheme | undefined diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml new file mode 100644 index 00000000..c5624ab4 --- /dev/null +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -0,0 +1,76 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.ThemeProvider + summary: >- + The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided + in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. + isPreview: true + name: ThemeProvider + fullName: sp-component-base.ThemeProvider + langs: + - typeScript + type: class + package: sp-component-base + children: + - sp-component-base.ThemeProvider.constructor + - sp-component-base.ThemeProvider.serviceKey + - sp-component-base.ThemeProvider.themeChangedEvent + - sp-component-base.ThemeProvider.tryGetTheme + - uid: sp-component-base.ThemeProvider.constructor + summary: 'Constructs a new instance of the [ThemeProvider](xref:sp-component-base.ThemeProvider) class' + name: 'constructor(serviceScope, theme)' + fullName: sp-component-base.ThemeProvider.constructor + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' + parameters: + - id: serviceScope + description: '' + type: + - ServiceScope + - id: theme + description: '' + type: + - ITheme + - uid: sp-component-base.ThemeProvider.serviceKey + summary: The service key for ThemeProvider. + isPreview: true + name: serviceKey + fullName: sp-component-base.ThemeProvider.serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - ServiceKey + - uid: sp-component-base.ThemeProvider.themeChangedEvent + summary: Raised when the theme changes with the new theme as an argument. + isPreview: true + name: themeChangedEvent + fullName: sp-component-base.ThemeProvider.themeChangedEvent + langs: + - typeScript + type: event + syntax: + content: 'readonly themeChangedEvent: SPEvent;' + return: + type: + - SPEvent + - uid: sp-component-base.ThemeProvider.tryGetTheme + summary: 'If set, get the current scoped theme.' + isPreview: true + name: tryGetTheme() + fullName: sp-component-base.ThemeProvider.tryGetTheme + langs: + - typeScript + type: method + syntax: + content: 'tryGetTheme(): IReadonlyTheme | undefined;' + return: + type: + - IReadonlyTheme | undefined + description: '' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index b308b4a7..b5e80066 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -5,11 +5,11 @@ items: remarks: >- The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware - that the uniqueness depends on the browser's Math.random() function and may be not be suitable for some + that the uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications. - See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. + See [ RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. name: Guid fullName: sp-core-library.Guid langs: @@ -55,8 +55,8 @@ items: - Guid - uid: sp-core-library.Guid.isValid summary: >- - Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by Guid.tryParse(). This function - is cheaper than Guid.tryParse() because it does not construct a Guid object. + Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This + function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. name: isValid(guid) fullName: sp-core-library.Guid.isValid langs: @@ -95,9 +95,14 @@ items: - IRandomNumberGenerator - uid: sp-core-library.Guid.parse summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' - remarks: >- - Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' - '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)' + remarks: |- + Example syntaxes accepted by this function: + + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` + + - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` + + - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` name: parse(guidString) fullName: sp-core-library.Guid.parse langs: @@ -118,9 +123,14 @@ items: summary: >- Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned. - remarks: >- - Example syntaxes accepted by this function: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' - '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)' + remarks: |- + Example syntaxes accepted by this function: + + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` + + - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` + + - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` name: tryParse(guid) fullName: sp-core-library.Guid.tryParse langs: diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index 0a52130b..8fc60cfa 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -15,15 +15,15 @@ items: - uid: sp-core-library.Text.format summary: Format a string by substituting parameters. remarks: >- - This function replaces template parameters such as "{0}" or "{1}" with the corresponding argument. If the value is - null or undefined, it will be replaced by the word "null" or "undefined". The format string s must not be null or - undefined. + This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the + value is null or undefined, it will be replaced by the word `"null"` or `"undefined"`. The format string s + must not be null or undefined. Usage example: - Text.format("hello {0}!", "world") will return "hello world!" + `Text.format("hello {0}!", "world")` will return `"hello world!"` name: 'format(s, values)' fullName: sp-core-library.Text.format langs: @@ -45,8 +45,8 @@ items: type: - 'any[]' - uid: sp-core-library.Text.replaceAll - summary: 'Returns the input string, with all instances of searchValue replaced by replaceValue.' - remarks: 'Note that JavaScript''s string.replace() only replaces the first match, unless a global RegExp is provided.' + summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' + remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' name: 'replaceAll(input, searchValue, replaceValue)' fullName: sp-core-library.Text.replaceAll langs: diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index c8489f22..a836af0c 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -46,10 +46,18 @@ items: - string - uid: sp-core-library.UrlQueryParameterCollection.getValue summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. - remarks: >- - Examples: this.\_queryParameterList = \[ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: - notdone}\] getValue('TEST') \-\-\-> 'done' getValue('debug') \-\-\-> 'false' getValue('lost') \-\-\-> - undefined + remarks: |- + Examples: + ``` + this._queryParameterList = [ + {key: TEST, value: done}, + {key: DEBUG, value: false}, + {key: TEST, value: notdone}] + getValue('TEST') ---> 'done' + getValue('debug') ---> 'false' + getValue('lost') ---> undefined + + ``` deprecated: content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: getValue(param) @@ -70,10 +78,18 @@ items: - string - uid: sp-core-library.UrlQueryParameterCollection.getValues summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. - remarks: >- - Examples: this.\_queryParameterList = \[ {key: TEST, value: done}, {key: DEBUG, value: false}, {key: TEST, value: - notdone}\] getValues('TEST') \-\-\-> \['done', 'notdone'\] getValues('debug') \-\-\-> \['false'\] - getValues('lost') \-\-\-> undefined + remarks: |- + Examples: + ``` + this._queryParameterList = [ + {key: TEST, value: done}, + {key: DEBUG, value: false}, + {key: TEST, value: notdone}] + getValues('TEST') ---> ['done', 'notdone'] + getValues('debug') ---> ['false'] + getValues('lost') ---> undefined + + ``` deprecated: content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: getValues(param) diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index bf1a2990..171d4933 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -3,12 +3,12 @@ items: - uid: sp-core-library.Version summary: 'Represents a version number with two, three, or four parts.' remarks: >- - This class represents versions that follow the string format of MAJOR.MINOR\[.PATCH\[.REVISION\]\] where the - MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are - allowed, but they are discarded. Missing parts are treated as zeroes for comparisons. + This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, + MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, + but they are discarded. Missing parts are treated as zeroes for comparisons. - Examples: 1.0, 1.0.0, 1.0.0.0, 1.01, 01.02.03, 001.002.003.004 + Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` name: Version fullName: sp-core-library.Version langs: @@ -54,12 +54,15 @@ items: - Version - uid: sp-core-library.Version.equals summary: Tests whether this version is equal to the input parameter. - remarks: >- + remarks: |- Examples: + ``` + 1.0.0 equals 1.0.0 -> true; + 2.0.1 equals 2.0.0 -> false; + 3.0 equals 3.0.0 -> true; + 04.01 equals 4.1 -> true - - 1.0.0 equals 1.0.0 -> true; 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> - true + ``` name: equals(compareWith) fullName: sp-core-library.Version.equals langs: @@ -80,8 +83,12 @@ items: summary: Tests whether this version is greater than (i.e. newer than) the input parameter. remarks: |- Examples: + ``` + 1.0.0 greaterThan 0.0.9 -> true; + 2.0 greaterThan 2.0.0 -> false; + 3.0.1 greaterThan 3.0 -> true - 1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true + ``` name: greaterThan(compareWith) fullName: sp-core-library.Version.greaterThan langs: @@ -118,12 +125,15 @@ items: - string | undefined | null - uid: sp-core-library.Version.lessThan summary: Tests whether this version is less than (i.e. older than) the input parameter. - remarks: >- + remarks: |- Examples: + ``` + 0.9.9 lessThan 1.0.0 -> true; + 2.0 lessThan 2.0.0 -> false; + 3.0 lessThan 3.0.1 -> true; + 04.01 lessThan 4.1 -> false - - 0.9.9 lessThan 1.0.0 -> true; 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 - -> false + ``` name: lessThan(compareWith) fullName: sp-core-library.Version.lessThan langs: @@ -227,9 +237,18 @@ items: Examples: + ``` + + 1.0.0 satisfies 1.0.0 -> true; + + 1.1.0 satisfies 1.0.0 -> true; + + 2.0.0 satisfies 1.0.0 -> false; + + 1.0.0 satisfies 1.1.0 -> false + - 1.0.0 satisfies 1.0.0 -> true; 1.1.0 satisfies 1.0.0 -> true; 2.0.0 satisfies 1.0.0 -> false; 1.0.0 - satisfies 1.1.0 -> false + ``` name: satisfies(compareWith) fullName: sp-core-library.Version.satisfies langs: diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index a9eaf410..985301e3 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -30,18 +30,32 @@ items: - sp-dialog.BaseDialog.secondaryDialogProvider - sp-dialog.BaseDialog.show - uid: sp-dialog.BaseDialog.constructor - summary: Constructor for the BaseDialog class. + summary: Constructor for the `BaseDialog` class. remarks: >- - It is important to keep the constructor lightweight. Use onBeforeOpen() for doing heavy-weight initialization that - is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use - the constructor to set initial parameters of your dialog such as references to resources in your application. The - reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may - not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience - and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another - benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric - onBeforeOpen() and onAfterClose() events. If you allocate resources in the constructor, you have a memory leak + It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization + that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can + use the constructor to set initial parameters of your dialog such as references to resources in your application. + The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog + may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user + experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects + it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric + `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose. + + + Example: + + ``` + constructor(cacheReference: any) { + super(); + + this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. + this._cache.refresh(); // This is bad practice. + // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() + } + + ``` name: constructor(config) fullName: sp-dialog.BaseDialog.constructor langs: @@ -51,18 +65,14 @@ items: content: 'constructor(config?: IDialogConfiguration);' parameters: - id: config - description: >- - the dialog configuration that affects how the dialog is displayed Example: constructor(cacheReference: any) - { super(); this.\_cache = cacheReference; // This is okay. Keeping a reference to my internal cache. - this.\_cache.refresh(); // This is bad practice. // If you need to refresh the cache (or fetch data) for - rendering, do it in onBeforeOpen() } + description: the dialog configuration that affects how the dialog is displayed \* type: - IDialogConfiguration - uid: sp-dialog.BaseDialog.close - summary: >- - Close the dialog. This will void the permission to show for this dialog. Every dialog should have a mechanism to - eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request - to show. + summary: Close the dialog. + remarks: >- + This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to + avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. name: close() fullName: sp-dialog.BaseDialog.close langs: @@ -75,10 +85,8 @@ items: - Promise description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - uid: sp-dialog.BaseDialog.domElement - summary: |- - Use this property to access the container element provided by the framework for rendering. - - See [BaseDialog.render](xref:sp-dialog.BaseDialog.render) for more information on rendering. + summary: Use this property to access the container element provided by the framework for rendering. + remarks: 'See [BaseDialog.render](xref:sp-dialog.BaseDialog.render) for more information on rendering.' name: domElement fullName: sp-dialog.BaseDialog.domElement langs: @@ -90,10 +98,10 @@ items: type: - HTMLElement - uid: sp-dialog.BaseDialog.isHidden - summary: >- - If the dialog is visually hidden. This happens when the dialog goes behind a secondary dialog. Note that this is - different from closed, because the dialog still has the permission to show and will eventually unhide. This - returns false if the dialog is closed. + summary: If the dialog is visually hidden. + remarks: >- + This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the + dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. name: isHidden fullName: sp-dialog.BaseDialog.isHidden langs: @@ -131,12 +139,12 @@ items: type: - boolean - uid: sp-dialog.BaseDialog.onAfterClose - summary: >- - This method is called after the dialog is visually closed and gives an opportunity for doing clean up. The dialog - lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog - may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should - reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, - consider allocating it outside the dialog object and passing its reference to the dialog constructor. + summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. + remarks: >- + The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though + the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle + that should reallocate its own resources. If there are any resources that you would like to keep for multiple + lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. name: onAfterClose() fullName: sp-dialog.BaseDialog.onAfterClose langs: @@ -152,7 +160,7 @@ items: summary: >- This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. - remarks: All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak. + remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. name: onBeforeOpen() fullName: sp-dialog.BaseDialog.onBeforeOpen langs: @@ -165,15 +173,17 @@ items: - Promise description: >- A promise that resolves when the operations are done and the dialog is ready to render. If the promise is - rejected, the dialog will not be rendered and onAfterClose() will not be called. + rejected, the dialog will not be rendered and `onAfterClose()` will not be called. - uid: sp-dialog.BaseDialog.render - summary: >- - The render method must be implemented to render the content of the dialog in the conrainer element provided by the - framework. Use this.domElement to access this container. The container is inside a modal rendered in the center of - the page on top of a dark overlay. + summary: Renders the contents of the dialog. remarks: >- + The `render` method must be implemented to render the content of the dialog in the container element provided by + the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the + center of the page on top of a dark overlay. + + The render method is called once after the modal element is created and opened. It is recommended to use - onBeforeOpen() for doing non-UI preperations for your rendering that might take a long time. This will ensure that + `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which @@ -224,6 +234,6 @@ items: request is rejected or aborted. parameters: - id: options - description: 'Dialog showing options. See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' + description: 'Dialog showing options. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' type: - IDialogShowOptions diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 570d9d9c..dbcef72c 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -43,7 +43,7 @@ items: type: - string - id: options - description: 'Dialog showing options. See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' + description: 'Dialog showing options. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' type: - IAlertOptions - uid: sp-dialog.ISecondaryDialogProvider.prompt @@ -68,8 +68,8 @@ items: - string - id: options description: >- - Dialog showing options. The confirmOpen option will be ignored. - See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. + Dialog showing options. The confirmOpen option will be ignored. See + [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. type: - IPromptOptions - uid: sp-dialog.ISecondaryDialogProvider.show @@ -94,7 +94,7 @@ items: - BaseDialog - id: options description: >- - Dialog showing options. The confirmOpen option will be ignored. - See[IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. + Dialog showing options. The confirmOpen option will be ignored. See + [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. type: - IDialogShowOptions diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index 577ec9ca..d8ef4434 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -12,20 +12,32 @@ items: type: package children: - sp-dynamic-data.DynamicDataReference + - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue - sp-dynamic-data.IDynamicDataCallables + - sp-dynamic-data.IDynamicDataEventDefinition - sp-dynamic-data.IDynamicDataPropertyDefinition - sp-dynamic-data.IDynamicDataPropertyMetadata + - sp-dynamic-data.IDynamicDataPropertyValueMetadata + - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection - sp-dynamic-data.IDynamicDataSource - sp-dynamic-data.IDynamicDataSourceMetadata references: - uid: sp-dynamic-data.DynamicDataReference name: DynamicDataReference + - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + name: IDynamicDataAnnotatedPropertyValue - uid: sp-dynamic-data.IDynamicDataCallables name: IDynamicDataCallables + - uid: sp-dynamic-data.IDynamicDataEventDefinition + name: IDynamicDataEventDefinition - uid: sp-dynamic-data.IDynamicDataPropertyDefinition name: IDynamicDataPropertyDefinition - uid: sp-dynamic-data.IDynamicDataPropertyMetadata name: IDynamicDataPropertyMetadata + - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + name: IDynamicDataPropertyValueMetadata + - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + name: IDynamicDataPropertyValueMetadataCollection - uid: sp-dynamic-data.IDynamicDataSource name: IDynamicDataSource - uid: sp-dynamic-data.IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 07d12a91..949206ab 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -4,14 +4,10 @@ items: summary: >- Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data - remarks: >- - The reference string is of the form <sourceId>:<property> or - <sourceId>:<property>:<propertyPath> + remarks: |- + The reference string is of the form `:` or `::` - - Examples of references are: PageContext:user - WebPart.<componentId>.<instanceId>:myComplexProperty:myArray\[0\].lastName - isPreview: true + Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` name: DynamicDataReference fullName: sp-dynamic-data.DynamicDataReference langs: @@ -40,7 +36,6 @@ items: - string - uid: sp-dynamic-data.DynamicDataReference.property summary: Returns the referred property of the Dynamic Data. - isPreview: true name: property fullName: sp-dynamic-data.DynamicDataReference.property langs: @@ -53,7 +48,6 @@ items: - string - uid: sp-dynamic-data.DynamicDataReference.propertyPath summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. - isPreview: true name: propertyPath fullName: sp-dynamic-data.DynamicDataReference.propertyPath langs: @@ -66,7 +60,6 @@ items: - string | undefined - uid: sp-dynamic-data.DynamicDataReference.reference summary: Returns the full reference of the Dynamic Data object as a string. - isPreview: true name: reference fullName: sp-dynamic-data.DynamicDataReference.reference langs: @@ -79,7 +72,6 @@ items: - string - uid: sp-dynamic-data.DynamicDataReference.sourceId summary: Returns the referred id of the Dynamic Data Source. - isPreview: true name: sourceId fullName: sp-dynamic-data.DynamicDataReference.sourceId langs: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml new file mode 100644 index 00000000..cf06af1b --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -0,0 +1,39 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + summary: >- + Describes the value and the structure of a property value. It contains sample value of the property and the + metadata describing the structure of that value. + name: IDynamicDataAnnotatedPropertyValue + fullName: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata + - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue + - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata + summary: Metadata describing the sample value of the property. + name: metadata + fullName: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata + langs: + - typeScript + type: property + syntax: + content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' + return: + type: + - IDynamicDataPropertyValueMetadataCollection + - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue + summary: Sample value of a property + name: sampleValue + fullName: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue + langs: + - typeScript + type: property + syntax: + content: 'sampleValue: any;' + return: + type: + - any diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 20d0b10e..9c9293a3 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -4,7 +4,6 @@ items: summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. - isPreview: true name: IDynamicDataCallables fullName: sp-dynamic-data.IDynamicDataCallables langs: @@ -12,13 +11,52 @@ items: type: interface package: sp-dynamic-data children: + - sp-dynamic-data.IDynamicDataCallables.allowedEvents + - sp-dynamic-data.IDynamicDataCallables.getAnnotatedPropertyValue - sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions - sp-dynamic-data.IDynamicDataCallables.getPropertyValue - - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions - summary: >- - Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the - component. + - sp-dynamic-data.IDynamicDataCallables.sendEvent + - uid: sp-dynamic-data.IDynamicDataCallables.allowedEvents + summary: |- + Returns list of allowed events on the dynamic data source. + + When this function returns a non-empty result, then source must define 'sendEvent' api. + + If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. isPreview: true + name: allowedEvents() + fullName: sp-dynamic-data.IDynamicDataCallables.allowedEvents + langs: + - typeScript + type: method + syntax: + content: 'allowedEvents?(): ReadonlyArray;' + return: + type: + - ReadonlyArray + description: '' + - uid: sp-dynamic-data.IDynamicDataCallables.getAnnotatedPropertyValue + summary: >- + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. + name: getAnnotatedPropertyValue(propertyId) + fullName: sp-dynamic-data.IDynamicDataCallables.getAnnotatedPropertyValue + langs: + - typeScript + type: method + syntax: + content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' + return: + type: + - IDynamicDataAnnotatedPropertyValue | undefined + description: '' + parameters: + - id: propertyId + description: One of the property ids exposed from the dynamic data source. + type: + - string + - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions + summary: Returns all the property definitions that the DataSource will provide. name: getPropertyDefinitions() fullName: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions langs: @@ -31,10 +69,8 @@ items: - ReadonlyArray description: '' - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyValue - summary: >- - Given a property id, returns the value of the property. This needs to be overriden by the implementation of the - component. - isPreview: true + summary: 'Given a property id, returns the value of the property.' + remarks: 'It is assumed that when this function returns an array, it is homogeneous.' name: getPropertyValue(propertyId) fullName: sp-dynamic-data.IDynamicDataCallables.getPropertyValue langs: @@ -51,3 +87,31 @@ items: description: '' type: - string + - uid: sp-dynamic-data.IDynamicDataCallables.sendEvent + summary: >- + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. + + + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + isPreview: true + name: 'sendEvent(eventName, data)' + fullName: sp-dynamic-data.IDynamicDataCallables.sendEvent + langs: + - typeScript + type: method + syntax: + content: 'sendEvent?(eventName: string, data: any): void;' + return: + type: + - void + description: '' + parameters: + - id: eventName + description: A case-sensitive string representing the name of the event. + type: + - string + - id: data + description: Data to be sent to the dynamic data source. + type: + - any diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml new file mode 100644 index 00000000..39b97b78 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -0,0 +1,43 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataEventDefinition + summary: |- + Definition of an event which a dynamic data source accepts. + + It includes the name of the event and description to be seen and used by end users. + isPreview: true + name: IDynamicDataEventDefinition + fullName: sp-dynamic-data.IDynamicDataEventDefinition + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataEventDefinition.description + - sp-dynamic-data.IDynamicDataEventDefinition.name + - uid: sp-dynamic-data.IDynamicDataEventDefinition.description + summary: 'User-friendly, localized description of the event.' + isPreview: true + name: description + fullName: sp-dynamic-data.IDynamicDataEventDefinition.description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataEventDefinition.name + summary: Event name + isPreview: true + name: name + fullName: sp-dynamic-data.IDynamicDataEventDefinition.name + langs: + - typeScript + type: property + syntax: + content: 'name: string;' + return: + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index d158accb..10cf311e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -4,7 +4,6 @@ items: summary: >- Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. - isPreview: true name: IDynamicDataPropertyDefinition fullName: sp-dynamic-data.IDynamicDataPropertyDefinition langs: @@ -16,9 +15,9 @@ items: children: - sp-dynamic-data.IDynamicDataPropertyDefinition.id - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.id - summary: 'Id of the property. This can only contains letters, numbers, dashes and underscores.' - remarks: 'The regular expression used to validate the constraints is /^\[a-zA-Z0-9\\-\_\]+$/ Example: "myFiles"' - isPreview: true + summary: >- + Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or + "time\_in\_24-hour\_clock" name: id fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.id langs: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index 16f017aa..dfff4298 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -2,7 +2,6 @@ items: - uid: sp-dynamic-data.IDynamicDataPropertyMetadata summary: Metadata of a property - isPreview: true name: IDynamicDataPropertyMetadata fullName: sp-dynamic-data.IDynamicDataPropertyMetadata langs: @@ -16,7 +15,6 @@ items: summary: >- User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" - isPreview: true name: description fullName: sp-dynamic-data.IDynamicDataPropertyMetadata.description langs: @@ -31,7 +29,6 @@ items: summary: >- User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) - isPreview: true name: title fullName: sp-dynamic-data.IDynamicDataPropertyMetadata.title langs: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml new file mode 100644 index 00000000..9f8eb2a9 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -0,0 +1,26 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + summary: Metadata describing the sample value of the property. + name: IDynamicDataPropertyValueMetadata + fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadata + langs: + - typeScript + type: interface + extends: + - IDynamicDataPropertyMetadata + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata + - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata + summary: Metadata describing the sample value of the property. + name: metadata + fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata + langs: + - typeScript + type: property + syntax: + content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' + return: + type: + - IDynamicDataPropertyValueMetadataCollection diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml new file mode 100644 index 00000000..e6fe6acd --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -0,0 +1,102 @@ +### YamlMime:UniversalReference +items: + - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + summary: >- + A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the + metadata describing the 'key' and its value. + remarks: >- + Important note: + + + 1. Key in the metadata should match the key in the sample value object. + + + 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below + example for more details. + + + For example: + + ``` + + case 1: With simple values + Sample Property Id value - { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + } + + MetadataCollection for the above object would be - + metadataCollection: { + 'firstName': { title: 'First Name' }, + 'lastName': { title: 'Last Name' }, + 'age': { title: 'Age' } + } + + Case 2: With complex values + Sample Property Id value - { + person: { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + }, + visitedLocations: [ + { + city: 'Redmond', + state: 'WA' + }, + { + city: 'New York City', + state: 'NY' + } + ] + } + + MetadataCollection for the above object would be - + metadataCollection: { + 'person': { + title: 'Person', + metadataCollection: { + 'firstName': { title: 'First Name' }, + 'lastName': { title: 'Last Name' }, + 'age': { title: 'Age' } + } + }, + 'vistedLocations': { + title: 'Visted Locations', + metadataCollection: { + 'city': { title: 'City' }, + 'state': { title: 'State' } + } + } + } + + ``` + name: IDynamicDataPropertyValueMetadataCollection + fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + langs: + - typeScript + type: interface + package: sp-dynamic-data + children: + - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection.__index + - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection.__index + summary: >- + Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata + describing the 'key' and its value. + name: __index(key) + fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection.__index + langs: + - typeScript + type: method + syntax: + content: '[key: string]: IDynamicDataPropertyValueMetadata;' + return: + type: + - IDynamicDataPropertyValueMetadata + description: '' + parameters: + - id: key + description: '' + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index bb82a5c9..204c9ae8 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -4,7 +4,6 @@ items: summary: >- Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. - isPreview: true name: IDynamicDataSource fullName: sp-dynamic-data.IDynamicDataSource langs: @@ -12,15 +11,56 @@ items: type: interface package: sp-dynamic-data children: + - sp-dynamic-data.IDynamicDataSource.allowedEvents + - sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue - sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions - sp-dynamic-data.IDynamicDataSource.getPropertyValue - sp-dynamic-data.IDynamicDataSource.id - sp-dynamic-data.IDynamicDataSource.metadata + - sp-dynamic-data.IDynamicDataSource.sendEvent + - uid: sp-dynamic-data.IDynamicDataSource.allowedEvents + summary: >- + Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source + must define 'sendData' api. + + + If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. + isPreview: true + name: allowedEvents() + fullName: sp-dynamic-data.IDynamicDataSource.allowedEvents + langs: + - typeScript + type: method + syntax: + content: 'allowedEvents?(): ReadonlyArray;' + return: + type: + - ReadonlyArray + description: '' + - uid: sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue + summary: >- + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. + name: getAnnotatedPropertyValue(propertyId) + fullName: sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue + langs: + - typeScript + type: method + syntax: + content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' + return: + type: + - IDynamicDataAnnotatedPropertyValue + description: '' + parameters: + - id: propertyId + description: One of the property ids exposed from the dynamic data source. + type: + - string - uid: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions summary: >- Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. - isPreview: true name: getPropertyDefinitions() fullName: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions langs: @@ -36,7 +76,6 @@ items: summary: >- Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. - isPreview: true name: getPropertyValue(propertyId) fullName: sp-dynamic-data.IDynamicDataSource.getPropertyValue langs: @@ -55,7 +94,6 @@ items: - string - uid: sp-dynamic-data.IDynamicDataSource.id summary: Id of the Dynamic Data Source. - isPreview: true name: id fullName: sp-dynamic-data.IDynamicDataSource.id langs: @@ -68,7 +106,6 @@ items: - string - uid: sp-dynamic-data.IDynamicDataSource.metadata summary: Metadata of the Dynamic Data Source. - isPreview: true name: metadata fullName: sp-dynamic-data.IDynamicDataSource.metadata langs: @@ -79,3 +116,31 @@ items: return: type: - IDynamicDataSourceMetadata + - uid: sp-dynamic-data.IDynamicDataSource.sendEvent + summary: >- + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. + + + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + isPreview: true + name: 'sendEvent(eventName, data)' + fullName: sp-dynamic-data.IDynamicDataSource.sendEvent + langs: + - typeScript + type: method + syntax: + content: 'sendEvent?(eventName: string, data: any): void;' + return: + type: + - void + description: '' + parameters: + - id: eventName + description: A case-sensitive string representing the name of the event. + type: + - string + - id: data + description: Data to be sent to the dynamic data source. + type: + - any diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 3daa0d10..97206d20 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -2,7 +2,6 @@ items: - uid: sp-dynamic-data.IDynamicDataSourceMetadata summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. - isPreview: true name: IDynamicDataSourceMetadata fullName: sp-dynamic-data.IDynamicDataSourceMetadata langs: @@ -19,7 +18,6 @@ items: summary: >- Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - isPreview: true name: alias fullName: sp-dynamic-data.IDynamicDataSourceMetadata.alias langs: @@ -34,7 +32,6 @@ items: summary: >- Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - isPreview: true name: componentId fullName: sp-dynamic-data.IDynamicDataSourceMetadata.componentId langs: @@ -47,7 +44,6 @@ items: - string - uid: sp-dynamic-data.IDynamicDataSourceMetadata.description summary: 'User-friendly, localized description of the Dynamic Data Source.' - isPreview: true name: description fullName: sp-dynamic-data.IDynamicDataSourceMetadata.description langs: @@ -63,7 +59,6 @@ items: Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - isPreview: true name: instanceId fullName: sp-dynamic-data.IDynamicDataSourceMetadata.instanceId langs: @@ -78,7 +73,6 @@ items: summary: >- User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. - isPreview: true name: title fullName: sp-dynamic-data.IDynamicDataSourceMetadata.title langs: diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 95acca79..bc717903 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -8,8 +8,8 @@ items: and expires after a server configurable amount of time. - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + For more information, see the MSDN article [ "Complete basic operations using SharePoint 2013 REST endpoints" + ](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) name: DigestCache fullName: sp-http.DigestCache langs: diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 1b993e66..61b09fa6 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -32,7 +32,7 @@ items: - sp-http.HttpClientResponse.type - sp-http.HttpClientResponse.url - uid: sp-http.HttpClientResponse.arrayBuffer - summary: 'See documentation for whatwg-fetch:Body.arrayBuffer' + summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: arrayBuffer() fullName: sp-http.HttpClientResponse.arrayBuffer langs: @@ -45,7 +45,7 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.blob - summary: 'See documentation for whatwg-fetch:Body.blob' + summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: blob() fullName: sp-http.HttpClientResponse.blob langs: @@ -58,7 +58,7 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.bodyUsed - summary: 'See documentation for whatwg-fetch:Body.bodyUsed' + summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: bodyUsed fullName: sp-http.HttpClientResponse.bodyUsed langs: @@ -84,7 +84,7 @@ items: - HttpClientResponse description: '' - uid: sp-http.HttpClientResponse.formData - summary: 'See documentation for whatwg-fetch:Body.formData' + summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: formData() fullName: sp-http.HttpClientResponse.formData langs: @@ -97,7 +97,7 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.headers - summary: 'See documentation for whatwg-fetch:Response.headers' + summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: headers fullName: sp-http.HttpClientResponse.headers langs: @@ -109,7 +109,7 @@ items: type: - Headers - uid: sp-http.HttpClientResponse.json - summary: 'See documentation for whatwg-fetch:Body.json' + summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: json() fullName: sp-http.HttpClientResponse.json langs: @@ -133,7 +133,7 @@ items: type: - Response - uid: sp-http.HttpClientResponse.ok - summary: 'See documentation for whatwg-fetch:Response.ok' + summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: ok fullName: sp-http.HttpClientResponse.ok langs: @@ -145,7 +145,7 @@ items: type: - boolean - uid: sp-http.HttpClientResponse.status - summary: 'See documentation for whatwg-fetch:Response.status' + summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: status fullName: sp-http.HttpClientResponse.status langs: @@ -157,7 +157,7 @@ items: type: - number - uid: sp-http.HttpClientResponse.statusText - summary: 'See documentation for whatwg-fetch:Response.statusText' + summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: statusText fullName: sp-http.HttpClientResponse.statusText langs: @@ -169,7 +169,7 @@ items: type: - string - uid: sp-http.HttpClientResponse.text - summary: 'See documentation for whatwg-fetch:Body.text' + summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: text() fullName: sp-http.HttpClientResponse.text langs: @@ -182,7 +182,7 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.type - summary: 'See documentation for whatwg-fetch:Response.type' + summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: type fullName: sp-http.HttpClientResponse.type langs: @@ -194,7 +194,7 @@ items: type: - ResponseType - uid: sp-http.HttpClientResponse.url - summary: 'See documentation for whatwg-fetch:Response.url' + summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: url fullName: sp-http.HttpClientResponse.url langs: diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 98b6624f..0c67ebeb 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -8,8 +8,8 @@ items: and expires after a server configurable amount of time. - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + For more information, see the MSDN article [ "Complete basic operations using SharePoint 2013 REST endpoints" + ](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) name: IDigestCache fullName: sp-http.IDigestCache langs: diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index c65720b1..bed988e1 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -61,8 +61,11 @@ items: The parameters for this function are basically the same as the WHATWG API standard documented here: - [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/)However, be aware that certain REST - headers are ignored or not allowed inside a batch. See the ODATA documentation for details. + [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/) + + + However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation + for details. When execute() is called, it will POST to a URL such as "http://example.com/sites/sample/\_api/$batch". Typically diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index 6fb90282..18bb046b 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -29,7 +29,7 @@ items: type: - ListViewAccessor - uid: sp-listview-extensibility.ListViewCommandSetContext.manifest - summary: Manifest for the client side component. + summary: Manifest for the client-side component. name: manifest fullName: sp-listview-extensibility.ListViewCommandSetContext.manifest langs: diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index 77af5753..30f1bb13 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -13,7 +13,7 @@ items: children: - sp-odata-types.IODataChangeToken.StringValue - uid: sp-odata-types.IODataChangeToken.StringValue - summary: 'Example: { StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }' + summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' name: StringValue fullName: sp-odata-types.IODataChangeToken.StringValue langs: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 6e002eab..287dad03 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -16,7 +16,7 @@ items: - sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions - sp-odata-types.IODataContextWebInformation.WebFullUrl - uid: sp-odata-types.IODataContextWebInformation.LibraryVersion - summary: 'Example: "16.0.4919.3000"' + summary: 'Example: `"16.0.4919.3000"`' name: LibraryVersion fullName: sp-odata-types.IODataContextWebInformation.LibraryVersion langs: @@ -28,7 +28,7 @@ items: type: - string - uid: sp-odata-types.IODataContextWebInformation.SiteFullUrl - summary: 'Example: "http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite"' + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: SiteFullUrl fullName: sp-odata-types.IODataContextWebInformation.SiteFullUrl langs: @@ -40,7 +40,7 @@ items: type: - string - uid: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions - summary: 'Example: \[ "14.0.0.0", "15.0.0.0" \]' + summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' name: SupportedSchemaVersions fullName: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions langs: @@ -52,7 +52,7 @@ items: type: - 'string[]' - uid: sp-odata-types.IODataContextWebInformation.WebFullUrl - summary: 'Example: "http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite"' + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: WebFullUrl fullName: sp-odata-types.IODataContextWebInformation.WebFullUrl langs: diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 19027da6..b7b88aa5 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -3,7 +3,7 @@ items: - uid: sp-odata-types.IODataList summary: >- Represents an OData SP.List object. For more information about this object see the MSDN documentation here: - https://msdn.microsoft.com/en-us/library/office/jj860569.aspx + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataList fullName: sp-odata-types.IODataList langs: @@ -37,7 +37,7 @@ items: type: - number - uid: sp-odata-types.IODataList.Created - summary: 'Example: "/Date(1453294804000)/"' + summary: 'Example: `"/Date(1453294804000)/"`' name: Created fullName: sp-odata-types.IODataList.Created langs: @@ -73,7 +73,7 @@ items: type: - string - uid: sp-odata-types.IODataList.EntityTypeName - summary: 'Example: "MyListTitleList"' + summary: 'Example: `"MyListTitleList"`' name: EntityTypeName fullName: sp-odata-types.IODataList.EntityTypeName langs: @@ -99,7 +99,7 @@ items: type: - boolean - uid: sp-odata-types.IODataList.Id - summary: 'Example: "/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"' + summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' name: Id fullName: sp-odata-types.IODataList.Id langs: @@ -111,7 +111,7 @@ items: type: - string - uid: sp-odata-types.IODataList.LastItemDeletedDate - summary: 'Example: "/Date(1453294809000)/"' + summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemDeletedDate fullName: sp-odata-types.IODataList.LastItemDeletedDate langs: @@ -123,7 +123,7 @@ items: type: - string - uid: sp-odata-types.IODataList.LastItemModifiedDate - summary: 'Example: "/Date(1453294809000)/"' + summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemModifiedDate fullName: sp-odata-types.IODataList.LastItemModifiedDate langs: @@ -135,7 +135,7 @@ items: type: - string - uid: sp-odata-types.IODataList.ListItemEntityTypeFullName - summary: 'Example: "SP.Data.MyListTitleListItem"' + summary: 'Example: `"SP.Data.MyListTitleListItem"`' name: ListItemEntityTypeFullName fullName: sp-odata-types.IODataList.ListItemEntityTypeFullName langs: @@ -147,7 +147,7 @@ items: type: - string - uid: sp-odata-types.IODataList.ParentWebUrl - summary: 'Example: "/sites/PubSite"' + summary: 'Example: `"/sites/PubSite"`' name: ParentWebUrl fullName: sp-odata-types.IODataList.ParentWebUrl langs: @@ -159,7 +159,7 @@ items: type: - string - uid: sp-odata-types.IODataList.TemplateFeatureId - summary: 'Example: "/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"' + summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' name: TemplateFeatureId fullName: sp-odata-types.IODataList.TemplateFeatureId langs: @@ -171,7 +171,7 @@ items: type: - string - uid: sp-odata-types.IODataList.Title - summary: 'Example: "Pages"' + summary: 'Example: `"Pages"`' name: Title fullName: sp-odata-types.IODataList.Title langs: diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 5432f925..ac40614b 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -3,7 +3,7 @@ items: - uid: sp-odata-types.IODataListItem summary: >- Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: - https://msdn.microsoft.com/en-us/library/office/jj860569.aspx + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataListItem fullName: sp-odata-types.IODataListItem langs: @@ -16,7 +16,7 @@ items: - sp-odata-types.IODataListItem.Title - sp-odata-types.IODataListItem.UniqueId - uid: sp-odata-types.IODataListItem.ContentTypeId - summary: 'Example: { StringValue: "0x010100C5..." }' + summary: 'Example: `{ StringValue: "0x010100C5..." }`' name: ContentTypeId fullName: sp-odata-types.IODataListItem.ContentTypeId langs: @@ -54,7 +54,7 @@ items: type: - string - uid: sp-odata-types.IODataListItem.UniqueId - summary: 'Example: "/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"' + summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' name: UniqueId fullName: sp-odata-types.IODataListItem.UniqueId langs: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 47708890..d8959057 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -1,7 +1,9 @@ ### YamlMime:UniversalReference items: - uid: sp-odata-types.IODataNavigationNode - summary: 'Represents an OData SP.NavigationNode object. https://msdn.microsoft.com/en-us/library/office/jj246311.aspx' + summary: >- + Represents an OData SP.NavigationNode object. + [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) name: IODataNavigationNode fullName: sp-odata-types.IODataNavigationNode langs: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index f44f0c2c..4784ccb7 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -3,7 +3,7 @@ items: - uid: sp-odata-types.IODataNavigationNodeCollection summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. - https://msdn.microsoft.com/en-us/library/office/ee557907.aspx + [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) name: IODataNavigationNodeCollection fullName: sp-odata-types.IODataNavigationNodeCollection langs: diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index 15fc641e..ef5d357f 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -3,7 +3,7 @@ items: - uid: sp-odata-types.IODataUser summary: >- Represents an OData SP.User object. For more information about this object see the MSDN documentation here: - https://msdn.microsoft.com/en-us/library/office/jj860569.aspx + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataUser fullName: sp-odata-types.IODataUser langs: @@ -19,7 +19,7 @@ items: - sp-odata-types.IODataUser.Title - sp-odata-types.IODataUser.UserId - uid: sp-odata-types.IODataUser.Email - summary: 'Example: "someone@example.com"' + summary: 'Example: `"someone@example.com"`' name: Email fullName: sp-odata-types.IODataUser.Email langs: @@ -54,7 +54,7 @@ items: type: - boolean - uid: sp-odata-types.IODataUser.LoginName - summary: 'Example: "i:0\#.w\|domain\\user"' + summary: 'Example: `"i:0#.w|domain\user"`' name: LoginName fullName: sp-odata-types.IODataUser.LoginName langs: @@ -92,7 +92,7 @@ items: type: - number - uid: sp-odata-types.IODataUser.Title - summary: 'Example: "DOMAIN\\user"' + summary: 'Example: `"DOMAIN\user"`' name: Title fullName: sp-odata-types.IODataUser.Title langs: diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index 6a5bb538..ea0d341a 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -3,7 +3,8 @@ items: - uid: sp-odata-types.IODataUserCustomAction summary: >- Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation - here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction + here: + [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) name: IODataUserCustomAction fullName: sp-odata-types.IODataUserCustomAction langs: @@ -31,7 +32,7 @@ items: - sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction - uid: sp-odata-types.IODataUserCustomAction.ClientSideComponentId summary: The unique identifier of the client-side component defined with SharePoint Framework - remarks: 'Example: "359af2a7-b73c-4aac-874c-60a865da0be7"' + remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' name: ClientSideComponentId fullName: sp-odata-types.IODataUserCustomAction.ClientSideComponentId langs: @@ -50,7 +51,7 @@ items: client-side component. - Example: "{ \\"maxItemsToShow\\": 123 }" + Example: `"{ \"maxItemsToShow\": 123 }"` name: ClientSideComponentProperties fullName: sp-odata-types.IODataUserCustomAction.ClientSideComponentProperties langs: @@ -104,7 +105,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.Id summary: >- Gets a value that specifies the identifier (GUID) of the custom action. Example: - "48309f28-53aa-43ed-b113-625120e5af6f" + `"48309f28-53aa-43ed-b113-625120e5af6f"` name: Id fullName: sp-odata-types.IODataUserCustomAction.Id langs: @@ -129,7 +130,7 @@ items: - string - uid: sp-odata-types.IODataUserCustomAction.Location summary: Gets or sets the location of the custom action. - remarks: 'Example: "ClientSide.Application"' + remarks: 'Example: `"ClientSide.Application"`' name: Location fullName: sp-odata-types.IODataUserCustomAction.Location langs: @@ -255,7 +256,7 @@ items: - string - uid: sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction summary: Gets a value that specifies an implementation specific version identifier. - remarks: 'Example: "16.0.1.0"' + remarks: 'Example: `"16.0.1.0"`' name: VersionOfUserCustomAction fullName: sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction langs: diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 8b5a873b..864bccb6 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -3,7 +3,7 @@ items: - uid: sp-odata-types.IODataWeb summary: >- Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: - https://msdn.microsoft.com/en-us/library/office/jj860569.aspx + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataWeb fullName: sp-odata-types.IODataWeb langs: @@ -30,7 +30,10 @@ items: - sp-odata-types.IODataWeb.Url - sp-odata-types.IODataWeb.WebTemplate - uid: sp-odata-types.IODataWeb.Created - summary: 'Gets a value that specifies when the site was created. Example: "/Date(2016,0,20,12,58,7,0)/"' + summary: |- + Gets a value that specifies when the site was created. + + Example: `"/Date(2016,0,20,12,58,7,0)/"` name: Created fullName: sp-odata-types.IODataWeb.Created langs: @@ -54,9 +57,10 @@ items: type: - IODataChangeToken - uid: sp-odata-types.IODataWeb.CustomMasterUrl - summary: >- - Gets or sets the URL for a custom master page file to apply to the website. Example: - "/sites/PubSite/\_catalogs/masterpage/seattle.master" + summary: |- + Gets or sets the URL for a custom master page file to apply to the website. + + Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` name: CustomMasterUrl fullName: sp-odata-types.IODataWeb.CustomMasterUrl langs: @@ -80,9 +84,10 @@ items: type: - string - uid: sp-odata-types.IODataWeb.Id - summary: >- - Gets a value that specifies the site identifier for the site. Example: - "/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/" + summary: |- + Gets a value that specifies the site identifier for the site. + + Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` name: Id fullName: sp-odata-types.IODataWeb.Id langs: @@ -106,7 +111,10 @@ items: type: - boolean - uid: sp-odata-types.IODataWeb.Language - summary: 'Gets a value that specifies the LCID for the language that is used on the site. Example: 1033' + summary: |- + Gets a value that specifies the LCID for the language that is used on the site. + + Example: `1033` name: Language fullName: sp-odata-types.IODataWeb.Language langs: @@ -118,7 +126,10 @@ items: type: - number - uid: sp-odata-types.IODataWeb.LastItemModifiedDate - summary: 'Gets a value that specifies when an item was last modified in the site. Example: "/Date(1453618828000)/"' + summary: |- + Gets a value that specifies when an item was last modified in the site. + + Example: `"/Date(1453618828000)/"` name: LastItemModifiedDate fullName: sp-odata-types.IODataWeb.LastItemModifiedDate langs: @@ -130,9 +141,10 @@ items: type: - string - uid: sp-odata-types.IODataWeb.MasterUrl - summary: >- - Gets or sets the URL of the master page that is used for the website. Example: - "/sites/PubSite/\_catalogs/masterpage/seattle.master" + summary: |- + Gets or sets the URL of the master page that is used for the website. + + Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` name: MasterUrl fullName: sp-odata-types.IODataWeb.MasterUrl langs: @@ -180,7 +192,10 @@ items: type: - boolean - uid: sp-odata-types.IODataWeb.ServerRelativeUrl - summary: 'Gets or sets the server-relative URL for the Web site. Example: "/sites/PubSite"' + summary: |- + Gets or sets the server-relative URL for the Web site. + + Example: `"/sites/PubSite"` name: ServerRelativeUrl fullName: sp-odata-types.IODataWeb.ServerRelativeUrl langs: @@ -216,7 +231,10 @@ items: type: - string - uid: sp-odata-types.IODataWeb.UIVersion - summary: 'Gets or sets the user interface (UI) version of the Web site. Example: 15' + summary: |- + Gets or sets the user interface (UI) version of the Web site. + + Example: `15` name: UIVersion fullName: sp-odata-types.IODataWeb.UIVersion langs: @@ -228,7 +246,10 @@ items: type: - number - uid: sp-odata-types.IODataWeb.Url - summary: 'Gets the absolute URL for the website. Example: "http://example.com/sites/PubSite"' + summary: |- + Gets the absolute URL for the website. + + Example: `"http://example.com/sites/PubSite"` name: Url fullName: sp-odata-types.IODataWeb.Url langs: @@ -240,7 +261,10 @@ items: type: - string - uid: sp-odata-types.IODataWeb.WebTemplate - summary: 'Gets the name of the site definition or site template that was used to create the site. Example: "BLANKINTERNET"' + summary: |- + Gets the name of the site definition or site template that was used to create the site. + + Example: `"BLANKINTERNET"` name: WebTemplate fullName: sp-odata-types.IODataWeb.WebTemplate langs: diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 7bee5ff3..8af017ee 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -2,7 +2,7 @@ items: - uid: sp-page-context.CultureInfo summary: >- - This class is primarily used with the PageContext class. It provides culture info for the current user of the + This class is primarily used with the `PageContext` class. It provides culture info for the current user of the application. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -25,8 +25,8 @@ items: This property may be an empty string, but it will never be undefined. - Example: If the currentCultureName is "en-AU" then the application could use this information to display the date - as 1/8 instead of 8/1. + Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the + date as 1/8 instead of 8/1. name: currentCultureName fullName: sp-page-context.CultureInfo.currentCultureName langs: @@ -43,8 +43,8 @@ items: This property may have an empty string, but will never be undefined. - Example: If the currentUICultureName is "es-MX", then the application could use this information to translate the - word "hello" to "hola". + Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to + translate the word "hello" to "hola". name: currentUICultureName fullName: sp-page-context.CultureInfo.currentUICultureName langs: diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index 69ebfba2..74b701f4 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -1,7 +1,7 @@ ### YamlMime:UniversalReference items: - uid: sp-page-context.ISPSystemTime - summary: Interface that represents a SPSystemTime structure. + summary: Interface that represents a `SPSystemTime` structure. isPreview: true name: ISPSystemTime fullName: sp-page-context.ISPSystemTime diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 5b91ed3c..3eec6c3a 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -1,7 +1,7 @@ ### YamlMime:UniversalReference items: - uid: sp-page-context.ISPTimeZoneData - summary: Interface that represents the data neccesary to build an TimeZone object. + summary: Interface that represents the data necessary to build an `TimeZone` object. isPreview: true name: ISPTimeZoneData fullName: sp-page-context.ISPTimeZoneData diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index ac74cd9d..bf0af7b0 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -1,7 +1,8 @@ ### YamlMime:UniversalReference items: - uid: sp-page-context.PageContext - summary: >- + summary: The SharePoint page context object. + remarks: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application @@ -55,7 +56,7 @@ items: - uid: sp-page-context.PageContext.cultureInfo summary: >- It provides culture info for the current user of the application. This class is primarily used with the - PageContext class. + `PageContext` class. name: cultureInfo fullName: sp-page-context.PageContext.cultureInfo langs: @@ -67,7 +68,7 @@ items: type: - CultureInfo - uid: sp-page-context.PageContext.isInitialized - summary: Returns whether the PageContext has been initialized. + summary: Returns whether the `PageContext` has been initialized. name: isInitialized fullName: sp-page-context.PageContext.isInitialized langs: @@ -82,15 +83,15 @@ items: summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. remarks: >- This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents - are similar to the \_spPageContextInfo window variable from classic pages. The contents of this variable may + are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees. - NOTE: If certain functionality is exposed in the legacyPageContext but does not seem to have a proper TypeScript + NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the - legacyPageContext object. + `legacyPageContext` object. name: legacyPageContext fullName: sp-page-context.PageContext.legacyPageContext langs: @@ -142,7 +143,7 @@ items: type: - ServiceKey - uid: sp-page-context.PageContext.site - summary: Contextual information for the SharePoint site collection ("site") that is hosting the page. + summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. name: site fullName: sp-page-context.PageContext.site langs: @@ -156,7 +157,7 @@ items: - uid: sp-page-context.PageContext.user summary: >- It provides contextual information for the SharePoint user that is accessing the page. This class is primarily - used with the PageContext class. + used with the `PageContext` class. name: user fullName: sp-page-context.PageContext.user langs: @@ -168,7 +169,7 @@ items: type: - SPUser - uid: sp-page-context.PageContext.web - summary: Contextual information for the SharePoint site ("web") that is hosting the page. + summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. name: web fullName: sp-page-context.PageContext.web langs: diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 2ad6ca8b..e0bf7623 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -1,12 +1,14 @@ ### YamlMime:UniversalReference items: - uid: sp-page-context.SPField - summary: >- - The client-side equivalent for SharePoint SPField class. Used in Fields property of SPList and SPListItem classes. - A field represents the data model for a column in SharePoint list view. + summary: A field represents the data model for a column in SharePoint list view. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPField class. + + + This is the client-side equivalent for SharePoint `SPField` class. It is used with the + `@microsoft/sp-listview-extensibility` package. name: SPField fullName: sp-page-context.SPField langs: @@ -34,10 +36,10 @@ items: type: - Guid | undefined - uid: sp-page-context.SPField.clientSideComponentProperties - summary: >- - This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string - must contain a JSON object with custom initialization properties whose format and meaning are defined by the - client-side component. + summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. + remarks: >- + If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning + are defined by the client-side component. name: clientSideComponentProperties fullName: sp-page-context.SPField.clientSideComponentProperties langs: diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 334810c1..4e19f363 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -2,7 +2,7 @@ items: - uid: sp-page-context.SPList summary: >- - This class is primarily used with the PageContext class. It provides contextual information for the SharePoint + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -47,7 +47,7 @@ items: type: - SPPermission - uid: sp-page-context.SPList.serverRelativeUrl - summary: Returns the server-relative URL for this SPList. + summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' name: serverRelativeUrl fullName: sp-page-context.SPList.serverRelativeUrl @@ -60,7 +60,7 @@ items: type: - string - uid: sp-page-context.SPList.title - summary: Returns the title for this SPList. + summary: Returns the title for this `SPList`. name: title fullName: sp-page-context.SPList.title langs: diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index f1f8d8f4..943a2a30 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -2,7 +2,7 @@ items: - uid: sp-page-context.SPListItem summary: >- - This class is primarily used with the PageContext class. It provides contextual information for the SharePoint + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list item that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -16,7 +16,7 @@ items: children: - sp-page-context.SPListItem.id - uid: sp-page-context.SPListItem.id - summary: The number that identifies the SPListItem on the server. + summary: The number that identifies the `SPListItem` on the server. name: id fullName: sp-page-context.SPListItem.id langs: diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index ef98d4c0..f75bf04d 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -2,10 +2,12 @@ items: - uid: sp-page-context.SPPermission summary: Used to test whether the current user has a requested set of permissions. - remarks: |- + remarks: >- Specifies the built-in permissions available in SharePoint Foundation - For more information, see: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx + + For more information, see: + [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) name: SPPermission fullName: sp-page-context.SPPermission langs: diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index b4d095fb..6c20bae0 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -2,8 +2,8 @@ items: - uid: sp-page-context.SPSite summary: >- - This class is primarily used with the PageContext class. It provides contextual information for the SharePoint - site collection ("site") that hosts the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + site collection ("SPSite") that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPSite class. diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 6ac24759..7e75a77d 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -4,14 +4,21 @@ items: summary: >- It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula. - - - isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate LocalTime = UTCTime - - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) June 11, 2 A.M. PST = June 11, 9 A.M. - (480 - minutes) - (-60 minutes) remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPTimeZone class. + + + ``` + + isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate + + LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) + + June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) + + + ``` isPreview: true name: SPTimeZone fullName: sp-page-context.SPTimeZone diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 9d46f2b4..f9902c5a 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -2,7 +2,7 @@ items: - uid: sp-page-context.SPUser summary: >- - This class is primarily used with the PageContext class. It provides contextual information for the SharePoint + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user that is accessing the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -24,7 +24,7 @@ items: - sp-page-context.SPUser.timeZoneInfo - uid: sp-page-context.SPUser.displayName summary: The display name for the current user. - remarks: 'Example: "John Doe"' + remarks: 'Example: `"John Doe"`' name: displayName fullName: sp-page-context.SPUser.displayName langs: @@ -37,7 +37,7 @@ items: - string - uid: sp-page-context.SPUser.email summary: The email address for the current user. - remarks: 'Example: "example@contoso.com"' + remarks: 'Example: `"example@contoso.com"`' name: email fullName: sp-page-context.SPUser.email langs: @@ -87,7 +87,7 @@ items: - boolean - uid: sp-page-context.SPUser.loginName summary: The login name for current user. - remarks: 'Example: on-premise user: "domain\\user", online user: "user@domain.com"' + remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' name: loginName fullName: sp-page-context.SPUser.loginName langs: diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 30cdf7db..368c78e0 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -2,8 +2,8 @@ items: - uid: sp-page-context.SPWeb summary: >- - This class is primarily used with the PageContext class. It provides contextual information for the SharePoint - site ("web") that hosts the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + site ("SPWeb") that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPWeb class. @@ -27,7 +27,7 @@ items: - sp-page-context.SPWeb.timeZoneInfo - sp-page-context.SPWeb.title - uid: sp-page-context.SPWeb.absoluteUrl - summary: 'Returns the absolute URL for this SPWeb. Example: "https://example.com/sites/PubSite/SubWeb"' + summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' name: absoluteUrl fullName: sp-page-context.SPWeb.absoluteUrl langs: @@ -76,7 +76,7 @@ items: type: - Guid - uid: sp-page-context.SPWeb.isAppWeb - summary: Returns true if this SPWeb the container web for an SPApp. + summary: Returns true if this `SPWeb` the container web for an `SPApp`. name: isAppWeb fullName: sp-page-context.SPWeb.isAppWeb langs: @@ -102,7 +102,7 @@ items: - number - uid: sp-page-context.SPWeb.logoUrl summary: Returns the absolute URL of the website logo. - remarks: 'Example: https://example.com/sites/PubSite/SubWeb/logo.jpg' + remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' name: logoUrl fullName: sp-page-context.SPWeb.logoUrl langs: @@ -129,7 +129,7 @@ items: - SPPermission - uid: sp-page-context.SPWeb.serverRelativeUrl summary: Returns the server-relative URL for this SPWeb. - remarks: 'Example: "/sites/PubSite/SubWeb"' + remarks: 'Example: `"/sites/PubSite/SubWeb"`' name: serverRelativeUrl fullName: sp-page-context.SPWeb.serverRelativeUrl langs: @@ -144,7 +144,7 @@ items: summary: >- Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. - remarks: 'Example: "1" represents the team site template when creating a new site on SharePoint.' + remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' name: templateName fullName: sp-page-context.SPWeb.templateName langs: diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml deleted file mode 100644 index a0e8c669..00000000 --- a/SP-Framework/sp-property-pane.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:UniversalReference -items: - - uid: sp-property-pane - summary: SharePoint Framework property pane. - remarks: 'Helps create the property pane for the SharePoint components such as web parts, canvas etc.,' - name: '@microsoft/sp-property-pane' - fullName: sp-property-pane - langs: - - typeScript - type: package diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index a26b1ec4..d2e57548 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -15,7 +15,12 @@ items: - sp-webpart-base.BaseClientSideWebPart - sp-webpart-base.BaseWebPart - sp-webpart-base.BaseWebPartContext + - sp-webpart-base.DynamicDataSharedDepth - sp-webpart-base.IClientSideWebPartStatusRenderer + - sp-webpart-base.IDynamicDataSharedPropertyConfiguration + - sp-webpart-base.IDynamicDataSharedPropertyFilters + - sp-webpart-base.IDynamicDataSharedSourceConfiguration + - sp-webpart-base.IDynamicDataSharedSourceFilters - sp-webpart-base.IPlaceholderSpinnerProps - sp-webpart-base.IPropertyPaneAccessor - sp-webpart-base.IPropertyPaneButtonProps @@ -23,11 +28,14 @@ items: - sp-webpart-base.IPropertyPaneChoiceGroupOption - sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps - sp-webpart-base.IPropertyPaneChoiceGroupProps + - sp-webpart-base.IPropertyPaneConditionalGroup - sp-webpart-base.IPropertyPaneConfiguration - sp-webpart-base.IPropertyPaneCustomFieldProps - sp-webpart-base.IPropertyPaneDropdownCalloutProps - sp-webpart-base.IPropertyPaneDropdownOption - sp-webpart-base.IPropertyPaneDropdownProps + - sp-webpart-base.IPropertyPaneDynamicFieldProps + - sp-webpart-base.IPropertyPaneDynamicFieldSetProps - sp-webpart-base.IPropertyPaneDynamicTextFieldProps - sp-webpart-base.IPropertyPaneField - sp-webpart-base.IPropertyPaneGroup @@ -51,6 +59,8 @@ items: - sp-webpart-base.PropertyPaneCustomField - sp-webpart-base.PropertyPaneDropdown - sp-webpart-base.PropertyPaneDropdownOptionType + - sp-webpart-base.PropertyPaneDynamicField + - sp-webpart-base.PropertyPaneDynamicFieldSet - sp-webpart-base.PropertyPaneDynamicTextField - sp-webpart-base.PropertyPaneFieldType - sp-webpart-base.PropertyPaneHorizontalRule @@ -60,6 +70,7 @@ items: - sp-webpart-base.PropertyPaneTextField - sp-webpart-base.PropertyPaneToggle - sp-webpart-base.WebPartContext + - sp-webpart-base.WebPartFormFactor - uid: sp-webpart-base.PropertyPaneButton summary: Helper method to create a Button on the PropertyPane. name: 'PropertyPaneButton(targetProperty, properties)' @@ -182,8 +193,62 @@ items: description: Strongly typed Dropdown properties. type: - IPropertyPaneDropdownProps + - uid: sp-webpart-base.PropertyPaneDynamicField + summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. + name: 'PropertyPaneDynamicField(targetProperty, properties)' + fullName: sp-webpart-base.PropertyPaneDynamicField + langs: + - typeScript + type: function + syntax: + content: >- + export function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): + IPropertyPaneField; + return: + type: + - IPropertyPaneField + description: '' + parameters: + - id: targetProperty + description: Target property the Dynamic Data widget is associated to. + type: + - string + - id: properties + description: '' + type: + - IPropertyPaneDynamicFieldProps + - uid: sp-webpart-base.PropertyPaneDynamicFieldSet + summary: >- + Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data + source. + + + These fields can possibly share the same property based on the associated filters. + name: PropertyPaneDynamicFieldSet(properties) + fullName: sp-webpart-base.PropertyPaneDynamicFieldSet + langs: + - typeScript + type: function + syntax: + content: >- + export function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): + IPropertyPaneField; + return: + type: + - IPropertyPaneField + description: '' + parameters: + - id: properties + description: >- + Contains entries and options, described as below: entries - A set of entries to be configured by the widget. + Each entry includes the target property and, optionally, the label to show. options - Options enabling + customized values for callback, filters etc., for the given set of dynamic fields. + type: + - IPropertyPaneDynamicFieldSetProps - uid: sp-webpart-base.PropertyPaneDynamicTextField summary: Helper method to create a Dynamic TextField on the PropertyPane. + deprecated: + content: '- This has been replaced by PropertyPaneDynamicField' isPreview: true name: 'PropertyPaneDynamicTextField(targetProperty, properties)' fullName: sp-webpart-base.PropertyPaneDynamicTextField @@ -347,8 +412,18 @@ references: name: BaseWebPart - uid: sp-webpart-base.BaseWebPartContext name: BaseWebPartContext + - uid: sp-webpart-base.DynamicDataSharedDepth + name: DynamicDataSharedDepth - uid: sp-webpart-base.IClientSideWebPartStatusRenderer name: IClientSideWebPartStatusRenderer + - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + name: IDynamicDataSharedPropertyConfiguration + - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + name: IDynamicDataSharedPropertyFilters + - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + name: IDynamicDataSharedSourceConfiguration + - uid: sp-webpart-base.IDynamicDataSharedSourceFilters + name: IDynamicDataSharedSourceFilters - uid: sp-webpart-base.IPlaceholderSpinnerProps name: IPlaceholderSpinnerProps - uid: sp-webpart-base.IPropertyPaneAccessor @@ -363,6 +438,8 @@ references: name: IPropertyPaneChoiceGroupOptionIconProps - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps name: IPropertyPaneChoiceGroupProps + - uid: sp-webpart-base.IPropertyPaneConditionalGroup + name: IPropertyPaneConditionalGroup - uid: sp-webpart-base.IPropertyPaneConfiguration name: IPropertyPaneConfiguration - uid: sp-webpart-base.IPropertyPaneCustomFieldProps @@ -373,6 +450,10 @@ references: name: IPropertyPaneDropdownOption - uid: sp-webpart-base.IPropertyPaneDropdownProps name: IPropertyPaneDropdownProps + - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + name: IPropertyPaneDynamicFieldProps + - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + name: IPropertyPaneDynamicFieldSetProps - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps name: IPropertyPaneDynamicTextFieldProps - uid: sp-webpart-base.IPropertyPaneField @@ -413,3 +494,5 @@ references: name: PropertyPaneFieldType - uid: sp-webpart-base.WebPartContext name: WebPartContext + - uid: sp-webpart-base.WebPartFormFactor + name: WebPartFormFactor diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 99b99219..f92b86a2 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -2,7 +2,7 @@ items: - uid: sp-webpart-base.BaseClientSideWebPart summary: >- - This abstract class implements the the base functionality for a client side web part. Every client side web part + This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs to inherit from this class. remarks: >- Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall @@ -42,13 +42,9 @@ items: - uid: sp-webpart-base.BaseClientSideWebPart.constructor summary: Constructor for the BaseClientSideWebPart class. remarks: >- - If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is - highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of - the web part features like this.context and this.properties are not available to be used before the the onInit - part of the web part loading lifecycle. - - - e.g. constructor() { super(); . . class specific constructor code .. } + It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. + Most of the web part features like this.context and `this.properties` are not available to be used before the the + `onInit()` part of the web part loading lifecycle. name: constructor() fullName: sp-webpart-base.BaseClientSideWebPart.constructor langs: @@ -59,12 +55,15 @@ items: - uid: sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender summary: This property indicates whether a web part can open a popup on initial render. remarks: >- - In some environments the host re-renders the web parts frequently, and therefor, opening popups during render will - cause popups to open repeatedly and hence poor user experience. As an example, the classic SharePoint pages - perform postbacks and hence page re-render on all button clicks. If a web part needs to open a popup on render, it - should use this API before opening the popup. If this API returns false, the web part should not open popup on - initial render. Some web parts that open popups during render are the document embed web part that pops up the - file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. + In some environments the host re-renders the web parts frequently, and therefore opening popups during render will + cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages + perform postbacks causing the page to re-render on all button clicks. + + + If a web part needs to open a popup on render, it should use this API before opening the popup. If this API + returns false, the web part should not open popup on initial render. Some web parts that open popups during render + are the document embed web part that pops up the file picker on initial render, embedded video web part that pops + up the PropertyPane on initial render. name: canOpenPopupOnRender fullName: sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender langs: @@ -119,16 +118,22 @@ items: type: - HTMLElement - uid: sp-webpart-base.BaseClientSideWebPart.isRenderAsync - summary: >- - Indicates whether the web part is rendering in Async mode. Default value is false. If the web part overrides this - field to return true, then it needs to call renderCompleted API after the web part rendering is complete. + summary: Indicates whether the web part is rendering in Async mode. + remarks: >- + If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part + rendering is complete. + + + The default value is false. name: isRenderAsync fullName: sp-webpart-base.BaseClientSideWebPart.isRenderAsync langs: - typeScript type: property syntax: - content: 'protected readonly isRenderAsync: boolean;' + content: |- + /** @virtual */ + protected readonly isRenderAsync: boolean; return: type: - boolean @@ -144,7 +149,9 @@ items: - typeScript type: method syntax: - content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' + content: |- + /** @virtual */ + protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; return: type: - void @@ -167,7 +174,9 @@ items: - typeScript type: method syntax: - content: 'protected onDispose(): void;' + content: |- + /** @virtual */ + protected onDispose(): void; return: type: - void @@ -191,7 +200,7 @@ items: summary: >- This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part - initiates the IFrame rendering in the render() API but the actual rendering is complete only after the iframe + initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. name: renderCompleted() fullName: sp-webpart-base.BaseClientSideWebPart.renderCompleted @@ -222,7 +231,7 @@ items: - uid: sp-webpart-base.BaseClientSideWebPart.renderedOnce summary: >- This property indicates whether the web part has been rendered once or not. After the first time rendering, the - value of this property is always true. Till a full re-render of the web part happens. + value of this property is always true until a full re-render of the web part happens. name: renderedOnce fullName: sp-webpart-base.BaseClientSideWebPart.renderedOnce langs: diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index e09b42de..7d6cc34d 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -2,7 +2,7 @@ items: - uid: sp-webpart-base.BaseWebPart summary: >- - This abstract class implements the UI-agnostic base functionality for a client side web part. The purpose is to + This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. name: BaseWebPart fullName: sp-webpart-base.BaseWebPart @@ -38,15 +38,11 @@ items: - sp-webpart-base.BaseWebPart.propertiesMetadata - sp-webpart-base.BaseWebPart.title - uid: sp-webpart-base.BaseWebPart.constructor - summary: Constructor for the BaseWebPart class. + summary: Constructor for the `BaseWebPart` class. remarks: >- - If a sub class overrides the constructor, it needs to call super() as the first line of its constructor. It is - highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of - the web part features like this.context and this.properties are not available to be used before the the onInit - part of the web part loading lifecycle. - - - e.g. constructor() { super(); . . class specific constructor code .. } + It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. + Most of the web part features like this.context and this.properties are not available to be used before the the + onInit part of the web part loading lifecycle. name: constructor() fullName: sp-webpart-base.BaseWebPart.constructor langs: @@ -112,7 +108,7 @@ items: type: - string - uid: sp-webpart-base.BaseWebPart.disableReactivePropertyChanges - summary: This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive. + summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. remarks: >- The default behavior is Reactive. @@ -179,7 +175,7 @@ items: An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use - onAfterDeserialize to check the dataVersion and fix the property bag. + `onAfterDeserialize` to check the dataVersion and fix the property bag. name: 'onAfterDeserialize(deserializedObject, dataVersion)' fullName: sp-webpart-base.BaseWebPart.onAfterDeserialize langs: @@ -282,7 +278,8 @@ items: - void description: '' - uid: sp-webpart-base.BaseWebPart.onInit - summary: >- + summary: This event method is called when the web part is initialized. + remarks: >- This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. @@ -304,9 +301,9 @@ items: - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. - - When user clicks 'x'(close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + - When user clicks the "X" (close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - When user clciks 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - When the user switches web parts then the current web part gets this event. name: onPropertyPaneConfigurationComplete() @@ -358,8 +355,8 @@ items: - id: propertyPath description: >- JSON path of the property in the property bag. In the case of custom field, if no target property is - provided then a custom value is assigned, which will be in the form of '\_\_CustomField\_<key provided - when the custom field is created>'. + provided then a custom value is assigned, which will be in the form of `__CustomField_`. type: - string - id: oldValue @@ -414,7 +411,9 @@ items: summary: >- This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data. - remarks: See IWebPartPropertiesMetadata for more information about how to define metadata + remarks: >- + See [IWebPartPropertiesMetadata](xref:sp-webpart-base.IWebPartPropertiesMetadata) for more information about how + to define metadata name: propertiesMetadata fullName: sp-webpart-base.BaseWebPart.propertiesMetadata langs: diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 83fc49c9..9a35210f 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -19,11 +19,28 @@ items: - BaseComponentContext package: sp-webpart-base children: + - sp-webpart-base.BaseWebPartContext.formFactor - sp-webpart-base.BaseWebPartContext.manifest - sp-webpart-base.BaseWebPartContext.propertyPane - sp-webpart-base.BaseWebPartContext.webPartTag + - uid: sp-webpart-base.BaseWebPartContext.formFactor + summary: Form factor of the web part. + remarks: >- + Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set + up different margins that when rendering in a canvas. + isPreview: true + name: formFactor + fullName: sp-webpart-base.BaseWebPartContext.formFactor + langs: + - typeScript + type: property + syntax: + content: 'readonly formFactor: WebPartFormFactor;' + return: + type: + - WebPartFormFactor - uid: sp-webpart-base.BaseWebPartContext.manifest - summary: Manifest for the client side component. + summary: Manifest for the client-side component. name: manifest fullName: sp-webpart-base.BaseWebPartContext.manifest langs: diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml new file mode 100644 index 00000000..f6f25a10 --- /dev/null +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -0,0 +1,38 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.DynamicDataSharedDepth + summary: Enum for the possible values of shared depth of the dynamic data reference. + name: DynamicDataSharedDepth + fullName: sp-webpart-base.DynamicDataSharedDepth + langs: + - typeScript + type: enum + package: sp-webpart-base + children: + - sp-webpart-base.DynamicDataSharedDepth.None + - sp-webpart-base.DynamicDataSharedDepth.Property + - sp-webpart-base.DynamicDataSharedDepth.Source + - uid: sp-webpart-base.DynamicDataSharedDepth.None + summary: Indicates that nothing is shared. + name: None + fullName: sp-webpart-base.DynamicDataSharedDepth.None + langs: + - typeScript + type: field + numericValue: '0' + - uid: sp-webpart-base.DynamicDataSharedDepth.Property + summary: Indicates that both the dynamic data source and the property are shared. + name: Property + fullName: sp-webpart-base.DynamicDataSharedDepth.Property + langs: + - typeScript + type: field + numericValue: '2' + - uid: sp-webpart-base.DynamicDataSharedDepth.Source + summary: Indicates that the dynamic data source is shared. + name: Source + fullName: sp-webpart-base.DynamicDataSharedDepth.Source + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml new file mode 100644 index 00000000..c3d14836 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -0,0 +1,24 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + summary: Configuration related to a shared property. + name: IDynamicDataSharedPropertyConfiguration + fullName: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters + - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters + summary: Filters for the shared property. + name: filters + fullName: sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters + langs: + - typeScript + type: property + syntax: + content: 'filters?: IDynamicDataSharedPropertyFilters;' + return: + type: + - IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml new file mode 100644 index 00000000..356f61a4 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -0,0 +1,35 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + summary: Property pane dynamic data property filters. + name: IDynamicDataSharedPropertyFilters + fullName: sp-webpart-base.IDynamicDataSharedPropertyFilters + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IDynamicDataSharedPropertyFilters.propertyId + - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters.propertyId + summary: |- + Property Id + + Usage: Use this filter when the author can only to connect to a specific property from the selected source. + remarks: >- + This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the + dynamic data widget. + + + When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. + Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is + pre-selected, the control will be disabled to ensure that authors can not change it. + name: propertyId + fullName: sp-webpart-base.IDynamicDataSharedPropertyFilters.propertyId + langs: + - typeScript + type: property + syntax: + content: 'propertyId?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml new file mode 100644 index 00000000..930aae2b --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -0,0 +1,40 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + summary: Configuration related to a shared source. + name: IDynamicDataSharedSourceConfiguration + fullName: sp-webpart-base.IDynamicDataSharedSourceConfiguration + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters + - sp-webpart-base.IDynamicDataSharedSourceConfiguration.sourcesLabel + - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters + summary: Filters for the shared source. + name: filters + fullName: sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters + langs: + - typeScript + type: property + syntax: + content: 'filters?: IDynamicDataSharedSourceFilters;' + return: + type: + - IDynamicDataSharedSourceFilters + - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration.sourcesLabel + summary: |- + User-friendly, localized label for the sources dropdown. + + default value - 'Connect to source' + name: sourcesLabel + fullName: sp-webpart-base.IDynamicDataSharedSourceConfiguration.sourcesLabel + langs: + - typeScript + type: property + syntax: + content: 'sourcesLabel?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml new file mode 100644 index 00000000..f04a6b05 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -0,0 +1,65 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IDynamicDataSharedSourceFilters + summary: Property pane dynamic data source filters. + name: IDynamicDataSharedSourceFilters + fullName: sp-webpart-base.IDynamicDataSharedSourceFilters + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IDynamicDataSharedSourceFilters.componentId + - sp-webpart-base.IDynamicDataSharedSourceFilters.sourceId + - uid: sp-webpart-base.IDynamicDataSharedSourceFilters.componentId + summary: |- + Component Id. + + Usage: Use this filter when the author should only be able to connect to a specific type of source. + remarks: >- + This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic + data widget. + + + When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources + matching the given component id. + + + Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only + shows document library web parts on the page which are registered dynamic sources. + name: componentId + fullName: sp-webpart-base.IDynamicDataSharedSourceFilters.componentId + langs: + - typeScript + type: property + syntax: + content: 'componentId?: Guid;' + return: + type: + - Guid + - uid: sp-webpart-base.IDynamicDataSharedSourceFilters.sourceId + summary: |- + Source Id + + Usage: Use this filter, when the author can only to connect to a specific data source. + remarks: >- + This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the + dynamic data widget. + + + When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if + available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is + pre-selected, the control will be disabled to ensure that authors can not change it. + + + The source id for a web part will be of the form WebPart.. + name: sourceId + fullName: sp-webpart-base.IDynamicDataSharedSourceFilters.sourceId + langs: + - typeScript + type: property + syntax: + content: 'sourceId?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 474a7a23..ca34dbb9 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -11,10 +11,24 @@ items: type: interface package: sp-webpart-base children: + - sp-webpart-base.IPropertyPaneAccessor.close - sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen - sp-webpart-base.IPropertyPaneAccessor.isRenderedByWebPart - sp-webpart-base.IPropertyPaneAccessor.open - sp-webpart-base.IPropertyPaneAccessor.refresh + - uid: sp-webpart-base.IPropertyPaneAccessor.close + summary: This API should be used to close the PropertyPane to help configure the web part. + name: close() + fullName: sp-webpart-base.IPropertyPaneAccessor.close + langs: + - typeScript + type: method + syntax: + content: 'close(): void;' + return: + type: + - void + description: '' - uid: sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen summary: Returns true if the PropertyPane is open. name: isPropertyPaneOpen() diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml new file mode 100644 index 00000000..eed30f93 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -0,0 +1,76 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IPropertyPaneConditionalGroup + summary: Property pane conditional group. + name: IPropertyPaneConditionalGroup + fullName: sp-webpart-base.IPropertyPaneConditionalGroup + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup + - sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup + - sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup + - sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup + - sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup + - uid: sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup + summary: Callback when user clicks to show primary group. + name: onShowPrimaryGroup + fullName: sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup + langs: + - typeScript + type: property + syntax: + content: 'onShowPrimaryGroup?: () => void;' + return: + type: + - () => void + - uid: sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup + summary: Callback when user clicks to show secondary group. + name: onShowSecondaryGroup + fullName: sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup + langs: + - typeScript + type: property + syntax: + content: 'onShowSecondaryGroup?: () => void;' + return: + type: + - () => void + - uid: sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup + summary: Primary group to show + name: primaryGroup + fullName: sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup + langs: + - typeScript + type: property + syntax: + content: 'primaryGroup: IPropertyPaneGroup;' + return: + type: + - IPropertyPaneGroup + - uid: sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup + summary: Secondary group to show + name: secondaryGroup + fullName: sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup + langs: + - typeScript + type: property + syntax: + content: 'secondaryGroup: IPropertyPaneGroup;' + return: + type: + - IPropertyPaneGroup + - uid: sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup + summary: Indicating whether the property pane should show primary group or the secondary group. + name: showSecondaryGroup + fullName: sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup + langs: + - typeScript + type: property + syntax: + content: 'showSecondaryGroup: boolean;' + return: + type: + - boolean diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 0a609f36..1c420cad 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -37,7 +37,7 @@ items: to pick the value of the key. - For more information, see the [React + For more information, see the [ React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). name: key fullName: sp-webpart-base.IPropertyPaneCustomFieldProps.key diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml new file mode 100644 index 00000000..f6cb3690 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -0,0 +1,75 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + summary: PropertyPaneDynamicField props. + name: IPropertyPaneDynamicFieldProps + fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IPropertyPaneDynamicFieldProps.filters + - sp-webpart-base.IPropertyPaneDynamicFieldProps.label + - sp-webpart-base.IPropertyPaneDynamicFieldProps.propertyValueDepth + - sp-webpart-base.IPropertyPaneDynamicFieldProps.sourcesLabel + - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.filters + summary: Filters for the property pane dynamic field. + name: filters + fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.filters + langs: + - typeScript + type: property + syntax: + content: 'filters?: IPropertyPaneDynamicFieldFilters;' + return: + type: + - IPropertyPaneDynamicFieldFilters + - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.label + summary: 'User-friendly, localized label to identify the field.' + name: label + fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.label + langs: + - typeScript + type: property + syntax: + content: 'label: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.propertyValueDepth + summary: |- + Indicates to what depth of property values are shown on the property pane dynamic data widget. + + If not specified, then max of 2 levels of property value will be shown. + remarks: >- + It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only + source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., + the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two + levels of property value will be shown i.e., the widget will display two levels after the source and property for + this field. + name: propertyValueDepth + fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.propertyValueDepth + langs: + - typeScript + type: property + syntax: + content: 'propertyValueDepth?: number;' + return: + type: + - number + - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.sourcesLabel + summary: |- + User-friendly, localized label for the sources dropdown. + + default value - 'Connect to source' + name: sourcesLabel + fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.sourcesLabel + langs: + - typeScript + type: property + syntax: + content: 'sourcesLabel?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml new file mode 100644 index 00000000..976282ec --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -0,0 +1,65 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + summary: PropertyPane DynamicFieldSet props. + name: IPropertyPaneDynamicFieldSetProps + fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields + - sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label + - sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration + - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields + summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. + name: fields + fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields + langs: + - typeScript + type: property + syntax: + content: 'fields: IPropertyPaneField[];' + return: + type: + - 'IPropertyPaneField[]' + - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label + summary: 'User-friendly, localized label to identify the property.' + name: label + fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label + langs: + - typeScript + type: property + syntax: + content: 'label: string;' + return: + type: + - string + - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration + summary: Configuration shared between all the entries of the set. + name: sharedConfiguration + fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration + langs: + - typeScript + type: property + syntax: + content: 'sharedConfiguration?:' + return: + type: + - |- + { + /** + * Indicates to what depth the dynamic reference is shared between the set of fields + * of the dynamic field set. + */ + depth: DynamicDataSharedDepth; + /** + * Shared source configuration + */ + source?: IDynamicDataSharedSourceConfiguration; + /** + * Shared property configuration + */ + property?: IDynamicDataSharedPropertyConfiguration; + } diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index d16ccae4..611088ca 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -1,7 +1,9 @@ ### YamlMime:UniversalReference items: - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps - summary: PropertyPaneDynamicData component props. + summary: '`PropertyPaneDynamicData` component props.' + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: IPropertyPaneDynamicTextFieldProps fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps @@ -21,7 +23,9 @@ items: - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel - summary: 'Aria Label for text field, if any.' + summary: 'ARIA Label for text field, if any.' + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: ariaLabel fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel @@ -35,6 +39,8 @@ items: - string - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description summary: The text field input description. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: description fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description @@ -48,6 +54,8 @@ items: - string - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled summary: Whether the property pane text field is enabled or not. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: disabled fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled @@ -62,11 +70,13 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage summary: 'If set, this will be displayed as an error message.' remarks: >- - When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the + When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the error message. - So, make sure to set this only if you want to see an error message displayed for the text field. + Make sure to set this only if you want to see an error message displayed for the text field. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: errorMessage fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage @@ -80,6 +90,8 @@ items: - string - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label summary: Label for the text field. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: label fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label @@ -92,7 +104,7 @@ items: type: - string - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage - summary: The method is used to get the validation error message and determine whether the input value is valid or not. + summary: This method is used to get the validation error message and determine whether the input value is valid or not. remarks: |- When it returns string: @@ -100,11 +112,13 @@ items: - If invalid, it returns the error message string and an error message is displayed below the text field. - When it returns Promise<string>: + When it returns `Promise`: - The resolved value is display as error message. - The rejected, the value is thrown away. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: onGetErrorMessage fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage @@ -117,7 +131,9 @@ items: type: - '(value: string) => string | Promise' - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder - summary: placeholder text to be displayed in the text field. + summary: Placeholder text to be displayed in the text field. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: placeholder fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder @@ -132,6 +148,8 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: validateOnFocusIn fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn @@ -144,8 +162,10 @@ items: type: - boolean - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut - summary: Run validation when the PropertyPaneTextField is out of focus or on blur. + summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: validateOnFocusOut fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut @@ -161,6 +181,8 @@ items: summary: >- Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: value fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 322ca94f..decf81ff 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -39,7 +39,7 @@ items: type: - string - uid: sp-webpart-base.IPropertyPaneTextFieldProps.deferredValidationTime - summary: Text field will start to validate after users stop typing for \`deferredValidationTime\` milliseconds. + summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. name: deferredValidationTime fullName: sp-webpart-base.IPropertyPaneTextFieldProps.deferredValidationTime @@ -106,12 +106,28 @@ items: type: - string - uid: sp-webpart-base.IPropertyPaneTextFieldProps.logName - summary: Engagement name to log PropertyPaneTextField value change. + summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. remarks: >- - It will be logged format as <moduleName>.<controlName>. E.g. {moduleName: 'ImageWebPart', controlName: - 'OverlayText'}, it will log: 1. action type, including 'Add', 'Clear' and 'Edit'. Clear: reset the content of - caption element to initial/unset state. Add: change from initial/unset state to customized content. (first edit) - Edit: any edition that changes the content apart from add and clear 2. text length after each edit. + The messages will be logged with a format such as `.`. + + + For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might + contain: + + + 1. The action type: + + + `Add`: change from initial/unset state to customized content. (first edit) + + + `Clear`: reset the content of caption element to initial/unset state. + + + `Edit`: any edition that changes the content apart from add and clear + + + 2. The text length after each edit name: logName fullName: sp-webpart-base.IPropertyPaneTextFieldProps.logName langs: @@ -161,7 +177,7 @@ items: - If invalid, it returns the error message string and an error message is displayed below the text field. - When it returns Promise<string>: + When it returns `Promise`: - The resolved value is display as error message. diff --git a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index d99e1c2b..23f15cc6 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -20,9 +20,17 @@ items: fixup on them. - Example: { 'myRichDescription': '<div>Some standard <b>HTML content</b><a - href='http://somelink'>A Link</a></div>' 'anotherRichText': <div class='aClass'><span - style='color:red'>Some red text</div> } + Example: + + ``` + + { + 'myRichDescription': '
Some standard HTML contentA Link
' + 'anotherRichText':
Some red text
+ } + + + ``` name: htmlStrings fullName: sp-webpart-base.ISerializedServerProcessedData.htmlStrings langs: @@ -41,7 +49,14 @@ items: remarks: |- SharePoint servers treat the values as image sources and run services like search index and link fixup on them. - Example: { 'myImage1': 'http://res.contoso.com/path/to/file' 'myImage2': 'https://res.contoso.com/someName.jpg' } + Example: + ``` + { + 'myImage1': 'http://res.contoso.com/path/to/file' + 'myImage2': 'https://res.contoso.com/someName.jpg' + } + + ``` name: imageSources fullName: sp-webpart-base.ISerializedServerProcessedData.imageSources langs: @@ -60,7 +75,14 @@ items: remarks: |- SharePoint servers treat the values as links and run services like link fixup on them. - Example: { 'myWebURL': 'http://contoso.com' 'myFileLink': 'https://res.contoso.com/file.docx' } + Example: + ``` + { + 'myWebURL': 'http://contoso.com' + 'myFileLink': 'https://res.contoso.com/file.docx' + } + + ``` name: links fullName: sp-webpart-base.ISerializedServerProcessedData.links langs: @@ -81,8 +103,17 @@ items: but are not treated as valid HTML. So, other services such as link fixup will not run on them. - Example: { 'justSomeText': 'This is some plain text', 'anotherText': 'Can have <any> characters here: - "<>&\\'' } + Example: + + ``` + + { + 'justSomeText': 'This is some plain text', + 'anotherText': 'Can have characters here: "<>&\'' + } + + + ``` name: searchablePlainTexts fullName: sp-webpart-base.ISerializedServerProcessedData.searchablePlainTexts langs: diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index 96e7f2bb..cfe9da30 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -24,8 +24,10 @@ items: serialized data of the web part. Refer to dataVersion field of your web part for more information. - Usage: versioning and evolving the serialized data of the web part Required: yes Type: Version Supported values: - MAJOR.MINOR Example: "1.0" + Supported values: MAJOR.MINOR + + + Example: `"1.0"` name: dataVersion fullName: sp-webpart-base.ISerializedWebPartData.dataVersion langs: @@ -37,14 +39,20 @@ items: type: - Version - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths - summary: >- - Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. + summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. + remarks: |- The key is the path within the web part properties, and the value is the dynamic data internal id. + Example: + ``` + { + 'pageContextUser': + 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' + } - Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', - 'anotherWebPartProperty': - 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } + ``` isPreview: true name: dynamicDataPaths fullName: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths @@ -62,11 +70,18 @@ items: - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataValues summary: >- Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the - web part. The key is the path within the web part properties, and the value is the dynamic data static value. + web part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data static value. + Example: + ``` + { + 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true + } - Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', - 'aBooleanProperty': true } + ``` isPreview: true name: dynamicDataValues fullName: sp-webpart-base.ISerializedWebPartData.dynamicDataValues @@ -84,9 +99,14 @@ items: - uid: sp-webpart-base.ISerializedWebPartData.properties summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- - Usage: used by the web part to manage its internal metadata and config data. The framework code never touches - these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { - 'value': 'text value' } + Used by the web part to manage its internal metadata and config data. The framework code never touches these + properties. + + + Supported values: any JSON stringifiable object hierarchy. + + + Example: `{ 'value': 'text value' }` name: properties fullName: sp-webpart-base.ISerializedWebPartData.properties langs: diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 0cc8d103..6b6a1a88 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -28,7 +28,7 @@ items: - sp-webpart-base.IWebPartContext.statusRenderer - sp-webpart-base.IWebPartContext.webPartTag - uid: sp-webpart-base.IWebPartContext.domElement - summary: Reference to the DOM element that hosts this client side component. + summary: Reference to the DOM element that hosts this client-side component. deprecated: content: >- This interface will be removed in an upcoming release. Use the @@ -93,7 +93,7 @@ items: type: - string - uid: sp-webpart-base.IWebPartContext.manifest - summary: Manifest for the client side web part. + summary: Manifest for the client-side web part. deprecated: content: >- This interface will be removed in an upcoming release. Use the diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 3c1d19e7..290f9f0b 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -1,10 +1,11 @@ ### YamlMime:UniversalReference items: - uid: sp-webpart-base.IWebPartData - summary: >- - This structure represents the serialized state of a web part. When the serialize() API is called on a web part, - the output should be this structure. The structure of the 'properties' field is owned by the web part and is - specific to the web part. Each web part can decide the set of properties it wants to serialize. + summary: This structure represents the serialized state of a web part. + remarks: >- + When the `serialize()` API is called on a web part, the output should be this structure. The structure of the + 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of + properties it wants to serialize. name: IWebPartData fullName: sp-webpart-base.IWebPartData langs: @@ -29,8 +30,10 @@ items: serialized data of the web part. Refer to dataVersion field of your web part for more information. - Usage: versioning and evolving the serialized data of the web part Required: yes Type: string Supported values: - MAJOR.MINOR Example: "1.0" + Supported values: MAJOR.MINOR + + + Example: `"1.0"` name: dataVersion fullName: sp-webpart-base.IWebPartData.dataVersion langs: @@ -43,9 +46,12 @@ items: - string - uid: sp-webpart-base.IWebPartData.description summary: Web part description - remarks: >- - Usage: display the description of the web part. Required: no Type: string Supported values: string with the - description. Example: "Text" + remarks: |- + Used to display the description of the web part. + + Supported values: string with the description. + + Example: `"Text"` name: description fullName: sp-webpart-base.IWebPartData.description langs: @@ -57,14 +63,25 @@ items: type: - string - uid: sp-webpart-base.IWebPartData.dynamicDataPaths - summary: >- - Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. - The key is the path within the web part properties, and the value is the dynamic data internal id. + summary: Paths for the dynamic data. + remarks: >- + This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within + the web part properties, and the value is the dynamic data internal id. + + + Example: + + ``` + { + 'pageContextUser': + 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' + } - Required: no Supported values: Map from string to string Example: { 'pageContextUser': 'PageContext:user', - 'anotherWebPartProperty': - 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } + + ``` isPreview: true name: dynamicDataPaths fullName: sp-webpart-base.IWebPartData.dynamicDataPaths @@ -82,11 +99,18 @@ items: - uid: sp-webpart-base.IWebPartData.dynamicDataValues summary: >- Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web - part. The key is the path within the web part properties, and the value is the dynamic data static value. + part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data static value. + Example: + ``` + { + 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true + } - Required: no Supported values: Map from string to string Example: { 'aStringProperty': 'thisIsAString', - 'aBooleanProperty': true } + ``` isPreview: true name: dynamicDataValues fullName: sp-webpart-base.IWebPartData.dynamicDataValues @@ -103,9 +127,7 @@ items: } - uid: sp-webpart-base.IWebPartData.id summary: Universally unique web part Type id. - remarks: >- - Usage: uniquely identify a web part. Required: yes Type: GUID Supported values: any GUID Example: - "dbef608d-3ad5-4f8f-b139-d916f2f0a294" + remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' name: id fullName: sp-webpart-base.IWebPartData.id langs: @@ -120,10 +142,10 @@ items: summary: >- Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries. - remarks: >- - how used: used by the framework to uniquely identify an instance of a web part. mandatory: yes type: string - supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: - \["dbef608d-3ad5-4f8f-b139-d916f2f0a294"\] experimental: yes + remarks: |- + supported values: a unique string. Could be GUID or other uniquely identifiable formats. + + example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` name: instanceId fullName: sp-webpart-base.IWebPartData.instanceId langs: @@ -137,9 +159,14 @@ items: - uid: sp-webpart-base.IWebPartData.properties summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- - Usage: used by the web part to manage its internal metadata and config data. The framework code never touches - these properties. Required: yes Type: any Supported values: any JSON stringifiable object hierarchy. Example: { - 'value': 'text value' } + Used by the web part to manage its internal metadata and config data. The framework code never touches these + properties. + + + Supported values: any object hierarchy that can be serialized using `JSON.stringify()`. + + + Example: `{ 'value': 'text value' }` name: properties fullName: sp-webpart-base.IWebPartData.properties langs: @@ -151,9 +178,7 @@ items: type: - any - uid: sp-webpart-base.IWebPartData.serverProcessedContent - summary: >- - Definition: The collections of data that can be processed by server side services like search index and link fixup - Required: no + summary: The collections of data that can be processed by server side services like search index and link fixup name: serverProcessedContent fullName: sp-webpart-base.IWebPartData.serverProcessedContent langs: @@ -166,9 +191,12 @@ items: - ISerializedServerProcessedData - uid: sp-webpart-base.IWebPartData.title summary: Web part title - remarks: >- - Usage: display the name of the web part in the toolbox, web part gallery and the page. Required: yes Type: string - Supported values: string less than 100 characters Example: "Text" + remarks: |- + Used to display the name of the web part in the toolbox, web part gallery and the page. + + Supported values: string less than 100 characters + + Example: `"Text"` name: title fullName: sp-webpart-base.IWebPartData.title langs: diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 05794a2d..dbb99063 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -1,32 +1,56 @@ ### YamlMime:UniversalReference items: - uid: sp-webpart-base.IWebPartPropertiesMetadata - summary: This structure is used to define metadata for web part properties as a map of string to IWebPartPropertyMetadata + summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` remarks: >- The key should be a JSON path to the property in web part properties. The JSON path supports the following operators: - - Dot . for selecting object members e.g. person.name + - Dot `.` for selecting object members, for example `person.name` - - Brackets \[\] for selecting array items e.g. person.photoURLs\[0\] + - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` - - Bracketed asterisk \[\*\] for array elements wildcard e.g. person.websites\[\*\]. + - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. - You can make combinations of these operators e.g. person.websites\[\*\].url Important Note: Only one wildcard per - path is supported. + You can make combinations of these operators, for example `person.websites[*].url` - Example: Let's assume we have a web part with properties that have the following schema: { title: string; person: - { name: string; bio: string; photoURLs: string\[\]; websites: { title: string; url: string; }\[\] } } + Important Note: Only one wildcard per path is supported. - We can define the metadata for the desired properties as following: { 'person.bio': { isRichContent: true }, - 'person.photoURLs\[\*\]': { isImageSource: true }, 'person.websites\[\*\].url': { isLink: true } } + Example: Let's assume we have a web part with properties that have the following schema: + ``` + + { + title: string; + person: { + name: string; + bio: string; + photoURLs: string[]; + websites: { title: string; url: string; }[] + } + } + + + ``` + + We can define the metadata for the desired properties as following: + + ``` + + { + 'person.bio': { isRichContent: true }, + 'person.photoURLs[*]': { isImageSource: true }, + 'person.websites[*].url': { isLink: true } + } + + + ``` This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 3b0fc632..d49cd5cd 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -1,7 +1,7 @@ ### YamlMime:UniversalReference items: - uid: sp-webpart-base.IWebPartPropertyMetadata - summary: This is the structure used for map values in IWebPartPropertiesMetadata + summary: This is the structure used for map values in `IWebPartPropertiesMetadata` name: IWebPartPropertyMetadata fullName: sp-webpart-base.IWebPartPropertyMetadata langs: @@ -9,22 +9,60 @@ items: type: interface package: sp-webpart-base children: + - sp-webpart-base.IWebPartPropertyMetadata.dynamicPropertyType - sp-webpart-base.IWebPartPropertyMetadata.isHtmlString - sp-webpart-base.IWebPartPropertyMetadata.isImageSource - sp-webpart-base.IWebPartPropertyMetadata.isLink - sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText - sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist + - uid: sp-webpart-base.IWebPartPropertyMetadata.dynamicPropertyType + summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' + remarks: >- + If a web part has properties that are dynamically configurable, then use this flag to declare the property as a + dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework + ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a + property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the + IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create + the DynamicProperty themselves and assign it to the property. + + + A web part can configure a default value for the property by specifying it in the properties section of the web + part's manifest. This value will be used when a dynamic property is constructed for the property. + + + Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. + name: dynamicPropertyType + fullName: sp-webpart-base.IWebPartPropertyMetadata.dynamicPropertyType + langs: + - typeScript + type: property + syntax: + content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' + return: + type: + - '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' - uid: sp-webpart-base.IWebPartPropertyMetadata.isHtmlString summary: Indicates whether the property should be serialized as HTML. remarks: >- This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on - it: - normalizing HTML encodings - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) - search - indexing - SharePoint link fix-up + it: + + + - normalizing HTML encodings + + + - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) + + + - search indexing + + + - SharePoint link fix-up Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply - needs to be exposed to the search index (without any rewriting), use the isSearchablePlainText flag instead. + needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. name: isHtmlString fullName: sp-webpart-base.IWebPartPropertyMetadata.isHtmlString langs: @@ -69,8 +107,10 @@ items: This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the - isHtmlString setting instead. Security note: For security reasons, never assign a plain text string to - Element.innerHTML. + isHtmlString setting instead. + + + Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. name: isSearchablePlainText fullName: sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText langs: @@ -82,14 +122,14 @@ items: type: - boolean - uid: sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist - summary: >- - Indicates if the framework should persist the property on the server. Use this for properties that are only - important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data - of the web part and optimize the webpart load time. The property value will be removed from the serialized data - sent to the server, but this has no effect on the run-time property bag. The property value will still be - available in onBeforeSerialize() method, and the value will not be cleared from the run-time property bag. The - initial render of your web part should not depend on the value of the property. Setting a default value for the - property can be done in onInit() method. + summary: Indicates if the framework should persist the property on the server. + remarks: >- + Use this for properties that are only important in run-time, and do not need to persist on the server. This can + reduce the size of the serialized data of the web part and optimize the web part load time. The property value + will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. + The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared + from the run-time property bag. The initial render of your web part should not depend on the value of the + property. Setting a default value for the property can be done in `onInit()` method. Note that if the property path refers to a property that has a complex object as the value, the whole object will diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index ca2d4291..f5b06f6a 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -17,6 +17,8 @@ items: - sp-webpart-base.PropertyPaneFieldType.ChoiceGroup - sp-webpart-base.PropertyPaneFieldType.Custom - sp-webpart-base.PropertyPaneFieldType.Dropdown + - sp-webpart-base.PropertyPaneFieldType.DynamicField + - sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet - sp-webpart-base.PropertyPaneFieldType.DynamicTextField - sp-webpart-base.PropertyPaneFieldType.Heading - sp-webpart-base.PropertyPaneFieldType.HorizontalRule @@ -65,8 +67,26 @@ items: - typeScript type: field numericValue: '6' + - uid: sp-webpart-base.PropertyPaneFieldType.DynamicField + summary: Dynamic data field. + name: DynamicField + fullName: sp-webpart-base.PropertyPaneFieldType.DynamicField + langs: + - typeScript + type: field + numericValue: '14' + - uid: sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet + summary: A set of dynamic fields. + name: DynamicFieldSet + fullName: sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet + langs: + - typeScript + type: field + numericValue: '16' - uid: sp-webpart-base.PropertyPaneFieldType.DynamicTextField summary: Dynamic Text Field + deprecated: + content: '- Please use DynamicField' isPreview: true name: DynamicTextField fullName: sp-webpart-base.PropertyPaneFieldType.DynamicTextField diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index f5282a65..84987203 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -17,9 +17,10 @@ items: package: sp-webpart-base children: - sp-webpart-base.WebPartContext.domElement + - sp-webpart-base.WebPartContext.microsoftTeams - sp-webpart-base.WebPartContext.statusRenderer - uid: sp-webpart-base.WebPartContext.domElement - summary: Reference to the DOM element that hosts this client side component. + summary: Reference to the DOM element that hosts this client-side component. name: domElement fullName: sp-webpart-base.WebPartContext.domElement langs: @@ -30,6 +31,24 @@ items: return: type: - HTMLElement + - uid: sp-webpart-base.WebPartContext.microsoftTeams + summary: >- + Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is + being hosted in Microsoft Teams. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + isPreview: true + name: microsoftTeams + fullName: sp-webpart-base.WebPartContext.microsoftTeams + langs: + - typeScript + type: property + syntax: + content: 'readonly microsoftTeams: typeof microsoftTeams | undefined;' + return: + type: + - typeof microsoftTeams | undefined - uid: sp-webpart-base.WebPartContext.statusRenderer summary: Web part status renderer. name: statusRenderer diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml new file mode 100644 index 00000000..e008bc2e --- /dev/null +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -0,0 +1,39 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.WebPartFormFactor + summary: Form factor of the web part. + remarks: >- + This will change based on how the web part is used, not by the web part itself. In cases like web parts used in + Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web + parts, it will have a canvas web part form factor. + isPreview: true + name: WebPartFormFactor + fullName: sp-webpart-base.WebPartFormFactor + langs: + - typeScript + type: enum + package: sp-webpart-base + children: + - sp-webpart-base.WebPartFormFactor.FullSize + - sp-webpart-base.WebPartFormFactor.Standard + - uid: sp-webpart-base.WebPartFormFactor.FullSize + summary: 'Full size form factor. This means the web part is rendered in full size, taking all space available in the page.' + remarks: This is the case for Teams tabs or single web part App pages. + isPreview: true + name: FullSize + fullName: sp-webpart-base.WebPartFormFactor.FullSize + langs: + - typeScript + type: field + numericValue: '1' + - uid: sp-webpart-base.WebPartFormFactor.Standard + summary: >- + Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this + case, the width is determined by the container, and web part self-adjust for height. + isPreview: true + name: Standard + fullName: sp-webpart-base.WebPartFormFactor.Standard + langs: + - typeScript + type: field + numericValue: '0' diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index a1721862..02b20244 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -33,6 +33,22 @@ uid: sp-component-base.DynamicDataSourceManager - name: DynamicProperty uid: sp-component-base.DynamicProperty + - name: IFontStyles + uid: sp-component-base.IFontStyles + - name: IPalette + uid: sp-component-base.IPalette + - name: IReadonlyFontStyles + uid: sp-component-base.IReadonlyFontStyles + - name: IReadonlyTheme + uid: sp-component-base.IReadonlyTheme + - name: ISemanticColors + uid: sp-component-base.ISemanticColors + - name: ITheme + uid: sp-component-base.ITheme + - name: ThemeChangedEventArgs + uid: sp-component-base.ThemeChangedEventArgs + - name: ThemeProvider + uid: sp-component-base.ThemeProvider - name: sp-core-library uid: sp-core-library items: @@ -102,12 +118,20 @@ items: - name: DynamicDataReference uid: sp-dynamic-data.DynamicDataReference + - name: IDynamicDataAnnotatedPropertyValue + uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue - name: IDynamicDataCallables uid: sp-dynamic-data.IDynamicDataCallables + - name: IDynamicDataEventDefinition + uid: sp-dynamic-data.IDynamicDataEventDefinition - name: IDynamicDataPropertyDefinition uid: sp-dynamic-data.IDynamicDataPropertyDefinition - name: IDynamicDataPropertyMetadata uid: sp-dynamic-data.IDynamicDataPropertyMetadata + - name: IDynamicDataPropertyValueMetadata + uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + - name: IDynamicDataPropertyValueMetadataCollection + uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection - name: IDynamicDataSource uid: sp-dynamic-data.IDynamicDataSource - name: IDynamicDataSourceMetadata @@ -287,8 +311,6 @@ uid: sp-page-context.SPUser - name: SPWeb uid: sp-page-context.SPWeb - - name: sp-property-pane - uid: sp-property-pane - name: sp-webpart-base uid: sp-webpart-base items: @@ -298,8 +320,18 @@ uid: sp-webpart-base.BaseWebPart - name: BaseWebPartContext uid: sp-webpart-base.BaseWebPartContext + - name: DynamicDataSharedDepth + uid: sp-webpart-base.DynamicDataSharedDepth - name: IClientSideWebPartStatusRenderer uid: sp-webpart-base.IClientSideWebPartStatusRenderer + - name: IDynamicDataSharedPropertyConfiguration + uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + - name: IDynamicDataSharedPropertyFilters + uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + - name: IDynamicDataSharedSourceConfiguration + uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + - name: IDynamicDataSharedSourceFilters + uid: sp-webpart-base.IDynamicDataSharedSourceFilters - name: IPlaceholderSpinnerProps uid: sp-webpart-base.IPlaceholderSpinnerProps - name: IPropertyPaneAccessor @@ -314,6 +346,8 @@ uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps - name: IPropertyPaneChoiceGroupProps uid: sp-webpart-base.IPropertyPaneChoiceGroupProps + - name: IPropertyPaneConditionalGroup + uid: sp-webpart-base.IPropertyPaneConditionalGroup - name: IPropertyPaneConfiguration uid: sp-webpart-base.IPropertyPaneConfiguration - name: IPropertyPaneCustomFieldProps @@ -324,6 +358,10 @@ uid: sp-webpart-base.IPropertyPaneDropdownOption - name: IPropertyPaneDropdownProps uid: sp-webpart-base.IPropertyPaneDropdownProps + - name: IPropertyPaneDynamicFieldProps + uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + - name: IPropertyPaneDynamicFieldSetProps + uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps - name: IPropertyPaneDynamicTextFieldProps uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps - name: IPropertyPaneField @@ -364,3 +402,5 @@ uid: sp-webpart-base.PropertyPaneFieldType - name: WebPartContext uid: sp-webpart-base.WebPartContext + - name: WebPartFormFactor + uid: sp-webpart-base.WebPartFormFactor From 675fdfc784d9bcdeed851a4125308799ba5c87eb Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 9 Nov 2018 06:47:31 -0800 Subject: [PATCH 23/55] Regenerate JSON files using latest development branch of API Extractor --- generate-docs/json/sp-core-library.api.json | 2 +- generate-docs/json/sp-http.api.json | 28 ++++++++++----------- generate-docs/json/sp-webpart-base.api.json | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index bdedc126..f763dd56 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -221,7 +221,7 @@ "elements": [ { "kind": "text", - "text": " RFC4122" + "text": "RFC4122" } ], "targetUrl": "https://www.ietf.org/rfc/rfc4122.txt" diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index 29ede74c..517c41bb 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -740,7 +740,7 @@ "elements": [ { "kind": "text", - "text": " \"Complete basic operations using SharePoint 2013 REST endpoints\" " + "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" } ], "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" @@ -3011,7 +3011,7 @@ "elements": [ { "kind": "text", - "text": " Body" + "text": "Body" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" @@ -3049,7 +3049,7 @@ "elements": [ { "kind": "text", - "text": " Body" + "text": "Body" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" @@ -3083,7 +3083,7 @@ "elements": [ { "kind": "text", - "text": " Body" + "text": "Body" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" @@ -3141,7 +3141,7 @@ "elements": [ { "kind": "text", - "text": " Body" + "text": "Body" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" @@ -3175,7 +3175,7 @@ "elements": [ { "kind": "text", - "text": " Response" + "text": "Response" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" @@ -3214,7 +3214,7 @@ "elements": [ { "kind": "text", - "text": " Body" + "text": "Body" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" @@ -3264,7 +3264,7 @@ "elements": [ { "kind": "text", - "text": " Response" + "text": "Response" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" @@ -3299,7 +3299,7 @@ "elements": [ { "kind": "text", - "text": " Response" + "text": "Response" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" @@ -3334,7 +3334,7 @@ "elements": [ { "kind": "text", - "text": " Response" + "text": "Response" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" @@ -3373,7 +3373,7 @@ "elements": [ { "kind": "text", - "text": " Body" + "text": "Body" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" @@ -3407,7 +3407,7 @@ "elements": [ { "kind": "text", - "text": " Response" + "text": "Response" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" @@ -3442,7 +3442,7 @@ "elements": [ { "kind": "text", - "text": " Response" + "text": "Response" } ], "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" @@ -3594,7 +3594,7 @@ "elements": [ { "kind": "text", - "text": " \"Complete basic operations using SharePoint 2013 REST endpoints\" " + "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" } ], "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index de92414b..da59a94d 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -2967,7 +2967,7 @@ "elements": [ { "kind": "text", - "text": " React documentation" + "text": "React documentation" } ], "targetUrl": "https://facebook.github.io/react/docs/lists-and-keys.html#keys" From 73313ecbd4a90d6a8ff2c22370684f4906eb2e3c Mon Sep 17 00:00:00 2001 From: pgonzal Date: Fri, 9 Nov 2018 06:49:41 -0800 Subject: [PATCH 24/55] Regenerate docs using API Documenter from the https://github.com/Microsoft/web-build-tools/pull/921 PR branch --- SP-Framework/decorators.yml | 8 +- SP-Framework/sp-application-base.yml | 2 +- .../applicationaccessor.yml | 6 +- .../applicationcustomizercontext.yml | 8 +- .../baseapplicationcustomizer.yml | 8 +- .../iplaceholdercreatecontentoptions.yml | 4 +- .../placeholdercontent.yml | 12 +- .../sp-application-base/placeholdername.yml | 6 +- .../placeholderprovider.yml | 12 +- SP-Framework/sp-component-base.yml | 2 +- .../sp-component-base/basecomponent.yml | 16 +-- .../basecomponentcontext.yml | 30 ++-- .../sp-component-base/dynamicdataprovider.yml | 22 +-- .../dynamicdatasourcemanager.yml | 16 +-- .../sp-component-base/dynamicproperty.yml | 28 ++-- .../sp-component-base/ifontstyles.yml | 24 ++-- SP-Framework/sp-component-base/ipalette.yml | 98 ++++++------- .../sp-component-base/ireadonlyfontstyles.yml | 24 ++-- .../sp-component-base/ireadonlytheme.yml | 8 +- .../sp-component-base/isemanticcolors.yml | 134 +++++++++--------- SP-Framework/sp-component-base/itheme.yml | 12 +- .../themechangedeventargs.yml | 4 +- .../sp-component-base/themeprovider.yml | 10 +- SP-Framework/sp-core-library.yml | 2 +- SP-Framework/sp-core-library/displaymode.yml | 6 +- SP-Framework/sp-core-library/environment.yml | 4 +- .../sp-core-library/environmenttype.yml | 10 +- SP-Framework/sp-core-library/guid.yml | 16 +-- SP-Framework/sp-core-library/idisposable.yml | 6 +- .../irandomnumbergenerator.yml | 4 +- .../sp-core-library/iservicecollection.yml | 4 +- .../sp-core-library/ispeventobserver.yml | 6 +- .../sp-core-library/itimeprovider.yml | 6 +- SP-Framework/sp-core-library/log.yml | 10 +- .../sp-core-library/randomnumbergenerator.yml | 8 +- SP-Framework/sp-core-library/servicekey.yml | 12 +- SP-Framework/sp-core-library/servicescope.yml | 22 +-- SP-Framework/sp-core-library/session.yml | 6 +- SP-Framework/sp-core-library/spevent.yml | 6 +- SP-Framework/sp-core-library/speventargs.yml | 2 +- SP-Framework/sp-core-library/text.yml | 6 +- SP-Framework/sp-core-library/timeprovider.yml | 10 +- .../urlqueryparametercollection.yml | 8 +- SP-Framework/sp-core-library/validate.yml | 10 +- SP-Framework/sp-core-library/version.yml | 26 ++-- SP-Framework/sp-diagnostics.yml | 2 +- SP-Framework/sp-dialog.yml | 2 +- SP-Framework/sp-dialog/basedialog.yml | 24 ++-- SP-Framework/sp-dialog/dialog.yml | 6 +- SP-Framework/sp-dialog/ialertoptions.yml | 2 +- .../sp-dialog/idialogconfiguration.yml | 4 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 4 +- SP-Framework/sp-dialog/ipromptoptions.yml | 4 +- .../sp-dialog/isecondarydialogprovider.yml | 8 +- SP-Framework/sp-dynamic-data.yml | 2 +- .../sp-dynamic-data/dynamicdatareference.yml | 12 +- .../idynamicdataannotatedpropertyvalue.yml | 6 +- .../sp-dynamic-data/idynamicdatacallables.yml | 12 +- .../idynamicdataeventdefinition.yml | 6 +- .../idynamicdatapropertydefinition.yml | 4 +- .../idynamicdatapropertymetadata.yml | 6 +- .../idynamicdatapropertyvaluemetadata.yml | 4 +- ...micdatapropertyvaluemetadatacollection.yml | 4 +- .../sp-dynamic-data/idynamicdatasource.yml | 16 +-- .../idynamicdatasourcemetadata.yml | 12 +- SP-Framework/sp-extension-base.yml | 2 +- .../sp-extension-base/baseextension.yml | 8 +- .../sp-extension-base/extensioncontext.yml | 2 +- SP-Framework/sp-http.yml | 2 +- SP-Framework/sp-http/aadhttpclient.yml | 12 +- .../sp-http/aadhttpclientconfiguration.yml | 8 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 6 +- SP-Framework/sp-http/aadtokenprovider.yml | 6 +- .../sp-http/aadtokenproviderfactory.yml | 6 +- SP-Framework/sp-http/digestcache.yml | 18 +-- SP-Framework/sp-http/graphhttpclient.yml | 14 +- .../sp-http/graphhttpclientconfiguration.yml | 6 +- .../sp-http/graphhttpclientresponse.yml | 8 +- SP-Framework/sp-http/graphrequest.yml | 62 ++++---- SP-Framework/sp-http/httpclient.yml | 14 +- .../sp-http/httpclientconfiguration.yml | 10 +- SP-Framework/sp-http/httpclientresponse.yml | 54 +++---- .../sp-http/iaadhttpclientconfiguration.yml | 2 +- .../sp-http/iaadhttpclientconfigurations.yml | 4 +- .../sp-http/iaadhttpclientoptions.yml | 6 +- SP-Framework/sp-http/idigestcache.yml | 14 +- .../sp-http/igraphhttpclientconfiguration.yml | 2 +- .../igraphhttpclientconfigurations.yml | 4 +- .../sp-http/igraphhttpclientoptions.yml | 2 +- .../sp-http/ihttpclientconfiguration.yml | 2 +- .../sp-http/ihttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/ihttpclientoptions.yml | 2 +- .../isphttpclientbatchconfiguration.yml | 2 +- .../isphttpclientbatchconfigurations.yml | 4 +- .../isphttpclientbatchcreationoptions.yml | 4 +- .../sp-http/isphttpclientbatchoptions.yml | 2 +- .../isphttpclientcommonconfiguration.yml | 6 +- .../sp-http/isphttpclientconfiguration.yml | 8 +- .../sp-http/isphttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/isphttpclientoptions.yml | 4 +- SP-Framework/sp-http/msgraphclient.yml | 4 +- SP-Framework/sp-http/msgraphclientfactory.yml | 6 +- SP-Framework/sp-http/odataversion.yml | 8 +- SP-Framework/sp-http/sphttpclient.yml | 18 +-- SP-Framework/sp-http/sphttpclientbatch.yml | 12 +- .../sphttpclientbatchconfiguration.yml | 10 +- .../sphttpclientcommonconfiguration.yml | 14 +- .../sp-http/sphttpclientconfiguration.yml | 16 +-- SP-Framework/sp-http/sphttpclientresponse.yml | 8 +- SP-Framework/sp-http/sphttpheader.yml | 4 +- .../sp-http/tokenacquisitioneventargs.yml | 8 +- SP-Framework/sp-listview-extensibility.yml | 2 +- .../basefieldcustomizer.yml | 8 +- .../baselistviewcommandset.yml | 10 +- .../columnaccessor.yml | 6 +- .../sp-listview-extensibility/command.yml | 12 +- .../fieldcustomizercontext.yml | 6 +- .../ifieldcustomizercelleventparameters.yml | 10 +- ...stviewcommandsetexecuteeventparameters.yml | 6 +- ...iewcommandsetlistviewupdatedparameters.yml | 4 +- .../listitemaccessor.yml | 8 +- .../listviewaccessor.yml | 8 +- .../listviewcommandsetcontext.yml | 6 +- .../sp-listview-extensibility/rowaccessor.yml | 2 +- .../selectedrowschangedeventargs.yml | 4 +- SP-Framework/sp-odata-types.yml | 2 +- .../sp-odata-types/iodatabasepermission.yml | 6 +- .../sp-odata-types/iodatachangetoken.yml | 4 +- .../iodatacontextwebinformation.yml | 10 +- SP-Framework/sp-odata-types/iodatalist.yml | 28 ++-- .../sp-odata-types/iodatalistitem.yml | 10 +- .../sp-odata-types/iodatanavigationnode.yml | 16 +-- .../iodatanavigationnodecollection.yml | 6 +- SP-Framework/sp-odata-types/iodatauser.yml | 16 +-- .../sp-odata-types/iodatausercustomaction.yml | 38 ++--- SP-Framework/sp-odata-types/iodataweb.yml | 38 ++--- SP-Framework/sp-page-context.yml | 2 +- SP-Framework/sp-page-context/cultureinfo.yml | 8 +- .../sp-page-context/ispsystemtime.yml | 18 +-- .../sp-page-context/isptimezonedata.yml | 16 +-- SP-Framework/sp-page-context/pagecontext.yml | 24 ++-- SP-Framework/sp-page-context/spdayofweek.yml | 16 +-- SP-Framework/sp-page-context/spfield.yml | 16 +-- SP-Framework/sp-page-context/splist.yml | 10 +- SP-Framework/sp-page-context/splistitem.yml | 4 +- SP-Framework/sp-page-context/sppermission.yml | 84 +++++------ SP-Framework/sp-page-context/spsite.yml | 24 ++-- SP-Framework/sp-page-context/sptimezone.yml | 16 +-- SP-Framework/sp-page-context/spuser.yml | 18 +-- SP-Framework/sp-page-context/spweb.yml | 26 ++-- SP-Framework/sp-webpart-base.yml | 30 ++-- .../sp-webpart-base/baseclientsidewebpart.yml | 28 ++-- SP-Framework/sp-webpart-base/basewebpart.yml | 46 +++--- .../sp-webpart-base/basewebpartcontext.yml | 10 +- .../dynamicdatashareddepth.yml | 8 +- .../iclientsidewebpartstatusrenderer.yml | 10 +- ...dynamicdatasharedpropertyconfiguration.yml | 4 +- .../idynamicdatasharedpropertyfilters.yml | 4 +- .../idynamicdatasharedsourceconfiguration.yml | 6 +- .../idynamicdatasharedsourcefilters.yml | 6 +- .../iplaceholderspinnerprops.yml | 6 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 12 +- .../ipropertypanebuttonprops.yml | 18 +-- .../ipropertypanecheckboxprops.yml | 8 +- .../ipropertypanechoicegroupoption.yml | 18 +-- ...propertypanechoicegroupoptioniconprops.yml | 4 +- .../ipropertypanechoicegroupprops.yml | 6 +- .../ipropertypaneconditionalgroup.yml | 12 +- .../ipropertypaneconfiguration.yml | 10 +- .../ipropertypanecustomfieldprops.yml | 12 +- .../ipropertypanedropdowncalloutprops.yml | 4 +- .../ipropertypanedropdownoption.yml | 10 +- .../ipropertypanedropdownprops.yml | 18 +-- .../ipropertypanedynamicfieldprops.yml | 10 +- .../ipropertypanedynamicfieldsetprops.yml | 8 +- .../ipropertypanedynamictextfieldprops.yml | 22 +-- .../sp-webpart-base/ipropertypanefield.yml | 10 +- .../sp-webpart-base/ipropertypanegroup.yml | 8 +- .../ipropertypanelabelprops.yml | 6 +- .../ipropertypanelinkprops.yml | 12 +- .../sp-webpart-base/ipropertypanepage.yml | 8 +- .../ipropertypanepageheader.yml | 6 +- .../ipropertypanesliderprops.yml | 18 +-- .../ipropertypanetextfieldprops.yml | 36 ++--- .../ipropertypanetoggleprops.yml | 18 +-- .../iserializedserverprocesseddata.yml | 10 +- .../iserializedwebpartdata.yml | 12 +- .../sp-webpart-base/iwebpartcontext.yml | 22 +-- SP-Framework/sp-webpart-base/iwebpartdata.yml | 20 +-- .../iwebpartpropertiesmetadata.yml | 4 +- .../iwebpartpropertymetadata.yml | 14 +- .../propertypanebuttontype.yml | 14 +- .../propertypanedropdownoptiontype.yml | 8 +- .../sp-webpart-base/propertypanefieldtype.yml | 32 ++--- .../sp-webpart-base/webpartcontext.yml | 8 +- .../sp-webpart-base/webpartformfactor.yml | 6 +- 196 files changed, 1198 insertions(+), 1198 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 19c4b3e9..0db6746d 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -7,7 +7,7 @@ items: using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This package is not intended to be a general toolkit of language extensions or helpful macros. name: '@microsoft/decorators' - fullName: decorators + fullName: '@microsoft/decorators' langs: - typeScript type: package @@ -21,7 +21,7 @@ items: another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. name: 'override(target, propertyKey, descriptor)' - fullName: decorators.override + fullName: override langs: - typeScript type: function @@ -52,7 +52,7 @@ items: inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. name: sealed(target) - fullName: decorators.sealed + fullName: sealed langs: - typeScript type: function @@ -74,7 +74,7 @@ items: then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. name: 'virtual(target, propertyKey, descriptor)' - fullName: decorators.virtual + fullName: virtual langs: - typeScript type: function diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index b61d8611..9bba1312 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -3,7 +3,7 @@ items: - uid: sp-application-base summary: SharePoint Framework support for building and extending client-side applications. name: '@microsoft/sp-application-base' - fullName: sp-application-base + fullName: '@microsoft/sp-application-base' langs: - typeScript type: package diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index ff47b35b..c65f51c3 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -15,7 +15,7 @@ items: subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications. name: ApplicationAccessor - fullName: sp-application-base.ApplicationAccessor + fullName: ApplicationAccessor langs: - typeScript type: class @@ -30,7 +30,7 @@ items: context, for example [BaseApplicationCustomizer.context](xref:sp-application-base.BaseApplicationCustomizer.context). name: constructor(serviceScope) - fullName: sp-application-base.ApplicationAccessor.constructor + fullName: constructor langs: - typeScript type: constructor @@ -45,7 +45,7 @@ items: summary: An event that is fired when the application's top-level page context navigates to a new page. remarks: 'This event fires after the top-level [PageContext](xref:sp-page-context.PageContext) has navigated to a new page.' name: navigatedEvent - fullName: sp-application-base.ApplicationAccessor.navigatedEvent + fullName: navigatedEvent langs: - typeScript type: event diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 9601a59d..c00a1daa 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ApplicationCustomizerContext class. name: ApplicationCustomizerContext - fullName: sp-application-base.ApplicationCustomizerContext + fullName: ApplicationCustomizerContext langs: - typeScript type: class @@ -20,7 +20,7 @@ items: - uid: sp-application-base.ApplicationCustomizerContext.application summary: Provides access to the client-side application that is currently running. name: application - fullName: sp-application-base.ApplicationCustomizerContext.application + fullName: application langs: - typeScript type: property @@ -31,7 +31,7 @@ items: - ApplicationAccessor - uid: sp-application-base.ApplicationCustomizerContext.dispose name: dispose() - fullName: sp-application-base.ApplicationCustomizerContext.dispose + fullName: dispose langs: - typeScript type: method @@ -46,7 +46,7 @@ items: - uid: sp-application-base.ApplicationCustomizerContext.placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. name: placeholderProvider - fullName: sp-application-base.ApplicationCustomizerContext.placeholderProvider + fullName: placeholderProvider langs: - typeScript type: property diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index d0384a65..3022f5e3 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -12,7 +12,7 @@ items: SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. name: BaseApplicationCustomizer - fullName: sp-application-base.BaseApplicationCustomizer + fullName: BaseApplicationCustomizer langs: - typeScript type: class @@ -30,7 +30,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-application-base.BaseApplicationCustomizer.context + fullName: context langs: - typeScript type: property @@ -46,7 +46,7 @@ items: for a web part or extension. To perform custom cleanup when your component is disposed, override the [BaseComponent.onDispose](xref:sp-component-base.BaseComponent.onDispose) method. name: dispose() - fullName: sp-application-base.BaseApplicationCustomizer.dispose + fullName: dispose langs: - typeScript type: method @@ -61,7 +61,7 @@ items: This event method is called when the placeholders of the host application change, come into existence, or disappear. name: onPlaceholdersChanged(placeholderProvider) - fullName: sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged + fullName: onPlaceholdersChanged langs: - typeScript type: method diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index fdbbab7b..faa3a299 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -5,7 +5,7 @@ items: Options for the [PlaceholderProvider.tryCreateContent](xref:sp-application-base.PlaceholderProvider.tryCreateContent) method. name: IPlaceholderCreateContentOptions - fullName: sp-application-base.IPlaceholderCreateContentOptions + fullName: IPlaceholderCreateContentOptions langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it. name: onDispose - fullName: sp-application-base.IPlaceholderCreateContentOptions.onDispose + fullName: onDispose langs: - typeScript type: property diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 3f880bda..3de7e03f 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -11,7 +11,7 @@ items: [PlaceholderProvider.tryCreateContent](xref:sp-application-base.PlaceholderProvider.tryCreateContent). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. name: PlaceholderContent - fullName: sp-application-base.PlaceholderContent + fullName: PlaceholderContent langs: - typeScript type: class @@ -32,7 +32,7 @@ items: [IPlaceholderCreateContentOptions.onDispose](xref:sp-application-base.IPlaceholderCreateContentOptions.onDispose) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. name: dispose() - fullName: sp-application-base.PlaceholderContent.dispose + fullName: dispose langs: - typeScript type: method @@ -49,7 +49,7 @@ items: [IPlaceholderCreateContentOptions.onDispose](xref:sp-application-base.IPlaceholderCreateContentOptions.onDispose) callback. name: domElement - fullName: sp-application-base.PlaceholderContent.domElement + fullName: domElement langs: - typeScript type: property @@ -60,7 +60,7 @@ items: - HTMLDivElement - uid: sp-application-base.PlaceholderContent.isDisposed name: isDisposed - fullName: sp-application-base.PlaceholderContent.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -74,7 +74,7 @@ items: Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. name: isVisible - fullName: sp-application-base.PlaceholderContent.isVisible + fullName: isVisible langs: - typeScript type: property @@ -87,7 +87,7 @@ items: summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' name: name - fullName: sp-application-base.PlaceholderContent.name + fullName: name langs: - typeScript type: property diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index e8e1ab9f..90e7d986 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -8,7 +8,7 @@ items: For more information about placeholders, see [PlaceholderProvider](xref:sp-application-base.PlaceholderProvider). name: PlaceholderName - fullName: sp-application-base.PlaceholderName + fullName: PlaceholderName langs: - typeScript type: enum @@ -19,7 +19,7 @@ items: - uid: sp-application-base.PlaceholderName.Bottom summary: A region at the bottom of the page. name: Bottom - fullName: sp-application-base.PlaceholderName.Bottom + fullName: Bottom langs: - typeScript type: field @@ -27,7 +27,7 @@ items: - uid: sp-application-base.PlaceholderName.Top summary: A region at the top of the page. name: Top - fullName: sp-application-base.PlaceholderName.Top + fullName: Top langs: - typeScript type: field diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 66de669c..5388f5ff 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -21,7 +21,7 @@ items: [PlaceholderProvider.changedEvent](xref:sp-application-base.PlaceholderProvider.changedEvent) event to discover when new placeholders appear. name: PlaceholderProvider - fullName: sp-application-base.PlaceholderProvider + fullName: PlaceholderProvider langs: - typeScript type: class @@ -41,7 +41,7 @@ items: placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear. name: changedEvent - fullName: sp-application-base.PlaceholderProvider.changedEvent + fullName: changedEvent langs: - typeScript type: event @@ -52,7 +52,7 @@ items: - SPEvent - uid: sp-application-base.PlaceholderProvider.dispose name: dispose() - fullName: sp-application-base.PlaceholderProvider.dispose + fullName: dispose langs: - typeScript type: method @@ -64,7 +64,7 @@ items: description: '' - uid: sp-application-base.PlaceholderProvider.isDisposed name: isDisposed - fullName: sp-application-base.PlaceholderProvider.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -76,7 +76,7 @@ items: - uid: sp-application-base.PlaceholderProvider.placeholderNames summary: Returns the names of the currently available placeholders. name: placeholderNames - fullName: sp-application-base.PlaceholderProvider.placeholderNames + fullName: placeholderNames langs: - typeScript type: property @@ -94,7 +94,7 @@ items: expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. name: 'tryCreateContent(name, options)' - fullName: sp-application-base.PlaceholderProvider.tryCreateContent + fullName: tryCreateContent langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 3e05b18e..e32baa4c 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -7,7 +7,7 @@ items: applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types. name: '@microsoft/sp-component-base' - fullName: sp-component-base + fullName: '@microsoft/sp-component-base' langs: - typeScript type: package diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index b3f80804..38a9c7f0 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponent class. name: BaseComponent - fullName: sp-component-base.BaseComponent + fullName: BaseComponent langs: - typeScript type: class @@ -28,7 +28,7 @@ items: may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value. name: componentId - fullName: sp-component-base.BaseComponent.componentId + fullName: componentId langs: - typeScript type: property @@ -44,7 +44,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-component-base.BaseComponent.context + fullName: context langs: - typeScript type: property @@ -60,7 +60,7 @@ items: for a web part or extension. To perform custom cleanup when your component is disposed, override the [BaseComponent.onDispose](xref:sp-component-base.BaseComponent.onDispose) method. name: dispose() - fullName: sp-component-base.BaseComponent.dispose + fullName: dispose langs: - typeScript type: method @@ -77,7 +77,7 @@ items: web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. name: instanceId - fullName: sp-component-base.BaseComponent.instanceId + fullName: instanceId langs: - typeScript type: property @@ -89,7 +89,7 @@ items: - uid: sp-component-base.BaseComponent.isDisposed summary: Returns true if the component has been already disposed. name: isDisposed - fullName: sp-component-base.BaseComponent.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -102,7 +102,7 @@ items: summary: Provides access to the manifest for the client-side component. remarks: Child classes can override this with more specialized manifest types. name: manifest - fullName: sp-component-base.BaseComponent.manifest + fullName: manifest langs: - typeScript type: property @@ -116,7 +116,7 @@ items: This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. name: onDispose() - fullName: sp-component-base.BaseComponent.onDispose + fullName: onDispose langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 55cf04d5..6e994242 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -11,7 +11,7 @@ items: business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. name: BaseComponentContext - fullName: sp-component-base.BaseComponentContext + fullName: BaseComponentContext langs: - typeScript type: class @@ -36,7 +36,7 @@ items: - uid: sp-component-base.BaseComponentContext.aadHttpClientFactory summary: The instance of AadHttpClientFactory created for this instance of component name: aadHttpClientFactory - fullName: sp-component-base.BaseComponentContext.aadHttpClientFactory + fullName: aadHttpClientFactory langs: - typeScript type: property @@ -48,7 +48,7 @@ items: - uid: sp-component-base.BaseComponentContext.aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component name: aadTokenProviderFactory - fullName: sp-component-base.BaseComponentContext.aadTokenProviderFactory + fullName: aadTokenProviderFactory langs: - typeScript type: property @@ -60,7 +60,7 @@ items: - uid: sp-component-base.BaseComponentContext.dispose summary: Disposes the base component context. name: dispose() - fullName: sp-component-base.BaseComponentContext.dispose + fullName: dispose langs: - typeScript type: method @@ -73,7 +73,7 @@ items: - uid: sp-component-base.BaseComponentContext.dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. name: dynamicDataProvider - fullName: sp-component-base.BaseComponentContext.dynamicDataProvider + fullName: dynamicDataProvider langs: - typeScript type: property @@ -85,7 +85,7 @@ items: - uid: sp-component-base.BaseComponentContext.dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. name: dynamicDataSourceManager - fullName: sp-component-base.BaseComponentContext.dynamicDataSourceManager + fullName: dynamicDataSourceManager langs: - typeScript type: property @@ -103,7 +103,7 @@ items: instead isPreview: true name: graphHttpClient - fullName: sp-component-base.BaseComponentContext.graphHttpClient + fullName: graphHttpClient langs: - typeScript type: property @@ -115,7 +115,7 @@ items: - uid: sp-component-base.BaseComponentContext.httpClient summary: The instance of HttpClient created for this instance of component name: httpClient - fullName: sp-component-base.BaseComponentContext.httpClient + fullName: httpClient langs: - typeScript type: property @@ -131,7 +131,7 @@ items: web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. name: instanceId - fullName: sp-component-base.BaseComponentContext.instanceId + fullName: instanceId langs: - typeScript type: property @@ -143,7 +143,7 @@ items: - uid: sp-component-base.BaseComponentContext.isDisposed summary: Returns true if the context is disposed. name: isDisposed - fullName: sp-component-base.BaseComponentContext.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -155,7 +155,7 @@ items: - uid: sp-component-base.BaseComponentContext.manifest summary: Manifest for the client-side component. name: manifest - fullName: sp-component-base.BaseComponentContext.manifest + fullName: manifest langs: - typeScript type: property @@ -167,7 +167,7 @@ items: - uid: sp-component-base.BaseComponentContext.msGraphClientFactory summary: The instance of MSGraphClientFactory created for this instance of component name: msGraphClientFactory - fullName: sp-component-base.BaseComponentContext.msGraphClientFactory + fullName: msGraphClientFactory langs: - typeScript type: property @@ -181,7 +181,7 @@ items: The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. name: pageContext - fullName: sp-component-base.BaseComponentContext.pageContext + fullName: pageContext langs: - typeScript type: property @@ -194,7 +194,7 @@ items: summary: 'The associated [ServiceScope](xref:sp-core-library.ServiceScope) for this component.' remarks: A child service scope is created for each client-side component. name: serviceScope - fullName: sp-component-base.BaseComponentContext.serviceScope + fullName: serviceScope langs: - typeScript type: property @@ -206,7 +206,7 @@ items: - uid: sp-component-base.BaseComponentContext.spHttpClient summary: The instance of SpHttpClient created for this instance of component name: spHttpClient - fullName: sp-component-base.BaseComponentContext.spHttpClient + fullName: spHttpClient langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 52c9d24d..36af8045 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -5,7 +5,7 @@ items: The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. name: DynamicDataProvider - fullName: sp-component-base.DynamicDataProvider + fullName: DynamicDataProvider langs: - typeScript type: class @@ -26,7 +26,7 @@ items: - uid: sp-component-base.DynamicDataProvider.dispose summary: Disposes the Dynamic Data Provider. name: dispose() - fullName: sp-component-base.DynamicDataProvider.dispose + fullName: dispose langs: - typeScript type: method @@ -39,7 +39,7 @@ items: - uid: sp-component-base.DynamicDataProvider.getAvailableSources summary: Returns a list with all available Dynamic Data Sources. name: getAvailableSources() - fullName: sp-component-base.DynamicDataProvider.getAvailableSources + fullName: getAvailableSources langs: - typeScript type: method @@ -52,7 +52,7 @@ items: - uid: sp-component-base.DynamicDataProvider.isDisposed summary: Returns true if the Dynamic Data Provider is disposed. name: isDisposed - fullName: sp-component-base.DynamicDataProvider.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -64,7 +64,7 @@ items: - uid: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. name: registerAvailableSourcesChanged(callback) - fullName: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged + fullName: registerAvailableSourcesChanged langs: - typeScript type: method @@ -82,7 +82,7 @@ items: - uid: sp-component-base.DynamicDataProvider.registerPropertyChanged summary: Registers a callback for updates when a property is changed in a Dynamic Data source. name: 'registerPropertyChanged(sourceId, propertyId, callback)' - fullName: sp-component-base.DynamicDataProvider.registerPropertyChanged + fullName: registerPropertyChanged langs: - typeScript type: method @@ -110,7 +110,7 @@ items: Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. name: 'registerSourceChanged(sourceId, callback)' - fullName: sp-component-base.DynamicDataProvider.registerSourceChanged + fullName: registerSourceChanged langs: - typeScript type: method @@ -132,7 +132,7 @@ items: - uid: sp-component-base.DynamicDataProvider.tryGetSource summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' name: tryGetSource(id) - fullName: sp-component-base.DynamicDataProvider.tryGetSource + fullName: tryGetSource langs: - typeScript type: method @@ -150,7 +150,7 @@ items: - uid: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. name: unregisterAvailableSourcesChanged(callback) - fullName: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged + fullName: unregisterAvailableSourcesChanged langs: - typeScript type: method @@ -168,7 +168,7 @@ items: - uid: sp-component-base.DynamicDataProvider.unregisterPropertyChanged summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - fullName: sp-component-base.DynamicDataProvider.unregisterPropertyChanged + fullName: unregisterPropertyChanged langs: - typeScript type: method @@ -194,7 +194,7 @@ items: - uid: sp-component-base.DynamicDataProvider.unregisterSourceChanged summary: Unregisters a callback for updates when a Dynamic Data source is changed. name: 'unregisterSourceChanged(sourceId, callback)' - fullName: sp-component-base.DynamicDataProvider.unregisterSourceChanged + fullName: unregisterSourceChanged langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 5514310c..6a0c87cf 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -6,7 +6,7 @@ items: initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated. name: DynamicDataSourceManager - fullName: sp-component-base.DynamicDataSourceManager + fullName: DynamicDataSourceManager langs: - typeScript type: class @@ -24,7 +24,7 @@ items: - uid: sp-component-base.DynamicDataSourceManager.dispose summary: Disposes the resources held by the Dynamic Data source. name: dispose() - fullName: sp-component-base.DynamicDataSourceManager.dispose + fullName: dispose langs: - typeScript type: method @@ -37,7 +37,7 @@ items: - uid: sp-component-base.DynamicDataSourceManager.initializeSource summary: Initializes the Dynamic Data Source for the component. name: initializeSource(callableFunctions) - fullName: sp-component-base.DynamicDataSourceManager.initializeSource + fullName: initializeSource langs: - typeScript type: method @@ -55,7 +55,7 @@ items: - uid: sp-component-base.DynamicDataSourceManager.isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. name: isDisposed - fullName: sp-component-base.DynamicDataSourceManager.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -72,7 +72,7 @@ items: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. name: notifyPropertyChanged(propertyId) - fullName: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged + fullName: notifyPropertyChanged langs: - typeScript type: method @@ -95,7 +95,7 @@ items: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. name: notifySourceChanged() - fullName: sp-component-base.DynamicDataSourceManager.notifySourceChanged + fullName: notifySourceChanged langs: - typeScript type: method @@ -108,7 +108,7 @@ items: - uid: sp-component-base.DynamicDataSourceManager.sourceId summary: Returns the Id of the current DataSource. name: sourceId - fullName: sp-component-base.DynamicDataSourceManager.sourceId + fullName: sourceId langs: - typeScript type: property @@ -122,7 +122,7 @@ items: Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. name: updateMetadata(metadata) - fullName: sp-component-base.DynamicDataSourceManager.updateMetadata + fullName: updateMetadata langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 6c1f44a1..759c2ce5 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -7,7 +7,7 @@ items: default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically. name: DynamicProperty - fullName: sp-component-base.DynamicProperty + fullName: DynamicProperty langs: - typeScript type: class @@ -31,7 +31,7 @@ items: - uid: sp-component-base.DynamicProperty.constructor summary: Create a new DynamicProperty object. name: 'constructor(provider, callback)' - fullName: sp-component-base.DynamicProperty.constructor + fullName: constructor langs: - typeScript type: constructor @@ -50,7 +50,7 @@ items: summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: dispose() - fullName: sp-component-base.DynamicProperty.dispose + fullName: dispose langs: - typeScript type: method @@ -63,7 +63,7 @@ items: - uid: sp-component-base.DynamicProperty.hasDefaultCallback summary: Returns true if the object has a default callback. name: hasDefaultCallback() - fullName: sp-component-base.DynamicProperty.hasDefaultCallback + fullName: hasDefaultCallback langs: - typeScript type: method @@ -79,7 +79,7 @@ items: permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: isDisposed - fullName: sp-component-base.DynamicProperty.isDisposed + fullName: isDisposed langs: - typeScript type: property @@ -94,7 +94,7 @@ items: `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' name: reference - fullName: sp-component-base.DynamicProperty.reference + fullName: reference langs: - typeScript type: property @@ -106,7 +106,7 @@ items: - uid: sp-component-base.DynamicProperty.register summary: Registers a callback function for updates on the associated DynamicDataSource. name: register(callback) - fullName: sp-component-base.DynamicProperty.register + fullName: register langs: - typeScript type: method @@ -125,7 +125,7 @@ items: summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. name: removeDefaultCallback() - fullName: sp-component-base.DynamicProperty.removeDefaultCallback + fullName: removeDefaultCallback langs: - typeScript type: method @@ -140,7 +140,7 @@ items: Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. name: setReference(reference) - fullName: sp-component-base.DynamicProperty.setReference + fullName: setReference langs: - typeScript type: method @@ -158,7 +158,7 @@ items: - uid: sp-component-base.DynamicProperty.setValue summary: Sets a static value in the DynamicProperty. name: setValue(value) - fullName: sp-component-base.DynamicProperty.setValue + fullName: setValue langs: - typeScript type: method @@ -178,7 +178,7 @@ items: Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. name: tryGetSource() - fullName: sp-component-base.DynamicProperty.tryGetSource + fullName: tryGetSource langs: - typeScript type: method @@ -198,7 +198,7 @@ items: NOTE: This api will never return an array. To retrieve an array value, use the [DynamicProperty.tryGetValues](xref:sp-component-base.DynamicProperty.tryGetValues) API. name: tryGetValue() - fullName: sp-component-base.DynamicProperty.tryGetValue + fullName: tryGetValue langs: - typeScript type: method @@ -218,7 +218,7 @@ items: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the [DynamicProperty.tryGetValue](xref:sp-component-base.DynamicProperty.tryGetValue) API. name: tryGetValues() - fullName: sp-component-base.DynamicProperty.tryGetValues + fullName: tryGetValues langs: - typeScript type: method @@ -233,7 +233,7 @@ items: Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. name: unregister(callback) - fullName: sp-component-base.DynamicProperty.unregister + fullName: unregister langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/ifontstyles.yml b/SP-Framework/sp-component-base/ifontstyles.yml index 265dc107..43cce5d6 100644 --- a/SP-Framework/sp-component-base/ifontstyles.yml +++ b/SP-Framework/sp-component-base/ifontstyles.yml @@ -4,7 +4,7 @@ items: summary: Font styles for different sizes. isPreview: true name: IFontStyles - fullName: sp-component-base.IFontStyles + fullName: IFontStyles langs: - typeScript type: interface @@ -25,7 +25,7 @@ items: summary: Large font style. isPreview: true name: large - fullName: sp-component-base.IFontStyles.large + fullName: large langs: - typeScript type: property @@ -38,7 +38,7 @@ items: summary: Medium font style. isPreview: true name: medium - fullName: sp-component-base.IFontStyles.medium + fullName: medium langs: - typeScript type: property @@ -51,7 +51,7 @@ items: summary: Larger than medium but smaller than large font style. isPreview: true name: mediumPlus - fullName: sp-component-base.IFontStyles.mediumPlus + fullName: mediumPlus langs: - typeScript type: property @@ -64,7 +64,7 @@ items: summary: Mega sized font style. isPreview: true name: mega - fullName: sp-component-base.IFontStyles.mega + fullName: mega langs: - typeScript type: property @@ -77,7 +77,7 @@ items: summary: Small font style. isPreview: true name: small - fullName: sp-component-base.IFontStyles.small + fullName: small langs: - typeScript type: property @@ -90,7 +90,7 @@ items: summary: Larger than small but smaller than medium font style. isPreview: true name: smallPlus - fullName: sp-component-base.IFontStyles.smallPlus + fullName: smallPlus langs: - typeScript type: property @@ -103,7 +103,7 @@ items: summary: Super large font style. isPreview: true name: superLarge - fullName: sp-component-base.IFontStyles.superLarge + fullName: superLarge langs: - typeScript type: property @@ -116,7 +116,7 @@ items: summary: Tiny font style. isPreview: true name: tiny - fullName: sp-component-base.IFontStyles.tiny + fullName: tiny langs: - typeScript type: property @@ -129,7 +129,7 @@ items: summary: Extra large font style. isPreview: true name: xLarge - fullName: sp-component-base.IFontStyles.xLarge + fullName: xLarge langs: - typeScript type: property @@ -142,7 +142,7 @@ items: summary: Extra small font style. isPreview: true name: xSmall - fullName: sp-component-base.IFontStyles.xSmall + fullName: xSmall langs: - typeScript type: property @@ -155,7 +155,7 @@ items: summary: Extra extra large font style. isPreview: true name: xxLarge - fullName: sp-component-base.IFontStyles.xxLarge + fullName: xxLarge langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/ipalette.yml b/SP-Framework/sp-component-base/ipalette.yml index a73e53f6..556914e8 100644 --- a/SP-Framework/sp-component-base/ipalette.yml +++ b/SP-Framework/sp-component-base/ipalette.yml @@ -4,7 +4,7 @@ items: summary: Color palette. isPreview: true name: IPalette - fullName: sp-component-base.IPalette + fullName: IPalette langs: - typeScript type: interface @@ -62,7 +62,7 @@ items: summary: Color code for the accent. isPreview: true name: accent - fullName: sp-component-base.IPalette.accent + fullName: accent langs: - typeScript type: property @@ -77,7 +77,7 @@ items: themes. isPreview: true name: black - fullName: sp-component-base.IPalette.black + fullName: black langs: - typeScript type: property @@ -90,7 +90,7 @@ items: summary: Color code for blackTranslucent40. isPreview: true name: blackTranslucent40 - fullName: sp-component-base.IPalette.blackTranslucent40 + fullName: blackTranslucent40 langs: - typeScript type: property @@ -103,7 +103,7 @@ items: summary: Color code for blue. isPreview: true name: blue - fullName: sp-component-base.IPalette.blue + fullName: blue langs: - typeScript type: property @@ -116,7 +116,7 @@ items: summary: Color code for blueDark. isPreview: true name: blueDark - fullName: sp-component-base.IPalette.blueDark + fullName: blueDark langs: - typeScript type: property @@ -129,7 +129,7 @@ items: summary: Color code for blueLight. isPreview: true name: blueLight - fullName: sp-component-base.IPalette.blueLight + fullName: blueLight langs: - typeScript type: property @@ -142,7 +142,7 @@ items: summary: Color code for blueMid. isPreview: true name: blueMid - fullName: sp-component-base.IPalette.blueMid + fullName: blueMid langs: - typeScript type: property @@ -155,7 +155,7 @@ items: summary: Color code for green. isPreview: true name: green - fullName: sp-component-base.IPalette.green + fullName: green langs: - typeScript type: property @@ -168,7 +168,7 @@ items: summary: Color code for greenDark. isPreview: true name: greenDark - fullName: sp-component-base.IPalette.greenDark + fullName: greenDark langs: - typeScript type: property @@ -181,7 +181,7 @@ items: summary: Color code for greenLight. isPreview: true name: greenLight - fullName: sp-component-base.IPalette.greenLight + fullName: greenLight langs: - typeScript type: property @@ -194,7 +194,7 @@ items: summary: Color code for magenta. isPreview: true name: magenta - fullName: sp-component-base.IPalette.magenta + fullName: magenta langs: - typeScript type: property @@ -207,7 +207,7 @@ items: summary: Color code for magentaDark. isPreview: true name: magentaDark - fullName: sp-component-base.IPalette.magentaDark + fullName: magentaDark langs: - typeScript type: property @@ -220,7 +220,7 @@ items: summary: Color code for magentaLight. isPreview: true name: magentaLight - fullName: sp-component-base.IPalette.magentaLight + fullName: magentaLight langs: - typeScript type: property @@ -233,7 +233,7 @@ items: summary: Color code for neutralDark. isPreview: true name: neutralDark - fullName: sp-component-base.IPalette.neutralDark + fullName: neutralDark langs: - typeScript type: property @@ -246,7 +246,7 @@ items: summary: Color code for neutralLight. isPreview: true name: neutralLight - fullName: sp-component-base.IPalette.neutralLight + fullName: neutralLight langs: - typeScript type: property @@ -259,7 +259,7 @@ items: summary: Color code for neutralLighter. isPreview: true name: neutralLighter - fullName: sp-component-base.IPalette.neutralLighter + fullName: neutralLighter langs: - typeScript type: property @@ -272,7 +272,7 @@ items: summary: Color code for neutralLighterAlt. isPreview: true name: neutralLighterAlt - fullName: sp-component-base.IPalette.neutralLighterAlt + fullName: neutralLighterAlt langs: - typeScript type: property @@ -285,7 +285,7 @@ items: summary: Color code for neutralPrimary. isPreview: true name: neutralPrimary - fullName: sp-component-base.IPalette.neutralPrimary + fullName: neutralPrimary langs: - typeScript type: property @@ -298,7 +298,7 @@ items: summary: Color code for neutralPrimaryAlt. isPreview: true name: neutralPrimaryAlt - fullName: sp-component-base.IPalette.neutralPrimaryAlt + fullName: neutralPrimaryAlt langs: - typeScript type: property @@ -311,7 +311,7 @@ items: summary: Color code for neutralQuaternary. isPreview: true name: neutralQuaternary - fullName: sp-component-base.IPalette.neutralQuaternary + fullName: neutralQuaternary langs: - typeScript type: property @@ -324,7 +324,7 @@ items: summary: Color code for neutralQuaternaryAlt. isPreview: true name: neutralQuaternaryAlt - fullName: sp-component-base.IPalette.neutralQuaternaryAlt + fullName: neutralQuaternaryAlt langs: - typeScript type: property @@ -337,7 +337,7 @@ items: summary: Color code for neutralSecondary. isPreview: true name: neutralSecondary - fullName: sp-component-base.IPalette.neutralSecondary + fullName: neutralSecondary langs: - typeScript type: property @@ -350,7 +350,7 @@ items: summary: Color code for neutralTertiary. isPreview: true name: neutralTertiary - fullName: sp-component-base.IPalette.neutralTertiary + fullName: neutralTertiary langs: - typeScript type: property @@ -363,7 +363,7 @@ items: summary: Color code for neutralTertiaryAlt. isPreview: true name: neutralTertiaryAlt - fullName: sp-component-base.IPalette.neutralTertiaryAlt + fullName: neutralTertiaryAlt langs: - typeScript type: property @@ -376,7 +376,7 @@ items: summary: Color code for orange. isPreview: true name: orange - fullName: sp-component-base.IPalette.orange + fullName: orange langs: - typeScript type: property @@ -389,7 +389,7 @@ items: summary: Color code for orangeLight. isPreview: true name: orangeLight - fullName: sp-component-base.IPalette.orangeLight + fullName: orangeLight langs: - typeScript type: property @@ -402,7 +402,7 @@ items: summary: Color code for orangeLighter. isPreview: true name: orangeLighter - fullName: sp-component-base.IPalette.orangeLighter + fullName: orangeLighter langs: - typeScript type: property @@ -415,7 +415,7 @@ items: summary: Color code for purple. isPreview: true name: purple - fullName: sp-component-base.IPalette.purple + fullName: purple langs: - typeScript type: property @@ -428,7 +428,7 @@ items: summary: Color code for purpleDark. isPreview: true name: purpleDark - fullName: sp-component-base.IPalette.purpleDark + fullName: purpleDark langs: - typeScript type: property @@ -441,7 +441,7 @@ items: summary: Color code for purpleLight. isPreview: true name: purpleLight - fullName: sp-component-base.IPalette.purpleLight + fullName: purpleLight langs: - typeScript type: property @@ -454,7 +454,7 @@ items: summary: Color code for red. isPreview: true name: red - fullName: sp-component-base.IPalette.red + fullName: red langs: - typeScript type: property @@ -467,7 +467,7 @@ items: summary: Color code for redDark. isPreview: true name: redDark - fullName: sp-component-base.IPalette.redDark + fullName: redDark langs: - typeScript type: property @@ -480,7 +480,7 @@ items: summary: Color code for teal. isPreview: true name: teal - fullName: sp-component-base.IPalette.teal + fullName: teal langs: - typeScript type: property @@ -493,7 +493,7 @@ items: summary: Color code for tealDark. isPreview: true name: tealDark - fullName: sp-component-base.IPalette.tealDark + fullName: tealDark langs: - typeScript type: property @@ -506,7 +506,7 @@ items: summary: Color code for tealLight. isPreview: true name: tealLight - fullName: sp-component-base.IPalette.tealLight + fullName: tealLight langs: - typeScript type: property @@ -519,7 +519,7 @@ items: summary: Color code for themeDark. isPreview: true name: themeDark - fullName: sp-component-base.IPalette.themeDark + fullName: themeDark langs: - typeScript type: property @@ -532,7 +532,7 @@ items: summary: Color code for themeDarkAlt. isPreview: true name: themeDarkAlt - fullName: sp-component-base.IPalette.themeDarkAlt + fullName: themeDarkAlt langs: - typeScript type: property @@ -545,7 +545,7 @@ items: summary: Color code for themeDarker. isPreview: true name: themeDarker - fullName: sp-component-base.IPalette.themeDarker + fullName: themeDarker langs: - typeScript type: property @@ -558,7 +558,7 @@ items: summary: Color code for themeLight. isPreview: true name: themeLight - fullName: sp-component-base.IPalette.themeLight + fullName: themeLight langs: - typeScript type: property @@ -571,7 +571,7 @@ items: summary: Color code for themeLighter. isPreview: true name: themeLighter - fullName: sp-component-base.IPalette.themeLighter + fullName: themeLighter langs: - typeScript type: property @@ -584,7 +584,7 @@ items: summary: Color code for themeLighterAlt. isPreview: true name: themeLighterAlt - fullName: sp-component-base.IPalette.themeLighterAlt + fullName: themeLighterAlt langs: - typeScript type: property @@ -597,7 +597,7 @@ items: summary: Color code for themePrimary. isPreview: true name: themePrimary - fullName: sp-component-base.IPalette.themePrimary + fullName: themePrimary langs: - typeScript type: property @@ -610,7 +610,7 @@ items: summary: Color code for themeSecondary. isPreview: true name: themeSecondary - fullName: sp-component-base.IPalette.themeSecondary + fullName: themeSecondary langs: - typeScript type: property @@ -623,7 +623,7 @@ items: summary: Color code for themeTertiary. isPreview: true name: themeTertiary - fullName: sp-component-base.IPalette.themeTertiary + fullName: themeTertiary langs: - typeScript type: property @@ -638,7 +638,7 @@ items: This is the page background. isPreview: true name: white - fullName: sp-component-base.IPalette.white + fullName: white langs: - typeScript type: property @@ -651,7 +651,7 @@ items: summary: Color code for whiteTranslucent40 isPreview: true name: whiteTranslucent40 - fullName: sp-component-base.IPalette.whiteTranslucent40 + fullName: whiteTranslucent40 langs: - typeScript type: property @@ -664,7 +664,7 @@ items: summary: Color code for yellow. isPreview: true name: yellow - fullName: sp-component-base.IPalette.yellow + fullName: yellow langs: - typeScript type: property @@ -677,7 +677,7 @@ items: summary: Color code for yellowLight. isPreview: true name: yellowLight - fullName: sp-component-base.IPalette.yellowLight + fullName: yellowLight langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 751fae63..783120ea 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -4,7 +4,7 @@ items: summary: Font styles for different sizes. isPreview: true name: IReadonlyFontStyles - fullName: sp-component-base.IReadonlyFontStyles + fullName: IReadonlyFontStyles langs: - typeScript type: interface @@ -25,7 +25,7 @@ items: summary: Large font style. isPreview: true name: large - fullName: sp-component-base.IReadonlyFontStyles.large + fullName: large langs: - typeScript type: property @@ -38,7 +38,7 @@ items: summary: Medium font style. isPreview: true name: medium - fullName: sp-component-base.IReadonlyFontStyles.medium + fullName: medium langs: - typeScript type: property @@ -51,7 +51,7 @@ items: summary: Larger than medium but smaller than large font style. isPreview: true name: mediumPlus - fullName: sp-component-base.IReadonlyFontStyles.mediumPlus + fullName: mediumPlus langs: - typeScript type: property @@ -64,7 +64,7 @@ items: summary: Mega sized font style. isPreview: true name: mega - fullName: sp-component-base.IReadonlyFontStyles.mega + fullName: mega langs: - typeScript type: property @@ -77,7 +77,7 @@ items: summary: Small font style. isPreview: true name: small - fullName: sp-component-base.IReadonlyFontStyles.small + fullName: small langs: - typeScript type: property @@ -90,7 +90,7 @@ items: summary: Larger than small but smaller than medium font style. isPreview: true name: smallPlus - fullName: sp-component-base.IReadonlyFontStyles.smallPlus + fullName: smallPlus langs: - typeScript type: property @@ -103,7 +103,7 @@ items: summary: Super large font style. isPreview: true name: superLarge - fullName: sp-component-base.IReadonlyFontStyles.superLarge + fullName: superLarge langs: - typeScript type: property @@ -116,7 +116,7 @@ items: summary: Tiny font style. isPreview: true name: tiny - fullName: sp-component-base.IReadonlyFontStyles.tiny + fullName: tiny langs: - typeScript type: property @@ -129,7 +129,7 @@ items: summary: Extra large font style. isPreview: true name: xLarge - fullName: sp-component-base.IReadonlyFontStyles.xLarge + fullName: xLarge langs: - typeScript type: property @@ -142,7 +142,7 @@ items: summary: Extra small font style. isPreview: true name: xSmall - fullName: sp-component-base.IReadonlyFontStyles.xSmall + fullName: xSmall langs: - typeScript type: property @@ -155,7 +155,7 @@ items: summary: Extra extra large font style. isPreview: true name: xxLarge - fullName: sp-component-base.IReadonlyFontStyles.xxLarge + fullName: xxLarge langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 65064e14..4cb4deb7 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -4,7 +4,7 @@ items: summary: Immutable ITheme. isPreview: true name: IReadonlyTheme - fullName: sp-component-base.IReadonlyTheme + fullName: IReadonlyTheme langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: summary: Font styles for different sizes. isPreview: true name: fonts - fullName: sp-component-base.IReadonlyTheme.fonts + fullName: fonts langs: - typeScript type: property @@ -32,7 +32,7 @@ items: summary: Color palette. isPreview: true name: palette - fullName: sp-component-base.IReadonlyTheme.palette + fullName: palette langs: - typeScript type: property @@ -45,7 +45,7 @@ items: summary: The collection of all semantic slots for colors used in themes. isPreview: true name: semanticColors - fullName: sp-component-base.IReadonlyTheme.semanticColors + fullName: semanticColors langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/isemanticcolors.yml b/SP-Framework/sp-component-base/isemanticcolors.yml index 3038b554..b233384a 100644 --- a/SP-Framework/sp-component-base/isemanticcolors.yml +++ b/SP-Framework/sp-component-base/isemanticcolors.yml @@ -65,7 +65,7 @@ items: one-item-per-row lists (like DetailsList) or ones with a tiled layout. isPreview: true name: ISemanticColors - fullName: sp-component-base.ISemanticColors + fullName: ISemanticColors langs: - typeScript type: interface @@ -141,7 +141,7 @@ items: summary: Neutral colored links and links for action buttons. isPreview: true name: actionLink - fullName: sp-component-base.ISemanticColors.actionLink + fullName: actionLink langs: - typeScript type: property @@ -154,7 +154,7 @@ items: summary: Hover state for neutral colored links and links for action buttons. isPreview: true name: actionLinkHovered - fullName: sp-component-base.ISemanticColors.actionLinkHovered + fullName: actionLinkHovered langs: - typeScript type: property @@ -167,7 +167,7 @@ items: summary: 'Background for blocking issues, which is more severe than a warning, but not as bad as an error.' isPreview: true name: blockingBackground - fullName: sp-component-base.ISemanticColors.blockingBackground + fullName: blockingBackground langs: - typeScript type: property @@ -180,7 +180,7 @@ items: summary: The default color for backgrounds. isPreview: true name: bodyBackground - fullName: sp-component-base.ISemanticColors.bodyBackground + fullName: bodyBackground langs: - typeScript type: property @@ -193,7 +193,7 @@ items: summary: 'Divider lines; e.g. lines that separate sections in a menu, an
element.' isPreview: true name: bodyDivider - fullName: sp-component-base.ISemanticColors.bodyDivider + fullName: bodyDivider langs: - typeScript type: property @@ -209,7 +209,7 @@ items: color of bodyBackground. See also: bodyFrameDivider isPreview: true name: bodyFrameBackground - fullName: sp-component-base.ISemanticColors.bodyFrameBackground + fullName: bodyFrameBackground langs: - typeScript type: property @@ -225,7 +225,7 @@ items: disappear. See also: bodyFrameBackground isPreview: true name: bodyFrameDivider - fullName: sp-component-base.ISemanticColors.bodyFrameDivider + fullName: bodyFrameDivider langs: - typeScript type: property @@ -241,7 +241,7 @@ items: inverted themes. isPreview: true name: bodyStandoutBackground - fullName: sp-component-base.ISemanticColors.bodyStandoutBackground + fullName: bodyStandoutBackground langs: - typeScript type: property @@ -254,7 +254,7 @@ items: summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' isPreview: true name: bodySubtext - fullName: sp-component-base.ISemanticColors.bodySubtext + fullName: bodySubtext langs: - typeScript type: property @@ -267,7 +267,7 @@ items: summary: The default color for text. isPreview: true name: bodyText - fullName: sp-component-base.ISemanticColors.bodyText + fullName: bodyText langs: - typeScript type: property @@ -280,7 +280,7 @@ items: summary: 'Checked text color, e.g. selected menu item text.' isPreview: true name: bodyTextChecked - fullName: sp-component-base.ISemanticColors.bodyTextChecked + fullName: bodyTextChecked langs: - typeScript type: property @@ -293,7 +293,7 @@ items: summary: Background of a standard button isPreview: true name: buttonBackground - fullName: sp-component-base.ISemanticColors.buttonBackground + fullName: buttonBackground langs: - typeScript type: property @@ -306,7 +306,7 @@ items: summary: Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar isPreview: true name: buttonBackgroundChecked - fullName: sp-component-base.ISemanticColors.buttonBackgroundChecked + fullName: buttonBackgroundChecked langs: - typeScript type: property @@ -319,7 +319,7 @@ items: summary: Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar isPreview: true name: buttonBackgroundCheckedHovered - fullName: sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered + fullName: buttonBackgroundCheckedHovered langs: - typeScript type: property @@ -332,7 +332,7 @@ items: summary: Background of a hovered standard button isPreview: true name: buttonBackgroundHovered - fullName: sp-component-base.ISemanticColors.buttonBackgroundHovered + fullName: buttonBackgroundHovered langs: - typeScript type: property @@ -345,7 +345,7 @@ items: summary: Background of a pressed standard button; i.e. currently being clicked by mouse isPreview: true name: buttonBackgroundPressed - fullName: sp-component-base.ISemanticColors.buttonBackgroundPressed + fullName: buttonBackgroundPressed langs: - typeScript type: property @@ -358,7 +358,7 @@ items: summary: Border of a standard button isPreview: true name: buttonBorder - fullName: sp-component-base.ISemanticColors.buttonBorder + fullName: buttonBorder langs: - typeScript type: property @@ -371,7 +371,7 @@ items: summary: Border of a disabled standard button isPreview: true name: buttonBorderDisabled - fullName: sp-component-base.ISemanticColors.buttonBorderDisabled + fullName: buttonBorderDisabled langs: - typeScript type: property @@ -384,7 +384,7 @@ items: summary: Color of text in a standard button isPreview: true name: buttonText - fullName: sp-component-base.ISemanticColors.buttonText + fullName: buttonText langs: - typeScript type: property @@ -397,7 +397,7 @@ items: summary: Color of text in a checked standard button isPreview: true name: buttonTextChecked - fullName: sp-component-base.ISemanticColors.buttonTextChecked + fullName: buttonTextChecked langs: - typeScript type: property @@ -410,7 +410,7 @@ items: summary: Color of text in a checked and hovered standard button isPreview: true name: buttonTextCheckedHovered - fullName: sp-component-base.ISemanticColors.buttonTextCheckedHovered + fullName: buttonTextCheckedHovered langs: - typeScript type: property @@ -423,7 +423,7 @@ items: summary: Color of text in a disabled standard button isPreview: true name: buttonTextDisabled - fullName: sp-component-base.ISemanticColors.buttonTextDisabled + fullName: buttonTextDisabled langs: - typeScript type: property @@ -436,7 +436,7 @@ items: summary: Color of text in a hovered standard button isPreview: true name: buttonTextHovered - fullName: sp-component-base.ISemanticColors.buttonTextHovered + fullName: buttonTextHovered langs: - typeScript type: property @@ -449,7 +449,7 @@ items: summary: Color of text in a pressed standard button; i.e. currently being clicked by mouse isPreview: true name: buttonTextPressed - fullName: sp-component-base.ISemanticColors.buttonTextPressed + fullName: buttonTextPressed langs: - typeScript type: property @@ -462,7 +462,7 @@ items: summary: The default color for backgrounds of disabled controls; e.g. disabled text field. isPreview: true name: disabledBackground - fullName: sp-component-base.ISemanticColors.disabledBackground + fullName: disabledBackground langs: - typeScript type: property @@ -475,7 +475,7 @@ items: summary: The default color for disabled text on the default background (bodyBackground). isPreview: true name: disabledBodyText - fullName: sp-component-base.ISemanticColors.disabledBodyText + fullName: disabledBodyText langs: - typeScript type: property @@ -488,7 +488,7 @@ items: summary: 'Disabled de-emphasized text, for use on disabledBackground.' isPreview: true name: disabledSubtext - fullName: sp-component-base.ISemanticColors.disabledSubtext + fullName: disabledSubtext langs: - typeScript type: property @@ -503,7 +503,7 @@ items: button text. isPreview: true name: disabledText - fullName: sp-component-base.ISemanticColors.disabledText + fullName: disabledText langs: - typeScript type: property @@ -516,7 +516,7 @@ items: summary: 'The background for errors, if necessary, or highlighting the section of the page where the error is present.' isPreview: true name: errorBackground - fullName: sp-component-base.ISemanticColors.errorBackground + fullName: errorBackground langs: - typeScript type: property @@ -529,7 +529,7 @@ items: summary: 'The default color of error text, used on bodyBackground.' isPreview: true name: errorText - fullName: sp-component-base.ISemanticColors.errorText + fullName: errorText langs: - typeScript type: property @@ -542,7 +542,7 @@ items: summary: The color of the outline around focused controls that don't already have a border; e.g. menu items isPreview: true name: focusBorder - fullName: sp-component-base.ISemanticColors.focusBorder + fullName: focusBorder langs: - typeScript type: property @@ -555,7 +555,7 @@ items: summary: 'The background color of an input, e.g. textbox background.' isPreview: true name: inputBackground - fullName: sp-component-base.ISemanticColors.inputBackground + fullName: inputBackground langs: - typeScript type: property @@ -568,7 +568,7 @@ items: summary: 'The background of a checked control; e.g. checked radio button''s dot, checked toggle''s background.' isPreview: true name: inputBackgroundChecked - fullName: sp-component-base.ISemanticColors.inputBackgroundChecked + fullName: inputBackgroundChecked langs: - typeScript type: property @@ -581,7 +581,7 @@ items: summary: The background of a checked and hovered control; e.g. checked checkbox's background color on hover. isPreview: true name: inputBackgroundCheckedHovered - fullName: sp-component-base.ISemanticColors.inputBackgroundCheckedHovered + fullName: inputBackgroundCheckedHovered langs: - typeScript type: property @@ -594,7 +594,7 @@ items: summary: 'The border of a large input control in its resting, state; e.g. the box of dropdown.' isPreview: true name: inputBorder - fullName: sp-component-base.ISemanticColors.inputBorder + fullName: inputBorder langs: - typeScript type: property @@ -607,7 +607,7 @@ items: summary: 'The border color of a large hovered input control, such as textbox.' isPreview: true name: inputBorderHovered - fullName: sp-component-base.ISemanticColors.inputBorderHovered + fullName: inputBorderHovered langs: - typeScript type: property @@ -620,7 +620,7 @@ items: summary: The alternate focus border color for elements that already have a border; e.g. text field borders on focus. isPreview: true name: inputFocusBorderAlt - fullName: sp-component-base.ISemanticColors.inputFocusBorderAlt + fullName: inputFocusBorderAlt langs: - typeScript type: property @@ -635,7 +635,7 @@ items: button's background color around the dot. isPreview: true name: inputForegroundChecked - fullName: sp-component-base.ISemanticColors.inputForegroundChecked + fullName: inputForegroundChecked langs: - typeScript type: property @@ -648,7 +648,7 @@ items: summary: The color of placeholder text. isPreview: true name: inputPlaceholderText - fullName: sp-component-base.ISemanticColors.inputPlaceholderText + fullName: inputPlaceholderText langs: - typeScript type: property @@ -661,7 +661,7 @@ items: summary: The color of a link. isPreview: true name: link - fullName: sp-component-base.ISemanticColors.link + fullName: link langs: - typeScript type: property @@ -674,7 +674,7 @@ items: summary: The color of a hovered link. Also used when the link is active. isPreview: true name: linkHovered - fullName: sp-component-base.ISemanticColors.linkHovered + fullName: linkHovered langs: - typeScript type: property @@ -687,7 +687,7 @@ items: summary: The background color for the entire list. isPreview: true name: listBackground - fullName: sp-component-base.ISemanticColors.listBackground + fullName: listBackground langs: - typeScript type: property @@ -700,7 +700,7 @@ items: summary: The background color for a hovered list header. isPreview: true name: listHeaderBackgroundHovered - fullName: sp-component-base.ISemanticColors.listHeaderBackgroundHovered + fullName: listHeaderBackgroundHovered langs: - typeScript type: property @@ -713,7 +713,7 @@ items: summary: The background color for a pressed list header. isPreview: true name: listHeaderBackgroundPressed - fullName: sp-component-base.ISemanticColors.listHeaderBackgroundPressed + fullName: listHeaderBackgroundPressed langs: - typeScript type: property @@ -726,7 +726,7 @@ items: summary: The background color of a checked list item. isPreview: true name: listItemBackgroundChecked - fullName: sp-component-base.ISemanticColors.listItemBackgroundChecked + fullName: listItemBackgroundChecked langs: - typeScript type: property @@ -739,7 +739,7 @@ items: summary: The background color of a checked and hovered list item. isPreview: true name: listItemBackgroundCheckedHovered - fullName: sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered + fullName: listItemBackgroundCheckedHovered langs: - typeScript type: property @@ -752,7 +752,7 @@ items: summary: The background color of a hovered list item. isPreview: true name: listItemBackgroundHovered - fullName: sp-component-base.ISemanticColors.listItemBackgroundHovered + fullName: listItemBackgroundHovered langs: - typeScript type: property @@ -765,7 +765,7 @@ items: summary: The default text color for list item titles and text in column fields. isPreview: true name: listText - fullName: sp-component-base.ISemanticColors.listText + fullName: listText langs: - typeScript type: property @@ -780,7 +780,7 @@ items: content: This slot was incorrectly named. Use listText instead. isPreview: true name: listTextColor - fullName: sp-component-base.ISemanticColors.listTextColor + fullName: listTextColor langs: - typeScript type: property @@ -793,7 +793,7 @@ items: summary: The headers in menus that denote title of a section. isPreview: true name: menuHeader - fullName: sp-component-base.ISemanticColors.menuHeader + fullName: menuHeader langs: - typeScript type: property @@ -806,7 +806,7 @@ items: summary: The default colors of icons in menus. isPreview: true name: menuIcon - fullName: sp-component-base.ISemanticColors.menuIcon + fullName: menuIcon langs: - typeScript type: property @@ -823,7 +823,7 @@ items: whose submenu is open, a selected dropdown item. isPreview: true name: menuItemBackgroundChecked - fullName: sp-component-base.ISemanticColors.menuItemBackgroundChecked + fullName: menuItemBackgroundChecked langs: - typeScript type: property @@ -836,7 +836,7 @@ items: summary: The background of a hovered menu item. isPreview: true name: menuItemBackgroundHovered - fullName: sp-component-base.ISemanticColors.menuItemBackgroundHovered + fullName: menuItemBackgroundHovered langs: - typeScript type: property @@ -849,7 +849,7 @@ items: summary: Background of a primary button isPreview: true name: primaryButtonBackground - fullName: sp-component-base.ISemanticColors.primaryButtonBackground + fullName: primaryButtonBackground langs: - typeScript type: property @@ -862,7 +862,7 @@ items: summary: Background of a hovered primary button isPreview: true name: primaryButtonBackgroundHovered - fullName: sp-component-base.ISemanticColors.primaryButtonBackgroundHovered + fullName: primaryButtonBackgroundHovered langs: - typeScript type: property @@ -875,7 +875,7 @@ items: summary: Background of a pressed primary button; i.e. currently being clicked by mouse isPreview: true name: primaryButtonBackgroundPressed - fullName: sp-component-base.ISemanticColors.primaryButtonBackgroundPressed + fullName: primaryButtonBackgroundPressed langs: - typeScript type: property @@ -888,7 +888,7 @@ items: summary: Border of a primary button isPreview: true name: primaryButtonBorder - fullName: sp-component-base.ISemanticColors.primaryButtonBorder + fullName: primaryButtonBorder langs: - typeScript type: property @@ -901,7 +901,7 @@ items: summary: Color of text in a primary button isPreview: true name: primaryButtonText - fullName: sp-component-base.ISemanticColors.primaryButtonText + fullName: primaryButtonText langs: - typeScript type: property @@ -914,7 +914,7 @@ items: summary: Color of text in a hovered primary button isPreview: true name: primaryButtonTextHovered - fullName: sp-component-base.ISemanticColors.primaryButtonTextHovered + fullName: primaryButtonTextHovered langs: - typeScript type: property @@ -927,7 +927,7 @@ items: summary: Color of text in a pressed primary button; i.e. currently being clicked by mouse isPreview: true name: primaryButtonTextPressed - fullName: sp-component-base.ISemanticColors.primaryButtonTextPressed + fullName: primaryButtonTextPressed langs: - typeScript type: property @@ -940,7 +940,7 @@ items: summary: The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox. isPreview: true name: smallInputBorder - fullName: sp-component-base.ISemanticColors.smallInputBorder + fullName: smallInputBorder langs: - typeScript type: property @@ -953,7 +953,7 @@ items: summary: Background for success isPreview: true name: successBackground - fullName: sp-component-base.ISemanticColors.successBackground + fullName: successBackground langs: - typeScript type: property @@ -966,7 +966,7 @@ items: summary: 'The color of the border that provides contrast between an element, such as a card, and an emphasized background.' isPreview: true name: variantBorder - fullName: sp-component-base.ISemanticColors.variantBorder + fullName: variantBorder langs: - typeScript type: property @@ -979,7 +979,7 @@ items: summary: Background for warning messages. isPreview: true name: warningBackground - fullName: sp-component-base.ISemanticColors.warningBackground + fullName: warningBackground langs: - typeScript type: property @@ -992,7 +992,7 @@ items: summary: Foreground color for warning highlights isPreview: true name: warningHighlight - fullName: sp-component-base.ISemanticColors.warningHighlight + fullName: warningHighlight langs: - typeScript type: property @@ -1005,7 +1005,7 @@ items: summary: 'The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.' isPreview: true name: warningText - fullName: sp-component-base.ISemanticColors.warningText + fullName: warningText langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index b9af6c42..6072dd4f 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -4,7 +4,7 @@ items: summary: 'Collection of theme values, which can be used to programatically style components.' isPreview: true name: ITheme - fullName: sp-component-base.ITheme + fullName: ITheme langs: - typeScript type: interface @@ -22,7 +22,7 @@ items: remarks: This has a vary narrow use case and most likely should be avoided. isPreview: true name: disableGlobalClassNames - fullName: sp-component-base.ITheme.disableGlobalClassNames + fullName: disableGlobalClassNames langs: - typeScript type: property @@ -34,7 +34,7 @@ items: - uid: sp-component-base.ITheme.fonts summary: Font styles for different sizes. name: fonts - fullName: sp-component-base.ITheme.fonts + fullName: fonts langs: - typeScript type: property @@ -47,7 +47,7 @@ items: summary: Indicates whether the theme is inverted. isPreview: true name: isInverted - fullName: sp-component-base.ITheme.isInverted + fullName: isInverted langs: - typeScript type: property @@ -59,7 +59,7 @@ items: - uid: sp-component-base.ITheme.palette summary: Color palette. name: palette - fullName: sp-component-base.ITheme.palette + fullName: palette langs: - typeScript type: property @@ -71,7 +71,7 @@ items: - uid: sp-component-base.ITheme.semanticColors summary: The collection of all semantic slots for colors used in themes. name: semanticColors - fullName: sp-component-base.ITheme.semanticColors + fullName: semanticColors langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index 17c1b969..9bf4f88a 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -4,7 +4,7 @@ items: summary: The object passed when the IThemeProvider.themeChangedEvent is raised. isPreview: true name: ThemeChangedEventArgs - fullName: sp-component-base.ThemeChangedEventArgs + fullName: ThemeChangedEventArgs langs: - typeScript type: class @@ -17,7 +17,7 @@ items: summary: 'The new theme. If the value is undefined, then the theme was cleared.' isPreview: true name: theme - fullName: sp-component-base.ThemeChangedEventArgs.theme + fullName: theme langs: - typeScript type: property diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index c5624ab4..b9f89b57 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -6,7 +6,7 @@ items: in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. isPreview: true name: ThemeProvider - fullName: sp-component-base.ThemeProvider + fullName: ThemeProvider langs: - typeScript type: class @@ -19,7 +19,7 @@ items: - uid: sp-component-base.ThemeProvider.constructor summary: 'Constructs a new instance of the [ThemeProvider](xref:sp-component-base.ThemeProvider) class' name: 'constructor(serviceScope, theme)' - fullName: sp-component-base.ThemeProvider.constructor + fullName: constructor langs: - typeScript type: constructor @@ -38,7 +38,7 @@ items: summary: The service key for ThemeProvider. isPreview: true name: serviceKey - fullName: sp-component-base.ThemeProvider.serviceKey + fullName: serviceKey langs: - typeScript type: property @@ -51,7 +51,7 @@ items: summary: Raised when the theme changes with the new theme as an argument. isPreview: true name: themeChangedEvent - fullName: sp-component-base.ThemeProvider.themeChangedEvent + fullName: themeChangedEvent langs: - typeScript type: event @@ -64,7 +64,7 @@ items: summary: 'If set, get the current scoped theme.' isPreview: true name: tryGetTheme() - fullName: sp-component-base.ThemeProvider.tryGetTheme + fullName: tryGetTheme langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index f0d4d772..88a538cf 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -7,7 +7,7 @@ items: SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes small code size and broad applicability, versus flexibility or richness of features. name: '@microsoft/sp-core-library' - fullName: sp-core-library + fullName: '@microsoft/sp-core-library' langs: - typeScript type: package diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index a1283a35..558aaf01 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -3,7 +3,7 @@ items: - uid: sp-core-library.DisplayMode summary: Indicates whether a visual control should display itself for reading or for editing. name: DisplayMode - fullName: sp-core-library.DisplayMode + fullName: DisplayMode langs: - typeScript type: enum @@ -16,7 +16,7 @@ items: The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience. name: Edit - fullName: sp-core-library.DisplayMode.Edit + fullName: Edit langs: - typeScript type: field @@ -26,7 +26,7 @@ items: The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled. name: Read - fullName: sp-core-library.DisplayMode.Read + fullName: Read langs: - typeScript type: field diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index 2b9ee831..8f14ba6b 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -3,7 +3,7 @@ items: - uid: sp-core-library.Environment summary: Information about the system environment where the SharePoint Framework is running. name: Environment - fullName: sp-core-library.Environment + fullName: Environment langs: - typeScript type: class @@ -13,7 +13,7 @@ items: - uid: sp-core-library.Environment.type summary: Indicates the general type of environment where the SharePoint Framework is running. name: type - fullName: sp-core-library.Environment.type + fullName: type langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index d6aa340f..7f8e2382 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -6,7 +6,7 @@ items: This enum is used by the [Environment.type](xref:sp-core-library.Environment.type) property. It provides a way to distinguish environments where certain functionality may be limited or disabled. name: EnvironmentType - fullName: sp-core-library.EnvironmentType + fullName: EnvironmentType langs: - typeScript type: enum @@ -21,7 +21,7 @@ items: Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported. name: ClassicSharePoint - fullName: sp-core-library.EnvironmentType.ClassicSharePoint + fullName: ClassicSharePoint langs: - typeScript type: field @@ -33,7 +33,7 @@ items: network access may not authenticate properly. Certain page context information may be using mock values for testing. name: Local - fullName: sp-core-library.EnvironmentType.Local + fullName: Local langs: - typeScript type: field @@ -43,7 +43,7 @@ items: Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario. name: SharePoint - fullName: sp-core-library.EnvironmentType.SharePoint + fullName: SharePoint langs: - typeScript type: field @@ -53,7 +53,7 @@ items: Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled. name: Test - fullName: sp-core-library.EnvironmentType.Test + fullName: Test langs: - typeScript type: field diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index b5e80066..d7d37f76 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -9,9 +9,9 @@ items: applications. - See [ RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. + See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. name: Guid - fullName: sp-core-library.Guid + fullName: Guid langs: - typeScript type: class @@ -26,7 +26,7 @@ items: - uid: sp-core-library.Guid.empty summary: Returns a new empty Guid instance. name: empty - fullName: sp-core-library.Guid.empty + fullName: empty langs: - typeScript type: property @@ -38,7 +38,7 @@ items: - uid: sp-core-library.Guid.equals summary: Compare this instance to another Guid instance name: equals(guid) - fullName: sp-core-library.Guid.equals + fullName: equals langs: - typeScript type: method @@ -58,7 +58,7 @@ items: Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. name: isValid(guid) - fullName: sp-core-library.Guid.isValid + fullName: isValid langs: - typeScript type: method @@ -78,7 +78,7 @@ items: Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. name: newGuid(randomNumberGenerator) - fullName: sp-core-library.Guid.newGuid + fullName: newGuid langs: - typeScript type: method @@ -104,7 +104,7 @@ items: - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` name: parse(guidString) - fullName: sp-core-library.Guid.parse + fullName: parse langs: - typeScript type: method @@ -132,7 +132,7 @@ items: - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` name: tryParse(guid) - fullName: sp-core-library.Guid.tryParse + fullName: tryParse langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index a13b61dd..916eff59 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -4,7 +4,7 @@ items: summary: Implemented by an object that supports a disposal lifecycle. remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. name: IDisposable - fullName: sp-core-library.IDisposable + fullName: IDisposable langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: dispose() - fullName: sp-core-library.IDisposable.dispose + fullName: dispose langs: - typeScript type: method @@ -32,7 +32,7 @@ items: permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: isDisposed - fullName: sp-core-library.IDisposable.isDisposed + fullName: isDisposed langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 39b418bf..1bdec3ea 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -8,7 +8,7 @@ items: [RandomNumberGenerator](xref:sp-core-library.RandomNumberGenerator) service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable. name: IRandomNumberGenerator - fullName: sp-core-library.IRandomNumberGenerator + fullName: IRandomNumberGenerator langs: - typeScript type: interface @@ -18,7 +18,7 @@ items: - uid: sp-core-library.IRandomNumberGenerator.generate summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' name: generate() - fullName: sp-core-library.IRandomNumberGenerator.generate + fullName: generate langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index 9075b6a0..2bfd32cc 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -7,7 +7,7 @@ items: This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release. name: IServiceCollection - fullName: sp-core-library.IServiceCollection + fullName: IServiceCollection langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release. name: serviceScope - fullName: sp-core-library.IServiceCollection.serviceScope + fullName: serviceScope langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index d29dad34..8aa07f99 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -10,7 +10,7 @@ items: must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements. name: ISPEventObserver - fullName: sp-core-library.ISPEventObserver + fullName: ISPEventObserver langs: - typeScript type: interface @@ -24,7 +24,7 @@ items: summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' name: componentId - fullName: sp-core-library.ISPEventObserver.componentId + fullName: componentId langs: - typeScript type: property @@ -37,7 +37,7 @@ items: summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' name: instanceId - fullName: sp-core-library.ISPEventObserver.instanceId + fullName: instanceId langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index e30fcc70..17326548 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -8,7 +8,7 @@ items: [TimeProvider](xref:sp-core-library.TimeProvider) service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. name: ITimeProvider - fullName: sp-core-library.ITimeProvider + fullName: ITimeProvider langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: - uid: sp-core-library.ITimeProvider.getDate summary: 'Returns the current date/time, similar to the Date class constructor.' name: getDate() - fullName: sp-core-library.ITimeProvider.getDate + fullName: getDate langs: - typeScript type: method @@ -32,7 +32,7 @@ items: - uid: sp-core-library.ITimeProvider.getTimestamp summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' name: getTimestamp() - fullName: sp-core-library.ITimeProvider.getTimestamp + fullName: getTimestamp langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index 7356d389..e3f3fe5c 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -8,7 +8,7 @@ items: filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. name: Log - fullName: sp-core-library.Log + fullName: Log langs: - typeScript type: class @@ -21,7 +21,7 @@ items: - uid: sp-core-library.Log.error summary: Logs an error. name: 'error(source, error, scope)' - fullName: sp-core-library.Log.error + fullName: error langs: - typeScript type: method @@ -51,7 +51,7 @@ items: - uid: sp-core-library.Log.info summary: Logs a general informational message. name: 'info(source, message, scope)' - fullName: sp-core-library.Log.info + fullName: info langs: - typeScript type: method @@ -81,7 +81,7 @@ items: - uid: sp-core-library.Log.verbose summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. name: 'verbose(source, message, scope)' - fullName: sp-core-library.Log.verbose + fullName: verbose langs: - typeScript type: method @@ -111,7 +111,7 @@ items: - uid: sp-core-library.Log.warn summary: Logs a warning. name: 'warn(source, message, scope)' - fullName: sp-core-library.Log.warn + fullName: warn langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index f6763572..57fef596 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -5,7 +5,7 @@ items: This is the default implementation of [IRandomNumberGenerator](xref:sp-core-library.IRandomNumberGenerator) that simply calls Math.random(). name: RandomNumberGenerator - fullName: sp-core-library.RandomNumberGenerator + fullName: RandomNumberGenerator langs: - typeScript type: class @@ -19,7 +19,7 @@ items: - uid: sp-core-library.RandomNumberGenerator.constructor summary: 'Constructs a new instance of the [RandomNumberGenerator](xref:sp-core-library.RandomNumberGenerator) class' name: constructor(serviceScope) - fullName: sp-core-library.RandomNumberGenerator.constructor + fullName: constructor langs: - typeScript type: constructor @@ -33,7 +33,7 @@ items: - uid: sp-core-library.RandomNumberGenerator.generate summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' name: generate() - fullName: sp-core-library.RandomNumberGenerator.generate + fullName: generate langs: - typeScript type: method @@ -46,7 +46,7 @@ items: - uid: sp-core-library.RandomNumberGenerator.serviceKey summary: The service key for IRandomNumberGenerator. name: serviceKey - fullName: sp-core-library.RandomNumberGenerator.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index b5e798b0..e017ca76 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -10,7 +10,7 @@ items: can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency. name: ServiceKey - fullName: sp-core-library.ServiceKey + fullName: ServiceKey langs: - typeScript type: class @@ -29,7 +29,7 @@ items: If you want to specify custom constructor parameters, use [ServiceKey.createCustom](xref:sp-core-library.ServiceKey.createCustom) instead. name: 'create(name, serviceClass)' - fullName: sp-core-library.ServiceKey.create + fullName: create langs: - typeScript type: method @@ -57,7 +57,7 @@ items: - uid: sp-core-library.ServiceKey.createCustom summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. name: 'createCustom(name, defaultCreator)' - fullName: sp-core-library.ServiceKey.createCustom + fullName: createCustom langs: - typeScript type: method @@ -79,7 +79,7 @@ items: - uid: sp-core-library.ServiceKey.defaultCreator summary: A callback function that constructs the default instance of this service. name: defaultCreator - fullName: sp-core-library.ServiceKey.defaultCreator + fullName: defaultCreator langs: - typeScript type: property @@ -102,7 +102,7 @@ items: different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes. name: id - fullName: sp-core-library.ServiceKey.id + fullName: id langs: - typeScript type: property @@ -121,7 +121,7 @@ items: The system does not assume that this string is unique. Instead, the [ServiceKey.id](xref:sp-core-library.ServiceKey.id) is used wherever a lookup key is needed. name: name - fullName: sp-core-library.ServiceKey.name + fullName: name langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 988c5d19..dbc806b1 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -45,7 +45,7 @@ items: coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished(). name: ServiceScope - fullName: sp-core-library.ServiceScope + fullName: ServiceScope langs: - typeScript type: class @@ -64,7 +64,7 @@ items: - uid: sp-core-library.ServiceScope.constructor summary: 'Constructs a new instance of the [ServiceScope](xref:sp-core-library.ServiceScope) class' name: constructor(parent) - fullName: sp-core-library.ServiceScope.constructor + fullName: constructor langs: - typeScript type: constructor @@ -82,7 +82,7 @@ items: registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. name: consume(serviceKey) - fullName: sp-core-library.ServiceScope.consume + fullName: consume langs: - typeScript type: method @@ -102,7 +102,7 @@ items: This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). name: 'createAndProvide(serviceKey, simpleServiceClass)' - fullName: sp-core-library.ServiceScope.createAndProvide + fullName: createAndProvide langs: - typeScript type: method @@ -132,7 +132,7 @@ items: This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). name: createDefaultAndProvide(serviceKey) - fullName: sp-core-library.ServiceScope.createDefaultAndProvide + fullName: createDefaultAndProvide langs: - typeScript type: method @@ -160,7 +160,7 @@ items: different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. name: finish() - fullName: sp-core-library.ServiceScope.finish + fullName: finish langs: - typeScript type: method @@ -173,7 +173,7 @@ items: - uid: sp-core-library.ServiceScope.getParent summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' name: getParent() - fullName: sp-core-library.ServiceScope.getParent + fullName: getParent langs: - typeScript type: method @@ -189,7 +189,7 @@ items: ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. name: 'provide(serviceKey, service)' - fullName: sp-core-library.ServiceScope.provide + fullName: provide langs: - typeScript type: method @@ -214,7 +214,7 @@ items: The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. name: startNewChild() - fullName: sp-core-library.ServiceScope.startNewChild + fullName: startNewChild langs: - typeScript type: method @@ -229,7 +229,7 @@ items: Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. name: startNewRoot() - fullName: sp-core-library.ServiceScope.startNewRoot + fullName: startNewRoot langs: - typeScript type: method @@ -252,7 +252,7 @@ items: However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). name: whenFinished(callback) - fullName: sp-core-library.ServiceScope.whenFinished + fullName: whenFinished langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 845d131d..f70296fd 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -3,7 +3,7 @@ items: - uid: sp-core-library.Session summary: Provides access to the application's browser session and active page. name: Session - fullName: sp-core-library.Session + fullName: Session langs: - typeScript type: class @@ -20,7 +20,7 @@ items: router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions. name: applicationId - fullName: sp-core-library.Session.applicationId + fullName: applicationId langs: - typeScript type: property @@ -46,7 +46,7 @@ items: The concept of a page is subjective and defined by the router for a particular application. name: pageId - fullName: sp-core-library.Session.pageId + fullName: pageId langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index 86568d6e..617d549b 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -23,7 +23,7 @@ items: exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component. name: SPEvent - fullName: sp-core-library.SPEvent + fullName: SPEvent langs: - typeScript type: class @@ -38,7 +38,7 @@ items: ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. name: 'add(observer, eventHandler)' - fullName: sp-core-library.SPEvent.add + fullName: add langs: - typeScript type: method @@ -64,7 +64,7 @@ items: summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' name: 'remove(observer, eventHandler)' - fullName: sp-core-library.SPEvent.remove + fullName: remove langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 5894316d..5c877c68 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -4,7 +4,7 @@ items: summary: 'The base class for event arguments used with the [SPEvent](xref:sp-core-library.SPEvent) class.' remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' name: SPEventArgs - fullName: sp-core-library.SPEventArgs + fullName: SPEventArgs langs: - typeScript type: class diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index 8fc60cfa..68617559 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -4,7 +4,7 @@ items: summary: Operations for working with strings that contain text. remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' name: Text - fullName: sp-core-library.Text + fullName: Text langs: - typeScript type: class @@ -25,7 +25,7 @@ items: `Text.format("hello {0}!", "world")` will return `"hello world!"` name: 'format(s, values)' - fullName: sp-core-library.Text.format + fullName: format langs: - typeScript type: method @@ -48,7 +48,7 @@ items: summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' name: 'replaceAll(input, searchValue, replaceValue)' - fullName: sp-core-library.Text.replaceAll + fullName: replaceAll langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 91016174..cbce968a 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -5,7 +5,7 @@ items: This is the default implementation of [ITimeProvider](xref:sp-core-library.ITimeProvider) that simply calls the real browser APIs. name: TimeProvider - fullName: sp-core-library.TimeProvider + fullName: TimeProvider langs: - typeScript type: class @@ -20,7 +20,7 @@ items: - uid: sp-core-library.TimeProvider.constructor summary: 'Constructs a new instance of the [TimeProvider](xref:sp-core-library.TimeProvider) class' name: constructor(serviceScope) - fullName: sp-core-library.TimeProvider.constructor + fullName: constructor langs: - typeScript type: constructor @@ -34,7 +34,7 @@ items: - uid: sp-core-library.TimeProvider.getDate summary: 'Returns the current date/time, similar to the Date class constructor.' name: getDate() - fullName: sp-core-library.TimeProvider.getDate + fullName: getDate langs: - typeScript type: method @@ -47,7 +47,7 @@ items: - uid: sp-core-library.TimeProvider.getTimestamp summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' name: getTimestamp() - fullName: sp-core-library.TimeProvider.getTimestamp + fullName: getTimestamp langs: - typeScript type: method @@ -60,7 +60,7 @@ items: - uid: sp-core-library.TimeProvider.serviceKey summary: The service key for ITimeProvider. name: serviceKey - fullName: sp-core-library.TimeProvider.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index a836af0c..aa3313e2 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -17,7 +17,7 @@ items: deprecated: content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: UrlQueryParameterCollection - fullName: sp-core-library.UrlQueryParameterCollection + fullName: UrlQueryParameterCollection langs: - typeScript type: class @@ -33,7 +33,7 @@ items: deprecated: content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: constructor(url) - fullName: sp-core-library.UrlQueryParameterCollection.constructor + fullName: constructor langs: - typeScript type: constructor @@ -61,7 +61,7 @@ items: deprecated: content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: getValue(param) - fullName: sp-core-library.UrlQueryParameterCollection.getValue + fullName: getValue langs: - typeScript type: method @@ -93,7 +93,7 @@ items: deprecated: content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: getValues(param) - fullName: sp-core-library.UrlQueryParameterCollection.getValues + fullName: getValues langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 6d636198..856762aa 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -7,7 +7,7 @@ items: assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance. name: Validate - fullName: sp-core-library.Validate + fullName: Validate langs: - typeScript type: class @@ -20,7 +20,7 @@ items: - uid: sp-core-library.Validate.isNonemptyString summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' name: 'isNonemptyString(value, variableName)' - fullName: sp-core-library.Validate.isNonemptyString + fullName: isNonemptyString langs: - typeScript type: method @@ -42,7 +42,7 @@ items: - uid: sp-core-library.Validate.isNotDisposed summary: Throws an exception if the specified object has been disposed. name: 'isNotDisposed(value, className)' - fullName: sp-core-library.Validate.isNotDisposed + fullName: isNotDisposed langs: - typeScript type: method @@ -64,7 +64,7 @@ items: - uid: sp-core-library.Validate.isNotNullOrUndefined summary: Throws an exception if the specified value is null or undefined. name: 'isNotNullOrUndefined(value, variableName)' - fullName: sp-core-library.Validate.isNotNullOrUndefined + fullName: isNotNullOrUndefined langs: - typeScript type: method @@ -86,7 +86,7 @@ items: - uid: sp-core-library.Validate.isTrue summary: Throws an exception if the specified value is not true. name: 'isTrue(value, variableName)' - fullName: sp-core-library.Validate.isTrue + fullName: isTrue langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 171d4933..1179a915 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -10,7 +10,7 @@ items: Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` name: Version - fullName: sp-core-library.Version + fullName: Version langs: - typeScript type: class @@ -31,7 +31,7 @@ items: - uid: sp-core-library.Version.compare summary: Compares two Version objects to determine which version is newer. name: 'compare(v1, v2)' - fullName: sp-core-library.Version.compare + fullName: compare langs: - typeScript type: method @@ -64,7 +64,7 @@ items: ``` name: equals(compareWith) - fullName: sp-core-library.Version.equals + fullName: equals langs: - typeScript type: method @@ -90,7 +90,7 @@ items: ``` name: greaterThan(compareWith) - fullName: sp-core-library.Version.greaterThan + fullName: greaterThan langs: - typeScript type: method @@ -108,7 +108,7 @@ items: - uid: sp-core-library.Version.isValid summary: Test whether a string is a valid version specifier. name: isValid(versionString) - fullName: sp-core-library.Version.isValid + fullName: isValid langs: - typeScript type: method @@ -135,7 +135,7 @@ items: ``` name: lessThan(compareWith) - fullName: sp-core-library.Version.lessThan + fullName: lessThan langs: - typeScript type: method @@ -154,7 +154,7 @@ items: summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. name: major - fullName: sp-core-library.Version.major + fullName: major langs: - typeScript type: property @@ -169,7 +169,7 @@ items: Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases. name: minor - fullName: sp-core-library.Version.minor + fullName: minor langs: - typeScript type: property @@ -181,7 +181,7 @@ items: - uid: sp-core-library.Version.parse summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. name: parse(versionString) - fullName: sp-core-library.Version.parse + fullName: parse langs: - typeScript type: method @@ -202,7 +202,7 @@ items: Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the "build" number. name: patch - fullName: sp-core-library.Version.patch + fullName: patch langs: - typeScript type: property @@ -217,7 +217,7 @@ items: This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers. name: revision - fullName: sp-core-library.Version.revision + fullName: revision langs: - typeScript type: property @@ -250,7 +250,7 @@ items: ``` name: satisfies(compareWith) - fullName: sp-core-library.Version.satisfies + fullName: satisfies langs: - typeScript type: method @@ -270,7 +270,7 @@ items: Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. name: tryParse(versionString) - fullName: sp-core-library.Version.tryParse + fullName: tryParse langs: - typeScript type: method diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index b9ca7c6a..524bdeb6 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -5,7 +5,7 @@ items: This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user engagement and performance logging. name: '@microsoft/sp-diagnostics' - fullName: sp-diagnostics + fullName: '@microsoft/sp-diagnostics' langs: - typeScript type: package diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index 0f8d5e50..0bf85e79 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -7,7 +7,7 @@ items: [Dialog.prompt](xref:sp-dialog.Dialog.prompt), along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications. name: '@microsoft/sp-dialog' - fullName: sp-dialog + fullName: '@microsoft/sp-dialog' langs: - typeScript type: package diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 985301e3..d408518f 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -12,7 +12,7 @@ items: show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class. name: BaseDialog - fullName: sp-dialog.BaseDialog + fullName: BaseDialog langs: - typeScript type: class @@ -57,7 +57,7 @@ items: ``` name: constructor(config) - fullName: sp-dialog.BaseDialog.constructor + fullName: constructor langs: - typeScript type: constructor @@ -74,7 +74,7 @@ items: This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. name: close() - fullName: sp-dialog.BaseDialog.close + fullName: close langs: - typeScript type: method @@ -88,7 +88,7 @@ items: summary: Use this property to access the container element provided by the framework for rendering. remarks: 'See [BaseDialog.render](xref:sp-dialog.BaseDialog.render) for more information on rendering.' name: domElement - fullName: sp-dialog.BaseDialog.domElement + fullName: domElement langs: - typeScript type: property @@ -103,7 +103,7 @@ items: This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. name: isHidden - fullName: sp-dialog.BaseDialog.isHidden + fullName: isHidden langs: - typeScript type: property @@ -117,7 +117,7 @@ items: If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. name: isOpen - fullName: sp-dialog.BaseDialog.isOpen + fullName: isOpen langs: - typeScript type: property @@ -129,7 +129,7 @@ items: - uid: sp-dialog.BaseDialog.isSecondary summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. name: isSecondary - fullName: sp-dialog.BaseDialog.isSecondary + fullName: isSecondary langs: - typeScript type: property @@ -146,7 +146,7 @@ items: that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. name: onAfterClose() - fullName: sp-dialog.BaseDialog.onAfterClose + fullName: onAfterClose langs: - typeScript type: method @@ -162,7 +162,7 @@ items: loading indicator is displayed during the lifetime of this method. remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. name: onBeforeOpen() - fullName: sp-dialog.BaseDialog.onBeforeOpen + fullName: onBeforeOpen langs: - typeScript type: method @@ -189,7 +189,7 @@ items: UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. name: render() - fullName: sp-dialog.BaseDialog.render + fullName: render langs: - typeScript type: method @@ -208,7 +208,7 @@ items: a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. name: secondaryDialogProvider - fullName: sp-dialog.BaseDialog.secondaryDialogProvider + fullName: secondaryDialogProvider langs: - typeScript type: property @@ -220,7 +220,7 @@ items: - uid: sp-dialog.BaseDialog.show summary: Request the framework to show this dialog. name: show(options) - fullName: sp-dialog.BaseDialog.show + fullName: show langs: - typeScript type: method diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index a07f183a..6e91901e 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -3,7 +3,7 @@ items: - uid: sp-dialog.Dialog summary: A static class for showing stock dialogs such as an alert or prompt. name: Dialog - fullName: sp-dialog.Dialog + fullName: Dialog langs: - typeScript type: class @@ -20,7 +20,7 @@ items: dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. name: 'alert(message, options)' - fullName: sp-dialog.Dialog.alert + fullName: alert langs: - typeScript type: method @@ -48,7 +48,7 @@ items: dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. name: 'prompt(message, options)' - fullName: sp-dialog.Dialog.prompt + fullName: prompt langs: - typeScript type: method diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index 0e3f25f3..a826df7f 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -3,7 +3,7 @@ items: - uid: sp-dialog.IAlertOptions summary: Options for showing an alert dialog name: IAlertOptions - fullName: sp-dialog.IAlertOptions + fullName: IAlertOptions langs: - typeScript type: interface diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 31bccc57..06da012c 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-dialog.IDialogConfiguration summary: The interface for dialog configuration name: IDialogConfiguration - fullName: sp-dialog.IDialogConfiguration + fullName: IDialogConfiguration langs: - typeScript type: interface @@ -13,7 +13,7 @@ items: - uid: sp-dialog.IDialogConfiguration.isBlocking summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). name: isBlocking - fullName: sp-dialog.IDialogConfiguration.isBlocking + fullName: isBlocking langs: - typeScript type: property diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index decb9748..9ace73be 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -3,7 +3,7 @@ items: - uid: sp-dialog.IDialogShowOptions summary: Options for showing a dialog name: IDialogShowOptions - fullName: sp-dialog.IDialogShowOptions + fullName: IDialogShowOptions langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. name: confirmOpen - fullName: sp-dialog.IDialogShowOptions.confirmOpen + fullName: confirmOpen langs: - typeScript type: property diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 837142a8..73ab9652 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -3,7 +3,7 @@ items: - uid: sp-dialog.IPromptOptions summary: Options for showing a prompt dialog name: IPromptOptions - fullName: sp-dialog.IPromptOptions + fullName: IPromptOptions langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-dialog.IPromptOptions.defaultValue summary: The default value for the input text field of prompt dialog name: defaultValue - fullName: sp-dialog.IPromptOptions.defaultValue + fullName: defaultValue langs: - typeScript type: property diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index dbcef72c..a886a333 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -13,7 +13,7 @@ items: See [BaseDialog.secondaryDialogProvider](xref:sp-dialog.BaseDialog.secondaryDialogProvider) for how to use this. name: ISecondaryDialogProvider - fullName: sp-dialog.ISecondaryDialogProvider + fullName: ISecondaryDialogProvider langs: - typeScript type: interface @@ -27,7 +27,7 @@ items: Similar to [Dialog.alert](xref:sp-dialog.Dialog.alert). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'alert(message, options)' - fullName: sp-dialog.ISecondaryDialogProvider.alert + fullName: alert langs: - typeScript type: method @@ -51,7 +51,7 @@ items: Similar to [Dialog.prompt](xref:sp-dialog.Dialog.prompt). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'prompt(message, options)' - fullName: sp-dialog.ISecondaryDialogProvider.prompt + fullName: prompt langs: - typeScript type: method @@ -77,7 +77,7 @@ items: Similar to [BaseDialog.show](xref:sp-dialog.BaseDialog.show). The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'show(dialog, options)' - fullName: sp-dialog.ISecondaryDialogProvider.show + fullName: show langs: - typeScript type: method diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index d8ef4434..db6c2d21 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -6,7 +6,7 @@ items: This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and implement components that use it. name: '@microsoft/sp-dynamic-data' - fullName: sp-dynamic-data + fullName: '@microsoft/sp-dynamic-data' langs: - typeScript type: package diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 949206ab..111693a9 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -9,7 +9,7 @@ items: Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` name: DynamicDataReference - fullName: sp-dynamic-data.DynamicDataReference + fullName: DynamicDataReference langs: - typeScript type: class @@ -23,7 +23,7 @@ items: - uid: sp-dynamic-data.DynamicDataReference.constructor summary: 'Constructs a new instance of the [DynamicDataReference](xref:sp-dynamic-data.DynamicDataReference) class' name: constructor(reference) - fullName: sp-dynamic-data.DynamicDataReference.constructor + fullName: constructor langs: - typeScript type: constructor @@ -37,7 +37,7 @@ items: - uid: sp-dynamic-data.DynamicDataReference.property summary: Returns the referred property of the Dynamic Data. name: property - fullName: sp-dynamic-data.DynamicDataReference.property + fullName: property langs: - typeScript type: property @@ -49,7 +49,7 @@ items: - uid: sp-dynamic-data.DynamicDataReference.propertyPath summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. name: propertyPath - fullName: sp-dynamic-data.DynamicDataReference.propertyPath + fullName: propertyPath langs: - typeScript type: property @@ -61,7 +61,7 @@ items: - uid: sp-dynamic-data.DynamicDataReference.reference summary: Returns the full reference of the Dynamic Data object as a string. name: reference - fullName: sp-dynamic-data.DynamicDataReference.reference + fullName: reference langs: - typeScript type: property @@ -73,7 +73,7 @@ items: - uid: sp-dynamic-data.DynamicDataReference.sourceId summary: Returns the referred id of the Dynamic Data Source. name: sourceId - fullName: sp-dynamic-data.DynamicDataReference.sourceId + fullName: sourceId langs: - typeScript type: property diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index cf06af1b..d14c71a7 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -5,7 +5,7 @@ items: Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value. name: IDynamicDataAnnotatedPropertyValue - fullName: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + fullName: IDynamicDataAnnotatedPropertyValue langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata summary: Metadata describing the sample value of the property. name: metadata - fullName: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata + fullName: metadata langs: - typeScript type: property @@ -28,7 +28,7 @@ items: - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue summary: Sample value of a property name: sampleValue - fullName: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue + fullName: sampleValue langs: - typeScript type: property diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 9c9293a3..36353190 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -5,7 +5,7 @@ items: Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. name: IDynamicDataCallables - fullName: sp-dynamic-data.IDynamicDataCallables + fullName: IDynamicDataCallables langs: - typeScript type: interface @@ -25,7 +25,7 @@ items: If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. isPreview: true name: allowedEvents() - fullName: sp-dynamic-data.IDynamicDataCallables.allowedEvents + fullName: allowedEvents langs: - typeScript type: method @@ -40,7 +40,7 @@ items: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. name: getAnnotatedPropertyValue(propertyId) - fullName: sp-dynamic-data.IDynamicDataCallables.getAnnotatedPropertyValue + fullName: getAnnotatedPropertyValue langs: - typeScript type: method @@ -58,7 +58,7 @@ items: - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions summary: Returns all the property definitions that the DataSource will provide. name: getPropertyDefinitions() - fullName: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions + fullName: getPropertyDefinitions langs: - typeScript type: method @@ -72,7 +72,7 @@ items: summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' name: getPropertyValue(propertyId) - fullName: sp-dynamic-data.IDynamicDataCallables.getPropertyValue + fullName: getPropertyValue langs: - typeScript type: method @@ -96,7 +96,7 @@ items: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. isPreview: true name: 'sendEvent(eventName, data)' - fullName: sp-dynamic-data.IDynamicDataCallables.sendEvent + fullName: sendEvent langs: - typeScript type: method diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 39b97b78..6cdfebca 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -7,7 +7,7 @@ items: It includes the name of the event and description to be seen and used by end users. isPreview: true name: IDynamicDataEventDefinition - fullName: sp-dynamic-data.IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: summary: 'User-friendly, localized description of the event.' isPreview: true name: description - fullName: sp-dynamic-data.IDynamicDataEventDefinition.description + fullName: description langs: - typeScript type: property @@ -32,7 +32,7 @@ items: summary: Event name isPreview: true name: name - fullName: sp-dynamic-data.IDynamicDataEventDefinition.name + fullName: name langs: - typeScript type: property diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 10cf311e..2e07d2e0 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -5,7 +5,7 @@ items: Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. name: IDynamicDataPropertyDefinition - fullName: sp-dynamic-data.IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" name: id - fullName: sp-dynamic-data.IDynamicDataPropertyDefinition.id + fullName: id langs: - typeScript type: property diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index dfff4298..88b84573 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -3,7 +3,7 @@ items: - uid: sp-dynamic-data.IDynamicDataPropertyMetadata summary: Metadata of a property name: IDynamicDataPropertyMetadata - fullName: sp-dynamic-data.IDynamicDataPropertyMetadata + fullName: IDynamicDataPropertyMetadata langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" name: description - fullName: sp-dynamic-data.IDynamicDataPropertyMetadata.description + fullName: description langs: - typeScript type: property @@ -30,7 +30,7 @@ items: User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) name: title - fullName: sp-dynamic-data.IDynamicDataPropertyMetadata.title + fullName: title langs: - typeScript type: property diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 9f8eb2a9..605dfd70 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -3,7 +3,7 @@ items: - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata summary: Metadata describing the sample value of the property. name: IDynamicDataPropertyValueMetadata - fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadata + fullName: IDynamicDataPropertyValueMetadata langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata summary: Metadata describing the sample value of the property. name: metadata - fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata + fullName: metadata langs: - typeScript type: property diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index e6fe6acd..1d94b645 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -73,7 +73,7 @@ items: ``` name: IDynamicDataPropertyValueMetadataCollection - fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + fullName: IDynamicDataPropertyValueMetadataCollection langs: - typeScript type: interface @@ -85,7 +85,7 @@ items: Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value. name: __index(key) - fullName: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection.__index + fullName: __index langs: - typeScript type: method diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 204c9ae8..0b350b5c 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -5,7 +5,7 @@ items: Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. name: IDynamicDataSource - fullName: sp-dynamic-data.IDynamicDataSource + fullName: IDynamicDataSource langs: - typeScript type: interface @@ -27,7 +27,7 @@ items: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. isPreview: true name: allowedEvents() - fullName: sp-dynamic-data.IDynamicDataSource.allowedEvents + fullName: allowedEvents langs: - typeScript type: method @@ -42,7 +42,7 @@ items: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. name: getAnnotatedPropertyValue(propertyId) - fullName: sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue + fullName: getAnnotatedPropertyValue langs: - typeScript type: method @@ -62,7 +62,7 @@ items: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. name: getPropertyDefinitions() - fullName: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions + fullName: getPropertyDefinitions langs: - typeScript type: method @@ -77,7 +77,7 @@ items: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. name: getPropertyValue(propertyId) - fullName: sp-dynamic-data.IDynamicDataSource.getPropertyValue + fullName: getPropertyValue langs: - typeScript type: method @@ -95,7 +95,7 @@ items: - uid: sp-dynamic-data.IDynamicDataSource.id summary: Id of the Dynamic Data Source. name: id - fullName: sp-dynamic-data.IDynamicDataSource.id + fullName: id langs: - typeScript type: property @@ -107,7 +107,7 @@ items: - uid: sp-dynamic-data.IDynamicDataSource.metadata summary: Metadata of the Dynamic Data Source. name: metadata - fullName: sp-dynamic-data.IDynamicDataSource.metadata + fullName: metadata langs: - typeScript type: property @@ -125,7 +125,7 @@ items: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. isPreview: true name: 'sendEvent(eventName, data)' - fullName: sp-dynamic-data.IDynamicDataSource.sendEvent + fullName: sendEvent langs: - typeScript type: method diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 97206d20..0eb3aa32 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -3,7 +3,7 @@ items: - uid: sp-dynamic-data.IDynamicDataSourceMetadata summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. name: IDynamicDataSourceMetadata - fullName: sp-dynamic-data.IDynamicDataSourceMetadata + fullName: IDynamicDataSourceMetadata langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. name: alias - fullName: sp-dynamic-data.IDynamicDataSourceMetadata.alias + fullName: alias langs: - typeScript type: property @@ -33,7 +33,7 @@ items: Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. name: componentId - fullName: sp-dynamic-data.IDynamicDataSourceMetadata.componentId + fullName: componentId langs: - typeScript type: property @@ -45,7 +45,7 @@ items: - uid: sp-dynamic-data.IDynamicDataSourceMetadata.description summary: 'User-friendly, localized description of the Dynamic Data Source.' name: description - fullName: sp-dynamic-data.IDynamicDataSourceMetadata.description + fullName: description langs: - typeScript type: property @@ -60,7 +60,7 @@ items: example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. name: instanceId - fullName: sp-dynamic-data.IDynamicDataSourceMetadata.instanceId + fullName: instanceId langs: - typeScript type: property @@ -74,7 +74,7 @@ items: User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. name: title - fullName: sp-dynamic-data.IDynamicDataSourceMetadata.title + fullName: title langs: - typeScript type: property diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index 8129a8fa..903e22b3 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -3,7 +3,7 @@ items: - uid: sp-extension-base summary: SharePoint Framework support for building client-side extensions. name: '@microsoft/sp-extension-base' - fullName: sp-extension-base + fullName: '@microsoft/sp-extension-base' langs: - typeScript type: package diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index e35e4b7d..14626c02 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseExtension class. name: BaseExtension - fullName: sp-extension-base.BaseExtension + fullName: BaseExtension langs: - typeScript type: class @@ -24,7 +24,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-extension-base.BaseExtension.context + fullName: context langs: - typeScript type: property @@ -36,7 +36,7 @@ items: - uid: sp-extension-base.BaseExtension.onInit summary: This event method is called when the client-side extension is first activated on the page. name: onInit() - fullName: sp-extension-base.BaseExtension.onInit + fullName: onInit langs: - typeScript type: method @@ -53,7 +53,7 @@ items: what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization. name: properties - fullName: sp-extension-base.BaseExtension.properties + fullName: properties langs: - typeScript type: property diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 5f464632..2892d5d0 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ExtensionContext class. name: ExtensionContext - fullName: sp-extension-base.ExtensionContext + fullName: ExtensionContext langs: - typeScript type: class diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 8f880f55..99a55b9d 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -7,7 +7,7 @@ items: authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that follow the recommended best practices. name: '@microsoft/sp-http' - fullName: sp-http + fullName: '@microsoft/sp-http' langs: - typeScript type: package diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index eba953c1..b199fa82 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -9,7 +9,7 @@ items: For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For communicating with Microsoft Graph, use the [MSGraphClient](xref:sp-http.MSGraphClient) class. name: AadHttpClient - fullName: sp-http.AadHttpClient + fullName: AadHttpClient langs: - typeScript type: class @@ -23,7 +23,7 @@ items: - uid: sp-http.AadHttpClient.constructor summary: 'Constructs a new instance of the [AadHttpClient](xref:sp-http.AadHttpClient) class' name: 'constructor(serviceScope, resourceEndpoint, options)' - fullName: sp-http.AadHttpClient.constructor + fullName: constructor langs: - typeScript type: constructor @@ -45,7 +45,7 @@ items: - uid: sp-http.AadHttpClient.configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. name: configurations - fullName: sp-http.AadHttpClient.configurations + fullName: configurations langs: - typeScript type: property @@ -61,7 +61,7 @@ items: HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ name: 'fetch(url, configuration, options)' - fullName: sp-http.AadHttpClient.fetch + fullName: fetch langs: - typeScript type: method @@ -91,7 +91,7 @@ items: - uid: sp-http.AadHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' - fullName: sp-http.AadHttpClient.get + fullName: get langs: - typeScript type: method @@ -121,7 +121,7 @@ items: - uid: sp-http.AadHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: sp-http.AadHttpClient.post + fullName: post langs: - typeScript type: method diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 44bf3289..7b2a1a1d 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -8,7 +8,7 @@ items: predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. name: AadHttpClientConfiguration - fullName: sp-http.AadHttpClientConfiguration + fullName: AadHttpClientConfiguration langs: - typeScript type: class @@ -26,7 +26,7 @@ items: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. name: 'constructor(flags, overrideFlags)' - fullName: sp-http.AadHttpClientConfiguration.constructor + fullName: constructor langs: - typeScript type: constructor @@ -43,7 +43,7 @@ items: - IAadHttpClientConfiguration - uid: sp-http.AadHttpClientConfiguration.flags name: flags - fullName: sp-http.AadHttpClientConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -54,7 +54,7 @@ items: - IAadHttpClientConfiguration - uid: sp-http.AadHttpClientConfiguration.overrideWith name: overrideWith(sourceFlags) - fullName: sp-http.AadHttpClientConfiguration.overrideWith + fullName: overrideWith langs: - typeScript type: method diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 027ec763..e15b8204 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClientFactory class. name: AadHttpClientFactory - fullName: sp-http.AadHttpClientFactory + fullName: AadHttpClientFactory langs: - typeScript type: class @@ -21,7 +21,7 @@ items: Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. name: getClient(resourceEndpoint) - fullName: sp-http.AadHttpClientFactory.getClient + fullName: getClient langs: - typeScript type: method @@ -39,7 +39,7 @@ items: - uid: sp-http.AadHttpClientFactory.serviceKey summary: The service key for AadHttpClientFactory. name: serviceKey - fullName: sp-http.AadHttpClientFactory.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index cc14ab57..34c78f00 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -14,7 +14,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadTokenProvider class. name: AadTokenProvider - fullName: sp-http.AadTokenProvider + fullName: AadTokenProvider langs: - typeScript type: class @@ -30,7 +30,7 @@ items: The OAuth2 token should not be cached by the caller since it is already cached by the method itself. name: getToken(resourceEndpoint) - fullName: sp-http.AadTokenProvider.getToken + fullName: getToken langs: - typeScript type: method @@ -50,7 +50,7 @@ items: - uid: sp-http.AadTokenProvider.tokenAcquisitionEvent summary: Notifies the developer when Token Acquisition requires user action. name: tokenAcquisitionEvent - fullName: sp-http.AadTokenProvider.tokenAcquisitionEvent + fullName: tokenAcquisitionEvent langs: - typeScript type: event diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 47e4ab7e..a11ac1fd 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.AadTokenProviderFactory summary: Returns a preinitialized version of the AadTokenProviderFactory. name: AadTokenProviderFactory - fullName: sp-http.AadTokenProviderFactory + fullName: AadTokenProviderFactory langs: - typeScript type: class @@ -16,7 +16,7 @@ items: Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. name: getTokenProvider() - fullName: sp-http.AadTokenProviderFactory.getTokenProvider + fullName: getTokenProvider langs: - typeScript type: method @@ -29,7 +29,7 @@ items: - uid: sp-http.AadTokenProviderFactory.serviceKey summary: The service key for AadTokenProviderFactory. name: serviceKey - fullName: sp-http.AadTokenProviderFactory.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index bc717903..54043d7b 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -8,10 +8,10 @@ items: and expires after a server configurable amount of time. - For more information, see the MSDN article [ "Complete basic operations using SharePoint 2013 REST endpoints" - ](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) name: DigestCache - fullName: sp-http.DigestCache + fullName: DigestCache langs: - typeScript type: class @@ -28,7 +28,7 @@ items: - uid: sp-http.DigestCache.constructor summary: 'Constructs a new instance of the [DigestCache](xref:sp-http.DigestCache) class' name: constructor(serviceScope) - fullName: sp-http.DigestCache.constructor + fullName: constructor langs: - typeScript type: constructor @@ -45,7 +45,7 @@ items: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - fullName: sp-http.DigestCache.addDigestToCache + fullName: addDigestToCache langs: - typeScript type: method @@ -76,7 +76,7 @@ items: - uid: sp-http.DigestCache.clearAllDigests summary: Clears all values from the cache. name: clearAllDigests() - fullName: sp-http.DigestCache.clearAllDigests + fullName: clearAllDigests langs: - typeScript type: method @@ -91,7 +91,7 @@ items: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. name: clearDigest(webUrl) - fullName: sp-http.DigestCache.clearDigest + fullName: clearDigest langs: - typeScript type: method @@ -112,7 +112,7 @@ items: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. name: fetchDigest(webUrl) - fullName: sp-http.DigestCache.fetchDigest + fullName: fetchDigest langs: - typeScript type: method @@ -130,7 +130,7 @@ items: - uid: sp-http.DigestCache.serviceKey summary: The service key for IDigestCache. name: serviceKey - fullName: sp-http.DigestCache.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml index 1d5fca12..fbd01f4e 100644 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ b/SP-Framework/sp-http/graphhttpclient.yml @@ -15,7 +15,7 @@ items: content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: GraphHttpClient - fullName: sp-http.GraphHttpClient + fullName: GraphHttpClient langs: - typeScript type: class @@ -32,7 +32,7 @@ items: deprecated: content: The GraphHttpClient class has been superseded by the MSGraphClient class. name: constructor(serviceScope) - fullName: sp-http.GraphHttpClient.constructor + fullName: constructor langs: - typeScript type: constructor @@ -49,7 +49,7 @@ items: content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: configurations - fullName: sp-http.GraphHttpClient.configurations + fullName: configurations langs: - typeScript type: property @@ -72,7 +72,7 @@ items: content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: 'fetch(url, configuration, options)' - fullName: sp-http.GraphHttpClient.fetch + fullName: fetch langs: - typeScript type: method @@ -107,7 +107,7 @@ items: content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: 'get(url, configuration, options)' - fullName: sp-http.GraphHttpClient.get + fullName: get langs: - typeScript type: method @@ -140,7 +140,7 @@ items: content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: 'post(url, configuration, options)' - fullName: sp-http.GraphHttpClient.post + fullName: post langs: - typeScript type: method @@ -173,7 +173,7 @@ items: content: The GraphHttpClient class has been superseded by the MSGraphClient class. isPreview: true name: serviceKey - fullName: sp-http.GraphHttpClient.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/graphhttpclientconfiguration.yml b/SP-Framework/sp-http/graphhttpclientconfiguration.yml index ec5d4395..651833c0 100644 --- a/SP-Framework/sp-http/graphhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/graphhttpclientconfiguration.yml @@ -11,7 +11,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: GraphHttpClientConfiguration - fullName: sp-http.GraphHttpClientConfiguration + fullName: GraphHttpClientConfiguration langs: - typeScript type: class @@ -31,7 +31,7 @@ items: deprecated: content: The GraphHttpClient class has been superceded by the MSGraphClient class. name: 'constructor(flags, overrideFlags)' - fullName: sp-http.GraphHttpClientConfiguration.constructor + fullName: constructor langs: - typeScript type: constructor @@ -51,7 +51,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: flags - fullName: sp-http.GraphHttpClientConfiguration.flags + fullName: flags langs: - typeScript type: property diff --git a/SP-Framework/sp-http/graphhttpclientresponse.yml b/SP-Framework/sp-http/graphhttpclientresponse.yml index 792e83e7..3d737943 100644 --- a/SP-Framework/sp-http/graphhttpclientresponse.yml +++ b/SP-Framework/sp-http/graphhttpclientresponse.yml @@ -12,7 +12,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: GraphHttpClientResponse - fullName: sp-http.GraphHttpClientResponse + fullName: GraphHttpClientResponse langs: - typeScript type: class @@ -28,7 +28,7 @@ items: deprecated: content: The GraphHttpClient class has been superceded by the MSGraphClient class. name: constructor(response) - fullName: sp-http.GraphHttpClientResponse.constructor + fullName: constructor langs: - typeScript type: constructor @@ -44,7 +44,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: clone() - fullName: sp-http.GraphHttpClientResponse.clone + fullName: clone langs: - typeScript type: method @@ -62,7 +62,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: correlationId - fullName: sp-http.GraphHttpClientResponse.correlationId + fullName: correlationId langs: - typeScript type: property diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index f35c13fd..ecc3f4df 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -5,7 +5,7 @@ items: Typings for the GraphRequest Object For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) name: GraphRequest - fullName: sp-http.GraphRequest + fullName: GraphRequest langs: - typeScript type: class @@ -44,7 +44,7 @@ items: - uid: sp-http.GraphRequest.constructor summary: 'Constructs a new instance of the [GraphRequest](xref:sp-http.GraphRequest) class' name: 'constructor(config, path)' - fullName: sp-http.GraphRequest.constructor + fullName: constructor langs: - typeScript type: constructor @@ -61,7 +61,7 @@ items: - string - uid: sp-http.GraphRequest._headers name: _headers - fullName: sp-http.GraphRequest._headers + fullName: _headers langs: - typeScript type: property @@ -75,7 +75,7 @@ items: } - uid: sp-http.GraphRequest._responseType name: _responseType - fullName: sp-http.GraphRequest._responseType + fullName: _responseType langs: - typeScript type: property @@ -86,7 +86,7 @@ items: - string - uid: sp-http.GraphRequest.buildFullUrl name: buildFullUrl() - fullName: sp-http.GraphRequest.buildFullUrl + fullName: buildFullUrl langs: - typeScript type: method @@ -98,7 +98,7 @@ items: description: '' - uid: sp-http.GraphRequest.config name: config - fullName: sp-http.GraphRequest.config + fullName: config langs: - typeScript type: property @@ -109,7 +109,7 @@ items: - Options - uid: sp-http.GraphRequest.count name: count(count) - fullName: sp-http.GraphRequest.count + fullName: count langs: - typeScript type: method @@ -126,7 +126,7 @@ items: - boolean - uid: sp-http.GraphRequest.create name: 'create(content, callback)' - fullName: sp-http.GraphRequest.create + fullName: create langs: - typeScript type: method @@ -147,7 +147,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.del name: del(callback) - fullName: sp-http.GraphRequest.del + fullName: del langs: - typeScript type: method @@ -164,7 +164,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.delete name: delete(callback) - fullName: sp-http.GraphRequest.delete + fullName: delete langs: - typeScript type: method @@ -181,7 +181,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.expand name: expand(properties) - fullName: sp-http.GraphRequest.expand + fullName: expand langs: - typeScript type: method @@ -198,7 +198,7 @@ items: - 'string | string[]' - uid: sp-http.GraphRequest.filter name: filter(filterStr) - fullName: sp-http.GraphRequest.filter + fullName: filter langs: - typeScript type: method @@ -215,7 +215,7 @@ items: - string - uid: sp-http.GraphRequest.get name: get(callback) - fullName: sp-http.GraphRequest.get + fullName: get langs: - typeScript type: method @@ -232,7 +232,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.getStream name: getStream(callback) - fullName: sp-http.GraphRequest.getStream + fullName: getStream langs: - typeScript type: method @@ -249,7 +249,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.header name: 'header(headerKey, headerValue)' - fullName: sp-http.GraphRequest.header + fullName: header langs: - typeScript type: method @@ -270,7 +270,7 @@ items: - string - uid: sp-http.GraphRequest.headers name: headers(headers) - fullName: sp-http.GraphRequest.headers + fullName: headers langs: - typeScript type: method @@ -293,7 +293,7 @@ items: } - uid: sp-http.GraphRequest.orderby name: orderby(properties) - fullName: sp-http.GraphRequest.orderby + fullName: orderby langs: - typeScript type: method @@ -310,7 +310,7 @@ items: - 'string | string[]' - uid: sp-http.GraphRequest.parsePath name: parsePath(rawPath) - fullName: sp-http.GraphRequest.parsePath + fullName: parsePath langs: - typeScript type: method @@ -327,7 +327,7 @@ items: - string - uid: sp-http.GraphRequest.patch name: 'patch(content, callback)' - fullName: sp-http.GraphRequest.patch + fullName: patch langs: - typeScript type: method @@ -348,7 +348,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.post name: 'post(content, callback)' - fullName: sp-http.GraphRequest.post + fullName: post langs: - typeScript type: method @@ -369,7 +369,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.put name: 'put(content, callback)' - fullName: sp-http.GraphRequest.put + fullName: put langs: - typeScript type: method @@ -390,7 +390,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.putStream name: 'putStream(stream, callback)' - fullName: sp-http.GraphRequest.putStream + fullName: putStream langs: - typeScript type: method @@ -411,7 +411,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.query name: query(queryDictionaryOrString) - fullName: sp-http.GraphRequest.query + fullName: query langs: - typeScript type: method @@ -434,7 +434,7 @@ items: } - uid: sp-http.GraphRequest.responseType name: responseType(responseType) - fullName: sp-http.GraphRequest.responseType + fullName: responseType langs: - typeScript type: method @@ -451,7 +451,7 @@ items: - string - uid: sp-http.GraphRequest.select name: select(properties) - fullName: sp-http.GraphRequest.select + fullName: select langs: - typeScript type: method @@ -468,7 +468,7 @@ items: - 'string | string[]' - uid: sp-http.GraphRequest.skip name: skip(n) - fullName: sp-http.GraphRequest.skip + fullName: skip langs: - typeScript type: method @@ -485,7 +485,7 @@ items: - number - uid: sp-http.GraphRequest.skipToken name: skipToken(token) - fullName: sp-http.GraphRequest.skipToken + fullName: skipToken langs: - typeScript type: method @@ -502,7 +502,7 @@ items: - string - uid: sp-http.GraphRequest.top name: top(n) - fullName: sp-http.GraphRequest.top + fullName: top langs: - typeScript type: method @@ -519,7 +519,7 @@ items: - number - uid: sp-http.GraphRequest.update name: 'update(content, callback)' - fullName: sp-http.GraphRequest.update + fullName: update langs: - typeScript type: method @@ -540,7 +540,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.urlComponents name: urlComponents - fullName: sp-http.GraphRequest.urlComponents + fullName: urlComponents langs: - typeScript type: property @@ -551,7 +551,7 @@ items: - URLComponents - uid: sp-http.GraphRequest.version name: version(v) - fullName: sp-http.GraphRequest.version + fullName: version langs: - typeScript type: method diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 20b10abf..45b927d8 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -4,7 +4,7 @@ items: summary: HttpClient implements a basic set of features for performing REST operations against a generic service. remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead.' name: HttpClient - fullName: sp-http.HttpClient + fullName: HttpClient langs: - typeScript type: class @@ -19,7 +19,7 @@ items: - uid: sp-http.HttpClient.constructor summary: 'Constructs a new instance of the [HttpClient](xref:sp-http.HttpClient) class' name: constructor(serviceScope) - fullName: sp-http.HttpClient.constructor + fullName: constructor langs: - typeScript type: constructor @@ -33,7 +33,7 @@ items: - uid: sp-http.HttpClient.configurations summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. name: configurations - fullName: sp-http.HttpClient.configurations + fullName: configurations langs: - typeScript type: property @@ -49,7 +49,7 @@ items: HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ name: 'fetch(url, configuration, options)' - fullName: sp-http.HttpClient.fetch + fullName: fetch langs: - typeScript type: method @@ -83,7 +83,7 @@ items: - uid: sp-http.HttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' - fullName: sp-http.HttpClient.get + fullName: get langs: - typeScript type: method @@ -117,7 +117,7 @@ items: - uid: sp-http.HttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: sp-http.HttpClient.post + fullName: post langs: - typeScript type: method @@ -151,7 +151,7 @@ items: - uid: sp-http.HttpClient.serviceKey summary: The service key for HttpClient. name: serviceKey - fullName: sp-http.HttpClient.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index a520445c..df3da5ba 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -8,7 +8,7 @@ items: predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. name: HttpClientConfiguration - fullName: sp-http.HttpClientConfiguration + fullName: HttpClientConfiguration langs: - typeScript type: class @@ -25,7 +25,7 @@ items: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. name: 'constructor(flags, overrideFlags)' - fullName: sp-http.HttpClientConfiguration.constructor + fullName: constructor langs: - typeScript type: constructor @@ -42,7 +42,7 @@ items: - IHttpClientConfiguration - uid: sp-http.HttpClientConfiguration.flags name: flags - fullName: sp-http.HttpClientConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -54,7 +54,7 @@ items: - uid: sp-http.HttpClientConfiguration.initializeFlags summary: Child classes should override this method to initialize the flags object. name: initializeFlags() - fullName: sp-http.HttpClientConfiguration.initializeFlags + fullName: initializeFlags langs: - typeScript type: method @@ -69,7 +69,7 @@ items: - uid: sp-http.HttpClientConfiguration.overrideWith summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' name: overrideWith(sourceFlags) - fullName: sp-http.HttpClientConfiguration.overrideWith + fullName: overrideWith langs: - typeScript type: method diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 61b09fa6..4722ff10 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -9,7 +9,7 @@ items: This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. name: HttpClientResponse - fullName: sp-http.HttpClientResponse + fullName: HttpClientResponse langs: - typeScript type: class @@ -32,9 +32,9 @@ items: - sp-http.HttpClientResponse.type - sp-http.HttpClientResponse.url - uid: sp-http.HttpClientResponse.arrayBuffer - summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: arrayBuffer() - fullName: sp-http.HttpClientResponse.arrayBuffer + fullName: arrayBuffer langs: - typeScript type: method @@ -45,9 +45,9 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.blob - summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: blob() - fullName: sp-http.HttpClientResponse.blob + fullName: blob langs: - typeScript type: method @@ -58,9 +58,9 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.bodyUsed - summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: bodyUsed - fullName: sp-http.HttpClientResponse.bodyUsed + fullName: bodyUsed langs: - typeScript type: property @@ -71,7 +71,7 @@ items: - boolean - uid: sp-http.HttpClientResponse.clone name: clone() - fullName: sp-http.HttpClientResponse.clone + fullName: clone langs: - typeScript type: method @@ -84,9 +84,9 @@ items: - HttpClientResponse description: '' - uid: sp-http.HttpClientResponse.formData - summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: formData() - fullName: sp-http.HttpClientResponse.formData + fullName: formData langs: - typeScript type: method @@ -97,9 +97,9 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.headers - summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: headers - fullName: sp-http.HttpClientResponse.headers + fullName: headers langs: - typeScript type: property @@ -109,9 +109,9 @@ items: type: - Headers - uid: sp-http.HttpClientResponse.json - summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: json() - fullName: sp-http.HttpClientResponse.json + fullName: json langs: - typeScript type: method @@ -123,7 +123,7 @@ items: description: '' - uid: sp-http.HttpClientResponse.nativeResponse name: nativeResponse - fullName: sp-http.HttpClientResponse.nativeResponse + fullName: nativeResponse langs: - typeScript type: property @@ -133,9 +133,9 @@ items: type: - Response - uid: sp-http.HttpClientResponse.ok - summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: ok - fullName: sp-http.HttpClientResponse.ok + fullName: ok langs: - typeScript type: property @@ -145,9 +145,9 @@ items: type: - boolean - uid: sp-http.HttpClientResponse.status - summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: status - fullName: sp-http.HttpClientResponse.status + fullName: status langs: - typeScript type: property @@ -157,9 +157,9 @@ items: type: - number - uid: sp-http.HttpClientResponse.statusText - summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: statusText - fullName: sp-http.HttpClientResponse.statusText + fullName: statusText langs: - typeScript type: property @@ -169,9 +169,9 @@ items: type: - string - uid: sp-http.HttpClientResponse.text - summary: 'See documentation for the browser''s [ Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: text() - fullName: sp-http.HttpClientResponse.text + fullName: text langs: - typeScript type: method @@ -182,9 +182,9 @@ items: - Promise description: '' - uid: sp-http.HttpClientResponse.type - summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: type - fullName: sp-http.HttpClientResponse.type + fullName: type langs: - typeScript type: property @@ -194,9 +194,9 @@ items: type: - ResponseType - uid: sp-http.HttpClientResponse.url - summary: 'See documentation for the browser''s [ Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: url - fullName: sp-http.HttpClientResponse.url + fullName: url langs: - typeScript type: property diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 32fa938c..35da54d0 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.IAadHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. name: IAadHttpClientConfiguration - fullName: sp-http.IAadHttpClientConfiguration + fullName: IAadHttpClientConfiguration langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 62369e4f..95f41aec 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -9,7 +9,7 @@ items: introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) name: IAadHttpClientConfigurations - fullName: sp-http.IAadHttpClientConfigurations + fullName: IAadHttpClientConfigurations langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ name: v1 - fullName: sp-http.IAadHttpClientConfigurations.v1 + fullName: v1 langs: - typeScript type: property diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index e8b8e770..f7d6b6a1 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.IAadHttpClientOptions summary: Interface for overriding the default behavior of AadHttpClient. name: IAadHttpClientOptions - fullName: sp-http.IAadHttpClientOptions + fullName: IAadHttpClientOptions langs: - typeScript type: interface @@ -13,7 +13,7 @@ items: - sp-http.IAadHttpClientOptions.tokenProvider - uid: sp-http.IAadHttpClientOptions.configuration name: configuration - fullName: sp-http.IAadHttpClientOptions.configuration + fullName: configuration langs: - typeScript type: property @@ -24,7 +24,7 @@ items: - IAadTokenProviderConfiguration - uid: sp-http.IAadHttpClientOptions.tokenProvider name: tokenProvider - fullName: sp-http.IAadHttpClientOptions.tokenProvider + fullName: tokenProvider langs: - typeScript type: property diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 0c67ebeb..19926f1e 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -8,10 +8,10 @@ items: and expires after a server configurable amount of time. - For more information, see the MSDN article [ "Complete basic operations using SharePoint 2013 REST endpoints" - ](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) name: IDigestCache - fullName: sp-http.IDigestCache + fullName: IDigestCache langs: - typeScript type: interface @@ -27,7 +27,7 @@ items: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - fullName: sp-http.IDigestCache.addDigestToCache + fullName: addDigestToCache langs: - typeScript type: method @@ -58,7 +58,7 @@ items: - uid: sp-http.IDigestCache.clearAllDigests summary: Clears all values from the cache. name: clearAllDigests() - fullName: sp-http.IDigestCache.clearAllDigests + fullName: clearAllDigests langs: - typeScript type: method @@ -73,7 +73,7 @@ items: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. name: clearDigest(webUrl) - fullName: sp-http.IDigestCache.clearDigest + fullName: clearDigest langs: - typeScript type: method @@ -94,7 +94,7 @@ items: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. name: fetchDigest(webUrl) - fullName: sp-http.IDigestCache.fetchDigest + fullName: fetchDigest langs: - typeScript type: method diff --git a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml b/SP-Framework/sp-http/igraphhttpclientconfiguration.yml index 54d39045..9de703ee 100644 --- a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/igraphhttpclientconfiguration.yml @@ -6,7 +6,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: IGraphHttpClientConfiguration - fullName: sp-http.IGraphHttpClientConfiguration + fullName: IGraphHttpClientConfiguration langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml index ae210738..5a1d6c4d 100644 --- a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml @@ -12,7 +12,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: IGraphHttpClientConfigurations - fullName: sp-http.IGraphHttpClientConfigurations + fullName: IGraphHttpClientConfigurations langs: - typeScript type: interface @@ -27,7 +27,7 @@ items: content: The GraphHttpClient class has been superceded by the MSGraphClient class. isPreview: true name: v1 - fullName: sp-http.IGraphHttpClientConfigurations.v1 + fullName: v1 langs: - typeScript type: property diff --git a/SP-Framework/sp-http/igraphhttpclientoptions.yml b/SP-Framework/sp-http/igraphhttpclientoptions.yml index 319130f6..7ff35876 100644 --- a/SP-Framework/sp-http/igraphhttpclientoptions.yml +++ b/SP-Framework/sp-http/igraphhttpclientoptions.yml @@ -7,7 +7,7 @@ items: based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ isPreview: true name: IGraphHttpClientOptions - fullName: sp-http.IGraphHttpClientOptions + fullName: IGraphHttpClientOptions langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index fd9a9bf2..a702a6bd 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.IHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. name: IHttpClientConfiguration - fullName: sp-http.IHttpClientConfiguration + fullName: IHttpClientConfiguration langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index c1ff7660..2408db35 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -9,7 +9,7 @@ items: introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) name: IHttpClientConfigurations - fullName: sp-http.IHttpClientConfigurations + fullName: IHttpClientConfigurations langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ name: v1 - fullName: sp-http.IHttpClientConfigurations.v1 + fullName: v1 langs: - typeScript type: property diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index 58a5db7e..d8a39fb6 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -6,7 +6,7 @@ items: This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ name: IHttpClientOptions - fullName: sp-http.IHttpClientOptions + fullName: IHttpClientOptions langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 891e21df..52158dc6 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -4,7 +4,7 @@ items: summary: Flags interface for SPHttpClientBatchConfiguration. isPreview: true name: ISPHttpClientBatchConfiguration - fullName: sp-http.ISPHttpClientBatchConfiguration + fullName: ISPHttpClientBatchConfiguration langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 5281f9d8..3809b060 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -10,7 +10,7 @@ items: the time when it was tested.) isPreview: true name: ISPHttpClientBatchConfigurations - fullName: sp-http.ISPHttpClientBatchConfigurations + fullName: ISPHttpClientBatchConfigurations langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' isPreview: true name: v1 - fullName: sp-http.ISPHttpClientBatchConfigurations.v1 + fullName: v1 langs: - typeScript type: property diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 5ffcbf05..9478aaee 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -4,7 +4,7 @@ items: summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. isPreview: true name: ISPHttpClientBatchCreationOptions - fullName: sp-http.ISPHttpClientBatchCreationOptions + fullName: ISPHttpClientBatchCreationOptions langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: fetch(), but if not, the webUrl can be explicitly specified using this option. isPreview: true name: webUrl - fullName: sp-http.ISPHttpClientBatchCreationOptions.webUrl + fullName: webUrl langs: - typeScript type: property diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 3262ff68..457119a5 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -6,7 +6,7 @@ items: based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ isPreview: true name: ISPHttpClientBatchOptions - fullName: sp-http.ISPHttpClientBatchOptions + fullName: ISPHttpClientBatchOptions langs: - typeScript type: interface diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index aeabdaee..f395a6be 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.ISPHttpClientCommonConfiguration summary: Flags interface for SPHttpClientCommonConfiguration name: ISPHttpClientCommonConfiguration - fullName: sp-http.ISPHttpClientCommonConfiguration + fullName: ISPHttpClientCommonConfiguration langs: - typeScript type: interface @@ -28,7 +28,7 @@ items: For OData 4.0, the value is 'application/json;charset=utf-8'. name: jsonRequest - fullName: sp-http.ISPHttpClientCommonConfiguration.jsonRequest + fullName: jsonRequest langs: - typeScript type: property @@ -48,7 +48,7 @@ items: For OData 4.0, the value is 'application/json;odata.metadata=minimal'. name: jsonResponse - fullName: sp-http.ISPHttpClientCommonConfiguration.jsonResponse + fullName: jsonResponse langs: - typeScript type: property diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 85701ccf..906443c8 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.ISPHttpClientConfiguration summary: Flags interface for SPHttpClientConfiguration. name: ISPHttpClientConfiguration - fullName: sp-http.ISPHttpClientConfiguration + fullName: ISPHttpClientConfiguration langs: - typeScript type: interface @@ -24,7 +24,7 @@ items: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. name: defaultODataVersion - fullName: sp-http.ISPHttpClientConfiguration.defaultODataVersion + fullName: defaultODataVersion langs: - typeScript type: property @@ -45,7 +45,7 @@ items: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials name: defaultSameOriginCredentials - fullName: sp-http.ISPHttpClientConfiguration.defaultSameOriginCredentials + fullName: defaultSameOriginCredentials langs: - typeScript type: property @@ -64,7 +64,7 @@ items: request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. name: requestDigest - fullName: sp-http.ISPHttpClientConfiguration.requestDigest + fullName: requestDigest langs: - typeScript type: property diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 1e89944f..bc3d7ee0 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -9,7 +9,7 @@ items: introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) name: ISPHttpClientConfigurations - fullName: sp-http.ISPHttpClientConfigurations + fullName: ISPHttpClientConfigurations langs: - typeScript type: interface @@ -24,7 +24,7 @@ items: consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true name: v1 - fullName: sp-http.ISPHttpClientConfigurations.v1 + fullName: v1 langs: - typeScript type: property diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index f187428d..036ab964 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -5,7 +5,7 @@ items: This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ name: ISPHttpClientOptions - fullName: sp-http.ISPHttpClientOptions + fullName: ISPHttpClientOptions langs: - typeScript type: interface @@ -23,7 +23,7 @@ items: as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option. name: webUrl - fullName: sp-http.ISPHttpClientOptions.webUrl + fullName: webUrl langs: - typeScript type: property diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 1b65dc62..b49270b0 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -16,7 +16,7 @@ items: For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) name: MSGraphClient - fullName: sp-http.MSGraphClient + fullName: MSGraphClient langs: - typeScript type: class @@ -33,7 +33,7 @@ items: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript name: 'api(path, config)' - fullName: sp-http.MSGraphClient.api + fullName: api langs: - typeScript type: method diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 0cd49ea8..37cf5d1d 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MSGraphClientFactory class. name: MSGraphClientFactory - fullName: sp-http.MSGraphClientFactory + fullName: MSGraphClientFactory langs: - typeScript type: class @@ -21,7 +21,7 @@ items: Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. name: getClient() - fullName: sp-http.MSGraphClientFactory.getClient + fullName: getClient langs: - typeScript type: method @@ -34,7 +34,7 @@ items: - uid: sp-http.MSGraphClientFactory.serviceKey summary: The service key for MSGraphClientFactory. name: serviceKey - fullName: sp-http.MSGraphClientFactory.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 0446ad22..98199dde 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.ODataVersion summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' name: ODataVersion - fullName: sp-http.ODataVersion + fullName: ODataVersion langs: - typeScript type: class @@ -18,7 +18,7 @@ items: If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. name: tryParseFromHeaders(headers) - fullName: sp-http.ODataVersion.tryParseFromHeaders + fullName: tryParseFromHeaders langs: - typeScript type: method @@ -36,7 +36,7 @@ items: - uid: sp-http.ODataVersion.v3 summary: Represents version 3.0 for the "OData-Version" header name: v3 - fullName: sp-http.ODataVersion.v3 + fullName: v3 langs: - typeScript type: property @@ -48,7 +48,7 @@ items: - uid: sp-http.ODataVersion.v4 summary: Represents version 4.0 for the "OData-Version" header name: v4 - fullName: sp-http.ODataVersion.v4 + fullName: v4 langs: - typeScript type: property diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 8eca7c01..f1353c2b 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -9,7 +9,7 @@ items: For communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class. name: SPHttpClient - fullName: sp-http.SPHttpClient + fullName: SPHttpClient langs: - typeScript type: class @@ -26,7 +26,7 @@ items: - uid: sp-http.SPHttpClient.constructor summary: 'Constructs a new instance of the [SPHttpClient](xref:sp-http.SPHttpClient) class' name: constructor(serviceScope) - fullName: sp-http.SPHttpClient.constructor + fullName: constructor langs: - typeScript type: constructor @@ -41,7 +41,7 @@ items: summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' isPreview: true name: beginBatch(batchCreationOptions) - fullName: sp-http.SPHttpClient.beginBatch + fullName: beginBatch langs: - typeScript type: method @@ -59,7 +59,7 @@ items: - uid: sp-http.SPHttpClient.configurations summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. name: configurations - fullName: sp-http.SPHttpClient.configurations + fullName: configurations langs: - typeScript type: property @@ -93,7 +93,7 @@ items: appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. name: 'fetch(url, configuration, options)' - fullName: sp-http.SPHttpClient.fetch + fullName: fetch langs: - typeScript type: method @@ -127,7 +127,7 @@ items: - uid: sp-http.SPHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' - fullName: sp-http.SPHttpClient.get + fullName: get langs: - typeScript type: method @@ -173,7 +173,7 @@ items: If the URL cannot be determined, an exception is thrown. name: getWebUrlFromRequestUrl(requestUrl) - fullName: sp-http.SPHttpClient.getWebUrlFromRequestUrl + fullName: getWebUrlFromRequestUrl langs: - typeScript type: method @@ -191,7 +191,7 @@ items: - uid: sp-http.SPHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: sp-http.SPHttpClient.post + fullName: post langs: - typeScript type: method @@ -225,7 +225,7 @@ items: - uid: sp-http.SPHttpClient.serviceKey summary: The service key for SPHttpClient. name: serviceKey - fullName: sp-http.SPHttpClient.serviceKey + fullName: serviceKey langs: - typeScript type: property diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index bed988e1..6eea0767 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -15,7 +15,7 @@ items: create subclasses that extend the SPHttpClientBatch class. isPreview: true name: SPHttpClientBatch - fullName: sp-http.SPHttpClientBatch + fullName: SPHttpClientBatch langs: - typeScript type: class @@ -30,7 +30,7 @@ items: summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. isPreview: true name: configurations - fullName: sp-http.SPHttpClientBatch.configurations + fullName: configurations langs: - typeScript type: property @@ -43,7 +43,7 @@ items: summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). isPreview: true name: execute() - fullName: sp-http.SPHttpClientBatch.execute + fullName: execute langs: - typeScript type: method @@ -74,7 +74,7 @@ items: explicitly. isPreview: true name: 'fetch(url, configuration, options)' - fullName: sp-http.SPHttpClientBatch.fetch + fullName: fetch langs: - typeScript type: method @@ -109,7 +109,7 @@ items: summary: 'Calls fetch(), but sets the method to ''GET''.' isPreview: true name: 'get(url, configuration, options)' - fullName: sp-http.SPHttpClientBatch.get + fullName: get langs: - typeScript type: method @@ -144,7 +144,7 @@ items: summary: 'Calls fetch(), but sets the method to ''POST''.' isPreview: true name: 'post(url, configuration, options)' - fullName: sp-http.SPHttpClientBatch.post + fullName: post langs: - typeScript type: method diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 29035010..9e6872b4 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -9,7 +9,7 @@ items: changed via the SPHttpClientBatchConfiguration.overrideWith() method. isPreview: true name: SPHttpClientBatchConfiguration - fullName: sp-http.SPHttpClientBatchConfiguration + fullName: SPHttpClientBatchConfiguration langs: - typeScript type: class @@ -28,7 +28,7 @@ items: Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. name: 'constructor(flags, overrideFlags)' - fullName: sp-http.SPHttpClientBatchConfiguration.constructor + fullName: constructor langs: - typeScript type: constructor @@ -46,7 +46,7 @@ items: - uid: sp-http.SPHttpClientBatchConfiguration.flags isPreview: true name: flags - fullName: sp-http.SPHttpClientBatchConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -58,7 +58,7 @@ items: - uid: sp-http.SPHttpClientBatchConfiguration.initializeFlags isPreview: true name: initializeFlags() - fullName: sp-http.SPHttpClientBatchConfiguration.initializeFlags + fullName: initializeFlags langs: - typeScript type: method @@ -73,7 +73,7 @@ items: - uid: sp-http.SPHttpClientBatchConfiguration.overrideWith isPreview: true name: overrideWith(sourceFlags) - fullName: sp-http.SPHttpClientBatchConfiguration.overrideWith + fullName: overrideWith langs: - typeScript type: method diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 252b96b2..b8881f93 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.SPHttpClientCommonConfiguration summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. name: SPHttpClientCommonConfiguration - fullName: sp-http.SPHttpClientCommonConfiguration + fullName: SPHttpClientCommonConfiguration langs: - typeScript type: class @@ -25,7 +25,7 @@ items: The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. name: 'constructor(flags, overrideFlags)' - fullName: sp-http.SPHttpClientCommonConfiguration.constructor + fullName: constructor langs: - typeScript type: constructor @@ -42,7 +42,7 @@ items: - ISPHttpClientCommonConfiguration - uid: sp-http.SPHttpClientCommonConfiguration.flags name: flags - fullName: sp-http.SPHttpClientCommonConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -53,7 +53,7 @@ items: - ISPHttpClientCommonConfiguration - uid: sp-http.SPHttpClientCommonConfiguration.initializeFlags name: initializeFlags() - fullName: sp-http.SPHttpClientCommonConfiguration.initializeFlags + fullName: initializeFlags langs: - typeScript type: method @@ -80,7 +80,7 @@ items: For OData 4.0, the value is 'application/json;charset=utf-8'. name: jsonRequest - fullName: sp-http.SPHttpClientCommonConfiguration.jsonRequest + fullName: jsonRequest langs: - typeScript type: property @@ -100,7 +100,7 @@ items: For OData 4.0, the value is 'application/json;odata.metadata=minimal'. name: jsonResponse - fullName: sp-http.SPHttpClientCommonConfiguration.jsonResponse + fullName: jsonResponse langs: - typeScript type: property @@ -111,7 +111,7 @@ items: - boolean - uid: sp-http.SPHttpClientCommonConfiguration.overrideWith name: overrideWith(sourceFlags) - fullName: sp-http.SPHttpClientCommonConfiguration.overrideWith + fullName: overrideWith langs: - typeScript type: method diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 78e93ac9..b5cc13a2 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -8,7 +8,7 @@ items: the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method. name: SPHttpClientConfiguration - fullName: sp-http.SPHttpClientConfiguration + fullName: SPHttpClientConfiguration langs: - typeScript type: class @@ -30,7 +30,7 @@ items: Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. name: 'constructor(flags, overrideFlags)' - fullName: sp-http.SPHttpClientConfiguration.constructor + fullName: constructor langs: - typeScript type: constructor @@ -55,7 +55,7 @@ items: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. name: defaultODataVersion - fullName: sp-http.SPHttpClientConfiguration.defaultODataVersion + fullName: defaultODataVersion langs: - typeScript type: property @@ -76,7 +76,7 @@ items: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials name: defaultSameOriginCredentials - fullName: sp-http.SPHttpClientConfiguration.defaultSameOriginCredentials + fullName: defaultSameOriginCredentials langs: - typeScript type: property @@ -87,7 +87,7 @@ items: - boolean - uid: sp-http.SPHttpClientConfiguration.flags name: flags - fullName: sp-http.SPHttpClientConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -98,7 +98,7 @@ items: - ISPHttpClientConfiguration - uid: sp-http.SPHttpClientConfiguration.initializeFlags name: initializeFlags() - fullName: sp-http.SPHttpClientConfiguration.initializeFlags + fullName: initializeFlags langs: - typeScript type: method @@ -112,7 +112,7 @@ items: description: '' - uid: sp-http.SPHttpClientConfiguration.overrideWith name: overrideWith(sourceFlags) - fullName: sp-http.SPHttpClientConfiguration.overrideWith + fullName: overrideWith langs: - typeScript type: method @@ -139,7 +139,7 @@ items: request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. name: requestDigest - fullName: sp-http.SPHttpClientConfiguration.requestDigest + fullName: requestDigest langs: - typeScript type: property diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index e37ddf31..fe0f7092 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -7,7 +7,7 @@ items: This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. name: SPHttpClientResponse - fullName: sp-http.SPHttpClientResponse + fullName: SPHttpClientResponse langs: - typeScript type: class @@ -21,7 +21,7 @@ items: - uid: sp-http.SPHttpClientResponse.constructor summary: 'Constructs a new instance of the [SPHttpClientResponse](xref:sp-http.SPHttpClientResponse) class' name: constructor(response) - fullName: sp-http.SPHttpClientResponse.constructor + fullName: constructor langs: - typeScript type: constructor @@ -34,7 +34,7 @@ items: - Response - uid: sp-http.SPHttpClientResponse.clone name: clone() - fullName: sp-http.SPHttpClientResponse.clone + fullName: clone langs: - typeScript type: method @@ -54,7 +54,7 @@ items: correlation ID as the "sprequestguid" header. isPreview: true name: correlationId - fullName: sp-http.SPHttpClientResponse.correlationId + fullName: correlationId langs: - typeScript type: property diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 1f148208..63464a21 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -4,7 +4,7 @@ items: summary: 'Standard HTTP headers used with [SPHttpClient](xref:sp-http.SPHttpClient)' isPreview: true name: SPHttpHeader - fullName: sp-http.SPHttpHeader + fullName: SPHttpHeader langs: - typeScript type: enum @@ -18,7 +18,7 @@ items: Example value: "9417279e-40e1-0000-2465-306ba786bfd7" isPreview: true name: SPRequestGuid - fullName: sp-http.SPHttpHeader.SPRequestGuid + fullName: SPRequestGuid langs: - typeScript type: field diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 45ecf423..7ee17c74 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -3,7 +3,7 @@ items: - uid: sp-http.TokenAcquisitionEventArgs summary: Arguments for a token acquisition failure event. name: TokenAcquisitionEventArgs - fullName: sp-http.TokenAcquisitionEventArgs + fullName: TokenAcquisitionEventArgs langs: - typeScript type: class @@ -17,7 +17,7 @@ items: - uid: sp-http.TokenAcquisitionEventArgs.constructor summary: 'Constructs a new instance of the [TokenAcquisitionEventArgs](xref:sp-http.TokenAcquisitionEventArgs) class' name: 'constructor(message, redirectUrl)' - fullName: sp-http.TokenAcquisitionEventArgs.constructor + fullName: constructor langs: - typeScript type: constructor @@ -35,7 +35,7 @@ items: - uid: sp-http.TokenAcquisitionEventArgs.message summary: The message returned from ADAL fails to retrieve a token from Azure AD. name: message - fullName: sp-http.TokenAcquisitionEventArgs.message + fullName: message langs: - typeScript type: property @@ -47,7 +47,7 @@ items: - uid: sp-http.TokenAcquisitionEventArgs.redirectUrl summary: The url of the page for the end user to perform Multi Factor Authentication name: redirectUrl - fullName: sp-http.TokenAcquisitionEventArgs.redirectUrl + fullName: redirectUrl langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index e0e7fe53..0982ff09 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -3,7 +3,7 @@ items: - uid: sp-listview-extensibility summary: SharePoint Framework support for customizing the list view. name: '@microsoft/sp-listview-extensibility' - fullName: sp-listview-extensibility + fullName: '@microsoft/sp-listview-extensibility' langs: - typeScript type: package diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 0a5e39dd..925f1d14 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -8,7 +8,7 @@ items: In the component manifest, the "extensionType" should be set to "FieldCustomizer". name: BaseFieldCustomizer - fullName: sp-listview-extensibility.BaseFieldCustomizer + fullName: BaseFieldCustomizer langs: - typeScript type: class @@ -26,7 +26,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-listview-extensibility.BaseFieldCustomizer.context + fullName: context langs: - typeScript type: property @@ -37,7 +37,7 @@ items: - FieldCustomizerContext - uid: sp-listview-extensibility.BaseFieldCustomizer.onDisposeCell name: onDisposeCell(event) - fullName: sp-listview-extensibility.BaseFieldCustomizer.onDisposeCell + fullName: onDisposeCell langs: - typeScript type: method @@ -54,7 +54,7 @@ items: - IFieldCustomizerCellEventParameters - uid: sp-listview-extensibility.BaseFieldCustomizer.onRenderCell name: onRenderCell(event) - fullName: sp-listview-extensibility.BaseFieldCustomizer.onRenderCell + fullName: onRenderCell langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index c4d7d6ad..d7a53809 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -11,7 +11,7 @@ items: In the component manifest, the "extensionType" should be set to "ListViewCommandSet". name: BaseListViewCommandSet - fullName: sp-listview-extensibility.BaseListViewCommandSet + fullName: BaseListViewCommandSet langs: - typeScript type: class @@ -30,7 +30,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-listview-extensibility.BaseListViewCommandSet.context + fullName: context langs: - typeScript type: property @@ -42,7 +42,7 @@ items: - uid: sp-listview-extensibility.BaseListViewCommandSet.onExecute summary: 'This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item.' name: onExecute(event) - fullName: sp-listview-extensibility.BaseListViewCommandSet.onExecute + fullName: onExecute langs: - typeScript type: method @@ -63,7 +63,7 @@ items: This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title. name: onListViewUpdated(event) - fullName: sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated + fullName: onListViewUpdated langs: - typeScript type: method @@ -81,7 +81,7 @@ items: - uid: sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand summary: Returns the command with the given id. Returns undefined if there is not command with the given id. name: tryGetCommand(id) - fullName: sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand + fullName: tryGetCommand langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index aa99ff4e..0d636d8f 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -13,7 +13,7 @@ items: A "column" is the visual presentation of a field, when displayed by the ListView. name: ColumnAccessor - fullName: sp-listview-extensibility.ColumnAccessor + fullName: ColumnAccessor langs: - typeScript type: class @@ -24,7 +24,7 @@ items: - uid: sp-listview-extensibility.ColumnAccessor.field summary: The server-side definition of the field. This property is read-only. name: field - fullName: sp-listview-extensibility.ColumnAccessor.field + fullName: field langs: - typeScript type: property @@ -36,7 +36,7 @@ items: - uid: sp-listview-extensibility.ColumnAccessor.visible summary: Whether to show this column in the list view. This property is read-only. name: visible - fullName: sp-listview-extensibility.ColumnAccessor.visible + fullName: visible langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index e6ff38c3..f17a0df3 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -10,7 +10,7 @@ items: -->. The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. name: Command - fullName: sp-listview-extensibility.Command + fullName: Command langs: - typeScript type: class @@ -26,7 +26,7 @@ items: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." name: ariaLabel - fullName: sp-listview-extensibility.Command.ariaLabel + fullName: ariaLabel langs: - typeScript type: property @@ -41,7 +41,7 @@ items: the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. name: iconImageUrl - fullName: sp-listview-extensibility.Command.iconImageUrl + fullName: iconImageUrl langs: - typeScript type: property @@ -53,7 +53,7 @@ items: - uid: sp-listview-extensibility.Command.id summary: Id of the command. name: id - fullName: sp-listview-extensibility.Command.id + fullName: id langs: - typeScript type: property @@ -73,7 +73,7 @@ items: alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension. name: title - fullName: sp-listview-extensibility.Command.title + fullName: title langs: - typeScript type: property @@ -85,7 +85,7 @@ items: - uid: sp-listview-extensibility.Command.visible summary: True if the command is visible. name: visible - fullName: sp-listview-extensibility.Command.visible + fullName: visible langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index be01b550..13e168bf 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FieldCustomizerContext class. name: FieldCustomizerContext - fullName: sp-listview-extensibility.FieldCustomizerContext + fullName: FieldCustomizerContext langs: - typeScript type: class @@ -19,7 +19,7 @@ items: - uid: sp-listview-extensibility.FieldCustomizerContext.field summary: Provides access to the SharePoint field that the customizer will operate on. name: field - fullName: sp-listview-extensibility.FieldCustomizerContext.field + fullName: field langs: - typeScript type: property @@ -36,7 +36,7 @@ items: Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. name: tryGetListView() - fullName: sp-listview-extensibility.FieldCustomizerContext.tryGetListView + fullName: tryGetListView langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index f7dc7547..7b348e02 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -3,7 +3,7 @@ items: - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters summary: Event parameters for BaseFieldCustomizer.onRenderCell() name: IFieldCustomizerCellEventParameters - fullName: sp-listview-extensibility.IFieldCustomizerCellEventParameters + fullName: IFieldCustomizerCellEventParameters langs: - typeScript type: interface @@ -18,7 +18,7 @@ items: The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. name: domElement - fullName: sp-listview-extensibility.IFieldCustomizerCellEventParameters.domElement + fullName: domElement langs: - typeScript type: property @@ -30,7 +30,7 @@ items: - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.fieldValue summary: The value of the field being rendered. name: fieldValue - fullName: sp-listview-extensibility.IFieldCustomizerCellEventParameters.fieldValue + fullName: fieldValue langs: - typeScript type: property @@ -42,7 +42,7 @@ items: - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.listItem summary: The list item being edited. name: listItem - fullName: sp-listview-extensibility.IFieldCustomizerCellEventParameters.listItem + fullName: listItem langs: - typeScript type: property @@ -58,7 +58,7 @@ items: to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed. name: userData - fullName: sp-listview-extensibility.IFieldCustomizerCellEventParameters.userData + fullName: userData langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index fd869947..e678fab3 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -3,7 +3,7 @@ items: - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters summary: 'Parameters for [BaseListViewCommandSet.onExecute](xref:sp-listview-extensibility.BaseListViewCommandSet.onExecute)' name: IListViewCommandSetExecuteEventParameters - fullName: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters + fullName: IListViewCommandSetExecuteEventParameters langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. name: itemId - fullName: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.itemId + fullName: itemId langs: - typeScript type: property @@ -28,7 +28,7 @@ items: - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' name: selectedRows - fullName: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.selectedRows + fullName: selectedRows langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 56a04b1b..66586ad4 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -5,7 +5,7 @@ items: Parameters for [BaseListViewCommandSet.onListViewUpdated](xref:sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated) name: IListViewCommandSetListViewUpdatedParameters - fullName: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters + fullName: IListViewCommandSetListViewUpdatedParameters langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters.selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' name: selectedRows - fullName: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters.selectedRows + fullName: selectedRows langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 77eb964c..d63fa4a7 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -18,7 +18,7 @@ items: ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not. name: ListItemAccessor - fullName: sp-listview-extensibility.ListItemAccessor + fullName: ListItemAccessor langs: - typeScript type: class @@ -34,7 +34,7 @@ items: corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type. name: fields - fullName: sp-listview-extensibility.ListItemAccessor.fields + fullName: fields langs: - typeScript type: property @@ -48,7 +48,7 @@ items: Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. name: getValue(field) - fullName: sp-listview-extensibility.ListItemAccessor.getValue + fullName: getValue langs: - typeScript type: method @@ -68,7 +68,7 @@ items: Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. name: getValueByName(internalName) - fullName: sp-listview-extensibility.ListItemAccessor.getValueByName + fullName: getValueByName langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 05b13a38..47e02b01 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewAccessor class. name: ListViewAccessor - fullName: sp-listview-extensibility.ListViewAccessor + fullName: ListViewAccessor langs: - typeScript type: class @@ -18,7 +18,7 @@ items: - uid: sp-listview-extensibility.ListViewAccessor.columns summary: 'The columns in associated with this view, including hidden columns.' name: columns - fullName: sp-listview-extensibility.ListViewAccessor.columns + fullName: columns langs: - typeScript type: property @@ -30,7 +30,7 @@ items: - uid: sp-listview-extensibility.ListViewAccessor.selectedRowsChangedEvent summary: Event that gets raised every time the selected items in the list view change. name: selectedRowsChangedEvent - fullName: sp-listview-extensibility.ListViewAccessor.selectedRowsChangedEvent + fullName: selectedRowsChangedEvent langs: - typeScript type: event @@ -44,7 +44,7 @@ items: Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. name: tryGetColumnByName(internalName) - fullName: sp-listview-extensibility.ListViewAccessor.tryGetColumnByName + fullName: tryGetColumnByName langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index 18bb046b..e1f74809 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -6,7 +6,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewCommandSetContext class. name: ListViewCommandSetContext - fullName: sp-listview-extensibility.ListViewCommandSetContext + fullName: ListViewCommandSetContext langs: - typeScript type: class @@ -19,7 +19,7 @@ items: - uid: sp-listview-extensibility.ListViewCommandSetContext.listView summary: Provides access to the ListView control that the customizer will operate on. name: listView - fullName: sp-listview-extensibility.ListViewCommandSetContext.listView + fullName: listView langs: - typeScript type: property @@ -31,7 +31,7 @@ items: - uid: sp-listview-extensibility.ListViewCommandSetContext.manifest summary: Manifest for the client-side component. name: manifest - fullName: sp-listview-extensibility.ListViewCommandSetContext.manifest + fullName: manifest langs: - typeScript type: property diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 95bee9da..8742d58b 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -14,7 +14,7 @@ items: A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns. name: RowAccessor - fullName: sp-listview-extensibility.RowAccessor + fullName: RowAccessor langs: - typeScript type: class diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 448e2771..7b923352 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -3,7 +3,7 @@ items: - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs summary: Arguments for the selected rows changed event. name: SelectedRowsChangedEventArgs - fullName: sp-listview-extensibility.SelectedRowsChangedEventArgs + fullName: SelectedRowsChangedEventArgs langs: - typeScript type: class @@ -15,7 +15,7 @@ items: - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows summary: The list of rows that were selected in the list view at the time when the event was fired. name: selectedRows - fullName: sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows + fullName: selectedRows langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index dfadd082..83c0b9d5 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -7,7 +7,7 @@ items: It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions. name: '@microsoft/sp-odata-types' - fullName: sp-odata-types + fullName: '@microsoft/sp-odata-types' langs: - typeScript type: package diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 89e4d8e1..82310c1e 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -3,7 +3,7 @@ items: - uid: sp-odata-types.IODataBasePermission summary: Data used for creating a SPPermission object. name: IODataBasePermission - fullName: sp-odata-types.IODataBasePermission + fullName: IODataBasePermission langs: - typeScript type: interface @@ -13,7 +13,7 @@ items: - sp-odata-types.IODataBasePermission.Low - uid: sp-odata-types.IODataBasePermission.High name: High - fullName: sp-odata-types.IODataBasePermission.High + fullName: High langs: - typeScript type: property @@ -24,7 +24,7 @@ items: - number - uid: sp-odata-types.IODataBasePermission.Low name: Low - fullName: sp-odata-types.IODataBasePermission.Low + fullName: Low langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index 30f1bb13..af54d375 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataChangeToken - fullName: sp-odata-types.IODataChangeToken + fullName: IODataChangeToken langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-odata-types.IODataChangeToken.StringValue summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' name: StringValue - fullName: sp-odata-types.IODataChangeToken.StringValue + fullName: StringValue langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 287dad03..5876e51b 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataContextWebInformation - fullName: sp-odata-types.IODataContextWebInformation + fullName: IODataContextWebInformation langs: - typeScript type: interface @@ -18,7 +18,7 @@ items: - uid: sp-odata-types.IODataContextWebInformation.LibraryVersion summary: 'Example: `"16.0.4919.3000"`' name: LibraryVersion - fullName: sp-odata-types.IODataContextWebInformation.LibraryVersion + fullName: LibraryVersion langs: - typeScript type: property @@ -30,7 +30,7 @@ items: - uid: sp-odata-types.IODataContextWebInformation.SiteFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: SiteFullUrl - fullName: sp-odata-types.IODataContextWebInformation.SiteFullUrl + fullName: SiteFullUrl langs: - typeScript type: property @@ -42,7 +42,7 @@ items: - uid: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' name: SupportedSchemaVersions - fullName: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions + fullName: SupportedSchemaVersions langs: - typeScript type: property @@ -54,7 +54,7 @@ items: - uid: sp-odata-types.IODataContextWebInformation.WebFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: WebFullUrl - fullName: sp-odata-types.IODataContextWebInformation.WebFullUrl + fullName: WebFullUrl langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index b7b88aa5..7751c81f 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataList - fullName: sp-odata-types.IODataList + fullName: IODataList langs: - typeScript type: interface @@ -27,7 +27,7 @@ items: - uid: sp-odata-types.IODataList.BaseTemplate summary: The list definition type on which the list is based. name: BaseTemplate - fullName: sp-odata-types.IODataList.BaseTemplate + fullName: BaseTemplate langs: - typeScript type: property @@ -39,7 +39,7 @@ items: - uid: sp-odata-types.IODataList.Created summary: 'Example: `"/Date(1453294804000)/"`' name: Created - fullName: sp-odata-types.IODataList.Created + fullName: Created langs: - typeScript type: property @@ -51,7 +51,7 @@ items: - uid: sp-odata-types.IODataList.CurrentChangeToken summary: The change token that will be used in logging the next change to the list. name: CurrentChangeToken - fullName: sp-odata-types.IODataList.CurrentChangeToken + fullName: CurrentChangeToken langs: - typeScript type: property @@ -63,7 +63,7 @@ items: - uid: sp-odata-types.IODataList.Description summary: A description of the List. name: Description - fullName: sp-odata-types.IODataList.Description + fullName: Description langs: - typeScript type: property @@ -75,7 +75,7 @@ items: - uid: sp-odata-types.IODataList.EntityTypeName summary: 'Example: `"MyListTitleList"`' name: EntityTypeName - fullName: sp-odata-types.IODataList.EntityTypeName + fullName: EntityTypeName langs: - typeScript type: property @@ -89,7 +89,7 @@ items: A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. name: Hidden - fullName: sp-odata-types.IODataList.Hidden + fullName: Hidden langs: - typeScript type: property @@ -101,7 +101,7 @@ items: - uid: sp-odata-types.IODataList.Id summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' name: Id - fullName: sp-odata-types.IODataList.Id + fullName: Id langs: - typeScript type: property @@ -113,7 +113,7 @@ items: - uid: sp-odata-types.IODataList.LastItemDeletedDate summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemDeletedDate - fullName: sp-odata-types.IODataList.LastItemDeletedDate + fullName: LastItemDeletedDate langs: - typeScript type: property @@ -125,7 +125,7 @@ items: - uid: sp-odata-types.IODataList.LastItemModifiedDate summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemModifiedDate - fullName: sp-odata-types.IODataList.LastItemModifiedDate + fullName: LastItemModifiedDate langs: - typeScript type: property @@ -137,7 +137,7 @@ items: - uid: sp-odata-types.IODataList.ListItemEntityTypeFullName summary: 'Example: `"SP.Data.MyListTitleListItem"`' name: ListItemEntityTypeFullName - fullName: sp-odata-types.IODataList.ListItemEntityTypeFullName + fullName: ListItemEntityTypeFullName langs: - typeScript type: property @@ -149,7 +149,7 @@ items: - uid: sp-odata-types.IODataList.ParentWebUrl summary: 'Example: `"/sites/PubSite"`' name: ParentWebUrl - fullName: sp-odata-types.IODataList.ParentWebUrl + fullName: ParentWebUrl langs: - typeScript type: property @@ -161,7 +161,7 @@ items: - uid: sp-odata-types.IODataList.TemplateFeatureId summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' name: TemplateFeatureId - fullName: sp-odata-types.IODataList.TemplateFeatureId + fullName: TemplateFeatureId langs: - typeScript type: property @@ -173,7 +173,7 @@ items: - uid: sp-odata-types.IODataList.Title summary: 'Example: `"Pages"`' name: Title - fullName: sp-odata-types.IODataList.Title + fullName: Title langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index ac40614b..744049c4 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataListItem - fullName: sp-odata-types.IODataListItem + fullName: IODataListItem langs: - typeScript type: interface @@ -18,7 +18,7 @@ items: - uid: sp-odata-types.IODataListItem.ContentTypeId summary: 'Example: `{ StringValue: "0x010100C5..." }`' name: ContentTypeId - fullName: sp-odata-types.IODataListItem.ContentTypeId + fullName: ContentTypeId langs: - typeScript type: property @@ -32,7 +32,7 @@ items: } - uid: sp-odata-types.IODataListItem.ID name: ID - fullName: sp-odata-types.IODataListItem.ID + fullName: ID langs: - typeScript type: property @@ -44,7 +44,7 @@ items: - uid: sp-odata-types.IODataListItem.Title summary: Title of the List Item name: Title - fullName: sp-odata-types.IODataListItem.Title + fullName: Title langs: - typeScript type: property @@ -56,7 +56,7 @@ items: - uid: sp-odata-types.IODataListItem.UniqueId summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' name: UniqueId - fullName: sp-odata-types.IODataListItem.UniqueId + fullName: UniqueId langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index d8959057..e684029c 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.NavigationNode object. [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) name: IODataNavigationNode - fullName: sp-odata-types.IODataNavigationNode + fullName: IODataNavigationNode langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: - uid: sp-odata-types.IODataNavigationNode.Children summary: Gets or sets an array of Navigation Nodes that are children to the current node. name: Children - fullName: sp-odata-types.IODataNavigationNode.Children + fullName: Children langs: - typeScript type: property @@ -33,7 +33,7 @@ items: - uid: sp-odata-types.IODataNavigationNode.Id summary: Gets a value that specifies the identifier for the navigation node. name: Id - fullName: sp-odata-types.IODataNavigationNode.Id + fullName: Id langs: - typeScript type: property @@ -44,7 +44,7 @@ items: - number - uid: sp-odata-types.IODataNavigationNode.IsDocLib name: IsDocLib - fullName: sp-odata-types.IODataNavigationNode.IsDocLib + fullName: IsDocLib langs: - typeScript type: property @@ -58,7 +58,7 @@ items: Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. name: IsExternal - fullName: sp-odata-types.IODataNavigationNode.IsExternal + fullName: IsExternal langs: - typeScript type: property @@ -70,7 +70,7 @@ items: - uid: sp-odata-types.IODataNavigationNode.IsVisible summary: Gets or sets a value that specifies if the node navigation link should be visible. name: IsVisible - fullName: sp-odata-types.IODataNavigationNode.IsVisible + fullName: IsVisible langs: - typeScript type: property @@ -82,7 +82,7 @@ items: - uid: sp-odata-types.IODataNavigationNode.Title summary: Gets or sets a value that specifies the anchor text for the node navigation link. name: Title - fullName: sp-odata-types.IODataNavigationNode.Title + fullName: Title langs: - typeScript type: property @@ -96,7 +96,7 @@ items: Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. name: Url - fullName: sp-odata-types.IODataNavigationNode.Url + fullName: Url langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 4784ccb7..1b621a5a 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -5,7 +5,7 @@ items: Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) name: IODataNavigationNodeCollection - fullName: sp-odata-types.IODataNavigationNodeCollection + fullName: IODataNavigationNodeCollection langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: - uid: sp-odata-types.IODataNavigationNodeCollection.quickLaunch summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. name: quickLaunch - fullName: sp-odata-types.IODataNavigationNodeCollection.quickLaunch + fullName: quickLaunch langs: - typeScript type: property @@ -28,7 +28,7 @@ items: - uid: sp-odata-types.IODataNavigationNodeCollection.topNav summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. name: topNav - fullName: sp-odata-types.IODataNavigationNodeCollection.topNav + fullName: topNav langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index ef5d357f..fae5d743 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataUser - fullName: sp-odata-types.IODataUser + fullName: IODataUser langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: - uid: sp-odata-types.IODataUser.Email summary: 'Example: `"someone@example.com"`' name: Email - fullName: sp-odata-types.IODataUser.Email + fullName: Email langs: - typeScript type: property @@ -32,7 +32,7 @@ items: - string - uid: sp-odata-types.IODataUser.Id name: Id - fullName: sp-odata-types.IODataUser.Id + fullName: Id langs: - typeScript type: property @@ -44,7 +44,7 @@ items: - uid: sp-odata-types.IODataUser.IsSiteAdmin summary: Boolean value that specifies whether the user is a site collection administrator. name: IsSiteAdmin - fullName: sp-odata-types.IODataUser.IsSiteAdmin + fullName: IsSiteAdmin langs: - typeScript type: property @@ -56,7 +56,7 @@ items: - uid: sp-odata-types.IODataUser.LoginName summary: 'Example: `"i:0#.w|domain\user"`' name: LoginName - fullName: sp-odata-types.IODataUser.LoginName + fullName: LoginName langs: - typeScript type: property @@ -82,7 +82,7 @@ items: All: 15 name: PrincipalType - fullName: sp-odata-types.IODataUser.PrincipalType + fullName: PrincipalType langs: - typeScript type: property @@ -94,7 +94,7 @@ items: - uid: sp-odata-types.IODataUser.Title summary: 'Example: `"DOMAIN\user"`' name: Title - fullName: sp-odata-types.IODataUser.Title + fullName: Title langs: - typeScript type: property @@ -108,7 +108,7 @@ items: Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. name: UserId - fullName: sp-odata-types.IODataUser.UserId + fullName: UserId langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index ea0d341a..0f26a753 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -6,7 +6,7 @@ items: here: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) name: IODataUserCustomAction - fullName: sp-odata-types.IODataUserCustomAction + fullName: IODataUserCustomAction langs: - typeScript type: interface @@ -34,7 +34,7 @@ items: summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' name: ClientSideComponentId - fullName: sp-odata-types.IODataUserCustomAction.ClientSideComponentId + fullName: ClientSideComponentId langs: - typeScript type: property @@ -53,7 +53,7 @@ items: Example: `"{ \"maxItemsToShow\": 123 }"` name: ClientSideComponentProperties - fullName: sp-odata-types.IODataUserCustomAction.ClientSideComponentProperties + fullName: ClientSideComponentProperties langs: - typeScript type: property @@ -67,7 +67,7 @@ items: Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. name: CommandUIExtension - fullName: sp-odata-types.IODataUserCustomAction.CommandUIExtension + fullName: CommandUIExtension langs: - typeScript type: property @@ -79,7 +79,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.Description summary: Gets or sets the description of the custom action. name: Description - fullName: sp-odata-types.IODataUserCustomAction.Description + fullName: Description langs: - typeScript type: property @@ -93,7 +93,7 @@ items: Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. name: Group - fullName: sp-odata-types.IODataUserCustomAction.Group + fullName: Group langs: - typeScript type: property @@ -107,7 +107,7 @@ items: Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` name: Id - fullName: sp-odata-types.IODataUserCustomAction.Id + fullName: Id langs: - typeScript type: property @@ -119,7 +119,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.ImageUrl summary: Gets or sets the URL of the image associated with the custom action. name: ImageUrl - fullName: sp-odata-types.IODataUserCustomAction.ImageUrl + fullName: ImageUrl langs: - typeScript type: property @@ -132,7 +132,7 @@ items: summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' name: Location - fullName: sp-odata-types.IODataUserCustomAction.Location + fullName: Location langs: - typeScript type: property @@ -144,7 +144,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.RegistrationId summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. name: RegistrationId - fullName: sp-odata-types.IODataUserCustomAction.RegistrationId + fullName: RegistrationId langs: - typeScript type: property @@ -159,7 +159,7 @@ items: Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4. name: RegistrationType - fullName: sp-odata-types.IODataUserCustomAction.RegistrationType + fullName: RegistrationType langs: - typeScript type: property @@ -171,7 +171,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.Rights summary: Gets or sets the value that specifies the permissions needed for the custom action. name: Rights - fullName: sp-odata-types.IODataUserCustomAction.Rights + fullName: Rights langs: - typeScript type: property @@ -183,7 +183,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.Scope summary: Gets a value that specifies the scope of the custom action. name: Scope - fullName: sp-odata-types.IODataUserCustomAction.Scope + fullName: Scope langs: - typeScript type: property @@ -195,7 +195,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.ScriptBlock summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. name: ScriptBlock - fullName: sp-odata-types.IODataUserCustomAction.ScriptBlock + fullName: ScriptBlock langs: - typeScript type: property @@ -207,7 +207,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.ScriptSrc summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. name: ScriptSrc - fullName: sp-odata-types.IODataUserCustomAction.ScriptSrc + fullName: ScriptSrc langs: - typeScript type: property @@ -221,7 +221,7 @@ items: Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. name: Sequence - fullName: sp-odata-types.IODataUserCustomAction.Sequence + fullName: Sequence langs: - typeScript type: property @@ -233,7 +233,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.Title summary: Gets or sets the display title of the custom action. name: Title - fullName: sp-odata-types.IODataUserCustomAction.Title + fullName: Title langs: - typeScript type: property @@ -245,7 +245,7 @@ items: - uid: sp-odata-types.IODataUserCustomAction.Url summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' name: Url - fullName: sp-odata-types.IODataUserCustomAction.Url + fullName: Url langs: - typeScript type: property @@ -258,7 +258,7 @@ items: summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' name: VersionOfUserCustomAction - fullName: sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction + fullName: VersionOfUserCustomAction langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 864bccb6..80922e7b 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -5,7 +5,7 @@ items: Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataWeb - fullName: sp-odata-types.IODataWeb + fullName: IODataWeb langs: - typeScript type: interface @@ -35,7 +35,7 @@ items: Example: `"/Date(2016,0,20,12,58,7,0)/"` name: Created - fullName: sp-odata-types.IODataWeb.Created + fullName: Created langs: - typeScript type: property @@ -47,7 +47,7 @@ items: - uid: sp-odata-types.IODataWeb.CurrentChangeToken summary: Represents the unique sequential location of a change within the change log. name: CurrentChangeToken - fullName: sp-odata-types.IODataWeb.CurrentChangeToken + fullName: CurrentChangeToken langs: - typeScript type: property @@ -62,7 +62,7 @@ items: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` name: CustomMasterUrl - fullName: sp-odata-types.IODataWeb.CustomMasterUrl + fullName: CustomMasterUrl langs: - typeScript type: property @@ -74,7 +74,7 @@ items: - uid: sp-odata-types.IODataWeb.Description summary: Gets or sets the description for the site. name: Description - fullName: sp-odata-types.IODataWeb.Description + fullName: Description langs: - typeScript type: property @@ -89,7 +89,7 @@ items: Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` name: Id - fullName: sp-odata-types.IODataWeb.Id + fullName: Id langs: - typeScript type: property @@ -101,7 +101,7 @@ items: - uid: sp-odata-types.IODataWeb.IsMultilingual summary: Value that represents if the web was name: IsMultilingual - fullName: sp-odata-types.IODataWeb.IsMultilingual + fullName: IsMultilingual langs: - typeScript type: property @@ -116,7 +116,7 @@ items: Example: `1033` name: Language - fullName: sp-odata-types.IODataWeb.Language + fullName: Language langs: - typeScript type: property @@ -131,7 +131,7 @@ items: Example: `"/Date(1453618828000)/"` name: LastItemModifiedDate - fullName: sp-odata-types.IODataWeb.LastItemModifiedDate + fullName: LastItemModifiedDate langs: - typeScript type: property @@ -146,7 +146,7 @@ items: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` name: MasterUrl - fullName: sp-odata-types.IODataWeb.MasterUrl + fullName: MasterUrl langs: - typeScript type: property @@ -158,7 +158,7 @@ items: - uid: sp-odata-types.IODataWeb.NoCrawl summary: Determines if a particular web will be crawled by search or not. name: NoCrawl - fullName: sp-odata-types.IODataWeb.NoCrawl + fullName: NoCrawl langs: - typeScript type: property @@ -170,7 +170,7 @@ items: - uid: sp-odata-types.IODataWeb.QuickLaunchEnabled summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. name: QuickLaunchEnabled - fullName: sp-odata-types.IODataWeb.QuickLaunchEnabled + fullName: QuickLaunchEnabled langs: - typeScript type: property @@ -182,7 +182,7 @@ items: - uid: sp-odata-types.IODataWeb.RecycleBinEnabled summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. name: RecycleBinEnabled - fullName: sp-odata-types.IODataWeb.RecycleBinEnabled + fullName: RecycleBinEnabled langs: - typeScript type: property @@ -197,7 +197,7 @@ items: Example: `"/sites/PubSite"` name: ServerRelativeUrl - fullName: sp-odata-types.IODataWeb.ServerRelativeUrl + fullName: ServerRelativeUrl langs: - typeScript type: property @@ -209,7 +209,7 @@ items: - uid: sp-odata-types.IODataWeb.SiteLogoUrl summary: Gets the url for the logo of this particular site. name: SiteLogoUrl - fullName: sp-odata-types.IODataWeb.SiteLogoUrl + fullName: SiteLogoUrl langs: - typeScript type: property @@ -221,7 +221,7 @@ items: - uid: sp-odata-types.IODataWeb.Title summary: The title of the web. name: Title - fullName: sp-odata-types.IODataWeb.Title + fullName: Title langs: - typeScript type: property @@ -236,7 +236,7 @@ items: Example: `15` name: UIVersion - fullName: sp-odata-types.IODataWeb.UIVersion + fullName: UIVersion langs: - typeScript type: property @@ -251,7 +251,7 @@ items: Example: `"http://example.com/sites/PubSite"` name: Url - fullName: sp-odata-types.IODataWeb.Url + fullName: Url langs: - typeScript type: property @@ -266,7 +266,7 @@ items: Example: `"BLANKINTERNET"` name: WebTemplate - fullName: sp-odata-types.IODataWeb.WebTemplate + fullName: WebTemplate langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index 9f4eac1a..f670d678 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -6,7 +6,7 @@ items: The page context allows an application and its web parts to share common data about the current page, such as its contents, URL, list, user, permissions, navigation menu, etc. name: '@microsoft/sp-page-context' - fullName: sp-page-context + fullName: '@microsoft/sp-page-context' langs: - typeScript type: package diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 8af017ee..7d1bd278 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CultureInfo class. name: CultureInfo - fullName: sp-page-context.CultureInfo + fullName: CultureInfo langs: - typeScript type: class @@ -28,7 +28,7 @@ items: Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the date as 1/8 instead of 8/1. name: currentCultureName - fullName: sp-page-context.CultureInfo.currentCultureName + fullName: currentCultureName langs: - typeScript type: property @@ -46,7 +46,7 @@ items: Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to translate the word "hello" to "hola". name: currentUICultureName - fullName: sp-page-context.CultureInfo.currentUICultureName + fullName: currentUICultureName langs: - typeScript type: property @@ -58,7 +58,7 @@ items: - uid: sp-page-context.CultureInfo.isRightToLeft summary: This boolean represents the dominant direction of written text for the default user interface language. name: isRightToLeft - fullName: sp-page-context.CultureInfo.isRightToLeft + fullName: isRightToLeft langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index 74b701f4..70b4b6fd 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -4,7 +4,7 @@ items: summary: Interface that represents a `SPSystemTime` structure. isPreview: true name: ISPSystemTime - fullName: sp-page-context.ISPSystemTime + fullName: ISPSystemTime langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: - uid: sp-page-context.ISPSystemTime.Day isPreview: true name: Day - fullName: sp-page-context.ISPSystemTime.Day + fullName: Day langs: - typeScript type: property @@ -33,7 +33,7 @@ items: - uid: sp-page-context.ISPSystemTime.DayOfWeek isPreview: true name: DayOfWeek - fullName: sp-page-context.ISPSystemTime.DayOfWeek + fullName: DayOfWeek langs: - typeScript type: property @@ -45,7 +45,7 @@ items: - uid: sp-page-context.ISPSystemTime.Hour isPreview: true name: Hour - fullName: sp-page-context.ISPSystemTime.Hour + fullName: Hour langs: - typeScript type: property @@ -57,7 +57,7 @@ items: - uid: sp-page-context.ISPSystemTime.Milliseconds isPreview: true name: Milliseconds - fullName: sp-page-context.ISPSystemTime.Milliseconds + fullName: Milliseconds langs: - typeScript type: property @@ -69,7 +69,7 @@ items: - uid: sp-page-context.ISPSystemTime.Minute isPreview: true name: Minute - fullName: sp-page-context.ISPSystemTime.Minute + fullName: Minute langs: - typeScript type: property @@ -81,7 +81,7 @@ items: - uid: sp-page-context.ISPSystemTime.Month isPreview: true name: Month - fullName: sp-page-context.ISPSystemTime.Month + fullName: Month langs: - typeScript type: property @@ -93,7 +93,7 @@ items: - uid: sp-page-context.ISPSystemTime.Second isPreview: true name: Second - fullName: sp-page-context.ISPSystemTime.Second + fullName: Second langs: - typeScript type: property @@ -105,7 +105,7 @@ items: - uid: sp-page-context.ISPSystemTime.Year isPreview: true name: Year - fullName: sp-page-context.ISPSystemTime.Year + fullName: Year langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 3eec6c3a..c5cdfd21 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -4,7 +4,7 @@ items: summary: Interface that represents the data necessary to build an `TimeZone` object. isPreview: true name: ISPTimeZoneData - fullName: sp-page-context.ISPTimeZoneData + fullName: ISPTimeZoneData langs: - typeScript type: interface @@ -20,7 +20,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.daylightDate isPreview: true name: daylightDate - fullName: sp-page-context.ISPTimeZoneData.daylightDate + fullName: daylightDate langs: - typeScript type: property @@ -32,7 +32,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.daylightOffset isPreview: true name: daylightOffset - fullName: sp-page-context.ISPTimeZoneData.daylightOffset + fullName: daylightOffset langs: - typeScript type: property @@ -44,7 +44,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.description isPreview: true name: description - fullName: sp-page-context.ISPTimeZoneData.description + fullName: description langs: - typeScript type: property @@ -56,7 +56,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.id isPreview: true name: id - fullName: sp-page-context.ISPTimeZoneData.id + fullName: id langs: - typeScript type: property @@ -68,7 +68,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.offset isPreview: true name: offset - fullName: sp-page-context.ISPTimeZoneData.offset + fullName: offset langs: - typeScript type: property @@ -80,7 +80,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.standardDate isPreview: true name: standardDate - fullName: sp-page-context.ISPTimeZoneData.standardDate + fullName: standardDate langs: - typeScript type: property @@ -92,7 +92,7 @@ items: - uid: sp-page-context.ISPTimeZoneData.standardOffset isPreview: true name: standardOffset - fullName: sp-page-context.ISPTimeZoneData.standardOffset + fullName: standardOffset langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index bf0af7b0..a305eec9 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -8,7 +8,7 @@ items: navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. name: PageContext - fullName: sp-page-context.PageContext + fullName: PageContext langs: - typeScript type: class @@ -28,7 +28,7 @@ items: - uid: sp-page-context.PageContext.constructor summary: 'Constructs a new instance of the [PageContext](xref:sp-page-context.PageContext) class' name: constructor(serviceScope) - fullName: sp-page-context.PageContext.constructor + fullName: constructor langs: - typeScript type: constructor @@ -44,7 +44,7 @@ items: Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. name: aadInfo - fullName: sp-page-context.PageContext.aadInfo + fullName: aadInfo langs: - typeScript type: property @@ -58,7 +58,7 @@ items: It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. name: cultureInfo - fullName: sp-page-context.PageContext.cultureInfo + fullName: cultureInfo langs: - typeScript type: property @@ -70,7 +70,7 @@ items: - uid: sp-page-context.PageContext.isInitialized summary: Returns whether the `PageContext` has been initialized. name: isInitialized - fullName: sp-page-context.PageContext.isInitialized + fullName: isInitialized langs: - typeScript type: property @@ -93,7 +93,7 @@ items: API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object. name: legacyPageContext - fullName: sp-page-context.PageContext.legacyPageContext + fullName: legacyPageContext langs: - typeScript type: property @@ -107,7 +107,7 @@ items: Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. name: list - fullName: sp-page-context.PageContext.list + fullName: list langs: - typeScript type: property @@ -121,7 +121,7 @@ items: Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. name: listItem - fullName: sp-page-context.PageContext.listItem + fullName: listItem langs: - typeScript type: property @@ -133,7 +133,7 @@ items: - uid: sp-page-context.PageContext.serviceKey summary: The service key for PageContext. name: serviceKey - fullName: sp-page-context.PageContext.serviceKey + fullName: serviceKey langs: - typeScript type: property @@ -145,7 +145,7 @@ items: - uid: sp-page-context.PageContext.site summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. name: site - fullName: sp-page-context.PageContext.site + fullName: site langs: - typeScript type: property @@ -159,7 +159,7 @@ items: It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. name: user - fullName: sp-page-context.PageContext.user + fullName: user langs: - typeScript type: property @@ -171,7 +171,7 @@ items: - uid: sp-page-context.PageContext.web summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. name: web - fullName: sp-page-context.PageContext.web + fullName: web langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/spdayofweek.yml b/SP-Framework/sp-page-context/spdayofweek.yml index 71b50a06..98bd5197 100644 --- a/SP-Framework/sp-page-context/spdayofweek.yml +++ b/SP-Framework/sp-page-context/spdayofweek.yml @@ -4,7 +4,7 @@ items: summary: The enum members represent the seven days of a week. isPreview: true name: SPDayOfWeek - fullName: sp-page-context.SPDayOfWeek + fullName: SPDayOfWeek langs: - typeScript type: enum @@ -20,7 +20,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Friday isPreview: true name: Friday - fullName: sp-page-context.SPDayOfWeek.Friday + fullName: Friday langs: - typeScript type: field @@ -28,7 +28,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Monday isPreview: true name: Monday - fullName: sp-page-context.SPDayOfWeek.Monday + fullName: Monday langs: - typeScript type: field @@ -36,7 +36,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Saturday isPreview: true name: Saturday - fullName: sp-page-context.SPDayOfWeek.Saturday + fullName: Saturday langs: - typeScript type: field @@ -44,7 +44,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Sunday isPreview: true name: Sunday - fullName: sp-page-context.SPDayOfWeek.Sunday + fullName: Sunday langs: - typeScript type: field @@ -52,7 +52,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Thursday isPreview: true name: Thursday - fullName: sp-page-context.SPDayOfWeek.Thursday + fullName: Thursday langs: - typeScript type: field @@ -60,7 +60,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Tuesday isPreview: true name: Tuesday - fullName: sp-page-context.SPDayOfWeek.Tuesday + fullName: Tuesday langs: - typeScript type: field @@ -68,7 +68,7 @@ items: - uid: sp-page-context.SPDayOfWeek.Wednesday isPreview: true name: Wednesday - fullName: sp-page-context.SPDayOfWeek.Wednesday + fullName: Wednesday langs: - typeScript type: field diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index e0bf7623..75502ba4 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -10,7 +10,7 @@ items: This is the client-side equivalent for SharePoint `SPField` class. It is used with the `@microsoft/sp-listview-extensibility` package. name: SPField - fullName: sp-page-context.SPField + fullName: SPField langs: - typeScript type: class @@ -26,7 +26,7 @@ items: - uid: sp-page-context.SPField.clientSideComponentId summary: The unique identifier of the client-side component associated with the field. name: clientSideComponentId - fullName: sp-page-context.SPField.clientSideComponentId + fullName: clientSideComponentId langs: - typeScript type: property @@ -41,7 +41,7 @@ items: If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. name: clientSideComponentProperties - fullName: sp-page-context.SPField.clientSideComponentProperties + fullName: clientSideComponentProperties langs: - typeScript type: property @@ -53,7 +53,7 @@ items: - uid: sp-page-context.SPField.displayName summary: The display name of the field. This name is shown as column name in UI. name: displayName - fullName: sp-page-context.SPField.displayName + fullName: displayName langs: - typeScript type: property @@ -65,7 +65,7 @@ items: - uid: sp-page-context.SPField.fieldType summary: The type of the field represented as a string name: fieldType - fullName: sp-page-context.SPField.fieldType + fullName: fieldType langs: - typeScript type: property @@ -77,7 +77,7 @@ items: - uid: sp-page-context.SPField.id summary: The GUID identifier for this field. name: id - fullName: sp-page-context.SPField.id + fullName: id langs: - typeScript type: property @@ -89,7 +89,7 @@ items: - uid: sp-page-context.SPField.internalName summary: The internal name of the field. This name is usually used to find the field. name: internalName - fullName: sp-page-context.SPField.internalName + fullName: internalName langs: - typeScript type: property @@ -101,7 +101,7 @@ items: - uid: sp-page-context.SPField.isRequired summary: Whether the field is required for each list item in the list name: isRequired - fullName: sp-page-context.SPField.isRequired + fullName: isRequired langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 4e19f363..01c234be 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPList class. name: SPList - fullName: sp-page-context.SPList + fullName: SPList langs: - typeScript type: class @@ -23,7 +23,7 @@ items: The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. name: id - fullName: sp-page-context.SPList.id + fullName: id langs: - typeScript type: property @@ -37,7 +37,7 @@ items: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. name: permissions - fullName: sp-page-context.SPList.permissions + fullName: permissions langs: - typeScript type: property @@ -50,7 +50,7 @@ items: summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' name: serverRelativeUrl - fullName: sp-page-context.SPList.serverRelativeUrl + fullName: serverRelativeUrl langs: - typeScript type: property @@ -62,7 +62,7 @@ items: - uid: sp-page-context.SPList.title summary: Returns the title for this `SPList`. name: title - fullName: sp-page-context.SPList.title + fullName: title langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 943a2a30..9f4daf53 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPListItem class. name: SPListItem - fullName: sp-page-context.SPListItem + fullName: SPListItem langs: - typeScript type: class @@ -18,7 +18,7 @@ items: - uid: sp-page-context.SPListItem.id summary: The number that identifies the `SPListItem` on the server. name: id - fullName: sp-page-context.SPListItem.id + fullName: id langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index f75bf04d..ee2f4b51 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -9,7 +9,7 @@ items: For more information, see: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) name: SPPermission - fullName: sp-page-context.SPPermission + fullName: SPPermission langs: - typeScript type: class @@ -59,7 +59,7 @@ items: - uid: sp-page-context.SPPermission.constructor summary: 'Constructs a new instance of the [SPPermission](xref:sp-page-context.SPPermission) class' name: constructor(value) - fullName: sp-page-context.SPPermission.constructor + fullName: constructor langs: - typeScript type: constructor @@ -75,7 +75,7 @@ items: Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor. name: addAndCustomizePages - fullName: sp-page-context.SPPermission.addAndCustomizePages + fullName: addAndCustomizePages langs: - typeScript type: property @@ -87,7 +87,7 @@ items: - uid: sp-page-context.SPPermission.addDelPrivateWebParts summary: Add or remove personal web parts on a web part Page. name: addDelPrivateWebParts - fullName: sp-page-context.SPPermission.addDelPrivateWebParts + fullName: addDelPrivateWebParts langs: - typeScript type: property @@ -99,7 +99,7 @@ items: - uid: sp-page-context.SPPermission.addListItems summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' name: addListItems - fullName: sp-page-context.SPPermission.addListItems + fullName: addListItems langs: - typeScript type: property @@ -111,7 +111,7 @@ items: - uid: sp-page-context.SPPermission.applyStyleSheets summary: Apply a style sheet (.css file) to the Web site. name: applyStyleSheets - fullName: sp-page-context.SPPermission.applyStyleSheets + fullName: applyStyleSheets langs: - typeScript type: property @@ -123,7 +123,7 @@ items: - uid: sp-page-context.SPPermission.applyThemeAndBorder summary: Apply a theme or borders to the entire Web site. name: applyThemeAndBorder - fullName: sp-page-context.SPPermission.applyThemeAndBorder + fullName: applyThemeAndBorder langs: - typeScript type: property @@ -135,7 +135,7 @@ items: - uid: sp-page-context.SPPermission.approveItems summary: Approve a minor version of a list item or document. name: approveItems - fullName: sp-page-context.SPPermission.approveItems + fullName: approveItems langs: - typeScript type: property @@ -147,7 +147,7 @@ items: - uid: sp-page-context.SPPermission.browseDirectories summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. name: browseDirectories - fullName: sp-page-context.SPPermission.browseDirectories + fullName: browseDirectories langs: - typeScript type: property @@ -159,7 +159,7 @@ items: - uid: sp-page-context.SPPermission.browserUserInfo summary: View information about users of the Web site. name: browserUserInfo - fullName: sp-page-context.SPPermission.browserUserInfo + fullName: browserUserInfo langs: - typeScript type: property @@ -171,7 +171,7 @@ items: - uid: sp-page-context.SPPermission.cancelCheckout summary: Discard or check in a document which is checked out to another user. name: cancelCheckout - fullName: sp-page-context.SPPermission.cancelCheckout + fullName: cancelCheckout langs: - typeScript type: property @@ -183,7 +183,7 @@ items: - uid: sp-page-context.SPPermission.createAlerts summary: Create e-mail alerts. name: createAlerts - fullName: sp-page-context.SPPermission.createAlerts + fullName: createAlerts langs: - typeScript type: property @@ -195,7 +195,7 @@ items: - uid: sp-page-context.SPPermission.createGroups summary: Create a group of users that can be used anywhere within the site collection. name: createGroups - fullName: sp-page-context.SPPermission.createGroups + fullName: createGroups langs: - typeScript type: property @@ -207,7 +207,7 @@ items: - uid: sp-page-context.SPPermission.createSSCSite summary: Create a Web site using Self-Service Site Creation. name: createSSCSite - fullName: sp-page-context.SPPermission.createSSCSite + fullName: createSSCSite langs: - typeScript type: property @@ -219,7 +219,7 @@ items: - uid: sp-page-context.SPPermission.deleteListItems summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' name: deleteListItems - fullName: sp-page-context.SPPermission.deleteListItems + fullName: deleteListItems langs: - typeScript type: property @@ -231,7 +231,7 @@ items: - uid: sp-page-context.SPPermission.deleteVersions summary: Delete past versions of a list item or document. name: deleteVersions - fullName: sp-page-context.SPPermission.deleteVersions + fullName: deleteVersions langs: - typeScript type: property @@ -245,7 +245,7 @@ items: Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. name: editListItems - fullName: sp-page-context.SPPermission.editListItems + fullName: editListItems langs: - typeScript type: property @@ -257,7 +257,7 @@ items: - uid: sp-page-context.SPPermission.editMyUserInfo summary: 'Allows a user to change his or her user information, such as adding a picture.' name: editMyUserInfo - fullName: sp-page-context.SPPermission.editMyUserInfo + fullName: editMyUserInfo langs: - typeScript type: property @@ -269,7 +269,7 @@ items: - uid: sp-page-context.SPPermission.emptyMask summary: Has no permissions on the Web site. Not available through the user interface. name: emptyMask - fullName: sp-page-context.SPPermission.emptyMask + fullName: emptyMask langs: - typeScript type: property @@ -281,7 +281,7 @@ items: - uid: sp-page-context.SPPermission.enumeratePermissions summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' name: enumeratePermissions - fullName: sp-page-context.SPPermission.enumeratePermissions + fullName: enumeratePermissions langs: - typeScript type: property @@ -293,7 +293,7 @@ items: - uid: sp-page-context.SPPermission.fullMask summary: Has all permissions on the Web site. Not available through the user interface. name: fullMask - fullName: sp-page-context.SPPermission.fullMask + fullName: fullMask langs: - typeScript type: property @@ -305,7 +305,7 @@ items: - uid: sp-page-context.SPPermission.hasAllPermissions summary: Function for testing whether a given permission mask has all of the requested permissions. name: hasAllPermissions(requestedPerms) - fullName: sp-page-context.SPPermission.hasAllPermissions + fullName: hasAllPermissions langs: - typeScript type: method @@ -323,7 +323,7 @@ items: - uid: sp-page-context.SPPermission.hasAnyPermissions summary: Function for testing whether a given permission mask has any of the requested permissions. name: hasAnyPermissions(requestedPerms) - fullName: sp-page-context.SPPermission.hasAnyPermissions + fullName: hasAnyPermissions langs: - typeScript type: method @@ -341,7 +341,7 @@ items: - uid: sp-page-context.SPPermission.hasPermission summary: Function for testing whether a given permission mask has the requested permission. name: hasPermission(requestedPerm) - fullName: sp-page-context.SPPermission.hasPermission + fullName: hasPermission langs: - typeScript type: method @@ -359,7 +359,7 @@ items: - uid: sp-page-context.SPPermission.layoutsPage summary: View the layouts page? name: layoutsPage - fullName: sp-page-context.SPPermission.layoutsPage + fullName: layoutsPage langs: - typeScript type: property @@ -371,7 +371,7 @@ items: - uid: sp-page-context.SPPermission.manageAlerts summary: Manage alerts for all users of the Web site. name: manageAlerts - fullName: sp-page-context.SPPermission.manageAlerts + fullName: manageAlerts langs: - typeScript type: property @@ -383,7 +383,7 @@ items: - uid: sp-page-context.SPPermission.manageLists summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' name: manageLists - fullName: sp-page-context.SPPermission.manageLists + fullName: manageLists langs: - typeScript type: property @@ -395,7 +395,7 @@ items: - uid: sp-page-context.SPPermission.managePermissions summary: Create and change permission levels on the Web site and assign permissions to users and groups. name: managePermissions - fullName: sp-page-context.SPPermission.managePermissions + fullName: managePermissions langs: - typeScript type: property @@ -407,7 +407,7 @@ items: - uid: sp-page-context.SPPermission.managePersonalViews summary: 'Create, change, and delete personal views of lists.' name: managePersonalViews - fullName: sp-page-context.SPPermission.managePersonalViews + fullName: managePersonalViews langs: - typeScript type: property @@ -419,7 +419,7 @@ items: - uid: sp-page-context.SPPermission.manageSubwebs summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' name: manageSubwebs - fullName: sp-page-context.SPPermission.manageSubwebs + fullName: manageSubwebs langs: - typeScript type: property @@ -437,7 +437,7 @@ items: activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. name: manageWeb - fullName: sp-page-context.SPPermission.manageWeb + fullName: manageWeb langs: - typeScript type: property @@ -449,7 +449,7 @@ items: - uid: sp-page-context.SPPermission.open summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' name: open - fullName: sp-page-context.SPPermission.open + fullName: open langs: - typeScript type: property @@ -461,7 +461,7 @@ items: - uid: sp-page-context.SPPermission.openItems summary: View the source of documents with server-side file handlers. name: openItems - fullName: sp-page-context.SPPermission.openItems + fullName: openItems langs: - typeScript type: property @@ -473,7 +473,7 @@ items: - uid: sp-page-context.SPPermission.updatePersonalWebParts summary: Update web parts to display personalized information. name: updatePersonalWebParts - fullName: sp-page-context.SPPermission.updatePersonalWebParts + fullName: updatePersonalWebParts langs: - typeScript type: property @@ -485,7 +485,7 @@ items: - uid: sp-page-context.SPPermission.useClientIntegration summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' name: useClientIntegration - fullName: sp-page-context.SPPermission.useClientIntegration + fullName: useClientIntegration langs: - typeScript type: property @@ -497,7 +497,7 @@ items: - uid: sp-page-context.SPPermission.useRemoteAPIs summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' name: useRemoteAPIs - fullName: sp-page-context.SPPermission.useRemoteAPIs + fullName: useRemoteAPIs langs: - typeScript type: property @@ -509,7 +509,7 @@ items: - uid: sp-page-context.SPPermission.value summary: Returns the value of this SPPermission object name: value - fullName: sp-page-context.SPPermission.value + fullName: value langs: - typeScript type: property @@ -521,7 +521,7 @@ items: - uid: sp-page-context.SPPermission.viewFormPages summary: 'View forms, views, and application pages, and enumerate lists.' name: viewFormPages - fullName: sp-page-context.SPPermission.viewFormPages + fullName: viewFormPages langs: - typeScript type: property @@ -533,7 +533,7 @@ items: - uid: sp-page-context.SPPermission.viewListItems summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' name: viewListItems - fullName: sp-page-context.SPPermission.viewListItems + fullName: viewListItems langs: - typeScript type: property @@ -545,7 +545,7 @@ items: - uid: sp-page-context.SPPermission.viewPages summary: View pages in a Web site. name: viewPages - fullName: sp-page-context.SPPermission.viewPages + fullName: viewPages langs: - typeScript type: property @@ -557,7 +557,7 @@ items: - uid: sp-page-context.SPPermission.viewUsageData summary: View reports on Web site usage. name: viewUsageData - fullName: sp-page-context.SPPermission.viewUsageData + fullName: viewUsageData langs: - typeScript type: property @@ -569,7 +569,7 @@ items: - uid: sp-page-context.SPPermission.viewVersions summary: View past versions of a list item or document. name: viewVersions - fullName: sp-page-context.SPPermission.viewVersions + fullName: viewVersions langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index 6c20bae0..63587459 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPSite class. name: SPSite - fullName: sp-page-context.SPSite + fullName: SPSite langs: - typeScript type: class @@ -29,7 +29,7 @@ items: summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' name: absoluteUrl - fullName: sp-page-context.SPSite.absoluteUrl + fullName: absoluteUrl langs: - typeScript type: property @@ -41,7 +41,7 @@ items: - uid: sp-page-context.SPSite.cdnPrefix summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. name: cdnPrefix - fullName: sp-page-context.SPSite.cdnPrefix + fullName: cdnPrefix langs: - typeScript type: property @@ -53,7 +53,7 @@ items: - uid: sp-page-context.SPSite.classification summary: Returns the classification of the site. name: classification - fullName: sp-page-context.SPSite.classification + fullName: classification langs: - typeScript type: property @@ -65,7 +65,7 @@ items: - uid: sp-page-context.SPSite.correlationId summary: Returns the correlation id to the current server request. name: correlationId - fullName: sp-page-context.SPSite.correlationId + fullName: correlationId langs: - typeScript type: property @@ -79,7 +79,7 @@ items: Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. name: group - fullName: sp-page-context.SPSite.group + fullName: group langs: - typeScript type: property @@ -91,7 +91,7 @@ items: - uid: sp-page-context.SPSite.id summary: The GUID that identifies the SPSite on the server. name: id - fullName: sp-page-context.SPSite.id + fullName: id langs: - typeScript type: property @@ -103,7 +103,7 @@ items: - uid: sp-page-context.SPSite.isNoScriptEnabled summary: Returns true if isNoScript has been enabled on the SPSite. name: isNoScriptEnabled - fullName: sp-page-context.SPSite.isNoScriptEnabled + fullName: isNoScriptEnabled langs: - typeScript type: property @@ -115,7 +115,7 @@ items: - uid: sp-page-context.SPSite.recycleBinItemCount summary: The amount of items in the recycle bin. name: recycleBinItemCount - fullName: sp-page-context.SPSite.recycleBinItemCount + fullName: recycleBinItemCount langs: - typeScript type: property @@ -128,7 +128,7 @@ items: summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' name: serverRelativeUrl - fullName: sp-page-context.SPSite.serverRelativeUrl + fullName: serverRelativeUrl langs: - typeScript type: property @@ -141,7 +141,7 @@ items: summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' name: serverRequestPath - fullName: sp-page-context.SPSite.serverRequestPath + fullName: serverRequestPath langs: - typeScript type: property @@ -153,7 +153,7 @@ items: - uid: sp-page-context.SPSite.sitePagesEnabled summary: Returns true if SitePages are enabled on this SPSite. name: sitePagesEnabled - fullName: sp-page-context.SPSite.sitePagesEnabled + fullName: sitePagesEnabled langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 7e75a77d..98213d9c 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -21,7 +21,7 @@ items: ``` isPreview: true name: SPTimeZone - fullName: sp-page-context.SPTimeZone + fullName: SPTimeZone langs: - typeScript type: class @@ -38,7 +38,7 @@ items: summary: Gets the date on which daylight time begins for the time zone. isPreview: true name: daylightDate - fullName: sp-page-context.SPTimeZone.daylightDate + fullName: daylightDate langs: - typeScript type: property @@ -53,7 +53,7 @@ items: Time (UTC). isPreview: true name: daylightOffset - fullName: sp-page-context.SPTimeZone.daylightOffset + fullName: daylightOffset langs: - typeScript type: property @@ -66,7 +66,7 @@ items: summary: Gets the description for the time zone. isPreview: true name: description - fullName: sp-page-context.SPTimeZone.description + fullName: description langs: - typeScript type: property @@ -79,7 +79,7 @@ items: summary: Gets the ID of the time zone. isPreview: true name: id - fullName: sp-page-context.SPTimeZone.id + fullName: id langs: - typeScript type: property @@ -92,7 +92,7 @@ items: summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). isPreview: true name: offset - fullName: sp-page-context.SPTimeZone.offset + fullName: offset langs: - typeScript type: property @@ -105,7 +105,7 @@ items: summary: Gets the date on which standard time begins for the time zone. isPreview: true name: standardDate - fullName: sp-page-context.SPTimeZone.standardDate + fullName: standardDate langs: - typeScript type: property @@ -120,7 +120,7 @@ items: time (UTC). isPreview: true name: standardOffset - fullName: sp-page-context.SPTimeZone.standardOffset + fullName: standardOffset langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index f9902c5a..65ace27b 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPUser class. name: SPUser - fullName: sp-page-context.SPUser + fullName: SPUser langs: - typeScript type: class @@ -26,7 +26,7 @@ items: summary: The display name for the current user. remarks: 'Example: `"John Doe"`' name: displayName - fullName: sp-page-context.SPUser.displayName + fullName: displayName langs: - typeScript type: property @@ -39,7 +39,7 @@ items: summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' name: email - fullName: sp-page-context.SPUser.email + fullName: email langs: - typeScript type: property @@ -52,7 +52,7 @@ items: summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. isPreview: true name: firstDayOfWeek - fullName: sp-page-context.SPUser.firstDayOfWeek + fullName: firstDayOfWeek langs: - typeScript type: property @@ -64,7 +64,7 @@ items: - uid: sp-page-context.SPUser.isAnonymousGuestUser summary: Returns if the current user is an anonymous guest. name: isAnonymousGuestUser - fullName: sp-page-context.SPUser.isAnonymousGuestUser + fullName: isAnonymousGuestUser langs: - typeScript type: property @@ -76,7 +76,7 @@ items: - uid: sp-page-context.SPUser.isExternalGuestUser summary: Returns true if the current user is an external guest. name: isExternalGuestUser - fullName: sp-page-context.SPUser.isExternalGuestUser + fullName: isExternalGuestUser langs: - typeScript type: property @@ -89,7 +89,7 @@ items: summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' name: loginName - fullName: sp-page-context.SPUser.loginName + fullName: loginName langs: - typeScript type: property @@ -101,7 +101,7 @@ items: - uid: sp-page-context.SPUser.preferUserTimeZone summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. name: preferUserTimeZone - fullName: sp-page-context.SPUser.preferUserTimeZone + fullName: preferUserTimeZone langs: - typeScript type: property @@ -114,7 +114,7 @@ items: summary: Returns the user's regional timezone settings or undefined if they haven't been set. isPreview: true name: timeZoneInfo - fullName: sp-page-context.SPUser.timeZoneInfo + fullName: timeZoneInfo langs: - typeScript type: property diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 368c78e0..92084c09 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPWeb class. name: SPWeb - fullName: sp-page-context.SPWeb + fullName: SPWeb langs: - typeScript type: class @@ -29,7 +29,7 @@ items: - uid: sp-page-context.SPWeb.absoluteUrl summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' name: absoluteUrl - fullName: sp-page-context.SPWeb.absoluteUrl + fullName: absoluteUrl langs: - typeScript type: property @@ -41,7 +41,7 @@ items: - uid: sp-page-context.SPWeb.description summary: Returns the description of the current SPWeb. name: description - fullName: sp-page-context.SPWeb.description + fullName: description langs: - typeScript type: property @@ -54,7 +54,7 @@ items: summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. isPreview: true name: firstDayOfWeek - fullName: sp-page-context.SPWeb.firstDayOfWeek + fullName: firstDayOfWeek langs: - typeScript type: property @@ -66,7 +66,7 @@ items: - uid: sp-page-context.SPWeb.id summary: The GUID that identifies the SPWeb on the server. name: id - fullName: sp-page-context.SPWeb.id + fullName: id langs: - typeScript type: property @@ -78,7 +78,7 @@ items: - uid: sp-page-context.SPWeb.isAppWeb summary: Returns true if this `SPWeb` the container web for an `SPApp`. name: isAppWeb - fullName: sp-page-context.SPWeb.isAppWeb + fullName: isAppWeb langs: - typeScript type: property @@ -91,7 +91,7 @@ items: summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' name: language - fullName: sp-page-context.SPWeb.language + fullName: language langs: - typeScript type: property @@ -104,7 +104,7 @@ items: summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' name: logoUrl - fullName: sp-page-context.SPWeb.logoUrl + fullName: logoUrl langs: - typeScript type: property @@ -118,7 +118,7 @@ items: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. name: permissions - fullName: sp-page-context.SPWeb.permissions + fullName: permissions langs: - typeScript type: property @@ -131,7 +131,7 @@ items: summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' name: serverRelativeUrl - fullName: sp-page-context.SPWeb.serverRelativeUrl + fullName: serverRelativeUrl langs: - typeScript type: property @@ -146,7 +146,7 @@ items: create the site. remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' name: templateName - fullName: sp-page-context.SPWeb.templateName + fullName: templateName langs: - typeScript type: property @@ -159,7 +159,7 @@ items: summary: Returns the web's regional timezone settings or undefined if they haven't been set. isPreview: true name: timeZoneInfo - fullName: sp-page-context.SPWeb.timeZoneInfo + fullName: timeZoneInfo langs: - typeScript type: property @@ -171,7 +171,7 @@ items: - uid: sp-page-context.SPWeb.title summary: Returns the title of the current SPWeb. name: title - fullName: sp-page-context.SPWeb.title + fullName: title langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index d2e57548..2cc5b82f 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -7,7 +7,7 @@ items: object that a page author can add to their content, and customize using a property pane. Examples of web parts include an embedded video player, a map, a group calendar, a chart, etc. name: '@microsoft/sp-webpart-base' - fullName: sp-webpart-base + fullName: '@microsoft/sp-webpart-base' langs: - typeScript type: package @@ -74,7 +74,7 @@ items: - uid: sp-webpart-base.PropertyPaneButton summary: Helper method to create a Button on the PropertyPane. name: 'PropertyPaneButton(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneButton + fullName: PropertyPaneButton langs: - typeScript type: function @@ -98,7 +98,7 @@ items: - uid: sp-webpart-base.PropertyPaneCheckbox summary: Helper method to create a Checkbox on the PropertyPane. name: 'PropertyPaneCheckbox(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneCheckbox + fullName: PropertyPaneCheckbox langs: - typeScript type: function @@ -122,7 +122,7 @@ items: - uid: sp-webpart-base.PropertyPaneChoiceGroup summary: Helper method to create a Choice Group on the PropertyPane. name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneChoiceGroup + fullName: PropertyPaneChoiceGroup langs: - typeScript type: function @@ -152,7 +152,7 @@ items: fill that gap. isPreview: true name: PropertyPaneCustomField(properties) - fullName: sp-webpart-base.PropertyPaneCustomField + fullName: PropertyPaneCustomField langs: - typeScript type: function @@ -172,7 +172,7 @@ items: - uid: sp-webpart-base.PropertyPaneDropdown summary: Helper method to create a Dropdown on the PropertyPane. name: 'PropertyPaneDropdown(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneDropdown + fullName: PropertyPaneDropdown langs: - typeScript type: function @@ -196,7 +196,7 @@ items: - uid: sp-webpart-base.PropertyPaneDynamicField summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. name: 'PropertyPaneDynamicField(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneDynamicField + fullName: PropertyPaneDynamicField langs: - typeScript type: function @@ -225,7 +225,7 @@ items: These fields can possibly share the same property based on the associated filters. name: PropertyPaneDynamicFieldSet(properties) - fullName: sp-webpart-base.PropertyPaneDynamicFieldSet + fullName: PropertyPaneDynamicFieldSet langs: - typeScript type: function @@ -251,7 +251,7 @@ items: content: '- This has been replaced by PropertyPaneDynamicField' isPreview: true name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneDynamicTextField + fullName: PropertyPaneDynamicTextField langs: - typeScript type: function @@ -275,7 +275,7 @@ items: - uid: sp-webpart-base.PropertyPaneHorizontalRule summary: Helper method to create a Horizontal Rule on the PropertyPane. name: PropertyPaneHorizontalRule() - fullName: sp-webpart-base.PropertyPaneHorizontalRule + fullName: PropertyPaneHorizontalRule langs: - typeScript type: function @@ -288,7 +288,7 @@ items: - uid: sp-webpart-base.PropertyPaneLabel summary: Helper method to create a Label on the PropertyPane. name: 'PropertyPaneLabel(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneLabel + fullName: PropertyPaneLabel langs: - typeScript type: function @@ -312,7 +312,7 @@ items: - uid: sp-webpart-base.PropertyPaneLink summary: Helper method to create a Link on the PropertyPane. name: 'PropertyPaneLink(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneLink + fullName: PropertyPaneLink langs: - typeScript type: function @@ -336,7 +336,7 @@ items: - uid: sp-webpart-base.PropertyPaneSlider summary: Helper method to create a Slider on the PropertyPane. name: 'PropertyPaneSlider(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneSlider + fullName: PropertyPaneSlider langs: - typeScript type: function @@ -360,7 +360,7 @@ items: - uid: sp-webpart-base.PropertyPaneTextField summary: Helper method to create a TextField on the PropertyPane. name: 'PropertyPaneTextField(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneTextField + fullName: PropertyPaneTextField langs: - typeScript type: function @@ -384,7 +384,7 @@ items: - uid: sp-webpart-base.PropertyPaneToggle summary: Helper method to create a Toggle on the PropertyPane. name: 'PropertyPaneToggle(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneToggle + fullName: PropertyPaneToggle langs: - typeScript type: function diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index f92b86a2..72dbc005 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -18,7 +18,7 @@ items: part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision. name: BaseClientSideWebPart - fullName: sp-webpart-base.BaseClientSideWebPart + fullName: BaseClientSideWebPart langs: - typeScript type: class @@ -46,7 +46,7 @@ items: Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. name: constructor() - fullName: sp-webpart-base.BaseClientSideWebPart.constructor + fullName: constructor langs: - typeScript type: constructor @@ -65,7 +65,7 @@ items: are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. name: canOpenPopupOnRender - fullName: sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender + fullName: canOpenPopupOnRender langs: - typeScript type: property @@ -77,7 +77,7 @@ items: - uid: sp-webpart-base.BaseClientSideWebPart.clearError summary: This API should be used to clear the error message from the web part display area. name: clearError() - fullName: sp-webpart-base.BaseClientSideWebPart.clearError + fullName: clearError langs: - typeScript type: method @@ -94,7 +94,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-webpart-base.BaseClientSideWebPart.context + fullName: context langs: - typeScript type: property @@ -108,7 +108,7 @@ items: This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. name: domElement - fullName: sp-webpart-base.BaseClientSideWebPart.domElement + fullName: domElement langs: - typeScript type: property @@ -126,7 +126,7 @@ items: The default value is false. name: isRenderAsync - fullName: sp-webpart-base.BaseClientSideWebPart.isRenderAsync + fullName: isRenderAsync langs: - typeScript type: property @@ -144,7 +144,7 @@ items: display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. name: onDisplayModeChanged(oldDisplayMode) - fullName: sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged + fullName: onDisplayModeChanged langs: - typeScript type: method @@ -169,7 +169,7 @@ items: like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. name: onDispose() - fullName: sp-webpart-base.BaseClientSideWebPart.onDispose + fullName: onDispose langs: - typeScript type: method @@ -186,7 +186,7 @@ items: This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. name: render() - fullName: sp-webpart-base.BaseClientSideWebPart.render + fullName: render langs: - typeScript type: method @@ -203,7 +203,7 @@ items: initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. name: renderCompleted() - fullName: sp-webpart-base.BaseClientSideWebPart.renderCompleted + fullName: renderCompleted langs: - typeScript type: method @@ -219,7 +219,7 @@ items: time that the web part was saved) or not. remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' name: renderedFromPersistedData - fullName: sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData + fullName: renderedFromPersistedData langs: - typeScript type: property @@ -233,7 +233,7 @@ items: This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens. name: renderedOnce - fullName: sp-webpart-base.BaseClientSideWebPart.renderedOnce + fullName: renderedOnce langs: - typeScript type: property @@ -247,7 +247,7 @@ items: This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. name: renderError(error) - fullName: sp-webpart-base.BaseClientSideWebPart.renderError + fullName: renderError langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 7d6cc34d..2d3ce473 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -5,7 +5,7 @@ items: This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. name: BaseWebPart - fullName: sp-webpart-base.BaseWebPart + fullName: BaseWebPart langs: - typeScript type: class @@ -44,7 +44,7 @@ items: Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. name: constructor() - fullName: sp-webpart-base.BaseWebPart.constructor + fullName: constructor langs: - typeScript type: constructor @@ -56,7 +56,7 @@ items: returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. name: accessibleTitle - fullName: sp-webpart-base.BaseWebPart.accessibleTitle + fullName: accessibleTitle langs: - typeScript type: property @@ -72,7 +72,7 @@ items: read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. name: context - fullName: sp-webpart-base.BaseWebPart.context + fullName: context langs: - typeScript type: property @@ -86,7 +86,7 @@ items: The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 name: dataVersion - fullName: sp-webpart-base.BaseWebPart.dataVersion + fullName: dataVersion langs: - typeScript type: property @@ -98,7 +98,7 @@ items: - uid: sp-webpart-base.BaseWebPart.description summary: Description of the WebPart name: description - fullName: sp-webpart-base.BaseWebPart.description + fullName: description langs: - typeScript type: property @@ -121,7 +121,7 @@ items: NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane button is clicked. name: disableReactivePropertyChanges - fullName: sp-webpart-base.BaseWebPart.disableReactivePropertyChanges + fullName: disableReactivePropertyChanges langs: - typeScript type: property @@ -133,7 +133,7 @@ items: - uid: sp-webpart-base.BaseWebPart.displayMode summary: This property is the current display mode of the web part. name: displayMode - fullName: sp-webpart-base.BaseWebPart.displayMode + fullName: displayMode langs: - typeScript type: property @@ -154,7 +154,7 @@ items: See IPropertyPane and other PropertyPane integration wiki documentation for more details. name: getPropertyPaneConfiguration() - fullName: sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration + fullName: getPropertyPaneConfiguration langs: - typeScript type: method @@ -177,7 +177,7 @@ items: deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. name: 'onAfterDeserialize(deserializedObject, dataVersion)' - fullName: sp-webpart-base.BaseWebPart.onAfterDeserialize + fullName: onAfterDeserialize langs: - typeScript type: method @@ -207,7 +207,7 @@ items: This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. name: onAfterPropertyPaneChangesApplied() - fullName: sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied + fullName: onAfterPropertyPaneChangesApplied langs: - typeScript type: method @@ -227,7 +227,7 @@ items: web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. name: onBeforeSerialize() - fullName: sp-webpart-base.BaseWebPart.onBeforeSerialize + fullName: onBeforeSerialize langs: - typeScript type: method @@ -244,7 +244,7 @@ items: display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. name: onDisplayModeChanged(oldDisplayMode) - fullName: sp-webpart-base.BaseWebPart.onDisplayModeChanged + fullName: onDisplayModeChanged langs: - typeScript type: method @@ -267,7 +267,7 @@ items: like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. name: onDispose() - fullName: sp-webpart-base.BaseWebPart.onDispose + fullName: onDispose langs: - typeScript type: method @@ -284,7 +284,7 @@ items: the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. name: onInit() - fullName: sp-webpart-base.BaseWebPart.onInit + fullName: onInit langs: - typeScript type: method @@ -307,7 +307,7 @@ items: - When the user switches web parts then the current web part gets this event. name: onPropertyPaneConfigurationComplete() - fullName: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationComplete + fullName: onPropertyPaneConfigurationComplete langs: - typeScript type: method @@ -326,7 +326,7 @@ items: - When the user switches web parts then the new web part gets this event. name: onPropertyPaneConfigurationStart() - fullName: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationStart + fullName: onPropertyPaneConfigurationStart langs: - typeScript type: method @@ -341,7 +341,7 @@ items: This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - fullName: sp-webpart-base.BaseWebPart.onPropertyPaneFieldChanged + fullName: onPropertyPaneFieldChanged langs: - typeScript type: method @@ -370,7 +370,7 @@ items: - uid: sp-webpart-base.BaseWebPart.onPropertyPaneRendered summary: This API is invoked when the PropertyPane is rendered. name: onPropertyPaneRendered() - fullName: sp-webpart-base.BaseWebPart.onPropertyPaneRendered + fullName: onPropertyPaneRendered langs: - typeScript type: method @@ -386,7 +386,7 @@ items: that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present. name: previewImageUrl - fullName: sp-webpart-base.BaseWebPart.previewImageUrl + fullName: previewImageUrl langs: - typeScript type: property @@ -398,7 +398,7 @@ items: - uid: sp-webpart-base.BaseWebPart.properties summary: This property is the pointer to the custom property bag of the web part. name: properties - fullName: sp-webpart-base.BaseWebPart.properties + fullName: properties langs: - typeScript type: property @@ -415,7 +415,7 @@ items: See [IWebPartPropertiesMetadata](xref:sp-webpart-base.IWebPartPropertiesMetadata) for more information about how to define metadata name: propertiesMetadata - fullName: sp-webpart-base.BaseWebPart.propertiesMetadata + fullName: propertiesMetadata langs: - typeScript type: property @@ -427,7 +427,7 @@ items: - uid: sp-webpart-base.BaseWebPart.title summary: Title of the WebPart name: title - fullName: sp-webpart-base.BaseWebPart.title + fullName: title langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 9a35210f..efc73e05 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -11,7 +11,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseWebPartContext class. name: BaseWebPartContext - fullName: sp-webpart-base.BaseWebPartContext + fullName: BaseWebPartContext langs: - typeScript type: class @@ -30,7 +30,7 @@ items: up different margins that when rendering in a canvas. isPreview: true name: formFactor - fullName: sp-webpart-base.BaseWebPartContext.formFactor + fullName: formFactor langs: - typeScript type: property @@ -42,7 +42,7 @@ items: - uid: sp-webpart-base.BaseWebPartContext.manifest summary: Manifest for the client-side component. name: manifest - fullName: sp-webpart-base.BaseWebPartContext.manifest + fullName: manifest langs: - typeScript type: property @@ -54,7 +54,7 @@ items: - uid: sp-webpart-base.BaseWebPartContext.propertyPane summary: Accessor for common web part property pane operations. name: propertyPane - fullName: sp-webpart-base.BaseWebPartContext.propertyPane + fullName: propertyPane langs: - typeScript type: property @@ -66,7 +66,7 @@ items: - uid: sp-webpart-base.BaseWebPartContext.webPartTag summary: Web part tag to be used for logging and telemetry. name: webPartTag - fullName: sp-webpart-base.BaseWebPartContext.webPartTag + fullName: webPartTag langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index f6f25a10..1af03003 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. name: DynamicDataSharedDepth - fullName: sp-webpart-base.DynamicDataSharedDepth + fullName: DynamicDataSharedDepth langs: - typeScript type: enum @@ -15,7 +15,7 @@ items: - uid: sp-webpart-base.DynamicDataSharedDepth.None summary: Indicates that nothing is shared. name: None - fullName: sp-webpart-base.DynamicDataSharedDepth.None + fullName: None langs: - typeScript type: field @@ -23,7 +23,7 @@ items: - uid: sp-webpart-base.DynamicDataSharedDepth.Property summary: Indicates that both the dynamic data source and the property are shared. name: Property - fullName: sp-webpart-base.DynamicDataSharedDepth.Property + fullName: Property langs: - typeScript type: field @@ -31,7 +31,7 @@ items: - uid: sp-webpart-base.DynamicDataSharedDepth.Source summary: Indicates that the dynamic data source is shared. name: Source - fullName: sp-webpart-base.DynamicDataSharedDepth.Source + fullName: Source langs: - typeScript type: field diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index cdf04959..89857203 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -5,7 +5,7 @@ items: Interface to be implemented by a component that should display the loading indicator and error messages for a web part. name: IClientSideWebPartStatusRenderer - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer + fullName: IClientSideWebPartStatusRenderer langs: - typeScript type: interface @@ -18,7 +18,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearError summary: Clear the webpart error message. name: clearError(domElement) - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.clearError + fullName: clearError langs: - typeScript type: method @@ -36,7 +36,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator summary: Clear the loading indicator. name: clearLoadingIndicator(domElement) - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator + fullName: clearLoadingIndicator langs: - typeScript type: method @@ -54,7 +54,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator summary: Display a loading spinner. name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator + fullName: displayLoadingIndicator langs: - typeScript type: method @@ -80,7 +80,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.renderError summary: Render the provided error message in the webpart container div. name: 'renderError(domElement, error)' - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.renderError + fullName: renderError langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index c3d14836..4c3420bd 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. name: IDynamicDataSharedPropertyConfiguration - fullName: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration langs: - typeScript type: interface @@ -13,7 +13,7 @@ items: - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters summary: Filters for the shared property. name: filters - fullName: sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters + fullName: filters langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index 356f61a4..d72c6cd4 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. name: IDynamicDataSharedPropertyFilters - fullName: sp-webpart-base.IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters langs: - typeScript type: interface @@ -24,7 +24,7 @@ items: Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it. name: propertyId - fullName: sp-webpart-base.IDynamicDataSharedPropertyFilters.propertyId + fullName: propertyId langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 930aae2b..1d4da3ab 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. name: IDynamicDataSharedSourceConfiguration - fullName: sp-webpart-base.IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration langs: - typeScript type: interface @@ -14,7 +14,7 @@ items: - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters summary: Filters for the shared source. name: filters - fullName: sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters + fullName: filters langs: - typeScript type: property @@ -29,7 +29,7 @@ items: default value - 'Connect to source' name: sourcesLabel - fullName: sp-webpart-base.IDynamicDataSharedSourceConfiguration.sourcesLabel + fullName: sourcesLabel langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index f04a6b05..2788eedb 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. name: IDynamicDataSharedSourceFilters - fullName: sp-webpart-base.IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters langs: - typeScript type: interface @@ -28,7 +28,7 @@ items: Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources. name: componentId - fullName: sp-webpart-base.IDynamicDataSharedSourceFilters.componentId + fullName: componentId langs: - typeScript type: property @@ -54,7 +54,7 @@ items: The source id for a web part will be of the form WebPart.. name: sourceId - fullName: sp-webpart-base.IDynamicDataSharedSourceFilters.sourceId + fullName: sourceId langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml b/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml index 0fbae79b..1dbec14c 100644 --- a/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml +++ b/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPlaceholderSpinnerProps summary: Interface for properties used to display the loading spinner in the web part display area. name: IPlaceholderSpinnerProps - fullName: sp-webpart-base.IPlaceholderSpinnerProps + fullName: IPlaceholderSpinnerProps langs: - typeScript type: interface @@ -14,7 +14,7 @@ items: - uid: sp-webpart-base.IPlaceholderSpinnerProps.hideSpinner summary: 'Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner' name: hideSpinner - fullName: sp-webpart-base.IPlaceholderSpinnerProps.hideSpinner + fullName: hideSpinner langs: - typeScript type: property @@ -26,7 +26,7 @@ items: - uid: sp-webpart-base.IPlaceholderSpinnerProps.label summary: Label associated with the spinner. name: label - fullName: sp-webpart-base.IPlaceholderSpinnerProps.label + fullName: label langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index ca34dbb9..5a83a622 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -5,7 +5,7 @@ items: Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane. name: IPropertyPaneAccessor - fullName: sp-webpart-base.IPropertyPaneAccessor + fullName: IPropertyPaneAccessor langs: - typeScript type: interface @@ -19,7 +19,7 @@ items: - uid: sp-webpart-base.IPropertyPaneAccessor.close summary: This API should be used to close the PropertyPane to help configure the web part. name: close() - fullName: sp-webpart-base.IPropertyPaneAccessor.close + fullName: close langs: - typeScript type: method @@ -32,7 +32,7 @@ items: - uid: sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen summary: Returns true if the PropertyPane is open. name: isPropertyPaneOpen() - fullName: sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen + fullName: isPropertyPaneOpen langs: - typeScript type: method @@ -48,7 +48,7 @@ items: For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. name: isRenderedByWebPart() - fullName: sp-webpart-base.IPropertyPaneAccessor.isRenderedByWebPart + fullName: isRenderedByWebPart langs: - typeScript type: method @@ -61,7 +61,7 @@ items: - uid: sp-webpart-base.IPropertyPaneAccessor.open summary: This API should be used to open the PropertyPane to help configure the web part. name: open() - fullName: sp-webpart-base.IPropertyPaneAccessor.open + fullName: open langs: - typeScript type: method @@ -77,7 +77,7 @@ items: This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. name: refresh() - fullName: sp-webpart-base.IPropertyPaneAccessor.refresh + fullName: refresh langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 1e0081c6..b87bb3e9 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps summary: PropertyPane button props. name: IPropertyPaneButtonProps - fullName: sp-webpart-base.IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps langs: - typeScript type: interface @@ -23,7 +23,7 @@ items: Besides the compound button, other button types will need more information provided to screen reader. name: ariaDescription - fullName: sp-webpart-base.IPropertyPaneButtonProps.ariaDescription + fullName: ariaDescription langs: - typeScript type: property @@ -35,7 +35,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps.ariaLabel summary: The aria label of the button for the benefit of screen readers. name: ariaLabel - fullName: sp-webpart-base.IPropertyPaneButtonProps.ariaLabel + fullName: ariaLabel langs: - typeScript type: property @@ -47,7 +47,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps.buttonType summary: The type of button to render. Default value is ButtonType.normal. name: buttonType - fullName: sp-webpart-base.IPropertyPaneButtonProps.buttonType + fullName: buttonType langs: - typeScript type: property @@ -59,7 +59,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps.description summary: Description of the action this button takes. Only used for compound buttons. name: description - fullName: sp-webpart-base.IPropertyPaneButtonProps.description + fullName: description langs: - typeScript type: property @@ -71,7 +71,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps.disabled summary: Whether the button is disabled. name: disabled - fullName: sp-webpart-base.IPropertyPaneButtonProps.disabled + fullName: disabled langs: - typeScript type: property @@ -83,7 +83,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps.icon summary: The button icon shown in command or hero type. name: icon - fullName: sp-webpart-base.IPropertyPaneButtonProps.icon + fullName: icon langs: - typeScript type: property @@ -98,7 +98,7 @@ items: returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. name: onClick - fullName: sp-webpart-base.IPropertyPaneButtonProps.onClick + fullName: onClick langs: - typeScript type: property @@ -110,7 +110,7 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps.text summary: Display text of the element. name: text - fullName: sp-webpart-base.IPropertyPaneButtonProps.text + fullName: text langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 39e03aea..1e66200f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. name: IPropertyPaneCheckboxProps - fullName: sp-webpart-base.IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. name: checked - fullName: sp-webpart-base.IPropertyPaneCheckboxProps.checked + fullName: checked langs: - typeScript type: property @@ -28,7 +28,7 @@ items: - uid: sp-webpart-base.IPropertyPaneCheckboxProps.disabled summary: Whether the property pane checkbox is disabled or not. name: disabled - fullName: sp-webpart-base.IPropertyPaneCheckboxProps.disabled + fullName: disabled langs: - typeScript type: property @@ -40,7 +40,7 @@ items: - uid: sp-webpart-base.IPropertyPaneCheckboxProps.text summary: Label to display next to the checkbox. name: text - fullName: sp-webpart-base.IPropertyPaneCheckboxProps.text + fullName: text langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index a3b56fae..a03c710f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. name: IPropertyPaneChoiceGroupOption - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption langs: - typeScript type: interface @@ -23,7 +23,7 @@ items: Default value is false. name: checked - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.checked + fullName: checked langs: - typeScript type: property @@ -35,7 +35,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.disabled summary: Whether the property pane choice group option is disabled or not. name: disabled - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.disabled + fullName: disabled langs: - typeScript type: property @@ -47,7 +47,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.iconProps summary: The Icon component props for choice field. name: iconProps - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.iconProps + fullName: iconProps langs: - typeScript type: property @@ -59,7 +59,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSize summary: The width and height of the image in px for choice field. name: imageSize - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSize + fullName: imageSize langs: - typeScript type: property @@ -75,7 +75,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSrc summary: The src of image for choice field. name: imageSrc - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSrc + fullName: imageSrc langs: - typeScript type: property @@ -87,7 +87,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.key summary: A required key to uniquely identify the option. name: key - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.key + fullName: key langs: - typeScript type: property @@ -99,7 +99,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.selectedImageSrc summary: The src of image for choice field which is selected. name: selectedImageSrc - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.selectedImageSrc + fullName: selectedImageSrc langs: - typeScript type: property @@ -111,7 +111,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.text summary: The text string for the option. name: text - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOption.text + fullName: text langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index b45e14f0..597fcb8c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. name: IPropertyPaneChoiceGroupOptionIconProps - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps langs: - typeScript type: interface @@ -13,7 +13,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps.officeFabricIconFontName summary: The name of the icon to use from the Office Fabric icon set. name: officeFabricIconFontName - fullName: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps.officeFabricIconFontName + fullName: officeFabricIconFontName langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 13e128b6..b41730d0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. name: IPropertyPaneChoiceGroupProps - fullName: sp-webpart-base.IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps langs: - typeScript type: interface @@ -14,7 +14,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps.label summary: Descriptive label for the choice group. name: label - fullName: sp-webpart-base.IPropertyPaneChoiceGroupProps.label + fullName: label langs: - typeScript type: property @@ -26,7 +26,7 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps.options summary: The options for the choice group. name: options - fullName: sp-webpart-base.IPropertyPaneChoiceGroupProps.options + fullName: options langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index eed30f93..a8539be3 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup summary: Property pane conditional group. name: IPropertyPaneConditionalGroup - fullName: sp-webpart-base.IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup langs: - typeScript type: interface @@ -17,7 +17,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup summary: Callback when user clicks to show primary group. name: onShowPrimaryGroup - fullName: sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup + fullName: onShowPrimaryGroup langs: - typeScript type: property @@ -29,7 +29,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup summary: Callback when user clicks to show secondary group. name: onShowSecondaryGroup - fullName: sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup + fullName: onShowSecondaryGroup langs: - typeScript type: property @@ -41,7 +41,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup summary: Primary group to show name: primaryGroup - fullName: sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup + fullName: primaryGroup langs: - typeScript type: property @@ -53,7 +53,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup summary: Secondary group to show name: secondaryGroup - fullName: sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup + fullName: secondaryGroup langs: - typeScript type: property @@ -65,7 +65,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup summary: Indicating whether the property pane should show primary group or the secondary group. name: showSecondaryGroup - fullName: sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup + fullName: showSecondaryGroup langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 1dc9c8a6..2b6f023b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConfiguration summary: Web part configuration settings name: IPropertyPaneConfiguration - fullName: sp-webpart-base.IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConfiguration.currentPage summary: Page to be displayed on the PropertyPane. name: currentPage - fullName: sp-webpart-base.IPropertyPaneConfiguration.currentPage + fullName: currentPage langs: - typeScript type: property @@ -29,7 +29,7 @@ items: summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. name: loadingIndicatorDelayTime - fullName: sp-webpart-base.IPropertyPaneConfiguration.loadingIndicatorDelayTime + fullName: loadingIndicatorDelayTime langs: - typeScript type: property @@ -41,7 +41,7 @@ items: - uid: sp-webpart-base.IPropertyPaneConfiguration.pages summary: Total number of pages on the PropertyPane. name: pages - fullName: sp-webpart-base.IPropertyPaneConfiguration.pages + fullName: pages langs: - typeScript type: property @@ -61,7 +61,7 @@ items: The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user. name: showLoadingIndicator - fullName: sp-webpart-base.IPropertyPaneConfiguration.showLoadingIndicator + fullName: showLoadingIndicator langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 1c420cad..98a8f163 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. name: IPropertyPaneCustomFieldProps - fullName: sp-webpart-base.IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps langs: - typeScript type: interface @@ -18,7 +18,7 @@ items: Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information. name: context - fullName: sp-webpart-base.IPropertyPaneCustomFieldProps.context + fullName: context langs: - typeScript type: property @@ -37,10 +37,10 @@ items: to pick the value of the key. - For more information, see the [ React + For more information, see the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). name: key - fullName: sp-webpart-base.IPropertyPaneCustomFieldProps.key + fullName: key langs: - typeScript type: property @@ -52,7 +52,7 @@ items: - uid: sp-webpart-base.IPropertyPaneCustomFieldProps.onDispose summary: This API is called when the component is unmounted from the host element. name: onDispose - fullName: sp-webpart-base.IPropertyPaneCustomFieldProps.onDispose + fullName: onDispose langs: - typeScript type: property @@ -64,7 +64,7 @@ items: - uid: sp-webpart-base.IPropertyPaneCustomFieldProps.onRender summary: This API will be called once the custom field is mounted on the host element. name: onRender - fullName: sp-webpart-base.IPropertyPaneCustomFieldProps.onRender + fullName: onRender langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 550d84cf..8c2fc847 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. name: IPropertyPaneDropdownCalloutProps - fullName: sp-webpart-base.IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps langs: - typeScript type: interface @@ -13,7 +13,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen name: calloutMaxHeight - fullName: sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight + fullName: calloutMaxHeight langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 1eef5152..3b7d3777 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownOption summary: PropertyPane drop down options. name: IPropertyPaneDropdownOption - fullName: sp-webpart-base.IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownOption.index summary: Index for this option. name: index - fullName: sp-webpart-base.IPropertyPaneDropdownOption.index + fullName: index langs: - typeScript type: property @@ -28,7 +28,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownOption.key summary: A key to uniquely identify this option. name: key - fullName: sp-webpart-base.IPropertyPaneDropdownOption.key + fullName: key langs: - typeScript type: property @@ -40,7 +40,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownOption.text summary: Text to render for this option. name: text - fullName: sp-webpart-base.IPropertyPaneDropdownOption.text + fullName: text langs: - typeScript type: property @@ -52,7 +52,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownOption.type summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' name: type - fullName: sp-webpart-base.IPropertyPaneDropdownOption.type + fullName: type langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 87f05a3d..d2867dde 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps summary: PropertyPane drop down component props. name: IPropertyPaneDropdownProps - fullName: sp-webpart-base.IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps langs: - typeScript type: interface @@ -20,7 +20,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel summary: A description of the dropdown for the benefit of screen reader users. name: ariaLabel - fullName: sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel + fullName: ariaLabel langs: - typeScript type: property @@ -34,7 +34,7 @@ items: Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1. name: ariaPositionInSet - fullName: sp-webpart-base.IPropertyPaneDropdownProps.ariaPositionInSet + fullName: ariaPositionInSet langs: - typeScript type: property @@ -46,7 +46,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. name: ariaSetSize - fullName: sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize + fullName: ariaSetSize langs: - typeScript type: property @@ -58,7 +58,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.calloutProps summary: Custom properties for Dropdown's Callout used to render options. name: calloutProps - fullName: sp-webpart-base.IPropertyPaneDropdownProps.calloutProps + fullName: calloutProps langs: - typeScript type: property @@ -70,7 +70,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.disabled summary: Whether the property pane dropdown option is disabled or not. name: disabled - fullName: sp-webpart-base.IPropertyPaneDropdownProps.disabled + fullName: disabled langs: - typeScript type: property @@ -82,7 +82,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.label summary: Descriptive label for the Dropdown. name: label - fullName: sp-webpart-base.IPropertyPaneDropdownProps.label + fullName: label langs: - typeScript type: property @@ -94,7 +94,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.options summary: Collection of options for this Dropdown. name: options - fullName: sp-webpart-base.IPropertyPaneDropdownProps.options + fullName: options langs: - typeScript type: property @@ -106,7 +106,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps.selectedKey summary: The key of the initially selected option. name: selectedKey - fullName: sp-webpart-base.IPropertyPaneDropdownProps.selectedKey + fullName: selectedKey langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index f6cb3690..318cfb21 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. name: IPropertyPaneDynamicFieldProps - fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps langs: - typeScript type: interface @@ -16,7 +16,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.filters summary: Filters for the property pane dynamic field. name: filters - fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.filters + fullName: filters langs: - typeScript type: property @@ -28,7 +28,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.label summary: 'User-friendly, localized label to identify the field.' name: label - fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.label + fullName: label langs: - typeScript type: property @@ -49,7 +49,7 @@ items: levels of property value will be shown i.e., the widget will display two levels after the source and property for this field. name: propertyValueDepth - fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.propertyValueDepth + fullName: propertyValueDepth langs: - typeScript type: property @@ -64,7 +64,7 @@ items: default value - 'Connect to source' name: sourcesLabel - fullName: sp-webpart-base.IPropertyPaneDynamicFieldProps.sourcesLabel + fullName: sourcesLabel langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 976282ec..50f986a5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. name: IPropertyPaneDynamicFieldSetProps - fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. name: fields - fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields + fullName: fields langs: - typeScript type: property @@ -27,7 +27,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label summary: 'User-friendly, localized label to identify the property.' name: label - fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label + fullName: label langs: - typeScript type: property @@ -39,7 +39,7 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration summary: Configuration shared between all the entries of the set. name: sharedConfiguration - fullName: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration + fullName: sharedConfiguration langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 611088ca..2678a81f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -6,7 +6,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: IPropertyPaneDynamicTextFieldProps - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps langs: - typeScript type: interface @@ -28,7 +28,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: ariaLabel - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel + fullName: ariaLabel langs: - typeScript type: property @@ -43,7 +43,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: description - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description + fullName: description langs: - typeScript type: property @@ -58,7 +58,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: disabled - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled + fullName: disabled langs: - typeScript type: property @@ -79,7 +79,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: errorMessage - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage + fullName: errorMessage langs: - typeScript type: property @@ -94,7 +94,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: label - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label + fullName: label langs: - typeScript type: property @@ -121,7 +121,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: onGetErrorMessage - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage + fullName: onGetErrorMessage langs: - typeScript type: property @@ -136,7 +136,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: placeholder - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder + fullName: placeholder langs: - typeScript type: property @@ -152,7 +152,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: validateOnFocusIn - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn + fullName: validateOnFocusIn langs: - typeScript type: property @@ -168,7 +168,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: validateOnFocusOut - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut + fullName: validateOnFocusOut langs: - typeScript type: property @@ -185,7 +185,7 @@ items: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' isPreview: true name: value - fullName: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value + fullName: value langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 81b7fe82..860d4131 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneField summary: PropertyPane field. name: IPropertyPaneField - fullName: sp-webpart-base.IPropertyPaneField + fullName: IPropertyPaneField langs: - typeScript type: interface @@ -17,7 +17,7 @@ items: summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' name: properties - fullName: sp-webpart-base.IPropertyPaneField.properties + fullName: properties langs: - typeScript type: property @@ -30,7 +30,7 @@ items: summary: Whether this control should be focused. remarks: The default value is false. name: shouldFocus - fullName: sp-webpart-base.IPropertyPaneField.shouldFocus + fullName: shouldFocus langs: - typeScript type: property @@ -42,7 +42,7 @@ items: - uid: sp-webpart-base.IPropertyPaneField.targetProperty summary: Target property from the web part's property bag. name: targetProperty - fullName: sp-webpart-base.IPropertyPaneField.targetProperty + fullName: targetProperty langs: - typeScript type: property @@ -54,7 +54,7 @@ items: - uid: sp-webpart-base.IPropertyPaneField.type summary: Type of the PropertyPane field. name: type - fullName: sp-webpart-base.IPropertyPaneField.type + fullName: type langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index b4e6efeb..aabbdf01 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. name: IPropertyPaneGroup - fullName: sp-webpart-base.IPropertyPaneGroup + fullName: IPropertyPaneGroup langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-webpart-base.IPropertyPaneGroup.groupFields summary: List of PropertyPane fields. name: groupFields - fullName: sp-webpart-base.IPropertyPaneGroup.groupFields + fullName: groupFields langs: - typeScript type: property @@ -28,7 +28,7 @@ items: summary: Display name for the group. remarks: 'For performance reasons, it''s highly recommended to keep this name unique within the property pane page.' name: groupName - fullName: sp-webpart-base.IPropertyPaneGroup.groupName + fullName: groupName langs: - typeScript type: property @@ -41,7 +41,7 @@ items: summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. name: isCollapsed - fullName: sp-webpart-base.IPropertyPaneGroup.isCollapsed + fullName: isCollapsed langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index a9bc4e3c..7ad34f65 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLabelProps summary: PropertyPaneLabel component props. name: IPropertyPaneLabelProps - fullName: sp-webpart-base.IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: summary: Whether the associated form field is required or not. remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' name: required - fullName: sp-webpart-base.IPropertyPaneLabelProps.required + fullName: required langs: - typeScript type: property @@ -27,7 +27,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLabelProps.text summary: Display text fot the label. name: text - fullName: sp-webpart-base.IPropertyPaneLabelProps.text + fullName: text langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index a948ea37..943ef41c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLinkProps summary: PropertyPaneLink component props. name: IPropertyPaneLinkProps - fullName: sp-webpart-base.IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps langs: - typeScript type: interface @@ -17,7 +17,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLinkProps.disabled summary: Whether the property pane link is disabled or not. name: disabled - fullName: sp-webpart-base.IPropertyPaneLinkProps.disabled + fullName: disabled langs: - typeScript type: property @@ -29,7 +29,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLinkProps.href summary: Location to which the link is targeted to. name: href - fullName: sp-webpart-base.IPropertyPaneLinkProps.href + fullName: href langs: - typeScript type: property @@ -41,7 +41,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLinkProps.popupWindowProps summary: The props of pop up window. name: popupWindowProps - fullName: sp-webpart-base.IPropertyPaneLinkProps.popupWindowProps + fullName: popupWindowProps langs: - typeScript type: property @@ -68,7 +68,7 @@ items: \_top - Load the response into the original window. name: target - fullName: sp-webpart-base.IPropertyPaneLinkProps.target + fullName: target langs: - typeScript type: property @@ -80,7 +80,7 @@ items: - uid: sp-webpart-base.IPropertyPaneLinkProps.text summary: Display text for the link. name: text - fullName: sp-webpart-base.IPropertyPaneLinkProps.text + fullName: text langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index 33d4236a..49a7d32e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPanePage summary: PropertyPanePage interface. name: IPropertyPanePage - fullName: sp-webpart-base.IPropertyPanePage + fullName: IPropertyPanePage langs: - typeScript type: interface @@ -15,7 +15,7 @@ items: - uid: sp-webpart-base.IPropertyPanePage.displayGroupsAsAccordion summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. name: displayGroupsAsAccordion - fullName: sp-webpart-base.IPropertyPanePage.displayGroupsAsAccordion + fullName: displayGroupsAsAccordion langs: - typeScript type: property @@ -27,7 +27,7 @@ items: - uid: sp-webpart-base.IPropertyPanePage.groups summary: List of groups to be displayed on the PropertyPane page. name: groups - fullName: sp-webpart-base.IPropertyPanePage.groups + fullName: groups langs: - typeScript type: property @@ -39,7 +39,7 @@ items: - uid: sp-webpart-base.IPropertyPanePage.header summary: PropertyPane page header. name: header - fullName: sp-webpart-base.IPropertyPanePage.header + fullName: header langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index d938de44..5835ef0f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. name: IPropertyPanePageHeader - fullName: sp-webpart-base.IPropertyPanePageHeader + fullName: IPropertyPanePageHeader langs: - typeScript type: interface @@ -14,7 +14,7 @@ items: - uid: sp-webpart-base.IPropertyPanePageHeader.description summary: Header to display. name: description - fullName: sp-webpart-base.IPropertyPanePageHeader.description + fullName: description langs: - typeScript type: property @@ -26,7 +26,7 @@ items: - uid: sp-webpart-base.IPropertyPanePageHeader.image summary: Image url for the background image. name: image - fullName: sp-webpart-base.IPropertyPanePageHeader.image + fullName: image langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index f0e2c8ab..3e70917b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. name: IPropertyPaneSliderProps - fullName: sp-webpart-base.IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps langs: - typeScript type: interface @@ -20,7 +20,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps.ariaLabel summary: A description of the Slider for the benefit of screen readers. name: ariaLabel - fullName: sp-webpart-base.IPropertyPaneSliderProps.ariaLabel + fullName: ariaLabel langs: - typeScript type: property @@ -32,7 +32,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps.disabled summary: Whether or not the Slider is disabled. name: disabled - fullName: sp-webpart-base.IPropertyPaneSliderProps.disabled + fullName: disabled langs: - typeScript type: property @@ -44,7 +44,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps.label summary: Description label of the Slider. name: label - fullName: sp-webpart-base.IPropertyPaneSliderProps.label + fullName: label langs: - typeScript type: property @@ -56,7 +56,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps.max summary: The max value of the Slider. name: max - fullName: sp-webpart-base.IPropertyPaneSliderProps.max + fullName: max langs: - typeScript type: property @@ -68,7 +68,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps.min summary: The min value of the Slider. name: min - fullName: sp-webpart-base.IPropertyPaneSliderProps.min + fullName: min langs: - typeScript type: property @@ -81,7 +81,7 @@ items: summary: Whether to show the value on the right of the Slider. remarks: 'If you want to show the value by yourself, you may want to set this value to false.' name: showValue - fullName: sp-webpart-base.IPropertyPaneSliderProps.showValue + fullName: showValue langs: - typeScript type: property @@ -93,7 +93,7 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps.step summary: The difference between the two adjacent values of the Slider. Defaults to 1. name: step - fullName: sp-webpart-base.IPropertyPaneSliderProps.step + fullName: step langs: - typeScript type: property @@ -108,7 +108,7 @@ items: Defaults to min. name: value - fullName: sp-webpart-base.IPropertyPaneSliderProps.value + fullName: value langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index decf81ff..514e1d38 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. name: IPropertyPaneTextFieldProps - fullName: sp-webpart-base.IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps langs: - typeScript type: interface @@ -29,7 +29,7 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps.ariaLabel summary: 'Aria Label for text field, if any.' name: ariaLabel - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.ariaLabel + fullName: ariaLabel langs: - typeScript type: property @@ -42,7 +42,7 @@ items: summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. name: deferredValidationTime - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.deferredValidationTime + fullName: deferredValidationTime langs: - typeScript type: property @@ -54,7 +54,7 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps.description summary: The text field input description. name: description - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.description + fullName: description langs: - typeScript type: property @@ -66,7 +66,7 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps.disabled summary: Whether the property pane text field is enabled or not. name: disabled - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.disabled + fullName: disabled langs: - typeScript type: property @@ -84,7 +84,7 @@ items: So, make sure to set this only if you want to see an error message displayed for the text field. name: errorMessage - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.errorMessage + fullName: errorMessage langs: - typeScript type: property @@ -96,7 +96,7 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps.label summary: Label for the text field. name: label - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.label + fullName: label langs: - typeScript type: property @@ -129,7 +129,7 @@ items: 2. The text length after each edit name: logName - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.logName + fullName: logName langs: - typeScript type: property @@ -146,7 +146,7 @@ items: summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' name: maxLength - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.maxLength + fullName: maxLength langs: - typeScript type: property @@ -159,7 +159,7 @@ items: summary: Whether or not the text field is a multiline text field. remarks: The default value is false. name: multiline - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.multiline + fullName: multiline langs: - typeScript type: property @@ -183,7 +183,7 @@ items: - The rejected, the value is thrown away. name: onGetErrorMessage - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.onGetErrorMessage + fullName: onGetErrorMessage langs: - typeScript type: property @@ -195,7 +195,7 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps.placeholder summary: placeholder text to be displayed in the text field. name: placeholder - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.placeholder + fullName: placeholder langs: - typeScript type: property @@ -208,7 +208,7 @@ items: summary: Whether or not the multiline text field is resizable. remarks: The default value is true. name: resizable - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.resizable + fullName: resizable langs: - typeScript type: property @@ -221,7 +221,7 @@ items: summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. name: rows - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.rows + fullName: rows langs: - typeScript type: property @@ -234,7 +234,7 @@ items: summary: Whether or not the text field is underlined. remarks: The default value is false. name: underlined - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.underlined + fullName: underlined langs: - typeScript type: property @@ -247,7 +247,7 @@ items: summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. name: validateOnFocusIn - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.validateOnFocusIn + fullName: validateOnFocusIn langs: - typeScript type: property @@ -260,7 +260,7 @@ items: summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. name: validateOnFocusOut - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.validateOnFocusOut + fullName: validateOnFocusOut langs: - typeScript type: property @@ -274,7 +274,7 @@ items: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. name: value - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.value + fullName: value langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index d4918fe9..0c6eb968 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps summary: PropertyPaneToggle component props. name: IPropertyPaneToggleProps - fullName: sp-webpart-base.IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps langs: - typeScript type: interface @@ -21,7 +21,7 @@ items: summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' name: checked - fullName: sp-webpart-base.IPropertyPaneToggleProps.checked + fullName: checked langs: - typeScript type: property @@ -33,7 +33,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.disabled summary: Optional disabled flag. name: disabled - fullName: sp-webpart-base.IPropertyPaneToggleProps.disabled + fullName: disabled langs: - typeScript type: property @@ -45,7 +45,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.key summary: A key to uniquely identify the field. name: key - fullName: sp-webpart-base.IPropertyPaneToggleProps.key + fullName: key langs: - typeScript type: property @@ -57,7 +57,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.label summary: A label for the toggle. name: label - fullName: sp-webpart-base.IPropertyPaneToggleProps.label + fullName: label langs: - typeScript type: property @@ -69,7 +69,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.offAriaLabel summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. name: offAriaLabel - fullName: sp-webpart-base.IPropertyPaneToggleProps.offAriaLabel + fullName: offAriaLabel langs: - typeScript type: property @@ -81,7 +81,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.offText summary: Test display when toggle is OFF. name: offText - fullName: sp-webpart-base.IPropertyPaneToggleProps.offText + fullName: offText langs: - typeScript type: property @@ -93,7 +93,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.onAriaLabel summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. name: onAriaLabel - fullName: sp-webpart-base.IPropertyPaneToggleProps.onAriaLabel + fullName: onAriaLabel langs: - typeScript type: property @@ -105,7 +105,7 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps.onText summary: Text to display when toggle is ON. name: onText - fullName: sp-webpart-base.IPropertyPaneToggleProps.onText + fullName: onText langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index 23f15cc6..38fa6f8f 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.ISerializedServerProcessedData summary: Contains collections of data that can be processed by server side services like search index and link fixup name: ISerializedServerProcessedData - fullName: sp-webpart-base.ISerializedServerProcessedData + fullName: ISerializedServerProcessedData langs: - typeScript type: interface @@ -32,7 +32,7 @@ items: ``` name: htmlStrings - fullName: sp-webpart-base.ISerializedServerProcessedData.htmlStrings + fullName: htmlStrings langs: - typeScript type: property @@ -58,7 +58,7 @@ items: ``` name: imageSources - fullName: sp-webpart-base.ISerializedServerProcessedData.imageSources + fullName: imageSources langs: - typeScript type: property @@ -84,7 +84,7 @@ items: ``` name: links - fullName: sp-webpart-base.ISerializedServerProcessedData.links + fullName: links langs: - typeScript type: property @@ -115,7 +115,7 @@ items: ``` name: searchablePlainTexts - fullName: sp-webpart-base.ISerializedServerProcessedData.searchablePlainTexts + fullName: searchablePlainTexts langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index cfe9da30..d8e3c909 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -5,7 +5,7 @@ items: This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data. name: ISerializedWebPartData - fullName: sp-webpart-base.ISerializedWebPartData + fullName: ISerializedWebPartData langs: - typeScript type: interface @@ -29,7 +29,7 @@ items: Example: `"1.0"` name: dataVersion - fullName: sp-webpart-base.ISerializedWebPartData.dataVersion + fullName: dataVersion langs: - typeScript type: property @@ -55,7 +55,7 @@ items: ``` isPreview: true name: dynamicDataPaths - fullName: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths + fullName: dynamicDataPaths langs: - typeScript type: property @@ -84,7 +84,7 @@ items: ``` isPreview: true name: dynamicDataValues - fullName: sp-webpart-base.ISerializedWebPartData.dynamicDataValues + fullName: dynamicDataValues langs: - typeScript type: property @@ -108,7 +108,7 @@ items: Example: `{ 'value': 'text value' }` name: properties - fullName: sp-webpart-base.ISerializedWebPartData.properties + fullName: properties langs: - typeScript type: property @@ -120,7 +120,7 @@ items: - uid: sp-webpart-base.ISerializedWebPartData.serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup. name: serverProcessedContent - fullName: sp-webpart-base.ISerializedWebPartData.serverProcessedContent + fullName: serverProcessedContent langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 6b6a1a88..fe9ea102 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -11,7 +11,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: IWebPartContext - fullName: sp-webpart-base.IWebPartContext + fullName: IWebPartContext langs: - typeScript type: interface @@ -34,7 +34,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: domElement - fullName: sp-webpart-base.IWebPartContext.domElement + fullName: domElement langs: - typeScript type: property @@ -51,7 +51,7 @@ items: [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. isPreview: true name: graphHttpClient - fullName: sp-webpart-base.IWebPartContext.graphHttpClient + fullName: graphHttpClient langs: - typeScript type: property @@ -67,7 +67,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: httpClient - fullName: sp-webpart-base.IWebPartContext.httpClient + fullName: httpClient langs: - typeScript type: property @@ -83,7 +83,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: instanceId - fullName: sp-webpart-base.IWebPartContext.instanceId + fullName: instanceId langs: - typeScript type: property @@ -99,7 +99,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: manifest - fullName: sp-webpart-base.IWebPartContext.manifest + fullName: manifest langs: - typeScript type: property @@ -115,7 +115,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: pageContext - fullName: sp-webpart-base.IWebPartContext.pageContext + fullName: pageContext langs: - typeScript type: property @@ -131,7 +131,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: propertyPane - fullName: sp-webpart-base.IWebPartContext.propertyPane + fullName: propertyPane langs: - typeScript type: property @@ -147,7 +147,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: spHttpClient - fullName: sp-webpart-base.IWebPartContext.spHttpClient + fullName: spHttpClient langs: - typeScript type: property @@ -163,7 +163,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: statusRenderer - fullName: sp-webpart-base.IWebPartContext.statusRenderer + fullName: statusRenderer langs: - typeScript type: property @@ -179,7 +179,7 @@ items: This interface will be removed in an upcoming release. Use the [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: webPartTag - fullName: sp-webpart-base.IWebPartContext.webPartTag + fullName: webPartTag langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 290f9f0b..c789f1bd 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -7,7 +7,7 @@ items: 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize. name: IWebPartData - fullName: sp-webpart-base.IWebPartData + fullName: IWebPartData langs: - typeScript type: interface @@ -35,7 +35,7 @@ items: Example: `"1.0"` name: dataVersion - fullName: sp-webpart-base.IWebPartData.dataVersion + fullName: dataVersion langs: - typeScript type: property @@ -53,7 +53,7 @@ items: Example: `"Text"` name: description - fullName: sp-webpart-base.IWebPartData.description + fullName: description langs: - typeScript type: property @@ -84,7 +84,7 @@ items: ``` isPreview: true name: dynamicDataPaths - fullName: sp-webpart-base.IWebPartData.dynamicDataPaths + fullName: dynamicDataPaths langs: - typeScript type: property @@ -113,7 +113,7 @@ items: ``` isPreview: true name: dynamicDataValues - fullName: sp-webpart-base.IWebPartData.dynamicDataValues + fullName: dynamicDataValues langs: - typeScript type: property @@ -129,7 +129,7 @@ items: summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' name: id - fullName: sp-webpart-base.IWebPartData.id + fullName: id langs: - typeScript type: property @@ -147,7 +147,7 @@ items: example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` name: instanceId - fullName: sp-webpart-base.IWebPartData.instanceId + fullName: instanceId langs: - typeScript type: property @@ -168,7 +168,7 @@ items: Example: `{ 'value': 'text value' }` name: properties - fullName: sp-webpart-base.IWebPartData.properties + fullName: properties langs: - typeScript type: property @@ -180,7 +180,7 @@ items: - uid: sp-webpart-base.IWebPartData.serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup name: serverProcessedContent - fullName: sp-webpart-base.IWebPartData.serverProcessedContent + fullName: serverProcessedContent langs: - typeScript type: property @@ -198,7 +198,7 @@ items: Example: `"Text"` name: title - fullName: sp-webpart-base.IWebPartData.title + fullName: title langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index dbb99063..4b859165 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -56,7 +56,7 @@ items: indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated. name: IWebPartPropertiesMetadata - fullName: sp-webpart-base.IWebPartPropertiesMetadata + fullName: IWebPartPropertiesMetadata langs: - typeScript type: interface @@ -65,7 +65,7 @@ items: - sp-webpart-base.IWebPartPropertiesMetadata.__index - uid: sp-webpart-base.IWebPartPropertiesMetadata.__index name: __index(key) - fullName: sp-webpart-base.IWebPartPropertiesMetadata.__index + fullName: __index langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index d49cd5cd..6e72ed64 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.IWebPartPropertyMetadata summary: This is the structure used for map values in `IWebPartPropertiesMetadata` name: IWebPartPropertyMetadata - fullName: sp-webpart-base.IWebPartPropertyMetadata + fullName: IWebPartPropertyMetadata langs: - typeScript type: interface @@ -32,7 +32,7 @@ items: Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. name: dynamicPropertyType - fullName: sp-webpart-base.IWebPartPropertyMetadata.dynamicPropertyType + fullName: dynamicPropertyType langs: - typeScript type: property @@ -64,7 +64,7 @@ items: SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. name: isHtmlString - fullName: sp-webpart-base.IWebPartPropertyMetadata.isHtmlString + fullName: isHtmlString langs: - typeScript type: property @@ -78,7 +78,7 @@ items: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. name: isImageSource - fullName: sp-webpart-base.IWebPartPropertyMetadata.isImageSource + fullName: isImageSource langs: - typeScript type: property @@ -92,7 +92,7 @@ items: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. name: isLink - fullName: sp-webpart-base.IWebPartPropertyMetadata.isLink + fullName: isLink langs: - typeScript type: property @@ -112,7 +112,7 @@ items: Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. name: isSearchablePlainText - fullName: sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText + fullName: isSearchablePlainText langs: - typeScript type: property @@ -135,7 +135,7 @@ items: Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data. name: shouldNotPersist - fullName: sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist + fullName: shouldNotPersist langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index d5a8d1f7..8c260331 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -3,7 +3,7 @@ items: - uid: sp-webpart-base.PropertyPaneButtonType summary: Enum for all the supported button types. name: PropertyPaneButtonType - fullName: sp-webpart-base.PropertyPaneButtonType + fullName: PropertyPaneButtonType langs: - typeScript type: enum @@ -21,7 +21,7 @@ items: Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts. name: Command - fullName: sp-webpart-base.PropertyPaneButtonType.Command + fullName: Command langs: - typeScript type: field @@ -32,7 +32,7 @@ items: Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form name: Compound - fullName: sp-webpart-base.PropertyPaneButtonType.Compound + fullName: Compound langs: - typeScript type: field @@ -40,7 +40,7 @@ items: - uid: sp-webpart-base.PropertyPaneButtonType.Hero summary: Hero button. name: Hero - fullName: sp-webpart-base.PropertyPaneButtonType.Hero + fullName: Hero langs: - typeScript type: field @@ -56,7 +56,7 @@ items: SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range. name: Icon - fullName: sp-webpart-base.PropertyPaneButtonType.Icon + fullName: Icon langs: - typeScript type: field @@ -68,7 +68,7 @@ items: an action. Examples: "Done" button which closes a container but doesn't make a server call or an "Undo" button when a user is uploading a file in OneDrive. name: Normal - fullName: sp-webpart-base.PropertyPaneButtonType.Normal + fullName: Normal langs: - typeScript type: field @@ -77,7 +77,7 @@ items: summary: Preferred completion action when paired with a Standard button. remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' name: Primary - fullName: sp-webpart-base.PropertyPaneButtonType.Primary + fullName: Primary langs: - typeScript type: field diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 9019252e..0e5affc2 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -5,7 +5,7 @@ items: Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown](xref:sp-webpart-base.PropertyPaneDropdown). name: PropertyPaneDropdownOptionType - fullName: sp-webpart-base.PropertyPaneDropdownOptionType + fullName: PropertyPaneDropdownOptionType langs: - typeScript type: enum @@ -17,7 +17,7 @@ items: - uid: sp-webpart-base.PropertyPaneDropdownOptionType.Divider summary: Render a divider. name: Divider - fullName: sp-webpart-base.PropertyPaneDropdownOptionType.Divider + fullName: Divider langs: - typeScript type: field @@ -25,7 +25,7 @@ items: - uid: sp-webpart-base.PropertyPaneDropdownOptionType.Header summary: Render menu item as a header. name: Header - fullName: sp-webpart-base.PropertyPaneDropdownOptionType.Header + fullName: Header langs: - typeScript type: field @@ -33,7 +33,7 @@ items: - uid: sp-webpart-base.PropertyPaneDropdownOptionType.Normal summary: Render normal menu item. name: Normal - fullName: sp-webpart-base.PropertyPaneDropdownOptionType.Normal + fullName: Normal langs: - typeScript type: field diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index f5b06f6a..b8ac8915 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -6,7 +6,7 @@ items: Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. name: PropertyPaneFieldType - fullName: sp-webpart-base.PropertyPaneFieldType + fullName: PropertyPaneFieldType langs: - typeScript type: enum @@ -30,7 +30,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Button summary: Button field. name: Button - fullName: sp-webpart-base.PropertyPaneFieldType.Button + fullName: Button langs: - typeScript type: field @@ -38,7 +38,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.CheckBox summary: Checkbox field. name: CheckBox - fullName: sp-webpart-base.PropertyPaneFieldType.CheckBox + fullName: CheckBox langs: - typeScript type: field @@ -46,7 +46,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.ChoiceGroup summary: Choice Group field. name: ChoiceGroup - fullName: sp-webpart-base.PropertyPaneFieldType.ChoiceGroup + fullName: ChoiceGroup langs: - typeScript type: field @@ -54,7 +54,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Custom summary: Custom field. name: Custom - fullName: sp-webpart-base.PropertyPaneFieldType.Custom + fullName: Custom langs: - typeScript type: field @@ -62,7 +62,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Dropdown summary: Dropdown field. name: Dropdown - fullName: sp-webpart-base.PropertyPaneFieldType.Dropdown + fullName: Dropdown langs: - typeScript type: field @@ -70,7 +70,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.DynamicField summary: Dynamic data field. name: DynamicField - fullName: sp-webpart-base.PropertyPaneFieldType.DynamicField + fullName: DynamicField langs: - typeScript type: field @@ -78,7 +78,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet summary: A set of dynamic fields. name: DynamicFieldSet - fullName: sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet + fullName: DynamicFieldSet langs: - typeScript type: field @@ -89,7 +89,7 @@ items: content: '- Please use DynamicField' isPreview: true name: DynamicTextField - fullName: sp-webpart-base.PropertyPaneFieldType.DynamicTextField + fullName: DynamicTextField langs: - typeScript type: field @@ -97,7 +97,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Heading summary: Heading field. name: Heading - fullName: sp-webpart-base.PropertyPaneFieldType.Heading + fullName: Heading langs: - typeScript type: field @@ -105,7 +105,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.HorizontalRule summary: Horizontal Rule field. name: HorizontalRule - fullName: sp-webpart-base.PropertyPaneFieldType.HorizontalRule + fullName: HorizontalRule langs: - typeScript type: field @@ -113,7 +113,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Label summary: Label field. name: Label - fullName: sp-webpart-base.PropertyPaneFieldType.Label + fullName: Label langs: - typeScript type: field @@ -121,7 +121,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Link summary: Link field. name: Link - fullName: sp-webpart-base.PropertyPaneFieldType.Link + fullName: Link langs: - typeScript type: field @@ -129,7 +129,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Slider summary: Slider field. name: Slider - fullName: sp-webpart-base.PropertyPaneFieldType.Slider + fullName: Slider langs: - typeScript type: field @@ -137,7 +137,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.TextField summary: TextField field. name: TextField - fullName: sp-webpart-base.PropertyPaneFieldType.TextField + fullName: TextField langs: - typeScript type: field @@ -145,7 +145,7 @@ items: - uid: sp-webpart-base.PropertyPaneFieldType.Toggle summary: Toggle field. name: Toggle - fullName: sp-webpart-base.PropertyPaneFieldType.Toggle + fullName: Toggle langs: - typeScript type: field diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 84987203..8aa06167 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -8,7 +8,7 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WebPartContext class. name: WebPartContext - fullName: sp-webpart-base.WebPartContext + fullName: WebPartContext langs: - typeScript type: class @@ -22,7 +22,7 @@ items: - uid: sp-webpart-base.WebPartContext.domElement summary: Reference to the DOM element that hosts this client-side component. name: domElement - fullName: sp-webpart-base.WebPartContext.domElement + fullName: domElement langs: - typeScript type: property @@ -40,7 +40,7 @@ items: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) isPreview: true name: microsoftTeams - fullName: sp-webpart-base.WebPartContext.microsoftTeams + fullName: microsoftTeams langs: - typeScript type: property @@ -52,7 +52,7 @@ items: - uid: sp-webpart-base.WebPartContext.statusRenderer summary: Web part status renderer. name: statusRenderer - fullName: sp-webpart-base.WebPartContext.statusRenderer + fullName: statusRenderer langs: - typeScript type: property diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index e008bc2e..60fc3323 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -8,7 +8,7 @@ items: parts, it will have a canvas web part form factor. isPreview: true name: WebPartFormFactor - fullName: sp-webpart-base.WebPartFormFactor + fullName: WebPartFormFactor langs: - typeScript type: enum @@ -21,7 +21,7 @@ items: remarks: This is the case for Teams tabs or single web part App pages. isPreview: true name: FullSize - fullName: sp-webpart-base.WebPartFormFactor.FullSize + fullName: FullSize langs: - typeScript type: field @@ -32,7 +32,7 @@ items: case, the width is determined by the container, and web part self-adjust for height. isPreview: true name: Standard - fullName: sp-webpart-base.WebPartFormFactor.Standard + fullName: Standard langs: - typeScript type: field From 30ad9b7bacda4a039dcea30b680b2b0607a5dca2 Mon Sep 17 00:00:00 2001 From: Vesa Juvonen Date: Tue, 20 Aug 2019 13:22:16 +0300 Subject: [PATCH 25/55] Refresh of the SPFx API documentation --- SP-Framework/decorators.yml | 25 +- SP-Framework/overview/sharepoint.md | 7 + .../applicationaccessor.yml | 10 +- .../applicationcustomizercontext.yml | 10 +- .../baseapplicationcustomizer.yml | 18 +- .../iplaceholdercreatecontentoptions.yml | 2 +- .../placeholdercontent.yml | 16 +- .../placeholderprovider.yml | 22 +- SP-Framework/sp-component-base.yml | 6 + .../sp-component-base/basecomponent.yml | 12 +- .../basecomponentcontext.yml | 49 +- .../sp-component-base/dynamicdataprovider.yml | 20 +- .../dynamicdatasourcemanager.yml | 14 +- .../sp-component-base/dynamicproperty.yml | 36 +- .../sp-component-base/ifontstyles.yml | 34 +- SP-Framework/sp-component-base/ipalette.yml | 62 +- SP-Framework/sp-component-base/irawstyle.yml | 45 + .../sp-component-base/ireadonlyfontstyles.yml | 12 - .../sp-component-base/ireadonlytheme.yml | 6 +- .../sp-component-base/isemanticcolors.yml | 466 +- .../sp-component-base/isemantictextcolors.yml | 391 + SP-Framework/sp-component-base/itheme.yml | 11 +- .../themechangedeventargs.yml | 4 +- .../sp-component-base/themeprovider.yml | 24 +- SP-Framework/sp-core-library/environment.yml | 2 +- SP-Framework/sp-core-library/guid.yml | 41 +- SP-Framework/sp-core-library/idisposable.yml | 2 +- .../irandomnumbergenerator.yml | 2 +- .../sp-core-library/iservicecollection.yml | 6 +- .../sp-core-library/ispeventobserver.yml | 2 +- .../sp-core-library/itimeprovider.yml | 4 +- SP-Framework/sp-core-library/log.yml | 16 +- .../sp-core-library/randomnumbergenerator.yml | 16 +- SP-Framework/sp-core-library/servicekey.yml | 12 +- SP-Framework/sp-core-library/servicescope.yml | 38 +- SP-Framework/sp-core-library/session.yml | 4 +- SP-Framework/sp-core-library/spevent.yml | 16 +- SP-Framework/sp-core-library/text.yml | 4 +- SP-Framework/sp-core-library/timeprovider.yml | 18 +- .../urlqueryparametercollection.yml | 24 +- SP-Framework/sp-core-library/validate.yml | 10 +- SP-Framework/sp-core-library/version.yml | 51 +- SP-Framework/sp-dialog.yml | 4 +- SP-Framework/sp-dialog/basedialog.yml | 25 +- SP-Framework/sp-dialog/dialog.yml | 8 +- SP-Framework/sp-dialog/ialertoptions.yml | 2 +- SP-Framework/sp-dialog/ipromptoptions.yml | 2 +- .../sp-dialog/isecondarydialogprovider.yml | 23 +- .../sp-dynamic-data/dynamicdatareference.yml | 10 +- .../idynamicdataannotatedpropertyvalue.yml | 2 +- .../sp-dynamic-data/idynamicdatacallables.yml | 10 +- .../idynamicdatapropertydefinition.yml | 2 +- .../idynamicdatapropertyvaluemetadata.yml | 4 +- ...micdatapropertyvaluemetadatacollection.yml | 23 +- .../sp-dynamic-data/idynamicdatasource.yml | 62 +- .../sp-extension-base/baseextension.yml | 8 +- .../sp-extension-base/extensioncontext.yml | 4 +- SP-Framework/sp-http.yml | 24 +- SP-Framework/sp-http/aadhttpclient.yml | 34 +- .../sp-http/aadhttpclientconfiguration.yml | 24 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 4 +- SP-Framework/sp-http/aadtokenprovider.yml | 20 +- .../sp-http/aadtokenproviderfactory.yml | 2 +- SP-Framework/sp-http/digestcache.yml | 22 +- SP-Framework/sp-http/graphrequest.yml | 180 +- SP-Framework/sp-http/httpclient.yml | 32 +- .../sp-http/httpclientconfiguration.yml | 24 +- SP-Framework/sp-http/httpclientresponse.yml | 21 +- .../sp-http/iaadhttpclientconfiguration.yml | 2 +- .../sp-http/iaadhttpclientconfigurations.yml | 2 +- .../sp-http/iaadhttpclientoptions.yml | 22 +- SP-Framework/sp-http/iaadtokenprovider.yml | 61 + .../iaadtokenproviderconfiguration.yml | 113 + SP-Framework/sp-http/idigestcache.yml | 8 +- .../sp-http/igraphhttpclientoptions.yml | 2 +- .../sp-http/ihttpclientconfigurations.yml | 2 +- SP-Framework/sp-http/ihttpclientoptions.yml | 2 +- .../isphttpclientbatchconfiguration.yml | 2 +- .../isphttpclientbatchconfigurations.yml | 2 +- .../sp-http/isphttpclientbatchoptions.yml | 2 +- .../isphttpclientcommonconfiguration.yml | 2 +- .../sp-http/isphttpclientconfiguration.yml | 4 +- .../sp-http/isphttpclientconfigurations.yml | 2 +- SP-Framework/sp-http/isphttpclientoptions.yml | 2 +- .../sp-http/itokenacquisitioneventargs.yml | 39 + SP-Framework/sp-http/msgraphclient.yml | 14 +- SP-Framework/sp-http/msgraphclientfactory.yml | 4 +- SP-Framework/sp-http/odataversion.yml | 20 +- SP-Framework/sp-http/sphttpclient.yml | 40 +- SP-Framework/sp-http/sphttpclientbatch.yml | 24 +- .../sphttpclientbatchconfiguration.yml | 27 +- .../sphttpclientcommonconfiguration.yml | 26 +- .../sp-http/sphttpclientconfiguration.yml | 28 +- SP-Framework/sp-http/sphttpclientresponse.yml | 16 +- .../sp-http/tokenacquisitioneventargs.yml | 12 +- .../basefieldcustomizer.yml | 12 +- .../baselistviewcommandset.yml | 22 +- .../columnaccessor.yml | 14 +- .../sp-listview-extensibility/command.yml | 2 +- .../fieldcustomizercontext.yml | 8 +- .../ifieldcustomizercelleventparameters.yml | 2 +- ...stviewcommandsetexecuteeventparameters.yml | 4 +- ...iewcommandsetlistviewupdatedparameters.yml | 2 +- .../listitemaccessor.yml | 16 +- .../listviewaccessor.yml | 6 +- .../listviewcommandsetcontext.yml | 6 +- .../sp-listview-extensibility/rowaccessor.yml | 10 +- .../selectedrowschangedeventargs.yml | 2 +- SP-Framework/sp-odata-types.yml | 3 + SP-Framework/sp-odata-types/_iodatauserid.yml | 39 + SP-Framework/sp-odata-types/iodatalist.yml | 2 +- .../sp-odata-types/iodatalistitem.yml | 5 +- .../sp-odata-types/iodatausercustomaction.yml | 2 +- SP-Framework/sp-odata-types/iodataweb.yml | 2 +- SP-Framework/sp-page-context/cultureinfo.yml | 2 +- .../sp-page-context/isptimezonedata.yml | 4 +- SP-Framework/sp-page-context/pagecontext.yml | 20 +- SP-Framework/sp-page-context/spfield.yml | 10 +- SP-Framework/sp-page-context/splist.yml | 6 +- SP-Framework/sp-page-context/splistitem.yml | 2 +- SP-Framework/sp-page-context/sppermission.yml | 94 +- SP-Framework/sp-page-context/spsite.yml | 6 +- SP-Framework/sp-page-context/sptimezone.yml | 11 +- SP-Framework/sp-page-context/spuser.yml | 2 +- SP-Framework/sp-page-context/spweb.yml | 6 +- SP-Framework/sp-webpart-base.yml | 154 +- .../sp-webpart-base/baseclientsidewebpart.yml | 26 +- SP-Framework/sp-webpart-base/basewebpart.yml | 46 +- .../sp-webpart-base/basewebpartcontext.yml | 8 +- .../dynamicdatashareddepth.yml | 4 + .../iclientsidewebpartstatusrenderer.yml | 8 +- ...dynamicdatasharedpropertyconfiguration.yml | 20 +- .../idynamicdatasharedpropertyfilters.yml | 31 +- .../idynamicdatasharedsourceconfiguration.yml | 36 +- .../idynamicdatasharedsourcefilters.yml | 61 +- .../sp-webpart-base/imicrosoftteams.yml | 37 + .../sp-webpart-base/ipropertypaneaccessor.yml | 10 +- .../ipropertypanebuttonprops.yml | 117 +- .../ipropertypanecheckboxprops.yml | 47 +- .../ipropertypanechoicegroupoption.yml | 118 +- ...propertypanechoicegroupoptioniconprops.yml | 20 +- .../ipropertypanechoicegroupprops.yml | 33 +- .../ipropertypaneconditionalgroup.yml | 72 +- .../ipropertypaneconfiguration.yml | 68 +- .../ipropertypanecustomfieldprops.yml | 75 +- .../ipropertypanedropdowncalloutprops.yml | 20 +- .../ipropertypanedropdownoption.yml | 59 +- .../ipropertypanedropdownprops.yml | 113 +- .../ipropertypanedynamicfieldfilters.yml | 16 + .../ipropertypanedynamicfieldprops.yml | 71 +- .../ipropertypanedynamicfieldsetprops.yml | 61 +- .../ipropertypanedynamictextfieldprops.yml | 185 +- .../sp-webpart-base/ipropertypanefield.yml | 61 +- .../sp-webpart-base/ipropertypanegroup.yml | 48 +- .../ipropertypanelabelprops.yml | 34 +- .../ipropertypanelinkprops.yml | 87 +- .../sp-webpart-base/ipropertypanepage.yml | 46 +- .../ipropertypanepageheader.yml | 33 +- .../ipropertypanesliderprops.yml | 115 +- .../ipropertypanetextfieldprops.yml | 281 +- .../ipropertypanetoggleprops.yml | 112 +- SP-Framework/sp-webpart-base/isdks.yml | 29 + .../iserializedserverprocesseddata.yml | 24 +- .../iserializedwebpartdata.yml | 16 +- .../sp-webpart-base/iwebpartcontext.yml | 50 +- SP-Framework/sp-webpart-base/iwebpartdata.yml | 14 +- .../iwebpartpropertiesmetadata.yml | 21 +- .../propertypanebuttontype.yml | 4 + .../propertypanedropdownoptiontype.yml | 6 +- .../sp-webpart-base/propertypanefieldtype.yml | 4 + .../sp-webpart-base/webpartcontext.yml | 20 +- SP-Framework/spfx-toc/toc.yml | 819 +- generate-docs/json/decorators.api.json | 401 +- generate-docs/json/recopy.bat | 26 +- .../json/sp-application-base.api.json | 1804 +- generate-docs/json/sp-component-base.api.json | 12448 ++++++++------ generate-docs/json/sp-core-library.api.json | 7813 +++++---- generate-docs/json/sp-diagnostics.api.json | 59 +- generate-docs/json/sp-dialog.api.json | 1970 +-- generate-docs/json/sp-dynamic-data.api.json | 2393 +-- generate-docs/json/sp-extension-base.api.json | 311 +- generate-docs/json/sp-http.api.json | 14080 +++++++++------- .../json/sp-listview-extensibility.api.json | 2758 +-- generate-docs/json/sp-odata-types.api.json | 4690 ++--- generate-docs/json/sp-page-context.api.json | 7587 +++++---- generate-docs/json/sp-webpart-base.api.json | 13763 +++++++-------- 186 files changed, 41461 insertions(+), 34930 deletions(-) create mode 100644 SP-Framework/sp-component-base/irawstyle.yml create mode 100644 SP-Framework/sp-component-base/isemantictextcolors.yml create mode 100644 SP-Framework/sp-http/iaadtokenprovider.yml create mode 100644 SP-Framework/sp-http/iaadtokenproviderconfiguration.yml create mode 100644 SP-Framework/sp-http/itokenacquisitioneventargs.yml create mode 100644 SP-Framework/sp-odata-types/_iodatauserid.yml create mode 100644 SP-Framework/sp-webpart-base/imicrosoftteams.yml create mode 100644 SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml create mode 100644 SP-Framework/sp-webpart-base/isdks.yml diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 0db6746d..66664fa8 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -18,16 +18,17 @@ items: - uid: decorators.override summary: >- This decorator is applied to a class's member function or property. It indicates that the definition overrides - another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. - This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. + another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at + runtime. name: 'override(target, propertyKey, descriptor)' - fullName: override + fullName: 'override(target, propertyKey, descriptor)' langs: - typeScript type: function syntax: content: >- - export function override(target: Object, propertyKey: string | symbol, descriptor: + export declare function override(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void; return: type: @@ -52,12 +53,12 @@ items: inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. name: sealed(target) - fullName: sealed + fullName: sealed(target) langs: - typeScript type: function syntax: - content: 'export function sealed(target: Function): void;' + content: 'export declare function sealed(target: Function): void;' return: type: - void @@ -70,18 +71,18 @@ items: - uid: decorators.virtual summary: >- This decorator is applied to a class's member function or property. It indicates that the definition may - optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a definition, - then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the - future, it may be enforced at runtime. + optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a + definition, then child classes may NOT override it. This decorator is currently used for documentation purposes + only. In the future, it may be enforced at runtime. name: 'virtual(target, propertyKey, descriptor)' - fullName: virtual + fullName: 'virtual(target, propertyKey, descriptor)' langs: - typeScript type: function syntax: content: >- - export function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): - void; + export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; return: type: - void diff --git a/SP-Framework/overview/sharepoint.md b/SP-Framework/overview/sharepoint.md index de10fce3..617f5738 100644 --- a/SP-Framework/overview/sharepoint.md +++ b/SP-Framework/overview/sharepoint.md @@ -1,3 +1,10 @@ +--- +title: SharePoint Framework TypeScript Reference +description: The SharePoint Framework object model is built in TypeScript. +ms.date: 08/20/2019 +ms.prod: sharepoint +--- + # SharePoint Framework Reference The SharePoint Framework object model is built in TypeScript. Use this section to learn more about the classes, methods, and other types available for building your SharePoint Framework solutions. diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index c65f51c3..aaa3bf93 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -21,16 +21,16 @@ items: type: class package: sp-application-base children: - - sp-application-base.ApplicationAccessor.constructor + - sp-application-base.ApplicationAccessor.(constructor) - sp-application-base.ApplicationAccessor.navigatedEvent - - uid: sp-application-base.ApplicationAccessor.constructor + - uid: sp-application-base.ApplicationAccessor.(constructor) summary: 'Constructs a new instance of the [ApplicationAccessor](xref:sp-application-base.ApplicationAccessor) class.' remarks: >- Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example [BaseApplicationCustomizer.context](xref:sp-application-base.BaseApplicationCustomizer.context). - name: constructor(serviceScope) - fullName: constructor + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -40,7 +40,7 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-application-base.ApplicationAccessor.navigatedEvent summary: An event that is fired when the application's top-level page context navigates to a new page. remarks: 'This event fires after the top-level [PageContext](xref:sp-page-context.PageContext) has navigated to a new page.' diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index c00a1daa..4892dd6a 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -4,14 +4,14 @@ items: summary: 'The component context for [BaseApplicationCustomizer](xref:sp-application-base.BaseApplicationCustomizer).' remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the ApplicationCustomizerContext class. + create subclasses that extend the `ApplicationCustomizerContext` class. name: ApplicationCustomizerContext fullName: ApplicationCustomizerContext langs: - typeScript type: class extends: - - ExtensionContext + - sp-extension-base.ExtensionContext package: sp-application-base children: - sp-application-base.ApplicationCustomizerContext.application @@ -28,10 +28,10 @@ items: content: 'readonly application: ApplicationAccessor;' return: type: - - ApplicationAccessor + - sp-application-base.ApplicationAccessor - uid: sp-application-base.ApplicationCustomizerContext.dispose name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -54,4 +54,4 @@ items: content: 'readonly placeholderProvider: PlaceholderProvider;' return: type: - - PlaceholderProvider + - sp-application-base.PlaceholderProvider diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index 3022f5e3..ea010bb2 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -17,18 +17,13 @@ items: - typeScript type: class extends: - - BaseExtension + - 'BaseExtension ' package: sp-application-base children: - sp-application-base.BaseApplicationCustomizer.context - sp-application-base.BaseApplicationCustomizer.dispose - sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged - uid: sp-application-base.BaseApplicationCustomizer.context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. name: context fullName: context langs: @@ -38,15 +33,14 @@ items: content: 'protected readonly context: ApplicationCustomizerContext;' return: type: - - ApplicationCustomizerContext + - sp-application-base.ApplicationCustomizerContext - uid: sp-application-base.BaseApplicationCustomizer.dispose summary: Disposes the component. remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends - for a web part or extension. To perform custom cleanup when your component is disposed, override the - [BaseComponent.onDispose](xref:sp-component-base.BaseComponent.onDispose) method. + for a web part or extension. To perform custom cleanup when your component is disposed, override the method. name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -61,7 +55,7 @@ items: This event method is called when the placeholders of the host application change, come into existence, or disappear. name: onPlaceholdersChanged(placeholderProvider) - fullName: onPlaceholdersChanged + fullName: onPlaceholdersChanged(placeholderProvider) langs: - typeScript type: method @@ -75,4 +69,4 @@ items: - id: placeholderProvider description: '' type: - - PlaceholderProvider + - sp-application-base.PlaceholderProvider diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index faa3a299..4d650869 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -3,7 +3,7 @@ items: - uid: sp-application-base.IPlaceholderCreateContentOptions summary: >- Options for the - [PlaceholderProvider.tryCreateContent](xref:sp-application-base.PlaceholderProvider.tryCreateContent) method. + [PlaceholderProvider.tryCreateContent()](xref:sp-application-base.PlaceholderProvider.tryCreateContent) method. name: IPlaceholderCreateContentOptions fullName: IPlaceholderCreateContentOptions langs: diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 3de7e03f..8f80c7fb 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -3,20 +3,20 @@ items: - uid: sp-application-base.PlaceholderContent summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the PlaceholderContent class. + This object is returned by + [PlaceholderProvider.tryCreateContent()](xref:sp-application-base.PlaceholderProvider.tryCreateContent). + It provides access to a Document Object Model (DOM) element where the owner can render its custom content. - This object is returned by - [PlaceholderProvider.tryCreateContent](xref:sp-application-base.PlaceholderProvider.tryCreateContent). It - provides access to a Document Object Model (DOM) element where the owner can render its custom content. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderContent` class. name: PlaceholderContent fullName: PlaceholderContent langs: - typeScript type: class implements: - - IDisposable + - sp-core-library.IDisposable package: sp-application-base children: - sp-application-base.PlaceholderContent.dispose @@ -32,7 +32,7 @@ items: [IPlaceholderCreateContentOptions.onDispose](xref:sp-application-base.IPlaceholderCreateContentOptions.onDispose) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -95,4 +95,4 @@ items: content: 'readonly name: PlaceholderName;' return: type: - - PlaceholderName + - sp-application-base.PlaceholderName diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 5388f5ff..f8139c55 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -5,10 +5,6 @@ items: Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the PlaceholderProvider class. - - Placeholders are designated regions on the page, identified by one of the predefined [PlaceholderName](xref:sp-application-base.PlaceholderName) constants. Different applications and pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, @@ -16,17 +12,21 @@ items: be available. - Use [PlaceholderProvider.tryCreateContent](xref:sp-application-base.PlaceholderProvider.tryCreateContent) to test - whether a placeholder is available and add content to it. Use the + Use [PlaceholderProvider.tryCreateContent()](xref:sp-application-base.PlaceholderProvider.tryCreateContent) to + test whether a placeholder is available and add content to it. Use the [PlaceholderProvider.changedEvent](xref:sp-application-base.PlaceholderProvider.changedEvent) event to discover when new placeholders appear. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderProvider` class. name: PlaceholderProvider fullName: PlaceholderProvider langs: - typeScript type: class implements: - - IDisposable + - sp-core-library.IDisposable package: sp-application-base children: - sp-application-base.PlaceholderProvider.changedEvent @@ -52,7 +52,7 @@ items: - SPEvent - uid: sp-application-base.PlaceholderProvider.dispose name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -94,7 +94,7 @@ items: expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. name: 'tryCreateContent(name, options)' - fullName: tryCreateContent + fullName: 'tryCreateContent(name, options)' langs: - typeScript type: method @@ -110,8 +110,8 @@ items: - id: name description: The requested placeholder type: - - PlaceholderName + - sp-application-base.PlaceholderName - id: options description: 'Additional options, for example to detect when the placeholder is disposed.' type: - - IPlaceholderCreateContentOptions + - sp-application-base.IPlaceholderCreateContentOptions diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index e32baa4c..3a2ff431 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -19,9 +19,11 @@ items: - sp-component-base.DynamicProperty - sp-component-base.IFontStyles - sp-component-base.IPalette + - sp-component-base.IRawStyle - sp-component-base.IReadonlyFontStyles - sp-component-base.IReadonlyTheme - sp-component-base.ISemanticColors + - sp-component-base.ISemanticTextColors - sp-component-base.ITheme - sp-component-base.ThemeChangedEventArgs - sp-component-base.ThemeProvider @@ -40,12 +42,16 @@ references: name: IFontStyles - uid: sp-component-base.IPalette name: IPalette + - uid: sp-component-base.IRawStyle + name: IRawStyle - uid: sp-component-base.IReadonlyFontStyles name: IReadonlyFontStyles - uid: sp-component-base.IReadonlyTheme name: IReadonlyTheme - uid: sp-component-base.ISemanticColors name: ISemanticColors + - uid: sp-component-base.ISemanticTextColors + name: ISemanticTextColors - uid: sp-component-base.ITheme name: ITheme - uid: sp-component-base.ThemeChangedEventArgs diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 38a9c7f0..7b530eaf 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -4,14 +4,14 @@ items: summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the BaseComponent class. + create subclasses that extend the `BaseComponent` class. name: BaseComponent fullName: BaseComponent langs: - typeScript type: class implements: - - ISPEventObserver + - sp-core-library.ISPEventObserver package: sp-component-base children: - sp-component-base.BaseComponent.componentId @@ -52,15 +52,15 @@ items: content: 'protected context: BaseComponentContext;' return: type: - - BaseComponentContext + - sp-component-base.BaseComponentContext - uid: sp-component-base.BaseComponent.dispose summary: Disposes the component. remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the - [BaseComponent.onDispose](xref:sp-component-base.BaseComponent.onDispose) method. + [BaseComponent.onDispose()](xref:sp-component-base.BaseComponent.onDispose) method. name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -116,7 +116,7 @@ items: This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. name: onDispose() - fullName: onDispose + fullName: onDispose() langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 6e994242..89d9f981 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -3,20 +3,20 @@ items: - uid: sp-component-base.BaseComponentContext summary: The base class for context objects for client-side components. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the BaseComponentContext class. - - A "context" object is a collection of well-known services and other objects that are likely to be needed by business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponentContext` class. name: BaseComponentContext fullName: BaseComponentContext langs: - typeScript type: class implements: - - IDisposable + - sp-core-library.IDisposable package: sp-component-base children: - sp-component-base.BaseComponentContext.aadHttpClientFactory @@ -24,7 +24,6 @@ items: - sp-component-base.BaseComponentContext.dispose - sp-component-base.BaseComponentContext.dynamicDataProvider - sp-component-base.BaseComponentContext.dynamicDataSourceManager - - sp-component-base.BaseComponentContext.graphHttpClient - sp-component-base.BaseComponentContext.httpClient - sp-component-base.BaseComponentContext.instanceId - sp-component-base.BaseComponentContext.isDisposed @@ -44,7 +43,7 @@ items: content: 'readonly aadHttpClientFactory: AadHttpClientFactory;' return: type: - - AadHttpClientFactory + - sp-http.AadHttpClientFactory - uid: sp-component-base.BaseComponentContext.aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component name: aadTokenProviderFactory @@ -56,11 +55,11 @@ items: content: 'readonly aadTokenProviderFactory: AadTokenProviderFactory;' return: type: - - AadTokenProviderFactory + - sp-http.AadTokenProviderFactory - uid: sp-component-base.BaseComponentContext.dispose summary: Disposes the base component context. name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -81,7 +80,7 @@ items: content: 'readonly dynamicDataProvider: DynamicDataProvider;' return: type: - - DynamicDataProvider + - sp-component-base.DynamicDataProvider - uid: sp-component-base.BaseComponentContext.dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. name: dynamicDataSourceManager @@ -93,25 +92,7 @@ items: content: 'readonly dynamicDataSourceManager: DynamicDataSourceManager;' return: type: - - DynamicDataSourceManager - - uid: sp-component-base.BaseComponentContext.graphHttpClient - summary: The instance of GraphHttpClient created for this instance of component - deprecated: - content: >- - Use - [BaseComponentContext.msGraphClientFactory](xref:sp-component-base.BaseComponentContext.msGraphClientFactory) - instead - isPreview: true - name: graphHttpClient - fullName: graphHttpClient - langs: - - typeScript - type: property - syntax: - content: 'readonly graphHttpClient: GraphHttpClient;' - return: - type: - - GraphHttpClient + - sp-component-base.DynamicDataSourceManager - uid: sp-component-base.BaseComponentContext.httpClient summary: The instance of HttpClient created for this instance of component name: httpClient @@ -123,7 +104,7 @@ items: content: 'readonly httpClient: HttpClient;' return: type: - - HttpClient + - sp-http.HttpClient - uid: sp-component-base.BaseComponentContext.instanceId summary: A unique identifier for the instance of the component. remarks: >- @@ -175,7 +156,7 @@ items: content: 'readonly msGraphClientFactory: MSGraphClientFactory;' return: type: - - MSGraphClientFactory + - sp-http.MSGraphClientFactory - uid: sp-component-base.BaseComponentContext.pageContext summary: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the @@ -189,7 +170,7 @@ items: content: 'readonly pageContext: PageContext;' return: type: - - PageContext + - sp-page-context.PageContext - uid: sp-component-base.BaseComponentContext.serviceScope summary: 'The associated [ServiceScope](xref:sp-core-library.ServiceScope) for this component.' remarks: A child service scope is created for each client-side component. @@ -202,7 +183,7 @@ items: content: 'readonly serviceScope: ServiceScope;' return: type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-component-base.BaseComponentContext.spHttpClient summary: The instance of SpHttpClient created for this instance of component name: spHttpClient @@ -214,4 +195,4 @@ items: content: 'readonly spHttpClient: SPHttpClient;' return: type: - - SPHttpClient + - sp-http.SPHttpClient diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 36af8045..a0aa4ead 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -10,7 +10,7 @@ items: - typeScript type: class implements: - - IDisposable + - sp-core-library.IDisposable package: sp-component-base children: - sp-component-base.DynamicDataProvider.dispose @@ -26,7 +26,7 @@ items: - uid: sp-component-base.DynamicDataProvider.dispose summary: Disposes the Dynamic Data Provider. name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -39,7 +39,7 @@ items: - uid: sp-component-base.DynamicDataProvider.getAvailableSources summary: Returns a list with all available Dynamic Data Sources. name: getAvailableSources() - fullName: getAvailableSources + fullName: getAvailableSources() langs: - typeScript type: method @@ -64,7 +64,7 @@ items: - uid: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. name: registerAvailableSourcesChanged(callback) - fullName: registerAvailableSourcesChanged + fullName: registerAvailableSourcesChanged(callback) langs: - typeScript type: method @@ -82,7 +82,7 @@ items: - uid: sp-component-base.DynamicDataProvider.registerPropertyChanged summary: Registers a callback for updates when a property is changed in a Dynamic Data source. name: 'registerPropertyChanged(sourceId, propertyId, callback)' - fullName: registerPropertyChanged + fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' langs: - typeScript type: method @@ -110,7 +110,7 @@ items: Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. name: 'registerSourceChanged(sourceId, callback)' - fullName: registerSourceChanged + fullName: 'registerSourceChanged(sourceId, callback)' langs: - typeScript type: method @@ -132,7 +132,7 @@ items: - uid: sp-component-base.DynamicDataProvider.tryGetSource summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' name: tryGetSource(id) - fullName: tryGetSource + fullName: tryGetSource(id) langs: - typeScript type: method @@ -150,7 +150,7 @@ items: - uid: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. name: unregisterAvailableSourcesChanged(callback) - fullName: unregisterAvailableSourcesChanged + fullName: unregisterAvailableSourcesChanged(callback) langs: - typeScript type: method @@ -168,7 +168,7 @@ items: - uid: sp-component-base.DynamicDataProvider.unregisterPropertyChanged summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - fullName: unregisterPropertyChanged + fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' langs: - typeScript type: method @@ -194,7 +194,7 @@ items: - uid: sp-component-base.DynamicDataProvider.unregisterSourceChanged summary: Unregisters a callback for updates when a Dynamic Data source is changed. name: 'unregisterSourceChanged(sourceId, callback)' - fullName: unregisterSourceChanged + fullName: 'unregisterSourceChanged(sourceId, callback)' langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 6a0c87cf..d223202f 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -11,7 +11,7 @@ items: - typeScript type: class implements: - - IDisposable + - sp-core-library.IDisposable package: sp-component-base children: - sp-component-base.DynamicDataSourceManager.dispose @@ -24,7 +24,7 @@ items: - uid: sp-component-base.DynamicDataSourceManager.dispose summary: Disposes the resources held by the Dynamic Data source. name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -37,7 +37,7 @@ items: - uid: sp-component-base.DynamicDataSourceManager.initializeSource summary: Initializes the Dynamic Data Source for the component. name: initializeSource(callableFunctions) - fullName: initializeSource + fullName: initializeSource(callableFunctions) langs: - typeScript type: method @@ -51,7 +51,7 @@ items: - id: callableFunctions description: Set of methods that are exposed through the Dynamic Data Source type: - - IDynamicDataCallables + - sp-dynamic-data.IDynamicDataCallables - uid: sp-component-base.DynamicDataSourceManager.isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. name: isDisposed @@ -72,7 +72,7 @@ items: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. name: notifyPropertyChanged(propertyId) - fullName: notifyPropertyChanged + fullName: notifyPropertyChanged(propertyId) langs: - typeScript type: method @@ -95,7 +95,7 @@ items: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. name: notifySourceChanged() - fullName: notifySourceChanged + fullName: notifySourceChanged() langs: - typeScript type: method @@ -122,7 +122,7 @@ items: Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. name: updateMetadata(metadata) - fullName: updateMetadata + fullName: updateMetadata(metadata) langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 759c2ce5..43ea4755 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -12,10 +12,10 @@ items: - typeScript type: class implements: - - IDisposable + - sp-core-library.IDisposable package: sp-component-base children: - - sp-component-base.DynamicProperty.constructor + - sp-component-base.DynamicProperty.(constructor) - sp-component-base.DynamicProperty.dispose - sp-component-base.DynamicProperty.hasDefaultCallback - sp-component-base.DynamicProperty.isDisposed @@ -28,10 +28,10 @@ items: - sp-component-base.DynamicProperty.tryGetValue - sp-component-base.DynamicProperty.tryGetValues - sp-component-base.DynamicProperty.unregister - - uid: sp-component-base.DynamicProperty.constructor + - uid: sp-component-base.DynamicProperty.(constructor) summary: Create a new DynamicProperty object. - name: 'constructor(provider, callback)' - fullName: constructor + name: '(constructor)(provider, callback)' + fullName: '(constructor)(provider, callback)' langs: - typeScript type: constructor @@ -41,7 +41,7 @@ items: - id: provider description: DynamicDataProvider. type: - - DynamicDataProvider + - sp-component-base.DynamicDataProvider - id: callback description: Optional. Default callback to be registered for updates in the DynamicDataSource. type: @@ -50,7 +50,7 @@ items: summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method @@ -63,7 +63,7 @@ items: - uid: sp-component-base.DynamicProperty.hasDefaultCallback summary: Returns true if the object has a default callback. name: hasDefaultCallback() - fullName: hasDefaultCallback + fullName: hasDefaultCallback() langs: - typeScript type: method @@ -106,7 +106,7 @@ items: - uid: sp-component-base.DynamicProperty.register summary: Registers a callback function for updates on the associated DynamicDataSource. name: register(callback) - fullName: register + fullName: register(callback) langs: - typeScript type: method @@ -125,7 +125,7 @@ items: summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. name: removeDefaultCallback() - fullName: removeDefaultCallback + fullName: removeDefaultCallback() langs: - typeScript type: method @@ -140,7 +140,7 @@ items: Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. name: setReference(reference) - fullName: setReference + fullName: setReference(reference) langs: - typeScript type: method @@ -158,7 +158,7 @@ items: - uid: sp-component-base.DynamicProperty.setValue summary: Sets a static value in the DynamicProperty. name: setValue(value) - fullName: setValue + fullName: setValue(value) langs: - typeScript type: method @@ -178,7 +178,7 @@ items: Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. name: tryGetSource() - fullName: tryGetSource + fullName: tryGetSource() langs: - typeScript type: method @@ -196,9 +196,9 @@ items: NOTE: This api will never return an array. To retrieve an array value, use the - [DynamicProperty.tryGetValues](xref:sp-component-base.DynamicProperty.tryGetValues) API. + [DynamicProperty.tryGetValues()](xref:sp-component-base.DynamicProperty.tryGetValues) API. name: tryGetValue() - fullName: tryGetValue + fullName: tryGetValue() langs: - typeScript type: method @@ -216,9 +216,9 @@ items: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array - value, use the [DynamicProperty.tryGetValue](xref:sp-component-base.DynamicProperty.tryGetValue) API. + value, use the [DynamicProperty.tryGetValue()](xref:sp-component-base.DynamicProperty.tryGetValue) API. name: tryGetValues() - fullName: tryGetValues + fullName: tryGetValues() langs: - typeScript type: method @@ -233,7 +233,7 @@ items: Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. name: unregister(callback) - fullName: unregister + fullName: unregister(callback) langs: - typeScript type: method diff --git a/SP-Framework/sp-component-base/ifontstyles.yml b/SP-Framework/sp-component-base/ifontstyles.yml index 43cce5d6..488c47e4 100644 --- a/SP-Framework/sp-component-base/ifontstyles.yml +++ b/SP-Framework/sp-component-base/ifontstyles.yml @@ -2,7 +2,6 @@ items: - uid: sp-component-base.IFontStyles summary: Font styles for different sizes. - isPreview: true name: IFontStyles fullName: IFontStyles langs: @@ -23,7 +22,6 @@ items: - sp-component-base.IFontStyles.xxLarge - uid: sp-component-base.IFontStyles.large summary: Large font style. - isPreview: true name: large fullName: large langs: @@ -33,10 +31,9 @@ items: content: 'large: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.medium summary: Medium font style. - isPreview: true name: medium fullName: medium langs: @@ -46,10 +43,9 @@ items: content: 'medium: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.mediumPlus summary: Larger than medium but smaller than large font style. - isPreview: true name: mediumPlus fullName: mediumPlus langs: @@ -59,10 +55,9 @@ items: content: 'mediumPlus: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.mega summary: Mega sized font style. - isPreview: true name: mega fullName: mega langs: @@ -72,10 +67,9 @@ items: content: 'mega: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.small summary: Small font style. - isPreview: true name: small fullName: small langs: @@ -85,10 +79,9 @@ items: content: 'small: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.smallPlus summary: Larger than small but smaller than medium font style. - isPreview: true name: smallPlus fullName: smallPlus langs: @@ -98,10 +91,9 @@ items: content: 'smallPlus: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.superLarge summary: Super large font style. - isPreview: true name: superLarge fullName: superLarge langs: @@ -111,10 +103,9 @@ items: content: 'superLarge: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.tiny summary: Tiny font style. - isPreview: true name: tiny fullName: tiny langs: @@ -124,10 +115,9 @@ items: content: 'tiny: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.xLarge summary: Extra large font style. - isPreview: true name: xLarge fullName: xLarge langs: @@ -137,10 +127,9 @@ items: content: 'xLarge: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.xSmall summary: Extra small font style. - isPreview: true name: xSmall fullName: xSmall langs: @@ -150,10 +139,9 @@ items: content: 'xSmall: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle - uid: sp-component-base.IFontStyles.xxLarge summary: Extra extra large font style. - isPreview: true name: xxLarge fullName: xxLarge langs: @@ -163,4 +151,4 @@ items: content: 'xxLarge: IRawStyle;' return: type: - - IRawStyle + - sp-component-base.IRawStyle diff --git a/SP-Framework/sp-component-base/ipalette.yml b/SP-Framework/sp-component-base/ipalette.yml index 556914e8..ee5482b1 100644 --- a/SP-Framework/sp-component-base/ipalette.yml +++ b/SP-Framework/sp-component-base/ipalette.yml @@ -2,7 +2,6 @@ items: - uid: sp-component-base.IPalette summary: Color palette. - isPreview: true name: IPalette fullName: IPalette langs: @@ -32,6 +31,7 @@ items: - sp-component-base.IPalette.neutralQuaternary - sp-component-base.IPalette.neutralQuaternaryAlt - sp-component-base.IPalette.neutralSecondary + - sp-component-base.IPalette.neutralSecondaryAlt - sp-component-base.IPalette.neutralTertiary - sp-component-base.IPalette.neutralTertiaryAlt - sp-component-base.IPalette.orange @@ -60,7 +60,6 @@ items: - sp-component-base.IPalette.yellowLight - uid: sp-component-base.IPalette.accent summary: Color code for the accent. - isPreview: true name: accent fullName: accent langs: @@ -75,7 +74,6 @@ items: summary: >- Color code for the strongest color, which is black in the default theme. This is a very light color in inverted themes. - isPreview: true name: black fullName: black langs: @@ -88,7 +86,6 @@ items: - string - uid: sp-component-base.IPalette.blackTranslucent40 summary: Color code for blackTranslucent40. - isPreview: true name: blackTranslucent40 fullName: blackTranslucent40 langs: @@ -101,7 +98,6 @@ items: - string - uid: sp-component-base.IPalette.blue summary: Color code for blue. - isPreview: true name: blue fullName: blue langs: @@ -114,7 +110,6 @@ items: - string - uid: sp-component-base.IPalette.blueDark summary: Color code for blueDark. - isPreview: true name: blueDark fullName: blueDark langs: @@ -127,7 +122,6 @@ items: - string - uid: sp-component-base.IPalette.blueLight summary: Color code for blueLight. - isPreview: true name: blueLight fullName: blueLight langs: @@ -140,7 +134,6 @@ items: - string - uid: sp-component-base.IPalette.blueMid summary: Color code for blueMid. - isPreview: true name: blueMid fullName: blueMid langs: @@ -153,7 +146,6 @@ items: - string - uid: sp-component-base.IPalette.green summary: Color code for green. - isPreview: true name: green fullName: green langs: @@ -166,7 +158,6 @@ items: - string - uid: sp-component-base.IPalette.greenDark summary: Color code for greenDark. - isPreview: true name: greenDark fullName: greenDark langs: @@ -179,7 +170,6 @@ items: - string - uid: sp-component-base.IPalette.greenLight summary: Color code for greenLight. - isPreview: true name: greenLight fullName: greenLight langs: @@ -192,7 +182,6 @@ items: - string - uid: sp-component-base.IPalette.magenta summary: Color code for magenta. - isPreview: true name: magenta fullName: magenta langs: @@ -205,7 +194,6 @@ items: - string - uid: sp-component-base.IPalette.magentaDark summary: Color code for magentaDark. - isPreview: true name: magentaDark fullName: magentaDark langs: @@ -218,7 +206,6 @@ items: - string - uid: sp-component-base.IPalette.magentaLight summary: Color code for magentaLight. - isPreview: true name: magentaLight fullName: magentaLight langs: @@ -231,7 +218,6 @@ items: - string - uid: sp-component-base.IPalette.neutralDark summary: Color code for neutralDark. - isPreview: true name: neutralDark fullName: neutralDark langs: @@ -244,7 +230,6 @@ items: - string - uid: sp-component-base.IPalette.neutralLight summary: Color code for neutralLight. - isPreview: true name: neutralLight fullName: neutralLight langs: @@ -257,7 +242,6 @@ items: - string - uid: sp-component-base.IPalette.neutralLighter summary: Color code for neutralLighter. - isPreview: true name: neutralLighter fullName: neutralLighter langs: @@ -270,7 +254,6 @@ items: - string - uid: sp-component-base.IPalette.neutralLighterAlt summary: Color code for neutralLighterAlt. - isPreview: true name: neutralLighterAlt fullName: neutralLighterAlt langs: @@ -283,7 +266,6 @@ items: - string - uid: sp-component-base.IPalette.neutralPrimary summary: Color code for neutralPrimary. - isPreview: true name: neutralPrimary fullName: neutralPrimary langs: @@ -296,7 +278,6 @@ items: - string - uid: sp-component-base.IPalette.neutralPrimaryAlt summary: Color code for neutralPrimaryAlt. - isPreview: true name: neutralPrimaryAlt fullName: neutralPrimaryAlt langs: @@ -309,7 +290,6 @@ items: - string - uid: sp-component-base.IPalette.neutralQuaternary summary: Color code for neutralQuaternary. - isPreview: true name: neutralQuaternary fullName: neutralQuaternary langs: @@ -322,7 +302,6 @@ items: - string - uid: sp-component-base.IPalette.neutralQuaternaryAlt summary: Color code for neutralQuaternaryAlt. - isPreview: true name: neutralQuaternaryAlt fullName: neutralQuaternaryAlt langs: @@ -335,7 +314,6 @@ items: - string - uid: sp-component-base.IPalette.neutralSecondary summary: Color code for neutralSecondary. - isPreview: true name: neutralSecondary fullName: neutralSecondary langs: @@ -346,9 +324,20 @@ items: return: type: - string + - uid: sp-component-base.IPalette.neutralSecondaryAlt + summary: Color code for neutralSecondaryAlt. + name: neutralSecondaryAlt + fullName: neutralSecondaryAlt + langs: + - typeScript + type: property + syntax: + content: 'neutralSecondaryAlt: string;' + return: + type: + - string - uid: sp-component-base.IPalette.neutralTertiary summary: Color code for neutralTertiary. - isPreview: true name: neutralTertiary fullName: neutralTertiary langs: @@ -361,7 +350,6 @@ items: - string - uid: sp-component-base.IPalette.neutralTertiaryAlt summary: Color code for neutralTertiaryAlt. - isPreview: true name: neutralTertiaryAlt fullName: neutralTertiaryAlt langs: @@ -374,7 +362,6 @@ items: - string - uid: sp-component-base.IPalette.orange summary: Color code for orange. - isPreview: true name: orange fullName: orange langs: @@ -387,7 +374,6 @@ items: - string - uid: sp-component-base.IPalette.orangeLight summary: Color code for orangeLight. - isPreview: true name: orangeLight fullName: orangeLight langs: @@ -400,7 +386,6 @@ items: - string - uid: sp-component-base.IPalette.orangeLighter summary: Color code for orangeLighter. - isPreview: true name: orangeLighter fullName: orangeLighter langs: @@ -413,7 +398,6 @@ items: - string - uid: sp-component-base.IPalette.purple summary: Color code for purple. - isPreview: true name: purple fullName: purple langs: @@ -426,7 +410,6 @@ items: - string - uid: sp-component-base.IPalette.purpleDark summary: Color code for purpleDark. - isPreview: true name: purpleDark fullName: purpleDark langs: @@ -439,7 +422,6 @@ items: - string - uid: sp-component-base.IPalette.purpleLight summary: Color code for purpleLight. - isPreview: true name: purpleLight fullName: purpleLight langs: @@ -452,7 +434,6 @@ items: - string - uid: sp-component-base.IPalette.red summary: Color code for red. - isPreview: true name: red fullName: red langs: @@ -465,7 +446,6 @@ items: - string - uid: sp-component-base.IPalette.redDark summary: Color code for redDark. - isPreview: true name: redDark fullName: redDark langs: @@ -478,7 +458,6 @@ items: - string - uid: sp-component-base.IPalette.teal summary: Color code for teal. - isPreview: true name: teal fullName: teal langs: @@ -491,7 +470,6 @@ items: - string - uid: sp-component-base.IPalette.tealDark summary: Color code for tealDark. - isPreview: true name: tealDark fullName: tealDark langs: @@ -504,7 +482,6 @@ items: - string - uid: sp-component-base.IPalette.tealLight summary: Color code for tealLight. - isPreview: true name: tealLight fullName: tealLight langs: @@ -517,7 +494,6 @@ items: - string - uid: sp-component-base.IPalette.themeDark summary: Color code for themeDark. - isPreview: true name: themeDark fullName: themeDark langs: @@ -530,7 +506,6 @@ items: - string - uid: sp-component-base.IPalette.themeDarkAlt summary: Color code for themeDarkAlt. - isPreview: true name: themeDarkAlt fullName: themeDarkAlt langs: @@ -543,7 +518,6 @@ items: - string - uid: sp-component-base.IPalette.themeDarker summary: Color code for themeDarker. - isPreview: true name: themeDarker fullName: themeDarker langs: @@ -556,7 +530,6 @@ items: - string - uid: sp-component-base.IPalette.themeLight summary: Color code for themeLight. - isPreview: true name: themeLight fullName: themeLight langs: @@ -569,7 +542,6 @@ items: - string - uid: sp-component-base.IPalette.themeLighter summary: Color code for themeLighter. - isPreview: true name: themeLighter fullName: themeLighter langs: @@ -582,7 +554,6 @@ items: - string - uid: sp-component-base.IPalette.themeLighterAlt summary: Color code for themeLighterAlt. - isPreview: true name: themeLighterAlt fullName: themeLighterAlt langs: @@ -595,7 +566,6 @@ items: - string - uid: sp-component-base.IPalette.themePrimary summary: Color code for themePrimary. - isPreview: true name: themePrimary fullName: themePrimary langs: @@ -608,7 +578,6 @@ items: - string - uid: sp-component-base.IPalette.themeSecondary summary: Color code for themeSecondary. - isPreview: true name: themeSecondary fullName: themeSecondary langs: @@ -621,7 +590,6 @@ items: - string - uid: sp-component-base.IPalette.themeTertiary summary: Color code for themeTertiary. - isPreview: true name: themeTertiary fullName: themeTertiary langs: @@ -636,7 +604,6 @@ items: summary: >- Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. This is the page background. - isPreview: true name: white fullName: white langs: @@ -649,7 +616,6 @@ items: - string - uid: sp-component-base.IPalette.whiteTranslucent40 summary: Color code for whiteTranslucent40 - isPreview: true name: whiteTranslucent40 fullName: whiteTranslucent40 langs: @@ -662,7 +628,6 @@ items: - string - uid: sp-component-base.IPalette.yellow summary: Color code for yellow. - isPreview: true name: yellow fullName: yellow langs: @@ -675,7 +640,6 @@ items: - string - uid: sp-component-base.IPalette.yellowLight summary: Color code for yellowLight. - isPreview: true name: yellowLight fullName: yellowLight langs: diff --git a/SP-Framework/sp-component-base/irawstyle.yml b/SP-Framework/sp-component-base/irawstyle.yml new file mode 100644 index 00000000..04ba0153 --- /dev/null +++ b/SP-Framework/sp-component-base/irawstyle.yml @@ -0,0 +1,45 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.IRawStyle + summary: 'IStyleObject extends a raw style objects, but allows selectors to be defined under the selectors node.' + name: IRawStyle + fullName: IRawStyle + langs: + - typeScript + type: interface + extends: + - 'IRawStyleBase ' + package: sp-component-base + children: + - sp-component-base.IRawStyle.displayName + - sp-component-base.IRawStyle.selectors + - uid: sp-component-base.IRawStyle.displayName + summary: Display name for the style. + name: displayName + fullName: displayName + langs: + - typeScript + type: property + syntax: + content: 'displayName?: string;' + return: + type: + - string + - uid: sp-component-base.IRawStyle.selectors + summary: Custom selectors for the style. + name: selectors + fullName: selectors + langs: + - typeScript + type: property + syntax: + content: |- + selectors?: { + [key: string]: IStyle; + }; + return: + type: + - |- + { + [key: string]: IStyle; + } diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 783120ea..c8e61d5e 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -2,7 +2,6 @@ items: - uid: sp-component-base.IReadonlyFontStyles summary: Font styles for different sizes. - isPreview: true name: IReadonlyFontStyles fullName: IReadonlyFontStyles langs: @@ -23,7 +22,6 @@ items: - sp-component-base.IReadonlyFontStyles.xxLarge - uid: sp-component-base.IReadonlyFontStyles.large summary: Large font style. - isPreview: true name: large fullName: large langs: @@ -36,7 +34,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.medium summary: Medium font style. - isPreview: true name: medium fullName: medium langs: @@ -49,7 +46,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.mediumPlus summary: Larger than medium but smaller than large font style. - isPreview: true name: mediumPlus fullName: mediumPlus langs: @@ -62,7 +58,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.mega summary: Mega sized font style. - isPreview: true name: mega fullName: mega langs: @@ -75,7 +70,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.small summary: Small font style. - isPreview: true name: small fullName: small langs: @@ -88,7 +82,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.smallPlus summary: Larger than small but smaller than medium font style. - isPreview: true name: smallPlus fullName: smallPlus langs: @@ -101,7 +94,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.superLarge summary: Super large font style. - isPreview: true name: superLarge fullName: superLarge langs: @@ -114,7 +106,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.tiny summary: Tiny font style. - isPreview: true name: tiny fullName: tiny langs: @@ -127,7 +118,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.xLarge summary: Extra large font style. - isPreview: true name: xLarge fullName: xLarge langs: @@ -140,7 +130,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.xSmall summary: Extra small font style. - isPreview: true name: xSmall fullName: xSmall langs: @@ -153,7 +142,6 @@ items: - IReadonlyRawStyle - uid: sp-component-base.IReadonlyFontStyles.xxLarge summary: Extra extra large font style. - isPreview: true name: xxLarge fullName: xxLarge langs: diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 4cb4deb7..7bb4b2e5 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -2,14 +2,13 @@ items: - uid: sp-component-base.IReadonlyTheme summary: Immutable ITheme. - isPreview: true name: IReadonlyTheme fullName: IReadonlyTheme langs: - typeScript type: interface extends: - - Readonly + - 'Readonly ' package: sp-component-base children: - sp-component-base.IReadonlyTheme.fonts @@ -17,7 +16,6 @@ items: - sp-component-base.IReadonlyTheme.semanticColors - uid: sp-component-base.IReadonlyTheme.fonts summary: Font styles for different sizes. - isPreview: true name: fonts fullName: fonts langs: @@ -30,7 +28,6 @@ items: - Readonly - uid: sp-component-base.IReadonlyTheme.palette summary: Color palette. - isPreview: true name: palette fullName: palette langs: @@ -43,7 +40,6 @@ items: - Readonly - uid: sp-component-base.IReadonlyTheme.semanticColors summary: The collection of all semantic slots for colors used in themes. - isPreview: true name: semanticColors fullName: semanticColors langs: diff --git a/SP-Framework/sp-component-base/isemanticcolors.yml b/SP-Framework/sp-component-base/isemanticcolors.yml index b233384a..19704dee 100644 --- a/SP-Framework/sp-component-base/isemanticcolors.yml +++ b/SP-Framework/sp-component-base/isemanticcolors.yml @@ -2,7 +2,10 @@ items: - uid: sp-component-base.ISemanticColors summary: >- - The collection of semantic slots for colors used in themes. + The collection of all semantic slots for colors used in themes. + + + Note: text colors are defined in ISemanticTextColors.ts. \#\# Naming Convention @@ -63,44 +66,33 @@ items: Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a large and complex interaction surface. This category covers all kinds of lists, whether they're typical one-item-per-row lists (like DetailsList) or ones with a tiled layout. - isPreview: true name: ISemanticColors fullName: ISemanticColors langs: - typeScript type: interface + extends: + - sp-component-base.ISemanticTextColors package: sp-component-base children: - - sp-component-base.ISemanticColors.actionLink - - sp-component-base.ISemanticColors.actionLinkHovered + - sp-component-base.ISemanticColors.accentButtonBackground - sp-component-base.ISemanticColors.blockingBackground - sp-component-base.ISemanticColors.bodyBackground - sp-component-base.ISemanticColors.bodyDivider - sp-component-base.ISemanticColors.bodyFrameBackground - sp-component-base.ISemanticColors.bodyFrameDivider - sp-component-base.ISemanticColors.bodyStandoutBackground - - sp-component-base.ISemanticColors.bodySubtext - - sp-component-base.ISemanticColors.bodyText - - sp-component-base.ISemanticColors.bodyTextChecked - sp-component-base.ISemanticColors.buttonBackground - sp-component-base.ISemanticColors.buttonBackgroundChecked - sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered + - sp-component-base.ISemanticColors.buttonBackgroundDisabled - sp-component-base.ISemanticColors.buttonBackgroundHovered - sp-component-base.ISemanticColors.buttonBackgroundPressed - sp-component-base.ISemanticColors.buttonBorder - sp-component-base.ISemanticColors.buttonBorderDisabled - - sp-component-base.ISemanticColors.buttonText - - sp-component-base.ISemanticColors.buttonTextChecked - - sp-component-base.ISemanticColors.buttonTextCheckedHovered - - sp-component-base.ISemanticColors.buttonTextDisabled - - sp-component-base.ISemanticColors.buttonTextHovered - - sp-component-base.ISemanticColors.buttonTextPressed + - sp-component-base.ISemanticColors.defaultStateBackground - sp-component-base.ISemanticColors.disabledBackground - - sp-component-base.ISemanticColors.disabledBodyText - - sp-component-base.ISemanticColors.disabledSubtext - - sp-component-base.ISemanticColors.disabledText - sp-component-base.ISemanticColors.errorBackground - - sp-component-base.ISemanticColors.errorText - sp-component-base.ISemanticColors.focusBorder - sp-component-base.ISemanticColors.inputBackground - sp-component-base.ISemanticColors.inputBackgroundChecked @@ -109,9 +101,6 @@ items: - sp-component-base.ISemanticColors.inputBorderHovered - sp-component-base.ISemanticColors.inputFocusBorderAlt - sp-component-base.ISemanticColors.inputForegroundChecked - - sp-component-base.ISemanticColors.inputPlaceholderText - - sp-component-base.ISemanticColors.link - - sp-component-base.ISemanticColors.linkHovered - sp-component-base.ISemanticColors.listBackground - sp-component-base.ISemanticColors.listHeaderBackgroundHovered - sp-component-base.ISemanticColors.listHeaderBackgroundPressed @@ -119,53 +108,40 @@ items: - sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered - sp-component-base.ISemanticColors.listItemBackgroundHovered - sp-component-base.ISemanticColors.listText - - sp-component-base.ISemanticColors.listTextColor + - sp-component-base.ISemanticColors.menuBackground + - sp-component-base.ISemanticColors.menuDivider - sp-component-base.ISemanticColors.menuHeader - sp-component-base.ISemanticColors.menuIcon - sp-component-base.ISemanticColors.menuItemBackgroundChecked - sp-component-base.ISemanticColors.menuItemBackgroundHovered + - sp-component-base.ISemanticColors.menuItemBackgroundPressed + - sp-component-base.ISemanticColors.menuItemText + - sp-component-base.ISemanticColors.menuItemTextHovered - sp-component-base.ISemanticColors.primaryButtonBackground + - sp-component-base.ISemanticColors.primaryButtonBackgroundDisabled - sp-component-base.ISemanticColors.primaryButtonBackgroundHovered - sp-component-base.ISemanticColors.primaryButtonBackgroundPressed - sp-component-base.ISemanticColors.primaryButtonBorder - - sp-component-base.ISemanticColors.primaryButtonText - - sp-component-base.ISemanticColors.primaryButtonTextHovered - - sp-component-base.ISemanticColors.primaryButtonTextPressed - sp-component-base.ISemanticColors.smallInputBorder - sp-component-base.ISemanticColors.successBackground - sp-component-base.ISemanticColors.variantBorder + - sp-component-base.ISemanticColors.variantBorderHovered - sp-component-base.ISemanticColors.warningBackground - sp-component-base.ISemanticColors.warningHighlight - - sp-component-base.ISemanticColors.warningText - - uid: sp-component-base.ISemanticColors.actionLink - summary: Neutral colored links and links for action buttons. - isPreview: true - name: actionLink - fullName: actionLink - langs: - - typeScript - type: property - syntax: - content: 'actionLink: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.actionLinkHovered - summary: Hover state for neutral colored links and links for action buttons. - isPreview: true - name: actionLinkHovered - fullName: actionLinkHovered + - uid: sp-component-base.ISemanticColors.accentButtonBackground + summary: Background of an accent button (kicker) + name: accentButtonBackground + fullName: accentButtonBackground langs: - typeScript type: property syntax: - content: 'actionLinkHovered: string;' + content: 'accentButtonBackground: string;' return: type: - string - uid: sp-component-base.ISemanticColors.blockingBackground summary: 'Background for blocking issues, which is more severe than a warning, but not as bad as an error.' - isPreview: true name: blockingBackground fullName: blockingBackground langs: @@ -178,7 +154,6 @@ items: - string - uid: sp-component-base.ISemanticColors.bodyBackground summary: The default color for backgrounds. - isPreview: true name: bodyBackground fullName: bodyBackground langs: @@ -191,7 +166,6 @@ items: - string - uid: sp-component-base.ISemanticColors.bodyDivider summary: 'Divider lines; e.g. lines that separate sections in a menu, an
element.' - isPreview: true name: bodyDivider fullName: bodyDivider langs: @@ -207,7 +181,6 @@ items: The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the color of bodyBackground. See also: bodyFrameDivider - isPreview: true name: bodyFrameBackground fullName: bodyFrameBackground langs: @@ -223,7 +196,6 @@ items: Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually disappear. See also: bodyFrameBackground - isPreview: true name: bodyFrameDivider fullName: bodyFrameDivider langs: @@ -239,7 +211,6 @@ items: The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in inverted themes. - isPreview: true name: bodyStandoutBackground fullName: bodyStandoutBackground langs: @@ -250,48 +221,8 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.bodySubtext - summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' - isPreview: true - name: bodySubtext - fullName: bodySubtext - langs: - - typeScript - type: property - syntax: - content: 'bodySubtext: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.bodyText - summary: The default color for text. - isPreview: true - name: bodyText - fullName: bodyText - langs: - - typeScript - type: property - syntax: - content: 'bodyText: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.bodyTextChecked - summary: 'Checked text color, e.g. selected menu item text.' - isPreview: true - name: bodyTextChecked - fullName: bodyTextChecked - langs: - - typeScript - type: property - syntax: - content: 'bodyTextChecked: string;' - return: - type: - - string - uid: sp-component-base.ISemanticColors.buttonBackground summary: Background of a standard button - isPreview: true name: buttonBackground fullName: buttonBackground langs: @@ -304,7 +235,6 @@ items: - string - uid: sp-component-base.ISemanticColors.buttonBackgroundChecked summary: Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar - isPreview: true name: buttonBackgroundChecked fullName: buttonBackgroundChecked langs: @@ -317,7 +247,6 @@ items: - string - uid: sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered summary: Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar - isPreview: true name: buttonBackgroundCheckedHovered fullName: buttonBackgroundCheckedHovered langs: @@ -328,9 +257,20 @@ items: return: type: - string + - uid: sp-component-base.ISemanticColors.buttonBackgroundDisabled + summary: Background of a disabled standard button + name: buttonBackgroundDisabled + fullName: buttonBackgroundDisabled + langs: + - typeScript + type: property + syntax: + content: 'buttonBackgroundDisabled: string;' + return: + type: + - string - uid: sp-component-base.ISemanticColors.buttonBackgroundHovered summary: Background of a hovered standard button - isPreview: true name: buttonBackgroundHovered fullName: buttonBackgroundHovered langs: @@ -343,7 +283,6 @@ items: - string - uid: sp-component-base.ISemanticColors.buttonBackgroundPressed summary: Background of a pressed standard button; i.e. currently being clicked by mouse - isPreview: true name: buttonBackgroundPressed fullName: buttonBackgroundPressed langs: @@ -356,7 +295,6 @@ items: - string - uid: sp-component-base.ISemanticColors.buttonBorder summary: Border of a standard button - isPreview: true name: buttonBorder fullName: buttonBorder langs: @@ -369,7 +307,6 @@ items: - string - uid: sp-component-base.ISemanticColors.buttonBorderDisabled summary: Border of a disabled standard button - isPreview: true name: buttonBorderDisabled fullName: buttonBorderDisabled langs: @@ -380,87 +317,22 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonText - summary: Color of text in a standard button - isPreview: true - name: buttonText - fullName: buttonText - langs: - - typeScript - type: property - syntax: - content: 'buttonText: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.buttonTextChecked - summary: Color of text in a checked standard button - isPreview: true - name: buttonTextChecked - fullName: buttonTextChecked - langs: - - typeScript - type: property - syntax: - content: 'buttonTextChecked: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.buttonTextCheckedHovered - summary: Color of text in a checked and hovered standard button - isPreview: true - name: buttonTextCheckedHovered - fullName: buttonTextCheckedHovered - langs: - - typeScript - type: property - syntax: - content: 'buttonTextCheckedHovered: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.buttonTextDisabled - summary: Color of text in a disabled standard button - isPreview: true - name: buttonTextDisabled - fullName: buttonTextDisabled - langs: - - typeScript - type: property - syntax: - content: 'buttonTextDisabled: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.buttonTextHovered - summary: Color of text in a hovered standard button - isPreview: true - name: buttonTextHovered - fullName: buttonTextHovered - langs: - - typeScript - type: property - syntax: - content: 'buttonTextHovered: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.buttonTextPressed - summary: Color of text in a pressed standard button; i.e. currently being clicked by mouse - isPreview: true - name: buttonTextPressed - fullName: buttonTextPressed + - uid: sp-component-base.ISemanticColors.defaultStateBackground + summary: >- + Background color for default/empty state graphical elements; eg default icons, empty section that needs user to + fill in content, placeholder graphics, empty seats, etc. + name: defaultStateBackground + fullName: defaultStateBackground langs: - typeScript type: property syntax: - content: 'buttonTextPressed: string;' + content: 'defaultStateBackground: string;' return: type: - string - uid: sp-component-base.ISemanticColors.disabledBackground summary: The default color for backgrounds of disabled controls; e.g. disabled text field. - isPreview: true name: disabledBackground fullName: disabledBackground langs: @@ -471,50 +343,8 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.disabledBodyText - summary: The default color for disabled text on the default background (bodyBackground). - isPreview: true - name: disabledBodyText - fullName: disabledBodyText - langs: - - typeScript - type: property - syntax: - content: 'disabledBodyText: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.disabledSubtext - summary: 'Disabled de-emphasized text, for use on disabledBackground.' - isPreview: true - name: disabledSubtext - fullName: disabledSubtext - langs: - - typeScript - type: property - syntax: - content: 'disabledSubtext: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.disabledText - summary: >- - The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled - button text. - isPreview: true - name: disabledText - fullName: disabledText - langs: - - typeScript - type: property - syntax: - content: 'disabledText: string;' - return: - type: - - string - uid: sp-component-base.ISemanticColors.errorBackground summary: 'The background for errors, if necessary, or highlighting the section of the page where the error is present.' - isPreview: true name: errorBackground fullName: errorBackground langs: @@ -525,22 +355,8 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.errorText - summary: 'The default color of error text, used on bodyBackground.' - isPreview: true - name: errorText - fullName: errorText - langs: - - typeScript - type: property - syntax: - content: 'errorText: string;' - return: - type: - - string - uid: sp-component-base.ISemanticColors.focusBorder summary: The color of the outline around focused controls that don't already have a border; e.g. menu items - isPreview: true name: focusBorder fullName: focusBorder langs: @@ -553,7 +369,6 @@ items: - string - uid: sp-component-base.ISemanticColors.inputBackground summary: 'The background color of an input, e.g. textbox background.' - isPreview: true name: inputBackground fullName: inputBackground langs: @@ -566,7 +381,6 @@ items: - string - uid: sp-component-base.ISemanticColors.inputBackgroundChecked summary: 'The background of a checked control; e.g. checked radio button''s dot, checked toggle''s background.' - isPreview: true name: inputBackgroundChecked fullName: inputBackgroundChecked langs: @@ -579,7 +393,6 @@ items: - string - uid: sp-component-base.ISemanticColors.inputBackgroundCheckedHovered summary: The background of a checked and hovered control; e.g. checked checkbox's background color on hover. - isPreview: true name: inputBackgroundCheckedHovered fullName: inputBackgroundCheckedHovered langs: @@ -592,7 +405,6 @@ items: - string - uid: sp-component-base.ISemanticColors.inputBorder summary: 'The border of a large input control in its resting, state; e.g. the box of dropdown.' - isPreview: true name: inputBorder fullName: inputBorder langs: @@ -605,7 +417,6 @@ items: - string - uid: sp-component-base.ISemanticColors.inputBorderHovered summary: 'The border color of a large hovered input control, such as textbox.' - isPreview: true name: inputBorderHovered fullName: inputBorderHovered langs: @@ -618,7 +429,6 @@ items: - string - uid: sp-component-base.ISemanticColors.inputFocusBorderAlt summary: The alternate focus border color for elements that already have a border; e.g. text field borders on focus. - isPreview: true name: inputFocusBorderAlt fullName: inputFocusBorderAlt langs: @@ -633,7 +443,6 @@ items: summary: >- The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio button's background color around the dot. - isPreview: true name: inputForegroundChecked fullName: inputForegroundChecked langs: @@ -644,48 +453,8 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputPlaceholderText - summary: The color of placeholder text. - isPreview: true - name: inputPlaceholderText - fullName: inputPlaceholderText - langs: - - typeScript - type: property - syntax: - content: 'inputPlaceholderText: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.link - summary: The color of a link. - isPreview: true - name: link - fullName: link - langs: - - typeScript - type: property - syntax: - content: 'link: string;' - return: - type: - - string - - uid: sp-component-base.ISemanticColors.linkHovered - summary: The color of a hovered link. Also used when the link is active. - isPreview: true - name: linkHovered - fullName: linkHovered - langs: - - typeScript - type: property - syntax: - content: 'linkHovered: string;' - return: - type: - - string - uid: sp-component-base.ISemanticColors.listBackground summary: The background color for the entire list. - isPreview: true name: listBackground fullName: listBackground langs: @@ -698,7 +467,6 @@ items: - string - uid: sp-component-base.ISemanticColors.listHeaderBackgroundHovered summary: The background color for a hovered list header. - isPreview: true name: listHeaderBackgroundHovered fullName: listHeaderBackgroundHovered langs: @@ -711,7 +479,6 @@ items: - string - uid: sp-component-base.ISemanticColors.listHeaderBackgroundPressed summary: The background color for a pressed list header. - isPreview: true name: listHeaderBackgroundPressed fullName: listHeaderBackgroundPressed langs: @@ -724,7 +491,6 @@ items: - string - uid: sp-component-base.ISemanticColors.listItemBackgroundChecked summary: The background color of a checked list item. - isPreview: true name: listItemBackgroundChecked fullName: listItemBackgroundChecked langs: @@ -737,7 +503,6 @@ items: - string - uid: sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered summary: The background color of a checked and hovered list item. - isPreview: true name: listItemBackgroundCheckedHovered fullName: listItemBackgroundCheckedHovered langs: @@ -750,7 +515,6 @@ items: - string - uid: sp-component-base.ISemanticColors.listItemBackgroundHovered summary: The background color of a hovered list item. - isPreview: true name: listItemBackgroundHovered fullName: listItemBackgroundHovered langs: @@ -763,7 +527,6 @@ items: - string - uid: sp-component-base.ISemanticColors.listText summary: The default text color for list item titles and text in column fields. - isPreview: true name: listText fullName: listText langs: @@ -774,24 +537,32 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listTextColor - summary: Deprecated. Do not use. - deprecated: - content: This slot was incorrectly named. Use listText instead. - isPreview: true - name: listTextColor - fullName: listTextColor + - uid: sp-component-base.ISemanticColors.menuBackground + summary: The background of a menu. + name: menuBackground + fullName: menuBackground + langs: + - typeScript + type: property + syntax: + content: 'menuBackground: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.menuDivider + summary: The divider between menu items. + name: menuDivider + fullName: menuDivider langs: - typeScript type: property syntax: - content: 'listTextColor: string;' + content: 'menuDivider: string;' return: type: - string - uid: sp-component-base.ISemanticColors.menuHeader summary: The headers in menus that denote title of a section. - isPreview: true name: menuHeader fullName: menuHeader langs: @@ -804,7 +575,6 @@ items: - string - uid: sp-component-base.ISemanticColors.menuIcon summary: The default colors of icons in menus. - isPreview: true name: menuIcon fullName: menuIcon langs: @@ -816,12 +586,10 @@ items: type: - string - uid: sp-component-base.ISemanticColors.menuItemBackgroundChecked - summary: Deprecated. Do not use. deprecated: content: >- (Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item whose submenu is open, a selected dropdown item. - isPreview: true name: menuItemBackgroundChecked fullName: menuItemBackgroundChecked langs: @@ -834,7 +602,6 @@ items: - string - uid: sp-component-base.ISemanticColors.menuItemBackgroundHovered summary: The background of a hovered menu item. - isPreview: true name: menuItemBackgroundHovered fullName: menuItemBackgroundHovered langs: @@ -845,100 +612,104 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackground - summary: Background of a primary button - isPreview: true - name: primaryButtonBackground - fullName: primaryButtonBackground + - uid: sp-component-base.ISemanticColors.menuItemBackgroundPressed + summary: The background of a pressed menu item. + name: menuItemBackgroundPressed + fullName: menuItemBackgroundPressed langs: - typeScript type: property syntax: - content: 'primaryButtonBackground: string;' + content: 'menuItemBackgroundPressed: string;' return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundHovered - summary: Background of a hovered primary button - isPreview: true - name: primaryButtonBackgroundHovered - fullName: primaryButtonBackgroundHovered + - uid: sp-component-base.ISemanticColors.menuItemText + summary: The text color of a menu item. + name: menuItemText + fullName: menuItemText langs: - typeScript type: property syntax: - content: 'primaryButtonBackgroundHovered: string;' + content: 'menuItemText: string;' return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundPressed - summary: Background of a pressed primary button; i.e. currently being clicked by mouse - isPreview: true - name: primaryButtonBackgroundPressed - fullName: primaryButtonBackgroundPressed + - uid: sp-component-base.ISemanticColors.menuItemTextHovered + summary: The text color of a hovered menu item. + name: menuItemTextHovered + fullName: menuItemTextHovered langs: - typeScript type: property syntax: - content: 'primaryButtonBackgroundPressed: string;' + content: 'menuItemTextHovered: string;' return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBorder - summary: Border of a primary button - isPreview: true - name: primaryButtonBorder - fullName: primaryButtonBorder + - uid: sp-component-base.ISemanticColors.primaryButtonBackground + summary: Background of a primary button + name: primaryButtonBackground + fullName: primaryButtonBackground langs: - typeScript type: property syntax: - content: 'primaryButtonBorder: string;' + content: 'primaryButtonBackground: string;' return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonText - summary: Color of text in a primary button - isPreview: true - name: primaryButtonText - fullName: primaryButtonText + - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundDisabled + summary: Background of a disabled primary button + name: primaryButtonBackgroundDisabled + fullName: primaryButtonBackgroundDisabled langs: - typeScript type: property syntax: - content: 'primaryButtonText: string;' + content: 'primaryButtonBackgroundDisabled: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundHovered + summary: Background of a hovered primary button + name: primaryButtonBackgroundHovered + fullName: primaryButtonBackgroundHovered + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonBackgroundHovered: string;' return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonTextHovered - summary: Color of text in a hovered primary button - isPreview: true - name: primaryButtonTextHovered - fullName: primaryButtonTextHovered + - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundPressed + summary: Background of a pressed primary button; i.e. currently being clicked by mouse + name: primaryButtonBackgroundPressed + fullName: primaryButtonBackgroundPressed langs: - typeScript type: property syntax: - content: 'primaryButtonTextHovered: string;' + content: 'primaryButtonBackgroundPressed: string;' return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonTextPressed - summary: Color of text in a pressed primary button; i.e. currently being clicked by mouse - isPreview: true - name: primaryButtonTextPressed - fullName: primaryButtonTextPressed + - uid: sp-component-base.ISemanticColors.primaryButtonBorder + summary: Border of a primary button + name: primaryButtonBorder + fullName: primaryButtonBorder langs: - typeScript type: property syntax: - content: 'primaryButtonTextPressed: string;' + content: 'primaryButtonBorder: string;' return: type: - string - uid: sp-component-base.ISemanticColors.smallInputBorder summary: The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox. - isPreview: true name: smallInputBorder fullName: smallInputBorder langs: @@ -951,7 +722,6 @@ items: - string - uid: sp-component-base.ISemanticColors.successBackground summary: Background for success - isPreview: true name: successBackground fullName: successBackground langs: @@ -964,7 +734,6 @@ items: - string - uid: sp-component-base.ISemanticColors.variantBorder summary: 'The color of the border that provides contrast between an element, such as a card, and an emphasized background.' - isPreview: true name: variantBorder fullName: variantBorder langs: @@ -975,9 +744,20 @@ items: return: type: - string + - uid: sp-component-base.ISemanticColors.variantBorderHovered + summary: 'Hover color of border that provides contrast between an element, such as a card, and an emphasized background.' + name: variantBorderHovered + fullName: variantBorderHovered + langs: + - typeScript + type: property + syntax: + content: 'variantBorderHovered: string;' + return: + type: + - string - uid: sp-component-base.ISemanticColors.warningBackground summary: Background for warning messages. - isPreview: true name: warningBackground fullName: warningBackground langs: @@ -990,7 +770,6 @@ items: - string - uid: sp-component-base.ISemanticColors.warningHighlight summary: Foreground color for warning highlights - isPreview: true name: warningHighlight fullName: warningHighlight langs: @@ -1001,16 +780,3 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.warningText - summary: 'The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.' - isPreview: true - name: warningText - fullName: warningText - langs: - - typeScript - type: property - syntax: - content: 'warningText: string;' - return: - type: - - string diff --git a/SP-Framework/sp-component-base/isemantictextcolors.yml b/SP-Framework/sp-component-base/isemantictextcolors.yml new file mode 100644 index 00000000..f71d0470 --- /dev/null +++ b/SP-Framework/sp-component-base/isemantictextcolors.yml @@ -0,0 +1,391 @@ +### YamlMime:UniversalReference +items: + - uid: sp-component-base.ISemanticTextColors + summary: Collection of semantic text colors. + name: ISemanticTextColors + fullName: ISemanticTextColors + langs: + - typeScript + type: interface + package: sp-component-base + children: + - sp-component-base.ISemanticTextColors.accentButtonText + - sp-component-base.ISemanticTextColors.actionLink + - sp-component-base.ISemanticTextColors.actionLinkHovered + - sp-component-base.ISemanticTextColors.bodySubtext + - sp-component-base.ISemanticTextColors.bodyText + - sp-component-base.ISemanticTextColors.bodyTextChecked + - sp-component-base.ISemanticTextColors.buttonText + - sp-component-base.ISemanticTextColors.buttonTextChecked + - sp-component-base.ISemanticTextColors.buttonTextCheckedHovered + - sp-component-base.ISemanticTextColors.buttonTextDisabled + - sp-component-base.ISemanticTextColors.buttonTextHovered + - sp-component-base.ISemanticTextColors.buttonTextPressed + - sp-component-base.ISemanticTextColors.disabledBodySubtext + - sp-component-base.ISemanticTextColors.disabledBodyText + - sp-component-base.ISemanticTextColors.disabledSubtext + - sp-component-base.ISemanticTextColors.disabledText + - sp-component-base.ISemanticTextColors.errorText + - sp-component-base.ISemanticTextColors.inputPlaceholderText + - sp-component-base.ISemanticTextColors.inputText + - sp-component-base.ISemanticTextColors.inputTextHovered + - sp-component-base.ISemanticTextColors.link + - sp-component-base.ISemanticTextColors.linkHovered + - sp-component-base.ISemanticTextColors.listText + - sp-component-base.ISemanticTextColors.listTextColor + - sp-component-base.ISemanticTextColors.primaryButtonText + - sp-component-base.ISemanticTextColors.primaryButtonTextDisabled + - sp-component-base.ISemanticTextColors.primaryButtonTextHovered + - sp-component-base.ISemanticTextColors.primaryButtonTextPressed + - sp-component-base.ISemanticTextColors.warningText + - uid: sp-component-base.ISemanticTextColors.accentButtonText + summary: Color of text for accent button (kicker) + name: accentButtonText + fullName: accentButtonText + langs: + - typeScript + type: property + syntax: + content: 'accentButtonText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.actionLink + summary: Neutral colored links and links for action buttons. + name: actionLink + fullName: actionLink + langs: + - typeScript + type: property + syntax: + content: 'actionLink: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.actionLinkHovered + summary: Hover state for neutral colored links and links for action buttons. + name: actionLinkHovered + fullName: actionLinkHovered + langs: + - typeScript + type: property + syntax: + content: 'actionLinkHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.bodySubtext + summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' + name: bodySubtext + fullName: bodySubtext + langs: + - typeScript + type: property + syntax: + content: 'bodySubtext: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.bodyText + summary: The default color for text. + name: bodyText + fullName: bodyText + langs: + - typeScript + type: property + syntax: + content: 'bodyText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.bodyTextChecked + summary: 'Checked text color, e.g. selected menu item text.' + name: bodyTextChecked + fullName: bodyTextChecked + langs: + - typeScript + type: property + syntax: + content: 'bodyTextChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.buttonText + summary: Color of text in a standard button + name: buttonText + fullName: buttonText + langs: + - typeScript + type: property + syntax: + content: 'buttonText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.buttonTextChecked + summary: Color of text in a checked standard button + name: buttonTextChecked + fullName: buttonTextChecked + langs: + - typeScript + type: property + syntax: + content: 'buttonTextChecked: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.buttonTextCheckedHovered + summary: Color of text in a checked and hovered standard button + name: buttonTextCheckedHovered + fullName: buttonTextCheckedHovered + langs: + - typeScript + type: property + syntax: + content: 'buttonTextCheckedHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.buttonTextDisabled + summary: Color of text in a disabled standard button + name: buttonTextDisabled + fullName: buttonTextDisabled + langs: + - typeScript + type: property + syntax: + content: 'buttonTextDisabled: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.buttonTextHovered + summary: Color of text in a hovered standard button + name: buttonTextHovered + fullName: buttonTextHovered + langs: + - typeScript + type: property + syntax: + content: 'buttonTextHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.buttonTextPressed + summary: Color of text in a pressed standard button; i.e. currently being clicked by mouse + name: buttonTextPressed + fullName: buttonTextPressed + langs: + - typeScript + type: property + syntax: + content: 'buttonTextPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.disabledBodySubtext + summary: 'Disabled de-emphasized text, for use on the default background (bodyBackground).' + name: disabledBodySubtext + fullName: disabledBodySubtext + langs: + - typeScript + type: property + syntax: + content: 'disabledBodySubtext: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.disabledBodyText + summary: The default color for disabled text on the default background (bodyBackground). + name: disabledBodyText + fullName: disabledBodyText + langs: + - typeScript + type: property + syntax: + content: 'disabledBodyText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.disabledSubtext + summary: 'Disabled de-emphasized text, for use on disabledBackground.' + name: disabledSubtext + fullName: disabledSubtext + langs: + - typeScript + type: property + syntax: + content: 'disabledSubtext: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.disabledText + summary: >- + The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled + button text. + name: disabledText + fullName: disabledText + langs: + - typeScript + type: property + syntax: + content: 'disabledText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.errorText + summary: 'The default color of error text, used on bodyBackground.' + name: errorText + fullName: errorText + langs: + - typeScript + type: property + syntax: + content: 'errorText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.inputPlaceholderText + summary: The color of placeholder text. + name: inputPlaceholderText + fullName: inputPlaceholderText + langs: + - typeScript + type: property + syntax: + content: 'inputPlaceholderText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.inputText + summary: The color of input text. + name: inputText + fullName: inputText + langs: + - typeScript + type: property + syntax: + content: 'inputText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.inputTextHovered + summary: The color of input text on hover. + name: inputTextHovered + fullName: inputTextHovered + langs: + - typeScript + type: property + syntax: + content: 'inputTextHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.link + summary: The color of a link. + name: link + fullName: link + langs: + - typeScript + type: property + syntax: + content: 'link: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.linkHovered + summary: The color of a hovered link. Also used when the link is active. + name: linkHovered + fullName: linkHovered + langs: + - typeScript + type: property + syntax: + content: 'linkHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.listText + summary: The default text color for list item titles and text in column fields. + name: listText + fullName: listText + langs: + - typeScript + type: property + syntax: + content: 'listText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.listTextColor + deprecated: + content: This slot was incorrectly named. Use listText instead. + name: listTextColor + fullName: listTextColor + langs: + - typeScript + type: property + syntax: + content: 'listTextColor: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.primaryButtonText + summary: Color of text in a primary button + name: primaryButtonText + fullName: primaryButtonText + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonText: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.primaryButtonTextDisabled + summary: Color of text in a disabled primary button + name: primaryButtonTextDisabled + fullName: primaryButtonTextDisabled + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonTextDisabled: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.primaryButtonTextHovered + summary: Color of text in a hovered primary button + name: primaryButtonTextHovered + fullName: primaryButtonTextHovered + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonTextHovered: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.primaryButtonTextPressed + summary: Color of text in a pressed primary button; i.e. currently being clicked by mouse + name: primaryButtonTextPressed + fullName: primaryButtonTextPressed + langs: + - typeScript + type: property + syntax: + content: 'primaryButtonTextPressed: string;' + return: + type: + - string + - uid: sp-component-base.ISemanticTextColors.warningText + summary: 'The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.' + name: warningText + fullName: warningText + langs: + - typeScript + type: property + syntax: + content: 'warningText: string;' + return: + type: + - string diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index 6072dd4f..d6ca82af 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -2,7 +2,6 @@ items: - uid: sp-component-base.ITheme summary: 'Collection of theme values, which can be used to programatically style components.' - isPreview: true name: ITheme fullName: ITheme langs: @@ -17,10 +16,9 @@ items: - sp-component-base.ITheme.semanticColors - uid: sp-component-base.ITheme.disableGlobalClassNames summary: >- - Diables global styles on Fabric components. This will prevent global overrides that might have been set by other + Disables global styles on Fabric components. This will prevent global overrides that might have been set by other Fabric users from applying to your components. remarks: This has a vary narrow use case and most likely should be avoided. - isPreview: true name: disableGlobalClassNames fullName: disableGlobalClassNames langs: @@ -42,10 +40,9 @@ items: content: 'fonts: IFontStyles;' return: type: - - IFontStyles + - sp-component-base.IFontStyles - uid: sp-component-base.ITheme.isInverted summary: Indicates whether the theme is inverted. - isPreview: true name: isInverted fullName: isInverted langs: @@ -67,7 +64,7 @@ items: content: 'palette: IPalette;' return: type: - - IPalette + - sp-component-base.IPalette - uid: sp-component-base.ITheme.semanticColors summary: The collection of all semantic slots for colors used in themes. name: semanticColors @@ -79,4 +76,4 @@ items: content: 'semanticColors: ISemanticColors;' return: type: - - ISemanticColors + - sp-component-base.ISemanticColors diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index 9bf4f88a..e733d4ed 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -2,20 +2,18 @@ items: - uid: sp-component-base.ThemeChangedEventArgs summary: The object passed when the IThemeProvider.themeChangedEvent is raised. - isPreview: true name: ThemeChangedEventArgs fullName: ThemeChangedEventArgs langs: - typeScript type: class extends: - - SPEventArgs + - sp-core-library.SPEventArgs package: sp-component-base children: - sp-component-base.ThemeChangedEventArgs.theme - uid: sp-component-base.ThemeChangedEventArgs.theme summary: 'The new theme. If the value is undefined, then the theme was cleared.' - isPreview: true name: theme fullName: theme langs: diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index b9f89b57..dbded6c4 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -4,7 +4,6 @@ items: summary: >- The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. - isPreview: true name: ThemeProvider fullName: ThemeProvider langs: @@ -12,14 +11,14 @@ items: type: class package: sp-component-base children: - - sp-component-base.ThemeProvider.constructor + - sp-component-base.ThemeProvider.(constructor) - sp-component-base.ThemeProvider.serviceKey - sp-component-base.ThemeProvider.themeChangedEvent - sp-component-base.ThemeProvider.tryGetTheme - - uid: sp-component-base.ThemeProvider.constructor - summary: 'Constructs a new instance of the [ThemeProvider](xref:sp-component-base.ThemeProvider) class' - name: 'constructor(serviceScope, theme)' - fullName: constructor + - uid: sp-component-base.ThemeProvider.(constructor) + summary: Construct a new instance of the ThemeProvider class. + name: '(constructor)(serviceScope, theme)' + fullName: '(constructor)(serviceScope, theme)' langs: - typeScript type: constructor @@ -27,16 +26,15 @@ items: content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' parameters: - id: serviceScope - description: '' + description: The current service scope. type: - - ServiceScope + - sp-core-library.ServiceScope - id: theme - description: '' + description: Theme to provide. type: - - ITheme + - sp-component-base.ITheme - uid: sp-component-base.ThemeProvider.serviceKey summary: The service key for ThemeProvider. - isPreview: true name: serviceKey fullName: serviceKey langs: @@ -49,7 +47,6 @@ items: - ServiceKey - uid: sp-component-base.ThemeProvider.themeChangedEvent summary: Raised when the theme changes with the new theme as an argument. - isPreview: true name: themeChangedEvent fullName: themeChangedEvent langs: @@ -62,9 +59,8 @@ items: - SPEvent - uid: sp-component-base.ThemeProvider.tryGetTheme summary: 'If set, get the current scoped theme.' - isPreview: true name: tryGetTheme() - fullName: tryGetTheme + fullName: tryGetTheme() langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index 8f14ba6b..f9040134 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -21,4 +21,4 @@ items: content: 'static readonly type: EnvironmentType;' return: type: - - EnvironmentType + - sp-core-library.EnvironmentType diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index d7d37f76..f6f93d00 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -22,6 +22,7 @@ items: - sp-core-library.Guid.isValid - sp-core-library.Guid.newGuid - sp-core-library.Guid.parse + - sp-core-library.Guid.toString - sp-core-library.Guid.tryParse - uid: sp-core-library.Guid.empty summary: Returns a new empty Guid instance. @@ -34,11 +35,11 @@ items: content: 'static readonly empty: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-core-library.Guid.equals summary: Compare this instance to another Guid instance name: equals(guid) - fullName: equals + fullName: equals(guid) langs: - typeScript type: method @@ -52,13 +53,13 @@ items: - id: guid description: '' type: - - Guid + - sp-core-library.Guid - uid: sp-core-library.Guid.isValid summary: >- Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. name: isValid(guid) - fullName: isValid + fullName: isValid(guid) langs: - typeScript type: method @@ -78,7 +79,7 @@ items: Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. name: newGuid(randomNumberGenerator) - fullName: newGuid + fullName: newGuid(randomNumberGenerator) langs: - typeScript type: method @@ -86,25 +87,27 @@ items: content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' return: type: - - Guid + - sp-core-library.Guid description: A new unique Guid object parameters: - id: randomNumberGenerator description: '' type: - - IRandomNumberGenerator + - sp-core-library.IRandomNumberGenerator - uid: sp-core-library.Guid.parse summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' remarks: |- Example syntaxes accepted by this function: + - `"d5369f3bbd7a412a9c0f7f0650bb5489"` + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` name: parse(guidString) - fullName: parse + fullName: parse(guidString) langs: - typeScript type: method @@ -112,13 +115,29 @@ items: content: 'static parse(guidString: string | undefined | null): Guid;' return: type: - - Guid + - sp-core-library.Guid description: A valid Guid object parameters: - id: guidString description: '' type: - string | undefined | null + - uid: sp-core-library.Guid.toString + summary: Returns a string representation of the GUID + name: toString() + fullName: toString() + langs: + - typeScript + type: method + syntax: + content: 'toString(): string;' + return: + type: + - string + description: |- + The GUID value in lowercase hexadecimal without braces. + + Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` - uid: sp-core-library.Guid.tryParse summary: >- Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined @@ -126,13 +145,15 @@ items: remarks: |- Example syntaxes accepted by this function: + - `"d5369f3bbd7a412a9c0f7f0650bb5489"` + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` name: tryParse(guid) - fullName: tryParse + fullName: tryParse(guid) langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 916eff59..c0792e98 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -16,7 +16,7 @@ items: summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: dispose() - fullName: dispose + fullName: dispose() langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 1bdec3ea..5401697f 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -18,7 +18,7 @@ items: - uid: sp-core-library.IRandomNumberGenerator.generate summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' name: generate() - fullName: generate + fullName: generate() langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index 2bfd32cc..2039dce0 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -16,10 +16,6 @@ items: - sp-core-library.IServiceCollection.serviceScope - uid: sp-core-library.IServiceCollection.serviceScope summary: Returns the underlying ServiceScope that the members belong to. - deprecated: - content: >- - This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future - release. name: serviceScope fullName: serviceScope langs: @@ -29,4 +25,4 @@ items: content: 'readonly serviceScope: ServiceScope;' return: type: - - ServiceScope + - sp-core-library.ServiceScope diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 8aa07f99..c444c9ed 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -15,7 +15,7 @@ items: - typeScript type: interface extends: - - IDisposable + - sp-core-library.IDisposable package: sp-core-library children: - sp-core-library.ISPEventObserver.componentId diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 17326548..a78899ac 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -19,7 +19,7 @@ items: - uid: sp-core-library.ITimeProvider.getDate summary: 'Returns the current date/time, similar to the Date class constructor.' name: getDate() - fullName: getDate + fullName: getDate() langs: - typeScript type: method @@ -32,7 +32,7 @@ items: - uid: sp-core-library.ITimeProvider.getTimestamp summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' name: getTimestamp() - fullName: getTimestamp + fullName: getTimestamp() langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index e3f3fe5c..e8955584 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -21,7 +21,7 @@ items: - uid: sp-core-library.Log.error summary: Logs an error. name: 'error(source, error, scope)' - fullName: error + fullName: 'error(source, error, scope)' langs: - typeScript type: method @@ -47,11 +47,11 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error. type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-core-library.Log.info summary: Logs a general informational message. name: 'info(source, message, scope)' - fullName: info + fullName: 'info(source, message, scope)' langs: - typeScript type: method @@ -77,11 +77,11 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-core-library.Log.verbose summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. name: 'verbose(source, message, scope)' - fullName: verbose + fullName: 'verbose(source, message, scope)' langs: - typeScript type: method @@ -107,11 +107,11 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-core-library.Log.warn summary: Logs a warning. name: 'warn(source, message, scope)' - fullName: warn + fullName: 'warn(source, message, scope)' langs: - typeScript type: method @@ -137,4 +137,4 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. type: - - ServiceScope + - sp-core-library.ServiceScope diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 57fef596..4eab7f6b 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -10,16 +10,16 @@ items: - typeScript type: class implements: - - IRandomNumberGenerator + - sp-core-library.IRandomNumberGenerator package: sp-core-library children: - - sp-core-library.RandomNumberGenerator.constructor + - sp-core-library.RandomNumberGenerator.(constructor) - sp-core-library.RandomNumberGenerator.generate - sp-core-library.RandomNumberGenerator.serviceKey - - uid: sp-core-library.RandomNumberGenerator.constructor - summary: 'Constructs a new instance of the [RandomNumberGenerator](xref:sp-core-library.RandomNumberGenerator) class' - name: constructor(serviceScope) - fullName: constructor + - uid: sp-core-library.RandomNumberGenerator.(constructor) + summary: Constructs a new instance of the `RandomNumberGenerator` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -29,11 +29,11 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-core-library.RandomNumberGenerator.generate summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' name: generate() - fullName: generate + fullName: generate() langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index e017ca76..3a1490c5 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -3,7 +3,7 @@ items: - uid: sp-core-library.ServiceKey summary: >- The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume](xref:sp-core-library.ServiceScope.consume) to fetch a dependency. + [ServiceScope.consume()](xref:sp-core-library.ServiceScope.consume) to fetch a dependency. remarks: >- Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies @@ -27,16 +27,16 @@ items: the standard constructor parameter. remarks: >- If you want to specify custom constructor parameters, use - [ServiceKey.createCustom](xref:sp-core-library.ServiceKey.createCustom) instead. + [ServiceKey.createCustom()](xref:sp-core-library.ServiceKey.createCustom) instead. name: 'create(name, serviceClass)' - fullName: create + fullName: 'create(name, serviceClass)' langs: - typeScript type: method syntax: content: |- static create(name: string, serviceClass: { - new (serviceScope: ServiceScope); + new (serviceScope: ServiceScope): TKey; }): ServiceKey; return: type: @@ -52,12 +52,12 @@ items: type: - |- { - new (serviceScope: ServiceScope); + new (serviceScope: ServiceScope): TKey; } - uid: sp-core-library.ServiceKey.createCustom summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. name: 'createCustom(name, defaultCreator)' - fullName: createCustom + fullName: 'createCustom(name, defaultCreator)' langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index dbc806b1..ba575ed1 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -51,7 +51,7 @@ items: type: class package: sp-core-library children: - - sp-core-library.ServiceScope.constructor + - sp-core-library.ServiceScope.(constructor) - sp-core-library.ServiceScope.consume - sp-core-library.ServiceScope.createAndProvide - sp-core-library.ServiceScope.createDefaultAndProvide @@ -61,10 +61,10 @@ items: - sp-core-library.ServiceScope.startNewChild - sp-core-library.ServiceScope.startNewRoot - sp-core-library.ServiceScope.whenFinished - - uid: sp-core-library.ServiceScope.constructor - summary: 'Constructs a new instance of the [ServiceScope](xref:sp-core-library.ServiceScope) class' - name: constructor(parent) - fullName: constructor + - uid: sp-core-library.ServiceScope.(constructor) + summary: Constructs a new instance of the `ServiceScope` class + name: (constructor)(parent) + fullName: (constructor)(parent) langs: - typeScript type: constructor @@ -82,7 +82,7 @@ items: registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. name: consume(serviceKey) - fullName: consume + fullName: consume(serviceKey) langs: - typeScript type: method @@ -102,14 +102,14 @@ items: This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). name: 'createAndProvide(serviceKey, simpleServiceClass)' - fullName: createAndProvide + fullName: 'createAndProvide(serviceKey, simpleServiceClass)' langs: - typeScript type: method syntax: content: |- createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { - new (serviceScope: ServiceScope); + new (serviceScope: ServiceScope): T; }): T; return: type: @@ -125,14 +125,14 @@ items: type: - |- { - new (serviceScope: ServiceScope); + new (serviceScope: ServiceScope): T; } - uid: sp-core-library.ServiceScope.createDefaultAndProvide summary: >- This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). name: createDefaultAndProvide(serviceKey) - fullName: createDefaultAndProvide + fullName: createDefaultAndProvide(serviceKey) langs: - typeScript type: method @@ -160,7 +160,7 @@ items: different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. name: finish() - fullName: finish + fullName: finish() langs: - typeScript type: method @@ -173,7 +173,7 @@ items: - uid: sp-core-library.ServiceScope.getParent summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' name: getParent() - fullName: getParent + fullName: getParent() langs: - typeScript type: method @@ -189,7 +189,7 @@ items: ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. name: 'provide(serviceKey, service)' - fullName: provide + fullName: 'provide(serviceKey, service)' langs: - typeScript type: method @@ -214,7 +214,7 @@ items: The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. name: startNewChild() - fullName: startNewChild + fullName: startNewChild() langs: - typeScript type: method @@ -222,14 +222,14 @@ items: content: 'startNewChild(): ServiceScope;' return: type: - - ServiceScope + - sp-core-library.ServiceScope description: the newly created root ServiceScope - uid: sp-core-library.ServiceScope.startNewRoot summary: >- Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. name: startNewRoot() - fullName: startNewRoot + fullName: startNewRoot() langs: - typeScript type: method @@ -237,10 +237,10 @@ items: content: 'static startNewRoot(): ServiceScope;' return: type: - - ServiceScope + - sp-core-library.ServiceScope description: the newly created root ServiceScope - uid: sp-core-library.ServiceScope.whenFinished - summary: 'Defer an operation until after [ServiceScope.finish](xref:sp-core-library.ServiceScope.finish) has completed.' + summary: 'Defer an operation until after [ServiceScope.finish()](xref:sp-core-library.ServiceScope.finish) has completed.' remarks: >- It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the @@ -252,7 +252,7 @@ items: However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). name: whenFinished(callback) - fullName: whenFinished + fullName: whenFinished(callback) langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index f70296fd..ab37add5 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -28,7 +28,7 @@ items: content: 'static readonly applicationId: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-core-library.Session.pageId summary: A unique identifier for the current page within the client-side application. remarks: >- @@ -54,4 +54,4 @@ items: content: 'static readonly pageId: Guid;' return: type: - - Guid + - sp-core-library.Guid diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index 617d549b..f5709b4f 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -3,10 +3,6 @@ items: - uid: sp-core-library.SPEvent summary: Represents a framework event that components can subscribe to. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPEvent class. - - Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed @@ -22,6 +18,10 @@ items: unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPEvent` class. name: SPEvent fullName: SPEvent langs: @@ -38,7 +38,7 @@ items: ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. name: 'add(observer, eventHandler)' - fullName: add + fullName: 'add(observer, eventHandler)' langs: - typeScript type: method @@ -55,7 +55,7 @@ items: be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception. type: - - ISPEventObserver + - sp-core-library.ISPEventObserver - id: eventHandler description: A callback function that will be invoked whenever the event occurs type: @@ -64,7 +64,7 @@ items: summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' name: 'remove(observer, eventHandler)' - fullName: remove + fullName: 'remove(observer, eventHandler)' langs: - typeScript type: method @@ -78,7 +78,7 @@ items: - id: observer description: This must be the same observer that was passed to the add() function. type: - - ISPEventObserver + - sp-core-library.ISPEventObserver - id: eventHandler description: The event handler to remove; this must be the same object instance that was passed to the add() function. type: diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index 68617559..877e10cf 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -25,7 +25,7 @@ items: `Text.format("hello {0}!", "world")` will return `"hello world!"` name: 'format(s, values)' - fullName: format + fullName: 'format(s, values)' langs: - typeScript type: method @@ -48,7 +48,7 @@ items: summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' name: 'replaceAll(input, searchValue, replaceValue)' - fullName: replaceAll + fullName: 'replaceAll(input, searchValue, replaceValue)' langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index cbce968a..7829b695 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -10,17 +10,17 @@ items: - typeScript type: class implements: - - ITimeProvider + - sp-core-library.ITimeProvider package: sp-core-library children: - - sp-core-library.TimeProvider.constructor + - sp-core-library.TimeProvider.(constructor) - sp-core-library.TimeProvider.getDate - sp-core-library.TimeProvider.getTimestamp - sp-core-library.TimeProvider.serviceKey - - uid: sp-core-library.TimeProvider.constructor - summary: 'Constructs a new instance of the [TimeProvider](xref:sp-core-library.TimeProvider) class' - name: constructor(serviceScope) - fullName: constructor + - uid: sp-core-library.TimeProvider.(constructor) + summary: Constructs a new instance of the `TimeProvider` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -30,11 +30,11 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-core-library.TimeProvider.getDate summary: 'Returns the current date/time, similar to the Date class constructor.' name: getDate() - fullName: getDate + fullName: getDate() langs: - typeScript type: method @@ -47,7 +47,7 @@ items: - uid: sp-core-library.TimeProvider.getTimestamp summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' name: getTimestamp() - fullName: getTimestamp + fullName: getTimestamp() langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index aa3313e2..efd7ce25 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -23,17 +23,13 @@ items: type: class package: sp-core-library children: - - sp-core-library.UrlQueryParameterCollection.constructor + - sp-core-library.UrlQueryParameterCollection.(constructor) - sp-core-library.UrlQueryParameterCollection.getValue - sp-core-library.UrlQueryParameterCollection.getValues - - uid: sp-core-library.UrlQueryParameterCollection.constructor - summary: >- - Constructs a new instance of the [UrlQueryParameterCollection](xref:sp-core-library.UrlQueryParameterCollection) - class - deprecated: - content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. - name: constructor(url) - fullName: constructor + - uid: sp-core-library.UrlQueryParameterCollection.(constructor) + summary: Constructs a new instance of the `UrlQueryParameterCollection` class + name: (constructor)(url) + fullName: (constructor)(url) langs: - typeScript type: constructor @@ -48,6 +44,7 @@ items: summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. remarks: |- Examples: + ``` this._queryParameterList = [ {key: TEST, value: done}, @@ -58,10 +55,8 @@ items: getValue('lost') ---> undefined ``` - deprecated: - content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: getValue(param) - fullName: getValue + fullName: getValue(param) langs: - typeScript type: method @@ -80,6 +75,7 @@ items: summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. remarks: |- Examples: + ``` this._queryParameterList = [ {key: TEST, value: done}, @@ -90,10 +86,8 @@ items: getValues('lost') ---> undefined ``` - deprecated: - content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. name: getValues(param) - fullName: getValues + fullName: getValues(param) langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 856762aa..940cca1b 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -20,7 +20,7 @@ items: - uid: sp-core-library.Validate.isNonemptyString summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' name: 'isNonemptyString(value, variableName)' - fullName: isNonemptyString + fullName: 'isNonemptyString(value, variableName)' langs: - typeScript type: method @@ -42,7 +42,7 @@ items: - uid: sp-core-library.Validate.isNotDisposed summary: Throws an exception if the specified object has been disposed. name: 'isNotDisposed(value, className)' - fullName: isNotDisposed + fullName: 'isNotDisposed(value, className)' langs: - typeScript type: method @@ -56,7 +56,7 @@ items: - id: value description: the value to check type: - - IDisposable + - sp-core-library.IDisposable - id: className description: 'the class name, which will be mentioned in the error message' type: @@ -64,7 +64,7 @@ items: - uid: sp-core-library.Validate.isNotNullOrUndefined summary: Throws an exception if the specified value is null or undefined. name: 'isNotNullOrUndefined(value, variableName)' - fullName: isNotNullOrUndefined + fullName: 'isNotNullOrUndefined(value, variableName)' langs: - typeScript type: method @@ -86,7 +86,7 @@ items: - uid: sp-core-library.Validate.isTrue summary: Throws an exception if the specified value is not true. name: 'isTrue(value, variableName)' - fullName: isTrue + fullName: 'isTrue(value, variableName)' langs: - typeScript type: method diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 1179a915..6e6ca0ab 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -27,11 +27,12 @@ items: - sp-core-library.Version.patch - sp-core-library.Version.revision - sp-core-library.Version.satisfies + - sp-core-library.Version.toString - sp-core-library.Version.tryParse - uid: sp-core-library.Version.compare summary: Compares two Version objects to determine which version is newer. name: 'compare(v1, v2)' - fullName: compare + fullName: 'compare(v1, v2)' langs: - typeScript type: method @@ -47,15 +48,16 @@ items: - id: v1 description: The first version class for comparison type: - - Version + - sp-core-library.Version - id: v2 description: The second version class for comparison type: - - Version + - sp-core-library.Version - uid: sp-core-library.Version.equals summary: Tests whether this version is equal to the input parameter. remarks: |- Examples: + ``` 1.0.0 equals 1.0.0 -> true; 2.0.1 equals 2.0.0 -> false; @@ -64,7 +66,7 @@ items: ``` name: equals(compareWith) - fullName: equals + fullName: equals(compareWith) langs: - typeScript type: method @@ -78,11 +80,12 @@ items: - id: compareWith description: The version to compare with type: - - Version + - sp-core-library.Version - uid: sp-core-library.Version.greaterThan summary: Tests whether this version is greater than (i.e. newer than) the input parameter. remarks: |- Examples: + ``` 1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; @@ -90,7 +93,7 @@ items: ``` name: greaterThan(compareWith) - fullName: greaterThan + fullName: greaterThan(compareWith) langs: - typeScript type: method @@ -104,11 +107,11 @@ items: - id: compareWith description: The version to compare with type: - - Version + - sp-core-library.Version - uid: sp-core-library.Version.isValid summary: Test whether a string is a valid version specifier. name: isValid(versionString) - fullName: isValid + fullName: isValid(versionString) langs: - typeScript type: method @@ -127,6 +130,7 @@ items: summary: Tests whether this version is less than (i.e. older than) the input parameter. remarks: |- Examples: + ``` 0.9.9 lessThan 1.0.0 -> true; 2.0 lessThan 2.0.0 -> false; @@ -135,7 +139,7 @@ items: ``` name: lessThan(compareWith) - fullName: lessThan + fullName: lessThan(compareWith) langs: - typeScript type: method @@ -149,7 +153,7 @@ items: - id: compareWith description: The version to compare with type: - - Version + - sp-core-library.Version - uid: sp-core-library.Version.major summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. @@ -181,7 +185,7 @@ items: - uid: sp-core-library.Version.parse summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. name: parse(versionString) - fullName: parse + fullName: parse(versionString) langs: - typeScript type: method @@ -189,7 +193,7 @@ items: content: 'static parse(versionString: string | undefined | null): Version;' return: type: - - Version + - sp-core-library.Version description: a new Version object parameters: - id: versionString @@ -237,6 +241,7 @@ items: Examples: + ``` 1.0.0 satisfies 1.0.0 -> true; @@ -250,7 +255,7 @@ items: ``` name: satisfies(compareWith) - fullName: satisfies + fullName: satisfies(compareWith) langs: - typeScript type: method @@ -264,13 +269,29 @@ items: - id: compareWith description: The version to compare with type: - - Version + - sp-core-library.Version + - uid: sp-core-library.Version.toString + summary: Returns a string representation of the version. + remarks: >- + The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). + However, the number of version parts will be unchanged. + name: toString() + fullName: toString() + langs: + - typeScript + type: method + syntax: + content: 'toString(): string;' + return: + type: + - string + description: '' - uid: sp-core-library.Version.tryParse summary: >- Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. name: tryParse(versionString) - fullName: tryParse + fullName: tryParse(versionString) langs: - typeScript type: method diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index 0bf85e79..c07aa11f 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -3,8 +3,8 @@ items: - uid: sp-dialog summary: SharePoint Framework support for displaying pop-up dialog boxes. remarks: >- - This library provides simple stock dialogs such as [Dialog.alert](xref:sp-dialog.Dialog.alert) and - [Dialog.prompt](xref:sp-dialog.Dialog.prompt), along with a general framework for building custom dialog + This library provides simple stock dialogs such as [Dialog.alert()](xref:sp-dialog.Dialog.alert) and + [Dialog.prompt()](xref:sp-dialog.Dialog.prompt), along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications. name: '@microsoft/sp-dialog' fullName: '@microsoft/sp-dialog' diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index d408518f..d32107f8 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -18,7 +18,7 @@ items: type: class package: sp-dialog children: - - sp-dialog.BaseDialog.constructor + - sp-dialog.BaseDialog.(constructor) - sp-dialog.BaseDialog.close - sp-dialog.BaseDialog.domElement - sp-dialog.BaseDialog.isHidden @@ -29,7 +29,7 @@ items: - sp-dialog.BaseDialog.render - sp-dialog.BaseDialog.secondaryDialogProvider - sp-dialog.BaseDialog.show - - uid: sp-dialog.BaseDialog.constructor + - uid: sp-dialog.BaseDialog.(constructor) summary: Constructor for the `BaseDialog` class. remarks: >- It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization @@ -46,6 +46,7 @@ items: Example: + ``` constructor(cacheReference: any) { super(); @@ -56,8 +57,8 @@ items: } ``` - name: constructor(config) - fullName: constructor + name: (constructor)(config) + fullName: (constructor)(config) langs: - typeScript type: constructor @@ -67,14 +68,14 @@ items: - id: config description: the dialog configuration that affects how the dialog is displayed \* type: - - IDialogConfiguration + - sp-dialog.IDialogConfiguration - uid: sp-dialog.BaseDialog.close summary: Close the dialog. remarks: >- This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. name: close() - fullName: close + fullName: close() langs: - typeScript type: method @@ -86,7 +87,7 @@ items: description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - uid: sp-dialog.BaseDialog.domElement summary: Use this property to access the container element provided by the framework for rendering. - remarks: 'See [BaseDialog.render](xref:sp-dialog.BaseDialog.render) for more information on rendering.' + remarks: 'See [BaseDialog.render()](xref:sp-dialog.BaseDialog.render) for more information on rendering.' name: domElement fullName: domElement langs: @@ -146,7 +147,7 @@ items: that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. name: onAfterClose() - fullName: onAfterClose + fullName: onAfterClose() langs: - typeScript type: method @@ -162,7 +163,7 @@ items: loading indicator is displayed during the lifetime of this method. remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. name: onBeforeOpen() - fullName: onBeforeOpen + fullName: onBeforeOpen() langs: - typeScript type: method @@ -189,7 +190,7 @@ items: UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. name: render() - fullName: render + fullName: render() langs: - typeScript type: method @@ -220,7 +221,7 @@ items: - uid: sp-dialog.BaseDialog.show summary: Request the framework to show this dialog. name: show(options) - fullName: show + fullName: show(options) langs: - typeScript type: method @@ -236,4 +237,4 @@ items: - id: options description: 'Dialog showing options. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' type: - - IDialogShowOptions + - sp-dialog.IDialogShowOptions diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 6e91901e..e352351d 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -20,7 +20,7 @@ items: dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. name: 'alert(message, options)' - fullName: alert + fullName: 'alert(message, options)' langs: - typeScript type: method @@ -38,7 +38,7 @@ items: - id: options description: '' type: - - IAlertOptions + - sp-dialog.IAlertOptions - uid: sp-dialog.Dialog.prompt summary: >- Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to @@ -48,7 +48,7 @@ items: dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. name: 'prompt(message, options)' - fullName: prompt + fullName: 'prompt(message, options)' langs: - typeScript type: method @@ -66,4 +66,4 @@ items: - id: options description: '' type: - - IPromptOptions + - sp-dialog.IPromptOptions diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index a826df7f..e06e20cc 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -8,5 +8,5 @@ items: - typeScript type: interface extends: - - IDialogShowOptions + - sp-dialog.IDialogShowOptions package: sp-dialog diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 73ab9652..9d4cc363 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -8,7 +8,7 @@ items: - typeScript type: interface extends: - - IDialogShowOptions + - sp-dialog.IDialogShowOptions package: sp-dialog children: - sp-dialog.IPromptOptions.defaultValue diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index a886a333..1f6239ee 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -24,10 +24,10 @@ items: - sp-dialog.ISecondaryDialogProvider.show - uid: sp-dialog.ISecondaryDialogProvider.alert summary: >- - Similar to [Dialog.alert](xref:sp-dialog.Dialog.alert). The only difference is that the dialog is + Similar to [Dialog.alert()](xref:sp-dialog.Dialog.alert). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'alert(message, options)' - fullName: alert + fullName: 'alert(message, options)' langs: - typeScript type: method @@ -45,13 +45,13 @@ items: - id: options description: 'Dialog showing options. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' type: - - IAlertOptions + - sp-dialog.IAlertOptions - uid: sp-dialog.ISecondaryDialogProvider.prompt summary: >- - Similar to [Dialog.prompt](xref:sp-dialog.Dialog.prompt). The only difference is that the dialog is + Similar to [Dialog.prompt()](xref:sp-dialog.Dialog.prompt). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'prompt(message, options)' - fullName: prompt + fullName: 'prompt(message, options)' langs: - typeScript type: method @@ -71,13 +71,14 @@ items: Dialog showing options. The confirmOpen option will be ignored. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. type: - - IPromptOptions + - sp-dialog.IPromptOptions - uid: sp-dialog.ISecondaryDialogProvider.show summary: >- - Similar to [BaseDialog.show](xref:sp-dialog.BaseDialog.show). The dialog to show is passed in as parameter - and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + Similar to [BaseDialog.show()](xref:sp-dialog.BaseDialog.show). The dialog to show is passed in as + parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise + rejects. name: 'show(dialog, options)' - fullName: show + fullName: 'show(dialog, options)' langs: - typeScript type: method @@ -91,10 +92,10 @@ items: - id: dialog description: '' type: - - BaseDialog + - sp-dialog.BaseDialog - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. type: - - IDialogShowOptions + - sp-dialog.IDialogShowOptions diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 111693a9..fd893d62 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -15,15 +15,15 @@ items: type: class package: sp-dynamic-data children: - - sp-dynamic-data.DynamicDataReference.constructor + - sp-dynamic-data.DynamicDataReference.(constructor) - sp-dynamic-data.DynamicDataReference.property - sp-dynamic-data.DynamicDataReference.propertyPath - sp-dynamic-data.DynamicDataReference.reference - sp-dynamic-data.DynamicDataReference.sourceId - - uid: sp-dynamic-data.DynamicDataReference.constructor - summary: 'Constructs a new instance of the [DynamicDataReference](xref:sp-dynamic-data.DynamicDataReference) class' - name: constructor(reference) - fullName: constructor + - uid: sp-dynamic-data.DynamicDataReference.(constructor) + summary: Constructs a new instance of the `DynamicDataReference` class + name: (constructor)(reference) + fullName: (constructor)(reference) langs: - typeScript type: constructor diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index d14c71a7..5d0f7191 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -24,7 +24,7 @@ items: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: type: - - IDynamicDataPropertyValueMetadataCollection + - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue summary: Sample value of a property name: sampleValue diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 36353190..238d16e0 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -25,7 +25,7 @@ items: If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. isPreview: true name: allowedEvents() - fullName: allowedEvents + fullName: allowedEvents() langs: - typeScript type: method @@ -40,7 +40,7 @@ items: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. name: getAnnotatedPropertyValue(propertyId) - fullName: getAnnotatedPropertyValue + fullName: getAnnotatedPropertyValue(propertyId) langs: - typeScript type: method @@ -58,7 +58,7 @@ items: - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions summary: Returns all the property definitions that the DataSource will provide. name: getPropertyDefinitions() - fullName: getPropertyDefinitions + fullName: getPropertyDefinitions() langs: - typeScript type: method @@ -72,7 +72,7 @@ items: summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' name: getPropertyValue(propertyId) - fullName: getPropertyValue + fullName: getPropertyValue(propertyId) langs: - typeScript type: method @@ -96,7 +96,7 @@ items: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. isPreview: true name: 'sendEvent(eventName, data)' - fullName: sendEvent + fullName: 'sendEvent(eventName, data)' langs: - typeScript type: method diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 2e07d2e0..b39f1ad7 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -10,7 +10,7 @@ items: - typeScript type: interface extends: - - IDynamicDataPropertyMetadata + - sp-dynamic-data.IDynamicDataPropertyMetadata package: sp-dynamic-data children: - sp-dynamic-data.IDynamicDataPropertyDefinition.id diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 605dfd70..05a2f8e3 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -8,7 +8,7 @@ items: - typeScript type: interface extends: - - IDynamicDataPropertyMetadata + - sp-dynamic-data.IDynamicDataPropertyMetadata package: sp-dynamic-data children: - sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata @@ -23,4 +23,4 @@ items: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: type: - - IDynamicDataPropertyValueMetadataCollection + - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index 1d94b645..b0d80744 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -17,6 +17,7 @@ items: For example: + ``` case 1: With simple values @@ -78,25 +79,3 @@ items: - typeScript type: interface package: sp-dynamic-data - children: - - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection.__index - - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection.__index - summary: >- - Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata - describing the 'key' and its value. - name: __index(key) - fullName: __index - langs: - - typeScript - type: method - syntax: - content: '[key: string]: IDynamicDataPropertyValueMetadata;' - return: - type: - - IDynamicDataPropertyValueMetadata - description: '' - parameters: - - id: key - description: '' - type: - - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 0b350b5c..922f0d15 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -15,9 +15,9 @@ items: - sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue - sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions - sp-dynamic-data.IDynamicDataSource.getPropertyValue + - sp-dynamic-data.IDynamicDataSource.sendEvent - sp-dynamic-data.IDynamicDataSource.id - sp-dynamic-data.IDynamicDataSource.metadata - - sp-dynamic-data.IDynamicDataSource.sendEvent - uid: sp-dynamic-data.IDynamicDataSource.allowedEvents summary: >- Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source @@ -27,7 +27,7 @@ items: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. isPreview: true name: allowedEvents() - fullName: allowedEvents + fullName: allowedEvents() langs: - typeScript type: method @@ -42,7 +42,7 @@ items: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. name: getAnnotatedPropertyValue(propertyId) - fullName: getAnnotatedPropertyValue + fullName: getAnnotatedPropertyValue(propertyId) langs: - typeScript type: method @@ -50,7 +50,7 @@ items: content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' return: type: - - IDynamicDataAnnotatedPropertyValue + - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue description: '' parameters: - id: propertyId @@ -62,7 +62,7 @@ items: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. name: getPropertyDefinitions() - fullName: getPropertyDefinitions + fullName: getPropertyDefinitions() langs: - typeScript type: method @@ -77,7 +77,7 @@ items: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. name: getPropertyValue(propertyId) - fullName: getPropertyValue + fullName: getPropertyValue(propertyId) langs: - typeScript type: method @@ -92,30 +92,6 @@ items: description: '' type: - string - - uid: sp-dynamic-data.IDynamicDataSource.id - summary: Id of the Dynamic Data Source. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'id: string;' - return: - type: - - string - - uid: sp-dynamic-data.IDynamicDataSource.metadata - summary: Metadata of the Dynamic Data Source. - name: metadata - fullName: metadata - langs: - - typeScript - type: property - syntax: - content: 'metadata: IDynamicDataSourceMetadata;' - return: - type: - - IDynamicDataSourceMetadata - uid: sp-dynamic-data.IDynamicDataSource.sendEvent summary: >- If defined, enables the consumer to send data to the associated dynamic data source. Then source can act @@ -125,7 +101,7 @@ items: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. isPreview: true name: 'sendEvent(eventName, data)' - fullName: sendEvent + fullName: 'sendEvent(eventName, data)' langs: - typeScript type: method @@ -144,3 +120,27 @@ items: description: Data to be sent to the dynamic data source. type: - any + - uid: sp-dynamic-data.IDynamicDataSource.id + summary: Id of the Dynamic Data Source. + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id: string;' + return: + type: + - string + - uid: sp-dynamic-data.IDynamicDataSource.metadata + summary: Metadata of the Dynamic Data Source. + name: metadata + fullName: metadata + langs: + - typeScript + type: property + syntax: + content: 'metadata: IDynamicDataSourceMetadata;' + return: + type: + - sp-dynamic-data.IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 14626c02..59cc70cb 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -4,14 +4,14 @@ items: summary: The base class for all client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the BaseExtension class. + create subclasses that extend the `BaseExtension` class. name: BaseExtension fullName: BaseExtension langs: - typeScript type: class extends: - - BaseComponent + - sp-component-base.BaseComponent package: sp-extension-base children: - sp-extension-base.BaseExtension.context @@ -32,11 +32,11 @@ items: content: 'protected readonly context: ExtensionContext;' return: type: - - ExtensionContext + - sp-extension-base.ExtensionContext - uid: sp-extension-base.BaseExtension.onInit summary: This event method is called when the client-side extension is first activated on the page. name: onInit() - fullName: onInit + fullName: onInit() langs: - typeScript type: method diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 2892d5d0..4df3a4aa 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -4,12 +4,12 @@ items: summary: The base class for context objects for client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the ExtensionContext class. + create subclasses that extend the `ExtensionContext` class. name: ExtensionContext fullName: ExtensionContext langs: - typeScript type: class extends: - - BaseComponentContext + - sp-component-base.BaseComponentContext package: sp-extension-base diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 99a55b9d..1a35c68c 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -18,9 +18,6 @@ items: - sp-http.AadTokenProvider - sp-http.AadTokenProviderFactory - sp-http.DigestCache - - sp-http.GraphHttpClient - - sp-http.GraphHttpClientConfiguration - - sp-http.GraphHttpClientResponse - sp-http.GraphRequest - sp-http.HttpClient - sp-http.HttpClientConfiguration @@ -28,9 +25,9 @@ items: - sp-http.IAadHttpClientConfiguration - sp-http.IAadHttpClientConfigurations - sp-http.IAadHttpClientOptions + - sp-http.IAadTokenProvider + - sp-http.IAadTokenProviderConfiguration - sp-http.IDigestCache - - sp-http.IGraphHttpClientConfiguration - - sp-http.IGraphHttpClientConfigurations - sp-http.IGraphHttpClientOptions - sp-http.IHttpClientConfiguration - sp-http.IHttpClientConfigurations @@ -43,6 +40,7 @@ items: - sp-http.ISPHttpClientConfiguration - sp-http.ISPHttpClientConfigurations - sp-http.ISPHttpClientOptions + - sp-http.ITokenAcquisitionEventArgs - sp-http.MSGraphClient - sp-http.MSGraphClientFactory - sp-http.ODataVersion @@ -67,12 +65,6 @@ references: name: AadTokenProviderFactory - uid: sp-http.DigestCache name: DigestCache - - uid: sp-http.GraphHttpClient - name: GraphHttpClient - - uid: sp-http.GraphHttpClientConfiguration - name: GraphHttpClientConfiguration - - uid: sp-http.GraphHttpClientResponse - name: GraphHttpClientResponse - uid: sp-http.GraphRequest name: GraphRequest - uid: sp-http.HttpClient @@ -87,12 +79,12 @@ references: name: IAadHttpClientConfigurations - uid: sp-http.IAadHttpClientOptions name: IAadHttpClientOptions + - uid: sp-http.IAadTokenProvider + name: IAadTokenProvider + - uid: sp-http.IAadTokenProviderConfiguration + name: IAadTokenProviderConfiguration - uid: sp-http.IDigestCache name: IDigestCache - - uid: sp-http.IGraphHttpClientConfiguration - name: IGraphHttpClientConfiguration - - uid: sp-http.IGraphHttpClientConfigurations - name: IGraphHttpClientConfigurations - uid: sp-http.IGraphHttpClientOptions name: IGraphHttpClientOptions - uid: sp-http.IHttpClientConfiguration @@ -117,6 +109,8 @@ references: name: ISPHttpClientConfigurations - uid: sp-http.ISPHttpClientOptions name: ISPHttpClientOptions + - uid: sp-http.ITokenAcquisitionEventArgs + name: ITokenAcquisitionEventArgs - uid: sp-http.MSGraphClient name: MSGraphClient - uid: sp-http.MSGraphClientFactory diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index b199fa82..a49e37ed 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -15,15 +15,15 @@ items: type: class package: sp-http children: - - sp-http.AadHttpClient.constructor + - sp-http.AadHttpClient.(constructor) - sp-http.AadHttpClient.configurations - sp-http.AadHttpClient.fetch - sp-http.AadHttpClient.get - sp-http.AadHttpClient.post - - uid: sp-http.AadHttpClient.constructor - summary: 'Constructs a new instance of the [AadHttpClient](xref:sp-http.AadHttpClient) class' - name: 'constructor(serviceScope, resourceEndpoint, options)' - fullName: constructor + - uid: sp-http.AadHttpClient.(constructor) + summary: Constructs a new instance of the `AadHttpClient` class + name: '(constructor)(serviceScope, resourceEndpoint, options)' + fullName: '(constructor)(serviceScope, resourceEndpoint, options)' langs: - typeScript type: constructor @@ -33,7 +33,7 @@ items: - id: serviceScope description: The service scope is needed to retrieve some of the class's internal components. type: - - ServiceScope + - sp-core-library.ServiceScope - id: resourceEndpoint description: '' type: @@ -41,7 +41,7 @@ items: - id: options description: Configuration options for the request to get an access token. type: - - IAadHttpClientOptions + - sp-http.IAadHttpClientOptions - uid: sp-http.AadHttpClient.configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. name: configurations @@ -53,7 +53,7 @@ items: content: 'static readonly configurations: IAadHttpClientConfigurations;' return: type: - - IAadHttpClientConfigurations + - sp-http.IAadHttpClientConfigurations - uid: sp-http.AadHttpClient.fetch summary: Performs a REST service call. remarks: >- @@ -61,7 +61,7 @@ items: HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ name: 'fetch(url, configuration, options)' - fullName: fetch + fullName: 'fetch(url, configuration, options)' langs: - typeScript type: method @@ -83,15 +83,15 @@ items: Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. type: - - AadHttpClientConfiguration + - sp-http.AadHttpClientConfiguration - id: options description: Additional options that affect the request. type: - - IHttpClientOptions + - sp-http.IHttpClientOptions - uid: sp-http.AadHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' - fullName: get + fullName: 'get(url, configuration, options)' langs: - typeScript type: method @@ -113,15 +113,15 @@ items: Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. type: - - AadHttpClientConfiguration + - sp-http.AadHttpClientConfiguration - id: options description: Additional options that affect the request. type: - - IHttpClientOptions + - sp-http.IHttpClientOptions - uid: sp-http.AadHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: post + fullName: 'post(url, configuration, options)' langs: - typeScript type: method @@ -143,8 +143,8 @@ items: Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. type: - - AadHttpClientConfiguration + - sp-http.AadHttpClientConfiguration - id: options description: Additional options that affect the request. type: - - IHttpClientOptions + - sp-http.IHttpClientOptions diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 7b2a1a1d..f859198f 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -13,20 +13,20 @@ items: - typeScript type: class extends: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration implements: - - IAadHttpClientConfiguration + - sp-http.IAadHttpClientConfiguration package: sp-http children: - - sp-http.AadHttpClientConfiguration.constructor + - sp-http.AadHttpClientConfiguration.(constructor) - sp-http.AadHttpClientConfiguration.flags - sp-http.AadHttpClientConfiguration.overrideWith - - uid: sp-http.AadHttpClientConfiguration.constructor + - uid: sp-http.AadHttpClientConfiguration.(constructor) summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: 'constructor(flags, overrideFlags)' - fullName: constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -36,11 +36,11 @@ items: - id: flags description: '' type: - - IAadHttpClientConfiguration + - sp-http.IAadHttpClientConfiguration - id: overrideFlags description: '' type: - - IAadHttpClientConfiguration + - sp-http.IAadHttpClientConfiguration - uid: sp-http.AadHttpClientConfiguration.flags name: flags fullName: flags @@ -51,10 +51,10 @@ items: content: 'protected flags: IAadHttpClientConfiguration;' return: type: - - IAadHttpClientConfiguration + - sp-http.IAadHttpClientConfiguration - uid: sp-http.AadHttpClientConfiguration.overrideWith name: overrideWith(sourceFlags) - fullName: overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method @@ -64,10 +64,10 @@ items: overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; return: type: - - AadHttpClientConfiguration + - sp-http.AadHttpClientConfiguration description: '' parameters: - id: sourceFlags description: '' type: - - IAadHttpClientConfiguration + - sp-http.IAadHttpClientConfiguration diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index e15b8204..4b3c4f0e 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -6,7 +6,7 @@ items: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the AadHttpClientFactory class. + create subclasses that extend the `AadHttpClientFactory` class. name: AadHttpClientFactory fullName: AadHttpClientFactory langs: @@ -21,7 +21,7 @@ items: Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. name: getClient(resourceEndpoint) - fullName: getClient + fullName: getClient(resourceEndpoint) langs: - typeScript type: method diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 34c78f00..2ec27f72 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -12,14 +12,14 @@ items: The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the AadTokenProvider class. + create subclasses that extend the `AadTokenProvider` class. name: AadTokenProvider fullName: AadTokenProvider langs: - typeScript type: class implements: - - IAadTokenProvider + - sp-http.IAadTokenProvider package: sp-http children: - sp-http.AadTokenProvider.getToken @@ -29,24 +29,28 @@ items: Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. The OAuth2 token should not be cached by the caller since it is already cached by the method itself. - name: getToken(resourceEndpoint) - fullName: getToken + name: 'getToken(resourceEndpoint, useCachedToken)' + fullName: 'getToken(resourceEndpoint, useCachedToken)' langs: - typeScript type: method syntax: - content: 'getToken(resourceEndpoint: string): Promise;' + content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' return: type: - Promise description: A promise that will be fullfiled with the token or that will reject with an error message parameters: - id: resourceEndpoint - description: >- - the resource for which the token should be obtained An example of a resourceEndpoint would be - https://graph.microsoft.com + description: the resource for which the token should be obtained type: - string + - id: useCachedToken + description: >- + Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would + be https://graph.microsoft.com + type: + - boolean - uid: sp-http.AadTokenProvider.tokenAcquisitionEvent summary: Notifies the developer when Token Acquisition requires user action. name: tokenAcquisitionEvent diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index a11ac1fd..368e0ff1 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -16,7 +16,7 @@ items: Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. name: getTokenProvider() - fullName: getTokenProvider + fullName: getTokenProvider() langs: - typeScript type: method diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 54043d7b..eb2766fb 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -16,19 +16,19 @@ items: - typeScript type: class implements: - - IDigestCache + - sp-http.IDigestCache package: sp-http children: - - sp-http.DigestCache.constructor + - sp-http.DigestCache.(constructor) - sp-http.DigestCache.addDigestToCache - sp-http.DigestCache.clearAllDigests - sp-http.DigestCache.clearDigest - sp-http.DigestCache.fetchDigest - sp-http.DigestCache.serviceKey - - uid: sp-http.DigestCache.constructor - summary: 'Constructs a new instance of the [DigestCache](xref:sp-http.DigestCache) class' - name: constructor(serviceScope) - fullName: constructor + - uid: sp-http.DigestCache.(constructor) + summary: Constructs a new instance of the `DigestCache` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -38,14 +38,14 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-http.DigestCache.addDigestToCache summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - fullName: addDigestToCache + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' langs: - typeScript type: method @@ -76,7 +76,7 @@ items: - uid: sp-http.DigestCache.clearAllDigests summary: Clears all values from the cache. name: clearAllDigests() - fullName: clearAllDigests + fullName: clearAllDigests() langs: - typeScript type: method @@ -91,7 +91,7 @@ items: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. name: clearDigest(webUrl) - fullName: clearDigest + fullName: clearDigest(webUrl) langs: - typeScript type: method @@ -112,7 +112,7 @@ items: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. name: fetchDigest(webUrl) - fullName: fetchDigest + fullName: fetchDigest(webUrl) langs: - typeScript type: method diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index ecc3f4df..e1e26fb9 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -8,14 +8,13 @@ items: fullName: GraphRequest langs: - typeScript - type: class + type: interface package: sp-http children: - - sp-http.GraphRequest.constructor - sp-http.GraphRequest._headers - sp-http.GraphRequest._responseType - sp-http.GraphRequest.buildFullUrl - - sp-http.GraphRequest.config + - sp-http.GraphRequest.constructor - sp-http.GraphRequest.count - sp-http.GraphRequest.create - sp-http.GraphRequest.del @@ -39,26 +38,9 @@ items: - sp-http.GraphRequest.skipToken - sp-http.GraphRequest.top - sp-http.GraphRequest.update - - sp-http.GraphRequest.urlComponents - sp-http.GraphRequest.version - - uid: sp-http.GraphRequest.constructor - summary: 'Constructs a new instance of the [GraphRequest](xref:sp-http.GraphRequest) class' - name: 'constructor(config, path)' - fullName: constructor - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(config: Options, path: string);' - parameters: - - id: config - description: '' - type: - - Options - - id: path - description: '' - type: - - string + - sp-http.GraphRequest.config + - sp-http.GraphRequest.urlComponents - uid: sp-http.GraphRequest._headers name: _headers fullName: _headers @@ -66,7 +48,10 @@ items: - typeScript type: property syntax: - content: '_headers:' + content: |- + _headers: { + [key: string]: string | number; + }; return: type: - |- @@ -86,7 +71,7 @@ items: - string - uid: sp-http.GraphRequest.buildFullUrl name: buildFullUrl() - fullName: buildFullUrl + fullName: buildFullUrl() langs: - typeScript type: method @@ -96,28 +81,38 @@ items: type: - string description: '' - - uid: sp-http.GraphRequest.config - name: config - fullName: config + - uid: sp-http.GraphRequest.constructor + name: 'constructor(config, path)' + fullName: 'constructor(config, path)' langs: - typeScript - type: property + type: method syntax: - content: 'config: Options;' + content: 'constructor(config: Options, path: string): IGraphRequest;' return: type: - - Options + - IGraphRequest + description: '' + parameters: + - id: config + description: '' + type: + - Options + - id: path + description: '' + type: + - string - uid: sp-http.GraphRequest.count name: count(count) - fullName: count + fullName: count(count) langs: - typeScript type: method syntax: - content: 'count(count: boolean): GraphRequest;' + content: 'count(count: boolean): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: count @@ -126,7 +121,7 @@ items: - boolean - uid: sp-http.GraphRequest.create name: 'create(content, callback)' - fullName: create + fullName: 'create(content, callback)' langs: - typeScript type: method @@ -147,7 +142,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.del name: del(callback) - fullName: del + fullName: del(callback) langs: - typeScript type: method @@ -164,7 +159,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.delete name: delete(callback) - fullName: delete + fullName: delete(callback) langs: - typeScript type: method @@ -181,15 +176,15 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.expand name: expand(properties) - fullName: expand + fullName: expand(properties) langs: - typeScript type: method syntax: - content: 'expand(properties: string | string[]): GraphRequest;' + content: 'expand(properties: string | string[]): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: properties @@ -198,15 +193,15 @@ items: - 'string | string[]' - uid: sp-http.GraphRequest.filter name: filter(filterStr) - fullName: filter + fullName: filter(filterStr) langs: - typeScript type: method syntax: - content: 'filter(filterStr: string): GraphRequest;' + content: 'filter(filterStr: string): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: filterStr @@ -215,7 +210,7 @@ items: - string - uid: sp-http.GraphRequest.get name: get(callback) - fullName: get + fullName: get(callback) langs: - typeScript type: method @@ -232,7 +227,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.getStream name: getStream(callback) - fullName: getStream + fullName: getStream(callback) langs: - typeScript type: method @@ -249,7 +244,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.header name: 'header(headerKey, headerValue)' - fullName: header + fullName: 'header(headerKey, headerValue)' langs: - typeScript type: method @@ -270,7 +265,7 @@ items: - string - uid: sp-http.GraphRequest.headers name: headers(headers) - fullName: headers + fullName: headers(headers) langs: - typeScript type: method @@ -293,15 +288,15 @@ items: } - uid: sp-http.GraphRequest.orderby name: orderby(properties) - fullName: orderby + fullName: orderby(properties) langs: - typeScript type: method syntax: - content: 'orderby(properties: string | string[]): GraphRequest;' + content: 'orderby(properties: string | string[]): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: properties @@ -310,7 +305,7 @@ items: - 'string | string[]' - uid: sp-http.GraphRequest.parsePath name: parsePath(rawPath) - fullName: parsePath + fullName: parsePath(rawPath) langs: - typeScript type: method @@ -327,7 +322,7 @@ items: - string - uid: sp-http.GraphRequest.patch name: 'patch(content, callback)' - fullName: patch + fullName: 'patch(content, callback)' langs: - typeScript type: method @@ -348,7 +343,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.post name: 'post(content, callback)' - fullName: post + fullName: 'post(content, callback)' langs: - typeScript type: method @@ -369,7 +364,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.put name: 'put(content, callback)' - fullName: put + fullName: 'put(content, callback)' langs: - typeScript type: method @@ -390,7 +385,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.putStream name: 'putStream(stream, callback)' - fullName: putStream + fullName: 'putStream(stream, callback)' langs: - typeScript type: method @@ -411,7 +406,7 @@ items: - GraphRequestCallback - uid: sp-http.GraphRequest.query name: query(queryDictionaryOrString) - fullName: query + fullName: query(queryDictionaryOrString) langs: - typeScript type: method @@ -419,10 +414,10 @@ items: content: |- query(queryDictionaryOrString: string | { [key: string]: string | number; - }): GraphRequest; + }): IGraphRequest; return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: queryDictionaryOrString @@ -434,15 +429,15 @@ items: } - uid: sp-http.GraphRequest.responseType name: responseType(responseType) - fullName: responseType + fullName: responseType(responseType) langs: - typeScript type: method syntax: - content: 'responseType(responseType: string): GraphRequest;' + content: 'responseType(responseType: string): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: responseType @@ -451,15 +446,15 @@ items: - string - uid: sp-http.GraphRequest.select name: select(properties) - fullName: select + fullName: select(properties) langs: - typeScript type: method syntax: - content: 'select(properties: string | string[]): GraphRequest;' + content: 'select(properties: string | string[]): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: properties @@ -468,15 +463,15 @@ items: - 'string | string[]' - uid: sp-http.GraphRequest.skip name: skip(n) - fullName: skip + fullName: skip(n) langs: - typeScript type: method syntax: - content: 'skip(n: number): GraphRequest;' + content: 'skip(n: number): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: 'n' @@ -485,15 +480,15 @@ items: - number - uid: sp-http.GraphRequest.skipToken name: skipToken(token) - fullName: skipToken + fullName: skipToken(token) langs: - typeScript type: method syntax: - content: 'skipToken(token: string): GraphRequest;' + content: 'skipToken(token: string): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: token @@ -502,15 +497,15 @@ items: - string - uid: sp-http.GraphRequest.top name: top(n) - fullName: top + fullName: top(n) langs: - typeScript type: method syntax: - content: 'top(n: number): GraphRequest;' + content: 'top(n: number): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: 'n' @@ -519,7 +514,7 @@ items: - number - uid: sp-http.GraphRequest.update name: 'update(content, callback)' - fullName: update + fullName: 'update(content, callback)' langs: - typeScript type: method @@ -538,31 +533,42 @@ items: description: '' type: - GraphRequestCallback - - uid: sp-http.GraphRequest.urlComponents - name: urlComponents - fullName: urlComponents - langs: - - typeScript - type: property - syntax: - content: 'urlComponents: URLComponents;' - return: - type: - - URLComponents - uid: sp-http.GraphRequest.version name: version(v) - fullName: version + fullName: version(v) langs: - typeScript type: method syntax: - content: 'version(v: string): GraphRequest;' + content: 'version(v: string): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: v description: '' type: - string + - uid: sp-http.GraphRequest.config + name: config + fullName: config + langs: + - typeScript + type: property + syntax: + content: 'config: Options;' + return: + type: + - Options + - uid: sp-http.GraphRequest.urlComponents + name: urlComponents + fullName: urlComponents + langs: + - typeScript + type: property + syntax: + content: 'urlComponents: URLComponents;' + return: + type: + - URLComponents diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 45b927d8..901a5a24 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -10,16 +10,16 @@ items: type: class package: sp-http children: - - sp-http.HttpClient.constructor + - sp-http.HttpClient.(constructor) - sp-http.HttpClient.configurations - sp-http.HttpClient.fetch - sp-http.HttpClient.get - sp-http.HttpClient.post - sp-http.HttpClient.serviceKey - - uid: sp-http.HttpClient.constructor - summary: 'Constructs a new instance of the [HttpClient](xref:sp-http.HttpClient) class' - name: constructor(serviceScope) - fullName: constructor + - uid: sp-http.HttpClient.(constructor) + summary: Constructs a new instance of the `HttpClient` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -29,7 +29,7 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-http.HttpClient.configurations summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. name: configurations @@ -41,7 +41,7 @@ items: content: 'static readonly configurations: IHttpClientConfigurations;' return: type: - - IHttpClientConfigurations + - sp-http.IHttpClientConfigurations - uid: sp-http.HttpClient.fetch summary: Performs a REST service call. remarks: >- @@ -49,7 +49,7 @@ items: HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ name: 'fetch(url, configuration, options)' - fullName: fetch + fullName: 'fetch(url, configuration, options)' langs: - typeScript type: method @@ -75,15 +75,15 @@ items: determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration - id: options description: additional options that affect the request type: - - IHttpClientOptions + - sp-http.IHttpClientOptions - uid: sp-http.HttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' - fullName: get + fullName: 'get(url, configuration, options)' langs: - typeScript type: method @@ -109,15 +109,15 @@ items: determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration - id: options description: additional options that affect the request type: - - IHttpClientOptions + - sp-http.IHttpClientOptions - uid: sp-http.HttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: post + fullName: 'post(url, configuration, options)' langs: - typeScript type: method @@ -143,11 +143,11 @@ items: determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration - id: options description: additional options that affect the request type: - - IHttpClientOptions + - sp-http.IHttpClientOptions - uid: sp-http.HttpClient.serviceKey summary: The service key for HttpClient. name: serviceKey diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index df3da5ba..33258cc7 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -13,19 +13,19 @@ items: - typeScript type: class implements: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration package: sp-http children: - - sp-http.HttpClientConfiguration.constructor + - sp-http.HttpClientConfiguration.(constructor) - sp-http.HttpClientConfiguration.flags - sp-http.HttpClientConfiguration.initializeFlags - sp-http.HttpClientConfiguration.overrideWith - - uid: sp-http.HttpClientConfiguration.constructor + - uid: sp-http.HttpClientConfiguration.(constructor) summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: 'constructor(flags, overrideFlags)' - fullName: constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -35,11 +35,11 @@ items: - id: flags description: '' type: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration - id: overrideFlags description: '' type: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration - uid: sp-http.HttpClientConfiguration.flags name: flags fullName: flags @@ -50,11 +50,11 @@ items: content: 'protected flags: IHttpClientConfiguration;' return: type: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration - uid: sp-http.HttpClientConfiguration.initializeFlags summary: Child classes should override this method to initialize the flags object. name: initializeFlags() - fullName: initializeFlags + fullName: initializeFlags() langs: - typeScript type: method @@ -69,7 +69,7 @@ items: - uid: sp-http.HttpClientConfiguration.overrideWith summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' name: overrideWith(sourceFlags) - fullName: overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method @@ -79,10 +79,10 @@ items: overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; return: type: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration description: '' parameters: - id: sourceFlags description: '' type: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 4722ff10..07764fc2 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -3,11 +3,11 @@ items: - uid: sp-http.HttpClientResponse summary: The Response subclass returned by methods such as HttpClient.fetch(). remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the HttpClientResponse class. + This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. - This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `HttpClientResponse` class. name: HttpClientResponse fullName: HttpClientResponse langs: @@ -15,6 +15,7 @@ items: type: class implements: - Response + - 'Body ' package: sp-http children: - sp-http.HttpClientResponse.arrayBuffer @@ -34,7 +35,7 @@ items: - uid: sp-http.HttpClientResponse.arrayBuffer summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: arrayBuffer() - fullName: arrayBuffer + fullName: arrayBuffer() langs: - typeScript type: method @@ -47,7 +48,7 @@ items: - uid: sp-http.HttpClientResponse.blob summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: blob() - fullName: blob + fullName: blob() langs: - typeScript type: method @@ -71,7 +72,7 @@ items: - boolean - uid: sp-http.HttpClientResponse.clone name: clone() - fullName: clone + fullName: clone() langs: - typeScript type: method @@ -81,12 +82,12 @@ items: clone(): HttpClientResponse; return: type: - - HttpClientResponse + - sp-http.HttpClientResponse description: '' - uid: sp-http.HttpClientResponse.formData summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: formData() - fullName: formData + fullName: formData() langs: - typeScript type: method @@ -111,7 +112,7 @@ items: - uid: sp-http.HttpClientResponse.json summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: json() - fullName: json + fullName: json() langs: - typeScript type: method @@ -171,7 +172,7 @@ items: - uid: sp-http.HttpClientResponse.text summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: text() - fullName: text + fullName: text() langs: - typeScript type: method diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 35da54d0..1ba5db80 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -8,5 +8,5 @@ items: - typeScript type: interface extends: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration package: sp-http diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 95f41aec..507cd084 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -29,4 +29,4 @@ items: content: 'readonly v1: AadHttpClientConfiguration;' return: type: - - AadHttpClientConfiguration + - sp-http.AadHttpClientConfiguration diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index f7d6b6a1..acd57a7b 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -11,7 +11,10 @@ items: children: - sp-http.IAadHttpClientOptions.configuration - sp-http.IAadHttpClientOptions.tokenProvider + - sp-http.IAadHttpClientOptions.useCachedToken - uid: sp-http.IAadHttpClientOptions.configuration + deprecated: + content: '- AadHttpClient''s configuration cannot be altered' name: configuration fullName: configuration langs: @@ -21,8 +24,10 @@ items: content: 'configuration?: IAadTokenProviderConfiguration;' return: type: - - IAadTokenProviderConfiguration + - sp-http.IAadTokenProviderConfiguration - uid: sp-http.IAadHttpClientOptions.tokenProvider + deprecated: + content: '- AadHttpClient does not support a custom tokenProvider.' name: tokenProvider fullName: tokenProvider langs: @@ -32,4 +37,17 @@ items: content: 'tokenProvider?: IAadTokenProvider;' return: type: - - IAadTokenProvider + - sp-http.IAadTokenProvider + - uid: sp-http.IAadHttpClientOptions.useCachedToken + summary: Allows the developer to specify if cached tokens should be use for the current request. + isPreview: true + name: useCachedToken + fullName: useCachedToken + langs: + - typeScript + type: property + syntax: + content: 'useCachedToken?: boolean;' + return: + type: + - boolean diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml new file mode 100644 index 00000000..937a5a57 --- /dev/null +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -0,0 +1,61 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadTokenProvider + summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. + + + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. + remarks: >- + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some + point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will + switch to MSAL. + name: IAadTokenProvider + fullName: IAadTokenProvider + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IAadTokenProvider.getToken + - sp-http.IAadTokenProvider.tokenAcquisitionEvent + - uid: sp-http.IAadTokenProvider.getToken + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + + The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. + + An example of a resourceEndpoint would be https://sdfpilot.outlook.com + name: 'getToken(resourceEndpoint, useCachedToken)' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + langs: + - typeScript + type: method + syntax: + content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' + return: + type: + - Promise + description: A promise that will be fullfiled with the token or that will reject with an error message + parameters: + - id: resourceEndpoint + description: the resource for which the token should be obtained + type: + - string + - id: useCachedToken + description: Allows the developer to specify if cached tokens should be returned. + type: + - boolean + - uid: sp-http.IAadTokenProvider.tokenAcquisitionEvent + summary: Notifies the developer when Token Acquistion requires user action. + name: tokenAcquisitionEvent + fullName: tokenAcquisitionEvent + langs: + - typeScript + type: event + syntax: + content: 'readonly tokenAcquisitionEvent: SPEvent;' + return: + type: + - SPEvent diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml new file mode 100644 index 00000000..a72b133a --- /dev/null +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -0,0 +1,113 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.IAadTokenProviderConfiguration + summary: Required strings for constructing an AadTokenProvider. + name: IAadTokenProviderConfiguration + fullName: IAadTokenProviderConfiguration + langs: + - typeScript + type: interface + package: sp-http + children: + - sp-http.IAadTokenProviderConfiguration.aadInstanceUrl + - sp-http.IAadTokenProviderConfiguration.aadTenantId + - sp-http.IAadTokenProviderConfiguration.aadUserId + - sp-http.IAadTokenProviderConfiguration.redirectUri + - sp-http.IAadTokenProviderConfiguration.servicePrincipalId + - sp-http.IAadTokenProviderConfiguration.userEmail + - sp-http.IAadTokenProviderConfiguration.userPrincipalName + - uid: sp-http.IAadTokenProviderConfiguration.aadInstanceUrl + summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. + name: aadInstanceUrl + fullName: aadInstanceUrl + langs: + - typeScript + type: property + syntax: + content: 'aadInstanceUrl: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.aadTenantId + summary: The Azure Active Directory's tenant id. + name: aadTenantId + fullName: aadTenantId + langs: + - typeScript + type: property + syntax: + content: 'aadTenantId: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.aadUserId + summary: >- + The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current + user. + name: aadUserId + fullName: aadUserId + langs: + - typeScript + type: property + syntax: + content: 'aadUserId?: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.redirectUri + summary: >- + The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's + application redirect uris. + name: redirectUri + fullName: redirectUri + langs: + - typeScript + type: property + syntax: + content: 'redirectUri: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.servicePrincipalId + summary: The client ID of the developer's Azure Active Directory application. + name: servicePrincipalId + fullName: servicePrincipalId + langs: + - typeScript + type: property + syntax: + content: 'servicePrincipalId: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.userEmail + summary: >- + The user's email address. This will be used to ensure that the current user's identity is used for fetching auth + tokens. + deprecated: + content: This parameter will be ignored. Use userPrincipalName instead + name: userEmail + fullName: userEmail + langs: + - typeScript + type: property + syntax: + content: 'userEmail?: string;' + return: + type: + - string + - uid: sp-http.IAadTokenProviderConfiguration.userPrincipalName + summary: >- + The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth + tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the + current request" error. + name: userPrincipalName + fullName: userPrincipalName + langs: + - typeScript + type: property + syntax: + content: 'userPrincipalName?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 19926f1e..f3e79ff7 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -27,7 +27,7 @@ items: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - fullName: addDigestToCache + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' langs: - typeScript type: method @@ -58,7 +58,7 @@ items: - uid: sp-http.IDigestCache.clearAllDigests summary: Clears all values from the cache. name: clearAllDigests() - fullName: clearAllDigests + fullName: clearAllDigests() langs: - typeScript type: method @@ -73,7 +73,7 @@ items: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. name: clearDigest(webUrl) - fullName: clearDigest + fullName: clearDigest(webUrl) langs: - typeScript type: method @@ -94,7 +94,7 @@ items: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. name: fetchDigest(webUrl) - fullName: fetchDigest + fullName: fetchDigest(webUrl) langs: - typeScript type: method diff --git a/SP-Framework/sp-http/igraphhttpclientoptions.yml b/SP-Framework/sp-http/igraphhttpclientoptions.yml index 7ff35876..0a844bab 100644 --- a/SP-Framework/sp-http/igraphhttpclientoptions.yml +++ b/SP-Framework/sp-http/igraphhttpclientoptions.yml @@ -12,5 +12,5 @@ items: - typeScript type: interface extends: - - IHttpClientOptions + - sp-http.IHttpClientOptions package: sp-http diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 2408db35..66ac6805 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -29,4 +29,4 @@ items: content: 'readonly v1: HttpClientConfiguration;' return: type: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index d8a39fb6..55c85217 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -11,5 +11,5 @@ items: - typeScript type: interface extends: - - RequestInit + - 'RequestInit ' package: sp-http diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 52158dc6..b7407467 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -9,5 +9,5 @@ items: - typeScript type: interface extends: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration package: sp-http diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 3809b060..1a3db2a8 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -29,4 +29,4 @@ items: content: 'readonly v1: SPHttpClientBatchConfiguration;' return: type: - - SPHttpClientBatchConfiguration + - sp-http.SPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 457119a5..01bef9dd 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -11,5 +11,5 @@ items: - typeScript type: interface extends: - - IHttpClientOptions + - sp-http.IHttpClientOptions package: sp-http diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index f395a6be..ec8fdf96 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -8,7 +8,7 @@ items: - typeScript type: interface extends: - - IHttpClientConfiguration + - sp-http.IHttpClientConfiguration package: sp-http children: - sp-http.ISPHttpClientCommonConfiguration.jsonRequest diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 906443c8..e3b218ae 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -8,7 +8,7 @@ items: - typeScript type: interface extends: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration package: sp-http children: - sp-http.ISPHttpClientConfiguration.defaultODataVersion @@ -32,7 +32,7 @@ items: content: 'defaultODataVersion?: ODataVersion;' return: type: - - ODataVersion + - sp-http.ODataVersion - uid: sp-http.ISPHttpClientConfiguration.defaultSameOriginCredentials summary: Automatically configure the RequestInit.credentials. remarks: >- diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index bc3d7ee0..959e5405 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -32,4 +32,4 @@ items: content: 'readonly v1: SPHttpClientConfiguration;' return: type: - - SPHttpClientConfiguration + - sp-http.SPHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 036ab964..a6d91187 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -10,7 +10,7 @@ items: - typeScript type: interface extends: - - IHttpClientOptions + - sp-http.IHttpClientOptions package: sp-http children: - sp-http.ISPHttpClientOptions.webUrl diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml new file mode 100644 index 00000000..41253dc0 --- /dev/null +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -0,0 +1,39 @@ +### YamlMime:UniversalReference +items: + - uid: sp-http.ITokenAcquisitionEventArgs + summary: Represents arguments used for raising a token acquisiton failure event. + name: ITokenAcquisitionEventArgs + fullName: ITokenAcquisitionEventArgs + langs: + - typeScript + type: interface + extends: + - sp-core-library.SPEventArgs + package: sp-http + children: + - sp-http.ITokenAcquisitionEventArgs.message + - sp-http.ITokenAcquisitionEventArgs.redirectUrl + - uid: sp-http.ITokenAcquisitionEventArgs.message + summary: The message returned from ADAL fails to retrieve a token from Azure AD. + name: message + fullName: message + langs: + - typeScript + type: property + syntax: + content: 'message: string;' + return: + type: + - string + - uid: sp-http.ITokenAcquisitionEventArgs.redirectUrl + summary: The url of the page for the end user to interact with Azure AD. + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property + syntax: + content: 'redirectUrl?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index b49270b0..678194c8 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -3,10 +3,6 @@ items: - uid: sp-http.MSGraphClient summary: MSGraphClient is used to perform REST calls against Microsoft Graph. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the MSGraphClient class. - - The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that @@ -15,6 +11,10 @@ items: For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClient` class. name: MSGraphClient fullName: MSGraphClient langs: @@ -33,15 +33,15 @@ items: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript name: 'api(path, config)' - fullName: api + fullName: 'api(path, config)' langs: - typeScript type: method syntax: - content: 'api(path: string, config?: Options): GraphRequest;' + content: 'api(path: string, config?: Options): IGraphRequest;' return: type: - - GraphRequest + - IGraphRequest description: '' parameters: - id: path diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 37cf5d1d..7b4bf1a0 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -6,7 +6,7 @@ items: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the MSGraphClientFactory class. + create subclasses that extend the `MSGraphClientFactory` class. name: MSGraphClientFactory fullName: MSGraphClientFactory langs: @@ -21,7 +21,7 @@ items: Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. name: getClient() - fullName: getClient + fullName: getClient() langs: - typeScript type: method diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 98199dde..45af5730 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -9,16 +9,30 @@ items: type: class package: sp-http children: + - sp-http.ODataVersion.toString - sp-http.ODataVersion.tryParseFromHeaders - sp-http.ODataVersion.v3 - sp-http.ODataVersion.v4 + - uid: sp-http.ODataVersion.toString + summary: 'Returns the "OData-Version" value, for example "4.0".' + name: toString() + fullName: toString() + langs: + - typeScript + type: method + syntax: + content: 'toString(): string;' + return: + type: + - string + description: '' - uid: sp-http.ODataVersion.tryParseFromHeaders summary: Attempt to parse the "OData-Version" header. remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. name: tryParseFromHeaders(headers) - fullName: tryParseFromHeaders + fullName: tryParseFromHeaders(headers) langs: - typeScript type: method @@ -44,7 +58,7 @@ items: content: 'static v3: ODataVersion;' return: type: - - ODataVersion + - sp-http.ODataVersion - uid: sp-http.ODataVersion.v4 summary: Represents version 4.0 for the "OData-Version" header name: v4 @@ -56,4 +70,4 @@ items: content: 'static v4: ODataVersion;' return: type: - - ODataVersion + - sp-http.ODataVersion diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index f1353c2b..f87696cf 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -15,7 +15,7 @@ items: type: class package: sp-http children: - - sp-http.SPHttpClient.constructor + - sp-http.SPHttpClient.(constructor) - sp-http.SPHttpClient.beginBatch - sp-http.SPHttpClient.configurations - sp-http.SPHttpClient.fetch @@ -23,10 +23,10 @@ items: - sp-http.SPHttpClient.getWebUrlFromRequestUrl - sp-http.SPHttpClient.post - sp-http.SPHttpClient.serviceKey - - uid: sp-http.SPHttpClient.constructor - summary: 'Constructs a new instance of the [SPHttpClient](xref:sp-http.SPHttpClient) class' - name: constructor(serviceScope) - fullName: constructor + - uid: sp-http.SPHttpClient.(constructor) + summary: Constructs a new instance of the `SPHttpClient` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -36,12 +36,12 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-http.SPHttpClient.beginBatch summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' isPreview: true name: beginBatch(batchCreationOptions) - fullName: beginBatch + fullName: beginBatch(batchCreationOptions) langs: - typeScript type: method @@ -49,13 +49,13 @@ items: content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' return: type: - - SPHttpClientBatch + - sp-http.SPHttpClientBatch description: 'An [SPHttpClientBatch](xref:sp-http.SPHttpClientBatch) object used to manage the batch operation.' parameters: - id: batchCreationOptions description: '' type: - - ISPHttpClientBatchCreationOptions + - sp-http.ISPHttpClientBatchCreationOptions - uid: sp-http.SPHttpClient.configurations summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. name: configurations @@ -67,7 +67,7 @@ items: content: 'static readonly configurations: ISPHttpClientConfigurations;' return: type: - - ISPHttpClientConfigurations + - sp-http.ISPHttpClientConfigurations - uid: sp-http.SPHttpClient.fetch summary: Perform a REST service call. remarks: >- @@ -93,7 +93,7 @@ items: appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. name: 'fetch(url, configuration, options)' - fullName: fetch + fullName: 'fetch(url, configuration, options)' langs: - typeScript type: method @@ -119,15 +119,15 @@ items: determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - SPHttpClientConfiguration + - sp-http.SPHttpClientConfiguration - id: options description: additional options that affect the request type: - - ISPHttpClientOptions + - sp-http.ISPHttpClientOptions - uid: sp-http.SPHttpClient.get summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' - fullName: get + fullName: 'get(url, configuration, options)' langs: - typeScript type: method @@ -153,11 +153,11 @@ items: determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - SPHttpClientConfiguration + - sp-http.SPHttpClientConfiguration - id: options description: additional options that affect the request type: - - ISPHttpClientOptions + - sp-http.ISPHttpClientOptions - uid: sp-http.SPHttpClient.getWebUrlFromRequestUrl summary: Use a heuristic to infer the base URL for authentication. remarks: >- @@ -173,7 +173,7 @@ items: If the URL cannot be determined, an exception is thrown. name: getWebUrlFromRequestUrl(requestUrl) - fullName: getWebUrlFromRequestUrl + fullName: getWebUrlFromRequestUrl(requestUrl) langs: - typeScript type: method @@ -191,7 +191,7 @@ items: - uid: sp-http.SPHttpClient.post summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: post + fullName: 'post(url, configuration, options)' langs: - typeScript type: method @@ -217,11 +217,11 @@ items: determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - SPHttpClientConfiguration + - sp-http.SPHttpClientConfiguration - id: options description: additional options that affect the request type: - - ISPHttpClientOptions + - sp-http.ISPHttpClientOptions - uid: sp-http.SPHttpClient.serviceKey summary: The service key for SPHttpClient. name: serviceKey diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 6eea0767..0f4f6a9a 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -12,7 +12,7 @@ items: SPHttpClientResponse object for that particular request. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPHttpClientBatch class. + create subclasses that extend the `SPHttpClientBatch` class. isPreview: true name: SPHttpClientBatch fullName: SPHttpClientBatch @@ -38,12 +38,12 @@ items: content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: type: - - ISPHttpClientBatchConfigurations + - sp-http.ISPHttpClientBatchConfigurations - uid: sp-http.SPHttpClientBatch.execute summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). isPreview: true name: execute() - fullName: execute + fullName: execute() langs: - typeScript type: method @@ -74,7 +74,7 @@ items: explicitly. isPreview: true name: 'fetch(url, configuration, options)' - fullName: fetch + fullName: 'fetch(url, configuration, options)' langs: - typeScript type: method @@ -100,16 +100,16 @@ items: determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - SPHttpClientBatchConfiguration + - sp-http.SPHttpClientBatchConfiguration - id: options description: additional options that affect the request type: - - ISPHttpClientBatchOptions + - sp-http.ISPHttpClientBatchOptions - uid: sp-http.SPHttpClientBatch.get summary: 'Calls fetch(), but sets the method to ''GET''.' isPreview: true name: 'get(url, configuration, options)' - fullName: get + fullName: 'get(url, configuration, options)' langs: - typeScript type: method @@ -135,16 +135,16 @@ items: determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - SPHttpClientBatchConfiguration + - sp-http.SPHttpClientBatchConfiguration - id: options description: additional options that affect the request type: - - ISPHttpClientBatchOptions + - sp-http.ISPHttpClientBatchOptions - uid: sp-http.SPHttpClientBatch.post summary: 'Calls fetch(), but sets the method to ''POST''.' isPreview: true name: 'post(url, configuration, options)' - fullName: post + fullName: 'post(url, configuration, options)' langs: - typeScript type: method @@ -170,8 +170,8 @@ items: determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - SPHttpClientBatchConfiguration + - sp-http.SPHttpClientBatchConfiguration - id: options description: additional options that affect the request type: - - ISPHttpClientBatchOptions + - sp-http.ISPHttpClientBatchOptions diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 9e6872b4..ddd08ad4 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -14,21 +14,22 @@ items: - typeScript type: class extends: - - SPHttpClientCommonConfiguration + - sp-http.SPHttpClientCommonConfiguration implements: - - ISPHttpClientBatchConfiguration + - sp-http.ISPHttpClientBatchConfiguration package: sp-http children: - - sp-http.SPHttpClientBatchConfiguration.constructor + - sp-http.SPHttpClientBatchConfiguration.(constructor) - sp-http.SPHttpClientBatchConfiguration.flags - sp-http.SPHttpClientBatchConfiguration.initializeFlags - sp-http.SPHttpClientBatchConfiguration.overrideWith - - uid: sp-http.SPHttpClientBatchConfiguration.constructor + - uid: sp-http.SPHttpClientBatchConfiguration.(constructor) summary: >- Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: 'constructor(flags, overrideFlags)' - fullName: constructor + isPreview: true + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -38,11 +39,11 @@ items: - id: flags description: '' type: - - ISPHttpClientBatchConfiguration + - sp-http.ISPHttpClientBatchConfiguration - id: overrideFlags description: '' type: - - ISPHttpClientBatchConfiguration + - sp-http.ISPHttpClientBatchConfiguration - uid: sp-http.SPHttpClientBatchConfiguration.flags isPreview: true name: flags @@ -54,11 +55,11 @@ items: content: 'protected flags: ISPHttpClientBatchConfiguration;' return: type: - - ISPHttpClientBatchConfiguration + - sp-http.ISPHttpClientBatchConfiguration - uid: sp-http.SPHttpClientBatchConfiguration.initializeFlags isPreview: true name: initializeFlags() - fullName: initializeFlags + fullName: initializeFlags() langs: - typeScript type: method @@ -73,7 +74,7 @@ items: - uid: sp-http.SPHttpClientBatchConfiguration.overrideWith isPreview: true name: overrideWith(sourceFlags) - fullName: overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method @@ -83,10 +84,10 @@ items: overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; return: type: - - SPHttpClientBatchConfiguration + - sp-http.SPHttpClientBatchConfiguration description: '' parameters: - id: sourceFlags description: '' type: - - ISPHttpClientBatchConfiguration + - sp-http.ISPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index b8881f93..7968098f 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -8,24 +8,24 @@ items: - typeScript type: class extends: - - HttpClientConfiguration + - sp-http.HttpClientConfiguration implements: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration package: sp-http children: - - sp-http.SPHttpClientCommonConfiguration.constructor + - sp-http.SPHttpClientCommonConfiguration.(constructor) - sp-http.SPHttpClientCommonConfiguration.flags - sp-http.SPHttpClientCommonConfiguration.initializeFlags - sp-http.SPHttpClientCommonConfiguration.jsonRequest - sp-http.SPHttpClientCommonConfiguration.jsonResponse - sp-http.SPHttpClientCommonConfiguration.overrideWith - - uid: sp-http.SPHttpClientCommonConfiguration.constructor + - uid: sp-http.SPHttpClientCommonConfiguration.(constructor) summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: 'constructor(flags, overrideFlags)' - fullName: constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -35,11 +35,11 @@ items: - id: flags description: '' type: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration - id: overrideFlags description: '' type: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration - uid: sp-http.SPHttpClientCommonConfiguration.flags name: flags fullName: flags @@ -50,10 +50,10 @@ items: content: 'protected flags: ISPHttpClientCommonConfiguration;' return: type: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration - uid: sp-http.SPHttpClientCommonConfiguration.initializeFlags name: initializeFlags() - fullName: initializeFlags + fullName: initializeFlags() langs: - typeScript type: method @@ -111,7 +111,7 @@ items: - boolean - uid: sp-http.SPHttpClientCommonConfiguration.overrideWith name: overrideWith(sourceFlags) - fullName: overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method @@ -121,10 +121,10 @@ items: overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; return: type: - - SPHttpClientCommonConfiguration + - sp-http.SPHttpClientCommonConfiguration description: '' parameters: - id: sourceFlags description: '' type: - - ISPHttpClientCommonConfiguration + - sp-http.ISPHttpClientCommonConfiguration diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index b5cc13a2..d43ed090 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -13,24 +13,24 @@ items: - typeScript type: class extends: - - SPHttpClientCommonConfiguration + - sp-http.SPHttpClientCommonConfiguration implements: - - ISPHttpClientConfiguration + - sp-http.ISPHttpClientConfiguration package: sp-http children: - - sp-http.SPHttpClientConfiguration.constructor + - sp-http.SPHttpClientConfiguration.(constructor) - sp-http.SPHttpClientConfiguration.defaultODataVersion - sp-http.SPHttpClientConfiguration.defaultSameOriginCredentials - sp-http.SPHttpClientConfiguration.flags - sp-http.SPHttpClientConfiguration.initializeFlags - sp-http.SPHttpClientConfiguration.overrideWith - sp-http.SPHttpClientConfiguration.requestDigest - - uid: sp-http.SPHttpClientConfiguration.constructor + - uid: sp-http.SPHttpClientConfiguration.(constructor) summary: >- Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: 'constructor(flags, overrideFlags)' - fullName: constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -40,11 +40,11 @@ items: - id: flags description: '' type: - - ISPHttpClientConfiguration + - sp-http.ISPHttpClientConfiguration - id: overrideFlags description: '' type: - - ISPHttpClientConfiguration + - sp-http.ISPHttpClientConfiguration - uid: sp-http.SPHttpClientConfiguration.defaultODataVersion summary: Automatically configure the "OData-Version" header. remarks: >- @@ -63,7 +63,7 @@ items: content: 'readonly defaultODataVersion: ODataVersion;' return: type: - - ODataVersion + - sp-http.ODataVersion - uid: sp-http.SPHttpClientConfiguration.defaultSameOriginCredentials summary: Automatically configure the RequestInit.credentials. remarks: >- @@ -95,10 +95,10 @@ items: content: 'protected flags: ISPHttpClientConfiguration;' return: type: - - ISPHttpClientConfiguration + - sp-http.ISPHttpClientConfiguration - uid: sp-http.SPHttpClientConfiguration.initializeFlags name: initializeFlags() - fullName: initializeFlags + fullName: initializeFlags() langs: - typeScript type: method @@ -112,7 +112,7 @@ items: description: '' - uid: sp-http.SPHttpClientConfiguration.overrideWith name: overrideWith(sourceFlags) - fullName: overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method @@ -122,13 +122,13 @@ items: overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; return: type: - - SPHttpClientConfiguration + - sp-http.SPHttpClientConfiguration description: '' parameters: - id: sourceFlags description: '' type: - - ISPHttpClientConfiguration + - sp-http.ISPHttpClientConfiguration - uid: sp-http.SPHttpClientConfiguration.requestDigest summary: Automatically provide an "X-RequestDigest" header for authentication. remarks: >- diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index fe0f7092..143c6982 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -12,16 +12,16 @@ items: - typeScript type: class extends: - - HttpClientResponse + - sp-http.HttpClientResponse package: sp-http children: - - sp-http.SPHttpClientResponse.constructor + - sp-http.SPHttpClientResponse.(constructor) - sp-http.SPHttpClientResponse.clone - sp-http.SPHttpClientResponse.correlationId - - uid: sp-http.SPHttpClientResponse.constructor - summary: 'Constructs a new instance of the [SPHttpClientResponse](xref:sp-http.SPHttpClientResponse) class' - name: constructor(response) - fullName: constructor + - uid: sp-http.SPHttpClientResponse.(constructor) + summary: Constructs a new instance of the `SPHttpClientResponse` class + name: (constructor)(response) + fullName: (constructor)(response) langs: - typeScript type: constructor @@ -34,7 +34,7 @@ items: - Response - uid: sp-http.SPHttpClientResponse.clone name: clone() - fullName: clone + fullName: clone() langs: - typeScript type: method @@ -44,7 +44,7 @@ items: clone(): SPHttpClientResponse; return: type: - - SPHttpClientResponse + - sp-http.SPHttpClientResponse description: '' - uid: sp-http.SPHttpClientResponse.correlationId summary: Returns the SharePoint correlation ID. diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 7ee17c74..139a8053 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -8,16 +8,16 @@ items: - typeScript type: class extends: - - SPEventArgs + - sp-core-library.SPEventArgs package: sp-http children: - - sp-http.TokenAcquisitionEventArgs.constructor + - sp-http.TokenAcquisitionEventArgs.(constructor) - sp-http.TokenAcquisitionEventArgs.message - sp-http.TokenAcquisitionEventArgs.redirectUrl - - uid: sp-http.TokenAcquisitionEventArgs.constructor - summary: 'Constructs a new instance of the [TokenAcquisitionEventArgs](xref:sp-http.TokenAcquisitionEventArgs) class' - name: 'constructor(message, redirectUrl)' - fullName: constructor + - uid: sp-http.TokenAcquisitionEventArgs.(constructor) + summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class + name: '(constructor)(message, redirectUrl)' + fullName: '(constructor)(message, redirectUrl)' langs: - typeScript type: constructor diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 925f1d14..feb7d2db 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -13,7 +13,7 @@ items: - typeScript type: class extends: - - BaseExtension + - 'BaseExtension ' package: sp-listview-extensibility children: - sp-listview-extensibility.BaseFieldCustomizer.context @@ -34,10 +34,10 @@ items: content: 'protected readonly context: FieldCustomizerContext;' return: type: - - FieldCustomizerContext + - sp-listview-extensibility.FieldCustomizerContext - uid: sp-listview-extensibility.BaseFieldCustomizer.onDisposeCell name: onDisposeCell(event) - fullName: onDisposeCell + fullName: onDisposeCell(event) langs: - typeScript type: method @@ -51,10 +51,10 @@ items: - id: event description: '' type: - - IFieldCustomizerCellEventParameters + - sp-listview-extensibility.IFieldCustomizerCellEventParameters - uid: sp-listview-extensibility.BaseFieldCustomizer.onRenderCell name: onRenderCell(event) - fullName: onRenderCell + fullName: onRenderCell(event) langs: - typeScript type: method @@ -68,4 +68,4 @@ items: - id: event description: '' type: - - IFieldCustomizerCellEventParameters + - sp-listview-extensibility.IFieldCustomizerCellEventParameters diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index d7a53809..50d67cf7 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -5,18 +5,18 @@ items: This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the BaseListViewCommandSet class. + In the component manifest, the "extensionType" should be set to "ListViewCommandSet". - In the component manifest, the "extensionType" should be set to "ListViewCommandSet". + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseListViewCommandSet` class. name: BaseListViewCommandSet fullName: BaseListViewCommandSet langs: - typeScript type: class extends: - - BaseExtension + - 'BaseExtension ' package: sp-listview-extensibility children: - sp-listview-extensibility.BaseListViewCommandSet.context @@ -38,11 +38,11 @@ items: content: 'readonly context: ListViewCommandSetContext;' return: type: - - ListViewCommandSetContext + - sp-listview-extensibility.ListViewCommandSetContext - uid: sp-listview-extensibility.BaseListViewCommandSet.onExecute summary: 'This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item.' name: onExecute(event) - fullName: onExecute + fullName: onExecute(event) langs: - typeScript type: method @@ -56,14 +56,14 @@ items: - id: event description: '' type: - - IListViewCommandSetExecuteEventParameters + - sp-listview-extensibility.IListViewCommandSetExecuteEventParameters - uid: sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated summary: This event occurs whenever the ListView state changes. remarks: >- This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title. name: onListViewUpdated(event) - fullName: onListViewUpdated + fullName: onListViewUpdated(event) langs: - typeScript type: method @@ -77,11 +77,11 @@ items: - id: event description: '' type: - - IListViewCommandSetListViewUpdatedParameters + - sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters - uid: sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand summary: Returns the command with the given id. Returns undefined if there is not command with the given id. name: tryGetCommand(id) - fullName: tryGetCommand + fullName: tryGetCommand(id) langs: - typeScript type: method @@ -89,7 +89,7 @@ items: content: 'tryGetCommand(id: string): Command;' return: type: - - Command + - sp-listview-extensibility.Command description: '' parameters: - id: id diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 0d636d8f..b59a5268 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -3,15 +3,15 @@ items: - uid: sp-listview-extensibility.ColumnAccessor summary: 'Provides access to a ListView column, which is the visual presentation of a field.' remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the ColumnAccessor class. - - A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a "property".) A "column" is the visual presentation of a field, when displayed by the ListView. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ColumnAccessor` class. name: ColumnAccessor fullName: ColumnAccessor langs: @@ -29,10 +29,10 @@ items: - typeScript type: property syntax: - content: 'readonly field: SPField;' + content: 'abstract readonly field: SPField;' return: type: - - SPField + - sp-page-context.SPField - uid: sp-listview-extensibility.ColumnAccessor.visible summary: Whether to show this column in the list view. This property is read-only. name: visible @@ -41,7 +41,7 @@ items: - typeScript type: property syntax: - content: 'readonly visible: boolean;' + content: 'abstract readonly visible: boolean;' return: type: - boolean diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index f17a0df3..57a02f46 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -6,7 +6,7 @@ items: The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling - [BaseListViewCommandSet.tryGetCommand](xref:sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. name: Command diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 13e168bf..c07a3a0d 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -4,14 +4,14 @@ items: summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the FieldCustomizerContext class. + create subclasses that extend the `FieldCustomizerContext` class. name: FieldCustomizerContext fullName: FieldCustomizerContext langs: - typeScript type: class extends: - - ExtensionContext + - sp-extension-base.ExtensionContext package: sp-listview-extensibility children: - sp-listview-extensibility.FieldCustomizerContext.field @@ -27,7 +27,7 @@ items: content: 'readonly field: SPField;' return: type: - - SPField + - sp-page-context.SPField - uid: sp-listview-extensibility.FieldCustomizerContext.tryGetListView summary: >- If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific @@ -36,7 +36,7 @@ items: Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. name: tryGetListView() - fullName: tryGetListView + fullName: tryGetListView() langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 7b348e02..1e17ebda 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -50,7 +50,7 @@ items: content: 'readonly listItem: ListItemAccessor;' return: type: - - ListItemAccessor + - sp-listview-extensibility.ListItemAccessor - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.userData summary: An implementation defined storage property. remarks: >- diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index e678fab3..e5dac21e 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,7 +1,9 @@ ### YamlMime:UniversalReference items: - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters - summary: 'Parameters for [BaseListViewCommandSet.onExecute](xref:sp-listview-extensibility.BaseListViewCommandSet.onExecute)' + summary: >- + Parameters for + [BaseListViewCommandSet.onExecute()](xref:sp-listview-extensibility.BaseListViewCommandSet.onExecute) name: IListViewCommandSetExecuteEventParameters fullName: IListViewCommandSetExecuteEventParameters langs: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 66586ad4..7f45f249 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -3,7 +3,7 @@ items: - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters summary: >- Parameters for - [BaseListViewCommandSet.onListViewUpdated](xref:sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated) + [BaseListViewCommandSet.onListViewUpdated()](xref:sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated) name: IListViewCommandSetListViewUpdatedParameters fullName: IListViewCommandSetListViewUpdatedParameters langs: diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index d63fa4a7..ba92f66f 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -5,10 +5,6 @@ items: When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the ListItemAccessor class. - - ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and retrieve the current values for those fields. In the future, it may also support validation and editing operations. @@ -17,6 +13,10 @@ items: When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListItemAccessor` class. name: ListItemAccessor fullName: ListItemAccessor langs: @@ -39,7 +39,7 @@ items: - typeScript type: property syntax: - content: 'readonly fields: ReadonlyArray;' + content: 'abstract readonly fields: ReadonlyArray;' return: type: - ReadonlyArray @@ -48,7 +48,7 @@ items: Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. name: getValue(field) - fullName: getValue + fullName: getValue(field) langs: - typeScript type: method @@ -62,13 +62,13 @@ items: - id: field description: '' type: - - SPField + - sp-page-context.SPField - uid: sp-listview-extensibility.ListItemAccessor.getValueByName summary: >- Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. name: getValueByName(internalName) - fullName: getValueByName + fullName: getValueByName(internalName) langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 47e02b01..e4375cd3 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -4,7 +4,7 @@ items: summary: Provides access to a SharePoint ListView control. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the ListViewAccessor class. + create subclasses that extend the `ListViewAccessor` class. name: ListViewAccessor fullName: ListViewAccessor langs: @@ -23,7 +23,7 @@ items: - typeScript type: property syntax: - content: 'readonly columns: ReadonlyArray;' + content: 'abstract readonly columns: ReadonlyArray;' return: type: - ReadonlyArray @@ -44,7 +44,7 @@ items: Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. name: tryGetColumnByName(internalName) - fullName: tryGetColumnByName + fullName: tryGetColumnByName(internalName) langs: - typeScript type: method diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index e1f74809..d30f8cef 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -4,14 +4,14 @@ items: summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the ListViewCommandSetContext class. + create subclasses that extend the `ListViewCommandSetContext` class. name: ListViewCommandSetContext fullName: ListViewCommandSetContext langs: - typeScript type: class extends: - - ExtensionContext + - sp-extension-base.ExtensionContext package: sp-listview-extensibility children: - sp-listview-extensibility.ListViewCommandSetContext.listView @@ -27,7 +27,7 @@ items: content: 'readonly listView: ListViewAccessor;' return: type: - - ListViewAccessor + - sp-listview-extensibility.ListViewAccessor - uid: sp-listview-extensibility.ListViewCommandSetContext.manifest summary: Manifest for the client-side component. name: manifest diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 8742d58b..709c7fe8 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -3,21 +3,21 @@ items: - uid: sp-listview-extensibility.RowAccessor summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the RowAccessor class. - - A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields. A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `RowAccessor` class. name: RowAccessor fullName: RowAccessor langs: - typeScript type: class extends: - - ListItemAccessor + - sp-listview-extensibility.ListItemAccessor package: sp-listview-extensibility diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 7b923352..8e43e00d 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -8,7 +8,7 @@ items: - typeScript type: class extends: - - SPEventArgs + - sp-core-library.SPEventArgs package: sp-listview-extensibility children: - sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index 83c0b9d5..16c9cb49 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -12,6 +12,7 @@ items: - typeScript type: package children: + - sp-odata-types._IODataUserId - sp-odata-types.IODataBasePermission - sp-odata-types.IODataChangeToken - sp-odata-types.IODataContextWebInformation @@ -23,6 +24,8 @@ items: - sp-odata-types.IODataUserCustomAction - sp-odata-types.IODataWeb references: + - uid: sp-odata-types._IODataUserId + name: _IODataUserId - uid: sp-odata-types.IODataBasePermission name: IODataBasePermission - uid: sp-odata-types.IODataChangeToken diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml new file mode 100644 index 00000000..4318c32a --- /dev/null +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -0,0 +1,39 @@ +### YamlMime:UniversalReference +items: + - uid: sp-odata-types._IODataUserId + summary: >- + Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: _IODataUserId + fullName: _IODataUserId + langs: + - typeScript + type: interface + package: sp-odata-types + children: + - sp-odata-types._IODataUserId.NameId + - sp-odata-types._IODataUserId.NameIdIssuer + - uid: sp-odata-types._IODataUserId.NameId + summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' + name: NameId + fullName: NameId + langs: + - typeScript + type: property + syntax: + content: 'NameId: string;' + return: + type: + - string + - uid: sp-odata-types._IODataUserId.NameIdIssuer + summary: 'Example: `"urn:office:idp:activedirectory"`' + name: NameIdIssuer + fullName: NameIdIssuer + langs: + - typeScript + type: property + syntax: + content: 'NameIdIssuer: string;' + return: + type: + - string diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 7751c81f..862fb675 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -59,7 +59,7 @@ items: content: 'CurrentChangeToken: IODataChangeToken;' return: type: - - IODataChangeToken + - sp-odata-types.IODataChangeToken - uid: sp-odata-types.IODataList.Description summary: A description of the List. name: Description diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 744049c4..3524afe6 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -23,7 +23,10 @@ items: - typeScript type: property syntax: - content: 'ContentTypeId:' + content: |- + ContentTypeId: { + StringValue: string; + }; return: type: - |- diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index 0f26a753..4b579165 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -179,7 +179,7 @@ items: content: 'Rights: IODataBasePermission;' return: type: - - IODataBasePermission + - sp-odata-types.IODataBasePermission - uid: sp-odata-types.IODataUserCustomAction.Scope summary: Gets a value that specifies the scope of the custom action. name: Scope diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 80922e7b..296da4fd 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -55,7 +55,7 @@ items: content: 'CurrentChangeToken?: IODataChangeToken;' return: type: - - IODataChangeToken + - sp-odata-types.IODataChangeToken - uid: sp-odata-types.IODataWeb.CustomMasterUrl summary: |- Gets or sets the URL for a custom master page file to apply to the website. diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 7d1bd278..44994052 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -6,7 +6,7 @@ items: application. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the CultureInfo class. + create subclasses that extend the `CultureInfo` class. name: CultureInfo fullName: CultureInfo langs: diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index c5cdfd21..e6a54be5 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -28,7 +28,7 @@ items: content: 'daylightDate: ISPSystemTime;' return: type: - - ISPSystemTime + - sp-page-context.ISPSystemTime - uid: sp-page-context.ISPTimeZoneData.daylightOffset isPreview: true name: daylightOffset @@ -88,7 +88,7 @@ items: content: 'standardDate: ISPSystemTime;' return: type: - - ISPSystemTime + - sp-page-context.ISPSystemTime - uid: sp-page-context.ISPTimeZoneData.standardOffset isPreview: true name: standardOffset diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index a305eec9..13984901 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -14,7 +14,7 @@ items: type: class package: sp-page-context children: - - sp-page-context.PageContext.constructor + - sp-page-context.PageContext.(constructor) - sp-page-context.PageContext.aadInfo - sp-page-context.PageContext.cultureInfo - sp-page-context.PageContext.isInitialized @@ -25,10 +25,10 @@ items: - sp-page-context.PageContext.site - sp-page-context.PageContext.user - sp-page-context.PageContext.web - - uid: sp-page-context.PageContext.constructor - summary: 'Constructs a new instance of the [PageContext](xref:sp-page-context.PageContext) class' - name: constructor(serviceScope) - fullName: constructor + - uid: sp-page-context.PageContext.(constructor) + summary: Constructs a new instance of the `PageContext` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -38,7 +38,7 @@ items: - id: serviceScope description: '' type: - - ServiceScope + - sp-core-library.ServiceScope - uid: sp-page-context.PageContext.aadInfo summary: >- Contextual information for communicating with Azure Active Directory. If the current page doesn't have an @@ -66,7 +66,7 @@ items: content: 'readonly cultureInfo: CultureInfo;' return: type: - - CultureInfo + - sp-page-context.CultureInfo - uid: sp-page-context.PageContext.isInitialized summary: Returns whether the `PageContext` has been initialized. name: isInitialized @@ -153,7 +153,7 @@ items: content: 'readonly site: SPSite;' return: type: - - SPSite + - sp-page-context.SPSite - uid: sp-page-context.PageContext.user summary: >- It provides contextual information for the SharePoint user that is accessing the page. This class is primarily @@ -167,7 +167,7 @@ items: content: 'readonly user: SPUser;' return: type: - - SPUser + - sp-page-context.SPUser - uid: sp-page-context.PageContext.web summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. name: web @@ -179,4 +179,4 @@ items: content: 'readonly web: SPWeb;' return: type: - - SPWeb + - sp-page-context.SPWeb diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 75502ba4..c36406aa 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -3,12 +3,12 @@ items: - uid: sp-page-context.SPField summary: A field represents the data model for a column in SharePoint list view. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPField class. - - This is the client-side equivalent for SharePoint `SPField` class. It is used with the `@microsoft/sp-listview-extensibility` package. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPField` class. name: SPField fullName: SPField langs: @@ -85,7 +85,7 @@ items: content: 'readonly id: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-page-context.SPField.internalName summary: The internal name of the field. This name is usually used to find the field. name: internalName diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 01c234be..4181ea69 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -6,7 +6,7 @@ items: list that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPList class. + create subclasses that extend the `SPList` class. name: SPList fullName: SPList langs: @@ -31,7 +31,7 @@ items: content: 'readonly id: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-page-context.SPList.permissions summary: >- Return the SPPermission object that represents the set of permissions that the current user has for interacting @@ -45,7 +45,7 @@ items: content: 'readonly permissions: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPList.serverRelativeUrl summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 9f4daf53..b9bdb3a3 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -6,7 +6,7 @@ items: list item that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPListItem class. + create subclasses that extend the `SPListItem` class. name: SPListItem fullName: SPListItem langs: diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index ee2f4b51..632d49a8 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -15,7 +15,7 @@ items: type: class package: sp-page-context children: - - sp-page-context.SPPermission.constructor + - sp-page-context.SPPermission.(constructor) - sp-page-context.SPPermission.addAndCustomizePages - sp-page-context.SPPermission.addDelPrivateWebParts - sp-page-context.SPPermission.addListItems @@ -56,10 +56,10 @@ items: - sp-page-context.SPPermission.viewPages - sp-page-context.SPPermission.viewUsageData - sp-page-context.SPPermission.viewVersions - - uid: sp-page-context.SPPermission.constructor - summary: 'Constructs a new instance of the [SPPermission](xref:sp-page-context.SPPermission) class' - name: constructor(value) - fullName: constructor + - uid: sp-page-context.SPPermission.(constructor) + summary: Constructs a new instance of the `SPPermission` class + name: (constructor)(value) + fullName: (constructor)(value) langs: - typeScript type: constructor @@ -69,7 +69,7 @@ items: - id: value description: '' type: - - IODataBasePermission + - sp-odata-types.IODataBasePermission - uid: sp-page-context.SPPermission.addAndCustomizePages summary: >- Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint @@ -83,7 +83,7 @@ items: content: 'static readonly addAndCustomizePages: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.addDelPrivateWebParts summary: Add or remove personal web parts on a web part Page. name: addDelPrivateWebParts @@ -95,7 +95,7 @@ items: content: 'static readonly addDelPrivateWebParts: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.addListItems summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' name: addListItems @@ -107,7 +107,7 @@ items: content: 'static readonly addListItems: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.applyStyleSheets summary: Apply a style sheet (.css file) to the Web site. name: applyStyleSheets @@ -119,7 +119,7 @@ items: content: 'static readonly applyStyleSheets: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.applyThemeAndBorder summary: Apply a theme or borders to the entire Web site. name: applyThemeAndBorder @@ -131,7 +131,7 @@ items: content: 'static readonly applyThemeAndBorder: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.approveItems summary: Approve a minor version of a list item or document. name: approveItems @@ -143,7 +143,7 @@ items: content: 'static readonly approveItems: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.browseDirectories summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. name: browseDirectories @@ -155,7 +155,7 @@ items: content: 'static readonly browseDirectories: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.browserUserInfo summary: View information about users of the Web site. name: browserUserInfo @@ -167,7 +167,7 @@ items: content: 'static readonly browserUserInfo: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.cancelCheckout summary: Discard or check in a document which is checked out to another user. name: cancelCheckout @@ -179,7 +179,7 @@ items: content: 'static readonly cancelCheckout: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.createAlerts summary: Create e-mail alerts. name: createAlerts @@ -191,7 +191,7 @@ items: content: 'static readonly createAlerts: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.createGroups summary: Create a group of users that can be used anywhere within the site collection. name: createGroups @@ -203,7 +203,7 @@ items: content: 'static readonly createGroups: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.createSSCSite summary: Create a Web site using Self-Service Site Creation. name: createSSCSite @@ -215,7 +215,7 @@ items: content: 'static readonly createSSCSite: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.deleteListItems summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' name: deleteListItems @@ -227,7 +227,7 @@ items: content: 'static readonly deleteListItems: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.deleteVersions summary: Delete past versions of a list item or document. name: deleteVersions @@ -239,7 +239,7 @@ items: content: 'static readonly deleteVersions: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.editListItems summary: >- Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and @@ -253,7 +253,7 @@ items: content: 'static readonly editListItems: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.editMyUserInfo summary: 'Allows a user to change his or her user information, such as adding a picture.' name: editMyUserInfo @@ -265,7 +265,7 @@ items: content: 'static readonly editMyUserInfo: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.emptyMask summary: Has no permissions on the Web site. Not available through the user interface. name: emptyMask @@ -277,7 +277,7 @@ items: content: 'static readonly emptyMask: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.enumeratePermissions summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' name: enumeratePermissions @@ -289,7 +289,7 @@ items: content: 'static readonly enumeratePermissions: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.fullMask summary: Has all permissions on the Web site. Not available through the user interface. name: fullMask @@ -301,11 +301,11 @@ items: content: 'static readonly fullMask: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.hasAllPermissions summary: Function for testing whether a given permission mask has all of the requested permissions. name: hasAllPermissions(requestedPerms) - fullName: hasAllPermissions + fullName: hasAllPermissions(requestedPerms) langs: - typeScript type: method @@ -323,7 +323,7 @@ items: - uid: sp-page-context.SPPermission.hasAnyPermissions summary: Function for testing whether a given permission mask has any of the requested permissions. name: hasAnyPermissions(requestedPerms) - fullName: hasAnyPermissions + fullName: hasAnyPermissions(requestedPerms) langs: - typeScript type: method @@ -341,7 +341,7 @@ items: - uid: sp-page-context.SPPermission.hasPermission summary: Function for testing whether a given permission mask has the requested permission. name: hasPermission(requestedPerm) - fullName: hasPermission + fullName: hasPermission(requestedPerm) langs: - typeScript type: method @@ -355,7 +355,7 @@ items: - id: requestedPerm description: The SPPermission object to be compared against the original type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.layoutsPage summary: View the layouts page? name: layoutsPage @@ -367,7 +367,7 @@ items: content: 'static readonly layoutsPage: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.manageAlerts summary: Manage alerts for all users of the Web site. name: manageAlerts @@ -379,7 +379,7 @@ items: content: 'static readonly manageAlerts: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.manageLists summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' name: manageLists @@ -391,7 +391,7 @@ items: content: 'static readonly manageLists: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.managePermissions summary: Create and change permission levels on the Web site and assign permissions to users and groups. name: managePermissions @@ -403,7 +403,7 @@ items: content: 'static readonly managePermissions: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.managePersonalViews summary: 'Create, change, and delete personal views of lists.' name: managePersonalViews @@ -415,7 +415,7 @@ items: content: 'static readonly managePersonalViews: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.manageSubwebs summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' name: manageSubwebs @@ -427,7 +427,7 @@ items: content: 'static readonly manageSubwebs: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.manageWeb summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. remarks: >- @@ -445,7 +445,7 @@ items: content: 'static readonly manageWeb: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.open summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' name: open @@ -457,7 +457,7 @@ items: content: 'static readonly open: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.openItems summary: View the source of documents with server-side file handlers. name: openItems @@ -469,7 +469,7 @@ items: content: 'static readonly openItems: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.updatePersonalWebParts summary: Update web parts to display personalized information. name: updatePersonalWebParts @@ -481,7 +481,7 @@ items: content: 'static readonly updatePersonalWebParts: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.useClientIntegration summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' name: useClientIntegration @@ -493,7 +493,7 @@ items: content: 'static readonly useClientIntegration: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.useRemoteAPIs summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' name: useRemoteAPIs @@ -505,7 +505,7 @@ items: content: 'static readonly useRemoteAPIs: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.value summary: Returns the value of this SPPermission object name: value @@ -517,7 +517,7 @@ items: content: 'readonly value: IODataBasePermission;' return: type: - - IODataBasePermission + - sp-odata-types.IODataBasePermission - uid: sp-page-context.SPPermission.viewFormPages summary: 'View forms, views, and application pages, and enumerate lists.' name: viewFormPages @@ -529,7 +529,7 @@ items: content: 'static readonly viewFormPages: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.viewListItems summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' name: viewListItems @@ -541,7 +541,7 @@ items: content: 'static readonly viewListItems: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.viewPages summary: View pages in a Web site. name: viewPages @@ -553,7 +553,7 @@ items: content: 'static readonly viewPages: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.viewUsageData summary: View reports on Web site usage. name: viewUsageData @@ -565,7 +565,7 @@ items: content: 'static readonly viewUsageData: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPPermission.viewVersions summary: View past versions of a list item or document. name: viewVersions @@ -577,4 +577,4 @@ items: content: 'static readonly viewVersions: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index 63587459..b61046c1 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -6,7 +6,7 @@ items: site collection ("SPSite") that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPSite class. + create subclasses that extend the `SPSite` class. name: SPSite fullName: SPSite langs: @@ -73,7 +73,7 @@ items: content: 'readonly correlationId: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-page-context.SPSite.group summary: >- Contextual information about the O365 Group associated with this site. If there is no O365Group associated with @@ -99,7 +99,7 @@ items: content: 'readonly id: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-page-context.SPSite.isNoScriptEnabled summary: Returns true if isNoScript has been enabled on the SPSite. name: isNoScriptEnabled diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 98213d9c..96f17dc1 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -5,10 +5,6 @@ items: It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula. remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPTimeZone class. - - ``` isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate @@ -19,6 +15,9 @@ items: ``` + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPTimeZone` class. isPreview: true name: SPTimeZone fullName: SPTimeZone @@ -46,7 +45,7 @@ items: content: 'readonly daylightDate: ISPSystemTime;' return: type: - - ISPSystemTime + - sp-page-context.ISPSystemTime - uid: sp-page-context.SPTimeZone.daylightOffset summary: >- Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal @@ -113,7 +112,7 @@ items: content: 'readonly standardDate: ISPSystemTime;' return: type: - - ISPSystemTime + - sp-page-context.ISPSystemTime - uid: sp-page-context.SPTimeZone.standardOffset summary: >- Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 65ace27b..50048e6d 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -6,7 +6,7 @@ items: user that is accessing the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPUser class. + create subclasses that extend the `SPUser` class. name: SPUser fullName: SPUser langs: diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 92084c09..6a65cd99 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -6,7 +6,7 @@ items: site ("SPWeb") that hosts the page. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the SPWeb class. + create subclasses that extend the `SPWeb` class. name: SPWeb fullName: SPWeb langs: @@ -74,7 +74,7 @@ items: content: 'readonly id: Guid;' return: type: - - Guid + - sp-core-library.Guid - uid: sp-page-context.SPWeb.isAppWeb summary: Returns true if this `SPWeb` the container web for an `SPApp`. name: isAppWeb @@ -126,7 +126,7 @@ items: content: 'readonly permissions: SPPermission;' return: type: - - SPPermission + - sp-page-context.SPPermission - uid: sp-page-context.SPWeb.serverRelativeUrl summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 2cc5b82f..30f91500 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -21,7 +21,7 @@ items: - sp-webpart-base.IDynamicDataSharedPropertyFilters - sp-webpart-base.IDynamicDataSharedSourceConfiguration - sp-webpart-base.IDynamicDataSharedSourceFilters - - sp-webpart-base.IPlaceholderSpinnerProps + - sp-webpart-base.IMicrosoftTeams - sp-webpart-base.IPropertyPaneAccessor - sp-webpart-base.IPropertyPaneButtonProps - sp-webpart-base.IPropertyPaneCheckboxProps @@ -34,6 +34,7 @@ items: - sp-webpart-base.IPropertyPaneDropdownCalloutProps - sp-webpart-base.IPropertyPaneDropdownOption - sp-webpart-base.IPropertyPaneDropdownProps + - sp-webpart-base.IPropertyPaneDynamicFieldFilters - sp-webpart-base.IPropertyPaneDynamicFieldProps - sp-webpart-base.IPropertyPaneDynamicFieldSetProps - sp-webpart-base.IPropertyPaneDynamicTextFieldProps @@ -46,6 +47,7 @@ items: - sp-webpart-base.IPropertyPaneSliderProps - sp-webpart-base.IPropertyPaneTextFieldProps - sp-webpart-base.IPropertyPaneToggleProps + - sp-webpart-base.ISDKs - sp-webpart-base.ISerializedServerProcessedData - sp-webpart-base.ISerializedWebPartData - sp-webpart-base.IWebPartContext @@ -73,14 +75,18 @@ items: - sp-webpart-base.WebPartFormFactor - uid: sp-webpart-base.PropertyPaneButton summary: Helper method to create a Button on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneButton(targetProperty, properties)' - fullName: PropertyPaneButton + fullName: 'PropertyPaneButton(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField; return: type: @@ -94,17 +100,21 @@ items: - id: properties description: Strongly typed Button properties. type: - - IPropertyPaneButtonProps + - sp-webpart-base.IPropertyPaneButtonProps - uid: sp-webpart-base.PropertyPaneCheckbox summary: Helper method to create a Checkbox on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneCheckbox(targetProperty, properties)' - fullName: PropertyPaneCheckbox + fullName: 'PropertyPaneCheckbox(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField; return: type: @@ -118,18 +128,22 @@ items: - id: properties description: Strongly typed Checkbox properties. type: - - IPropertyPaneCheckboxProps + - sp-webpart-base.IPropertyPaneCheckboxProps - uid: sp-webpart-base.PropertyPaneChoiceGroup summary: Helper method to create a Choice Group on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - fullName: PropertyPaneChoiceGroup + fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): - IPropertyPaneField; + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; return: type: - IPropertyPaneField @@ -142,7 +156,7 @@ items: - id: properties description: Strongly typed Choice Group properties. type: - - IPropertyPaneChoiceGroupProps + - sp-webpart-base.IPropertyPaneChoiceGroupProps - uid: sp-webpart-base.PropertyPaneCustomField summary: Helper method to create a custom field on the PropertyPane. remarks: >- @@ -150,15 +164,19 @@ items: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. isPreview: true name: PropertyPaneCustomField(properties) - fullName: PropertyPaneCustomField + fullName: PropertyPaneCustomField(properties) langs: - typeScript type: function syntax: content: >- - export function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField; return: type: @@ -168,17 +186,21 @@ items: - id: properties description: Strongly typed Custom field properties. type: - - IPropertyPaneCustomFieldProps + - sp-webpart-base.IPropertyPaneCustomFieldProps - uid: sp-webpart-base.PropertyPaneDropdown summary: Helper method to create a Dropdown on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneDropdown(targetProperty, properties)' - fullName: PropertyPaneDropdown + fullName: 'PropertyPaneDropdown(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField; return: type: @@ -192,18 +214,22 @@ items: - id: properties description: Strongly typed Dropdown properties. type: - - IPropertyPaneDropdownProps + - sp-webpart-base.IPropertyPaneDropdownProps - uid: sp-webpart-base.PropertyPaneDynamicField summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneDynamicField(targetProperty, properties)' - fullName: PropertyPaneDynamicField + fullName: 'PropertyPaneDynamicField(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): - IPropertyPaneField; + export declare function PropertyPaneDynamicField(targetProperty: string, properties: + IPropertyPaneDynamicFieldProps): IPropertyPaneField; return: type: - IPropertyPaneField @@ -216,7 +242,7 @@ items: - id: properties description: '' type: - - IPropertyPaneDynamicFieldProps + - sp-webpart-base.IPropertyPaneDynamicFieldProps - uid: sp-webpart-base.PropertyPaneDynamicFieldSet summary: >- Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data @@ -224,14 +250,18 @@ items: These fields can possibly share the same property based on the associated filters. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: PropertyPaneDynamicFieldSet(properties) - fullName: PropertyPaneDynamicFieldSet + fullName: PropertyPaneDynamicFieldSet(properties) langs: - typeScript type: function syntax: content: >- - export function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): + export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField; return: type: @@ -244,20 +274,22 @@ items: Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields. type: - - IPropertyPaneDynamicFieldSetProps + - sp-webpart-base.IPropertyPaneDynamicFieldSetProps - uid: sp-webpart-base.PropertyPaneDynamicTextField summary: Helper method to create a Dynamic TextField on the PropertyPane. deprecated: - content: '- This has been replaced by PropertyPaneDynamicField' + content: >- + This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please + consume it from there. isPreview: true name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - fullName: PropertyPaneDynamicTextField + fullName: 'PropertyPaneDynamicTextField(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneDynamicTextField(targetProperty: string, properties: + export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; return: type: @@ -271,30 +303,38 @@ items: - id: properties description: Properties of the PropertyPaneDynamicTextField. type: - - IPropertyPaneDynamicTextFieldProps + - sp-webpart-base.IPropertyPaneDynamicTextFieldProps - uid: sp-webpart-base.PropertyPaneHorizontalRule summary: Helper method to create a Horizontal Rule on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: PropertyPaneHorizontalRule() - fullName: PropertyPaneHorizontalRule + fullName: PropertyPaneHorizontalRule() langs: - typeScript type: function syntax: - content: 'export function PropertyPaneHorizontalRule(): IPropertyPaneField;' + content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' return: type: - IPropertyPaneField description: '' - uid: sp-webpart-base.PropertyPaneLabel summary: Helper method to create a Label on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneLabel(targetProperty, properties)' - fullName: PropertyPaneLabel + fullName: 'PropertyPaneLabel(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField; return: type: @@ -308,17 +348,21 @@ items: - id: properties description: Strongly typed Label properties. type: - - IPropertyPaneLabelProps + - sp-webpart-base.IPropertyPaneLabelProps - uid: sp-webpart-base.PropertyPaneLink summary: Helper method to create a Link on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneLink(targetProperty, properties)' - fullName: PropertyPaneLink + fullName: 'PropertyPaneLink(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField; return: type: @@ -332,17 +376,21 @@ items: - id: properties description: Strongly typed Link properties. type: - - IPropertyPaneLinkProps + - sp-webpart-base.IPropertyPaneLinkProps - uid: sp-webpart-base.PropertyPaneSlider summary: Helper method to create a Slider on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneSlider(targetProperty, properties)' - fullName: PropertyPaneSlider + fullName: 'PropertyPaneSlider(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField; return: type: @@ -356,17 +404,21 @@ items: - id: properties description: Strongly typed Slider properties. type: - - IPropertyPaneSliderProps + - sp-webpart-base.IPropertyPaneSliderProps - uid: sp-webpart-base.PropertyPaneTextField summary: Helper method to create a TextField on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneTextField(targetProperty, properties)' - fullName: PropertyPaneTextField + fullName: 'PropertyPaneTextField(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField; return: type: @@ -380,17 +432,21 @@ items: - id: properties description: Strongly typed TextField properties. type: - - IPropertyPaneTextFieldProps + - sp-webpart-base.IPropertyPaneTextFieldProps - uid: sp-webpart-base.PropertyPaneToggle summary: Helper method to create a Toggle on the PropertyPane. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneToggle(targetProperty, properties)' - fullName: PropertyPaneToggle + fullName: 'PropertyPaneToggle(targetProperty, properties)' langs: - typeScript type: function syntax: content: >- - export function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField; return: type: @@ -404,7 +460,7 @@ items: - id: properties description: Strongly typed Toggle properties. type: - - IPropertyPaneToggleProps + - sp-webpart-base.IPropertyPaneToggleProps references: - uid: sp-webpart-base.BaseClientSideWebPart name: BaseClientSideWebPart @@ -424,8 +480,8 @@ references: name: IDynamicDataSharedSourceConfiguration - uid: sp-webpart-base.IDynamicDataSharedSourceFilters name: IDynamicDataSharedSourceFilters - - uid: sp-webpart-base.IPlaceholderSpinnerProps - name: IPlaceholderSpinnerProps + - uid: sp-webpart-base.IMicrosoftTeams + name: IMicrosoftTeams - uid: sp-webpart-base.IPropertyPaneAccessor name: IPropertyPaneAccessor - uid: sp-webpart-base.IPropertyPaneButtonProps @@ -450,6 +506,8 @@ references: name: IPropertyPaneDropdownOption - uid: sp-webpart-base.IPropertyPaneDropdownProps name: IPropertyPaneDropdownProps + - uid: sp-webpart-base.IPropertyPaneDynamicFieldFilters + name: IPropertyPaneDynamicFieldFilters - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps name: IPropertyPaneDynamicFieldProps - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps @@ -474,6 +532,8 @@ references: name: IPropertyPaneTextFieldProps - uid: sp-webpart-base.IPropertyPaneToggleProps name: IPropertyPaneToggleProps + - uid: sp-webpart-base.ISDKs + name: ISDKs - uid: sp-webpart-base.ISerializedServerProcessedData name: ISerializedServerProcessedData - uid: sp-webpart-base.ISerializedWebPartData diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 72dbc005..638aad76 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -23,10 +23,10 @@ items: - typeScript type: class extends: - - BaseWebPart + - 'BaseWebPart ' package: sp-webpart-base children: - - sp-webpart-base.BaseClientSideWebPart.constructor + - sp-webpart-base.BaseClientSideWebPart.(constructor) - sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender - sp-webpart-base.BaseClientSideWebPart.clearError - sp-webpart-base.BaseClientSideWebPart.context @@ -39,14 +39,14 @@ items: - sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData - sp-webpart-base.BaseClientSideWebPart.renderedOnce - sp-webpart-base.BaseClientSideWebPart.renderError - - uid: sp-webpart-base.BaseClientSideWebPart.constructor + - uid: sp-webpart-base.BaseClientSideWebPart.(constructor) summary: Constructor for the BaseClientSideWebPart class. remarks: >- It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. - name: constructor() - fullName: constructor + name: (constructor)() + fullName: (constructor)() langs: - typeScript type: constructor @@ -77,7 +77,7 @@ items: - uid: sp-webpart-base.BaseClientSideWebPart.clearError summary: This API should be used to clear the error message from the web part display area. name: clearError() - fullName: clearError + fullName: clearError() langs: - typeScript type: method @@ -102,7 +102,7 @@ items: content: 'protected readonly context: WebPartContext;' return: type: - - WebPartContext + - sp-webpart-base.WebPartContext - uid: sp-webpart-base.BaseClientSideWebPart.domElement summary: >- This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole @@ -144,7 +144,7 @@ items: display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. name: onDisplayModeChanged(oldDisplayMode) - fullName: onDisplayModeChanged + fullName: onDisplayModeChanged(oldDisplayMode) langs: - typeScript type: method @@ -160,7 +160,7 @@ items: - id: oldDisplayMode description: The old display mode. type: - - DisplayMode + - sp-core-library.DisplayMode - uid: sp-webpart-base.BaseClientSideWebPart.onDispose summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- @@ -169,7 +169,7 @@ items: like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. name: onDispose() - fullName: onDispose + fullName: onDispose() langs: - typeScript type: method @@ -186,7 +186,7 @@ items: This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. name: render() - fullName: render + fullName: render() langs: - typeScript type: method @@ -203,7 +203,7 @@ items: initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. name: renderCompleted() - fullName: renderCompleted + fullName: renderCompleted() langs: - typeScript type: method @@ -247,7 +247,7 @@ items: This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. name: renderError(error) - fullName: renderError + fullName: renderError(error) langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 2d3ce473..ed2b8fdd 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -10,12 +10,12 @@ items: - typeScript type: class extends: - - BaseComponent + - sp-component-base.BaseComponent implements: - - IPropertyPaneConsumer + - 'IPropertyPaneConsumer ' package: sp-webpart-base children: - - sp-webpart-base.BaseWebPart.constructor + - sp-webpart-base.BaseWebPart.(constructor) - sp-webpart-base.BaseWebPart.accessibleTitle - sp-webpart-base.BaseWebPart.context - sp-webpart-base.BaseWebPart.dataVersion @@ -37,14 +37,14 @@ items: - sp-webpart-base.BaseWebPart.properties - sp-webpart-base.BaseWebPart.propertiesMetadata - sp-webpart-base.BaseWebPart.title - - uid: sp-webpart-base.BaseWebPart.constructor + - uid: sp-webpart-base.BaseWebPart.(constructor) summary: Constructor for the `BaseWebPart` class. remarks: >- It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. - name: constructor() - fullName: constructor + name: (constructor)() + fullName: (constructor)() langs: - typeScript type: constructor @@ -80,7 +80,7 @@ items: content: 'protected readonly context: BaseWebPartContext;' return: type: - - BaseWebPartContext + - sp-webpart-base.BaseWebPartContext - uid: sp-webpart-base.BaseWebPart.dataVersion summary: >- The value of this property is stored in the serialized data of the web part to allow developers to manage @@ -94,7 +94,7 @@ items: content: 'protected readonly dataVersion: Version;' return: type: - - Version + - sp-core-library.Version - uid: sp-webpart-base.BaseWebPart.description summary: Description of the WebPart name: description @@ -141,7 +141,7 @@ items: content: 'protected readonly displayMode: DisplayMode;' return: type: - - DisplayMode + - sp-core-library.DisplayMode - uid: sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration summary: >- This API is used to ger the configuration to build the property pane for the web part. If the web part wants to @@ -154,7 +154,7 @@ items: See IPropertyPane and other PropertyPane integration wiki documentation for more details. name: getPropertyPaneConfiguration() - fullName: getPropertyPaneConfiguration + fullName: getPropertyPaneConfiguration() langs: - typeScript type: method @@ -162,7 +162,7 @@ items: content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: type: - - IPropertyPaneConfiguration + - sp-webpart-base.IPropertyPaneConfiguration description: '' - uid: sp-webpart-base.BaseWebPart.onAfterDeserialize summary: 'This API is called after the web part is deserialized to an object, right before the property bag is populated.' @@ -177,7 +177,7 @@ items: deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. name: 'onAfterDeserialize(deserializedObject, dataVersion)' - fullName: onAfterDeserialize + fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' langs: - typeScript type: method @@ -201,13 +201,13 @@ items: serialized by an older web part. Web parts can define their data version by overriding the dataVersion property. type: - - Version + - sp-core-library.Version - uid: sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied summary: >- This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. name: onAfterPropertyPaneChangesApplied() - fullName: onAfterPropertyPaneChangesApplied + fullName: onAfterPropertyPaneChangesApplied() langs: - typeScript type: method @@ -227,7 +227,7 @@ items: web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. name: onBeforeSerialize() - fullName: onBeforeSerialize + fullName: onBeforeSerialize() langs: - typeScript type: method @@ -244,7 +244,7 @@ items: display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. name: onDisplayModeChanged(oldDisplayMode) - fullName: onDisplayModeChanged + fullName: onDisplayModeChanged(oldDisplayMode) langs: - typeScript type: method @@ -258,7 +258,7 @@ items: - id: oldDisplayMode description: The old display mode. type: - - DisplayMode + - sp-core-library.DisplayMode - uid: sp-webpart-base.BaseWebPart.onDispose summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- @@ -267,7 +267,7 @@ items: like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. name: onDispose() - fullName: onDispose + fullName: onDispose() langs: - typeScript type: method @@ -284,7 +284,7 @@ items: the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. name: onInit() - fullName: onInit + fullName: onInit() langs: - typeScript type: method @@ -307,7 +307,7 @@ items: - When the user switches web parts then the current web part gets this event. name: onPropertyPaneConfigurationComplete() - fullName: onPropertyPaneConfigurationComplete + fullName: onPropertyPaneConfigurationComplete() langs: - typeScript type: method @@ -326,7 +326,7 @@ items: - When the user switches web parts then the new web part gets this event. name: onPropertyPaneConfigurationStart() - fullName: onPropertyPaneConfigurationStart + fullName: onPropertyPaneConfigurationStart() langs: - typeScript type: method @@ -341,7 +341,7 @@ items: This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - fullName: onPropertyPaneFieldChanged + fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' langs: - typeScript type: method @@ -370,7 +370,7 @@ items: - uid: sp-webpart-base.BaseWebPart.onPropertyPaneRendered summary: This API is invoked when the PropertyPane is rendered. name: onPropertyPaneRendered() - fullName: onPropertyPaneRendered + fullName: onPropertyPaneRendered() langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index efc73e05..5c0cdbfb 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -9,14 +9,14 @@ items: This base is to be extended by UI-specific WebPart's base. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the BaseWebPartContext class. + create subclasses that extend the `BaseWebPartContext` class. name: BaseWebPartContext fullName: BaseWebPartContext langs: - typeScript type: class extends: - - BaseComponentContext + - sp-component-base.BaseComponentContext package: sp-webpart-base children: - sp-webpart-base.BaseWebPartContext.formFactor @@ -38,7 +38,7 @@ items: content: 'readonly formFactor: WebPartFormFactor;' return: type: - - WebPartFormFactor + - sp-webpart-base.WebPartFormFactor - uid: sp-webpart-base.BaseWebPartContext.manifest summary: Manifest for the client-side component. name: manifest @@ -62,7 +62,7 @@ items: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: type: - - IPropertyPaneAccessor + - sp-webpart-base.IPropertyPaneAccessor - uid: sp-webpart-base.BaseWebPartContext.webPartTag summary: Web part tag to be used for logging and telemetry. name: webPartTag diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 1af03003..280bd790 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -2,6 +2,10 @@ items: - uid: sp-webpart-base.DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. name: DynamicDataSharedDepth fullName: DynamicDataSharedDepth langs: diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 89857203..b4a1e349 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -18,7 +18,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearError summary: Clear the webpart error message. name: clearError(domElement) - fullName: clearError + fullName: clearError(domElement) langs: - typeScript type: method @@ -36,7 +36,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator summary: Clear the loading indicator. name: clearLoadingIndicator(domElement) - fullName: clearLoadingIndicator + fullName: clearLoadingIndicator(domElement) langs: - typeScript type: method @@ -54,7 +54,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator summary: Display a loading spinner. name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - fullName: displayLoadingIndicator + fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' langs: - typeScript type: method @@ -80,7 +80,7 @@ items: - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.renderError summary: Render the provided error message in the webpart container div. name: 'renderError(domElement, error)' - fullName: renderError + fullName: 'renderError(domElement, error)' langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index 4c3420bd..b160aee7 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -2,23 +2,15 @@ items: - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IDynamicDataSharedPropertyConfiguration fullName: IDynamicDataSharedPropertyConfiguration langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IDynamicDataSharedPropertyConfiguration ' package: sp-webpart-base - children: - - sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters - - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration.filters - summary: Filters for the shared property. - name: filters - fullName: filters - langs: - - typeScript - type: property - syntax: - content: 'filters?: IDynamicDataSharedPropertyFilters;' - return: - type: - - IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index d72c6cd4..db560354 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -2,34 +2,15 @@ items: - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IDynamicDataSharedPropertyFilters fullName: IDynamicDataSharedPropertyFilters langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IDynamicDataSharedPropertyFilters ' package: sp-webpart-base - children: - - sp-webpart-base.IDynamicDataSharedPropertyFilters.propertyId - - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters.propertyId - summary: |- - Property Id - - Usage: Use this filter when the author can only to connect to a specific property from the selected source. - remarks: >- - This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the - dynamic data widget. - - - When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. - Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is - pre-selected, the control will be disabled to ensure that authors can not change it. - name: propertyId - fullName: propertyId - langs: - - typeScript - type: property - syntax: - content: 'propertyId?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 1d4da3ab..bc2677d3 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -2,39 +2,15 @@ items: - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IDynamicDataSharedSourceConfiguration fullName: IDynamicDataSharedSourceConfiguration langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IDynamicDataSharedSourceConfiguration ' package: sp-webpart-base - children: - - sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters - - sp-webpart-base.IDynamicDataSharedSourceConfiguration.sourcesLabel - - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration.filters - summary: Filters for the shared source. - name: filters - fullName: filters - langs: - - typeScript - type: property - syntax: - content: 'filters?: IDynamicDataSharedSourceFilters;' - return: - type: - - IDynamicDataSharedSourceFilters - - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration.sourcesLabel - summary: |- - User-friendly, localized label for the sources dropdown. - - default value - 'Connect to source' - name: sourcesLabel - fullName: sourcesLabel - langs: - - typeScript - type: property - syntax: - content: 'sourcesLabel?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index 2788eedb..382eae8a 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -2,64 +2,15 @@ items: - uid: sp-webpart-base.IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IDynamicDataSharedSourceFilters fullName: IDynamicDataSharedSourceFilters langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IDynamicDataSharedSourceFilters ' package: sp-webpart-base - children: - - sp-webpart-base.IDynamicDataSharedSourceFilters.componentId - - sp-webpart-base.IDynamicDataSharedSourceFilters.sourceId - - uid: sp-webpart-base.IDynamicDataSharedSourceFilters.componentId - summary: |- - Component Id. - - Usage: Use this filter when the author should only be able to connect to a specific type of source. - remarks: >- - This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic - data widget. - - - When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources - matching the given component id. - - - Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only - shows document library web parts on the page which are registered dynamic sources. - name: componentId - fullName: componentId - langs: - - typeScript - type: property - syntax: - content: 'componentId?: Guid;' - return: - type: - - Guid - - uid: sp-webpart-base.IDynamicDataSharedSourceFilters.sourceId - summary: |- - Source Id - - Usage: Use this filter, when the author can only to connect to a specific data source. - remarks: >- - This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the - dynamic data widget. - - - When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if - available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is - pre-selected, the control will be disabled to ensure that authors can not change it. - - - The source id for a web part will be of the form WebPart.. - name: sourceId - fullName: sourceId - langs: - - typeScript - type: property - syntax: - content: 'sourceId?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml new file mode 100644 index 00000000..b5d0a2d3 --- /dev/null +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -0,0 +1,37 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IMicrosoftTeams + summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. + name: IMicrosoftTeams + fullName: IMicrosoftTeams + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.IMicrosoftTeams.context + - sp-webpart-base.IMicrosoftTeams.teamsJs + - uid: sp-webpart-base.IMicrosoftTeams.context + summary: Microsoft Teams Context. + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'context: microsoftTeams.Context;' + return: + type: + - microsoftTeams.Context + - uid: sp-webpart-base.IMicrosoftTeams.teamsJs + summary: Microsoft Teams SDK. + name: teamsJs + fullName: teamsJs + langs: + - typeScript + type: property + syntax: + content: 'teamsJs: typeof microsoftTeams;' + return: + type: + - typeof microsoftTeams diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 5a83a622..f712d2a2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -19,7 +19,7 @@ items: - uid: sp-webpart-base.IPropertyPaneAccessor.close summary: This API should be used to close the PropertyPane to help configure the web part. name: close() - fullName: close + fullName: close() langs: - typeScript type: method @@ -32,7 +32,7 @@ items: - uid: sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen summary: Returns true if the PropertyPane is open. name: isPropertyPaneOpen() - fullName: isPropertyPaneOpen + fullName: isPropertyPaneOpen() langs: - typeScript type: method @@ -48,7 +48,7 @@ items: For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. name: isRenderedByWebPart() - fullName: isRenderedByWebPart + fullName: isRenderedByWebPart() langs: - typeScript type: method @@ -61,7 +61,7 @@ items: - uid: sp-webpart-base.IPropertyPaneAccessor.open summary: This API should be used to open the PropertyPane to help configure the web part. name: open() - fullName: open + fullName: open() langs: - typeScript type: method @@ -77,7 +77,7 @@ items: This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. name: refresh() - fullName: refresh + fullName: refresh() langs: - typeScript type: method diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index b87bb3e9..542f3236 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -2,120 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneButtonProps summary: PropertyPane button props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneButtonProps fullName: IPropertyPaneButtonProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneButtonProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneButtonProps.ariaDescription - - sp-webpart-base.IPropertyPaneButtonProps.ariaLabel - - sp-webpart-base.IPropertyPaneButtonProps.buttonType - - sp-webpart-base.IPropertyPaneButtonProps.description - - sp-webpart-base.IPropertyPaneButtonProps.disabled - - sp-webpart-base.IPropertyPaneButtonProps.icon - - sp-webpart-base.IPropertyPaneButtonProps.onClick - - sp-webpart-base.IPropertyPaneButtonProps.text - - uid: sp-webpart-base.IPropertyPaneButtonProps.ariaDescription - summary: |- - Detailed description of the button for the benefit of screen readers. - - Besides the compound button, other button types will need more information provided to screen reader. - name: ariaDescription - fullName: ariaDescription - langs: - - typeScript - type: property - syntax: - content: 'ariaDescription?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneButtonProps.ariaLabel - summary: The aria label of the button for the benefit of screen readers. - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneButtonProps.buttonType - summary: The type of button to render. Default value is ButtonType.normal. - name: buttonType - fullName: buttonType - langs: - - typeScript - type: property - syntax: - content: 'buttonType?: PropertyPaneButtonType;' - return: - type: - - PropertyPaneButtonType - - uid: sp-webpart-base.IPropertyPaneButtonProps.description - summary: Description of the action this button takes. Only used for compound buttons. - name: description - fullName: description - langs: - - typeScript - type: property - syntax: - content: 'description?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneButtonProps.disabled - summary: Whether the button is disabled. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneButtonProps.icon - summary: The button icon shown in command or hero type. - name: icon - fullName: icon - langs: - - typeScript - type: property - syntax: - content: 'icon?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneButtonProps.onClick - summary: >- - A callback which is invoked on the button click, which takes in the existing value for the bound property and - returns the new value and which is then used to update the properties bag. This update will result in the - re-render of the PropertyPane with the new props. - name: onClick - fullName: onClick - langs: - - typeScript - type: property - syntax: - content: 'onClick: (value: any) => any;' - return: - type: - - '(value: any) => any' - - uid: sp-webpart-base.IPropertyPaneButtonProps.text - summary: Display text of the element. - name: text - fullName: text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 1e66200f..771df1e2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -2,50 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneCheckboxProps fullName: IPropertyPaneCheckboxProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneCheckboxProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneCheckboxProps.checked - - sp-webpart-base.IPropertyPaneCheckboxProps.disabled - - sp-webpart-base.IPropertyPaneCheckboxProps.text - - uid: sp-webpart-base.IPropertyPaneCheckboxProps.checked - summary: Whether the property pane checkbox is checked or not. - remarks: The default value is false. - name: checked - fullName: checked - langs: - - typeScript - type: property - syntax: - content: 'checked?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneCheckboxProps.disabled - summary: Whether the property pane checkbox is disabled or not. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneCheckboxProps.text - summary: Label to display next to the checkbox. - name: text - fullName: text - langs: - - typeScript - type: property - syntax: - content: 'text?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index a03c710f..3603db65 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -2,121 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneChoiceGroupOption fullName: IPropertyPaneChoiceGroupOption langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneChoiceGroupOption ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneChoiceGroupOption.checked - - sp-webpart-base.IPropertyPaneChoiceGroupOption.disabled - - sp-webpart-base.IPropertyPaneChoiceGroupOption.iconProps - - sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSize - - sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSrc - - sp-webpart-base.IPropertyPaneChoiceGroupOption.key - - sp-webpart-base.IPropertyPaneChoiceGroupOption.selectedImageSrc - - sp-webpart-base.IPropertyPaneChoiceGroupOption.text - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.checked - summary: |- - Whether the property pane choice group option is checked or not. - - Default value is false. - name: checked - fullName: checked - langs: - - typeScript - type: property - syntax: - content: 'checked?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.disabled - summary: Whether the property pane choice group option is disabled or not. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.iconProps - summary: The Icon component props for choice field. - name: iconProps - fullName: iconProps - langs: - - typeScript - type: property - syntax: - content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' - return: - type: - - IPropertyPaneChoiceGroupOptionIconProps - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSize - summary: The width and height of the image in px for choice field. - name: imageSize - fullName: imageSize - langs: - - typeScript - type: property - syntax: - content: 'imageSize?:' - return: - type: - - |- - { - width: number; - height: number; - } - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.imageSrc - summary: The src of image for choice field. - name: imageSrc - fullName: imageSrc - langs: - - typeScript - type: property - syntax: - content: 'imageSrc?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.key - summary: A required key to uniquely identify the option. - name: key - fullName: key - langs: - - typeScript - type: property - syntax: - content: 'key: string | number;' - return: - type: - - string | number - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.selectedImageSrc - summary: The src of image for choice field which is selected. - name: selectedImageSrc - fullName: selectedImageSrc - langs: - - typeScript - type: property - syntax: - content: 'selectedImageSrc?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption.text - summary: The text string for the option. - name: text - fullName: text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 597fcb8c..2fbac45d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -2,23 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneChoiceGroupOptionIconProps fullName: IPropertyPaneChoiceGroupOptionIconProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps.officeFabricIconFontName - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps.officeFabricIconFontName - summary: The name of the icon to use from the Office Fabric icon set. - name: officeFabricIconFontName - fullName: officeFabricIconFontName - langs: - - typeScript - type: property - syntax: - content: 'officeFabricIconFontName?: string | null;' - return: - type: - - string | null diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index b41730d0..03733e3c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -2,36 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneChoiceGroupProps fullName: IPropertyPaneChoiceGroupProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneChoiceGroupProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneChoiceGroupProps.label - - sp-webpart-base.IPropertyPaneChoiceGroupProps.options - - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps.label - summary: Descriptive label for the choice group. - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps.options - summary: The options for the choice group. - name: options - fullName: options - langs: - - typeScript - type: property - syntax: - content: 'options: IPropertyPaneChoiceGroupOption[];' - return: - type: - - 'IPropertyPaneChoiceGroupOption[]' diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index a8539be3..1a6fbdff 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -2,75 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneConditionalGroup summary: Property pane conditional group. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneConditionalGroup fullName: IPropertyPaneConditionalGroup langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneConditionalGroup ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup - - sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup - - sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup - - sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup - - sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup - - uid: sp-webpart-base.IPropertyPaneConditionalGroup.onShowPrimaryGroup - summary: Callback when user clicks to show primary group. - name: onShowPrimaryGroup - fullName: onShowPrimaryGroup - langs: - - typeScript - type: property - syntax: - content: 'onShowPrimaryGroup?: () => void;' - return: - type: - - () => void - - uid: sp-webpart-base.IPropertyPaneConditionalGroup.onShowSecondaryGroup - summary: Callback when user clicks to show secondary group. - name: onShowSecondaryGroup - fullName: onShowSecondaryGroup - langs: - - typeScript - type: property - syntax: - content: 'onShowSecondaryGroup?: () => void;' - return: - type: - - () => void - - uid: sp-webpart-base.IPropertyPaneConditionalGroup.primaryGroup - summary: Primary group to show - name: primaryGroup - fullName: primaryGroup - langs: - - typeScript - type: property - syntax: - content: 'primaryGroup: IPropertyPaneGroup;' - return: - type: - - IPropertyPaneGroup - - uid: sp-webpart-base.IPropertyPaneConditionalGroup.secondaryGroup - summary: Secondary group to show - name: secondaryGroup - fullName: secondaryGroup - langs: - - typeScript - type: property - syntax: - content: 'secondaryGroup: IPropertyPaneGroup;' - return: - type: - - IPropertyPaneGroup - - uid: sp-webpart-base.IPropertyPaneConditionalGroup.showSecondaryGroup - summary: Indicating whether the property pane should show primary group or the secondary group. - name: showSecondaryGroup - fullName: showSecondaryGroup - langs: - - typeScript - type: property - syntax: - content: 'showSecondaryGroup: boolean;' - return: - type: - - boolean diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 2b6f023b..4773c73b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -2,71 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneConfiguration summary: Web part configuration settings + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneConfiguration fullName: IPropertyPaneConfiguration langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneConfiguration ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneConfiguration.currentPage - - sp-webpart-base.IPropertyPaneConfiguration.loadingIndicatorDelayTime - - sp-webpart-base.IPropertyPaneConfiguration.pages - - sp-webpart-base.IPropertyPaneConfiguration.showLoadingIndicator - - uid: sp-webpart-base.IPropertyPaneConfiguration.currentPage - summary: Page to be displayed on the PropertyPane. - name: currentPage - fullName: currentPage - langs: - - typeScript - type: property - syntax: - content: 'currentPage?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneConfiguration.loadingIndicatorDelayTime - summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. - remarks: The default value is 500. - name: loadingIndicatorDelayTime - fullName: loadingIndicatorDelayTime - langs: - - typeScript - type: property - syntax: - content: 'loadingIndicatorDelayTime?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneConfiguration.pages - summary: Total number of pages on the PropertyPane. - name: pages - fullName: pages - langs: - - typeScript - type: property - syntax: - content: 'pages: IPropertyPanePage[];' - return: - type: - - 'IPropertyPanePage[]' - - uid: sp-webpart-base.IPropertyPaneConfiguration.showLoadingIndicator - summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. - remarks: >- - This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay - loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator - property). - - - The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in - real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - name: showLoadingIndicator - fullName: showLoadingIndicator - langs: - - typeScript - type: property - syntax: - content: 'showLoadingIndicator?: boolean;' - return: - type: - - boolean diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 98a8f163..27a58657 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -2,78 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneCustomFieldProps fullName: IPropertyPaneCustomFieldProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneCustomFieldProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneCustomFieldProps.context - - sp-webpart-base.IPropertyPaneCustomFieldProps.key - - sp-webpart-base.IPropertyPaneCustomFieldProps.onDispose - - sp-webpart-base.IPropertyPaneCustomFieldProps.onRender - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps.context - summary: >- - Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web - part can use this context to manage state information. - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'context?: any;' - return: - type: - - any - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps.key - summary: >- - An UNIQUE key indicates the identity of this contorl. - - - The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should - be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how - to pick the value of the key. - - - For more information, see the [React - documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). - name: key - fullName: key - langs: - - typeScript - type: property - syntax: - content: 'key: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps.onDispose - summary: This API is called when the component is unmounted from the host element. - name: onDispose - fullName: onDispose - langs: - - typeScript - type: property - syntax: - content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' - return: - type: - - '(domElement: HTMLElement, context?: any) => void' - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps.onRender - summary: This API will be called once the custom field is mounted on the host element. - name: onRender - fullName: onRender - langs: - - typeScript - type: property - syntax: - content: >- - onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => - void) => void; - return: - type: - - >- - (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) - => void diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 8c2fc847..894b9e91 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -2,23 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneDropdownCalloutProps fullName: IPropertyPaneDropdownCalloutProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDropdownCalloutProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight - - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps.calloutMaxHeight - summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen - name: calloutMaxHeight - fullName: calloutMaxHeight - langs: - - typeScript - type: property - syntax: - content: 'calloutMaxHeight?: number;' - return: - type: - - number diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 3b7d3777..010a6618 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -2,62 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownOption summary: PropertyPane drop down options. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneDropdownOption fullName: IPropertyPaneDropdownOption langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDropdownOption ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDropdownOption.index - - sp-webpart-base.IPropertyPaneDropdownOption.key - - sp-webpart-base.IPropertyPaneDropdownOption.text - - sp-webpart-base.IPropertyPaneDropdownOption.type - - uid: sp-webpart-base.IPropertyPaneDropdownOption.index - summary: Index for this option. - name: index - fullName: index - langs: - - typeScript - type: property - syntax: - content: 'index?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneDropdownOption.key - summary: A key to uniquely identify this option. - name: key - fullName: key - langs: - - typeScript - type: property - syntax: - content: 'key: string | number;' - return: - type: - - string | number - - uid: sp-webpart-base.IPropertyPaneDropdownOption.text - summary: Text to render for this option. - name: text - fullName: text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDropdownOption.type - summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' - name: type - fullName: type - langs: - - typeScript - type: property - syntax: - content: 'type?: PropertyPaneDropdownOptionType;' - return: - type: - - PropertyPaneDropdownOptionType diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index d2867dde..1e21e8b6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -2,116 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneDropdownProps summary: PropertyPane drop down component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneDropdownProps fullName: IPropertyPaneDropdownProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDropdownProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel - - sp-webpart-base.IPropertyPaneDropdownProps.ariaPositionInSet - - sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize - - sp-webpart-base.IPropertyPaneDropdownProps.calloutProps - - sp-webpart-base.IPropertyPaneDropdownProps.disabled - - sp-webpart-base.IPropertyPaneDropdownProps.label - - sp-webpart-base.IPropertyPaneDropdownProps.options - - sp-webpart-base.IPropertyPaneDropdownProps.selectedKey - - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel - summary: A description of the dropdown for the benefit of screen reader users. - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaPositionInSet - summary: >- - Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It - starts from 1. - name: ariaPositionInSet - fullName: ariaPositionInSet - langs: - - typeScript - type: property - syntax: - content: 'ariaPositionInSet?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneDropdownProps.ariaSetSize - summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. - name: ariaSetSize - fullName: ariaSetSize - langs: - - typeScript - type: property - syntax: - content: 'ariaSetSize?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneDropdownProps.calloutProps - summary: Custom properties for Dropdown's Callout used to render options. - name: calloutProps - fullName: calloutProps - langs: - - typeScript - type: property - syntax: - content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' - return: - type: - - IPropertyPaneDropdownCalloutProps - - uid: sp-webpart-base.IPropertyPaneDropdownProps.disabled - summary: Whether the property pane dropdown option is disabled or not. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneDropdownProps.label - summary: Descriptive label for the Dropdown. - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDropdownProps.options - summary: Collection of options for this Dropdown. - name: options - fullName: options - langs: - - typeScript - type: property - syntax: - content: 'options?: IPropertyPaneDropdownOption[];' - return: - type: - - 'IPropertyPaneDropdownOption[]' - - uid: sp-webpart-base.IPropertyPaneDropdownProps.selectedKey - summary: The key of the initially selected option. - name: selectedKey - fullName: selectedKey - langs: - - typeScript - type: property - syntax: - content: 'selectedKey?: string | number;' - return: - type: - - string | number diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml new file mode 100644 index 00000000..9c8fa22d --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -0,0 +1,16 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.IPropertyPaneDynamicFieldFilters + summary: Property pane dynamic field filters which is an intersection of both source and property filters. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters + langs: + - typeScript + type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDynamicFieldFilters ' + package: sp-webpart-base diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 318cfb21..2a49daa9 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -2,74 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneDynamicFieldProps fullName: IPropertyPaneDynamicFieldProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDynamicFieldProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDynamicFieldProps.filters - - sp-webpart-base.IPropertyPaneDynamicFieldProps.label - - sp-webpart-base.IPropertyPaneDynamicFieldProps.propertyValueDepth - - sp-webpart-base.IPropertyPaneDynamicFieldProps.sourcesLabel - - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.filters - summary: Filters for the property pane dynamic field. - name: filters - fullName: filters - langs: - - typeScript - type: property - syntax: - content: 'filters?: IPropertyPaneDynamicFieldFilters;' - return: - type: - - IPropertyPaneDynamicFieldFilters - - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.label - summary: 'User-friendly, localized label to identify the field.' - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.propertyValueDepth - summary: |- - Indicates to what depth of property values are shown on the property pane dynamic data widget. - - If not specified, then max of 2 levels of property value will be shown. - remarks: >- - It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only - source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., - the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two - levels of property value will be shown i.e., the widget will display two levels after the source and property for - this field. - name: propertyValueDepth - fullName: propertyValueDepth - langs: - - typeScript - type: property - syntax: - content: 'propertyValueDepth?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps.sourcesLabel - summary: |- - User-friendly, localized label for the sources dropdown. - - default value - 'Connect to source' - name: sourcesLabel - fullName: sourcesLabel - langs: - - typeScript - type: property - syntax: - content: 'sourcesLabel?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 50f986a5..072f7b74 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -2,64 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneDynamicFieldSetProps fullName: IPropertyPaneDynamicFieldSetProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDynamicFieldSetProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields - - sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label - - sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration - - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.fields - summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. - name: fields - fullName: fields - langs: - - typeScript - type: property - syntax: - content: 'fields: IPropertyPaneField[];' - return: - type: - - 'IPropertyPaneField[]' - - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.label - summary: 'User-friendly, localized label to identify the property.' - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps.sharedConfiguration - summary: Configuration shared between all the entries of the set. - name: sharedConfiguration - fullName: sharedConfiguration - langs: - - typeScript - type: property - syntax: - content: 'sharedConfiguration?:' - return: - type: - - |- - { - /** - * Indicates to what depth the dynamic reference is shared between the set of fields - * of the dynamic field set. - */ - depth: DynamicDataSharedDepth; - /** - * Shared source configuration - */ - source?: IDynamicDataSharedSourceConfiguration; - /** - * Shared property configuration - */ - property?: IDynamicDataSharedPropertyConfiguration; - } diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 2678a81f..78ebd98c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -10,187 +10,6 @@ items: langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneDynamicTextFieldProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.ariaLabel - summary: 'ARIA Label for text field, if any.' - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.description - summary: The text field input description. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: description - fullName: description - langs: - - typeScript - type: property - syntax: - content: 'description?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.disabled - summary: Whether the property pane text field is enabled or not. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.errorMessage - summary: 'If set, this will be displayed as an error message.' - remarks: >- - When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the - error message. - - - Make sure to set this only if you want to see an error message displayed for the text field. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: errorMessage - fullName: errorMessage - langs: - - typeScript - type: property - syntax: - content: 'errorMessage?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.label - summary: Label for the text field. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.onGetErrorMessage - summary: This method is used to get the validation error message and determine whether the input value is valid or not. - remarks: |- - When it returns string: - - - If valid, it returns empty string. - - - If invalid, it returns the error message string and an error message is displayed below the text field. - - When it returns `Promise`: - - - The resolved value is display as error message. - - - The rejected, the value is thrown away. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: onGetErrorMessage - fullName: onGetErrorMessage - langs: - - typeScript - type: property - syntax: - content: 'onGetErrorMessage?: (value: string) => string | Promise;' - return: - type: - - '(value: string) => string | Promise' - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.placeholder - summary: Placeholder text to be displayed in the text field. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: placeholder - fullName: placeholder - langs: - - typeScript - type: property - syntax: - content: 'placeholder?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusIn - summary: Run validation when the PropertyPaneTextField is focused. - remarks: The default value is false. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: validateOnFocusIn - fullName: validateOnFocusIn - langs: - - typeScript - type: property - syntax: - content: 'validateOnFocusIn?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.validateOnFocusOut - summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. - remarks: The default value is false. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: validateOnFocusOut - fullName: validateOnFocusOut - langs: - - typeScript - type: property - syntax: - content: 'validateOnFocusOut?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps.value - summary: >- - Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is - empty or contains null value. - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: value - fullName: value - langs: - - typeScript - type: property - syntax: - content: 'value?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 860d4131..718f56f7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -2,64 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneField summary: PropertyPane field. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneField fullName: IPropertyPaneField langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneField ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneField.properties - - sp-webpart-base.IPropertyPaneField.shouldFocus - - sp-webpart-base.IPropertyPaneField.targetProperty - - sp-webpart-base.IPropertyPaneField.type - - uid: sp-webpart-base.IPropertyPaneField.properties - summary: Strongly typed properties object. Specific to each field type. - remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - name: properties - fullName: properties - langs: - - typeScript - type: property - syntax: - content: 'properties: TProperties;' - return: - type: - - TProperties - - uid: sp-webpart-base.IPropertyPaneField.shouldFocus - summary: Whether this control should be focused. - remarks: The default value is false. - name: shouldFocus - fullName: shouldFocus - langs: - - typeScript - type: property - syntax: - content: 'shouldFocus?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneField.targetProperty - summary: Target property from the web part's property bag. - name: targetProperty - fullName: targetProperty - langs: - - typeScript - type: property - syntax: - content: 'targetProperty: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneField.type - summary: Type of the PropertyPane field. - name: type - fullName: type - langs: - - typeScript - type: property - syntax: - content: 'type: PropertyPaneFieldType;' - return: - type: - - PropertyPaneFieldType diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index aabbdf01..babfea52 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -2,51 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneGroup fullName: IPropertyPaneGroup langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneGroup ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneGroup.groupFields - - sp-webpart-base.IPropertyPaneGroup.groupName - - sp-webpart-base.IPropertyPaneGroup.isCollapsed - - uid: sp-webpart-base.IPropertyPaneGroup.groupFields - summary: List of PropertyPane fields. - name: groupFields - fullName: groupFields - langs: - - typeScript - type: property - syntax: - content: 'groupFields: IPropertyPaneField[];' - return: - type: - - 'IPropertyPaneField[]' - - uid: sp-webpart-base.IPropertyPaneGroup.groupName - summary: Display name for the group. - remarks: 'For performance reasons, it''s highly recommended to keep this name unique within the property pane page.' - name: groupName - fullName: groupName - langs: - - typeScript - type: property - syntax: - content: 'groupName?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneGroup.isCollapsed - summary: Indicates whether the PropertyPane group is collapsed or not. - remarks: The default value is false. - name: isCollapsed - fullName: isCollapsed - langs: - - typeScript - type: property - syntax: - content: 'isCollapsed?: boolean;' - return: - type: - - boolean diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index 7ad34f65..33c7008b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -2,37 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneLabelProps summary: PropertyPaneLabel component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneLabelProps fullName: IPropertyPaneLabelProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneLabelProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneLabelProps.required - - sp-webpart-base.IPropertyPaneLabelProps.text - - uid: sp-webpart-base.IPropertyPaneLabelProps.required - summary: Whether the associated form field is required or not. - remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - name: required - fullName: required - langs: - - typeScript - type: property - syntax: - content: 'required?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneLabelProps.text - summary: Display text fot the label. - name: text - fullName: text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 943ef41c..3065f52e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -2,90 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneLinkProps summary: PropertyPaneLink component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneLinkProps fullName: IPropertyPaneLinkProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneLinkProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneLinkProps.disabled - - sp-webpart-base.IPropertyPaneLinkProps.href - - sp-webpart-base.IPropertyPaneLinkProps.popupWindowProps - - sp-webpart-base.IPropertyPaneLinkProps.target - - sp-webpart-base.IPropertyPaneLinkProps.text - - uid: sp-webpart-base.IPropertyPaneLinkProps.disabled - summary: Whether the property pane link is disabled or not. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneLinkProps.href - summary: Location to which the link is targeted to. - name: href - fullName: href - langs: - - typeScript - type: property - syntax: - content: 'href: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneLinkProps.popupWindowProps - summary: The props of pop up window. - name: popupWindowProps - fullName: popupWindowProps - langs: - - typeScript - type: property - syntax: - content: 'popupWindowProps?: IPopupWindowProps;' - return: - type: - - IPopupWindowProps - - uid: sp-webpart-base.IPropertyPaneLinkProps.target - summary: This attribute specifies where to display the linked resource. - remarks: >- - Following values can be used: - - - \_self - (default) Load the response in the current page. - - - \_blank - Load the response into a new unnamed tab. - - - \_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same - as "\_self" - - - \_top - Load the response into the original window. - name: target - fullName: target - langs: - - typeScript - type: property - syntax: - content: 'target?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneLinkProps.text - summary: Display text for the link. - name: text - fullName: text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index 49a7d32e..1435109e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -2,49 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPanePage summary: PropertyPanePage interface. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPanePage fullName: IPropertyPanePage langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPanePage ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPanePage.displayGroupsAsAccordion - - sp-webpart-base.IPropertyPanePage.groups - - sp-webpart-base.IPropertyPanePage.header - - uid: sp-webpart-base.IPropertyPanePage.displayGroupsAsAccordion - summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. - name: displayGroupsAsAccordion - fullName: displayGroupsAsAccordion - langs: - - typeScript - type: property - syntax: - content: 'displayGroupsAsAccordion?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPanePage.groups - summary: List of groups to be displayed on the PropertyPane page. - name: groups - fullName: groups - langs: - - typeScript - type: property - syntax: - content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' - return: - type: - - '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' - - uid: sp-webpart-base.IPropertyPanePage.header - summary: PropertyPane page header. - name: header - fullName: header - langs: - - typeScript - type: property - syntax: - content: 'header?: IPropertyPanePageHeader;' - return: - type: - - IPropertyPanePageHeader diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index 5835ef0f..e5e78a5b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -2,36 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPanePageHeader fullName: IPropertyPanePageHeader langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPanePageHeader ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPanePageHeader.description - - sp-webpart-base.IPropertyPanePageHeader.image - - uid: sp-webpart-base.IPropertyPanePageHeader.description - summary: Header to display. - name: description - fullName: description - langs: - - typeScript - type: property - syntax: - content: 'description: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPanePageHeader.image - summary: Image url for the background image. - name: image - fullName: image - langs: - - typeScript - type: property - syntax: - content: 'image?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index 3e70917b..c3a04b83 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -2,118 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneSliderProps fullName: IPropertyPaneSliderProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneSliderProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneSliderProps.ariaLabel - - sp-webpart-base.IPropertyPaneSliderProps.disabled - - sp-webpart-base.IPropertyPaneSliderProps.label - - sp-webpart-base.IPropertyPaneSliderProps.max - - sp-webpart-base.IPropertyPaneSliderProps.min - - sp-webpart-base.IPropertyPaneSliderProps.showValue - - sp-webpart-base.IPropertyPaneSliderProps.step - - sp-webpart-base.IPropertyPaneSliderProps.value - - uid: sp-webpart-base.IPropertyPaneSliderProps.ariaLabel - summary: A description of the Slider for the benefit of screen readers. - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneSliderProps.disabled - summary: Whether or not the Slider is disabled. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneSliderProps.label - summary: Description label of the Slider. - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneSliderProps.max - summary: The max value of the Slider. - name: max - fullName: max - langs: - - typeScript - type: property - syntax: - content: 'max: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneSliderProps.min - summary: The min value of the Slider. - name: min - fullName: min - langs: - - typeScript - type: property - syntax: - content: 'min: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneSliderProps.showValue - summary: Whether to show the value on the right of the Slider. - remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - name: showValue - fullName: showValue - langs: - - typeScript - type: property - syntax: - content: 'showValue?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneSliderProps.step - summary: The difference between the two adjacent values of the Slider. Defaults to 1. - name: step - fullName: step - langs: - - typeScript - type: property - syntax: - content: 'step?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneSliderProps.value - summary: |- - The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. - - Defaults to min. - name: value - fullName: value - langs: - - typeScript - type: property - syntax: - content: 'value?: number;' - return: - type: - - number diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 514e1d38..1c94fb9a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -2,284 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneTextFieldProps fullName: IPropertyPaneTextFieldProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneTextFieldProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneTextFieldProps.ariaLabel - - sp-webpart-base.IPropertyPaneTextFieldProps.deferredValidationTime - - sp-webpart-base.IPropertyPaneTextFieldProps.description - - sp-webpart-base.IPropertyPaneTextFieldProps.disabled - - sp-webpart-base.IPropertyPaneTextFieldProps.errorMessage - - sp-webpart-base.IPropertyPaneTextFieldProps.label - - sp-webpart-base.IPropertyPaneTextFieldProps.logName - - sp-webpart-base.IPropertyPaneTextFieldProps.maxLength - - sp-webpart-base.IPropertyPaneTextFieldProps.multiline - - sp-webpart-base.IPropertyPaneTextFieldProps.onGetErrorMessage - - sp-webpart-base.IPropertyPaneTextFieldProps.placeholder - - sp-webpart-base.IPropertyPaneTextFieldProps.resizable - - sp-webpart-base.IPropertyPaneTextFieldProps.rows - - sp-webpart-base.IPropertyPaneTextFieldProps.underlined - - sp-webpart-base.IPropertyPaneTextFieldProps.validateOnFocusIn - - sp-webpart-base.IPropertyPaneTextFieldProps.validateOnFocusOut - - sp-webpart-base.IPropertyPaneTextFieldProps.value - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.ariaLabel - summary: 'Aria Label for text field, if any.' - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.deferredValidationTime - summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. - remarks: The default value is 200. - name: deferredValidationTime - fullName: deferredValidationTime - langs: - - typeScript - type: property - syntax: - content: 'deferredValidationTime?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.description - summary: The text field input description. - name: description - fullName: description - langs: - - typeScript - type: property - syntax: - content: 'description?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.disabled - summary: Whether the property pane text field is enabled or not. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.errorMessage - summary: 'If set, this will be displayed as an error message.' - remarks: >- - When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the - error message. - - - So, make sure to set this only if you want to see an error message displayed for the text field. - name: errorMessage - fullName: errorMessage - langs: - - typeScript - type: property - syntax: - content: 'errorMessage?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.label - summary: Label for the text field. - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.logName - summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. - remarks: >- - The messages will be logged with a format such as `.`. - - - For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might - contain: - - - 1. The action type: - - - `Add`: change from initial/unset state to customized content. (first edit) - - - `Clear`: reset the content of caption element to initial/unset state. - - - `Edit`: any edition that changes the content apart from add and clear - - - 2. The text length after each edit - name: logName - fullName: logName - langs: - - typeScript - type: property - syntax: - content: 'logName?:' - return: - type: - - |- - { - moduleName: string; - controlName: string; - } - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.maxLength - summary: Maximum number of characters that the PropertyPaneTextField can have. - remarks: 'If the value is set to a negative number, an exception will be thrown.' - name: maxLength - fullName: maxLength - langs: - - typeScript - type: property - syntax: - content: 'maxLength?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.multiline - summary: Whether or not the text field is a multiline text field. - remarks: The default value is false. - name: multiline - fullName: multiline - langs: - - typeScript - type: property - syntax: - content: 'multiline?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.onGetErrorMessage - summary: The method is used to get the validation error message and determine whether the input value is valid or not. - remarks: |- - When it returns string: - - - If valid, it returns empty string. - - - If invalid, it returns the error message string and an error message is displayed below the text field. - - When it returns `Promise`: - - - The resolved value is display as error message. - - - The rejected, the value is thrown away. - name: onGetErrorMessage - fullName: onGetErrorMessage - langs: - - typeScript - type: property - syntax: - content: 'onGetErrorMessage?: (value: string) => string | Promise;' - return: - type: - - '(value: string) => string | Promise' - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.placeholder - summary: placeholder text to be displayed in the text field. - name: placeholder - fullName: placeholder - langs: - - typeScript - type: property - syntax: - content: 'placeholder?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.resizable - summary: Whether or not the multiline text field is resizable. - remarks: The default value is true. - name: resizable - fullName: resizable - langs: - - typeScript - type: property - syntax: - content: 'resizable?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.rows - summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' - remarks: This prop is used only when the multiline prop is set to true. - name: rows - fullName: rows - langs: - - typeScript - type: property - syntax: - content: 'rows?: number;' - return: - type: - - number - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.underlined - summary: Whether or not the text field is underlined. - remarks: The default value is false. - name: underlined - fullName: underlined - langs: - - typeScript - type: property - syntax: - content: 'underlined?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.validateOnFocusIn - summary: Run validation when the PropertyPaneTextField is focused. - remarks: The default value is false. - name: validateOnFocusIn - fullName: validateOnFocusIn - langs: - - typeScript - type: property - syntax: - content: 'validateOnFocusIn?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.validateOnFocusOut - summary: Run validation when the PropertyPaneTextField is out of focus or on blur. - remarks: The default value is false. - name: validateOnFocusOut - fullName: validateOnFocusOut - langs: - - typeScript - type: property - syntax: - content: 'validateOnFocusOut?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneTextFieldProps.value - summary: >- - Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is - empty or contains null value. - name: value - fullName: value - langs: - - typeScript - type: property - syntax: - content: 'value?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 0c6eb968..cc39aa3a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -2,115 +2,15 @@ items: - uid: sp-webpart-base.IPropertyPaneToggleProps summary: PropertyPaneToggle component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneToggleProps fullName: IPropertyPaneToggleProps langs: - typeScript type: interface + extends: + - 'SPPropertyPane.IPropertyPaneToggleProps ' package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneToggleProps.checked - - sp-webpart-base.IPropertyPaneToggleProps.disabled - - sp-webpart-base.IPropertyPaneToggleProps.key - - sp-webpart-base.IPropertyPaneToggleProps.label - - sp-webpart-base.IPropertyPaneToggleProps.offAriaLabel - - sp-webpart-base.IPropertyPaneToggleProps.offText - - sp-webpart-base.IPropertyPaneToggleProps.onAriaLabel - - sp-webpart-base.IPropertyPaneToggleProps.onText - - uid: sp-webpart-base.IPropertyPaneToggleProps.checked - summary: Checked state of the toggle. - remarks: 'If you are maintaining state yourself, use this property.' - name: checked - fullName: checked - langs: - - typeScript - type: property - syntax: - content: 'checked?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneToggleProps.disabled - summary: Optional disabled flag. - name: disabled - fullName: disabled - langs: - - typeScript - type: property - syntax: - content: 'disabled?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPropertyPaneToggleProps.key - summary: A key to uniquely identify the field. - name: key - fullName: key - langs: - - typeScript - type: property - syntax: - content: 'key?: string | number;' - return: - type: - - string | number - - uid: sp-webpart-base.IPropertyPaneToggleProps.label - summary: A label for the toggle. - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneToggleProps.offAriaLabel - summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. - name: offAriaLabel - fullName: offAriaLabel - langs: - - typeScript - type: property - syntax: - content: 'offAriaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneToggleProps.offText - summary: Test display when toggle is OFF. - name: offText - fullName: offText - langs: - - typeScript - type: property - syntax: - content: 'offText?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneToggleProps.onAriaLabel - summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. - name: onAriaLabel - fullName: onAriaLabel - langs: - - typeScript - type: property - syntax: - content: 'onAriaLabel?: string;' - return: - type: - - string - - uid: sp-webpart-base.IPropertyPaneToggleProps.onText - summary: Text to display when toggle is ON. - name: onText - fullName: onText - langs: - - typeScript - type: property - syntax: - content: 'onText?: string;' - return: - type: - - string diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml new file mode 100644 index 00000000..b57dfe04 --- /dev/null +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -0,0 +1,29 @@ +### YamlMime:UniversalReference +items: + - uid: sp-webpart-base.ISDKs + summary: Conditional set of SDKs provided by SPFx dependent on the environment. + name: ISDKs + fullName: ISDKs + langs: + - typeScript + type: interface + package: sp-webpart-base + children: + - sp-webpart-base.ISDKs.microsoftTeams + - uid: sp-webpart-base.ISDKs.microsoftTeams + summary: >- + Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is + being hosted in Microsoft Teams. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + name: microsoftTeams + fullName: microsoftTeams + langs: + - typeScript + type: property + syntax: + content: 'microsoftTeams?: IMicrosoftTeams;' + return: + type: + - sp-webpart-base.IMicrosoftTeams diff --git a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index 38fa6f8f..42b55b2f 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -22,6 +22,7 @@ items: Example: + ``` { @@ -37,7 +38,10 @@ items: - typeScript type: property syntax: - content: 'htmlStrings?:' + content: |- + htmlStrings?: { + [key: string]: string; + }; return: type: - |- @@ -50,6 +54,7 @@ items: SharePoint servers treat the values as image sources and run services like search index and link fixup on them. Example: + ``` { 'myImage1': 'http://res.contoso.com/path/to/file' @@ -63,7 +68,10 @@ items: - typeScript type: property syntax: - content: 'imageSources?:' + content: |- + imageSources?: { + [key: string]: string; + }; return: type: - |- @@ -76,6 +84,7 @@ items: SharePoint servers treat the values as links and run services like link fixup on them. Example: + ``` { 'myWebURL': 'http://contoso.com' @@ -89,7 +98,10 @@ items: - typeScript type: property syntax: - content: 'links?:' + content: |- + links?: { + [key: string]: string; + }; return: type: - |- @@ -105,6 +117,7 @@ items: Example: + ``` { @@ -120,7 +133,10 @@ items: - typeScript type: property syntax: - content: 'searchablePlainTexts?:' + content: |- + searchablePlainTexts?: { + [key: string]: string; + }; return: type: - |- diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index d8e3c909..ae5140ff 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -37,13 +37,14 @@ items: content: 'dataVersion: Version;' return: type: - - Version + - sp-core-library.Version - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. remarks: |- The key is the path within the web part properties, and the value is the dynamic data internal id. Example: + ``` { 'pageContextUser': @@ -60,7 +61,10 @@ items: - typeScript type: property syntax: - content: 'dynamicDataPaths?:' + content: |- + dynamicDataPaths?: { + [path: string]: string; + }; return: type: - |- @@ -75,6 +79,7 @@ items: The key is the path within the web part properties, and the value is the dynamic data static value. Example: + ``` { 'aStringProperty': 'thisIsAString', @@ -89,7 +94,10 @@ items: - typeScript type: property syntax: - content: 'dynamicDataValues?:' + content: |- + dynamicDataValues?: { + [path: string]: any; + }; return: type: - |- @@ -128,4 +136,4 @@ items: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: type: - - ISerializedServerProcessedData + - sp-webpart-base.ISerializedServerProcessedData diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index fe9ea102..ba0fffc4 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -29,10 +29,6 @@ items: - sp-webpart-base.IWebPartContext.webPartTag - uid: sp-webpart-base.IWebPartContext.domElement summary: Reference to the DOM element that hosts this client-side component. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: domElement fullName: domElement langs: @@ -45,10 +41,6 @@ items: - HTMLElement - uid: sp-webpart-base.IWebPartContext.graphHttpClient summary: GraphHttpClient instance scoped to this web part. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. isPreview: true name: graphHttpClient fullName: graphHttpClient @@ -62,10 +54,6 @@ items: - GraphHttpClient - uid: sp-webpart-base.IWebPartContext.httpClient summary: HttpClient instance scoped to this web part. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: httpClient fullName: httpClient langs: @@ -75,13 +63,9 @@ items: content: 'readonly httpClient: HttpClient;' return: type: - - HttpClient + - sp-http.HttpClient - uid: sp-webpart-base.IWebPartContext.instanceId summary: Web part instance id. This is a globally unique value. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: instanceId fullName: instanceId langs: @@ -94,10 +78,6 @@ items: - string - uid: sp-webpart-base.IWebPartContext.manifest summary: Manifest for the client-side web part. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: manifest fullName: manifest langs: @@ -110,10 +90,6 @@ items: - IClientSideWebPartManifestInstance - uid: sp-webpart-base.IWebPartContext.pageContext summary: SharePoint page context. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: pageContext fullName: pageContext langs: @@ -123,13 +99,9 @@ items: content: 'readonly pageContext: PageContext;' return: type: - - PageContext + - sp-page-context.PageContext - uid: sp-webpart-base.IWebPartContext.propertyPane summary: Accessor for common web part property pane operations. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: propertyPane fullName: propertyPane langs: @@ -139,13 +111,9 @@ items: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: type: - - IPropertyPaneAccessor + - sp-webpart-base.IPropertyPaneAccessor - uid: sp-webpart-base.IWebPartContext.spHttpClient summary: SPHttpClient instance scoped to this web part. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: spHttpClient fullName: spHttpClient langs: @@ -155,13 +123,9 @@ items: content: 'readonly spHttpClient: SPHttpClient;' return: type: - - SPHttpClient + - sp-http.SPHttpClient - uid: sp-webpart-base.IWebPartContext.statusRenderer summary: Web part status renderer. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: statusRenderer fullName: statusRenderer langs: @@ -171,13 +135,9 @@ items: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: type: - - IClientSideWebPartStatusRenderer + - sp-webpart-base.IClientSideWebPartStatusRenderer - uid: sp-webpart-base.IWebPartContext.webPartTag summary: Web part tag to be used for logging and telemetry. - deprecated: - content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. name: webPartTag fullName: webPartTag langs: diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index c789f1bd..c1a16d61 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -71,6 +71,7 @@ items: Example: + ``` { @@ -89,7 +90,10 @@ items: - typeScript type: property syntax: - content: 'dynamicDataPaths?:' + content: |- + dynamicDataPaths?: { + [path: string]: string; + }; return: type: - |- @@ -104,6 +108,7 @@ items: The key is the path within the web part properties, and the value is the dynamic data static value. Example: + ``` { 'aStringProperty': 'thisIsAString', @@ -118,7 +123,10 @@ items: - typeScript type: property syntax: - content: 'dynamicDataValues?:' + content: |- + dynamicDataValues?: { + [path: string]: any; + }; return: type: - |- @@ -188,7 +196,7 @@ items: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: type: - - ISerializedServerProcessedData + - sp-webpart-base.ISerializedServerProcessedData - uid: sp-webpart-base.IWebPartData.title summary: Web part title remarks: |- diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 4b859165..621cc990 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -24,6 +24,7 @@ items: Example: Let's assume we have a web part with properties that have the following schema: + ``` { @@ -41,6 +42,7 @@ items: We can define the metadata for the desired properties as following: + ``` { @@ -61,22 +63,3 @@ items: - typeScript type: interface package: sp-webpart-base - children: - - sp-webpart-base.IWebPartPropertiesMetadata.__index - - uid: sp-webpart-base.IWebPartPropertiesMetadata.__index - name: __index(key) - fullName: __index - langs: - - typeScript - type: method - syntax: - content: '[key: string]: IWebPartPropertyMetadata;' - return: - type: - - IWebPartPropertyMetadata - description: '' - parameters: - - id: key - description: '' - type: - - string diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 8c260331..559aec7c 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -2,6 +2,10 @@ items: - uid: sp-webpart-base.PropertyPaneButtonType summary: Enum for all the supported button types. + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. name: PropertyPaneButtonType fullName: PropertyPaneButtonType langs: diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 0e5affc2..69259dad 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -3,7 +3,11 @@ items: - uid: sp-webpart-base.PropertyPaneDropdownOptionType summary: >- Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown](xref:sp-webpart-base.PropertyPaneDropdown). + [PropertyPaneDropdown()](xref:sp-webpart-base.PropertyPaneDropdown). + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. name: PropertyPaneDropdownOptionType fullName: PropertyPaneDropdownOptionType langs: diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index b8ac8915..695b6462 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -5,6 +5,10 @@ items: Enum for all the supported PropertyPane field types. Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. name: PropertyPaneFieldType fullName: PropertyPaneFieldType langs: diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 8aa06167..e30261e7 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -6,18 +6,19 @@ items: instance to the http client. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the WebPartContext class. + create subclasses that extend the `WebPartContext` class. name: WebPartContext fullName: WebPartContext langs: - typeScript type: class extends: - - BaseWebPartContext + - sp-webpart-base.BaseWebPartContext package: sp-webpart-base children: - sp-webpart-base.WebPartContext.domElement - sp-webpart-base.WebPartContext.microsoftTeams + - sp-webpart-base.WebPartContext.sdks - sp-webpart-base.WebPartContext.statusRenderer - uid: sp-webpart-base.WebPartContext.domElement summary: Reference to the DOM element that hosts this client-side component. @@ -38,7 +39,6 @@ items: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - isPreview: true name: microsoftTeams fullName: microsoftTeams langs: @@ -49,6 +49,18 @@ items: return: type: - typeof microsoftTeams | undefined + - uid: sp-webpart-base.WebPartContext.sdks + summary: Conditional set of SDKs provided by SPFx dependent on the environment. + name: sdks + fullName: sdks + langs: + - typeScript + type: property + syntax: + content: 'readonly sdks: ISDKs;' + return: + type: + - sp-webpart-base.ISDKs - uid: sp-webpart-base.WebPartContext.statusRenderer summary: Web part status renderer. name: statusRenderer @@ -60,4 +72,4 @@ items: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: type: - - IClientSideWebPartStatusRenderer + - sp-webpart-base.IClientSideWebPartStatusRenderer diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index 02b20244..e65041d8 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -1,406 +1,413 @@ -- name: SharePoint Framework reference - href: ~/overview/sharepoint.md - items: - - name: decorators - uid: decorators - - name: sp-application-base - uid: sp-application-base - items: - - name: ApplicationAccessor - uid: sp-application-base.ApplicationAccessor - - name: ApplicationCustomizerContext - uid: sp-application-base.ApplicationCustomizerContext - - name: BaseApplicationCustomizer - uid: sp-application-base.BaseApplicationCustomizer - - name: IPlaceholderCreateContentOptions - uid: sp-application-base.IPlaceholderCreateContentOptions - - name: PlaceholderContent - uid: sp-application-base.PlaceholderContent - - name: PlaceholderName - uid: sp-application-base.PlaceholderName - - name: PlaceholderProvider - uid: sp-application-base.PlaceholderProvider - - name: sp-component-base - uid: sp-component-base - items: - - name: BaseComponent - uid: sp-component-base.BaseComponent - - name: BaseComponentContext - uid: sp-component-base.BaseComponentContext - - name: DynamicDataProvider - uid: sp-component-base.DynamicDataProvider - - name: DynamicDataSourceManager - uid: sp-component-base.DynamicDataSourceManager - - name: DynamicProperty - uid: sp-component-base.DynamicProperty - - name: IFontStyles - uid: sp-component-base.IFontStyles - - name: IPalette - uid: sp-component-base.IPalette - - name: IReadonlyFontStyles - uid: sp-component-base.IReadonlyFontStyles - - name: IReadonlyTheme - uid: sp-component-base.IReadonlyTheme - - name: ISemanticColors - uid: sp-component-base.ISemanticColors - - name: ITheme - uid: sp-component-base.ITheme - - name: ThemeChangedEventArgs - uid: sp-component-base.ThemeChangedEventArgs - - name: ThemeProvider - uid: sp-component-base.ThemeProvider - - name: sp-core-library - uid: sp-core-library - items: - - name: DisplayMode - uid: sp-core-library.DisplayMode - - name: Environment - uid: sp-core-library.Environment - - name: EnvironmentType - uid: sp-core-library.EnvironmentType - - name: Guid - uid: sp-core-library.Guid - - name: IDisposable - uid: sp-core-library.IDisposable - - name: IRandomNumberGenerator - uid: sp-core-library.IRandomNumberGenerator - - name: IServiceCollection - uid: sp-core-library.IServiceCollection - - name: ISPEventObserver - uid: sp-core-library.ISPEventObserver - - name: ITimeProvider - uid: sp-core-library.ITimeProvider - - name: Log - uid: sp-core-library.Log - - name: RandomNumberGenerator - uid: sp-core-library.RandomNumberGenerator - - name: ServiceKey - uid: sp-core-library.ServiceKey - - name: ServiceScope - uid: sp-core-library.ServiceScope - - name: Session - uid: sp-core-library.Session - - name: SPEvent - uid: sp-core-library.SPEvent - - name: SPEventArgs - uid: sp-core-library.SPEventArgs - - name: Text - uid: sp-core-library.Text - - name: TimeProvider - uid: sp-core-library.TimeProvider - - name: UrlQueryParameterCollection - uid: sp-core-library.UrlQueryParameterCollection - - name: Validate - uid: sp-core-library.Validate - - name: Version - uid: sp-core-library.Version - - name: sp-diagnostics - uid: sp-diagnostics - - name: sp-dialog - uid: sp-dialog - items: - - name: BaseDialog - uid: sp-dialog.BaseDialog - - name: Dialog - uid: sp-dialog.Dialog - - name: IAlertOptions - uid: sp-dialog.IAlertOptions - - name: IDialogConfiguration - uid: sp-dialog.IDialogConfiguration - - name: IDialogShowOptions - uid: sp-dialog.IDialogShowOptions - - name: IPromptOptions - uid: sp-dialog.IPromptOptions - - name: ISecondaryDialogProvider - uid: sp-dialog.ISecondaryDialogProvider - - name: sp-dynamic-data - uid: sp-dynamic-data - items: - - name: DynamicDataReference - uid: sp-dynamic-data.DynamicDataReference - - name: IDynamicDataAnnotatedPropertyValue - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue - - name: IDynamicDataCallables - uid: sp-dynamic-data.IDynamicDataCallables - - name: IDynamicDataEventDefinition - uid: sp-dynamic-data.IDynamicDataEventDefinition - - name: IDynamicDataPropertyDefinition - uid: sp-dynamic-data.IDynamicDataPropertyDefinition - - name: IDynamicDataPropertyMetadata - uid: sp-dynamic-data.IDynamicDataPropertyMetadata - - name: IDynamicDataPropertyValueMetadata - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata - - name: IDynamicDataPropertyValueMetadataCollection - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection - - name: IDynamicDataSource - uid: sp-dynamic-data.IDynamicDataSource - - name: IDynamicDataSourceMetadata - uid: sp-dynamic-data.IDynamicDataSourceMetadata - - name: sp-extension-base - uid: sp-extension-base - items: - - name: BaseExtension - uid: sp-extension-base.BaseExtension - - name: ExtensionContext - uid: sp-extension-base.ExtensionContext - - name: sp-http - uid: sp-http - items: - - name: AadHttpClient - uid: sp-http.AadHttpClient - - name: AadHttpClientConfiguration - uid: sp-http.AadHttpClientConfiguration - - name: AadHttpClientFactory - uid: sp-http.AadHttpClientFactory - - name: AadTokenProvider - uid: sp-http.AadTokenProvider - - name: AadTokenProviderFactory - uid: sp-http.AadTokenProviderFactory - - name: DigestCache - uid: sp-http.DigestCache - - name: GraphHttpClient - uid: sp-http.GraphHttpClient - - name: GraphHttpClientConfiguration - uid: sp-http.GraphHttpClientConfiguration - - name: GraphHttpClientResponse - uid: sp-http.GraphHttpClientResponse - - name: GraphRequest - uid: sp-http.GraphRequest - - name: HttpClient - uid: sp-http.HttpClient - - name: HttpClientConfiguration - uid: sp-http.HttpClientConfiguration - - name: HttpClientResponse - uid: sp-http.HttpClientResponse - - name: IAadHttpClientConfiguration - uid: sp-http.IAadHttpClientConfiguration - - name: IAadHttpClientConfigurations - uid: sp-http.IAadHttpClientConfigurations - - name: IAadHttpClientOptions - uid: sp-http.IAadHttpClientOptions - - name: IDigestCache - uid: sp-http.IDigestCache - - name: IGraphHttpClientConfiguration - uid: sp-http.IGraphHttpClientConfiguration - - name: IGraphHttpClientConfigurations - uid: sp-http.IGraphHttpClientConfigurations - - name: IGraphHttpClientOptions - uid: sp-http.IGraphHttpClientOptions - - name: IHttpClientConfiguration - uid: sp-http.IHttpClientConfiguration - - name: IHttpClientConfigurations - uid: sp-http.IHttpClientConfigurations - - name: IHttpClientOptions - uid: sp-http.IHttpClientOptions - - name: ISPHttpClientBatchConfiguration - uid: sp-http.ISPHttpClientBatchConfiguration - - name: ISPHttpClientBatchConfigurations - uid: sp-http.ISPHttpClientBatchConfigurations - - name: ISPHttpClientBatchCreationOptions - uid: sp-http.ISPHttpClientBatchCreationOptions - - name: ISPHttpClientBatchOptions - uid: sp-http.ISPHttpClientBatchOptions - - name: ISPHttpClientCommonConfiguration - uid: sp-http.ISPHttpClientCommonConfiguration - - name: ISPHttpClientConfiguration - uid: sp-http.ISPHttpClientConfiguration - - name: ISPHttpClientConfigurations - uid: sp-http.ISPHttpClientConfigurations - - name: ISPHttpClientOptions - uid: sp-http.ISPHttpClientOptions - - name: MSGraphClient - uid: sp-http.MSGraphClient - - name: MSGraphClientFactory - uid: sp-http.MSGraphClientFactory - - name: ODataVersion - uid: sp-http.ODataVersion - - name: SPHttpClient - uid: sp-http.SPHttpClient - - name: SPHttpClientBatch - uid: sp-http.SPHttpClientBatch - - name: SPHttpClientBatchConfiguration - uid: sp-http.SPHttpClientBatchConfiguration - - name: SPHttpClientCommonConfiguration - uid: sp-http.SPHttpClientCommonConfiguration - - name: SPHttpClientConfiguration - uid: sp-http.SPHttpClientConfiguration - - name: SPHttpClientResponse - uid: sp-http.SPHttpClientResponse - - name: SPHttpHeader - uid: sp-http.SPHttpHeader - - name: TokenAcquisitionEventArgs - uid: sp-http.TokenAcquisitionEventArgs - - name: sp-listview-extensibility - uid: sp-listview-extensibility - items: - - name: BaseFieldCustomizer - uid: sp-listview-extensibility.BaseFieldCustomizer - - name: BaseListViewCommandSet - uid: sp-listview-extensibility.BaseListViewCommandSet - - name: ColumnAccessor - uid: sp-listview-extensibility.ColumnAccessor - - name: Command - uid: sp-listview-extensibility.Command - - name: FieldCustomizerContext - uid: sp-listview-extensibility.FieldCustomizerContext - - name: IFieldCustomizerCellEventParameters - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters - - name: IListViewCommandSetExecuteEventParameters - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters - - name: IListViewCommandSetListViewUpdatedParameters - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters - - name: ListItemAccessor - uid: sp-listview-extensibility.ListItemAccessor - - name: ListViewAccessor - uid: sp-listview-extensibility.ListViewAccessor - - name: ListViewCommandSetContext - uid: sp-listview-extensibility.ListViewCommandSetContext - - name: RowAccessor - uid: sp-listview-extensibility.RowAccessor - - name: SelectedRowsChangedEventArgs - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs - - name: sp-odata-types - uid: sp-odata-types - items: - - name: IODataBasePermission - uid: sp-odata-types.IODataBasePermission - - name: IODataChangeToken - uid: sp-odata-types.IODataChangeToken - - name: IODataContextWebInformation - uid: sp-odata-types.IODataContextWebInformation - - name: IODataList - uid: sp-odata-types.IODataList - - name: IODataListItem - uid: sp-odata-types.IODataListItem - - name: IODataNavigationNode - uid: sp-odata-types.IODataNavigationNode - - name: IODataNavigationNodeCollection - uid: sp-odata-types.IODataNavigationNodeCollection - - name: IODataUser - uid: sp-odata-types.IODataUser - - name: IODataUserCustomAction - uid: sp-odata-types.IODataUserCustomAction - - name: IODataWeb - uid: sp-odata-types.IODataWeb - - name: sp-page-context - uid: sp-page-context - items: - - name: CultureInfo - uid: sp-page-context.CultureInfo - - name: ISPSystemTime - uid: sp-page-context.ISPSystemTime - - name: ISPTimeZoneData - uid: sp-page-context.ISPTimeZoneData - - name: PageContext - uid: sp-page-context.PageContext - - name: SPDayOfWeek - uid: sp-page-context.SPDayOfWeek - - name: SPField - uid: sp-page-context.SPField - - name: SPList - uid: sp-page-context.SPList - - name: SPListItem - uid: sp-page-context.SPListItem - - name: SPPermission - uid: sp-page-context.SPPermission - - name: SPSite - uid: sp-page-context.SPSite - - name: SPTimeZone - uid: sp-page-context.SPTimeZone - - name: SPUser - uid: sp-page-context.SPUser - - name: SPWeb - uid: sp-page-context.SPWeb - - name: sp-webpart-base - uid: sp-webpart-base - items: - - name: BaseClientSideWebPart - uid: sp-webpart-base.BaseClientSideWebPart - - name: BaseWebPart - uid: sp-webpart-base.BaseWebPart - - name: BaseWebPartContext - uid: sp-webpart-base.BaseWebPartContext - - name: DynamicDataSharedDepth - uid: sp-webpart-base.DynamicDataSharedDepth - - name: IClientSideWebPartStatusRenderer - uid: sp-webpart-base.IClientSideWebPartStatusRenderer - - name: IDynamicDataSharedPropertyConfiguration - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration - - name: IDynamicDataSharedPropertyFilters - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters - - name: IDynamicDataSharedSourceConfiguration - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration - - name: IDynamicDataSharedSourceFilters - uid: sp-webpart-base.IDynamicDataSharedSourceFilters - - name: IPlaceholderSpinnerProps - uid: sp-webpart-base.IPlaceholderSpinnerProps - - name: IPropertyPaneAccessor - uid: sp-webpart-base.IPropertyPaneAccessor - - name: IPropertyPaneButtonProps - uid: sp-webpart-base.IPropertyPaneButtonProps - - name: IPropertyPaneCheckboxProps - uid: sp-webpart-base.IPropertyPaneCheckboxProps - - name: IPropertyPaneChoiceGroupOption - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption - - name: IPropertyPaneChoiceGroupOptionIconProps - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps - - name: IPropertyPaneChoiceGroupProps - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps - - name: IPropertyPaneConditionalGroup - uid: sp-webpart-base.IPropertyPaneConditionalGroup - - name: IPropertyPaneConfiguration - uid: sp-webpart-base.IPropertyPaneConfiguration - - name: IPropertyPaneCustomFieldProps - uid: sp-webpart-base.IPropertyPaneCustomFieldProps - - name: IPropertyPaneDropdownCalloutProps - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps - - name: IPropertyPaneDropdownOption - uid: sp-webpart-base.IPropertyPaneDropdownOption - - name: IPropertyPaneDropdownProps - uid: sp-webpart-base.IPropertyPaneDropdownProps - - name: IPropertyPaneDynamicFieldProps - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps - - name: IPropertyPaneDynamicFieldSetProps - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps - - name: IPropertyPaneDynamicTextFieldProps - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps - - name: IPropertyPaneField - uid: sp-webpart-base.IPropertyPaneField - - name: IPropertyPaneGroup - uid: sp-webpart-base.IPropertyPaneGroup - - name: IPropertyPaneLabelProps - uid: sp-webpart-base.IPropertyPaneLabelProps - - name: IPropertyPaneLinkProps - uid: sp-webpart-base.IPropertyPaneLinkProps - - name: IPropertyPanePage - uid: sp-webpart-base.IPropertyPanePage - - name: IPropertyPanePageHeader - uid: sp-webpart-base.IPropertyPanePageHeader - - name: IPropertyPaneSliderProps - uid: sp-webpart-base.IPropertyPaneSliderProps - - name: IPropertyPaneTextFieldProps - uid: sp-webpart-base.IPropertyPaneTextFieldProps - - name: IPropertyPaneToggleProps - uid: sp-webpart-base.IPropertyPaneToggleProps - - name: ISerializedServerProcessedData - uid: sp-webpart-base.ISerializedServerProcessedData - - name: ISerializedWebPartData - uid: sp-webpart-base.ISerializedWebPartData - - name: IWebPartContext - uid: sp-webpart-base.IWebPartContext - - name: IWebPartData - uid: sp-webpart-base.IWebPartData - - name: IWebPartPropertiesMetadata - uid: sp-webpart-base.IWebPartPropertiesMetadata - - name: IWebPartPropertyMetadata - uid: sp-webpart-base.IWebPartPropertyMetadata - - name: PropertyPaneButtonType - uid: sp-webpart-base.PropertyPaneButtonType - - name: PropertyPaneDropdownOptionType - uid: sp-webpart-base.PropertyPaneDropdownOptionType - - name: PropertyPaneFieldType - uid: sp-webpart-base.PropertyPaneFieldType - - name: WebPartContext - uid: sp-webpart-base.WebPartContext - - name: WebPartFormFactor - uid: sp-webpart-base.WebPartFormFactor +items: + - name: SharePoint Framework reference + href: ~/overview/sharepoint.md + items: + - name: decorators + uid: decorators + - name: sp-application-base + uid: sp-application-base + items: + - name: ApplicationAccessor + uid: sp-application-base.ApplicationAccessor + - name: ApplicationCustomizerContext + uid: sp-application-base.ApplicationCustomizerContext + - name: BaseApplicationCustomizer + uid: sp-application-base.BaseApplicationCustomizer + - name: IPlaceholderCreateContentOptions + uid: sp-application-base.IPlaceholderCreateContentOptions + - name: PlaceholderContent + uid: sp-application-base.PlaceholderContent + - name: PlaceholderName + uid: sp-application-base.PlaceholderName + - name: PlaceholderProvider + uid: sp-application-base.PlaceholderProvider + - name: sp-component-base + uid: sp-component-base + items: + - name: BaseComponent + uid: sp-component-base.BaseComponent + - name: BaseComponentContext + uid: sp-component-base.BaseComponentContext + - name: DynamicDataProvider + uid: sp-component-base.DynamicDataProvider + - name: DynamicDataSourceManager + uid: sp-component-base.DynamicDataSourceManager + - name: DynamicProperty + uid: sp-component-base.DynamicProperty + - name: IFontStyles + uid: sp-component-base.IFontStyles + - name: IPalette + uid: sp-component-base.IPalette + - name: IRawStyle + uid: sp-component-base.IRawStyle + - name: IReadonlyFontStyles + uid: sp-component-base.IReadonlyFontStyles + - name: IReadonlyTheme + uid: sp-component-base.IReadonlyTheme + - name: ISemanticColors + uid: sp-component-base.ISemanticColors + - name: ISemanticTextColors + uid: sp-component-base.ISemanticTextColors + - name: ITheme + uid: sp-component-base.ITheme + - name: ThemeChangedEventArgs + uid: sp-component-base.ThemeChangedEventArgs + - name: ThemeProvider + uid: sp-component-base.ThemeProvider + - name: sp-core-library + uid: sp-core-library + items: + - name: DisplayMode + uid: sp-core-library.DisplayMode + - name: Environment + uid: sp-core-library.Environment + - name: EnvironmentType + uid: sp-core-library.EnvironmentType + - name: Guid + uid: sp-core-library.Guid + - name: IDisposable + uid: sp-core-library.IDisposable + - name: IRandomNumberGenerator + uid: sp-core-library.IRandomNumberGenerator + - name: IServiceCollection + uid: sp-core-library.IServiceCollection + - name: ISPEventObserver + uid: sp-core-library.ISPEventObserver + - name: ITimeProvider + uid: sp-core-library.ITimeProvider + - name: Log + uid: sp-core-library.Log + - name: RandomNumberGenerator + uid: sp-core-library.RandomNumberGenerator + - name: ServiceKey + uid: sp-core-library.ServiceKey + - name: ServiceScope + uid: sp-core-library.ServiceScope + - name: Session + uid: sp-core-library.Session + - name: SPEvent + uid: sp-core-library.SPEvent + - name: SPEventArgs + uid: sp-core-library.SPEventArgs + - name: Text + uid: sp-core-library.Text + - name: TimeProvider + uid: sp-core-library.TimeProvider + - name: UrlQueryParameterCollection + uid: sp-core-library.UrlQueryParameterCollection + - name: Validate + uid: sp-core-library.Validate + - name: Version + uid: sp-core-library.Version + - name: sp-diagnostics + uid: sp-diagnostics + - name: sp-dialog + uid: sp-dialog + items: + - name: BaseDialog + uid: sp-dialog.BaseDialog + - name: Dialog + uid: sp-dialog.Dialog + - name: IAlertOptions + uid: sp-dialog.IAlertOptions + - name: IDialogConfiguration + uid: sp-dialog.IDialogConfiguration + - name: IDialogShowOptions + uid: sp-dialog.IDialogShowOptions + - name: IPromptOptions + uid: sp-dialog.IPromptOptions + - name: ISecondaryDialogProvider + uid: sp-dialog.ISecondaryDialogProvider + - name: sp-dynamic-data + uid: sp-dynamic-data + items: + - name: DynamicDataReference + uid: sp-dynamic-data.DynamicDataReference + - name: IDynamicDataAnnotatedPropertyValue + uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + - name: IDynamicDataCallables + uid: sp-dynamic-data.IDynamicDataCallables + - name: IDynamicDataEventDefinition + uid: sp-dynamic-data.IDynamicDataEventDefinition + - name: IDynamicDataPropertyDefinition + uid: sp-dynamic-data.IDynamicDataPropertyDefinition + - name: IDynamicDataPropertyMetadata + uid: sp-dynamic-data.IDynamicDataPropertyMetadata + - name: IDynamicDataPropertyValueMetadata + uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + - name: IDynamicDataPropertyValueMetadataCollection + uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + - name: IDynamicDataSource + uid: sp-dynamic-data.IDynamicDataSource + - name: IDynamicDataSourceMetadata + uid: sp-dynamic-data.IDynamicDataSourceMetadata + - name: sp-extension-base + uid: sp-extension-base + items: + - name: BaseExtension + uid: sp-extension-base.BaseExtension + - name: ExtensionContext + uid: sp-extension-base.ExtensionContext + - name: sp-http + uid: sp-http + items: + - name: AadHttpClient + uid: sp-http.AadHttpClient + - name: AadHttpClientConfiguration + uid: sp-http.AadHttpClientConfiguration + - name: AadHttpClientFactory + uid: sp-http.AadHttpClientFactory + - name: AadTokenProvider + uid: sp-http.AadTokenProvider + - name: AadTokenProviderFactory + uid: sp-http.AadTokenProviderFactory + - name: DigestCache + uid: sp-http.DigestCache + - name: GraphRequest + uid: sp-http.GraphRequest + - name: HttpClient + uid: sp-http.HttpClient + - name: HttpClientConfiguration + uid: sp-http.HttpClientConfiguration + - name: HttpClientResponse + uid: sp-http.HttpClientResponse + - name: IAadHttpClientConfiguration + uid: sp-http.IAadHttpClientConfiguration + - name: IAadHttpClientConfigurations + uid: sp-http.IAadHttpClientConfigurations + - name: IAadHttpClientOptions + uid: sp-http.IAadHttpClientOptions + - name: IAadTokenProvider + uid: sp-http.IAadTokenProvider + - name: IAadTokenProviderConfiguration + uid: sp-http.IAadTokenProviderConfiguration + - name: IDigestCache + uid: sp-http.IDigestCache + - name: IGraphHttpClientOptions + uid: sp-http.IGraphHttpClientOptions + - name: IHttpClientConfiguration + uid: sp-http.IHttpClientConfiguration + - name: IHttpClientConfigurations + uid: sp-http.IHttpClientConfigurations + - name: IHttpClientOptions + uid: sp-http.IHttpClientOptions + - name: ISPHttpClientBatchConfiguration + uid: sp-http.ISPHttpClientBatchConfiguration + - name: ISPHttpClientBatchConfigurations + uid: sp-http.ISPHttpClientBatchConfigurations + - name: ISPHttpClientBatchCreationOptions + uid: sp-http.ISPHttpClientBatchCreationOptions + - name: ISPHttpClientBatchOptions + uid: sp-http.ISPHttpClientBatchOptions + - name: ISPHttpClientCommonConfiguration + uid: sp-http.ISPHttpClientCommonConfiguration + - name: ISPHttpClientConfiguration + uid: sp-http.ISPHttpClientConfiguration + - name: ISPHttpClientConfigurations + uid: sp-http.ISPHttpClientConfigurations + - name: ISPHttpClientOptions + uid: sp-http.ISPHttpClientOptions + - name: ITokenAcquisitionEventArgs + uid: sp-http.ITokenAcquisitionEventArgs + - name: MSGraphClient + uid: sp-http.MSGraphClient + - name: MSGraphClientFactory + uid: sp-http.MSGraphClientFactory + - name: ODataVersion + uid: sp-http.ODataVersion + - name: SPHttpClient + uid: sp-http.SPHttpClient + - name: SPHttpClientBatch + uid: sp-http.SPHttpClientBatch + - name: SPHttpClientBatchConfiguration + uid: sp-http.SPHttpClientBatchConfiguration + - name: SPHttpClientCommonConfiguration + uid: sp-http.SPHttpClientCommonConfiguration + - name: SPHttpClientConfiguration + uid: sp-http.SPHttpClientConfiguration + - name: SPHttpClientResponse + uid: sp-http.SPHttpClientResponse + - name: SPHttpHeader + uid: sp-http.SPHttpHeader + - name: TokenAcquisitionEventArgs + uid: sp-http.TokenAcquisitionEventArgs + - name: sp-listview-extensibility + uid: sp-listview-extensibility + items: + - name: BaseFieldCustomizer + uid: sp-listview-extensibility.BaseFieldCustomizer + - name: BaseListViewCommandSet + uid: sp-listview-extensibility.BaseListViewCommandSet + - name: ColumnAccessor + uid: sp-listview-extensibility.ColumnAccessor + - name: Command + uid: sp-listview-extensibility.Command + - name: FieldCustomizerContext + uid: sp-listview-extensibility.FieldCustomizerContext + - name: IFieldCustomizerCellEventParameters + uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters + - name: IListViewCommandSetExecuteEventParameters + uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters + - name: IListViewCommandSetListViewUpdatedParameters + uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters + - name: ListItemAccessor + uid: sp-listview-extensibility.ListItemAccessor + - name: ListViewAccessor + uid: sp-listview-extensibility.ListViewAccessor + - name: ListViewCommandSetContext + uid: sp-listview-extensibility.ListViewCommandSetContext + - name: RowAccessor + uid: sp-listview-extensibility.RowAccessor + - name: SelectedRowsChangedEventArgs + uid: sp-listview-extensibility.SelectedRowsChangedEventArgs + - name: sp-odata-types + uid: sp-odata-types + items: + - name: _IODataUserId + uid: sp-odata-types._IODataUserId + - name: IODataBasePermission + uid: sp-odata-types.IODataBasePermission + - name: IODataChangeToken + uid: sp-odata-types.IODataChangeToken + - name: IODataContextWebInformation + uid: sp-odata-types.IODataContextWebInformation + - name: IODataList + uid: sp-odata-types.IODataList + - name: IODataListItem + uid: sp-odata-types.IODataListItem + - name: IODataNavigationNode + uid: sp-odata-types.IODataNavigationNode + - name: IODataNavigationNodeCollection + uid: sp-odata-types.IODataNavigationNodeCollection + - name: IODataUser + uid: sp-odata-types.IODataUser + - name: IODataUserCustomAction + uid: sp-odata-types.IODataUserCustomAction + - name: IODataWeb + uid: sp-odata-types.IODataWeb + - name: sp-page-context + uid: sp-page-context + items: + - name: CultureInfo + uid: sp-page-context.CultureInfo + - name: ISPSystemTime + uid: sp-page-context.ISPSystemTime + - name: ISPTimeZoneData + uid: sp-page-context.ISPTimeZoneData + - name: PageContext + uid: sp-page-context.PageContext + - name: SPDayOfWeek + uid: sp-page-context.SPDayOfWeek + - name: SPField + uid: sp-page-context.SPField + - name: SPList + uid: sp-page-context.SPList + - name: SPListItem + uid: sp-page-context.SPListItem + - name: SPPermission + uid: sp-page-context.SPPermission + - name: SPSite + uid: sp-page-context.SPSite + - name: SPTimeZone + uid: sp-page-context.SPTimeZone + - name: SPUser + uid: sp-page-context.SPUser + - name: SPWeb + uid: sp-page-context.SPWeb + - name: sp-webpart-base + uid: sp-webpart-base + items: + - name: BaseClientSideWebPart + uid: sp-webpart-base.BaseClientSideWebPart + - name: BaseWebPart + uid: sp-webpart-base.BaseWebPart + - name: BaseWebPartContext + uid: sp-webpart-base.BaseWebPartContext + - name: DynamicDataSharedDepth + uid: sp-webpart-base.DynamicDataSharedDepth + - name: IClientSideWebPartStatusRenderer + uid: sp-webpart-base.IClientSideWebPartStatusRenderer + - name: IDynamicDataSharedPropertyConfiguration + uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + - name: IDynamicDataSharedPropertyFilters + uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + - name: IDynamicDataSharedSourceConfiguration + uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + - name: IDynamicDataSharedSourceFilters + uid: sp-webpart-base.IDynamicDataSharedSourceFilters + - name: IMicrosoftTeams + uid: sp-webpart-base.IMicrosoftTeams + - name: IPropertyPaneAccessor + uid: sp-webpart-base.IPropertyPaneAccessor + - name: IPropertyPaneButtonProps + uid: sp-webpart-base.IPropertyPaneButtonProps + - name: IPropertyPaneCheckboxProps + uid: sp-webpart-base.IPropertyPaneCheckboxProps + - name: IPropertyPaneChoiceGroupOption + uid: sp-webpart-base.IPropertyPaneChoiceGroupOption + - name: IPropertyPaneChoiceGroupOptionIconProps + uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + - name: IPropertyPaneChoiceGroupProps + uid: sp-webpart-base.IPropertyPaneChoiceGroupProps + - name: IPropertyPaneConditionalGroup + uid: sp-webpart-base.IPropertyPaneConditionalGroup + - name: IPropertyPaneConfiguration + uid: sp-webpart-base.IPropertyPaneConfiguration + - name: IPropertyPaneCustomFieldProps + uid: sp-webpart-base.IPropertyPaneCustomFieldProps + - name: IPropertyPaneDropdownCalloutProps + uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps + - name: IPropertyPaneDropdownOption + uid: sp-webpart-base.IPropertyPaneDropdownOption + - name: IPropertyPaneDropdownProps + uid: sp-webpart-base.IPropertyPaneDropdownProps + - name: IPropertyPaneDynamicFieldFilters + uid: sp-webpart-base.IPropertyPaneDynamicFieldFilters + - name: IPropertyPaneDynamicFieldProps + uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + - name: IPropertyPaneDynamicFieldSetProps + uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + - name: IPropertyPaneDynamicTextFieldProps + uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + - name: IPropertyPaneField + uid: sp-webpart-base.IPropertyPaneField + - name: IPropertyPaneGroup + uid: sp-webpart-base.IPropertyPaneGroup + - name: IPropertyPaneLabelProps + uid: sp-webpart-base.IPropertyPaneLabelProps + - name: IPropertyPaneLinkProps + uid: sp-webpart-base.IPropertyPaneLinkProps + - name: IPropertyPanePage + uid: sp-webpart-base.IPropertyPanePage + - name: IPropertyPanePageHeader + uid: sp-webpart-base.IPropertyPanePageHeader + - name: IPropertyPaneSliderProps + uid: sp-webpart-base.IPropertyPaneSliderProps + - name: IPropertyPaneTextFieldProps + uid: sp-webpart-base.IPropertyPaneTextFieldProps + - name: IPropertyPaneToggleProps + uid: sp-webpart-base.IPropertyPaneToggleProps + - name: ISDKs + uid: sp-webpart-base.ISDKs + - name: ISerializedServerProcessedData + uid: sp-webpart-base.ISerializedServerProcessedData + - name: ISerializedWebPartData + uid: sp-webpart-base.ISerializedWebPartData + - name: IWebPartContext + uid: sp-webpart-base.IWebPartContext + - name: IWebPartData + uid: sp-webpart-base.IWebPartData + - name: IWebPartPropertiesMetadata + uid: sp-webpart-base.IWebPartPropertiesMetadata + - name: IWebPartPropertyMetadata + uid: sp-webpart-base.IWebPartPropertyMetadata + - name: PropertyPaneButtonType + uid: sp-webpart-base.PropertyPaneButtonType + - name: PropertyPaneDropdownOptionType + uid: sp-webpart-base.PropertyPaneDropdownOptionType + - name: PropertyPaneFieldType + uid: sp-webpart-base.PropertyPaneFieldType + - name: WebPartContext + uid: sp-webpart-base.WebPartContext + - name: WebPartFormFactor + uid: sp-webpart-base.WebPartFormFactor diff --git a/generate-docs/json/decorators.api.json b/generate-docs/json/decorators.api.json index 4f29e5b5..38f68356 100644 --- a/generate-docs/json/decorators.api.json +++ b/generate-docs/json/decorators.api.json @@ -1,124 +1,297 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/decorators", + "docComment": "/**\n * A conservative set of decorators intended for use in both NodeJS and web browser projects.\n *\n * @remarks\n *\n * This package provides a small set of decorators that enable more rigorous specification of API contracts when using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This package is not intended to be a general toolkit of language extensions or helpful macros.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/decorators", - "summary": [ + "members": [ { - "kind": "text", - "text": "A conservative set of decorators intended for use in both NodeJS and web browser projects." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package provides a small set of decorators that enable more rigorous specification of API contracts when using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This package is not intended to be a general toolkit of language extensions or helpful macros." - } - ], - "exports": { - "override": { - "kind": "function", - "signature": "export function override(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "target": { - "name": "target", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Object" - }, - "propertyKey": { - "name": "propertyKey", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | symbol" - }, - "descriptor": { - "name": "descriptor", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "TypedPropertyDescriptor" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "text", - "text": "This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." - } - ], - "remarks": [], - "isBeta": false - }, - "sealed": { - "kind": "function", - "signature": "export function sealed(target: Function): void;", - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "target": { - "name": "target", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Function" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." - } - ], - "remarks": [], - "isBeta": false - }, - "virtual": { - "kind": "function", - "signature": "export function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void;", - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "target": { - "name": "target", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Object" + "kind": "Function", + "canonicalReference": "(override:0)", + "docComment": "/**\n * This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as \\@virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function " + }, + { + "kind": "Reference", + "text": "override" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "target" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Object" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "propertyKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | symbol" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "descriptor" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TypedPropertyDescriptor" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "propertyKey", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "descriptor", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + } + } + ], + "name": "override" }, - "propertyKey": { - "name": "propertyKey", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | symbol" + { + "kind": "Function", + "canonicalReference": "(sealed:0)", + "docComment": "/**\n * This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function " + }, + { + "kind": "Reference", + "text": "sealed" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "target" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Function" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "sealed" }, - "descriptor": { - "name": "descriptor", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "TypedPropertyDescriptor" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime." + "kind": "Function", + "canonicalReference": "(virtual:0)", + "docComment": "/**\n * This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child class. Conversely, if the \\@virtual decorator is NOT applied to a definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function " + }, + { + "kind": "Reference", + "text": "virtual" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "target" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Object" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "propertyKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | symbol" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "descriptor" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TypedPropertyDescriptor" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "propertyKey", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "descriptor", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + } + } + ], + "name": "virtual" } - ], - "remarks": [], - "isBeta": false + ] } - } + ] } diff --git a/generate-docs/json/recopy.bat b/generate-docs/json/recopy.bat index 2a76fe03..64f57e72 100644 --- a/generate-docs/json/recopy.bat +++ b/generate-docs/json/recopy.bat @@ -1,17 +1,17 @@ @echo off -copy /y ..\..\..\sp-client\spfx-core\sp-application-base\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-component-base\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-core-library\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-extension-base\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-http\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-odata-types\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-page-context\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-webpart-base\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\decorators\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-application-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-component-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-core-library\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-extension-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-http\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-odata-types\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-page-context\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-webpart-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\decorators\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-dialog\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\dist\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-diagnostics\dist\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-dialog\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-diagnostics\temp\*.api.json . pause diff --git a/generate-docs/json/sp-application-base.api.json b/generate-docs/json/sp-application-base.api.json index 66c76289..93b64deb 100644 --- a/generate-docs/json/sp-application-base.api.json +++ b/generate-docs/json/sp-application-base.api.json @@ -1,963 +1,1067 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-application-base", + "docComment": "/**\n * SharePoint Framework support for building and extending client-side applications.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-application-base", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for building and extending client-side applications." - } - ], - "remarks": [], - "exports": { - "ApplicationAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the client-side application that is currently running." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The client-side application determines the user experience for an entire web page. (It is a client-side component with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different application." - }, - { - "kind": "paragraph" - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "text", - "text": "The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(ApplicationAccessor:class)", + "docComment": "/**\n * Provides access to the client-side application that is currently running.\n *\n * @remarks\n *\n * The client-side application determines the user experience for an entire web page. (It is a client-side component with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different application.\n *\n * The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": "export default class " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ApplicationAccessor" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "ApplicationAccessor", - "memberName": "" - } + "kind": "Reference", + "text": "ApplicationAccessor" }, { - "kind": "text", - "text": " class." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "ApplicationAccessor", + "members": [ { - "kind": "text", - "text": "Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the {@link ApplicationAccessor} class.\n *\n * @remarks\n *\n * Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example {@link BaseApplicationCustomizer.context}.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, { - "kind": "text", - "text": "BaseApplicationCustomizer.context" + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "BaseApplicationCustomizer", - "memberName": "context" - } + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, { - "kind": "text", - "text": "." + "kind": "Property", + "canonicalReference": "(navigatedEvent:instance)", + "docComment": "/**\n * An event that is fired when the application's top-level page context navigates to a new page.\n *\n * @remarks\n *\n * This event fires after the top-level {@link @microsoft/sp-page-context#PageContext} has navigated to a new page.\n *\n * @eventproperty\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "navigatedEvent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPEvent" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPEventArgs" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "navigatedEvent", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false } - ] + ], + "implementsTokenRanges": [] }, - "navigatedEvent": { - "kind": "property", - "signature": "readonly navigatedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An event that is fired when the application's top-level page context navigates to a new page." + { + "kind": "Class", + "canonicalReference": "(ApplicationCustomizerContext:class)", + "docComment": "/**\n * The component context for {@link BaseApplicationCustomizer}.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "ApplicationCustomizerContext" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "ExtensionContext" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "ApplicationCustomizerContext", + "members": [ { - "kind": "text", - "text": "This event fires after the top-level " + "kind": "Property", + "canonicalReference": "(application:instance)", + "docComment": "/**\n * Provides access to the client-side application that is currently running.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "application" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ApplicationAccessor" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "application", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "PageContext" + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-page-context", - "exportName": "PageContext", - "memberName": "" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "text", - "text": " has navigated to a new page." + "kind": "Property", + "canonicalReference": "(placeholderProvider:instance)", + "docComment": "/**\n * Exposes a collection of content placeholders for use by third parties.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "placeholderProvider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PlaceholderProvider" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "placeholderProvider", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": true - } - } - }, - "ApplicationCustomizerContext": { - "kind": "class", - "extends": "ExtensionContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The component context for " + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] }, { - "kind": "api-link", - "elements": [ + "kind": "Class", + "canonicalReference": "(BaseApplicationCustomizer:class)", + "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting.\n *\n * @remarks\n *\n * In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\".\n *\n * Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default abstract class " + }, { - "kind": "text", + "kind": "Reference", "text": "BaseApplicationCustomizer" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "BaseApplicationCustomizer", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ApplicationCustomizerContext class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "application": { - "kind": "property", - "signature": "readonly application: ApplicationAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ApplicationAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the client-side application that is currently running." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "placeholderProvider": { - "kind": "property", - "signature": "readonly placeholderProvider: PlaceholderProvider;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PlaceholderProvider", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Exposes a collection of content placeholders for use by third parties." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "BaseApplicationCustomizer": { - "kind": "class", - "extends": "BaseExtension", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting." - } - ], - "remarks": [ - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\"." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "protected readonly context: ApplicationCustomizerContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ApplicationCustomizerContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ + }, { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": "> extends " + }, + { + "kind": "Reference", + "text": "BaseExtension" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, { - "kind": "text", - "text": "Disposes the component." + "kind": "Content", + "text": "> " } ], - "remarks": [ + "releaseTag": "Public", + "name": "BaseApplicationCustomizer", + "members": [ { - "kind": "text", - "text": "Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the " + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ApplicationCustomizerContext" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.dispose}\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "BaseComponent.onDispose" + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "BaseComponent", - "memberName": "onDispose" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "text", - "text": " method." + "kind": "Method", + "canonicalReference": "(onPlaceholdersChanged:instance,0)", + "docComment": "/**\n * This event method is called when the placeholders of the host application change, come into existence, or disappear.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onPlaceholdersChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "placeholderProvider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PlaceholderProvider" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "placeholderProvider", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "onPlaceholdersChanged" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPlaceholdersChanged": { - "kind": "method", - "signature": "protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] + "extendsTokenRange": { + "startIndex": 5, + "endIndex": 9 }, - "parameters": { - "placeholderProvider": { - "name": "placeholderProvider", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "PlaceholderProvider" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called when the placeholders of the host application change, come into existence, or disappear." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPlaceholderCreateContentOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for the " + "implementsTokenRanges": [] }, { - "kind": "api-link", - "elements": [ + "kind": "Interface", + "canonicalReference": "(IPlaceholderCreateContentOptions:interface)", + "docComment": "/**\n * Options for the {@link PlaceholderProvider.tryCreateContent} method.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "PlaceholderProvider.tryCreateContent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "tryCreateContent" - } - }, - { - "kind": "text", - "text": " method." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "onDispose": { - "kind": "property", - "signature": "onDispose?: (placeholderContent: PlaceholderContent) => void;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(placeholderContent: PlaceholderContent) => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An optional callback that will be invoked when the PlaceholderContent object is disposed." - } - ], - "remarks": [ + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPlaceholderCreateContentOptions" + }, { - "kind": "text", - "text": "To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "PlaceholderContent": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents custom content that is rendered inside a placeholder on a SharePoint page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderContent class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This object is returned by " - }, - { - "kind": "api-link", - "elements": [ + "releaseTag": "Public", + "name": "IPlaceholderCreateContentOptions", + "members": [ { - "kind": "text", - "text": "PlaceholderProvider.tryCreateContent" + "kind": "PropertySignature", + "canonicalReference": "onDispose", + "docComment": "/**\n * An optional callback that will be invoked when the PlaceholderContent object is disposed.\n *\n * @remarks\n *\n * To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "onDispose" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "placeholderContent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PlaceholderContent" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onDispose", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 7 + } } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "tryCreateContent" - } + "extendsTokenRanges": [] }, { - "kind": "text", - "text": ". It provides access to a Document Object Model (DOM) element where the owner can render its custom content." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(PlaceholderContent:class)", + "docComment": "/**\n * Represents custom content that is rendered inside a placeholder on a SharePoint page.\n *\n * @remarks\n *\n * This object is returned by {@link PlaceholderProvider.tryCreateContent}. It provides access to a Document Object Model (DOM) element where the owner can render its custom content.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderContent` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Disposes the PlaceholderContent object and removes its attached DOM element from the page." + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "PlaceholderContent" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "PlaceholderContent", + "members": [ { - "kind": "text", - "text": "This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the application when the containing placeholder is disposed. Calling dispose() invokes the " + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * Disposes the PlaceholderContent object and removes its attached DOM element from the page.\n *\n * @remarks\n *\n * This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the application when the containing placeholder is disposed. Calling dispose() invokes the {@link IPlaceholderCreateContentOptions.onDispose} callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(domElement:instance)", + "docComment": "/**\n * The Document Object Model (DOM) element where the owner should render its custom content.\n *\n * @remarks\n *\n * If the caller needs to be notified when the DOM element is disposed, use the {@link IPlaceholderCreateContentOptions.onDispose} callback.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "IPlaceholderCreateContentOptions.onDispose" + "kind": "Reference", + "text": "HTMLDivElement" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "IPlaceholderCreateContentOptions", - "memberName": "onDispose" - } + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLDivElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLDivElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Document Object Model (DOM) element where the owner should render its custom content." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the caller needs to be notified when the DOM element is disposed, use the " + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(isVisible:instance)", + "docComment": "/**\n * Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isVisible" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "IPlaceholderCreateContentOptions.onDispose" + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "IPlaceholderCreateContentOptions", - "memberName": "onDispose" - } + "releaseTag": "Public", + "name": "isVisible", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " callback." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isVisible": { - "kind": "property", - "signature": "readonly isVisible: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "name": { - "kind": "property", - "signature": "readonly name: PlaceholderName;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PlaceholderName", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Identifies the placeholder that this content was added to." + "kind": "Property", + "canonicalReference": "(name:instance)", + "docComment": "/**\n * Identifies the placeholder that this content was added to.\n *\n * @remarks\n *\n * Example: PlaceholderName.Top\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "name" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PlaceholderName" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "Example: PlaceholderName.Top" + "startIndex": 3, + "endIndex": 5 } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "PlaceholderName": { - "kind": "enum", - "values": { - "Bottom": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A region at the bottom of the page." - } - ], - "remarks": [], - "isBeta": false - }, - "Top": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A region at the top of the page." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The identifier for a content placeholder, which is a region on the page where third-party extensibility components can render custom content." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For more information about placeholders, see " + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Enum", + "canonicalReference": "(PlaceholderName:enum)", + "docComment": "/**\n * The identifier for a content placeholder, which is a region on the page where third-party extensibility components can render custom content.\n *\n * @remarks\n *\n * For more information about placeholders, see {@link PlaceholderProvider}.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "PlaceholderProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "isBeta": false - }, - "PlaceholderProvider": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderProvider class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Placeholders are designated regions on the page, identified by one of the predefined " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": "declare enum " + }, { - "kind": "text", + "kind": "Reference", "text": "PlaceholderName" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderName", - "memberName": "" - } - }, - { - "kind": "text", - "text": " constants. Different applications and pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, for example via in-place navigation. Third-party components should not assume that a given placeholder will always be available." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Use " - }, - { - "kind": "api-link", - "elements": [ + }, { - "kind": "text", - "text": "PlaceholderProvider.tryCreateContent" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "tryCreateContent" - } - }, - { - "kind": "text", - "text": " to test whether a placeholder is available and add content to it. Use the " - }, - { - "kind": "api-link", - "elements": [ + "releaseTag": "Public", + "name": "PlaceholderName", + "members": [ { - "kind": "text", - "text": "PlaceholderProvider.changedEvent" + "kind": "EnumMember", + "canonicalReference": "Bottom", + "docComment": "/**\n * A region at the bottom of the page.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Bottom" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Bottom", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Top", + "docComment": "/**\n * A region at the top of the page.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Top" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Top", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-application-base", - "exportName": "PlaceholderProvider", - "memberName": "changedEvent" - } + ] }, { - "kind": "text", - "text": " event to discover when new placeholders appear." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "changedEvent": { - "kind": "property", - "signature": "readonly changedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event is raised when the list of currently available placeholders is changed." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(PlaceholderProvider:class)", + "docComment": "/**\n * Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page.\n *\n * @remarks\n *\n * Placeholders are designated regions on the page, identified by one of the predefined {@link PlaceholderName} constants. Different applications and pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, for example via in-place navigation. Third-party components should not assume that a given placeholder will always be available.\n *\n * Use {@link PlaceholderProvider.tryCreateContent} to test whether a placeholder is available and add content to it. Use the {@link PlaceholderProvider.changedEvent} event to discover when new placeholders appear.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderProvider` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": true - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "placeholderNames": { - "kind": "property", - "signature": "readonly placeholderNames: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the names of the currently available placeholders." + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "PlaceholderProvider" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tryCreateContent": { - "kind": "method", - "signature": "tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "PlaceholderContent | undefined", - "description": [ - { - "kind": "text", - "text": "A new PlaceholderContent object, or undefined if the requested placeholder does not exist." - } - ] - }, - "parameters": { - "name": { - "name": "name", - "description": [ + "releaseTag": "Public", + "name": "PlaceholderProvider", + "members": [ + { + "kind": "Property", + "canonicalReference": "(changedEvent:instance)", + "docComment": "/**\n * This event is raised when the list of currently available placeholders is changed.\n *\n * @remarks\n *\n * The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear.\n *\n * @eventproperty\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "changedEvent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPEvent" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPEventArgs" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "changedEvent", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, { - "kind": "text", - "text": "The requested placeholder" + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "PlaceholderName" + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, - "options": { - "name": "options", - "description": [ + { + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "Additional options, for example to detect when the placeholder is disposed." + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "IPlaceholderCreateContentOptions" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(placeholderNames:instance)", + "docComment": "/**\n * Returns the names of the currently available placeholders.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "placeholderNames" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PlaceholderName" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "placeholderNames", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder." + "kind": "Method", + "canonicalReference": "(tryCreateContent:instance,0)", + "docComment": "/**\n * Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder.\n *\n * @remarks\n *\n * The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder.\n *\n * @param name - The requested placeholder\n *\n * @param options - Additional options, for example to detect when the placeholder is disposed.\n *\n * @returns A new PlaceholderContent object, or undefined if the requested placeholder does not exist.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryCreateContent" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "name" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PlaceholderName" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IPlaceholderCreateContentOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "PlaceholderContent" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "tryCreateContent" } ], - "remarks": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder." + "startIndex": 3, + "endIndex": 5 } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-component-base.api.json b/generate-docs/json/sp-component-base.api.json index 954a103e..5ee4cf76 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -1,5214 +1,7758 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-component-base", + "docComment": "/**\n * SharePoint Framework support for building client-side components\n *\n * @remarks\n *\n * This package supports development of client-side components (e.g. web parts, client-side extensions, and applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-component-base", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for building client-side components" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package supports development of client-side components (e.g. web parts, client-side extensions, and applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types." - } - ], - "exports": { - "BaseComponent": { - "kind": "class", - "extends": "", - "implements": "ISPEventObserver", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for client-side components such as BaseClientSideWebPart or BaseExtension." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponent class." - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "componentId": { - "kind": "property", - "signature": "readonly componentId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the component identifier as defined in the component’s associated manifest." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(BaseComponent:class)", + "docComment": "/**\n * The base class for client-side components such as BaseClientSideWebPart or BaseExtension.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponent` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "context": { - "kind": "property", - "signature": "protected context: BaseComponentContext;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "BaseComponentContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default abstract class " + }, { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "BaseComponent" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "ISPEventObserver" + }, { - "kind": "text", - "text": "Disposes the component." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "BaseComponent", + "members": [ { - "kind": "text", - "text": "Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the " + "kind": "Property", + "canonicalReference": "(componentId:instance)", + "docComment": "/**\n * Returns the component identifier as defined in the component’s associated manifest.\n *\n * @remarks\n *\n * Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "componentId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * Use the context object to access common services and state associated with the component.\n *\n * @remarks\n *\n * Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "BaseComponent.onDispose" + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "BaseComponentContext" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "BaseComponent", - "memberName": "onDispose" - } + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " method." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the instance of the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the component has been already disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideComponentManifest;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideComponentManifest", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the manifest for the client-side component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes can override this with more specialized manifest types." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onDispose": { - "kind": "method", - "signature": "protected onDispose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "BaseComponentContext": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for context objects for client-side components." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseComponentContext class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A \"context\" object is a collection of well-known services and other objects that are likely to be needed by business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "aadHttpClientFactory": { - "kind": "property", - "signature": "readonly aadHttpClientFactory: AadHttpClientFactory;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AadHttpClientFactory", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of AadHttpClientFactory created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "aadTokenProviderFactory": { - "kind": "property", - "signature": "readonly aadTokenProviderFactory: AadTokenProviderFactory;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AadTokenProviderFactory", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of AadTokenProviderFactory created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disposes the base component context." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "dynamicDataProvider": { - "kind": "property", - "signature": "readonly dynamicDataProvider: DynamicDataProvider;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "DynamicDataProvider", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the Dynamic Data Provider associated with the component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dynamicDataSourceManager": { - "kind": "property", - "signature": "readonly dynamicDataSourceManager: DynamicDataSourceManager;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "DynamicDataSourceManager", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the Dynamic Data Source Manager associated with the component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "graphHttpClient": { - "kind": "property", - "signature": "readonly graphHttpClient: GraphHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use " + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * Disposes the component.\n *\n * @remarks\n *\n * Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the {@link BaseComponent.onDispose} method.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(instanceId:instance)", + "docComment": "/**\n * A unique identifier for the instance of the component.\n *\n * @remarks\n *\n * A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "instanceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, { - "kind": "text", - "text": "BaseComponentContext.msGraphClientFactory" + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "BaseComponentContext", - "memberName": "msGraphClientFactory" - } + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " instead" - } - ], - "summary": [ - { - "kind": "text", - "text": "The instance of GraphHttpClient created for this instance of component" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "httpClient": { - "kind": "property", - "signature": "readonly httpClient: HttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of HttpClient created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the instance of the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the context is disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideComponentManifest;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideComponentManifest", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client-side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "msGraphClientFactory": { - "kind": "property", - "signature": "readonly msGraphClientFactory: MSGraphClientFactory;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "MSGraphClientFactory", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of MSGraphClientFactory created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "pageContext": { - "kind": "property", - "signature": "readonly pageContext: PageContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PageContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serviceScope": { - "kind": "property", - "signature": "readonly serviceScope: ServiceScope;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ServiceScope", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The associated " + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "/**\n * Returns true if the component has been already disposed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(manifest:instance)", + "docComment": "/**\n * Provides access to the manifest for the client-side component.\n *\n * @remarks\n *\n * Child classes can override this with more specialized manifest types.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "ServiceScope" + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "manifest" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " for this component." + "kind": "Method", + "canonicalReference": "(onDispose:instance,0)", + "docComment": "/**\n * This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onDispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onDispose" } ], - "remarks": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "A child service scope is created for each client-side component." + "startIndex": 3, + "endIndex": 5 } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "spHttpClient": { - "kind": "property", - "signature": "readonly spHttpClient: SPHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClient", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance of SpHttpClient created for this instance of component" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "DynamicDataProvider": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(BaseComponentContext:class)", + "docComment": "/**\n * The base class for context objects for client-side components.\n *\n * @remarks\n *\n * A \"context\" object is a collection of well-known services and other objects that are likely to be needed by business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponentContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Disposes the Dynamic Data Provider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getAvailableSources": { - "kind": "method", - "signature": "getAvailableSources(): ReadonlyArray;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ReadonlyArray", - "description": [ - { - "kind": "text", - "text": "Read-only array with all available sources." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "declare abstract class " + }, { - "kind": "text", - "text": "Returns a list with all available Dynamic Data Sources." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the Dynamic Data Provider is disposed." + "kind": "Reference", + "text": "BaseComponentContext" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "registerAvailableSourcesChanged": { - "kind": "method", - "signature": "registerAvailableSourcesChanged(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ + "releaseTag": "Public", + "name": "BaseComponentContext", + "members": [ + { + "kind": "Property", + "canonicalReference": "(aadHttpClientFactory:instance)", + "docComment": "/**\n * The instance of AadHttpClientFactory created for this instance of component\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Function to execute when the sources are updated." + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "aadHttpClientFactory" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "AadHttpClientFactory" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "aadHttpClientFactory", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "registerPropertyChanged": { - "kind": "method", - "signature": "registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ + "kind": "Property", + "canonicalReference": "(aadTokenProviderFactory:instance)", + "docComment": "/**\n * The instance of AadTokenProviderFactory created for this instance of component\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "aadTokenProviderFactory" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "AadTokenProviderFactory" + }, { - "kind": "text", - "text": "Id of the Dynamic Data Source." + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "aadTokenProviderFactory", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "propertyId": { - "name": "propertyId", - "description": [ + { + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * Disposes the base component context.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, { - "kind": "text", - "text": "Id of the property of the source." + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, - "callback": { - "name": "callback", - "description": [ + { + "kind": "Property", + "canonicalReference": "(dynamicDataProvider:instance)", + "docComment": "/**\n * Returns the Dynamic Data Provider associated with the component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "dynamicDataProvider" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Function to execute when the source updates its data." + "kind": "Reference", + "text": "DynamicDataProvider" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "dynamicDataProvider", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Registers a callback for updates when a property is changed in a Dynamic Data source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "registerSourceChanged": { - "kind": "method", - "signature": "registerSourceChanged(sourceId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ + "kind": "Property", + "canonicalReference": "(dynamicDataSourceManager:instance)", + "docComment": "/**\n * Returns the Dynamic Data Source Manager associated with the component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "dynamicDataSourceManager" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Id of the Dynamic Data Source." + "kind": "Reference", + "text": "DynamicDataSourceManager" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "dynamicDataSourceManager", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "callback": { - "name": "callback", - "description": [ + { + "kind": "Property", + "canonicalReference": "(httpClient:instance)", + "docComment": "/**\n * The instance of HttpClient created for this instance of component\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "httpClient" + }, { - "kind": "text", - "text": "Function to execute when the source updates its data." + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HttpClient" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "httpClient", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetSource": { - "kind": "method", - "signature": "tryGetSource(id: string): IDynamicDataSource | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataSource | undefined", - "description": [] - }, - "parameters": { - "id": { - "name": "id", - "description": [ + "kind": "Property", + "canonicalReference": "(instanceId:instance)", + "docComment": "/**\n * A unique identifier for the instance of the component.\n *\n * @remarks\n *\n * A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "instanceId" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Id of the Dynamic Data Source." + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregisterAvailableSourcesChanged": { - "kind": "method", - "signature": "unregisterAvailableSourcesChanged(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "/**\n * Returns true if the context is disposed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, { - "kind": "text", - "text": "Function to remove from the registration. Must be the same it was registered with." + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregisterPropertyChanged": { - "kind": "method", - "signature": "unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ + "kind": "Property", + "canonicalReference": "(manifest:instance)", + "docComment": "/**\n * Manifest for the client-side component.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Id of the Dynamic Data Source." + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "manifest" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "propertyId": { - "name": "propertyId", - "description": [ + { + "kind": "Property", + "canonicalReference": "(msGraphClientFactory:instance)", + "docComment": "/**\n * The instance of MSGraphClientFactory created for this instance of component\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "msGraphClientFactory" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Id of the property of the source." + "kind": "Reference", + "text": "MSGraphClientFactory" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "msGraphClientFactory", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "callback": { - "name": "callback", - "description": [ + { + "kind": "Property", + "canonicalReference": "(pageContext:instance)", + "docComment": "/**\n * The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "pageContext" + }, { - "kind": "text", - "text": "Function to remove from the registration. Must be the same it was registered with." + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PageContext" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "pageContext", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Unregisters a callback for updates when a property is changed in a Dynamic Data source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregisterSourceChanged": { - "kind": "method", - "signature": "unregisterSourceChanged(sourceId: string, callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "sourceId": { - "name": "sourceId", - "description": [ + "kind": "Property", + "canonicalReference": "(serviceScope:instance)", + "docComment": "/**\n * The associated {@link @microsoft/sp-core-library#ServiceScope} for this component.\n *\n * @remarks\n *\n * A child service scope is created for each client-side component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "serviceScope" + }, { - "kind": "text", - "text": "Id of the Dynamic Data Source." + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "serviceScope", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "callback": { - "name": "callback", - "description": [ + { + "kind": "Property", + "canonicalReference": "(spHttpClient:instance)", + "docComment": "/**\n * The instance of SpHttpClient created for this instance of component\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "spHttpClient" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Function to remove from the registration. Must be the same it was registered with." + "kind": "Reference", + "text": "SPHttpClient" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" + "releaseTag": "Public", + "name": "spHttpClient", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } - }, - "deprecatedMessage": [], - "summary": [ + ], + "implementsTokenRanges": [ { - "kind": "text", - "text": "Unregisters a callback for updates when a Dynamic Data source is changed." + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "DynamicDataSourceManager": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + ] + }, { - "kind": "text", - "text": "The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(DynamicDataProvider:class)", + "docComment": "/**\n * The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "DynamicDataProvider" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, { - "kind": "text", - "text": "Disposes the resources held by the Dynamic Data source." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "initializeSource": { - "kind": "method", - "signature": "initializeSource(callableFunctions: IDynamicDataCallables): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callableFunctions": { - "name": "callableFunctions", - "description": [ + "releaseTag": "Public", + "name": "DynamicDataProvider", + "members": [ + { + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * Disposes the Dynamic Data Provider.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, { - "kind": "text", - "text": "Set of methods that are exposed through the Dynamic Data Source" + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "IDynamicDataCallables" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" + }, { - "kind": "text", - "text": "Initializes the Dynamic Data Source for the component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the DynamicDataSourceManager is disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "notifyPropertyChanged": { - "kind": "method", - "signature": "notifyPropertyChanged(propertyId: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "propertyId": { - "name": "propertyId", - "description": [ + "kind": "Method", + "canonicalReference": "(getAvailableSources:instance,0)", + "docComment": "/**\n * Returns a list with all available Dynamic Data Sources.\n *\n * @returns Read-only array with all available sources.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Id of the updated property in the source." + "kind": "Reference", + "text": "getAvailableSources" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataSource" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies that this source has updated a specific property." + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getAvailableSources" }, { - "kind": "paragraph" + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "/**\n * Returns true if the Dynamic Data Provider is disposed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "notifySourceChanged": { - "kind": "method", - "signature": "notifySourceChanged(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies that this source has updated its properties." + "kind": "Method", + "canonicalReference": "(registerAvailableSourcesChanged:instance,0)", + "docComment": "/**\n * Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated.\n *\n * @param callback - Function to execute when the sources are updated.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "registerAvailableSourcesChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "registerAvailableSourcesChanged" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(registerPropertyChanged:instance,0)", + "docComment": "/**\n * Registers a callback for updates when a property is changed in a Dynamic Data source.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param propertyId - Id of the property of the source.\n *\n * @param callback - Function to execute when the source updates its data.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "registerPropertyChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "propertyId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "registerPropertyChanged" }, { - "kind": "text", - "text": "When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "sourceId": { - "kind": "property", - "signature": "readonly sourceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the Id of the current DataSource." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "updateMetadata": { - "kind": "method", - "signature": "updateMetadata(metadata: Partial): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "metadata": { - "name": "metadata", - "description": [ + "kind": "Method", + "canonicalReference": "(registerSourceChanged:instance,0)", + "docComment": "/**\n * Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param callback - Function to execute when the source updates its data.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Partial of the metadata." + "kind": "Reference", + "text": "registerSourceChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "Partial" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "registerSourceChanged" + }, { - "kind": "text", - "text": "Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "DynamicProperty": { - "kind": "class", - "extends": "", - "implements": "IDisposable", - "typeParameters": [ - "TValue" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Serializable object that simplifies usage of a DynamicProperty." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(provider: DynamicDataProvider, callback?: () => void);", - "parameters": { - "provider": { - "name": "provider", - "description": [ + "kind": "Method", + "canonicalReference": "(tryGetSource:instance,0)", + "docComment": "/**\n * Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.\n *\n * @param id - Id of the Dynamic Data Source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetSource" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IDynamicDataSource" + }, { - "kind": "text", - "text": "DynamicDataProvider." + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "id", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "isOptional": false, - "isSpread": false, - "type": "DynamicDataProvider" + "name": "tryGetSource" }, - "callback": { - "name": "callback", - "description": [ + { + "kind": "Method", + "canonicalReference": "(unregisterAvailableSourcesChanged:instance,0)", + "docComment": "/**\n * Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated.\n *\n * @param callback - Function to remove from the registration. Must be the same it was registered with.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "unregisterAvailableSourcesChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, { - "kind": "text", - "text": "Optional. Default callback to be registered for updates in the DynamicDataSource." + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "unregisterAvailableSourcesChanged" + }, { - "kind": "text", - "text": "Create a new DynamicProperty object." - } - ], - "remarks": [] - }, - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Method", + "canonicalReference": "(unregisterPropertyChanged:instance,0)", + "docComment": "/**\n * Unregisters a callback for updates when a property is changed in a Dynamic Data source.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param propertyId - Id of the property of the source.\n *\n * @param callback - Function to remove from the registration. Must be the same it was registered with.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "unregisterPropertyChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "propertyId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "unregisterPropertyChanged" + }, { - "kind": "text", - "text": "This method is called to permanently dispose the object." + "kind": "Method", + "canonicalReference": "(unregisterSourceChanged:instance,0)", + "docComment": "/**\n * Unregisters a callback for updates when a Dynamic Data source is changed.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param callback - Function to remove from the registration. Must be the same it was registered with.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "unregisterSourceChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "unregisterSourceChanged" } ], - "remarks": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." + "startIndex": 3, + "endIndex": 5 } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] }, - "hasDefaultCallback": { - "kind": "method", - "signature": "hasDefaultCallback(): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(DynamicDataSourceManager:class)", + "docComment": "/**\n * The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Returns true if the object has a default callback." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "readonly isDisposed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "reference": { - "kind": "property", - "signature": "readonly reference: string | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "DynamicDataSourceManager" + }, { - "kind": "text", - "text": "DynamicDataReference string that the DynamicProperty object points to. The reference is of the form " + "kind": "Content", + "text": " implements " }, { - "kind": "code", - "text": "::", - "highlighter": "plain" + "kind": "Reference", + "text": "IDisposable" }, { - "kind": "text", - "text": "." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "DynamicDataSourceManager", + "members": [ { - "kind": "text", - "text": "If the DynamicProperty is set up with static data, this returns undefined." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "register": { - "kind": "method", - "signature": "register(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * Disposes the resources held by the Dynamic Data source.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Callback function to register." - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback function for updates on the associated DynamicDataSource." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "removeDefaultCallback": { - "kind": "method", - "signature": "removeDefaultCallback(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Removes the registration for the default callback." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This can be useful for advanced users who only want their custom callbacks." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "setReference": { - "kind": "method", - "signature": "setReference(reference: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "reference": { - "name": "reference", - "description": [ + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "Id of the DynamicDataSource and property." + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form " + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "code", - "text": "::", - "highlighter": "plain" - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "setValue": { - "kind": "method", - "signature": "setValue(value: TValue): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ + "kind": "Method", + "canonicalReference": "(initializeSource:instance,0)", + "docComment": "/**\n * Initializes the Dynamic Data Source for the component.\n *\n * @param callableFunctions - Set of methods that are exposed through the Dynamic Data Source\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Value for the DynamicProperty." - } - ], - "isOptional": false, - "isSpread": false, - "type": "TValue" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "initializeSource" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callableFunctions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IDynamicDataCallables" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callableFunctions", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "initializeSource" + }, + { + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "/**\n * Returns true if the DynamicDataSourceManager is disposed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(notifyPropertyChanged:instance,0)", + "docComment": "/**\n * Notifies that this source has updated a specific property.\n *\n * When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.\n *\n * @param propertyId - Id of the updated property in the source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "notifyPropertyChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "propertyId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "notifyPropertyChanged" + }, + { + "kind": "Method", + "canonicalReference": "(notifySourceChanged:instance,0)", + "docComment": "/**\n * Notifies that this source has updated its properties.\n *\n * When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "notifySourceChanged" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "notifySourceChanged" + }, + { + "kind": "Property", + "canonicalReference": "(sourceId:instance)", + "docComment": "/**\n * Returns the Id of the current DataSource.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "sourceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourceId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Sets a static value in the DynamicProperty." + "kind": "Method", + "canonicalReference": "(updateMetadata:instance,0)", + "docComment": "/**\n * Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated.\n *\n * @param metadata - Partial of the metadata.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "updateMetadata" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "metadata" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Partial" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataSourceMetadata" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "metadata", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 8 + } + } + ], + "name": "updateMetadata" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetSource": { - "kind": "method", - "signature": "tryGetSource(): IDynamicDataSource | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataSource | undefined", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist." + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] }, - "tryGetValue": { - "kind": "method", - "signature": "tryGetValue(): TValue | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "TValue | undefined", - "description": [ - { - "kind": "text", - "text": "the value associated with the dynamic property or undefined if the source or the data doesn't exist." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(DynamicProperty:class)", + "docComment": "/**\n * Serializable object that simplifies usage of a DynamicProperty.\n *\n * @remarks\n *\n * This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "Returns the value of the object." + "kind": "Reference", + "text": "DynamicProperty" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TValue" + }, + { + "kind": "Content", + "text": "> implements " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "DynamicProperty", + "members": [ { - "kind": "text", - "text": "If the value is an array, then the first element of the array is returned; otherwise, the value itself is returned." + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Create a new DynamicProperty object.\n *\n * @param provider - DynamicDataProvider.\n *\n * @param callback - Optional. Default callback to be registered for updates in the DynamicDataSource.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "provider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "DynamicDataProvider" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "provider", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ] }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(dispose:instance,0)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-core-library#IDisposable.dispose}\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "text", - "text": "NOTE: This api will never return an array. To retrieve an array value, use the " + "kind": "Method", + "canonicalReference": "(hasDefaultCallback:instance,0)", + "docComment": "/**\n * Returns true if the object has a default callback.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "hasDefaultCallback" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "hasDefaultCallback" }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(isDisposed:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-core-library#IDisposable.isDisposed}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, { - "kind": "text", - "text": "DynamicProperty.tryGetValues" + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "DynamicProperty", - "memberName": "tryGetValues" - } + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " API." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetValues": { - "kind": "method", - "signature": "tryGetValues(): TValue[];", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "TValue[]", - "description": [ - { - "kind": "text", - "text": "the value associated with the dynamic property or an empty array if the source or the data doesn't exist." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Property", + "canonicalReference": "(reference:instance)", + "docComment": "/**\n * DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`.\n *\n * @remarks\n *\n * If the DynamicProperty is set up with static data, this returns undefined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "reference" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "reference", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Returns the value of the object." - } - ], - "remarks": [ + "kind": "Method", + "canonicalReference": "(register:instance,0)", + "docComment": "/**\n * Registers a callback function for updates on the associated DynamicDataSource.\n *\n * @param callback - Callback function to register.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "register" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "register" + }, { - "kind": "text", - "text": "If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the value itself is returned. If the property is undefined or cannot be found, an empty array will be returned." + "kind": "Method", + "canonicalReference": "(removeDefaultCallback:instance,0)", + "docComment": "/**\n * Removes the registration for the default callback.\n *\n * @remarks\n *\n * This can be useful for advanced users who only want their custom callbacks.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "removeDefaultCallback" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "removeDefaultCallback" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(setReference:instance,0)", + "docComment": "/**\n * Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`.\n *\n * @param reference - Id of the DynamicDataSource and property.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "setReference" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "reference" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "reference", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "setReference" }, { - "kind": "text", - "text": "NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the " + "kind": "Method", + "canonicalReference": "(setValue:instance,0)", + "docComment": "/**\n * Sets a static value in the DynamicProperty.\n *\n * @param value - Value for the DynamicProperty.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "setValue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TValue" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "setValue" }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(tryGetSource:instance,0)", + "docComment": "/**\n * Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetSource" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "DynamicProperty.tryGetValue" + "kind": "Reference", + "text": "IDynamicDataSource" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "DynamicProperty", - "memberName": "tryGetValue" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "tryGetSource" }, { - "kind": "text", - "text": " API." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "unregister": { - "kind": "method", - "signature": "unregister(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ + "kind": "Method", + "canonicalReference": "(tryGetValue:instance,0)", + "docComment": "/**\n * Returns the value of the object.\n *\n * @remarks\n *\n * If the value is an array, then the first element of the array is returned; otherwise, the value itself is returned.\n *\n * NOTE: This api will never return an array. To retrieve an array value, use the {@link DynamicProperty.tryGetValues} API.\n *\n * @returns the value associated with the dynamic property or undefined if the source or the data doesn't exist.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetValue" + }, { - "kind": "text", - "text": "Callback function to unregister." + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "TValue" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "tryGetValue" + }, { - "kind": "text", - "text": "Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IFontStyles": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Font styles for different sizes." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "large": { - "kind": "property", - "signature": "large: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "medium": { - "kind": "property", - "signature": "medium: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Medium font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "mediumPlus": { - "kind": "property", - "signature": "mediumPlus: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Larger than medium but smaller than large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "mega": { - "kind": "property", - "signature": "mega: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Mega sized font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "small": { - "kind": "property", - "signature": "small: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Small font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "smallPlus": { - "kind": "property", - "signature": "smallPlus: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Larger than small but smaller than medium font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "superLarge": { - "kind": "property", - "signature": "superLarge: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Super large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tiny": { - "kind": "property", - "signature": "tiny: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tiny font style." + "kind": "Method", + "canonicalReference": "(tryGetValues:instance,0)", + "docComment": "/**\n * Returns the value of the object.\n *\n * @remarks\n *\n * If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the value itself is returned. If the property is undefined or cannot be found, an empty array will be returned.\n *\n * NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the {@link DynamicProperty.tryGetValue} API.\n *\n * @returns the value associated with the dynamic property or an empty array if the source or the data doesn't exist.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetValues" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "TValue" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "tryGetValues" + }, + { + "kind": "Method", + "canonicalReference": "(unregister:instance,0)", + "docComment": "/**\n * Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with.\n *\n * @param callback - Callback function to unregister.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "unregister" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "unregister" } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "xLarge": { - "kind": "property", - "signature": "xLarge: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extra large font style." + "implementsTokenRanges": [ + { + "startIndex": 5, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "xSmall": { - "kind": "property", - "signature": "xSmall: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extra small font style." + { + "kind": "Interface", + "canonicalReference": "(IFontStyles:interface)", + "docComment": "/**\n * Font styles for different sizes.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IFontStyles" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "xxLarge": { - "kind": "property", - "signature": "xxLarge: IRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extra extra large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPalette": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color palette." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "accent": { - "kind": "property", - "signature": "accent: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for the accent." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "black": { - "kind": "property", - "signature": "black: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for the strongest color, which is black in the default theme. This is a very light color in inverted themes." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "blackTranslucent40": { - "kind": "property", - "signature": "blackTranslucent40: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for blackTranslucent40." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "blue": { - "kind": "property", - "signature": "blue: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for blue." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "blueDark": { - "kind": "property", - "signature": "blueDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for blueDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "blueLight": { - "kind": "property", - "signature": "blueLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for blueLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "blueMid": { - "kind": "property", - "signature": "blueMid: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for blueMid." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "green": { - "kind": "property", - "signature": "green: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for green." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "greenDark": { - "kind": "property", - "signature": "greenDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for greenDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "greenLight": { - "kind": "property", - "signature": "greenLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for greenLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "magenta": { - "kind": "property", - "signature": "magenta: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for magenta." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "magentaDark": { - "kind": "property", - "signature": "magentaDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for magentaDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "magentaLight": { - "kind": "property", - "signature": "magentaLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for magentaLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralDark": { - "kind": "property", - "signature": "neutralDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralLight": { - "kind": "property", - "signature": "neutralLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralLighter": { - "kind": "property", - "signature": "neutralLighter: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralLighter." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralLighterAlt": { - "kind": "property", - "signature": "neutralLighterAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralLighterAlt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralPrimary": { - "kind": "property", - "signature": "neutralPrimary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralPrimary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralPrimaryAlt": { - "kind": "property", - "signature": "neutralPrimaryAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralPrimaryAlt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralQuaternary": { - "kind": "property", - "signature": "neutralQuaternary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralQuaternary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralQuaternaryAlt": { - "kind": "property", - "signature": "neutralQuaternaryAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralQuaternaryAlt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralSecondary": { - "kind": "property", - "signature": "neutralSecondary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralSecondary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralTertiary": { - "kind": "property", - "signature": "neutralTertiary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralTertiary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "neutralTertiaryAlt": { - "kind": "property", - "signature": "neutralTertiaryAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for neutralTertiaryAlt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "orange": { - "kind": "property", - "signature": "orange: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for orange." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "orangeLight": { - "kind": "property", - "signature": "orangeLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for orangeLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "orangeLighter": { - "kind": "property", - "signature": "orangeLighter: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for orangeLighter." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "purple": { - "kind": "property", - "signature": "purple: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for purple." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "purpleDark": { - "kind": "property", - "signature": "purpleDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for purpleDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "purpleLight": { - "kind": "property", - "signature": "purpleLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for purpleLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "red": { - "kind": "property", - "signature": "red: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for red." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "redDark": { - "kind": "property", - "signature": "redDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for redDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "teal": { - "kind": "property", - "signature": "teal: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for teal." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tealDark": { - "kind": "property", - "signature": "tealDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for tealDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tealLight": { - "kind": "property", - "signature": "tealLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for tealLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeDark": { - "kind": "property", - "signature": "themeDark: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeDark." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeDarkAlt": { - "kind": "property", - "signature": "themeDarkAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeDarkAlt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeDarker": { - "kind": "property", - "signature": "themeDarker: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeDarker." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeLight": { - "kind": "property", - "signature": "themeLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeLighter": { - "kind": "property", - "signature": "themeLighter: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeLighter." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeLighterAlt": { - "kind": "property", - "signature": "themeLighterAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeLighterAlt." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themePrimary": { - "kind": "property", - "signature": "themePrimary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themePrimary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeSecondary": { - "kind": "property", - "signature": "themeSecondary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeSecondary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeTertiary": { - "kind": "property", - "signature": "themeTertiary: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for themeTertiary." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "white": { - "kind": "property", - "signature": "white: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. This is the page background." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "whiteTranslucent40": { - "kind": "property", - "signature": "whiteTranslucent40: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for whiteTranslucent40" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "yellow": { - "kind": "property", - "signature": "yellow: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for yellow." + "releaseTag": "Public", + "name": "IFontStyles", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "large", + "docComment": "/**\n * Large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "large" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "large", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "medium", + "docComment": "/**\n * Medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "medium" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "medium", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "mediumPlus", + "docComment": "/**\n * Larger than medium but smaller than large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "mediumPlus" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mediumPlus", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "mega", + "docComment": "/**\n * Mega sized font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "mega" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mega", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "small", + "docComment": "/**\n * Small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "small" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "small", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "smallPlus", + "docComment": "/**\n * Larger than small but smaller than medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "smallPlus" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "smallPlus", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "superLarge", + "docComment": "/**\n * Super large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "superLarge" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "superLarge", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "tiny", + "docComment": "/**\n * Tiny font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tiny" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tiny", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "xLarge", + "docComment": "/**\n * Extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "xLarge" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xLarge", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "xSmall", + "docComment": "/**\n * Extra small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "xSmall" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xSmall", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "xxLarge", + "docComment": "/**\n * Extra extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "xxLarge" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xxLarge", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "yellowLight": { - "kind": "property", - "signature": "yellowLight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color code for yellowLight." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IReadonlyFontStyles": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Font styles for different sizes." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "large": { - "kind": "property", - "signature": "large: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "medium": { - "kind": "property", - "signature": "medium: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Medium font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "mediumPlus": { - "kind": "property", - "signature": "mediumPlus: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Larger than medium but smaller than large font style." + "kind": "Interface", + "canonicalReference": "(IPalette:interface)", + "docComment": "/**\n * Color palette.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPalette" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "mega": { - "kind": "property", - "signature": "mega: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Mega sized font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "small": { - "kind": "property", - "signature": "small: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Small font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "smallPlus": { - "kind": "property", - "signature": "smallPlus: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Larger than small but smaller than medium font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "superLarge": { - "kind": "property", - "signature": "superLarge: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Super large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tiny": { - "kind": "property", - "signature": "tiny: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tiny font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "xLarge": { - "kind": "property", - "signature": "xLarge: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extra large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "xSmall": { - "kind": "property", - "signature": "xSmall: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extra small font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "xxLarge": { - "kind": "property", - "signature": "xxLarge: IReadonlyRawStyle;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IReadonlyRawStyle", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Extra extra large font style." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IReadonlyTheme": { - "kind": "interface", - "extends": "Readonly", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Immutable ITheme." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "fonts": { - "kind": "property", - "signature": "readonly fonts: Readonly;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Readonly", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Font styles for different sizes." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "palette": { - "kind": "property", - "signature": "readonly palette: Readonly;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Readonly", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color palette." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "semanticColors": { - "kind": "property", - "signature": "readonly semanticColors: Readonly;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Readonly", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The collection of all semantic slots for colors used in themes." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISemanticColors": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The collection of semantic slots for colors used in themes." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Naming Convention" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The name of a semantic slot can quickly tell you how it’s meant to be used. It generally follows this format:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "[category name][element name][checked state][hovered/pressed/disabled state] [category name] – The “family” that this slot belongs to. [element name] – The name of the thing being targeted, such as the background or border. [checked state] – Whether the thing is checked. We assume things are unchecked by default, so no need to specify the unchecked state. (We used “checked” to refer to anything that is on, selected, toggled, highlighted, emphasized, etc.) [hovered/pressed/disabled state] – One of these states, if applicable. Each of these states are mutually exclusive. Pressed styles overwrite hovered styles, and disabled elements cannot be hovered or pressed." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Base Slots" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A basic set of slots that provide many default body styles, such as text, subtext, disabled colors, and so on. If a category doesn't provide the slot you're looking for, use one from this category. For example, the placeholder text on a text input field has no corresponding slot in its category, so you'd use the bodySubtextColor from this category." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Invariants" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "When color has meaning, we do not want to change the color much theme to theme. For example, we will always want errors to be some shade of red, but we will need to tweak the exact shade so it's legible depending on whether it's an inverted theme or not. Invariant colors should almost never be changed by the theme, the defaults should suffice." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Input Controls" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This category contains input components commonly used to denote state, including radio buttons, check boxes, toggle switches, sliders, progress bars, and more." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Buttons" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Buttons! And all the flavors thereof." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Menus" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Any kind of popup menus uses this category." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "## Lists" + "releaseTag": "Public", + "name": "IPalette", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "accent", + "docComment": "/**\n * Color code for the accent.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "accent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accent", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "black", + "docComment": "/**\n * Color code for the strongest color, which is black in the default theme. This is a very light color in inverted themes.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "black" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "black", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "blackTranslucent40", + "docComment": "/**\n * Color code for blackTranslucent40.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blackTranslucent40" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blackTranslucent40", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "blue", + "docComment": "/**\n * Color code for blue.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blue", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "blueDark", + "docComment": "/**\n * Color code for blueDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blueDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blueDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "blueLight", + "docComment": "/**\n * Color code for blueLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blueLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blueLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "blueMid", + "docComment": "/**\n * Color code for blueMid.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blueMid" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blueMid", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "green", + "docComment": "/**\n * Color code for green.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "green" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "green", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "greenDark", + "docComment": "/**\n * Color code for greenDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "greenDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "greenDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "greenLight", + "docComment": "/**\n * Color code for greenLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "greenLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "greenLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "magenta", + "docComment": "/**\n * Color code for magenta.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "magenta" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "magenta", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "magentaDark", + "docComment": "/**\n * Color code for magentaDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "magentaDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "magentaDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "magentaLight", + "docComment": "/**\n * Color code for magentaLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "magentaLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "magentaLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralDark", + "docComment": "/**\n * Color code for neutralDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralLight", + "docComment": "/**\n * Color code for neutralLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralLighter", + "docComment": "/**\n * Color code for neutralLighter.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralLighter" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralLighter", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralLighterAlt", + "docComment": "/**\n * Color code for neutralLighterAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralLighterAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralLighterAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralPrimary", + "docComment": "/**\n * Color code for neutralPrimary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralPrimary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralPrimary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralPrimaryAlt", + "docComment": "/**\n * Color code for neutralPrimaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralPrimaryAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralPrimaryAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralQuaternary", + "docComment": "/**\n * Color code for neutralQuaternary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralQuaternary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralQuaternary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralQuaternaryAlt", + "docComment": "/**\n * Color code for neutralQuaternaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralQuaternaryAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralQuaternaryAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralSecondary", + "docComment": "/**\n * Color code for neutralSecondary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralSecondary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralSecondary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralSecondaryAlt", + "docComment": "/**\n * Color code for neutralSecondaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralSecondaryAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralSecondaryAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralTertiary", + "docComment": "/**\n * Color code for neutralTertiary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralTertiary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralTertiary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "neutralTertiaryAlt", + "docComment": "/**\n * Color code for neutralTertiaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "neutralTertiaryAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralTertiaryAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "orange", + "docComment": "/**\n * Color code for orange.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "orange" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "orange", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "orangeLight", + "docComment": "/**\n * Color code for orangeLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "orangeLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "orangeLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "orangeLighter", + "docComment": "/**\n * Color code for orangeLighter.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "orangeLighter" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "orangeLighter", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "purple", + "docComment": "/**\n * Color code for purple.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "purple" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "purple", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "purpleDark", + "docComment": "/**\n * Color code for purpleDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "purpleDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "purpleDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "purpleLight", + "docComment": "/**\n * Color code for purpleLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "purpleLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "purpleLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "red", + "docComment": "/**\n * Color code for red.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "red" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "red", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "redDark", + "docComment": "/**\n * Color code for redDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "redDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "teal", + "docComment": "/**\n * Color code for teal.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "teal" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "teal", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "tealDark", + "docComment": "/**\n * Color code for tealDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tealDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tealDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "tealLight", + "docComment": "/**\n * Color code for tealLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tealLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tealLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeDark", + "docComment": "/**\n * Color code for themeDark.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeDark" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeDark", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeDarkAlt", + "docComment": "/**\n * Color code for themeDarkAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeDarkAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeDarkAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeDarker", + "docComment": "/**\n * Color code for themeDarker.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeDarker" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeDarker", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeLight", + "docComment": "/**\n * Color code for themeLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeLighter", + "docComment": "/**\n * Color code for themeLighter.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeLighter" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeLighter", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeLighterAlt", + "docComment": "/**\n * Color code for themeLighterAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeLighterAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeLighterAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themePrimary", + "docComment": "/**\n * Color code for themePrimary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themePrimary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themePrimary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeSecondary", + "docComment": "/**\n * Color code for themeSecondary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeSecondary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeSecondary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "themeTertiary", + "docComment": "/**\n * Color code for themeTertiary.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "themeTertiary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeTertiary", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "white", + "docComment": "/**\n * Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. This is the page background.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "white" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "white", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "whiteTranslucent40", + "docComment": "/**\n * Color code for whiteTranslucent40\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "whiteTranslucent40" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "whiteTranslucent40", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "yellow", + "docComment": "/**\n * Color code for yellow.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "yellow" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "yellow", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "yellowLight", + "docComment": "/**\n * Color code for yellowLight.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "yellowLight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "yellowLight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, { - "kind": "paragraph" + "kind": "Interface", + "canonicalReference": "(IRawStyle:interface)", + "docComment": "/**\n * IStyleObject extends a raw style objects, but allows selectors to be defined under the selectors node.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IRawStyleBase" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IRawStyle", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "displayName", + "docComment": "/**\n * Display name for the style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "displayName" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayName", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "selectors", + "docComment": "/**\n * Custom selectors for the style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "selectors" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: " + }, + { + "kind": "Reference", + "text": "IStyle" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectors", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 7 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] }, { - "kind": "text", - "text": "Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a large and complex interaction surface. This category covers all kinds of lists, whether they're typical one-item-per-row lists (like DetailsList) or ones with a tiled layout." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "actionLink": { - "kind": "property", - "signature": "actionLink: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Neutral colored links and links for action buttons." + "kind": "Interface", + "canonicalReference": "(IReadonlyFontStyles:interface)", + "docComment": "/**\n * Font styles for different sizes.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IReadonlyFontStyles" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "actionLinkHovered": { - "kind": "property", - "signature": "actionLinkHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Hover state for neutral colored links and links for action buttons." + "releaseTag": "Public", + "name": "IReadonlyFontStyles", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "large", + "docComment": "/**\n * Large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "large" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "large", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "medium", + "docComment": "/**\n * Medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "medium" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "medium", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "mediumPlus", + "docComment": "/**\n * Larger than medium but smaller than large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "mediumPlus" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mediumPlus", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "mega", + "docComment": "/**\n * Mega sized font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "mega" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mega", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "small", + "docComment": "/**\n * Small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "small" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "small", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "smallPlus", + "docComment": "/**\n * Larger than small but smaller than medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "smallPlus" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "smallPlus", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "superLarge", + "docComment": "/**\n * Super large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "superLarge" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "superLarge", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "tiny", + "docComment": "/**\n * Tiny font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tiny" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tiny", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "xLarge", + "docComment": "/**\n * Extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "xLarge" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xLarge", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "xSmall", + "docComment": "/**\n * Extra small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "xSmall" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xSmall", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "xxLarge", + "docComment": "/**\n * Extra extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "xxLarge" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xxLarge", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "blockingBackground": { - "kind": "property", - "signature": "blockingBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background for blocking issues, which is more severe than a warning, but not as bad as an error." + { + "kind": "Interface", + "canonicalReference": "(IReadonlyTheme:interface)", + "docComment": "/**\n * Immutable ITheme.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IReadonlyTheme" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "Readonly" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ITheme" + }, + { + "kind": "Content", + "text": "> " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodyBackground": { - "kind": "property", - "signature": "bodyBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default color for backgrounds." + "releaseTag": "Public", + "name": "IReadonlyTheme", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "fonts", + "docComment": "/**\n * Font styles for different sizes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "fonts" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Readonly" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IReadonlyFontStyles" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fonts", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "palette", + "docComment": "/**\n * Color palette.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "palette" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Readonly" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPalette" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "palette", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "semanticColors", + "docComment": "/**\n * The collection of all semantic slots for colors used in themes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "semanticColors" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Readonly" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ISemanticColors" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "semanticColors", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] }, - "bodyDivider": { - "kind": "property", - "signature": "bodyDivider: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(ISemanticColors:interface)", + "docComment": "/**\n * The collection of all semantic slots for colors used in themes.\n *\n * Note: text colors are defined in ISemanticTextColors.ts.\n *\n * ## Naming Convention\n *\n * The name of a semantic slot can quickly tell you how it’s meant to be used. It generally follows this format:\n *\n * [category name][element name][checked state][hovered/pressed/disabled state] [category name] – The “family” that this slot belongs to. [element name] – The name of the thing being targeted, such as the background or border. [checked state] – Whether the thing is checked. We assume things are unchecked by default, so no need to specify the unchecked state. (We used “checked” to refer to anything that is on, selected, toggled, highlighted, emphasized, etc.) [hovered/pressed/disabled state] – One of these states, if applicable. Each of these states are mutually exclusive. Pressed styles overwrite hovered styles, and disabled elements cannot be hovered or pressed.\n *\n * ## Base Slots\n *\n * A basic set of slots that provide many default body styles, such as text, subtext, disabled colors, and so on. If a category doesn't provide the slot you're looking for, use one from this category. For example, the placeholder text on a text input field has no corresponding slot in its category, so you'd use the bodySubtextColor from this category.\n *\n * ## Invariants\n *\n * When color has meaning, we do not want to change the color much theme to theme. For example, we will always want errors to be some shade of red, but we will need to tweak the exact shade so it's legible depending on whether it's an inverted theme or not. Invariant colors should almost never be changed by the theme, the defaults should suffice.\n *\n * ## Input Controls\n *\n * This category contains input components commonly used to denote state, including radio buttons, check boxes, toggle switches, sliders, progress bars, and more.\n *\n * ## Buttons\n *\n * Buttons! And all the flavors thereof.\n *\n * ## Menus\n *\n * Any kind of popup menus uses this category.\n *\n * ## Lists\n *\n * Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a large and complex interaction surface. This category covers all kinds of lists, whether they're typical one-item-per-row lists (like DetailsList) or ones with a tiled layout.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISemanticColors" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "ISemanticTextColors" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISemanticColors", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "accentButtonBackground", + "docComment": "/**\n * Background of an accent button (kicker)\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "accentButtonBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentButtonBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "blockingBackground", + "docComment": "/**\n * Background for blocking issues, which is more severe than a warning, but not as bad as an error.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blockingBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blockingBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyBackground", + "docComment": "/**\n * The default color for backgrounds.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyDivider", + "docComment": "/**\n * Divider lines; e.g. lines that separate sections in a menu, an
element.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyDivider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyDivider", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyFrameBackground", + "docComment": "/**\n * The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the color of bodyBackground. See also: bodyFrameDivider\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyFrameBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyFrameBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyFrameDivider", + "docComment": "/**\n * Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually disappear. See also: bodyFrameBackground\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyFrameDivider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyFrameDivider", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyStandoutBackground", + "docComment": "/**\n * The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in inverted themes.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyStandoutBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyStandoutBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBackground", + "docComment": "/**\n * Background of a standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBackgroundChecked", + "docComment": "/**\n * Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBackgroundChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBackgroundCheckedHovered", + "docComment": "/**\n * Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBackgroundCheckedHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBackgroundDisabled", + "docComment": "/**\n * Background of a disabled standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBackgroundDisabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundDisabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBackgroundHovered", + "docComment": "/**\n * Background of a hovered standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBackgroundHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBackgroundPressed", + "docComment": "/**\n * Background of a pressed standard button; i.e. currently being clicked by mouse\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBackgroundPressed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBorder", + "docComment": "/**\n * Border of a standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBorder", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonBorderDisabled", + "docComment": "/**\n * Border of a disabled standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonBorderDisabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBorderDisabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "defaultStateBackground", + "docComment": "/**\n * Background color for default/empty state graphical elements; eg default icons, empty section that needs user to fill in content, placeholder graphics, empty seats, etc.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "defaultStateBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultStateBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "disabledBackground", + "docComment": "/**\n * The default color for backgrounds of disabled controls; e.g. disabled text field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "disabledBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "errorBackground", + "docComment": "/**\n * The background for errors, if necessary, or highlighting the section of the page where the error is present.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "errorBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "errorBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "focusBorder", + "docComment": "/**\n * The color of the outline around focused controls that don't already have a border; e.g. menu items\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "focusBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "focusBorder", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputBackground", + "docComment": "/**\n * The background color of an input, e.g. textbox background.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputBackgroundChecked", + "docComment": "/**\n * The background of a checked control; e.g. checked radio button's dot, checked toggle's background.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputBackgroundChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputBackgroundCheckedHovered", + "docComment": "/**\n * The background of a checked and hovered control; e.g. checked checkbox's background color on hover.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputBackgroundCheckedHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBackgroundCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputBorder", + "docComment": "/**\n * The border of a large input control in its resting, state; e.g. the box of dropdown.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBorder", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputBorderHovered", + "docComment": "/**\n * The border color of a large hovered input control, such as textbox.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputBorderHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBorderHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputFocusBorderAlt", + "docComment": "/**\n * The alternate focus border color for elements that already have a border; e.g. text field borders on focus.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputFocusBorderAlt" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputFocusBorderAlt", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputForegroundChecked", + "docComment": "/**\n * The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio button's background color around the dot.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputForegroundChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputForegroundChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listBackground", + "docComment": "/**\n * The background color for the entire list.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listHeaderBackgroundHovered", + "docComment": "/**\n * The background color for a hovered list header.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listHeaderBackgroundHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listHeaderBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listHeaderBackgroundPressed", + "docComment": "/**\n * The background color for a pressed list header.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listHeaderBackgroundPressed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listHeaderBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listItemBackgroundChecked", + "docComment": "/**\n * The background color of a checked list item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listItemBackgroundChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItemBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listItemBackgroundCheckedHovered", + "docComment": "/**\n * The background color of a checked and hovered list item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listItemBackgroundCheckedHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItemBackgroundCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listItemBackgroundHovered", + "docComment": "/**\n * The background color of a hovered list item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listItemBackgroundHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItemBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listText", + "docComment": "/**\n * The default text color for list item titles and text in column fields.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "menuBackground", + "docComment": "/**\n * The background of a menu.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Divider lines; e.g. lines that separate sections in a menu, an " + "kind": "PropertySignature", + "canonicalReference": "menuDivider", + "docComment": "/**\n * The divider between menu items.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuDivider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuDivider", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "html-tag", - "token": "
" + "kind": "PropertySignature", + "canonicalReference": "menuHeader", + "docComment": "/**\n * The headers in menus that denote title of a section.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuHeader" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuHeader", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " element." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodyFrameBackground": { - "kind": "property", - "signature": "bodyFrameBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the color of bodyBackground. See also: bodyFrameDivider" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodyFrameDivider": { - "kind": "property", - "signature": "bodyFrameDivider: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually disappear. See also: bodyFrameBackground" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodyStandoutBackground": { - "kind": "property", - "signature": "bodyStandoutBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in inverted themes." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodySubtext": { - "kind": "property", - "signature": "bodySubtext: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "De-emphasized text; e.g. metadata, captions, placeholder text." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodyText": { - "kind": "property", - "signature": "bodyText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default color for text." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "bodyTextChecked": { - "kind": "property", - "signature": "bodyTextChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Checked text color, e.g. selected menu item text." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBackground": { - "kind": "property", - "signature": "buttonBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBackgroundChecked": { - "kind": "property", - "signature": "buttonBackgroundChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBackgroundCheckedHovered": { - "kind": "property", - "signature": "buttonBackgroundCheckedHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBackgroundHovered": { - "kind": "property", - "signature": "buttonBackgroundHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a hovered standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBackgroundPressed": { - "kind": "property", - "signature": "buttonBackgroundPressed: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a pressed standard button; i.e. currently being clicked by mouse" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBorder": { - "kind": "property", - "signature": "buttonBorder: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Border of a standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonBorderDisabled": { - "kind": "property", - "signature": "buttonBorderDisabled: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Border of a disabled standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonText": { - "kind": "property", - "signature": "buttonText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonTextChecked": { - "kind": "property", - "signature": "buttonTextChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a checked standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonTextCheckedHovered": { - "kind": "property", - "signature": "buttonTextCheckedHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a checked and hovered standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonTextDisabled": { - "kind": "property", - "signature": "buttonTextDisabled: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a disabled standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonTextHovered": { - "kind": "property", - "signature": "buttonTextHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a hovered standard button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonTextPressed": { - "kind": "property", - "signature": "buttonTextPressed: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a pressed standard button; i.e. currently being clicked by mouse" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabledBackground": { - "kind": "property", - "signature": "disabledBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default color for backgrounds of disabled controls; e.g. disabled text field." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabledBodyText": { - "kind": "property", - "signature": "disabledBodyText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default color for disabled text on the default background (bodyBackground)." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabledSubtext": { - "kind": "property", - "signature": "disabledSubtext: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Disabled de-emphasized text, for use on disabledBackground." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabledText": { - "kind": "property", - "signature": "disabledText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled button text." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "errorBackground": { - "kind": "property", - "signature": "errorBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background for errors, if necessary, or highlighting the section of the page where the error is present." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "errorText": { - "kind": "property", - "signature": "errorText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default color of error text, used on bodyBackground." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "focusBorder": { - "kind": "property", - "signature": "focusBorder: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color of the outline around focused controls that don't already have a border; e.g. menu items" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputBackground": { - "kind": "property", - "signature": "inputBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color of an input, e.g. textbox background." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputBackgroundChecked": { - "kind": "property", - "signature": "inputBackgroundChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background of a checked control; e.g. checked radio button's dot, checked toggle's background." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputBackgroundCheckedHovered": { - "kind": "property", - "signature": "inputBackgroundCheckedHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background of a checked and hovered control; e.g. checked checkbox's background color on hover." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputBorder": { - "kind": "property", - "signature": "inputBorder: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The border of a large input control in its resting, state; e.g. the box of dropdown." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputBorderHovered": { - "kind": "property", - "signature": "inputBorderHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The border color of a large hovered input control, such as textbox." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputFocusBorderAlt": { - "kind": "property", - "signature": "inputFocusBorderAlt: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The alternate focus border color for elements that already have a border; e.g. text field borders on focus." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputForegroundChecked": { - "kind": "property", - "signature": "inputForegroundChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio button's background color around the dot." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "inputPlaceholderText": { - "kind": "property", - "signature": "inputPlaceholderText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color of placeholder text." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "link": { - "kind": "property", - "signature": "link: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color of a link." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "linkHovered": { - "kind": "property", - "signature": "linkHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color of a hovered link. Also used when the link is active." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listBackground": { - "kind": "property", - "signature": "listBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color for the entire list." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listHeaderBackgroundHovered": { - "kind": "property", - "signature": "listHeaderBackgroundHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color for a hovered list header." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listHeaderBackgroundPressed": { - "kind": "property", - "signature": "listHeaderBackgroundPressed: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color for a pressed list header." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listItemBackgroundChecked": { - "kind": "property", - "signature": "listItemBackgroundChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color of a checked list item." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listItemBackgroundCheckedHovered": { - "kind": "property", - "signature": "listItemBackgroundCheckedHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color of a checked and hovered list item." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listItemBackgroundHovered": { - "kind": "property", - "signature": "listItemBackgroundHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background color of a hovered list item." + "kind": "PropertySignature", + "canonicalReference": "menuIcon", + "docComment": "/**\n * The default colors of icons in menus.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuIcon" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuIcon", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "menuItemBackgroundChecked", + "docComment": "/**\n * @deprecated\n *\n * (Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item whose submenu is open, a selected dropdown item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuItemBackgroundChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "menuItemBackgroundHovered", + "docComment": "/**\n * The background of a hovered menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuItemBackgroundHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "menuItemBackgroundPressed", + "docComment": "/**\n * The background of a pressed menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuItemBackgroundPressed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "menuItemText", + "docComment": "/**\n * The text color of a menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuItemText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "menuItemTextHovered", + "docComment": "/**\n * The text color of a hovered menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "menuItemTextHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemTextHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonBackground", + "docComment": "/**\n * Background of a primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonBackgroundDisabled", + "docComment": "/**\n * Background of a disabled primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonBackgroundDisabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackgroundDisabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonBackgroundHovered", + "docComment": "/**\n * Background of a hovered primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonBackgroundHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonBackgroundPressed", + "docComment": "/**\n * Background of a pressed primary button; i.e. currently being clicked by mouse\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonBackgroundPressed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonBorder", + "docComment": "/**\n * Border of a primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBorder", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "smallInputBorder", + "docComment": "/**\n * The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "smallInputBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "smallInputBorder", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "successBackground", + "docComment": "/**\n * Background for success\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "successBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "successBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "variantBorder", + "docComment": "/**\n * The color of the border that provides contrast between an element, such as a card, and an emphasized background.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "variantBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "variantBorder", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "variantBorderHovered", + "docComment": "/**\n * Hover color of border that provides contrast between an element, such as a card, and an emphasized background.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "variantBorderHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "variantBorderHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "warningBackground", + "docComment": "/**\n * Background for warning messages.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "warningBackground" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "warningBackground", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "warningHighlight", + "docComment": "/**\n * Foreground color for warning highlights\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "warningHighlight" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "warningHighlight", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listText": { - "kind": "property", - "signature": "listText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default text color for list item titles and text in column fields." + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "listTextColor": { - "kind": "property", - "signature": "listTextColor: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This slot was incorrectly named. Use listText instead." + { + "kind": "Interface", + "canonicalReference": "(ISemanticTextColors:interface)", + "docComment": "/**\n * Collection of semantic text colors.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISemanticTextColors" + }, + { + "kind": "Content", + "text": " " } ], - "summary": [ + "releaseTag": "Public", + "name": "ISemanticTextColors", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "accentButtonText", + "docComment": "/**\n * Color of text for accent button (kicker)\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "accentButtonText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentButtonText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "actionLink", + "docComment": "/**\n * Neutral colored links and links for action buttons.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "actionLink" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "actionLink", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "actionLinkHovered", + "docComment": "/**\n * Hover state for neutral colored links and links for action buttons.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "actionLinkHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "actionLinkHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodySubtext", + "docComment": "/**\n * De-emphasized text; e.g. metadata, captions, placeholder text.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodySubtext" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodySubtext", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyText", + "docComment": "/**\n * The default color for text.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bodyTextChecked", + "docComment": "/**\n * Checked text color, e.g. selected menu item text.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "bodyTextChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyTextChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonText", + "docComment": "/**\n * Color of text in a standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonTextChecked", + "docComment": "/**\n * Color of text in a checked standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonTextChecked" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextChecked", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonTextCheckedHovered", + "docComment": "/**\n * Color of text in a checked and hovered standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonTextCheckedHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonTextDisabled", + "docComment": "/**\n * Color of text in a disabled standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonTextDisabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextDisabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonTextHovered", + "docComment": "/**\n * Color of text in a hovered standard button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonTextHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "buttonTextPressed", + "docComment": "/**\n * Color of text in a pressed standard button; i.e. currently being clicked by mouse\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buttonTextPressed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextPressed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "disabledBodySubtext", + "docComment": "/**\n * Disabled de-emphasized text, for use on the default background (bodyBackground).\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "disabledBodySubtext" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledBodySubtext", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "disabledBodyText", + "docComment": "/**\n * The default color for disabled text on the default background (bodyBackground).\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "disabledBodyText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledBodyText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "disabledSubtext", + "docComment": "/**\n * Disabled de-emphasized text, for use on disabledBackground.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "disabledSubtext" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledSubtext", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "disabledText", + "docComment": "/**\n * The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled button text.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "disabledText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "errorText", + "docComment": "/**\n * The default color of error text, used on bodyBackground.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "errorText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "errorText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputPlaceholderText", + "docComment": "/**\n * The color of placeholder text.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputPlaceholderText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputPlaceholderText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputText", + "docComment": "/**\n * The color of input text.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "inputTextHovered", + "docComment": "/**\n * The color of input text on hover.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "inputTextHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputTextHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "link", + "docComment": "/**\n * The color of a link.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "link" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "link", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "linkHovered", + "docComment": "/**\n * The color of a hovered link. Also used when the link is active.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "linkHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "linkHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listText", + "docComment": "/**\n * The default text color for list item titles and text in column fields.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "listTextColor", + "docComment": "/**\n * @deprecated\n *\n * This slot was incorrectly named. Use listText instead.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "listTextColor" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listTextColor", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Deprecated. Do not use." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "menuHeader": { - "kind": "property", - "signature": "menuHeader: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The headers in menus that denote title of a section." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "menuIcon": { - "kind": "property", - "signature": "menuIcon: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The default colors of icons in menus." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "menuItemBackgroundChecked": { - "kind": "property", - "signature": "menuItemBackgroundChecked: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "(Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item whose submenu is open, a selected dropdown item." - } - ], - "summary": [ + "kind": "PropertySignature", + "canonicalReference": "primaryButtonText", + "docComment": "/**\n * Color of text in a primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Deprecated. Do not use." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "menuItemBackgroundHovered": { - "kind": "property", - "signature": "menuItemBackgroundHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The background of a hovered menu item." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonBackground": { - "kind": "property", - "signature": "primaryButtonBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a primary button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonBackgroundHovered": { - "kind": "property", - "signature": "primaryButtonBackgroundHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a hovered primary button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonBackgroundPressed": { - "kind": "property", - "signature": "primaryButtonBackgroundPressed: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background of a pressed primary button; i.e. currently being clicked by mouse" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonBorder": { - "kind": "property", - "signature": "primaryButtonBorder: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Border of a primary button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonText": { - "kind": "property", - "signature": "primaryButtonText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a primary button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonTextHovered": { - "kind": "property", - "signature": "primaryButtonTextHovered: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a hovered primary button" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryButtonTextPressed": { - "kind": "property", - "signature": "primaryButtonTextPressed: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color of text in a pressed primary button; i.e. currently being clicked by mouse" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "smallInputBorder": { - "kind": "property", - "signature": "smallInputBorder: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "successBackground": { - "kind": "property", - "signature": "successBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background for success" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "variantBorder": { - "kind": "property", - "signature": "variantBorder: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color of the border that provides contrast between an element, such as a card, and an emphasized background." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "warningBackground": { - "kind": "property", - "signature": "warningBackground: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Background for warning messages." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "warningHighlight": { - "kind": "property", - "signature": "warningHighlight: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Foreground color for warning highlights" + "kind": "PropertySignature", + "canonicalReference": "primaryButtonTextDisabled", + "docComment": "/**\n * Color of text in a disabled primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonTextDisabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonTextDisabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonTextHovered", + "docComment": "/**\n * Color of text in a hovered primary button\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonTextHovered" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonTextHovered", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "primaryButtonTextPressed", + "docComment": "/**\n * Color of text in a pressed primary button; i.e. currently being clicked by mouse\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "primaryButtonTextPressed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonTextPressed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "warningText", + "docComment": "/**\n * The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "warningText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "warningText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "warningText": { - "kind": "property", - "signature": "warningText: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The color of text on errorBackground, warningBackground, blockingBackground, or successBackground." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ITheme": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Collection of theme values, which can be used to programatically style components." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "disableGlobalClassNames": { - "kind": "property", - "signature": "disableGlobalClassNames: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Diables global styles on Fabric components. This will prevent global overrides that might have been set by other Fabric users from applying to your components." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(ITheme:interface)", + "docComment": "/**\n * Collection of theme values, which can be used to programatically style components.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "This has a vary narrow use case and most likely should be avoided." + "kind": "Reference", + "text": "ITheme" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fonts": { - "kind": "property", - "signature": "fonts: IFontStyles;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IFontStyles", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Font styles for different sizes." + "releaseTag": "Public", + "name": "ITheme", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "disableGlobalClassNames", + "docComment": "/**\n * Disables global styles on Fabric components. This will prevent global overrides that might have been set by other Fabric users from applying to your components.\n *\n * @remarks\n *\n * This has a vary narrow use case and most likely should be avoided.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "disableGlobalClassNames" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disableGlobalClassNames", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "fonts", + "docComment": "/**\n * Font styles for different sizes.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fonts" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IFontStyles" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fonts", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "isInverted", + "docComment": "/**\n * Indicates whether the theme is inverted.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isInverted" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isInverted", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "palette", + "docComment": "/**\n * Color palette.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "palette" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IPalette" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "palette", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "semanticColors", + "docComment": "/**\n * The collection of all semantic slots for colors used in themes.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "semanticColors" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISemanticColors" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "semanticColors", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "isInverted": { - "kind": "property", - "signature": "isInverted: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the theme is inverted." + { + "kind": "Class", + "canonicalReference": "(ThemeChangedEventArgs:class)", + "docComment": "/**\n * The object passed when the IThemeProvider.themeChangedEvent is raised.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class " + }, + { + "kind": "Reference", + "text": "ThemeChangedEventArgs" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPEventArgs" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "palette": { - "kind": "property", - "signature": "palette: IPalette;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPalette", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Color palette." + "releaseTag": "Public", + "name": "ThemeChangedEventArgs", + "members": [ + { + "kind": "Property", + "canonicalReference": "(theme:instance)", + "docComment": "/**\n * The new theme. If the value is undefined, then the theme was cleared.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "theme" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ITheme" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "theme", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] }, - "semanticColors": { - "kind": "property", - "signature": "semanticColors: ISemanticColors;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISemanticColors", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The collection of all semantic slots for colors used in themes." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ThemeChangedEventArgs": { - "kind": "class", - "extends": "SPEventArgs", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The object passed when the IThemeProvider.themeChangedEvent is raised." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "theme": { - "kind": "property", - "signature": "readonly theme: ITheme | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ITheme | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The new theme. If the value is undefined, then the theme was cleared." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ThemeProvider": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope, theme?: ITheme);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" + "kind": "Class", + "canonicalReference": "(ThemeProvider:class)", + "docComment": "/**\n * The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class " }, - "theme": { - "name": "theme", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ITheme" + { + "kind": "Reference", + "text": "ThemeProvider" + }, + { + "kind": "Content", + "text": " " } - }, - "deprecatedMessage": [], - "summary": [ + ], + "releaseTag": "Public", + "name": "ThemeProvider", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Construct a new instance of the ThemeProvider class.\n *\n * @param serviceScope - The current service scope.\n *\n * @param theme - Theme to provide.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "theme" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ITheme" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "theme", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for ThemeProvider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", "text": "ThemeProvider" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-component-base", - "exportName": "ThemeProvider", - "memberName": "" - } + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for ThemeProvider." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "themeChangedEvent": { - "kind": "property", - "signature": "readonly themeChangedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Raised when the theme changes with the new theme as an argument." + "kind": "Property", + "canonicalReference": "(themeChangedEvent:instance)", + "docComment": "/**\n * Raised when the theme changes with the new theme as an argument.\n *\n * @eventproperty\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "themeChangedEvent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPEvent" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ThemeChangedEventArgs" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeChangedEvent", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(tryGetTheme:instance,0)", + "docComment": "/**\n * If set, get the current scoped theme.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetTheme" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "IReadonlyTheme" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "tryGetTheme" } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": true + "implementsTokenRanges": [] }, - "tryGetTheme": { - "kind": "method", - "signature": "tryGetTheme(): IReadonlyTheme | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IReadonlyTheme | undefined", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "TypeAlias", + "canonicalReference": "IReadonlyRawStyle", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Reference", + "text": "Readonly" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IRawStyle" + }, { - "kind": "text", - "text": "If set, get the current scoped theme." + "kind": "Content", + "text": ">;" } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "releaseTag": "Public", + "name": "IReadonlyRawStyle" } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index f763dd56..7f99443e 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -1,3886 +1,4679 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-core-library", + "docComment": "/**\n * SharePoint Framework core libraries.\n *\n * @remarks\n *\n * This package provides a foundation of core classes that ensure a consistent character across all the other SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes small code size and broad applicability, versus flexibility or richness of features.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-core-library", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework core libraries." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package provides a foundation of core classes that ensure a consistent character across all the other SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes small code size and broad applicability, versus flexibility or richness of features." - } - ], - "exports": { - "DisplayMode": { - "kind": "enum", - "values": { - "Edit": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience." - } - ], - "remarks": [], - "isBeta": false - }, - "Read": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether a visual control should display itself for reading or for editing." - } - ], - "remarks": [], - "isBeta": false - }, - "Environment": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Information about the system environment where the SharePoint Framework is running." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "type": { - "kind": "property", - "signature": "static readonly type: EnvironmentType;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "EnvironmentType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates the general type of environment where the SharePoint Framework is running." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "EnvironmentType": { - "kind": "enum", - "values": { - "ClassicSharePoint": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported." - } - ], - "remarks": [], - "isBeta": false - }, - "Local": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the SharePoint Framework is running on a page from a \"localhost\" web server, for example the SharePoint Workbench when hosted via \"gulp serve\". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing." - } - ], - "remarks": [], - "isBeta": false - }, - "SharePoint": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario." - } - ], - "remarks": [], - "isBeta": false - }, - "Test": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates the general type of environment where the SharePoint Framework is running." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This enum is used by the " - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "api-link", - "elements": [ + "kind": "Enum", + "canonicalReference": "(DisplayMode:enum)", + "docComment": "/**\n * Indicates whether a visual control should display itself for reading or for editing.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Environment.type" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "Environment", - "memberName": "type" - } - }, - { - "kind": "text", - "text": " property. It provides a way to distinguish environments where certain functionality may be limited or disabled." - } - ], - "isBeta": false - }, - "Guid": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class represents a globally unique identifier, as described by IETF RFC 4122." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's " - }, - { - "kind": "code", - "text": "Math.random()", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " function and may be not be suitable for some applications." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "See " - }, - { - "kind": "web-link", - "elements": [ + "kind": "Content", + "text": "declare enum " + }, { - "kind": "text", - "text": "RFC4122" - } - ], - "targetUrl": "https://www.ietf.org/rfc/rfc4122.txt" - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "empty": { - "kind": "property", - "signature": "static readonly empty: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a new empty Guid instance." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "equals": { - "kind": "method", - "signature": "equals(guid: Guid): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "True if this instance and the specified Guid object represent the same value." - } - ] - }, - "parameters": { - "guid": { - "name": "guid", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Guid" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "DisplayMode" + }, { - "kind": "text", - "text": "Compare this instance to another Guid instance" + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isValid": { - "kind": "method", - "signature": "static isValid(guid: string | undefined | null): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "true, if the Guid is valid." - } - ] - }, - "parameters": { - "guid": { - "name": "guid", - "description": [ + "releaseTag": "Public", + "name": "DisplayMode", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "Edit", + "docComment": "/**\n * The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The input string." + "kind": "Reference", + "text": "Edit" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" } ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by " + "releaseTag": "Public", + "name": "Edit", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "Guid.tryParse()", - "highlighter": "plain" - }, + "kind": "EnumMember", + "canonicalReference": "Read", + "docComment": "/**\n * The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Read" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Read", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ] + }, + { + "kind": "Class", + "canonicalReference": "(Environment:class)", + "docComment": "/**\n * Information about the system environment where the SharePoint Framework is running.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": ". This function is cheaper than " + "kind": "Content", + "text": "export default class " }, { - "kind": "code", - "text": "Guid.tryParse()", - "highlighter": "plain" + "kind": "Reference", + "text": "Environment" }, { - "kind": "text", - "text": " because it does not construct a Guid object." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "newGuid": { - "kind": "method", - "signature": "static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Guid", - "description": [ - { - "kind": "text", - "text": "A new unique Guid object" - } - ] - }, - "parameters": { - "randomNumberGenerator": { - "name": "randomNumberGenerator", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IRandomNumberGenerator" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122." + "releaseTag": "Public", + "name": "Environment", + "members": [ + { + "kind": "Property", + "canonicalReference": "(type:static)", + "docComment": "/**\n * Indicates the general type of environment where the SharePoint Framework is running.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "type" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "EnvironmentType" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "implementsTokenRanges": [] }, - "parse": { - "kind": "method", - "signature": "static parse(guidString: string | undefined | null): Guid;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Guid", - "description": [ - { - "kind": "text", - "text": "A valid Guid object" - } - ] - }, - "parameters": { - "guidString": { - "name": "guidString", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example syntaxes accepted by this function:" - }, + { + "kind": "Enum", + "canonicalReference": "(EnvironmentType:enum)", + "docComment": "/**\n * Indicates the general type of environment where the SharePoint Framework is running.\n *\n * @remarks\n *\n * This enum is used by the {@link Environment.\"type\"} property. It provides a way to distinguish environments where certain functionality may be limited or disabled.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export declare enum " }, { - "kind": "text", - "text": "- " + "kind": "Reference", + "text": "EnvironmentType" }, { - "kind": "code", - "text": "\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"", - "highlighter": "plain" + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "EnvironmentType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "ClassicSharePoint", + "docComment": "/**\n * Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ClassicSharePoint" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "ClassicSharePoint", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "EnumMember", + "canonicalReference": "Local", + "docComment": "/**\n * Indicates that the SharePoint Framework is running on a page from a \"localhost\" web server, for example the SharePoint Workbench when hosted via \"gulp serve\". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Local" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Local", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "- " + "kind": "EnumMember", + "canonicalReference": "SharePoint", + "docComment": "/**\n * Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "SharePoint" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "SharePoint", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"", - "highlighter": "plain" - }, + "kind": "EnumMember", + "canonicalReference": "Test", + "docComment": "/**\n * Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Test" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Test", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ] + }, + { + "kind": "Class", + "canonicalReference": "(Guid:class)", + "docComment": "/**\n * This class represents a globally unique identifier, as described by IETF RFC 4122.\n *\n * @remarks\n *\n * The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications.\n *\n * See {@link https://www.ietf.org/rfc/rfc4122.txt | RFC4122} for more information.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export default class " }, { - "kind": "text", - "text": "- " + "kind": "Reference", + "text": "Guid" }, { - "kind": "code", - "text": "\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"", - "highlighter": "plain" + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "toString": { - "kind": "method", - "signature": "toString(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [ - { - "kind": "text", - "text": "The GUID value in lowercase hexadecimal without braces." - }, - { - "kind": "paragraph" + "releaseTag": "Public", + "name": "Guid", + "members": [ + { + "kind": "Property", + "canonicalReference": "(empty:static)", + "docComment": "/**\n * Returns a new empty Guid instance.\n *\n * @returns A new empty Guid object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "empty" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "empty", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 }, - { - "kind": "text", - "text": "Example: " + "isStatic": true + }, + { + "kind": "Method", + "canonicalReference": "(equals:instance,0)", + "docComment": "/**\n * Compare this instance to another Guid instance\n *\n * @returns True if this instance and the specified Guid object represent the same value.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "equals" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "guid" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 }, - { - "kind": "code", - "text": "'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'", - "highlighter": "plain" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a string representation of the GUID" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryParse": { - "kind": "method", - "signature": "static tryParse(guid: string | undefined | null): Guid | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Guid | undefined", - "description": [ - { - "kind": "text", - "text": "The Guid object, or undefined if the string could not be parsed." - } - ] - }, - "parameters": { - "guid": { - "name": "guid", - "description": [ + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "The input string." + "parameterName": "guid", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example syntaxes accepted by this function:" + "name": "equals" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(isValid:static,0)", + "docComment": "/**\n * Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object.\n *\n * @param guid - The input string.\n *\n * @returns true, if the Guid is valid.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "isValid" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "guid" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "guid", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "isValid" }, { - "kind": "text", - "text": "- " + "kind": "Method", + "canonicalReference": "(newGuid:static,0)", + "docComment": "/**\n * Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122.\n *\n * @returns A new unique Guid object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "newGuid" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "randomNumberGenerator" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IRandomNumberGenerator" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "randomNumberGenerator", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "newGuid" }, { - "kind": "code", - "text": "\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"", - "highlighter": "plain" + "kind": "Method", + "canonicalReference": "(parse:static,0)", + "docComment": "/**\n * Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.\n *\n * @remarks\n *\n * Example syntaxes accepted by this function:\n *\n * - `\"d5369f3bbd7a412a9c0f7f0650bb5489\"`\n *\n * - `\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"`\n *\n * - `\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"`\n *\n * - `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n *\n * @param guid - The input string.\n *\n * @returns A valid Guid object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "parse" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "guidString" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "guidString", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "parse" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(toString:instance,0)", + "docComment": "/**\n * Returns a string representation of the GUID\n *\n * @returns The GUID value in lowercase hexadecimal without braces.\n *\n * Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "toString" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "toString" }, { - "kind": "text", - "text": "- " - }, + "kind": "Method", + "canonicalReference": "(tryParse:static,0)", + "docComment": "/**\n * Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned.\n *\n * @remarks\n *\n * Example syntaxes accepted by this function:\n *\n * - `\"d5369f3bbd7a412a9c0f7f0650bb5489\"`\n *\n * - `\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"`\n *\n * - `\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"`\n *\n * - `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n *\n * @param guid - The input string.\n *\n * @returns The Guid object, or undefined if the string could not be parsed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "tryParse" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "guid" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "guid", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "tryParse" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IDisposable:interface)", + "docComment": "/**\n * Implemented by an object that supports a disposal lifecycle.\n *\n * @remarks\n *\n * The dispose event allows an object to free any resources that it allocated before its lifecycle ends.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "code", - "text": "\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"", - "highlighter": "plain" + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IDisposable" }, { - "kind": "text", - "text": "- " + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDisposable", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(dispose:0)", + "docComment": "/**\n * This method is called to permanently dispose the object.\n *\n * @remarks\n *\n * After the object has been disposed, do not call its methods or access its properties.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "dispose" }, { - "kind": "code", - "text": "\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "isDisposed", + "docComment": "/**\n * Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently.\n *\n * @remarks\n *\n * After the object has been disposed, do not call its methods or access its properties.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isDisposed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDisposable": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Implemented by an object that supports a disposal lifecycle." - } - ], - "remarks": [ + "extendsTokenRanges": [] + }, { - "kind": "text", - "text": "The dispose event allows an object to free any resources that it allocated before its lifecycle ends." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "dispose": { - "kind": "method", - "signature": "dispose(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This method is called to permanently dispose the object." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(IRandomNumberGenerator:interface)", + "docComment": "/**\n * This is a {@link ServiceScope} contract for generating pseudorandom random numbers.\n *\n * @remarks\n *\n * This interface abstracts the functionality of the system Math.random() API for usage with a {@link ServiceScope}. For example, a unit test might replace the default {@link RandomNumberGenerator} service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isDisposed": { - "kind": "property", - "signature": "isDisposed: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently." - } - ], - "remarks": [ - { - "kind": "text", - "text": "After the object has been disposed, do not call its methods or access its properties." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IRandomNumberGenerator": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": " contract for generating pseudorandom random numbers." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface abstracts the functionality of the system Math.random() API for usage with a " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Reference", + "text": "IRandomNumberGenerator" + }, { - "kind": "text", - "text": "ServiceScope" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": ". For example, a unit test might replace the default " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "RandomNumberGenerator" + "releaseTag": "Public", + "name": "IRandomNumberGenerator", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(generate:0)", + "docComment": "/**\n * Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "generate" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "generate" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "RandomNumberGenerator", - "memberName": "" - } + "extendsTokenRanges": [] }, { - "kind": "text", - "text": " service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "generate": { - "kind": "method", - "signature": "generate(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IServiceCollection": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release." - } - ], - "summary": [ - { - "kind": "text", - "text": "A shorthand pattern for extracting well-known services from a ServiceScope." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "serviceScope": { - "kind": "property", - "signature": "readonly serviceScope: ServiceScope;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ServiceScope", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release." - } - ], - "summary": [ + "kind": "Interface", + "canonicalReference": "(IServiceCollection:interface)", + "docComment": "/**\n * A shorthand pattern for extracting well-known services from a ServiceScope.\n *\n * @deprecated\n *\n * This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Returns the underlying ServiceScope that the members belong to." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPEventObserver": { - "kind": "interface", - "extends": "IDisposable", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Used with the " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": "interface " + }, { - "kind": "text", - "text": "SPEvent" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "SPEvent", - "memberName": "" - } - }, - { - "kind": "text", - "text": " system, this interface is implemented by components that can subscribe to events." - } - ], - "remarks": [ - { - "kind": "text", - "text": "ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "componentId": { - "kind": "property", - "signature": "readonly componentId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The component identifier, from the component's manifest." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IServiceCollection" + }, { - "kind": "text", - "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The instance identifier for the component." + "kind": "Content", + "text": " " } ], - "remarks": [ - { - "kind": "text", - "text": "This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception" + "releaseTag": "Public", + "name": "IServiceCollection", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "serviceScope", + "docComment": "/**\n * Returns the underlying ServiceScope that the members belong to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceScope", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ITimeProvider": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a " + "extendsTokenRanges": [] }, { - "kind": "api-link", - "elements": [ + "kind": "Interface", + "canonicalReference": "(ISPEventObserver:interface)", + "docComment": "/**\n * Used with the {@link SPEvent} system, this interface is implemented by components that can subscribe to events.\n *\n * @remarks\n *\n * ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": " contract for reading the system clock." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface abstracts the functionality of the system time APIs for usage with a " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } - }, - { - "kind": "text", - "text": ". For example, a unit test might replace the default " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Reference", + "text": "ISPEventObserver" + }, { - "kind": "text", - "text": "TimeProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "TimeProvider", - "memberName": "" - } - }, - { - "kind": "text", - "text": " service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "getDate": { - "kind": "method", - "signature": "getDate(): Date;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Date", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the current date/time, similar to the Date class constructor." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getTimestamp": { - "kind": "method", - "signature": "getTimestamp(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Log": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A basic redirectable logging system." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "error": { - "kind": "method", - "signature": "static error(source: string, error: Error, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ - { - "kind": "text", - "text": "the source from where the error is logged, e.g., the class name. The source provides context information for the logged error. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "error": { - "name": "error", - "description": [ - { - "kind": "text", - "text": "the error to be logged" - } - ], - "isOptional": false, - "isSpread": false, - "type": "Error" - }, - "scope": { - "name": "scope", - "description": [ - { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error." - } - ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, { - "kind": "text", - "text": "Logs an error." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "info": { - "kind": "method", - "signature": "static info(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ + "releaseTag": "Public", + "name": "ISPEventObserver", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "componentId", + "docComment": "/**\n * The component identifier, from the component's manifest.\n *\n * @remarks\n *\n * This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "message": { - "name": "message", - "description": [ + "kind": "Content", + "text": "readonly " + }, { - "kind": "text", - "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." + "kind": "Reference", + "text": "componentId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, - "scope": { - "name": "scope", - "description": [ + { + "kind": "PropertySignature", + "canonicalReference": "instanceId", + "docComment": "/**\n * The instance identifier for the component.\n *\n * @remarks\n *\n * This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "instanceId" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } } - }, - "deprecatedMessage": [], - "summary": [ + ], + "extendsTokenRanges": [ { - "kind": "text", - "text": "Logs a general informational message." + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] }, - "verbose": { - "kind": "method", - "signature": "static verbose(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ - { - "kind": "text", - "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" + { + "kind": "Interface", + "canonicalReference": "(ITimeProvider:interface)", + "docComment": "/**\n * This is a {@link ServiceScope} contract for reading the system clock.\n *\n * @remarks\n *\n * This interface abstracts the functionality of the system time APIs for usage with a {@link ServiceScope}. For example, a unit test might replace the default {@link TimeProvider} service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " }, - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" + { + "kind": "Reference", + "text": "ITimeProvider" }, - "scope": { - "name": "scope", - "description": [ - { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." - } - ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Logs a message which contains detailed information that is generally only needed for troubleshooting." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "warn": { - "kind": "method", - "signature": "static warn(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "source": { - "name": "source", - "description": [ + "releaseTag": "Public", + "name": "ITimeProvider", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(getDate:0)", + "docComment": "/**\n * Returns the current date/time, similar to the Date class constructor.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "message": { - "name": "message", - "description": [ + "kind": "Reference", + "text": "getDate" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Date" + }, { - "kind": "text", - "text": "the message to be logged If the message's length is more than 100, only the first 100 characters are kept." + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getDate" }, - "scope": { - "name": "scope", - "description": [ + { + "kind": "MethodSignature", + "canonicalReference": "(getTimestamp:0)", + "docComment": "/**\n * Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getTimestamp" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message." + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Logs a warning." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "RandomNumberGenerator": { - "kind": "class", - "extends": "", - "implements": "IRandomNumberGenerator", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the default implementation of " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IRandomNumberGenerator" + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getTimestamp" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "IRandomNumberGenerator", - "memberName": "" - } + "extendsTokenRanges": [] }, { - "kind": "text", - "text": " that simply calls Math.random()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(Log:class)", + "docComment": "/**\n * A basic redirectable logging system.\n *\n * @remarks\n *\n * The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": "export default class " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "RandomNumberGenerator" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "RandomNumberGenerator", - "memberName": "" - } + "kind": "Reference", + "text": "Log" }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "generate": { - "kind": "method", - "signature": "generate(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for IRandomNumberGenerator." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ServiceKey": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [ - "T" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The ServiceKey is a lookup key that is used when calling " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope.consume" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "consume" - } - }, - { - "kind": "text", - "text": " to fetch a dependency." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "create": { - "kind": "method", - "signature": "static create(name: string, serviceClass: {\n new (serviceScope: ServiceScope);\n }): ServiceKey;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ServiceKey", - "description": [ - { - "kind": "text", - "text": "the newly created ServiceKey" - } - ] - }, - "parameters": { - "name": { - "name": "name", - "description": [ + "releaseTag": "Public", + "name": "Log", + "members": [ + { + "kind": "Method", + "canonicalReference": "(error:static,0)", + "docComment": "/**\n * Logs an error.\n *\n * @param source - the source from where the error is logged, e.g., the class name. The source provides context information for the logged error. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param error - the error to be logged\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "error" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "source" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "error" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "A name such as \"my-package.IMyService\" which should be unique across packages." + "kind": "Reference", + "text": "Error" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "scope" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "serviceClass": { - "name": "serviceClass", - "description": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, { - "kind": "text", - "text": "the TypeScript class that implements the service." + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } } ], - "isOptional": false, - "isSpread": false, - "type": "{\n new (serviceScope: ServiceScope);\n }" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If you want to specify custom constructor parameters, use " + "name": "error" }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(info:static,0)", + "docComment": "/**\n * Logs a general informational message.\n *\n * @param source - the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param message - the message to be logged If the message's length is more than 100, only the first 100 characters are kept.\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "info" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "source" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "scope" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, { - "kind": "text", - "text": "ServiceKey.createCustom" + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceKey", - "memberName": "createCustom" - } - }, - { - "kind": "text", - "text": " instead." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createCustom": { - "kind": "method", - "signature": "static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ServiceKey", - "description": [ - { - "kind": "text", - "text": "the newly created service key" - } - ] - }, - "parameters": { - "name": { - "name": "name", - "description": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "A name such as \"my-package.IMyService\" which should be unique across packages." + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "name": "info" }, - "defaultCreator": { - "name": "defaultCreator", - "description": [ + { + "kind": "Method", + "canonicalReference": "(verbose:static,0)", + "docComment": "/**\n * Logs a message which contains detailed information that is generally only needed for troubleshooting.\n *\n * @param source - the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param message - the message to be logged If the message's length is more than 100, only the first 100 characters are kept.\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "a callback that returns an object that implements the T interface" - } + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "verbose" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "source" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "scope" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } ], - "isOptional": false, - "isSpread": false, - "type": "ServiceCreator" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } + } + ], + "name": "verbose" + }, { - "kind": "text", - "text": "Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "defaultCreator": { - "kind": "property", - "signature": "readonly defaultCreator: ServiceCreator;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ServiceCreator", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A callback function that constructs the default instance of this service." + "kind": "Method", + "canonicalReference": "(warn:static,0)", + "docComment": "/**\n * Logs a warning.\n *\n * @param source - the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param message - the message to be logged If the message's length is more than 100, only the first 100 characters are kept.\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "warn" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "source" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "scope" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } + } + ], + "name": "warn" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "id": { - "kind": "property", - "signature": "readonly id: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this service key." - } - ], - "remarks": [ + { + "kind": "Class", + "canonicalReference": "(RandomNumberGenerator:class)", + "docComment": "/**\n * This is the default implementation of {@link IRandomNumberGenerator} that simply calls Math.random().\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers should not make assumptions about the formatting of this string. It is currently based on a global counter, but this may change in the future." + "kind": "Content", + "text": "export default class " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "RandomNumberGenerator" }, { - "kind": "text", - "text": "The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "name": { - "kind": "property", - "signature": "readonly name: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The name of the service." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the package name, followed by a period, followed by the class or interface name." + "kind": "Content", + "text": " implements " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IRandomNumberGenerator" }, { - "kind": "text", - "text": "The system does not assume that this string is unique. Instead, the " + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "RandomNumberGenerator", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `RandomNumberGenerator` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(generate:instance,0)", + "docComment": "/**\n * Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "generate" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "ServiceKey.id" + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceKey", - "memberName": "id" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "generate" }, { - "kind": "text", - "text": " is used wherever a lookup key is needed." + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for IRandomNumberGenerator.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IRandomNumberGenerator" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ServiceScope": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service locator pattern used by the SharePoint Framework." - } - ], - "remarks": [ - { - "kind": "text", - "text": "ServiceScope provides a formalized way for components to register and consume dependencies (\"services\"), and to enable different implementations to be registered in different scopes. This improves modularity by decoupling components from their dependencies in an extensible way." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For example, suppose that various components need access to an IPageManager instance. We could simply make the PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter for each component that requires it, however then we immediately face the problem that any code that calls these constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with name like \"ApplicationContext\", and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, it still has a design problem that \"ApplicationContext\" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the popular \"service locator\" design pattern, familiar from the SPContext API in classic SharePoint." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components can assume that consume() will always return some object that implements the contract." - }, - { - "kind": "paragraph" + "implementsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] }, { - "kind": "text", - "text": "Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are initially in an \"unfinished\" state, during which provide() can be called to register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the same key, and does not depend on order of initialization. It also allows us to support circular dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished()." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "protected constructor(parent: ServiceScope | undefined);", - "parameters": { - "parent": { - "name": "parent", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope | undefined" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(ServiceKey:class)", + "docComment": "/**\n * The ServiceKey is a lookup key that is used when calling {@link ServiceScope.consume} to fetch a dependency.\n *\n * @remarks\n *\n * Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": "export default class " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "" - } + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": " class" + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": "> " } ], - "remarks": [] - }, - "consume": { - "kind": "method", - "signature": "consume(serviceKey: ServiceKey): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "the service instance" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ + "releaseTag": "Public", + "name": "ServiceKey", + "members": [ + { + "kind": "Method", + "canonicalReference": "(create:static,0)", + "docComment": "/**\n * Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter.\n *\n * @remarks\n *\n * If you want to specify custom constructor parameters, use {@link ServiceKey.createCustom} instead.\n *\n * @param name - A name such as \"my-package.IMyService\" which should be unique across packages.\n *\n * @param serviceClass - the TypeScript class that implements the service.\n *\n * @returns the newly created ServiceKey\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "create" + }, + { + "kind": "Content", + "text": "<" + }, { - "kind": "text", - "text": "the key that was used when provide() was called to register the service" + "kind": "Reference", + "text": "TKey" + }, + { + "kind": "Content", + "text": ">(" + }, + { + "kind": "Reference", + "text": "name" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "serviceClass" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "{\n new (" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "TKey" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TKey" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Consumes a service from the service scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Components should call this function to \"consume\" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createAndProvide": { - "kind": "method", - "signature": "createAndProvide(serviceKey: ServiceKey, simpleServiceClass: {\n new (serviceScope: ServiceScope);\n }): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "a newly constructed instance of simpleServiceClass" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 19, + "endIndex": 23 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "the key that can be used later to consume the service" + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "serviceClass", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 18 + } } ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" + "name": "create" }, - "simpleServiceClass": { - "name": "simpleServiceClass", - "description": [ + { + "kind": "Method", + "canonicalReference": "(createCustom:static,0)", + "docComment": "/**\n * Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback.\n *\n * @param name - A name such as \"my-package.IMyService\" which should be unique across packages.\n *\n * @param defaultCreator - a callback that returns an object that implements the T interface\n *\n * @returns the newly created service key\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "createCustom" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TKey" + }, + { + "kind": "Content", + "text": ">(" + }, + { + "kind": "Reference", + "text": "name" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "defaultCreator" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceCreator" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TKey" + }, { - "kind": "text", - "text": "the TypeScript class to be constructed" + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TKey" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "{\n new (serviceScope: ServiceScope);\n }" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "createDefaultAndProvide": { - "kind": "method", - "signature": "createDefaultAndProvide(serviceKey: ServiceKey): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "a service instance that was constructed using ServiceKey.defaultCreator" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 16, + "endIndex": 20 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "the key that can be used later to consume the service" + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "defaultCreator", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + } } ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide()." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "finish": { - "kind": "method", - "signature": "finish(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Completes the initialization sequence for a service scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When a ServiceScope is first started, it is in an \"unfinished\" state where provide() is allowed but consume() is disallowed. After calling finish(), then consume() is allowed but provide() is disallowed." + "name": "createCustom" }, { - "kind": "paragraph" + "kind": "Property", + "canonicalReference": "(defaultCreator:instance)", + "docComment": "/**\n * A callback function that constructs the default instance of this service.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "defaultCreator" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceCreator" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultCreator", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false }, { - "kind": "text", - "text": "This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getParent": { - "kind": "method", - "signature": "getParent(): ServiceScope | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ServiceScope | undefined", - "description": [ - { - "kind": "text", - "text": "the parent service scope" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the parent of the current ServiceScope, or undefined if this is a root scope." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "provide": { - "kind": "method", - "signature": "provide(serviceKey: ServiceKey, service: T): T;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "T", - "description": [ - { - "kind": "text", - "text": "the same object that was passed as the \"service\" parameter" - } - ] - }, - "parameters": { - "serviceKey": { - "name": "serviceKey", - "description": [ + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * A unique identifier for this service key.\n *\n * @remarks\n *\n * This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers should not make assumptions about the formatting of this string. It is currently based on a global counter, but this may change in the future.\n *\n * The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, { - "kind": "text", - "text": "the key that will later be used to consume the service" + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "ServiceKey" + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "service": { - "name": "service", - "description": [ + { + "kind": "Property", + "canonicalReference": "(name:instance)", + "docComment": "/**\n * The name of the service.\n *\n * @remarks\n *\n * This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the package name, followed by a period, followed by the class or interface name.\n *\n * The system does not assume that this string is unique. Instead, the {@link ServiceKey.id} is used wherever a lookup key is needed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "name" + }, { - "kind": "text", - "text": "the service instance that is being registered" + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "T" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add a new service to a service scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an \"unfinished\" state, i.e. before finish() has been called." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "startNewChild": { - "kind": "method", - "signature": "startNewChild(): ServiceScope;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ServiceScope", - "description": [ - { - "kind": "text", - "text": "the newly created root ServiceScope" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new ServiceScope that is a child of the current scope." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "startNewRoot": { - "kind": "method", - "signature": "static startNewRoot(): ServiceScope;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ServiceScope", - "description": [ - { - "kind": "text", - "text": "the newly created root ServiceScope" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys." + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "implementsTokenRanges": [] }, - "whenFinished": { - "kind": "method", - "signature": "whenFinished(callback: () => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [ - { - "kind": "text", - "text": "A block of code that needs to call ServiceScope.consume()" - } - ], - "isOptional": false, - "isSpread": false, - "type": "() => void" - } - }, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(ServiceScope:class)", + "docComment": "/**\n * The service locator pattern used by the SharePoint Framework.\n *\n * @remarks\n *\n * ServiceScope provides a formalized way for components to register and consume dependencies (\"services\"), and to enable different implementations to be registered in different scopes. This improves modularity by decoupling components from their dependencies in an extensible way.\n *\n * For example, suppose that various components need access to an IPageManager instance. We could simply make the PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter for each component that requires it, however then we immediately face the problem that any code that calls these constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with name like \"ApplicationContext\", and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, it still has a design problem that \"ApplicationContext\" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the popular \"service locator\" design pattern, familiar from the SPContext API in classic SharePoint.\n *\n * ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components can assume that consume() will always return some object that implements the contract.\n *\n * Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are initially in an \"unfinished\" state, during which provide() can be called to register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the same key, and does not depend on order of initialization. It also allows us to support circular dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished().\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Defer an operation until after " + "kind": "Content", + "text": "export default class " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ServiceScope.finish" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ServiceScope", - "memberName": "finish" - } + "kind": "Reference", + "text": "ServiceScope" }, { - "kind": "text", - "text": " has completed." + "kind": "Content", + "text": " " } ], - "remarks": [ - { - "kind": "text", - "text": "It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed later when the scope is finished." + "releaseTag": "Public", + "name": "ServiceScope", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `ServiceScope` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected constructor(" + }, + { + "kind": "Reference", + "text": "parent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "parent", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ] }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(consume:instance,0)", + "docComment": "/**\n * Consumes a service from the service scope.\n *\n * @remarks\n *\n * Components should call this function to \"consume\" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope.\n *\n * @param serviceKey - the key that was used when provide() was called to register the service\n *\n * @returns the service instance\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "consume" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">(" + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + } + } + ], + "name": "consume" }, { - "kind": "text", - "text": "NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished()." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Session": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the application's browser session and active page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "applicationId": { - "kind": "property", - "signature": "static readonly applicationId: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the current instance of the client-side application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the duration of the client-side application instance, i.e. it begins with the server request that renders the page, and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "pageId": { - "kind": "property", - "signature": "static readonly pageId: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the current page within the client-side application." - } - ], - "remarks": [ + "kind": "Method", + "canonicalReference": "(createAndProvide:instance,0)", + "docComment": "/**\n * This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide().\n *\n * @param serviceKey - the key that can be used later to consume the service\n *\n * @param simpleServiceClass - the TypeScript class to be constructed\n *\n * @returns a newly constructed instance of simpleServiceClass\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "createAndProvide" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">(" + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "simpleServiceClass" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "{\n new (" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 21, + "endIndex": 22 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + } + }, + { + "parameterName": "simpleServiceClass", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 20 + } + } + ], + "name": "createAndProvide" + }, { - "kind": "text", - "text": "A unique identifier used to correlate logging and other diagnostic information. Whereas the " + "kind": "Method", + "canonicalReference": "(createDefaultAndProvide:instance,0)", + "docComment": "/**\n * This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide().\n *\n * @param serviceKey - the key that can be used later to consume the service\n *\n * @returns a service instance that was constructed using ServiceKey.defaultCreator\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "createDefaultAndProvide" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">(" + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + } + } + ], + "name": "createDefaultAndProvide" }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(finish:instance,0)", + "docComment": "/**\n * Completes the initialization sequence for a service scope.\n *\n * @remarks\n *\n * When a ServiceScope is first started, it is in an \"unfinished\" state where provide() is allowed but consume() is disallowed. After calling finish(), then consume() is allowed but provide() is disallowed.\n *\n * This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "finish" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "Session.applicationId" + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "Session", - "memberName": "applicationId" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "finish" }, { - "kind": "text", - "text": " tracks the entire lifetime of the client-side application instance, the pageId tracks an individual \"page\" that is rendered." + "kind": "Method", + "canonicalReference": "(getParent:instance,0)", + "docComment": "/**\n * Returns the parent of the current ServiceScope, or undefined if this is a root scope.\n *\n * @returns the parent service scope\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getParent" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getParent" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(provide:instance,0)", + "docComment": "/**\n * Add a new service to a service scope.\n *\n * @remarks\n *\n * ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an \"unfinished\" state, i.e. before finish() has been called.\n *\n * @param serviceKey - the key that will later be used to consume the service\n *\n * @param service - the service instance that is being registered\n *\n * @returns the same object that was passed as the \"service\" parameter\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "provide" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">(" + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "service" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + } + }, + { + "parameterName": "service", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } + } + ], + "name": "provide" }, { - "kind": "text", - "text": "For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA independently of PageB." + "kind": "Method", + "canonicalReference": "(startNewChild:instance,0)", + "docComment": "/**\n * Constructs a new ServiceScope that is a child of the current scope.\n *\n * @remarks\n *\n * The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted.\n *\n * @returns the newly created root ServiceScope\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "startNewChild" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "startNewChild" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(startNewRoot:static,0)", + "docComment": "/**\n * Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys.\n *\n * @returns the newly created root ServiceScope\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "startNewRoot" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "startNewRoot" }, { - "kind": "text", - "text": "The concept of a page is subjective and defined by the router for a particular application." + "kind": "Method", + "canonicalReference": "(whenFinished:instance,0)", + "docComment": "/**\n * Defer an operation until after {@link ServiceScope.finish} has completed.\n *\n * @remarks\n *\n * It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed later when the scope is finished.\n *\n * NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished().\n *\n * @param callback - A block of code that needs to call ServiceScope.consume()\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "whenFinished" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "whenFinished" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPEvent": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [ - "TEventArgs extends SPEventArgs" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a framework event that components can subscribe to." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPEvent class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed." - }, - { - "kind": "paragraph" + "implementsTokenRanges": [] }, { - "kind": "text", - "text": "When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "add": { - "kind": "method", - "signature": "add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "observer": { - "name": "observer", - "description": [ - { - "kind": "text", - "text": "Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception." - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPEventObserver" - }, - "eventHandler": { - "name": "eventHandler", - "description": [ - { - "kind": "text", - "text": "A callback function that will be invoked whenever the event occurs" - } - ], - "isOptional": false, - "isSpread": false, - "type": "(eventArgs: TEventArgs) => void" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Registers a callback that will be invoked whenever the event occurs." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(Session:class)", + "docComment": "/**\n * Provides access to the application's browser session and active page.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "remove": { - "kind": "method", - "signature": "remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "observer": { - "name": "observer", - "description": [ - { - "kind": "text", - "text": "This must be the same observer that was passed to the add() function." - } - ], - "isOptional": false, - "isSpread": false, - "type": "ISPEventObserver" - }, - "eventHandler": { - "name": "eventHandler", - "description": [ - { - "kind": "text", - "text": "The event handler to remove; this must be the same object instance that was passed to the add() function." - } - ], - "isOptional": false, - "isSpread": false, - "type": "(eventArgs: TEventArgs) => void" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "Unregisters a callback that was registered using add()." - } - ], - "remarks": [ + "kind": "Reference", + "text": "Session" + }, { - "kind": "text", - "text": "If the event handler has already been removed, or if it was never added, then this method has no effect." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPEventArgs": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for event arguments used with the " - }, - { - "kind": "api-link", - "elements": [ + "releaseTag": "Public", + "name": "Session", + "members": [ + { + "kind": "Property", + "canonicalReference": "(applicationId:static)", + "docComment": "/**\n * A unique identifier for the current instance of the client-side application.\n *\n * @remarks\n *\n * A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the duration of the client-side application instance, i.e. it begins with the server request that renders the page, and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "applicationId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, { - "kind": "text", - "text": "SPEvent" + "kind": "Property", + "canonicalReference": "(pageId:static)", + "docComment": "/**\n * A unique identifier for the current page within the client-side application.\n *\n * @remarks\n *\n * A unique identifier used to correlate logging and other diagnostic information. Whereas the {@link Session.applicationId} tracks the entire lifetime of the client-side application instance, the pageId tracks an individual \"page\" that is rendered.\n *\n * For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA independently of PageB.\n *\n * The concept of a page is subjective and defined by the router for a particular application.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "pageId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "pageId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "SPEvent", - "memberName": "" - } + "implementsTokenRanges": [] }, { - "kind": "text", - "text": " class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If certain event types need to provide additional details, they will define a subclass of SPEventArgs." - } - ], - "isBeta": false, - "isSealed": false - }, - "Text": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Operations for working with strings that contain text." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The utilities provided by this class are intended to be simple, small, and very broadly applicable." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "format": { - "kind": "method", - "signature": "static format(s: string, ...values: any[]): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": { - "s": { - "name": "s", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "values": { - "name": "values", - "description": [], - "isOptional": false, - "isSpread": true, - "type": "any[]" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Format a string by substituting parameters." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This function replaces template parameters such as " - }, - { - "kind": "code", - "text": "\"{0}\"", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "\"{1}\"", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " with the corresponding argument. If the value is null or undefined, it will be replaced by the word " - }, - { - "kind": "code", - "text": "\"null\"", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "\"undefined\"", - "highlighter": "plain" - }, + "kind": "Class", + "canonicalReference": "(SPEvent:class)", + "docComment": "/**\n * Represents a framework event that components can subscribe to.\n *\n * @remarks\n *\n * Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed.\n *\n * When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPEvent` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": ". The format string s must not be null or undefined." + "kind": "Content", + "text": "export default class " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPEvent" }, { - "kind": "text", - "text": "Usage example:" + "kind": "Content", + "text": "<" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "TEventArgs" }, { - "kind": "code", - "text": "Text.format(\"hello {0}!\", \"world\")", - "highlighter": "plain" + "kind": "Content", + "text": " extends " }, { - "kind": "text", - "text": " will return " + "kind": "Reference", + "text": "SPEventArgs" }, { - "kind": "code", - "text": "\"hello world!\"", - "highlighter": "plain" + "kind": "Content", + "text": "> " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "replaceAll": { - "kind": "method", - "signature": "static replaceAll(input: string, searchValue: string, replaceValue: string): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": { - "input": { - "name": "input", - "description": [ + "releaseTag": "Public", + "name": "SPEvent", + "members": [ + { + "kind": "Method", + "canonicalReference": "(add:instance,0)", + "docComment": "/**\n * Registers a callback that will be invoked whenever the event occurs.\n *\n * @remarks\n *\n * The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed.\n *\n * @param observer - Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception.\n *\n * @param eventHandler - A callback function that will be invoked whenever the event occurs\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "add" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "observer" + }, { - "kind": "text", - "text": "The string to be modified" + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPEventObserver" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "eventHandler" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "eventArgs" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TEventArgs" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "searchValue": { - "name": "searchValue", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "The value to search for" + "parameterName": "observer", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "eventHandler", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 13 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "name": "add" }, - "replaceValue": { - "name": "replaceValue", - "description": [ + { + "kind": "Method", + "canonicalReference": "(remove:instance,0)", + "docComment": "/**\n * Unregisters a callback that was registered using add().\n *\n * @remarks\n *\n * If the event handler has already been removed, or if it was never added, then this method has no effect.\n *\n * @param observer - This must be the same observer that was passed to the add() function.\n *\n * @param eventHandler - The event handler to remove; this must be the same object instance that was passed to the add() function.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The replacement text" + "kind": "Reference", + "text": "remove" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "observer" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPEventObserver" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "eventHandler" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "eventArgs" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TEventArgs" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the input string, with all instances of " - }, - { - "kind": "code", - "text": "searchValue", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " replaced by " - }, - { - "kind": "code", - "text": "replaceValue", - "highlighter": "plain" - }, - { - "kind": "text", - "text": "." + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "observer", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "eventHandler", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 13 + } + } + ], + "name": "remove" } ], - "remarks": [ + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(SPEventArgs:class)", + "docComment": "/**\n * The base class for event arguments used with the {@link SPEvent} class.\n *\n * @remarks\n *\n * If certain event types need to provide additional details, they will define a subclass of SPEventArgs.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Note that JavaScript's " + "kind": "Content", + "text": "export default class " }, { - "kind": "code", - "text": "string.replace()", - "highlighter": "plain" + "kind": "Reference", + "text": "SPEventArgs" }, { - "kind": "text", - "text": " only replaces the first match, unless a global RegExp is provided." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "TimeProvider": { - "kind": "class", - "extends": "", - "implements": "ITimeProvider", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the default implementation of " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "ITimeProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "ITimeProvider", - "memberName": "" - } + "releaseTag": "Public", + "name": "SPEventArgs", + "members": [], + "implementsTokenRanges": [] }, { - "kind": "text", - "text": " that simply calls the real browser APIs." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(Text:class)", + "docComment": "/**\n * Operations for working with strings that contain text.\n *\n * @remarks\n *\n * The utilities provided by this class are intended to be simple, small, and very broadly applicable.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": "export default class " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "TimeProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "TimeProvider", - "memberName": "" - } + "kind": "Reference", + "text": "Text" }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "getDate": { - "kind": "method", - "signature": "getDate(): Date;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Date", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the current date/time, similar to the Date class constructor." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getTimestamp": { - "kind": "method", - "signature": "getTimestamp(): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "number", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for ITimeProvider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "UrlQueryParameterCollection": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Provides features for storing and retrieving URL query parameters." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with \"?\" to indicate the first query parameter and use \"&\" for all subsequent parameters. The class also supports fragments." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Edge case behavior:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(url: string);", - "parameters": { - "url": { - "name": "url", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." + "kind": "Content", + "text": " " } ], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ + "releaseTag": "Public", + "name": "Text", + "members": [ + { + "kind": "Method", + "canonicalReference": "(format:static,0)", + "docComment": "/**\n * Format a string by substituting parameters.\n *\n * @remarks\n *\n * This function replaces template parameters such as `\"{0}\"` or `\"{1}\"` with the corresponding argument. If the value is null or undefined, it will be replaced by the word `\"null\"` or `\"undefined\"`. The format string s must not be null or undefined.\n *\n * Usage example:\n *\n * `Text.format(\"hello {0}!\", \"world\")` will return `\"hello world!\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "format" + }, { - "kind": "text", - "text": "UrlQueryParameterCollection" + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "s" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", ..." + }, + { + "kind": "Reference", + "text": "values" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-core-library", - "exportName": "UrlQueryParameterCollection", - "memberName": "" - } + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "s", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "values", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "format" }, { - "kind": "text", - "text": " class" + "kind": "Method", + "canonicalReference": "(replaceAll:static,0)", + "docComment": "/**\n * Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.\n *\n * @remarks\n *\n * Note that JavaScript's `string.replace()` only replaces the first match, unless a global RegExp is provided.\n *\n * @param input - The string to be modified\n *\n * @param searchValue - The value to search for\n *\n * @param replaceValue - The replacement text\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "replaceAll" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "input" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "searchValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "replaceValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "input", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "searchValue", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "replaceValue", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } + } + ], + "name": "replaceAll" } ], - "remarks": [] + "implementsTokenRanges": [] }, - "getValue": { - "kind": "method", - "signature": "getValue(param: string): string | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string | undefined", - "description": [] - }, - "parameters": { - "param": { - "name": "param", - "description": [ - { - "kind": "text", - "text": "the case insensitive key for the desired query parameter value." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Returns the value of the first matching query parameter or undefined if the key doesn't exist." - } - ], - "remarks": [ + { + "kind": "Class", + "canonicalReference": "(TimeProvider:class)", + "docComment": "/**\n * This is the default implementation of {@link ITimeProvider} that simply calls the real browser APIs.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Examples:" + "kind": "Content", + "text": "export default class " }, { - "kind": "code-box", - "text": "this._queryParameterList = [\n{key: TEST, value: done},\n{key: DEBUG, value: false},\n{key: TEST, value: notdone}]\n getValue('TEST') ---> 'done'\n getValue('debug') ---> 'false'\n getValue('lost') ---> undefined\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getValues": { - "kind": "method", - "signature": "getValues(param: string): (string | undefined)[] | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "(string | undefined)[] | undefined", - "description": [] - }, - "parameters": { - "param": { - "name": "param", - "description": [ - { - "kind": "text", - "text": "the case insensitive key for the desired query parameter value." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers." - } - ], - "summary": [ - { - "kind": "text", - "text": "Returns the values of all of the matching query parameters or undefined if the key doesn't exist." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples:" + "kind": "Reference", + "text": "TimeProvider" }, { - "kind": "code-box", - "text": "this._queryParameterList = [\n{key: TEST, value: done},\n{key: DEBUG, value: false},\n{key: TEST, value: notdone}]\n getValues('TEST') ---> ['done', 'notdone']\n getValues('debug') ---> ['false']\n getValues('lost') ---> undefined\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Validate": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Performs common validation tests for properties and function parameters." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "isNonemptyString": { - "kind": "method", - "signature": "static isNonemptyString(value: string | undefined | null, variableName: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - }, - "variableName": { - "name": "variableName", - "description": [ - { - "kind": "text", - "text": "the program variable name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Throws an exception if the specified string is null, undefined, or an empty string." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isNotDisposed": { - "kind": "method", - "signature": "static isNotDisposed(value: IDisposable, className: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "IDisposable" - }, - "className": { - "name": "className", - "description": [ - { - "kind": "text", - "text": "the class name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Throws an exception if the specified object has been disposed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isNotNullOrUndefined": { - "kind": "method", - "signature": "static isNotNullOrUndefined(value: any, variableName: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "variableName": { - "name": "variableName", - "description": [ - { - "kind": "text", - "text": "the program variable name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": " implements " + }, { - "kind": "text", - "text": "Throws an exception if the specified value is null or undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isTrue": { - "kind": "method", - "signature": "static isTrue(value: boolean | undefined | null, variableName: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "value": { - "name": "value", - "description": [ - { - "kind": "text", - "text": "the value to check" - } - ], - "isOptional": false, - "isSpread": false, - "type": "boolean | undefined | null" - }, - "variableName": { - "name": "variableName", - "description": [ - { - "kind": "text", - "text": "the program variable name, which will be mentioned in the error message" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "ITimeProvider" + }, { - "kind": "text", - "text": "Throws an exception if the specified value is not true." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Version": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a version number with two, three, or four parts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This class represents versions that follow the string format of " - }, - { - "kind": "code", - "text": "MAJOR.MINOR[.PATCH[.REVISION]]", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Examples: " - }, - { - "kind": "code", - "text": "1.0", - "highlighter": "plain" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "1.0.0", - "highlighter": "plain" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "1.0.0.0", - "highlighter": "plain" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "1.01", - "highlighter": "plain" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "01.02.03", - "highlighter": "plain" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "001.002.003.004", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "compare": { - "kind": "method", - "signature": "static compare(v1: Version, v2: Version): number;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "number", - "description": [ - { - "kind": "text", - "text": "-1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if the first input is greater than the second input." - } - ] - }, - "parameters": { - "v1": { - "name": "v1", - "description": [ + "releaseTag": "Public", + "name": "TimeProvider", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `TimeProvider` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, { - "kind": "text", - "text": "The first version class for comparison" + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" } ], - "isOptional": false, - "isSpread": false, - "type": "Version" + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, - "v2": { - "name": "v2", - "description": [ + { + "kind": "Method", + "canonicalReference": "(getDate:instance,0)", + "docComment": "/**\n * Returns the current date/time, similar to the Date class constructor.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getDate" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "The second version class for comparison" + "kind": "Reference", + "text": "Date" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getDate" + }, { - "kind": "text", - "text": "Compares two Version objects to determine which version is newer." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "equals": { - "kind": "method", - "signature": "equals(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is equal to the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ + "kind": "Method", + "canonicalReference": "(getTimestamp:instance,0)", + "docComment": "/**\n * Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The version to compare with" + "kind": "Reference", + "text": "getTimestamp" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Tests whether this version is equal to the input parameter." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Examples:" + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getTimestamp" }, { - "kind": "code-box", - "text": "1.0.0 equals 1.0.0 -> true;\n2.0.1 equals 2.0.0 -> false;\n3.0 equals 3.0.0 -> true;\n04.01 equals 4.1 -> true\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "greaterThan": { - "kind": "method", - "signature": "greaterThan(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is greater than the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for ITimeProvider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ITimeProvider" + }, + { + "kind": "Content", + "text": ">" + }, { - "kind": "text", - "text": "The version to compare with" + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "Version" + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } - }, - "deprecatedMessage": [], - "summary": [ + ], + "implementsTokenRanges": [ { - "kind": "text", - "text": "Tests whether this version is greater than (i.e. newer than) the input parameter." + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [ + ] + }, + { + "kind": "Class", + "canonicalReference": "(UrlQueryParameterCollection:class)", + "docComment": "/**\n * Provides features for storing and retrieving URL query parameters.\n *\n * @remarks\n *\n * The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with \"?\" to indicate the first query parameter and use \"&\" for all subsequent parameters. The class also supports fragments.\n *\n * Edge case behavior:\n *\n * Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value\n *\n * @deprecated\n *\n * Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "Examples:" + "kind": "Reference", + "text": "UrlQueryParameterCollection" }, { - "kind": "code-box", - "text": "1.0.0 greaterThan 0.0.9 -> true;\n2.0 greaterThan 2.0.0 -> false;\n3.0.1 greaterThan 3.0 -> true\n", - "highlighter": "plain" + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isValid": { - "kind": "method", - "signature": "static isValid(versionString: string | undefined | null): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "true if the versionString is a valid version specifier" - } - ] - }, - "parameters": { - "versionString": { - "name": "versionString", - "description": [ + "releaseTag": "Public", + "name": "UrlQueryParameterCollection", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `UrlQueryParameterCollection` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "url" + }, { - "kind": "text", - "text": "The version string" + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" } ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Test whether a string is a valid version specifier." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "lessThan": { - "kind": "method", - "signature": "lessThan(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is less than the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "(getValue:instance,0)", + "docComment": "/**\n * Returns the value of the first matching query parameter or undefined if the key doesn't exist.\n *\n * @remarks\n *\n * Examples:\n * ```\n * this._queryParameterList = [\n * {key: TEST, value: done},\n * {key: DEBUG, value: false},\n * {key: TEST, value: notdone}]\n * getValue('TEST') ---> 'done'\n * getValue('debug') ---> 'false'\n * getValue('lost') ---> undefined\n * ```\n *\n * @param param - the case insensitive key for the desired query parameter value.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getValue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "param" + }, { - "kind": "text", - "text": "The version to compare with" + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "param", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "getValue" + }, { - "kind": "text", - "text": "Tests whether this version is less than (i.e. older than) the input parameter." + "kind": "Method", + "canonicalReference": "(getValues:instance,0)", + "docComment": "/**\n * Returns the values of all of the matching query parameters or undefined if the key doesn't exist.\n *\n * @remarks\n *\n * Examples:\n * ```\n * this._queryParameterList = [\n * {key: TEST, value: done},\n * {key: DEBUG, value: false},\n * {key: TEST, value: notdone}]\n * getValues('TEST') ---> ['done', 'notdone']\n * getValues('debug') ---> ['false']\n * getValues('lost') ---> undefined\n * ```\n *\n * @param param - the case insensitive key for the desired query parameter value.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getValues" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "param" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "(string | undefined)[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "param", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "getValues" } ], - "remarks": [ + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(Validate:class)", + "docComment": "/**\n * Performs common validation tests for properties and function parameters.\n *\n * @remarks\n *\n * This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Examples:" + "kind": "Content", + "text": "export default class " }, { - "kind": "code-box", - "text": "0.9.9 lessThan 1.0.0 -> true;\n2.0 lessThan 2.0.0 -> false;\n3.0 lessThan 3.0.1 -> true;\n04.01 lessThan 4.1 -> false\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "major": { - "kind": "property", - "signature": "readonly major: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the first component of the version string." - } - ], - "remarks": [ + "kind": "Reference", + "text": "Validate" + }, { - "kind": "text", - "text": "Typically a change in the major version number indicates a compatibility break with previous versions." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "minor": { - "kind": "property", - "signature": "readonly minor: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the second component of the version string." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "Validate", + "members": [ + { + "kind": "Method", + "canonicalReference": "(isNonemptyString:static,0)", + "docComment": "/**\n * Throws an exception if the specified string is null, undefined, or an empty string.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "isNonemptyString" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "variableName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "variableName", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "isNonemptyString" + }, { - "kind": "text", - "text": "Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "parse": { - "kind": "method", - "signature": "static parse(versionString: string | undefined | null): Version;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Version", - "description": [ - { - "kind": "text", - "text": "a new Version object" - } - ] - }, - "parameters": { - "versionString": { - "name": "versionString", - "description": [ + "kind": "Method", + "canonicalReference": "(isNotDisposed:static,0)", + "docComment": "/**\n * Throws an exception if the specified object has been disposed.\n *\n * @param value - the value to check\n *\n * @param className - the class name, which will be mentioned in the error message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "isNotDisposed" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IDisposable" + }, { - "kind": "text", - "text": "A version string" + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "className" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "className", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "isNotDisposed" + }, { - "kind": "text", - "text": "Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "patch": { - "kind": "property", - "signature": "readonly patch: number | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The third number in the version string, or undefined if unspecified." - } - ], - "remarks": [ + "kind": "Method", + "canonicalReference": "(isNotNullOrUndefined:static,0)", + "docComment": "/**\n * Throws an exception if the specified value is null or undefined.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "isNotNullOrUndefined" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "variableName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "variableName", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "isNotNullOrUndefined" + }, { - "kind": "text", - "text": "Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the \"build\" number." + "kind": "Method", + "canonicalReference": "(isTrue:static,0)", + "docComment": "/**\n * Throws an exception if the specified value is not true.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "isTrue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean | undefined | null" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "variableName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "variableName", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "isTrue" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "revision": { - "kind": "property", - "signature": "readonly revision: number | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The fourth number in the version string, or undefined if unspecified." - } - ], - "remarks": [ + { + "kind": "Class", + "canonicalReference": "(Version:class)", + "docComment": "/**\n * Represents a version number with two, three, or four parts.\n *\n * @remarks\n *\n * This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons.\n *\n * Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004`\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "Version" + }, { - "kind": "text", - "text": "This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "satisfies": { - "kind": "method", - "signature": "satisfies(compareWith: Version): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "A boolean indicating if this version is compatible with the input parameter" - } - ] - }, - "parameters": { - "compareWith": { - "name": "compareWith", - "description": [ + "releaseTag": "Public", + "name": "Version", + "members": [ + { + "kind": "Method", + "canonicalReference": "(compare:static,0)", + "docComment": "/**\n * Compares two Version objects to determine which version is newer.\n *\n * @param v1 - The first version class for comparison\n *\n * @param v2 - The second version class for comparison\n *\n * @returns -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if the first input is greater than the second input.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "compare" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "v1" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "v2" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "The version to compare with" + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "v1", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "v2", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "compare" + }, { - "kind": "text", - "text": "Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible." - } - ], - "remarks": [ + "kind": "Method", + "canonicalReference": "(equals:instance,0)", + "docComment": "/**\n * Tests whether this version is equal to the input parameter.\n *\n * @remarks\n *\n * Examples:\n * ```\n * 1.0.0 equals 1.0.0 -> true;\n * 2.0.1 equals 2.0.0 -> false;\n * 3.0 equals 3.0.0 -> true;\n * 04.01 equals 4.1 -> true\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is equal to the input parameter\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "equals" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "compareWith" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "equals" + }, + { + "kind": "Method", + "canonicalReference": "(greaterThan:instance,0)", + "docComment": "/**\n * Tests whether this version is greater than (i.e. newer than) the input parameter.\n *\n * @remarks\n *\n * Examples:\n * ```\n * 1.0.0 greaterThan 0.0.9 -> true;\n * 2.0 greaterThan 2.0.0 -> false;\n * 3.0.1 greaterThan 3.0 -> true\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is greater than the input parameter\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "greaterThan" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "compareWith" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "greaterThan" + }, { - "kind": "text", - "text": "In order to satisfy the compatibility requirements, this object must have the same major version number as the input parameter, and it must NOT be older than the input parameter." + "kind": "Method", + "canonicalReference": "(isValid:static,0)", + "docComment": "/**\n * Test whether a string is a valid version specifier.\n *\n * @param versionString - The version string\n *\n * @returns true if the versionString is a valid version specifier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "isValid" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "versionString" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "versionString", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "isValid" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(lessThan:instance,0)", + "docComment": "/**\n * Tests whether this version is less than (i.e. older than) the input parameter.\n *\n * @remarks\n *\n * Examples:\n * ```\n * 0.9.9 lessThan 1.0.0 -> true;\n * 2.0 lessThan 2.0.0 -> false;\n * 3.0 lessThan 3.0.1 -> true;\n * 04.01 lessThan 4.1 -> false\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is less than the input parameter\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "lessThan" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "compareWith" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "lessThan" }, { - "kind": "text", - "text": "Examples:" + "kind": "Property", + "canonicalReference": "(major:instance)", + "docComment": "/**\n * Returns the first component of the version string.\n *\n * @remarks\n *\n * Typically a change in the major version number indicates a compatibility break with previous versions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "major" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "major", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code-box", - "text": "1.0.0 satisfies 1.0.0 -> true;\n1.1.0 satisfies 1.0.0 -> true;\n2.0.0 satisfies 1.0.0 -> false;\n1.0.0 satisfies 1.1.0 -> false\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "toString": { - "kind": "method", - "signature": "toString(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a string representation of the version." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(minor:instance)", + "docComment": "/**\n * Returns the second component of the version string.\n *\n * @remarks\n *\n * Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "minor" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "minor", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryParse": { - "kind": "method", - "signature": "static tryParse(versionString: string | undefined | null): Version | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Version | undefined", - "description": [ - { - "kind": "text", - "text": "The Version object, or undefined if the string could not be parsed." - } - ] - }, - "parameters": { - "versionString": { - "name": "versionString", - "description": [ + "kind": "Method", + "canonicalReference": "(parse:static,0)", + "docComment": "/**\n * Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed.\n *\n * @param versionString - A version string\n *\n * @returns a new Version object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "parse" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "versionString" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "A version string" + "parameterName": "versionString", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string | undefined | null" + "name": "parse" + }, + { + "kind": "Property", + "canonicalReference": "(patch:instance)", + "docComment": "/**\n * The third number in the version string, or undefined if unspecified.\n *\n * @remarks\n *\n * Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the \"build\" number.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "patch" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "patch", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(revision:instance)", + "docComment": "/**\n * The fourth number in the version string, or undefined if unspecified.\n *\n * @remarks\n *\n * This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "revision" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "revision", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(satisfies:instance,0)", + "docComment": "/**\n * Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible.\n *\n * @remarks\n *\n * In order to satisfy the compatibility requirements, this object must have the same major version number as the input parameter, and it must NOT be older than the input parameter.\n *\n * Examples:\n * ```\n * 1.0.0 satisfies 1.0.0 -> true;\n * 1.1.0 satisfies 1.0.0 -> true;\n * 2.0.0 satisfies 1.0.0 -> false;\n * 1.0.0 satisfies 1.1.0 -> false\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is compatible with the input parameter\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "satisfies" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "compareWith" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "satisfies" + }, + { + "kind": "Method", + "canonicalReference": "(toString:instance,0)", + "docComment": "/**\n * Returns a string representation of the version.\n *\n * @remarks\n *\n * The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "toString" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "toString" + }, + { + "kind": "Method", + "canonicalReference": "(tryParse:static,0)", + "docComment": "/**\n * Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned.\n *\n * @param versionString - A version string\n *\n * @returns The Version object, or undefined if the string could not be parsed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "tryParse" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "versionString" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "versionString", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "tryParse" } - }, - "deprecatedMessage": [], - "summary": [ + ], + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "ServiceCreator", + "docComment": "/**\n * This is a callback that is used by ServiceKey.createCustom().\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type " + }, + { + "kind": "Reference", + "text": "ServiceCreator" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "T" + }, + { + "kind": "Content", + "text": "> = (" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "T" + }, { - "kind": "text", - "text": "Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned." + "kind": "Content", + "text": ";" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "releaseTag": "Public", + "name": "ServiceCreator" } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-diagnostics.api.json b/generate-docs/json/sp-diagnostics.api.json index b13df3c7..638f53e5 100644 --- a/generate-docs/json/sp-diagnostics.api.json +++ b/generate-docs/json/sp-diagnostics.api.json @@ -1,12 +1,57 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-diagnostics", + "docComment": "/**\n * This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user engagement and performance logging.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-diagnostics", - "summary": [ + "members": [ { - "kind": "text", - "text": "This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user engagement and performance logging." + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ + { + "kind": "Variable", + "canonicalReference": "_logSourceServiceKey", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "logSourceServiceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "LogSource" + }, + { + "kind": "Content", + "text": ">" + } + ], + "releaseTag": "Public", + "name": "_logSourceServiceKey", + "variableTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + } + } + ] } - ], - "remarks": [], - "exports": {} + ] } diff --git a/generate-docs/json/sp-dialog.api.json b/generate-docs/json/sp-dialog.api.json index 576b57c7..e97efa16 100644 --- a/generate-docs/json/sp-dialog.api.json +++ b/generate-docs/json/sp-dialog.api.json @@ -1,1090 +1,1140 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-dialog", + "docComment": "/**\n * SharePoint Framework support for displaying pop-up dialog boxes.\n *\n * @remarks\n *\n * This library provides simple stock dialogs such as {@link Dialog.alert} and {@link Dialog.prompt}, along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-dialog", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for displaying pop-up dialog boxes." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This library provides simple stock dialogs such as " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Dialog.alert" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "alert" - } - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "Dialog.prompt" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "prompt" - } - }, - { - "kind": "text", - "text": ", along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications." - } - ], - "exports": { - "BaseDialog": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to the user inside SharePoint Framework components." - } - ], - "remarks": [ + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "text", - "text": "Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(config?: IDialogConfiguration);", - "parameters": { - "config": { - "name": "config", - "description": [ - { - "kind": "text", - "text": "the dialog configuration that affects how the dialog is displayed *" - } - ], - "isOptional": true, - "isSpread": false, - "type": "IDialogConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(BaseDialog:class)", + "docComment": "/**\n * The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to the user inside SharePoint Framework components.\n *\n * @remarks\n *\n * Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructor for the " + "kind": "Content", + "text": "export default abstract class " }, { - "kind": "code", - "text": "BaseDialog", - "highlighter": "plain" + "kind": "Reference", + "text": "BaseDialog" }, { - "kind": "text", - "text": " class." + "kind": "Content", + "text": " " } ], - "remarks": [ - { - "kind": "text", - "text": "It is important to keep the constructor lightweight. Use " - }, + "releaseTag": "Public", + "name": "BaseDialog", + "members": [ { - "kind": "code", - "text": "onBeforeOpen()", - "highlighter": "plain" + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructor for the `BaseDialog` class.\n *\n * @remarks\n *\n * It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose.\n *\n * Example:\n * ```\n * constructor(cacheReference: any) {\n * super();\n *\n * this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache.\n * this._cache.refresh(); // This is bad practice.\n * // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen()\n * }\n * ```\n *\n * @param config - the dialog configuration that affects how the dialog is displayed *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "config" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IDialogConfiguration" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, { - "kind": "text", - "text": " for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric " + "kind": "Method", + "canonicalReference": "(close:instance,0)", + "docComment": "/**\n * Close the dialog.\n *\n * @remarks\n *\n * This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show.\n *\n * @returns A promise that resolves when the dialog is visually closed, or if it was already closed\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "close" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "close" }, { - "kind": "code", - "text": "onBeforeOpen()", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(domElement:instance)", + "docComment": "/**\n * Use this property to access the container element provided by the framework for rendering.\n *\n * @remarks\n *\n * See {@link BaseDialog.render} for more information on rendering.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLElement" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " and " + "kind": "Property", + "canonicalReference": "(isHidden:instance)", + "docComment": "/**\n * If the dialog is visually hidden.\n *\n * @remarks\n *\n * This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isHidden" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isHidden", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "onAfterClose()", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(isOpen:instance)", + "docComment": "/**\n * If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isOpen" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isOpen", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose." + "kind": "Property", + "canonicalReference": "(isSecondary:instance)", + "docComment": "/**\n * If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isSecondary" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isSecondary", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(onAfterClose:instance,0)", + "docComment": "/**\n * This method is called after the dialog is visually closed and gives an opportunity for doing clean up.\n *\n * @remarks\n *\n * The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onAfterClose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onAfterClose" }, { - "kind": "text", - "text": "Example:" + "kind": "Method", + "canonicalReference": "(onBeforeOpen:instance,0)", + "docComment": "/**\n * This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method.\n *\n * @remarks\n *\n * All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak.\n *\n * @returns A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and `onAfterClose()` will not be called.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onBeforeOpen" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onBeforeOpen" }, { - "kind": "code-box", - "text": " constructor(cacheReference: any) {\n super();\n\n this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache.\n this._cache.refresh(); // This is bad practice.\n // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen()\n }\n", - "highlighter": "plain" - } - ] - }, - "close": { - "kind": "method", - "signature": "close(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that resolves when the dialog is visually closed, or if it was already closed" - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Close the dialog." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "domElement": { - "kind": "property", - "signature": "protected readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use this property to access the container element provided by the framework for rendering." - } - ], - "remarks": [ - { - "kind": "text", - "text": "See " + "kind": "Method", + "canonicalReference": "(render:instance,0)", + "docComment": "/**\n * Renders the contents of the dialog.\n *\n * @remarks\n *\n * The `render` method must be implemented to render the content of the dialog in the container element provided by the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay.\n *\n * The render method is called once after the modal element is created and opened. It is recommended to use `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected abstract " + }, + { + "kind": "Reference", + "text": "render" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "render" }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(secondaryDialogProvider:instance)", + "docComment": "/**\n * An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs are permitted.\n *\n * @remarks\n *\n * Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "secondaryDialogProvider" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISecondaryDialogProvider" + }, + { + "kind": "Content", + "text": " | undefined" + }, { - "kind": "text", - "text": "BaseDialog.render" + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "BaseDialog", - "memberName": "render" - } + "releaseTag": "Public", + "name": "secondaryDialogProvider", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false }, { - "kind": "text", - "text": " for more information on rendering." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isHidden": { - "kind": "property", - "signature": "readonly isHidden: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If the dialog is visually hidden." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed." + "kind": "Method", + "canonicalReference": "(show:instance,0)", + "docComment": "/**\n * Request the framework to show this dialog.\n *\n * @param options - Dialog showing options. See {@link IDialogShowOptions} for more information.\n *\n * @returns A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or aborted.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "show" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "show" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "isOpen": { - "kind": "property", - "signature": "readonly isOpen: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(Dialog:class)", + "docComment": "/**\n * A static class for showing stock dialogs such as an alert or prompt.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isSecondary": { - "kind": "property", - "signature": "readonly isSecondary: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onAfterClose": { - "kind": "method", - "signature": "protected onAfterClose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "Dialog" + }, { - "kind": "text", - "text": "This method is called after the dialog is visually closed and gives an opportunity for doing clean up." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "Dialog", + "members": [ { - "kind": "text", - "text": "The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onBeforeOpen": { - "kind": "method", - "signature": "protected onBeforeOpen(): Promise;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and " - }, - { - "kind": "code", - "text": "onAfterClose()", - "highlighter": "plain" + "kind": "Method", + "canonicalReference": "(alert:static,0)", + "docComment": "/**\n * Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog.\n *\n * @remarks\n *\n * There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason.\n *\n * @param message - The message to alert\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "alert" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IAlertOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 13 }, - { - "kind": "text", - "text": " will not be called." - } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method." - } - ], - "remarks": [ - { - "kind": "text", - "text": "All resource allocations in onBeforeOpen() should be properly disposed in " - }, - { - "kind": "code", - "text": "onAfterClose()", - "highlighter": "plain" + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "alert" }, { - "kind": "text", - "text": " to a avoid memory leak." + "kind": "Method", + "canonicalReference": "(prompt:static,0)", + "docComment": "/**\n * Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog.\n *\n * @remarks\n *\n * There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason.\n *\n * @param message - The message for prompt dialog\n *\n * @param defaultValue - The default value for the input text field\n *\n * @returns The input string or undefined if the dialog was canceled\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "prompt" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IPromptOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "prompt" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "implementsTokenRanges": [] }, - "render": { - "kind": "method", - "signature": "protected abstract render(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Renders the contents of the dialog." - } - ], - "remarks": [ + { + "kind": "Interface", + "canonicalReference": "(IAlertOptions:interface)", + "docComment": "/**\n * Options for showing an alert dialog\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The " + "kind": "Content", + "text": "export interface " }, { - "kind": "code", - "text": "render", - "highlighter": "plain" + "kind": "Reference", + "text": "IAlertOptions" }, { - "kind": "text", - "text": " method must be implemented to render the content of the dialog in the container element provided by the framework. Use " + "kind": "Content", + "text": " extends " }, { - "kind": "code", - "text": "this.domElement", - "highlighter": "plain" + "kind": "Reference", + "text": "IDialogShowOptions" }, { - "kind": "text", - "text": " to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay." - }, + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAlertOptions", + "members": [], + "extendsTokenRanges": [ { - "kind": "paragraph" - }, + "startIndex": 3, + "endIndex": 5 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IDialogConfiguration:interface)", + "docComment": "/**\n * The interface for dialog configuration\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The render method is called once after the modal element is created and opened. It is recommended to use " + "kind": "Content", + "text": "export interface " }, { - "kind": "code", - "text": "onBeforeOpen()", - "highlighter": "plain" + "kind": "Reference", + "text": "IDialogConfiguration" }, { - "kind": "text", - "text": " for doing non-UI operations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "secondaryDialogProvider": { - "kind": "property", - "signature": "readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ISecondaryDialogProvider | undefined", - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "IDialogConfiguration", + "members": [ { - "kind": "text", - "text": "An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs are permitted." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "show": { - "kind": "method", - "signature": "show(options?: IDialogShowOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or aborted." - } - ] - }, - "parameters": { - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. See " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" - } + "kind": "PropertySignature", + "canonicalReference": "isBlocking", + "docComment": "/**\n * Whether the dialog can be closed by clicking outside the dialog (on the overlay).\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isBlocking" }, { - "kind": "text", - "text": " for more information." + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "IDialogShowOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Request the framework to show this dialog." + "releaseTag": "Public", + "name": "isBlocking", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "Dialog": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + "extendsTokenRanges": [] + }, { - "kind": "text", - "text": "A static class for showing stock dialogs such as an alert or prompt." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "alert": { - "kind": "method", - "signature": "static alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "The message to alert" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" + "kind": "Interface", + "canonicalReference": "(IDialogShowOptions:interface)", + "docComment": "/**\n * Options for showing a dialog\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions" }, - "options": { - "name": "options", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IAlertOptions" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "IDialogShowOptions", + "members": [ { - "kind": "text", - "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." + "kind": "PropertySignature", + "canonicalReference": "confirmOpen", + "docComment": "/**\n * A callback that is invoked immediately before the dialog receives focus.\n *\n * @remarks\n *\n * Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the framework. For example, you can check if a long time has passed since the request was made or the the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "confirmOpen" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "() => boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "confirmOpen", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "extendsTokenRanges": [] }, - "prompt": { - "kind": "method", - "signature": "static prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "The input string or undefined if the dialog was canceled" - } - ] - }, - "parameters": { - "message": { - "name": "message", - "description": [ - { - "kind": "text", - "text": "The message for prompt dialog" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" + { + "kind": "Interface", + "canonicalReference": "(IPromptOptions:interface)", + "docComment": "/**\n * Options for showing a prompt dialog\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " }, - "options": { - "name": "options", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IPromptOptions" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPromptOptions" + }, { - "kind": "text", - "text": "There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IAlertOptions": { - "kind": "interface", - "extends": "IDialogShowOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing an alert dialog" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false - }, - "IDialogConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The interface for dialog configuration" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "isBlocking": { - "kind": "property", - "signature": "isBlocking?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": " extends " + }, { - "kind": "text", - "text": "Whether the dialog can be closed by clicking outside the dialog (on the overlay)." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDialogShowOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing a dialog" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "confirmOpen": { - "kind": "property", - "signature": "confirmOpen?: () => boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "() => boolean", - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "IDialogShowOptions" + }, { - "kind": "text", - "text": "A callback that is invoked immediately before the dialog receives focus." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "IPromptOptions", + "members": [ { - "kind": "text", - "text": "Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the framework. For example, you can check if a long time has passed since the request was made or the the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it." + "kind": "PropertySignature", + "canonicalReference": "defaultValue", + "docComment": "/**\n * The default value for the input text field of prompt dialog\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "defaultValue" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultValue", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPromptOptions": { - "kind": "interface", - "extends": "IDialogShowOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing a prompt dialog" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "defaultValue": { - "kind": "property", - "signature": "defaultValue?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + "extendsTokenRanges": [ { - "kind": "text", - "text": "The default value for the input text field of prompt dialog" + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISecondaryDialogProvider": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider inside a dialog." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more secondary dialogs are rejected." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "See " + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Interface", + "canonicalReference": "(ISecondaryDialogProvider:interface)", + "docComment": "/**\n * This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider inside a dialog.\n *\n * @remarks\n *\n * Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more secondary dialogs are rejected.\n *\n * See {@link BaseDialog.secondaryDialogProvider} for how to use this.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "BaseDialog.secondaryDialogProvider" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "BaseDialog", - "memberName": "secondaryDialogProvider" - } - }, - { - "kind": "text", - "text": " for how to use this." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "alert": { - "kind": "method", - "signature": "alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "message": { - "name": "message", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" + "kind": "Content", + "text": "export interface " }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. See " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" - } - }, - { - "kind": "text", - "text": " for more information." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IAlertOptions" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Similar to " + "kind": "Reference", + "text": "ISecondaryDialogProvider" }, { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISecondaryDialogProvider", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(alert:0)", + "docComment": "/**\n * Similar to {@link Dialog.alert}. The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects.\n *\n * @param options - Dialog showing options. See {@link IDialogShowOptions} for more information.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "alert" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, { - "kind": "text", - "text": "Dialog.alert" + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IAlertOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "alert" - } - }, - { - "kind": "text", - "text": ". The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "prompt": { - "kind": "method", - "signature": "prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "message": { - "name": "message", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. The confirmOpen option will be ignored. See " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 } }, { - "kind": "text", - "text": " for more information." + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } } ], - "isOptional": true, - "isSpread": false, - "type": "IPromptOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Similar to " + "name": "alert" }, { - "kind": "api-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(prompt:0)", + "docComment": "/**\n * Similar to {@link Dialog.prompt}. The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects.\n *\n * @param options - Dialog showing options. The confirmOpen option will be ignored. See {@link IDialogShowOptions} for more information.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "prompt" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IPromptOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, { - "kind": "text", - "text": "Dialog.prompt" + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "Dialog", - "memberName": "prompt" - } - }, - { - "kind": "text", - "text": ". The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "show": { - "kind": "method", - "signature": "show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "dialog": { - "name": "dialog", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "BaseDialog" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Dialog showing options. The confirmOpen option will be ignored. See " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IDialogShowOptions" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "IDialogShowOptions", - "memberName": "" + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 } }, { - "kind": "text", - "text": " for more information." + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } } ], - "isOptional": true, - "isSpread": false, - "type": "IDialogShowOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Similar to " + "name": "prompt" }, { - "kind": "api-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(show:0)", + "docComment": "/**\n * Similar to {@link BaseDialog.show}. The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects.\n *\n * @param options - Dialog showing options. The confirmOpen option will be ignored. See {@link IDialogShowOptions} for more information.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "show" + }, + { + "kind": "Content", + "text": "(" + }, { - "kind": "text", - "text": "BaseDialog.show" + "kind": "Reference", + "text": "dialog" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "BaseDialog" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dialog", - "exportName": "BaseDialog", - "memberName": "show" - } - }, - { - "kind": "text", - "text": ". The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects." + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "dialog", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "show" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "extendsTokenRanges": [] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-dynamic-data.api.json b/generate-docs/json/sp-dynamic-data.api.json index e0652a31..e1afe9b0 100644 --- a/generate-docs/json/sp-dynamic-data.api.json +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -1,1110 +1,1497 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-dynamic-data", + "docComment": "/**\n * SharePoint Framework support for dynamic data bindings.\n *\n * @remarks\n *\n * This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and implement components that use it.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-dynamic-data", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for dynamic data bindings." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and implement components that use it." - } - ], - "exports": { - "DynamicDataReference": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The reference string is of the form " - }, - { - "kind": "code", - "text": ":", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "::", - "highlighter": "plain" - }, - { - "kind": "paragraph" - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "text", - "text": "Examples of references are: " - }, - { - "kind": "code", - "text": "WebPart..:myComplexProperty:myArray[0].lastName", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(reference: string);", - "parameters": { - "reference": { - "name": "reference", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" + "kind": "Class", + "canonicalReference": "(DynamicDataReference:class)", + "docComment": "/**\n * Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data\n *\n * @remarks\n *\n * The reference string is of the form `:` or `::`\n *\n * Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName`\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "DynamicDataReference" + }, + { + "kind": "Content", + "text": " " } - }, - "deprecatedMessage": [], - "summary": [ + ], + "releaseTag": "Public", + "name": "DynamicDataReference", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `DynamicDataReference` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "reference" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "reference", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(property:instance)", + "docComment": "/**\n * Returns the referred property of the Dynamic Data.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "property" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "DynamicDataReference" + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-dynamic-data", - "exportName": "DynamicDataReference", - "memberName": "" - } + "releaseTag": "Public", + "name": "property", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "property": { - "kind": "property", - "signature": "readonly property: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the referred property of the Dynamic Data." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "propertyPath": { - "kind": "property", - "signature": "readonly propertyPath: string | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "reference": { - "kind": "property", - "signature": "readonly reference: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the full reference of the Dynamic Data object as a string." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "sourceId": { - "kind": "property", - "signature": "readonly sourceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the referred id of the Dynamic Data Source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataAnnotatedPropertyValue": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "metadata": { - "kind": "property", - "signature": "metadata?: IDynamicDataPropertyValueMetadataCollection;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IDynamicDataPropertyValueMetadataCollection", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Metadata describing the sample value of the property." + "kind": "Property", + "canonicalReference": "(propertyPath:instance)", + "docComment": "/**\n * Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "propertyPath" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyPath", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(reference:instance)", + "docComment": "/**\n * Returns the full reference of the Dynamic Data object as a string.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "reference" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "reference", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(sourceId:instance)", + "docComment": "/**\n * Returns the referred id of the Dynamic Data Source.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "sourceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourceId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "sampleValue": { - "kind": "property", - "signature": "sampleValue: any;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Sample value of a property" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataCallables": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "allowedEvents": { - "kind": "method", - "signature": "allowedEvents?(): ReadonlyArray;", - "accessModifier": "", - "isOptional": true, - "isStatic": false, - "returnValue": { - "type": "ReadonlyArray", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns list of allowed events on the dynamic data source." - }, + "kind": "Interface", + "canonicalReference": "(IDynamicDataAnnotatedPropertyValue:interface)", + "docComment": "/**\n * Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export interface " }, { - "kind": "text", - "text": "When this function returns a non-empty result, then source must define 'sendEvent' api." + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue" }, { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "If this api is not defined or returns an empty array, then no consumer will be able to talk to this source." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getAnnotatedPropertyValue": { - "kind": "method", - "signature": "getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;", - "accessModifier": "", - "isOptional": true, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataAnnotatedPropertyValue | undefined", - "description": [] - }, - "parameters": { - "propertyId": { - "name": "propertyId", - "description": [ - { - "kind": "text", - "text": "One of the property ids exposed from the dynamic data source." + "releaseTag": "Public", + "name": "IDynamicDataAnnotatedPropertyValue", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "metadata", + "docComment": "/**\n * Metadata describing the sample value of the property.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "metadata" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadataCollection" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getPropertyDefinitions": { - "kind": "method", - "signature": "getPropertyDefinitions(): ReadonlyArray;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ReadonlyArray", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns all the property definitions that the DataSource will provide." + "kind": "PropertySignature", + "canonicalReference": "sampleValue", + "docComment": "/**\n * Sample value of a property\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "sampleValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sampleValue", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "extendsTokenRanges": [] }, - "getPropertyValue": { - "kind": "method", - "signature": "getPropertyValue(propertyId: string): any;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "any", - "description": [] - }, - "parameters": { - "propertyId": { - "name": "propertyId", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataCallables:interface)", + "docComment": "/**\n * Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Given a property id, returns the value of the property." - } - ], - "remarks": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "It is assumed that when this function returns an array, it is homogeneous." + "kind": "Reference", + "text": "IDynamicDataCallables" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "sendEvent": { - "kind": "method", - "signature": "sendEvent?(eventName: string, data: any): void;", - "accessModifier": "", - "isOptional": true, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "eventName": { - "name": "eventName", - "description": [ - { - "kind": "text", - "text": "A case-sensitive string representing the name of the event." + "releaseTag": "Public", + "name": "IDynamicDataCallables", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(allowedEvents:0)", + "docComment": "/**\n * Returns list of allowed events on the dynamic data source.\n *\n * When this function returns a non-empty result, then source must define 'sendEvent' api.\n *\n * If this api is not defined or returns an empty array, then no consumer will be able to talk to this source.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "allowedEvents" + }, + { + "kind": "Content", + "text": "?(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataEventDefinition" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [], + "name": "allowedEvents" }, - "data": { - "name": "data", - "description": [ + { + "kind": "MethodSignature", + "canonicalReference": "(getAnnotatedPropertyValue:0)", + "docComment": "/**\n * Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined.\n *\n * @param propertyId - One of the property ids exposed from the dynamic data source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getAnnotatedPropertyValue" + }, + { + "kind": "Content", + "text": "?(" + }, + { + "kind": "Reference", + "text": "propertyId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, { - "kind": "text", - "text": "Data to be sent to the dynamic data source." + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "any" - } - }, - "deprecatedMessage": [], - "summary": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "getAnnotatedPropertyValue" + }, { - "kind": "text", - "text": "If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly." + "kind": "MethodSignature", + "canonicalReference": "(getPropertyDefinitions:0)", + "docComment": "/**\n * Returns all the property definitions that the DataSource will provide.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getPropertyDefinitions" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyDefinition" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getPropertyDefinitions" }, { - "kind": "paragraph" + "kind": "MethodSignature", + "canonicalReference": "(getPropertyValue:0)", + "docComment": "/**\n * Given a property id, returns the value of the property.\n *\n * @remarks\n *\n * It is assumed that when this function returns an array, it is homogeneous.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getPropertyValue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "propertyId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "getPropertyValue" }, { - "kind": "text", - "text": "Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source." + "kind": "MethodSignature", + "canonicalReference": "(sendEvent:0)", + "docComment": "/**\n * If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly.\n *\n * Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source.\n *\n * @param eventName - A case-sensitive string representing the name of the event.\n *\n * @param data - Data to be sent to the dynamic data source.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "sendEvent" + }, + { + "kind": "Content", + "text": "?(" + }, + { + "kind": "Reference", + "text": "eventName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "data" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "eventName", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "sendEvent" } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDynamicDataEventDefinition": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Definition of an event which a dynamic data source accepts." - }, - { - "kind": "paragraph" + "extendsTokenRanges": [] }, { - "kind": "text", - "text": "It includes the name of the event and description to be seen and used by end users." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized description of the event." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "name": { - "kind": "property", - "signature": "name: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event name" + "kind": "Interface", + "canonicalReference": "(IDynamicDataEventDefinition:interface)", + "docComment": "/**\n * Definition of an event which a dynamic data source accepts.\n *\n * It includes the name of the event and description to be seen and used by end users.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataEventDefinition" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataPropertyDefinition": { - "kind": "interface", - "extends": "IDynamicDataPropertyMetadata", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "id": { - "kind": "property", - "signature": "id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the property. This can only contains letters, numbers, dashes and underscores. Example: \"myFiles\" or \"time_in_24-hour_clock\"" + "releaseTag": "Beta", + "name": "IDynamicDataEventDefinition", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "description", + "docComment": "/**\n * User-friendly, localized description of the event.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "name", + "docComment": "/**\n * Event name\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "name" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataPropertyMetadata": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + "extendsTokenRanges": [] + }, { - "kind": "text", - "text": "Metadata of a property" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized description of the property. Example: \"Contains a list of ids with the files of the current user\"" + "kind": "Interface", + "canonicalReference": "(IDynamicDataPropertyDefinition:interface)", + "docComment": "/**\n * Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyDefinition" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyMetadata" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "title": { - "kind": "property", - "signature": "title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized title of the property. Example: \"My files\" / \"Mis archivos\" (depending of current language)" + "releaseTag": "Public", + "name": "IDynamicDataPropertyDefinition", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "id", + "docComment": "/**\n * Id of the property. This can only contains letters, numbers, dashes and underscores. Example: \"myFiles\" or \"time_in_24-hour_clock\"\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataPropertyValueMetadata": { - "kind": "interface", - "extends": "IDynamicDataPropertyMetadata", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Metadata describing the sample value of the property." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "metadata": { - "kind": "property", - "signature": "metadata?: IDynamicDataPropertyValueMetadataCollection;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IDynamicDataPropertyValueMetadataCollection", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Metadata describing the sample value of the property." + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataPropertyValueMetadataCollection": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Important note:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "1. Key in the metadata should match the key in the sample value object." - }, - { - "kind": "paragraph" + ] }, { - "kind": "text", - "text": "2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example for more details." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For example:" - }, - { - "kind": "code-box", - "text": "case 1: With simple values\n Sample Property Id value - {\n firstName: 'Bob',\n lastName: 'Smith',\n age: 30\n }\n\n MetadataCollection for the above object would be -\n metadataCollection: {\n 'firstName': { title: 'First Name' },\n 'lastName': { title: 'Last Name' },\n 'age': { title: 'Age' }\n }\n\nCase 2: With complex values\n Sample Property Id value - {\n person: {\n firstName: 'Bob',\n lastName: 'Smith',\n age: 30\n },\n visitedLocations: [\n {\n city: 'Redmond',\n state: 'WA'\n },\n {\n city: 'New York City',\n state: 'NY'\n }\n ]\n }\n\n MetadataCollection for the above object would be -\n metadataCollection: {\n 'person': {\n title: 'Person',\n metadataCollection: {\n 'firstName': { title: 'First Name' },\n 'lastName': { title: 'Last Name' },\n 'age': { title: 'Age' }\n }\n },\n 'vistedLocations': {\n title: 'Visted Locations',\n metadataCollection: {\n 'city': { title: 'City' },\n 'state': { title: 'State' }\n }\n }\n }\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__index": { - "kind": "method", - "signature": "[key: string]: IDynamicDataPropertyValueMetadata;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataPropertyValueMetadata", - "description": [] - }, - "parameters": { - "key": { - "name": "key", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" + "kind": "Interface", + "canonicalReference": "(IDynamicDataPropertyMetadata:interface)", + "docComment": "/**\n * Metadata of a property\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyMetadata" + }, + { + "kind": "Content", + "text": " " } - }, - "deprecatedMessage": [], - "summary": [ + ], + "releaseTag": "Public", + "name": "IDynamicDataPropertyMetadata", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "description", + "docComment": "/**\n * User-friendly, localized description of the property. Example: \"Contains a list of ids with the files of the current user\"\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value." + "kind": "PropertySignature", + "canonicalReference": "title", + "docComment": "/**\n * User-friendly, localized title of the property. Example: \"My files\" / \"Mis archivos\" (depending of current language)\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDynamicDataSource": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + "extendsTokenRanges": [] + }, { - "kind": "text", - "text": "Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "allowedEvents": { - "kind": "method", - "signature": "allowedEvents?(): ReadonlyArray;", - "accessModifier": "", - "isOptional": true, - "isStatic": false, - "returnValue": { - "type": "ReadonlyArray", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source must define 'sendData' api." + "kind": "Interface", + "canonicalReference": "(IDynamicDataPropertyValueMetadata:interface)", + "docComment": "/**\n * Metadata describing the sample value of the property.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadata" + }, + { + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IDynamicDataPropertyMetadata" }, { - "kind": "text", - "text": "If this api is not defined or returns an empty map, then no consumer will be able to talk to this source." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getAnnotatedPropertyValue": { - "kind": "method", - "signature": "getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IDynamicDataAnnotatedPropertyValue", - "description": [] - }, - "parameters": { - "propertyId": { - "name": "propertyId", - "description": [ - { - "kind": "text", - "text": "One of the property ids exposed from the dynamic data source." + "releaseTag": "Public", + "name": "IDynamicDataPropertyValueMetadata", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "metadata", + "docComment": "/**\n * Metadata describing the sample value of the property.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "metadata" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadataCollection" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined." + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getPropertyDefinitions": { - "kind": "method", - "signature": "getPropertyDefinitions(): ReadonlyArray;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ReadonlyArray", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component." + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] }, - "getPropertyValue": { - "kind": "method", - "signature": "getPropertyValue(propertyId: string): any;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "any", - "description": [] - }, - "parameters": { - "propertyId": { - "name": "propertyId", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataPropertyValueMetadataCollection:interface)", + "docComment": "/**\n * A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value.\n *\n * @remarks\n *\n * Important note:\n *\n * 1. Key in the metadata should match the key in the sample value object.\n *\n * 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example for more details.\n *\n * For example:\n * ```\n * case 1: With simple values\n * Sample Property Id value - {\n * firstName: 'Bob',\n * lastName: 'Smith',\n * age: 30\n * }\n *\n * MetadataCollection for the above object would be -\n * metadataCollection: {\n * 'firstName': { title: 'First Name' },\n * 'lastName': { title: 'Last Name' },\n * 'age': { title: 'Age' }\n * }\n *\n * Case 2: With complex values\n * Sample Property Id value - {\n * person: {\n * firstName: 'Bob',\n * lastName: 'Smith',\n * age: 30\n * },\n * visitedLocations: [\n * {\n * city: 'Redmond',\n * state: 'WA'\n * },\n * {\n * city: 'New York City',\n * state: 'NY'\n * }\n * ]\n * }\n *\n * MetadataCollection for the above object would be -\n * metadataCollection: {\n * 'person': {\n * title: 'Person',\n * metadataCollection: {\n * 'firstName': { title: 'First Name' },\n * 'lastName': { title: 'Last Name' },\n * 'age': { title: 'Age' }\n * }\n * },\n * 'vistedLocations': {\n * title: 'Visted Locations',\n * metadataCollection: {\n * 'city': { title: 'City' },\n * 'state': { title: 'State' }\n * }\n * }\n * }\n * ```\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component." + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadataCollection" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "id": { - "kind": "property", - "signature": "id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the Dynamic Data Source." + "releaseTag": "Public", + "name": "IDynamicDataPropertyValueMetadataCollection", + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "(:index,0)", + "docComment": "/**\n * Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "[" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadata" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "metadata": { - "kind": "property", - "signature": "metadata: IDynamicDataSourceMetadata;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IDynamicDataSourceMetadata", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Metadata of the Dynamic Data Source." + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataSource:interface)", + "docComment": "/**\n * Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataSource" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "sendEvent": { - "kind": "method", - "signature": "sendEvent?(eventName: string, data: any): void;", - "accessModifier": "", - "isOptional": true, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "eventName": { - "name": "eventName", - "description": [ - { - "kind": "text", - "text": "A case-sensitive string representing the name of the event." + "releaseTag": "Public", + "name": "IDynamicDataSource", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(allowedEvents:0)", + "docComment": "/**\n * Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source must define 'sendData' api.\n *\n * If this api is not defined or returns an empty map, then no consumer will be able to talk to this source.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "allowedEvents" + }, + { + "kind": "Content", + "text": "?(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataEventDefinition" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [], + "name": "allowedEvents" }, - "data": { - "name": "data", - "description": [ + { + "kind": "MethodSignature", + "canonicalReference": "(getAnnotatedPropertyValue:0)", + "docComment": "/**\n * Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined.\n *\n * @param propertyId - One of the property ids exposed from the dynamic data source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getAnnotatedPropertyValue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "propertyId" + }, { - "kind": "text", - "text": "Data to be sent to the dynamic data source." + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "any" - } - }, - "deprecatedMessage": [], - "summary": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "getAnnotatedPropertyValue" + }, { - "kind": "text", - "text": "If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly." + "kind": "MethodSignature", + "canonicalReference": "(getPropertyDefinitions:0)", + "docComment": "/**\n * Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getPropertyDefinitions" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyDefinition" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getPropertyDefinitions" }, { - "kind": "paragraph" + "kind": "MethodSignature", + "canonicalReference": "(getPropertyValue:0)", + "docComment": "/**\n * Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getPropertyValue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "propertyId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "getPropertyValue" }, { - "kind": "text", - "text": "Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDynamicDataSourceMetadata": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "alias": { - "kind": "property", - "signature": "alias?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "componentId": { - "kind": "property", - "signature": "componentId?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized description of the Dynamic Data Source." + "kind": "MethodSignature", + "canonicalReference": "(sendEvent:0)", + "docComment": "/**\n * If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly.\n *\n * Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source.\n *\n * @param eventName - A case-sensitive string representing the name of the event.\n *\n * @param data - Data to be sent to the dynamic data source.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "sendEvent" + }, + { + "kind": "Content", + "text": "?(" + }, + { + "kind": "Reference", + "text": "eventName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "data" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "eventName", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "sendEvent" + }, + { + "kind": "PropertySignature", + "canonicalReference": "id", + "docComment": "/**\n * Id of the Dynamic Data Source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "metadata", + "docComment": "/**\n * Metadata of the Dynamic Data Source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "metadata" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IDynamicDataSourceMetadata" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "instanceId": { - "kind": "property", - "signature": "instanceId?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources." + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataSourceMetadata:interface)", + "docComment": "/**\n * Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataSourceMetadata" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "title": { - "kind": "property", - "signature": "title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component." + "releaseTag": "Public", + "name": "IDynamicDataSourceMetadata", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "alias", + "docComment": "/**\n * Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "alias" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "alias", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "componentId", + "docComment": "/**\n * Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "componentId" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "description", + "docComment": "/**\n * User-friendly, localized description of the Dynamic Data Source.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "instanceId", + "docComment": "/**\n * Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "instanceId" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "title", + "docComment": "/**\n * User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-extension-base.api.json b/generate-docs/json/sp-extension-base.api.json index 91bbd13e..3c2c9b9b 100644 --- a/generate-docs/json/sp-extension-base.api.json +++ b/generate-docs/json/sp-extension-base.api.json @@ -1,142 +1,207 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-extension-base", + "docComment": "/**\n * SharePoint Framework support for building client-side extensions.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-extension-base", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for building client-side extensions." - } - ], - "remarks": [], - "exports": { - "BaseExtension": { - "kind": "class", - "extends": "BaseComponent", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for all client-side extensions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseExtension class." - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "protected readonly context: ExtensionContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ExtensionContext", - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(BaseExtension:class)", + "docComment": "/**\n * The base class for all client-side extensions.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseExtension` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default abstract class " + }, { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + "kind": "Reference", + "text": "BaseExtension" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": "> extends " + }, + { + "kind": "Reference", + "text": "BaseComponent" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onInit": { - "kind": "method", - "signature": "protected onInit(): Promise;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "BaseExtension", + "members": [ + { + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ExtensionContext" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "This event method is called when the client-side extension is first activated on the page." + "kind": "Method", + "canonicalReference": "(onInit:instance,0)", + "docComment": "/**\n * This event method is called when the client-side extension is first activated on the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onInit" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onInit" + }, + { + "kind": "Property", + "canonicalReference": "(properties:instance)", + "docComment": "/**\n * Extension properties is a JavaScript object that are passed in by the application that initializes the extension.\n *\n * @remarks\n *\n * Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "extendsTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "implementsTokenRanges": [] }, - "properties": { - "kind": "property", - "signature": "protected readonly properties: TProperties;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "TProperties", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(ExtensionContext:class)", + "docComment": "/**\n * The base class for context objects for client-side extensions.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtensionContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Extension properties is a JavaScript object that are passed in by the application that initializes the extension." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "ExtensionContext" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "BaseComponentContext" + }, { - "kind": "text", - "text": "Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ExtensionContext": { - "kind": "class", - "extends": "BaseComponentContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The base class for context objects for client-side extensions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ExtensionContext class." - }, - { - "kind": "paragraph" + "releaseTag": "Public", + "name": "ExtensionContext", + "members": [], + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] } - ], - "isBeta": false, - "isSealed": false, - "members": {} + ] } - } + ] } diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index 517c41bb..f93d1343 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -1,6435 +1,8859 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-http", + "docComment": "/**\n * Base communication layer for the SharePoint Framework\n *\n * @remarks\n *\n * This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that follow the recommended best practices.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-http", - "summary": [ + "members": [ { - "kind": "text", - "text": "Base communication layer for the SharePoint Framework" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that follow the recommended best practices." - } - ], - "exports": { - "AadHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "AadHttpClient is used to perform REST calls against an Azure AD Application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with SharePoint, use the " - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "api-link", - "elements": [ + "kind": "Class", + "canonicalReference": "(AadHttpClient:class)", + "docComment": "/**\n * AadHttpClient is used to perform REST calls against an Azure AD Application.\n *\n * @remarks\n *\n * For communicating with SharePoint, use the {@link SPHttpClient} class instead. For communicating with Microsoft Graph, use the {@link MSGraphClient} class.\n *\n * @public @sealed\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "SPHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead. For communicating with Microsoft Graph, use the " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "MSGraphClient" + "kind": "Reference", + "text": "AadHttpClient" + }, + { + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "MSGraphClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "isBeta": false, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [ - { - "kind": "text", - "text": "The service scope is needed to retrieve some of the class's internal components." - } - ], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - }, - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "Configuration options for the request to get an access token." - } - ], - "isOptional": true, - "isSpread": false, - "type": "IAadHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "AadHttpClient", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `AadHttpClient` class\n *\n * @param serviceScope - The service scope is needed to retrieve some of the class's internal components.\n *\n * @param resourceUrl - The resource for which the token should be obtained.\n *\n * @param options - Configuration options for the request to get an access token.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "resourceEndpoint" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientOptions" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(configurations:static)", + "docComment": "/**\n * The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "AadHttpClient" + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "configurations" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfigurations" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "AadHttpClient", - "memberName": "" - } + "releaseTag": "Public", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: IAadHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "IAadHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that will return the result." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "kind": "Method", + "canonicalReference": "(fetch:instance,0)", + "docComment": "/**\n * Performs a REST service call.\n *\n * @remarks\n *\n * Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * @param url - The endpoint URL that fetch will be called on.\n *\n * @param configuration - Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations.\n *\n * @param options - Additional options that affect the request.\n *\n * @returns A promise that will return the result.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fetch" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, { - "kind": "text", - "text": "The endpoint URL that fetch will be called on." + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, { - "kind": "text", - "text": "Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations." + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } } ], - "isOptional": false, - "isSpread": false, - "type": "AadHttpClientConfiguration" + "name": "fetch" }, - "options": { - "name": "options", - "description": [ + { + "kind": "Method", + "canonicalReference": "(get:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to \"GET\".\n *\n * @param url - The endpoint URL that fetch will be called on.\n *\n * @param configuration - Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations.\n *\n * @param options - Additional options that affect the request.\n *\n * @returns A promise that will return the result.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "get" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Additional options that affect the request." + "kind": "Reference", + "text": "AadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Performs a REST service call." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that will return the result." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, { - "kind": "text", - "text": "The endpoint URL that fetch will be called on." + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "name": "get" }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Method", + "canonicalReference": "(post:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to \"POST\".\n *\n * @param url - The endpoint URL that fetch will be called on.\n *\n * @param configuration - Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations.\n *\n * @param options - Additional options that affect the request.\n *\n * @returns A promise that will return the result.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "post" + }, + { + "kind": "Content", + "text": "(" + }, { - "kind": "text", - "text": "Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations." + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "AadHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, { - "kind": "text", - "text": "Additional options that affect the request." + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } } ], - "isOptional": true, - "isSpread": false, - "type": "IHttpClientOptions" + "name": "post" } - }, - "deprecatedMessage": [], - "summary": [ + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(AadHttpClientConfiguration:class)", + "docComment": "/**\n * Configuration for HttpClient.\n *\n * @remarks\n *\n * The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration" + }, { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that will return the result." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Public", + "name": "AadHttpClientConfiguration", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "flags" + }, { - "kind": "text", - "text": "The endpoint URL that fetch will be called on." + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "overrideFlags" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ");" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ] }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Property", + "canonicalReference": "(flags:instance)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations." + "kind": "Reference", + "text": "IAadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "AadHttpClientConfiguration" + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "options": { - "name": "options", - "description": [ + { + "kind": "Method", + "canonicalReference": "(overrideWith:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "overrideWith" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceFlags" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Additional options that affect the request." + "kind": "Reference", + "text": "IAadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "overrideWith" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "AadHttpClientConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "IAadHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for HttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IAadHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IAadHttpClientConfiguration" - } + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 }, - "deprecatedMessage": [], - "summary": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "flags": { - "kind": "property", - "signature": "protected flags: IAadHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IAadHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "AadHttpClientConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IAadHttpClientConfiguration" + "startIndex": 6, + "endIndex": 8 } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - } - } - }, - "AadHttpClientFactory": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: " + ] }, { - "kind": "web-link", - "elements": [ + "kind": "Class", + "canonicalReference": "(AadHttpClientFactory:class)", + "docComment": "/**\n * Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient}\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadHttpClientFactory` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "AadHttpClientFactory" + }, { - "kind": "text", - "text": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" + "kind": "Content", + "text": " " } ], - "targetUrl": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadHttpClientFactory class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "getClient": { - "kind": "method", - "signature": "getClient(resourceEndpoint: string): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [ + "releaseTag": "Public", + "name": "AadHttpClientFactory", + "members": [ + { + "kind": "Method", + "canonicalReference": "(getClient:instance,0)", + "docComment": "/**\n * Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal.\n *\n * @param resourceEndpoint - The target AAD application's resource endpoint.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getClient" + }, + { + "kind": "Content", + "text": "(" + }, { - "kind": "text", - "text": "The target AAD application's resource endpoint." + "kind": "Reference", + "text": "resourceEndpoint" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadHttpClient" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for AadHttpClientFactory." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "AadTokenProvider": { - "kind": "class", - "extends": "", - "implements": "IAadTokenProvider", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class allows a developer to obtain OAuth2 tokens from Azure AD." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AadTokenProvider class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": true, - "members": { - "getToken": { - "kind": "method", - "signature": "getToken(resourceEndpoint: string): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that will be fullfiled with the token or that will reject with an error message" - } - ] - }, - "parameters": { - "resourceEndpoint": { - "name": "resourceEndpoint", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "the resource for which the token should be obtained An example of a resourceEndpoint would be https://graph.microsoft.com" + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource." - }, - { - "kind": "paragraph" + "name": "getClient" }, { - "kind": "text", - "text": "The OAuth2 token should not be cached by the caller since it is already cached by the method itself." + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for AadHttpClientFactory.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadHttpClientFactory" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "implementsTokenRanges": [] }, - "tokenAcquisitionEvent": { - "kind": "property", - "signature": "readonly tokenAcquisitionEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Notifies the developer when Token Acquisition requires user action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": true - } - } - }, - "AadTokenProviderFactory": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Returns a preinitialized version of the AadTokenProviderFactory." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "getTokenProvider": { - "kind": "method", - "signature": "getTokenProvider(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(AadTokenProvider:class)", + "docComment": "/**\n * This class allows a developer to obtain OAuth2 tokens from Azure AD.\n *\n * OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadTokenProvider` class.\n *\n * @public @sealed\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for AadTokenProviderFactory." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "DigestCache": { - "kind": "class", - "extends": "", - "implements": "IDigestCache", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information, see the MSDN article " - }, - { - "kind": "web-link", - "elements": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "AadTokenProvider" + }, { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": " implements " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "DigestCache" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "DigestCache", - "memberName": "" - } + "kind": "Reference", + "text": "IAadTokenProvider" }, { - "kind": "text", - "text": " class" + "kind": "Content", + "text": " " } ], - "remarks": [] - }, - "addDigestToCache": { - "kind": "method", - "signature": "addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "webUrl": { - "name": "webUrl", - "description": [ + "releaseTag": "Public", + "name": "AadTokenProvider", + "members": [ + { + "kind": "Method", + "canonicalReference": "(getToken:instance,0)", + "docComment": "/**\n * Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource.\n *\n * The OAuth2 token should not be cached by the caller since it is already cached by the method itself.\n *\n * @param resourceEndpoint - the resource for which the token should be obtained\n *\n * @param useCachedToken - Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would be https://graph.microsoft.com\n *\n * @returns A promise that will be fullfiled with the token or that will reject with an error message\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "digestValue": { - "name": "digestValue", - "description": [ + "kind": "Reference", + "text": "getToken" + }, { - "kind": "text", - "text": "The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "expirationTimestamp": { - "name": "expirationTimestamp", - "description": [ + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "resourceEndpoint" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "useCachedToken" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, { - "kind": "text", - "text": "A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000." + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "number" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clearAllDigests": { - "kind": "method", - "signature": "clearAllDigests(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Clears all values from the cache." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clearDigest": { - "kind": "method", - "signature": "clearDigest(webUrl: string): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "Returns true if a cache entry was found and deleted; false otherwise." - } - ] - }, - "parameters": { - "webUrl": { - "name": "webUrl", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL." + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "useCachedToken", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "name": "getToken" + }, { - "kind": "text", - "text": "Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetchDigest": { - "kind": "method", - "signature": "fetchDigest(webUrl: string): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that is fulfilled with the digest value." - } - ] - }, - "parameters": { - "webUrl": { - "name": "webUrl", - "description": [ + "kind": "Property", + "canonicalReference": "(tokenAcquisitionEvent:instance)", + "docComment": "/**\n * Notifies the developer when Token Acquisition requires user action.\n *\n * @eventproperty\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "tokenAcquisitionEvent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPEvent" + }, { - "kind": "text", - "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TokenAcquisitionEventArgs" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for IDigestCache." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "GraphHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds default headers and collects telemetry that helps the service to monitor the performance of an application. https://developer.microsoft.com/en-us/graph/" - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with SharePoint, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" + "releaseTag": "Public", + "name": "tokenAcquisitionEvent", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead. For communicating with other internet services, use the " - }, - { - "kind": "api-link", - "elements": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "HttpClient" + "startIndex": 3, + "endIndex": 5 } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClient", - "memberName": "" - } + ] }, { - "kind": "text", - "text": " class instead." - } - ], - "isBeta": true, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." - } - ], - "summary": [ + "kind": "Class", + "canonicalReference": "(AadTokenProviderFactory:class)", + "docComment": "/**\n * Returns a preinitialized version of the AadTokenProviderFactory.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": "export default class " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClient", - "memberName": "" - } + "kind": "Reference", + "text": "AadTokenProviderFactory" }, { - "kind": "text", - "text": " class" + "kind": "Content", + "text": " " } ], - "remarks": [] - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: IGraphHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "IGraphHttpClientConfigurations", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." - } - ], - "summary": [ + "releaseTag": "Public", + "name": "AadTokenProviderFactory", + "members": [ { - "kind": "text", - "text": "The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "kind": "Method", + "canonicalReference": "(getTokenProvider:instance,0)", + "docComment": "/**\n * Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The url string should be relative to the graph server. Good: 'v1.0/me/events' Bad: '/v1.0/me/events', 'https://graph.microsoft.com/v1.0/me/events'" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ + "kind": "Reference", + "text": "getTokenProvider" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, { - "kind": "text", - "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" + "kind": "Reference", + "text": "AadTokenProvider" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "GraphHttpClientConfiguration" + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getTokenProvider" }, - "options": { - "name": "options", - "description": [ + { + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for AadTokenProviderFactory.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, { - "kind": "text", - "text": "additional options that affect the request" + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadTokenProviderFactory" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "IGraphHttpClientOptions" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } ], - "summary": [ + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(DigestCache:class)", + "docComment": "/**\n * IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time.\n *\n * For more information, see the MSDN article {@link https://msdn.microsoft.com/en-us/library/office/jj164022.aspx | \"Complete basic operations using SharePoint 2013 REST endpoints\"}\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Perform a REST service call." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "Generally, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" + "kind": "Reference", + "text": "DigestCache" }, { - "kind": "paragraph" + "kind": "Content", + "text": " implements " }, { - "kind": "text", - "text": "The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead): - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." + "kind": "Reference", + "text": "IDigestCache" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: GraphHttpClientConfiguration, options?: IGraphHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Public", + "name": "DigestCache", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `DigestCache` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, { - "kind": "text", - "text": "the URL to fetch" + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Method", + "canonicalReference": "(addDigestToCache:instance,0)", + "docComment": "/**\n * Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @param digestValue - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"\n *\n * @param expirationTimestamp - A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "addDigestToCache" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "digestValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "expirationTimestamp" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "GraphHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "digestValue", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, { - "kind": "text", - "text": "additional options that affect the request" + "parameterName": "expirationTimestamp", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } } ], - "isOptional": true, - "isSpread": false, - "type": "IGraphHttpClientOptions" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." - } - ], - "summary": [ + "name": "addDigestToCache" + }, { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "kind": "Method", + "canonicalReference": "(clearAllDigests:instance,0)", + "docComment": "/**\n * Clears all values from the cache.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clearAllDigests" + }, + { + "kind": "Content", + "text": "(): " + }, { - "kind": "text", - "text": "the URL to fetch" + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "clearAllDigests" }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Method", + "canonicalReference": "(clearDigest:instance,0)", + "docComment": "/**\n * Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time.\n *\n * @param webUrl - The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL.\n *\n * @returns Returns true if a cache entry was found and deleted; false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clearDigest" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "determines the default behavior of GraphHttpClient; normally this should be the latest version number from GraphHttpClientConfigurations" + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "GraphHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "additional options that affect the request" + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "isOptional": false, - "isSpread": false, - "type": "IGraphHttpClientOptions" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superseded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "The service key for GraphHttpClient." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "GraphHttpClientConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "IGraphHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Configuration for " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphHttpClient" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The GraphHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the GraphHttpClient class. Normally these switches are set (e.g. when calling GraphHttpClient.fetch()) by providing one of the predefined defaults from GraphHttpClientConfigurations, however switches can also be changed via the GraphHttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: IGraphHttpClientConfiguration, overrideFlags?: IGraphHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IGraphHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IGraphHttpClientConfiguration" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of GraphHttpClientCommonConfiguration with the specified flags." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ] - }, - "flags": { - "kind": "property", - "signature": "protected flags: IGraphHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IGraphHttpClientConfiguration", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "GraphHttpClientResponse": { - "kind": "class", - "extends": "HttpClientResponse", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "The Response subclass returned by methods such as GraphHttpClient.fetch()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This is a placeholder. In the future, additional GraphHttpClient-specific functionality may be added to this class." - } - ], - "isBeta": true, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(response: Response);", - "parameters": { - "response": { - "name": "response", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Response" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " + "name": "clearDigest" }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(fetchDigest:instance,0)", + "docComment": "/**\n * Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @returns A promise that is fulfilled with the digest value.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fetchDigest" + }, + { + "kind": "Content", + "text": "(" + }, { - "kind": "text", - "text": "GraphHttpClientResponse" + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphHttpClientResponse", - "memberName": "" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "fetchDigest" }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "clone": { - "kind": "method", - "signature": "clone(): GraphHttpClientResponse;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphHttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "correlationId": { - "kind": "property", - "signature": "readonly correlationId: Guid | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid | undefined", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for IDigestCache.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDigestCache" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } ], - "summary": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "Returns the Graph API correlation ID." + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "GraphRequest": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Typings for the GraphRequest Object For more information: " + ] }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://github.com/microsoftgraph/msgraph-sdk-javascript" - } - ], - "targetUrl": "https://github.com/microsoftgraph/msgraph-sdk-javascript" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(config: Options, path: string);", - "parameters": { - "config": { - "name": "config", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Options" - }, - "path": { - "name": "path", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Interface", + "canonicalReference": "(GraphRequest:interface)", + "docComment": "/**\n * Typings for the GraphRequest Object For more information: {@link https://github.com/microsoftgraph/msgraph-sdk-javascript}\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Content", + "text": "export interface " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "GraphRequest" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "GraphRequest", - "memberName": "" - } + "kind": "Reference", + "text": "IGraphRequest" }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "_headers": { - "kind": "property", - "signature": "_headers:", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string | number;\n }", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "_responseType": { - "kind": "property", - "signature": "_responseType: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buildFullUrl": { - "kind": "method", - "signature": "buildFullUrl(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "config": { - "kind": "property", - "signature": "config: Options;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "Options", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "count": { - "kind": "method", - "signature": "count(count: boolean): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "count": { - "name": "count", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "boolean" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "create": { - "kind": "method", - "signature": "create(content: any, callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "content": { - "name": "content", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "del": { - "kind": "method", - "signature": "del(callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "delete": { - "kind": "method", - "signature": "delete(callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "expand": { - "kind": "method", - "signature": "expand(properties: string | string[]): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "properties": { - "name": "properties", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | string[]" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "filter": { - "kind": "method", - "signature": "filter(filterStr: string): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "filterStr": { - "name": "filterStr", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getStream": { - "kind": "method", - "signature": "getStream(callback: GraphRequestCallback): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "callback": { - "name": "callback", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "header": { - "kind": "method", - "signature": "header(headerKey: string, headerValue: string): this;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "this", - "description": [] - }, - "parameters": { - "headerKey": { - "name": "headerKey", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "headerValue": { - "name": "headerValue", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "headers": { - "kind": "method", - "signature": "headers(headers: {\n [key: string]: string | number;\n }): this;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "this", - "description": [] - }, - "parameters": { - "headers": { - "name": "headers", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "{\n [key: string]: string | number;\n }" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "orderby": { - "kind": "method", - "signature": "orderby(properties: string | string[]): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "properties": { - "name": "properties", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | string[]" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "parsePath": { - "kind": "method", - "signature": "parsePath(rawPath: string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "rawPath": { - "name": "rawPath", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "patch": { - "kind": "method", - "signature": "patch(content: any, callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "content": { - "name": "content", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(content: any, callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "content": { - "name": "content", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "put": { - "kind": "method", - "signature": "put(content: any, callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "content": { - "name": "content", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "putStream": { - "kind": "method", - "signature": "putStream(stream: any, callback: GraphRequestCallback): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "stream": { - "name": "stream", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "callback": { - "name": "callback", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "query": { - "kind": "method", - "signature": "query(queryDictionaryOrString: string | {\n [key: string]: string | number;\n }): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "queryDictionaryOrString": { - "name": "queryDictionaryOrString", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | {\n [key: string]: string | number;\n }" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "responseType": { - "kind": "method", - "signature": "responseType(responseType: string): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "responseType": { - "name": "responseType", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "select": { - "kind": "method", - "signature": "select(properties: string | string[]): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "properties": { - "name": "properties", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string | string[]" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "skip": { - "kind": "method", - "signature": "skip(n: number): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "n": { - "name": "n", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "number" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "skipToken": { - "kind": "method", - "signature": "skipToken(token: string): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "token": { - "name": "token", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "top": { - "kind": "method", - "signature": "top(n: number): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "n": { - "name": "n", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "number" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "update": { - "kind": "method", - "signature": "update(content: any, callback?: GraphRequestCallback): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": { - "content": { - "name": "content", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "any" - }, - "callback": { - "name": "callback", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "GraphRequestCallback" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "urlComponents": { - "kind": "property", - "signature": "urlComponents: URLComponents;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "URLComponents", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "version": { - "kind": "method", - "signature": "version(v: string): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "v": { - "name": "v", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "HttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "HttpClient implements a basic set of features for performing REST operations against a generic service." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with SharePoint, use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClient" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "GraphRequest", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ + "kind": "PropertySignature", + "canonicalReference": "_headers", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "HttpClient" + "kind": "Reference", + "text": "_headers" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string | number;\n }" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClient", - "memberName": "" + "releaseTag": "Public", + "name": "_headers", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 } }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: IHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "IHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined HttpClientConfiguration objects for use with the HttpClient class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "kind": "PropertySignature", + "canonicalReference": "_responseType", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ + "kind": "Reference", + "text": "_responseType" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "HttpClientConfiguration" + "releaseTag": "Public", + "name": "_responseType", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, - "options": { - "name": "options", - "description": [ + { + "kind": "MethodSignature", + "canonicalReference": "(buildFullUrl:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "buildFullUrl" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "string" + }, { - "kind": "text", - "text": "additional options that affect the request" + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "buildFullUrl" + }, { - "kind": "text", - "text": "Performs a REST service call." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "kind": "MethodSignature", + "canonicalReference": "(constructor:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "constructor" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "config" + }, { - "kind": "text", - "text": "the URL to fetch" + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Options" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "path" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } } ], - "isOptional": false, - "isSpread": false, - "type": "HttpClientConfiguration" + "name": "constructor" }, - "options": { - "name": "options", - "description": [ + { + "kind": "MethodSignature", + "canonicalReference": "(count:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "count" + }, { - "kind": "text", - "text": "additional options that affect the request" + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "count" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "the URL to fetch" + "parameterName": "count", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "name": "count" }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "MethodSignature", + "canonicalReference": "(create:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "create" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "content" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, { - "kind": "text", - "text": "determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations" + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "HttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, { - "kind": "text", - "text": "additional options that affect the request" + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } } ], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for HttpClient." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "HttpClientConfiguration": { - "kind": "class", - "extends": "", - "implements": "IHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for HttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "IHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "flags": { - "kind": "property", - "signature": "protected flags: IHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Child classes should override this method to initialize the flags object." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "HttpClientConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Child classes should override this method to construct the child class type, rather than the base class type." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - } - } - }, - "HttpClientResponse": { - "kind": "class", - "extends": "", - "implements": "Response", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Response subclass returned by methods such as HttpClient.fetch()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HttpClientResponse class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "arrayBuffer": { - "kind": "method", - "signature": "arrayBuffer(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " + "name": "create" }, { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(del:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "del" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, { - "kind": "text", - "text": "Body" + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "blob": { - "kind": "method", - "signature": "blob(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " - }, - { - "kind": "web-link", - "elements": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "Body" + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "bodyUsed": { - "kind": "property", - "signature": "readonly bodyUsed: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " + "name": "del" }, { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(delete:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "delete" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, { - "kind": "text", - "text": "Body" + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "clone": { - "kind": "method", - "signature": "clone(): HttpClientResponse;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "HttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - }, - "formData": { - "kind": "method", - "signature": "formData(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " - }, - { - "kind": "web-link", - "elements": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "Body" + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "headers": { - "kind": "property", - "signature": "readonly headers: Headers;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Headers", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " + "name": "delete" }, { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(expand:0)", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "Response" + "kind": "Reference", + "text": "expand" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "json": { - "kind": "method", - "signature": "json(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " - }, - { - "kind": "web-link", - "elements": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "Body" + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" + "name": "expand" }, { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "nativeResponse": { - "kind": "property", - "signature": "protected nativeResponse: Response;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "Response", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ok": { - "kind": "property", - "signature": "readonly ok: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " - }, - { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(filter:0)", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "Response" + "kind": "Reference", + "text": "filter" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "filterStr" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "status": { - "kind": "property", - "signature": "readonly status: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " - }, - { - "kind": "web-link", - "elements": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "Response" + "parameterName": "filterStr", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "statusText": { - "kind": "property", - "signature": "readonly statusText: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " + "name": "filter" }, { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(get:0)", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "Response" + "kind": "Reference", + "text": "get" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "text": { - "kind": "method", - "signature": "text(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " - }, - { - "kind": "web-link", - "elements": [ + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "Body" + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Body" - }, - { - "kind": "text", - "text": " API" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "type": { - "kind": "property", - "signature": "readonly type: ResponseType;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ResponseType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for the browser's " + "name": "get" }, { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(getStream:0)", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "Response" + "kind": "Reference", + "text": "getStream" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + "name": "getStream" }, { - "kind": "text", - "text": " API" - } + "kind": "MethodSignature", + "canonicalReference": "(header:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "header" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "headerKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "headerValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "this" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "headerKey", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "headerValue", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "header" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(headers:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "headers" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "headers" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string | number;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "this" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "headers", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 7 + } + } + ], + "name": "headers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(orderby:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "orderby" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "orderby" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(parsePath:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "parsePath" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "rawPath" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "rawPath", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "parsePath" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(patch:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "patch" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "content" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "patch" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(post:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "post" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "content" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "post" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(put:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "put" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "content" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "put" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(putStream:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "putStream" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "stream" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "stream", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "putStream" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(query:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "query" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "queryDictionaryOrString" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | {\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string | number;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "queryDictionaryOrString", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 7 + } + } + ], + "name": "query" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(responseType:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "responseType" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "responseType" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "responseType", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "responseType" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(select:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "select" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "select" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(skip:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "skip" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "n" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "skip" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(skipToken:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "skipToken" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "token" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "token", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "skipToken" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(top:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "top" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "n" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "top" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(update:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "update" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "content" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "callback" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "update" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(version:0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "version" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "v" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "v", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "version" + }, + { + "kind": "PropertySignature", + "canonicalReference": "config", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "config" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Options" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "config", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "urlComponents", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "urlComponents" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "URLComponents" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "urlComponents", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(HttpClient:class)", + "docComment": "/**\n * HttpClient implements a basic set of features for performing REST operations against a generic service.\n *\n * @remarks\n *\n * For communicating with SharePoint, use the {@link SPHttpClient} class instead.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "HttpClient" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpClient", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `HttpClient` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "(configurations:static)", + "docComment": "/**\n * The standard predefined HttpClientConfiguration objects for use with the HttpClient class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "configurations" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientConfigurations" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Method", + "canonicalReference": "(fetch:instance,0)", + "docComment": "/**\n * Performs a REST service call.\n *\n * @remarks\n *\n * Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fetch" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "fetch" + }, + { + "kind": "Method", + "canonicalReference": "(get:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to \"GET\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "get" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "canonicalReference": "(post:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to \"POST\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "post" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "post" + }, + { + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for HttpClient.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClient" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(HttpClientConfiguration:class)", + "docComment": "/**\n * Configuration for HttpClient.\n *\n * @remarks\n *\n * The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpClientConfiguration", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "overrideFlags" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "(flags:instance)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(initializeFlags:instance,0)", + "docComment": "/**\n * Child classes should override this method to initialize the flags object.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "initializeFlags" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "initializeFlags" + }, + { + "kind": "Method", + "canonicalReference": "(overrideWith:instance,0)", + "docComment": "/**\n * Child classes should override this method to construct the child class type, rather than the base class type.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "overrideWith" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceFlags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "overrideWith" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] + }, + { + "kind": "Class", + "canonicalReference": "(HttpClientResponse:class)", + "docComment": "/**\n * The Response subclass returned by methods such as HttpClient.fetch().\n *\n * @remarks\n *\n * This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HttpClientResponse` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": " implements " + }, + { + "kind": "Reference", + "text": "Response" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "Body" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpClientResponse", + "members": [ + { + "kind": "Method", + "canonicalReference": "(arrayBuffer:instance,0)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "arrayBuffer" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ArrayBuffer" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "arrayBuffer" + }, + { + "kind": "Method", + "canonicalReference": "(blob:instance,0)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "blob" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Blob" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "blob" + }, + { + "kind": "Property", + "canonicalReference": "(bodyUsed:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "bodyUsed" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyUsed", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(clone:instance,0)", + "docComment": "/**\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clone" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "HttpClientResponse" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "clone" + }, + { + "kind": "Method", + "canonicalReference": "(formData:instance,0)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "formData" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "FormData" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "formData" + }, + { + "kind": "Property", + "canonicalReference": "(headers:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "headers" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Headers" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "headers", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(json:instance,0)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "json" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "json" + }, + { + "kind": "Property", + "canonicalReference": "(nativeResponse:instance)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "nativeResponse" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Response" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "nativeResponse", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(ok:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "ok" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ok", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(status:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "status" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(statusText:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "statusText" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "statusText", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(text:instance,0)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "text" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "text" + }, + { + "kind": "Property", + "canonicalReference": "(type:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "type" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ResponseType" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(url:instance)", + "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "url", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 4 + }, + { + "startIndex": 5, + "endIndex": 7 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IAadHttpClientConfiguration:interface)", + "docComment": "/**\n * Flags interface for HttpClientConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAadHttpClientConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IAadHttpClientConfigurations:interface)", + "docComment": "/**\n * Standard configurations for AadHttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfigurations" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAadHttpClientConfigurations", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "v1", + "docComment": "/**\n * This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "v1" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IAadHttpClientOptions:interface)", + "docComment": "/**\n * Interface for overriding the default behavior of AadHttpClient.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IAadHttpClientOptions" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAadHttpClientOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "configuration", + "docComment": "/**\n * @deprecated\n *\n * - AadHttpClient's configuration cannot be altered\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IAadTokenProviderConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configuration", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "tokenProvider", + "docComment": "/**\n * @deprecated\n *\n * - AadHttpClient does not support a custom tokenProvider.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tokenProvider" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IAadTokenProvider" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tokenProvider", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "useCachedToken", + "docComment": "/**\n * Allows the developer to specify if cached tokens should be use for the current request.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "useCachedToken" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "useCachedToken", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IAadTokenProvider:interface)", + "docComment": "/**\n * This class allows a developer to obtain OAuth2 tokens from Azure AD.\n *\n * OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc.\n *\n * @remarks\n *\n * AadTokenProvider is replacing the /_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IAadTokenProvider" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAadTokenProvider", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(getToken:0)", + "docComment": "/**\n * Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource.\n *\n * The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself.\n *\n * An example of a resourceEndpoint would be https://sdfpilot.outlook.com\n *\n * @param resourceEndpoint - the resource for which the token should be obtained\n *\n * @param useCachedToken - Allows the developer to specify if cached tokens should be returned.\n *\n * @returns A promise that will be fullfiled with the token or that will reject with an error message\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getToken" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "resourceEndpoint" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "useCachedToken" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "useCachedToken", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "getToken" + }, + { + "kind": "PropertySignature", + "canonicalReference": "tokenAcquisitionEvent", + "docComment": "/**\n * Notifies the developer when Token Acquistion requires user action.\n *\n * @eventproperty\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "tokenAcquisitionEvent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPEvent" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ITokenAcquisitionEventArgs" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tokenAcquisitionEvent", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IAadTokenProviderConfiguration:interface)", + "docComment": "/**\n * Required strings for constructing an AadTokenProvider.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IAadTokenProviderConfiguration" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAadTokenProviderConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "aadInstanceUrl", + "docComment": "/**\n * The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "aadInstanceUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadInstanceUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "aadTenantId", + "docComment": "/**\n * The Azure Active Directory's tenant id.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "aadTenantId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadTenantId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "aadUserId", + "docComment": "/**\n * The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "aadUserId" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadUserId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "redirectUri", + "docComment": "/**\n * The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "redirectUri" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redirectUri", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "servicePrincipalId", + "docComment": "/**\n * The client ID of the developer's Azure Active Directory application.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "servicePrincipalId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "servicePrincipalId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "userEmail", + "docComment": "/**\n * The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens.\n *\n * @deprecated\n *\n * This parameter will be ignored. Use userPrincipalName instead\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "userEmail" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "userEmail", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "userPrincipalName", + "docComment": "/**\n * The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth tokens. This parameter will avoid the \"Request is ambiguous: multiple user identities are avaliable for the current request\" error.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "userPrincipalName" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "userPrincipalName", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "url": { - "kind": "property", - "signature": "readonly url: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IDigestCache:interface)", + "docComment": "/**\n * IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time.\n *\n * For more information, see the MSDN article {@link https://msdn.microsoft.com/en-us/library/office/jj164022.aspx | \"Complete basic operations using SharePoint 2013 REST endpoints\"}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDigestCache" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDigestCache", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(addDigestToCache:0)", + "docComment": "/**\n * Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @param digestValue - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"\n *\n * @param expirationTimestamp - A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "addDigestToCache" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "digestValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "expirationTimestamp" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "digestValue", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "expirationTimestamp", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "addDigestToCache" + }, { - "kind": "text", - "text": "See documentation for the browser's " + "kind": "MethodSignature", + "canonicalReference": "(clearAllDigests:0)", + "docComment": "/**\n * Clears all values from the cache.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clearAllDigests" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "clearAllDigests" }, { - "kind": "web-link", - "elements": [ + "kind": "MethodSignature", + "canonicalReference": "(clearDigest:0)", + "docComment": "/**\n * Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time.\n *\n * @param webUrl - The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL.\n *\n * @returns Returns true if a cache entry was found and deleted; false otherwise.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Response" + "kind": "Reference", + "text": "clearDigest" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "targetUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Response" + "name": "clearDigest" }, { - "kind": "text", - "text": " API" + "kind": "MethodSignature", + "canonicalReference": "(fetchDigest:0)", + "docComment": "/**\n * Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @returns A promise that is fulfilled with the digest value.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fetchDigest" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "fetchDigest" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IAadHttpClientConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for HttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false - }, - "IAadHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for AadHttpClient." - } - ], - "remarks": [ + "extendsTokenRanges": [] + }, { - "kind": "text", - "text": "This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: AadHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AadHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" + "kind": "Interface", + "canonicalReference": "(IGraphHttpClientOptions:interface)", + "docComment": "/**\n * Options for HttpClient\n *\n * @remarks\n *\n * This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IGraphHttpClientOptions" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IAadHttpClientOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Interface for overriding the default behavior of AadHttpClient." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "configuration": { - "kind": "property", - "signature": "configuration?: IAadTokenProviderConfiguration;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IAadTokenProviderConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tokenProvider": { - "kind": "property", - "signature": "tokenProvider?: IAadTokenProvider;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IAadTokenProvider", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDigestCache": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time." - }, - { - "kind": "paragraph" + "releaseTag": "Beta", + "name": "IGraphHttpClientOptions", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] }, { - "kind": "text", - "text": "For more information, see the MSDN article " + "kind": "Interface", + "canonicalReference": "(IHttpClientConfiguration:interface)", + "docComment": "/**\n * Flags interface for HttpClientConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IHttpClientConfiguration", + "members": [], + "extendsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ + "kind": "Interface", + "canonicalReference": "(IHttpClientConfigurations:interface)", + "docComment": "/**\n * Standard configurations for HttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IHttpClientConfigurations" + }, { - "kind": "text", - "text": "\"Complete basic operations using SharePoint 2013 REST endpoints\"" + "kind": "Content", + "text": " " } ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj164022.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "addDigestToCache": { - "kind": "method", - "signature": "addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "webUrl": { - "name": "webUrl", - "description": [ + "releaseTag": "Public", + "name": "IHttpClientConfigurations", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "v1", + "docComment": "/**\n * This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "digestValue": { - "name": "digestValue", - "description": [ + "kind": "Content", + "text": "readonly " + }, { - "kind": "text", - "text": "The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "expirationTimestamp": { - "name": "expirationTimestamp", - "description": [ + "kind": "Reference", + "text": "v1" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration" + }, { - "kind": "text", - "text": "A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000." + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "number" + "releaseTag": "Public", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } } - }, - "deprecatedMessage": [], - "summary": [ + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IHttpClientOptions:interface)", + "docComment": "/**\n * Options for HttpClient\n *\n * @remarks\n *\n * This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "RequestInit" + }, { - "kind": "text", - "text": "Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "releaseTag": "Public", + "name": "IHttpClientOptions", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] }, - "clearAllDigests": { - "kind": "method", - "signature": "clearAllDigests(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(ISPHttpClientBatchConfiguration:interface)", + "docComment": "/**\n * Flags interface for SPHttpClientBatchConfiguration.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "Clears all values from the cache." + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "releaseTag": "Beta", + "name": "ISPHttpClientBatchConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] }, - "clearDigest": { - "kind": "method", - "signature": "clearDigest(webUrl: string): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [ - { - "kind": "text", - "text": "Returns true if a cache entry was found and deleted; false otherwise." - } - ] - }, - "parameters": { - "webUrl": { - "name": "webUrl", - "description": [ + { + "kind": "Interface", + "canonicalReference": "(ISPHttpClientBatchConfigurations:interface)", + "docComment": "/**\n * Standard configurations for SPHttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfigurations" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ISPHttpClientBatchConfigurations", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "v1", + "docComment": "/**\n * Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "v1" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL." + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Beta", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } } - }, - "deprecatedMessage": [], - "summary": [ + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(ISPHttpClientBatchCreationOptions:interface)", + "docComment": "/**\n * This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time." + "kind": "Reference", + "text": "ISPHttpClientBatchCreationOptions" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetchDigest": { - "kind": "method", - "signature": "fetchDigest(webUrl: string): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise that is fulfilled with the digest value." - } - ] - }, - "parameters": { - "webUrl": { - "name": "webUrl", - "description": [ + "releaseTag": "Beta", + "name": "ISPHttpClientBatchCreationOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "webUrl", + "docComment": "/**\n * SPHttpClientBatch will need to perform its POST to an endpoint such as \"http://example.com/sites/sample/_api/$batch\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "webUrl" + }, { - "kind": "text", - "text": "The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL." + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Beta", + "name": "webUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - }, - "deprecatedMessage": [], - "summary": [ + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(ISPHttpClientBatchOptions:interface)", + "docComment": "/**\n * This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache." + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IGraphHttpClientConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Flags interface for GraphHttpClientCommonConfiguration" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "IGraphHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for GraphHttpClient." - } - ], - "remarks": [ + "releaseTag": "Beta", + "name": "ISPHttpClientBatchOptions", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] + }, { - "kind": "text", - "text": "This interface provides standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: GraphHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClientConfiguration", - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded by the MSGraphClient class." + "kind": "Interface", + "canonicalReference": "(ISPHttpClientCommonConfiguration:interface)", + "docComment": "/**\n * Flags interface for SPHttpClientCommonConfiguration\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " " } ], - "summary": [ + "releaseTag": "Public", + "name": "ISPHttpClientCommonConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "jsonRequest", + "docComment": "/**\n * Automatically configure the \"Content-Type\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\").\n *\n * For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'.\n *\n * For OData 4.0, the value is 'application/json;charset=utf-8'.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "jsonRequest" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "jsonRequest", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" + "kind": "PropertySignature", + "canonicalReference": "jsonResponse", + "docComment": "/**\n * Automatically configure the \"Accept\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it.\n *\n * For OData 3.0, the value is 'application/json'.\n *\n * For OData 4.0, the value is 'application/json;odata.metadata=minimal'.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "jsonResponse" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "jsonResponse", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IGraphHttpClientOptions": { - "kind": "interface", - "extends": "IHttpClientOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for HttpClient" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": true, - "isSealed": false - }, - "IHttpClientConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for HttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false - }, - "IHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for HttpClient." - } - ], - "remarks": [ + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 + } + ] + }, { - "kind": "text", - "text": "This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: HttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClientConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/" + "kind": "Interface", + "canonicalReference": "(ISPHttpClientConfiguration:interface)", + "docComment": "/**\n * Flags interface for SPHttpClientConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IHttpClientOptions": { - "kind": "interface", - "extends": "RequestInit", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for HttpClient" - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "isBeta": false, - "isSealed": false - }, - "ISPHttpClientBatchConfiguration": { - "kind": "interface", - "extends": "ISPHttpClientCommonConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientBatchConfiguration." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "ISPHttpClientBatchConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for SPHttpClient." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: SPHttpClientBatchConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClientBatchConfiguration", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true" + "releaseTag": "Public", + "name": "ISPHttpClientConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "defaultODataVersion", + "docComment": "/**\n * Automatically configure the \"OData-Version\" header.\n *\n * @remarks\n *\n * When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion.\n *\n * NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "defaultODataVersion" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ODataVersion" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultODataVersion", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "defaultSameOriginCredentials", + "docComment": "/**\n * Automatically configure the RequestInit.credentials.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults.\n *\n * For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "defaultSameOriginCredentials" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultSameOriginCredentials", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "requestDigest", + "docComment": "/**\n * Automatically provide an \"X-RequestDigest\" header for authentication.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "requestDigest" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "requestDigest", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPHttpClientBatchCreationOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "webUrl": { - "kind": "property", - "signature": "webUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "SPHttpClientBatch will need to perform its POST to an endpoint such as \"http://example.com/sites/sample/_api/$batch\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option." + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPHttpClientBatchOptions": { - "kind": "interface", - "extends": "IHttpClientOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false - }, - "ISPHttpClientCommonConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + ] + }, { - "kind": "text", - "text": "Flags interface for SPHttpClientCommonConfiguration" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "jsonRequest": { - "kind": "property", - "signature": "jsonRequest?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Content-Type\" header for a JSON payload." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(ISPHttpClientConfigurations:interface)", + "docComment": "/**\n * Standard configurations for SPHttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When this switch is true:" + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ISPHttpClientConfigurations" }, { - "kind": "text", - "text": "If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\")." + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISPHttpClientConfigurations", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "v1", + "docComment": "/**\n * Version 1 enables these switches:\n *\n * consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "v1" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(ISPHttpClientOptions:interface)", + "docComment": "/**\n * This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ISPHttpClientOptions" }, { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IHttpClientOptions" }, { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "jsonResponse": { - "kind": "property", - "signature": "jsonResponse?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Accept\" header for a JSON payload." + "releaseTag": "Public", + "name": "ISPHttpClientOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "webUrl", + "docComment": "/**\n * Configure the SPWeb URL for authentication.\n *\n * @remarks\n *\n * For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be fetched using a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "webUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [ + "extendsTokenRanges": [ { - "kind": "text", - "text": "When this switch is true:" - }, + "startIndex": 3, + "endIndex": 5 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(ITokenAcquisitionEventArgs:interface)", + "docComment": "/**\n * Represents arguments used for raising a token acquisiton failure event.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export interface " }, { - "kind": "text", - "text": "If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it." + "kind": "Reference", + "text": "ITokenAcquisitionEventArgs" }, { - "kind": "paragraph" + "kind": "Content", + "text": " extends " }, { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json'." + "kind": "Reference", + "text": "SPEventArgs" }, { - "kind": "paragraph" + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ITokenAcquisitionEventArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "message", + "docComment": "/**\n * The message returned from ADAL fails to retrieve a token from Azure AD.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." + "kind": "PropertySignature", + "canonicalReference": "redirectUrl", + "docComment": "/**\n * The url of the page for the end user to interact with Azure AD.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "redirectUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redirectUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPHttpClientConfiguration": { - "kind": "interface", - "extends": "ISPHttpClientCommonConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "defaultODataVersion": { - "kind": "property", - "signature": "defaultODataVersion?: ODataVersion;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"OData-Version\" header." + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 5 } - ], - "remarks": [ + ] + }, + { + "kind": "Class", + "canonicalReference": "(MSGraphClient:class)", + "docComment": "/**\n * MSGraphClient is used to perform REST calls against Microsoft Graph.\n *\n * @remarks\n *\n * The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom configuration for every request.\n *\n * For more information: {@link https://github.com/microsoftgraph/msgraph-sdk-javascript}\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClient` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion." + "kind": "Content", + "text": "export default class " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "MSGraphClient" }, { - "kind": "text", - "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "defaultSameOriginCredentials": { - "kind": "property", - "signature": "defaultSameOriginCredentials?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the RequestInit.credentials." + "releaseTag": "Public", + "name": "MSGraphClient", + "members": [ + { + "kind": "Method", + "canonicalReference": "(api:instance,0)", + "docComment": "/**\n * All calls to Microsoft Graph are chained together starting with the api function.\n *\n * @remarks\n *\n * Path supports the following formats: * me * /me * https://graph.microsoft.com/v1.0/me * https://graph.microsoft.com/beta/me * me/events?$filter=startswith(subject, 'ship')\n *\n * The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript\n *\n * @param path - The path for the request to MSGraph.\n *\n * @param config - Sets the configuration for this request.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "api" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "path" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "config" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "Options" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + } + ], + "name": "api" } ], - "remarks": [ + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(MSGraphClientFactory:class)", + "docComment": "/**\n * Returns a preinitialized version of the MSGraphClient. For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph}\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientFactory` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When this switch is true:" + "kind": "Content", + "text": "export default class " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "MSGraphClientFactory" }, { - "kind": "text", - "text": "If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults." - }, + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "MSGraphClientFactory", + "members": [ { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(getClient:instance,0)", + "docComment": "/**\n * Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "getClient" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MSGraphClient" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getClient" }, { - "kind": "text", - "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for MSGraphClientFactory.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MSGraphClientFactory" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "requestDigest": { - "kind": "property", - "signature": "requestDigest?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically provide an \"X-RequestDigest\" header for authentication." + { + "kind": "Class", + "canonicalReference": "(ODataVersion:class)", + "docComment": "/**\n * Represents supported version of the \"OData-Version\" header, which is part of the Open Data Protocol standard.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "ODataVersion" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "ODataVersion", + "members": [ + { + "kind": "Method", + "canonicalReference": "(toString:instance,0)", + "docComment": "/**\n * Returns the \"OData-Version\" value, for example \"4.0\".\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "toString" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "toString" + }, { - "kind": "text", - "text": "When this switch is true:" + "kind": "Method", + "canonicalReference": "(tryParseFromHeaders:static,0)", + "docComment": "/**\n * Attempt to parse the \"OData-Version\" header.\n *\n * @remarks\n *\n * If the \"OData-Version\" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "tryParseFromHeaders" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "headers" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Headers" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ODataVersion" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "headers", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "tryParseFromHeaders" }, { - "kind": "paragraph" + "kind": "Property", + "canonicalReference": "(v3:static)", + "docComment": "/**\n * Represents version 3.0 for the \"OData-Version\" header\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "v3" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ODataVersion" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v3", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true }, { - "kind": "text", - "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." + "kind": "Property", + "canonicalReference": "(v4:static)", + "docComment": "/**\n * Represents version 4.0 for the \"OData-Version\" header\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "v4" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ODataVersion" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v4", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPHttpClientConfigurations": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard configurations for SPHttpClient." - } - ], - "remarks": [ + "implementsTokenRanges": [] + }, { - "kind": "text", - "text": "This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "v1": { - "kind": "property", - "signature": "readonly v1: SPHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(SPHttpClient:class)", + "docComment": "/**\n * SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application.\n *\n * @remarks\n *\n * For communicating with other internet services, use the {@link HttpClient} class.\n *\n * @public @sealed\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "SPHttpClient" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPHttpClient", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `SPHttpClient` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "(beginBatch:instance,0)", + "docComment": "/**\n * Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.\n *\n * @returns An {@link SPHttpClientBatch} object used to manage the batch operation.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "beginBatch" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "batchCreationOptions" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchCreationOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatch" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "batchCreationOptions", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "beginBatch" + }, + { + "kind": "Property", + "canonicalReference": "(configurations:static)", + "docComment": "/**\n * The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "configurations" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfigurations" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, { - "kind": "text", - "text": "Version 1 enables these switches:" + "kind": "Method", + "canonicalReference": "(fetch:instance,0)", + "docComment": "/**\n * Perform a REST service call.\n *\n * @remarks\n *\n * Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead):\n *\n * - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified.\n *\n * - For write operations, an \"X-RequestDigest\" header is automatically added\n *\n * - The request digest token is automatically fetched and stored in a cache, with support for preloading\n *\n * For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fetch" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "fetch" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(get:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to \"GET\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "get" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "get" }, { - "kind": "text", - "text": "consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPHttpClientOptions": { - "kind": "interface", - "extends": "IHttpClientOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "webUrl": { - "kind": "property", - "signature": "webUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configure the SPWeb URL for authentication." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be fetched using a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "MSGraphClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "MSGraphClient is used to perform REST calls against Microsoft Graph." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MSGraphClient class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom configuration for every request." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information: " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://github.com/microsoftgraph/msgraph-sdk-javascript" - } - ], - "targetUrl": "https://github.com/microsoftgraph/msgraph-sdk-javascript" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "api": { - "kind": "method", - "signature": "api(path: string, config?: Options): GraphRequest;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "GraphRequest", - "description": [] - }, - "parameters": { - "path": { - "name": "path", - "description": [ + "kind": "Method", + "canonicalReference": "(getWebUrlFromRequestUrl:static,0)", + "docComment": "/**\n * Use a heuristic to infer the base URL for authentication.\n *\n * @remarks\n *\n * Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path components such as \"_api\", \"_layouts\", or \"_vit_bin\". This is necessary for operations such as the X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a request.\n *\n * For example, if the requestUrl is \"/sites/site/web/_api/service\", the returned URL would be \"/sites/site/web\". Or if the requestUrl is \"http://example.com/_layouts/service\", the returned URL would be \"http://example.com\".\n *\n * If the URL cannot be determined, an exception is thrown.\n *\n * @param requestUrl - The URL for a SharePoint REST service\n *\n * @returns the inferred SPWeb URL\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static " + }, + { + "kind": "Reference", + "text": "getWebUrlFromRequestUrl" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "requestUrl" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "The path for the request to MSGraph." + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "config": { - "name": "config", - "description": [ + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "Sets the configuration for this request." + "parameterName": "requestUrl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } } ], - "isOptional": true, - "isSpread": false, - "type": "Options" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "All calls to Microsoft Graph are chained together starting with the api function." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Path supports the following formats: * me * /me * https://graph.microsoft.com/v1.0/me * https://graph.microsoft.com/beta/me * me/events?$filter=startswith(subject, 'ship')" + "name": "getWebUrlFromRequestUrl" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(post:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to \"POST\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "post" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "post" }, { - "kind": "text", - "text": "The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "MSGraphClientFactory": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns a preinitialized version of the MSGraphClient. For more information: " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph" - } - ], - "targetUrl": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MSGraphClientFactory class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "getClient": { - "kind": "method", - "signature": "getClient(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal." + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for SPHttpClient.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClient" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "implementsTokenRanges": [] }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for MSGraphClientFactory." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ODataVersion": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Represents supported version of the \"OData-Version\" header, which is part of the Open Data Protocol standard." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "toString": { - "kind": "method", - "signature": "toString(): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "string", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the \"OData-Version\" value, for example \"4.0\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryParseFromHeaders": { - "kind": "method", - "signature": "static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "ODataVersion | undefined", - "description": [] - }, - "parameters": { - "headers": { - "name": "headers", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Headers" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(SPHttpClientBatch:class)", + "docComment": "/**\n * The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html\n *\n * The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an SPHttpClientResponse object for that particular request.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPHttpClientBatch` class.\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Attempt to parse the \"OData-Version\" header." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "If the \"OData-Version\" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "v3": { - "kind": "property", - "signature": "static v3: ODataVersion;", - "isOptional": false, - "isReadOnly": false, - "isStatic": true, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents version 3.0 for the \"OData-Version\" header" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "v4": { - "kind": "property", - "signature": "static v4: ODataVersion;", - "isOptional": false, - "isReadOnly": false, - "isStatic": true, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents version 4.0 for the \"OData-Version\" header" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "For communicating with other internet services, use the " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Reference", + "text": "SPHttpClientBatch" + }, { - "kind": "text", - "text": "HttpClient" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClient", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class." - } - ], - "isBeta": false, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Beta", + "name": "SPHttpClientBatch", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Property", + "canonicalReference": "(configurations:static)", + "docComment": "/**\n * The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "configurations" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfigurations" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true }, { - "kind": "api-link", - "elements": [ + "kind": "Method", + "canonicalReference": "(execute:instance,0)", + "docComment": "/**\n * Executes the batched queries that were queued using SPHttpClientBatch.fetch().\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "SPHttpClient" + "kind": "Reference", + "text": "execute" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientBatch" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [], + "name": "execute" }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "beginBatch": { - "kind": "method", - "signature": "beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientBatch", - "description": [ - { - "kind": "text", - "text": "An " + "kind": "Method", + "canonicalReference": "(fetch:instance,0)", + "docComment": "/**\n * Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed).\n *\n * @remarks\n *\n * The parameters for this function are basically the same as the WHATWG API standard documented here:\n *\n * {@link https://fetch.spec.whatwg.org/}\n *\n * However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details.\n *\n * When execute() is called, it will POST to a URL such as \"http://example.com/sites/sample/_api/$batch\". Typically SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "fetch" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "SPHttpClientBatch" + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClientBatch", - "memberName": "" } - }, - { - "kind": "text", - "text": " object used to manage the batch operation." - } - ] - }, - "parameters": { - "batchCreationOptions": { - "name": "batchCreationOptions", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchCreationOptions" - } - }, - "deprecatedMessage": [], - "summary": [ + ], + "name": "fetch" + }, { - "kind": "text", - "text": "Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "configurations": { - "kind": "property", - "signature": "static readonly configurations: ISPHttpClientConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ISPHttpClientConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" + "kind": "Method", + "canonicalReference": "(get:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to 'GET'.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "get" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, { - "kind": "text", - "text": "the URL to fetch" + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "name": "get" }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Method", + "canonicalReference": "(post:instance,0)", + "docComment": "/**\n * Calls fetch(), but sets the method to 'POST'.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "post" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "configuration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "options" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions" + }, + { + "kind": "Content", + "text": "): " + }, { - "kind": "text", - "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 18 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, { - "kind": "text", - "text": "additional options that affect the request" + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } } ], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Perform a REST service call." + "name": "post" } ], - "remarks": [ - { - "kind": "text", - "text": "Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead):" - }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(SPHttpClientBatchConfiguration:class)", + "docComment": "/**\n * Configuration for SPHttpClientBatch.\n *\n * @remarks\n *\n * The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method.\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export default class " }, { - "kind": "text", - "text": "- Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified." + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration" }, { - "kind": "paragraph" + "kind": "Content", + "text": " extends " }, { - "kind": "text", - "text": "- For write operations, an \"X-RequestDigest\" header is automatically added" + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration" }, { - "kind": "paragraph" + "kind": "Content", + "text": " " }, { - "kind": "text", - "text": "- The request digest token is automatically fetched and stored in a cache, with support for preloading" + "kind": "Content", + "text": "implements " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration" }, { - "kind": "text", - "text": "For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Beta", + "name": "SPHttpClientBatchConfiguration", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, { - "kind": "text", - "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" + "kind": "Reference", + "text": "overrideFlags" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ");" } ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "additional options that affect the request" + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } } - ], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientOptions" - } - }, - "deprecatedMessage": [], - "summary": [ + ] + }, { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getWebUrlFromRequestUrl": { - "kind": "method", - "signature": "static getWebUrlFromRequestUrl(requestUrl: string): string;", - "accessModifier": "", - "isOptional": false, - "isStatic": true, - "returnValue": { - "type": "string", - "description": [ - { - "kind": "text", - "text": "the inferred SPWeb URL" - } - ] - }, - "parameters": { - "requestUrl": { - "name": "requestUrl", - "description": [ + "kind": "Property", + "canonicalReference": "(flags:instance)", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "The URL for a SharePoint REST service" + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use a heuristic to infer the base URL for authentication." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path components such as \"_api\", \"_layouts\", or \"_vit_bin\". This is necessary for operations such as the X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a request." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For example, if the requestUrl is \"/sites/site/web/_api/service\", the returned URL would be \"/sites/site/web\". Or if the requestUrl is \"http://example.com/_layouts/service\", the returned URL would be \"http://example.com\"." - }, - { - "kind": "paragraph" + "releaseTag": "Beta", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "If the URL cannot be determined, an exception is thrown." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "kind": "Method", + "canonicalReference": "(initializeFlags:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "initializeFlags" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, { - "kind": "text", - "text": "the URL to fetch" + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [], + "name": "initializeFlags" }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Method", + "canonicalReference": "(overrideWith:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "overrideWith" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceFlags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration" + }, { - "kind": "text", - "text": "determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations" + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientConfiguration" - }, - "options": { - "name": "options", - "description": [ + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "additional options that affect the request" + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } } ], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientOptions" + "name": "overrideWith" } + ], + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 }, - "deprecatedMessage": [], - "summary": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for SPHttpClient." + "startIndex": 6, + "endIndex": 8 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPHttpClientBatch": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an SPHttpClientResponse object for that particular request." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPHttpClientBatch class." + ] }, { - "kind": "paragraph" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "configurations": { - "kind": "property", - "signature": "static readonly configurations: ISPHttpClientBatchConfigurations;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ISPHttpClientBatchConfigurations", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "execute": { - "kind": "method", - "signature": "execute(): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(SPHttpClientCommonConfiguration:class)", + "docComment": "/**\n * Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Executes the batched queries that were queued using SPHttpClientBatch.fetch()." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "fetch": { - "kind": "method", - "signature": "fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ - { - "kind": "text", - "text": "the URL to fetch" - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ - { - "kind": "text", - "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientBatchConfiguration" + "kind": "Content", + "text": "export default class " }, - "options": { - "name": "options", - "description": [ - { - "kind": "text", - "text": "additional options that affect the request" - } - ], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed)." - } - ], - "remarks": [ { - "kind": "text", - "text": "The parameters for this function are basically the same as the WHATWG API standard documented here:" + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration" }, { - "kind": "paragraph" + "kind": "Content", + "text": " extends " }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://fetch.spec.whatwg.org/" - } - ], - "targetUrl": "https://fetch.spec.whatwg.org/" + "kind": "Reference", + "text": "HttpClientConfiguration" }, { - "kind": "paragraph" + "kind": "Content", + "text": " " }, { - "kind": "text", - "text": "However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details." + "kind": "Content", + "text": "implements " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" }, { - "kind": "text", - "text": "When execute() is called, it will POST to a URL such as \"http://example.com/sites/sample/_api/$batch\". Typically SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly." + "kind": "Content", + "text": " " } ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "get": { - "kind": "method", - "signature": "get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" - } - }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Public", + "name": "SPHttpClientCommonConfiguration", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags.\n *\n * @remarks\n *\n * The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "flags" + }, { - "kind": "text", - "text": "the URL to fetch" + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "overrideFlags" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": ");" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "configuration": { - "name": "configuration", - "description": [ + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ { - "kind": "text", - "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } } - ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientBatchConfiguration" + ] }, - "options": { - "name": "options", - "description": [ + { + "kind": "Property", + "canonicalReference": "(flags:instance)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "additional options that affect the request" + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to 'GET'." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "post": { - "kind": "method", - "signature": "post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [ - { - "kind": "text", - "text": "A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with " + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "HttpClientResponse.ok" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "HttpClientResponse", - "memberName": "ok" + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(initializeFlags:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "initializeFlags" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 }, - { - "kind": "text", - "text": " being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server." - } - ] - }, - "parameters": { - "url": { - "name": "url", - "description": [ + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "initializeFlags" + }, + { + "kind": "Property", + "canonicalReference": "(jsonRequest:instance)", + "docComment": "/**\n * Automatically configure the \"Content-Type\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\").\n *\n * For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'.\n *\n * For OData 4.0, the value is 'application/json;charset=utf-8'.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "jsonRequest" + }, { - "kind": "text", - "text": "the URL to fetch" + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Public", + "name": "jsonRequest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "configuration": { - "name": "configuration", - "description": [ + { + "kind": "Property", + "canonicalReference": "(jsonResponse:instance)", + "docComment": "/**\n * Automatically configure the \"Accept\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it.\n *\n * For OData 3.0, the value is 'application/json'.\n *\n * For OData 4.0, the value is 'application/json;odata.metadata=minimal'.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "jsonResponse" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations" + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "SPHttpClientBatchConfiguration" + "releaseTag": "Public", + "name": "jsonResponse", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, - "options": { - "name": "options", - "description": [ + { + "kind": "Method", + "canonicalReference": "(overrideWith:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "overrideWith" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceFlags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration" + }, { - "kind": "text", - "text": "additional options that affect the request" + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchOptions" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to 'POST'." + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "overrideWith" } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "SPHttpClientBatchConfiguration": { - "kind": "class", - "extends": "SPHttpClientCommonConfiguration", - "implements": "ISPHttpClientBatchConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for SPHttpClientBatch." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method." - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - } + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 }, - "deprecatedMessage": [], - "summary": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." + "startIndex": 6, + "endIndex": 8 } - ], - "remarks": [] - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientBatchConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientBatchConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": true + ] }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientBatchConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": true - } - } - }, - "SPHttpClientCommonConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "ISPHttpClientCommonConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(SPHttpClientConfiguration:class)", + "docComment": "/**\n * Configuration for {@link SPHttpClient}.\n *\n * @remarks\n *\n * The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ] - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientCommonConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientCommonConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "jsonRequest": { - "kind": "property", - "signature": "readonly jsonRequest: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Content-Type\" header for a JSON payload." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "When this switch is true:" + "kind": "Reference", + "text": "SPHttpClientConfiguration" }, { - "kind": "paragraph" + "kind": "Content", + "text": " extends " }, { - "kind": "text", - "text": "If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\")." + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration" }, { - "kind": "paragraph" + "kind": "Content", + "text": " " }, { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'." + "kind": "Content", + "text": "implements " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ISPHttpClientConfiguration" }, { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;charset=utf-8'." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "jsonResponse": { - "kind": "property", - "signature": "readonly jsonResponse: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"Accept\" header for a JSON payload." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "SPHttpClientConfiguration", + "members": [ { - "kind": "text", - "text": "When this switch is true:" + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "overrideFlags" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ] }, { - "kind": "paragraph" + "kind": "Property", + "canonicalReference": "(defaultODataVersion:instance)", + "docComment": "/**\n * Automatically configure the \"OData-Version\" header.\n *\n * @remarks\n *\n * When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion.\n *\n * NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "defaultODataVersion" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ODataVersion" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultODataVersion", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it." + "kind": "Property", + "canonicalReference": "(defaultSameOriginCredentials:instance)", + "docComment": "/**\n * Automatically configure the RequestInit.credentials.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults.\n *\n * For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "defaultSameOriginCredentials" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultSameOriginCredentials", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "paragraph" + "kind": "Property", + "canonicalReference": "(flags:instance)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "flags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "For OData 3.0, the value is 'application/json'." + "kind": "Method", + "canonicalReference": "(initializeFlags:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "initializeFlags" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "initializeFlags" }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(overrideWith:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "overrideWith" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "sourceFlags" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "overrideWith" }, { - "kind": "text", - "text": "For OData 4.0, the value is 'application/json;odata.metadata=minimal'." + "kind": "Property", + "canonicalReference": "(requestDigest:instance)", + "docComment": "/**\n * Automatically provide an \"X-RequestDigest\" header for authentication.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "requestDigest" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "requestDigest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientCommonConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - } + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - } - } - }, - "SPHttpClientConfiguration": { - "kind": "class", - "extends": "SPHttpClientCommonConfiguration", - "implements": "ISPHttpClientConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration for " - }, - { - "kind": "api-link", - "elements": [ + "implementsTokenRanges": [ { - "kind": "text", - "text": "SPHttpClient" + "startIndex": 6, + "endIndex": 8 } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } + ] }, { - "kind": "text", - "text": "." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);", - "parameters": { - "flags": { - "name": "flags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - }, - "overrideFlags": { - "name": "overrideFlags", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags." - } - ], - "remarks": [] - }, - "defaultODataVersion": { - "kind": "property", - "signature": "readonly defaultODataVersion: ODataVersion;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ODataVersion", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the \"OData-Version\" header." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(SPHttpClientResponse:class)", + "docComment": "/**\n * The Response subclass returned by methods such as SPHttpClient.fetch().\n *\n * @remarks\n *\n * This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class.\n *\n * @public @sealed\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion." + "kind": "Content", + "text": "export default class " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPHttpClientResponse" }, { - "kind": "text", - "text": "NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "defaultSameOriginCredentials": { - "kind": "property", - "signature": "readonly defaultSameOriginCredentials: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically configure the RequestInit.credentials." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When this switch is true:" + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "HttpClientResponse" }, { - "kind": "text", - "text": "If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults." + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPHttpClientResponse", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `SPHttpClientResponse` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "response" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Response" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "response", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, { - "kind": "paragraph" + "kind": "Method", + "canonicalReference": "(clone:instance,0)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clone" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "clone" }, { - "kind": "text", - "text": "For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials" + "kind": "Property", + "canonicalReference": "(correlationId:instance)", + "docComment": "/**\n * Returns the SharePoint correlation ID.\n *\n * @remarks\n *\n * The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the \"sprequestguid\" header.\n *\n * @returns the correlation ID, or undefined if the \"sprequestguid\" header was not found\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "correlationId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "correlationId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "initializeFlags": { - "kind": "method", - "signature": "protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true - }, - "overrideWith": { - "kind": "method", - "signature": "overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientConfiguration", - "description": [] + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true + "implementsTokenRanges": [] }, - "requestDigest": { - "kind": "property", - "signature": "readonly requestDigest: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Automatically provide an \"X-RequestDigest\" header for authentication." - } - ], - "remarks": [ + { + "kind": "Enum", + "canonicalReference": "(SPHttpHeader:enum)", + "docComment": "/**\n * Standard HTTP headers used with {@link SPHttpClient}\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When this switch is true:" + "kind": "Content", + "text": "export declare const enum " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPHttpHeader" }, { - "kind": "text", - "text": "If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPHttpClientResponse": { - "kind": "class", - "extends": "HttpClientResponse", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Response subclass returned by methods such as SPHttpClient.fetch()." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class." - } - ], - "isBeta": false, - "isSealed": true, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(response: Response);", - "parameters": { - "response": { - "name": "response", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "Response" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Beta", + "name": "SPHttpHeader", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " - }, - { - "kind": "api-link", - "elements": [ + "kind": "EnumMember", + "canonicalReference": "SPRequestGuid", + "docComment": "/**\n * SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request.\n *\n * Example value: \"9417279e-40e1-0000-2465-306ba786bfd7\"\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "SPHttpClientResponse" + "kind": "Reference", + "text": "SPRequestGuid" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "\"SPRequestGuid\"" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClientResponse", - "memberName": "" + "releaseTag": "Beta", + "name": "SPRequestGuid", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 } - }, - { - "kind": "text", - "text": " class" } - ], - "remarks": [] - }, - "clone": { - "kind": "method", - "signature": "clone(): SPHttpClientResponse;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": true + ] }, - "correlationId": { - "kind": "property", - "signature": "readonly correlationId: Guid | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the SharePoint correlation ID." - } - ], - "remarks": [ + { + "kind": "Class", + "canonicalReference": "(TokenAcquisitionEventArgs:class)", + "docComment": "/**\n * Arguments for a token acquisition failure event.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the \"sprequestguid\" header." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPHttpHeader": { - "kind": "enum", - "values": { - "SPRequestGuid": { - "kind": "enum value", - "value": "\"SPRequestGuid\"", - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "export declare class " + }, { - "kind": "text", - "text": "SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request." + "kind": "Reference", + "text": "TokenAcquisitionEventArgs" }, { - "kind": "paragraph" + "kind": "Content", + "text": " extends " }, { - "kind": "text", - "text": "Example value: \"9417279e-40e1-0000-2465-306ba786bfd7\"" - } - ], - "remarks": [], - "isBeta": true - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard HTTP headers used with " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Reference", + "text": "SPEventArgs" + }, { - "kind": "text", - "text": "SPHttpClient" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "SPHttpClient", - "memberName": "" - } - } - ], - "remarks": [], - "isBeta": true - }, - "TokenAcquisitionEventArgs": { - "kind": "class", - "extends": "SPEventArgs", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Arguments for a token acquisition failure event." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(message: string, redirectUrl?: string);", - "parameters": { - "message": { - "name": "message", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "redirectUrl": { - "name": "redirectUrl", - "description": [], - "isOptional": true, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "TokenAcquisitionEventArgs", + "members": [ { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `TokenAcquisitionEventArgs` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "redirectUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "redirectUrl", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ] }, { - "kind": "api-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(message:instance)", + "docComment": "/**\n * The message returned from ADAL fails to retrieve a token from Azure AD.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "TokenAcquisitionEventArgs" + "kind": "Reference", + "text": "message" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-http", - "exportName": "TokenAcquisitionEventArgs", - "memberName": "" - } + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "message": { - "kind": "property", - "signature": "message: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The message returned from ADAL fails to retrieve a token from Azure AD." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "redirectUrl": { - "kind": "property", - "signature": "redirectUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The url of the page for the end user to perform Multi Factor Authentication" + "kind": "Property", + "canonicalReference": "(redirectUrl:instance)", + "docComment": "/**\n * The url of the page for the end user to perform Multi Factor Authentication\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "redirectUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redirectUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-listview-extensibility.api.json b/generate-docs/json/sp-listview-extensibility.api.json index 95e9f084..533e3a4a 100644 --- a/generate-docs/json/sp-listview-extensibility.api.json +++ b/generate-docs/json/sp-listview-extensibility.api.json @@ -1,1214 +1,1754 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-listview-extensibility", + "docComment": "/**\n * SharePoint Framework support for customizing the list view.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-listview-extensibility", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for customizing the list view." - } - ], - "remarks": [], - "exports": { - "BaseFieldCustomizer": { - "kind": "class", - "extends": "BaseExtension", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the base class that third parties should extend when implementing a client-side extension that customizes the appearance of fields in a SharePoint ListView." - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"FieldCustomizer\"." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "protected readonly context: FieldCustomizerContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "FieldCustomizerContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." + "kind": "Class", + "canonicalReference": "(BaseFieldCustomizer:class)", + "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that customizes the appearance of fields in a SharePoint ListView.\n *\n * In the component manifest, the \"extensionType\" should be set to \"FieldCustomizer\".\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare abstract class " + }, + { + "kind": "Reference", + "text": "BaseFieldCustomizer" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": "> extends " + }, + { + "kind": "Reference", + "text": "BaseExtension" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": "> " } ], - "remarks": [ + "releaseTag": "Public", + "name": "BaseFieldCustomizer", + "members": [ + { + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "FieldCustomizerContext" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(onDisposeCell:instance,0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "onDisposeCell" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "event" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IFieldCustomizerCellEventParameters" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "onDisposeCell" + }, { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." + "kind": "Method", + "canonicalReference": "(onRenderCell:instance,0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "onRenderCell" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "event" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IFieldCustomizerCellEventParameters" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "onRenderCell" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onDisposeCell": { - "kind": "method", - "signature": "onDisposeCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IFieldCustomizerCellEventParameters" - } + "extendsTokenRange": { + "startIndex": 5, + "endIndex": 9 }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "implementsTokenRanges": [] }, - "onRenderCell": { - "kind": "method", - "signature": "onRenderCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IFieldCustomizerCellEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "BaseListViewCommandSet": { - "kind": "class", - "extends": "BaseExtension", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view." - } - ], - "remarks": [ { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseListViewCommandSet class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "In the component manifest, the \"extensionType\" should be set to \"ListViewCommandSet\"." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "readonly context: ListViewCommandSetContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ListViewCommandSetContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(BaseListViewCommandSet:class)", + "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view.\n *\n * @remarks\n *\n * In the component manifest, the \"extensionType\" should be set to \"ListViewCommandSet\".\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseListViewCommandSet` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onExecute": { - "kind": "method", - "signature": "onExecute(event: IListViewCommandSetExecuteEventParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IListViewCommandSetExecuteEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "declare abstract class " + }, { - "kind": "text", - "text": "This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onListViewUpdated": { - "kind": "method", - "signature": "onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IListViewCommandSetListViewUpdatedParameters" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "BaseListViewCommandSet" + }, { - "kind": "text", - "text": "This event occurs whenever the ListView state changes." - } - ], - "remarks": [ + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, { - "kind": "text", - "text": "This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title." + "kind": "Content", + "text": "> extends " + }, + { + "kind": "Reference", + "text": "BaseExtension" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": "> " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "tryGetCommand": { - "kind": "method", - "signature": "tryGetCommand(id: string): Command;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Command", - "description": [] - }, - "parameters": { - "id": { - "name": "id", - "description": [ + "releaseTag": "Public", + "name": "BaseListViewCommandSet", + "members": [ + { + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ListViewCommandSetContext" + }, { - "kind": "text", - "text": "Id of the command" + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(onExecute:instance,0)", + "docComment": "/**\n * This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "onExecute" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "event" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IListViewCommandSetExecuteEventParameters" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "onExecute" + }, { - "kind": "text", - "text": "Returns the command with the given id. Returns undefined if there is not command with the given id." + "kind": "Method", + "canonicalReference": "(onListViewUpdated:instance,0)", + "docComment": "/**\n * This event occurs whenever the ListView state changes.\n *\n * @remarks\n *\n * This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "onListViewUpdated" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "event" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IListViewCommandSetListViewUpdatedParameters" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "onListViewUpdated" + }, + { + "kind": "Method", + "canonicalReference": "(tryGetCommand:instance,0)", + "docComment": "/**\n * Returns the command with the given id. Returns undefined if there is not command with the given id.\n *\n * @param id - Id of the command\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetCommand" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Command" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "id", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "tryGetCommand" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ColumnAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to a ListView column, which is the visual presentation of a field." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ColumnAccessor class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A SharePoint \"field\" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a \"property\".)" - }, - { - "kind": "paragraph" + "extendsTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "implementsTokenRanges": [] }, { - "kind": "text", - "text": "A \"column\" is the visual presentation of a field, when displayed by the ListView." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "field": { - "kind": "property", - "signature": "readonly field: SPField;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPField", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The server-side definition of the field. This property is read-only." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "visible": { - "kind": "property", - "signature": "readonly visible: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether to show this column in the list view. This property is read-only." + "kind": "Class", + "canonicalReference": "(ColumnAccessor:class)", + "docComment": "/**\n * Provides access to a ListView column, which is the visual presentation of a field.\n *\n * @remarks\n *\n * A SharePoint \"field\" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a \"property\".)\n *\n * A \"column\" is the visual presentation of a field, when displayed by the ListView.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ColumnAccessor` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare abstract class " + }, + { + "kind": "Reference", + "text": "ColumnAccessor" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "Command": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents a command belonging to a command set." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling " - }, - { - "kind": "api-link", - "elements": [ + "releaseTag": "Public", + "name": "ColumnAccessor", + "members": [ + { + "kind": "Property", + "canonicalReference": "(field:instance)", + "docComment": "/**\n * The server-side definition of the field. This property is read-only.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract readonly " + }, + { + "kind": "Reference", + "text": "field" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPField" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "field", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "BaseListViewCommandSet.tryGetCommand" + "kind": "Property", + "canonicalReference": "(visible:instance)", + "docComment": "/**\n * Whether to show this column in the list view. This property is read-only.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract readonly " + }, + { + "kind": "Reference", + "text": "visible" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "visible", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-listview-extensibility", - "exportName": "BaseListViewCommandSet", - "memberName": "tryGetCommand" - } + "implementsTokenRanges": [] }, { - "kind": "text", - "text": ". The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel: string | undefined;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "iconImageUrl": { - "kind": "property", - "signature": "iconImageUrl: string | undefined;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(Command:class)", + "docComment": "/**\n * Represents a command belonging to a command set.\n *\n * @remarks\n *\n * The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling {@link BaseListViewCommandSet.tryGetCommand}. The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "Command" + }, { - "kind": "text", - "text": "This must be a absolute URL." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the command." + "releaseTag": "Public", + "name": "Command", + "members": [ + { + "kind": "Property", + "canonicalReference": "(ariaLabel:instance)", + "docComment": "/**\n * Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ariaLabel" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(iconImageUrl:instance)", + "docComment": "/**\n * An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all.\n *\n * @remarks\n *\n * This must be a absolute URL.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "iconImageUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "iconImageUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * Id of the command.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(title:instance)", + "docComment": "/**\n * A short label to be displayed by the associated button, menu item, etc.\n *\n * @remarks\n *\n * Example: \"Show information\"\n *\n * Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(visible:instance)", + "docComment": "/**\n * True if the command is visible.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "visible" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "visible", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "title": { - "kind": "property", - "signature": "title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A short label to be displayed by the associated button, menu item, etc." - } - ], - "remarks": [ + { + "kind": "Class", + "canonicalReference": "(FieldCustomizerContext:class)", + "docComment": "/**\n * This object provides contextual information for BaseFieldCustomizer.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FieldCustomizerContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "FieldCustomizerContext" + }, { - "kind": "text", - "text": "Example: \"Show information\"" + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ExtensionContext" }, { - "kind": "text", - "text": "Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "visible": { - "kind": "property", - "signature": "visible: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "True if the command is visible." + "releaseTag": "Public", + "name": "FieldCustomizerContext", + "members": [ + { + "kind": "Property", + "canonicalReference": "(field:instance)", + "docComment": "/**\n * Provides access to the SharePoint field that the customizer will operate on.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "field" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPField" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "field", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(tryGetListView:instance,0)", + "docComment": "/**\n * If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined.\n *\n * @remarks\n *\n * Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form.\n *\n * @returns the SharePoint list view, or undefined if there is none.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "tryGetListView" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "ListViewAccessor" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "tryGetListView" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "FieldCustomizerContext": { - "kind": "class", - "extends": "ExtensionContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This object provides contextual information for BaseFieldCustomizer." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FieldCustomizerContext class." + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "field": { - "kind": "property", - "signature": "readonly field: SPField;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPField", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the SharePoint field that the customizer will operate on." + "kind": "Interface", + "canonicalReference": "(IFieldCustomizerCellEventParameters:interface)", + "docComment": "/**\n * Event parameters for BaseFieldCustomizer.onRenderCell()\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IFieldCustomizerCellEventParameters" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "tryGetListView": { - "kind": "method", - "signature": "tryGetListView(): ListViewAccessor | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ListViewAccessor | undefined", - "description": [ - { - "kind": "text", - "text": "the SharePoint list view, or undefined if there is none." + "releaseTag": "Public", + "name": "IFieldCustomizerCellEventParameters", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "domElement", + "docComment": "/**\n * The HTML \"div\" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLDivElement" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 } - ] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + }, { - "kind": "text", - "text": "If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined." - } - ], - "remarks": [ + "kind": "PropertySignature", + "canonicalReference": "fieldValue", + "docComment": "/**\n * The value of the field being rendered.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "fieldValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fieldValue", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, { - "kind": "text", - "text": "Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IFieldCustomizerCellEventParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event parameters for BaseFieldCustomizer.onRenderCell()" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLDivElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLDivElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The HTML \"div\" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fieldValue": { - "kind": "property", - "signature": "readonly fieldValue: any;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The value of the field being rendered." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listItem": { - "kind": "property", - "signature": "readonly listItem: ListItemAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ListItemAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The list item being edited." + "kind": "PropertySignature", + "canonicalReference": "listItem", + "docComment": "/**\n * The list item being edited.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "listItem" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ListItemAccessor" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItem", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "userData", + "docComment": "/**\n * An implementation defined storage property.\n *\n * @remarks\n *\n * For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "userData" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "userData", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "userData": { - "kind": "property", - "signature": "userData: any;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An implementation defined storage property." + { + "kind": "Interface", + "canonicalReference": "(IListViewCommandSetExecuteEventParameters:interface)", + "docComment": "/**\n * Parameters for {@link BaseListViewCommandSet.onExecute}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IListViewCommandSetExecuteEventParameters" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "IListViewCommandSetExecuteEventParameters", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "itemId", + "docComment": "/**\n * The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "itemId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "itemId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, { - "kind": "text", - "text": "For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed." + "kind": "PropertySignature", + "canonicalReference": "selectedRows", + "docComment": "/**\n * The currently selected ListView rows, at the time when the event occurred.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "selectedRows" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "RowAccessor" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRows", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IListViewCommandSetExecuteEventParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Parameters for " + "extendsTokenRanges": [] }, { - "kind": "api-link", - "elements": [ + "kind": "Interface", + "canonicalReference": "(IListViewCommandSetListViewUpdatedParameters:interface)", + "docComment": "/**\n * Parameters for {@link BaseListViewCommandSet.onListViewUpdated}\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "BaseListViewCommandSet.onExecute" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-listview-extensibility", - "exportName": "BaseListViewCommandSet", - "memberName": "onExecute" - } - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "itemId": { - "kind": "property", - "signature": "readonly itemId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest." + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IListViewCommandSetListViewUpdatedParameters" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "selectedRows": { - "kind": "property", - "signature": "readonly selectedRows: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The currently selected ListView rows, at the time when the event occurred." + "releaseTag": "Public", + "name": "IListViewCommandSetListViewUpdatedParameters", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "selectedRows", + "docComment": "/**\n * The currently selected ListView rows, at the time when the event occurred.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "selectedRows" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "RowAccessor" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRows", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IListViewCommandSetListViewUpdatedParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Parameters for " + "extendsTokenRanges": [] }, { - "kind": "api-link", - "elements": [ + "kind": "Class", + "canonicalReference": "(ListItemAccessor:class)", + "docComment": "/**\n * When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item.\n *\n * @remarks\n *\n * ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and retrieve the current values for those fields. In the future, it may also support validation and editing operations.\n *\n * When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListItemAccessor` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default abstract class " + }, + { + "kind": "Reference", + "text": "ListItemAccessor" + }, { - "kind": "text", - "text": "BaseListViewCommandSet.onListViewUpdated" + "kind": "Content", + "text": " " } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-listview-extensibility", - "exportName": "BaseListViewCommandSet", - "memberName": "onListViewUpdated" - } - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "selectedRows": { - "kind": "property", - "signature": "readonly selectedRows: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The currently selected ListView rows, at the time when the event occurred." + "releaseTag": "Public", + "name": "ListItemAccessor", + "members": [ + { + "kind": "Property", + "canonicalReference": "(fields:instance)", + "docComment": "/**\n * The SharePoint fields that are currently available in the editor for this list item.\n *\n * @remarks\n *\n * The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract readonly " + }, + { + "kind": "Reference", + "text": "fields" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPField" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fields", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(getValue:instance,0)", + "docComment": "/**\n * Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract " + }, + { + "kind": "Reference", + "text": "getValue" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "field" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPField" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "field", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getValue" + }, + { + "kind": "Method", + "canonicalReference": "(getValueByName:instance,0)", + "docComment": "/**\n * Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract " + }, + { + "kind": "Reference", + "text": "getValueByName" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "internalName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "internalName", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getValueByName" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ListItemAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListItemAccessor class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and retrieve the current values for those fields. In the future, it may also support validation and editing operations." - }, - { - "kind": "paragraph" + "implementsTokenRanges": [] }, { - "kind": "text", - "text": "When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "fields": { - "kind": "property", - "signature": "readonly fields: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The SharePoint fields that are currently available in the editor for this list item." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(ListViewAccessor:class)", + "docComment": "/**\n * Provides access to a SharePoint ListView control.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewAccessor` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "getValue": { - "kind": "method", - "signature": "abstract getValue(field: SPField): any;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "any", - "description": [] - }, - "parameters": { - "field": { - "name": "field", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "SPField" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "declare abstract class " + }, + { + "kind": "Reference", + "text": "ListViewAccessor" + }, { - "kind": "text", - "text": "Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "getValueByName": { - "kind": "method", - "signature": "abstract getValueByName(internalName: string): any;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "any", - "description": [] - }, - "parameters": { - "internalName": { - "name": "internalName", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "ListViewAccessor", + "members": [ { - "kind": "text", - "text": "Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc." + "kind": "Property", + "canonicalReference": "(columns:instance)", + "docComment": "/**\n * The columns in associated with this view, including hidden columns.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract readonly " + }, + { + "kind": "Reference", + "text": "columns" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ColumnAccessor" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "columns", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(selectedRowsChangedEvent:instance)", + "docComment": "/**\n * Event that gets raised every time the selected items in the list view change.\n *\n * @eventproperty\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "selectedRowsChangedEvent" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPEvent" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SelectedRowsChangedEventArgs" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRowsChangedEvent", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(tryGetColumnByName:instance,0)", + "docComment": "/**\n * Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "abstract " + }, + { + "kind": "Reference", + "text": "tryGetColumnByName" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "internalName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ColumnAccessor" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "internalName", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "tryGetColumnByName" } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ListViewAccessor": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to a SharePoint ListView control." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewAccessor class." + "implementsTokenRanges": [] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "columns": { - "kind": "property", - "signature": "readonly columns: ReadonlyArray;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The columns in associated with this view, including hidden columns." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "selectedRowsChangedEvent": { - "kind": "property", - "signature": "readonly selectedRowsChangedEvent: SPEvent;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPEvent", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event that gets raised every time the selected items in the list view change." + "kind": "Class", + "canonicalReference": "(ListViewCommandSetContext:class)", + "docComment": "/**\n * This object provides contextual information for BaseListViewCommandSet.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewCommandSetContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "ListViewCommandSetContext" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "ExtensionContext" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": true - }, - "tryGetColumnByName": { - "kind": "method", - "signature": "abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "ColumnAccessor | undefined", - "description": [] - }, - "parameters": { - "internalName": { - "name": "internalName", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "ListViewCommandSetContext", + "members": [ + { + "kind": "Property", + "canonicalReference": "(listView:instance)", + "docComment": "/**\n * Provides access to the ListView control that the customizer will operate on.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "listView" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ListViewAccessor" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listView", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found." + "kind": "Property", + "canonicalReference": "(manifest:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "manifest" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ICommandSetExtensionManifest" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "ListViewCommandSetContext": { - "kind": "class", - "extends": "ExtensionContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This object provides contextual information for BaseListViewCommandSet." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ListViewCommandSetContext class." + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "listView": { - "kind": "property", - "signature": "readonly listView: ListViewAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ListViewAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to the ListView control that the customizer will operate on." + "kind": "Class", + "canonicalReference": "(RowAccessor:class)", + "docComment": "/**\n * Provides access to a ListView row, which is the visual presentation of a SharePoint list item.\n *\n * @remarks\n *\n * A SharePoint \"list item\" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields.\n *\n * A \"row\" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RowAccessor` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare abstract class " + }, + { + "kind": "Reference", + "text": "RowAccessor" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "ListItemAccessor" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "releaseTag": "Public", + "name": "RowAccessor", + "members": [], + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: ICommandSetExtensionManifest;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ICommandSetExtensionManifest", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client-side component." + { + "kind": "Class", + "canonicalReference": "(SelectedRowsChangedEventArgs:class)", + "docComment": "/**\n * Arguments for the selected rows changed event.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class " + }, + { + "kind": "Reference", + "text": "SelectedRowsChangedEventArgs" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPEventArgs" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "RowAccessor": { - "kind": "class", - "extends": "ListItemAccessor", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Provides access to a ListView row, which is the visual presentation of a SharePoint list item." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the RowAccessor class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A SharePoint \"list item\" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "A \"row\" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns." - } - ], - "isBeta": false, - "isSealed": false, - "members": {} - }, - "SelectedRowsChangedEventArgs": { - "kind": "class", - "extends": "SPEventArgs", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Arguments for the selected rows changed event." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "selectedRows": { - "kind": "property", - "signature": "selectedRows: ReadonlyArray;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ReadonlyArray", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The list of rows that were selected in the list view at the time when the event was fired." + "releaseTag": "Public", + "name": "SelectedRowsChangedEventArgs", + "members": [ + { + "kind": "Property", + "canonicalReference": "(selectedRows:instance)", + "docComment": "/**\n * The list of rows that were selected in the list view at the time when the event was fired.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "selectedRows" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ReadonlyArray" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "RowAccessor" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRows", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 6 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-odata-types.api.json b/generate-docs/json/sp-odata-types.api.json index 344d6132..f582db8c 100644 --- a/generate-docs/json/sp-odata-types.api.json +++ b/generate-docs/json/sp-odata-types.api.json @@ -1,2178 +1,2566 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-odata-types", + "docComment": "/**\n * TypeScript interfaces for working with SharePoint REST APIs.\n *\n * @remarks\n *\n * This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-odata-types", - "summary": [ + "members": [ { - "kind": "text", - "text": "TypeScript interfaces for working with SharePoint REST APIs." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions." - } - ], - "exports": { - "IODataBasePermission": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Data used for creating a SPPermission object." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "High": { - "kind": "property", - "signature": "High: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Low": { - "kind": "property", - "signature": "Low: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataChangeToken": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "text", - "text": "Represents an OData SP.ChangeToken object. For more information about this object, see " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "StringValue": { - "kind": "property", - "signature": "StringValue: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "{ StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataContextWebInformation": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.ContextWebInformation object. For more information about this object, see " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "LibraryVersion": { - "kind": "property", - "signature": "LibraryVersion: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"16.0.4919.3000\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "kind": "Interface", + "canonicalReference": "(_IODataUserId:interface)", + "docComment": "/**\n * Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataUserId" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "_IODataUserId", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "NameId", + "docComment": "/**\n * Example: `\"s-1-5-21-2127521184-1604012920-1887927527-2632426\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "NameId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "NameId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "NameIdIssuer", + "docComment": "/**\n * Example: `\"urn:office:idp:activedirectory\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "NameIdIssuer" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "NameIdIssuer", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, - "SiteFullUrl": { - "kind": "property", - "signature": "SiteFullUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "SupportedSchemaVersions": { - "kind": "property", - "signature": "SupportedSchemaVersions: string[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "[ \"14.0.0.0\", \"15.0.0.0\" ]", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "WebFullUrl": { - "kind": "property", - "signature": "WebFullUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataList": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "BaseTemplate": { - "kind": "property", - "signature": "BaseTemplate: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The list definition type on which the list is based." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Created": { - "kind": "property", - "signature": "Created: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Date(1453294804000)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "CurrentChangeToken": { - "kind": "property", - "signature": "CurrentChangeToken: IODataChangeToken;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataChangeToken", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The change token that will be used in logging the next change to the list." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Description": { - "kind": "property", - "signature": "Description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A description of the List." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "EntityTypeName": { - "kind": "property", - "signature": "EntityTypeName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"MyListTitleList\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Hidden": { - "kind": "property", - "signature": "Hidden: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Id": { - "kind": "property", - "signature": "Id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "LastItemDeletedDate": { - "kind": "property", - "signature": "LastItemDeletedDate: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Date(1453294809000)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "LastItemModifiedDate": { - "kind": "property", - "signature": "LastItemModifiedDate: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Date(1453294809000)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ListItemEntityTypeFullName": { - "kind": "property", - "signature": "ListItemEntityTypeFullName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"SP.Data.MyListTitleListItem\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ParentWebUrl": { - "kind": "property", - "signature": "ParentWebUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/sites/PubSite\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "TemplateFeatureId": { - "kind": "property", - "signature": "TemplateFeatureId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"Pages\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataListItem": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: " - }, - { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ContentTypeId": { - "kind": "property", - "signature": "ContentTypeId:", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "{\n StringValue: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "{ StringValue: \"0x010100C5...\" }", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ID": { - "kind": "property", - "signature": "ID: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Title of the List Item" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "UniqueId": { - "kind": "property", - "signature": "UniqueId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataNavigationNode": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Represents an OData SP.NavigationNode object. " + "kind": "Interface", + "canonicalReference": "(IODataBasePermission:interface)", + "docComment": "/**\n * Data used for creating a SPPermission object.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataBasePermission" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataBasePermission", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "High", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "High" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "High", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Low", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Low" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Low", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj246311.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "Children": { - "kind": "property", - "signature": "Children?: IODataNavigationNode[];", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IODataNavigationNode[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets an array of Navigation Nodes that are children to the current node." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Id": { - "kind": "property", - "signature": "Id?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the identifier for the navigation node." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "IsDocLib": { - "kind": "property", - "signature": "IsDocLib?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "IsExternal": { - "kind": "property", - "signature": "IsExternal?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "kind": "Interface", + "canonicalReference": "(IODataChangeToken:interface)", + "docComment": "/**\n * Represents an OData SP.ChangeToken object. For more information about this object, see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataChangeToken" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataChangeToken", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "StringValue", + "docComment": "/**\n * Example: `{ StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "StringValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "StringValue", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, - "IsVisible": { - "kind": "property", - "signature": "IsVisible?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies if the node navigation link should be visible." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Title": { - "kind": "property", - "signature": "Title?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies the anchor text for the node navigation link." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Url": { - "kind": "property", - "signature": "Url?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataNavigationNodeCollection": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. " + "kind": "Interface", + "canonicalReference": "(IODataContextWebInformation:interface)", + "docComment": "/**\n * Represents an OData SP.ContextWebInformation object. For more information about this object, see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataContextWebInformation" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataContextWebInformation", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "LibraryVersion", + "docComment": "/**\n * Example: `\"16.0.4919.3000\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "LibraryVersion" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LibraryVersion", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "SiteFullUrl", + "docComment": "/**\n * Example: `\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "SiteFullUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "SiteFullUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "SupportedSchemaVersions", + "docComment": "/**\n * Example: `[ \"14.0.0.0\", \"15.0.0.0\" ]`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "SupportedSchemaVersions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "SupportedSchemaVersions", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "WebFullUrl", + "docComment": "/**\n * Example: `\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "WebFullUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "WebFullUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/ee557907.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "quickLaunch": { - "kind": "property", - "signature": "quickLaunch: IODataNavigationNode[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataNavigationNode[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "kind": "Interface", + "canonicalReference": "(IODataList:interface)", + "docComment": "/**\n * Represents an OData SP.List object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataList" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataList", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "BaseTemplate", + "docComment": "/**\n * The list definition type on which the list is based.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "BaseTemplate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BaseTemplate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Created", + "docComment": "/**\n * Example: `\"/Date(1453294804000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Created" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Created", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "CurrentChangeToken", + "docComment": "/**\n * The change token that will be used in logging the next change to the list.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "CurrentChangeToken" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataChangeToken" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CurrentChangeToken", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Description", + "docComment": "/**\n * A description of the List.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Description" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "EntityTypeName", + "docComment": "/**\n * Example: `\"MyListTitleList\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "EntityTypeName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "EntityTypeName", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Hidden", + "docComment": "/**\n * A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Hidden" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Hidden", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Id", + "docComment": "/**\n * Example: `\"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "LastItemDeletedDate", + "docComment": "/**\n * Example: `\"/Date(1453294809000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "LastItemDeletedDate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LastItemDeletedDate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "LastItemModifiedDate", + "docComment": "/**\n * Example: `\"/Date(1453294809000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "LastItemModifiedDate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LastItemModifiedDate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ListItemEntityTypeFullName", + "docComment": "/**\n * Example: `\"SP.Data.MyListTitleListItem\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ListItemEntityTypeFullName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ListItemEntityTypeFullName", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ParentWebUrl", + "docComment": "/**\n * Example: `\"/sites/PubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ParentWebUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ParentWebUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "TemplateFeatureId", + "docComment": "/**\n * Example: `\"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "TemplateFeatureId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TemplateFeatureId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Title", + "docComment": "/**\n * Example: `\"Pages\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, - "topNav": { - "kind": "property", - "signature": "topNav: IODataNavigationNode[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataNavigationNode[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets an SPNavigationNode object that contains the nodes in the top link bar for the website." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataUser": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: " + "kind": "Interface", + "canonicalReference": "(IODataListItem:interface)", + "docComment": "/**\n * Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataListItem" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataListItem", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "ContentTypeId", + "docComment": "/**\n * Example: `{ StringValue: \"0x010100C5...\" }`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ContentTypeId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "{\n " + }, + { + "kind": "Reference", + "text": "StringValue" + }, + { + "kind": "Content", + "text": ": string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ContentTypeId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ID", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ID" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ID", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Title", + "docComment": "/**\n * Title of the List Item\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "UniqueId", + "docComment": "/**\n * Example: `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "UniqueId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UniqueId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "Email": { - "kind": "property", - "signature": "Email: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"someone@example.com\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "kind": "Interface", + "canonicalReference": "(IODataNavigationNode:interface)", + "docComment": "/**\n * Represents an OData SP.NavigationNode object. {@link https://msdn.microsoft.com/en-us/library/office/jj246311.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataNavigationNode", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "Children", + "docComment": "/**\n * Gets or sets an array of Navigation Nodes that are children to the current node.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Children" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Children", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Id", + "docComment": "/**\n * Gets a value that specifies the identifier for the navigation node.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Id" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "IsDocLib", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "IsDocLib" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsDocLib", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "IsExternal", + "docComment": "/**\n * Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "IsExternal" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsExternal", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "IsVisible", + "docComment": "/**\n * Gets or sets a value that specifies if the node navigation link should be visible.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "IsVisible" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsVisible", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Title", + "docComment": "/**\n * Gets or sets a value that specifies the anchor text for the node navigation link.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Title" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Url", + "docComment": "/**\n * Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Url" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Url", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, - "Id": { - "kind": "property", - "signature": "Id: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "IsSiteAdmin": { - "kind": "property", - "signature": "IsSiteAdmin: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Boolean value that specifies whether the user is a site collection administrator." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "LoginName": { - "kind": "property", - "signature": "LoginName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"i:0#.w|domain\\user\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "PrincipalType": { - "kind": "property", - "signature": "PrincipalType: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Values:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "None: 0" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "User: 1" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "DistributionList: 2" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "SecurityGroup: 4" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "SharePointGroup: 8" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "All: 15" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"DOMAIN\\user\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "UserId": { - "kind": "property", - "signature": "UserId: IODataUserId;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataUserId", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataUserCustomAction": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: " + "kind": "Interface", + "canonicalReference": "(IODataNavigationNodeCollection:interface)", + "docComment": "/**\n * Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. {@link https://msdn.microsoft.com/en-us/library/office/ee557907.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataNavigationNodeCollection" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataNavigationNodeCollection", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "quickLaunch", + "docComment": "/**\n * Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "quickLaunch" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "quickLaunch", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "topNav", + "docComment": "/**\n * Gets an SPNavigationNode object that contains the nodes in the top link bar for the website.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "topNav" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "topNav", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ClientSideComponentId": { - "kind": "property", - "signature": "ClientSideComponentId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the client-side component defined with SharePoint Framework" - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"359af2a7-b73c-4aac-874c-60a865da0be7\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ClientSideComponentProperties": { - "kind": "property", - "signature": "ClientSideComponentProperties: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom initialization properties for the client-side component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"{ \\\"maxItemsToShow\\\": 123 }\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "kind": "Interface", + "canonicalReference": "(IODataUser:interface)", + "docComment": "/**\n * Represents an OData SP.User object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataUser" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataUser", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "Email", + "docComment": "/**\n * Example: `\"someone@example.com\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Email" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Email", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Id", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "IsSiteAdmin", + "docComment": "/**\n * Boolean value that specifies whether the user is a site collection administrator.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "IsSiteAdmin" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsSiteAdmin", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "LoginName", + "docComment": "/**\n * Example: `\"i:0#.w|domain\\user\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "LoginName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LoginName", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "PrincipalType", + "docComment": "/**\n * This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.\n *\n * @remarks\n *\n * Values:\n *\n * None: 0\n *\n * User: 1\n *\n * DistributionList: 2\n *\n * SecurityGroup: 4\n *\n * SharePointGroup: 8\n *\n * All: 15\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "PrincipalType" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "PrincipalType", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Title", + "docComment": "/**\n * Example: `\"DOMAIN\\user\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "UserId", + "docComment": "/**\n * Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "UserId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataUserId" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UserId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, - "CommandUIExtension": { - "kind": "property", - "signature": "CommandUIExtension: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Description": { - "kind": "property", - "signature": "Description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the description of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Group": { - "kind": "property", - "signature": "Group: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Id": { - "kind": "property", - "signature": "Id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the identifier (GUID) of the custom action. Example: " - }, - { - "kind": "code", - "text": "\"48309f28-53aa-43ed-b113-625120e5af6f\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ImageUrl": { - "kind": "property", - "signature": "ImageUrl: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL of the image associated with the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Location": { - "kind": "property", - "signature": "Location: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the location of the custom action." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"ClientSide.Application\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "RegistrationId": { - "kind": "property", - "signature": "RegistrationId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the identifier of the object associated with the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "RegistrationType": { - "kind": "property", - "signature": "RegistrationType: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the type of object associated with the custom action." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Rights": { - "kind": "property", - "signature": "Rights: IODataBasePermission;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IODataBasePermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the permissions needed for the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Scope": { - "kind": "property", - "signature": "Scope: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the scope of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ScriptBlock": { - "kind": "property", - "signature": "ScriptBlock: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ScriptSrc": { - "kind": "property", - "signature": "ScriptSrc: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Sequence": { - "kind": "property", - "signature": "Sequence: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the display title of the custom action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Url": { - "kind": "property", - "signature": "Url: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "VersionOfUserCustomAction": { - "kind": "property", - "signature": "VersionOfUserCustomAction: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies an implementation specific version identifier." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"16.0.1.0\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IODataWeb": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: " + "kind": "Interface", + "canonicalReference": "(IODataUserCustomAction:interface)", + "docComment": "/**\n * Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataUserCustomAction" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataUserCustomAction", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "ClientSideComponentId", + "docComment": "/**\n * The unique identifier of the client-side component defined with SharePoint Framework\n *\n * @remarks\n *\n * Example: `\"359af2a7-b73c-4aac-874c-60a865da0be7\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ClientSideComponentId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ClientSideComponentId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ClientSideComponentProperties", + "docComment": "/**\n * Custom initialization properties for the client-side component.\n *\n * @remarks\n *\n * This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component.\n *\n * Example: `\"{ \\\"maxItemsToShow\\\": 123 }\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ClientSideComponentProperties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ClientSideComponentProperties", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "CommandUIExtension", + "docComment": "/**\n * Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "CommandUIExtension" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CommandUIExtension", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Description", + "docComment": "/**\n * Gets or sets the description of the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Description" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Group", + "docComment": "/**\n * Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Group" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Group", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Id", + "docComment": "/**\n * Gets a value that specifies the identifier (GUID) of the custom action. Example: `\"48309f28-53aa-43ed-b113-625120e5af6f\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ImageUrl", + "docComment": "/**\n * Gets or sets the URL of the image associated with the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ImageUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ImageUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Location", + "docComment": "/**\n * Gets or sets the location of the custom action.\n *\n * @remarks\n *\n * Example: `\"ClientSide.Application\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Location" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Location", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "RegistrationId", + "docComment": "/**\n * Gets or sets the value that specifies the identifier of the object associated with the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "RegistrationId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "RegistrationId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "RegistrationType", + "docComment": "/**\n * Gets or sets the value that specifies the type of object associated with the custom action.\n *\n * @remarks\n *\n * Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "RegistrationType" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "RegistrationType", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Rights", + "docComment": "/**\n * Gets or sets the value that specifies the permissions needed for the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Rights" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataBasePermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Rights", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Scope", + "docComment": "/**\n * Gets a value that specifies the scope of the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Scope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Scope", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ScriptBlock", + "docComment": "/**\n * Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ScriptBlock" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ScriptBlock", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ScriptSrc", + "docComment": "/**\n * Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ScriptSrc" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ScriptSrc", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Sequence", + "docComment": "/**\n * Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Sequence" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Sequence", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Title", + "docComment": "/**\n * Gets or sets the display title of the custom action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Url", + "docComment": "/**\n * Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Url" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Url", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "VersionOfUserCustomAction", + "docComment": "/**\n * Gets a value that specifies an implementation specific version identifier.\n *\n * @remarks\n *\n * Example: `\"16.0.1.0\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "VersionOfUserCustomAction" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "VersionOfUserCustomAction", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "Created": { - "kind": "property", - "signature": "Created?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies when the site was created." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Date(2016,0,20,12,58,7,0)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "CurrentChangeToken": { - "kind": "property", - "signature": "CurrentChangeToken?: IODataChangeToken;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IODataChangeToken", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Represents the unique sequential location of a change within the change log." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "CustomMasterUrl": { - "kind": "property", - "signature": "CustomMasterUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL for a custom master page file to apply to the website." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/sites/PubSite/_catalogs/masterpage/seattle.master\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Description": { - "kind": "property", - "signature": "Description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the description for the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Id": { - "kind": "property", - "signature": "Id?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the site identifier for the site." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "IsMultilingual": { - "kind": "property", - "signature": "IsMultilingual?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Value that represents if the web was" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Language": { - "kind": "property", - "signature": "Language?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies the LCID for the language that is used on the site." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "1033", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "LastItemModifiedDate": { - "kind": "property", - "signature": "LastItemModifiedDate?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets a value that specifies when an item was last modified in the site." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/Date(1453618828000)/\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "MasterUrl": { - "kind": "property", - "signature": "MasterUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the URL of the master page that is used for the website." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/sites/PubSite/_catalogs/masterpage/seattle.master\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "NoCrawl": { - "kind": "property", - "signature": "NoCrawl?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Determines if a particular web will be crawled by search or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "QuickLaunchEnabled": { - "kind": "property", - "signature": "QuickLaunchEnabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that specifies whether the Quick Launch area is enabled on the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "RecycleBinEnabled": { - "kind": "property", - "signature": "RecycleBinEnabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets a value that determines whether the recycle bin is enabled for the website." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ServerRelativeUrl": { - "kind": "property", - "signature": "ServerRelativeUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the server-relative URL for the Web site." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"/sites/PubSite\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "SiteLogoUrl": { - "kind": "property", - "signature": "SiteLogoUrl?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the url for the logo of this particular site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Title": { - "kind": "property", - "signature": "Title?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The title of the web." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "UIVersion": { - "kind": "property", - "signature": "UIVersion?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets or sets the user interface (UI) version of the Web site." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "15", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Url": { - "kind": "property", - "signature": "Url?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the absolute URL for the website." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"http://example.com/sites/PubSite\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "WebTemplate": { - "kind": "property", - "signature": "WebTemplate?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the name of the site definition or site template that was used to create the site." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: " - }, - { - "kind": "code", - "text": "\"BLANKINTERNET\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "kind": "Interface", + "canonicalReference": "(IODataWeb:interface)", + "docComment": "/**\n * Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IODataWeb" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IODataWeb", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "Created", + "docComment": "/**\n * Gets a value that specifies when the site was created.\n *\n * Example: `\"/Date(2016,0,20,12,58,7,0)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Created" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Created", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "CurrentChangeToken", + "docComment": "/**\n * Represents the unique sequential location of a change within the change log.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "CurrentChangeToken" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IODataChangeToken" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CurrentChangeToken", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "CustomMasterUrl", + "docComment": "/**\n * Gets or sets the URL for a custom master page file to apply to the website.\n *\n * Example: `\"/sites/PubSite/_catalogs/masterpage/seattle.master\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "CustomMasterUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CustomMasterUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Description", + "docComment": "/**\n * Gets or sets the description for the site.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Description" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Id", + "docComment": "/**\n * Gets a value that specifies the site identifier for the site.\n *\n * Example: `\"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Id" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "IsMultilingual", + "docComment": "/**\n * Value that represents if the web was\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "IsMultilingual" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsMultilingual", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Language", + "docComment": "/**\n * Gets a value that specifies the LCID for the language that is used on the site.\n *\n * Example: `1033`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Language" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Language", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "LastItemModifiedDate", + "docComment": "/**\n * Gets a value that specifies when an item was last modified in the site.\n *\n * Example: `\"/Date(1453618828000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "LastItemModifiedDate" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LastItemModifiedDate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "MasterUrl", + "docComment": "/**\n * Gets or sets the URL of the master page that is used for the website.\n *\n * Example: `\"/sites/PubSite/_catalogs/masterpage/seattle.master\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "MasterUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "MasterUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "NoCrawl", + "docComment": "/**\n * Determines if a particular web will be crawled by search or not.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "NoCrawl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "NoCrawl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "QuickLaunchEnabled", + "docComment": "/**\n * Gets or sets a value that specifies whether the Quick Launch area is enabled on the site.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "QuickLaunchEnabled" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "QuickLaunchEnabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "RecycleBinEnabled", + "docComment": "/**\n * Gets or sets a value that determines whether the recycle bin is enabled for the website.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "RecycleBinEnabled" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "RecycleBinEnabled", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "ServerRelativeUrl", + "docComment": "/**\n * Gets or sets the server-relative URL for the Web site.\n *\n * Example: `\"/sites/PubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ServerRelativeUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ServerRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "SiteLogoUrl", + "docComment": "/**\n * Gets the url for the logo of this particular site.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "SiteLogoUrl" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "SiteLogoUrl", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Title", + "docComment": "/**\n * The title of the web.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Title" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "UIVersion", + "docComment": "/**\n * Gets or sets the user interface (UI) version of the Web site.\n *\n * Example: `15`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "UIVersion" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UIVersion", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "Url", + "docComment": "/**\n * Gets the absolute URL for the website.\n *\n * Example: `\"http://example.com/sites/PubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Url" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Url", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "WebTemplate", + "docComment": "/**\n * Gets the name of the site definition or site template that was used to create the site.\n *\n * Example: `\"BLANKINTERNET\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "WebTemplate" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "WebTemplate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-page-context.api.json b/generate-docs/json/sp-page-context.api.json index b10365ef..3fd23fd4 100644 --- a/generate-docs/json/sp-page-context.api.json +++ b/generate-docs/json/sp-page-context.api.json @@ -1,3300 +1,4641 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-page-context", + "docComment": "/**\n * Page context services for the SharePoint Framework\n *\n * @remarks\n *\n * The page context allows an application and its web parts to share common data about the current page, such as its contents, URL, list, user, permissions, navigation menu, etc.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-page-context", - "summary": [ + "members": [ { - "kind": "text", - "text": "Page context services for the SharePoint Framework" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The page context allows an application and its web parts to share common data about the current page, such as its contents, URL, list, user, permissions, navigation menu, etc." - } - ], - "exports": { - "CultureInfo": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the " - }, - { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It provides culture info for the current user of the application." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CultureInfo class." - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "currentCultureName": { - "kind": "property", - "signature": "readonly currentCultureName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(CultureInfo:class)", + "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides culture info for the current user of the application.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CultureInfo` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This property may be an empty string, but it will never be undefined." + "kind": "Content", + "text": "export default class " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "CultureInfo" }, { - "kind": "text", - "text": "Example: If the currentCultureName is " + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "CultureInfo", + "members": [ + { + "kind": "Property", + "canonicalReference": "(currentCultureName:instance)", + "docComment": "/**\n * This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons.\n *\n * @remarks\n *\n * This property may be an empty string, but it will never be undefined.\n *\n * Example: If the currentCultureName is `\"en-AU\"` then the application could use this information to display the date as 1/8 instead of 8/1.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "currentCultureName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "currentCultureName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "\"en-AU\"", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(currentUICultureName:instance)", + "docComment": "/**\n * This string determines the default user interface language. This used for localization and translation of text.\n *\n * @remarks\n *\n * This property may have an empty string, but will never be undefined.\n *\n * Example: If the currentUICultureName is `\"es-MX\"`, then the application could use this information to translate the word \"hello\" to \"hola\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "currentUICultureName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "currentUICultureName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": " then the application could use this information to display the date as 1/8 instead of 8/1." + "kind": "Property", + "canonicalReference": "(isRightToLeft:instance)", + "docComment": "/**\n * This boolean represents the dominant direction of written text for the default user interface language.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isRightToLeft" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isRightToLeft", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "currentUICultureName": { - "kind": "property", - "signature": "readonly currentUICultureName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This string determines the default user interface language. This used for localization and translation of text." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This property may have an empty string, but will never be undefined." - }, - { - "kind": "paragraph" - }, + { + "kind": "Interface", + "canonicalReference": "(ISPSystemTime:interface)", + "docComment": "/**\n * Interface that represents a `SPSystemTime` structure.\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Example: If the currentUICultureName is " + "kind": "Content", + "text": "export interface " }, { - "kind": "code", - "text": "\"es-MX\"", - "highlighter": "plain" + "kind": "Reference", + "text": "ISPSystemTime" }, { - "kind": "text", - "text": ", then the application could use this information to translate the word \"hello\" to \"hola\"." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isRightToLeft": { - "kind": "property", - "signature": "readonly isRightToLeft: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This boolean represents the dominant direction of written text for the default user interface language." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPSystemTime": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Interface that represents a " - }, - { - "kind": "code", - "text": "SPSystemTime", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " structure." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "Day": { - "kind": "property", - "signature": "Day: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "DayOfWeek": { - "kind": "property", - "signature": "DayOfWeek: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Hour": { - "kind": "property", - "signature": "Hour: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Milliseconds": { - "kind": "property", - "signature": "Milliseconds: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Minute": { - "kind": "property", - "signature": "Minute: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Month": { - "kind": "property", - "signature": "Month: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Second": { - "kind": "property", - "signature": "Second: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "Year": { - "kind": "property", - "signature": "Year: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISPTimeZoneData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Interface that represents the data necessary to build an " - }, - { - "kind": "code", - "text": "TimeZone", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " object." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "daylightDate": { - "kind": "property", - "signature": "daylightDate: ISPSystemTime;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPSystemTime", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "daylightOffset": { - "kind": "property", - "signature": "daylightOffset: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "id: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "offset": { - "kind": "property", - "signature": "offset: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "standardDate": { - "kind": "property", - "signature": "standardDate: ISPSystemTime;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPSystemTime", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "standardOffset": { - "kind": "property", - "signature": "standardOffset: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "PageContext": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The SharePoint page context object." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(serviceScope: ServiceScope);", - "parameters": { - "serviceScope": { - "name": "serviceScope", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ServiceScope" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructs a new instance of the " + "releaseTag": "Beta", + "name": "ISPSystemTime", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "Day", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Day" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Day", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "api-link", - "elements": [ + "kind": "PropertySignature", + "canonicalReference": "DayOfWeek", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "PageContext" + "kind": "Reference", + "text": "DayOfWeek" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-page-context", - "exportName": "PageContext", - "memberName": "" + "releaseTag": "Beta", + "name": "DayOfWeek", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 } }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "aadInfo": { - "kind": "property", - "signature": "readonly aadInfo: AzureActiveDirectoryInfo | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "AzureActiveDirectoryInfo | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "cultureInfo": { - "kind": "property", - "signature": "readonly cultureInfo: CultureInfo;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "CultureInfo", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "It provides culture info for the current user of the application. This class is primarily used with the " + "kind": "PropertySignature", + "canonicalReference": "Hour", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Hour" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Hour", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "Milliseconds", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Milliseconds" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Milliseconds", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isInitialized": { - "kind": "property", - "signature": "readonly isInitialized: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ + "kind": "PropertySignature", + "canonicalReference": "Minute", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Minute" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Minute", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Returns whether the " + "kind": "PropertySignature", + "canonicalReference": "Month", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Month" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Month", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "Second", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Second" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Second", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " has been initialized." + "kind": "PropertySignature", + "canonicalReference": "Year", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Year" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Year", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "legacyPageContext": { - "kind": "property", - "signature": "readonly legacyPageContext: any;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "An object providing classic SharePoint properties that may be required by certain legacy scripts." - } - ], - "remarks": [ + { + "kind": "Interface", + "canonicalReference": "(ISPTimeZoneData:interface)", + "docComment": "/**\n * Interface that represents the data necessary to build an `TimeZone` object.\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the " + "kind": "Content", + "text": "export interface " }, { - "kind": "code", - "text": "_spPageContextInfo", - "highlighter": "plain" + "kind": "Reference", + "text": "ISPTimeZoneData" }, { - "kind": "text", - "text": " window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees." + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ISPTimeZoneData", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daylightDate", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "daylightDate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPSystemTime" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightDate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "daylightOffset", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "daylightOffset" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightOffset", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "NOTE: If certain functionality is exposed in the " + "kind": "PropertySignature", + "canonicalReference": "description", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "legacyPageContext", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "id", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the " + "kind": "PropertySignature", + "canonicalReference": "offset", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "offset" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "offset", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "legacyPageContext", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "standardDate", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "standardDate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPSystemTime" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardDate", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " object." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "list": { - "kind": "property", - "signature": "readonly list: SPList | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPList | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "listItem": { - "kind": "property", - "signature": "readonly listItem: SPListItem | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPListItem | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serviceKey": { - "kind": "property", - "signature": "static readonly serviceKey: ServiceKey;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "ServiceKey", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The service key for PageContext." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "site": { - "kind": "property", - "signature": "readonly site: SPSite;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPSite", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint site collection (\"SPSite\") that is hosting the page." + "kind": "PropertySignature", + "canonicalReference": "standardOffset", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "standardOffset" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardOffset", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "user": { - "kind": "property", - "signature": "readonly user: SPUser;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPUser", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(PageContext:class)", + "docComment": "/**\n * The SharePoint page context object.\n *\n * @remarks\n *\n * The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the " + "kind": "Content", + "text": "export default class " }, { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" + "kind": "Reference", + "text": "PageContext" }, { - "kind": "text", - "text": " class." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "web": { - "kind": "property", - "signature": "readonly web: SPWeb;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPWeb", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information for the SharePoint site (\"SPWeb\") that is hosting the page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPDayOfWeek": { - "kind": "enum", - "values": { - "Friday": { - "kind": "enum value", - "value": "5", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "Monday": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "Saturday": { - "kind": "enum value", - "value": "6", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "Sunday": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "Thursday": { - "kind": "enum value", - "value": "4", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "Tuesday": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "Wednesday": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The enum members represent the seven days of a week." - } - ], - "remarks": [], - "isBeta": true - }, - "SPField": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A field represents the data model for a column in SharePoint list view." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPField class." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This is the client-side equivalent for SharePoint " - }, - { - "kind": "code", - "text": "SPField", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It is used with the " - }, - { - "kind": "code", - "text": "@microsoft/sp-listview-extensibility", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " package." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "clientSideComponentId": { - "kind": "property", - "signature": "readonly clientSideComponentId: Guid | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the client-side component associated with the field." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "clientSideComponentProperties": { - "kind": "property", - "signature": "readonly clientSideComponentProperties: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is only used when a " - }, - { - "kind": "code", - "text": "ClientSideComponentId", - "highlighter": "plain" + "releaseTag": "Public", + "name": "PageContext", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `PageContext` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "serviceScope" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceScope" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] }, { - "kind": "text", - "text": " is specified. It is optional." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(aadInfo:instance)", + "docComment": "/**\n * Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "aadInfo" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "AzureActiveDirectoryInfo" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadInfo", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, { - "kind": "text", - "text": "If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "displayName": { - "kind": "property", - "signature": "readonly displayName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The display name of the field. This name is shown as column name in UI." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fieldType": { - "kind": "property", - "signature": "readonly fieldType: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The type of the field represented as a string" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID identifier for this field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "internalName": { - "kind": "property", - "signature": "readonly internalName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The internal name of the field. This name is usually used to find the field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isRequired": { - "kind": "property", - "signature": "readonly isRequired: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the field is required for each list item in the list" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPList": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the " - }, - { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It provides contextual information for the SharePoint list that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPList class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "permissions": { - "kind": "property", - "signature": "readonly permissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "readonly serverRelativeUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + "kind": "Property", + "canonicalReference": "(cultureInfo:instance)", + "docComment": "/**\n * It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "cultureInfo" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "CultureInfo" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cultureInfo", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Returns the server-relative URL for this " + "kind": "Property", + "canonicalReference": "(isInitialized:instance)", + "docComment": "/**\n * Returns whether the `PageContext` has been initialized.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isInitialized" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isInitialized", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "SPList", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(legacyPageContext:instance)", + "docComment": "/**\n * An object providing classic SharePoint properties that may be required by certain legacy scripts.\n *\n * @remarks\n *\n * This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees.\n *\n * NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "legacyPageContext" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "legacyPageContext", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(list:instance)", + "docComment": "/**\n * Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "list" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPList" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "list", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example: \"/sites/PubSite\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "title": { - "kind": "property", - "signature": "readonly title: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + "kind": "Property", + "canonicalReference": "(listItem:instance)", + "docComment": "/**\n * Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "listItem" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPListItem" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItem", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Returns the title for this " + "kind": "Property", + "canonicalReference": "(serviceKey:static)", + "docComment": "/**\n * The service key for PageContext.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "serviceKey" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ServiceKey" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PageContext" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "isStatic": true }, { - "kind": "code", - "text": "SPList", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(site:instance)", + "docComment": "/**\n * Contextual information for the SharePoint site collection (\"SPSite\") that is hosting the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "site" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPSite" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "site", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPListItem": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the " - }, - { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It provides contextual information for the SharePoint list item that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPListItem class." - }, - { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "id": { - "kind": "property", - "signature": "readonly id: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The number that identifies the " - }, - { - "kind": "code", - "text": "SPListItem", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " on the server." + "kind": "Property", + "canonicalReference": "(user:instance)", + "docComment": "/**\n * It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "user" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPUser" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "user", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(web:instance)", + "docComment": "/**\n * Contextual information for the SharePoint site (\"SPWeb\") that is hosting the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "web" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPWeb" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "web", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPPermission": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Used to test whether the current user has a requested set of permissions." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Specifies the built-in permissions available in SharePoint Foundation" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "For more information, see: " + "implementsTokenRanges": [] }, { - "kind": "web-link", - "elements": [ + "kind": "Enum", + "canonicalReference": "(SPDayOfWeek:enum)", + "docComment": "/**\n * The enum members represent the seven days of a week.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum " + }, + { + "kind": "Reference", + "text": "SPDayOfWeek" + }, { - "kind": "text", - "text": "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" + "kind": "Content", + "text": " " } ], - "targetUrl": "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor(value: IODataBasePermission);", - "parameters": { - "value": { - "name": "value", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IODataBasePermission" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Beta", + "name": "SPDayOfWeek", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "Friday", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Friday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Beta", + "name": "Friday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "Constructs a new instance of the " + "kind": "EnumMember", + "canonicalReference": "Monday", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Monday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Beta", + "name": "Monday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "api-link", - "elements": [ + "kind": "EnumMember", + "canonicalReference": "Saturday", + "docComment": "", + "excerptTokens": [ { - "kind": "text", - "text": "SPPermission" + "kind": "Reference", + "text": "Saturday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "6" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-page-context", - "exportName": "SPPermission", - "memberName": "" + "releaseTag": "Beta", + "name": "Saturday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 } }, { - "kind": "text", - "text": " class" - } - ], - "remarks": [] - }, - "addAndCustomizePages": { - "kind": "property", - "signature": "static readonly addAndCustomizePages: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "addDelPrivateWebParts": { - "kind": "property", - "signature": "static readonly addDelPrivateWebParts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add or remove personal web parts on a web part Page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "addListItems": { - "kind": "property", - "signature": "static readonly addListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Add items to lists, add documents to document libraries, and add Web discussion comments." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "applyStyleSheets": { - "kind": "property", - "signature": "static readonly applyStyleSheets: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Apply a style sheet (.css file) to the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "applyThemeAndBorder": { - "kind": "property", - "signature": "static readonly applyThemeAndBorder: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Apply a theme or borders to the entire Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "approveItems": { - "kind": "property", - "signature": "static readonly approveItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Approve a minor version of a list item or document." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "browseDirectories": { - "kind": "property", - "signature": "static readonly browseDirectories: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "browserUserInfo": { - "kind": "property", - "signature": "static readonly browserUserInfo: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View information about users of the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "cancelCheckout": { - "kind": "property", - "signature": "static readonly cancelCheckout: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Discard or check in a document which is checked out to another user." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "createAlerts": { - "kind": "property", - "signature": "static readonly createAlerts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create e-mail alerts." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "createGroups": { - "kind": "property", - "signature": "static readonly createGroups: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a group of users that can be used anywhere within the site collection." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "createSSCSite": { - "kind": "property", - "signature": "static readonly createSSCSite: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create a Web site using Self-Service Site Creation." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "deleteListItems": { - "kind": "property", - "signature": "static readonly deleteListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Delete items from a list, documents from a document library, and Web discussion comments in documents." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "deleteVersions": { - "kind": "property", - "signature": "static readonly deleteVersions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Delete past versions of a list item or document." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "editListItems": { - "kind": "property", - "signature": "static readonly editListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "editMyUserInfo": { - "kind": "property", - "signature": "static readonly editMyUserInfo: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Allows a user to change his or her user information, such as adding a picture." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "emptyMask": { - "kind": "property", - "signature": "static readonly emptyMask: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Has no permissions on the Web site. Not available through the user interface." + "kind": "EnumMember", + "canonicalReference": "Sunday", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Sunday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Beta", + "name": "Sunday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Thursday", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Thursday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "releaseTag": "Beta", + "name": "Thursday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Tuesday", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Tuesday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Beta", + "name": "Tuesday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Wednesday", + "docComment": "", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Wednesday" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Beta", + "name": "Wednesday", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "enumeratePermissions": { - "kind": "property", - "signature": "static readonly enumeratePermissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enumerate permissions on the Web site, list, folder, document, or list item." + { + "kind": "Class", + "canonicalReference": "(SPField:class)", + "docComment": "/**\n * A field represents the data model for a column in SharePoint list view.\n *\n * @remarks\n *\n * This is the client-side equivalent for SharePoint `SPField` class. It is used with the `@microsoft/sp-listview-extensibility` package.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPField` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "SPField" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "fullMask": { - "kind": "property", - "signature": "static readonly fullMask: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Has all permissions on the Web site. Not available through the user interface." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "hasAllPermissions": { - "kind": "method", - "signature": "hasAllPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": { - "requestedPerms": { - "name": "requestedPerms", - "description": [ - { - "kind": "text", - "text": "Any number of SPPermission objects to be compared against the original" - } - ], - "isOptional": false, - "isSpread": true, - "type": "SPPermission[]" - } - }, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "SPField", + "members": [ + { + "kind": "Property", + "canonicalReference": "(clientSideComponentId:instance)", + "docComment": "/**\n * The unique identifier of the client-side component associated with the field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "clientSideComponentId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "clientSideComponentId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Function for testing whether a given permission mask has all of the requested permissions." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "hasAnyPermissions": { - "kind": "method", - "signature": "hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": { - "requestedPerms": { - "name": "requestedPerms", - "description": [ - { - "kind": "text", - "text": "Any number of SPPermission objects to be compared against the original" - } - ], - "isOptional": false, - "isSpread": true, - "type": "SPPermission[]" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Property", + "canonicalReference": "(clientSideComponentProperties:instance)", + "docComment": "/**\n * This property is only used when a `ClientSideComponentId` is specified. It is optional.\n *\n * @remarks\n *\n * If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "clientSideComponentProperties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "clientSideComponentProperties", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Function for testing whether a given permission mask has any of the requested permissions." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "hasPermission": { - "kind": "method", - "signature": "hasPermission(requestedPerm: SPPermission): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": { - "requestedPerm": { - "name": "requestedPerm", - "description": [ - { - "kind": "text", - "text": "The SPPermission object to be compared against the original" - } - ], - "isOptional": false, - "isSpread": false, - "type": "SPPermission" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Property", + "canonicalReference": "(displayName:instance)", + "docComment": "/**\n * The display name of the field. This name is shown as column name in UI.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "displayName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Function for testing whether a given permission mask has the requested permission." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "layoutsPage": { - "kind": "property", - "signature": "static readonly layoutsPage: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View the layouts page?" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manageAlerts": { - "kind": "property", - "signature": "static readonly manageAlerts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manage alerts for all users of the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manageLists": { - "kind": "property", - "signature": "static readonly manageLists: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create and delete lists, add or remove columns in a list, and add or remove public views of a list." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "managePermissions": { - "kind": "property", - "signature": "static readonly managePermissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create and change permission levels on the Web site and assign permissions to users and groups." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "managePersonalViews": { - "kind": "property", - "signature": "static readonly managePersonalViews: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create, change, and delete personal views of lists." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manageSubwebs": { - "kind": "property", - "signature": "static readonly manageSubwebs: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manageWeb": { - "kind": "property", - "signature": "static readonly manageWeb: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Grant the ability to perform all administration tasks for the Web site as well as manage content." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(fieldType:instance)", + "docComment": "/**\n * The type of the field represented as a string\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "fieldType" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fieldType", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "open": { - "kind": "property", - "signature": "static readonly open: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Allow users to open a Web site, list, or folder to access items inside that container." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "openItems": { - "kind": "property", - "signature": "static readonly openItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View the source of documents with server-side file handlers." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "updatePersonalWebParts": { - "kind": "property", - "signature": "static readonly updatePersonalWebParts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Update web parts to display personalized information." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "useClientIntegration": { - "kind": "property", - "signature": "static readonly useClientIntegration: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use features that launch client applications; otherwise, users must work on documents locally and upload changes." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "useRemoteAPIs": { - "kind": "property", - "signature": "static readonly useRemoteAPIs: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "value": { - "kind": "property", - "signature": "readonly value: IODataBasePermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IODataBasePermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the value of this SPPermission object" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "viewFormPages": { - "kind": "property", - "signature": "static readonly viewFormPages: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View forms, views, and application pages, and enumerate lists." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "viewListItems": { - "kind": "property", - "signature": "static readonly viewListItems: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View items in lists, documents in document libraries, and view Web discussion comments." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "viewPages": { - "kind": "property", - "signature": "static readonly viewPages: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View pages in a Web site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "viewUsageData": { - "kind": "property", - "signature": "static readonly viewUsageData: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View reports on Web site usage." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "viewVersions": { - "kind": "property", - "signature": "static readonly viewVersions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View past versions of a list item or document." + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * The GUID identifier for this field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(internalName:instance)", + "docComment": "/**\n * The internal name of the field. This name is usually used to find the field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "internalName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "internalName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(isRequired:instance)", + "docComment": "/**\n * Whether the field is required for each list item in the list\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isRequired" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isRequired", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPSite": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the " - }, - { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It provides contextual information for the SharePoint site collection (\"SPSite\") that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPSite class." + "implementsTokenRanges": [] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "absoluteUrl": { - "kind": "property", - "signature": "readonly absoluteUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the absolute URL for this SPSite." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(SPList:class)", + "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPList` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Example: \"https://example.com/sites/PubSite\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "cdnPrefix": { - "kind": "property", - "signature": "readonly cdnPrefix: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the prefix of the application's specified cdn or an empty string if there isn't one." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "classification": { - "kind": "property", - "signature": "readonly classification: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the classification of the site." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "correlationId": { - "kind": "property", - "signature": "readonly correlationId: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the correlation id to the current server request." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "group": { - "kind": "property", - "signature": "readonly group: O365GroupAssociation | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "O365GroupAssociation | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID that identifies the SPSite on the server." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isNoScriptEnabled": { - "kind": "property", - "signature": "readonly isNoScriptEnabled: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if isNoScript has been enabled on the SPSite." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "recycleBinItemCount": { - "kind": "property", - "signature": "readonly recycleBinItemCount: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The amount of items in the recycle bin." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "readonly serverRelativeUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the server-relative URL for this SPSite." - } - ], - "remarks": [ + "kind": "Content", + "text": "export default class " + }, { - "kind": "text", - "text": "Example: \"/sites/PubSite\"" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serverRequestPath": { - "kind": "property", - "signature": "readonly serverRequestPath: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns serverRelativeUrl of the original request." - } - ], - "remarks": [ + "kind": "Reference", + "text": "SPList" + }, { - "kind": "text", - "text": "Example: \"/teams/SPClientTest/SitePages/Home.aspx\"" + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "sitePagesEnabled": { - "kind": "property", - "signature": "readonly sitePagesEnabled: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if SitePages are enabled on this SPSite." + "releaseTag": "Public", + "name": "SPList", + "members": [ + { + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(permissions:instance)", + "docComment": "/**\n * Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "permissions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "permissions", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(serverRelativeUrl:instance)", + "docComment": "/**\n * Returns the server-relative URL for this `SPList`.\n *\n * @remarks\n *\n * Example: \"/sites/PubSite\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "serverRelativeUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(title:instance)", + "docComment": "/**\n * Returns the title for this `SPList`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPTimeZone": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPTimeZone class." - }, - { - "kind": "paragraph" + "implementsTokenRanges": [] }, { - "kind": "code-box", - "text": "isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate\nLocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset)\nJune 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)\n", - "highlighter": "plain" - } - ], - "isBeta": true, - "isSealed": false, - "members": { - "daylightDate": { - "kind": "property", - "signature": "readonly daylightDate: ISPSystemTime;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ISPSystemTime", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the date on which daylight time begins for the time zone." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "daylightOffset": { - "kind": "property", - "signature": "readonly daylightOffset: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC)." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "readonly description: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the description for the time zone." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "readonly id: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the ID of the time zone." + "kind": "Class", + "canonicalReference": "(SPListItem:class)", + "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list item that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPListItem` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "SPListItem" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "offset": { - "kind": "property", - "signature": "readonly offset: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC)." + "releaseTag": "Public", + "name": "SPListItem", + "members": [ + { + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * The number that identifies the `SPListItem` on the server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] }, - "standardDate": { - "kind": "property", - "signature": "readonly standardDate: ISPSystemTime;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "ISPSystemTime", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the date on which standard time begins for the time zone." + { + "kind": "Class", + "canonicalReference": "(SPPermission:class)", + "docComment": "/**\n * Used to test whether the current user has a requested set of permissions.\n *\n * @remarks\n *\n * Specifies the built-in permissions available in SharePoint Foundation\n *\n * For more information, see: {@link https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "standardOffset": { - "kind": "property", - "signature": "readonly standardOffset: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC)." + "releaseTag": "Public", + "name": "SPPermission", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructs a new instance of the `SPPermission` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(" + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataBasePermission" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "(addAndCustomizePages:static)", + "docComment": "/**\n * Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "addAndCustomizePages" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "addAndCustomizePages", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(addDelPrivateWebParts:static)", + "docComment": "/**\n * Add or remove personal web parts on a web part Page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "addDelPrivateWebParts" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "addDelPrivateWebParts", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(addListItems:static)", + "docComment": "/**\n * Add items to lists, add documents to document libraries, and add Web discussion comments.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "addListItems" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "addListItems", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(applyStyleSheets:static)", + "docComment": "/**\n * Apply a style sheet (.css file) to the Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "applyStyleSheets" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "applyStyleSheets", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(applyThemeAndBorder:static)", + "docComment": "/**\n * Apply a theme or borders to the entire Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "applyThemeAndBorder" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "applyThemeAndBorder", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(approveItems:static)", + "docComment": "/**\n * Approve a minor version of a list item or document.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "approveItems" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "approveItems", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(browseDirectories:static)", + "docComment": "/**\n * Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "browseDirectories" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "browseDirectories", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(browserUserInfo:static)", + "docComment": "/**\n * View information about users of the Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "browserUserInfo" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "browserUserInfo", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(cancelCheckout:static)", + "docComment": "/**\n * Discard or check in a document which is checked out to another user.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "cancelCheckout" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cancelCheckout", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(createAlerts:static)", + "docComment": "/**\n * Create e-mail alerts.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "createAlerts" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createAlerts", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(createGroups:static)", + "docComment": "/**\n * Create a group of users that can be used anywhere within the site collection.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "createGroups" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createGroups", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(createSSCSite:static)", + "docComment": "/**\n * Create a Web site using Self-Service Site Creation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "createSSCSite" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createSSCSite", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(deleteListItems:static)", + "docComment": "/**\n * Delete items from a list, documents from a document library, and Web discussion comments in documents.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "deleteListItems" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "deleteListItems", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(deleteVersions:static)", + "docComment": "/**\n * Delete past versions of a list item or document.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "deleteVersions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "deleteVersions", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(editListItems:static)", + "docComment": "/**\n * Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "editListItems" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "editListItems", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(editMyUserInfo:static)", + "docComment": "/**\n * Allows a user to change his or her user information, such as adding a picture.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "editMyUserInfo" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "editMyUserInfo", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(emptyMask:static)", + "docComment": "/**\n * Has no permissions on the Web site. Not available through the user interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "emptyMask" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "emptyMask", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(enumeratePermissions:static)", + "docComment": "/**\n * Enumerate permissions on the Web site, list, folder, document, or list item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "enumeratePermissions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "enumeratePermissions", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(fullMask:static)", + "docComment": "/**\n * Has all permissions on the Web site. Not available through the user interface.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "fullMask" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fullMask", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Method", + "canonicalReference": "(hasAllPermissions:instance,0)", + "docComment": "/**\n * Function for testing whether a given permission mask has all of the requested permissions.\n *\n * @param requestedPerms - Any number of SPPermission objects to be compared against the original\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "hasAllPermissions" + }, + { + "kind": "Content", + "text": "(..." + }, + { + "kind": "Reference", + "text": "requestedPerms" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "requestedPerms", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 6 + } + } + ], + "name": "hasAllPermissions" + }, + { + "kind": "Method", + "canonicalReference": "(hasAnyPermissions:instance,0)", + "docComment": "/**\n * Function for testing whether a given permission mask has any of the requested permissions.\n *\n * @param requestedPerms - Any number of SPPermission objects to be compared against the original\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "hasAnyPermissions" + }, + { + "kind": "Content", + "text": "(..." + }, + { + "kind": "Reference", + "text": "requestedPerms" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "requestedPerms", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 6 + } + } + ], + "name": "hasAnyPermissions" + }, + { + "kind": "Method", + "canonicalReference": "(hasPermission:instance,0)", + "docComment": "/**\n * Function for testing whether a given permission mask has the requested permission.\n *\n * @param requestedPerm - The SPPermission object to be compared against the original\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "hasPermission" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "requestedPerm" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "requestedPerm", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "hasPermission" + }, + { + "kind": "Property", + "canonicalReference": "(layoutsPage:static)", + "docComment": "/**\n * View the layouts page?\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "layoutsPage" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "layoutsPage", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(manageAlerts:static)", + "docComment": "/**\n * Manage alerts for all users of the Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "manageAlerts" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageAlerts", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(manageLists:static)", + "docComment": "/**\n * Create and delete lists, add or remove columns in a list, and add or remove public views of a list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "manageLists" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageLists", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(managePermissions:static)", + "docComment": "/**\n * Create and change permission levels on the Web site and assign permissions to users and groups.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "managePermissions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "managePermissions", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(managePersonalViews:static)", + "docComment": "/**\n * Create, change, and delete personal views of lists.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "managePersonalViews" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "managePersonalViews", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(manageSubwebs:static)", + "docComment": "/**\n * Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "manageSubwebs" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageSubwebs", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(manageWeb:static)", + "docComment": "/**\n * Grant the ability to perform all administration tasks for the Web site as well as manage content.\n *\n * @remarks\n *\n * Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "manageWeb" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageWeb", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(open:static)", + "docComment": "/**\n * Allow users to open a Web site, list, or folder to access items inside that container.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "open" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "open", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(openItems:static)", + "docComment": "/**\n * View the source of documents with server-side file handlers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "openItems" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "openItems", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(updatePersonalWebParts:static)", + "docComment": "/**\n * Update web parts to display personalized information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "updatePersonalWebParts" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "updatePersonalWebParts", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(useClientIntegration:static)", + "docComment": "/**\n * Use features that launch client applications; otherwise, users must work on documents locally and upload changes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "useClientIntegration" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "useClientIntegration", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(useRemoteAPIs:static)", + "docComment": "/**\n * Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "useRemoteAPIs" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "useRemoteAPIs", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(value:instance)", + "docComment": "/**\n * Returns the value of this SPPermission object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "value" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IODataBasePermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(viewFormPages:static)", + "docComment": "/**\n * View forms, views, and application pages, and enumerate lists.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "viewFormPages" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewFormPages", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(viewListItems:static)", + "docComment": "/**\n * View items in lists, documents in document libraries, and view Web discussion comments.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "viewListItems" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewListItems", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(viewPages:static)", + "docComment": "/**\n * View pages in a Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "viewPages" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewPages", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(viewUsageData:static)", + "docComment": "/**\n * View reports on Web site usage.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "viewUsageData" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewUsageData", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "(viewVersions:static)", + "docComment": "/**\n * View past versions of a list item or document.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly " + }, + { + "kind": "Reference", + "text": "viewVersions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewVersions", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(SPSite:class)", + "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site collection (\"SPSite\") that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPSite` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "SPSite" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPSite", + "members": [ + { + "kind": "Property", + "canonicalReference": "(absoluteUrl:instance)", + "docComment": "/**\n * Returns the absolute URL for this SPSite.\n *\n * @remarks\n *\n * Example: \"https://example.com/sites/PubSite\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "absoluteUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "absoluteUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(cdnPrefix:instance)", + "docComment": "/**\n * Returns the prefix of the application's specified cdn or an empty string if there isn't one.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "cdnPrefix" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cdnPrefix", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(classification:instance)", + "docComment": "/**\n * Returns the classification of the site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "classification" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "classification", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(correlationId:instance)", + "docComment": "/**\n * Returns the correlation id to the current server request.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "correlationId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "correlationId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(group:instance)", + "docComment": "/**\n * Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "group" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "O365GroupAssociation" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "group", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * The GUID that identifies the SPSite on the server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(isNoScriptEnabled:instance)", + "docComment": "/**\n * Returns true if isNoScript has been enabled on the SPSite.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isNoScriptEnabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isNoScriptEnabled", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(recycleBinItemCount:instance)", + "docComment": "/**\n * The amount of items in the recycle bin.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "recycleBinItemCount" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "recycleBinItemCount", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(serverRelativeUrl:instance)", + "docComment": "/**\n * Returns the server-relative URL for this SPSite.\n *\n * @remarks\n *\n * Example: \"/sites/PubSite\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "serverRelativeUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(serverRequestPath:instance)", + "docComment": "/**\n * Returns serverRelativeUrl of the original request.\n *\n * @remarks\n *\n * Example: \"/teams/SPClientTest/SitePages/Home.aspx\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "serverRequestPath" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRequestPath", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(sitePagesEnabled:instance)", + "docComment": "/**\n * Returns true if SitePages are enabled on this SPSite.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "sitePagesEnabled" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sitePagesEnabled", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "(SPTimeZone:class)", + "docComment": "/**\n * It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula.\n *\n * @remarks\n * ```\n * isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate\n * LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset)\n * June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)\n * ```\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPTimeZone` class.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "SPTimeZone" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "SPTimeZone", + "members": [ + { + "kind": "Property", + "canonicalReference": "(daylightDate:instance)", + "docComment": "/**\n * Gets the date on which daylight time begins for the time zone.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "daylightDate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPSystemTime" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightDate", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(daylightOffset:instance)", + "docComment": "/**\n * Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "daylightOffset" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightOffset", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(description:instance)", + "docComment": "/**\n * Gets the description for the time zone.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * Gets the ID of the time zone.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(offset:instance)", + "docComment": "/**\n * Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "offset" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "offset", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(standardDate:instance)", + "docComment": "/**\n * Gets the date on which standard time begins for the time zone.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "standardDate" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISPSystemTime" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardDate", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(standardOffset:instance)", + "docComment": "/**\n * Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "standardOffset" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardOffset", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPUser": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the " - }, - { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It provides contextual information for the SharePoint user that is accessing the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPUser class." + "implementsTokenRanges": [] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "displayName": { - "kind": "property", - "signature": "readonly displayName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The display name for the current user." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(SPUser:class)", + "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user that is accessing the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPUser` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": "export default class " }, { - "kind": "code", - "text": "\"John Doe\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "email": { - "kind": "property", - "signature": "readonly email: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The email address for the current user." + "kind": "Reference", + "text": "SPUser" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "SPUser", + "members": [ + { + "kind": "Property", + "canonicalReference": "(displayName:instance)", + "docComment": "/**\n * The display name for the current user.\n *\n * @remarks\n *\n * Example: `\"John Doe\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "displayName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example: " + "kind": "Property", + "canonicalReference": "(email:instance)", + "docComment": "/**\n * The email address for the current user.\n *\n * @remarks\n *\n * Example: `\"example@contoso.com\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "email" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "email", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "\"example@contoso.com\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "firstDayOfWeek": { - "kind": "property", - "signature": "readonly firstDayOfWeek: SPDayOfWeek | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPDayOfWeek | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the user's regional first day of week setting or undefined if it hasn't been set." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isAnonymousGuestUser": { - "kind": "property", - "signature": "readonly isAnonymousGuestUser: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns if the current user is an anonymous guest." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isExternalGuestUser": { - "kind": "property", - "signature": "readonly isExternalGuestUser: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns true if the current user is an external guest." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "loginName": { - "kind": "property", - "signature": "readonly loginName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The login name for current user." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(firstDayOfWeek:instance)", + "docComment": "/**\n * Returns the user's regional first day of week setting or undefined if it hasn't been set.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "firstDayOfWeek" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPDayOfWeek" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "firstDayOfWeek", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example: on-premise user: " + "kind": "Property", + "canonicalReference": "(isAnonymousGuestUser:instance)", + "docComment": "/**\n * Returns if the current user is an anonymous guest.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isAnonymousGuestUser" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isAnonymousGuestUser", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "\"domain\\user\"", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(isExternalGuestUser:instance)", + "docComment": "/**\n * Returns true if the current user is an external guest.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isExternalGuestUser" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isExternalGuestUser", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": ", online user: " + "kind": "Property", + "canonicalReference": "(loginName:instance)", + "docComment": "/**\n * The login name for current user.\n *\n * @remarks\n *\n * Example: on-premise user: `\"domain\\user\"`, online user: `\"user@domain.com\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "loginName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "loginName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "\"user@domain.com\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "preferUserTimeZone": { - "kind": "property", - "signature": "readonly preferUserTimeZone: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This boolean represents if a the user or web's time zone settings should be used to display the current time." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "timeZoneInfo": { - "kind": "property", - "signature": "readonly timeZoneInfo: SPTimeZone | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPTimeZone | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the user's regional timezone settings or undefined if they haven't been set." + "kind": "Property", + "canonicalReference": "(preferUserTimeZone:instance)", + "docComment": "/**\n * This boolean represents if a the user or web's time zone settings should be used to display the current time.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "preferUserTimeZone" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "preferUserTimeZone", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(timeZoneInfo:instance)", + "docComment": "/**\n * Returns the user's regional timezone settings or undefined if they haven't been set.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "timeZoneInfo" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPTimeZone" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "timeZoneInfo", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "SPWeb": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This class is primarily used with the " - }, - { - "kind": "code", - "text": "PageContext", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " class. It provides contextual information for the SharePoint site (\"SPWeb\") that hosts the page." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPWeb class." + "implementsTokenRanges": [] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "absoluteUrl": { - "kind": "property", - "signature": "readonly absoluteUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the absolute URL for this SPWeb. Example: " - }, - { - "kind": "code", - "text": "\"https://example.com/sites/PubSite/SubWeb\"", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "readonly description: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the description of the current SPWeb." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "firstDayOfWeek": { - "kind": "property", - "signature": "readonly firstDayOfWeek: SPDayOfWeek | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPDayOfWeek | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the web's regional first day of week setting or undefined if it hasn't been set." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "readonly id: Guid;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The GUID that identifies the SPWeb on the server." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isAppWeb": { - "kind": "property", - "signature": "readonly isAppWeb: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ + "kind": "Class", + "canonicalReference": "(SPWeb:class)", + "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site (\"SPWeb\") that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPWeb` class.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Returns true if this " + "kind": "Content", + "text": "export default class " }, { - "kind": "code", - "text": "SPWeb", - "highlighter": "plain" + "kind": "Reference", + "text": "SPWeb" }, { - "kind": "text", - "text": " the container web for an " + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPWeb", + "members": [ + { + "kind": "Property", + "canonicalReference": "(absoluteUrl:instance)", + "docComment": "/**\n * Returns the absolute URL for this SPWeb. Example: `\"https://example.com/sites/PubSite/SubWeb\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "absoluteUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "absoluteUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "SPApp", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(description:instance)", + "docComment": "/**\n * Returns the description of the current SPWeb.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "language": { - "kind": "property", - "signature": "readonly language: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the locale identifier (LCID) for the default language of the website." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(firstDayOfWeek:instance)", + "docComment": "/**\n * Returns the web's regional first day of week setting or undefined if it hasn't been set.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "firstDayOfWeek" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPDayOfWeek" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "firstDayOfWeek", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example: 1033 represents the locale identifier for en-US." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "logoUrl": { - "kind": "property", - "signature": "readonly logoUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the absolute URL of the website logo." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(id:instance)", + "docComment": "/**\n * The GUID that identifies the SPWeb on the server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Guid" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example:" + "kind": "Property", + "canonicalReference": "(isAppWeb:instance)", + "docComment": "/**\n * Returns true if this `SPWeb` the container web for an `SPApp`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "isAppWeb" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isAppWeb", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": " https://example.com/sites/PubSite/SubWeb/logo.jpg", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "permissions": { - "kind": "property", - "signature": "readonly permissions: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "readonly serverRelativeUrl: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the server-relative URL for this SPWeb." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(language:instance)", + "docComment": "/**\n * Returns the locale identifier (LCID) for the default language of the website.\n *\n * @remarks\n *\n * Example: 1033 represents the locale identifier for en-US.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "language" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "language", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example: " + "kind": "Property", + "canonicalReference": "(logoUrl:instance)", + "docComment": "/**\n * Returns the absolute URL of the website logo.\n *\n * @remarks\n *\n * Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "logoUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "logoUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "\"/sites/PubSite/SubWeb\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "templateName": { - "kind": "property", - "signature": "readonly templateName: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the string representing the numeric identifier for the site definition or site template that was used to create the site." - } - ], - "remarks": [ + "kind": "Property", + "canonicalReference": "(permissions:instance)", + "docComment": "/**\n * Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "permissions" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPPermission" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "permissions", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(serverRelativeUrl:instance)", + "docComment": "/**\n * Returns the server-relative URL for this SPWeb.\n *\n * @remarks\n *\n * Example: `\"/sites/PubSite/SubWeb\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "serverRelativeUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, { - "kind": "text", - "text": "Example: " + "kind": "Property", + "canonicalReference": "(templateName:instance)", + "docComment": "/**\n * Returns the string representing the numeric identifier for the site definition or site template that was used to create the site.\n *\n * @remarks\n *\n * Example: `\"1\"` represents the team site template when creating a new site on SharePoint.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "templateName" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "templateName", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "code", - "text": "\"1\"", - "highlighter": "plain" + "kind": "Property", + "canonicalReference": "(timeZoneInfo:instance)", + "docComment": "/**\n * Returns the web's regional timezone settings or undefined if they haven't been set.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "timeZoneInfo" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPTimeZone" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "timeZoneInfo", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false }, { - "kind": "text", - "text": " represents the team site template when creating a new site on SharePoint." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "timeZoneInfo": { - "kind": "property", - "signature": "readonly timeZoneInfo: SPTimeZone | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPTimeZone | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the web's regional timezone settings or undefined if they haven't been set." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "title": { - "kind": "property", - "signature": "readonly title: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Returns the title of the current SPWeb." + "kind": "Property", + "canonicalReference": "(title:instance)", + "docComment": "/**\n * Returns the title of the current SPWeb.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "implementsTokenRanges": [] } - } + ] } - } + ] } diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index da59a94d..974272c1 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -1,8299 +1,7104 @@ { - "kind": "package", + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.1.8", + "schemaVersion": 1000 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-webpart-base", + "docComment": "/**\n * SharePoint Framework support for building web parts.\n *\n * @remarks\n *\n * This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual object that a page author can add to their content, and customize using a property pane. Examples of web parts include an embedded video player, a map, a group calendar, a chart, etc.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-webpart-base", - "summary": [ + "members": [ { - "kind": "text", - "text": "SharePoint Framework support for building web parts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual object that a page author can add to their content, and customize using a property pane. Examples of web parts include an embedded video player, a map, a group calendar, a chart, etc." - } - ], - "exports": { - "BaseClientSideWebPart": { - "kind": "class", - "extends": "BaseWebPart", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs to inherit from this class." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in two catagories." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API should be used to access contextual data relevant to this web part instance." - }, - { - "kind": "paragraph" - }, + "kind": "EntryPoint", + "canonicalReference": "", + "name": "", + "members": [ { - "kind": "text", - "text": "The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor();", - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Constructor for the BaseClientSideWebPart class." - } - ], - "remarks": [ + "kind": "Class", + "canonicalReference": "(BaseClientSideWebPart:class)", + "docComment": "/**\n * This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs to inherit from this class.\n *\n * @remarks\n *\n * Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in two catagories.\n *\n * The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API should be used to access contextual data relevant to this web part instance.\n *\n * The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "It is highly recommended that the web part use the " + "kind": "Content", + "text": "export default abstract class " }, { - "kind": "code", - "text": "onInit()", - "highlighter": "plain" + "kind": "Reference", + "text": "BaseClientSideWebPart" }, { - "kind": "text", - "text": " API to perform any web part specific initialization. Most of the web part features like this.context and " + "kind": "Content", + "text": "<" }, { - "kind": "code", - "text": "this.properties", - "highlighter": "plain" + "kind": "Reference", + "text": "TProperties" }, { - "kind": "text", - "text": " are not available to be used before the the " + "kind": "Content", + "text": "> extends " }, { - "kind": "code", - "text": "onInit()", - "highlighter": "plain" + "kind": "Reference", + "text": "BaseWebPart" }, { - "kind": "text", - "text": " part of the web part loading lifecycle." - } - ] - }, - "canOpenPopupOnRender": { - "kind": "property", - "signature": "protected readonly canOpenPopupOnRender: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property indicates whether a web part can open a popup on initial render." - } - ], - "remarks": [ - { - "kind": "text", - "text": "In some environments the host re-renders the web parts frequently, and therefore opening popups during render will cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages perform postbacks causing the page to re-render on all button clicks." + "kind": "Content", + "text": "<" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "TProperties" }, { - "kind": "text", - "text": "If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "clearError": { - "kind": "method", - "signature": "protected clearError(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to clear the error message from the web part display area." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "context": { - "kind": "property", - "signature": "protected readonly context: WebPartContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "WebPartContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "domElement": { - "kind": "property", - "signature": "protected readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part." + "kind": "Content", + "text": "> " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isRenderAsync": { - "kind": "property", - "signature": "protected readonly isRenderAsync: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the web part is rendering in Async mode." - } - ], - "remarks": [ + "releaseTag": "Public", + "name": "BaseClientSideWebPart", + "members": [ { - "kind": "text", - "text": "If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete." + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructor for the BaseClientSideWebPart class.\n *\n * @remarks\n *\n * It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor();" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [] }, { - "kind": "paragraph" + "kind": "Property", + "canonicalReference": "(canOpenPopupOnRender:instance)", + "docComment": "/**\n * This property indicates whether a web part can open a popup on initial render.\n *\n * @remarks\n *\n * In some environments the host re-renders the web parts frequently, and therefore opening popups during render will cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages perform postbacks causing the page to re-render on all button clicks.\n *\n * If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "canOpenPopupOnRender" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "canOpenPopupOnRender", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(clearError:instance,0)", + "docComment": "/**\n * This API should be used to clear the error message from the web part display area.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "clearError" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "clearError" + }, + { + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "WebPartContext" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(domElement:instance)", + "docComment": "/**\n * This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLElement" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false, - "isEventProperty": false - }, - "onDisplayModeChanged": { - "kind": "method", - "signature": "protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "oldDisplayMode": { - "name": "oldDisplayMode", - "description": [ + "kind": "Property", + "canonicalReference": "(isRenderAsync:instance)", + "docComment": "/**\n * Indicates whether the web part is rendering in Async mode.\n *\n * @remarks\n *\n * If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete.\n *\n * The default value is false.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "isRenderAsync" + }, { - "kind": "text", - "text": "The old display mode." + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "DisplayMode" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This event method is called when the display mode of a web part is changed." - } - ], - "remarks": [ + "releaseTag": "Public", + "name": "isRenderAsync", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(onDisplayModeChanged:instance,0)", + "docComment": "/**\n * This event method is called when the display mode of a web part is changed.\n *\n * @remarks\n *\n * The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode.\n *\n * @param oldDisplayMode - The old display mode.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onDisplayModeChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "oldDisplayMode" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "DisplayMode" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "oldDisplayMode", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "onDisplayModeChanged" + }, { - "kind": "text", - "text": "The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode." + "kind": "Method", + "canonicalReference": "(onDispose:instance,0)", + "docComment": "/**\n * This API should be used to refresh the contents of the PropertyPane.\n *\n * @remarks\n *\n * This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onDispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onDispose" + }, + { + "kind": "Method", + "canonicalReference": "(render:instance,0)", + "docComment": "/**\n * This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected abstract " + }, + { + "kind": "Reference", + "text": "render" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "render" + }, + { + "kind": "Method", + "canonicalReference": "(renderCompleted:instance,0)", + "docComment": "/**\n * This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "renderCompleted" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "renderCompleted" + }, + { + "kind": "Property", + "canonicalReference": "(renderedFromPersistedData:instance)", + "docComment": "/**\n * This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not.\n *\n * @remarks\n *\n * Example: When web part is added for the first time using toolbox then the value is false.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "renderedFromPersistedData" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "renderedFromPersistedData", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(renderedOnce:instance)", + "docComment": "/**\n * This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "renderedOnce" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "renderedOnce", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(renderError:instance,0)", + "docComment": "/**\n * This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger.\n *\n * @param error - An error object containing the error message to render.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "renderError" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "error" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Error" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "renderError" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false - }, - "onDispose": { - "kind": "method", - "signature": "protected onDispose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] + "extendsTokenRange": { + "startIndex": 5, + "endIndex": 9 }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API should be used to refresh the contents of the PropertyPane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": true, - "isOverride": false + "implementsTokenRanges": [] }, - "render": { - "kind": "method", - "signature": "protected abstract render(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Class", + "canonicalReference": "(BaseWebPart:class)", + "docComment": "/**\n * This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderCompleted": { - "kind": "method", - "signature": "protected renderCompleted(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "export default abstract class " + }, { - "kind": "text", - "text": "This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the " + "kind": "Reference", + "text": "BaseWebPart" }, { - "kind": "code", - "text": "render()", - "highlighter": "plain" + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": " API but the actual rendering is complete only after the iframe loading completes." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderedFromPersistedData": { - "kind": "property", - "signature": "protected readonly renderedFromPersistedData: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not." - } - ], - "remarks": [ + "kind": "Reference", + "text": "TProperties" + }, { - "kind": "text", - "text": "Example: When web part is added for the first time using toolbox then the value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "renderedOnce": { - "kind": "property", - "signature": "protected readonly renderedOnce: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "renderError": { - "kind": "method", - "signature": "protected renderError(error: Error): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "error": { - "name": "error", - "description": [ - { - "kind": "text", - "text": "An error object containing the error message to render." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Error" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": " extends {}> extends " + }, { - "kind": "text", - "text": "This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "BaseWebPart": { - "kind": "class", - "extends": "BaseComponent", - "implements": "IPropertyPaneConsumer", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "constructor();", - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "BaseComponent" + }, { - "kind": "text", - "text": "Constructor for the " + "kind": "Content", + "text": " " }, { - "kind": "code", - "text": "BaseWebPart", - "highlighter": "plain" + "kind": "Content", + "text": "implements " }, { - "kind": "text", - "text": " class." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPropertyPaneConsumer" + }, { - "kind": "text", - "text": "It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle." - } - ] - }, - "accessibleTitle": { - "kind": "property", - "signature": "protected readonly accessibleTitle: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "context": { - "kind": "property", - "signature": "protected readonly context: BaseWebPartContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "BaseWebPartContext", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Use the context object to access common services and state associated with the component." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "BaseWebPart", + "members": [ { - "kind": "text", - "text": "Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dataVersion": { - "kind": "property", - "signature": "protected readonly dataVersion: Version;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Version", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0" + "kind": "Constructor", + "canonicalReference": "(:constructor,0)", + "docComment": "/**\n * Constructor for the `BaseWebPart` class.\n *\n * @remarks\n *\n * It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor();" + } + ], + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [] + }, + { + "kind": "Property", + "canonicalReference": "(accessibleTitle:instance)", + "docComment": "/**\n * This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "accessibleTitle" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accessibleTitle", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(context:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "BaseWebPartContext" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(dataVersion:instance)", + "docComment": "/**\n * The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "dataVersion" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(description:instance)", + "docComment": "/**\n * Description of the WebPart\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(disableReactivePropertyChanges:instance)", + "docComment": "/**\n * This property is used to change the web part's property pane interaction from Reactive to NonReactive.\n *\n * @remarks\n *\n * The default behavior is Reactive.\n *\n * Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can see instant updates. This helps the page creator get instant feedback and decide if they should keep the new configuration changes or not.\n *\n * NonReactive implies that the configuration changes are transmitted to the web part only after \"Apply\" PropertyPane button is clicked.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "disableReactivePropertyChanges" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disableReactivePropertyChanges", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(displayMode:instance)", + "docComment": "/**\n * This property is the current display mode of the web part.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "displayMode" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "DisplayMode" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayMode", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "(getPropertyPaneConfiguration:instance,0)", + "docComment": "/**\n * This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the configuration for the PropertyPane.\n *\n * This API is not invoked until the 'loadPropertyPaneResources' promise is resolved.\n *\n * See IPropertyPane and other PropertyPane integration wiki documentation for more details.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "getPropertyPaneConfiguration" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneConfiguration" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "getPropertyPaneConfiguration" + }, + { + "kind": "Method", + "canonicalReference": "(onAfterDeserialize:instance,0)", + "docComment": "/**\n * This API is called after the web part is deserialized to an object, right before the property bag is populated.\n *\n * @remarks\n *\n * The default implementation is a no-op. A web part developer can override this API if the deserialized object does not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate the property bag right after the data is deserialized to an object.\n *\n * An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag.\n *\n * @param deserializedObject - The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the web part\n *\n * @param dataVersion - The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older web part. Web parts can define their data version by overriding the dataVersion property.\n *\n * @returns The property bag of the web part\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onAfterDeserialize" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "deserializedObject" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "dataVersion" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "deserializedObject", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "dataVersion", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "onAfterDeserialize" + }, + { + "kind": "Method", + "canonicalReference": "(onAfterPropertyPaneChangesApplied:instance,0)", + "docComment": "/**\n * This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onAfterPropertyPaneChangesApplied" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onAfterPropertyPaneChangesApplied" + }, + { + "kind": "Method", + "canonicalReference": "(onBeforeSerialize:instance,0)", + "docComment": "/**\n * This event method is called before the web part is serialized.\n *\n * @remarks\n *\n * The default implementation is a no-op. The serialization process serializes the web part property bag i.e. this.properties. This API gives the web part a chance to update it's property bag before the serialization happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onBeforeSerialize" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onBeforeSerialize" + }, + { + "kind": "Method", + "canonicalReference": "(onDisplayModeChanged:instance,0)", + "docComment": "/**\n * This event method is called when the display mode of a web part is changed.\n *\n * @remarks\n *\n * The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode.\n *\n * @param oldDisplayMode - The old display mode.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onDisplayModeChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "oldDisplayMode" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "DisplayMode" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "oldDisplayMode", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "onDisplayModeChanged" + }, + { + "kind": "Method", + "canonicalReference": "(onDispose:instance,0)", + "docComment": "/**\n * This API should be used to refresh the contents of the PropertyPane.\n *\n * @remarks\n *\n * This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onDispose" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onDispose" + }, + { + "kind": "Method", + "canonicalReference": "(onInit:instance,0)", + "docComment": "/**\n * This event method is called when the web part is initialized.\n *\n * @remarks\n *\n * This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onInit" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Reference", + "text": "Promise" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onInit" + }, + { + "kind": "Method", + "canonicalReference": "(onPropertyPaneConfigurationComplete:instance,0)", + "docComment": "/**\n * This API is invoked when the configuration is completed on the PropertyPane.\n *\n * @remarks\n *\n * This event method is invoked in the following cases:\n *\n * - When the CONFIGURATION_COMPLETE_TIMEOUT((currently the value is 5 secs) elapses after the last change.\n *\n * - When user clicks the \"X\" (close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses.\n *\n * - When user clicks the 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses.\n *\n * - When the user switches web parts then the current web part gets this event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onPropertyPaneConfigurationComplete" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onPropertyPaneConfigurationComplete" + }, + { + "kind": "Method", + "canonicalReference": "(onPropertyPaneConfigurationStart:instance,0)", + "docComment": "/**\n * This event method is invoked when the configuration starts on the PropertyPane.\n *\n * @remarks\n *\n * This event method is invoked in the following cases:\n *\n * - When the PropertyPane is opened.\n *\n * - When the user switches web parts then the new web part gets this event.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onPropertyPaneConfigurationStart" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onPropertyPaneConfigurationStart" + }, + { + "kind": "Method", + "canonicalReference": "(onPropertyPaneFieldChanged:instance,0)", + "docComment": "/**\n * This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode.\n *\n * @param propertyPath - JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of `__CustomField_`.\n *\n * @param oldValue - Old value of the property. This value could be undefined/empty in the case of custom field.\n *\n * @param newValue - New value of the property. This value could be undefined/empty in the case of custom field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onPropertyPaneFieldChanged" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "propertyPath" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "oldValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "newValue" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "propertyPath", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "oldValue", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + }, + { + "parameterName": "newValue", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + } + } + ], + "name": "onPropertyPaneFieldChanged" + }, + { + "kind": "Method", + "canonicalReference": "(onPropertyPaneRendered:instance,0)", + "docComment": "/**\n * This API is invoked when the PropertyPane is rendered.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected " + }, + { + "kind": "Reference", + "text": "onPropertyPaneRendered" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "onPropertyPaneRendered" + }, + { + "kind": "Property", + "canonicalReference": "(previewImageUrl:instance)", + "docComment": "/**\n * This property points to the preview image for the web part. The base implementation returns undefined. Web parts that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "previewImageUrl" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "previewImageUrl", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(properties:instance)", + "docComment": "/**\n * This property is the pointer to the custom property bag of the web part.\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(propertiesMetadata:instance)", + "docComment": "/**\n * This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data.\n *\n * @remarks\n *\n * See {@link IWebPartPropertiesMetadata} for more information about how to define metadata\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "propertiesMetadata" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IWebPartPropertiesMetadata" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertiesMetadata", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(title:instance)", + "docComment": "/**\n * Title of the WebPart\n *\n * @readonly\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly " + }, + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "implementsTokenRanges": [ + { + "startIndex": 8, + "endIndex": 10 + } + ] + }, + { + "kind": "Class", + "canonicalReference": "(BaseWebPartContext:class)", + "docComment": "/**\n * Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client.\n *\n * This base is to be extended by UI-specific WebPart's base.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseWebPartContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "BaseWebPartContext" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "BaseComponentContext" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "BaseWebPartContext", + "members": [ + { + "kind": "Property", + "canonicalReference": "(formFactor:instance)", + "docComment": "/**\n * Form factor of the web part.\n *\n * @remarks\n *\n * Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "formFactor" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "WebPartFormFactor" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "formFactor", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(manifest:instance)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "manifest" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartManifestInstance" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(propertyPane:instance)", + "docComment": "/**\n * Accessor for common web part property pane operations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "propertyPane" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IPropertyPaneAccessor" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyPane", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(webPartTag:instance)", + "docComment": "/**\n * Web part tag to be used for logging and telemetry.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "webPartTag" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webPartTag", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "(DynamicDataSharedDepth:enum)", + "docComment": "/**\n * Enum for the possible values of shared depth of the dynamic data reference.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum " + }, + { + "kind": "Reference", + "text": "DynamicDataSharedDepth" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DynamicDataSharedDepth", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "None", + "docComment": "/**\n * Indicates that nothing is shared.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "None" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "None", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Property", + "docComment": "/**\n * Indicates that both the dynamic data source and the property are shared.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Property" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Property", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Source", + "docComment": "/**\n * Indicates that the dynamic data source is shared.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Source" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Source", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IClientSideWebPartStatusRenderer:interface)", + "docComment": "/**\n * Interface to be implemented by a component that should display the loading indicator and error messages for a web part.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default interface " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartStatusRenderer" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IClientSideWebPartStatusRenderer", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(clearError:0)", + "docComment": "/**\n * Clear the webpart error message.\n *\n * @param domElement - the web part container div.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clearError" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLElement" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "clearError" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(clearLoadingIndicator:0)", + "docComment": "/**\n * Clear the loading indicator.\n *\n * @param domElement - the web part container div.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "clearLoadingIndicator" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Element" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "name": "clearLoadingIndicator" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(displayLoadingIndicator:0)", + "docComment": "/**\n * Display a loading spinner.\n *\n * @param domElement - the web part container div.\n *\n * @param loadingMessage - the message to be displayed when the loading spinner id displayed.\n *\n * @param timeout - timeout to render the loading indicator. Default is 1500ms.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "displayLoadingIndicator" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Element" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "loadingMessage" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "timeout" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "loadingMessage", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + } + }, + { + "parameterName": "timeout", + "parameterTypeTokenRange": { + "startIndex": 12, + "endIndex": 13 + } + } + ], + "name": "displayLoadingIndicator" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(renderError:0)", + "docComment": "/**\n * Render the provided error message in the webpart container div.\n *\n * @param domElement - the web part container div.\n *\n * @param error - the error message.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "renderError" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLElement" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "error" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Error" + }, + { + "kind": "Content", + "text": " | string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + } + } + ], + "name": "renderError" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataSharedPropertyConfiguration:interface)", + "docComment": "/**\n * Configuration related to a shared property.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyConfiguration" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedPropertyConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataSharedPropertyFilters:interface)", + "docComment": "/**\n * Property pane dynamic data property filters.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyFilters" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyFilters" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedPropertyFilters", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataSharedSourceConfiguration:interface)", + "docComment": "/**\n * Configuration related to a shared source.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceConfiguration" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceConfiguration" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedSourceConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IDynamicDataSharedSourceFilters:interface)", + "docComment": "/**\n * Property pane dynamic data source filters.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceFilters" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceFilters" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedSourceFilters", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IMicrosoftTeams:interface)", + "docComment": "/**\n * Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IMicrosoftTeams" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IMicrosoftTeams", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "context", + "docComment": "/**\n * Microsoft Teams Context.\n * {@inheritDoc @microsoft/teams-js#Context}\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "context" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "microsoftTeams" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "Context" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "teamsJs", + "docComment": "/**\n * Microsoft Teams SDK.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "teamsJs" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "microsoftTeams" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "teamsJs", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneAccessor:interface)", + "docComment": "/**\n * Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneAccessor" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneAccessor", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "(close:0)", + "docComment": "/**\n * This API should be used to close the PropertyPane to help configure the web part.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "close" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "close" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(isPropertyPaneOpen:0)", + "docComment": "/**\n * Returns true if the PropertyPane is open.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isPropertyPaneOpen" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "isPropertyPaneOpen" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(isRenderedByWebPart:0)", + "docComment": "/**\n * Indicates whether the PropertyPane was initially opened by the web part.\n *\n * @remarks\n *\n * For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isRenderedByWebPart" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "isRenderedByWebPart" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(open:0)", + "docComment": "/**\n * This API should be used to open the PropertyPane to help configure the web part.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "open" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "open" + }, + { + "kind": "MethodSignature", + "canonicalReference": "(refresh:0)", + "docComment": "/**\n * This API should be used to invoke the PropertyPane to help configure the web part.\n *\n * @remarks\n *\n * This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "refresh" + }, + { + "kind": "Content", + "text": "(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "refresh" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneButtonProps:interface)", + "docComment": "/**\n * PropertyPane button props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "releaseTag": "Public", + "name": "IPropertyPaneButtonProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] }, - "description": { - "kind": "property", - "signature": "protected readonly description: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Description of the WebPart" + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneCheckboxProps:interface)", + "docComment": "/**\n * PropertyPane CheckBox component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "releaseTag": "Public", + "name": "IPropertyPaneCheckboxProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] }, - "disableReactivePropertyChanges": { - "kind": "property", - "signature": "protected readonly disableReactivePropertyChanges: boolean;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is used to change the web part's property pane interaction from Reactive to NonReactive." + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneChoiceGroupOption:interface)", + "docComment": "/**\n * PropertyPane ChoiceGroup option props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOption" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOption" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupOption", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [ + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneChoiceGroupOptionIconProps:interface)", + "docComment": "/**\n * PropertyPane ChoiceGroup icon props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOptionIconProps" + }, { - "kind": "text", - "text": "The default behavior is Reactive." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can see instant updates. This helps the page creator get instant feedback and decide if they should keep the new configuration changes or not." + "kind": "Content", + "text": "." }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOptionIconProps" }, { - "kind": "text", - "text": "NonReactive implies that the configuration changes are transmitted to the web part only after \"Apply\" PropertyPane button is clicked." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "displayMode": { - "kind": "property", - "signature": "protected readonly displayMode: DisplayMode;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "DisplayMode", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is the current display mode of the web part." + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupOptionIconProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "getPropertyPaneConfiguration": { - "kind": "method", - "signature": "protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IPropertyPaneConfiguration", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneChoiceGroupProps:interface)", + "docComment": "/**\n * PropertyPane ChoiceGroup props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps" + }, { - "kind": "text", - "text": "This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the configuration for the PropertyPane." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "This API is not invoked until the 'loadPropertyPaneResources' promise is resolved." + "kind": "Content", + "text": "." }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps" }, { - "kind": "text", - "text": "See IPropertyPane and other PropertyPane integration wiki documentation for more details." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] }, - "onAfterDeserialize": { - "kind": "method", - "signature": "protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "TProperties", - "description": [ - { - "kind": "text", - "text": "The property bag of the web part" - } - ] - }, - "parameters": { - "deserializedObject": { - "name": "deserializedObject", - "description": [ - { - "kind": "text", - "text": "The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the web part" - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneConditionalGroup:interface)", + "docComment": "/**\n * Property pane conditional group.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " }, - "dataVersion": { - "name": "dataVersion", - "description": [ - { - "kind": "text", - "text": "The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older web part. Web parts can define their data version by overriding the dataVersion property." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Version" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "This API is called after the web part is deserialized to an object, right before the property bag is populated." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPropertyPaneConditionalGroup" + }, { - "kind": "text", - "text": "The default implementation is a no-op. A web part developer can override this API if the deserialized object does not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate the property bag right after the data is deserialized to an object." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use " + "kind": "Content", + "text": "." }, { - "kind": "code", - "text": "onAfterDeserialize", - "highlighter": "plain" + "kind": "Reference", + "text": "IPropertyPaneConditionalGroup" }, { - "kind": "text", - "text": " to check the dataVersion and fix the property bag." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onAfterPropertyPaneChangesApplied": { - "kind": "method", - "signature": "protected onAfterPropertyPaneChangesApplied(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "IPropertyPaneConditionalGroup", + "members": [], + "extendsTokenRanges": [ { - "kind": "text", - "text": "This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode." + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] }, - "onBeforeSerialize": { - "kind": "method", - "signature": "protected onBeforeSerialize(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneConfiguration:interface)", + "docComment": "/**\n * Web part configuration settings\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This event method is called before the web part is serialized." - } - ], - "remarks": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "The default implementation is a no-op. The serialization process serializes the web part property bag i.e. this.properties. This API gives the web part a chance to update it's property bag before the serialization happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDisplayModeChanged": { - "kind": "method", - "signature": "protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "oldDisplayMode": { - "name": "oldDisplayMode", - "description": [ - { - "kind": "text", - "text": "The old display mode." - } - ], - "isOptional": false, - "isSpread": false, - "type": "DisplayMode" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "IPropertyPaneConfiguration" + }, { - "kind": "text", - "text": "This event method is called when the display mode of a web part is changed." - } - ], - "remarks": [ + "kind": "Content", + "text": " extends " + }, { - "kind": "text", - "text": "The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onDispose": { - "kind": "method", - "signature": "protected onDispose(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "SPPropertyPane" + }, { - "kind": "text", - "text": "This API should be used to refresh the contents of the PropertyPane." - } - ], - "remarks": [ + "kind": "Content", + "text": "." + }, { - "kind": "text", - "text": "This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onInit": { - "kind": "method", - "signature": "protected onInit(): Promise;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "IPropertyPaneConfiguration" + }, { - "kind": "text", - "text": "This event method is called when the web part is initialized." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "IPropertyPaneConfiguration", + "members": [], + "extendsTokenRanges": [ { - "kind": "text", - "text": "This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part." + "startIndex": 3, + "endIndex": 7 } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false + ] }, - "onPropertyPaneConfigurationComplete": { - "kind": "method", - "signature": "protected onPropertyPaneConfigurationComplete(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneCustomFieldProps:interface)", + "docComment": "/**\n * PropertyPane CustomPropertyField props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This API is invoked when the configuration is completed on the PropertyPane." - } - ], - "remarks": [ + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, { - "kind": "text", - "text": "This event method is invoked in the following cases:" + "kind": "Content", + "text": "." }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps" }, { - "kind": "text", - "text": "- When the CONFIGURATION_COMPLETE_TIMEOUT((currently the value is 5 secs) elapses after the last change." + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneCustomFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDropdownCalloutProps:interface)", + "docComment": "/**\n * PropertyPane dropdown callout properties.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDropdownCalloutProps" }, { - "kind": "text", - "text": "- When user clicks the \"X\" (close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "- When user clicks the 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses." + "kind": "Content", + "text": "." }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDropdownCalloutProps" }, { - "kind": "text", - "text": "- When the user switches web parts then the current web part gets this event." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneConfigurationStart": { - "kind": "method", - "signature": "protected onPropertyPaneConfigurationStart(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "IPropertyPaneDropdownCalloutProps", + "members": [], + "extendsTokenRanges": [ { - "kind": "text", - "text": "This event method is invoked when the configuration starts on the PropertyPane." + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [ + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDropdownOption:interface)", + "docComment": "/**\n * PropertyPane drop down options.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This event method is invoked in the following cases:" + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDropdownOption" }, { - "kind": "text", - "text": "- When the PropertyPane is opened." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "- When the user switches web parts then the new web part gets this event." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneFieldChanged": { - "kind": "method", - "signature": "protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "propertyPath": { - "name": "propertyPath", - "description": [ - { - "kind": "text", - "text": "JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of " - }, - { - "kind": "code", - "text": "__CustomField_", - "highlighter": "plain" - }, - { - "kind": "text", - "text": "." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" + "kind": "Content", + "text": "." }, - "oldValue": { - "name": "oldValue", - "description": [ - { - "kind": "text", - "text": "Old value of the property. This value could be undefined/empty in the case of custom field." - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" + { + "kind": "Reference", + "text": "IPropertyPaneDropdownOption" }, - "newValue": { - "name": "newValue", - "description": [ - { - "kind": "text", - "text": "New value of the property. This value could be undefined/empty in the case of custom field." - } - ], - "isOptional": false, - "isSpread": false, - "type": "any" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "onPropertyPaneRendered": { - "kind": "method", - "signature": "protected onPropertyPaneRendered(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "IPropertyPaneDropdownOption", + "members": [], + "extendsTokenRanges": [ { - "kind": "text", - "text": "This API is invoked when the PropertyPane is rendered." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "previewImageUrl": { - "kind": "property", - "signature": "protected readonly previewImageUrl: string | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property points to the preview image for the web part. The base implementation returns undefined. Web parts that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present." + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "properties": { - "kind": "property", - "signature": "protected readonly properties: TProperties;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "TProperties", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property is the pointer to the custom property bag of the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "propertiesMetadata": { - "kind": "property", - "signature": "protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IWebPartPropertiesMetadata | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data." - } - ], - "remarks": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDropdownProps:interface)", + "docComment": "/**\n * PropertyPane drop down component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "See " + "kind": "Content", + "text": "export interface " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "IWebPartPropertiesMetadata" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "IWebPartPropertiesMetadata", - "memberName": "" - } + "kind": "Reference", + "text": "IPropertyPaneDropdownProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." }, { - "kind": "text", - "text": " for more information about how to define metadata" + "kind": "Reference", + "text": "IPropertyPaneDropdownProps" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "title": { - "kind": "property", - "signature": "protected readonly title: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Title of the WebPart" + "releaseTag": "Public", + "name": "IPropertyPaneDropdownProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "BaseWebPartContext": { - "kind": "class", - "extends": "BaseComponentContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "This base is to be extended by UI-specific WebPart's base." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseWebPartContext class." + ] }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "formFactor": { - "kind": "property", - "signature": "readonly formFactor: WebPartFormFactor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "WebPartFormFactor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Form factor of the web part." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDynamicFieldFilters:interface)", + "docComment": "/**\n * Property pane dynamic field filters which is an intersection of both source and property filters.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideWebPartManifestInstance;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartManifestInstance", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client-side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "propertyPane": { - "kind": "property", - "signature": "readonly propertyPane: IPropertyPaneAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IPropertyPaneAccessor", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Accessor for common web part property pane operations." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "webPartTag": { - "kind": "property", - "signature": "readonly webPartTag: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part tag to be used for logging and telemetry." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "DynamicDataSharedDepth": { - "kind": "enum", - "values": { - "None": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that nothing is shared." + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldFilters" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldFilters" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false - }, - "Property": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that both the dynamic data source and the property are shared." + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldFilters", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false + ] }, - "Source": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates that the dynamic data source is shared." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enum for the possible values of shared depth of the dynamic data reference." - } - ], - "remarks": [], - "isBeta": false - }, - "IClientSideWebPartStatusRenderer": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Interface to be implemented by a component that should display the loading indicator and error messages for a web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "clearError": { - "kind": "method", - "signature": "clearError(domElement: HTMLElement): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "HTMLElement" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDynamicFieldProps:interface)", + "docComment": "/**\n * PropertyPaneDynamicField props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Clear the webpart error message." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "clearLoadingIndicator": { - "kind": "method", - "signature": "clearLoadingIndicator(domElement: Element): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Element" - } - }, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "Clear the loading indicator." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "displayLoadingIndicator": { - "kind": "method", - "signature": "displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Element" + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps" }, - "loadingMessage": { - "name": "loadingMessage", - "description": [ - { - "kind": "text", - "text": "the message to be displayed when the loading spinner id displayed." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" + { + "kind": "Content", + "text": " extends " }, - "timeout": { - "name": "timeout", - "description": [ - { - "kind": "text", - "text": "timeout to render the loading indicator. Default is 1500ms." - } - ], - "isOptional": true, - "isSpread": false, - "type": "number" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Display a loading spinner." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "renderError": { - "kind": "method", - "signature": "renderError(domElement: HTMLElement, error: Error | string): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "domElement": { - "name": "domElement", - "description": [ - { - "kind": "text", - "text": "the web part container div." - } - ], - "isOptional": false, - "isSpread": false, - "type": "HTMLElement" + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps" }, - "error": { - "name": "error", - "description": [ - { - "kind": "text", - "text": "the error message." - } - ], - "isOptional": false, - "isSpread": false, - "type": "Error | string" - } - }, - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Render the provided error message in the webpart container div." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IDynamicDataSharedPropertyConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration related to a shared property." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "filters": { - "kind": "property", - "signature": "filters?: IDynamicDataSharedPropertyFilters;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IDynamicDataSharedPropertyFilters", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Filters for the shared property." + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataSharedPropertyFilters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ + ] + }, { - "kind": "text", - "text": "Property pane dynamic data property filters." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "propertyId": { - "kind": "property", - "signature": "propertyId?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Property Id" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Usage: Use this filter when the author can only to connect to a specific property from the selected source." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDynamicFieldSetProps:interface)", + "docComment": "/**\n * PropertyPane DynamicFieldSet props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the dynamic data widget." + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps" }, { - "kind": "text", - "text": "When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataSharedSourceConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration related to a shared source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "filters": { - "kind": "property", - "signature": "filters?: IDynamicDataSharedSourceFilters;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IDynamicDataSharedSourceFilters", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Filters for the shared source." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "sourcesLabel": { - "kind": "property", - "signature": "sourcesLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, { - "kind": "text", - "text": "User-friendly, localized label for the sources dropdown." + "kind": "Content", + "text": "." }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps" }, { - "kind": "text", - "text": "default value - 'Connect to source'" + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IDynamicDataSharedSourceFilters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Property pane dynamic data source filters." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "componentId": { - "kind": "property", - "signature": "componentId?: Guid;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "Guid", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Component Id." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Usage: Use this filter when the author should only be able to connect to a specific type of source." + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldSetProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [ + ] + }, + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneDynamicTextFieldProps:interface)", + "docComment": "/**\n * `PropertyPaneDynamicData` component props.\n *\n * @deprecated\n *\n * - This has been replaced by IPropertyPaneDynamicFieldProps\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic data widget." + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps" }, { - "kind": "text", - "text": "When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources matching the given component id." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources." + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "releaseTag": "Beta", + "name": "IPropertyPaneDynamicTextFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 + } + ] }, - "sourceId": { - "kind": "property", - "signature": "sourceId?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneField:interface)", + "docComment": "/**\n * PropertyPane field.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Source Id" + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "text", - "text": "Usage: Use this filter, when the author can only to connect to a specific data source." - } - ], - "remarks": [ + "kind": "Content", + "text": "<" + }, { - "kind": "text", - "text": "This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the dynamic data widget." + "kind": "Reference", + "text": "TProperties" }, { - "kind": "paragraph" + "kind": "Content", + "text": "> extends " }, { - "kind": "text", - "text": "When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is pre-selected, the control will be disabled to ensure that authors can not change it." + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "paragraph" + "kind": "Content", + "text": "." }, { - "kind": "text", - "text": "The source id for a web part will be of the form WebPart." + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "html-tag", - "token": "" + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": "." + "kind": "Reference", + "text": "TProperties" }, { - "kind": "html-tag", - "token": "" + "kind": "Content", + "text": "> " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPlaceholderSpinnerProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Interface for properties used to display the loading spinner in the web part display area." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "hideSpinner": { - "kind": "property", - "signature": "hideSpinner?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner" + "releaseTag": "Public", + "name": "IPropertyPaneField", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 5, + "endIndex": 11 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label associated with the spinner." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneAccessor": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "close": { - "kind": "method", - "signature": "close(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Interface", + "canonicalReference": "(IPropertyPaneGroup:interface)", + "docComment": "/**\n * PropertyPane group. Group is part of the PropertyPanePage.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This API should be used to close the PropertyPane to help configure the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isPropertyPaneOpen": { - "kind": "method", - "signature": "isPropertyPaneOpen(): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "Returns true if the PropertyPane is open." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "isRenderedByWebPart": { - "kind": "method", - "signature": "isRenderedByWebPart(): boolean;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "boolean", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "IPropertyPaneGroup" + }, { - "kind": "text", - "text": "Indicates whether the PropertyPane was initially opened by the web part." - } - ], - "remarks": [ + "kind": "Content", + "text": " extends " + }, { - "kind": "text", - "text": "For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "open": { - "kind": "method", - "signature": "open(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Reference", + "text": "SPPropertyPane" + }, { - "kind": "text", - "text": "This API should be used to open the PropertyPane to help configure the web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - }, - "refresh": { - "kind": "method", - "signature": "refresh(): void;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ + "kind": "Content", + "text": "." + }, { - "kind": "text", - "text": "This API should be used to invoke the PropertyPane to help configure the web part." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPropertyPaneGroup" + }, { - "kind": "text", - "text": "This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IPropertyPaneButtonProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane button props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaDescription": { - "kind": "property", - "signature": "ariaDescription?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Detailed description of the button for the benefit of screen readers." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Besides the compound button, other button types will need more information provided to screen reader." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The aria label of the button for the benefit of screen readers." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "buttonType": { - "kind": "property", - "signature": "buttonType?: PropertyPaneButtonType;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "PropertyPaneButtonType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The type of button to render. Default value is ButtonType.normal." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Description of the action this button takes. Only used for compound buttons." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the button is disabled." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "icon": { - "kind": "property", - "signature": "icon?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The button icon shown in command or hero type." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onClick": { - "kind": "property", - "signature": "onClick: (value: any) => any;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "(value: any) => any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props." + "releaseTag": "Public", + "name": "IPropertyPaneGroup", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display text of the element." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneCheckboxProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "PropertyPane CheckBox component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "checked": { - "kind": "property", - "signature": "checked?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane checkbox is checked or not." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(IPropertyPaneLabelProps:interface)", + "docComment": "/**\n * PropertyPaneLabel component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps" + }, + { + "kind": "Content", + "text": " extends " + }, { - "kind": "text", - "text": "The default value is false." + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane checkbox is disabled or not." + "releaseTag": "Public", + "name": "IPropertyPaneLabelProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "text": { - "kind": "property", - "signature": "text?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label to display next to the checkbox." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneChoiceGroupOption": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "PropertyPane ChoiceGroup option props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "checked": { - "kind": "property", - "signature": "checked?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane choice group option is checked or not." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Default value is false." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane choice group option is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "iconProps": { - "kind": "property", - "signature": "iconProps?: IPropertyPaneChoiceGroupOptionIconProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneChoiceGroupOptionIconProps", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The Icon component props for choice field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "imageSize": { - "kind": "property", - "signature": "imageSize?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n width: number;\n height: number;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The width and height of the image in px for choice field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "imageSrc": { - "kind": "property", - "signature": "imageSrc?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The src of image for choice field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "key": { - "kind": "property", - "signature": "key: string | number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A required key to uniquely identify the option." + "kind": "Interface", + "canonicalReference": "(IPropertyPaneLinkProps:interface)", + "docComment": "/**\n * PropertyPaneLink component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "selectedImageSrc": { - "kind": "property", - "signature": "selectedImageSrc?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The src of image for choice field which is selected." + "releaseTag": "Public", + "name": "IPropertyPaneLinkProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The text string for the option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneChoiceGroupOptionIconProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "PropertyPane ChoiceGroup icon props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "officeFabricIconFontName": { - "kind": "property", - "signature": "officeFabricIconFontName?: string | null;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string | null", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The name of the icon to use from the Office Fabric icon set." + "kind": "Interface", + "canonicalReference": "(IPropertyPanePage:interface)", + "docComment": "/**\n * PropertyPanePage interface.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPanePage" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPanePage" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneChoiceGroupProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Descriptive label for the choice group." + "releaseTag": "Public", + "name": "IPropertyPanePage", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "options": { - "kind": "property", - "signature": "options: IPropertyPaneChoiceGroupOption[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneChoiceGroupOption[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The options for the choice group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneConditionalGroup": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Property pane conditional group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "onShowPrimaryGroup": { - "kind": "property", - "signature": "onShowPrimaryGroup?: () => void;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "() => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Callback when user clicks to show primary group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onShowSecondaryGroup": { - "kind": "property", - "signature": "onShowSecondaryGroup?: () => void;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "() => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Callback when user clicks to show secondary group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "primaryGroup": { - "kind": "property", - "signature": "primaryGroup: IPropertyPaneGroup;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneGroup", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Primary group to show" + "kind": "Interface", + "canonicalReference": "(IPropertyPanePageHeader:interface)", + "docComment": "/**\n * PropertyPane header. This header remains same for all the pages.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPanePageHeader" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, + { + "kind": "Reference", + "text": "IPropertyPanePageHeader" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "secondaryGroup": { - "kind": "property", - "signature": "secondaryGroup: IPropertyPaneGroup;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneGroup", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Secondary group to show" + "releaseTag": "Public", + "name": "IPropertyPanePageHeader", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "showSecondaryGroup": { - "kind": "property", - "signature": "showSecondaryGroup: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicating whether the property pane should show primary group or the secondary group." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Web part configuration settings" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "currentPage": { - "kind": "property", - "signature": "currentPage?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Page to be displayed on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "loadingIndicatorDelayTime": { - "kind": "property", - "signature": "loadingIndicatorDelayTime?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Number of milliseconds to be delayed before the loading indicator is shown on the property pane." - } - ], - "remarks": [ + "kind": "Interface", + "canonicalReference": "(IPropertyPaneSliderProps:interface)", + "docComment": "/**\n * PropertyPaneSliderProps component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, + { + "kind": "Content", + "text": "." + }, { - "kind": "text", - "text": "The default value is 500." + "kind": "Reference", + "text": "IPropertyPaneSliderProps" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "pages": { - "kind": "property", - "signature": "pages: IPropertyPanePage[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPanePage[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Total number of pages on the PropertyPane." + "releaseTag": "Public", + "name": "IPropertyPaneSliderProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "showLoadingIndicator": { - "kind": "property", - "signature": "showLoadingIndicator?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the loading indicator should be displayed on top of the property pane or not." - } - ], - "remarks": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneTextFieldProps:interface)", + "docComment": "/**\n * PropertyPaneTextField component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "SPPropertyPane" + }, { - "kind": "text", - "text": "This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator property)." + "kind": "Content", + "text": "." }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps" }, { - "kind": "text", - "text": "The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user." + "kind": "Content", + "text": " " } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneCustomFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane CustomPropertyField props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "context": { - "kind": "property", - "signature": "context?: any;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information." + "releaseTag": "Public", + "name": "IPropertyPaneTextFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "key": { - "kind": "property", - "signature": "key: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IPropertyPaneToggleProps:interface)", + "docComment": "/**\n * PropertyPaneToggle component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "An UNIQUE key indicates the identity of this contorl." + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneToggleProps" }, { - "kind": "text", - "text": "The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how to pick the value of the key." + "kind": "Content", + "text": " extends " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "SPPropertyPane" }, { - "kind": "text", - "text": "For more information, see the " + "kind": "Content", + "text": "." }, { - "kind": "web-link", - "elements": [ - { - "kind": "text", - "text": "React documentation" - } - ], - "targetUrl": "https://facebook.github.io/react/docs/lists-and-keys.html#keys" + "kind": "Reference", + "text": "IPropertyPaneToggleProps" }, { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onDispose": { - "kind": "property", - "signature": "onDispose?: (domElement: HTMLElement, context?: any) => void;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(domElement: HTMLElement, context?: any) => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API is called when the component is unmounted from the host element." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onRender": { - "kind": "property", - "signature": "onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "(domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API will be called once the custom field is mounted on the host element." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneDropdownCalloutProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane dropdown callout properties." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "calloutMaxHeight": { - "kind": "property", - "signature": "calloutMaxHeight?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Set max height of callout When not set the callout will expand with contents up to the bottom of the screen" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneDropdownOption": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane drop down options." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "index": { - "kind": "property", - "signature": "index?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Index for this option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "key": { - "kind": "property", - "signature": "key: string | number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key to uniquely identify this option." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Text to render for this option." + "releaseTag": "Public", + "name": "IPropertyPaneToggleProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 3, + "endIndex": 7 } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "type": { - "kind": "property", - "signature": "type?: PropertyPaneDropdownOptionType;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "PropertyPaneDropdownOptionType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneDropdownProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "PropertyPane drop down component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A description of the dropdown for the benefit of screen reader users." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ariaPositionInSet": { - "kind": "property", - "signature": "ariaPositionInSet?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "ariaSetSize": { - "kind": "property", - "signature": "ariaSetSize?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Defines the number of items in the current set of controls. Maps to native aria-setsize attribute." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "calloutProps": { - "kind": "property", - "signature": "calloutProps?: IPropertyPaneDropdownCalloutProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneDropdownCalloutProps", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom properties for Dropdown's Callout used to render options." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane dropdown option is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Descriptive label for the Dropdown." + "kind": "Interface", + "canonicalReference": "(ISDKs:interface)", + "docComment": "/**\n * Conditional set of SDKs provided by SPFx dependent on the environment.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface " + }, + { + "kind": "Reference", + "text": "ISDKs" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "options": { - "kind": "property", - "signature": "options?: IPropertyPaneDropdownOption[];", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneDropdownOption[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Collection of options for this Dropdown." + "releaseTag": "Public", + "name": "ISDKs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "microsoftTeams", + "docComment": "/**\n * Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest}\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "microsoftTeams" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "IMicrosoftTeams" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "microsoftTeams", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "selectedKey": { - "kind": "property", - "signature": "selectedKey?: string | number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The key of the initially selected option." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneDynamicFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "PropertyPaneDynamicField props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "filters": { - "kind": "property", - "signature": "filters?: IPropertyPaneDynamicFieldFilters;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneDynamicFieldFilters", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Filters for the property pane dynamic field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized label to identify the field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "propertyValueDepth": { - "kind": "property", - "signature": "propertyValueDepth?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ + "kind": "Interface", + "canonicalReference": "(ISerializedServerProcessedData:interface)", + "docComment": "/**\n * Contains collections of data that can be processed by server side services like search index and link fixup\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Indicates to what depth of property values are shown on the property pane dynamic data widget." + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "ISerializedServerProcessedData" }, { - "kind": "text", - "text": "If not specified, then max of 2 levels of property value will be shown." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "ISerializedServerProcessedData", + "members": [ { - "kind": "text", - "text": "It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "sourcesLabel": { - "kind": "property", - "signature": "sourcesLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ + "kind": "PropertySignature", + "canonicalReference": "htmlStrings", + "docComment": "/**\n * A key-value map where keys are string identifiers and values are rich text with HTML format.\n *\n * @remarks\n *\n * SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myRichDescription': '
Some standard HTML contentA Link
'\n * 'anotherRichText':
Some red text
\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "htmlStrings" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "htmlStrings", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } + }, { - "kind": "text", - "text": "User-friendly, localized label for the sources dropdown." + "kind": "PropertySignature", + "canonicalReference": "imageSources", + "docComment": "/**\n * A key-value map where keys are string identifiers and values are image sources.\n *\n * @remarks\n *\n * SharePoint servers treat the values as image sources and run services like search index and link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myImage1': 'http://res.contoso.com/path/to/file'\n * 'myImage2': 'https://res.contoso.com/someName.jpg'\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "imageSources" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "imageSources", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "links", + "docComment": "/**\n * A key-value map where keys are string identifiers and values are links.\n *\n * @remarks\n *\n * SharePoint servers treat the values as links and run services like link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myWebURL': 'http://contoso.com'\n * 'myFileLink': 'https://res.contoso.com/file.docx'\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "links" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "links", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } }, { - "kind": "text", - "text": "default value - 'Connect to source'" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneDynamicFieldSetProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane DynamicFieldSet props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "fields": { - "kind": "property", - "signature": "fields: IPropertyPaneField[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneField[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "List of property pane dynamic fields to be configured on the Dynamic Data Widget." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "User-friendly, localized label to identify the property." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "sharedConfiguration": { - "kind": "property", - "signature": "sharedConfiguration?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n /**\n * Indicates to what depth the dynamic reference is shared between the set of fields\n * of the dynamic field set.\n */\n depth: DynamicDataSharedDepth;\n /**\n * Shared source configuration\n */\n source?: IDynamicDataSharedSourceConfiguration;\n /**\n * Shared property configuration\n */\n property?: IDynamicDataSharedPropertyConfiguration;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Configuration shared between all the entries of the set." + "kind": "PropertySignature", + "canonicalReference": "searchablePlainTexts", + "docComment": "/**\n * A key-value map where keys are string identifiers and values are strings that should be search indexed.\n *\n * @remarks\n *\n * The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, but are not treated as valid HTML. So, other services such as link fixup will not run on them.\n *\n * Example:\n * ```\n * {\n * 'justSomeText': 'This is some plain text',\n * 'anotherText': 'Can have characters here: \"<>&\\''\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "searchablePlainTexts" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "searchablePlainTexts", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneDynamicTextFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "code", - "text": "PropertyPaneDynamicData", - "highlighter": "plain" + "extendsTokenRanges": [] }, { - "kind": "text", - "text": " component props." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "text", - "text": "ARIA Label for text field, if any." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ + "kind": "Interface", + "canonicalReference": "(ISerializedWebPartData:interface)", + "docComment": "/**\n * This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The text field input description." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ + "kind": "Content", + "text": "export interface " + }, { - "kind": "text", - "text": "Whether the property pane text field is enabled or not." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "errorMessage": { - "kind": "property", - "signature": "errorMessage?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ + "kind": "Reference", + "text": "ISerializedWebPartData" + }, { - "kind": "text", - "text": "If set, this will be displayed as an error message." + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "ISerializedWebPartData", + "members": [ { - "kind": "text", - "text": "When " + "kind": "PropertySignature", + "canonicalReference": "dataVersion", + "docComment": "/**\n * Web part data version.\n *\n * @remarks\n *\n * Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information.\n *\n * Supported values: MAJOR.MINOR\n *\n * Example: `\"1.0\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dataVersion" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "Version" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "onGetErrorMessage", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "dynamicDataPaths", + "docComment": "/**\n * Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part.\n *\n * @remarks\n *\n * The key is the path within the web part properties, and the value is the dynamic data internal id.\n *\n * Example:\n * ```\n * {\n * 'pageContextUser':\n * 'PageContext:user',\n * 'anotherWebPartProperty':\n * 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n * }\n * ```\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dynamicDataPaths" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "path" + }, + { + "kind": "Content", + "text": ": string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataPaths", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } }, { - "kind": "text", - "text": " returns empty string, if this property has a value set then this will be displayed as the error message." + "kind": "PropertySignature", + "canonicalReference": "dynamicDataValues", + "docComment": "/**\n * Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part.\n *\n * @remarks\n *\n * The key is the path within the web part properties, and the value is the dynamic data static value.\n *\n * Example:\n * ```\n * {\n * 'aStringProperty': 'thisIsAString',\n * 'aBooleanProperty': true\n * }\n * ```\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dynamicDataValues" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "path" + }, + { + "kind": "Content", + "text": ": string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataValues", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "properties", + "docComment": "/**\n * Web part specific properties. The individual web part owns the definition of these properties.\n *\n * @remarks\n *\n * Used by the web part to manage its internal metadata and config data. The framework code never touches these properties.\n *\n * Supported values: any JSON stringifiable object hierarchy.\n *\n * Example: `{ 'value': 'text value' }`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "Make sure to set this only if you want to see an error message displayed for the text field." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "text", - "text": "Label for the text field." + "kind": "PropertySignature", + "canonicalReference": "serverProcessedContent", + "docComment": "/**\n * The collections of data that can be processed by server side services like search index and link fixup.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "serverProcessedContent" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISerializedServerProcessedData" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverProcessedContent", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "onGetErrorMessage": { - "kind": "property", - "signature": "onGetErrorMessage?: (value: string) => string | Promise;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(value: string) => string | Promise", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "text", - "text": "This method is used to get the validation error message and determine whether the input value is valid or not." - } - ], - "remarks": [ + { + "kind": "Interface", + "canonicalReference": "(IWebPartContext:interface)", + "docComment": "/**\n * The base context interface for client-side web parts.\n *\n * @remarks\n *\n * A \"context\" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc.\n *\n * @deprecated\n *\n * This interface will be removed in an upcoming release. Use the {@link WebPartContext} class instead.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When it returns string:" + "kind": "Content", + "text": "interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IWebPartContext" }, { - "kind": "text", - "text": "- If valid, it returns empty string." - }, + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IWebPartContext", + "members": [ { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "domElement", + "docComment": "/**\n * Reference to the DOM element that hosts this client-side component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLElement" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "text", - "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." + "kind": "PropertySignature", + "canonicalReference": "graphHttpClient", + "docComment": "/**\n * GraphHttpClient instance scoped to this web part.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "graphHttpClient" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "GraphHttpClient" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "graphHttpClient", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "httpClient", + "docComment": "/**\n * HttpClient instance scoped to this web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "httpClient" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HttpClient" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "httpClient", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "text", - "text": "When it returns " + "kind": "PropertySignature", + "canonicalReference": "instanceId", + "docComment": "/**\n * Web part instance id. This is a globally unique value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "instanceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "code", - "text": "Promise", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "manifest", + "docComment": "/**\n * Manifest for the client-side web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "manifest" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartManifestInstance" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } }, { - "kind": "text", - "text": ":" + "kind": "PropertySignature", + "canonicalReference": "pageContext", + "docComment": "/**\n * SharePoint page context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "pageContext" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "PageContext" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "pageContext", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "propertyPane", + "docComment": "/**\n * Accessor for common web part property pane operations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "propertyPane" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IPropertyPaneAccessor" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyPane", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "text", - "text": "- The resolved value is display as error message." + "kind": "PropertySignature", + "canonicalReference": "spHttpClient", + "docComment": "/**\n * SPHttpClient instance scoped to this web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "spHttpClient" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "SPHttpClient" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "spHttpClient", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "statusRenderer", + "docComment": "/**\n * Web part status renderer.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "statusRenderer" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartStatusRenderer" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "statusRenderer", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } }, { - "kind": "text", - "text": "- The rejected, the value is thrown away." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "placeholder": { - "kind": "property", - "signature": "placeholder?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "text", - "text": "Placeholder text to be displayed in the text field." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "validateOnFocusIn": { - "kind": "property", - "signature": "validateOnFocusIn?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is focused." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." + "kind": "PropertySignature", + "canonicalReference": "webPartTag", + "docComment": "/**\n * Web part tag to be used for logging and telemetry.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "webPartTag" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webPartTag", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } } ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "validateOnFocusOut": { - "kind": "property", - "signature": "validateOnFocusOut?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IWebPartData:interface)", + "docComment": "/**\n * This structure represents the serialized state of a web part.\n *\n * @remarks\n *\n * When the `serialize()` API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Run validation when the " + "kind": "Content", + "text": "interface " }, { - "kind": "code", - "text": "PropertyPaneTextField", - "highlighter": "plain" + "kind": "Reference", + "text": "IWebPartData" }, { - "kind": "text", - "text": " is out of focus or on blur." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "value": { - "kind": "property", - "signature": "value?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by IPropertyPaneDynamicFieldProps" - } - ], - "summary": [ - { - "kind": "text", - "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneField": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "properties": { - "kind": "property", - "signature": "properties: TProperties;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "TProperties", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Strongly typed properties object. Specific to each field type." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Example: Checkbox has ICheckboxProps, TextField has ITextField props." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "shouldFocus": { - "kind": "property", - "signature": "shouldFocus?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether this control should be focused." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "targetProperty": { - "kind": "property", - "signature": "targetProperty: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Target property from the web part's property bag." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "type": { - "kind": "property", - "signature": "type: PropertyPaneFieldType;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "PropertyPaneFieldType", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Type of the PropertyPane field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneGroup": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane group. Group is part of the PropertyPanePage." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "groupFields": { - "kind": "property", - "signature": "groupFields: IPropertyPaneField[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPaneField[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "List of PropertyPane fields." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "groupName": { - "kind": "property", - "signature": "groupName?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display name for the group." - } - ], - "remarks": [ + "releaseTag": "Public", + "name": "IWebPartData", + "members": [ { - "kind": "text", - "text": "For performance reasons, it's highly recommended to keep this name unique within the property pane page." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isCollapsed": { - "kind": "property", - "signature": "isCollapsed?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the PropertyPane group is collapsed or not." - } - ], - "remarks": [ + "kind": "PropertySignature", + "canonicalReference": "dataVersion", + "docComment": "/**\n * Web part data version\n *\n * @remarks\n *\n * Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information.\n *\n * Supported values: MAJOR.MINOR\n *\n * Example: `\"1.0\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dataVersion" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneLabelProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneLabel component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "required": { - "kind": "property", - "signature": "required?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the associated form field is required or not." - } - ], - "remarks": [ + "kind": "PropertySignature", + "canonicalReference": "description", + "docComment": "/**\n * Web part description\n *\n * @remarks\n *\n * Used to display the description of the web part.\n *\n * Supported values: string with the description.\n *\n * Example: `\"Text\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "description" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "If true, a red asterisk is displayed to the right of the label. Default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display text fot the label." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneLinkProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneLink component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane link is disabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "href": { - "kind": "property", - "signature": "href: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Location to which the link is targeted to." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "popupWindowProps": { - "kind": "property", - "signature": "popupWindowProps?: IPopupWindowProps;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPopupWindowProps", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The props of pop up window." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "target": { - "kind": "property", - "signature": "target?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This attribute specifies where to display the linked resource." - } - ], - "remarks": [ + "kind": "PropertySignature", + "canonicalReference": "dynamicDataPaths", + "docComment": "/**\n * Paths for the dynamic data.\n *\n * @remarks\n *\n * This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id.\n *\n * Example:\n * ```\n * {\n * 'pageContextUser':\n * 'PageContext:user',\n * 'anotherWebPartProperty':\n * 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n * }\n * ```\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dynamicDataPaths" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "path" + }, + { + "kind": "Content", + "text": ": string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataPaths", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } + }, { - "kind": "text", - "text": "Following values can be used:" + "kind": "PropertySignature", + "canonicalReference": "dynamicDataValues", + "docComment": "/**\n * Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part.\n *\n * @remarks\n *\n * The key is the path within the web part properties, and the value is the dynamic data static value.\n *\n * Example:\n * ```\n * {\n * 'aStringProperty': 'thisIsAString',\n * 'aBooleanProperty': true\n * }\n * ```\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dynamicDataValues" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "{\n [" + }, + { + "kind": "Reference", + "text": "path" + }, + { + "kind": "Content", + "text": ": string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataValues", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 5 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "id", + "docComment": "/**\n * Universally unique web part Type id.\n *\n * @remarks\n *\n * Example: `\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "id" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "_self - (default) Load the response in the current page." + "kind": "PropertySignature", + "canonicalReference": "instanceId", + "docComment": "/**\n * Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries.\n *\n * @remarks\n *\n * supported values: a unique string. Could be GUID or other uniquely identifiable formats.\n *\n * example: `[\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"]`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "instanceId" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "properties", + "docComment": "/**\n * Web part specific properties. The individual web part owns the definition of these properties.\n *\n * @remarks\n *\n * Used by the web part to manage its internal metadata and config data. The framework code never touches these properties.\n *\n * Supported values: any object hierarchy that can be serialized using `JSON.stringify()`.\n *\n * Example: `{ 'value': 'text value' }`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "_blank - Load the response into a new unnamed tab." + "kind": "PropertySignature", + "canonicalReference": "serverProcessedContent", + "docComment": "/**\n * The collections of data that can be processed by server side services like search index and link fixup\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "serverProcessedContent" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Reference", + "text": "ISerializedServerProcessedData" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverProcessedContent", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" - }, + "kind": "PropertySignature", + "canonicalReference": "title", + "docComment": "/**\n * Web part title\n *\n * @remarks\n *\n * Used to display the name of the web part in the toolbox, web part gallery and the page.\n *\n * Supported values: string less than 100 characters\n *\n * Example: `\"Text\"`\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "title" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "(IWebPartPropertiesMetadata:interface)", + "docComment": "/**\n * This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata`\n *\n * @remarks\n *\n * The key should be a JSON path to the property in web part properties. The JSON path supports the following operators:\n *\n * - Dot `.` for selecting object members, for example `person.name`\n *\n * - Brackets `[]` for selecting array items, for example `person.photoURLs[0]`\n *\n * - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`.\n *\n * You can make combinations of these operators, for example `person.websites[*].url`\n *\n * Important Note: Only one wildcard per path is supported.\n *\n * Example: Let's assume we have a web part with properties that have the following schema:\n * ```\n * {\n * title: string;\n * person: {\n * name: string;\n * bio: string;\n * photoURLs: string[];\n * websites: { title: string; url: string; }[]\n * }\n * }\n * ```\n *\n * We can define the metadata for the desired properties as following:\n * ```\n * {\n * 'person.bio': { isRichContent: true },\n * 'person.photoURLs[*]': { isImageSource: true },\n * 'person.websites[*].url': { isLink: true }\n * }\n * ```\n *\n * This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same as \"_self\"" + "kind": "Content", + "text": "interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IWebPartPropertiesMetadata" }, { - "kind": "text", - "text": "_top - Load the response into the original window." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "text": { - "kind": "property", - "signature": "text: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Display text for the link." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPanePage": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPanePage interface." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "displayGroupsAsAccordion": { - "kind": "property", - "signature": "displayGroupsAsAccordion?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the groups on the PropertyPanePage are displayed as accordion or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "groups": { - "kind": "property", - "signature": "groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "List of groups to be displayed on the PropertyPane page." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "header": { - "kind": "property", - "signature": "header?: IPropertyPanePageHeader;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "IPropertyPanePageHeader", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane page header." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPanePageHeader": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane header. This header remains same for all the pages." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "description": { - "kind": "property", - "signature": "description: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Header to display." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "image": { - "kind": "property", - "signature": "image?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Image url for the background image." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneSliderProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneSliderProps component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A description of the Slider for the benefit of screen readers." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the Slider is disabled." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Description label of the Slider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "max": { - "kind": "property", - "signature": "max: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The max value of the Slider." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "min": { - "kind": "property", - "signature": "min: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The min value of the Slider." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "showValue": { - "kind": "property", - "signature": "showValue?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether to show the value on the right of the Slider." - } - ], - "remarks": [ + "releaseTag": "Public", + "name": "IWebPartPropertiesMetadata", + "members": [ { - "kind": "text", - "text": "If you want to show the value by yourself, you may want to set this value to false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "step": { - "kind": "property", - "signature": "step?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The difference between the two adjacent values of the Slider. Defaults to 1." + "kind": "IndexSignature", + "canonicalReference": "(:index,0)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[" + }, + { + "kind": "Reference", + "text": "key" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Reference", + "text": "IWebPartPropertyMetadata" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "value": { - "kind": "property", - "signature": "value?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Interface", + "canonicalReference": "(IWebPartPropertyMetadata:interface)", + "docComment": "/**\n * This is the structure used for map values in `IWebPartPropertiesMetadata`\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events." + "kind": "Content", + "text": "export interface " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IWebPartPropertyMetadata" }, { - "kind": "text", - "text": "Defaults to min." + "kind": "Content", + "text": " " } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneTextFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneTextField component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "ariaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Aria Label for text field, if any." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "deferredValidationTime": { - "kind": "property", - "signature": "deferredValidationTime?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ + "releaseTag": "Public", + "name": "IWebPartPropertyMetadata", + "members": [ { - "kind": "text", - "text": "Text field will start to validate after users stop typing for " + "kind": "PropertySignature", + "canonicalReference": "dynamicPropertyType", + "docComment": "/**\n * If specified, indicates that the property is a dynamic property and the type of the dynamic property.\n *\n * @remarks\n *\n * If a web part has properties that are dynamically configurable, then use this flag to declare the property as a dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create the DynamicProperty themselves and assign it to the property.\n *\n * A web part can configure a default value for the property by specifying it in the properties section of the web part's manifest. This value will be used when a dynamic property is constructed for the property.\n *\n * Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "dynamicPropertyType" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "'boolean' | 'number' | 'string' | 'array' | 'object'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dynamicPropertyType", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "deferredValidationTime", - "highlighter": "plain" + "kind": "PropertySignature", + "canonicalReference": "isHtmlString", + "docComment": "/**\n * Indicates whether the property should be serialized as HTML.\n *\n * @remarks\n *\n * This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it:\n *\n * - normalizing HTML encodings\n *\n * - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML)\n *\n * - search indexing\n *\n * - SharePoint link fix-up\n *\n * Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isHtmlString" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isHtmlString", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " milliseconds." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is 200." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The text field input description." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether the property pane text field is enabled or not." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "errorMessage": { - "kind": "property", - "signature": "errorMessage?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If set, this will be displayed as an error message." - } - ], - "remarks": [ + "kind": "PropertySignature", + "canonicalReference": "isImageSource", + "docComment": "/**\n * Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isImageSource" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isImageSource", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message." + "kind": "PropertySignature", + "canonicalReference": "isLink", + "docComment": "/**\n * Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isLink" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isLink", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "PropertySignature", + "canonicalReference": "isSearchablePlainText", + "docComment": "/**\n * Indicates if the property contains plain text that should be search-indexed by SharePoint.\n *\n * @remarks\n *\n * This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the isHtmlString setting instead.\n *\n * Security note: For security reasons, never assign a plain text string to `Element.innerHTML`.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "isSearchablePlainText" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isSearchablePlainText", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "So, make sure to set this only if you want to see an error message displayed for the text field." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label for the text field." + "kind": "PropertySignature", + "canonicalReference": "shouldNotPersist", + "docComment": "/**\n * Indicates if the framework should persist the property on the server.\n *\n * @remarks\n *\n * Use this for properties that are only important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data of the web part and optimize the web part load time. The property value will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared from the run-time property bag. The initial render of your web part should not depend on the value of the property. Setting a default value for the property can be done in `onInit()` method.\n *\n * Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "shouldNotPersist" + }, + { + "kind": "Content", + "text": "?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "shouldNotPersist", + "propertyTypeTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "extendsTokenRanges": [] }, - "logName": { - "kind": "property", - "signature": "logName?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n moduleName: string;\n controlName: string;\n }", - "deprecatedMessage": [], - "summary": [ + { + "kind": "Function", + "canonicalReference": "(PropertyPaneButton:0)", + "docComment": "/**\n * Helper method to create a Button on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the Button is associated to.\n *\n * @param properties - Strongly typed Button properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Name used to log " + "kind": "Content", + "text": "export declare function " }, { - "kind": "code", - "text": "PropertyPaneTextField", - "highlighter": "plain" + "kind": "Reference", + "text": "PropertyPaneButton" }, { - "kind": "text", - "text": " value changes for engagement tracking." - } - ], - "remarks": [ + "kind": "Content", + "text": "(" + }, { - "kind": "text", - "text": "The messages will be logged with a format such as " + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "code", - "text": ".", - "highlighter": "plain" + "kind": "Content", + "text": ": " }, { - "kind": "text", - "text": "." + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "properties" }, { - "kind": "text", - "text": "For example, if " + "kind": "Content", + "text": ": " }, { - "kind": "code", - "text": "{moduleName: 'ImageWebPart', controlName: 'OverlayText'}", - "highlighter": "plain" + "kind": "Reference", + "text": "IPropertyPaneButtonProps" }, { - "kind": "text", - "text": " is specified, the engagement log might contain:" + "kind": "Content", + "text": "): " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "text", - "text": "1. The action type:" + "kind": "Content", + "text": "<" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneButtonProps" }, { - "kind": "code", - "text": "Add", - "highlighter": "plain" + "kind": "Content", + "text": ">" }, { - "kind": "text", - "text": ": change from initial/unset state to customized content. (first edit)" + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } }, { - "kind": "paragraph" + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "PropertyPaneButton" + }, + { + "kind": "Enum", + "canonicalReference": "(PropertyPaneButtonType:enum)", + "docComment": "/**\n * Enum for all the supported button types.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum " }, { - "kind": "code", - "text": "Clear", - "highlighter": "plain" + "kind": "Reference", + "text": "PropertyPaneButtonType" }, { - "kind": "text", - "text": ": reset the content of caption element to initial/unset state." + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneButtonType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "Command", + "docComment": "/**\n * Optional actions.\n *\n * @remarks\n *\n * Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Command" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "releaseTag": "Public", + "name": "Command", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "EnumMember", + "canonicalReference": "Compound", + "docComment": "/**\n * Always used as a set with both Standard and Primary compound buttons.\n *\n * @remarks\n *\n * Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Compound" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "Compound", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "Edit", - "highlighter": "plain" + "kind": "EnumMember", + "canonicalReference": "Hero", + "docComment": "/**\n * Hero button.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Hero" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Hero", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": ": any edition that changes the content apart from add and clear" + "kind": "EnumMember", + "canonicalReference": "Icon", + "docComment": "/**\n * Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar.\n *\n * @remarks\n *\n * Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Icon" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Public", + "name": "Icon", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "EnumMember", + "canonicalReference": "Normal", + "docComment": "/**\n * Optional completion action.\n *\n * @remarks\n *\n * Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo an action. Examples: \"Done\" button which closes a container but doesn't make a server call or an \"Undo\" button when a user is uploading a file in OneDrive.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Normal" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Normal", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "2. The text length after each edit" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "maxLength": { - "kind": "property", - "signature": "maxLength?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Maximum number of characters that the PropertyPaneTextField can have." - } - ], - "remarks": [ - { - "kind": "text", - "text": "If the value is set to a negative number, an exception will be thrown." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "multiline": { - "kind": "property", - "signature": "multiline?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the text field is a multiline text field." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is false." + "kind": "EnumMember", + "canonicalReference": "Primary", + "docComment": "/**\n * Preferred completion action when paired with a Standard button.\n *\n * @remarks\n *\n * Typically used at the end of a task or form. Examples: \"Create\", \"Save\", \"Send\" which makes a server call.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Primary" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Primary", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "onGetErrorMessage": { - "kind": "property", - "signature": "onGetErrorMessage?: (value: string) => string | Promise;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "(value: string) => string | Promise", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The method is used to get the validation error message and determine whether the input value is valid or not." - } - ], - "remarks": [ + { + "kind": "Function", + "canonicalReference": "(PropertyPaneCheckbox:0)", + "docComment": "/**\n * Helper method to create a Checkbox on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the checkbox is associated to.\n *\n * @param properties - Strongly typed Checkbox properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "When it returns string:" + "kind": "Content", + "text": "export declare function " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "PropertyPaneCheckbox" }, { - "kind": "text", - "text": "- If valid, it returns empty string." + "kind": "Content", + "text": "(" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "text", - "text": "- If invalid, it returns the error message string and an error message is displayed below the text field." + "kind": "Content", + "text": ": " }, { - "kind": "paragraph" + "kind": "Content", + "text": "string" }, { - "kind": "text", - "text": "When it returns " + "kind": "Content", + "text": ", " }, { - "kind": "code", - "text": "Promise", - "highlighter": "plain" + "kind": "Reference", + "text": "properties" }, { - "kind": "text", - "text": ":" + "kind": "Content", + "text": ": " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps" }, { - "kind": "text", - "text": "- The resolved value is display as error message." + "kind": "Content", + "text": "): " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "text", - "text": "- The rejected, the value is thrown away." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "placeholder": { - "kind": "property", - "signature": "placeholder?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "placeholder text to be displayed in the text field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "resizable": { - "kind": "property", - "signature": "resizable?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the multiline text field is resizable." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The default value is true." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "rows": { - "kind": "property", - "signature": "rows?: number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Specifies the visible height of a text area(multiline text TextField), in lines." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This prop is used only when the multiline prop is set to true." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "underlined": { - "kind": "property", - "signature": "underlined?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Whether or not the text field is underlined." - } - ], - "remarks": [ + "kind": "Content", + "text": "<" + }, { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "validateOnFocusIn": { - "kind": "property", - "signature": "validateOnFocusIn?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is focused." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps" + }, { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "validateOnFocusOut": { - "kind": "property", - "signature": "validateOnFocusOut?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Run validation when the PropertyPaneTextField is out of focus or on blur." - } - ], - "remarks": [ + "kind": "Content", + "text": ">" + }, { - "kind": "text", - "text": "The default value is false." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "value": { - "kind": "property", - "signature": "value?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IPropertyPaneToggleProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneToggle component props." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "checked": { - "kind": "property", - "signature": "checked?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Checked state of the toggle." + "kind": "Content", + "text": ";" } ], - "remarks": [ + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "If you are maintaining state yourself, use this property." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "disabled": { - "kind": "property", - "signature": "disabled?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional disabled flag." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "key": { - "kind": "property", - "signature": "key?: string | number;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string | number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key to uniquely identify the field." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "label": { - "kind": "property", - "signature": "label: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A label for the toggle." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "offAriaLabel": { - "kind": "property", - "signature": "offAriaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "offText": { - "kind": "property", - "signature": "offText?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Test display when toggle is OFF." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "onAriaLabel": { - "kind": "property", - "signature": "onAriaLabel?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON." + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "name": "PropertyPaneCheckbox" }, - "onText": { - "kind": "property", - "signature": "onText?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Text to display when toggle is ON." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISerializedServerProcessedData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ { - "kind": "text", - "text": "Contains collections of data that can be processed by server side services like search index and link fixup" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "htmlStrings": { - "kind": "property", - "signature": "htmlStrings?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are rich text with HTML format." - } - ], - "remarks": [ - { - "kind": "text", - "text": "SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them." - }, + "kind": "Function", + "canonicalReference": "(PropertyPaneChoiceGroup:0)", + "docComment": "/**\n * Helper method to create a Choice Group on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the choice group is associated to.\n *\n * @param properties - Strongly typed Choice Group properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export declare function " }, { - "kind": "text", - "text": "Example:" + "kind": "Reference", + "text": "PropertyPaneChoiceGroup" }, { - "kind": "code-box", - "text": "{\n 'myRichDescription': '
Some standard HTML contentA Link
'\n 'anotherRichText':
Some red text
\n}\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "imageSources": { - "kind": "property", - "signature": "imageSources?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are image sources." - } - ], - "remarks": [ - { - "kind": "text", - "text": "SharePoint servers treat the values as image sources and run services like search index and link fixup on them." + "kind": "Content", + "text": "(" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "text", - "text": "Example:" + "kind": "Content", + "text": ": " }, { - "kind": "code-box", - "text": "{\n 'myImage1': 'http://res.contoso.com/path/to/file'\n 'myImage2': 'https://res.contoso.com/someName.jpg'\n}\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "links": { - "kind": "property", - "signature": "links?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are links." - } - ], - "remarks": [ - { - "kind": "text", - "text": "SharePoint servers treat the values as links and run services like link fixup on them." + "kind": "Content", + "text": "string" }, { - "kind": "paragraph" + "kind": "Content", + "text": ", " }, { - "kind": "text", - "text": "Example:" + "kind": "Reference", + "text": "properties" }, { - "kind": "code-box", - "text": "{\n 'myWebURL': 'http://contoso.com'\n 'myFileLink': 'https://res.contoso.com/file.docx'\n}\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "searchablePlainTexts": { - "kind": "property", - "signature": "searchablePlainTexts?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [key: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A key-value map where keys are string identifiers and values are strings that should be search indexed." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, but are not treated as valid HTML. So, other services such as link fixup will not run on them." + "kind": "Content", + "text": ": " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps" }, { - "kind": "text", - "text": "Example:" + "kind": "Content", + "text": "): " }, { - "kind": "code-box", - "text": "{\n 'justSomeText': 'This is some plain text',\n 'anotherText': 'Can have characters here: \"<>&\\''\n}\n", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "ISerializedWebPartData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "dataVersion": { - "kind": "property", - "signature": "dataVersion: Version;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "Version", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part data version." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information." + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "paragraph" + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": "Supported values: MAJOR.MINOR" + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps" }, { - "kind": "paragraph" + "kind": "Content", + "text": ">" }, { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } }, { - "kind": "code", - "text": "\"1.0\"", - "highlighter": "plain" + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "name": "PropertyPaneChoiceGroup" }, - "dynamicDataPaths": { - "kind": "property", - "signature": "dynamicDataPaths?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part." - } - ], - "remarks": [ + { + "kind": "Function", + "canonicalReference": "(PropertyPaneCustomField:0)", + "docComment": "/**\n * Helper method to create a custom field on the PropertyPane.\n *\n * @remarks\n *\n * The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - target property for this field. This parameter is being deprecated in future releases.\n *\n * @param properties - Strongly typed Custom field properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The key is the path within the web part properties, and the value is the dynamic data internal id." + "kind": "Content", + "text": "export declare function " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "PropertyPaneCustomField" }, { - "kind": "text", - "text": "Example:" + "kind": "Content", + "text": "(" }, { - "kind": "code-box", - "text": "{\n 'pageContextUser':\n 'PageContext:user',\n 'anotherWebPartProperty':\n 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n}\n", - "highlighter": "plain" - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dynamicDataValues": { - "kind": "property", - "signature": "dynamicDataValues?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: any;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The key is the path within the web part properties, and the value is the dynamic data static value." + "kind": "Reference", + "text": "properties" }, { - "kind": "paragraph" + "kind": "Content", + "text": ": " }, { - "kind": "text", - "text": "Example:" + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps" }, { - "kind": "code-box", - "text": "{\n 'aStringProperty': 'thisIsAString',\n 'aBooleanProperty': true\n}\n", - "highlighter": "plain" - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "properties": { - "kind": "property", - "signature": "properties?: any;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part specific properties. The individual web part owns the definition of these properties." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Used by the web part to manage its internal metadata and config data. The framework code never touches these properties." + "kind": "Content", + "text": "): " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "text", - "text": "Supported values: any JSON stringifiable object hierarchy." + "kind": "Content", + "text": "<" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps" }, { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": ">" }, { - "kind": "code", - "text": "{ 'value': 'text value' }", - "highlighter": "plain" + "kind": "Content", + "text": ";" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serverProcessedContent": { - "kind": "property", - "signature": "serverProcessedContent?: ISerializedServerProcessedData;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "ISerializedServerProcessedData", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The collections of data that can be processed by server side services like search index and link fixup." + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IWebPartContext": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "name": "PropertyPaneCustomField" }, { - "kind": "api-link", - "elements": [ + "kind": "Function", + "canonicalReference": "(PropertyPaneDropdown:0)", + "docComment": "/**\n * Helper method to create a Dropdown on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the dropdown is associated to.\n *\n * @param properties - Strongly typed Dropdown properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } - }, - { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "The base context interface for client-side web parts." - } - ], - "remarks": [ - { - "kind": "text", - "text": "A \"context\" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " - }, - { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": "export declare function " }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Reference to the DOM element that hosts this client-side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "graphHttpClient": { - "kind": "property", - "signature": "readonly graphHttpClient: GraphHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "GraphHttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Reference", + "text": "PropertyPaneDropdown" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": "(" }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "GraphHttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "httpClient": { - "kind": "property", - "signature": "readonly httpClient: HttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": ": " }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "HttpClient instance scoped to this web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "instanceId": { - "kind": "property", - "signature": "readonly instanceId: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Content", + "text": "string" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": ", " }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Web part instance id. This is a globally unique value." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "manifest": { - "kind": "property", - "signature": "readonly manifest: IClientSideWebPartManifestInstance;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartManifestInstance", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Reference", + "text": "properties" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": ": " }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Manifest for the client-side web part." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "pageContext": { - "kind": "property", - "signature": "readonly pageContext: PageContext;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "PageContext", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Reference", + "text": "IPropertyPaneDropdownProps" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": "): " }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "SharePoint page context." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "propertyPane": { - "kind": "property", - "signature": "readonly propertyPane: IPropertyPaneAccessor;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IPropertyPaneAccessor", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Accessor for common web part property pane operations." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "spHttpClient": { - "kind": "property", - "signature": "readonly spHttpClient: SPHttpClient;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "SPHttpClient", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Reference", + "text": "IPropertyPaneDropdownProps" }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Content", + "text": ">" }, { - "kind": "text", - "text": " class instead." + "kind": "Content", + "text": ";" } ], - "summary": [ + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "SPHttpClient instance scoped to this web part." + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "name": "PropertyPaneDropdown" }, - "statusRenderer": { - "kind": "property", - "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartStatusRenderer", - "deprecatedMessage": [ + { + "kind": "Enum", + "canonicalReference": "(PropertyPaneDropdownOptionType:enum)", + "docComment": "/**\n * Specifies the type of option in a dropdown menu rendered by {@link PropertyPaneDropdown}.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "Content", + "text": "export declare enum " }, { - "kind": "api-link", - "elements": [ - { - "kind": "text", - "text": "WebPartContext" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" - } + "kind": "Reference", + "text": "PropertyPaneDropdownOptionType" }, { - "kind": "text", - "text": " class instead." + "kind": "Content", + "text": " " } ], - "summary": [ + "releaseTag": "Public", + "name": "PropertyPaneDropdownOptionType", + "members": [ { - "kind": "text", - "text": "Web part status renderer." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "webPartTag": { - "kind": "property", - "signature": "readonly webPartTag: string;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "string", - "deprecatedMessage": [ - { - "kind": "text", - "text": "This interface will be removed in an upcoming release. Use the " + "kind": "EnumMember", + "canonicalReference": "Divider", + "docComment": "/**\n * Render a divider.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Divider" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Divider", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "api-link", - "elements": [ + "kind": "EnumMember", + "canonicalReference": "Header", + "docComment": "/**\n * Render menu item as a header.\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "WebPartContext" + "kind": "Reference", + "text": "Header" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" } ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "WebPartContext", - "memberName": "" + "releaseTag": "Public", + "name": "Header", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 } }, { - "kind": "text", - "text": " class instead." - } - ], - "summary": [ - { - "kind": "text", - "text": "Web part tag to be used for logging and telemetry." + "kind": "EnumMember", + "canonicalReference": "Normal", + "docComment": "/**\n * Render normal menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Normal" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Normal", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IWebPartData": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This structure represents the serialized state of a web part." - } - ], - "remarks": [ - { - "kind": "text", - "text": "When the " - }, - { - "kind": "code", - "text": "serialize()", - "highlighter": "plain" + ] }, { - "kind": "text", - "text": " API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "dataVersion": { - "kind": "property", - "signature": "dataVersion: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part data version" - } - ], - "remarks": [ + "kind": "Function", + "canonicalReference": "(PropertyPaneDynamicField:0)", + "docComment": "/**\n * Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the Dynamic Data widget is associated to.\n *\n * @param options - Options to enable customized values for callback, filters etc., for the dynamic field.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information." + "kind": "Content", + "text": "export declare function " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "PropertyPaneDynamicField" }, { - "kind": "text", - "text": "Supported values: MAJOR.MINOR" + "kind": "Content", + "text": "(" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": ": " }, { - "kind": "code", - "text": "\"1.0\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "description": { - "kind": "property", - "signature": "description?: string;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part description" - } - ], - "remarks": [ + "kind": "Content", + "text": "string" + }, { - "kind": "text", - "text": "Used to display the description of the web part." + "kind": "Content", + "text": ", " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "properties" }, { - "kind": "text", - "text": "Supported values: string with the description." + "kind": "Content", + "text": ": " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps" }, { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": "): " }, { - "kind": "code", - "text": "\"Text\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dynamicDataPaths": { - "kind": "property", - "signature": "dynamicDataPaths?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: string;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Paths for the dynamic data." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPropertyPaneField" + }, { - "kind": "text", - "text": "This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id." + "kind": "Content", + "text": "<" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps" }, { - "kind": "text", - "text": "Example:" + "kind": "Content", + "text": ">" }, { - "kind": "code-box", - "text": "{\n 'pageContextUser':\n 'PageContext:user',\n 'anotherWebPartProperty':\n 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n}\n", - "highlighter": "plain" + "kind": "Content", + "text": ";" } ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "dynamicDataValues": { - "kind": "property", - "signature": "dynamicDataValues?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{\n [path: string]: any;\n }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part." + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "remarks": [ + "name": "PropertyPaneDynamicField" + }, + { + "kind": "Function", + "canonicalReference": "(PropertyPaneDynamicFieldSet:0)", + "docComment": "/**\n * Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source.\n *\n * These fields can possibly share the same property based on the associated filters.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param properties - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "The key is the path within the web part properties, and the value is the dynamic data static value." + "kind": "Content", + "text": "export declare function " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "PropertyPaneDynamicFieldSet" }, { - "kind": "text", - "text": "Example:" + "kind": "Content", + "text": "(" }, { - "kind": "code-box", - "text": "{\n 'aStringProperty': 'thisIsAString',\n 'aBooleanProperty': true\n}\n", - "highlighter": "plain" - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "id": { - "kind": "property", - "signature": "id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Universally unique web part Type id." - } - ], - "remarks": [ + "kind": "Reference", + "text": "properties" + }, { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": ": " }, { - "kind": "code", - "text": "\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "instanceId": { - "kind": "property", - "signature": "instanceId: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries." - } - ], - "remarks": [ + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField" + }, { - "kind": "text", - "text": "supported values: a unique string. Could be GUID or other uniquely identifiable formats." + "kind": "Content", + "text": "<" }, { - "kind": "paragraph" + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps" }, { - "kind": "text", - "text": "example: " + "kind": "Content", + "text": ">" }, { - "kind": "code", - "text": "[\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"]", - "highlighter": "plain" + "kind": "Content", + "text": ";" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "properties": { - "kind": "property", - "signature": "properties?: any;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "any", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part specific properties. The individual web part owns the definition of these properties." + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } } ], - "remarks": [ + "name": "PropertyPaneDynamicFieldSet" + }, + { + "kind": "Function", + "canonicalReference": "(PropertyPaneDynamicTextField:0)", + "docComment": "/**\n * Helper method to create a Dynamic TextField on the PropertyPane.\n *\n * @deprecated\n *\n * This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the dynamic textfield is associated to.\n *\n * @param properties - Properties of the PropertyPaneDynamicTextField.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @beta\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Used by the web part to manage its internal metadata and config data. The framework code never touches these properties." + "kind": "Content", + "text": "export declare function " }, { - "kind": "paragraph" + "kind": "Reference", + "text": "PropertyPaneDynamicTextField" }, { - "kind": "text", - "text": "Supported values: any object hierarchy that can be serialized using " + "kind": "Content", + "text": "(" }, { - "kind": "code", - "text": "JSON.stringify()", - "highlighter": "plain" + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "text", - "text": "." + "kind": "Content", + "text": ": " }, { - "kind": "paragraph" + "kind": "Content", + "text": "string" }, { - "kind": "text", - "text": "Example: " + "kind": "Content", + "text": ", " }, { - "kind": "code", - "text": "{ 'value': 'text value' }", - "highlighter": "plain" - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "serverProcessedContent": { - "kind": "property", - "signature": "serverProcessedContent?: ISerializedServerProcessedData;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "ISerializedServerProcessedData", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The collections of data that can be processed by server side services like search index and link fixup" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "title": { - "kind": "property", - "signature": "title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part title" - } - ], - "remarks": [ + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Used to display the name of the web part in the toolbox, web part gallery and the page." + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps" }, { - "kind": "paragraph" + "kind": "Content", + "text": "): " }, { - "kind": "text", - "text": "Supported values: string less than 100 characters" + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "paragraph" + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": "Example: " + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps" }, { - "kind": "code", - "text": "\"Text\"", - "highlighter": "plain" + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "IWebPartPropertiesMetadata": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This structure is used to define metadata for web part properties as a map of string to " - }, - { - "kind": "code", - "text": "IWebPartPropertyMetadata", - "highlighter": "plain" - } - ], - "remarks": [ - { - "kind": "text", - "text": "The key should be a JSON path to the property in web part properties. The JSON path supports the following operators:" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Dot " - }, - { - "kind": "code", - "text": ".", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " for selecting object members, for example " - }, - { - "kind": "code", - "text": "person.name", - "highlighter": "plain" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Brackets " - }, - { - "kind": "code", - "text": "[]", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " for selecting array items, for example " - }, - { - "kind": "code", - "text": "person.photoURLs[0]", - "highlighter": "plain" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "- Bracketed asterisk " - }, - { - "kind": "code", - "text": "[*]", - "highlighter": "plain" - }, - { - "kind": "text", - "text": " for array elements wildcard, for example " - }, - { - "kind": "code", - "text": "person.websites[*]", - "highlighter": "plain" - }, - { - "kind": "text", - "text": "." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "You can make combinations of these operators, for example " - }, - { - "kind": "code", - "text": "person.websites[*].url", - "highlighter": "plain" - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Important Note: Only one wildcard per path is supported." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "Example: Let's assume we have a web part with properties that have the following schema:" - }, - { - "kind": "code-box", - "text": "{\n title: string;\n person: {\n name: string;\n bio: string;\n photoURLs: string[];\n websites: { title: string; url: string; }[]\n }\n}\n", - "highlighter": "plain" - }, - { - "kind": "text", - "text": "We can define the metadata for the desired properties as following:" - }, - { - "kind": "code-box", - "text": "{\n 'person.bio': { isRichContent: true },\n 'person.photoURLs[*]': { isImageSource: true },\n 'person.websites[*].url': { isLink: true }\n}\n", - "highlighter": "plain" - }, - { - "kind": "text", - "text": "This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated." - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "__index": { - "kind": "method", - "signature": "[key: string]: IWebPartPropertyMetadata;", - "accessModifier": "", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "IWebPartPropertyMetadata", - "description": [] + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 }, - "parameters": { - "key": { - "name": "key", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "string" + "releaseTag": "Beta", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false - } - } - }, - "IWebPartPropertyMetadata": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This is the structure used for map values in " + ], + "name": "PropertyPaneDynamicTextField" }, { - "kind": "code", - "text": "IWebPartPropertiesMetadata", - "highlighter": "plain" - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "members": { - "dynamicPropertyType": { - "kind": "property", - "signature": "dynamicPropertyType?: 'boolean' | 'number' | 'string' | 'array' | 'object';", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "'boolean' | 'number' | 'string' | 'array' | 'object'", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "If specified, indicates that the property is a dynamic property and the type of the dynamic property." + "kind": "Enum", + "canonicalReference": "(PropertyPaneFieldType:enum)", + "docComment": "/**\n * Enum for all the supported PropertyPane field types.\n *\n * Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum " + }, + { + "kind": "Reference", + "text": "PropertyPaneFieldType" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "PropertyPaneFieldType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "Button", + "docComment": "/**\n * Button field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Button" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "11" + } + ], + "releaseTag": "Public", + "name": "Button", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "CheckBox", + "docComment": "/**\n * Checkbox field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "CheckBox" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "CheckBox", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "ChoiceGroup", + "docComment": "/**\n * Choice Group field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "ChoiceGroup" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "10" + } + ], + "releaseTag": "Public", + "name": "ChoiceGroup", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Custom", + "docComment": "/**\n * Custom field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Custom" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Custom", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Dropdown", + "docComment": "/**\n * Dropdown field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Dropdown" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "6" + } + ], + "releaseTag": "Public", + "name": "Dropdown", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "DynamicField", + "docComment": "/**\n * Dynamic data field.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "DynamicField" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "14" + } + ], + "releaseTag": "Public", + "name": "DynamicField", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "DynamicFieldSet", + "docComment": "/**\n * A set of dynamic fields.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "DynamicFieldSet" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "16" + } + ], + "releaseTag": "Public", + "name": "DynamicFieldSet", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "DynamicTextField", + "docComment": "/**\n * Dynamic Text Field\n *\n * @deprecated\n *\n * - Please use DynamicField\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "DynamicTextField" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "15" + } + ], + "releaseTag": "Beta", + "name": "DynamicTextField", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, { - "kind": "text", - "text": "If a web part has properties that are dynamically configurable, then use this flag to declare the property as a dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create the DynamicProperty themselves and assign it to the property." + "kind": "EnumMember", + "canonicalReference": "Heading", + "docComment": "/**\n * Heading field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Heading" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "9" + } + ], + "releaseTag": "Public", + "name": "Heading", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "EnumMember", + "canonicalReference": "HorizontalRule", + "docComment": "/**\n * Horizontal Rule field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "HorizontalRule" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "12" + } + ], + "releaseTag": "Public", + "name": "HorizontalRule", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "A web part can configure a default value for the property by specifying it in the properties section of the web part's manifest. This value will be used when a dynamic property is constructed for the property." + "kind": "EnumMember", + "canonicalReference": "Label", + "docComment": "/**\n * Label field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Label" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "7" + } + ], + "releaseTag": "Public", + "name": "Label", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "paragraph" + "kind": "EnumMember", + "canonicalReference": "Link", + "docComment": "/**\n * Link field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Link" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "13" + } + ], + "releaseTag": "Public", + "name": "Link", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": "Note: Web parts should be able to type cast the resultant value from the " + "kind": "EnumMember", + "canonicalReference": "Slider", + "docComment": "/**\n * Slider field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Slider" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "8" + } + ], + "releaseTag": "Public", + "name": "Slider", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "code", - "text": "tryGetValue", - "highlighter": "plain" + "kind": "EnumMember", + "canonicalReference": "TextField", + "docComment": "/**\n * TextField field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "TextField" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "TextField", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } }, { - "kind": "text", - "text": " to suit their needs." + "kind": "EnumMember", + "canonicalReference": "Toggle", + "docComment": "/**\n * Toggle field.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Toggle" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Public", + "name": "Toggle", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + ] }, - "isHtmlString": { - "kind": "property", - "signature": "isHtmlString?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates whether the property should be serialized as HTML." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it:" - }, + { + "kind": "Function", + "canonicalReference": "(PropertyPaneHorizontalRule:0)", + "docComment": "/**\n * Helper method to create a Horizontal Rule on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param properties - Strongly typed Horizontal Rule properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export declare function " }, { - "kind": "text", - "text": "- normalizing HTML encodings" + "kind": "Reference", + "text": "PropertyPaneHorizontalRule" }, { - "kind": "paragraph" + "kind": "Content", + "text": "(): " }, { - "kind": "text", - "text": "- stripping unsafe HTML tags (i.e. for usage with Element.innerHTML)" + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "paragraph" + "kind": "Content", + "text": "" }, { - "kind": "text", - "text": "- search indexing" - }, + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [], + "name": "PropertyPaneHorizontalRule" + }, + { + "kind": "Function", + "canonicalReference": "(PropertyPaneLabel:0)", + "docComment": "/**\n * Helper method to create a Label on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the label is associated to.\n *\n * @param properties - Strongly typed Label properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "paragraph" + "kind": "Content", + "text": "export declare function " }, { - "kind": "text", - "text": "- SharePoint link fix-up" + "kind": "Reference", + "text": "PropertyPaneLabel" }, { - "kind": "paragraph" + "kind": "Content", + "text": "(" }, { - "kind": "text", - "text": "Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the " + "kind": "Reference", + "text": "targetProperty" }, { - "kind": "code", - "text": "isSearchablePlainText", - "highlighter": "plain" + "kind": "Content", + "text": ": " }, { - "kind": "text", - "text": " flag instead." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isImageSource": { - "kind": "property", - "signature": "isImageSource?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isLink": { - "kind": "property", - "signature": "isLink?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "isSearchablePlainText": { - "kind": "property", - "signature": "isSearchablePlainText?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates if the property contains plain text that should be search-indexed by SharePoint." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the isHtmlString setting instead." + "kind": "Content", + "text": "string" }, { - "kind": "paragraph" + "kind": "Content", + "text": ", " }, { - "kind": "text", - "text": "Security note: For security reasons, never assign a plain text string to " + "kind": "Reference", + "text": "properties" }, { - "kind": "code", - "text": "Element.innerHTML", - "highlighter": "plain" + "kind": "Content", + "text": ": " }, { - "kind": "text", - "text": "." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "shouldNotPersist": { - "kind": "property", - "signature": "shouldNotPersist?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Indicates if the framework should persist the property on the server." - } - ], - "remarks": [ - { - "kind": "text", - "text": "Use this for properties that are only important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data of the web part and optimize the web part load time. The property value will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. The property value will still be available in the " + "kind": "Reference", + "text": "IPropertyPaneLabelProps" }, { - "kind": "code", - "text": "onBeforeSerialize()", - "highlighter": "plain" + "kind": "Content", + "text": "): " }, { - "kind": "text", - "text": " method, and the value will not be cleared from the run-time property bag. The initial render of your web part should not depend on the value of the property. Setting a default value for the property can be done in " + "kind": "Reference", + "text": "IPropertyPaneField" }, { - "kind": "code", - "text": "onInit()", - "highlighter": "plain" + "kind": "Content", + "text": "<" }, { - "kind": "text", - "text": " method." + "kind": "Reference", + "text": "IPropertyPaneLabelProps" }, { - "kind": "paragraph" + "kind": "Content", + "text": ">" }, { - "kind": "text", - "text": "Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data." - } - ], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "PropertyPaneButton": { - "kind": "function", - "signature": "export function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the Button is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Button properties." + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneButtonProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Button on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneButtonType": { - "kind": "enum", - "values": { - "Command": { - "kind": "enum value", - "value": "4", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional actions." - } - ], - "remarks": [ + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts." + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "isBeta": false + "name": "PropertyPaneLabel" }, - "Compound": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Always used as a set with both Standard and Primary compound buttons." - } - ], - "remarks": [ + { + "kind": "Function", + "canonicalReference": "(PropertyPaneLink:0)", + "docComment": "/**\n * Helper method to create a Link on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the Link is associated to.\n *\n * @param properties - Strongly typed Link properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form" - } - ], - "isBeta": false - }, - "Hero": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Hero button." - } - ], - "remarks": [], - "isBeta": false - }, - "Icon": { - "kind": "enum value", - "value": "5", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar." - } - ], - "remarks": [ + "kind": "Content", + "text": "export declare function " + }, { - "kind": "text", - "text": "Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range." - } - ], - "isBeta": false - }, - "Normal": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Optional completion action." - } - ], - "remarks": [ + "kind": "Reference", + "text": "PropertyPaneLink" + }, { - "kind": "text", - "text": "Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo an action. Examples: \"Done\" button which closes a container but doesn't make a server call or an \"Undo\" button when a user is uploading a file in OneDrive." - } - ], - "isBeta": false - }, - "Primary": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Preferred completion action when paired with a Standard button." - } - ], - "remarks": [ + "kind": "Content", + "text": "(" + }, { - "kind": "text", - "text": "Typically used at the end of a task or form. Examples: \"Create\", \"Save\", \"Send\" which makes a server call." - } - ], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enum for all the supported button types." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneCheckbox": { - "kind": "function", - "signature": "export function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the checkbox is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "kind": "Reference", + "text": "targetProperty" + }, { - "kind": "text", - "text": "Strongly typed Checkbox properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneCheckboxProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Checkbox on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneChoiceGroup": { - "kind": "function", - "signature": "export function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the choice group is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "Strongly typed Choice Group properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneChoiceGroupProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Choice Group on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneCustomField": { - "kind": "function", - "signature": "export function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Strongly typed Custom field properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneCustomFieldProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a custom field on the PropertyPane." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap." - } - ], - "isBeta": true - }, - "PropertyPaneDropdown": { - "kind": "function", - "signature": "export function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the dropdown is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "kind": "Content", + "text": "string" + }, { - "kind": "text", - "text": "Strongly typed Dropdown properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneDropdownProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Dropdown on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneDropdownOptionType": { - "kind": "enum", - "values": { - "Divider": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render a divider." - } - ], - "remarks": [], - "isBeta": false - }, - "Header": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render menu item as a header." - } - ], - "remarks": [], - "isBeta": false - }, - "Normal": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Render normal menu item." - } - ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Specifies the type of option in a dropdown menu rendered by " - }, - { - "kind": "api-link", - "elements": [ + "kind": "Content", + "text": ", " + }, { - "kind": "text", - "text": "PropertyPaneDropdown" - } - ], - "target": { - "scopeName": "@microsoft", - "packageName": "sp-webpart-base", - "exportName": "PropertyPaneDropdown", - "memberName": "" - } - }, - { - "kind": "text", - "text": "." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneDynamicField": { - "kind": "function", - "signature": "export function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the Dynamic Data widget is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneDynamicFieldProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneDynamicFieldSet": { - "kind": "function", - "signature": "export function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "properties": { - "name": "properties", - "description": [ - { - "kind": "text", - "text": "Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneDynamicFieldSetProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source." - }, - { - "kind": "paragraph" - }, - { - "kind": "text", - "text": "These fields can possibly share the same property based on the associated filters." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneDynamicTextField": { - "kind": "function", - "signature": "export function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the dynamic textfield is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "kind": "Reference", + "text": "properties" + }, { - "kind": "text", - "text": "Properties of the PropertyPaneDynamicTextField." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneDynamicTextFieldProps" - } - }, - "deprecatedMessage": [ - { - "kind": "text", - "text": "- This has been replaced by PropertyPaneDynamicField" - } - ], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Dynamic TextField on the PropertyPane." - } - ], - "remarks": [], - "isBeta": true - }, - "PropertyPaneFieldType": { - "kind": "enum", - "values": { - "Button": { - "kind": "enum value", - "value": "11", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Button field." - } - ], - "remarks": [], - "isBeta": false - }, - "CheckBox": { - "kind": "enum value", - "value": "2", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Checkbox field." - } - ], - "remarks": [], - "isBeta": false - }, - "ChoiceGroup": { - "kind": "enum value", - "value": "10", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Choice Group field." - } - ], - "remarks": [], - "isBeta": false - }, - "Custom": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Custom field." - } - ], - "remarks": [], - "isBeta": false - }, - "Dropdown": { - "kind": "enum value", - "value": "6", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Dropdown field." - } - ], - "remarks": [], - "isBeta": false - }, - "DynamicField": { - "kind": "enum value", - "value": "14", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Dynamic data field." - } - ], - "remarks": [], - "isBeta": false - }, - "DynamicFieldSet": { - "kind": "enum value", - "value": "16", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "A set of dynamic fields." - } - ], - "remarks": [], - "isBeta": false - }, - "DynamicTextField": { - "kind": "enum value", - "value": "15", - "deprecatedMessage": [ + "kind": "Content", + "text": ": " + }, { - "kind": "text", - "text": "- Please use DynamicField" - } - ], - "summary": [ + "kind": "Reference", + "text": "IPropertyPaneLinkProps" + }, { - "kind": "text", - "text": "Dynamic Text Field" - } - ], - "remarks": [], - "isBeta": true - }, - "Heading": { - "kind": "enum value", - "value": "9", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Heading field." - } - ], - "remarks": [], - "isBeta": false - }, - "HorizontalRule": { - "kind": "enum value", - "value": "12", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Horizontal Rule field." - } - ], - "remarks": [], - "isBeta": false - }, - "Label": { - "kind": "enum value", - "value": "7", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Label field." - } - ], - "remarks": [], - "isBeta": false - }, - "Link": { - "kind": "enum value", - "value": "13", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Link field." - } - ], - "remarks": [], - "isBeta": false - }, - "Slider": { - "kind": "enum value", - "value": "8", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Slider field." - } - ], - "remarks": [], - "isBeta": false - }, - "TextField": { - "kind": "enum value", - "value": "3", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "TextField field." + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "remarks": [], - "isBeta": false - }, - "Toggle": { - "kind": "enum value", - "value": "5", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Toggle field." + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "remarks": [], - "isBeta": false - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Enum for all the supported PropertyPane field types." - }, - { - "kind": "paragraph" + "name": "PropertyPaneLink" }, { - "kind": "text", - "text": "Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneHorizontalRule": { - "kind": "function", - "signature": "export function PropertyPaneHorizontalRule(): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Horizontal Rule on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneLabel": { - "kind": "function", - "signature": "export function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the label is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "kind": "Function", + "canonicalReference": "(PropertyPaneSlider:0)", + "docComment": "/**\n * Helper method to create a Slider on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the slider is associated to.\n *\n * @param properties - Strongly typed Slider properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { - "kind": "text", - "text": "Strongly typed Label properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneLabelProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Label on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneLink": { - "kind": "function", - "signature": "export function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the Link is associated to." - } - ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "kind": "Content", + "text": "export declare function " + }, { - "kind": "text", - "text": "Strongly typed Link properties." - } - ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneLinkProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Link on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneSlider": { - "kind": "function", - "signature": "export function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the slider is associated to." + "kind": "Reference", + "text": "PropertyPaneSlider" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "targetProperty" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "Strongly typed Slider properties." + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneSliderProps" - } - }, - "deprecatedMessage": [], - "summary": [ + "name": "PropertyPaneSlider" + }, { - "kind": "text", - "text": "Helper method to create a Slider on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneTextField": { - "kind": "function", - "signature": "export function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the textfield is associated to." + "kind": "Function", + "canonicalReference": "(PropertyPaneTextField:0)", + "docComment": "/**\n * Helper method to create a TextField on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the textfield is associated to.\n *\n * @param properties - Strongly typed TextField properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function " + }, + { + "kind": "Reference", + "text": "PropertyPaneTextField" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "targetProperty" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "Strongly typed TextField properties." + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneTextFieldProps" - } - }, - "deprecatedMessage": [], - "summary": [ + "name": "PropertyPaneTextField" + }, { - "kind": "text", - "text": "Helper method to create a TextField on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "PropertyPaneToggle": { - "kind": "function", - "signature": "export function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField;", - "returnValue": { - "type": "IPropertyPaneField", - "description": [] - }, - "parameters": { - "targetProperty": { - "name": "targetProperty", - "description": [ - { - "kind": "text", - "text": "Target property the toggle is associated to." + "kind": "Function", + "canonicalReference": "(PropertyPaneToggle:0)", + "docComment": "/**\n * Helper method to create a Toggle on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the toggle is associated to.\n *\n * @param properties - Strongly typed Toggle properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function " + }, + { + "kind": "Reference", + "text": "PropertyPaneToggle" + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "targetProperty" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "properties" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" } ], - "isOptional": false, - "isSpread": false, - "type": "string" - }, - "properties": { - "name": "properties", - "description": [ + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 15 + }, + "releaseTag": "Public", + "overloadIndex": 0, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, { - "kind": "text", - "text": "Strongly typed Toggle properties." + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } } ], - "isOptional": false, - "isSpread": false, - "type": "IPropertyPaneToggleProps" - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Helper method to create a Toggle on the PropertyPane." - } - ], - "remarks": [], - "isBeta": false - }, - "WebPartContext": { - "kind": "class", - "extends": "BaseWebPartContext", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client." - } - ], - "remarks": [ - { - "kind": "text", - "text": "The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WebPartContext class." + "name": "PropertyPaneToggle" }, { - "kind": "paragraph" - } - ], - "isBeta": false, - "isSealed": false, - "members": { - "domElement": { - "kind": "property", - "signature": "readonly domElement: HTMLElement;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "HTMLElement", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Reference to the DOM element that hosts this client-side component." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - }, - "microsoftTeams": { - "kind": "property", - "signature": "readonly microsoftTeams: typeof microsoftTeams | undefined;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "typeof microsoftTeams | undefined", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams." + "kind": "Class", + "canonicalReference": "(WebPartContext:class)", + "docComment": "/**\n * Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebPartContext` class.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class " + }, + { + "kind": "Reference", + "text": "WebPartContext" + }, + { + "kind": "Content", + "text": " extends " + }, + { + "kind": "Reference", + "text": "BaseWebPartContext" + }, + { + "kind": "Content", + "text": " " } ], - "remarks": [ + "releaseTag": "Public", + "name": "WebPartContext", + "members": [ { - "kind": "text", - "text": "For more information, please see: " + "kind": "Property", + "canonicalReference": "(domElement:instance)", + "docComment": "/**\n * Reference to the DOM element that hosts this client-side component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "domElement" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "HTMLElement" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false }, { - "kind": "web-link", - "elements": [ + "kind": "Property", + "canonicalReference": "(microsoftTeams:instance)", + "docComment": "/**\n * Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest}\n *\n * @deprecated\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "microsoftTeams" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "microsoftTeams" + }, + { + "kind": "Content", + "text": " | undefined" + }, { - "kind": "text", - "text": "https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest" + "kind": "Content", + "text": ";" } ], - "targetUrl": "https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest" - } - ], - "isBeta": true, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false + "releaseTag": "Public", + "name": "microsoftTeams", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(sdks:instance)", + "docComment": "/**\n * Conditional set of SDKs provided by SPFx dependent on the environment.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "sdks" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "ISDKs" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sdks", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "(statusRenderer:instance)", + "docComment": "/**\n * Web part status renderer.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly " + }, + { + "kind": "Reference", + "text": "statusRenderer" + }, + { + "kind": "Content", + "text": ": " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartStatusRenderer" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "statusRenderer", + "propertyTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [] }, - "statusRenderer": { - "kind": "property", - "signature": "readonly statusRenderer: IClientSideWebPartStatusRenderer;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartStatusRenderer", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part status renderer." - } - ], - "remarks": [], - "isBeta": false, - "isSealed": false, - "isVirtual": false, - "isOverride": false, - "isEventProperty": false - } - } - }, - "WebPartFormFactor": { - "kind": "enum", - "values": { - "FullSize": { - "kind": "enum value", - "value": "1", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Full size form factor. This means the web part is rendered in full size, taking all space available in the page." - } - ], - "remarks": [ + { + "kind": "Enum", + "canonicalReference": "(WebPartFormFactor:enum)", + "docComment": "/**\n * Form factor of the web part.\n *\n * @remarks\n *\n * This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum " + }, { - "kind": "text", - "text": "This is the case for Teams tabs or single web part App pages." + "kind": "Reference", + "text": "WebPartFormFactor" + }, + { + "kind": "Content", + "text": " " } ], - "isBeta": true - }, - "Standard": { - "kind": "enum value", - "value": "0", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height." + "releaseTag": "Beta", + "name": "WebPartFormFactor", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "FullSize", + "docComment": "/**\n * Full size form factor. This means the web part is rendered in full size, taking all space available in the page.\n *\n * @remarks\n *\n * This is the case for Teams tabs or single web part App pages.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "FullSize" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Beta", + "name": "FullSize", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "Standard", + "docComment": "/**\n * Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height.\n */\n", + "excerptTokens": [ + { + "kind": "Reference", + "text": "Standard" + }, + { + "kind": "Content", + "text": " = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Beta", + "name": "Standard", + "initializerTokenRange": { + "startIndex": 2, + "endIndex": 3 + } } - ], - "remarks": [], - "isBeta": true - } - }, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Form factor of the web part." - } - ], - "remarks": [ - { - "kind": "text", - "text": "This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor." + ] } - ], - "isBeta": true + ] } - } + ] } From e5632bce08d766d70b1b17460ad0af600b59f5d2 Mon Sep 17 00:00:00 2001 From: John Nguyen Date: Thu, 16 Jan 2020 15:13:40 -0800 Subject: [PATCH 26/55] Update recopy.bat with missing packages --- generate-docs/json/recopy.bat | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/generate-docs/json/recopy.bat b/generate-docs/json/recopy.bat index 64f57e72..3ff1ff55 100644 --- a/generate-docs/json/recopy.bat +++ b/generate-docs/json/recopy.bat @@ -1,17 +1,23 @@ @echo off -copy /y ..\..\..\sp-client\spfx-core\sp-application-base\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-component-base\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-core-library\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-extension-base\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-http\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-odata-types\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-page-context\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-webpart-base\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\decorators\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-dialog\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\temp\*.api.json . -copy /y ..\..\..\sp-client\spfx-core\sp-diagnostics\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\decorators\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-application-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-component-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-core-library\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-diagnostics\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-dialog\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-dynamic-data\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-extension-base\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-http\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-list-subscription\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-listview-extensibility\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-loader\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-externals\sp-lodash-subset\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-module-interfaces\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-odata-types\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-page-context\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-property-pane\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-search-extensibility\temp\*.api.json . +copy /y ..\..\..\sp-client\spfx-core\sp-webpart-base\temp\*.api.json . pause From 52af7fae9ae01ead2b55c41b080b613ce62b305e Mon Sep 17 00:00:00 2001 From: John Nguyen Date: Thu, 16 Jan 2020 15:13:55 -0800 Subject: [PATCH 27/55] Update AE json files --- generate-docs/json/decorators.api.json | 170 +- .../json/sp-application-base.api.json | 569 +- generate-docs/json/sp-component-base.api.json | 3632 ++++------- generate-docs/json/sp-core-library.api.json | 2799 +++----- generate-docs/json/sp-diagnostics.api.json | 27 +- generate-docs/json/sp-dialog.api.json | 597 +- generate-docs/json/sp-dynamic-data.api.json | 873 ++- generate-docs/json/sp-extension-base.api.json | 124 +- generate-docs/json/sp-http.api.json | 4784 +++++--------- .../json/sp-list-subscription.api.json | 450 ++ .../json/sp-listview-extensibility.api.json | 927 +-- generate-docs/json/sp-loader.api.json | 373 ++ generate-docs/json/sp-lodash-subset.api.json | 73 + .../json/sp-module-interfaces.api.json | 2094 ++++++ generate-docs/json/sp-odata-types.api.json | 1108 +--- generate-docs/json/sp-page-context.api.json | 2365 ++----- generate-docs/json/sp-property-pane.api.json | 5695 +++++++++++++++++ .../json/sp-search-extensibility.api.json | 342 + generate-docs/json/sp-webpart-base.api.json | 3971 ++++-------- 19 files changed, 16019 insertions(+), 14954 deletions(-) create mode 100644 generate-docs/json/sp-list-subscription.api.json create mode 100644 generate-docs/json/sp-loader.api.json create mode 100644 generate-docs/json/sp-lodash-subset.api.json create mode 100644 generate-docs/json/sp-module-interfaces.api.json create mode 100644 generate-docs/json/sp-property-pane.api.json create mode 100644 generate-docs/json/sp-search-extensibility.api.json diff --git a/generate-docs/json/decorators.api.json b/generate-docs/json/decorators.api.json index 38f68356..e72dbc6b 100644 --- a/generate-docs/json/decorators.api.json +++ b/generate-docs/json/decorators.api.json @@ -1,59 +1,37 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/decorators", + "canonicalReference": "@microsoft/decorators!", "docComment": "/**\n * A conservative set of decorators intended for use in both NodeJS and web browser projects.\n *\n * @remarks\n *\n * This package provides a small set of decorators that enable more rigorous specification of API contracts when using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This package is not intended to be a general toolkit of language extensions or helpful macros.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/decorators", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/decorators!", "name": "", "members": [ { "kind": "Function", - "canonicalReference": "(override:0)", + "canonicalReference": "@microsoft/decorators!override:function(1)", "docComment": "/**\n * This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as \\@virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " + "text": "export declare function override(target: " }, { "kind": "Reference", - "text": "override" + "text": "Object", + "canonicalReference": "!Object:interface" }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "target" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Object" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "propertyKey" - }, - { - "kind": "Content", - "text": ": " + "text": ", propertyKey: " }, { "kind": "Content", @@ -61,19 +39,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "descriptor" - }, - { - "kind": "Content", - "text": ": " + "text": ", descriptor: " }, { "kind": "Reference", - "text": "TypedPropertyDescriptor" + "text": "TypedPropertyDescriptor", + "canonicalReference": "!TypedPropertyDescriptor:interface" }, { "kind": "Content", @@ -93,31 +64,31 @@ } ], "returnTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 + "startIndex": 8, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "propertyKey", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "descriptor", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 + "startIndex": 5, + "endIndex": 7 } } ], @@ -125,32 +96,17 @@ }, { "kind": "Function", - "canonicalReference": "(sealed:0)", + "canonicalReference": "@microsoft/decorators!sealed:function(1)", "docComment": "/**\n * This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "sealed" - }, - { - "kind": "Content", - "text": "(" + "text": "export declare function sealed(target: " }, { "kind": "Reference", - "text": "target" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Function" + "text": "Function", + "canonicalReference": "!Function:interface" }, { "kind": "Content", @@ -166,17 +122,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -184,44 +140,21 @@ }, { "kind": "Function", - "canonicalReference": "(virtual:0)", + "canonicalReference": "@microsoft/decorators!virtual:function(1)", "docComment": "/**\n * This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child class. Conversely, if the \\@virtual decorator is NOT applied to a definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "virtual" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "target" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Object" - }, - { - "kind": "Content", - "text": ", " + "text": "export declare function virtual(target: " }, { "kind": "Reference", - "text": "propertyKey" + "text": "Object", + "canonicalReference": "!Object:interface" }, { "kind": "Content", - "text": ": " + "text": ", propertyKey: " }, { "kind": "Content", @@ -229,19 +162,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", descriptor: " }, { "kind": "Reference", - "text": "descriptor" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "TypedPropertyDescriptor" + "text": "TypedPropertyDescriptor", + "canonicalReference": "!TypedPropertyDescriptor:interface" }, { "kind": "Content", @@ -261,31 +187,31 @@ } ], "returnTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 + "startIndex": 8, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "propertyKey", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "descriptor", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 + "startIndex": 5, + "endIndex": 7 } } ], diff --git a/generate-docs/json/sp-application-base.api.json b/generate-docs/json/sp-application-base.api.json index 93b64deb..bacbf049 100644 --- a/generate-docs/json/sp-application-base.api.json +++ b/generate-docs/json/sp-application-base.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-application-base", + "canonicalReference": "@microsoft/sp-application-base!", "docComment": "/**\n * SharePoint Framework support for building and extending client-side applications.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-application-base", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-application-base!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(ApplicationAccessor:class)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationAccessor:class", "docComment": "/**\n * Provides access to the client-side application that is currently running.\n *\n * @remarks\n *\n * The client-side application determines the user experience for an entire web page. (It is a client-side component with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different application.\n *\n * The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "ApplicationAccessor" - }, - { - "kind": "Content", - "text": " " + "text": "export default class ApplicationAccessor " } ], "releaseTag": "Public", @@ -37,24 +30,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationAccessor:constructor(1)", "docComment": "/**\n * Constructs a new instance of the {@link ApplicationAccessor} class.\n *\n * @remarks\n *\n * Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example {@link BaseApplicationCustomizer.context}.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", @@ -62,37 +48,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Property", - "canonicalReference": "(navigatedEvent:instance)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member", "docComment": "/**\n * An event that is fired when the application's top-level page context navigates to a new page.\n *\n * @remarks\n *\n * This event fires after the top-level {@link @microsoft/sp-page-context#PageContext} has navigated to a new page.\n *\n * @eventproperty\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "navigatedEvent" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly navigatedEvent: " }, { "kind": "Reference", - "text": "SPEvent" + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" }, { "kind": "Content", @@ -100,7 +79,8 @@ }, { "kind": "Reference", - "text": "SPEventArgs" + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" }, { "kind": "Content", @@ -114,8 +94,8 @@ "releaseTag": "Public", "name": "navigatedEvent", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false } @@ -124,24 +104,17 @@ }, { "kind": "Class", - "canonicalReference": "(ApplicationCustomizerContext:class)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationCustomizerContext:class", "docComment": "/**\n * The component context for {@link BaseApplicationCustomizer}.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class ApplicationCustomizerContext extends " }, { "kind": "Reference", - "text": "ApplicationCustomizerContext" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "ExtensionContext" + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" }, { "kind": "Content", @@ -153,24 +126,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(application:instance)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationCustomizerContext#application:member", "docComment": "/**\n * Provides access to the client-side application that is currently running.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "application" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly application: " }, { "kind": "Reference", - "text": "ApplicationAccessor" + "text": "ApplicationAccessor", + "canonicalReference": "@microsoft/sp-application-base!default:class" }, { "kind": "Content", @@ -180,23 +146,19 @@ "releaseTag": "Public", "name": "application", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -209,34 +171,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Property", - "canonicalReference": "(placeholderProvider:instance)", + "canonicalReference": "@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member", "docComment": "/**\n * Exposes a collection of content placeholders for use by third parties.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly placeholderProvider: " }, { "kind": "Reference", - "text": "placeholderProvider" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "PlaceholderProvider" + "text": "PlaceholderProvider", + "canonicalReference": "@microsoft/sp-application-base!default:class" }, { "kind": "Content", @@ -246,83 +201,66 @@ "releaseTag": "Public", "name": "placeholderProvider", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(BaseApplicationCustomizer:class)", + "canonicalReference": "@microsoft/sp-application-base!BaseApplicationCustomizer:class", "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting.\n *\n * @remarks\n *\n * In the component manifest, the \"extensionType\" should be set to \"ApplicationCustomizer\".\n *\n * Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " - }, - { - "kind": "Reference", - "text": "BaseApplicationCustomizer" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> extends " - }, - { - "kind": "Reference", - "text": "BaseExtension" - }, - { - "kind": "Content", - "text": "<" + "text": "export default abstract class BaseApplicationCustomizer extends " }, { "kind": "Reference", - "text": "TProperties" + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" }, { "kind": "Content", - "text": "> " + "text": " " } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "BaseApplicationCustomizer", "members": [ { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-application-base!BaseApplicationCustomizer#context:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly context: " }, { "kind": "Reference", - "text": "ApplicationCustomizerContext" + "text": "ApplicationCustomizerContext", + "canonicalReference": "@microsoft/sp-application-base!default:class" }, { "kind": "Content", @@ -332,23 +270,19 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.dispose}\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -361,42 +295,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Method", - "canonicalReference": "(onPlaceholdersChanged:instance,0)", + "canonicalReference": "@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)", "docComment": "/**\n * This event method is called when the placeholders of the host application change, come into existence, or disappear.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " + "text": "protected onPlaceholdersChanged(placeholderProvider: " }, { "kind": "Reference", - "text": "onPlaceholdersChanged" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "placeholderProvider" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "PlaceholderProvider" + "text": "PlaceholderProvider", + "canonicalReference": "@microsoft/sp-application-base!default:class" }, { "kind": "Content", @@ -413,17 +332,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "placeholderProvider", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -431,27 +350,19 @@ } ], "extendsTokenRange": { - "startIndex": 5, - "endIndex": 9 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Interface", - "canonicalReference": "(IPlaceholderCreateContentOptions:interface)", + "canonicalReference": "@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface", "docComment": "/**\n * Options for the {@link PlaceholderProvider.tryCreateContent} method.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPlaceholderCreateContentOptions" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IPlaceholderCreateContentOptions " } ], "releaseTag": "Public", @@ -459,32 +370,21 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "onDispose", + "canonicalReference": "@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member", "docComment": "/**\n * An optional callback that will be invoked when the PlaceholderContent object is disposed.\n *\n * @remarks\n *\n * To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "onDispose" - }, { "kind": "Content", - "text": "?: " + "text": "onDispose?: " }, { "kind": "Content", - "text": "(" + "text": "(placeholderContent: " }, { "kind": "Reference", - "text": "placeholderContent" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "PlaceholderContent" + "text": "PlaceholderContent", + "canonicalReference": "@microsoft/sp-application-base!default:class" }, { "kind": "Content", @@ -498,8 +398,8 @@ "releaseTag": "Public", "name": "onDispose", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } } ], @@ -507,24 +407,17 @@ }, { "kind": "Class", - "canonicalReference": "(PlaceholderContent:class)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent:class", "docComment": "/**\n * Represents custom content that is rendered inside a placeholder on a SharePoint page.\n *\n * @remarks\n *\n * This object is returned by {@link PlaceholderProvider.tryCreateContent}. It provides access to a Document Object Model (DOM) element where the owner can render its custom content.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderContent` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "PlaceholderContent" - }, - { - "kind": "Content", - "text": " implements " + "text": "export default class PlaceholderContent implements " }, { "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -536,16 +429,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)", "docComment": "/**\n * Disposes the PlaceholderContent object and removes its attached DOM element from the page.\n *\n * @remarks\n *\n * This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the application when the containing placeholder is disposed. Calling dispose() invokes the {@link IPlaceholderCreateContentOptions.onDispose} callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -558,34 +447,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Property", - "canonicalReference": "(domElement:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent#domElement:member", "docComment": "/**\n * The Document Object Model (DOM) element where the owner should render its custom content.\n *\n * @remarks\n *\n * If the caller needs to be notified when the DOM element is disposed, use the {@link IPlaceholderCreateContentOptions.onDispose} callback.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "domElement" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly domElement: " }, { "kind": "Reference", - "text": "HTMLDivElement" + "text": "HTMLDivElement", + "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", @@ -595,27 +477,19 @@ "releaseTag": "Public", "name": "domElement", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent#isDisposed:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -629,27 +503,19 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isVisible:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent#isVisible:member", "docComment": "/**\n * Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isVisible" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isVisible: " }, { "kind": "Content", @@ -663,31 +529,24 @@ "releaseTag": "Public", "name": "isVisible", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(name:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent#name:member", "docComment": "/**\n * Identifies the placeholder that this content was added to.\n *\n * @remarks\n *\n * Example: PlaceholderName.Top\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly name: " }, { "kind": "Reference", - "text": "name" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "PlaceholderName" + "text": "PlaceholderName", + "canonicalReference": "@microsoft/sp-application-base!~PlaceholderName:enum" }, { "kind": "Content", @@ -697,35 +556,27 @@ "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Enum", - "canonicalReference": "(PlaceholderName:enum)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderName:enum", "docComment": "/**\n * The identifier for a content placeholder, which is a region on the page where third-party extensibility components can render custom content.\n *\n * @remarks\n *\n * For more information about placeholders, see {@link PlaceholderProvider}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "declare enum " - }, - { - "kind": "Reference", - "text": "PlaceholderName" - }, - { - "kind": "Content", - "text": " " + "text": "declare enum PlaceholderName " } ], "releaseTag": "Public", @@ -733,16 +584,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "Bottom", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderName.Bottom:member", "docComment": "/**\n * A region at the bottom of the page.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Bottom" - }, { "kind": "Content", - "text": " = " + "text": "Bottom = " }, { "kind": "Content", @@ -752,22 +599,18 @@ "releaseTag": "Public", "name": "Bottom", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Top", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderName.Top:member", "docComment": "/**\n * A region at the top of the page.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Top" - }, { "kind": "Content", - "text": " = " + "text": "Top = " }, { "kind": "Content", @@ -777,32 +620,25 @@ "releaseTag": "Public", "name": "Top", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Class", - "canonicalReference": "(PlaceholderProvider:class)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider:class", "docComment": "/**\n * Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page.\n *\n * @remarks\n *\n * Placeholders are designated regions on the page, identified by one of the predefined {@link PlaceholderName} constants. Different applications and pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, for example via in-place navigation. Third-party components should not assume that a given placeholder will always be available.\n *\n * Use {@link PlaceholderProvider.tryCreateContent} to test whether a placeholder is available and add content to it. Use the {@link PlaceholderProvider.changedEvent} event to discover when new placeholders appear.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderProvider` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "PlaceholderProvider" - }, - { - "kind": "Content", - "text": " implements " + "text": "export default class PlaceholderProvider implements " }, { "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -814,24 +650,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(changedEvent:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member", "docComment": "/**\n * This event is raised when the list of currently available placeholders is changed.\n *\n * @remarks\n *\n * The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear.\n *\n * @eventproperty\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly changedEvent: " }, { "kind": "Reference", - "text": "changedEvent" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPEvent" + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" }, { "kind": "Content", @@ -839,7 +668,8 @@ }, { "kind": "Reference", - "text": "SPEventArgs" + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" }, { "kind": "Content", @@ -853,23 +683,19 @@ "releaseTag": "Public", "name": "changedEvent", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -882,30 +708,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -919,31 +737,24 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(placeholderNames:instance)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member", "docComment": "/**\n * Returns the names of the currently available placeholders.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "placeholderNames" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly placeholderNames: " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -951,7 +762,8 @@ }, { "kind": "Reference", - "text": "PlaceholderName" + "text": "PlaceholderName", + "canonicalReference": "@microsoft/sp-application-base!~PlaceholderName:enum" }, { "kind": "Content", @@ -965,51 +777,33 @@ "releaseTag": "Public", "name": "placeholderNames", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(tryCreateContent:instance,0)", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)", "docComment": "/**\n * Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder.\n *\n * @remarks\n *\n * The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder.\n *\n * @param name - The requested placeholder\n *\n * @param options - Additional options, for example to detect when the placeholder is disposed.\n *\n * @returns A new PlaceholderContent object, or undefined if the requested placeholder does not exist.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryCreateContent" - }, { "kind": "Content", - "text": "(" + "text": "tryCreateContent(name: " }, { "kind": "Reference", - "text": "name" + "text": "PlaceholderName", + "canonicalReference": "@microsoft/sp-application-base!~PlaceholderName:enum" }, { "kind": "Content", - "text": ": " + "text": ", options?: " }, { "kind": "Reference", - "text": "PlaceholderName" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "IPlaceholderCreateContentOptions" + "text": "IPlaceholderCreateContentOptions", + "canonicalReference": "@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface" }, { "kind": "Content", @@ -1017,7 +811,8 @@ }, { "kind": "Reference", - "text": "PlaceholderContent" + "text": "PlaceholderContent", + "canonicalReference": "@microsoft/sp-application-base!default:class" }, { "kind": "Content", @@ -1030,24 +825,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -1056,8 +851,8 @@ ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] } diff --git a/generate-docs/json/sp-component-base.api.json b/generate-docs/json/sp-component-base.api.json index 5ee4cf76..6b62d508 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -1,39 +1,33 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-component-base", + "canonicalReference": "@microsoft/sp-component-base!", "docComment": "/**\n * SharePoint Framework support for building client-side components\n *\n * @remarks\n *\n * This package supports development of client-side components (e.g. web parts, client-side extensions, and applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-component-base", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-component-base!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(BaseComponent:class)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent:class", "docComment": "/**\n * The base class for client-side components such as BaseClientSideWebPart or BaseExtension.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponent` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " + "text": "export default abstract class BaseComponent implements " }, { "kind": "Reference", - "text": "BaseComponent" - }, - { - "kind": "Content", - "text": " implements " - }, - { - "kind": "Reference", - "text": "ISPEventObserver" + "text": "ISPEventObserver", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver:interface" }, { "kind": "Content", @@ -45,20 +39,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(componentId:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#componentId:member", "docComment": "/**\n * Returns the component identifier as defined in the component’s associated manifest.\n *\n * @remarks\n *\n * Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "componentId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly componentId: " }, { "kind": "Content", @@ -72,31 +58,24 @@ "releaseTag": "Public", "name": "componentId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#context:member", "docComment": "/**\n * Use the context object to access common services and state associated with the component.\n *\n * @remarks\n *\n * Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " + "text": "protected context: " }, { "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "BaseComponentContext" + "text": "BaseComponentContext", + "canonicalReference": "@microsoft/sp-component-base!~BaseComponentContext:class" }, { "kind": "Content", @@ -106,23 +85,19 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#dispose:member(1)", "docComment": "/**\n * Disposes the component.\n *\n * @remarks\n *\n * Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the {@link BaseComponent.onDispose} method.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -135,30 +110,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Property", - "canonicalReference": "(instanceId:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#instanceId:member", "docComment": "/**\n * A unique identifier for the instance of the component.\n *\n * @remarks\n *\n * A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "instanceId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly instanceId: " }, { "kind": "Content", @@ -172,27 +139,19 @@ "releaseTag": "Public", "name": "instanceId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#isDisposed:member", "docComment": "/**\n * Returns true if the component has been already disposed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -206,31 +165,24 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(manifest:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#manifest:member", "docComment": "/**\n * Provides access to the manifest for the client-side component.\n *\n * @remarks\n *\n * Child classes can override this with more specialized manifest types.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "manifest" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly manifest: " }, { "kind": "Reference", - "text": "IClientSideComponentManifest" + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" }, { "kind": "Content", @@ -240,27 +192,19 @@ "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(onDispose:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent#onDispose:member(1)", "docComment": "/**\n * This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onDispose" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onDispose(): " }, { "kind": "Content", @@ -273,42 +217,35 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onDispose" } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(BaseComponentContext:class)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext:class", "docComment": "/**\n * The base class for context objects for client-side components.\n *\n * @remarks\n *\n * A \"context\" object is a collection of well-known services and other objects that are likely to be needed by business logic that interacts with a associated component. Each component type has its own specialized subclass of BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponentContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "declare abstract class " + "text": "declare abstract class BaseComponentContext implements " }, { "kind": "Reference", - "text": "BaseComponentContext" - }, - { - "kind": "Content", - "text": " implements " - }, - { - "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -320,24 +257,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(aadHttpClientFactory:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member", "docComment": "/**\n * The instance of AadHttpClientFactory created for this instance of component\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "aadHttpClientFactory" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly aadHttpClientFactory: " }, { "kind": "Reference", - "text": "AadHttpClientFactory" + "text": "AadHttpClientFactory", + "canonicalReference": "@microsoft/sp-http!AadHttpClientFactory:class" }, { "kind": "Content", @@ -347,31 +277,24 @@ "releaseTag": "Public", "name": "aadHttpClientFactory", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(aadTokenProviderFactory:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member", "docComment": "/**\n * The instance of AadTokenProviderFactory created for this instance of component\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "aadTokenProviderFactory" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly aadTokenProviderFactory: " }, { "kind": "Reference", - "text": "AadTokenProviderFactory" + "text": "AadTokenProviderFactory", + "canonicalReference": "@microsoft/sp-http!AadTokenProviderFactory:class" }, { "kind": "Content", @@ -381,23 +304,19 @@ "releaseTag": "Public", "name": "aadTokenProviderFactory", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)", "docComment": "/**\n * Disposes the base component context.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -410,34 +329,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Property", - "canonicalReference": "(dynamicDataProvider:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member", "docComment": "/**\n * Returns the Dynamic Data Provider associated with the component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "dynamicDataProvider" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly dynamicDataProvider: " }, { "kind": "Reference", - "text": "DynamicDataProvider" + "text": "DynamicDataProvider", + "canonicalReference": "@microsoft/sp-component-base!default:class" }, { "kind": "Content", @@ -447,31 +359,24 @@ "releaseTag": "Public", "name": "dynamicDataProvider", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(dynamicDataSourceManager:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member", "docComment": "/**\n * Returns the Dynamic Data Source Manager associated with the component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "dynamicDataSourceManager" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly dynamicDataSourceManager: " }, { "kind": "Reference", - "text": "DynamicDataSourceManager" + "text": "DynamicDataSourceManager", + "canonicalReference": "@microsoft/sp-component-base!default:class" }, { "kind": "Content", @@ -481,31 +386,24 @@ "releaseTag": "Public", "name": "dynamicDataSourceManager", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(httpClient:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#httpClient:member", "docComment": "/**\n * The instance of HttpClient created for this instance of component\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly httpClient: " }, { "kind": "Reference", - "text": "httpClient" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "HttpClient" + "text": "HttpClient", + "canonicalReference": "@microsoft/sp-http!HttpClient:class" }, { "kind": "Content", @@ -515,27 +413,19 @@ "releaseTag": "Public", "name": "httpClient", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(instanceId:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#instanceId:member", "docComment": "/**\n * A unique identifier for the instance of the component.\n *\n * @remarks\n *\n * A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "instanceId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly instanceId: " }, { "kind": "Content", @@ -549,27 +439,19 @@ "releaseTag": "Public", "name": "instanceId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#isDisposed:member", "docComment": "/**\n * Returns true if the context is disposed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -583,31 +465,24 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(manifest:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#manifest:member", "docComment": "/**\n * Manifest for the client-side component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly manifest: " }, { "kind": "Reference", - "text": "manifest" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IClientSideComponentManifest" + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" }, { "kind": "Content", @@ -617,31 +492,24 @@ "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(msGraphClientFactory:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member", "docComment": "/**\n * The instance of MSGraphClientFactory created for this instance of component\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly msGraphClientFactory: " }, { "kind": "Reference", - "text": "msGraphClientFactory" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "MSGraphClientFactory" + "text": "MSGraphClientFactory", + "canonicalReference": "@microsoft/sp-http!MSGraphClientFactory:class" }, { "kind": "Content", @@ -651,31 +519,24 @@ "releaseTag": "Public", "name": "msGraphClientFactory", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(pageContext:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#pageContext:member", "docComment": "/**\n * The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "pageContext" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly pageContext: " }, { "kind": "Reference", - "text": "PageContext" + "text": "PageContext", + "canonicalReference": "@microsoft/sp-page-context!PageContext:class" }, { "kind": "Content", @@ -685,31 +546,24 @@ "releaseTag": "Public", "name": "pageContext", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(serviceScope:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#serviceScope:member", "docComment": "/**\n * The associated {@link @microsoft/sp-core-library#ServiceScope} for this component.\n *\n * @remarks\n *\n * A child service scope is created for each client-side component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly serviceScope: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", @@ -719,31 +573,24 @@ "releaseTag": "Public", "name": "serviceScope", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(spHttpClient:instance)", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member", "docComment": "/**\n * The instance of SpHttpClient created for this instance of component\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly spHttpClient: " }, { "kind": "Reference", - "text": "spHttpClient" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClient" + "text": "SPHttpClient", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:class" }, { "kind": "Content", @@ -753,39 +600,32 @@ "releaseTag": "Public", "name": "spHttpClient", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(DynamicDataProvider:class)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider:class", "docComment": "/**\n * The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class DynamicDataProvider implements " }, { "kind": "Reference", - "text": "DynamicDataProvider" - }, - { - "kind": "Content", - "text": " implements " - }, - { - "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -797,16 +637,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)", "docComment": "/**\n * Disposes the Dynamic Data Provider.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -819,30 +655,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Method", - "canonicalReference": "(getAvailableSources:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)", "docComment": "/**\n * Returns a list with all available Dynamic Data Sources.\n *\n * @returns Read-only array with all available sources.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getAvailableSources" - }, { "kind": "Content", - "text": "(): " + "text": "getAvailableSources(): " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -850,7 +683,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataSource" + "text": "IDynamicDataSource", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface" }, { "kind": "Content", @@ -863,30 +697,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getAvailableSources" }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member", "docComment": "/**\n * Returns true if the Dynamic Data Provider is disposed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -900,31 +726,19 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(registerAvailableSourcesChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)", "docComment": "/**\n * Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated.\n *\n * @param callback - Function to execute when the sources are updated.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "registerAvailableSourcesChanged" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, { "kind": "Content", - "text": ": " + "text": "registerAvailableSourcesChanged(callback: " }, { "kind": "Content", @@ -945,17 +759,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -963,24 +777,12 @@ }, { "kind": "Method", - "canonicalReference": "(registerPropertyChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)", "docComment": "/**\n * Registers a callback for updates when a property is changed in a Dynamic Data source.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param propertyId - Id of the property of the source.\n *\n * @param callback - Function to execute when the source updates its data.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "registerPropertyChanged" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceId" - }, { "kind": "Content", - "text": ": " + "text": "registerPropertyChanged(sourceId: " }, { "kind": "Content", @@ -988,15 +790,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "propertyId" - }, - { - "kind": "Content", - "text": ": " + "text": ", propertyId: " }, { "kind": "Content", @@ -1004,15 +798,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": ": " + "text": ", callback: " }, { "kind": "Content", @@ -1033,31 +819,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1065,24 +851,12 @@ }, { "kind": "Method", - "canonicalReference": "(registerSourceChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)", "docComment": "/**\n * Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param callback - Function to execute when the source updates its data.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "registerSourceChanged" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceId" - }, - { - "kind": "Content", - "text": ": " + "text": "registerSourceChanged(sourceId: " }, { "kind": "Content", @@ -1090,15 +864,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": ": " + "text": ", callback: " }, { "kind": "Content", @@ -1119,24 +885,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -1144,24 +910,12 @@ }, { "kind": "Method", - "canonicalReference": "(tryGetSource:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)", "docComment": "/**\n * Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.\n *\n * @param id - Id of the Dynamic Data Source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetSource" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "id" - }, { "kind": "Content", - "text": ": " + "text": "tryGetSource(id: " }, { "kind": "Content", @@ -1173,7 +927,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataSource" + "text": "IDynamicDataSource", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface" }, { "kind": "Content", @@ -1186,17 +941,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1204,24 +959,12 @@ }, { "kind": "Method", - "canonicalReference": "(unregisterAvailableSourcesChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)", "docComment": "/**\n * Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated.\n *\n * @param callback - Function to remove from the registration. Must be the same it was registered with.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "unregisterAvailableSourcesChanged" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": ": " + "text": "unregisterAvailableSourcesChanged(callback: " }, { "kind": "Content", @@ -1242,17 +985,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1260,24 +1003,12 @@ }, { "kind": "Method", - "canonicalReference": "(unregisterPropertyChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)", "docComment": "/**\n * Unregisters a callback for updates when a property is changed in a Dynamic Data source.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param propertyId - Id of the property of the source.\n *\n * @param callback - Function to remove from the registration. Must be the same it was registered with.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "unregisterPropertyChanged" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceId" - }, - { - "kind": "Content", - "text": ": " + "text": "unregisterPropertyChanged(sourceId: " }, { "kind": "Content", @@ -1285,15 +1016,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "propertyId" - }, - { - "kind": "Content", - "text": ": " + "text": ", propertyId: " }, { "kind": "Content", @@ -1301,15 +1024,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": ": " + "text": ", callback: " }, { "kind": "Content", @@ -1330,31 +1045,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1362,24 +1077,12 @@ }, { "kind": "Method", - "canonicalReference": "(unregisterSourceChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)", "docComment": "/**\n * Unregisters a callback for updates when a Dynamic Data source is changed.\n *\n * @param sourceId - Id of the Dynamic Data Source.\n *\n * @param callback - Function to remove from the registration. Must be the same it was registered with.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "unregisterSourceChanged" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceId" - }, - { - "kind": "Content", - "text": ": " + "text": "unregisterSourceChanged(sourceId: " }, { "kind": "Content", @@ -1387,15 +1090,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": ": " + "text": ", callback: " }, { "kind": "Content", @@ -1416,24 +1111,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -1442,31 +1137,24 @@ ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(DynamicDataSourceManager:class)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager:class", "docComment": "/**\n * The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class DynamicDataSourceManager implements " }, { "kind": "Reference", - "text": "DynamicDataSourceManager" - }, - { - "kind": "Content", - "text": " implements " - }, - { - "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -1478,16 +1166,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)", "docComment": "/**\n * Disposes the resources held by the Dynamic Data source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -1500,38 +1184,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Method", - "canonicalReference": "(initializeSource:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)", "docComment": "/**\n * Initializes the Dynamic Data Source for the component.\n *\n * @param callableFunctions - Set of methods that are exposed through the Dynamic Data Source\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "initializeSource" - }, { "kind": "Content", - "text": "(" + "text": "initializeSource(callableFunctions: " }, { "kind": "Reference", - "text": "callableFunctions" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IDynamicDataCallables" + "text": "IDynamicDataCallables", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables:interface" }, { "kind": "Content", @@ -1548,17 +1221,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callableFunctions", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1566,20 +1239,12 @@ }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member", "docComment": "/**\n * Returns true if the DynamicDataSourceManager is disposed.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, + "excerptTokens": [ { "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -1593,31 +1258,19 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(notifyPropertyChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)", "docComment": "/**\n * Notifies that this source has updated a specific property.\n *\n * When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.\n *\n * @param propertyId - Id of the updated property in the source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "notifyPropertyChanged" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "propertyId" - }, { "kind": "Content", - "text": ": " + "text": "notifyPropertyChanged(propertyId: " }, { "kind": "Content", @@ -1638,17 +1291,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1656,16 +1309,12 @@ }, { "kind": "Method", - "canonicalReference": "(notifySourceChanged:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)", "docComment": "/**\n * Notifies that this source has updated its properties.\n *\n * When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "notifySourceChanged" - }, { "kind": "Content", - "text": "(): " + "text": "notifySourceChanged(): " }, { "kind": "Content", @@ -1678,30 +1327,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "notifySourceChanged" }, { "kind": "Property", - "canonicalReference": "(sourceId:instance)", - "docComment": "/**\n * Returns the Id of the current DataSource.\n */\n", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member", + "docComment": "/**\n * Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "sourceId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly sourceId: " }, { "kind": "Content", @@ -1715,35 +1356,24 @@ "releaseTag": "Public", "name": "sourceId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(updateMetadata:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)", "docComment": "/**\n * Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated.\n *\n * @param metadata - Partial of the metadata.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "updateMetadata" - }, { "kind": "Content", - "text": "(" + "text": "updateMetadata(metadata: " }, { "kind": "Reference", - "text": "metadata" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Partial" + "text": "Partial", + "canonicalReference": "!Partial:type" }, { "kind": "Content", @@ -1751,7 +1381,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataSourceMetadata" + "text": "IDynamicDataSourceMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface" }, { "kind": "Content", @@ -1772,17 +1403,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 6, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "metadata", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 8 + "startIndex": 1, + "endIndex": 5 } } ], @@ -1791,39 +1422,24 @@ ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(DynamicProperty:class)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty:class", "docComment": "/**\n * Serializable object that simplifies usage of a DynamicProperty.\n *\n * @remarks\n *\n * This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "DynamicProperty" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TValue" - }, - { - "kind": "Content", - "text": "> implements " + "text": "export default class DynamicProperty implements " }, { "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -1831,40 +1447,38 @@ } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TValue", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "DynamicProperty", "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty:constructor(1)", "docComment": "/**\n * Create a new DynamicProperty object.\n *\n * @param provider - DynamicDataProvider.\n *\n * @param callback - Optional. Default callback to be registered for updates in the DynamicDataSource.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "provider" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "DynamicDataProvider" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(provider: " }, { "kind": "Reference", - "text": "callback" + "text": "DynamicDataProvider", + "canonicalReference": "@microsoft/sp-component-base!default:class" }, { "kind": "Content", - "text": "?: " + "text": ", callback?: " }, { "kind": "Content", @@ -1876,36 +1490,32 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "provider", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Method", - "canonicalReference": "(dispose:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#dispose:member(1)", "docComment": "/**\n * {@inheritDoc @microsoft/sp-core-library#IDisposable.dispose}\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -1918,26 +1528,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "Method", - "canonicalReference": "(hasDefaultCallback:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)", "docComment": "/**\n * Returns true if the object has a default callback.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "hasDefaultCallback" - }, { "kind": "Content", - "text": "(): " + "text": "hasDefaultCallback(): " }, { "kind": "Content", @@ -1950,30 +1556,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "hasDefaultCallback" }, { "kind": "Property", - "canonicalReference": "(isDisposed:instance)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#isDisposed:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-core-library#IDisposable.isDisposed}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isDisposed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isDisposed: " }, { "kind": "Content", @@ -1987,27 +1585,19 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(reference:instance)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#reference:member", "docComment": "/**\n * DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`.\n *\n * @remarks\n *\n * If the DynamicProperty is set up with static data, this returns undefined.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "reference" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly reference: " }, { "kind": "Content", @@ -2021,31 +1611,19 @@ "releaseTag": "Public", "name": "reference", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(register:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#register:member(1)", "docComment": "/**\n * Registers a callback function for updates on the associated DynamicDataSource.\n *\n * @param callback - Callback function to register.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "register" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, { "kind": "Content", - "text": ": " + "text": "register(callback: " }, { "kind": "Content", @@ -2066,17 +1644,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2084,16 +1662,12 @@ }, { "kind": "Method", - "canonicalReference": "(removeDefaultCallback:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)", "docComment": "/**\n * Removes the registration for the default callback.\n *\n * @remarks\n *\n * This can be useful for advanced users who only want their custom callbacks.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "removeDefaultCallback" - }, { "kind": "Content", - "text": "(): " + "text": "removeDefaultCallback(): " }, { "kind": "Content", @@ -2106,34 +1680,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "removeDefaultCallback" }, { "kind": "Method", - "canonicalReference": "(setReference:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#setReference:member(1)", "docComment": "/**\n * Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`.\n *\n * @param reference - Id of the DynamicDataSource and property.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "setReference" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "reference" - }, { "kind": "Content", - "text": ": " + "text": "setReference(reference: " }, { "kind": "Content", @@ -2154,17 +1716,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2172,27 +1734,15 @@ }, { "kind": "Method", - "canonicalReference": "(setValue:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#setValue:member(1)", "docComment": "/**\n * Sets a static value in the DynamicProperty.\n *\n * @param value - Value for the DynamicProperty.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "setValue" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "value" + "text": "setValue(value: " }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", "text": "TValue" }, { @@ -2210,17 +1760,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2228,20 +1778,17 @@ }, { "kind": "Method", - "canonicalReference": "(tryGetSource:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)", "docComment": "/**\n * Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetSource" - }, { "kind": "Content", - "text": "(): " + "text": "tryGetSource(): " }, { "kind": "Reference", - "text": "IDynamicDataSource" + "text": "IDynamicDataSource", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface" }, { "kind": "Content", @@ -2254,34 +1801,26 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "tryGetSource" }, { "kind": "Method", - "canonicalReference": "(tryGetValue:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)", "docComment": "/**\n * Returns the value of the object.\n *\n * @remarks\n *\n * If the value is an array, then the first element of the array is returned; otherwise, the value itself is returned.\n *\n * NOTE: This api will never return an array. To retrieve an array value, use the {@link DynamicProperty.tryGetValues} API.\n *\n * @returns the value associated with the dynamic property or undefined if the source or the data doesn't exist.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetValue" - }, { "kind": "Content", - "text": "(): " - }, - { - "kind": "Reference", - "text": "TValue" + "text": "tryGetValue(): " }, { "kind": "Content", - "text": " | undefined" + "text": "TValue | undefined" }, { "kind": "Content", @@ -2290,34 +1829,26 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "tryGetValue" }, { "kind": "Method", - "canonicalReference": "(tryGetValues:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)", "docComment": "/**\n * Returns the value of the object.\n *\n * @remarks\n *\n * If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the value itself is returned. If the property is undefined or cannot be found, an empty array will be returned.\n *\n * NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the {@link DynamicProperty.tryGetValue} API.\n *\n * @returns the value associated with the dynamic property or an empty array if the source or the data doesn't exist.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetValues" - }, { "kind": "Content", - "text": "(): " - }, - { - "kind": "Reference", - "text": "TValue" + "text": "tryGetValues(): " }, { "kind": "Content", - "text": "[]" + "text": "TValue[]" }, { "kind": "Content", @@ -2326,34 +1857,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "tryGetValues" }, { "kind": "Method", - "canonicalReference": "(unregister:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#unregister:member(1)", "docComment": "/**\n * Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with.\n *\n * @param callback - Callback function to unregister.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "unregister" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, { "kind": "Content", - "text": ": " + "text": "unregister(callback: " }, { "kind": "Content", @@ -2374,17 +1893,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2393,27 +1912,19 @@ ], "implementsTokenRanges": [ { - "startIndex": 5, - "endIndex": 7 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(IFontStyles:interface)", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles:interface", "docComment": "/**\n * Font styles for different sizes.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IFontStyles" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IFontStyles " } ], "releaseTag": "Public", @@ -2421,20 +1932,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "large", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#large:member", "docComment": "/**\n * Large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "large" - }, { "kind": "Content", - "text": ": " + "text": "large: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2444,26 +1952,23 @@ "releaseTag": "Public", "name": "large", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "medium", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#medium:member", "docComment": "/**\n * Medium font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "medium" - }, { "kind": "Content", - "text": ": " + "text": "medium: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2473,26 +1978,23 @@ "releaseTag": "Public", "name": "medium", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "mediumPlus", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#mediumPlus:member", "docComment": "/**\n * Larger than medium but smaller than large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "mediumPlus" - }, { "kind": "Content", - "text": ": " + "text": "mediumPlus: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2502,26 +2004,23 @@ "releaseTag": "Public", "name": "mediumPlus", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "mega", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#mega:member", "docComment": "/**\n * Mega sized font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "mega" - }, { "kind": "Content", - "text": ": " + "text": "mega: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2531,26 +2030,23 @@ "releaseTag": "Public", "name": "mega", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "small", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#small:member", "docComment": "/**\n * Small font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "small" - }, { "kind": "Content", - "text": ": " + "text": "small: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2560,26 +2056,23 @@ "releaseTag": "Public", "name": "small", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "smallPlus", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#smallPlus:member", "docComment": "/**\n * Larger than small but smaller than medium font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "smallPlus" - }, { "kind": "Content", - "text": ": " + "text": "smallPlus: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2589,26 +2082,23 @@ "releaseTag": "Public", "name": "smallPlus", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "superLarge", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#superLarge:member", "docComment": "/**\n * Super large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "superLarge" - }, { "kind": "Content", - "text": ": " + "text": "superLarge: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2618,26 +2108,23 @@ "releaseTag": "Public", "name": "superLarge", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "tiny", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#tiny:member", "docComment": "/**\n * Tiny font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tiny" - }, { "kind": "Content", - "text": ": " + "text": "tiny: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2647,26 +2134,23 @@ "releaseTag": "Public", "name": "tiny", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "xLarge", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#xLarge:member", "docComment": "/**\n * Extra large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "xLarge" - }, { "kind": "Content", - "text": ": " + "text": "xLarge: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2676,26 +2160,23 @@ "releaseTag": "Public", "name": "xLarge", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "xSmall", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#xSmall:member", "docComment": "/**\n * Extra small font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "xSmall" - }, { "kind": "Content", - "text": ": " + "text": "xSmall: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2705,26 +2186,23 @@ "releaseTag": "Public", "name": "xSmall", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "xxLarge", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#xxLarge:member", "docComment": "/**\n * Extra extra large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "xxLarge" - }, { "kind": "Content", - "text": ": " + "text": "xxLarge: " }, { "kind": "Reference", - "text": "IRawStyle" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", @@ -2734,8 +2212,8 @@ "releaseTag": "Public", "name": "xxLarge", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2743,20 +2221,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IPalette:interface)", + "canonicalReference": "@microsoft/sp-component-base!IPalette:interface", "docComment": "/**\n * Color palette.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPalette" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IPalette " } ], "releaseTag": "Public", @@ -2764,16 +2234,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "accent", + "canonicalReference": "@microsoft/sp-component-base!IPalette#accent:member", "docComment": "/**\n * Color code for the accent.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "accent" - }, { "kind": "Content", - "text": ": " + "text": "accent: " }, { "kind": "Content", @@ -2787,22 +2253,18 @@ "releaseTag": "Public", "name": "accent", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "black", + "canonicalReference": "@microsoft/sp-component-base!IPalette#black:member", "docComment": "/**\n * Color code for the strongest color, which is black in the default theme. This is a very light color in inverted themes.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "black" - }, { "kind": "Content", - "text": ": " + "text": "black: " }, { "kind": "Content", @@ -2816,22 +2278,18 @@ "releaseTag": "Public", "name": "black", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "blackTranslucent40", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blackTranslucent40:member", "docComment": "/**\n * Color code for blackTranslucent40.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blackTranslucent40" - }, { "kind": "Content", - "text": ": " + "text": "blackTranslucent40: " }, { "kind": "Content", @@ -2845,22 +2303,18 @@ "releaseTag": "Public", "name": "blackTranslucent40", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "blue", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blue:member", "docComment": "/**\n * Color code for blue.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blue" - }, { "kind": "Content", - "text": ": " + "text": "blue: " }, { "kind": "Content", @@ -2874,22 +2328,18 @@ "releaseTag": "Public", "name": "blue", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "blueDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blueDark:member", "docComment": "/**\n * Color code for blueDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blueDark" - }, { "kind": "Content", - "text": ": " + "text": "blueDark: " }, { "kind": "Content", @@ -2903,22 +2353,18 @@ "releaseTag": "Public", "name": "blueDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "blueLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blueLight:member", "docComment": "/**\n * Color code for blueLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blueLight" - }, { "kind": "Content", - "text": ": " + "text": "blueLight: " }, { "kind": "Content", @@ -2932,22 +2378,18 @@ "releaseTag": "Public", "name": "blueLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "blueMid", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blueMid:member", "docComment": "/**\n * Color code for blueMid.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blueMid" - }, { "kind": "Content", - "text": ": " + "text": "blueMid: " }, { "kind": "Content", @@ -2961,22 +2403,18 @@ "releaseTag": "Public", "name": "blueMid", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "green", + "canonicalReference": "@microsoft/sp-component-base!IPalette#green:member", "docComment": "/**\n * Color code for green.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "green" - }, { "kind": "Content", - "text": ": " + "text": "green: " }, { "kind": "Content", @@ -2990,22 +2428,18 @@ "releaseTag": "Public", "name": "green", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "greenDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#greenDark:member", "docComment": "/**\n * Color code for greenDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "greenDark" - }, { "kind": "Content", - "text": ": " + "text": "greenDark: " }, { "kind": "Content", @@ -3019,22 +2453,18 @@ "releaseTag": "Public", "name": "greenDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "greenLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#greenLight:member", "docComment": "/**\n * Color code for greenLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "greenLight" - }, { "kind": "Content", - "text": ": " + "text": "greenLight: " }, { "kind": "Content", @@ -3048,22 +2478,18 @@ "releaseTag": "Public", "name": "greenLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "magenta", + "canonicalReference": "@microsoft/sp-component-base!IPalette#magenta:member", "docComment": "/**\n * Color code for magenta.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "magenta" - }, { "kind": "Content", - "text": ": " + "text": "magenta: " }, { "kind": "Content", @@ -3077,22 +2503,18 @@ "releaseTag": "Public", "name": "magenta", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "magentaDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#magentaDark:member", "docComment": "/**\n * Color code for magentaDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "magentaDark" - }, { "kind": "Content", - "text": ": " + "text": "magentaDark: " }, { "kind": "Content", @@ -3106,22 +2528,18 @@ "releaseTag": "Public", "name": "magentaDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "magentaLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#magentaLight:member", "docComment": "/**\n * Color code for magentaLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "magentaLight" - }, { "kind": "Content", - "text": ": " + "text": "magentaLight: " }, { "kind": "Content", @@ -3135,22 +2553,18 @@ "releaseTag": "Public", "name": "magentaLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralDark:member", "docComment": "/**\n * Color code for neutralDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralDark" - }, { "kind": "Content", - "text": ": " + "text": "neutralDark: " }, { "kind": "Content", @@ -3164,22 +2578,18 @@ "releaseTag": "Public", "name": "neutralDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralLight:member", "docComment": "/**\n * Color code for neutralLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralLight" - }, { "kind": "Content", - "text": ": " + "text": "neutralLight: " }, { "kind": "Content", @@ -3193,22 +2603,18 @@ "releaseTag": "Public", "name": "neutralLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralLighter", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralLighter:member", "docComment": "/**\n * Color code for neutralLighter.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralLighter" - }, { "kind": "Content", - "text": ": " + "text": "neutralLighter: " }, { "kind": "Content", @@ -3222,22 +2628,18 @@ "releaseTag": "Public", "name": "neutralLighter", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralLighterAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralLighterAlt:member", "docComment": "/**\n * Color code for neutralLighterAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralLighterAlt" - }, { "kind": "Content", - "text": ": " + "text": "neutralLighterAlt: " }, { "kind": "Content", @@ -3251,22 +2653,18 @@ "releaseTag": "Public", "name": "neutralLighterAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralPrimary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralPrimary:member", "docComment": "/**\n * Color code for neutralPrimary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralPrimary" - }, { "kind": "Content", - "text": ": " + "text": "neutralPrimary: " }, { "kind": "Content", @@ -3280,22 +2678,18 @@ "releaseTag": "Public", "name": "neutralPrimary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralPrimaryAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member", "docComment": "/**\n * Color code for neutralPrimaryAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralPrimaryAlt" - }, { "kind": "Content", - "text": ": " + "text": "neutralPrimaryAlt: " }, { "kind": "Content", @@ -3309,22 +2703,18 @@ "releaseTag": "Public", "name": "neutralPrimaryAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralQuaternary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralQuaternary:member", "docComment": "/**\n * Color code for neutralQuaternary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralQuaternary" - }, { "kind": "Content", - "text": ": " + "text": "neutralQuaternary: " }, { "kind": "Content", @@ -3338,22 +2728,18 @@ "releaseTag": "Public", "name": "neutralQuaternary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralQuaternaryAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member", "docComment": "/**\n * Color code for neutralQuaternaryAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralQuaternaryAlt" - }, { "kind": "Content", - "text": ": " + "text": "neutralQuaternaryAlt: " }, { "kind": "Content", @@ -3367,22 +2753,18 @@ "releaseTag": "Public", "name": "neutralQuaternaryAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralSecondary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralSecondary:member", "docComment": "/**\n * Color code for neutralSecondary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralSecondary" - }, { "kind": "Content", - "text": ": " + "text": "neutralSecondary: " }, { "kind": "Content", @@ -3396,22 +2778,18 @@ "releaseTag": "Public", "name": "neutralSecondary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralSecondaryAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member", "docComment": "/**\n * Color code for neutralSecondaryAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralSecondaryAlt" - }, { "kind": "Content", - "text": ": " + "text": "neutralSecondaryAlt: " }, { "kind": "Content", @@ -3425,22 +2803,18 @@ "releaseTag": "Public", "name": "neutralSecondaryAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralTertiary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralTertiary:member", "docComment": "/**\n * Color code for neutralTertiary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralTertiary" - }, { "kind": "Content", - "text": ": " + "text": "neutralTertiary: " }, { "kind": "Content", @@ -3454,22 +2828,18 @@ "releaseTag": "Public", "name": "neutralTertiary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "neutralTertiaryAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member", "docComment": "/**\n * Color code for neutralTertiaryAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "neutralTertiaryAlt" - }, { "kind": "Content", - "text": ": " + "text": "neutralTertiaryAlt: " }, { "kind": "Content", @@ -3483,22 +2853,18 @@ "releaseTag": "Public", "name": "neutralTertiaryAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "orange", + "canonicalReference": "@microsoft/sp-component-base!IPalette#orange:member", "docComment": "/**\n * Color code for orange.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "orange" - }, { "kind": "Content", - "text": ": " + "text": "orange: " }, { "kind": "Content", @@ -3512,22 +2878,18 @@ "releaseTag": "Public", "name": "orange", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "orangeLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#orangeLight:member", "docComment": "/**\n * Color code for orangeLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "orangeLight" - }, { "kind": "Content", - "text": ": " + "text": "orangeLight: " }, { "kind": "Content", @@ -3541,22 +2903,18 @@ "releaseTag": "Public", "name": "orangeLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "orangeLighter", + "canonicalReference": "@microsoft/sp-component-base!IPalette#orangeLighter:member", "docComment": "/**\n * Color code for orangeLighter.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "orangeLighter" - }, { "kind": "Content", - "text": ": " + "text": "orangeLighter: " }, { "kind": "Content", @@ -3570,22 +2928,18 @@ "releaseTag": "Public", "name": "orangeLighter", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "purple", + "canonicalReference": "@microsoft/sp-component-base!IPalette#purple:member", "docComment": "/**\n * Color code for purple.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "purple" - }, { "kind": "Content", - "text": ": " + "text": "purple: " }, { "kind": "Content", @@ -3599,22 +2953,18 @@ "releaseTag": "Public", "name": "purple", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "purpleDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#purpleDark:member", "docComment": "/**\n * Color code for purpleDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "purpleDark" - }, { "kind": "Content", - "text": ": " + "text": "purpleDark: " }, { "kind": "Content", @@ -3628,22 +2978,18 @@ "releaseTag": "Public", "name": "purpleDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "purpleLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#purpleLight:member", "docComment": "/**\n * Color code for purpleLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "purpleLight" - }, { "kind": "Content", - "text": ": " + "text": "purpleLight: " }, { "kind": "Content", @@ -3657,22 +3003,18 @@ "releaseTag": "Public", "name": "purpleLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "red", + "canonicalReference": "@microsoft/sp-component-base!IPalette#red:member", "docComment": "/**\n * Color code for red.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "red" - }, { "kind": "Content", - "text": ": " + "text": "red: " }, { "kind": "Content", @@ -3686,22 +3028,18 @@ "releaseTag": "Public", "name": "red", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "redDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#redDark:member", "docComment": "/**\n * Color code for redDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "redDark" - }, { "kind": "Content", - "text": ": " + "text": "redDark: " }, { "kind": "Content", @@ -3715,22 +3053,18 @@ "releaseTag": "Public", "name": "redDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "teal", + "canonicalReference": "@microsoft/sp-component-base!IPalette#teal:member", "docComment": "/**\n * Color code for teal.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "teal" - }, { "kind": "Content", - "text": ": " + "text": "teal: " }, { "kind": "Content", @@ -3744,22 +3078,18 @@ "releaseTag": "Public", "name": "teal", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "tealDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#tealDark:member", "docComment": "/**\n * Color code for tealDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tealDark" - }, { "kind": "Content", - "text": ": " + "text": "tealDark: " }, { "kind": "Content", @@ -3773,22 +3103,18 @@ "releaseTag": "Public", "name": "tealDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "tealLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#tealLight:member", "docComment": "/**\n * Color code for tealLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tealLight" - }, { "kind": "Content", - "text": ": " + "text": "tealLight: " }, { "kind": "Content", @@ -3802,22 +3128,18 @@ "releaseTag": "Public", "name": "tealLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeDark", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeDark:member", "docComment": "/**\n * Color code for themeDark.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeDark" - }, { "kind": "Content", - "text": ": " + "text": "themeDark: " }, { "kind": "Content", @@ -3831,22 +3153,18 @@ "releaseTag": "Public", "name": "themeDark", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeDarkAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeDarkAlt:member", "docComment": "/**\n * Color code for themeDarkAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeDarkAlt" - }, { "kind": "Content", - "text": ": " + "text": "themeDarkAlt: " }, { "kind": "Content", @@ -3860,22 +3178,18 @@ "releaseTag": "Public", "name": "themeDarkAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeDarker", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeDarker:member", "docComment": "/**\n * Color code for themeDarker.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeDarker" - }, { "kind": "Content", - "text": ": " + "text": "themeDarker: " }, { "kind": "Content", @@ -3889,22 +3203,18 @@ "releaseTag": "Public", "name": "themeDarker", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeLight:member", "docComment": "/**\n * Color code for themeLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeLight" - }, { "kind": "Content", - "text": ": " + "text": "themeLight: " }, { "kind": "Content", @@ -3918,22 +3228,18 @@ "releaseTag": "Public", "name": "themeLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeLighter", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeLighter:member", "docComment": "/**\n * Color code for themeLighter.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeLighter" - }, { "kind": "Content", - "text": ": " + "text": "themeLighter: " }, { "kind": "Content", @@ -3947,22 +3253,18 @@ "releaseTag": "Public", "name": "themeLighter", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeLighterAlt", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeLighterAlt:member", "docComment": "/**\n * Color code for themeLighterAlt.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeLighterAlt" - }, { "kind": "Content", - "text": ": " + "text": "themeLighterAlt: " }, { "kind": "Content", @@ -3976,22 +3278,18 @@ "releaseTag": "Public", "name": "themeLighterAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themePrimary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themePrimary:member", "docComment": "/**\n * Color code for themePrimary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themePrimary" - }, { "kind": "Content", - "text": ": " + "text": "themePrimary: " }, { "kind": "Content", @@ -4005,22 +3303,18 @@ "releaseTag": "Public", "name": "themePrimary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeSecondary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeSecondary:member", "docComment": "/**\n * Color code for themeSecondary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeSecondary" - }, { "kind": "Content", - "text": ": " + "text": "themeSecondary: " }, { "kind": "Content", @@ -4034,22 +3328,18 @@ "releaseTag": "Public", "name": "themeSecondary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "themeTertiary", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeTertiary:member", "docComment": "/**\n * Color code for themeTertiary.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "themeTertiary" - }, { "kind": "Content", - "text": ": " + "text": "themeTertiary: " }, { "kind": "Content", @@ -4063,22 +3353,18 @@ "releaseTag": "Public", "name": "themeTertiary", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "white", + "canonicalReference": "@microsoft/sp-component-base!IPalette#white:member", "docComment": "/**\n * Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. This is the page background.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "white" - }, { "kind": "Content", - "text": ": " + "text": "white: " }, { "kind": "Content", @@ -4092,22 +3378,18 @@ "releaseTag": "Public", "name": "white", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "whiteTranslucent40", + "canonicalReference": "@microsoft/sp-component-base!IPalette#whiteTranslucent40:member", "docComment": "/**\n * Color code for whiteTranslucent40\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "whiteTranslucent40" - }, { "kind": "Content", - "text": ": " + "text": "whiteTranslucent40: " }, { "kind": "Content", @@ -4121,22 +3403,18 @@ "releaseTag": "Public", "name": "whiteTranslucent40", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "yellow", + "canonicalReference": "@microsoft/sp-component-base!IPalette#yellow:member", "docComment": "/**\n * Color code for yellow.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "yellow" - }, { "kind": "Content", - "text": ": " + "text": "yellow: " }, { "kind": "Content", @@ -4150,22 +3428,18 @@ "releaseTag": "Public", "name": "yellow", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "yellowLight", + "canonicalReference": "@microsoft/sp-component-base!IPalette#yellowLight:member", "docComment": "/**\n * Color code for yellowLight.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "yellowLight" - }, { "kind": "Content", - "text": ": " + "text": "yellowLight: " }, { "kind": "Content", @@ -4179,8 +3453,8 @@ "releaseTag": "Public", "name": "yellowLight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4188,24 +3462,17 @@ }, { "kind": "Interface", - "canonicalReference": "(IRawStyle:interface)", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface", "docComment": "/**\n * IStyleObject extends a raw style objects, but allows selectors to be defined under the selectors node.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IRawStyle" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IRawStyle extends " }, { "kind": "Reference", - "text": "IRawStyleBase" + "text": "IRawStyleBase", + "canonicalReference": "@microsoft/sp-component-base!IRawStyleBase:interface" }, { "kind": "Content", @@ -4217,16 +3484,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "displayName", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle#displayName:member", "docComment": "/**\n * Display name for the style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "displayName" - }, { "kind": "Content", - "text": "?: " + "text": "displayName?: " }, { "kind": "Content", @@ -4240,38 +3503,27 @@ "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "selectors", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle#selectors:member", "docComment": "/**\n * Custom selectors for the style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "selectors" - }, - { - "kind": "Content", - "text": "?: " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "selectors?: " }, { "kind": "Content", - "text": ": string]: " + "text": "{\n [key: string]: " }, { "kind": "Reference", - "text": "IStyle" + "text": "IStyle", + "canonicalReference": "@microsoft/sp-component-base!IStyle:type" }, { "kind": "Content", @@ -4285,34 +3537,26 @@ "releaseTag": "Public", "name": "selectors", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(IReadonlyFontStyles:interface)", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles:interface", "docComment": "/**\n * Font styles for different sizes.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IReadonlyFontStyles" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IReadonlyFontStyles " } ], "releaseTag": "Public", @@ -4320,20 +3564,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "large", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#large:member", "docComment": "/**\n * Large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "large" - }, { "kind": "Content", - "text": ": " + "text": "large: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4343,26 +3584,23 @@ "releaseTag": "Public", "name": "large", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "medium", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#medium:member", "docComment": "/**\n * Medium font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "medium" - }, { "kind": "Content", - "text": ": " + "text": "medium: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4372,26 +3610,23 @@ "releaseTag": "Public", "name": "medium", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "mediumPlus", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member", "docComment": "/**\n * Larger than medium but smaller than large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "mediumPlus" - }, { "kind": "Content", - "text": ": " + "text": "mediumPlus: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4401,26 +3636,23 @@ "releaseTag": "Public", "name": "mediumPlus", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "mega", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#mega:member", "docComment": "/**\n * Mega sized font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "mega" - }, { "kind": "Content", - "text": ": " + "text": "mega: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4430,26 +3662,23 @@ "releaseTag": "Public", "name": "mega", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "small", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#small:member", "docComment": "/**\n * Small font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "small" - }, { "kind": "Content", - "text": ": " + "text": "small: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4459,26 +3688,23 @@ "releaseTag": "Public", "name": "small", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "smallPlus", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member", "docComment": "/**\n * Larger than small but smaller than medium font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "smallPlus" - }, { "kind": "Content", - "text": ": " + "text": "smallPlus: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4488,26 +3714,23 @@ "releaseTag": "Public", "name": "smallPlus", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "superLarge", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member", "docComment": "/**\n * Super large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "superLarge" - }, { "kind": "Content", - "text": ": " + "text": "superLarge: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4517,26 +3740,23 @@ "releaseTag": "Public", "name": "superLarge", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "tiny", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member", "docComment": "/**\n * Tiny font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tiny" - }, { "kind": "Content", - "text": ": " + "text": "tiny: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4546,26 +3766,23 @@ "releaseTag": "Public", "name": "tiny", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "xLarge", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member", "docComment": "/**\n * Extra large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "xLarge" - }, { "kind": "Content", - "text": ": " + "text": "xLarge: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4575,26 +3792,23 @@ "releaseTag": "Public", "name": "xLarge", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "xSmall", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member", "docComment": "/**\n * Extra small font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "xSmall" - }, { "kind": "Content", - "text": ": " + "text": "xSmall: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4604,26 +3818,23 @@ "releaseTag": "Public", "name": "xSmall", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "xxLarge", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member", "docComment": "/**\n * Extra extra large font style.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "xxLarge" - }, { "kind": "Content", - "text": ": " + "text": "xxLarge: " }, { "kind": "Reference", - "text": "IReadonlyRawStyle" + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" }, { "kind": "Content", @@ -4633,33 +3844,65 @@ "releaseTag": "Public", "name": "xxLarge", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [] }, { - "kind": "Interface", - "canonicalReference": "(IReadonlyTheme:interface)", - "docComment": "/**\n * Immutable ITheme.\n *\n * @public\n */\n", + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type", + "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " + "text": "export declare type IReadonlyRawStyle = " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" }, { "kind": "Reference", - "text": "IReadonlyTheme" + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" }, { "kind": "Content", - "text": " extends " + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IReadonlyRawStyle", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme:interface", + "docComment": "/**\n * Immutable ITheme.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IReadonlyTheme extends " }, { "kind": "Reference", - "text": "Readonly" + "text": "Readonly", + "canonicalReference": "!Readonly:type" }, { "kind": "Content", @@ -4667,7 +3910,8 @@ }, { "kind": "Reference", - "text": "ITheme" + "text": "ITheme", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface" }, { "kind": "Content", @@ -4679,24 +3923,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "fonts", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme#fonts:member", "docComment": "/**\n * Font styles for different sizes.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "fonts" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly fonts: " }, { "kind": "Reference", - "text": "Readonly" + "text": "Readonly", + "canonicalReference": "!Readonly:type" }, { "kind": "Content", @@ -4704,7 +3941,8 @@ }, { "kind": "Reference", - "text": "IReadonlyFontStyles" + "text": "IReadonlyFontStyles", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles:interface" }, { "kind": "Content", @@ -4718,30 +3956,23 @@ "releaseTag": "Public", "name": "fonts", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } }, { "kind": "PropertySignature", - "canonicalReference": "palette", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme#palette:member", "docComment": "/**\n * Color palette.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "palette" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly palette: " }, { "kind": "Reference", - "text": "Readonly" + "text": "Readonly", + "canonicalReference": "!Readonly:type" }, { "kind": "Content", @@ -4749,7 +3980,8 @@ }, { "kind": "Reference", - "text": "IPalette" + "text": "IPalette", + "canonicalReference": "@microsoft/sp-component-base!IPalette:interface" }, { "kind": "Content", @@ -4763,30 +3995,23 @@ "releaseTag": "Public", "name": "palette", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } }, { "kind": "PropertySignature", - "canonicalReference": "semanticColors", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member", "docComment": "/**\n * The collection of all semantic slots for colors used in themes.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly semanticColors: " }, { "kind": "Reference", - "text": "semanticColors" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Readonly" + "text": "Readonly", + "canonicalReference": "!Readonly:type" }, { "kind": "Content", @@ -4794,7 +4019,8 @@ }, { "kind": "Reference", - "text": "ISemanticColors" + "text": "ISemanticColors", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors:interface" }, { "kind": "Content", @@ -4808,38 +4034,31 @@ "releaseTag": "Public", "name": "semanticColors", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } ] }, { "kind": "Interface", - "canonicalReference": "(ISemanticColors:interface)", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors:interface", "docComment": "/**\n * The collection of all semantic slots for colors used in themes.\n *\n * Note: text colors are defined in ISemanticTextColors.ts.\n *\n * ## Naming Convention\n *\n * The name of a semantic slot can quickly tell you how it’s meant to be used. It generally follows this format:\n *\n * [category name][element name][checked state][hovered/pressed/disabled state] [category name] – The “family” that this slot belongs to. [element name] – The name of the thing being targeted, such as the background or border. [checked state] – Whether the thing is checked. We assume things are unchecked by default, so no need to specify the unchecked state. (We used “checked” to refer to anything that is on, selected, toggled, highlighted, emphasized, etc.) [hovered/pressed/disabled state] – One of these states, if applicable. Each of these states are mutually exclusive. Pressed styles overwrite hovered styles, and disabled elements cannot be hovered or pressed.\n *\n * ## Base Slots\n *\n * A basic set of slots that provide many default body styles, such as text, subtext, disabled colors, and so on. If a category doesn't provide the slot you're looking for, use one from this category. For example, the placeholder text on a text input field has no corresponding slot in its category, so you'd use the bodySubtextColor from this category.\n *\n * ## Invariants\n *\n * When color has meaning, we do not want to change the color much theme to theme. For example, we will always want errors to be some shade of red, but we will need to tweak the exact shade so it's legible depending on whether it's an inverted theme or not. Invariant colors should almost never be changed by the theme, the defaults should suffice.\n *\n * ## Input Controls\n *\n * This category contains input components commonly used to denote state, including radio buttons, check boxes, toggle switches, sliders, progress bars, and more.\n *\n * ## Buttons\n *\n * Buttons! And all the flavors thereof.\n *\n * ## Menus\n *\n * Any kind of popup menus uses this category.\n *\n * ## Lists\n *\n * Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a large and complex interaction surface. This category covers all kinds of lists, whether they're typical one-item-per-row lists (like DetailsList) or ones with a tiled layout.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISemanticColors" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface ISemanticColors extends " }, { "kind": "Reference", - "text": "ISemanticTextColors" + "text": "ISemanticTextColors", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors:interface" }, { "kind": "Content", @@ -4851,16 +4070,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "accentButtonBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member", "docComment": "/**\n * Background of an accent button (kicker)\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "accentButtonBackground" - }, { "kind": "Content", - "text": ": " + "text": "accentButtonBackground: " }, { "kind": "Content", @@ -4874,22 +4089,18 @@ "releaseTag": "Public", "name": "accentButtonBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "blockingBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#blockingBackground:member", "docComment": "/**\n * Background for blocking issues, which is more severe than a warning, but not as bad as an error.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blockingBackground" - }, { "kind": "Content", - "text": ": " + "text": "blockingBackground: " }, { "kind": "Content", @@ -4903,22 +4114,18 @@ "releaseTag": "Public", "name": "blockingBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#bodyBackground:member", "docComment": "/**\n * The default color for backgrounds.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyBackground" - }, { "kind": "Content", - "text": ": " + "text": "bodyBackground: " }, { "kind": "Content", @@ -4932,22 +4139,18 @@ "releaseTag": "Public", "name": "bodyBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyDivider", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#bodyDivider:member", "docComment": "/**\n * Divider lines; e.g. lines that separate sections in a menu, an
element.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyDivider" - }, { "kind": "Content", - "text": ": " + "text": "bodyDivider: " }, { "kind": "Content", @@ -4961,22 +4164,18 @@ "releaseTag": "Public", "name": "bodyDivider", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyFrameBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member", "docComment": "/**\n * The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the color of bodyBackground. See also: bodyFrameDivider\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyFrameBackground" - }, { "kind": "Content", - "text": ": " + "text": "bodyFrameBackground: " }, { "kind": "Content", @@ -4990,22 +4189,18 @@ "releaseTag": "Public", "name": "bodyFrameBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyFrameDivider", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#bodyFrameDivider:member", "docComment": "/**\n * Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually disappear. See also: bodyFrameBackground\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyFrameDivider" - }, { "kind": "Content", - "text": ": " + "text": "bodyFrameDivider: " }, { "kind": "Content", @@ -5019,22 +4214,18 @@ "releaseTag": "Public", "name": "bodyFrameDivider", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyStandoutBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member", "docComment": "/**\n * The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in inverted themes.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyStandoutBackground" - }, { "kind": "Content", - "text": ": " + "text": "bodyStandoutBackground: " }, { "kind": "Content", @@ -5048,22 +4239,18 @@ "releaseTag": "Public", "name": "bodyStandoutBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackground:member", "docComment": "/**\n * Background of a standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBackground" - }, { "kind": "Content", - "text": ": " + "text": "buttonBackground: " }, { "kind": "Content", @@ -5077,22 +4264,18 @@ "releaseTag": "Public", "name": "buttonBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBackgroundChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member", "docComment": "/**\n * Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBackgroundChecked" - }, { "kind": "Content", - "text": ": " + "text": "buttonBackgroundChecked: " }, { "kind": "Content", @@ -5106,22 +4289,18 @@ "releaseTag": "Public", "name": "buttonBackgroundChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBackgroundCheckedHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member", "docComment": "/**\n * Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBackgroundCheckedHovered" - }, { "kind": "Content", - "text": ": " + "text": "buttonBackgroundCheckedHovered: " }, { "kind": "Content", @@ -5135,22 +4314,18 @@ "releaseTag": "Public", "name": "buttonBackgroundCheckedHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBackgroundDisabled", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member", "docComment": "/**\n * Background of a disabled standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBackgroundDisabled" - }, { "kind": "Content", - "text": ": " + "text": "buttonBackgroundDisabled: " }, { "kind": "Content", @@ -5164,22 +4339,18 @@ "releaseTag": "Public", "name": "buttonBackgroundDisabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBackgroundHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member", "docComment": "/**\n * Background of a hovered standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBackgroundHovered" - }, { "kind": "Content", - "text": ": " + "text": "buttonBackgroundHovered: " }, { "kind": "Content", @@ -5193,22 +4364,18 @@ "releaseTag": "Public", "name": "buttonBackgroundHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBackgroundPressed", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member", "docComment": "/**\n * Background of a pressed standard button; i.e. currently being clicked by mouse\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBackgroundPressed" - }, { "kind": "Content", - "text": ": " + "text": "buttonBackgroundPressed: " }, { "kind": "Content", @@ -5222,22 +4389,18 @@ "releaseTag": "Public", "name": "buttonBackgroundPressed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBorder", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBorder:member", "docComment": "/**\n * Border of a standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBorder" - }, { "kind": "Content", - "text": ": " + "text": "buttonBorder: " }, { "kind": "Content", @@ -5251,22 +4414,18 @@ "releaseTag": "Public", "name": "buttonBorder", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonBorderDisabled", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member", "docComment": "/**\n * Border of a disabled standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonBorderDisabled" - }, { "kind": "Content", - "text": ": " + "text": "buttonBorderDisabled: " }, { "kind": "Content", @@ -5280,22 +4439,18 @@ "releaseTag": "Public", "name": "buttonBorderDisabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "defaultStateBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member", "docComment": "/**\n * Background color for default/empty state graphical elements; eg default icons, empty section that needs user to fill in content, placeholder graphics, empty seats, etc.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "defaultStateBackground" - }, { "kind": "Content", - "text": ": " + "text": "defaultStateBackground: " }, { "kind": "Content", @@ -5309,22 +4464,18 @@ "releaseTag": "Public", "name": "defaultStateBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "disabledBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#disabledBackground:member", "docComment": "/**\n * The default color for backgrounds of disabled controls; e.g. disabled text field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "disabledBackground" - }, { "kind": "Content", - "text": ": " + "text": "disabledBackground: " }, { "kind": "Content", @@ -5338,22 +4489,18 @@ "releaseTag": "Public", "name": "disabledBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "errorBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#errorBackground:member", "docComment": "/**\n * The background for errors, if necessary, or highlighting the section of the page where the error is present.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "errorBackground" - }, { "kind": "Content", - "text": ": " + "text": "errorBackground: " }, { "kind": "Content", @@ -5367,22 +4514,18 @@ "releaseTag": "Public", "name": "errorBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "focusBorder", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#focusBorder:member", "docComment": "/**\n * The color of the outline around focused controls that don't already have a border; e.g. menu items\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "focusBorder" - }, { "kind": "Content", - "text": ": " + "text": "focusBorder: " }, { "kind": "Content", @@ -5396,22 +4539,18 @@ "releaseTag": "Public", "name": "focusBorder", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputBackground:member", "docComment": "/**\n * The background color of an input, e.g. textbox background.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputBackground" - }, { "kind": "Content", - "text": ": " + "text": "inputBackground: " }, { "kind": "Content", @@ -5425,22 +4564,18 @@ "releaseTag": "Public", "name": "inputBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputBackgroundChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member", "docComment": "/**\n * The background of a checked control; e.g. checked radio button's dot, checked toggle's background.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputBackgroundChecked" - }, { "kind": "Content", - "text": ": " + "text": "inputBackgroundChecked: " }, { "kind": "Content", @@ -5454,22 +4589,18 @@ "releaseTag": "Public", "name": "inputBackgroundChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputBackgroundCheckedHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member", "docComment": "/**\n * The background of a checked and hovered control; e.g. checked checkbox's background color on hover.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputBackgroundCheckedHovered" - }, { "kind": "Content", - "text": ": " + "text": "inputBackgroundCheckedHovered: " }, { "kind": "Content", @@ -5483,22 +4614,18 @@ "releaseTag": "Public", "name": "inputBackgroundCheckedHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputBorder", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputBorder:member", "docComment": "/**\n * The border of a large input control in its resting, state; e.g. the box of dropdown.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputBorder" - }, { "kind": "Content", - "text": ": " + "text": "inputBorder: " }, { "kind": "Content", @@ -5512,22 +4639,18 @@ "releaseTag": "Public", "name": "inputBorder", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputBorderHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member", "docComment": "/**\n * The border color of a large hovered input control, such as textbox.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputBorderHovered" - }, { "kind": "Content", - "text": ": " + "text": "inputBorderHovered: " }, { "kind": "Content", @@ -5541,22 +4664,18 @@ "releaseTag": "Public", "name": "inputBorderHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputFocusBorderAlt", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member", "docComment": "/**\n * The alternate focus border color for elements that already have a border; e.g. text field borders on focus.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputFocusBorderAlt" - }, { "kind": "Content", - "text": ": " + "text": "inputFocusBorderAlt: " }, { "kind": "Content", @@ -5570,22 +4689,18 @@ "releaseTag": "Public", "name": "inputFocusBorderAlt", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputForegroundChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member", "docComment": "/**\n * The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio button's background color around the dot.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputForegroundChecked" - }, { "kind": "Content", - "text": ": " + "text": "inputForegroundChecked: " }, { "kind": "Content", @@ -5599,22 +4714,18 @@ "releaseTag": "Public", "name": "inputForegroundChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listBackground:member", "docComment": "/**\n * The background color for the entire list.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listBackground" - }, { "kind": "Content", - "text": ": " + "text": "listBackground: " }, { "kind": "Content", @@ -5628,22 +4739,18 @@ "releaseTag": "Public", "name": "listBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listHeaderBackgroundHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member", "docComment": "/**\n * The background color for a hovered list header.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listHeaderBackgroundHovered" - }, { "kind": "Content", - "text": ": " + "text": "listHeaderBackgroundHovered: " }, { "kind": "Content", @@ -5657,22 +4764,18 @@ "releaseTag": "Public", "name": "listHeaderBackgroundHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listHeaderBackgroundPressed", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member", "docComment": "/**\n * The background color for a pressed list header.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listHeaderBackgroundPressed" - }, { "kind": "Content", - "text": ": " + "text": "listHeaderBackgroundPressed: " }, { "kind": "Content", @@ -5686,22 +4789,18 @@ "releaseTag": "Public", "name": "listHeaderBackgroundPressed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listItemBackgroundChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member", "docComment": "/**\n * The background color of a checked list item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listItemBackgroundChecked" - }, { "kind": "Content", - "text": ": " + "text": "listItemBackgroundChecked: " }, { "kind": "Content", @@ -5715,22 +4814,18 @@ "releaseTag": "Public", "name": "listItemBackgroundChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listItemBackgroundCheckedHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member", "docComment": "/**\n * The background color of a checked and hovered list item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listItemBackgroundCheckedHovered" - }, { "kind": "Content", - "text": ": " + "text": "listItemBackgroundCheckedHovered: " }, { "kind": "Content", @@ -5744,22 +4839,18 @@ "releaseTag": "Public", "name": "listItemBackgroundCheckedHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listItemBackgroundHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member", "docComment": "/**\n * The background color of a hovered list item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listItemBackgroundHovered" - }, { "kind": "Content", - "text": ": " + "text": "listItemBackgroundHovered: " }, { "kind": "Content", @@ -5773,22 +4864,18 @@ "releaseTag": "Public", "name": "listItemBackgroundHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listText:member", "docComment": "/**\n * The default text color for list item titles and text in column fields.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listText" - }, { "kind": "Content", - "text": ": " + "text": "listText: " }, { "kind": "Content", @@ -5802,22 +4889,18 @@ "releaseTag": "Public", "name": "listText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuBackground:member", "docComment": "/**\n * The background of a menu.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuBackground" - }, { "kind": "Content", - "text": ": " + "text": "menuBackground: " }, { "kind": "Content", @@ -5831,22 +4914,18 @@ "releaseTag": "Public", "name": "menuBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuDivider", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuDivider:member", "docComment": "/**\n * The divider between menu items.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuDivider" - }, { "kind": "Content", - "text": ": " + "text": "menuDivider: " }, { "kind": "Content", @@ -5860,22 +4939,18 @@ "releaseTag": "Public", "name": "menuDivider", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuHeader", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuHeader:member", "docComment": "/**\n * The headers in menus that denote title of a section.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuHeader" - }, { "kind": "Content", - "text": ": " + "text": "menuHeader: " }, { "kind": "Content", @@ -5889,22 +4964,18 @@ "releaseTag": "Public", "name": "menuHeader", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuIcon", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuIcon:member", "docComment": "/**\n * The default colors of icons in menus.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuIcon" - }, { "kind": "Content", - "text": ": " + "text": "menuIcon: " }, { "kind": "Content", @@ -5918,22 +4989,18 @@ "releaseTag": "Public", "name": "menuIcon", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuItemBackgroundChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member", "docComment": "/**\n * @deprecated\n *\n * (Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item whose submenu is open, a selected dropdown item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuItemBackgroundChecked" - }, { "kind": "Content", - "text": ": " + "text": "menuItemBackgroundChecked: " }, { "kind": "Content", @@ -5947,22 +5014,18 @@ "releaseTag": "Public", "name": "menuItemBackgroundChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuItemBackgroundHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member", "docComment": "/**\n * The background of a hovered menu item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuItemBackgroundHovered" - }, { "kind": "Content", - "text": ": " + "text": "menuItemBackgroundHovered: " }, { "kind": "Content", @@ -5976,22 +5039,18 @@ "releaseTag": "Public", "name": "menuItemBackgroundHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuItemBackgroundPressed", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member", "docComment": "/**\n * The background of a pressed menu item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuItemBackgroundPressed" - }, { "kind": "Content", - "text": ": " + "text": "menuItemBackgroundPressed: " }, { "kind": "Content", @@ -6005,22 +5064,18 @@ "releaseTag": "Public", "name": "menuItemBackgroundPressed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuItemText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemText:member", "docComment": "/**\n * The text color of a menu item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuItemText" - }, { "kind": "Content", - "text": ": " + "text": "menuItemText: " }, { "kind": "Content", @@ -6034,22 +5089,18 @@ "releaseTag": "Public", "name": "menuItemText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "menuItemTextHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member", "docComment": "/**\n * The text color of a hovered menu item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "menuItemTextHovered" - }, { "kind": "Content", - "text": ": " + "text": "menuItemTextHovered: " }, { "kind": "Content", @@ -6063,22 +5114,18 @@ "releaseTag": "Public", "name": "menuItemTextHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member", "docComment": "/**\n * Background of a primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonBackground" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonBackground: " }, { "kind": "Content", @@ -6092,22 +5139,18 @@ "releaseTag": "Public", "name": "primaryButtonBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonBackgroundDisabled", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member", "docComment": "/**\n * Background of a disabled primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonBackgroundDisabled" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonBackgroundDisabled: " }, { "kind": "Content", @@ -6121,22 +5164,18 @@ "releaseTag": "Public", "name": "primaryButtonBackgroundDisabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonBackgroundHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member", "docComment": "/**\n * Background of a hovered primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonBackgroundHovered" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonBackgroundHovered: " }, { "kind": "Content", @@ -6150,22 +5189,18 @@ "releaseTag": "Public", "name": "primaryButtonBackgroundHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonBackgroundPressed", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member", "docComment": "/**\n * Background of a pressed primary button; i.e. currently being clicked by mouse\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonBackgroundPressed" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonBackgroundPressed: " }, { "kind": "Content", @@ -6179,22 +5214,18 @@ "releaseTag": "Public", "name": "primaryButtonBackgroundPressed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonBorder", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member", "docComment": "/**\n * Border of a primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonBorder" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonBorder: " }, { "kind": "Content", @@ -6208,22 +5239,18 @@ "releaseTag": "Public", "name": "primaryButtonBorder", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "smallInputBorder", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member", "docComment": "/**\n * The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "smallInputBorder" - }, { "kind": "Content", - "text": ": " + "text": "smallInputBorder: " }, { "kind": "Content", @@ -6237,22 +5264,18 @@ "releaseTag": "Public", "name": "smallInputBorder", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "successBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#successBackground:member", "docComment": "/**\n * Background for success\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "successBackground" - }, { "kind": "Content", - "text": ": " + "text": "successBackground: " }, { "kind": "Content", @@ -6266,22 +5289,18 @@ "releaseTag": "Public", "name": "successBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "variantBorder", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#variantBorder:member", "docComment": "/**\n * The color of the border that provides contrast between an element, such as a card, and an emphasized background.\n */\n", - "excerptTokens": [ - { - "kind": "Reference", - "text": "variantBorder" - }, + "excerptTokens": [ { "kind": "Content", - "text": ": " + "text": "variantBorder: " }, { "kind": "Content", @@ -6295,22 +5314,18 @@ "releaseTag": "Public", "name": "variantBorder", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "variantBorderHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member", "docComment": "/**\n * Hover color of border that provides contrast between an element, such as a card, and an emphasized background.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "variantBorderHovered" - }, { "kind": "Content", - "text": ": " + "text": "variantBorderHovered: " }, { "kind": "Content", @@ -6324,22 +5339,18 @@ "releaseTag": "Public", "name": "variantBorderHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "warningBackground", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#warningBackground:member", "docComment": "/**\n * Background for warning messages.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "warningBackground" - }, { "kind": "Content", - "text": ": " + "text": "warningBackground: " }, { "kind": "Content", @@ -6353,22 +5364,18 @@ "releaseTag": "Public", "name": "warningBackground", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "warningHighlight", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#warningHighlight:member", "docComment": "/**\n * Foreground color for warning highlights\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "warningHighlight" - }, { "kind": "Content", - "text": ": " + "text": "warningHighlight: " }, { "kind": "Content", @@ -6382,34 +5389,26 @@ "releaseTag": "Public", "name": "warningHighlight", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISemanticTextColors:interface)", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors:interface", "docComment": "/**\n * Collection of semantic text colors.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISemanticTextColors" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISemanticTextColors " } ], "releaseTag": "Public", @@ -6417,16 +5416,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "accentButtonText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member", "docComment": "/**\n * Color of text for accent button (kicker)\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "accentButtonText" - }, { "kind": "Content", - "text": ": " + "text": "accentButtonText: " }, { "kind": "Content", @@ -6440,22 +5435,18 @@ "releaseTag": "Public", "name": "accentButtonText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "actionLink", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#actionLink:member", "docComment": "/**\n * Neutral colored links and links for action buttons.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "actionLink" - }, { "kind": "Content", - "text": ": " + "text": "actionLink: " }, { "kind": "Content", @@ -6469,22 +5460,18 @@ "releaseTag": "Public", "name": "actionLink", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "actionLinkHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member", "docComment": "/**\n * Hover state for neutral colored links and links for action buttons.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "actionLinkHovered" - }, { "kind": "Content", - "text": ": " + "text": "actionLinkHovered: " }, { "kind": "Content", @@ -6498,22 +5485,18 @@ "releaseTag": "Public", "name": "actionLinkHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodySubtext", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member", "docComment": "/**\n * De-emphasized text; e.g. metadata, captions, placeholder text.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodySubtext" - }, { "kind": "Content", - "text": ": " + "text": "bodySubtext: " }, { "kind": "Content", @@ -6527,22 +5510,18 @@ "releaseTag": "Public", "name": "bodySubtext", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#bodyText:member", "docComment": "/**\n * The default color for text.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyText" - }, { "kind": "Content", - "text": ": " + "text": "bodyText: " }, { "kind": "Content", @@ -6556,22 +5535,18 @@ "releaseTag": "Public", "name": "bodyText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "bodyTextChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member", "docComment": "/**\n * Checked text color, e.g. selected menu item text.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "bodyTextChecked" - }, { "kind": "Content", - "text": ": " + "text": "bodyTextChecked: " }, { "kind": "Content", @@ -6585,22 +5560,18 @@ "releaseTag": "Public", "name": "bodyTextChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonText:member", "docComment": "/**\n * Color of text in a standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonText" - }, { "kind": "Content", - "text": ": " + "text": "buttonText: " }, { "kind": "Content", @@ -6614,22 +5585,18 @@ "releaseTag": "Public", "name": "buttonText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonTextChecked", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member", "docComment": "/**\n * Color of text in a checked standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonTextChecked" - }, { "kind": "Content", - "text": ": " + "text": "buttonTextChecked: " }, { "kind": "Content", @@ -6643,22 +5610,18 @@ "releaseTag": "Public", "name": "buttonTextChecked", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonTextCheckedHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member", "docComment": "/**\n * Color of text in a checked and hovered standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonTextCheckedHovered" - }, { "kind": "Content", - "text": ": " + "text": "buttonTextCheckedHovered: " }, { "kind": "Content", @@ -6672,22 +5635,18 @@ "releaseTag": "Public", "name": "buttonTextCheckedHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonTextDisabled", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member", "docComment": "/**\n * Color of text in a disabled standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonTextDisabled" - }, { "kind": "Content", - "text": ": " + "text": "buttonTextDisabled: " }, { "kind": "Content", @@ -6701,22 +5660,18 @@ "releaseTag": "Public", "name": "buttonTextDisabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonTextHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member", "docComment": "/**\n * Color of text in a hovered standard button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonTextHovered" - }, { "kind": "Content", - "text": ": " + "text": "buttonTextHovered: " }, { "kind": "Content", @@ -6730,22 +5685,18 @@ "releaseTag": "Public", "name": "buttonTextHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "buttonTextPressed", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member", "docComment": "/**\n * Color of text in a pressed standard button; i.e. currently being clicked by mouse\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "buttonTextPressed" - }, { "kind": "Content", - "text": ": " + "text": "buttonTextPressed: " }, { "kind": "Content", @@ -6759,22 +5710,18 @@ "releaseTag": "Public", "name": "buttonTextPressed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "disabledBodySubtext", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member", "docComment": "/**\n * Disabled de-emphasized text, for use on the default background (bodyBackground).\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "disabledBodySubtext" - }, { "kind": "Content", - "text": ": " + "text": "disabledBodySubtext: " }, { "kind": "Content", @@ -6788,22 +5735,18 @@ "releaseTag": "Public", "name": "disabledBodySubtext", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "disabledBodyText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member", "docComment": "/**\n * The default color for disabled text on the default background (bodyBackground).\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "disabledBodyText" - }, { "kind": "Content", - "text": ": " + "text": "disabledBodyText: " }, { "kind": "Content", @@ -6817,22 +5760,18 @@ "releaseTag": "Public", "name": "disabledBodyText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "disabledSubtext", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member", "docComment": "/**\n * Disabled de-emphasized text, for use on disabledBackground.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "disabledSubtext" - }, { "kind": "Content", - "text": ": " + "text": "disabledSubtext: " }, { "kind": "Content", @@ -6846,22 +5785,18 @@ "releaseTag": "Public", "name": "disabledSubtext", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "disabledText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#disabledText:member", "docComment": "/**\n * The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled button text.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "disabledText" - }, { "kind": "Content", - "text": ": " + "text": "disabledText: " }, { "kind": "Content", @@ -6875,22 +5810,18 @@ "releaseTag": "Public", "name": "disabledText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "errorText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#errorText:member", "docComment": "/**\n * The default color of error text, used on bodyBackground.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "errorText" - }, { "kind": "Content", - "text": ": " + "text": "errorText: " }, { "kind": "Content", @@ -6904,22 +5835,18 @@ "releaseTag": "Public", "name": "errorText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputPlaceholderText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member", "docComment": "/**\n * The color of placeholder text.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputPlaceholderText" - }, { "kind": "Content", - "text": ": " + "text": "inputPlaceholderText: " }, { "kind": "Content", @@ -6933,22 +5860,18 @@ "releaseTag": "Public", "name": "inputPlaceholderText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#inputText:member", "docComment": "/**\n * The color of input text.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputText" - }, { "kind": "Content", - "text": ": " + "text": "inputText: " }, { "kind": "Content", @@ -6962,22 +5885,18 @@ "releaseTag": "Public", "name": "inputText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "inputTextHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member", "docComment": "/**\n * The color of input text on hover.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "inputTextHovered" - }, { "kind": "Content", - "text": ": " + "text": "inputTextHovered: " }, { "kind": "Content", @@ -6991,22 +5910,18 @@ "releaseTag": "Public", "name": "inputTextHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "link", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#link:member", "docComment": "/**\n * The color of a link.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "link" - }, { "kind": "Content", - "text": ": " + "text": "link: " }, { "kind": "Content", @@ -7020,22 +5935,18 @@ "releaseTag": "Public", "name": "link", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "linkHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member", "docComment": "/**\n * The color of a hovered link. Also used when the link is active.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "linkHovered" - }, { "kind": "Content", - "text": ": " + "text": "linkHovered: " }, { "kind": "Content", @@ -7049,22 +5960,18 @@ "releaseTag": "Public", "name": "linkHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#listText:member", "docComment": "/**\n * The default text color for list item titles and text in column fields.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listText" - }, { "kind": "Content", - "text": ": " + "text": "listText: " }, { "kind": "Content", @@ -7078,22 +5985,18 @@ "releaseTag": "Public", "name": "listText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listTextColor", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member", "docComment": "/**\n * @deprecated\n *\n * This slot was incorrectly named. Use listText instead.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "listTextColor" - }, { "kind": "Content", - "text": ": " + "text": "listTextColor: " }, { "kind": "Content", @@ -7107,22 +6010,18 @@ "releaseTag": "Public", "name": "listTextColor", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member", "docComment": "/**\n * Color of text in a primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonText" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonText: " }, { "kind": "Content", @@ -7136,22 +6035,18 @@ "releaseTag": "Public", "name": "primaryButtonText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonTextDisabled", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member", "docComment": "/**\n * Color of text in a disabled primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonTextDisabled" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonTextDisabled: " }, { "kind": "Content", @@ -7165,22 +6060,18 @@ "releaseTag": "Public", "name": "primaryButtonTextDisabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonTextHovered", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member", "docComment": "/**\n * Color of text in a hovered primary button\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonTextHovered" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonTextHovered: " }, { "kind": "Content", @@ -7194,22 +6085,18 @@ "releaseTag": "Public", "name": "primaryButtonTextHovered", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "primaryButtonTextPressed", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member", "docComment": "/**\n * Color of text in a pressed primary button; i.e. currently being clicked by mouse\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "primaryButtonTextPressed" - }, { "kind": "Content", - "text": ": " + "text": "primaryButtonTextPressed: " }, { "kind": "Content", @@ -7223,22 +6110,18 @@ "releaseTag": "Public", "name": "primaryButtonTextPressed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "warningText", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#warningText:member", "docComment": "/**\n * The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "warningText" - }, { "kind": "Content", - "text": ": " + "text": "warningText: " }, { "kind": "Content", @@ -7252,8 +6135,8 @@ "releaseTag": "Public", "name": "warningText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -7261,20 +6144,12 @@ }, { "kind": "Interface", - "canonicalReference": "(ITheme:interface)", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface", "docComment": "/**\n * Collection of theme values, which can be used to programatically style components.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ITheme" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ITheme " } ], "releaseTag": "Public", @@ -7282,16 +6157,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "disableGlobalClassNames", + "canonicalReference": "@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member", "docComment": "/**\n * Disables global styles on Fabric components. This will prevent global overrides that might have been set by other Fabric users from applying to your components.\n *\n * @remarks\n *\n * This has a vary narrow use case and most likely should be avoided.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "disableGlobalClassNames" - }, { "kind": "Content", - "text": ": " + "text": "disableGlobalClassNames: " }, { "kind": "Content", @@ -7305,26 +6176,23 @@ "releaseTag": "Public", "name": "disableGlobalClassNames", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "fonts", + "canonicalReference": "@microsoft/sp-component-base!ITheme#fonts:member", "docComment": "/**\n * Font styles for different sizes.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fonts" - }, { "kind": "Content", - "text": ": " + "text": "fonts: " }, { "kind": "Reference", - "text": "IFontStyles" + "text": "IFontStyles", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles:interface" }, { "kind": "Content", @@ -7334,22 +6202,18 @@ "releaseTag": "Public", "name": "fonts", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "isInverted", + "canonicalReference": "@microsoft/sp-component-base!ITheme#isInverted:member", "docComment": "/**\n * Indicates whether the theme is inverted.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isInverted" - }, { "kind": "Content", - "text": ": " + "text": "isInverted: " }, { "kind": "Content", @@ -7363,26 +6227,23 @@ "releaseTag": "Public", "name": "isInverted", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "palette", + "canonicalReference": "@microsoft/sp-component-base!ITheme#palette:member", "docComment": "/**\n * Color palette.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "palette" - }, { "kind": "Content", - "text": ": " + "text": "palette: " }, { "kind": "Reference", - "text": "IPalette" + "text": "IPalette", + "canonicalReference": "@microsoft/sp-component-base!IPalette:interface" }, { "kind": "Content", @@ -7392,26 +6253,23 @@ "releaseTag": "Public", "name": "palette", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "semanticColors", + "canonicalReference": "@microsoft/sp-component-base!ITheme#semanticColors:member", "docComment": "/**\n * The collection of all semantic slots for colors used in themes.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "semanticColors" - }, { "kind": "Content", - "text": ": " + "text": "semanticColors: " }, { "kind": "Reference", - "text": "ISemanticColors" + "text": "ISemanticColors", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors:interface" }, { "kind": "Content", @@ -7421,8 +6279,8 @@ "releaseTag": "Public", "name": "semanticColors", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -7430,24 +6288,17 @@ }, { "kind": "Class", - "canonicalReference": "(ThemeChangedEventArgs:class)", + "canonicalReference": "@microsoft/sp-component-base!ThemeChangedEventArgs:class", "docComment": "/**\n * The object passed when the IThemeProvider.themeChangedEvent is raised.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare class " - }, - { - "kind": "Reference", - "text": "ThemeChangedEventArgs" - }, - { - "kind": "Content", - "text": " extends " + "text": "export declare class ThemeChangedEventArgs extends " }, { "kind": "Reference", - "text": "SPEventArgs" + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" }, { "kind": "Content", @@ -7459,24 +6310,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(theme:instance)", + "canonicalReference": "@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member", "docComment": "/**\n * The new theme. If the value is undefined, then the theme was cleared.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "theme" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly theme: " }, { "kind": "Reference", - "text": "ITheme" + "text": "ITheme", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface" }, { "kind": "Content", @@ -7490,34 +6334,26 @@ "releaseTag": "Public", "name": "theme", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(ThemeProvider:class)", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider:class", "docComment": "/**\n * The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare class " - }, - { - "kind": "Reference", - "text": "ThemeProvider" - }, - { - "kind": "Content", - "text": " " + "text": "export declare class ThemeProvider " } ], "releaseTag": "Public", @@ -7525,40 +6361,26 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider:constructor(1)", "docComment": "/**\n * Construct a new instance of the ThemeProvider class.\n *\n * @param serviceScope - The current service scope.\n *\n * @param theme - Theme to provide.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "theme" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", - "text": "?: " + "text": ", theme?: " }, { "kind": "Reference", - "text": "ITheme" + "text": "ITheme", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface" }, { "kind": "Content", @@ -7566,44 +6388,37 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "theme", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider.serviceKey:member", "docComment": "/**\n * The service key for ThemeProvider.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -7611,7 +6426,8 @@ }, { "kind": "Reference", - "text": "ThemeProvider" + "text": "ThemeProvider", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider:class" }, { "kind": "Content", @@ -7625,31 +6441,24 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(themeChangedEvent:instance)", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member", "docComment": "/**\n * Raised when the theme changes with the new theme as an argument.\n *\n * @eventproperty\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "themeChangedEvent" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly themeChangedEvent: " }, { "kind": "Reference", - "text": "SPEvent" + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" }, { "kind": "Content", @@ -7657,7 +6466,8 @@ }, { "kind": "Reference", - "text": "ThemeChangedEventArgs" + "text": "ThemeChangedEventArgs", + "canonicalReference": "@microsoft/sp-component-base!ThemeChangedEventArgs:class" }, { "kind": "Content", @@ -7671,27 +6481,24 @@ "releaseTag": "Public", "name": "themeChangedEvent", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(tryGetTheme:instance,0)", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)", "docComment": "/**\n * If set, get the current scoped theme.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetTheme" - }, { "kind": "Content", - "text": "(): " + "text": "tryGetTheme(): " }, { "kind": "Reference", - "text": "IReadonlyTheme" + "text": "IReadonlyTheme", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme:interface" }, { "kind": "Content", @@ -7704,53 +6511,16 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "tryGetTheme" } ], "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "IReadonlyRawStyle", - "docComment": "/**\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type " - }, - { - "kind": "Reference", - "text": "IReadonlyRawStyle" - }, - { - "kind": "Content", - "text": " = " - }, - { - "kind": "Reference", - "text": "Readonly" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IRawStyle" - }, - { - "kind": "Content", - "text": ">;" - } - ], - "releaseTag": "Public", - "name": "IReadonlyRawStyle" } ] } diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index 7f99443e..f4d3a166 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-core-library", + "canonicalReference": "@microsoft/sp-core-library!", "docComment": "/**\n * SharePoint Framework core libraries.\n *\n * @remarks\n *\n * This package provides a foundation of core classes that ensure a consistent character across all the other SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes small code size and broad applicability, versus flexibility or richness of features.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-core-library", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-core-library!", "name": "", "members": [ { "kind": "Enum", - "canonicalReference": "(DisplayMode:enum)", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum", "docComment": "/**\n * Indicates whether a visual control should display itself for reading or for editing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "declare enum " - }, - { - "kind": "Reference", - "text": "DisplayMode" - }, - { - "kind": "Content", - "text": " " + "text": "declare enum DisplayMode " } ], "releaseTag": "Public", @@ -37,16 +30,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "Edit", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode.Edit:member", "docComment": "/**\n * The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Edit" - }, { "kind": "Content", - "text": " = " + "text": "Edit = " }, { "kind": "Content", @@ -56,22 +45,18 @@ "releaseTag": "Public", "name": "Edit", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Read", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode.Read:member", "docComment": "/**\n * The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Read" - }, { "kind": "Content", - "text": " = " + "text": "Read = " }, { "kind": "Content", @@ -81,28 +66,20 @@ "releaseTag": "Public", "name": "Read", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Class", - "canonicalReference": "(Environment:class)", + "canonicalReference": "@microsoft/sp-core-library!Environment:class", "docComment": "/**\n * Information about the system environment where the SharePoint Framework is running.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Environment" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Environment " } ], "releaseTag": "Public", @@ -110,24 +87,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(type:static)", + "canonicalReference": "@microsoft/sp-core-library!Environment.type:member", "docComment": "/**\n * Indicates the general type of environment where the SharePoint Framework is running.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "type" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly type: " }, { "kind": "Reference", - "text": "EnvironmentType" + "text": "EnvironmentType", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType:enum" }, { "kind": "Content", @@ -137,8 +107,8 @@ "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true } @@ -147,20 +117,12 @@ }, { "kind": "Enum", - "canonicalReference": "(EnvironmentType:enum)", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType:enum", "docComment": "/**\n * Indicates the general type of environment where the SharePoint Framework is running.\n *\n * @remarks\n *\n * This enum is used by the {@link Environment.\"type\"} property. It provides a way to distinguish environments where certain functionality may be limited or disabled.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare enum " - }, - { - "kind": "Reference", - "text": "EnvironmentType" - }, - { - "kind": "Content", - "text": " " + "text": "export declare enum EnvironmentType " } ], "releaseTag": "Public", @@ -168,16 +130,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "ClassicSharePoint", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member", "docComment": "/**\n * Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ClassicSharePoint" - }, { "kind": "Content", - "text": " = " + "text": "ClassicSharePoint = " }, { "kind": "Content", @@ -187,22 +145,18 @@ "releaseTag": "Public", "name": "ClassicSharePoint", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Local", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType.Local:member", "docComment": "/**\n * Indicates that the SharePoint Framework is running on a page from a \"localhost\" web server, for example the SharePoint Workbench when hosted via \"gulp serve\". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Local" - }, { "kind": "Content", - "text": " = " + "text": "Local = " }, { "kind": "Content", @@ -212,22 +166,18 @@ "releaseTag": "Public", "name": "Local", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "SharePoint", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType.SharePoint:member", "docComment": "/**\n * Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "SharePoint" - }, { "kind": "Content", - "text": " = " + "text": "SharePoint = " }, { "kind": "Content", @@ -237,22 +187,18 @@ "releaseTag": "Public", "name": "SharePoint", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Test", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType.Test:member", "docComment": "/**\n * Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Test" - }, { "kind": "Content", - "text": " = " + "text": "Test = " }, { "kind": "Content", @@ -262,28 +208,20 @@ "releaseTag": "Public", "name": "Test", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Class", - "canonicalReference": "(Guid:class)", + "canonicalReference": "@microsoft/sp-core-library!Guid:class", "docComment": "/**\n * This class represents a globally unique identifier, as described by IETF RFC 4122.\n *\n * @remarks\n *\n * The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications.\n *\n * See {@link https://www.ietf.org/rfc/rfc4122.txt | RFC4122} for more information.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Guid" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Guid " } ], "releaseTag": "Public", @@ -291,24 +229,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(empty:static)", + "canonicalReference": "@microsoft/sp-core-library!Guid.empty:member", "docComment": "/**\n * Returns a new empty Guid instance.\n *\n * @returns A new empty Guid object.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "empty" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly empty: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -318,35 +249,24 @@ "releaseTag": "Public", "name": "empty", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Method", - "canonicalReference": "(equals:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Guid#equals:member(1)", "docComment": "/**\n * Compare this instance to another Guid instance\n *\n * @returns True if this instance and the specified Guid object represent the same value.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "equals" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "guid" - }, { "kind": "Content", - "text": ": " + "text": "equals(guid: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -363,17 +283,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "guid", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -381,28 +301,12 @@ }, { "kind": "Method", - "canonicalReference": "(isValid:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Guid.isValid:member(1)", "docComment": "/**\n * Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object.\n *\n * @param guid - The input string.\n *\n * @returns true, if the Guid is valid.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "isValid" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "guid" - }, - { - "kind": "Content", - "text": ": " + "text": "static isValid(guid: " }, { "kind": "Content", @@ -423,17 +327,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "guid", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -441,32 +345,17 @@ }, { "kind": "Method", - "canonicalReference": "(newGuid:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Guid.newGuid:member(1)", "docComment": "/**\n * Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122.\n *\n * @returns A new unique Guid object\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "newGuid" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "randomNumberGenerator" - }, - { - "kind": "Content", - "text": "?: " + "text": "static newGuid(randomNumberGenerator?: " }, { "kind": "Reference", - "text": "IRandomNumberGenerator" + "text": "IRandomNumberGenerator", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface" }, { "kind": "Content", @@ -474,7 +363,8 @@ }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -483,17 +373,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "randomNumberGenerator", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -501,28 +391,12 @@ }, { "kind": "Method", - "canonicalReference": "(parse:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Guid.parse:member(1)", "docComment": "/**\n * Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.\n *\n * @remarks\n *\n * Example syntaxes accepted by this function:\n *\n * - `\"d5369f3bbd7a412a9c0f7f0650bb5489\"`\n *\n * - `\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"`\n *\n * - `\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"`\n *\n * - `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n *\n * @param guid - The input string.\n *\n * @returns A valid Guid object\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "parse" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "guidString" - }, - { - "kind": "Content", - "text": ": " + "text": "static parse(guidString: " }, { "kind": "Content", @@ -534,7 +408,8 @@ }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -543,17 +418,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "guidString", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -561,16 +436,12 @@ }, { "kind": "Method", - "canonicalReference": "(toString:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Guid#toString:member(1)", "docComment": "/**\n * Returns a string representation of the GUID\n *\n * @returns The GUID value in lowercase hexadecimal without braces.\n *\n * Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "toString" - }, { "kind": "Content", - "text": "(): " + "text": "toString(): " }, { "kind": "Content", @@ -583,38 +454,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "toString" }, { "kind": "Method", - "canonicalReference": "(tryParse:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Guid.tryParse:member(1)", "docComment": "/**\n * Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned.\n *\n * @remarks\n *\n * Example syntaxes accepted by this function:\n *\n * - `\"d5369f3bbd7a412a9c0f7f0650bb5489\"`\n *\n * - `\"d5369f3b-bd7a-412a-9c0f-7f0650bb5489\"`\n *\n * - `\"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}\"`\n *\n * - `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n *\n * @param guid - The input string.\n *\n * @returns The Guid object, or undefined if the string could not be parsed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "tryParse" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "guid" - }, - { - "kind": "Content", - "text": ": " + "text": "static tryParse(guid: " }, { "kind": "Content", @@ -626,7 +481,8 @@ }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -639,17 +495,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 9 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "guid", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -660,20 +516,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDisposable:interface)", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface", "docComment": "/**\n * Implemented by an object that supports a disposal lifecycle.\n *\n * @remarks\n *\n * The dispose event allows an object to free any resources that it allocated before its lifecycle ends.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDisposable" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDisposable " } ], "releaseTag": "Public", @@ -681,16 +529,12 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(dispose:0)", + "canonicalReference": "@microsoft/sp-core-library!IDisposable#dispose:member(1)", "docComment": "/**\n * This method is called to permanently dispose the object.\n *\n * @remarks\n *\n * After the object has been disposed, do not call its methods or access its properties.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dispose" - }, { "kind": "Content", - "text": "(): " + "text": "dispose(): " }, { "kind": "Content", @@ -702,26 +546,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "dispose" }, { "kind": "PropertySignature", - "canonicalReference": "isDisposed", + "canonicalReference": "@microsoft/sp-core-library!IDisposable#isDisposed:member", "docComment": "/**\n * Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently.\n *\n * @remarks\n *\n * After the object has been disposed, do not call its methods or access its properties.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isDisposed" - }, { "kind": "Content", - "text": ": " + "text": "isDisposed: " }, { "kind": "Content", @@ -735,8 +575,8 @@ "releaseTag": "Public", "name": "isDisposed", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -744,20 +584,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IRandomNumberGenerator:interface)", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface", "docComment": "/**\n * This is a {@link ServiceScope} contract for generating pseudorandom random numbers.\n *\n * @remarks\n *\n * This interface abstracts the functionality of the system Math.random() API for usage with a {@link ServiceScope}. For example, a unit test might replace the default {@link RandomNumberGenerator} service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IRandomNumberGenerator" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IRandomNumberGenerator " } ], "releaseTag": "Public", @@ -765,16 +597,12 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(generate:0)", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)", "docComment": "/**\n * Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "generate" - }, { "kind": "Content", - "text": "(): " + "text": "generate(): " }, { "kind": "Content", @@ -786,11 +614,11 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "generate" } @@ -799,20 +627,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IServiceCollection:interface)", + "canonicalReference": "@microsoft/sp-core-library!IServiceCollection:interface", "docComment": "/**\n * A shorthand pattern for extracting well-known services from a ServiceScope.\n *\n * @deprecated\n *\n * This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future release.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "interface " - }, - { - "kind": "Reference", - "text": "IServiceCollection" - }, - { - "kind": "Content", - "text": " " + "text": "interface IServiceCollection " } ], "releaseTag": "Public", @@ -820,24 +640,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "serviceScope", + "canonicalReference": "@microsoft/sp-core-library!IServiceCollection#serviceScope:member", "docComment": "/**\n * Returns the underlying ServiceScope that the members belong to.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly serviceScope: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -847,8 +660,8 @@ "releaseTag": "Public", "name": "serviceScope", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -856,24 +669,17 @@ }, { "kind": "Interface", - "canonicalReference": "(ISPEventObserver:interface)", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver:interface", "docComment": "/**\n * Used with the {@link SPEvent} system, this interface is implemented by components that can subscribe to events.\n *\n * @remarks\n *\n * ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPEventObserver" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface ISPEventObserver extends " }, { "kind": "Reference", - "text": "IDisposable" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", @@ -885,20 +691,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "componentId", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver#componentId:member", "docComment": "/**\n * The component identifier, from the component's manifest.\n *\n * @remarks\n *\n * This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "componentId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly componentId: " }, { "kind": "Content", @@ -912,26 +710,18 @@ "releaseTag": "Public", "name": "componentId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "instanceId", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver#instanceId:member", "docComment": "/**\n * The instance identifier for the component.\n *\n * @remarks\n *\n * This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "instanceId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly instanceId: " }, { "kind": "Content", @@ -945,34 +735,26 @@ "releaseTag": "Public", "name": "instanceId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ITimeProvider:interface)", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider:interface", "docComment": "/**\n * This is a {@link ServiceScope} contract for reading the system clock.\n *\n * @remarks\n *\n * This interface abstracts the functionality of the system time APIs for usage with a {@link ServiceScope}. For example, a unit test might replace the default {@link TimeProvider} service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ITimeProvider" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ITimeProvider " } ], "releaseTag": "Public", @@ -980,20 +762,17 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(getDate:0)", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider#getDate:member(1)", "docComment": "/**\n * Returns the current date/time, similar to the Date class constructor.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getDate" - }, { "kind": "Content", - "text": "(): " + "text": "getDate(): " }, { "kind": "Reference", - "text": "Date" + "text": "Date", + "canonicalReference": "!Date:interface" }, { "kind": "Content", @@ -1001,26 +780,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getDate" }, { "kind": "MethodSignature", - "canonicalReference": "(getTimestamp:0)", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)", "docComment": "/**\n * Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getTimestamp" - }, { "kind": "Content", - "text": "(): " + "text": "getTimestamp(): " }, { "kind": "Content", @@ -1032,11 +807,11 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getTimestamp" } @@ -1045,20 +820,12 @@ }, { "kind": "Class", - "canonicalReference": "(Log:class)", + "canonicalReference": "@microsoft/sp-core-library!Log:class", "docComment": "/**\n * A basic redirectable logging system.\n *\n * @remarks\n *\n * The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Log" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Log " } ], "releaseTag": "Public", @@ -1066,28 +833,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(error:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Log.error:member(1)", "docComment": "/**\n * Logs an error.\n *\n * @param source - the source from where the error is logged, e.g., the class name. The source provides context information for the logged error. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param error - the error to be logged\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "error" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "source" - }, - { - "kind": "Content", - "text": ": " + "text": "static error(source: " }, { "kind": "Content", @@ -1095,39 +846,25 @@ }, { "kind": "Content", - "text": ", " + "text": ", error: " }, { "kind": "Reference", - "text": "error" + "text": "Error", + "canonicalReference": "!Error:interface" }, { "kind": "Content", - "text": ": " + "text": ", scope?: " }, { "kind": "Reference", - "text": "Error" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "scope" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "ServiceScope" - }, - { - "kind": "Content", - "text": "): " + "text": "): " }, { "kind": "Content", @@ -1140,31 +877,31 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "error", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "scope", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1172,28 +909,12 @@ }, { "kind": "Method", - "canonicalReference": "(info:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Log.info:member(1)", "docComment": "/**\n * Logs a general informational message.\n *\n * @param source - the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param message - the message to be logged If the message's length is more than 100, only the first 100 characters are kept.\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "info" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "source" - }, - { - "kind": "Content", - "text": ": " + "text": "static info(source: " }, { "kind": "Content", @@ -1201,15 +922,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": ", message: " }, { "kind": "Content", @@ -1217,19 +930,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "scope" - }, - { - "kind": "Content", - "text": "?: " + "text": ", scope?: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -1246,31 +952,31 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "scope", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1278,28 +984,12 @@ }, { "kind": "Method", - "canonicalReference": "(verbose:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Log.verbose:member(1)", "docComment": "/**\n * Logs a message which contains detailed information that is generally only needed for troubleshooting.\n *\n * @param source - the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param message - the message to be logged If the message's length is more than 100, only the first 100 characters are kept.\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "verbose" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "source" - }, - { - "kind": "Content", - "text": ": " + "text": "static verbose(source: " }, { "kind": "Content", @@ -1307,15 +997,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": ", message: " }, { "kind": "Content", @@ -1323,19 +1005,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "scope" - }, - { - "kind": "Content", - "text": "?: " + "text": ", scope?: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -1352,31 +1027,31 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "scope", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1384,28 +1059,12 @@ }, { "kind": "Method", - "canonicalReference": "(warn:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Log.warn:member(1)", "docComment": "/**\n * Logs a warning.\n *\n * @param source - the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept.\n *\n * @param message - the message to be logged If the message's length is more than 100, only the first 100 characters are kept.\n *\n * @param scope - the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "warn" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "source" - }, - { - "kind": "Content", - "text": ": " + "text": "static warn(source: " }, { "kind": "Content", @@ -1413,15 +1072,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": ", message: " }, { "kind": "Content", @@ -1429,19 +1080,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "scope" - }, - { - "kind": "Content", - "text": "?: " + "text": ", scope?: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -1458,31 +1102,31 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "scope", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1493,24 +1137,17 @@ }, { "kind": "Class", - "canonicalReference": "(RandomNumberGenerator:class)", + "canonicalReference": "@microsoft/sp-core-library!RandomNumberGenerator:class", "docComment": "/**\n * This is the default implementation of {@link IRandomNumberGenerator} that simply calls Math.random().\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "RandomNumberGenerator" - }, - { - "kind": "Content", - "text": " implements " + "text": "export default class RandomNumberGenerator implements " }, { "kind": "Reference", - "text": "IRandomNumberGenerator" + "text": "IRandomNumberGenerator", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface" }, { "kind": "Content", @@ -1522,24 +1159,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `RandomNumberGenerator` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -1547,29 +1177,25 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(generate:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)", "docComment": "/**\n * Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "generate" - }, { "kind": "Content", - "text": "(): " + "text": "generate(): " }, { "kind": "Content", @@ -1582,34 +1208,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "generate" }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member", "docComment": "/**\n * The service key for IRandomNumberGenerator.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -1617,7 +1236,8 @@ }, { "kind": "Reference", - "text": "IRandomNumberGenerator" + "text": "IRandomNumberGenerator", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface" }, { "kind": "Content", @@ -1631,124 +1251,203 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { - "kind": "Class", - "canonicalReference": "(ServiceKey:class)", - "docComment": "/**\n * The ServiceKey is a lookup key that is used when calling {@link ServiceScope.consume} to fetch a dependency.\n *\n * @remarks\n *\n * Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency.\n *\n * @public\n */\n", + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-core-library!ServiceCreator:type", + "docComment": "/**\n * This is a callback that is used by ServiceKey.createCustom().\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export declare type ServiceCreator = " + }, + { + "kind": "Content", + "text": "(serviceScope: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": "<" + "text": ") => T" }, { - "kind": "Reference", - "text": "T" - }, + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ServiceCreator", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class", + "docComment": "/**\n * The ServiceKey is a lookup key that is used when calling {@link ServiceScope.consume} to fetch a dependency.\n *\n * @remarks\n *\n * Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency.\n *\n * @public\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": "> " + "text": "export default class ServiceKey " } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "ServiceKey", "members": [ { "kind": "Method", - "canonicalReference": "(create:static,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey.create:member(1)", "docComment": "/**\n * Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter.\n *\n * @remarks\n *\n * If you want to specify custom constructor parameters, use {@link ServiceKey.createCustom} instead.\n *\n * @param name - A name such as \"my-package.IMyService\" which should be unique across packages.\n *\n * @param serviceClass - the TypeScript class that implements the service.\n *\n * @returns the newly created ServiceKey\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "create" + "text": "static create(name: " }, { "kind": "Content", - "text": "<" + "text": "string" }, { - "kind": "Reference", - "text": "TKey" + "kind": "Content", + "text": ", serviceClass: " }, { "kind": "Content", - "text": ">(" + "text": "{\n new (serviceScope: " }, { "kind": "Reference", - "text": "name" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Content", - "text": "string" + "text": "): TKey;\n }" }, { "kind": "Content", - "text": ", " + "text": "): " }, { "kind": "Reference", - "text": "serviceClass" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ": " + "text": "" }, { "kind": "Content", - "text": "{\n new (" - }, + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ { - "kind": "Reference", - "text": "serviceScope" + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } }, + { + "parameterName": "serviceClass", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "TKey", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "create" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey.createCustom:member(1)", + "docComment": "/**\n * Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback.\n *\n * @param name - A name such as \"my-package.IMyService\" which should be unique across packages.\n *\n * @param defaultCreator - a callback that returns an object that implements the T interface\n *\n * @returns the newly created service key\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": ": " + "text": "static createCustom(name: " }, { - "kind": "Reference", - "text": "ServiceScope" + "kind": "Content", + "text": "string" }, { "kind": "Content", - "text": "): " + "text": ", defaultCreator: " }, { "kind": "Reference", - "text": "TKey" + "text": "ServiceCreator", + "canonicalReference": "@microsoft/sp-core-library!ServiceCreator:type" }, { "kind": "Content", - "text": ";\n }" + "text": "" }, { "kind": "Content", @@ -1756,19 +1455,12 @@ }, { "kind": "Reference", - "text": "ServiceKey" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ">" + "text": "" }, { "kind": "Content", @@ -1777,176 +1469,59 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 19, - "endIndex": 23 + "startIndex": 6, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 1, + "endIndex": 2 } }, { - "parameterName": "serviceClass", + "parameterName": "defaultCreator", "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 18 + "startIndex": 3, + "endIndex": 5 } } ], - "name": "create" + "typeParameters": [ + { + "typeParameterName": "TKey", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "createCustom" }, { - "kind": "Method", - "canonicalReference": "(createCustom:static,0)", - "docComment": "/**\n * Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback.\n *\n * @param name - A name such as \"my-package.IMyService\" which should be unique across packages.\n *\n * @param defaultCreator - a callback that returns an object that implements the T interface\n *\n * @returns the newly created service key\n */\n", + "kind": "Property", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey#defaultCreator:member", + "docComment": "/**\n * A callback function that constructs the default instance of this service.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "createCustom" - }, - { - "kind": "Content", - "text": "<" + "text": "readonly defaultCreator: " }, { "kind": "Reference", - "text": "TKey" + "text": "ServiceCreator", + "canonicalReference": "@microsoft/sp-core-library!ServiceCreator:type" }, { "kind": "Content", - "text": ">(" - }, - { - "kind": "Reference", - "text": "name" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "defaultCreator" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceCreator" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TKey" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ServiceKey" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TKey" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": true, - "returnTypeTokenRange": { - "startIndex": 16, - "endIndex": 20 - }, - "releaseTag": "Public", - "overloadIndex": 0, - "parameters": [ - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - } - }, - { - "parameterName": "defaultCreator", - "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 - } - } - ], - "name": "createCustom" - }, - { - "kind": "Property", - "canonicalReference": "(defaultCreator:instance)", - "docComment": "/**\n * A callback function that constructs the default instance of this service.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "defaultCreator" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceCreator" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ">" + "text": "" }, { "kind": "Content", @@ -1956,27 +1531,19 @@ "releaseTag": "Public", "name": "defaultCreator", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey#id:member", "docComment": "/**\n * A unique identifier for this service key.\n *\n * @remarks\n *\n * This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers should not make assumptions about the formatting of this string. It is currently based on a global counter, but this may change in the future.\n *\n * The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly id: " }, { "kind": "Content", @@ -1990,27 +1557,19 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(name:instance)", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey#name:member", "docComment": "/**\n * The name of the service.\n *\n * @remarks\n *\n * This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the package name, followed by a period, followed by the class or interface name.\n *\n * The system does not assume that this string is unique. Instead, the {@link ServiceKey.id} is used wherever a lookup key is needed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "name" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly name: " }, { "kind": "Content", @@ -2024,8 +1583,8 @@ "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -2034,20 +1593,12 @@ }, { "kind": "Class", - "canonicalReference": "(ServiceScope:class)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class", "docComment": "/**\n * The service locator pattern used by the SharePoint Framework.\n *\n * @remarks\n *\n * ServiceScope provides a formalized way for components to register and consume dependencies (\"services\"), and to enable different implementations to be registered in different scopes. This improves modularity by decoupling components from their dependencies in an extensible way.\n *\n * For example, suppose that various components need access to an IPageManager instance. We could simply make the PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter for each component that requires it, however then we immediately face the problem that any code that calls these constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with name like \"ApplicationContext\", and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, it still has a design problem that \"ApplicationContext\" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the popular \"service locator\" design pattern, familiar from the SPContext API in classic SharePoint.\n *\n * ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components can assume that consume() will always return some object that implements the contract.\n *\n * Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are initially in an \"unfinished\" state, during which provide() can be called to register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the same key, and does not depend on order of initialization. It also allows us to support circular dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished().\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "ServiceScope" - }, - { - "kind": "Content", - "text": " " + "text": "export default class ServiceScope " } ], "releaseTag": "Public", @@ -2055,24 +1606,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `ServiceScope` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected constructor(" - }, - { - "kind": "Reference", - "text": "parent" - }, - { - "kind": "Content", - "text": ": " + "text": "protected constructor(parent: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -2084,68 +1628,41 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "parent", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } } ] }, { "kind": "Method", - "canonicalReference": "(consume:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#consume:member(1)", "docComment": "/**\n * Consumes a service from the service scope.\n *\n * @remarks\n *\n * Components should call this function to \"consume\" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope.\n *\n * @param serviceKey - the key that was used when provide() was called to register the service\n *\n * @returns the service instance\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "consume" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ">(" - }, - { - "kind": "Reference", - "text": "serviceKey" - }, { "kind": "Content", - "text": ": " + "text": "consume(serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ">" + "text": "" }, { "kind": "Content", "text": "): " }, { - "kind": "Reference", + "kind": "Content", "text": "T" }, { @@ -2155,17 +1672,30 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 4, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceKey", "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 + "startIndex": 1, + "endIndex": 3 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 } } ], @@ -2173,95 +1703,45 @@ }, { "kind": "Method", - "canonicalReference": "(createAndProvide:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)", "docComment": "/**\n * This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide().\n *\n * @param serviceKey - the key that can be used later to consume the service\n *\n * @param simpleServiceClass - the TypeScript class to be constructed\n *\n * @returns a newly constructed instance of simpleServiceClass\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "createAndProvide" - }, { "kind": "Content", - "text": "<" + "text": "createAndProvide(serviceKey: " }, { "kind": "Reference", - "text": "T" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ">(" - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceKey" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "simpleServiceClass" + "text": "" }, { "kind": "Content", - "text": ": " + "text": ", simpleServiceClass: " }, { "kind": "Content", - "text": "{\n new (" + "text": "{\n new (serviceScope: " }, { "kind": "Reference", - "text": "serviceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" + "text": "): T;\n }" }, { "kind": "Content", "text": "): " }, - { - "kind": "Reference", - "text": "T" - }, { "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", "text": "T" }, { @@ -2271,24 +1751,37 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 21, - "endIndex": 22 + "startIndex": 8, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceKey", "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 + "startIndex": 1, + "endIndex": 3 } }, { "parameterName": "simpleServiceClass", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 20 + "startIndex": 4, + "endIndex": 7 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 } } ], @@ -2296,55 +1789,28 @@ }, { "kind": "Method", - "canonicalReference": "(createDefaultAndProvide:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)", "docComment": "/**\n * This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide().\n *\n * @param serviceKey - the key that can be used later to consume the service\n *\n * @returns a service instance that was constructed using ServiceKey.defaultCreator\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "createDefaultAndProvide" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, { "kind": "Content", - "text": ">(" + "text": "createDefaultAndProvide(serviceKey: " }, { "kind": "Reference", - "text": "serviceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceKey" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ">" + "text": "" }, { "kind": "Content", "text": "): " }, { - "kind": "Reference", + "kind": "Content", "text": "T" }, { @@ -2354,17 +1820,30 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 4, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceKey", "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 + "startIndex": 1, + "endIndex": 3 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 } } ], @@ -2372,16 +1851,12 @@ }, { "kind": "Method", - "canonicalReference": "(finish:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#finish:member(1)", "docComment": "/**\n * Completes the initialization sequence for a service scope.\n *\n * @remarks\n *\n * When a ServiceScope is first started, it is in an \"unfinished\" state where provide() is allowed but consume() is disallowed. After calling finish(), then consume() is allowed but provide() is disallowed.\n *\n * This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "finish" - }, { "kind": "Content", - "text": "(): " + "text": "finish(): " }, { "kind": "Content", @@ -2394,30 +1869,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "finish" }, { "kind": "Method", - "canonicalReference": "(getParent:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#getParent:member(1)", "docComment": "/**\n * Returns the parent of the current ServiceScope, or undefined if this is a root scope.\n *\n * @returns the parent service scope\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getParent" - }, { "kind": "Content", - "text": "(): " + "text": "getParent(): " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -2430,73 +1902,38 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getParent" }, { "kind": "Method", - "canonicalReference": "(provide:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#provide:member(1)", "docComment": "/**\n * Add a new service to a service scope.\n *\n * @remarks\n *\n * ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an \"unfinished\" state, i.e. before finish() has been called.\n *\n * @param serviceKey - the key that will later be used to consume the service\n *\n * @param service - the service instance that is being registered\n *\n * @returns the same object that was passed as the \"service\" parameter\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "provide" - }, { "kind": "Content", - "text": "<" + "text": "provide(serviceKey: " }, { "kind": "Reference", - "text": "T" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ">(" - }, - { - "kind": "Reference", - "text": "serviceKey" + "text": "" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceKey" + "text": ", service: " }, { "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "service" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", "text": "T" }, { @@ -2504,7 +1941,7 @@ "text": "): " }, { - "kind": "Reference", + "kind": "Content", "text": "T" }, { @@ -2514,24 +1951,37 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 6, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceKey", "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 + "startIndex": 1, + "endIndex": 3 } }, { "parameterName": "service", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 4, + "endIndex": 5 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 } } ], @@ -2539,20 +1989,17 @@ }, { "kind": "Method", - "canonicalReference": "(startNewChild:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)", "docComment": "/**\n * Constructs a new ServiceScope that is a child of the current scope.\n *\n * @remarks\n *\n * The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted.\n *\n * @returns the newly created root ServiceScope\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "startNewChild" - }, { "kind": "Content", - "text": "(): " + "text": "startNewChild(): " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -2561,34 +2008,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "startNewChild" }, { "kind": "Method", - "canonicalReference": "(startNewRoot:static,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)", "docComment": "/**\n * Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys.\n *\n * @returns the newly created root ServiceScope\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " + "text": "static startNewRoot(): " }, { "kind": "Reference", - "text": "startNewRoot" - }, - { - "kind": "Content", - "text": "(): " - }, - { - "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -2597,34 +2037,22 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "startNewRoot" }, { "kind": "Method", - "canonicalReference": "(whenFinished:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)", "docComment": "/**\n * Defer an operation until after {@link ServiceScope.finish} has completed.\n *\n * @remarks\n *\n * It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed later when the scope is finished.\n *\n * NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished().\n *\n * @param callback - A block of code that needs to call ServiceScope.consume()\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "whenFinished" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, { "kind": "Content", - "text": ": " + "text": "whenFinished(callback: " }, { "kind": "Content", @@ -2645,17 +2073,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2666,20 +2094,12 @@ }, { "kind": "Class", - "canonicalReference": "(Session:class)", + "canonicalReference": "@microsoft/sp-core-library!Session:class", "docComment": "/**\n * Provides access to the application's browser session and active page.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Session" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Session " } ], "releaseTag": "Public", @@ -2687,24 +2107,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(applicationId:static)", + "canonicalReference": "@microsoft/sp-core-library!Session.applicationId:member", "docComment": "/**\n * A unique identifier for the current instance of the client-side application.\n *\n * @remarks\n *\n * A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the duration of the client-side application instance, i.e. it begins with the server request that renders the page, and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "applicationId" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly applicationId: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -2714,31 +2127,24 @@ "releaseTag": "Public", "name": "applicationId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(pageId:static)", + "canonicalReference": "@microsoft/sp-core-library!Session.pageId:member", "docComment": "/**\n * A unique identifier for the current page within the client-side application.\n *\n * @remarks\n *\n * A unique identifier used to correlate logging and other diagnostic information. Whereas the {@link Session.applicationId} tracks the entire lifetime of the client-side application instance, the pageId tracks an individual \"page\" that is rendered.\n *\n * For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA independently of PageB.\n *\n * The concept of a page is subjective and defined by the router for a particular application.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "pageId" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly pageId: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -2748,8 +2154,8 @@ "releaseTag": "Public", "name": "pageId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true } @@ -2758,32 +2164,17 @@ }, { "kind": "Class", - "canonicalReference": "(SPEvent:class)", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class", "docComment": "/**\n * Represents a framework event that components can subscribe to.\n *\n * @remarks\n *\n * Examples of events in a web application might include: the user clicking a button, the system navigating to another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The handler receives an SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when the component is disposed.\n *\n * When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception will not prevent other handlers from executing, but it will be reported as a problem with the associated component.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPEvent` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class SPEvent void" + "text": "(eventArgs: TEventArgs) => void" }, { "kind": "Content", @@ -2865,24 +2234,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "observer", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "eventHandler", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 13 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2890,60 +2259,25 @@ }, { "kind": "Method", - "canonicalReference": "(remove:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!SPEvent#remove:member(1)", "docComment": "/**\n * Unregisters a callback that was registered using add().\n *\n * @remarks\n *\n * If the event handler has already been removed, or if it was never added, then this method has no effect.\n *\n * @param observer - This must be the same observer that was passed to the add() function.\n *\n * @param eventHandler - The event handler to remove; this must be the same object instance that was passed to the add() function.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "remove" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "observer" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISPEventObserver" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "eventHandler" - }, - { - "kind": "Content", - "text": ": " - }, { "kind": "Content", - "text": "(" + "text": "remove(observer: " }, { "kind": "Reference", - "text": "eventArgs" + "text": "ISPEventObserver", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver:interface" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "TEventArgs" + "text": ", eventHandler: " }, { "kind": "Content", - "text": ") => void" + "text": "(eventArgs: TEventArgs) => void" }, { "kind": "Content", @@ -2960,24 +2294,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "observer", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "eventHandler", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 13 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2988,20 +2322,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPEventArgs:class)", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class", "docComment": "/**\n * The base class for event arguments used with the {@link SPEvent} class.\n *\n * @remarks\n *\n * If certain event types need to provide additional details, they will define a subclass of SPEventArgs.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPEventArgs" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPEventArgs " } ], "releaseTag": "Public", @@ -3011,20 +2337,12 @@ }, { "kind": "Class", - "canonicalReference": "(Text:class)", + "canonicalReference": "@microsoft/sp-core-library!Text:class", "docComment": "/**\n * Operations for working with strings that contain text.\n *\n * @remarks\n *\n * The utilities provided by this class are intended to be simple, small, and very broadly applicable.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Text" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Text " } ], "releaseTag": "Public", @@ -3032,28 +2350,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(format:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Text.format:member(1)", "docComment": "/**\n * Format a string by substituting parameters.\n *\n * @remarks\n *\n * This function replaces template parameters such as `\"{0}\"` or `\"{1}\"` with the corresponding argument. If the value is null or undefined, it will be replaced by the word `\"null\"` or `\"undefined\"`. The format string s must not be null or undefined.\n *\n * Usage example:\n *\n * `Text.format(\"hello {0}!\", \"world\")` will return `\"hello world!\"`\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "format" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "s" - }, - { - "kind": "Content", - "text": ": " + "text": "static format(s: " }, { "kind": "Content", @@ -3061,15 +2363,7 @@ }, { "kind": "Content", - "text": ", ..." - }, - { - "kind": "Reference", - "text": "values" - }, - { - "kind": "Content", - "text": ": " + "text": ", ...values: " }, { "kind": "Content", @@ -3090,24 +2384,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "s", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "values", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -3115,28 +2409,12 @@ }, { "kind": "Method", - "canonicalReference": "(replaceAll:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Text.replaceAll:member(1)", "docComment": "/**\n * Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.\n *\n * @remarks\n *\n * Note that JavaScript's `string.replace()` only replaces the first match, unless a global RegExp is provided.\n *\n * @param input - The string to be modified\n *\n * @param searchValue - The value to search for\n *\n * @param replaceValue - The replacement text\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "replaceAll" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "input" - }, - { - "kind": "Content", - "text": ": " + "text": "static replaceAll(input: " }, { "kind": "Content", @@ -3144,15 +2422,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "searchValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", searchValue: " }, { "kind": "Content", @@ -3160,15 +2430,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "replaceValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", replaceValue: " }, { "kind": "Content", @@ -3189,31 +2451,31 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "searchValue", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "replaceValue", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3224,24 +2486,17 @@ }, { "kind": "Class", - "canonicalReference": "(TimeProvider:class)", + "canonicalReference": "@microsoft/sp-core-library!TimeProvider:class", "docComment": "/**\n * This is the default implementation of {@link ITimeProvider} that simply calls the real browser APIs.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "TimeProvider" - }, - { - "kind": "Content", - "text": " implements " + "text": "export default class TimeProvider implements " }, { "kind": "Reference", - "text": "ITimeProvider" + "text": "ITimeProvider", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider:interface" }, { "kind": "Content", @@ -3253,24 +2508,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-core-library!TimeProvider:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `TimeProvider` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -3278,33 +2526,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(getDate:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!TimeProvider#getDate:member(1)", "docComment": "/**\n * Returns the current date/time, similar to the Date class constructor.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getDate" - }, { "kind": "Content", - "text": "(): " + "text": "getDate(): " }, { "kind": "Reference", - "text": "Date" + "text": "Date", + "canonicalReference": "!Date:interface" }, { "kind": "Content", @@ -3313,26 +2558,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getDate" }, { "kind": "Method", - "canonicalReference": "(getTimestamp:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)", "docComment": "/**\n * Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getTimestamp" - }, { "kind": "Content", - "text": "(): " + "text": "getTimestamp(): " }, { "kind": "Content", @@ -3345,34 +2586,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getTimestamp" }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-core-library!TimeProvider.serviceKey:member", "docComment": "/**\n * The service key for ITimeProvider.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -3380,7 +2614,8 @@ }, { "kind": "Reference", - "text": "ITimeProvider" + "text": "ITimeProvider", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider:interface" }, { "kind": "Content", @@ -3394,35 +2629,27 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(UrlQueryParameterCollection:class)", + "canonicalReference": "@microsoft/sp-core-library!UrlQueryParameterCollection:class", "docComment": "/**\n * Provides features for storing and retrieving URL query parameters.\n *\n * @remarks\n *\n * The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with \"?\" to indicate the first query parameter and use \"&\" for all subsequent parameters. The class also supports fragments.\n *\n * Edge case behavior:\n *\n * Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value\n *\n * @deprecated\n *\n * Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "UrlQueryParameterCollection" - }, - { - "kind": "Content", - "text": " " + "text": "export default class UrlQueryParameterCollection " } ], "releaseTag": "Public", @@ -3430,20 +2657,12 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `UrlQueryParameterCollection` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(url: " }, { "kind": "Content", @@ -3455,37 +2674,25 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(getValue:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)", "docComment": "/**\n * Returns the value of the first matching query parameter or undefined if the key doesn't exist.\n *\n * @remarks\n *\n * Examples:\n * ```\n * this._queryParameterList = [\n * {key: TEST, value: done},\n * {key: DEBUG, value: false},\n * {key: TEST, value: notdone}]\n * getValue('TEST') ---> 'done'\n * getValue('debug') ---> 'false'\n * getValue('lost') ---> undefined\n * ```\n *\n * @param param - the case insensitive key for the desired query parameter value.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getValue" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "param" - }, { "kind": "Content", - "text": ": " + "text": "getValue(param: " }, { "kind": "Content", @@ -3506,17 +2713,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "param", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3524,24 +2731,12 @@ }, { "kind": "Method", - "canonicalReference": "(getValues:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)", "docComment": "/**\n * Returns the values of all of the matching query parameters or undefined if the key doesn't exist.\n *\n * @remarks\n *\n * Examples:\n * ```\n * this._queryParameterList = [\n * {key: TEST, value: done},\n * {key: DEBUG, value: false},\n * {key: TEST, value: notdone}]\n * getValues('TEST') ---> ['done', 'notdone']\n * getValues('debug') ---> ['false']\n * getValues('lost') ---> undefined\n * ```\n *\n * @param param - the case insensitive key for the desired query parameter value.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getValues" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "param" - }, - { - "kind": "Content", - "text": ": " + "text": "getValues(param: " }, { "kind": "Content", @@ -3562,17 +2757,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "param", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3583,20 +2778,12 @@ }, { "kind": "Class", - "canonicalReference": "(Validate:class)", + "canonicalReference": "@microsoft/sp-core-library!Validate:class", "docComment": "/**\n * Performs common validation tests for properties and function parameters.\n *\n * @remarks\n *\n * This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Validate" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Validate " } ], "releaseTag": "Public", @@ -3604,28 +2791,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(isNonemptyString:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Validate.isNonemptyString:member(1)", "docComment": "/**\n * Throws an exception if the specified string is null, undefined, or an empty string.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "isNonemptyString" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "value" - }, - { - "kind": "Content", - "text": ": " + "text": "static isNonemptyString(value: " }, { "kind": "Content", @@ -3633,15 +2804,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "variableName" - }, - { - "kind": "Content", - "text": ": " + "text": ", variableName: " }, { "kind": "Content", @@ -3662,24 +2825,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "variableName", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -3687,44 +2850,21 @@ }, { "kind": "Method", - "canonicalReference": "(isNotDisposed:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Validate.isNotDisposed:member(1)", "docComment": "/**\n * Throws an exception if the specified object has been disposed.\n *\n * @param value - the value to check\n *\n * @param className - the class name, which will be mentioned in the error message\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "isNotDisposed" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "value" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IDisposable" - }, - { - "kind": "Content", - "text": ", " + "text": "static isNotDisposed(value: " }, { "kind": "Reference", - "text": "className" + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" }, { "kind": "Content", - "text": ": " + "text": ", className: " }, { "kind": "Content", @@ -3745,53 +2885,37 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "className", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], "name": "isNotDisposed" - }, - { - "kind": "Method", - "canonicalReference": "(isNotNullOrUndefined:static,0)", - "docComment": "/**\n * Throws an exception if the specified value is null or undefined.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "isNotNullOrUndefined" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "value" - }, + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)", + "docComment": "/**\n * Throws an exception if the specified value is null or undefined.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": ": " + "text": "static isNotNullOrUndefined(value: " }, { "kind": "Content", @@ -3799,15 +2923,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "variableName" - }, - { - "kind": "Content", - "text": ": " + "text": ", variableName: " }, { "kind": "Content", @@ -3828,24 +2944,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "variableName", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -3853,28 +2969,12 @@ }, { "kind": "Method", - "canonicalReference": "(isTrue:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Validate.isTrue:member(1)", "docComment": "/**\n * Throws an exception if the specified value is not true.\n *\n * @param value - the value to check\n *\n * @param variableName - the program variable name, which will be mentioned in the error message\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "isTrue" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "value" - }, - { - "kind": "Content", - "text": ": " + "text": "static isTrue(value: " }, { "kind": "Content", @@ -3882,15 +2982,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "variableName" - }, - { - "kind": "Content", - "text": ": " + "text": ", variableName: " }, { "kind": "Content", @@ -3911,24 +3003,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "variableName", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -3939,20 +3031,12 @@ }, { "kind": "Class", - "canonicalReference": "(Version:class)", + "canonicalReference": "@microsoft/sp-core-library!Version:class", "docComment": "/**\n * Represents a version number with two, three, or four parts.\n *\n * @remarks\n *\n * This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but they are discarded. Missing parts are treated as zeroes for comparisons.\n *\n * Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Version" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Version " } ], "releaseTag": "Public", @@ -3960,48 +3044,26 @@ "members": [ { "kind": "Method", - "canonicalReference": "(compare:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Version.compare:member(1)", "docComment": "/**\n * Compares two Version objects to determine which version is newer.\n *\n * @param v1 - The first version class for comparison\n *\n * @param v2 - The second version class for comparison\n *\n * @returns -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if the first input is greater than the second input.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "compare" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "v1" - }, - { - "kind": "Content", - "text": ": " + "text": "static compare(v1: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", - "text": ", " + "text": ", v2: " }, { "kind": "Reference", - "text": "v2" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4018,24 +3080,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "v1", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "v2", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -4043,28 +3105,17 @@ }, { "kind": "Method", - "canonicalReference": "(equals:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Version#equals:member(1)", "docComment": "/**\n * Tests whether this version is equal to the input parameter.\n *\n * @remarks\n *\n * Examples:\n * ```\n * 1.0.0 equals 1.0.0 -> true;\n * 2.0.1 equals 2.0.0 -> false;\n * 3.0 equals 3.0.0 -> true;\n * 04.01 equals 4.1 -> true\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is equal to the input parameter\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "equals" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "compareWith" - }, { "kind": "Content", - "text": ": " + "text": "equals(compareWith: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4081,17 +3132,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "compareWith", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4099,28 +3150,17 @@ }, { "kind": "Method", - "canonicalReference": "(greaterThan:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Version#greaterThan:member(1)", "docComment": "/**\n * Tests whether this version is greater than (i.e. newer than) the input parameter.\n *\n * @remarks\n *\n * Examples:\n * ```\n * 1.0.0 greaterThan 0.0.9 -> true;\n * 2.0 greaterThan 2.0.0 -> false;\n * 3.0.1 greaterThan 3.0 -> true\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is greater than the input parameter\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "greaterThan" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "compareWith" - }, { "kind": "Content", - "text": ": " + "text": "greaterThan(compareWith: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4137,17 +3177,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "compareWith", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4155,28 +3195,12 @@ }, { "kind": "Method", - "canonicalReference": "(isValid:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Version.isValid:member(1)", "docComment": "/**\n * Test whether a string is a valid version specifier.\n *\n * @param versionString - The version string\n *\n * @returns true if the versionString is a valid version specifier\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "isValid" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "versionString" - }, - { - "kind": "Content", - "text": ": " + "text": "static isValid(versionString: " }, { "kind": "Content", @@ -4197,17 +3221,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "versionString", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4215,28 +3239,17 @@ }, { "kind": "Method", - "canonicalReference": "(lessThan:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Version#lessThan:member(1)", "docComment": "/**\n * Tests whether this version is less than (i.e. older than) the input parameter.\n *\n * @remarks\n *\n * Examples:\n * ```\n * 0.9.9 lessThan 1.0.0 -> true;\n * 2.0 lessThan 2.0.0 -> false;\n * 3.0 lessThan 3.0.1 -> true;\n * 04.01 lessThan 4.1 -> false\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is less than the input parameter\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "lessThan" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "compareWith" - }, { "kind": "Content", - "text": ": " + "text": "lessThan(compareWith: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4253,17 +3266,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "compareWith", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4271,20 +3284,12 @@ }, { "kind": "Property", - "canonicalReference": "(major:instance)", + "canonicalReference": "@microsoft/sp-core-library!Version#major:member", "docComment": "/**\n * Returns the first component of the version string.\n *\n * @remarks\n *\n * Typically a change in the major version number indicates a compatibility break with previous versions.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "major" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly major: " }, { "kind": "Content", @@ -4298,27 +3303,19 @@ "releaseTag": "Public", "name": "major", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(minor:instance)", + "canonicalReference": "@microsoft/sp-core-library!Version#minor:member", "docComment": "/**\n * Returns the second component of the version string.\n *\n * @remarks\n *\n * Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "minor" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly minor: " }, { "kind": "Content", @@ -4332,35 +3329,19 @@ "releaseTag": "Public", "name": "minor", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(parse:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Version.parse:member(1)", "docComment": "/**\n * Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed.\n *\n * @param versionString - A version string\n *\n * @returns a new Version object\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "parse" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "versionString" - }, - { - "kind": "Content", - "text": ": " + "text": "static parse(versionString: " }, { "kind": "Content", @@ -4372,7 +3353,8 @@ }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4381,17 +3363,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "versionString", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4399,20 +3381,12 @@ }, { "kind": "Property", - "canonicalReference": "(patch:instance)", + "canonicalReference": "@microsoft/sp-core-library!Version#patch:member", "docComment": "/**\n * The third number in the version string, or undefined if unspecified.\n *\n * @remarks\n *\n * Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the \"build\" number.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "patch" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly patch: " }, { "kind": "Content", @@ -4426,27 +3400,19 @@ "releaseTag": "Public", "name": "patch", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(revision:instance)", + "canonicalReference": "@microsoft/sp-core-library!Version#revision:member", "docComment": "/**\n * The fourth number in the version string, or undefined if unspecified.\n *\n * @remarks\n *\n * This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "revision" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly revision: " }, { "kind": "Content", @@ -4460,35 +3426,24 @@ "releaseTag": "Public", "name": "revision", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(satisfies:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Version#satisfies:member(1)", "docComment": "/**\n * Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible.\n *\n * @remarks\n *\n * In order to satisfy the compatibility requirements, this object must have the same major version number as the input parameter, and it must NOT be older than the input parameter.\n *\n * Examples:\n * ```\n * 1.0.0 satisfies 1.0.0 -> true;\n * 1.1.0 satisfies 1.0.0 -> true;\n * 2.0.0 satisfies 1.0.0 -> false;\n * 1.0.0 satisfies 1.1.0 -> false\n * ```\n *\n * @param compareWith - The version to compare with\n *\n * @returns A boolean indicating if this version is compatible with the input parameter\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "satisfies" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "compareWith" - }, { "kind": "Content", - "text": ": " + "text": "satisfies(compareWith: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4505,17 +3460,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "compareWith", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4523,16 +3478,12 @@ }, { "kind": "Method", - "canonicalReference": "(toString:instance,0)", + "canonicalReference": "@microsoft/sp-core-library!Version#toString:member(1)", "docComment": "/**\n * Returns a string representation of the version.\n *\n * @remarks\n *\n * The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "toString" - }, { "kind": "Content", - "text": "(): " + "text": "toString(): " }, { "kind": "Content", @@ -4545,38 +3496,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "toString" }, { "kind": "Method", - "canonicalReference": "(tryParse:static,0)", + "canonicalReference": "@microsoft/sp-core-library!Version.tryParse:member(1)", "docComment": "/**\n * Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned.\n *\n * @param versionString - A version string\n *\n * @returns The Version object, or undefined if the string could not be parsed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "tryParse" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "versionString" - }, - { - "kind": "Content", - "text": ": " + "text": "static tryParse(versionString: " }, { "kind": "Content", @@ -4588,7 +3523,8 @@ }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" }, { "kind": "Content", @@ -4601,17 +3537,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 9 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "versionString", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4619,59 +3555,6 @@ } ], "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "ServiceCreator", - "docComment": "/**\n * This is a callback that is used by ServiceKey.createCustom().\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type " - }, - { - "kind": "Reference", - "text": "ServiceCreator" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": "> = (" - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "ServiceCreator" } ] } diff --git a/generate-docs/json/sp-diagnostics.api.json b/generate-docs/json/sp-diagnostics.api.json index 638f53e5..92c0df19 100644 --- a/generate-docs/json/sp-diagnostics.api.json +++ b/generate-docs/json/sp-diagnostics.api.json @@ -1,35 +1,33 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-diagnostics", + "canonicalReference": "@microsoft/sp-diagnostics!", "docComment": "/**\n * This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user engagement and performance logging.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-diagnostics", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-diagnostics!", "name": "", "members": [ { "kind": "Variable", - "canonicalReference": "_logSourceServiceKey", + "canonicalReference": "@microsoft/sp-diagnostics!_logSourceServiceKey:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "logSourceServiceKey" - }, { "kind": "Content", - "text": ": " + "text": "logSourceServiceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -37,7 +35,8 @@ }, { "kind": "Reference", - "text": "LogSource" + "text": "LogSource", + "canonicalReference": "@microsoft/sp-diagnostics!default:class" }, { "kind": "Content", @@ -47,8 +46,8 @@ "releaseTag": "Public", "name": "_logSourceServiceKey", "variableTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 } } ] diff --git a/generate-docs/json/sp-dialog.api.json b/generate-docs/json/sp-dialog.api.json index e97efa16..86849b91 100644 --- a/generate-docs/json/sp-dialog.api.json +++ b/generate-docs/json/sp-dialog.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-dialog", + "canonicalReference": "@microsoft/sp-dialog!", "docComment": "/**\n * SharePoint Framework support for displaying pop-up dialog boxes.\n *\n * @remarks\n *\n * This library provides simple stock dialogs such as {@link Dialog.alert} and {@link Dialog.prompt}, along with a general framework for building custom dialog boxes that participate in the focus management system for SharePoint Framework applications.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-dialog", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-dialog!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(BaseDialog:class)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog:class", "docComment": "/**\n * The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to the user inside SharePoint Framework components.\n *\n * @remarks\n *\n * Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " - }, - { - "kind": "Reference", - "text": "BaseDialog" - }, - { - "kind": "Content", - "text": " " + "text": "export default abstract class BaseDialog " } ], "releaseTag": "Public", @@ -37,24 +30,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog:constructor(1)", "docComment": "/**\n * Constructor for the `BaseDialog` class.\n *\n * @remarks\n *\n * It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can use the constructor to set initial parameters of your dialog such as references to resources in your application. The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to dispose.\n *\n * Example:\n * ```\n * constructor(cacheReference: any) {\n * super();\n *\n * this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache.\n * this._cache.refresh(); // This is bad practice.\n * // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen()\n * }\n * ```\n *\n * @param config - the dialog configuration that affects how the dialog is displayed *\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" + "text": "constructor(config?: " }, { "kind": "Reference", - "text": "config" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "IDialogConfiguration" + "text": "IDialogConfiguration", + "canonicalReference": "@microsoft/sp-dialog!IDialogConfiguration:interface" }, { "kind": "Content", @@ -62,33 +48,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(close:instance,0)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#close:member(1)", "docComment": "/**\n * Close the dialog.\n *\n * @remarks\n *\n * This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show.\n *\n * @returns A promise that resolves when the dialog is visually closed, or if it was already closed\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "close" - }, { "kind": "Content", - "text": "(): " + "text": "close(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -101,34 +84,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "Property", - "canonicalReference": "(domElement:instance)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#domElement:member", "docComment": "/**\n * Use this property to access the container element provided by the framework for rendering.\n *\n * @remarks\n *\n * See {@link BaseDialog.render} for more information on rendering.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " + "text": "protected readonly domElement: " }, { "kind": "Reference", - "text": "domElement" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "HTMLElement" + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", @@ -138,27 +114,19 @@ "releaseTag": "Public", "name": "domElement", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isHidden:instance)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#isHidden:member", "docComment": "/**\n * If the dialog is visually hidden.\n *\n * @remarks\n *\n * This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isHidden" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isHidden: " }, { "kind": "Content", @@ -172,27 +140,19 @@ "releaseTag": "Public", "name": "isHidden", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isOpen:instance)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#isOpen:member", "docComment": "/**\n * If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isOpen" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isOpen: " }, { "kind": "Content", @@ -206,27 +166,19 @@ "releaseTag": "Public", "name": "isOpen", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isSecondary:instance)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#isSecondary:member", "docComment": "/**\n * If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isSecondary" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isSecondary: " }, { "kind": "Content", @@ -240,27 +192,19 @@ "releaseTag": "Public", "name": "isSecondary", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(onAfterClose:instance,0)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)", "docComment": "/**\n * This method is called after the dialog is visually closed and gives an opportunity for doing clean up.\n *\n * @remarks\n *\n * The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onAfterClose" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onAfterClose(): " }, { "kind": "Content", @@ -273,34 +217,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onAfterClose" }, { "kind": "Method", - "canonicalReference": "(onBeforeOpen:instance,0)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)", "docComment": "/**\n * This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method.\n *\n * @remarks\n *\n * All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak.\n *\n * @returns A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and `onAfterClose()` will not be called.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " + "text": "protected onBeforeOpen(): " }, { "kind": "Reference", - "text": "onBeforeOpen" - }, - { - "kind": "Content", - "text": "(): " - }, - { - "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -313,30 +250,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onBeforeOpen" }, { "kind": "Method", - "canonicalReference": "(render:instance,0)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#render:member(1)", "docComment": "/**\n * Renders the contents of the dialog.\n *\n * @remarks\n *\n * The `render` method must be implemented to render the content of the dialog in the container element provided by the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the center of the page on top of a dark overlay.\n *\n * The render method is called once after the modal element is created and opened. It is recommended to use `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected abstract " - }, - { - "kind": "Reference", - "text": "render" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected abstract render(): " }, { "kind": "Content", @@ -349,34 +278,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "Property", - "canonicalReference": "(secondaryDialogProvider:instance)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member", "docComment": "/**\n * An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs are permitted.\n *\n * @remarks\n *\n * Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly secondaryDialogProvider: " }, { "kind": "Reference", - "text": "secondaryDialogProvider" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISecondaryDialogProvider" + "text": "ISecondaryDialogProvider", + "canonicalReference": "@microsoft/sp-dialog!ISecondaryDialogProvider:interface" }, { "kind": "Content", @@ -390,35 +312,24 @@ "releaseTag": "Public", "name": "secondaryDialogProvider", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(show:instance,0)", + "canonicalReference": "@microsoft/sp-dialog!BaseDialog#show:member(1)", "docComment": "/**\n * Request the framework to show this dialog.\n *\n * @param options - Dialog showing options. See {@link IDialogShowOptions} for more information.\n *\n * @returns A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or aborted.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "show" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "options" - }, { "kind": "Content", - "text": "?: " + "text": "show(options?: " }, { "kind": "Reference", - "text": "IDialogShowOptions" + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" }, { "kind": "Content", @@ -426,7 +337,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -439,17 +351,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -460,20 +372,12 @@ }, { "kind": "Class", - "canonicalReference": "(Dialog:class)", + "canonicalReference": "@microsoft/sp-dialog!Dialog:class", "docComment": "/**\n * A static class for showing stock dialogs such as an alert or prompt.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Dialog" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Dialog " } ], "releaseTag": "Public", @@ -481,28 +385,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(alert:static,0)", + "canonicalReference": "@microsoft/sp-dialog!Dialog.alert:member(1)", "docComment": "/**\n * Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog.\n *\n * @remarks\n *\n * There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason.\n *\n * @param message - The message to alert\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "alert" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": "static alert(message: " }, { "kind": "Content", @@ -510,19 +398,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "IAlertOptions" + "text": "IAlertOptions", + "canonicalReference": "@microsoft/sp-dialog!IAlertOptions:interface" }, { "kind": "Content", @@ -530,7 +411,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -543,24 +425,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 13 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -568,28 +450,12 @@ }, { "kind": "Method", - "canonicalReference": "(prompt:static,0)", + "canonicalReference": "@microsoft/sp-dialog!Dialog.prompt:member(1)", "docComment": "/**\n * Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog.\n *\n * @remarks\n *\n * There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason.\n *\n * @param message - The message for prompt dialog\n *\n * @param defaultValue - The default value for the input text field\n *\n * @returns The input string or undefined if the dialog was canceled\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "prompt" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": "static prompt(message: " }, { "kind": "Content", @@ -597,19 +463,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", options?: " }, { "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "IPromptOptions" + "text": "IPromptOptions", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions:interface" }, { "kind": "Content", @@ -617,7 +476,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -630,24 +490,24 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 13 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -658,24 +518,17 @@ }, { "kind": "Interface", - "canonicalReference": "(IAlertOptions:interface)", + "canonicalReference": "@microsoft/sp-dialog!IAlertOptions:interface", "docComment": "/**\n * Options for showing an alert dialog\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IAlertOptions" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IAlertOptions extends " }, { "kind": "Reference", - "text": "IDialogShowOptions" + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" }, { "kind": "Content", @@ -687,27 +540,19 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(IDialogConfiguration:interface)", + "canonicalReference": "@microsoft/sp-dialog!IDialogConfiguration:interface", "docComment": "/**\n * The interface for dialog configuration\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDialogConfiguration" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDialogConfiguration " } ], "releaseTag": "Public", @@ -715,16 +560,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "isBlocking", + "canonicalReference": "@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member", "docComment": "/**\n * Whether the dialog can be closed by clicking outside the dialog (on the overlay).\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isBlocking" - }, { "kind": "Content", - "text": "?: " + "text": "isBlocking?: " }, { "kind": "Content", @@ -738,8 +579,8 @@ "releaseTag": "Public", "name": "isBlocking", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -747,20 +588,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDialogShowOptions:interface)", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface", "docComment": "/**\n * Options for showing a dialog\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDialogShowOptions" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDialogShowOptions " } ], "releaseTag": "Public", @@ -768,16 +601,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "confirmOpen", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member", "docComment": "/**\n * A callback that is invoked immediately before the dialog receives focus.\n *\n * @remarks\n *\n * Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the framework. For example, you can check if a long time has passed since the request was made or the the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "confirmOpen" - }, { "kind": "Content", - "text": "?: " + "text": "confirmOpen?: " }, { "kind": "Content", @@ -791,8 +620,8 @@ "releaseTag": "Public", "name": "confirmOpen", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -800,24 +629,17 @@ }, { "kind": "Interface", - "canonicalReference": "(IPromptOptions:interface)", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions:interface", "docComment": "/**\n * Options for showing a prompt dialog\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPromptOptions" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IPromptOptions extends " }, { "kind": "Reference", - "text": "IDialogShowOptions" + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" }, { "kind": "Content", @@ -829,16 +651,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "defaultValue", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions#defaultValue:member", "docComment": "/**\n * The default value for the input text field of prompt dialog\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "defaultValue" - }, { "kind": "Content", - "text": "?: " + "text": "defaultValue?: " }, { "kind": "Content", @@ -852,34 +670,26 @@ "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISecondaryDialogProvider:interface)", + "canonicalReference": "@microsoft/sp-dialog!ISecondaryDialogProvider:interface", "docComment": "/**\n * This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider inside a dialog.\n *\n * @remarks\n *\n * Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more secondary dialogs are rejected.\n *\n * See {@link BaseDialog.secondaryDialogProvider} for how to use this.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISecondaryDialogProvider" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISecondaryDialogProvider " } ], "releaseTag": "Public", @@ -887,24 +697,12 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(alert:0)", + "canonicalReference": "@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)", "docComment": "/**\n * Similar to {@link Dialog.alert}. The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects.\n *\n * @param options - Dialog showing options. See {@link IDialogShowOptions} for more information.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "alert" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": "alert(message: " }, { "kind": "Content", @@ -912,19 +710,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "IAlertOptions" + "text": "IAlertOptions", + "canonicalReference": "@microsoft/sp-dialog!IAlertOptions:interface" }, { "kind": "Content", @@ -932,7 +723,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -944,24 +736,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -969,24 +761,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(prompt:0)", + "canonicalReference": "@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)", "docComment": "/**\n * Similar to {@link Dialog.prompt}. The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects.\n *\n * @param options - Dialog showing options. The confirmOpen option will be ignored. See {@link IDialogShowOptions} for more information.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "prompt" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "message" - }, { "kind": "Content", - "text": ": " + "text": "prompt(message: " }, { "kind": "Content", @@ -994,19 +774,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", options?: " }, { "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "IPromptOptions" + "text": "IPromptOptions", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions:interface" }, { "kind": "Content", @@ -1014,7 +787,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1026,24 +800,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -1051,44 +825,26 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(show:0)", + "canonicalReference": "@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)", "docComment": "/**\n * Similar to {@link BaseDialog.show}. The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects.\n *\n * @param options - Dialog showing options. The confirmOpen option will be ignored. See {@link IDialogShowOptions} for more information.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "show" - }, { "kind": "Content", - "text": "(" + "text": "show(dialog: " }, { "kind": "Reference", - "text": "dialog" + "text": "BaseDialog", + "canonicalReference": "@microsoft/sp-dialog!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options?: " }, { "kind": "Reference", - "text": "BaseDialog" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "IDialogShowOptions" + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" }, { "kind": "Content", @@ -1096,7 +852,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1108,24 +865,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "dialog", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], diff --git a/generate-docs/json/sp-dynamic-data.api.json b/generate-docs/json/sp-dynamic-data.api.json index e1afe9b0..a0552b4f 100644 --- a/generate-docs/json/sp-dynamic-data.api.json +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-dynamic-data", + "canonicalReference": "@microsoft/sp-dynamic-data!", "docComment": "/**\n * SharePoint Framework support for dynamic data bindings.\n *\n * @remarks\n *\n * This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and implement components that use it.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-dynamic-data", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-dynamic-data!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(DynamicDataReference:class)", + "canonicalReference": "@microsoft/sp-dynamic-data!DynamicDataReference:class", "docComment": "/**\n * Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data\n *\n * @remarks\n *\n * The reference string is of the form `:` or `::`\n *\n * Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "DynamicDataReference" - }, - { - "kind": "Content", - "text": " " + "text": "export default class DynamicDataReference " } ], "releaseTag": "Public", @@ -37,20 +30,12 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `DynamicDataReference` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "reference" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(reference: " }, { "kind": "Content", @@ -62,33 +47,25 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Property", - "canonicalReference": "(property:instance)", + "canonicalReference": "@microsoft/sp-dynamic-data!DynamicDataReference#property:member", "docComment": "/**\n * Returns the referred property of the Dynamic Data.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "property" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly property: " }, { "kind": "Content", @@ -102,27 +79,19 @@ "releaseTag": "Public", "name": "property", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(propertyPath:instance)", + "canonicalReference": "@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member", "docComment": "/**\n * Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "propertyPath" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly propertyPath: " }, { "kind": "Content", @@ -136,27 +105,19 @@ "releaseTag": "Public", "name": "propertyPath", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(reference:instance)", + "canonicalReference": "@microsoft/sp-dynamic-data!DynamicDataReference#reference:member", "docComment": "/**\n * Returns the full reference of the Dynamic Data object as a string.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "reference" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly reference: " }, { "kind": "Content", @@ -170,27 +131,19 @@ "releaseTag": "Public", "name": "reference", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(sourceId:instance)", + "canonicalReference": "@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member", "docComment": "/**\n * Returns the referred id of the Dynamic Data Source.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "sourceId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly sourceId: " }, { "kind": "Content", @@ -204,8 +157,8 @@ "releaseTag": "Public", "name": "sourceId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -214,20 +167,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataAnnotatedPropertyValue:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface", "docComment": "/**\n * Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataAnnotatedPropertyValue" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataAnnotatedPropertyValue " } ], "releaseTag": "Public", @@ -235,20 +180,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "metadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member", "docComment": "/**\n * Metadata describing the sample value of the property.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "metadata" - }, { "kind": "Content", - "text": "?: " + "text": "metadata?: " }, { "kind": "Reference", - "text": "IDynamicDataPropertyValueMetadataCollection" + "text": "IDynamicDataPropertyValueMetadataCollection", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface" }, { "kind": "Content", @@ -258,22 +200,18 @@ "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "sampleValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member", "docComment": "/**\n * Sample value of a property\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "sampleValue" - }, { "kind": "Content", - "text": ": " + "text": "sampleValue: " }, { "kind": "Content", @@ -287,8 +225,8 @@ "releaseTag": "Public", "name": "sampleValue", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -296,20 +234,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataCallables:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables:interface", "docComment": "/**\n * Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataCallables" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataCallables " } ], "releaseTag": "Public", @@ -317,20 +247,17 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(allowedEvents:0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)", "docComment": "/**\n * Returns list of allowed events on the dynamic data source.\n *\n * When this function returns a non-empty result, then source must define 'sendEvent' api.\n *\n * If this api is not defined or returns an empty array, then no consumer will be able to talk to this source.\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "allowedEvents" - }, { "kind": "Content", - "text": "?(): " + "text": "allowedEvents?(): " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -338,7 +265,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataEventDefinition" + "text": "IDynamicDataEventDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface" }, { "kind": "Content", @@ -350,34 +278,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "allowedEvents" }, { "kind": "MethodSignature", - "canonicalReference": "(getAnnotatedPropertyValue:0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)", "docComment": "/**\n * Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined.\n *\n * @param propertyId - One of the property ids exposed from the dynamic data source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getAnnotatedPropertyValue" - }, - { - "kind": "Content", - "text": "?(" - }, - { - "kind": "Reference", - "text": "propertyId" - }, { "kind": "Content", - "text": ": " + "text": "getAnnotatedPropertyValue?(propertyId: " }, { "kind": "Content", @@ -389,7 +305,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataAnnotatedPropertyValue" + "text": "IDynamicDataAnnotatedPropertyValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" }, { "kind": "Content", @@ -401,17 +318,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -419,20 +336,17 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(getPropertyDefinitions:0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)", "docComment": "/**\n * Returns all the property definitions that the DataSource will provide.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getPropertyDefinitions" - }, { "kind": "Content", - "text": "(): " + "text": "getPropertyDefinitions(): " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -440,7 +354,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataPropertyDefinition" + "text": "IDynamicDataPropertyDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" }, { "kind": "Content", @@ -452,34 +367,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getPropertyDefinitions" }, { "kind": "MethodSignature", - "canonicalReference": "(getPropertyValue:0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)", "docComment": "/**\n * Given a property id, returns the value of the property.\n *\n * @remarks\n *\n * It is assumed that when this function returns an array, it is homogeneous.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getPropertyValue" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "propertyId" - }, { "kind": "Content", - "text": ": " + "text": "getPropertyValue(propertyId: " }, { "kind": "Content", @@ -499,17 +402,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -517,24 +420,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(sendEvent:0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)", "docComment": "/**\n * If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly.\n *\n * Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source.\n *\n * @param eventName - A case-sensitive string representing the name of the event.\n *\n * @param data - Data to be sent to the dynamic data source.\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "sendEvent" - }, { "kind": "Content", - "text": "?(" - }, - { - "kind": "Reference", - "text": "eventName" - }, - { - "kind": "Content", - "text": ": " + "text": "sendEvent?(eventName: " }, { "kind": "Content", @@ -542,15 +433,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "data" - }, - { - "kind": "Content", - "text": ": " + "text": ", data: " }, { "kind": "Content", @@ -570,24 +453,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "eventName", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "data", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -598,20 +481,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataEventDefinition:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface", "docComment": "/**\n * Definition of an event which a dynamic data source accepts.\n *\n * It includes the name of the event and description to be seen and used by end users.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataEventDefinition" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataEventDefinition " } ], "releaseTag": "Beta", @@ -619,16 +494,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "description", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member", "docComment": "/**\n * User-friendly, localized description of the event.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "description" - }, { "kind": "Content", - "text": "?: " + "text": "description?: " }, { "kind": "Content", @@ -642,22 +513,18 @@ "releaseTag": "Beta", "name": "description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "name", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member", "docComment": "/**\n * Event name\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "name" - }, { "kind": "Content", - "text": ": " + "text": "name: " }, { "kind": "Content", @@ -671,8 +538,8 @@ "releaseTag": "Beta", "name": "name", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -680,24 +547,17 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataPropertyDefinition:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface", "docComment": "/**\n * Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataPropertyDefinition" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IDynamicDataPropertyDefinition extends " }, { "kind": "Reference", - "text": "IDynamicDataPropertyMetadata" + "text": "IDynamicDataPropertyMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface" }, { "kind": "Content", @@ -709,16 +569,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "id", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member", "docComment": "/**\n * Id of the property. This can only contains letters, numbers, dashes and underscores. Example: \"myFiles\" or \"time_in_24-hour_clock\"\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "id" - }, { "kind": "Content", - "text": ": " + "text": "id: " }, { "kind": "Content", @@ -732,34 +588,26 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataPropertyMetadata:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface", "docComment": "/**\n * Metadata of a property\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataPropertyMetadata" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataPropertyMetadata " } ], "releaseTag": "Public", @@ -767,16 +615,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "description", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member", "docComment": "/**\n * User-friendly, localized description of the property. Example: \"Contains a list of ids with the files of the current user\"\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "description" - }, { "kind": "Content", - "text": "?: " + "text": "description?: " }, { "kind": "Content", @@ -790,22 +634,18 @@ "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "title", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member", "docComment": "/**\n * User-friendly, localized title of the property. Example: \"My files\" / \"Mis archivos\" (depending of current language)\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "title" - }, { "kind": "Content", - "text": ": " + "text": "title: " }, { "kind": "Content", @@ -819,8 +659,8 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -828,24 +668,17 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataPropertyValueMetadata:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface", "docComment": "/**\n * Metadata describing the sample value of the property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataPropertyValueMetadata" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IDynamicDataPropertyValueMetadata extends " }, { "kind": "Reference", - "text": "IDynamicDataPropertyMetadata" + "text": "IDynamicDataPropertyMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface" }, { "kind": "Content", @@ -857,20 +690,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "metadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member", "docComment": "/**\n * Metadata describing the sample value of the property.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "metadata" - }, { "kind": "Content", - "text": "?: " + "text": "metadata?: " }, { "kind": "Reference", - "text": "IDynamicDataPropertyValueMetadataCollection" + "text": "IDynamicDataPropertyValueMetadataCollection", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface" }, { "kind": "Content", @@ -880,34 +710,26 @@ "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataPropertyValueMetadataCollection:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface", "docComment": "/**\n * A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value.\n *\n * @remarks\n *\n * Important note:\n *\n * 1. Key in the metadata should match the key in the sample value object.\n *\n * 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example for more details.\n *\n * For example:\n * ```\n * case 1: With simple values\n * Sample Property Id value - {\n * firstName: 'Bob',\n * lastName: 'Smith',\n * age: 30\n * }\n *\n * MetadataCollection for the above object would be -\n * metadataCollection: {\n * 'firstName': { title: 'First Name' },\n * 'lastName': { title: 'Last Name' },\n * 'age': { title: 'Age' }\n * }\n *\n * Case 2: With complex values\n * Sample Property Id value - {\n * person: {\n * firstName: 'Bob',\n * lastName: 'Smith',\n * age: 30\n * },\n * visitedLocations: [\n * {\n * city: 'Redmond',\n * state: 'WA'\n * },\n * {\n * city: 'New York City',\n * state: 'NY'\n * }\n * ]\n * }\n *\n * MetadataCollection for the above object would be -\n * metadataCollection: {\n * 'person': {\n * title: 'Person',\n * metadataCollection: {\n * 'firstName': { title: 'First Name' },\n * 'lastName': { title: 'Last Name' },\n * 'age': { title: 'Age' }\n * }\n * },\n * 'vistedLocations': {\n * title: 'Visted Locations',\n * metadataCollection: {\n * 'city': { title: 'City' },\n * 'state': { title: 'State' }\n * }\n * }\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataPropertyValueMetadataCollection" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataPropertyValueMetadataCollection " } ], "releaseTag": "Public", @@ -915,20 +737,12 @@ "members": [ { "kind": "IndexSignature", - "canonicalReference": "(:index,0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:index(1)", "docComment": "/**\n * Key-Value pair where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "[" - }, - { - "kind": "Reference", - "text": "key" - }, - { - "kind": "Content", - "text": ": " + "text": "[key: " }, { "kind": "Content", @@ -940,7 +754,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataPropertyValueMetadata" + "text": "IDynamicDataPropertyValueMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface" }, { "kind": "Content", @@ -948,17 +763,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] @@ -968,20 +783,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataSource:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface", "docComment": "/**\n * Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataSource" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataSource " } ], "releaseTag": "Public", @@ -989,20 +796,26 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(allowedEvents:0)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)", "docComment": "/**\n * Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source must define 'sendData' api.\n *\n * If this api is not defined or returns an empty map, then no consumer will be able to talk to this source.\n *\n * @beta\n */\n", "excerptTokens": [ + { + "kind": "Content", + "text": "allowedEventsAsync?(): " + }, { "kind": "Reference", - "text": "allowedEvents" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", - "text": "?(): " + "text": "<" }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1010,11 +823,12 @@ }, { "kind": "Reference", - "text": "IDynamicDataEventDefinition" + "text": "IDynamicDataEventDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface" }, { "kind": "Content", - "text": ">" + "text": ">>" }, { "kind": "Content", @@ -1022,34 +836,66 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 7 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], - "name": "allowedEvents" + "name": "allowedEventsAsync" }, { "kind": "MethodSignature", - "canonicalReference": "(getAnnotatedPropertyValue:0)", - "docComment": "/**\n * Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined.\n *\n * @param propertyId - One of the property ids exposed from the dynamic data source.\n */\n", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)", + "docComment": "/**\n * Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined.\n *\n * @deprecated\n *\n * - This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`\n *\n * @param propertyId - One of the property ids exposed from the dynamic data source.\n */\n", "excerptTokens": [ { - "kind": "Reference", - "text": "getAnnotatedPropertyValue" + "kind": "Content", + "text": "getAnnotatedPropertyValue(propertyId: " }, { "kind": "Content", - "text": "(" + "text": "string" + }, + { + "kind": "Content", + "text": "): " }, { "kind": "Reference", - "text": "propertyId" + "text": "IDynamicDataAnnotatedPropertyValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" }, { "kind": "Content", - "text": ": " + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAnnotatedPropertyValue" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)", + "docComment": "/**\n * Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined.\n *\n * @param propertyId - Property id for which the value is requested.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAnnotatedPropertyValueAsync(propertyId: " }, { "kind": "Content", @@ -1061,7 +907,21 @@ }, { "kind": "Reference", - "text": "IDynamicDataAnnotatedPropertyValue" + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" + }, + { + "kind": "Content", + "text": ">" }, { "kind": "Content", @@ -1069,38 +929,35 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, + "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], - "name": "getAnnotatedPropertyValue" + "name": "getAnnotatedPropertyValueAsync" }, { "kind": "MethodSignature", - "canonicalReference": "(getPropertyDefinitions:0)", - "docComment": "/**\n * Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component.\n */\n", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)", + "docComment": "/**\n * Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component.\n *\n * @deprecated\n *\n * - This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getPropertyDefinitions" - }, { "kind": "Content", - "text": "(): " + "text": "getPropertyDefinitions(): " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1108,7 +965,8 @@ }, { "kind": "Reference", - "text": "IDynamicDataPropertyDefinition" + "text": "IDynamicDataPropertyDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" }, { "kind": "Content", @@ -1120,34 +978,72 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getPropertyDefinitions" }, { "kind": "MethodSignature", - "canonicalReference": "(getPropertyValue:0)", - "docComment": "/**\n * Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component.\n */\n", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)", + "docComment": "/**\n * Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component.\n */\n", "excerptTokens": [ + { + "kind": "Content", + "text": "getPropertyDefinitionsAsync(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, { "kind": "Reference", - "text": "getPropertyValue" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", - "text": "(" + "text": "<" }, { "kind": "Reference", - "text": "propertyId" + "text": "IDynamicDataPropertyDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" + }, + { + "kind": "Content", + "text": ">>" }, { "kind": "Content", - "text": ": " + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPropertyDefinitionsAsync" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)", + "docComment": "/**\n * Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component.\n *\n * @deprecated\n *\n * - This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`\n *\n * @param propertyId - Property id for which the value is requested.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPropertyValue(propertyId: " }, { "kind": "Content", @@ -1167,17 +1063,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1185,24 +1081,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(sendEvent:0)", - "docComment": "/**\n * If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly.\n *\n * Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source.\n *\n * @param eventName - A case-sensitive string representing the name of the event.\n *\n * @param data - Data to be sent to the dynamic data source.\n *\n * @beta\n */\n", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)", + "docComment": "/**\n * Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component.\n *\n * @param propertyId - Property id for which the value is requested.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "sendEvent" - }, - { - "kind": "Content", - "text": "?(" - }, - { - "kind": "Reference", - "text": "eventName" - }, { "kind": "Content", - "text": ": " + "text": "getPropertyValueAsync(propertyId: " }, { "kind": "Content", @@ -1210,27 +1094,16 @@ }, { "kind": "Content", - "text": ", " + "text": "): " }, { "kind": "Reference", - "text": "data" - }, - { - "kind": "Content", - "text": ": " + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" + "text": "" }, { "kind": "Content", @@ -1238,41 +1111,30 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 3, + "endIndex": 5 }, - "releaseTag": "Beta", - "overloadIndex": 0, + "releaseTag": "Public", + "overloadIndex": 1, "parameters": [ { - "parameterName": "eventName", - "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - } - }, - { - "parameterName": "data", + "parameterName": "propertyId", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 1, + "endIndex": 2 } } ], - "name": "sendEvent" + "name": "getPropertyValueAsync" }, { "kind": "PropertySignature", - "canonicalReference": "id", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#id:member", "docComment": "/**\n * Id of the Dynamic Data Source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "id" - }, { "kind": "Content", - "text": ": " + "text": "id: " }, { "kind": "Content", @@ -1286,26 +1148,23 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "metadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member", "docComment": "/**\n * Metadata of the Dynamic Data Source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "metadata" - }, { "kind": "Content", - "text": ": " + "text": "metadata: " }, { "kind": "Reference", - "text": "IDynamicDataSourceMetadata" + "text": "IDynamicDataSourceMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface" }, { "kind": "Content", @@ -1315,29 +1174,79 @@ "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)", + "docComment": "/**\n * If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly.\n *\n * Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source.\n *\n * @param eventName - A case-sensitive string representing the name of the event.\n *\n * @param data - Data to be sent to the dynamic data source.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sendEvent?(eventName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", data: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "eventName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sendEvent" } ], "extendsTokenRanges": [] }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataSourceMetadata:interface)", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface", "docComment": "/**\n * Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataSourceMetadata" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDynamicDataSourceMetadata " } ], "releaseTag": "Public", @@ -1345,16 +1254,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "alias", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member", "docComment": "/**\n * Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "alias" - }, { "kind": "Content", - "text": "?: " + "text": "alias?: " }, { "kind": "Content", @@ -1368,22 +1273,18 @@ "releaseTag": "Public", "name": "alias", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "componentId", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member", "docComment": "/**\n * Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "componentId" - }, { "kind": "Content", - "text": "?: " + "text": "componentId?: " }, { "kind": "Content", @@ -1397,22 +1298,18 @@ "releaseTag": "Public", "name": "componentId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "description", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member", "docComment": "/**\n * User-friendly, localized description of the Dynamic Data Source.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "description" - }, { "kind": "Content", - "text": "?: " + "text": "description?: " }, { "kind": "Content", @@ -1426,22 +1323,18 @@ "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "instanceId", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member", "docComment": "/**\n * Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "instanceId" - }, { "kind": "Content", - "text": "?: " + "text": "instanceId?: " }, { "kind": "Content", @@ -1455,22 +1348,18 @@ "releaseTag": "Public", "name": "instanceId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "title", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member", "docComment": "/**\n * User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "title" - }, { "kind": "Content", - "text": ": " + "text": "title: " }, { "kind": "Content", @@ -1484,8 +1373,8 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], diff --git a/generate-docs/json/sp-extension-base.api.json b/generate-docs/json/sp-extension-base.api.json index 3c2c9b9b..cd1aa9e1 100644 --- a/generate-docs/json/sp-extension-base.api.json +++ b/generate-docs/json/sp-extension-base.api.json @@ -1,47 +1,33 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-extension-base", + "canonicalReference": "@microsoft/sp-extension-base!", "docComment": "/**\n * SharePoint Framework support for building client-side extensions.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-extension-base", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-extension-base!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(BaseExtension:class)", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class", "docComment": "/**\n * The base class for all client-side extensions.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseExtension` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " + "text": "export default abstract class BaseExtension extends " }, { "kind": "Reference", - "text": "BaseExtension" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> extends " - }, - { - "kind": "Reference", - "text": "BaseComponent" + "text": "BaseComponent", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent:class" }, { "kind": "Content", @@ -49,28 +35,34 @@ } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "BaseExtension", "members": [ { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension#context:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly context: " }, { "kind": "Reference", - "text": "ExtensionContext" + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!default:class" }, { "kind": "Content", @@ -80,31 +72,24 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(onInit:instance,0)", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension#onInit:member(1)", "docComment": "/**\n * This event method is called when the client-side extension is first activated on the page.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onInit" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onInit(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -117,33 +102,25 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onInit" }, { "kind": "Property", - "canonicalReference": "(properties:instance)", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension#properties:member", "docComment": "/**\n * Extension properties is a JavaScript object that are passed in by the application that initializes the extension.\n *\n * @remarks\n *\n * Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "properties" + "text": "protected readonly properties: " }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", "text": "TProperties" }, { @@ -154,38 +131,31 @@ "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 5, - "endIndex": 7 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(ExtensionContext:class)", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class", "docComment": "/**\n * The base class for context objects for client-side extensions.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtensionContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "ExtensionContext" - }, - { - "kind": "Content", - "text": " extends " + "text": "export default class ExtensionContext extends " }, { "kind": "Reference", - "text": "BaseComponentContext" + "text": "BaseComponentContext", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext:class" }, { "kind": "Content", @@ -196,8 +166,8 @@ "name": "ExtensionContext", "members": [], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] } diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index f93d1343..c1d74c0b 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-http", + "canonicalReference": "@microsoft/sp-http!", "docComment": "/**\n * Base communication layer for the SharePoint Framework\n *\n * @remarks\n *\n * This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that follow the recommended best practices.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-http", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-http!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(AadHttpClient:class)", + "canonicalReference": "@microsoft/sp-http!AadHttpClient:class", "docComment": "/**\n * AadHttpClient is used to perform REST calls against an Azure AD Application.\n *\n * @remarks\n *\n * For communicating with SharePoint, use the {@link SPHttpClient} class instead. For communicating with Microsoft Graph, use the {@link MSGraphClient} class.\n *\n * @public @sealed\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "AadHttpClient" - }, - { - "kind": "Content", - "text": " " + "text": "export default class AadHttpClient " } ], "releaseTag": "Public", @@ -37,36 +30,21 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `AadHttpClient` class\n *\n * @param serviceScope - The service scope is needed to retrieve some of the class's internal components.\n *\n * @param resourceUrl - The resource for which the token should be obtained.\n *\n * @param options - Configuration options for the request to get an access token.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "resourceEndpoint" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", - "text": ": " + "text": ", resourceEndpoint: " }, { "kind": "Content", @@ -74,19 +52,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "IAadHttpClientOptions" + "text": "IAadHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions:interface" }, { "kind": "Content", @@ -94,51 +65,44 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "resourceEndpoint", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 } } ] }, { "kind": "Property", - "canonicalReference": "(configurations:static)", + "canonicalReference": "@microsoft/sp-http!AadHttpClient.configurations:member", "docComment": "/**\n * The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "configurations" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly configurations: " }, { "kind": "Reference", - "text": "IAadHttpClientConfigurations" + "text": "IAadHttpClientConfigurations", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfigurations:interface" }, { "kind": "Content", @@ -148,31 +112,19 @@ "releaseTag": "Public", "name": "configurations", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Method", - "canonicalReference": "(fetch:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClient#fetch:member(1)", "docComment": "/**\n * Performs a REST service call.\n *\n * @remarks\n *\n * Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * @param url - The endpoint URL that fetch will be called on.\n *\n * @param configuration - Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations.\n *\n * @param options - Additional options that affect the request.\n *\n * @returns A promise that will return the result.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fetch" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "fetch(url: " }, { "kind": "Content", @@ -180,35 +132,21 @@ }, { "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "configuration" + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options: " }, { "kind": "Reference", - "text": "AadHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -216,7 +154,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -224,7 +163,8 @@ }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -237,31 +177,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -269,24 +209,12 @@ }, { "kind": "Method", - "canonicalReference": "(get:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClient#get:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to \"GET\".\n *\n * @param url - The endpoint URL that fetch will be called on.\n *\n * @param configuration - Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations.\n *\n * @param options - Additional options that affect the request.\n *\n * @returns A promise that will return the result.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "get" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "get(url: " }, { "kind": "Content", @@ -294,35 +222,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "AadHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -330,7 +244,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -338,7 +253,8 @@ }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -351,31 +267,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -383,24 +299,12 @@ }, { "kind": "Method", - "canonicalReference": "(post:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClient#post:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to \"POST\".\n *\n * @param url - The endpoint URL that fetch will be called on.\n *\n * @param configuration - Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations.\n *\n * @param options - Additional options that affect the request.\n *\n * @returns A promise that will return the result.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "post" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "post(url: " }, { "kind": "Content", @@ -408,35 +312,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "AadHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options: " }, { "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -444,7 +334,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -452,7 +343,8 @@ }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -465,31 +357,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -500,24 +392,17 @@ }, { "kind": "Class", - "canonicalReference": "(AadHttpClientConfiguration:class)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientConfiguration:class", "docComment": "/**\n * Configuration for HttpClient.\n *\n * @remarks\n *\n * The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class AadHttpClientConfiguration extends " }, { "kind": "Reference", - "text": "AadHttpClientConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "HttpClientConfiguration" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -529,7 +414,8 @@ }, { "kind": "Reference", - "text": "IAadHttpClientConfiguration" + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" }, { "kind": "Content", @@ -541,40 +427,26 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)", "docComment": "/**\n * Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IAadHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(flags: " }, { "kind": "Reference", - "text": "overrideFlags" + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" }, { "kind": "Content", - "text": "?: " + "text": ", overrideFlags?: " }, { "kind": "Reference", - "text": "IAadHttpClientConfiguration" + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" }, { "kind": "Content", @@ -582,44 +454,37 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "flags", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "overrideFlags", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(flags:instance)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientConfiguration#flags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " + "text": "protected flags: " }, { "kind": "Reference", - "text": "IAadHttpClientConfiguration" + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" }, { "kind": "Content", @@ -629,35 +494,24 @@ "releaseTag": "Public", "name": "flags", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(overrideWith:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "overrideWith" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceFlags" - }, { "kind": "Content", - "text": ": " + "text": "overrideWith(sourceFlags: " }, { "kind": "Reference", - "text": "IAadHttpClientConfiguration" + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" }, { "kind": "Content", @@ -665,7 +519,8 @@ }, { "kind": "Reference", - "text": "AadHttpClientConfiguration" + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -674,17 +529,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceFlags", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -692,32 +547,24 @@ } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [ { - "startIndex": 6, - "endIndex": 8 + "startIndex": 4, + "endIndex": 6 } ] }, { "kind": "Class", - "canonicalReference": "(AadHttpClientFactory:class)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientFactory:class", "docComment": "/**\n * Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient}\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadHttpClientFactory` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "AadHttpClientFactory" - }, - { - "kind": "Content", - "text": " " + "text": "export default class AadHttpClientFactory " } ], "releaseTag": "Public", @@ -725,24 +572,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(getClient:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)", "docComment": "/**\n * Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal.\n *\n * @param resourceEndpoint - The target AAD application's resource endpoint.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getClient" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "resourceEndpoint" - }, { "kind": "Content", - "text": ": " + "text": "getClient(resourceEndpoint: " }, { "kind": "Content", @@ -754,7 +589,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -762,7 +598,8 @@ }, { "kind": "Reference", - "text": "AadHttpClient" + "text": "AadHttpClient", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -775,17 +612,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 + "startIndex": 3, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "resourceEndpoint", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -793,24 +630,17 @@ }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-http!AadHttpClientFactory.serviceKey:member", "docComment": "/**\n * The service key for AadHttpClientFactory.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -818,7 +648,8 @@ }, { "kind": "Reference", - "text": "AadHttpClientFactory" + "text": "AadHttpClientFactory", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -832,8 +663,8 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } @@ -842,24 +673,17 @@ }, { "kind": "Class", - "canonicalReference": "(AadTokenProvider:class)", + "canonicalReference": "@microsoft/sp-http!AadTokenProvider:class", "docComment": "/**\n * This class allows a developer to obtain OAuth2 tokens from Azure AD.\n *\n * OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadTokenProvider` class.\n *\n * @public @sealed\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "AadTokenProvider" - }, - { - "kind": "Content", - "text": " implements " + "text": "export default class AadTokenProvider implements " }, { "kind": "Reference", - "text": "IAadTokenProvider" + "text": "IAadTokenProvider", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider:interface" }, { "kind": "Content", @@ -871,24 +695,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(getToken:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadTokenProvider#getToken:member(1)", "docComment": "/**\n * Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource.\n *\n * The OAuth2 token should not be cached by the caller since it is already cached by the method itself.\n *\n * @param resourceEndpoint - the resource for which the token should be obtained\n *\n * @param useCachedToken - Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would be https://graph.microsoft.com\n *\n * @returns A promise that will be fullfiled with the token or that will reject with an error message\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getToken" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "resourceEndpoint" - }, { "kind": "Content", - "text": ": " + "text": "getToken(resourceEndpoint: " }, { "kind": "Content", @@ -896,15 +708,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "useCachedToken" - }, - { - "kind": "Content", - "text": "?: " + "text": ", useCachedToken?: " }, { "kind": "Content", @@ -916,7 +720,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -929,24 +734,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "resourceEndpoint", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "useCachedToken", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -954,24 +759,17 @@ }, { "kind": "Property", - "canonicalReference": "(tokenAcquisitionEvent:instance)", + "canonicalReference": "@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member", "docComment": "/**\n * Notifies the developer when Token Acquisition requires user action.\n *\n * @eventproperty\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "tokenAcquisitionEvent" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly tokenAcquisitionEvent: " }, { "kind": "Reference", - "text": "SPEvent" + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" }, { "kind": "Content", @@ -979,7 +777,8 @@ }, { "kind": "Reference", - "text": "TokenAcquisitionEventArgs" + "text": "TokenAcquisitionEventArgs", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs:class" }, { "kind": "Content", @@ -993,35 +792,27 @@ "releaseTag": "Public", "name": "tokenAcquisitionEvent", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(AadTokenProviderFactory:class)", + "canonicalReference": "@microsoft/sp-http!AadTokenProviderFactory:class", "docComment": "/**\n * Returns a preinitialized version of the AadTokenProviderFactory.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "AadTokenProviderFactory" - }, - { - "kind": "Content", - "text": " " + "text": "export default class AadTokenProviderFactory " } ], "releaseTag": "Public", @@ -1029,20 +820,17 @@ "members": [ { "kind": "Method", - "canonicalReference": "(getTokenProvider:instance,0)", + "canonicalReference": "@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)", "docComment": "/**\n * Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getTokenProvider" - }, { "kind": "Content", - "text": "(): " + "text": "getTokenProvider(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1050,7 +838,8 @@ }, { "kind": "Reference", - "text": "AadTokenProvider" + "text": "AadTokenProvider", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -1063,34 +852,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getTokenProvider" }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member", "docComment": "/**\n * The service key for AadTokenProviderFactory.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -1098,7 +880,8 @@ }, { "kind": "Reference", - "text": "AadTokenProviderFactory" + "text": "AadTokenProviderFactory", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -1112,8 +895,8 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } @@ -1122,24 +905,17 @@ }, { "kind": "Class", - "canonicalReference": "(DigestCache:class)", + "canonicalReference": "@microsoft/sp-http!DigestCache:class", "docComment": "/**\n * IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time.\n *\n * For more information, see the MSDN article {@link https://msdn.microsoft.com/en-us/library/office/jj164022.aspx | \"Complete basic operations using SharePoint 2013 REST endpoints\"}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "DigestCache" - }, - { - "kind": "Content", - "text": " implements " + "text": "export default class DigestCache implements " }, { "kind": "Reference", - "text": "IDigestCache" + "text": "IDigestCache", + "canonicalReference": "@microsoft/sp-http!IDigestCache:interface" }, { "kind": "Content", @@ -1151,24 +927,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!DigestCache:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `DigestCache` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", @@ -1176,37 +945,25 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(addDigestToCache:instance,0)", + "canonicalReference": "@microsoft/sp-http!DigestCache#addDigestToCache:member(1)", "docComment": "/**\n * Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @param digestValue - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"\n *\n * @param expirationTimestamp - A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "addDigestToCache" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": ": " + "text": "addDigestToCache(webUrl: " }, { "kind": "Content", @@ -1214,15 +971,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "digestValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", digestValue: " }, { "kind": "Content", @@ -1230,15 +979,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "expirationTimestamp" - }, - { - "kind": "Content", - "text": ": " + "text": ", expirationTimestamp: " }, { "kind": "Content", @@ -1259,31 +1000,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "webUrl", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "digestValue", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "expirationTimestamp", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1291,16 +1032,12 @@ }, { "kind": "Method", - "canonicalReference": "(clearAllDigests:instance,0)", + "canonicalReference": "@microsoft/sp-http!DigestCache#clearAllDigests:member(1)", "docComment": "/**\n * Clears all values from the cache.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clearAllDigests" - }, { "kind": "Content", - "text": "(): " + "text": "clearAllDigests(): " }, { "kind": "Content", @@ -1313,34 +1050,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "clearAllDigests" }, { "kind": "Method", - "canonicalReference": "(clearDigest:instance,0)", + "canonicalReference": "@microsoft/sp-http!DigestCache#clearDigest:member(1)", "docComment": "/**\n * Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time.\n *\n * @param webUrl - The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL.\n *\n * @returns Returns true if a cache entry was found and deleted; false otherwise.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clearDigest" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": ": " + "text": "clearDigest(webUrl: " }, { "kind": "Content", @@ -1361,17 +1086,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "webUrl", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1379,24 +1104,12 @@ }, { "kind": "Method", - "canonicalReference": "(fetchDigest:instance,0)", + "canonicalReference": "@microsoft/sp-http!DigestCache#fetchDigest:member(1)", "docComment": "/**\n * Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @returns A promise that is fulfilled with the digest value.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fetchDigest" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": ": " + "text": "fetchDigest(webUrl: " }, { "kind": "Content", @@ -1408,7 +1121,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1421,17 +1135,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "webUrl", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1439,24 +1153,17 @@ }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-http!DigestCache.serviceKey:member", "docComment": "/**\n * The service key for IDigestCache.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -1464,7 +1171,8 @@ }, { "kind": "Reference", - "text": "IDigestCache" + "text": "IDigestCache", + "canonicalReference": "@microsoft/sp-http!IDigestCache:interface" }, { "kind": "Content", @@ -1478,35 +1186,27 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(GraphRequest:interface)", + "canonicalReference": "@microsoft/sp-http!GraphRequest:interface", "docComment": "/**\n * Typings for the GraphRequest Object For more information: {@link https://github.com/microsoftgraph/msgraph-sdk-javascript}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IGraphRequest" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IGraphRequest " } ], "releaseTag": "Public", @@ -1514,28 +1214,16 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "_headers", + "canonicalReference": "@microsoft/sp-http!GraphRequest#_headers:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "_headers" - }, - { - "kind": "Content", - "text": ": " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "_headers: " }, { "kind": "Content", - "text": ": string]: string | number;\n }" + "text": "{\n [key: string]: string | number;\n }" }, { "kind": "Content", @@ -1545,22 +1233,18 @@ "releaseTag": "Public", "name": "_headers", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "_responseType", + "canonicalReference": "@microsoft/sp-http!GraphRequest#_responseType:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "_responseType" - }, { "kind": "Content", - "text": ": " + "text": "_responseType: " }, { "kind": "Content", @@ -1574,22 +1258,18 @@ "releaseTag": "Public", "name": "_responseType", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "MethodSignature", - "canonicalReference": "(buildFullUrl:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "buildFullUrl" - }, { "kind": "Content", - "text": "(): " + "text": "buildFullUrl(): " }, { "kind": "Content", @@ -1601,50 +1281,57 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "buildFullUrl" }, { - "kind": "MethodSignature", - "canonicalReference": "(constructor:0)", + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#config:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "constructor" - }, { "kind": "Content", - "text": "(" + "text": "config: " }, { "kind": "Reference", - "text": "config" + "text": "Options", + "canonicalReference": "@microsoft/microsoft-graph-client!Options:interface" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Options" - }, + "text": ";" + } + ], + "releaseTag": "Public", + "name": "config", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#constructor:member(1)", + "docComment": "", + "excerptTokens": [ { "kind": "Content", - "text": ", " + "text": "constructor(config: " }, { "kind": "Reference", - "text": "path" + "text": "Options", + "canonicalReference": "@microsoft/microsoft-graph-client!Options:interface" }, { "kind": "Content", - "text": ": " + "text": ", path: " }, { "kind": "Content", @@ -1656,7 +1343,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -1664,24 +1352,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "path", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -1689,24 +1377,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(count:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#count:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "count" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "count" - }, { "kind": "Content", - "text": ": " + "text": "count(count: " }, { "kind": "Content", @@ -1718,7 +1394,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -1726,17 +1403,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "count", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1744,24 +1421,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(create:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#create:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "create" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "content" - }, { "kind": "Content", - "text": ": " + "text": "create(content: " }, { "kind": "Content", @@ -1769,19 +1434,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " + "text": ", callback?: " }, { "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -1789,7 +1447,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1801,24 +1460,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -1826,28 +1485,17 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(del:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#del:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "del" - }, { "kind": "Content", - "text": "(" + "text": "del(callback?: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -1855,7 +1503,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1867,17 +1516,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1885,28 +1534,17 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(delete:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#delete:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "delete" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, { "kind": "Content", - "text": "?: " + "text": "delete(callback?: " }, { "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -1914,7 +1552,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1926,17 +1565,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1944,24 +1583,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(expand:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#expand:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "expand" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": "expand(properties: " }, { "kind": "Content", @@ -1973,7 +1600,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -1981,17 +1609,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1999,24 +1627,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(filter:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#filter:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "filter" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "filterStr" - }, { "kind": "Content", - "text": ": " + "text": "filter(filterStr: " }, { "kind": "Content", @@ -2028,7 +1644,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -2036,17 +1653,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "filterStr", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2054,28 +1671,17 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(get:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#get:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "get" - }, { "kind": "Content", - "text": "(" + "text": "get(callback?: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -2083,7 +1689,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -2095,17 +1702,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2113,28 +1720,17 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(getStream:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#getStream:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "getStream" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "callback" - }, { "kind": "Content", - "text": ": " + "text": "getStream(callback: " }, { "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -2150,17 +1746,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2168,24 +1764,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(header:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#header:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "header" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "headerKey" - }, - { - "kind": "Content", - "text": ": " + "text": "header(headerKey: " }, { "kind": "Content", @@ -2193,15 +1777,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "headerValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", headerValue: " }, { "kind": "Content", @@ -2221,24 +1797,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "headerKey", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "headerValue", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2246,36 +1822,16 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(headers:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#headers:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "headers" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "headers" - }, - { - "kind": "Content", - "text": ": " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "headers(headers: " }, { "kind": "Content", - "text": ": string]: string | number;\n }" + "text": "{\n [key: string]: string | number;\n }" }, { "kind": "Content", @@ -2291,17 +1847,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 - }, + "startIndex": 3, + "endIndex": 4 + }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 7 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2309,24 +1865,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(orderby:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#orderby:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "orderby" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "properties" - }, { "kind": "Content", - "text": ": " + "text": "orderby(properties: " }, { "kind": "Content", @@ -2338,7 +1882,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -2346,17 +1891,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2364,24 +1909,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(parsePath:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#parsePath:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "parsePath" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "rawPath" - }, { "kind": "Content", - "text": ": " + "text": "parsePath(rawPath: " }, { "kind": "Content", @@ -2401,17 +1934,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "rawPath", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2419,24 +1952,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(patch:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#patch:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "patch" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "content" - }, - { - "kind": "Content", - "text": ": " + "text": "patch(content: " }, { "kind": "Content", @@ -2444,19 +1965,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", callback?: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -2464,7 +1978,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -2476,24 +1991,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2501,24 +2016,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(post:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#post:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "post" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "content" - }, { "kind": "Content", - "text": ": " + "text": "post(content: " }, { "kind": "Content", @@ -2526,19 +2029,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", callback?: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -2546,7 +2042,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -2558,24 +2055,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2583,24 +2080,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(put:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#put:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "put" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "content" - }, { "kind": "Content", - "text": ": " + "text": "put(content: " }, { "kind": "Content", @@ -2608,19 +2093,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", callback?: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -2628,7 +2106,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -2640,24 +2119,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2665,24 +2144,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(putStream:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#putStream:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "putStream" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "stream" - }, - { - "kind": "Content", - "text": ": " + "text": "putStream(stream: " }, { "kind": "Content", @@ -2690,19 +2157,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", callback: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -2718,24 +2178,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "stream", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -2743,36 +2203,16 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(query:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#query:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "query" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "queryDictionaryOrString" - }, - { - "kind": "Content", - "text": ": " - }, { "kind": "Content", - "text": "string | {\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "query(queryDictionaryOrString: " }, { "kind": "Content", - "text": ": string]: string | number;\n }" + "text": "string | {\n [key: string]: string | number;\n }" }, { "kind": "Content", @@ -2780,7 +2220,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -2788,17 +2229,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "queryDictionaryOrString", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 7 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2806,24 +2247,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(responseType:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#responseType:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "responseType" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "responseType" - }, - { - "kind": "Content", - "text": ": " + "text": "responseType(responseType: " }, { "kind": "Content", @@ -2835,7 +2264,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -2843,17 +2273,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "responseType", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2861,24 +2291,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(select:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#select:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "select" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "properties" - }, { "kind": "Content", - "text": ": " + "text": "select(properties: " }, { "kind": "Content", @@ -2890,7 +2308,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -2898,17 +2317,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2916,24 +2335,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(skip:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#skip:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "skip" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "n" - }, - { - "kind": "Content", - "text": ": " + "text": "skip(n: " }, { "kind": "Content", @@ -2945,7 +2352,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -2953,17 +2361,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2971,24 +2379,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(skipToken:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#skipToken:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "skipToken" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "token" - }, - { - "kind": "Content", - "text": ": " + "text": "skipToken(token: " }, { "kind": "Content", @@ -3000,7 +2396,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -3008,17 +2405,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "token", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3026,24 +2423,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(top:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#top:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "top" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "n" - }, - { - "kind": "Content", - "text": ": " + "text": "top(n: " }, { "kind": "Content", @@ -3055,7 +2440,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -3063,17 +2449,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3081,24 +2467,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(update:0)", + "canonicalReference": "@microsoft/sp-http!GraphRequest#update:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "update" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "content" - }, - { - "kind": "Content", - "text": ": " + "text": "update(content: " }, { "kind": "Content", @@ -3106,19 +2480,12 @@ }, { "kind": "Content", - "text": ", " + "text": ", callback?: " }, { "kind": "Reference", - "text": "callback" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "GraphRequestCallback" + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" }, { "kind": "Content", @@ -3126,7 +2493,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -3138,49 +2506,63 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "content", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "callback", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], "name": "update" }, { - "kind": "MethodSignature", - "canonicalReference": "(version:0)", + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#urlComponents:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "version" - }, { "kind": "Content", - "text": "(" + "text": "urlComponents: " }, { "kind": "Reference", - "text": "v" + "text": "URLComponents", + "canonicalReference": "@microsoft/microsoft-graph-client!URLComponents:interface" }, { "kind": "Content", - "text": ": " + "text": ";" + } + ], + "releaseTag": "Public", + "name": "urlComponents", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#version:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "version(v: " }, { "kind": "Content", @@ -3192,7 +2574,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -3200,99 +2583,33 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "v", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], "name": "version" - }, - { - "kind": "PropertySignature", - "canonicalReference": "config", - "docComment": "", - "excerptTokens": [ - { - "kind": "Reference", - "text": "config" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Options" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "config", - "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "urlComponents", - "docComment": "", - "excerptTokens": [ - { - "kind": "Reference", - "text": "urlComponents" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "URLComponents" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "urlComponents", - "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 - } } ], "extendsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(HttpClient:class)", + "canonicalReference": "@microsoft/sp-http!HttpClient:class", "docComment": "/**\n * HttpClient implements a basic set of features for performing REST operations against a generic service.\n *\n * @remarks\n *\n * For communicating with SharePoint, use the {@link SPHttpClient} class instead.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "HttpClient" - }, - { - "kind": "Content", - "text": " " + "text": "export default class HttpClient " } ], "releaseTag": "Public", @@ -3300,24 +2617,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!HttpClient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `HttpClient` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", @@ -3325,37 +2635,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Property", - "canonicalReference": "(configurations:static)", + "canonicalReference": "@microsoft/sp-http!HttpClient.configurations:member", "docComment": "/**\n * The standard predefined HttpClientConfiguration objects for use with the HttpClient class.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly configurations: " }, { "kind": "Reference", - "text": "configurations" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IHttpClientConfigurations" + "text": "IHttpClientConfigurations", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfigurations:interface" }, { "kind": "Content", @@ -3365,31 +2668,19 @@ "releaseTag": "Public", "name": "configurations", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Method", - "canonicalReference": "(fetch:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClient#fetch:member(1)", "docComment": "/**\n * Performs a REST service call.\n *\n * @remarks\n *\n * Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fetch" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "fetch(url: " }, { "kind": "Content", @@ -3397,35 +2688,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "HttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options: " }, { "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -3433,7 +2710,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -3441,7 +2719,8 @@ }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -3454,31 +2733,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3486,24 +2765,12 @@ }, { "kind": "Method", - "canonicalReference": "(get:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClient#get:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to \"GET\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "get" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "get(url: " }, { "kind": "Content", @@ -3511,35 +2778,21 @@ }, { "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "configuration" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options?: " }, { "kind": "Reference", - "text": "HttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": "?: " - }, - { - "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -3547,7 +2800,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -3555,7 +2809,8 @@ }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -3568,31 +2823,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3600,24 +2855,12 @@ }, { "kind": "Method", - "canonicalReference": "(post:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClient#post:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to \"POST\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "post" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "post(url: " }, { "kind": "Content", @@ -3625,35 +2868,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " + "text": ", configuration: " }, { "kind": "Reference", - "text": "HttpClientConfiguration" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ", " + "text": ", options: " }, { "kind": "Reference", - "text": "options" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -3661,7 +2890,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -3669,7 +2899,8 @@ }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -3682,31 +2913,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -3714,24 +2945,17 @@ }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-http!HttpClient.serviceKey:member", "docComment": "/**\n * The service key for HttpClient.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -3739,7 +2963,8 @@ }, { "kind": "Reference", - "text": "HttpClient" + "text": "HttpClient", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -3753,8 +2978,8 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } @@ -3763,24 +2988,17 @@ }, { "kind": "Class", - "canonicalReference": "(HttpClientConfiguration:class)", + "canonicalReference": "@microsoft/sp-http!HttpClientConfiguration:class", "docComment": "/**\n * Configuration for HttpClient.\n *\n * @remarks\n *\n * The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class HttpClientConfiguration implements " }, { "kind": "Reference", - "text": "HttpClientConfiguration" - }, - { - "kind": "Content", - "text": " implements " - }, - { - "kind": "Reference", - "text": "IHttpClientConfiguration" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", @@ -3792,40 +3010,26 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientConfiguration:constructor(1)", "docComment": "/**\n * Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(flags: " }, { "kind": "Reference", - "text": "overrideFlags" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", - "text": "?: " + "text": ", overrideFlags?: " }, { "kind": "Reference", - "text": "IHttpClientConfiguration" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", @@ -3833,44 +3037,37 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "flags", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "overrideFlags", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(flags:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientConfiguration#flags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "protected " + "text": "protected flags: " }, { "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IHttpClientConfiguration" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", @@ -3880,27 +3077,19 @@ "releaseTag": "Public", "name": "flags", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(initializeFlags:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)", "docComment": "/**\n * Child classes should override this method to initialize the flags object.\n *\n * @virtual\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "initializeFlags" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected initializeFlags(): " }, { "kind": "Content", @@ -3913,38 +3102,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "initializeFlags" }, { "kind": "Method", - "canonicalReference": "(overrideWith:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)", "docComment": "/**\n * Child classes should override this method to construct the child class type, rather than the base class type.\n *\n * @virtual\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "overrideWith" - }, { "kind": "Content", - "text": "(" + "text": "overrideWith(sourceFlags: " }, { "kind": "Reference", - "text": "sourceFlags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IHttpClientConfiguration" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", @@ -3952,7 +3130,8 @@ }, { "kind": "Reference", - "text": "HttpClientConfiguration" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -3961,17 +3140,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceFlags", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3980,31 +3159,24 @@ ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(HttpClientResponse:class)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse:class", "docComment": "/**\n * The Response subclass returned by methods such as HttpClient.fetch().\n *\n * @remarks\n *\n * This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HttpClientResponse` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class HttpClientResponse implements " }, { "kind": "Reference", - "text": "HttpClientResponse" - }, - { - "kind": "Content", - "text": " implements " - }, - { - "kind": "Reference", - "text": "Response" + "text": "Response", + "canonicalReference": "!Response:interface" }, { "kind": "Content", @@ -4012,7 +3184,8 @@ }, { "kind": "Reference", - "text": "Body" + "text": "Body", + "canonicalReference": "!Body:interface" }, { "kind": "Content", @@ -4024,20 +3197,17 @@ "members": [ { "kind": "Method", - "canonicalReference": "(arrayBuffer:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "arrayBuffer" - }, { "kind": "Content", - "text": "(): " + "text": "arrayBuffer(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -4045,7 +3215,8 @@ }, { "kind": "Reference", - "text": "ArrayBuffer" + "text": "ArrayBuffer", + "canonicalReference": "!ArrayBuffer:interface" }, { "kind": "Content", @@ -4058,30 +3229,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "arrayBuffer" }, { "kind": "Method", - "canonicalReference": "(blob:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#blob:member(1)", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "blob" - }, { "kind": "Content", - "text": "(): " + "text": "blob(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -4089,7 +3257,8 @@ }, { "kind": "Reference", - "text": "Blob" + "text": "Blob", + "canonicalReference": "!Blob:interface" }, { "kind": "Content", @@ -4102,30 +3271,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "blob" }, { "kind": "Property", - "canonicalReference": "(bodyUsed:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#bodyUsed:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "bodyUsed" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly bodyUsed: " }, { "kind": "Content", @@ -4139,27 +3300,24 @@ "releaseTag": "Public", "name": "bodyUsed", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(clone:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#clone:member(1)", "docComment": "/**\n * @virtual\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clone" - }, { "kind": "Content", - "text": "(): " + "text": "clone(): " }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -4168,30 +3326,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "clone" }, { "kind": "Method", - "canonicalReference": "(formData:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#formData:member(1)", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "formData" - }, { "kind": "Content", - "text": "(): " + "text": "formData(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -4199,7 +3354,8 @@ }, { "kind": "Reference", - "text": "FormData" + "text": "FormData", + "canonicalReference": "!FormData:interface" }, { "kind": "Content", @@ -4212,34 +3368,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "formData" }, { "kind": "Property", - "canonicalReference": "(headers:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#headers:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly headers: " }, { "kind": "Reference", - "text": "headers" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Headers" + "text": "Headers", + "canonicalReference": "!Headers:interface" }, { "kind": "Content", @@ -4249,27 +3398,24 @@ "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(json:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#json:member(1)", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "json" - }, { "kind": "Content", - "text": "(): " + "text": "json(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -4282,34 +3428,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "json" }, - { - "kind": "Property", - "canonicalReference": "(nativeResponse:instance)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "nativeResponse" - }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#nativeResponse:member", + "docComment": "", + "excerptTokens": [ { "kind": "Content", - "text": ": " + "text": "protected nativeResponse: " }, { "kind": "Reference", - "text": "Response" + "text": "Response", + "canonicalReference": "!Response:interface" }, { "kind": "Content", @@ -4319,27 +3458,19 @@ "releaseTag": "Public", "name": "nativeResponse", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(ok:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#ok:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "ok" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly ok: " }, { "kind": "Content", @@ -4353,27 +3484,19 @@ "releaseTag": "Public", "name": "ok", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(status:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#status:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "status" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly status: " }, { "kind": "Content", @@ -4387,27 +3510,19 @@ "releaseTag": "Public", "name": "status", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(statusText:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#statusText:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "statusText" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly statusText: " }, { "kind": "Content", @@ -4421,27 +3536,24 @@ "releaseTag": "Public", "name": "statusText", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(text:instance,0)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#text:member(1)", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Body | Body} API\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "text" - }, { "kind": "Content", - "text": "(): " + "text": "text(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -4454,34 +3566,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "text" }, { "kind": "Property", - "canonicalReference": "(type:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#type:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "type" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly type: " }, { "kind": "Reference", - "text": "ResponseType" + "text": "ResponseType", + "canonicalReference": "!ResponseType:type" }, { "kind": "Content", @@ -4491,27 +3596,19 @@ "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(url:instance)", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#url:member", "docComment": "/**\n * See documentation for the browser's {@link https://developer.mozilla.org/en-US/docs/Web/API/Response | Response} API\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly url: " }, { "kind": "Content", @@ -4525,43 +3622,36 @@ "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "implementsTokenRanges": [ { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, { - "startIndex": 5, - "endIndex": 7 + "startIndex": 3, + "endIndex": 5 } ] }, { "kind": "Interface", - "canonicalReference": "(IAadHttpClientConfiguration:interface)", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface", "docComment": "/**\n * Flags interface for HttpClientConfiguration.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IAadHttpClientConfiguration" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IAadHttpClientConfiguration extends " }, { "kind": "Reference", - "text": "IHttpClientConfiguration" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", @@ -4573,27 +3663,19 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(IAadHttpClientConfigurations:interface)", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfigurations:interface", "docComment": "/**\n * Standard configurations for AadHttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IAadHttpClientConfigurations" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IAadHttpClientConfigurations " } ], "releaseTag": "Public", @@ -4601,24 +3683,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "v1", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfigurations#v1:member", "docComment": "/**\n * This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "v1" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly v1: " }, { "kind": "Reference", - "text": "AadHttpClientConfiguration" + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -4628,8 +3703,8 @@ "releaseTag": "Public", "name": "v1", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4637,20 +3712,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IAadHttpClientOptions:interface)", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions:interface", "docComment": "/**\n * Interface for overriding the default behavior of AadHttpClient.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IAadHttpClientOptions" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IAadHttpClientOptions " } ], "releaseTag": "Public", @@ -4658,20 +3725,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "configuration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions#configuration:member", "docComment": "/**\n * @deprecated\n *\n * - AadHttpClient's configuration cannot be altered\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "configuration" - }, { "kind": "Content", - "text": "?: " + "text": "configuration?: " }, { "kind": "Reference", - "text": "IAadTokenProviderConfiguration" + "text": "IAadTokenProviderConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration:interface" }, { "kind": "Content", @@ -4681,26 +3745,23 @@ "releaseTag": "Public", "name": "configuration", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "tokenProvider", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member", "docComment": "/**\n * @deprecated\n *\n * - AadHttpClient does not support a custom tokenProvider.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tokenProvider" - }, { "kind": "Content", - "text": "?: " + "text": "tokenProvider?: " }, { "kind": "Reference", - "text": "IAadTokenProvider" + "text": "IAadTokenProvider", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider:interface" }, { "kind": "Content", @@ -4710,22 +3771,18 @@ "releaseTag": "Public", "name": "tokenProvider", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "useCachedToken", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member", "docComment": "/**\n * Allows the developer to specify if cached tokens should be use for the current request.\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "useCachedToken" - }, { "kind": "Content", - "text": "?: " + "text": "useCachedToken?: " }, { "kind": "Content", @@ -4739,8 +3796,8 @@ "releaseTag": "Beta", "name": "useCachedToken", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4748,20 +3805,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IAadTokenProvider:interface)", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider:interface", "docComment": "/**\n * This class allows a developer to obtain OAuth2 tokens from Azure AD.\n *\n * OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, Exchange, Yammer, etc.\n *\n * @remarks\n *\n * AadTokenProvider is replacing the /_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IAadTokenProvider" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IAadTokenProvider " } ], "releaseTag": "Public", @@ -4769,24 +3818,12 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(getToken:0)", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider#getToken:member(1)", "docComment": "/**\n * Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource.\n *\n * The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself.\n *\n * An example of a resourceEndpoint would be https://sdfpilot.outlook.com\n *\n * @param resourceEndpoint - the resource for which the token should be obtained\n *\n * @param useCachedToken - Allows the developer to specify if cached tokens should be returned.\n *\n * @returns A promise that will be fullfiled with the token or that will reject with an error message\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getToken" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "resourceEndpoint" - }, { "kind": "Content", - "text": ": " + "text": "getToken(resourceEndpoint: " }, { "kind": "Content", @@ -4794,15 +3831,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "useCachedToken" - }, - { - "kind": "Content", - "text": "?: " + "text": ", useCachedToken?: " }, { "kind": "Content", @@ -4814,7 +3843,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -4826,24 +3856,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 + "startIndex": 5, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "resourceEndpoint", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "useCachedToken", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -4851,24 +3881,17 @@ }, { "kind": "PropertySignature", - "canonicalReference": "tokenAcquisitionEvent", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member", "docComment": "/**\n * Notifies the developer when Token Acquistion requires user action.\n *\n * @eventproperty\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "tokenAcquisitionEvent" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly tokenAcquisitionEvent: " }, { "kind": "Reference", - "text": "SPEvent" + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" }, { "kind": "Content", @@ -4876,7 +3899,8 @@ }, { "kind": "Reference", - "text": "ITokenAcquisitionEventArgs" + "text": "ITokenAcquisitionEventArgs", + "canonicalReference": "@microsoft/sp-http!ITokenAcquisitionEventArgs:interface" }, { "kind": "Content", @@ -4890,8 +3914,8 @@ "releaseTag": "Public", "name": "tokenAcquisitionEvent", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } } ], @@ -4899,20 +3923,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IAadTokenProviderConfiguration:interface)", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration:interface", "docComment": "/**\n * Required strings for constructing an AadTokenProvider.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IAadTokenProviderConfiguration" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IAadTokenProviderConfiguration " } ], "releaseTag": "Public", @@ -4920,16 +3936,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "aadInstanceUrl", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member", "docComment": "/**\n * The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "aadInstanceUrl" - }, { "kind": "Content", - "text": ": " + "text": "aadInstanceUrl: " }, { "kind": "Content", @@ -4943,22 +3955,18 @@ "releaseTag": "Public", "name": "aadInstanceUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "aadTenantId", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member", "docComment": "/**\n * The Azure Active Directory's tenant id.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "aadTenantId" - }, { "kind": "Content", - "text": ": " + "text": "aadTenantId: " }, { "kind": "Content", @@ -4972,22 +3980,18 @@ "releaseTag": "Public", "name": "aadTenantId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "aadUserId", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member", "docComment": "/**\n * The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "aadUserId" - }, { "kind": "Content", - "text": "?: " + "text": "aadUserId?: " }, { "kind": "Content", @@ -5001,22 +4005,18 @@ "releaseTag": "Public", "name": "aadUserId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "redirectUri", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member", "docComment": "/**\n * The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "redirectUri" - }, { "kind": "Content", - "text": ": " + "text": "redirectUri: " }, { "kind": "Content", @@ -5030,22 +4030,18 @@ "releaseTag": "Public", "name": "redirectUri", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "servicePrincipalId", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member", "docComment": "/**\n * The client ID of the developer's Azure Active Directory application.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "servicePrincipalId" - }, { "kind": "Content", - "text": ": " + "text": "servicePrincipalId: " }, { "kind": "Content", @@ -5059,22 +4055,18 @@ "releaseTag": "Public", "name": "servicePrincipalId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "userEmail", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member", "docComment": "/**\n * The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens.\n *\n * @deprecated\n *\n * This parameter will be ignored. Use userPrincipalName instead\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "userEmail" - }, { "kind": "Content", - "text": "?: " + "text": "userEmail?: " }, { "kind": "Content", @@ -5088,22 +4080,18 @@ "releaseTag": "Public", "name": "userEmail", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "userPrincipalName", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member", "docComment": "/**\n * The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth tokens. This parameter will avoid the \"Request is ambiguous: multiple user identities are avaliable for the current request\" error.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "userPrincipalName" - }, { "kind": "Content", - "text": "?: " + "text": "userPrincipalName?: " }, { "kind": "Content", @@ -5117,8 +4105,8 @@ "releaseTag": "Public", "name": "userPrincipalName", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5126,20 +4114,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IDigestCache:interface)", + "canonicalReference": "@microsoft/sp-http!IDigestCache:interface", "docComment": "/**\n * IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, specified via the \"X-RequestDigest\" HTTP header. It is obtained by calling the \"/_api/contextinfo\" REST endpoint, and expires after a server configurable amount of time.\n *\n * For more information, see the MSDN article {@link https://msdn.microsoft.com/en-us/library/office/jj164022.aspx | \"Complete basic operations using SharePoint 2013 REST endpoints\"}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDigestCache" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IDigestCache " } ], "releaseTag": "Public", @@ -5147,24 +4127,12 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(addDigestToCache:0)", + "canonicalReference": "@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)", "docComment": "/**\n * Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @param digestValue - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: \"0x0B85...2EAC,29 Jan 2016 01:23:45 -0000\"\n *\n * @param expirationTimestamp - A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration \"5 seconds from right now\", use performance.now()+5000.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "addDigestToCache" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": ": " + "text": "addDigestToCache(webUrl: " }, { "kind": "Content", @@ -5172,15 +4140,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "digestValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", digestValue: " }, { "kind": "Content", @@ -5188,15 +4148,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "expirationTimestamp" - }, - { - "kind": "Content", - "text": ": " + "text": ", expirationTimestamp: " }, { "kind": "Content", @@ -5216,31 +4168,31 @@ } ], "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "webUrl", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "digestValue", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "expirationTimestamp", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -5248,16 +4200,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(clearAllDigests:0)", + "canonicalReference": "@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)", "docComment": "/**\n * Clears all values from the cache.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clearAllDigests" - }, { "kind": "Content", - "text": "(): " + "text": "clearAllDigests(): " }, { "kind": "Content", @@ -5269,34 +4217,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "clearAllDigests" }, { "kind": "MethodSignature", - "canonicalReference": "(clearDigest:0)", + "canonicalReference": "@microsoft/sp-http!IDigestCache#clearDigest:member(1)", "docComment": "/**\n * Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time.\n *\n * @param webUrl - The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL.\n *\n * @returns Returns true if a cache entry was found and deleted; false otherwise.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clearDigest" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": ": " + "text": "clearDigest(webUrl: " }, { "kind": "Content", @@ -5316,17 +4252,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "webUrl", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5334,24 +4270,12 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(fetchDigest:0)", + "canonicalReference": "@microsoft/sp-http!IDigestCache#fetchDigest:member(1)", "docComment": "/**\n * Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache.\n *\n * @param webUrl - The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL.\n *\n * @returns A promise that is fulfilled with the digest value.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fetchDigest" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": ": " + "text": "fetchDigest(webUrl: " }, { "kind": "Content", @@ -5363,7 +4287,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -5375,77 +4300,33 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ - { - "parameterName": "webUrl", - "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - } - } - ], - "name": "fetchDigest" - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "(IGraphHttpClientOptions:interface)", - "docComment": "/**\n * Options for HttpClient\n *\n * @remarks\n *\n * This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IGraphHttpClientOptions" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "IHttpClientOptions" - }, - { - "kind": "Content", - "text": " " + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "fetchDigest" } ], - "releaseTag": "Beta", - "name": "IGraphHttpClientOptions", - "members": [], - "extendsTokenRanges": [ - { - "startIndex": 3, - "endIndex": 5 - } - ] + "extendsTokenRanges": [] }, { "kind": "Interface", - "canonicalReference": "(IHttpClientConfiguration:interface)", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface", "docComment": "/**\n * Flags interface for HttpClientConfiguration.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IHttpClientConfiguration" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IHttpClientConfiguration " } ], "releaseTag": "Public", @@ -5455,20 +4336,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IHttpClientConfigurations:interface)", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfigurations:interface", "docComment": "/**\n * Standard configurations for HttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IHttpClientConfigurations" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IHttpClientConfigurations " } ], "releaseTag": "Public", @@ -5476,24 +4349,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "v1", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfigurations#v1:member", "docComment": "/**\n * This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "v1" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly v1: " }, { "kind": "Reference", - "text": "HttpClientConfiguration" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -5503,8 +4369,8 @@ "releaseTag": "Public", "name": "v1", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5512,24 +4378,17 @@ }, { "kind": "Interface", - "canonicalReference": "(IHttpClientOptions:interface)", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface", "docComment": "/**\n * Options for HttpClient\n *\n * @remarks\n *\n * This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IHttpClientOptions" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface IHttpClientOptions extends " }, { "kind": "Reference", - "text": "RequestInit" + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" }, { "kind": "Content", @@ -5541,31 +4400,24 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientBatchConfiguration:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface", "docComment": "/**\n * Flags interface for SPHttpClientBatchConfiguration.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPHttpClientBatchConfiguration" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface ISPHttpClientBatchConfiguration extends " }, { "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", @@ -5577,27 +4429,19 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientBatchConfigurations:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface", "docComment": "/**\n * Standard configurations for SPHttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPHttpClientBatchConfigurations" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISPHttpClientBatchConfigurations " } ], "releaseTag": "Beta", @@ -5605,24 +4449,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "v1", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member", "docComment": "/**\n * Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "v1" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly v1: " }, { "kind": "Reference", - "text": "SPHttpClientBatchConfiguration" + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -5632,8 +4469,8 @@ "releaseTag": "Beta", "name": "v1", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5641,20 +4478,12 @@ }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientBatchCreationOptions:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface", "docComment": "/**\n * This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPHttpClientBatchCreationOptions" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISPHttpClientBatchCreationOptions " } ], "releaseTag": "Beta", @@ -5662,16 +4491,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "webUrl", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member", "docComment": "/**\n * SPHttpClientBatch will need to perform its POST to an endpoint such as \"http://example.com/sites/sample/_api/$batch\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": "?: " + "text": "webUrl?: " }, { "kind": "Content", @@ -5685,8 +4510,8 @@ "releaseTag": "Beta", "name": "webUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5694,24 +4519,17 @@ }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientBatchOptions:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface", "docComment": "/**\n * This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " + "text": "export interface ISPHttpClientBatchOptions extends " }, { "kind": "Reference", - "text": "ISPHttpClientBatchOptions" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -5723,31 +4541,24 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientCommonConfiguration:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface", "docComment": "/**\n * Flags interface for SPHttpClientCommonConfiguration\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " + "text": "export interface ISPHttpClientCommonConfiguration extends " }, { "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "IHttpClientConfiguration" + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" }, { "kind": "Content", @@ -5759,16 +4570,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "jsonRequest", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member", "docComment": "/**\n * Automatically configure the \"Content-Type\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\").\n *\n * For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'.\n *\n * For OData 4.0, the value is 'application/json;charset=utf-8'.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "jsonRequest" - }, { "kind": "Content", - "text": "?: " + "text": "jsonRequest?: " }, { "kind": "Content", @@ -5782,22 +4589,18 @@ "releaseTag": "Public", "name": "jsonRequest", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "jsonResponse", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member", "docComment": "/**\n * Automatically configure the \"Accept\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it.\n *\n * For OData 3.0, the value is 'application/json'.\n *\n * For OData 4.0, the value is 'application/json;odata.metadata=minimal'.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "jsonResponse" - }, { "kind": "Content", - "text": "?: " + "text": "jsonResponse?: " }, { "kind": "Content", @@ -5811,38 +4614,31 @@ "releaseTag": "Public", "name": "jsonResponse", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientConfiguration:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface", "docComment": "/**\n * Flags interface for SPHttpClientConfiguration.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " + "text": "export interface ISPHttpClientConfiguration extends " }, { "kind": "Reference", - "text": "ISPHttpClientConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", @@ -5854,20 +4650,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "defaultODataVersion", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member", "docComment": "/**\n * Automatically configure the \"OData-Version\" header.\n *\n * @remarks\n *\n * When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion.\n *\n * NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "defaultODataVersion" - }, { "kind": "Content", - "text": "?: " + "text": "defaultODataVersion?: " }, { "kind": "Reference", - "text": "ODataVersion" + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -5877,22 +4670,18 @@ "releaseTag": "Public", "name": "defaultODataVersion", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "defaultSameOriginCredentials", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member", "docComment": "/**\n * Automatically configure the RequestInit.credentials.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults.\n *\n * For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "defaultSameOriginCredentials" - }, { "kind": "Content", - "text": "?: " + "text": "defaultSameOriginCredentials?: " }, { "kind": "Content", @@ -5906,22 +4695,18 @@ "releaseTag": "Public", "name": "defaultSameOriginCredentials", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "requestDigest", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member", "docComment": "/**\n * Automatically provide an \"X-RequestDigest\" header for authentication.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "requestDigest" - }, { "kind": "Content", - "text": "?: " + "text": "requestDigest?: " }, { "kind": "Content", @@ -5935,34 +4720,26 @@ "releaseTag": "Public", "name": "requestDigest", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientConfigurations:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfigurations:interface", "docComment": "/**\n * Standard configurations for SPHttpClient.\n *\n * @remarks\n *\n * This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.)\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPHttpClientConfigurations" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISPHttpClientConfigurations " } ], "releaseTag": "Public", @@ -5970,24 +4747,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "v1", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfigurations#v1:member", "docComment": "/**\n * Version 1 enables these switches:\n *\n * consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "v1" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly v1: " }, { "kind": "Reference", - "text": "SPHttpClientConfiguration" + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -5997,8 +4767,8 @@ "releaseTag": "Public", "name": "v1", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -6006,24 +4776,17 @@ }, { "kind": "Interface", - "canonicalReference": "(ISPHttpClientOptions:interface)", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface", "docComment": "/**\n * This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPHttpClientOptions" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface ISPHttpClientOptions extends " }, { "kind": "Reference", - "text": "IHttpClientOptions" + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" }, { "kind": "Content", @@ -6035,16 +4798,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "webUrl", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions#webUrl:member", "docComment": "/**\n * Configure the SPWeb URL for authentication.\n *\n * @remarks\n *\n * For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be fetched using a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the SPWeb URL (\"https://example.com/sites/sample\" in this example) can be guessed by looking for a reserved URL segment such as \"_api\" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "webUrl" - }, { "kind": "Content", - "text": "?: " + "text": "webUrl?: " }, { "kind": "Content", @@ -6058,38 +4817,31 @@ "releaseTag": "Public", "name": "webUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Interface", - "canonicalReference": "(ITokenAcquisitionEventArgs:interface)", + "canonicalReference": "@microsoft/sp-http!ITokenAcquisitionEventArgs:interface", "docComment": "/**\n * Represents arguments used for raising a token acquisiton failure event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ITokenAcquisitionEventArgs" - }, - { - "kind": "Content", - "text": " extends " + "text": "export interface ITokenAcquisitionEventArgs extends " }, { "kind": "Reference", - "text": "SPEventArgs" + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" }, { "kind": "Content", @@ -6101,16 +4853,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "message", + "canonicalReference": "@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member", "docComment": "/**\n * The message returned from ADAL fails to retrieve a token from Azure AD.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "message" - }, { "kind": "Content", - "text": ": " + "text": "message: " }, { "kind": "Content", @@ -6124,22 +4872,18 @@ "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "redirectUrl", + "canonicalReference": "@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member", "docComment": "/**\n * The url of the page for the end user to interact with Azure AD.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "redirectUrl" - }, { "kind": "Content", - "text": "?: " + "text": "redirectUrl?: " }, { "kind": "Content", @@ -6153,34 +4897,26 @@ "releaseTag": "Public", "name": "redirectUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } ] }, { "kind": "Class", - "canonicalReference": "(MSGraphClient:class)", + "canonicalReference": "@microsoft/sp-http!MSGraphClient:class", "docComment": "/**\n * MSGraphClient is used to perform REST calls against Microsoft Graph.\n *\n * @remarks\n *\n * The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom configuration for every request.\n *\n * For more information: {@link https://github.com/microsoftgraph/msgraph-sdk-javascript}\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClient` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "MSGraphClient" - }, - { - "kind": "Content", - "text": " " + "text": "export default class MSGraphClient " } ], "releaseTag": "Public", @@ -6188,24 +4924,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(api:instance,0)", + "canonicalReference": "@microsoft/sp-http!MSGraphClient#api:member(1)", "docComment": "/**\n * All calls to Microsoft Graph are chained together starting with the api function.\n *\n * @remarks\n *\n * Path supports the following formats: * me * /me * https://graph.microsoft.com/v1.0/me * https://graph.microsoft.com/beta/me * me/events?$filter=startswith(subject, 'ship')\n *\n * The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript\n *\n * @param path - The path for the request to MSGraph.\n *\n * @param config - Sets the configuration for this request.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "api" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "path" - }, { "kind": "Content", - "text": ": " + "text": "api(path: " }, { "kind": "Content", @@ -6213,19 +4937,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "config" - }, - { - "kind": "Content", - "text": "?: " + "text": ", config?: " }, { "kind": "Reference", - "text": "Options" + "text": "Options", + "canonicalReference": "@microsoft/microsoft-graph-client!Options:interface" }, { "kind": "Content", @@ -6233,7 +4950,8 @@ }, { "kind": "Reference", - "text": "IGraphRequest" + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" }, { "kind": "Content", @@ -6242,24 +4960,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 11 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "config", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } } ], @@ -6270,20 +4988,12 @@ }, { "kind": "Class", - "canonicalReference": "(MSGraphClientFactory:class)", + "canonicalReference": "@microsoft/sp-http!MSGraphClientFactory:class", "docComment": "/**\n * Returns a preinitialized version of the MSGraphClient. For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph}\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientFactory` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "MSGraphClientFactory" - }, - { - "kind": "Content", - "text": " " + "text": "export default class MSGraphClientFactory " } ], "releaseTag": "Public", @@ -6291,20 +5001,17 @@ "members": [ { "kind": "Method", - "canonicalReference": "(getClient:instance,0)", + "canonicalReference": "@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)", "docComment": "/**\n * Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "getClient" - }, { "kind": "Content", - "text": "(): " + "text": "getClient(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -6312,7 +5019,8 @@ }, { "kind": "Reference", - "text": "MSGraphClient" + "text": "MSGraphClient", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6325,34 +5033,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getClient" }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-http!MSGraphClientFactory.serviceKey:member", "docComment": "/**\n * The service key for MSGraphClientFactory.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -6360,7 +5061,8 @@ }, { "kind": "Reference", - "text": "MSGraphClientFactory" + "text": "MSGraphClientFactory", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6374,8 +5076,8 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } @@ -6384,20 +5086,12 @@ }, { "kind": "Class", - "canonicalReference": "(ODataVersion:class)", + "canonicalReference": "@microsoft/sp-http!ODataVersion:class", "docComment": "/**\n * Represents supported version of the \"OData-Version\" header, which is part of the Open Data Protocol standard.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "ODataVersion" - }, - { - "kind": "Content", - "text": " " + "text": "export default class ODataVersion " } ], "releaseTag": "Public", @@ -6405,16 +5099,12 @@ "members": [ { "kind": "Method", - "canonicalReference": "(toString:instance,0)", + "canonicalReference": "@microsoft/sp-http!ODataVersion#toString:member(1)", "docComment": "/**\n * Returns the \"OData-Version\" value, for example \"4.0\".\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "toString" - }, { "kind": "Content", - "text": "(): " + "text": "toString(): " }, { "kind": "Content", @@ -6427,42 +5117,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "toString" }, { "kind": "Method", - "canonicalReference": "(tryParseFromHeaders:static,0)", + "canonicalReference": "@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)", "docComment": "/**\n * Attempt to parse the \"OData-Version\" header.\n *\n * @remarks\n *\n * If the \"OData-Version\" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "tryParseFromHeaders" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "headers" - }, - { - "kind": "Content", - "text": ": " + "text": "static tryParseFromHeaders(headers: " }, { "kind": "Reference", - "text": "Headers" + "text": "Headers", + "canonicalReference": "!Headers:interface" }, { "kind": "Content", @@ -6470,7 +5145,8 @@ }, { "kind": "Reference", - "text": "ODataVersion" + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6483,17 +5159,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 9 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -6501,24 +5177,17 @@ }, { "kind": "Property", - "canonicalReference": "(v3:static)", + "canonicalReference": "@microsoft/sp-http!ODataVersion.v3:member", "docComment": "/**\n * Represents version 3.0 for the \"OData-Version\" header\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "v3" - }, - { - "kind": "Content", - "text": ": " + "text": "static v3: " }, { "kind": "Reference", - "text": "ODataVersion" + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6528,31 +5197,24 @@ "releaseTag": "Public", "name": "v3", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(v4:static)", + "canonicalReference": "@microsoft/sp-http!ODataVersion.v4:member", "docComment": "/**\n * Represents version 4.0 for the \"OData-Version\" header\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "v4" - }, - { - "kind": "Content", - "text": ": " + "text": "static v4: " }, { "kind": "Reference", - "text": "ODataVersion" + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6562,8 +5224,8 @@ "releaseTag": "Public", "name": "v4", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true } @@ -6572,20 +5234,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPHttpClient:class)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:class", "docComment": "/**\n * SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application.\n *\n * @remarks\n *\n * For communicating with other internet services, use the {@link HttpClient} class.\n *\n * @public @sealed\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPHttpClient" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPHttpClient " } ], "releaseTag": "Public", @@ -6593,24 +5247,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `SPHttpClient` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", @@ -6618,41 +5265,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(beginBatch:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient#beginBatch:member(1)", "docComment": "/**\n * Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.\n *\n * @returns An {@link SPHttpClientBatch} object used to manage the batch operation.\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "beginBatch" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "batchCreationOptions" - }, { "kind": "Content", - "text": "?: " + "text": "beginBatch(batchCreationOptions?: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchCreationOptions" + "text": "ISPHttpClientBatchCreationOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface" }, { "kind": "Content", @@ -6660,7 +5296,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientBatch" + "text": "SPHttpClientBatch", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6669,17 +5306,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "batchCreationOptions", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -6687,24 +5324,17 @@ }, { "kind": "Property", - "canonicalReference": "(configurations:static)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient.configurations:member", "docComment": "/**\n * The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "configurations" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly configurations: " }, { "kind": "Reference", - "text": "ISPHttpClientConfigurations" + "text": "ISPHttpClientConfigurations", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfigurations:interface" }, { "kind": "Content", @@ -6714,31 +5344,19 @@ "releaseTag": "Public", "name": "configurations", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Method", - "canonicalReference": "(fetch:instance,0)", - "docComment": "/**\n * Perform a REST service call.\n *\n * @remarks\n *\n * Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead):\n *\n * - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified.\n *\n * - For write operations, an \"X-RequestDigest\" header is automatically added\n *\n * - The request digest token is automatically fetched and stored in a cache, with support for preloading\n *\n * For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a seperate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", + "canonicalReference": "@microsoft/sp-http!SPHttpClient#fetch:member(1)", + "docComment": "/**\n * Perform a REST service call.\n *\n * @remarks\n *\n * Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/\n *\n * The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA API's (which can be avoided by using HttpClient instead):\n *\n * - Default \"Accept\" and \"Content-Type\" headers are added if not explicitly specified.\n *\n * - For write operations, an \"X-RequestDigest\" header is automatically added\n *\n * - The request digest token is automatically fetched and stored in a cache, with support for preloading\n *\n * For a write operation, SPHttpClient will automatically add the \"X-RequestDigest\" header, which may need to be obtained by issuing a separate request such as \"https://example.com/sites/sample/_api/contextinfo\". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as \"_api\" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n *\n * @public\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fetch" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "fetch(url: " }, { "kind": "Content", @@ -6746,35 +5364,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options: " }, { "kind": "Reference", - "text": "ISPHttpClientOptions" + "text": "ISPHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface" }, { "kind": "Content", @@ -6782,7 +5386,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -6790,7 +5395,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6803,31 +5409,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -6835,24 +5441,12 @@ }, { "kind": "Method", - "canonicalReference": "(get:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient#get:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to \"GET\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "get" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "get(url: " }, { "kind": "Content", @@ -6860,35 +5454,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "ISPHttpClientOptions" + "text": "ISPHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface" }, { "kind": "Content", @@ -6896,7 +5476,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -6904,7 +5485,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -6917,31 +5499,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -6949,28 +5531,12 @@ }, { "kind": "Method", - "canonicalReference": "(getWebUrlFromRequestUrl:static,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)", "docComment": "/**\n * Use a heuristic to infer the base URL for authentication.\n *\n * @remarks\n *\n * Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path components such as \"_api\", \"_layouts\", or \"_vit_bin\". This is necessary for operations such as the X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a request.\n *\n * For example, if the requestUrl is \"/sites/site/web/_api/service\", the returned URL would be \"/sites/site/web\". Or if the requestUrl is \"http://example.com/_layouts/service\", the returned URL would be \"http://example.com\".\n *\n * If the URL cannot be determined, an exception is thrown.\n *\n * @param requestUrl - The URL for a SharePoint REST service\n *\n * @returns the inferred SPWeb URL\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static " - }, - { - "kind": "Reference", - "text": "getWebUrlFromRequestUrl" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "requestUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "static getWebUrlFromRequestUrl(requestUrl: " }, { "kind": "Content", @@ -6991,17 +5557,17 @@ ], "isStatic": true, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "requestUrl", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -7009,24 +5575,12 @@ }, { "kind": "Method", - "canonicalReference": "(post:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient#post:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to \"POST\".\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "post" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "post(url: " }, { "kind": "Content", @@ -7034,35 +5588,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options: " }, { "kind": "Reference", - "text": "ISPHttpClientOptions" + "text": "ISPHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface" }, { "kind": "Content", @@ -7070,7 +5610,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -7078,7 +5619,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7091,31 +5633,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -7123,24 +5665,17 @@ }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-http!SPHttpClient.serviceKey:member", "docComment": "/**\n * The service key for SPHttpClient.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -7148,7 +5683,8 @@ }, { "kind": "Reference", - "text": "SPHttpClient" + "text": "SPHttpClient", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7162,8 +5698,8 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true } @@ -7172,20 +5708,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPHttpClientBatch:class)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch:class", "docComment": "/**\n * The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html\n *\n * The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an SPHttpClientResponse object for that particular request.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPHttpClientBatch` class.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPHttpClientBatch" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPHttpClientBatch " } ], "releaseTag": "Beta", @@ -7193,24 +5721,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(configurations:static)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch.configurations:member", "docComment": "/**\n * The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly configurations: " }, { "kind": "Reference", - "text": "configurations" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISPHttpClientBatchConfigurations" + "text": "ISPHttpClientBatchConfigurations", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface" }, { "kind": "Content", @@ -7220,27 +5741,24 @@ "releaseTag": "Beta", "name": "configurations", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Method", - "canonicalReference": "(execute:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch#execute:member(1)", "docComment": "/**\n * Executes the batched queries that were queued using SPHttpClientBatch.fetch().\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "execute" - }, { "kind": "Content", - "text": "(): " + "text": "execute(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -7248,7 +5766,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientBatch" + "text": "SPHttpClientBatch", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7261,34 +5780,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "execute" }, { "kind": "Method", - "canonicalReference": "(fetch:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)", "docComment": "/**\n * Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed).\n *\n * @remarks\n *\n * The parameters for this function are basically the same as the WHATWG API standard documented here:\n *\n * {@link https://fetch.spec.whatwg.org/}\n *\n * However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation for details.\n *\n * When execute() is called, it will POST to a URL such as \"http://example.com/sites/sample/_api/$batch\". Typically SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as \"_api\" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "fetch" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, - { - "kind": "Content", - "text": ": " + "text": "fetch(url: " }, { "kind": "Content", @@ -7296,35 +5803,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClientBatchConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchOptions" + "text": "ISPHttpClientBatchOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface" }, { "kind": "Content", @@ -7332,7 +5825,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -7340,7 +5834,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7353,31 +5848,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -7385,24 +5880,12 @@ }, { "kind": "Method", - "canonicalReference": "(get:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch#get:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to 'GET'.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "get" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "get(url: " }, { "kind": "Content", @@ -7410,35 +5893,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClientBatchConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": "?: " + "text": ", options?: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchOptions" + "text": "ISPHttpClientBatchOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface" }, { "kind": "Content", @@ -7446,7 +5915,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -7454,7 +5924,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7467,31 +5938,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -7499,24 +5970,12 @@ }, { "kind": "Method", - "canonicalReference": "(post:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch#post:member(1)", "docComment": "/**\n * Calls fetch(), but sets the method to 'POST'.\n *\n * @param url - the URL to fetch\n *\n * @param configuration - determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations\n *\n * @param options - additional options that affect the request\n *\n * @returns A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with {@link HttpClientResponse.ok} being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "post" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "url" - }, { "kind": "Content", - "text": ": " + "text": "post(url: " }, { "kind": "Content", @@ -7524,35 +5983,21 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "configuration" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClientBatchConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": ", configuration: " }, { "kind": "Reference", - "text": "options" + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", - "text": ": " + "text": ", options: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchOptions" + "text": "ISPHttpClientBatchOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface" }, { "kind": "Content", @@ -7560,7 +6005,8 @@ }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -7568,7 +6014,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7581,31 +6028,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 18 + "startIndex": 7, + "endIndex": 11 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "configuration", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "options", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -7614,26 +6061,19 @@ ], "implementsTokenRanges": [] }, - { - "kind": "Class", - "canonicalReference": "(SPHttpClientBatchConfiguration:class)", - "docComment": "/**\n * Configuration for SPHttpClientBatch.\n *\n * @remarks\n *\n * The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPHttpClientBatchConfiguration" - }, + { + "kind": "Class", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration:class", + "docComment": "/**\n * Configuration for SPHttpClientBatch.\n *\n * @remarks\n *\n * The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method.\n *\n * @beta\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": " extends " + "text": "export default class SPHttpClientBatchConfiguration extends " }, { "kind": "Reference", - "text": "SPHttpClientCommonConfiguration" + "text": "SPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7645,7 +6085,8 @@ }, { "kind": "Reference", - "text": "ISPHttpClientBatchConfiguration" + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" }, { "kind": "Content", @@ -7657,40 +6098,26 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)", "docComment": "/**\n * Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISPHttpClientBatchConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(flags: " }, { "kind": "Reference", - "text": "overrideFlags" + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" }, { "kind": "Content", - "text": "?: " + "text": ", overrideFlags?: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchConfiguration" + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" }, { "kind": "Content", @@ -7698,44 +6125,37 @@ } ], "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "flags", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "overrideFlags", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(flags:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " + "text": "protected flags: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchConfiguration" + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" }, { "kind": "Content", @@ -7745,27 +6165,19 @@ "releaseTag": "Beta", "name": "flags", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(initializeFlags:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "initializeFlags" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected initializeFlags(): " }, { "kind": "Content", @@ -7778,38 +6190,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "initializeFlags" }, { "kind": "Method", - "canonicalReference": "(overrideWith:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "overrideWith" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceFlags" - }, { "kind": "Content", - "text": ": " + "text": "overrideWith(sourceFlags: " }, { "kind": "Reference", - "text": "ISPHttpClientBatchConfiguration" + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" }, { "kind": "Content", @@ -7817,7 +6218,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientBatchConfiguration" + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7826,17 +6228,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceFlags", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -7844,36 +6246,29 @@ } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [ { - "startIndex": 6, - "endIndex": 8 + "startIndex": 4, + "endIndex": 6 } ] }, { "kind": "Class", - "canonicalReference": "(SPHttpClientCommonConfiguration:class)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration:class", "docComment": "/**\n * Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class SPHttpClientCommonConfiguration extends " }, { "kind": "Reference", - "text": "SPHttpClientCommonConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "HttpClientConfiguration" + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -7885,7 +6280,8 @@ }, { "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", @@ -7897,40 +6293,26 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)", "docComment": "/**\n * Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags.\n *\n * @remarks\n *\n * The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(flags: " }, { "kind": "Reference", - "text": "overrideFlags" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", - "text": "?: " + "text": ", overrideFlags?: " }, { "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", @@ -7938,44 +6320,37 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "flags", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "overrideFlags", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(flags:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " + "text": "protected flags: " }, { "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", @@ -7985,27 +6360,19 @@ "releaseTag": "Public", "name": "flags", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(initializeFlags:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "initializeFlags" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected initializeFlags(): " }, { "kind": "Content", @@ -8018,30 +6385,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "initializeFlags" }, { "kind": "Property", - "canonicalReference": "(jsonRequest:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member", "docComment": "/**\n * Automatically configure the \"Content-Type\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Content-Type\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\").\n *\n * For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'.\n *\n * For OData 4.0, the value is 'application/json;charset=utf-8'.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "jsonRequest" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly jsonRequest: " }, { "kind": "Content", @@ -8055,27 +6414,19 @@ "releaseTag": "Public", "name": "jsonRequest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(jsonResponse:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member", "docComment": "/**\n * Automatically configure the \"Accept\" header for a JSON payload.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"Accept\" header was not explicitly added for the request, then SPHttpClient will add it.\n *\n * For OData 3.0, the value is 'application/json'.\n *\n * For OData 4.0, the value is 'application/json;odata.metadata=minimal'.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "jsonResponse" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly jsonResponse: " }, { "kind": "Content", @@ -8089,35 +6440,24 @@ "releaseTag": "Public", "name": "jsonResponse", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(overrideWith:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "overrideWith" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceFlags" - }, { "kind": "Content", - "text": ": " + "text": "overrideWith(sourceFlags: " }, { "kind": "Reference", - "text": "ISPHttpClientCommonConfiguration" + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" }, { "kind": "Content", @@ -8125,7 +6465,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientCommonConfiguration" + "text": "SPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -8134,17 +6475,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceFlags", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -8152,36 +6493,29 @@ } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [ { - "startIndex": 6, - "endIndex": 8 + "startIndex": 4, + "endIndex": 6 } ] }, { "kind": "Class", - "canonicalReference": "(SPHttpClientConfiguration:class)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration:class", "docComment": "/**\n * Configuration for {@link SPHttpClient}.\n *\n * @remarks\n *\n * The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPHttpClientConfiguration" - }, - { - "kind": "Content", - "text": " extends " + "text": "export default class SPHttpClientConfiguration extends " }, { "kind": "Reference", - "text": "SPHttpClientCommonConfiguration" + "text": "SPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -8193,7 +6527,8 @@ }, { "kind": "Reference", - "text": "ISPHttpClientConfiguration" + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" }, { "kind": "Content", @@ -8205,40 +6540,26 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)", "docComment": "/**\n * Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISPHttpClientConfiguration" - }, - { - "kind": "Content", - "text": ", " + "text": "constructor(flags: " }, { "kind": "Reference", - "text": "overrideFlags" + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" }, { "kind": "Content", - "text": "?: " + "text": ", overrideFlags?: " }, { "kind": "Reference", - "text": "ISPHttpClientConfiguration" + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" }, { "kind": "Content", @@ -8246,44 +6567,37 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "flags", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "overrideFlags", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(defaultODataVersion:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member", "docComment": "/**\n * Automatically configure the \"OData-Version\" header.\n *\n * @remarks\n *\n * When this switch is specified (i.e. not undefined): If the \"OData-Version\" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion.\n *\n * NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly defaultODataVersion: " }, { "kind": "Reference", - "text": "defaultODataVersion" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ODataVersion" + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -8293,27 +6607,19 @@ "releaseTag": "Public", "name": "defaultODataVersion", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(defaultSameOriginCredentials:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member", "docComment": "/**\n * Automatically configure the RequestInit.credentials.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be \"same-origin\". Without this switch, different web browsers may apply different defaults.\n *\n * For more information, see the spec: https://fetch.spec.whatwg.org/#cors-protocol-and-credentials\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "defaultSameOriginCredentials" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly defaultSameOriginCredentials: " }, { "kind": "Content", @@ -8327,31 +6633,24 @@ "releaseTag": "Public", "name": "defaultSameOriginCredentials", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(flags:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#flags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "protected " + "text": "protected flags: " }, { "kind": "Reference", - "text": "flags" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ISPHttpClientConfiguration" + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" }, { "kind": "Content", @@ -8361,27 +6660,19 @@ "releaseTag": "Public", "name": "flags", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(initializeFlags:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "initializeFlags" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected initializeFlags(): " }, { "kind": "Content", @@ -8394,38 +6685,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "initializeFlags" }, { "kind": "Method", - "canonicalReference": "(overrideWith:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "overrideWith" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "sourceFlags" - }, { "kind": "Content", - "text": ": " + "text": "overrideWith(sourceFlags: " }, { "kind": "Reference", - "text": "ISPHttpClientConfiguration" + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" }, { "kind": "Content", @@ -8433,7 +6713,8 @@ }, { "kind": "Reference", - "text": "SPHttpClientConfiguration" + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -8442,17 +6723,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "sourceFlags", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -8460,20 +6741,12 @@ }, { "kind": "Property", - "canonicalReference": "(requestDigest:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member", "docComment": "/**\n * Automatically provide an \"X-RequestDigest\" header for authentication.\n *\n * @remarks\n *\n * When this switch is true:\n *\n * If the \"X-RequestDigest\" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than \"GET\", \"HEAD\", or \"OPTIONS\"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "requestDigest" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly requestDigest: " }, { "kind": "Content", @@ -8487,43 +6760,36 @@ "releaseTag": "Public", "name": "requestDigest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [ { - "startIndex": 6, - "endIndex": 8 + "startIndex": 4, + "endIndex": 6 } ] }, { "kind": "Class", - "canonicalReference": "(SPHttpClientResponse:class)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientResponse:class", "docComment": "/**\n * The Response subclass returned by methods such as SPHttpClient.fetch().\n *\n * @remarks\n *\n * This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class.\n *\n * @public @sealed\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPHttpClientResponse" - }, - { - "kind": "Content", - "text": " extends " + "text": "export default class SPHttpClientResponse extends " }, { "kind": "Reference", - "text": "HttpClientResponse" + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -8535,24 +6801,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientResponse:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `SPHttpClientResponse` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "response" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(response: " }, { "kind": "Reference", - "text": "Response" + "text": "Response", + "canonicalReference": "!Response:interface" }, { "kind": "Content", @@ -8560,33 +6819,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "response", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Method", - "canonicalReference": "(clone:instance,0)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientResponse#clone:member(1)", "docComment": "/**\n * @override\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clone" - }, { "kind": "Content", - "text": "(): " + "text": "clone(): " }, { "kind": "Reference", - "text": "SPHttpClientResponse" + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" }, { "kind": "Content", @@ -8595,34 +6851,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "clone" }, { "kind": "Property", - "canonicalReference": "(correlationId:instance)", + "canonicalReference": "@microsoft/sp-http!SPHttpClientResponse#correlationId:member", "docComment": "/**\n * Returns the SharePoint correlation ID.\n *\n * @remarks\n *\n * The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the \"sprequestguid\" header.\n *\n * @returns the correlation ID, or undefined if the \"sprequestguid\" header was not found\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "correlationId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly correlationId: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -8636,34 +6885,26 @@ "releaseTag": "Beta", "name": "correlationId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Enum", - "canonicalReference": "(SPHttpHeader:enum)", + "canonicalReference": "@microsoft/sp-http!SPHttpHeader:enum", "docComment": "/**\n * Standard HTTP headers used with {@link SPHttpClient}\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare const enum " - }, - { - "kind": "Reference", - "text": "SPHttpHeader" - }, - { - "kind": "Content", - "text": " " + "text": "export declare const enum SPHttpHeader " } ], "releaseTag": "Beta", @@ -8671,16 +6912,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "SPRequestGuid", + "canonicalReference": "@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member", "docComment": "/**\n * SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request.\n *\n * Example value: \"9417279e-40e1-0000-2465-306ba786bfd7\"\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "SPRequestGuid" - }, { "kind": "Content", - "text": " = " + "text": "SPRequestGuid = " }, { "kind": "Content", @@ -8690,32 +6927,25 @@ "releaseTag": "Beta", "name": "SPRequestGuid", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Class", - "canonicalReference": "(TokenAcquisitionEventArgs:class)", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs:class", "docComment": "/**\n * Arguments for a token acquisition failure event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare class " - }, - { - "kind": "Reference", - "text": "TokenAcquisitionEventArgs" - }, - { - "kind": "Content", - "text": " extends " + "text": "export declare class TokenAcquisitionEventArgs extends " }, { "kind": "Reference", - "text": "SPEventArgs" + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" }, { "kind": "Content", @@ -8727,20 +6957,12 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `TokenAcquisitionEventArgs` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "message" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(message: " }, { "kind": "Content", @@ -8748,15 +6970,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "redirectUrl" - }, - { - "kind": "Content", - "text": "?: " + "text": ", redirectUrl?: " }, { "kind": "Content", @@ -8768,36 +6982,32 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "redirectUrl", "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 } } ] }, { "kind": "Property", - "canonicalReference": "(message:instance)", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs#message:member", "docComment": "/**\n * The message returned from ADAL fails to retrieve a token from Azure AD.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "message" - }, { "kind": "Content", - "text": ": " + "text": "message: " }, { "kind": "Content", @@ -8811,23 +7021,19 @@ "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(redirectUrl:instance)", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member", "docComment": "/**\n * The url of the page for the end user to perform Multi Factor Authentication\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "redirectUrl" - }, { "kind": "Content", - "text": "?: " + "text": "redirectUrl?: " }, { "kind": "Content", @@ -8841,15 +7047,15 @@ "releaseTag": "Public", "name": "redirectUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] } diff --git a/generate-docs/json/sp-list-subscription.api.json b/generate-docs/json/sp-list-subscription.api.json new file mode 100644 index 00000000..9173d202 --- /dev/null +++ b/generate-docs/json/sp-list-subscription.api.json @@ -0,0 +1,450 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-list-subscription!", + "docComment": "/**\n * This package provides developer support for subscribing to changes in a SharePoint document library.\n *\n * @remarks\n *\n * This package creates and manages subscriptions to SharePoint document libraries. It registers callbacks provided by the developer with the subscription to handle subscription events.\n *\n * @packagedocumentation\n */\n", + "name": "@microsoft/sp-list-subscription", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-list-subscription!", + "name": "", + "members": [ + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface", + "docComment": "/**\n * A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a web, you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you will need to provide it as well.\n *\n * In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and the current domain, site and web will be used.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICreateSubscriptionSettings " + } + ], + "releaseTag": "Public", + "name": "ICreateSubscriptionSettings", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member", + "docComment": "/**\n * the list of callbacks\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "callbacks: " + }, + { + "kind": "Reference", + "text": "ISubscriptionCallbacks", + "canonicalReference": "@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "callbacks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member", + "docComment": "/**\n * In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "domain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member", + "docComment": "/**\n * The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listId?: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member", + "docComment": "/**\n * The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current site will be used.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "siteId?: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "siteId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member", + "docComment": "/**\n * The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web will be used.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "webId?: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-list-subscription!IListSubscription:interface", + "docComment": "/**\n * A subscription to a SharePoint list resource. Contains the id of the subscription.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IListSubscription " + } + ], + "releaseTag": "Public", + "name": "IListSubscription", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!IListSubscription#id:member", + "docComment": "/**\n * The id of the subscription.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface", + "docComment": "/**\n * The callbacks that can be triggered by a subscription event.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ISubscriptionCallbacks " + } + ], + "releaseTag": "Public", + "name": "ISubscriptionCallbacks", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member", + "docComment": "/**\n * The callback to invoke when a connection has been made to the list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "connect?: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "connect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member", + "docComment": "/**\n * The callback to invoke when the subscription is disconnected from the list.\n *\n * @param reason - either 'io server disconnect' or 'io client disconnect'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disconnect?: " + }, + { + "kind": "Content", + "text": "(reason: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disconnect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member", + "docComment": "/**\n * The callback to invoke when a change occurs in the list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "notification: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "notification", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/sp-list-subscription!ListSubscriptionFactory:class", + "docComment": "/**\n * Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the subscription to handle subscription events.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ListSubscriptionFactory " + } + ], + "releaseTag": "Public", + "name": "ListSubscriptionFactory", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `ListSubscriptionFactory` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(component: " + }, + { + "kind": "Reference", + "text": "BaseComponent", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "component", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)", + "docComment": "/**\n * Creates a connection to the list specified by the site id and list id.\n *\n * @param settings - The various parameters\n *\n * @returns Promise of the subscription to the list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createSubscription(settings: " + }, + { + "kind": "Reference", + "text": "ICreateSubscriptionSettings", + "canonicalReference": "@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IListSubscription", + "canonicalReference": "@microsoft/sp-list-subscription!IListSubscription:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "settings", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "createSubscription" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)", + "docComment": "/**\n * Deletes the subscription's connection to the resource.\n *\n * @param subscription - The subscription to delete.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deleteSubscription(subscription: " + }, + { + "kind": "Reference", + "text": "IListSubscription", + "canonicalReference": "@microsoft/sp-list-subscription!IListSubscription:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "subscription", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "deleteSubscription" + } + ], + "implementsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-listview-extensibility.api.json b/generate-docs/json/sp-listview-extensibility.api.json index 533e3a4a..166e4554 100644 --- a/generate-docs/json/sp-listview-extensibility.api.json +++ b/generate-docs/json/sp-listview-extensibility.api.json @@ -1,84 +1,68 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-listview-extensibility", + "canonicalReference": "@microsoft/sp-listview-extensibility!", "docComment": "/**\n * SharePoint Framework support for customizing the list view.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-listview-extensibility", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-listview-extensibility!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(BaseFieldCustomizer:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class", "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that customizes the appearance of fields in a SharePoint ListView.\n *\n * In the component manifest, the \"extensionType\" should be set to \"FieldCustomizer\".\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "declare abstract class " + "text": "declare abstract class BaseFieldCustomizer extends " }, { "kind": "Reference", - "text": "BaseFieldCustomizer" + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" }, { "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> extends " - }, - { - "kind": "Reference", - "text": "BaseExtension" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> " + "text": " " } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "BaseFieldCustomizer", "members": [ { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " + "text": "protected readonly context: " }, { "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "FieldCustomizerContext" + "text": "FieldCustomizerContext", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" }, { "kind": "Content", @@ -88,35 +72,24 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(onDisposeCell:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "onDisposeCell" - }, { "kind": "Content", - "text": "(" + "text": "onDisposeCell(event: " }, { "kind": "Reference", - "text": "event" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IFieldCustomizerCellEventParameters" + "text": "IFieldCustomizerCellEventParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface" }, { "kind": "Content", @@ -133,17 +106,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -151,28 +124,17 @@ }, { "kind": "Method", - "canonicalReference": "(onRenderCell:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "onRenderCell" - }, { "kind": "Content", - "text": "(" + "text": "onRenderCell(event: " }, { "kind": "Reference", - "text": "event" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IFieldCustomizerCellEventParameters" + "text": "IFieldCustomizerCellEventParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface" }, { "kind": "Content", @@ -189,17 +151,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -207,76 +169,59 @@ } ], "extendsTokenRange": { - "startIndex": 5, - "endIndex": 9 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(BaseListViewCommandSet:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class", "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view.\n *\n * @remarks\n *\n * In the component manifest, the \"extensionType\" should be set to \"ListViewCommandSet\".\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseListViewCommandSet` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "declare abstract class " - }, - { - "kind": "Reference", - "text": "BaseListViewCommandSet" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> extends " - }, - { - "kind": "Reference", - "text": "BaseExtension" - }, - { - "kind": "Content", - "text": "<" + "text": "declare abstract class BaseListViewCommandSet extends " }, { "kind": "Reference", - "text": "TProperties" + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" }, { "kind": "Content", - "text": "> " + "text": " " } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "BaseListViewCommandSet", "members": [ { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly context: " }, { "kind": "Reference", - "text": "ListViewCommandSetContext" + "text": "ListViewCommandSetContext", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" }, { "kind": "Content", @@ -286,35 +231,24 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(onExecute:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)", "docComment": "/**\n * This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "onExecute" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "event" - }, { "kind": "Content", - "text": ": " + "text": "onExecute(event: " }, { "kind": "Reference", - "text": "IListViewCommandSetExecuteEventParameters" + "text": "IListViewCommandSetExecuteEventParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface" }, { "kind": "Content", @@ -331,17 +265,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -349,28 +283,17 @@ }, { "kind": "Method", - "canonicalReference": "(onListViewUpdated:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)", "docComment": "/**\n * This event occurs whenever the ListView state changes.\n *\n * @remarks\n *\n * This event allows the implementor to tailor the appearance of the command. For example, to hide the command, assign its property visible = false. To customize the title, modify the command property title.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "onListViewUpdated" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "event" - }, { "kind": "Content", - "text": ": " + "text": "onListViewUpdated(event: " }, { "kind": "Reference", - "text": "IListViewCommandSetListViewUpdatedParameters" + "text": "IListViewCommandSetListViewUpdatedParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface" }, { "kind": "Content", @@ -387,17 +310,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -405,24 +328,12 @@ }, { "kind": "Method", - "canonicalReference": "(tryGetCommand:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)", "docComment": "/**\n * Returns the command with the given id. Returns undefined if there is not command with the given id.\n *\n * @param id - Id of the command\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetCommand" - }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "tryGetCommand(id: " }, { "kind": "Content", @@ -434,7 +345,8 @@ }, { "kind": "Reference", - "text": "Command" + "text": "Command", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" }, { "kind": "Content", @@ -443,17 +355,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -461,27 +373,19 @@ } ], "extendsTokenRange": { - "startIndex": 5, - "endIndex": 9 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(ColumnAccessor:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor:class", "docComment": "/**\n * Provides access to a ListView column, which is the visual presentation of a field.\n *\n * @remarks\n *\n * A SharePoint \"field\" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a \"property\".)\n *\n * A \"column\" is the visual presentation of a field, when displayed by the ListView.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ColumnAccessor` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare abstract class " - }, - { - "kind": "Reference", - "text": "ColumnAccessor" - }, - { - "kind": "Content", - "text": " " + "text": "export declare abstract class ColumnAccessor " } ], "releaseTag": "Public", @@ -489,24 +393,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(field:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor#field:member", "docComment": "/**\n * The server-side definition of the field. This property is read-only.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract readonly " + "text": "abstract readonly field: " }, { "kind": "Reference", - "text": "field" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPField" + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" }, { "kind": "Content", @@ -516,27 +413,19 @@ "releaseTag": "Public", "name": "field", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(visible:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member", "docComment": "/**\n * Whether to show this column in the list view. This property is read-only.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract readonly " - }, - { - "kind": "Reference", - "text": "visible" - }, - { - "kind": "Content", - "text": ": " + "text": "abstract readonly visible: " }, { "kind": "Content", @@ -550,8 +439,8 @@ "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -560,20 +449,12 @@ }, { "kind": "Class", - "canonicalReference": "(Command:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command:class", "docComment": "/**\n * Represents a command belonging to a command set.\n *\n * @remarks\n *\n * The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling {@link BaseListViewCommandSet.tryGetCommand}. The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "Command" - }, - { - "kind": "Content", - "text": " " + "text": "export default class Command " } ], "releaseTag": "Public", @@ -581,16 +462,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(ariaLabel:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#ariaLabel:member", "docComment": "/**\n * Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ariaLabel" - }, { "kind": "Content", - "text": ": " + "text": "ariaLabel: " }, { "kind": "Content", @@ -604,23 +481,19 @@ "releaseTag": "Public", "name": "ariaLabel", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(iconImageUrl:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#iconImageUrl:member", "docComment": "/**\n * An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all.\n *\n * @remarks\n *\n * This must be a absolute URL.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "iconImageUrl" - }, { "kind": "Content", - "text": ": " + "text": "iconImageUrl: " }, { "kind": "Content", @@ -634,23 +507,19 @@ "releaseTag": "Public", "name": "iconImageUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#id:member", "docComment": "/**\n * Id of the command.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "id" - }, { "kind": "Content", - "text": ": " + "text": "id: " }, { "kind": "Content", @@ -664,23 +533,19 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(title:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#title:member", "docComment": "/**\n * A short label to be displayed by the associated button, menu item, etc.\n *\n * @remarks\n *\n * Example: \"Show information\"\n *\n * Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "title" - }, { "kind": "Content", - "text": ": " + "text": "title: " }, { "kind": "Content", @@ -694,23 +559,19 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(visible:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#visible:member", "docComment": "/**\n * True if the command is visible.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "visible" - }, { "kind": "Content", - "text": ": " + "text": "visible: " }, { "kind": "Content", @@ -724,8 +585,8 @@ "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -734,24 +595,17 @@ }, { "kind": "Class", - "canonicalReference": "(FieldCustomizerContext:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!FieldCustomizerContext:class", "docComment": "/**\n * This object provides contextual information for BaseFieldCustomizer.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FieldCustomizerContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "FieldCustomizerContext" - }, - { - "kind": "Content", - "text": " extends " + "text": "export default class FieldCustomizerContext extends " }, { "kind": "Reference", - "text": "ExtensionContext" + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" }, { "kind": "Content", @@ -763,24 +617,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(field:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member", "docComment": "/**\n * Provides access to the SharePoint field that the customizer will operate on.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly field: " }, { "kind": "Reference", - "text": "field" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPField" + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" }, { "kind": "Content", @@ -790,27 +637,24 @@ "releaseTag": "Public", "name": "field", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(tryGetListView:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)", "docComment": "/**\n * If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined.\n *\n * @remarks\n *\n * Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form.\n *\n * @returns the SharePoint list view, or undefined if there is none.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "tryGetListView" - }, { "kind": "Content", - "text": "(): " + "text": "tryGetListView(): " }, { "kind": "Reference", - "text": "ListViewAccessor" + "text": "ListViewAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!~ListViewAccessor:class" }, { "kind": "Content", @@ -823,37 +667,29 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "tryGetListView" } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Interface", - "canonicalReference": "(IFieldCustomizerCellEventParameters:interface)", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface", "docComment": "/**\n * Event parameters for BaseFieldCustomizer.onRenderCell()\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IFieldCustomizerCellEventParameters" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IFieldCustomizerCellEventParameters " } ], "releaseTag": "Public", @@ -861,24 +697,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "domElement", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member", "docComment": "/**\n * The HTML \"div\" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "domElement" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly domElement: " }, { "kind": "Reference", - "text": "HTMLDivElement" + "text": "HTMLDivElement", + "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", @@ -888,26 +717,18 @@ "releaseTag": "Public", "name": "domElement", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "fieldValue", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member", "docComment": "/**\n * The value of the field being rendered.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "fieldValue" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly fieldValue: " }, { "kind": "Content", @@ -921,30 +742,23 @@ "releaseTag": "Public", "name": "fieldValue", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "listItem", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member", "docComment": "/**\n * The list item being edited.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly listItem: " }, { "kind": "Reference", - "text": "listItem" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ListItemAccessor" + "text": "ListItemAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" }, { "kind": "Content", @@ -954,22 +768,18 @@ "releaseTag": "Public", "name": "listItem", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "userData", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member", "docComment": "/**\n * An implementation defined storage property.\n *\n * @remarks\n *\n * For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "userData" - }, { "kind": "Content", - "text": ": " + "text": "userData: " }, { "kind": "Content", @@ -983,8 +793,8 @@ "releaseTag": "Public", "name": "userData", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -992,20 +802,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IListViewCommandSetExecuteEventParameters:interface)", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface", "docComment": "/**\n * Parameters for {@link BaseListViewCommandSet.onExecute}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IListViewCommandSetExecuteEventParameters" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IListViewCommandSetExecuteEventParameters " } ], "releaseTag": "Public", @@ -1013,20 +815,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "itemId", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member", "docComment": "/**\n * The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "itemId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly itemId: " }, { "kind": "Content", @@ -1040,30 +834,23 @@ "releaseTag": "Public", "name": "itemId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "selectedRows", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member", "docComment": "/**\n * The currently selected ListView rows, at the time when the event occurred.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "selectedRows" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly selectedRows: " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1071,7 +858,8 @@ }, { "kind": "Reference", - "text": "RowAccessor" + "text": "RowAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class" }, { "kind": "Content", @@ -1085,8 +873,8 @@ "releaseTag": "Public", "name": "selectedRows", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } } ], @@ -1094,20 +882,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IListViewCommandSetListViewUpdatedParameters:interface)", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface", "docComment": "/**\n * Parameters for {@link BaseListViewCommandSet.onListViewUpdated}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IListViewCommandSetListViewUpdatedParameters" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IListViewCommandSetListViewUpdatedParameters " } ], "releaseTag": "Public", @@ -1115,24 +895,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "selectedRows", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member", "docComment": "/**\n * The currently selected ListView rows, at the time when the event occurred.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "selectedRows" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly selectedRows: " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1140,7 +913,8 @@ }, { "kind": "Reference", - "text": "RowAccessor" + "text": "RowAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class" }, { "kind": "Content", @@ -1154,8 +928,8 @@ "releaseTag": "Public", "name": "selectedRows", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 } } ], @@ -1163,20 +937,12 @@ }, { "kind": "Class", - "canonicalReference": "(ListItemAccessor:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListItemAccessor:class", "docComment": "/**\n * When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item.\n *\n * @remarks\n *\n * ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and retrieve the current values for those fields. In the future, it may also support validation and editing operations.\n *\n * When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListItemAccessor` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " - }, - { - "kind": "Reference", - "text": "ListItemAccessor" - }, - { - "kind": "Content", - "text": " " + "text": "export default abstract class ListItemAccessor " } ], "releaseTag": "Public", @@ -1184,24 +950,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(fields:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member", "docComment": "/**\n * The SharePoint fields that are currently available in the editor for this list item.\n *\n * @remarks\n *\n * The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract readonly " + "text": "abstract readonly fields: " }, { "kind": "Reference", - "text": "fields" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1209,7 +968,8 @@ }, { "kind": "Reference", - "text": "SPField" + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" }, { "kind": "Content", @@ -1223,39 +983,24 @@ "releaseTag": "Public", "name": "fields", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(getValue:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)", "docComment": "/**\n * Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract " + "text": "abstract getValue(field: " }, { "kind": "Reference", - "text": "getValue" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "field" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPField" + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" }, { "kind": "Content", @@ -1272,17 +1017,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "field", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1290,28 +1035,12 @@ }, { "kind": "Method", - "canonicalReference": "(getValueByName:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)", "docComment": "/**\n * Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract " - }, - { - "kind": "Reference", - "text": "getValueByName" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "internalName" - }, - { - "kind": "Content", - "text": ": " + "text": "abstract getValueByName(internalName: " }, { "kind": "Content", @@ -1332,17 +1061,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "internalName", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1353,20 +1082,12 @@ }, { "kind": "Class", - "canonicalReference": "(ListViewAccessor:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewAccessor:class", "docComment": "/**\n * Provides access to a SharePoint ListView control.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewAccessor` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "declare abstract class " - }, - { - "kind": "Reference", - "text": "ListViewAccessor" - }, - { - "kind": "Content", - "text": " " + "text": "declare abstract class ListViewAccessor " } ], "releaseTag": "Public", @@ -1374,24 +1095,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(columns:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member", "docComment": "/**\n * The columns in associated with this view, including hidden columns.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract readonly " - }, - { - "kind": "Reference", - "text": "columns" - }, - { - "kind": "Content", - "text": ": " + "text": "abstract readonly columns: " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1399,7 +1113,8 @@ }, { "kind": "Reference", - "text": "ColumnAccessor" + "text": "ColumnAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor:class" }, { "kind": "Content", @@ -1413,31 +1128,24 @@ "releaseTag": "Public", "name": "columns", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(selectedRowsChangedEvent:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member", "docComment": "/**\n * Event that gets raised every time the selected items in the list view change.\n *\n * @eventproperty\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly selectedRowsChangedEvent: " }, { "kind": "Reference", - "text": "selectedRowsChangedEvent" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPEvent" + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" }, { "kind": "Content", @@ -1445,7 +1153,8 @@ }, { "kind": "Reference", - "text": "SelectedRowsChangedEventArgs" + "text": "SelectedRowsChangedEventArgs", + "canonicalReference": "@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class" }, { "kind": "Content", @@ -1459,35 +1168,19 @@ "releaseTag": "Public", "name": "selectedRowsChangedEvent", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(tryGetColumnByName:instance,0)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)", "docComment": "/**\n * Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "abstract " - }, - { - "kind": "Reference", - "text": "tryGetColumnByName" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "internalName" - }, - { - "kind": "Content", - "text": ": " + "text": "abstract tryGetColumnByName(internalName: " }, { "kind": "Content", @@ -1499,7 +1192,8 @@ }, { "kind": "Reference", - "text": "ColumnAccessor" + "text": "ColumnAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor:class" }, { "kind": "Content", @@ -1512,17 +1206,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 9 + "startIndex": 3, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "internalName", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1533,24 +1227,17 @@ }, { "kind": "Class", - "canonicalReference": "(ListViewCommandSetContext:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class", "docComment": "/**\n * This object provides contextual information for BaseListViewCommandSet.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewCommandSetContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " + "text": "export default class ListViewCommandSetContext extends " }, { "kind": "Reference", - "text": "ListViewCommandSetContext" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "ExtensionContext" + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" }, { "kind": "Content", @@ -1562,24 +1249,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(listView:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member", "docComment": "/**\n * Provides access to the ListView control that the customizer will operate on.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly listView: " }, { "kind": "Reference", - "text": "listView" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ListViewAccessor" + "text": "ListViewAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!~ListViewAccessor:class" }, { "kind": "Content", @@ -1589,31 +1269,24 @@ "releaseTag": "Public", "name": "listView", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(manifest:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly manifest: " }, { "kind": "Reference", - "text": "manifest" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ICommandSetExtensionManifest" + "text": "ICommandSetExtensionManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface" }, { "kind": "Content", @@ -1623,38 +1296,31 @@ "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(RowAccessor:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class", "docComment": "/**\n * Provides access to a ListView row, which is the visual presentation of a SharePoint list item.\n *\n * @remarks\n *\n * A SharePoint \"list item\" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields.\n *\n * A \"row\" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values for the associated columns.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RowAccessor` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare abstract class " + "text": "export declare abstract class RowAccessor extends " }, { "kind": "Reference", - "text": "RowAccessor" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "ListItemAccessor" + "text": "ListItemAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" }, { "kind": "Content", @@ -1665,31 +1331,24 @@ "name": "RowAccessor", "members": [], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(SelectedRowsChangedEventArgs:class)", + "canonicalReference": "@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class", "docComment": "/**\n * Arguments for the selected rows changed event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare class " + "text": "export declare class SelectedRowsChangedEventArgs extends " }, { "kind": "Reference", - "text": "SelectedRowsChangedEventArgs" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPEventArgs" + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" }, { "kind": "Content", @@ -1701,20 +1360,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(selectedRows:instance)", + "canonicalReference": "@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member", "docComment": "/**\n * The list of rows that were selected in the list view at the time when the event was fired.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "selectedRows" - }, { "kind": "Content", - "text": ": " + "text": "selectedRows: " }, { "kind": "Reference", - "text": "ReadonlyArray" + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", @@ -1722,7 +1378,8 @@ }, { "kind": "Reference", - "text": "RowAccessor" + "text": "RowAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class" }, { "kind": "Content", @@ -1736,15 +1393,15 @@ "releaseTag": "Public", "name": "selectedRows", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 6 + "startIndex": 1, + "endIndex": 5 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] } diff --git a/generate-docs/json/sp-loader.api.json b/generate-docs/json/sp-loader.api.json new file mode 100644 index 00000000..659628fa --- /dev/null +++ b/generate-docs/json/sp-loader.api.json @@ -0,0 +1,373 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-loader!", + "docComment": "/**\n * The SharePoint Framework loader\n *\n * @remarks\n *\n * Built on familiar standards such as RequireJS and WebPack, the loader is the first part of the SharePoint Framework to load on a page. It manages versioning and loading of client-side components.\n *\n * @packagedocumentation\n */\n", + "name": "@microsoft/sp-loader", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-loader!", + "name": "", + "members": [ + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-loader!ILoadScriptOptions:interface", + "docComment": "/**\n * Options for the loadScript() method in ISPComponentLoader\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ILoadScriptOptions " + } + ], + "releaseTag": "Public", + "name": "ILoadScriptOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member", + "docComment": "/**\n * If set, the loaded script will be stored in a global variable under this name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "globalExportsName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "globalExportsName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/sp-loader!SPComponentLoader:class", + "docComment": "/**\n * Component loader. Needs to be initialized with an implemented `ISPComponentLoader`.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class SPComponentLoader " + } + ], + "releaseTag": "Public", + "name": "SPComponentLoader", + "members": [ + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)", + "docComment": "/**\n * Returns static copies of all the manifests.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static getManifests(): " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getManifests" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)", + "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadComponent}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static loadComponent(manifest: " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "manifest", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "TComponent", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "loadComponent" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)", + "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadComponentById}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static loadComponentById(id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "id", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "version", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "TComponent", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "loadComponentById" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)", + "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadCss}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static loadCss(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "loadCss" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)", + "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadScript}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static loadScript(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ILoadScriptOptions", + "canonicalReference": "@microsoft/sp-loader!ILoadScriptOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "TModule", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "loadScript" + } + ], + "implementsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-lodash-subset.api.json b/generate-docs/json/sp-lodash-subset.api.json new file mode 100644 index 00000000..f8d6f6e9 --- /dev/null +++ b/generate-docs/json/sp-lodash-subset.api.json @@ -0,0 +1,73 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-lodash-subset!", + "docComment": "", + "name": "@microsoft/sp-lodash-subset", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-lodash-subset!", + "name": "", + "members": [ + { + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-lodash-subset!Cancelable:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type Cancelable = " + }, + { + "kind": "Reference", + "text": "Cancelable2", + "canonicalReference": "@types/lodash!~\"\\\"../index\\\"\".Cancelable:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Cancelable", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-lodash-subset!ThrottleSettings:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type ThrottleSettings = " + }, + { + "kind": "Reference", + "text": "ThrottleSettings2", + "canonicalReference": "@types/lodash!~\"\\\"../index\\\"\".ThrottleSettings:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ThrottleSettings", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/generate-docs/json/sp-module-interfaces.api.json b/generate-docs/json/sp-module-interfaces.api.json new file mode 100644 index 00000000..7d162b9c --- /dev/null +++ b/generate-docs/json/sp-module-interfaces.api.json @@ -0,0 +1,2094 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-module-interfaces!", + "docComment": "", + "name": "@microsoft/sp-module-interfaces", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-module-interfaces!", + "name": "", + "members": [ + { + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-module-interfaces!ComponentType:type", + "docComment": "/**\n * Type of client-side component.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type ComponentType = " + }, + { + "kind": "Content", + "text": "'Application' | 'WebPart' | 'Library' | 'Extension'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ComponentType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-module-interfaces!ExtensionType:type", + "docComment": "/**\n * The type of client-side extension. Used by IClientSideExtensionManifest.extensionType.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type ExtensionType = " + }, + { + "kind": "Content", + "text": "'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | 'ListViewCommandSet' | 'SearchQueryModifier'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ExtensionType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface", + "docComment": "/**\n * A library is defined by this manifest. Libraries currently do not have any additional properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideAssemblyManifest extends " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IClientSideAssemblyManifest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member", + "docComment": "/**\n * The ID of the component from which the assembly is built.\n *\n * @remarks\n *\n * Supported values: any GUID\n *\n * Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rootComponentId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "rootComponentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface", + "docComment": "/**\n * This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. It contains all data for loading an entrypoint script and its dependency scripts.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideComponentLoaderConfiguration " + } + ], + "releaseTag": "Beta", + "name": "IClientSideComponentLoaderConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member", + "docComment": "/**\n * This is the ID of one of the entries in the \"scriptResources\" dictionary.\n *\n * @remarks\n *\n * The loader will download and evaluate the script resource referenced in this field, resolve all dependencies against the keys in the \"scriptResources\", and return the exported object to the loader's calling function. The entry referenced in the \"scriptResources\" dictionary must be of the \"internal\" or the \"localized\" type.\n *\n * Supported values: An entry in the \"scriptResources\" dictionary that defines the base exported module of the component.\n *\n * Example: `\"myApplication.bundle\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "entryModuleId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "entryModuleId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member", + "docComment": "/**\n * The module referenced by the \"entryModuleId\" field may export an object with several fields.\n *\n * @remarks\n *\n * This value optionally references the name of a field on the object exported by the module referenced by the `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported by the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of the base exported object. For example, if entryModuleId refers to a module with with a top-level export of `{ foo: 'bar', baz: 123 }` and:\n *\n * - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }`\n *\n * - if this field is set to `foo`, the value returned by the module loader is `bar`\n *\n * - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a key in the top-level export).\n *\n * Example: `mySpWebpart`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exportName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "exportName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member", + "docComment": "/**\n * This is an array of fully-qualified paths to be prepended to each of the script resource paths with the \"internal\" or \"localized\" type. If one fails to load, the loader will attempt to load from the next until there are no base paths remaining.\n *\n * @remarks\n *\n * All \"internal\" and \"localized\" script resources that do not have fully-qualified URLs as their \"path\" field values must be hosted under each of the paths listed in this property. For example, if an internal module's \"path\" field value is `\"master_2015-04-20/my-application.bundle_1928f8a0.js\"` and this field's value is `[ \"https://contoso.akamaihd.net/files/\", \"https://contoso.msecnd.net/files/\" ]`, the loader will first attempt to load this script resource from the URL `\"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js\"`. If loading from that URL fails, the loader will then attempt to load this script resource from `\"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js\"`. If that URL fails to load, the component will fail to load and an error will be returned. It is important to note that the support for multiple base URLs is purely for failover support. This means that all files must be present on all hosts listed in this field.\n *\n * Usage: Base URLs for script resources with the \"internal\" or \"localized\" type.\n *\n * Supported values: Any URL that contains all internal scripts referenced in the \"scriptResources\" dictionary.\n *\n * Example: `[ \"https://contoso.akamaihd.net/files/\", \"https://contoso.msecnd.net/files/\" ]`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "internalModuleBaseUrls: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "internalModuleBaseUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member", + "docComment": "/**\n * This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` must contain the component's exported object.\n *\n * @remarks\n *\n * Supported values: A dictionary of named script resources.\n *\n * Example:\n * ```\n * {\n * \"myApplication.bundle\": {\n * \"type\": \"path\",\n * \"path\": \"master_2015-04-20/my-application.bundle_1928f8a0.js\"\n * },\n * \"@microsoft/sp-client-base\": {\n * \"type\": \"component\",\n * \"id\": \"af59c2b3-2da7-41fd-8b72-3939817960af\",\n * \"version\": \"latest\"\n * },\n * \"@microsoft/sp-client-preview\": {\n * \"type\": \"component\",\n * \"id\": \"4d5eb168-6729-49a8-aec7-0e397f486b6e\",\n * \"version\": \"latest\"\n * },\n * \"jQuery\": {\n * \"type\": \"component\",\n * \"id\": \"00000000-0000-0000-0000-000000000000\",\n * \"version\": \"2.2.4\",\n * \"path\": \"https://code.jquery.com/jquery-2.2.4.min.js\"\n * },\n * \"myApplication_strings\": {\n * \"type\": \"localizedPath\",\n * \"defaultPath\": \"master_2015-04-20/my-application_strings_default_af378e0d.js\",\n * \"paths\": {\n * \"en-us\": \"master_2015-04-20/my-application_strings_en-us_d38ff012.js\",\n * \"fr-fr\": \"master_2015-04-20/my-application_strings_fr-fr_138af7e4.js\"\n * }\n * }\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scriptResources: " + }, + { + "kind": "Content", + "text": "{\n [name: string]: " + }, + { + "kind": "Reference", + "text": "IModuleConfiguration", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "scriptResources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface", + "docComment": "/**\n * All client-side components built on the SharePoint framework need a valid component manifest. This interface represents properties that are required by all types of client-side components like Applications and Web Parts. Component specific manifests will extend this interface to add properties required by that component type.\n *\n * @remarks\n *\n * The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing this schema. This set of rules can also be called the \"manifest upgrade rules\".\n *\n * - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that processes the manifest should be able to handle the absence of those new properties.\n *\n * - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they impose a migration cost on developers.\n *\n * - The `'manifestVersion'` should be bumped for all small or big changes.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideComponentManifest extends " + }, + { + "kind": "Reference", + "text": "IClientSideManifestBase", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideManifestBase:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IClientSideComponentManifest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member", + "docComment": "/**\n * A short name usually given by developer. It does not need to be localized and is expected to stay the same through the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, `ClientSideApplication.alias` is given precedence over the value provided in the manifest.\n *\n * @remarks\n *\n * Usage: A short name to identify a client-side component by developer.\n *\n * Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters.\n *\n * Example: `\"NewFeed\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "alias: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "alias", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member", + "docComment": "/**\n * Type of client-side component. Components with the \"Application\" type are defined by the \"IClientSideApplicationManifest\" interface. Components with the \"WebPart\" type are defined by the \"IClientSideWebPartManifest\" interface. Components with the \"Library\" type are defined by the \"IClientSideLibraryManifest\" interface.\n *\n * @remarks\n *\n * Usage: To help bundling, loading, enumeration, and initialization of components based on their contents.\n *\n * Supported values: `\"Application\"`, `\"WebPart\"`, `\"Library\"`, `\"Extension\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "componentType: " + }, + { + "kind": "Reference", + "text": "ComponentType", + "canonicalReference": "@microsoft/sp-module-interfaces!ComponentType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member", + "docComment": "/**\n * This portion of the configuration describes how the component is to be loaded and initialized by a client. It contains an enumeration of scripts that the component requires along with a single entry point script.\n *\n * @remarks\n *\n * Usage: Loading a component.\n *\n * See `IClientSideComponentLoaderConfiguration` for more information and examples.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "loaderConfig: " + }, + { + "kind": "Reference", + "text": "IClientSideComponentLoaderConfiguration", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "loaderConfig", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member", + "docComment": "/**\n * This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts build after using spfx 1.1 don't need this.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "loadLegacyFabricCss?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "loadLegacyFabricCss", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member", + "docComment": "/**\n * If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true if the component allows authors to execute arbitrary scripts on the page.\n *\n * @remarks\n *\n * Defaults to false. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information.\n *\n * Usage: Requires Custom Script to be allowed in order for this component to be installed and run.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "requiresCustomScript?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "requiresCustomScript", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member", + "docComment": "/**\n * This property is provided for backwards compatibility. It no longer has any effect.\n *\n * @deprecated\n *\n * Use requiresCustomScript instead of safeWithCustomScriptDisabled.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "safeWithCustomScriptDisabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "safeWithCustomScriptDisabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member", + "docComment": "/**\n * Client-side component version. The value of this field is expected to be controlled by the developer of the client-side component.\n *\n * @remarks\n *\n * The purpose of this field is to help client-side component developers upgrade their client-side components in a managed way. This helps the consumers of the client-side component make decisions about when and how to upgrade the client-side component. As the developer evolves the code for their client-side component, they can decide to bump the MAJOR, MINOR or PATCH version of the component.\n *\n * All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. Please see {@link http://semver.org} for more details on how to manage the version of your components.\n *\n * Usage: Versioning and evolving a client-side component safely in a controlled way.\n *\n * Supported values: string representing a {@link http://semver.org | semantic version} i.e. MAJOR.MINOR.PATCH\n *\n * Example: `\"1.0.0\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface", + "docComment": "/**\n * This is the manifest for a client-side extension.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideExtensionManifest extends " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IClientSideExtensionManifest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member", + "docComment": "/**\n * Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "extensionType: " + }, + { + "kind": "Reference", + "text": "ExtensionType", + "canonicalReference": "@microsoft/sp-module-interfaces!ExtensionType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "extensionType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface", + "docComment": "/**\n * A library is defined by this manifest. Libraries currently do not have any additional properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideLibraryManifest extends " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IClientSideLibraryManifest", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideManifestBase:interface", + "docComment": "/**\n * This interface defines members that are common between all deployable manifests.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideManifestBase " + } + ], + "releaseTag": "Public", + "name": "IClientSideManifestBase", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member", + "docComment": "/**\n * A universally unique component id. Each client-side component is required to have this id. Once an id has been used for a component, it cannot be changed. A change in this value is treated same as the creation of a new component. Two components are never expected to have the same id.\n *\n * Usage: Uniquely identify a client-side component.\n *\n * Supported values: a GUID string\n *\n * Example: `\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member", + "docComment": "/**\n * Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this field is to help manage upgrades of the component manifest schema.\n *\n * @remarks\n *\n * A component developer needs to only confirm that they are using the correct value per the manifest schema. Please read the \"manifest upgrade rules\" for more details on when the schema could change. Note, manifest schema version upgrade will be considered a big API change event and will be advertised broadly.\n *\n * Usage: To help support multiple manifest schema versions.\n *\n * Supported values: A positive integer.\n *\n * Example: `1`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "manifestVersion: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifestVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface", + "docComment": "/**\n * The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a manifest.\n *\n * @remarks\n *\n * The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to identify, load and process a Web Part. The schema for this manifest is completely owned and versioned by Microsoft. There are some required properties in the manifest and some optional properties. Optional properties need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and functionality problems.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideWebPartManifest extends " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "IClientSideWebPartManifest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member", + "docComment": "/**\n * Indicates whether the web part uses the property pane to update the configuration of the web part.\n *\n * @remarks\n *\n * Default value is `true` if the property is not explicitly defined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "canUpdateConfiguration?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "canUpdateConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member", + "docComment": "/**\n * If true, this web part is disabled on SharePoint classic pages\n *\n * @remarks\n *\n * Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If this flag is true, the web part will not appear in the classic page web part gallery.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabledOnClassicSharepoint?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledOnClassicSharepoint", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member", + "docComment": "/**\n * If true, this web part should not be displayed in the modern SharePoint toolbox.\n *\n * @remarks\n *\n * Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts can be provisioned on pages though API or be added to the page in a pre configured way.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hiddenFromToolbox?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "hiddenFromToolbox", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member", + "docComment": "/**\n * Definition: Url of the image image used for preview\n *\n * @remarks\n *\n * Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module url\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "imagePreviewUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "imagePreviewUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member", + "docComment": "/**\n * A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part specific custom properties. And there can be multiple instances of these pre-configured properties.\n *\n * @remarks\n *\n * This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web Part in the Toolbox. Each entry is expected to configure the Web Part with a different set of pre-configured properties. A developer may decide to seed some initial values for these properties but an organization admin can go ahead and customize these properties per the needs of his/her organization. The properties can also be modified by the author of the page.\n *\n * Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part.\n *\n * Type: JSON object\n *\n * Supported values: Array of `IClientSideWebPartManifestEntry` objects.\n *\n * Example:\n * ```\n * [{\n * title:\"Image Web Part\",\n * description: \"This Web Part displays an image\",\n * group: \"Media\",\n * iconFontName: \"image\",\n * properties: {\n * imageSource: \"https://contoso.akamaihd.net/files/mountRainier.jpg\",\n * captionText: \"Mount Rainier\"\n * }\n * }]\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "preconfiguredEntries: " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartManifestEntry", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "preconfiguredEntries", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member", + "docComment": "/**\n * Definition: An array defining what host types are supported\n *\n * @remarks\n *\n * Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is provided. If SharePointFullPage is added the solution will be available when adding full page apps. If SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab or TeamsPersonalApp is added the solution will be available when using teams.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "supportedHosts?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "supportedHosts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member", + "docComment": "/**\n * Definition: If true, this web part supports and has been tested for full bleed experience.\n *\n * @remarks\n *\n * Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed experiences require special treatment and testing. By default no web parts support full bleed experiences.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "supportsFullBleed?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "supportsFullBleed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member", + "docComment": "/**\n * Definition: If true, this web part supports and has been tested for theme variants experience.\n *\n * @remarks\n *\n * Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no web parts support theme variants.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "supportsThemeVariants?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "supportsThemeVariants", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface", + "docComment": "/**\n * This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideWebPartManifestEntry " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "IClientSideWebPartManifestEntry", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member", + "docComment": "/**\n * Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note that data version is different from the version field in the manifest.\n *\n * @remarks\n *\n * The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information.\n *\n * Usage: versioning and evolving the serialized data of the web part\n *\n * Type: string representing a {@link http://semver.org | semantic version} with only two parts\n *\n * Supported values: MAJOR.MINOR\n *\n * Example: `\"1.0\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataVersion?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member", + "docComment": "/**\n * Description of the web part represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display areas.\n *\n * @remarks\n *\n * The Web Part developer may give an initial description to the web part. The organization admin and page author will have the ability to change this description as per need.\n *\n * Usage: display the description of the web part in the toolbox tooltip, web part gallery and the page.\n *\n * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.\n *\n * Example: `\"A tool for displaying neat information.\"`\n * ```\n * {\n * \"default\": \"A tool for displaying neat information.\",\n * \"en-us\": \"A tool for displaying neat information.\",\n * \"fr-fr\": \"Un outil d’affichage des informations soignées.\",\n * \"zh\": \"用於顯示整潔資訊的工具。\"\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "description: " + }, + { + "kind": "Reference", + "text": "ILocalizedString", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member", + "docComment": "/**\n * The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group.\n *\n * @remarks\n *\n * Example: `{ \"default\": \"Media and Content\" }`\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "group?: " + }, + { + "kind": "Reference", + "text": "ILocalizedString", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "group", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member", + "docComment": "/**\n * The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an id not in the predefined groups, it falls back to Other group.\n *\n * @remarks\n *\n * Supported values: the GUID from PredefinedGroup list\n *\n * Example: `\"cf066440-0614-43d6-98ae-0b31cf14c7c3\"`\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "groupId: " + }, + { + "kind": "Reference", + "text": "PredefinedGroup", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup:enum" + }, + { + "kind": "Content", + "text": " | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "groupId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member", + "docComment": "/**\n * The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).\n *\n * @remarks\n *\n * If the {@link IClientSideWebPartManifestEntry.officeFabricIconFontName} field does not have a value, this field must have a value. This value can be an absolute URL (e.g. `\"http://example.com/icons/my-icon.png\"`) or a relative file path (e.g. `\"./icons/my-icon.png\"`). In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property).\n *\n * Supported values: Any absolute URL.\n *\n * Example: `\"https://contoso.akamaihd.net/files/myWebpartIcon.png\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "iconImageUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "iconImageUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member", + "docComment": "/**\n * The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file.\n *\n * @remarks\n *\n * The icon font is specified here: {@link https://aka.ms/uifabric-icons} If this field has a value, the {@link IClientSideWebPartManifestEntry.iconImageUrl} field will be ignored.\n *\n * Supported values: Any character name in the Office 365 Icon Font.\n *\n * Example: \"graph\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "officeFabricIconFontName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "officeFabricIconFontName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member", + "docComment": "/**\n * Every web part is expected to have some custom properties. For example, an image web part might define properties for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so on.\n *\n * @remarks\n *\n * The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer fully controls the schema for these properties. The web part developer should follow versioning rules when updating the properties.\n *\n * Usage: rendering of the web part\n *\n * Example: `{\"imageSource\": \"https://contoso.akamaihd.net/files/contosoLogo.jpg\", \"captionText\": \"Contoso logo\"}\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "properties: " + }, + { + "kind": "Content", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member", + "docComment": "/**\n * This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.\n *\n * @remarks\n *\n * Example `[{ \"default\": \"image\" }, { \"default\": \"media\" }, { \"default\": \"picture\" }, ...]`\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tags?: " + }, + { + "kind": "Reference", + "text": "ILocalizedString", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "tags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member", + "docComment": "/**\n * Title of the web part represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox.\n *\n * @remarks\n *\n * This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title to the web part. The organization admin and page author will have the ability to change this title as per need.\n *\n * Usage: display the name of the web part in the toolbox, web part gallery and the page.\n *\n * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.\n *\n * Example: `\"My Webpart\"`\n * ```\n * {\n * \"default\": \"My WebPart\"\n * \"en-us\": \"My WebPart\",\n * \"fr-fr\": \"Ma WebPart\",\n * \"zh\": \"我的 web 部件\"\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "title: " + }, + { + "kind": "Reference", + "text": "ILocalizedString", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface", + "docComment": "/**\n * Manifest that is relevant to a Web Part instance.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IClientSideWebPartManifestInstance extends " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "IClientSideWebPartManifestInstance", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandDefinition:interface", + "docComment": "/**\n * Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICommandDefinition " + } + ], + "releaseTag": "Public", + "name": "ICommandDefinition", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member", + "docComment": "/**\n * Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Reference", + "text": "ILocalizedString", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member", + "docComment": "/**\n * An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all.\n *\n * @remarks\n *\n * This value can be an absolute URL (e.g. \"http://example.com/icons/my-icon.png\") or a relative file path (e.g. \"./icons/my-icon.png\"). In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "iconImageUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "iconImageUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandDefinition#title:member", + "docComment": "/**\n * A short label to be displayed by the associated button, menu item, etc. Example: \"Show information\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "title: " + }, + { + "kind": "Reference", + "text": "ILocalizedString", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandDefinition#type:member", + "docComment": "/**\n * Type of the item. Currently only \"command\" is allowed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "'command'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface", + "docComment": "/**\n * This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICommandSetExtensionManifest extends " + }, + { + "kind": "Reference", + "text": "IClientSideExtensionManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ICommandSetExtensionManifest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member", + "docComment": "/**\n * Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "extensionType: " + }, + { + "kind": "Content", + "text": "'ListViewCommandSet'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "extensionType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member", + "docComment": "/**\n * A table of items defined by this command set. The object key is the Item ID.\n *\n * @remarks\n *\n * The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: \"SHOW_INFO\"\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "items: " + }, + { + "kind": "Content", + "text": "{\n [itemId: string]: " + }, + { + "kind": "Reference", + "text": "ICommandDefinition", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandDefinition:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "items", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface", + "docComment": "/**\n * This is the interface for a script module with the \"component\" type. Modules of this type will be provided via manifests. In order for the dependency to be loaded, the manifest must be available on the site.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IComponentModuleConfiguration extends " + }, + { + "kind": "Reference", + "text": "IModuleConfiguration", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "IComponentModuleConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member", + "docComment": "/**\n * A path to the framework-supplied component in case the framework fails to load the requested version.\n *\n * @remarks\n *\n * This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` field. If this field is not specified and the version is not available in the framework runtime, the closest matching version of the component will be provided instead.\n *\n * Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field.\n *\n * Example: `\"https://code.jquery.com/jquery-2.2.4.min.js\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "failoverPath?: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "IPath", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "failoverPath", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member", + "docComment": "/**\n * The ID of the framework-supplied component to be loaded.\n *\n * @remarks\n *\n * Supported values: string representing a component's ID.\n *\n * Example: `\"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member", + "docComment": "/**\n * The version of the framework-supplied component to be loaded. For framework runtime component such as `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was developed against be specified.\n *\n * @remarks\n *\n * Supported values: string representing a {@link http://semver.org | semantic version}, or \"latest\".\n *\n * Example: `\"2.2.4\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface", + "docComment": "/**\n * This is the interface for a script module with the \"localizedPath\" type.\n *\n * @remarks\n *\n * Modules of this type must be provided by the component developer. These script resources are similar to those of the \"path\" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as \"internal\" modules are.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ILocalizedPathModuleConfiguration extends " + }, + { + "kind": "Reference", + "text": "IModuleConfiguration", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ILocalizedPathModuleConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member", + "docComment": "/**\n * A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field.\n *\n * @remarks\n *\n * If the user's locale does not resolve to one of the paths specified in the \"paths\" field, the path in this field is used. Paths in this module type are treated exactly the same way paths in modules of the \"internal\" type are treated.\n *\n * Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field.\n *\n * Example: `\"master_2015-04-20/my-application_strings_default_af378e0d.js\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultPath: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "IPath", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "defaultPath", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member", + "docComment": "/**\n * This is a dictionary of locale keys (in the `\"ll-cc\"` format) to paths to this module's locale javascript resource either as a fully-qualified URL or as a path under the paths provided in the `\"internalModuleBaseUrls\"` field.\n *\n * @remarks\n *\n * The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the script resource under that path. If the user's locale does not resolve to one of the paths specified in this field, the path in `\"defaultPath\"` field is used. For example, if the user's locale is `\"en-gb\"`, and this field's value contains the keys `[ \"en-us\", \"en-gb\", \"fr-fr\" ]`, the path specified by the `\"en-gb\"` key will be used. If the user's locale is \"en-gb\", and this field's value contains the keys `[ \"en-us\", \"fr-fr\" ]`, the path specified by the `\"en-us\"` key will be used. If the user's locale is `\"en-gb\"`, and this field's value contains the keys `[ \"es-es\", \"fr-fr\" ]`, the path specified by the \"defaultPath\" field will be used. Paths in this module type are treated exactly the same way paths in modules of the \"internal\" type are treated.\n *\n * Supported values: A dictionary of locale-to-path mappings.\n *\n * Example:\n * ```\n * {\n * \"en-us\": \"master_2015-04-20/my-application_strings_en-us_d38ff012.js\",\n * \"fr-fr\": \"master_2015-04-20/my-application_strings_fr-fr_138af7e4.js\"\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "paths?: " + }, + { + "kind": "Content", + "text": "{\n [locale: string]: string | " + }, + { + "kind": "Reference", + "text": "IPath", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "paths", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:interface", + "docComment": "/**\n * A set of localized strings.\n *\n * @remarks\n *\n * Supported values:\n *\n * - An Id referring to a localized resource. In this case it requires an 'id' key.\n *\n * - A dictionary of locale keys to strings. In this case it requires a 'default' key.\n * ```\n * Example 1: \"My Application\"\n * {\n * \"id\": \"$myStrings:myStrings.MyApplication;\"\n * }\n * Example 2: \"My Application\"\n * {\n * \"default\": \"My Application\"\n * \"en-us\": \"My Application\",\n * \"fr-fr\": \"Ma demande\",\n * \"zh\": \"我的應用程式\"\n * }\n * ```\n *\n * Notes on string ids:\n *\n * - Ids have the following structure: `$:;`\n *\n * - `resourceName` needs to be a `localizedResource` in the config.json.\n *\n * - `expression` is an expression that will be evaluated to access the string from the resource module.\n *\n * If your resource is a dictionary, access it through `\"$resource:resource.MyString;\"` or `\"$resource:resource[\\\"MyString\\\"];\"`\n *\n * For more complex cases, run an appropriate expression to access your resource and return the string.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ILocalizedString " + } + ], + "releaseTag": "Public", + "name": "ILocalizedString", + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[locale: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "locale", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString#default:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "default?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "default", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!ILocalizedString#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration:interface", + "docComment": "/**\n * This is the base interface for a script module's definition.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IModuleConfiguration " + } + ], + "releaseTag": "Beta", + "name": "IModuleConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member", + "docComment": "/**\n * If set to `true`, this module should not be preloaded when loading the component.\n *\n * @remarks\n *\n * The most common case for setting this property to \"true\" is when a module is defined in a manifest, but is not required for the module referenced in \"entryModuleId\" to load. Modules may be defined that are loaded asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`.\n *\n * Usage: Instructs the module loader to not preload this module.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shouldNotPreload?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "shouldNotPreload", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration#type:member", + "docComment": "/**\n * The type of the script block. `\"component\"` modules come from a component, `\"path\"` and `\"localizedPath\"` modules must be available on the paths provided in the `\"internalModuleBaseUrls\"` field.\n *\n * @remarks\n *\n * Modules with the `\"path\"` type use the `IPathModuleConfiguration` interface.\n *\n * Modules with the `\"component\"` type use the `IComponentModuleConfiguration` interface. Modules with the \"localizedPath\" type use the `ILocalizedPathModuleConfiguration` interface.\n *\n * Supported values: `\"component\"`, `\"path\"`, `\"localizedPath\"`\n *\n * Example: `\"localized\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "'component' | 'path' | 'localizedPath'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath:interface", + "docComment": "/**\n * This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded in exactly the same way as any other internal path.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPath " + } + ], + "releaseTag": "Beta", + "name": "IPath", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath#debug:member", + "docComment": "/**\n * A path to this module's debug javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field. The script referenced by this field is only loaded if it is present and debug scripts are explicitly requested.\n *\n * @remarks\n *\n * Supported values: The path to the debug script either as a fully-qualified URL or as a path under the paths provided in the `\"internalModuleBaseUrls\"` field.\n *\n * Example: `\"master_2015-04-20/my-application.bundle_18182c39.debug.js\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "debug?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "debug", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath#default:member", + "docComment": "/**\n * A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field. The script referenced by this field is loaded by default unless a debug version of the script is provided and explicitly requested.\n *\n * @remarks\n *\n * Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field.\n *\n * Example: `\"master_2015-04-20/my-application.bundle_1928f8a0.js\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "default: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "default", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface", + "docComment": "/**\n * This is the interface for a script module with the \"path\" type. Modules of this type must be provided by the component developer.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPathModuleConfiguration extends " + }, + { + "kind": "Reference", + "text": "IModuleConfiguration", + "canonicalReference": "@microsoft/sp-module-interfaces!IModuleConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "IPathModuleConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member", + "docComment": "/**\n * For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will ensure that those dependencies are already loaded.\n *\n * @remarks\n *\n * Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules in the same component manifest that this module is specified, the module loader will throw an exception and the component will fail to load.\n *\n * Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key `IClientSideComponentLoaderConfiguration.scriptResources[]`\n *\n * Example: `[\"jquery\"]`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "globalDependencies?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "globalDependencies", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member", + "docComment": "/**\n * If this property is specified, this module is considered non-AMD and the module loader will not expect \"define\" or \"require\" to be called.\n *\n * @remarks\n *\n * In order to load scripts that don't follow the AMD/module-pattern where \"define\" or \"require\" is called and dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which global variable must be examined. If this property is specified, this module is considered non-AMD and the module loader will not expect \"define\" or \"require\" to be called. Instead, it will wait for the script to finish loading and examine the global variable specified in this field.\n *\n * Supported values: Variable names that are expected to be populated after this module is loaded. For example, if this module is describing jQuery, this value should probably be \"$\". If an empty string is specified, the module loader will throw an exception and the component will fail to load.\n *\n * Example: `\"$\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "globalName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "globalName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member", + "docComment": "/**\n * A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided in the `internalModuleBaseUrls` field.\n *\n * @remarks\n *\n * For example, if this field's value is `\"master_2015-04-20/my-application.bundle_1928f8a0.js\"` and the `\"internalModuleBaseUrls\"` field's value is `[ \"https://contoso.akamaihd.net/files/\", \"https://contoso.msecnd.net/files/\" ]`, the loader will first attempt to load this script resource from the URL `\"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js\"`. If loading from that URL fails, the loader will then attempt to load this script resource from `\"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js\"`. If that URL fails to load, the component will fail to load and an error will be returned.\n *\n * Supported values: The path to the module either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field.\n *\n * Example: `\"master_2015-04-20/my-application.bundle_1928f8a0.js\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "path: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "IPath", + "canonicalReference": "@microsoft/sp-module-interfaces!IPath:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "path", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup:enum", + "docComment": "/**\n * Predefined web part group.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum PredefinedGroup " + } + ], + "releaseTag": "Beta", + "name": "PredefinedGroup", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member", + "docComment": "/**\n * Business and intelligence.\n *\n * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BusinessAndIntelligence = " + }, + { + "kind": "Content", + "text": "\"4aca9e90-eff5-4fa1-bac7-728f5f157b66\"" + } + ], + "releaseTag": "Beta", + "name": "BusinessAndIntelligence", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member", + "docComment": "/**\n * Communication and collaboration.\n *\n * This group includes web parts that facilitate information sharing, team work, and social interactions.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CommunicationAndCollaboration = " + }, + { + "kind": "Content", + "text": "\"75e22ed5-fa14-4829-850a-c890608aca2d\"" + } + ], + "releaseTag": "Beta", + "name": "CommunicationAndCollaboration", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member", + "docComment": "/**\n * Discovery.\n *\n * This group includes web parts that organize, group, and filter content to help users discover information.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Discovery = " + }, + { + "kind": "Content", + "text": "\"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489\"" + } + ], + "releaseTag": "Beta", + "name": "Discovery", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.Other:member", + "docComment": "/**\n * Other.\n *\n * This group includes web parts not in other groups.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Other = " + }, + { + "kind": "Content", + "text": "\"5c03119e-3074-46fd-976b-c60198311f70\"" + } + ], + "releaseTag": "Beta", + "name": "Other", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member", + "docComment": "/**\n * Planning and process.\n *\n * This group includes web parts that empower team productivity with the use of planning and process tools.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PlanningAndProcess = " + }, + { + "kind": "Content", + "text": "\"1bc7927e-4a5e-4520-b540-71305c79c20a\"" + } + ], + "releaseTag": "Beta", + "name": "PlanningAndProcess", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member", + "docComment": "/**\n * Site tools.\n *\n * This group includes web parts for site information and management.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SiteTools = " + }, + { + "kind": "Content", + "text": "\"070951d7-94da-4db8-b06e-9d581f1f55b1\"" + } + ], + "releaseTag": "Beta", + "name": "SiteTools", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member", + "docComment": "/**\n * Text, media and content.\n *\n * This group includes web parts that display text, multi-media, documents, information from the web, and other rich content.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "TextMediaAndContent = " + }, + { + "kind": "Content", + "text": "\"cf066440-0614-43d6-98ae-0b31cf14c7c3\"" + } + ], + "releaseTag": "Beta", + "name": "TextMediaAndContent", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-odata-types.api.json b/generate-docs/json/sp-odata-types.api.json index f582db8c..f4300af2 100644 --- a/generate-docs/json/sp-odata-types.api.json +++ b/generate-docs/json/sp-odata-types.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-odata-types", + "canonicalReference": "@microsoft/sp-odata-types!", "docComment": "/**\n * TypeScript interfaces for working with SharePoint REST APIs.\n *\n * @remarks\n *\n * This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-odata-types", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-odata-types!", "name": "", "members": [ { "kind": "Interface", - "canonicalReference": "(_IODataUserId:interface)", + "canonicalReference": "@microsoft/sp-odata-types!_IODataUserId:interface", "docComment": "/**\n * Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataUserId" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataUserId " } ], "releaseTag": "Public", @@ -37,16 +30,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "NameId", + "canonicalReference": "@microsoft/sp-odata-types!_IODataUserId#NameId:member", "docComment": "/**\n * Example: `\"s-1-5-21-2127521184-1604012920-1887927527-2632426\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "NameId" - }, { "kind": "Content", - "text": ": " + "text": "NameId: " }, { "kind": "Content", @@ -60,22 +49,18 @@ "releaseTag": "Public", "name": "NameId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "NameIdIssuer", + "canonicalReference": "@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member", "docComment": "/**\n * Example: `\"urn:office:idp:activedirectory\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "NameIdIssuer" - }, { "kind": "Content", - "text": ": " + "text": "NameIdIssuer: " }, { "kind": "Content", @@ -89,8 +74,8 @@ "releaseTag": "Public", "name": "NameIdIssuer", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -98,20 +83,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataBasePermission:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface", "docComment": "/**\n * Data used for creating a SPPermission object.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataBasePermission" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataBasePermission " } ], "releaseTag": "Public", @@ -119,16 +96,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "High", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission#High:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "High" - }, { "kind": "Content", - "text": ": " + "text": "High: " }, { "kind": "Content", @@ -142,22 +115,18 @@ "releaseTag": "Public", "name": "High", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Low", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission#Low:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Low" - }, { "kind": "Content", - "text": ": " + "text": "Low: " }, { "kind": "Content", @@ -171,8 +140,8 @@ "releaseTag": "Public", "name": "Low", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -180,20 +149,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataChangeToken:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataChangeToken:interface", "docComment": "/**\n * Represents an OData SP.ChangeToken object. For more information about this object, see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataChangeToken" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataChangeToken " } ], "releaseTag": "Public", @@ -201,16 +162,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "StringValue", + "canonicalReference": "@microsoft/sp-odata-types!IODataChangeToken#StringValue:member", "docComment": "/**\n * Example: `{ StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "StringValue" - }, { "kind": "Content", - "text": ": " + "text": "StringValue: " }, { "kind": "Content", @@ -224,8 +181,8 @@ "releaseTag": "Public", "name": "StringValue", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -233,20 +190,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataContextWebInformation:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation:interface", "docComment": "/**\n * Represents an OData SP.ContextWebInformation object. For more information about this object, see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataContextWebInformation" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataContextWebInformation " } ], "releaseTag": "Public", @@ -254,16 +203,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "LibraryVersion", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member", "docComment": "/**\n * Example: `\"16.0.4919.3000\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "LibraryVersion" - }, { "kind": "Content", - "text": ": " + "text": "LibraryVersion: " }, { "kind": "Content", @@ -277,22 +222,18 @@ "releaseTag": "Public", "name": "LibraryVersion", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "SiteFullUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member", "docComment": "/**\n * Example: `\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "SiteFullUrl" - }, { "kind": "Content", - "text": ": " + "text": "SiteFullUrl: " }, { "kind": "Content", @@ -306,22 +247,18 @@ "releaseTag": "Public", "name": "SiteFullUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "SupportedSchemaVersions", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member", "docComment": "/**\n * Example: `[ \"14.0.0.0\", \"15.0.0.0\" ]`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "SupportedSchemaVersions" - }, { "kind": "Content", - "text": ": " + "text": "SupportedSchemaVersions: " }, { "kind": "Content", @@ -335,22 +272,18 @@ "releaseTag": "Public", "name": "SupportedSchemaVersions", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "WebFullUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member", "docComment": "/**\n * Example: `\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "WebFullUrl" - }, { "kind": "Content", - "text": ": " + "text": "WebFullUrl: " }, { "kind": "Content", @@ -364,8 +297,8 @@ "releaseTag": "Public", "name": "WebFullUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -373,20 +306,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataList:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataList:interface", "docComment": "/**\n * Represents an OData SP.List object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataList" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataList " } ], "releaseTag": "Public", @@ -394,16 +319,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "BaseTemplate", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#BaseTemplate:member", "docComment": "/**\n * The list definition type on which the list is based.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "BaseTemplate" - }, { "kind": "Content", - "text": ": " + "text": "BaseTemplate: " }, { "kind": "Content", @@ -417,22 +338,18 @@ "releaseTag": "Public", "name": "BaseTemplate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Created", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Created:member", "docComment": "/**\n * Example: `\"/Date(1453294804000)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Created" - }, { "kind": "Content", - "text": ": " + "text": "Created: " }, { "kind": "Content", @@ -446,26 +363,23 @@ "releaseTag": "Public", "name": "Created", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "CurrentChangeToken", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member", "docComment": "/**\n * The change token that will be used in logging the next change to the list.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "CurrentChangeToken" - }, { "kind": "Content", - "text": ": " + "text": "CurrentChangeToken: " }, { "kind": "Reference", - "text": "IODataChangeToken" + "text": "IODataChangeToken", + "canonicalReference": "@microsoft/sp-odata-types!IODataChangeToken:interface" }, { "kind": "Content", @@ -475,22 +389,18 @@ "releaseTag": "Public", "name": "CurrentChangeToken", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Description", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Description:member", "docComment": "/**\n * A description of the List.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Description" - }, { "kind": "Content", - "text": ": " + "text": "Description: " }, { "kind": "Content", @@ -504,22 +414,18 @@ "releaseTag": "Public", "name": "Description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "EntityTypeName", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#EntityTypeName:member", "docComment": "/**\n * Example: `\"MyListTitleList\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "EntityTypeName" - }, { "kind": "Content", - "text": ": " + "text": "EntityTypeName: " }, { "kind": "Content", @@ -533,22 +439,18 @@ "releaseTag": "Public", "name": "EntityTypeName", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Hidden", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Hidden:member", "docComment": "/**\n * A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Hidden" - }, { "kind": "Content", - "text": ": " + "text": "Hidden: " }, { "kind": "Content", @@ -562,22 +464,18 @@ "releaseTag": "Public", "name": "Hidden", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Id", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Id:member", "docComment": "/**\n * Example: `\"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Id" - }, { "kind": "Content", - "text": ": " + "text": "Id: " }, { "kind": "Content", @@ -591,22 +489,18 @@ "releaseTag": "Public", "name": "Id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "LastItemDeletedDate", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member", "docComment": "/**\n * Example: `\"/Date(1453294809000)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "LastItemDeletedDate" - }, { "kind": "Content", - "text": ": " + "text": "LastItemDeletedDate: " }, { "kind": "Content", @@ -620,22 +514,18 @@ "releaseTag": "Public", "name": "LastItemDeletedDate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "LastItemModifiedDate", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member", "docComment": "/**\n * Example: `\"/Date(1453294809000)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "LastItemModifiedDate" - }, { "kind": "Content", - "text": ": " + "text": "LastItemModifiedDate: " }, { "kind": "Content", @@ -649,22 +539,18 @@ "releaseTag": "Public", "name": "LastItemModifiedDate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ListItemEntityTypeFullName", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member", "docComment": "/**\n * Example: `\"SP.Data.MyListTitleListItem\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ListItemEntityTypeFullName" - }, { "kind": "Content", - "text": ": " + "text": "ListItemEntityTypeFullName: " }, { "kind": "Content", @@ -678,22 +564,18 @@ "releaseTag": "Public", "name": "ListItemEntityTypeFullName", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ParentWebUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#ParentWebUrl:member", "docComment": "/**\n * Example: `\"/sites/PubSite\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ParentWebUrl" - }, { "kind": "Content", - "text": ": " + "text": "ParentWebUrl: " }, { "kind": "Content", @@ -707,22 +589,18 @@ "releaseTag": "Public", "name": "ParentWebUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "TemplateFeatureId", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member", "docComment": "/**\n * Example: `\"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "TemplateFeatureId" - }, { "kind": "Content", - "text": ": " + "text": "TemplateFeatureId: " }, { "kind": "Content", @@ -736,22 +614,18 @@ "releaseTag": "Public", "name": "TemplateFeatureId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Title", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Title:member", "docComment": "/**\n * Example: `\"Pages\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Title" - }, { "kind": "Content", - "text": ": " + "text": "Title: " }, { "kind": "Content", @@ -765,8 +639,8 @@ "releaseTag": "Public", "name": "Title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -774,20 +648,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataListItem:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem:interface", "docComment": "/**\n * Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataListItem" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataListItem " } ], "releaseTag": "Public", @@ -795,28 +661,16 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "ContentTypeId", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member", "docComment": "/**\n * Example: `{ StringValue: \"0x010100C5...\" }`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ContentTypeId" - }, - { - "kind": "Content", - "text": ": " - }, { "kind": "Content", - "text": "{\n " - }, - { - "kind": "Reference", - "text": "StringValue" + "text": "ContentTypeId: " }, { "kind": "Content", - "text": ": string;\n }" + "text": "{\n StringValue: string;\n }" }, { "kind": "Content", @@ -826,22 +680,18 @@ "releaseTag": "Public", "name": "ContentTypeId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ID", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#ID:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "ID" - }, { "kind": "Content", - "text": ": " + "text": "ID: " }, { "kind": "Content", @@ -855,22 +705,18 @@ "releaseTag": "Public", "name": "ID", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Title", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#Title:member", "docComment": "/**\n * Title of the List Item\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Title" - }, { "kind": "Content", - "text": ": " + "text": "Title: " }, { "kind": "Content", @@ -884,22 +730,18 @@ "releaseTag": "Public", "name": "Title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "UniqueId", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#UniqueId:member", "docComment": "/**\n * Example: `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "UniqueId" - }, { "kind": "Content", - "text": ": " + "text": "UniqueId: " }, { "kind": "Content", @@ -913,8 +755,8 @@ "releaseTag": "Public", "name": "UniqueId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -922,20 +764,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataNavigationNode:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface", "docComment": "/**\n * Represents an OData SP.NavigationNode object. {@link https://msdn.microsoft.com/en-us/library/office/jj246311.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataNavigationNode" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataNavigationNode " } ], "releaseTag": "Public", @@ -943,20 +777,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "Children", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#Children:member", "docComment": "/**\n * Gets or sets an array of Navigation Nodes that are children to the current node.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Children" - }, { "kind": "Content", - "text": "?: " + "text": "Children?: " }, { "kind": "Reference", - "text": "IODataNavigationNode" + "text": "IODataNavigationNode", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface" }, { "kind": "Content", @@ -970,22 +801,18 @@ "releaseTag": "Public", "name": "Children", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 } }, { "kind": "PropertySignature", - "canonicalReference": "Id", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#Id:member", "docComment": "/**\n * Gets a value that specifies the identifier for the navigation node.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Id" - }, { "kind": "Content", - "text": "?: " + "text": "Id?: " }, { "kind": "Content", @@ -999,22 +826,18 @@ "releaseTag": "Public", "name": "Id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "IsDocLib", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "IsDocLib" - }, { "kind": "Content", - "text": "?: " + "text": "IsDocLib?: " }, { "kind": "Content", @@ -1028,22 +851,18 @@ "releaseTag": "Public", "name": "IsDocLib", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "IsExternal", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member", "docComment": "/**\n * Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "IsExternal" - }, { "kind": "Content", - "text": "?: " + "text": "IsExternal?: " }, { "kind": "Content", @@ -1057,22 +876,18 @@ "releaseTag": "Public", "name": "IsExternal", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "IsVisible", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member", "docComment": "/**\n * Gets or sets a value that specifies if the node navigation link should be visible.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "IsVisible" - }, { "kind": "Content", - "text": "?: " + "text": "IsVisible?: " }, { "kind": "Content", @@ -1086,22 +901,18 @@ "releaseTag": "Public", "name": "IsVisible", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Title", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#Title:member", "docComment": "/**\n * Gets or sets a value that specifies the anchor text for the node navigation link.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Title" - }, { "kind": "Content", - "text": "?: " + "text": "Title?: " }, { "kind": "Content", @@ -1115,22 +926,18 @@ "releaseTag": "Public", "name": "Title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Url", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#Url:member", "docComment": "/**\n * Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Url" - }, { "kind": "Content", - "text": "?: " + "text": "Url?: " }, { "kind": "Content", @@ -1144,8 +951,8 @@ "releaseTag": "Public", "name": "Url", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1153,20 +960,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataNavigationNodeCollection:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface", "docComment": "/**\n * Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. {@link https://msdn.microsoft.com/en-us/library/office/ee557907.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataNavigationNodeCollection" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataNavigationNodeCollection " } ], "releaseTag": "Public", @@ -1174,20 +973,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "quickLaunch", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member", "docComment": "/**\n * Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "quickLaunch" - }, { "kind": "Content", - "text": ": " + "text": "quickLaunch: " }, { "kind": "Reference", - "text": "IODataNavigationNode" + "text": "IODataNavigationNode", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface" }, { "kind": "Content", @@ -1201,26 +997,23 @@ "releaseTag": "Public", "name": "quickLaunch", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 } }, { "kind": "PropertySignature", - "canonicalReference": "topNav", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member", "docComment": "/**\n * Gets an SPNavigationNode object that contains the nodes in the top link bar for the website.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "topNav" - }, { "kind": "Content", - "text": ": " + "text": "topNav: " }, { "kind": "Reference", - "text": "IODataNavigationNode" + "text": "IODataNavigationNode", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface" }, { "kind": "Content", @@ -1234,8 +1027,8 @@ "releaseTag": "Public", "name": "topNav", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 3 } } ], @@ -1243,20 +1036,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataUser:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser:interface", "docComment": "/**\n * Represents an OData SP.User object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataUser" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataUser " } ], "releaseTag": "Public", @@ -1264,16 +1049,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "Email", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#Email:member", "docComment": "/**\n * Example: `\"someone@example.com\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Email" - }, { "kind": "Content", - "text": ": " + "text": "Email: " }, { "kind": "Content", @@ -1287,22 +1068,18 @@ "releaseTag": "Public", "name": "Email", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Id", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#Id:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Id" - }, { "kind": "Content", - "text": ": " + "text": "Id: " }, { "kind": "Content", @@ -1316,22 +1093,18 @@ "releaseTag": "Public", "name": "Id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "IsSiteAdmin", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member", "docComment": "/**\n * Boolean value that specifies whether the user is a site collection administrator.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "IsSiteAdmin" - }, { "kind": "Content", - "text": ": " + "text": "IsSiteAdmin: " }, { "kind": "Content", @@ -1345,22 +1118,18 @@ "releaseTag": "Public", "name": "IsSiteAdmin", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "LoginName", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#LoginName:member", "docComment": "/**\n * Example: `\"i:0#.w|domain\\user\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "LoginName" - }, { "kind": "Content", - "text": ": " + "text": "LoginName: " }, { "kind": "Content", @@ -1374,22 +1143,18 @@ "releaseTag": "Public", "name": "LoginName", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "PrincipalType", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#PrincipalType:member", "docComment": "/**\n * This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.\n *\n * @remarks\n *\n * Values:\n *\n * None: 0\n *\n * User: 1\n *\n * DistributionList: 2\n *\n * SecurityGroup: 4\n *\n * SharePointGroup: 8\n *\n * All: 15\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "PrincipalType" - }, { "kind": "Content", - "text": ": " + "text": "PrincipalType: " }, { "kind": "Content", @@ -1403,22 +1168,18 @@ "releaseTag": "Public", "name": "PrincipalType", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Title", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#Title:member", "docComment": "/**\n * Example: `\"DOMAIN\\user\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Title" - }, { "kind": "Content", - "text": ": " + "text": "Title: " }, { "kind": "Content", @@ -1432,26 +1193,23 @@ "releaseTag": "Public", "name": "Title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "UserId", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#UserId:member", "docComment": "/**\n * Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "UserId" - }, { "kind": "Content", - "text": ": " + "text": "UserId: " }, { "kind": "Reference", - "text": "IODataUserId" + "text": "IODataUserId", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserId:interface" }, { "kind": "Content", @@ -1461,8 +1219,8 @@ "releaseTag": "Public", "name": "UserId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1470,20 +1228,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataUserCustomAction:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction:interface", "docComment": "/**\n * Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataUserCustomAction" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataUserCustomAction " } ], "releaseTag": "Public", @@ -1491,16 +1241,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "ClientSideComponentId", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member", "docComment": "/**\n * The unique identifier of the client-side component defined with SharePoint Framework\n *\n * @remarks\n *\n * Example: `\"359af2a7-b73c-4aac-874c-60a865da0be7\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ClientSideComponentId" - }, { "kind": "Content", - "text": ": " + "text": "ClientSideComponentId: " }, { "kind": "Content", @@ -1514,22 +1260,18 @@ "releaseTag": "Public", "name": "ClientSideComponentId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ClientSideComponentProperties", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member", "docComment": "/**\n * Custom initialization properties for the client-side component.\n *\n * @remarks\n *\n * This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component.\n *\n * Example: `\"{ \\\"maxItemsToShow\\\": 123 }\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ClientSideComponentProperties" - }, { "kind": "Content", - "text": ": " + "text": "ClientSideComponentProperties: " }, { "kind": "Content", @@ -1543,22 +1285,18 @@ "releaseTag": "Public", "name": "ClientSideComponentProperties", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "CommandUIExtension", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member", "docComment": "/**\n * Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "CommandUIExtension" - }, { "kind": "Content", - "text": ": " + "text": "CommandUIExtension: " }, { "kind": "Content", @@ -1572,22 +1310,18 @@ "releaseTag": "Public", "name": "CommandUIExtension", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Description", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Description:member", "docComment": "/**\n * Gets or sets the description of the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Description" - }, { "kind": "Content", - "text": ": " + "text": "Description: " }, { "kind": "Content", @@ -1601,22 +1335,18 @@ "releaseTag": "Public", "name": "Description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Group", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Group:member", "docComment": "/**\n * Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Group" - }, { "kind": "Content", - "text": ": " + "text": "Group: " }, { "kind": "Content", @@ -1630,22 +1360,18 @@ "releaseTag": "Public", "name": "Group", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Id", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Id:member", "docComment": "/**\n * Gets a value that specifies the identifier (GUID) of the custom action. Example: `\"48309f28-53aa-43ed-b113-625120e5af6f\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Id" - }, { "kind": "Content", - "text": ": " + "text": "Id: " }, { "kind": "Content", @@ -1659,22 +1385,18 @@ "releaseTag": "Public", "name": "Id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ImageUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member", "docComment": "/**\n * Gets or sets the URL of the image associated with the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ImageUrl" - }, { "kind": "Content", - "text": ": " + "text": "ImageUrl: " }, { "kind": "Content", @@ -1688,22 +1410,18 @@ "releaseTag": "Public", "name": "ImageUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Location", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Location:member", "docComment": "/**\n * Gets or sets the location of the custom action.\n *\n * @remarks\n *\n * Example: `\"ClientSide.Application\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Location" - }, { "kind": "Content", - "text": ": " + "text": "Location: " }, { "kind": "Content", @@ -1717,22 +1435,18 @@ "releaseTag": "Public", "name": "Location", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "RegistrationId", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member", "docComment": "/**\n * Gets or sets the value that specifies the identifier of the object associated with the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "RegistrationId" - }, { "kind": "Content", - "text": ": " + "text": "RegistrationId: " }, { "kind": "Content", @@ -1746,22 +1460,18 @@ "releaseTag": "Public", "name": "RegistrationId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "RegistrationType", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member", "docComment": "/**\n * Gets or sets the value that specifies the type of object associated with the custom action.\n *\n * @remarks\n *\n * Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "RegistrationType" - }, { "kind": "Content", - "text": ": " + "text": "RegistrationType: " }, { "kind": "Content", @@ -1775,26 +1485,23 @@ "releaseTag": "Public", "name": "RegistrationType", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Rights", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member", "docComment": "/**\n * Gets or sets the value that specifies the permissions needed for the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Rights" - }, { "kind": "Content", - "text": ": " + "text": "Rights: " }, { "kind": "Reference", - "text": "IODataBasePermission" + "text": "IODataBasePermission", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface" }, { "kind": "Content", @@ -1804,22 +1511,18 @@ "releaseTag": "Public", "name": "Rights", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Scope", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member", "docComment": "/**\n * Gets a value that specifies the scope of the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Scope" - }, { "kind": "Content", - "text": ": " + "text": "Scope: " }, { "kind": "Content", @@ -1833,22 +1536,18 @@ "releaseTag": "Public", "name": "Scope", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ScriptBlock", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member", "docComment": "/**\n * Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ScriptBlock" - }, { "kind": "Content", - "text": ": " + "text": "ScriptBlock: " }, { "kind": "Content", @@ -1862,22 +1561,18 @@ "releaseTag": "Public", "name": "ScriptBlock", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ScriptSrc", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member", "docComment": "/**\n * Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ScriptSrc" - }, { "kind": "Content", - "text": ": " + "text": "ScriptSrc: " }, { "kind": "Content", @@ -1891,22 +1586,18 @@ "releaseTag": "Public", "name": "ScriptSrc", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Sequence", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member", "docComment": "/**\n * Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Sequence" - }, { "kind": "Content", - "text": ": " + "text": "Sequence: " }, { "kind": "Content", @@ -1920,22 +1611,18 @@ "releaseTag": "Public", "name": "Sequence", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Title", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Title:member", "docComment": "/**\n * Gets or sets the display title of the custom action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Title" - }, { "kind": "Content", - "text": ": " + "text": "Title: " }, { "kind": "Content", @@ -1949,22 +1636,18 @@ "releaseTag": "Public", "name": "Title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Url", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Url:member", "docComment": "/**\n * Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Url" - }, { "kind": "Content", - "text": ": " + "text": "Url: " }, { "kind": "Content", @@ -1978,22 +1661,18 @@ "releaseTag": "Public", "name": "Url", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "VersionOfUserCustomAction", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member", "docComment": "/**\n * Gets a value that specifies an implementation specific version identifier.\n *\n * @remarks\n *\n * Example: `\"16.0.1.0\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "VersionOfUserCustomAction" - }, { "kind": "Content", - "text": ": " + "text": "VersionOfUserCustomAction: " }, { "kind": "Content", @@ -2007,8 +1686,8 @@ "releaseTag": "Public", "name": "VersionOfUserCustomAction", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2016,20 +1695,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IODataWeb:interface)", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb:interface", "docComment": "/**\n * Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IODataWeb" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IODataWeb " } ], "releaseTag": "Public", @@ -2037,16 +1708,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "Created", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Created:member", "docComment": "/**\n * Gets a value that specifies when the site was created.\n *\n * Example: `\"/Date(2016,0,20,12,58,7,0)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Created" - }, { "kind": "Content", - "text": "?: " + "text": "Created?: " }, { "kind": "Content", @@ -2060,26 +1727,23 @@ "releaseTag": "Public", "name": "Created", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "CurrentChangeToken", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member", "docComment": "/**\n * Represents the unique sequential location of a change within the change log.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "CurrentChangeToken" - }, { "kind": "Content", - "text": "?: " + "text": "CurrentChangeToken?: " }, { "kind": "Reference", - "text": "IODataChangeToken" + "text": "IODataChangeToken", + "canonicalReference": "@microsoft/sp-odata-types!IODataChangeToken:interface" }, { "kind": "Content", @@ -2089,22 +1753,18 @@ "releaseTag": "Public", "name": "CurrentChangeToken", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "CustomMasterUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member", "docComment": "/**\n * Gets or sets the URL for a custom master page file to apply to the website.\n *\n * Example: `\"/sites/PubSite/_catalogs/masterpage/seattle.master\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "CustomMasterUrl" - }, { "kind": "Content", - "text": "?: " + "text": "CustomMasterUrl?: " }, { "kind": "Content", @@ -2118,22 +1778,18 @@ "releaseTag": "Public", "name": "CustomMasterUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Description", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Description:member", "docComment": "/**\n * Gets or sets the description for the site.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Description" - }, { "kind": "Content", - "text": "?: " + "text": "Description?: " }, { "kind": "Content", @@ -2147,22 +1803,18 @@ "releaseTag": "Public", "name": "Description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Id", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Id:member", "docComment": "/**\n * Gets a value that specifies the site identifier for the site.\n *\n * Example: `\"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Id" - }, { "kind": "Content", - "text": "?: " + "text": "Id?: " }, { "kind": "Content", @@ -2176,22 +1828,18 @@ "releaseTag": "Public", "name": "Id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "IsMultilingual", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member", "docComment": "/**\n * Value that represents if the web was\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "IsMultilingual" - }, { "kind": "Content", - "text": "?: " + "text": "IsMultilingual?: " }, { "kind": "Content", @@ -2205,22 +1853,18 @@ "releaseTag": "Public", "name": "IsMultilingual", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Language", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Language:member", "docComment": "/**\n * Gets a value that specifies the LCID for the language that is used on the site.\n *\n * Example: `1033`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Language" - }, { "kind": "Content", - "text": "?: " + "text": "Language?: " }, { "kind": "Content", @@ -2234,22 +1878,18 @@ "releaseTag": "Public", "name": "Language", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "LastItemModifiedDate", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member", "docComment": "/**\n * Gets a value that specifies when an item was last modified in the site.\n *\n * Example: `\"/Date(1453618828000)/\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "LastItemModifiedDate" - }, { "kind": "Content", - "text": "?: " + "text": "LastItemModifiedDate?: " }, { "kind": "Content", @@ -2263,22 +1903,18 @@ "releaseTag": "Public", "name": "LastItemModifiedDate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "MasterUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#MasterUrl:member", "docComment": "/**\n * Gets or sets the URL of the master page that is used for the website.\n *\n * Example: `\"/sites/PubSite/_catalogs/masterpage/seattle.master\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "MasterUrl" - }, { "kind": "Content", - "text": "?: " + "text": "MasterUrl?: " }, { "kind": "Content", @@ -2292,22 +1928,18 @@ "releaseTag": "Public", "name": "MasterUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "NoCrawl", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#NoCrawl:member", "docComment": "/**\n * Determines if a particular web will be crawled by search or not.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "NoCrawl" - }, { "kind": "Content", - "text": "?: " + "text": "NoCrawl?: " }, { "kind": "Content", @@ -2321,22 +1953,18 @@ "releaseTag": "Public", "name": "NoCrawl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "QuickLaunchEnabled", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member", "docComment": "/**\n * Gets or sets a value that specifies whether the Quick Launch area is enabled on the site.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "QuickLaunchEnabled" - }, { "kind": "Content", - "text": "?: " + "text": "QuickLaunchEnabled?: " }, { "kind": "Content", @@ -2350,22 +1978,18 @@ "releaseTag": "Public", "name": "QuickLaunchEnabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "RecycleBinEnabled", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member", "docComment": "/**\n * Gets or sets a value that determines whether the recycle bin is enabled for the website.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "RecycleBinEnabled" - }, { "kind": "Content", - "text": "?: " + "text": "RecycleBinEnabled?: " }, { "kind": "Content", @@ -2379,22 +2003,18 @@ "releaseTag": "Public", "name": "RecycleBinEnabled", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "ServerRelativeUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member", "docComment": "/**\n * Gets or sets the server-relative URL for the Web site.\n *\n * Example: `\"/sites/PubSite\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ServerRelativeUrl" - }, { "kind": "Content", - "text": "?: " + "text": "ServerRelativeUrl?: " }, { "kind": "Content", @@ -2408,22 +2028,18 @@ "releaseTag": "Public", "name": "ServerRelativeUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "SiteLogoUrl", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member", "docComment": "/**\n * Gets the url for the logo of this particular site.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "SiteLogoUrl" - }, { "kind": "Content", - "text": "?: " + "text": "SiteLogoUrl?: " }, { "kind": "Content", @@ -2437,22 +2053,18 @@ "releaseTag": "Public", "name": "SiteLogoUrl", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Title", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Title:member", "docComment": "/**\n * The title of the web.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Title" - }, { "kind": "Content", - "text": "?: " + "text": "Title?: " }, { "kind": "Content", @@ -2466,22 +2078,18 @@ "releaseTag": "Public", "name": "Title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "UIVersion", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#UIVersion:member", "docComment": "/**\n * Gets or sets the user interface (UI) version of the Web site.\n *\n * Example: `15`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "UIVersion" - }, { "kind": "Content", - "text": "?: " + "text": "UIVersion?: " }, { "kind": "Content", @@ -2495,22 +2103,18 @@ "releaseTag": "Public", "name": "UIVersion", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Url", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Url:member", "docComment": "/**\n * Gets the absolute URL for the website.\n *\n * Example: `\"http://example.com/sites/PubSite\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Url" - }, { "kind": "Content", - "text": "?: " + "text": "Url?: " }, { "kind": "Content", @@ -2524,22 +2128,18 @@ "releaseTag": "Public", "name": "Url", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "WebTemplate", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#WebTemplate:member", "docComment": "/**\n * Gets the name of the site definition or site template that was used to create the site.\n *\n * Example: `\"BLANKINTERNET\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "WebTemplate" - }, { "kind": "Content", - "text": "?: " + "text": "WebTemplate?: " }, { "kind": "Content", @@ -2553,8 +2153,8 @@ "releaseTag": "Public", "name": "WebTemplate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], diff --git a/generate-docs/json/sp-page-context.api.json b/generate-docs/json/sp-page-context.api.json index 3fd23fd4..590d8a7e 100644 --- a/generate-docs/json/sp-page-context.api.json +++ b/generate-docs/json/sp-page-context.api.json @@ -1,35 +1,28 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-page-context", + "canonicalReference": "@microsoft/sp-page-context!", "docComment": "/**\n * Page context services for the SharePoint Framework\n *\n * @remarks\n *\n * The page context allows an application and its web parts to share common data about the current page, such as its contents, URL, list, user, permissions, navigation menu, etc.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-page-context", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-page-context!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(CultureInfo:class)", + "canonicalReference": "@microsoft/sp-page-context!CultureInfo:class", "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides culture info for the current user of the application.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CultureInfo` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "CultureInfo" - }, - { - "kind": "Content", - "text": " " + "text": "export default class CultureInfo " } ], "releaseTag": "Public", @@ -37,20 +30,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(currentCultureName:instance)", + "canonicalReference": "@microsoft/sp-page-context!CultureInfo#currentCultureName:member", "docComment": "/**\n * This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons.\n *\n * @remarks\n *\n * This property may be an empty string, but it will never be undefined.\n *\n * Example: If the currentCultureName is `\"en-AU\"` then the application could use this information to display the date as 1/8 instead of 8/1.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "currentCultureName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly currentCultureName: " }, { "kind": "Content", @@ -64,27 +49,19 @@ "releaseTag": "Public", "name": "currentCultureName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(currentUICultureName:instance)", + "canonicalReference": "@microsoft/sp-page-context!CultureInfo#currentUICultureName:member", "docComment": "/**\n * This string determines the default user interface language. This used for localization and translation of text.\n *\n * @remarks\n *\n * This property may have an empty string, but will never be undefined.\n *\n * Example: If the currentUICultureName is `\"es-MX\"`, then the application could use this information to translate the word \"hello\" to \"hola\".\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "currentUICultureName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly currentUICultureName: " }, { "kind": "Content", @@ -98,27 +75,19 @@ "releaseTag": "Public", "name": "currentUICultureName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isRightToLeft:instance)", + "canonicalReference": "@microsoft/sp-page-context!CultureInfo#isRightToLeft:member", "docComment": "/**\n * This boolean represents the dominant direction of written text for the default user interface language.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isRightToLeft" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isRightToLeft: " }, { "kind": "Content", @@ -132,8 +101,8 @@ "releaseTag": "Public", "name": "isRightToLeft", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -142,20 +111,12 @@ }, { "kind": "Interface", - "canonicalReference": "(ISPSystemTime:interface)", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface", "docComment": "/**\n * Interface that represents a `SPSystemTime` structure.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPSystemTime" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISPSystemTime " } ], "releaseTag": "Beta", @@ -163,16 +124,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "Day", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Day:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Day" - }, { "kind": "Content", - "text": ": " + "text": "Day: " }, { "kind": "Content", @@ -186,22 +143,18 @@ "releaseTag": "Beta", "name": "Day", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "DayOfWeek", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "DayOfWeek" - }, { "kind": "Content", - "text": ": " + "text": "DayOfWeek: " }, { "kind": "Content", @@ -215,22 +168,18 @@ "releaseTag": "Beta", "name": "DayOfWeek", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Hour", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Hour:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Hour" - }, { "kind": "Content", - "text": ": " + "text": "Hour: " }, { "kind": "Content", @@ -244,22 +193,18 @@ "releaseTag": "Beta", "name": "Hour", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Milliseconds", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Milliseconds" - }, { "kind": "Content", - "text": ": " + "text": "Milliseconds: " }, { "kind": "Content", @@ -273,22 +218,18 @@ "releaseTag": "Beta", "name": "Milliseconds", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Minute", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Minute:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Minute" - }, { "kind": "Content", - "text": ": " + "text": "Minute: " }, { "kind": "Content", @@ -302,22 +243,18 @@ "releaseTag": "Beta", "name": "Minute", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Month", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Month:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Month" - }, { "kind": "Content", - "text": ": " + "text": "Month: " }, { "kind": "Content", @@ -331,22 +268,18 @@ "releaseTag": "Beta", "name": "Month", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Second", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Second:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Second" - }, { "kind": "Content", - "text": ": " + "text": "Second: " }, { "kind": "Content", @@ -360,22 +293,18 @@ "releaseTag": "Beta", "name": "Second", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "Year", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Year:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Year" - }, { "kind": "Content", - "text": ": " + "text": "Year: " }, { "kind": "Content", @@ -389,8 +318,8 @@ "releaseTag": "Beta", "name": "Year", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -398,20 +327,12 @@ }, { "kind": "Interface", - "canonicalReference": "(ISPTimeZoneData:interface)", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData:interface", "docComment": "/**\n * Interface that represents the data necessary to build an `TimeZone` object.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISPTimeZoneData" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISPTimeZoneData " } ], "releaseTag": "Beta", @@ -419,20 +340,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "daylightDate", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "daylightDate" - }, { "kind": "Content", - "text": ": " + "text": "daylightDate: " }, { "kind": "Reference", - "text": "ISPSystemTime" + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" }, { "kind": "Content", @@ -442,22 +360,18 @@ "releaseTag": "Beta", "name": "daylightDate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "daylightOffset", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "daylightOffset" - }, { "kind": "Content", - "text": ": " + "text": "daylightOffset: " }, { "kind": "Content", @@ -471,22 +385,18 @@ "releaseTag": "Beta", "name": "daylightOffset", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "description", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#description:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "description" - }, { "kind": "Content", - "text": ": " + "text": "description: " }, { "kind": "Content", @@ -500,22 +410,18 @@ "releaseTag": "Beta", "name": "description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "id", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#id:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "id" - }, { "kind": "Content", - "text": ": " + "text": "id: " }, { "kind": "Content", @@ -529,22 +435,18 @@ "releaseTag": "Beta", "name": "id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "offset", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#offset:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "offset" - }, { "kind": "Content", - "text": ": " + "text": "offset: " }, { "kind": "Content", @@ -558,26 +460,23 @@ "releaseTag": "Beta", "name": "offset", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "standardDate", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "standardDate" - }, { "kind": "Content", - "text": ": " + "text": "standardDate: " }, { "kind": "Reference", - "text": "ISPSystemTime" + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" }, { "kind": "Content", @@ -587,22 +486,18 @@ "releaseTag": "Beta", "name": "standardDate", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "standardOffset", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "standardOffset" - }, { "kind": "Content", - "text": ": " + "text": "standardOffset: " }, { "kind": "Content", @@ -616,8 +511,8 @@ "releaseTag": "Beta", "name": "standardOffset", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -625,20 +520,12 @@ }, { "kind": "Class", - "canonicalReference": "(PageContext:class)", + "canonicalReference": "@microsoft/sp-page-context!PageContext:class", "docComment": "/**\n * The SharePoint page context object.\n *\n * @remarks\n *\n * The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "PageContext" - }, - { - "kind": "Content", - "text": " " + "text": "export default class PageContext " } ], "releaseTag": "Public", @@ -646,24 +533,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-page-context!PageContext:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `PageContext` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" + "text": "constructor(serviceScope: " }, { "kind": "Reference", - "text": "serviceScope" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "ServiceScope" + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" }, { "kind": "Content", @@ -671,37 +551,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "serviceScope", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Property", - "canonicalReference": "(aadInfo:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#aadInfo:member", "docComment": "/**\n * Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "aadInfo" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly aadInfo: " }, { "kind": "Reference", - "text": "AzureActiveDirectoryInfo" + "text": "AzureActiveDirectoryInfo", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -715,31 +588,24 @@ "releaseTag": "Public", "name": "aadInfo", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(cultureInfo:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#cultureInfo:member", "docComment": "/**\n * It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "cultureInfo" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly cultureInfo: " }, { "kind": "Reference", - "text": "CultureInfo" + "text": "CultureInfo", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -749,27 +615,19 @@ "releaseTag": "Public", "name": "cultureInfo", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isInitialized:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#isInitialized:member", "docComment": "/**\n * Returns whether the `PageContext` has been initialized.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isInitialized" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isInitialized: " }, { "kind": "Content", @@ -783,27 +641,19 @@ "releaseTag": "Public", "name": "isInitialized", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(legacyPageContext:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#legacyPageContext:member", "docComment": "/**\n * An object providing classic SharePoint properties that may be required by certain legacy scripts.\n *\n * @remarks\n *\n * This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility guarantees.\n *\n * NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "legacyPageContext" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly legacyPageContext: " }, { "kind": "Content", @@ -817,31 +667,24 @@ "releaseTag": "Public", "name": "legacyPageContext", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(list:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#list:member", "docComment": "/**\n * Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "list" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly list: " }, { "kind": "Reference", - "text": "SPList" + "text": "SPList", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -855,31 +698,24 @@ "releaseTag": "Public", "name": "list", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(listItem:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#listItem:member", "docComment": "/**\n * Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly listItem: " }, { "kind": "Reference", - "text": "listItem" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPListItem" + "text": "SPListItem", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -893,31 +729,24 @@ "releaseTag": "Public", "name": "listItem", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(serviceKey:static)", + "canonicalReference": "@microsoft/sp-page-context!PageContext.serviceKey:member", "docComment": "/**\n * The service key for PageContext.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "serviceKey" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly serviceKey: " }, { "kind": "Reference", - "text": "ServiceKey" + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" }, { "kind": "Content", @@ -925,7 +754,8 @@ }, { "kind": "Reference", - "text": "PageContext" + "text": "PageContext", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -939,31 +769,24 @@ "releaseTag": "Public", "name": "serviceKey", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 5 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(site:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#site:member", "docComment": "/**\n * Contextual information for the SharePoint site collection (\"SPSite\") that is hosting the page.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "site" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly site: " }, { "kind": "Reference", - "text": "SPSite" + "text": "SPSite", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -973,31 +796,24 @@ "releaseTag": "Public", "name": "site", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(user:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#user:member", "docComment": "/**\n * It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "user" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly user: " }, { "kind": "Reference", - "text": "SPUser" + "text": "SPUser", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1007,31 +823,24 @@ "releaseTag": "Public", "name": "user", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(web:instance)", + "canonicalReference": "@microsoft/sp-page-context!PageContext#web:member", "docComment": "/**\n * Contextual information for the SharePoint site (\"SPWeb\") that is hosting the page.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "web" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly web: " }, { "kind": "Reference", - "text": "SPWeb" + "text": "SPWeb", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1041,8 +850,8 @@ "releaseTag": "Public", "name": "web", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -1051,20 +860,12 @@ }, { "kind": "Enum", - "canonicalReference": "(SPDayOfWeek:enum)", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek:enum", "docComment": "/**\n * The enum members represent the seven days of a week.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare const enum " - }, - { - "kind": "Reference", - "text": "SPDayOfWeek" - }, - { - "kind": "Content", - "text": " " + "text": "export declare const enum SPDayOfWeek " } ], "releaseTag": "Beta", @@ -1072,16 +873,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "Friday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Friday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Friday" - }, { "kind": "Content", - "text": " = " + "text": "Friday = " }, { "kind": "Content", @@ -1091,22 +888,18 @@ "releaseTag": "Beta", "name": "Friday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Monday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Monday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Monday" - }, { "kind": "Content", - "text": " = " + "text": "Monday = " }, { "kind": "Content", @@ -1116,22 +909,18 @@ "releaseTag": "Beta", "name": "Monday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Saturday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Saturday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Saturday" - }, { "kind": "Content", - "text": " = " + "text": "Saturday = " }, { "kind": "Content", @@ -1141,22 +930,18 @@ "releaseTag": "Beta", "name": "Saturday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Sunday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Sunday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Sunday" - }, { "kind": "Content", - "text": " = " + "text": "Sunday = " }, { "kind": "Content", @@ -1166,22 +951,18 @@ "releaseTag": "Beta", "name": "Sunday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Thursday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Thursday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Thursday" - }, { "kind": "Content", - "text": " = " + "text": "Thursday = " }, { "kind": "Content", @@ -1191,22 +972,18 @@ "releaseTag": "Beta", "name": "Thursday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Tuesday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Tuesday" - }, { "kind": "Content", - "text": " = " + "text": "Tuesday = " }, { "kind": "Content", @@ -1216,22 +993,18 @@ "releaseTag": "Beta", "name": "Tuesday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Wednesday", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member", "docComment": "", "excerptTokens": [ - { - "kind": "Reference", - "text": "Wednesday" - }, { "kind": "Content", - "text": " = " + "text": "Wednesday = " }, { "kind": "Content", @@ -1241,28 +1014,20 @@ "releaseTag": "Beta", "name": "Wednesday", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Class", - "canonicalReference": "(SPField:class)", + "canonicalReference": "@microsoft/sp-page-context!SPField:class", "docComment": "/**\n * A field represents the data model for a column in SharePoint list view.\n *\n * @remarks\n *\n * This is the client-side equivalent for SharePoint `SPField` class. It is used with the `@microsoft/sp-listview-extensibility` package.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPField` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPField" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPField " } ], "releaseTag": "Public", @@ -1270,24 +1035,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(clientSideComponentId:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#clientSideComponentId:member", "docComment": "/**\n * The unique identifier of the client-side component associated with the field.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "clientSideComponentId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly clientSideComponentId: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -1301,27 +1059,19 @@ "releaseTag": "Public", "name": "clientSideComponentId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(clientSideComponentProperties:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#clientSideComponentProperties:member", "docComment": "/**\n * This property is only used when a `ClientSideComponentId` is specified. It is optional.\n *\n * @remarks\n *\n * If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "clientSideComponentProperties" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly clientSideComponentProperties: " }, { "kind": "Content", @@ -1335,27 +1085,19 @@ "releaseTag": "Public", "name": "clientSideComponentProperties", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(displayName:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#displayName:member", "docComment": "/**\n * The display name of the field. This name is shown as column name in UI.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "displayName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly displayName: " }, { "kind": "Content", @@ -1369,27 +1111,19 @@ "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(fieldType:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#fieldType:member", "docComment": "/**\n * The type of the field represented as a string\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "fieldType" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly fieldType: " }, { "kind": "Content", @@ -1403,31 +1137,24 @@ "releaseTag": "Public", "name": "fieldType", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#id:member", "docComment": "/**\n * The GUID identifier for this field.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly id: " }, { "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -1437,27 +1164,19 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(internalName:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#internalName:member", "docComment": "/**\n * The internal name of the field. This name is usually used to find the field.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "internalName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly internalName: " }, { "kind": "Content", @@ -1471,27 +1190,19 @@ "releaseTag": "Public", "name": "internalName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isRequired:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPField#isRequired:member", "docComment": "/**\n * Whether the field is required for each list item in the list\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isRequired" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isRequired: " }, { "kind": "Content", @@ -1505,8 +1216,8 @@ "releaseTag": "Public", "name": "isRequired", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -1515,20 +1226,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPList:class)", + "canonicalReference": "@microsoft/sp-page-context!SPList:class", "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPList` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPList" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPList " } ], "releaseTag": "Public", @@ -1536,24 +1239,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPList#id:member", "docComment": "/**\n * The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly id: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -1563,31 +1259,24 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(permissions:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPList#permissions:member", "docComment": "/**\n * Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "permissions" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly permissions: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1597,27 +1286,19 @@ "releaseTag": "Public", "name": "permissions", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(serverRelativeUrl:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPList#serverRelativeUrl:member", "docComment": "/**\n * Returns the server-relative URL for this `SPList`.\n *\n * @remarks\n *\n * Example: \"/sites/PubSite\"\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "serverRelativeUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly serverRelativeUrl: " }, { "kind": "Content", @@ -1631,27 +1312,19 @@ "releaseTag": "Public", "name": "serverRelativeUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(title:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPList#title:member", "docComment": "/**\n * Returns the title for this `SPList`.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "title" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly title: " }, { "kind": "Content", @@ -1665,8 +1338,8 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -1675,20 +1348,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPListItem:class)", + "canonicalReference": "@microsoft/sp-page-context!SPListItem:class", "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list item that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPListItem` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPListItem" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPListItem " } ], "releaseTag": "Public", @@ -1696,20 +1361,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPListItem#id:member", "docComment": "/**\n * The number that identifies the `SPListItem` on the server.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly id: " }, { "kind": "Content", @@ -1723,8 +1380,8 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -1733,20 +1390,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPPermission:class)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission:class", "docComment": "/**\n * Used to test whether the current user has a requested set of permissions.\n *\n * @remarks\n *\n * Specifies the built-in permissions available in SharePoint Foundation\n *\n * For more information, see: {@link https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPPermission" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPPermission " } ], "releaseTag": "Public", @@ -1754,24 +1403,17 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `SPPermission` class\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "constructor(" - }, - { - "kind": "Reference", - "text": "value" - }, - { - "kind": "Content", - "text": ": " + "text": "constructor(value: " }, { "kind": "Reference", - "text": "IODataBasePermission" + "text": "IODataBasePermission", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface" }, { "kind": "Content", @@ -1779,37 +1421,30 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Property", - "canonicalReference": "(addAndCustomizePages:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member", "docComment": "/**\n * Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "addAndCustomizePages" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly addAndCustomizePages: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1819,31 +1454,24 @@ "releaseTag": "Public", "name": "addAndCustomizePages", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(addDelPrivateWebParts:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member", "docComment": "/**\n * Add or remove personal web parts on a web part Page.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "addDelPrivateWebParts" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly addDelPrivateWebParts: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1853,31 +1481,24 @@ "releaseTag": "Public", "name": "addDelPrivateWebParts", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(addListItems:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.addListItems:member", "docComment": "/**\n * Add items to lists, add documents to document libraries, and add Web discussion comments.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "addListItems" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly addListItems: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1887,31 +1508,24 @@ "releaseTag": "Public", "name": "addListItems", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(applyStyleSheets:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.applyStyleSheets:member", "docComment": "/**\n * Apply a style sheet (.css file) to the Web site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "applyStyleSheets" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly applyStyleSheets: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1921,31 +1535,24 @@ "releaseTag": "Public", "name": "applyStyleSheets", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(applyThemeAndBorder:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member", "docComment": "/**\n * Apply a theme or borders to the entire Web site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "applyThemeAndBorder" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly applyThemeAndBorder: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1955,31 +1562,24 @@ "releaseTag": "Public", "name": "applyThemeAndBorder", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(approveItems:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.approveItems:member", "docComment": "/**\n * Approve a minor version of a list item or document.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "approveItems" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly approveItems: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -1989,31 +1589,24 @@ "releaseTag": "Public", "name": "approveItems", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(browseDirectories:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.browseDirectories:member", "docComment": "/**\n * Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "browseDirectories" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly browseDirectories: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2023,31 +1616,24 @@ "releaseTag": "Public", "name": "browseDirectories", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(browserUserInfo:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.browserUserInfo:member", "docComment": "/**\n * View information about users of the Web site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "browserUserInfo" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly browserUserInfo: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2057,31 +1643,24 @@ "releaseTag": "Public", "name": "browserUserInfo", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(cancelCheckout:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.cancelCheckout:member", "docComment": "/**\n * Discard or check in a document which is checked out to another user.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "cancelCheckout" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly cancelCheckout: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2091,31 +1670,24 @@ "releaseTag": "Public", "name": "cancelCheckout", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(createAlerts:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.createAlerts:member", "docComment": "/**\n * Create e-mail alerts.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "createAlerts" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly createAlerts: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2125,31 +1697,24 @@ "releaseTag": "Public", "name": "createAlerts", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(createGroups:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.createGroups:member", "docComment": "/**\n * Create a group of users that can be used anywhere within the site collection.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "createGroups" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly createGroups: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2159,31 +1724,24 @@ "releaseTag": "Public", "name": "createGroups", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(createSSCSite:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.createSSCSite:member", "docComment": "/**\n * Create a Web site using Self-Service Site Creation.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "createSSCSite" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly createSSCSite: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2193,31 +1751,24 @@ "releaseTag": "Public", "name": "createSSCSite", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(deleteListItems:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.deleteListItems:member", "docComment": "/**\n * Delete items from a list, documents from a document library, and Web discussion comments in documents.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "deleteListItems" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly deleteListItems: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2227,31 +1778,24 @@ "releaseTag": "Public", "name": "deleteListItems", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(deleteVersions:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.deleteVersions:member", "docComment": "/**\n * Delete past versions of a list item or document.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "deleteVersions" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly deleteVersions: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2261,31 +1805,24 @@ "releaseTag": "Public", "name": "deleteVersions", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(editListItems:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.editListItems:member", "docComment": "/**\n * Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "editListItems" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly editListItems: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2295,31 +1832,24 @@ "releaseTag": "Public", "name": "editListItems", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(editMyUserInfo:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.editMyUserInfo:member", "docComment": "/**\n * Allows a user to change his or her user information, such as adding a picture.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "editMyUserInfo" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly editMyUserInfo: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2329,31 +1859,24 @@ "releaseTag": "Public", "name": "editMyUserInfo", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(emptyMask:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.emptyMask:member", "docComment": "/**\n * Has no permissions on the Web site. Not available through the user interface.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "emptyMask" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly emptyMask: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2363,31 +1886,24 @@ "releaseTag": "Public", "name": "emptyMask", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(enumeratePermissions:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.enumeratePermissions:member", "docComment": "/**\n * Enumerate permissions on the Web site, list, folder, document, or list item.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "enumeratePermissions" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly enumeratePermissions: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2397,31 +1913,24 @@ "releaseTag": "Public", "name": "enumeratePermissions", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(fullMask:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.fullMask:member", "docComment": "/**\n * Has all permissions on the Web site. Not available through the user interface.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "fullMask" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly fullMask: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2431,35 +1940,24 @@ "releaseTag": "Public", "name": "fullMask", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Method", - "canonicalReference": "(hasAllPermissions:instance,0)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)", "docComment": "/**\n * Function for testing whether a given permission mask has all of the requested permissions.\n *\n * @param requestedPerms - Any number of SPPermission objects to be compared against the original\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "hasAllPermissions" - }, { "kind": "Content", - "text": "(..." + "text": "hasAllPermissions(...requestedPerms: " }, { "kind": "Reference", - "text": "requestedPerms" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2480,17 +1978,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 4, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "requestedPerms", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 6 + "startIndex": 1, + "endIndex": 3 } } ], @@ -2498,28 +1996,17 @@ }, { "kind": "Method", - "canonicalReference": "(hasAnyPermissions:instance,0)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)", "docComment": "/**\n * Function for testing whether a given permission mask has any of the requested permissions.\n *\n * @param requestedPerms - Any number of SPPermission objects to be compared against the original\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "hasAnyPermissions" - }, - { - "kind": "Content", - "text": "(..." - }, - { - "kind": "Reference", - "text": "requestedPerms" - }, { "kind": "Content", - "text": ": " + "text": "hasAnyPermissions(...requestedPerms: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2540,17 +2027,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 4, + "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "requestedPerms", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 6 + "startIndex": 1, + "endIndex": 3 } } ], @@ -2558,28 +2045,17 @@ }, { "kind": "Method", - "canonicalReference": "(hasPermission:instance,0)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission#hasPermission:member(1)", "docComment": "/**\n * Function for testing whether a given permission mask has the requested permission.\n *\n * @param requestedPerm - The SPPermission object to be compared against the original\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "hasPermission" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "requestedPerm" - }, { "kind": "Content", - "text": ": " + "text": "hasPermission(requestedPerm: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2596,17 +2072,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "requestedPerm", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2614,24 +2090,17 @@ }, { "kind": "Property", - "canonicalReference": "(layoutsPage:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.layoutsPage:member", "docComment": "/**\n * View the layouts page?\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "layoutsPage" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly layoutsPage: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2641,31 +2110,24 @@ "releaseTag": "Public", "name": "layoutsPage", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(manageAlerts:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.manageAlerts:member", "docComment": "/**\n * Manage alerts for all users of the Web site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "manageAlerts" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly manageAlerts: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2675,31 +2137,24 @@ "releaseTag": "Public", "name": "manageAlerts", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(manageLists:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.manageLists:member", "docComment": "/**\n * Create and delete lists, add or remove columns in a list, and add or remove public views of a list.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "manageLists" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly manageLists: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2709,31 +2164,24 @@ "releaseTag": "Public", "name": "manageLists", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(managePermissions:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.managePermissions:member", "docComment": "/**\n * Create and change permission levels on the Web site and assign permissions to users and groups.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "managePermissions" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly managePermissions: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2743,31 +2191,24 @@ "releaseTag": "Public", "name": "managePermissions", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(managePersonalViews:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.managePersonalViews:member", "docComment": "/**\n * Create, change, and delete personal views of lists.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "managePersonalViews" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly managePersonalViews: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2777,31 +2218,24 @@ "releaseTag": "Public", "name": "managePersonalViews", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(manageSubwebs:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.manageSubwebs:member", "docComment": "/**\n * Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly manageSubwebs: " }, { "kind": "Reference", - "text": "manageSubwebs" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2811,31 +2245,24 @@ "releaseTag": "Public", "name": "manageSubwebs", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(manageWeb:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.manageWeb:member", "docComment": "/**\n * Grant the ability to perform all administration tasks for the Web site as well as manage content.\n *\n * @remarks\n *\n * Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "manageWeb" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly manageWeb: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2845,31 +2272,24 @@ "releaseTag": "Public", "name": "manageWeb", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(open:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.open:member", "docComment": "/**\n * Allow users to open a Web site, list, or folder to access items inside that container.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "open" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly open: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2879,31 +2299,24 @@ "releaseTag": "Public", "name": "open", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(openItems:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.openItems:member", "docComment": "/**\n * View the source of documents with server-side file handlers.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "openItems" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly openItems: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2913,31 +2326,24 @@ "releaseTag": "Public", "name": "openItems", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(updatePersonalWebParts:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member", "docComment": "/**\n * Update web parts to display personalized information.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly updatePersonalWebParts: " }, { "kind": "Reference", - "text": "updatePersonalWebParts" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2947,31 +2353,24 @@ "releaseTag": "Public", "name": "updatePersonalWebParts", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(useClientIntegration:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.useClientIntegration:member", "docComment": "/**\n * Use features that launch client applications; otherwise, users must work on documents locally and upload changes.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "useClientIntegration" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly useClientIntegration: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -2981,31 +2380,24 @@ "releaseTag": "Public", "name": "useClientIntegration", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(useRemoteAPIs:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member", "docComment": "/**\n * Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly useRemoteAPIs: " }, { "kind": "Reference", - "text": "useRemoteAPIs" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3015,31 +2407,24 @@ "releaseTag": "Public", "name": "useRemoteAPIs", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(value:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission#value:member", "docComment": "/**\n * Returns the value of this SPPermission object\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly value: " }, { "kind": "Reference", - "text": "value" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IODataBasePermission" + "text": "IODataBasePermission", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface" }, { "kind": "Content", @@ -3049,31 +2434,24 @@ "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(viewFormPages:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewFormPages:member", "docComment": "/**\n * View forms, views, and application pages, and enumerate lists.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly viewFormPages: " }, { "kind": "Reference", - "text": "viewFormPages" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3083,31 +2461,24 @@ "releaseTag": "Public", "name": "viewFormPages", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(viewListItems:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewListItems:member", "docComment": "/**\n * View items in lists, documents in document libraries, and view Web discussion comments.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "viewListItems" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly viewListItems: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3117,31 +2488,24 @@ "releaseTag": "Public", "name": "viewListItems", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(viewPages:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewPages:member", "docComment": "/**\n * View pages in a Web site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "viewPages" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly viewPages: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3151,31 +2515,24 @@ "releaseTag": "Public", "name": "viewPages", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(viewUsageData:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewUsageData:member", "docComment": "/**\n * View reports on Web site usage.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " - }, - { - "kind": "Reference", - "text": "viewUsageData" - }, - { - "kind": "Content", - "text": ": " + "text": "static readonly viewUsageData: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3185,31 +2542,24 @@ "releaseTag": "Public", "name": "viewUsageData", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true }, { "kind": "Property", - "canonicalReference": "(viewVersions:static)", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewVersions:member", "docComment": "/**\n * View past versions of a list item or document.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "static readonly " + "text": "static readonly viewVersions: " }, { "kind": "Reference", - "text": "viewVersions" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3219,8 +2569,8 @@ "releaseTag": "Public", "name": "viewVersions", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": true } @@ -3229,20 +2579,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPSite:class)", + "canonicalReference": "@microsoft/sp-page-context!SPSite:class", "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site collection (\"SPSite\") that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPSite` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPSite" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPSite " } ], "releaseTag": "Public", @@ -3250,20 +2592,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(absoluteUrl:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#absoluteUrl:member", "docComment": "/**\n * Returns the absolute URL for this SPSite.\n *\n * @remarks\n *\n * Example: \"https://example.com/sites/PubSite\"\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "absoluteUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly absoluteUrl: " }, { "kind": "Content", @@ -3277,27 +2611,19 @@ "releaseTag": "Public", "name": "absoluteUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(cdnPrefix:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#cdnPrefix:member", "docComment": "/**\n * Returns the prefix of the application's specified cdn or an empty string if there isn't one.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "cdnPrefix" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly cdnPrefix: " }, { "kind": "Content", @@ -3311,27 +2637,19 @@ "releaseTag": "Public", "name": "cdnPrefix", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(classification:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#classification:member", "docComment": "/**\n * Returns the classification of the site.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "classification" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly classification: " }, { "kind": "Content", @@ -3345,31 +2663,24 @@ "releaseTag": "Public", "name": "classification", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(correlationId:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#correlationId:member", "docComment": "/**\n * Returns the correlation id to the current server request.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "correlationId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly correlationId: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -3379,31 +2690,24 @@ "releaseTag": "Public", "name": "correlationId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(group:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#group:member", "docComment": "/**\n * Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "group" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly group: " }, { "kind": "Reference", - "text": "O365GroupAssociation" + "text": "O365GroupAssociation", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -3417,31 +2721,24 @@ "releaseTag": "Public", "name": "group", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#id:member", "docComment": "/**\n * The GUID that identifies the SPSite on the server.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly id: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -3451,27 +2748,19 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isNoScriptEnabled:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member", "docComment": "/**\n * Returns true if isNoScript has been enabled on the SPSite.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isNoScriptEnabled" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isNoScriptEnabled: " }, { "kind": "Content", @@ -3485,27 +2774,19 @@ "releaseTag": "Public", "name": "isNoScriptEnabled", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(recycleBinItemCount:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#recycleBinItemCount:member", "docComment": "/**\n * The amount of items in the recycle bin.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "recycleBinItemCount" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly recycleBinItemCount: " }, { "kind": "Content", @@ -3519,27 +2800,19 @@ "releaseTag": "Public", "name": "recycleBinItemCount", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(serverRelativeUrl:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#serverRelativeUrl:member", "docComment": "/**\n * Returns the server-relative URL for this SPSite.\n *\n * @remarks\n *\n * Example: \"/sites/PubSite\"\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "serverRelativeUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly serverRelativeUrl: " }, { "kind": "Content", @@ -3553,27 +2826,19 @@ "releaseTag": "Public", "name": "serverRelativeUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(serverRequestPath:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#serverRequestPath:member", "docComment": "/**\n * Returns serverRelativeUrl of the original request.\n *\n * @remarks\n *\n * Example: \"/teams/SPClientTest/SitePages/Home.aspx\"\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "serverRequestPath" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly serverRequestPath: " }, { "kind": "Content", @@ -3587,27 +2852,19 @@ "releaseTag": "Public", "name": "serverRequestPath", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(sitePagesEnabled:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPSite#sitePagesEnabled:member", "docComment": "/**\n * Returns true if SitePages are enabled on this SPSite.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "sitePagesEnabled" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly sitePagesEnabled: " }, { "kind": "Content", @@ -3621,8 +2878,8 @@ "releaseTag": "Public", "name": "sitePagesEnabled", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -3631,20 +2888,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPTimeZone:class)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone:class", "docComment": "/**\n * It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula.\n *\n * @remarks\n * ```\n * isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate\n * LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset)\n * June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)\n * ```\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPTimeZone` class.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPTimeZone" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPTimeZone " } ], "releaseTag": "Beta", @@ -3652,24 +2901,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(daylightDate:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#daylightDate:member", "docComment": "/**\n * Gets the date on which daylight time begins for the time zone.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "daylightDate" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly daylightDate: " }, { "kind": "Reference", - "text": "ISPSystemTime" + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" }, { "kind": "Content", @@ -3679,27 +2921,19 @@ "releaseTag": "Beta", "name": "daylightDate", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(daylightOffset:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#daylightOffset:member", "docComment": "/**\n * Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC).\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "daylightOffset" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly daylightOffset: " }, { "kind": "Content", @@ -3713,27 +2947,19 @@ "releaseTag": "Beta", "name": "daylightOffset", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(description:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#description:member", "docComment": "/**\n * Gets the description for the time zone.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "description" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly description: " }, { "kind": "Content", @@ -3747,27 +2973,19 @@ "releaseTag": "Beta", "name": "description", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#id:member", "docComment": "/**\n * Gets the ID of the time zone.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly id: " }, { "kind": "Content", @@ -3781,27 +2999,19 @@ "releaseTag": "Beta", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(offset:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#offset:member", "docComment": "/**\n * Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC).\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "offset" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly offset: " }, { "kind": "Content", @@ -3815,31 +3025,24 @@ "releaseTag": "Beta", "name": "offset", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(standardDate:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#standardDate:member", "docComment": "/**\n * Gets the date on which standard time begins for the time zone.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "standardDate" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly standardDate: " }, { "kind": "Reference", - "text": "ISPSystemTime" + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" }, { "kind": "Content", @@ -3849,27 +3052,19 @@ "releaseTag": "Beta", "name": "standardDate", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(standardOffset:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#standardOffset:member", "docComment": "/**\n * Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC).\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "standardOffset" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly standardOffset: " }, { "kind": "Content", @@ -3883,8 +3078,8 @@ "releaseTag": "Beta", "name": "standardOffset", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } @@ -3893,20 +3088,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPUser:class)", + "canonicalReference": "@microsoft/sp-page-context!SPUser:class", "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user that is accessing the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPUser` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPUser" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPUser " } ], "releaseTag": "Public", @@ -3914,20 +3101,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(displayName:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#displayName:member", "docComment": "/**\n * The display name for the current user.\n *\n * @remarks\n *\n * Example: `\"John Doe\"`\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "displayName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly displayName: " }, { "kind": "Content", @@ -3941,27 +3120,19 @@ "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(email:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#email:member", "docComment": "/**\n * The email address for the current user.\n *\n * @remarks\n *\n * Example: `\"example@contoso.com\"`\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "email" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly email: " }, { "kind": "Content", @@ -3975,31 +3146,24 @@ "releaseTag": "Public", "name": "email", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(firstDayOfWeek:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#firstDayOfWeek:member", "docComment": "/**\n * Returns the user's regional first day of week setting or undefined if it hasn't been set.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly firstDayOfWeek: " }, { "kind": "Reference", - "text": "firstDayOfWeek" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPDayOfWeek" + "text": "SPDayOfWeek", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek:enum" }, { "kind": "Content", @@ -4013,27 +3177,19 @@ "releaseTag": "Beta", "name": "firstDayOfWeek", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isAnonymousGuestUser:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member", "docComment": "/**\n * Returns if the current user is an anonymous guest.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isAnonymousGuestUser" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isAnonymousGuestUser: " }, { "kind": "Content", @@ -4047,27 +3203,19 @@ "releaseTag": "Public", "name": "isAnonymousGuestUser", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isExternalGuestUser:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#isExternalGuestUser:member", "docComment": "/**\n * Returns true if the current user is an external guest.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isExternalGuestUser" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isExternalGuestUser: " }, { "kind": "Content", @@ -4081,27 +3229,19 @@ "releaseTag": "Public", "name": "isExternalGuestUser", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(loginName:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#loginName:member", "docComment": "/**\n * The login name for current user.\n *\n * @remarks\n *\n * Example: on-premise user: `\"domain\\user\"`, online user: `\"user@domain.com\"`\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "loginName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly loginName: " }, { "kind": "Content", @@ -4115,27 +3255,19 @@ "releaseTag": "Public", "name": "loginName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(preferUserTimeZone:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#preferUserTimeZone:member", "docComment": "/**\n * This boolean represents if a the user or web's time zone settings should be used to display the current time.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "preferUserTimeZone" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly preferUserTimeZone: " }, { "kind": "Content", @@ -4149,31 +3281,24 @@ "releaseTag": "Public", "name": "preferUserTimeZone", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(timeZoneInfo:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPUser#timeZoneInfo:member", "docComment": "/**\n * Returns the user's regional timezone settings or undefined if they haven't been set.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "timeZoneInfo" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly timeZoneInfo: " }, { "kind": "Reference", - "text": "SPTimeZone" + "text": "SPTimeZone", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -4187,8 +3312,8 @@ "releaseTag": "Beta", "name": "timeZoneInfo", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false } @@ -4197,20 +3322,12 @@ }, { "kind": "Class", - "canonicalReference": "(SPWeb:class)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb:class", "docComment": "/**\n * This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site (\"SPWeb\") that hosts the page.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPWeb` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "SPWeb" - }, - { - "kind": "Content", - "text": " " + "text": "export default class SPWeb " } ], "releaseTag": "Public", @@ -4218,20 +3335,12 @@ "members": [ { "kind": "Property", - "canonicalReference": "(absoluteUrl:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#absoluteUrl:member", "docComment": "/**\n * Returns the absolute URL for this SPWeb. Example: `\"https://example.com/sites/PubSite/SubWeb\"`\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "absoluteUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly absoluteUrl: " }, { "kind": "Content", @@ -4245,27 +3354,19 @@ "releaseTag": "Public", "name": "absoluteUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(description:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#description:member", "docComment": "/**\n * Returns the description of the current SPWeb.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "description" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly description: " }, { "kind": "Content", @@ -4279,31 +3380,24 @@ "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(firstDayOfWeek:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member", "docComment": "/**\n * Returns the web's regional first day of week setting or undefined if it hasn't been set.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly firstDayOfWeek: " }, { "kind": "Reference", - "text": "firstDayOfWeek" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPDayOfWeek" + "text": "SPDayOfWeek", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek:enum" }, { "kind": "Content", @@ -4317,31 +3411,24 @@ "releaseTag": "Beta", "name": "firstDayOfWeek", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(id:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#id:member", "docComment": "/**\n * The GUID that identifies the SPWeb on the server.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "id" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly id: " }, { "kind": "Reference", - "text": "Guid" + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" }, { "kind": "Content", @@ -4351,27 +3438,19 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isAppWeb:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#isAppWeb:member", "docComment": "/**\n * Returns true if this `SPWeb` the container web for an `SPApp`.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "isAppWeb" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly isAppWeb: " }, { "kind": "Content", @@ -4385,27 +3464,19 @@ "releaseTag": "Public", "name": "isAppWeb", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(language:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#language:member", "docComment": "/**\n * Returns the locale identifier (LCID) for the default language of the website.\n *\n * @remarks\n *\n * Example: 1033 represents the locale identifier for en-US.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "language" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly language: " }, { "kind": "Content", @@ -4419,27 +3490,45 @@ "releaseTag": "Public", "name": "language", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(logoUrl:instance)", - "docComment": "/**\n * Returns the absolute URL of the website logo.\n *\n * @remarks\n *\n * Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`\n */\n", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#languageName:member", + "docComment": "/**\n * Returns the language name for the default language of the website.\n *\n * @remarks\n *\n * Example: en-US represents the English language in the US locale.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly languageName: " }, { - "kind": "Reference", - "text": "logoUrl" + "kind": "Content", + "text": "string" }, { "kind": "Content", - "text": ": " + "text": ";" + } + ], + "releaseTag": "Public", + "name": "languageName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#logoUrl:member", + "docComment": "/**\n * Returns the absolute URL of the website logo.\n *\n * @remarks\n *\n * Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly logoUrl: " }, { "kind": "Content", @@ -4453,31 +3542,24 @@ "releaseTag": "Public", "name": "logoUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(permissions:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#permissions:member", "docComment": "/**\n * Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "permissions" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly permissions: " }, { "kind": "Reference", - "text": "SPPermission" + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -4487,27 +3569,19 @@ "releaseTag": "Public", "name": "permissions", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(serverRelativeUrl:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member", "docComment": "/**\n * Returns the server-relative URL for this SPWeb.\n *\n * @remarks\n *\n * Example: `\"/sites/PubSite/SubWeb\"`\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "serverRelativeUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly serverRelativeUrl: " }, { "kind": "Content", @@ -4521,27 +3595,19 @@ "releaseTag": "Public", "name": "serverRelativeUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(templateName:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#templateName:member", "docComment": "/**\n * Returns the string representing the numeric identifier for the site definition or site template that was used to create the site.\n *\n * @remarks\n *\n * Example: `\"1\"` represents the team site template when creating a new site on SharePoint.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "templateName" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly templateName: " }, { "kind": "Content", @@ -4555,31 +3621,24 @@ "releaseTag": "Public", "name": "templateName", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(timeZoneInfo:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#timeZoneInfo:member", "docComment": "/**\n * Returns the web's regional timezone settings or undefined if they haven't been set.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly timeZoneInfo: " }, { "kind": "Reference", - "text": "timeZoneInfo" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPTimeZone" + "text": "SPTimeZone", + "canonicalReference": "@microsoft/sp-page-context!default:class" }, { "kind": "Content", @@ -4593,27 +3652,19 @@ "releaseTag": "Beta", "name": "timeZoneInfo", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(title:instance)", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#title:member", "docComment": "/**\n * Returns the title of the current SPWeb.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "title" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly title: " }, { "kind": "Content", @@ -4627,8 +3678,8 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } diff --git a/generate-docs/json/sp-property-pane.api.json b/generate-docs/json/sp-property-pane.api.json new file mode 100644 index 00000000..6c4c1ab0 --- /dev/null +++ b/generate-docs/json/sp-property-pane.api.json @@ -0,0 +1,5695 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-property-pane!", + "docComment": "/**\n * SharePoint Framework property pane.\n *\n * @remarks\n *\n * Helps create the property pane for the SharePoint components such as web parts, canvas etc.,\n *\n * @packagedocumentation\n */\n", + "name": "@microsoft/sp-property-pane", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-property-pane!", + "name": "", + "members": [ + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-property-pane!DynamicDataSharedDepth:enum", + "docComment": "/**\n * Enum for the possible values of shared depth of the dynamic data reference.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum DynamicDataSharedDepth " + } + ], + "releaseTag": "Public", + "name": "DynamicDataSharedDepth", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member", + "docComment": "/**\n * Indicates that nothing is shared.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "None = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "None", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member", + "docComment": "/**\n * Indicates that both the dynamic data source and the property are shared.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Property = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Property", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member", + "docComment": "/**\n * Indicates that the dynamic data source is shared.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Source = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Source", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface", + "docComment": "/**\n * Configuration related to a shared property.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IDynamicDataSharedPropertyConfiguration " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedPropertyConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member", + "docComment": "/**\n * Filters for the shared property.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "filters?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "filters", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface", + "docComment": "/**\n * Property pane dynamic data property filters.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IDynamicDataSharedPropertyFilters " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedPropertyFilters", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member", + "docComment": "/**\n * Property Id\n *\n * Usage: Use this filter when the author can only to connect to a specific property from the selected source.\n *\n * @remarks\n *\n * This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the dynamic data widget.\n *\n * When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propertyId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface", + "docComment": "/**\n * Configuration related to a shared source.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IDynamicDataSharedSourceConfiguration " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedSourceConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member", + "docComment": "/**\n * Filters for the shared source.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "filters?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "filters", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member", + "docComment": "/**\n * User-friendly, localized label for the sources dropdown.\n *\n * default value - 'Connect to source'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sourcesLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourcesLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface", + "docComment": "/**\n * Property pane dynamic data source filters.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IDynamicDataSharedSourceFilters " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedSourceFilters", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member", + "docComment": "/**\n * Component Id.\n *\n * Usage: Use this filter when the author should only be able to connect to a specific type of source.\n *\n * @remarks\n *\n * This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic data widget.\n *\n * When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources matching the given component id.\n *\n * Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "componentId?: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member", + "docComment": "/**\n * Source Id\n *\n * Usage: Use this filter, when the author can only to connect to a specific data source.\n *\n * @remarks\n *\n * This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the dynamic data widget.\n *\n * When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is pre-selected, the control will be disabled to ensure that authors can not change it.\n *\n * The source id for a web part will be of the form WebPart..\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sourceId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPopupWindowProps:interface", + "docComment": "/**\n * Popup window props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPopupWindowProps " + } + ], + "releaseTag": "Public", + "name": "IPopupWindowProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPopupWindowProps#height:member", + "docComment": "/**\n * Height of pop up window.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "height: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "height", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member", + "docComment": "/**\n * The position of pop up window.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "positionWindowPosition: " + }, + { + "kind": "Reference", + "text": "PopupWindowPosition", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "positionWindowPosition", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPopupWindowProps#title:member", + "docComment": "/**\n * Title of pop up window.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPopupWindowProps#width:member", + "docComment": "/**\n * Width of pop up window.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "width: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "width", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface", + "docComment": "/**\n * PropertyPane button props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneButtonProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneButtonProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member", + "docComment": "/**\n * Detailed description of the button for the benefit of screen readers.\n *\n * Besides the compound button, other button types will need more information provided to screen reader.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaDescription?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaDescription", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member", + "docComment": "/**\n * The aria label of the button for the benefit of screen readers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member", + "docComment": "/**\n * The type of button to render. Default value is ButtonType.normal.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonType?: " + }, + { + "kind": "Reference", + "text": "PropertyPaneButtonType", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member", + "docComment": "/**\n * Description of the action this button takes. Only used for compound buttons.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "description?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member", + "docComment": "/**\n * Whether the button is disabled.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member", + "docComment": "/**\n * The button icon shown in command or hero type.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "icon?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "icon", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member", + "docComment": "/**\n * A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props.\n *\n * @param value - Value associated with element's target property in the properties bag.\n *\n * @returns - New value for the target property, which will eventually be updated in the properties bag.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onClick: " + }, + { + "kind": "Content", + "text": "(value: any) => any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onClick", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member", + "docComment": "/**\n * Display text of the element.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "text: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "text", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface", + "docComment": "/**\n * PropertyPane CheckBox component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneCheckboxProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneCheckboxProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member", + "docComment": "/**\n * Whether the property pane checkbox is checked or not.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "checked?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "checked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member", + "docComment": "/**\n * Whether the property pane checkbox is disabled or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member", + "docComment": "/**\n * Label to display next to the checkbox.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "text?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "text", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface", + "docComment": "/**\n * PropertyPane ChoiceGroup option props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneChoiceGroupOption " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupOption", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member", + "docComment": "/**\n * The aria label of the property pane choice group option for the benefit of screen readers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member", + "docComment": "/**\n * Whether the property pane choice group option is checked or not.\n *\n * Default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "checked?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "checked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member", + "docComment": "/**\n * Whether the property pane choice group option is disabled or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member", + "docComment": "/**\n * The Icon component props for choice field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "iconProps?: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOptionIconProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "iconProps", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member", + "docComment": "/**\n * The width and height of the image in px for choice field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "imageSize?: " + }, + { + "kind": "Content", + "text": "{\n width: number;\n height: number;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "imageSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member", + "docComment": "/**\n * The src of image for choice field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "imageSrc?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "imageSrc", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member", + "docComment": "/**\n * A required key to uniquely identify the option.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "key: " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "key", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member", + "docComment": "/**\n * The src of image for choice field which is selected.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "selectedImageSrc?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedImageSrc", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member", + "docComment": "/**\n * The text string for the option.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "text: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "text", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface", + "docComment": "/**\n * PropertyPane ChoiceGroup icon props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneChoiceGroupOptionIconProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupOptionIconProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member", + "docComment": "/**\n * The name of the icon to use from the Office Fabric icon set.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "officeFabricIconFontName?: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "officeFabricIconFontName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface", + "docComment": "/**\n * PropertyPane ChoiceGroup props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneChoiceGroupProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member", + "docComment": "/**\n * Descriptive label for the choice group.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member", + "docComment": "/**\n * The options for the choice group.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "options: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOption", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "options", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface", + "docComment": "/**\n * Property pane conditional group.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneConditionalGroup " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneConditionalGroup", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member", + "docComment": "/**\n * Callback when user clicks to show primary group.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onShowPrimaryGroup?: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onShowPrimaryGroup", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member", + "docComment": "/**\n * Callback when user clicks to show secondary group.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onShowSecondaryGroup?: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onShowSecondaryGroup", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member", + "docComment": "/**\n * Primary group to show\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryGroup: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryGroup", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member", + "docComment": "/**\n * Secondary group to show\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "secondaryGroup: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "secondaryGroup", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member", + "docComment": "/**\n * Indicating whether the property pane should show primary group or the secondary group.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "showSecondaryGroup: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "showSecondaryGroup", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface", + "docComment": "/**\n * Web part configuration settings\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneConfiguration " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneConfiguration", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member", + "docComment": "/**\n * Page to be displayed on the PropertyPane.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "currentPage?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "currentPage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member", + "docComment": "/**\n * List of properties to debounce the `onPropertyPaneFieldChanged` event.\n *\n * @remarks\n *\n * If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other properties will be unaffected.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "debounceProperties?: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDebounceProperty", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "debounceProperties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member", + "docComment": "/**\n * Number of milliseconds to be delayed before the loading indicator is shown on the property pane.\n *\n * @remarks\n *\n * The default value is 500.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "loadingIndicatorDelayTime?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "loadingIndicatorDelayTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member", + "docComment": "/**\n * Total number of pages on the PropertyPane.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "pages: " + }, + { + "kind": "Reference", + "text": "IPropertyPanePage", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "pages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member", + "docComment": "/**\n * Indicates whether the loading indicator should be displayed on top of the property pane or not.\n *\n * @remarks\n *\n * This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator property).\n *\n * The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "showLoadingIndicator?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "showLoadingIndicator", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface", + "docComment": "/**\n * PropertyPane CustomPropertyField props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneCustomFieldProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneCustomFieldProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member", + "docComment": "/**\n * Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member", + "docComment": "/**\n * An UNIQUE key indicates the identity of this contorl.\n *\n * The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how to pick the value of the key.\n *\n * For more information, see the {@link https://facebook.github.io/react/docs/lists-and-keys.html#keys | React documentation}.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "key", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member", + "docComment": "/**\n * This API is called when the component is unmounted from the host element.\n *\n * @param domElement - DOM element on which the custom control is mounted.\n *\n * @param context - Instance specific context. This context was passed in the constructor.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onDispose?: " + }, + { + "kind": "Content", + "text": "(domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ", context?: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onDispose", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member", + "docComment": "/**\n * This API will be called once the custom field is mounted on the host element.\n *\n * @param domElement - DOM element on which the custom control needs to be mounted.\n *\n * @param context - Instance specific context. This context was passed in the constructor.\n *\n * @param changeCallback - Callback called when a field changes within the custom field. This will allow the property pane to be aware of the change and act accordingly.\n *\n * @param targetProperty - associated target property from the properties bag. if not provided then a custom value which is unique at the custom field level is assigned, which will be in the form of `__CustomField_`.\n *\n * @param newValue - new value of the property. newValue is ignored if targetProperty is not specified.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onRender: " + }, + { + "kind": "Content", + "text": "(domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ", context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onRender", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface", + "docComment": "/**\n * Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDebounceProperty " + } + ], + "releaseTag": "Beta", + "name": "IPropertyPaneDebounceProperty", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member", + "docComment": "/**\n * Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired for this property.\n *\n * @remarks\n *\n * The default value is 500.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "debouncePeriod?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "debouncePeriod", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member", + "docComment": "/**\n * Property to debounce.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propertyName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "propertyName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface", + "docComment": "/**\n * PropertyPane dropdown callout properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDropdownCalloutProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDropdownCalloutProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member", + "docComment": "/**\n * Set max height of callout When not set the callout will expand with contents up to the bottom of the screen\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "calloutMaxHeight?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "calloutMaxHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface", + "docComment": "/**\n * PropertyPane drop down options.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDropdownOption " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDropdownOption", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member", + "docComment": "/**\n * Index for this option.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "index?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "index", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member", + "docComment": "/**\n * A key to uniquely identify this option.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "key: " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "key", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member", + "docComment": "/**\n * Text to render for this option.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "text: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "text", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member", + "docComment": "/**\n * The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type?: " + }, + { + "kind": "Reference", + "text": "PropertyPaneDropdownOptionType", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface", + "docComment": "/**\n * PropertyPane drop down component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDropdownProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDropdownProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member", + "docComment": "/**\n * A description of the dropdown for the benefit of screen reader users.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member", + "docComment": "/**\n * Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaPositionInSet?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaPositionInSet", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member", + "docComment": "/**\n * Defines the number of items in the current set of controls. Maps to native aria-setsize attribute.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaSetSize?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaSetSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member", + "docComment": "/**\n * Custom properties for Dropdown's Callout used to render options.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "calloutProps?: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownCalloutProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "calloutProps", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member", + "docComment": "/**\n * Whether the property pane dropdown option is disabled or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member", + "docComment": "/**\n * If set, this will be displayed as an error message.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "errorMessage?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "errorMessage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member", + "docComment": "/**\n * Descriptive label for the Dropdown.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member", + "docComment": "/**\n * Collection of options for this Dropdown.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "options?: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownOption", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "options", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member", + "docComment": "/**\n * The key of the initially selected option.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "selectedKey?: " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type", + "docComment": "/**\n * Property pane dynamic field filters which is an intersection of both source and property filters.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type IPropertyPaneDynamicFieldFilters = " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldFilters", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface", + "docComment": "/**\n * PropertyPaneDynamicField props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDynamicFieldProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member", + "docComment": "/**\n * Filters for the property pane dynamic field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "filters?: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldFilters", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "filters", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member", + "docComment": "/**\n * User-friendly, localized label to identify the field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member", + "docComment": "/**\n * Indicates to what depth of property values are shown on the property pane dynamic data widget.\n *\n * If not specified, then max of 2 levels of property value will be shown.\n *\n * @remarks\n *\n * It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propertyValueDepth?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyValueDepth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member", + "docComment": "/**\n * User-friendly, localized label for the sources dropdown.\n *\n * default value - 'Connect to source'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sourcesLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourcesLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface", + "docComment": "/**\n * PropertyPane DynamicFieldSet props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDynamicFieldSetProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldSetProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member", + "docComment": "/**\n * List of property pane dynamic fields to be configured on the Dynamic Data Widget.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fields: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface" + }, + { + "kind": "Content", + "text": ">[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fields", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member", + "docComment": "/**\n * User-friendly, localized label to identify the property.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member", + "docComment": "/**\n * Configuration shared between all the entries of the set.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sharedConfiguration?: " + }, + { + "kind": "Content", + "text": "{\n depth: " + }, + { + "kind": "Reference", + "text": "DynamicDataSharedDepth", + "canonicalReference": "@microsoft/sp-property-pane!DynamicDataSharedDepth:enum" + }, + { + "kind": "Content", + "text": ";\n source?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n property?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sharedConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface", + "docComment": "/**\n * `PropertyPaneDynamicData` component props.\n *\n * @deprecated\n *\n * - This has been replaced by IPropertyPaneDynamicFieldProps\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneDynamicTextFieldProps " + } + ], + "releaseTag": "Beta", + "name": "IPropertyPaneDynamicTextFieldProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member", + "docComment": "/**\n * ARIA Label for text field, if any.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member", + "docComment": "/**\n * The text field input description.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "description?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member", + "docComment": "/**\n * Whether the property pane text field is enabled or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member", + "docComment": "/**\n * If set, this will be displayed as an error message.\n *\n * @remarks\n *\n * When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the error message.\n *\n * Make sure to set this only if you want to see an error message displayed for the text field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "errorMessage?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "errorMessage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member", + "docComment": "/**\n * Label for the text field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member", + "docComment": "/**\n * This method is used to get the validation error message and determine whether the input value is valid or not.\n *\n * @remarks\n *\n * When it returns string:\n *\n * - If valid, it returns empty string.\n *\n * - If invalid, it returns the error message string and an error message is displayed below the text field.\n *\n * When it returns `Promise`:\n *\n * - The resolved value is display as error message.\n *\n * - The rejected, the value is thrown away.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onGetErrorMessage?: " + }, + { + "kind": "Content", + "text": "(value: string) => string | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "onGetErrorMessage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member", + "docComment": "/**\n * Placeholder text to be displayed in the text field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "placeholder?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "placeholder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member", + "docComment": "/**\n * Run validation when the PropertyPaneTextField is focused.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "validateOnFocusIn?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "validateOnFocusIn", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member", + "docComment": "/**\n * Run validation when the `PropertyPaneTextField` is out of focus or on blur.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "validateOnFocusOut?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "validateOnFocusOut", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member", + "docComment": "/**\n * Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "value?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface", + "docComment": "/**\n * PropertyPane field.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneField " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "IPropertyPaneField", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField#properties:member", + "docComment": "/**\n * Strongly typed properties object. Specific to each field type.\n *\n * @remarks\n *\n * Example: Checkbox has ICheckboxProps, TextField has ITextField props.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "properties: " + }, + { + "kind": "Content", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member", + "docComment": "/**\n * Whether this control should be focused.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shouldFocus?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "shouldFocus", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member", + "docComment": "/**\n * Target property from the web part's property bag.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "targetProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField#type:member", + "docComment": "/**\n * Type of the PropertyPane field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "PropertyPaneFieldType", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup:interface", + "docComment": "/**\n * PropertyPane group. Group is part of the PropertyPanePage.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneGroup " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneGroup", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member", + "docComment": "/**\n * List of PropertyPane fields.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "groupFields: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "groupFields", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member", + "docComment": "/**\n * Display name for the group.\n *\n * @remarks\n *\n * For performance reasons, it's highly recommended to keep this name unique within the property pane page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "groupName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "groupName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member", + "docComment": "/**\n * Indicates whether the PropertyPane group is collapsed or not.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isCollapsed?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isCollapsed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface", + "docComment": "/**\n * PropertyPaneLabel component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneLabelProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneLabelProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member", + "docComment": "/**\n * Whether the associated form field is required or not.\n *\n * @remarks\n *\n * If true, a red asterisk is displayed to the right of the label. Default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "required?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "required", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member", + "docComment": "/**\n * Display text fot the label.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "text: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "text", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface", + "docComment": "/**\n * PropertyPaneLink component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneLinkProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneLinkProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member", + "docComment": "/**\n * Whether the property pane link is disabled or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member", + "docComment": "/**\n * Location to which the link is targeted to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "href: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "href", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member", + "docComment": "/**\n * The props of pop up window.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "popupWindowProps?: " + }, + { + "kind": "Reference", + "text": "IPopupWindowProps", + "canonicalReference": "@microsoft/sp-property-pane!IPopupWindowProps:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "popupWindowProps", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member", + "docComment": "/**\n * This attribute specifies where to display the linked resource.\n *\n * @remarks\n *\n * Following values can be used:\n *\n * _self - (default) Load the response in the current page.\n *\n * _blank - Load the response into a new unnamed tab.\n *\n * _parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same as \"_self\"\n *\n * _top - Load the response into the original window.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "target?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "target", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member", + "docComment": "/**\n * Display text for the link.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "text: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "text", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage:interface", + "docComment": "/**\n * PropertyPanePage interface.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPanePage " + } + ], + "releaseTag": "Public", + "name": "IPropertyPanePage", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member", + "docComment": "/**\n * Indicates whether the groups on the PropertyPanePage are displayed as accordion or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "displayGroupsAsAccordion?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayGroupsAsAccordion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage#groups:member", + "docComment": "/**\n * List of groups to be displayed on the PropertyPane page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "groups: " + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "IPropertyPaneGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "IPropertyPaneConditionalGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface" + }, + { + "kind": "Content", + "text": ")[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "groups", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage#header:member", + "docComment": "/**\n * PropertyPane page header.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "header?: " + }, + { + "kind": "Reference", + "text": "IPropertyPanePageHeader", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePageHeader:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "header", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePageHeader:interface", + "docComment": "/**\n * PropertyPane header. This header remains same for all the pages.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPanePageHeader " + } + ], + "releaseTag": "Public", + "name": "IPropertyPanePageHeader", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member", + "docComment": "/**\n * Header to display.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "description: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member", + "docComment": "/**\n * Image url for the background image.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "image?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "image", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface", + "docComment": "/**\n * PropertyPaneSliderProps component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneSliderProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneSliderProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member", + "docComment": "/**\n * A description of the Slider for the benefit of screen readers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member", + "docComment": "/**\n * Whether or not the Slider is disabled.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member", + "docComment": "/**\n * Description label of the Slider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member", + "docComment": "/**\n * The max value of the Slider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "max: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "max", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member", + "docComment": "/**\n * The min value of the Slider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "min: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "min", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member", + "docComment": "/**\n * Whether to show the value on the right of the Slider.\n *\n * @remarks\n *\n * If you want to show the value by yourself, you may want to set this value to false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "showValue?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "showValue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member", + "docComment": "/**\n * The difference between the two adjacent values of the Slider. Defaults to 1.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "step?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "step", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member", + "docComment": "/**\n * The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events.\n *\n * Defaults to min.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "value?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member", + "docComment": "/**\n * Callback to format the Slider value. For example, if\n * ```typescript\n * (value) => `${value}%`\n * ```\n *\n * is specified, the value of the Slider has % after it.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "valueFormat?: " + }, + { + "kind": "Content", + "text": "(value: number) => string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "valueFormat", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface", + "docComment": "/**\n * PropertyPaneTextField component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneTextFieldProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneTextFieldProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member", + "docComment": "/**\n * Aria Label for text field, if any.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ariaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member", + "docComment": "/**\n * Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds.\n *\n * @remarks\n *\n * The default value is 200.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deferredValidationTime?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "deferredValidationTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member", + "docComment": "/**\n * The text field input description.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "description?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member", + "docComment": "/**\n * Whether the property pane text field is enabled or not.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member", + "docComment": "/**\n * If set, this will be displayed as an error message.\n *\n * @remarks\n *\n * When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the error message.\n *\n * So, make sure to set this only if you want to see an error message displayed for the text field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "errorMessage?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "errorMessage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member", + "docComment": "/**\n * Label for the text field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member", + "docComment": "/**\n * Name used to log `PropertyPaneTextField` value changes for engagement tracking.\n *\n * @remarks\n *\n * The messages will be logged with a format such as `.`.\n *\n * For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might contain:\n *\n * 1. The action type:\n *\n * `Add`: change from initial/unset state to customized content. (first edit)\n *\n * `Clear`: reset the content of caption element to initial/unset state.\n *\n * `Edit`: any edition that changes the content apart from add and clear\n *\n * 2. The text length after each edit\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "logName?: " + }, + { + "kind": "Content", + "text": "{\n moduleName: string;\n controlName: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "logName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member", + "docComment": "/**\n * Maximum number of characters that the PropertyPaneTextField can have.\n *\n * @remarks\n *\n * If the value is set to a negative number, an exception will be thrown.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxLength?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "maxLength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member", + "docComment": "/**\n * Whether or not the text field is a multiline text field.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "multiline?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "multiline", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member", + "docComment": "/**\n * The method is used to get the validation error message and determine whether the input value is valid or not.\n *\n * @remarks\n *\n * When it returns string:\n *\n * - If valid, it returns empty string.\n *\n * - If invalid, it returns the error message string and an error message is displayed below the text field.\n *\n * When it returns `Promise`:\n *\n * - The resolved value is display as error message.\n *\n * - The rejected, the value is thrown away.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onGetErrorMessage?: " + }, + { + "kind": "Content", + "text": "(value: string) => string | " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onGetErrorMessage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member", + "docComment": "/**\n * placeholder text to be displayed in the text field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "placeholder?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "placeholder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member", + "docComment": "/**\n * Whether or not the multiline text field is resizable.\n *\n * @remarks\n *\n * The default value is true.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resizable?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "resizable", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member", + "docComment": "/**\n * Specifies the visible height of a text area(multiline text TextField), in lines.\n *\n * @remarks\n *\n * This prop is used only when the multiline prop is set to true.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rows?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "rows", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member", + "docComment": "/**\n * Whether or not the text field is underlined.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "underlined?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "underlined", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member", + "docComment": "/**\n * Run validation when the PropertyPaneTextField is focused.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "validateOnFocusIn?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "validateOnFocusIn", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member", + "docComment": "/**\n * Run validation when the PropertyPaneTextField is out of focus or on blur.\n *\n * @remarks\n *\n * The default value is false.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "validateOnFocusOut?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "validateOnFocusOut", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member", + "docComment": "/**\n * Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "value?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface", + "docComment": "/**\n * PropertyPaneToggle component props.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPropertyPaneToggleProps " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneToggleProps", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member", + "docComment": "/**\n * Checked state of the toggle.\n *\n * @remarks\n *\n * If you are maintaining state yourself, use this property.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "checked?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "checked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member", + "docComment": "/**\n * Optional disabled flag.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member", + "docComment": "/**\n * A key to uniquely identify the field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "key?: " + }, + { + "kind": "Content", + "text": "string | number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "key", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member", + "docComment": "/**\n * A label for the toggle.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "label: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "JSX.Element", + "canonicalReference": "@types/react!~__global.JSX.Element:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "label", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member", + "docComment": "/**\n * Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "offAriaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "offAriaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member", + "docComment": "/**\n * Test display when toggle is OFF.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "offText?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "offText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member", + "docComment": "/**\n * Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onAriaLabel?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onAriaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member", + "docComment": "/**\n * Text to display when toggle is ON.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "onText?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition:enum", + "docComment": "/**\n * The position of pop up window.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum PopupWindowPosition " + } + ], + "releaseTag": "Public", + "name": "PopupWindowPosition", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition.center:member", + "docComment": "/**\n * PopupWindowPosition would be located in center of screen.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "center = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "center", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member", + "docComment": "/**\n * PopupWindowPosition would be located in left bottom of screen.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "leftBottom = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "releaseTag": "Public", + "name": "leftBottom", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member", + "docComment": "/**\n * PopupWindowPosition would be located in left top of screen.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "leftTop = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "leftTop", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member", + "docComment": "/**\n * PopupWindowPosition would be located in right bottom of screen.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rightBottom = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "rightBottom", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member", + "docComment": "/**\n * PopupWindowPosition would be located in right top of screen.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rightTop = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "rightTop", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButton:function(1)", + "docComment": "/**\n * Helper method to create a Button on the PropertyPane.\n *\n * @param targetProperty - Target property the Button is associated to.\n *\n * @param properties - Strongly typed Button properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneButton(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneButton" + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType:enum", + "docComment": "/**\n * Enum for all the supported button types.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum PropertyPaneButtonType " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneButtonType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member", + "docComment": "/**\n * Optional actions.\n *\n * @remarks\n *\n * Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Command = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "releaseTag": "Public", + "name": "Command", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member", + "docComment": "/**\n * Always used as a set with both Standard and Primary compound buttons.\n *\n * @remarks\n *\n * Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Compound = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "Compound", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member", + "docComment": "/**\n * Hero button.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Hero = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Hero", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member", + "docComment": "/**\n * Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar.\n *\n * @remarks\n *\n * Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Icon = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Public", + "name": "Icon", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member", + "docComment": "/**\n * Optional completion action.\n *\n * @remarks\n *\n * Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo an action. Examples: \"Done\" button which closes a container but doesn't make a server call or an \"Undo\" button when a user is uploading a file in OneDrive.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Normal = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Normal", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member", + "docComment": "/**\n * Preferred completion action when paired with a Standard button.\n *\n * @remarks\n *\n * Typically used at the end of a task or form. Examples: \"Create\", \"Save\", \"Send\" which makes a server call.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Primary = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Primary", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)", + "docComment": "/**\n * Helper method to create a Checkbox on the PropertyPane.\n *\n * @param targetProperty - Target property the checkbox is associated to.\n *\n * @param properties - Strongly typed Checkbox properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneCheckbox(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneCheckbox" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)", + "docComment": "/**\n * Helper method to create a Choice Group on the PropertyPane.\n *\n * @param targetProperty - Target property the choice group is associated to.\n *\n * @param properties - Strongly typed Choice Group properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneChoiceGroup(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneChoiceGroup" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)", + "docComment": "/**\n * Helper method to create a custom field on the PropertyPane.\n *\n * @remarks\n *\n * The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap.\n *\n * @param targetProperty - target property for this field. This parameter is being deprecated in future releases.\n *\n * @param properties - Strongly typed Custom field properties.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneCustomField(properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "PropertyPaneCustomField" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)", + "docComment": "/**\n * Helper method to create a Dropdown on the PropertyPane.\n *\n * @param targetProperty - Target property the dropdown is associated to.\n *\n * @param properties - Strongly typed Dropdown properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneDropdown(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneDropdown" + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum", + "docComment": "/**\n * Specifies the type of option in a dropdown menu rendered by {@link PropertyPaneDropdown}.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum PropertyPaneDropdownOptionType " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneDropdownOptionType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member", + "docComment": "/**\n * Render a divider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Divider = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Divider", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member", + "docComment": "/**\n * Render menu item as a header.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Header = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Header", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member", + "docComment": "/**\n * Render normal menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Normal = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Normal", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)", + "docComment": "/**\n * Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field.\n *\n * @param targetProperty - Target property the Dynamic Data widget is associated to.\n *\n * @param options - Options to enable customized values for callback, filters etc., for the dynamic field.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneDynamicField(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneDynamicField" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)", + "docComment": "/**\n * Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source.\n *\n * These fields can possibly share the same property based on the associated filters.\n *\n * @param properties - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneDynamicFieldSet(properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "PropertyPaneDynamicFieldSet" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)", + "docComment": "/**\n * Helper method to create a Dynamic TextField on the PropertyPane.\n *\n * @deprecated\n *\n * - This has been replaced by PropertyPaneDynamicField\n *\n * @param targetProperty - Target property the dynamic textfield is associated to.\n *\n * @param properties - Properties of the PropertyPaneDynamicTextField.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneDynamicTextField(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneDynamicTextField" + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType:enum", + "docComment": "/**\n * Enum for all the supported PropertyPane field types.\n *\n * Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum PropertyPaneFieldType " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneFieldType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member", + "docComment": "/**\n * Button field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Button = " + }, + { + "kind": "Content", + "text": "11" + } + ], + "releaseTag": "Public", + "name": "Button", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member", + "docComment": "/**\n * Checkbox field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CheckBox = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "CheckBox", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member", + "docComment": "/**\n * Choice Group field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ChoiceGroup = " + }, + { + "kind": "Content", + "text": "10" + } + ], + "releaseTag": "Public", + "name": "ChoiceGroup", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member", + "docComment": "/**\n * Custom field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Custom = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Custom", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member", + "docComment": "/**\n * Dropdown field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Dropdown = " + }, + { + "kind": "Content", + "text": "6" + } + ], + "releaseTag": "Public", + "name": "Dropdown", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member", + "docComment": "/**\n * Dynamic data field.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DynamicField = " + }, + { + "kind": "Content", + "text": "14" + } + ], + "releaseTag": "Public", + "name": "DynamicField", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member", + "docComment": "/**\n * A set of dynamic fields.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DynamicFieldSet = " + }, + { + "kind": "Content", + "text": "16" + } + ], + "releaseTag": "Public", + "name": "DynamicFieldSet", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member", + "docComment": "/**\n * Dynamic Text Field\n *\n * @deprecated\n *\n * - Please use DynamicField\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DynamicTextField = " + }, + { + "kind": "Content", + "text": "15" + } + ], + "releaseTag": "Beta", + "name": "DynamicTextField", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member", + "docComment": "/**\n * Heading field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Heading = " + }, + { + "kind": "Content", + "text": "9" + } + ], + "releaseTag": "Public", + "name": "Heading", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member", + "docComment": "/**\n * Horizontal Rule field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HorizontalRule = " + }, + { + "kind": "Content", + "text": "12" + } + ], + "releaseTag": "Public", + "name": "HorizontalRule", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member", + "docComment": "/**\n * Label field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Label = " + }, + { + "kind": "Content", + "text": "7" + } + ], + "releaseTag": "Public", + "name": "Label", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member", + "docComment": "/**\n * Link field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Link = " + }, + { + "kind": "Content", + "text": "13" + } + ], + "releaseTag": "Public", + "name": "Link", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member", + "docComment": "/**\n * Slider field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Slider = " + }, + { + "kind": "Content", + "text": "8" + } + ], + "releaseTag": "Public", + "name": "Slider", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member", + "docComment": "/**\n * TextField field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "TextField = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "TextField", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member", + "docComment": "/**\n * Toggle field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Toggle = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Public", + "name": "Toggle", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)", + "docComment": "/**\n * Helper method to create a Horizontal Rule on the PropertyPane.\n *\n * @param properties - Strongly typed Horizontal Rule properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneHorizontalRule(): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "PropertyPaneHorizontalRule" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneLabel:function(1)", + "docComment": "/**\n * Helper method to create a Label on the PropertyPane.\n *\n * @param targetProperty - Target property the label is associated to.\n *\n * @param properties - Strongly typed Label properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneLabel(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneLabel" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneLink:function(1)", + "docComment": "/**\n * Helper method to create a Link on the PropertyPane.\n *\n * @param targetProperty - Target property the Link is associated to.\n *\n * @param properties - Strongly typed Link properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneLink(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneLink" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneSlider:function(1)", + "docComment": "/**\n * Helper method to create a Slider on the PropertyPane.\n *\n * @param targetProperty - Target property the slider is associated to.\n *\n * @param properties - Strongly typed Slider properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneSlider(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneSlider" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneTextField:function(1)", + "docComment": "/**\n * Helper method to create a TextField on the PropertyPane.\n *\n * @param targetProperty - Target property the textfield is associated to.\n *\n * @param properties - Strongly typed TextField properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneTextField(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneTextField" + }, + { + "kind": "Function", + "canonicalReference": "@microsoft/sp-property-pane!PropertyPaneToggle:function(1)", + "docComment": "/**\n * Helper method to create a Toggle on the PropertyPane.\n *\n * @param targetProperty - Target property the toggle is associated to.\n *\n * @param properties - Strongly typed Toggle properties.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function PropertyPaneToggle(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "targetProperty", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "PropertyPaneToggle" + } + ] + } + ] +} diff --git a/generate-docs/json/sp-search-extensibility.api.json b/generate-docs/json/sp-search-extensibility.api.json new file mode 100644 index 00000000..30036f67 --- /dev/null +++ b/generate-docs/json/sp-search-extensibility.api.json @@ -0,0 +1,342 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "@microsoft/sp-search-extensibility!", + "docComment": "/**\n * SharePoint Framework developer support for customizing search.\n *\n * @packagedocumentation\n */\n", + "name": "@microsoft/sp-search-extensibility", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-search-extensibility!", + "name": "", + "members": [ + { + "kind": "Class", + "canonicalReference": "@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class", + "docComment": "/**\n * This is the base class that third parties should extend when implementing a client-side extension that can modify the search query.\n *\n * In the component manifest, the \"extensionType\" should be set to \"SearchQueryModifier\".\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default abstract class BaseSearchQueryModifier extends " + }, + { + "kind": "Reference", + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseSearchQueryModifier", + "members": [ + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected readonly context: " + }, + { + "kind": "Reference", + "text": "SearchQueryModifierContext", + "canonicalReference": "@microsoft/sp-search-extensibility!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)", + "docComment": "/**\n * Returns a modified search query.\n *\n * @param query - Query to modify.\n *\n * @param scenario - Search scenario.\n *\n * @returns - Modified query.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "modifySearchQuery(query: " + }, + { + "kind": "Reference", + "text": "IQuery", + "canonicalReference": "@microsoft/sp-search-extensibility!IQuery:interface" + }, + { + "kind": "Content", + "text": ", scenario: " + }, + { + "kind": "Reference", + "text": "SearchQueryScenario", + "canonicalReference": "@microsoft/sp-search-extensibility!SearchQueryScenario:enum" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IQuery", + "canonicalReference": "@microsoft/sp-search-extensibility!IQuery:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 9 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "query", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "scenario", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "modifySearchQuery" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member", + "docComment": "/**\n * Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the original query will be used instead of the modified one.\n *\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly timeout: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "timeout", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-search-extensibility!IQuery:interface", + "docComment": "/**\n * Query object. Includes the query text that will be used for search and exposed through dynamic data.\n *\n * @remarks\n *\n * Additional properties can be added to the object to pass data between extensions.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IQuery " + } + ], + "releaseTag": "Beta", + "name": "IQuery", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-search-extensibility!IQuery#originalQueryText:member", + "docComment": "/**\n * Query text that the user provided.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "originalQueryText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "originalQueryText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-search-extensibility!IQuery#queryText:member", + "docComment": "/**\n * Text of the query.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "queryText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "queryText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/sp-search-extensibility!SearchQueryModifierContext:class", + "docComment": "/**\n * Context for the search query modifier extensions.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export default class SearchQueryModifierContext extends " + }, + { + "kind": "Reference", + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "SearchQueryModifierContext", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-search-extensibility!SearchQueryScenario:enum", + "docComment": "/**\n * Scenario for the search query modifier.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum SearchQueryScenario " + } + ], + "releaseTag": "Beta", + "name": "SearchQueryScenario", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member", + "docComment": "/**\n * Search results scenario.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SearchResults = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Beta", + "name": "SearchResults", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member", + "docComment": "/**\n * Search suggestions scenario.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SearchSuggestions = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Beta", + "name": "SearchSuggestions", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index 974272c1..135fe782 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -1,67 +1,58 @@ { "metadata": { "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.1.8", - "schemaVersion": 1000 + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", - "canonicalReference": "@microsoft/sp-webpart-base", + "canonicalReference": "@microsoft/sp-webpart-base!", "docComment": "/**\n * SharePoint Framework support for building web parts.\n *\n * @remarks\n *\n * This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual object that a page author can add to their content, and customize using a property pane. Examples of web parts include an embedded video player, a map, a group calendar, a chart, etc.\n *\n * @packagedocumentation\n */\n", "name": "@microsoft/sp-webpart-base", "members": [ { "kind": "EntryPoint", - "canonicalReference": "", + "canonicalReference": "@microsoft/sp-webpart-base!", "name": "", "members": [ { "kind": "Class", - "canonicalReference": "(BaseClientSideWebPart:class)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart:class", "docComment": "/**\n * This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs to inherit from this class.\n *\n * @remarks\n *\n * Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in two catagories.\n *\n * The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API should be used to access contextual data relevant to this web part instance.\n *\n * The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " + "text": "export default abstract class BaseClientSideWebPart extends " }, { "kind": "Reference", - "text": "BaseClientSideWebPart" + "text": "BaseWebPart", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" }, { "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> extends " - }, - { - "kind": "Reference", - "text": "BaseWebPart" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> " + "text": " " } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "BaseClientSideWebPart", "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)", "docComment": "/**\n * Constructor for the BaseClientSideWebPart class.\n *\n * @remarks\n *\n * It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle.\n */\n", "excerptTokens": [ { @@ -70,25 +61,17 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [] }, { "kind": "Property", - "canonicalReference": "(canOpenPopupOnRender:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member", "docComment": "/**\n * This property indicates whether a web part can open a popup on initial render.\n *\n * @remarks\n *\n * In some environments the host re-renders the web parts frequently, and therefore opening popups during render will cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages perform postbacks causing the page to re-render on all button clicks.\n *\n * If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "canOpenPopupOnRender" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly canOpenPopupOnRender: " }, { "kind": "Content", @@ -102,27 +85,19 @@ "releaseTag": "Public", "name": "canOpenPopupOnRender", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(clearError:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)", "docComment": "/**\n * This API should be used to clear the error message from the web part display area.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "clearError" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected clearError(): " }, { "kind": "Content", @@ -135,34 +110,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "clearError" }, { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly context: " }, { "kind": "Reference", - "text": "WebPartContext" + "text": "WebPartContext", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" }, { "kind": "Content", @@ -172,31 +140,24 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(domElement:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member", "docComment": "/**\n * This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "domElement" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly domElement: " }, { "kind": "Reference", - "text": "HTMLElement" + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", @@ -206,27 +167,19 @@ "releaseTag": "Public", "name": "domElement", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(isRenderAsync:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member", "docComment": "/**\n * Indicates whether the web part is rendering in Async mode.\n *\n * @remarks\n *\n * If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part rendering is complete.\n *\n * The default value is false.\n *\n * @virtual\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "isRenderAsync" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly isRenderAsync: " }, { "kind": "Content", @@ -240,39 +193,24 @@ "releaseTag": "Public", "name": "isRenderAsync", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(onDisplayModeChanged:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)", "docComment": "/**\n * This event method is called when the display mode of a web part is changed.\n *\n * @remarks\n *\n * The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode.\n *\n * @param oldDisplayMode - The old display mode.\n *\n * @virtual\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onDisplayModeChanged" - }, - { - "kind": "Content", - "text": "(" + "text": "protected onDisplayModeChanged(oldDisplayMode: " }, { "kind": "Reference", - "text": "oldDisplayMode" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "DisplayMode" + "text": "DisplayMode", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum" }, { "kind": "Content", @@ -289,17 +227,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "oldDisplayMode", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -307,20 +245,12 @@ }, { "kind": "Method", - "canonicalReference": "(onDispose:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)", "docComment": "/**\n * This API should be used to refresh the contents of the PropertyPane.\n *\n * @remarks\n *\n * This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out.\n *\n * @virtual\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onDispose" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onDispose(): " }, { "kind": "Content", @@ -333,30 +263,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onDispose" }, { "kind": "Method", - "canonicalReference": "(render:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)", "docComment": "/**\n * This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected abstract " - }, - { - "kind": "Reference", - "text": "render" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected abstract render(): " }, { "kind": "Content", @@ -369,30 +291,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "Method", - "canonicalReference": "(renderCompleted:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)", "docComment": "/**\n * This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "renderCompleted" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected renderCompleted(): " }, { "kind": "Content", @@ -405,30 +319,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "renderCompleted" }, { "kind": "Property", - "canonicalReference": "(renderedFromPersistedData:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member", "docComment": "/**\n * This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not.\n *\n * @remarks\n *\n * Example: When web part is added for the first time using toolbox then the value is false.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "renderedFromPersistedData" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly renderedFromPersistedData: " }, { "kind": "Content", @@ -442,27 +348,19 @@ "releaseTag": "Public", "name": "renderedFromPersistedData", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(renderedOnce:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member", "docComment": "/**\n * This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "renderedOnce" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly renderedOnce: " }, { "kind": "Content", @@ -476,39 +374,24 @@ "releaseTag": "Public", "name": "renderedOnce", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(renderError:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)", "docComment": "/**\n * This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger.\n *\n * @param error - An error object containing the error message to render.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "renderError" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "error" - }, - { - "kind": "Content", - "text": ": " + "text": "protected renderError(error: " }, { "kind": "Reference", - "text": "Error" + "text": "Error", + "canonicalReference": "!Error:interface" }, { "kind": "Content", @@ -525,17 +408,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "error", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -543,39 +426,32 @@ } ], "extendsTokenRange": { - "startIndex": 5, - "endIndex": 9 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Class", - "canonicalReference": "(BaseWebPart:class)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart:class", "docComment": "/**\n * This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default abstract class " - }, - { - "kind": "Reference", - "text": "BaseWebPart" + "text": "export default abstract class BaseWebPart extends " + "text": "> extends " }, { "kind": "Reference", - "text": "BaseComponent" + "text": "BaseComponent", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent:class" }, { "kind": "Content", @@ -587,7 +463,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneConsumer" + "text": "IPropertyPaneConsumer", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConsumer:interface" }, { "kind": "Content", @@ -595,11 +472,24 @@ } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "BaseWebPart", "members": [ { "kind": "Constructor", - "canonicalReference": "(:constructor,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart:constructor(1)", "docComment": "/**\n * Constructor for the `BaseWebPart` class.\n *\n * @remarks\n *\n * It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle.\n */\n", "excerptTokens": [ { @@ -608,25 +498,17 @@ } ], "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [] }, { "kind": "Property", - "canonicalReference": "(accessibleTitle:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member", "docComment": "/**\n * This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "accessibleTitle" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly accessibleTitle: " }, { "kind": "Content", @@ -640,31 +522,24 @@ "releaseTag": "Public", "name": "accessibleTitle", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(context:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#context:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "context" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly context: " }, { "kind": "Reference", - "text": "BaseWebPartContext" + "text": "BaseWebPartContext", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" }, { "kind": "Content", @@ -674,31 +549,24 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(dataVersion:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member", "docComment": "/**\n * The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "dataVersion" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly dataVersion: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!Version:class" }, { "kind": "Content", @@ -708,27 +576,19 @@ "releaseTag": "Public", "name": "dataVersion", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(description:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#description:member", "docComment": "/**\n * Description of the WebPart\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "description" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly description: " }, { "kind": "Content", @@ -742,27 +602,19 @@ "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(disableReactivePropertyChanges:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member", "docComment": "/**\n * This property is used to change the web part's property pane interaction from Reactive to NonReactive.\n *\n * @remarks\n *\n * The default behavior is Reactive.\n *\n * Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can see instant updates. This helps the page creator get instant feedback and decide if they should keep the new configuration changes or not.\n *\n * NonReactive implies that the configuration changes are transmitted to the web part only after \"Apply\" PropertyPane button is clicked.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "disableReactivePropertyChanges" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly disableReactivePropertyChanges: " }, { "kind": "Content", @@ -776,31 +628,24 @@ "releaseTag": "Public", "name": "disableReactivePropertyChanges", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(displayMode:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#displayMode:member", "docComment": "/**\n * This property is the current display mode of the web part.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "displayMode" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly displayMode: " }, { "kind": "Reference", - "text": "DisplayMode" + "text": "DisplayMode", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum" }, { "kind": "Content", @@ -810,31 +655,24 @@ "releaseTag": "Public", "name": "displayMode", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Method", - "canonicalReference": "(getPropertyPaneConfiguration:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)", "docComment": "/**\n * This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the configuration for the PropertyPane.\n *\n * This API is not invoked until the 'loadPropertyPaneResources' promise is resolved.\n *\n * See IPropertyPane and other PropertyPane integration wiki documentation for more details.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "getPropertyPaneConfiguration" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected getPropertyPaneConfiguration(): " }, { "kind": "Reference", - "text": "IPropertyPaneConfiguration" + "text": "IPropertyPaneConfiguration", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface" }, { "kind": "Content", @@ -843,38 +681,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "getPropertyPaneConfiguration" }, { "kind": "Method", - "canonicalReference": "(onAfterDeserialize:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)", "docComment": "/**\n * This API is called after the web part is deserialized to an object, right before the property bag is populated.\n *\n * @remarks\n *\n * The default implementation is a no-op. A web part developer can override this API if the deserialized object does not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate the property bag right after the data is deserialized to an object.\n *\n * An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag.\n *\n * @param deserializedObject - The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the web part\n *\n * @param dataVersion - The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older web part. Web parts can define their data version by overriding the dataVersion property.\n *\n * @returns The property bag of the web part\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onAfterDeserialize" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "deserializedObject" - }, - { - "kind": "Content", - "text": ": " + "text": "protected onAfterDeserialize(deserializedObject: " }, { "kind": "Content", @@ -882,26 +704,19 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "dataVersion" - }, - { - "kind": "Content", - "text": ": " + "text": ", dataVersion: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!Version:class" }, { "kind": "Content", "text": "): " }, { - "kind": "Reference", + "kind": "Content", "text": "TProperties" }, { @@ -911,24 +726,24 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 5, + "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "deserializedObject", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "dataVersion", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -936,20 +751,12 @@ }, { "kind": "Method", - "canonicalReference": "(onAfterPropertyPaneChangesApplied:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)", "docComment": "/**\n * This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onAfterPropertyPaneChangesApplied" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onAfterPropertyPaneChangesApplied(): " }, { "kind": "Content", @@ -962,30 +769,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onAfterPropertyPaneChangesApplied" }, { "kind": "Method", - "canonicalReference": "(onBeforeSerialize:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)", "docComment": "/**\n * This event method is called before the web part is serialized.\n *\n * @remarks\n *\n * The default implementation is a no-op. The serialization process serializes the web part property bag i.e. this.properties. This API gives the web part a chance to update it's property bag before the serialization happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onBeforeSerialize" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onBeforeSerialize(): " }, { "kind": "Content", @@ -998,46 +797,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onBeforeSerialize" }, { "kind": "Method", - "canonicalReference": "(onDisplayModeChanged:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)", "docComment": "/**\n * This event method is called when the display mode of a web part is changed.\n *\n * @remarks\n *\n * The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode.\n *\n * @param oldDisplayMode - The old display mode.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " + "text": "protected onDisplayModeChanged(oldDisplayMode: " }, { "kind": "Reference", - "text": "onDisplayModeChanged" + "text": "DisplayMode", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum" }, { "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "oldDisplayMode" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "DisplayMode" - }, - { - "kind": "Content", - "text": "): " + "text": "): " }, { "kind": "Content", @@ -1050,17 +834,17 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "oldDisplayMode", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1068,20 +852,12 @@ }, { "kind": "Method", - "canonicalReference": "(onDispose:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)", "docComment": "/**\n * This API should be used to refresh the contents of the PropertyPane.\n *\n * @remarks\n *\n * This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onDispose" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onDispose(): " }, { "kind": "Content", @@ -1094,34 +870,27 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onDispose" }, { "kind": "Method", - "canonicalReference": "(onInit:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)", "docComment": "/**\n * This event method is called when the web part is initialized.\n *\n * @remarks\n *\n * This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onInit" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onInit(): " }, { "kind": "Reference", - "text": "Promise" + "text": "Promise", + "canonicalReference": "!Promise:class" }, { "kind": "Content", @@ -1134,30 +903,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onInit" }, { "kind": "Method", - "canonicalReference": "(onPropertyPaneConfigurationComplete:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)", "docComment": "/**\n * This API is invoked when the configuration is completed on the PropertyPane.\n *\n * @remarks\n *\n * This event method is invoked in the following cases:\n *\n * - When the CONFIGURATION_COMPLETE_TIMEOUT((currently the value is 5 secs) elapses after the last change.\n *\n * - When user clicks the \"X\" (close) button before the CONFIGURATION_COMPLETE_TIMEOUT elapses.\n *\n * - When user clicks the 'Apply' button before the CONFIGURATION_COMPLETE_TIMEOUT elapses.\n *\n * - When the user switches web parts then the current web part gets this event.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onPropertyPaneConfigurationComplete" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onPropertyPaneConfigurationComplete(): " }, { "kind": "Content", @@ -1170,30 +931,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onPropertyPaneConfigurationComplete" }, { "kind": "Method", - "canonicalReference": "(onPropertyPaneConfigurationStart:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)", "docComment": "/**\n * This event method is invoked when the configuration starts on the PropertyPane.\n *\n * @remarks\n *\n * This event method is invoked in the following cases:\n *\n * - When the PropertyPane is opened.\n *\n * - When the user switches web parts then the new web part gets this event.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onPropertyPaneConfigurationStart" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onPropertyPaneConfigurationStart(): " }, { "kind": "Content", @@ -1206,38 +959,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onPropertyPaneConfigurationStart" }, { "kind": "Method", - "canonicalReference": "(onPropertyPaneFieldChanged:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)", "docComment": "/**\n * This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode.\n *\n * @param propertyPath - JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of `__CustomField_`.\n *\n * @param oldValue - Old value of the property. This value could be undefined/empty in the case of custom field.\n *\n * @param newValue - New value of the property. This value could be undefined/empty in the case of custom field.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onPropertyPaneFieldChanged" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "propertyPath" - }, - { - "kind": "Content", - "text": ": " + "text": "protected onPropertyPaneFieldChanged(propertyPath: " }, { "kind": "Content", @@ -1245,15 +982,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "oldValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", oldValue: " }, { "kind": "Content", @@ -1261,15 +990,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "newValue" - }, - { - "kind": "Content", - "text": ": " + "text": ", newValue: " }, { "kind": "Content", @@ -1290,31 +1011,31 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "propertyPath", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "oldValue", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "newValue", "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 14 + "startIndex": 5, + "endIndex": 6 } } ], @@ -1322,20 +1043,12 @@ }, { "kind": "Method", - "canonicalReference": "(onPropertyPaneRendered:instance,0)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)", "docComment": "/**\n * This API is invoked when the PropertyPane is rendered.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected " - }, - { - "kind": "Reference", - "text": "onPropertyPaneRendered" - }, - { - "kind": "Content", - "text": "(): " + "text": "protected onPropertyPaneRendered(): " }, { "kind": "Content", @@ -1348,30 +1061,22 @@ ], "isStatic": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "onPropertyPaneRendered" }, { "kind": "Property", - "canonicalReference": "(previewImageUrl:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member", "docComment": "/**\n * This property points to the preview image for the web part. The base implementation returns undefined. Web parts that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "previewImageUrl" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly previewImageUrl: " }, { "kind": "Content", @@ -1385,30 +1090,22 @@ "releaseTag": "Public", "name": "previewImageUrl", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(properties:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#properties:member", "docComment": "/**\n * This property is the pointer to the custom property bag of the web part.\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "properties" + "text": "protected readonly properties: " }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", "text": "TProperties" }, { @@ -1419,31 +1116,24 @@ "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(propertiesMetadata:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member", "docComment": "/**\n * This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data.\n *\n * @remarks\n *\n * See {@link IWebPartPropertiesMetadata} for more information about how to define metadata\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "propertiesMetadata" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly propertiesMetadata: " }, { "kind": "Reference", - "text": "IWebPartPropertiesMetadata" + "text": "IWebPartPropertiesMetadata", + "canonicalReference": "@microsoft/sp-webpart-base!~IWebPartPropertiesMetadata:interface" }, { "kind": "Content", @@ -1457,27 +1147,19 @@ "releaseTag": "Public", "name": "propertiesMetadata", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(title:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#title:member", "docComment": "/**\n * Title of the WebPart\n *\n * @readonly\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "protected readonly " - }, - { - "kind": "Reference", - "text": "title" - }, - { - "kind": "Content", - "text": ": " + "text": "protected readonly title: " }, { "kind": "Content", @@ -1491,43 +1173,36 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 5, - "endIndex": 7 + "startIndex": 3, + "endIndex": 5 }, "implementsTokenRanges": [ { - "startIndex": 8, - "endIndex": 10 + "startIndex": 6, + "endIndex": 8 } ] }, { "kind": "Class", - "canonicalReference": "(BaseWebPartContext:class)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPartContext:class", "docComment": "/**\n * Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client.\n *\n * This base is to be extended by UI-specific WebPart's base.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseWebPartContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "BaseWebPartContext" - }, - { - "kind": "Content", - "text": " extends " + "text": "export default class BaseWebPartContext extends " }, { "kind": "Reference", - "text": "BaseComponentContext" + "text": "BaseComponentContext", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext:class" }, { "kind": "Content", @@ -1539,24 +1214,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(formFactor:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member", "docComment": "/**\n * Form factor of the web part.\n *\n * @remarks\n *\n * Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "formFactor" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly formFactor: " }, { "kind": "Reference", - "text": "WebPartFormFactor" + "text": "WebPartFormFactor", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartFormFactor:enum" }, { "kind": "Content", @@ -1566,31 +1234,24 @@ "releaseTag": "Beta", "name": "formFactor", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(manifest:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member", "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "manifest" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly manifest: " }, { "kind": "Reference", - "text": "IClientSideWebPartManifestInstance" + "text": "IClientSideWebPartManifestInstance", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface" }, { "kind": "Content", @@ -1604,31 +1265,24 @@ "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(propertyPane:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member", "docComment": "/**\n * Accessor for common web part property pane operations.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "propertyPane" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly propertyPane: " }, { "kind": "Reference", - "text": "IPropertyPaneAccessor" + "text": "IPropertyPaneAccessor", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface" }, { "kind": "Content", @@ -1638,27 +1292,19 @@ "releaseTag": "Public", "name": "propertyPane", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(webPartTag:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member", "docComment": "/**\n * Web part tag to be used for logging and telemetry.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "webPartTag" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly webPartTag: " }, { "kind": "Content", @@ -1672,34 +1318,26 @@ "releaseTag": "Public", "name": "webPartTag", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Enum", - "canonicalReference": "(DynamicDataSharedDepth:enum)", + "canonicalReference": "@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum", "docComment": "/**\n * Enum for the possible values of shared depth of the dynamic data reference.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare enum " - }, - { - "kind": "Reference", - "text": "DynamicDataSharedDepth" - }, - { - "kind": "Content", - "text": " " + "text": "export declare enum DynamicDataSharedDepth " } ], "releaseTag": "Public", @@ -1707,16 +1345,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "None", + "canonicalReference": "@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member", "docComment": "/**\n * Indicates that nothing is shared.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "None" - }, { "kind": "Content", - "text": " = " + "text": "None = " }, { "kind": "Content", @@ -1726,22 +1360,18 @@ "releaseTag": "Public", "name": "None", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Property", + "canonicalReference": "@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member", "docComment": "/**\n * Indicates that both the dynamic data source and the property are shared.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Property" - }, { "kind": "Content", - "text": " = " + "text": "Property = " }, { "kind": "Content", @@ -1751,22 +1381,18 @@ "releaseTag": "Public", "name": "Property", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Source", + "canonicalReference": "@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member", "docComment": "/**\n * Indicates that the dynamic data source is shared.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Source" - }, { "kind": "Content", - "text": " = " + "text": "Source = " }, { "kind": "Content", @@ -1776,28 +1402,20 @@ "releaseTag": "Public", "name": "Source", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Interface", - "canonicalReference": "(IClientSideWebPartStatusRenderer:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface", "docComment": "/**\n * Interface to be implemented by a component that should display the loading indicator and error messages for a web part.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default interface " - }, - { - "kind": "Reference", - "text": "IClientSideWebPartStatusRenderer" - }, - { - "kind": "Content", - "text": " " + "text": "export default interface IClientSideWebPartStatusRenderer " } ], "releaseTag": "Public", @@ -1805,28 +1423,17 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(clearError:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)", "docComment": "/**\n * Clear the webpart error message.\n *\n * @param domElement - the web part container div.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clearError" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "domElement" - }, { "kind": "Content", - "text": ": " + "text": "clearError(domElement: " }, { "kind": "Reference", - "text": "HTMLElement" + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", @@ -1842,17 +1449,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "domElement", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1860,28 +1467,17 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(clearLoadingIndicator:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)", "docComment": "/**\n * Clear the loading indicator.\n *\n * @param domElement - the web part container div.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "clearLoadingIndicator" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "domElement" - }, { "kind": "Content", - "text": ": " + "text": "clearLoadingIndicator(domElement: " }, { "kind": "Reference", - "text": "Element" + "text": "Element", + "canonicalReference": "!Element:interface" }, { "kind": "Content", @@ -1897,17 +1493,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "domElement", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -1915,40 +1511,21 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(displayLoadingIndicator:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)", "docComment": "/**\n * Display a loading spinner.\n *\n * @param domElement - the web part container div.\n *\n * @param loadingMessage - the message to be displayed when the loading spinner id displayed.\n *\n * @param timeout - timeout to render the loading indicator. Default is 1500ms.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "displayLoadingIndicator" - }, { "kind": "Content", - "text": "(" + "text": "displayLoadingIndicator(domElement: " }, { "kind": "Reference", - "text": "domElement" + "text": "Element", + "canonicalReference": "!Element:interface" }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Element" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "loadingMessage" - }, - { - "kind": "Content", - "text": ": " + "text": ", loadingMessage: " }, { "kind": "Content", @@ -1956,15 +1533,7 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "timeout" - }, - { - "kind": "Content", - "text": "?: " + "text": ", timeout?: " }, { "kind": "Content", @@ -1984,31 +1553,31 @@ } ], "returnTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 + "startIndex": 7, + "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "domElement", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "loadingMessage", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 9 + "startIndex": 3, + "endIndex": 4 } }, { "parameterName": "timeout", "parameterTypeTokenRange": { - "startIndex": 12, - "endIndex": 13 + "startIndex": 5, + "endIndex": 6 } } ], @@ -2016,52 +1585,34 @@ }, { "kind": "MethodSignature", - "canonicalReference": "(renderError:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)", "docComment": "/**\n * Render the provided error message in the webpart container div.\n *\n * @param domElement - the web part container div.\n *\n * @param error - the error message.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "renderError" - }, { "kind": "Content", - "text": "(" + "text": "renderError(domElement: " }, { "kind": "Reference", - "text": "domElement" + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", - "text": ": " + "text": ", error: " }, { "kind": "Reference", - "text": "HTMLElement" + "text": "Error", + "canonicalReference": "!Error:interface" }, { "kind": "Content", - "text": ", " + "text": " | string" }, { - "kind": "Reference", - "text": "error" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "Error" - }, - { - "kind": "Content", - "text": " | string" - }, - { - "kind": "Content", - "text": "): " + "kind": "Content", + "text": "): " }, { "kind": "Content", @@ -2073,24 +1624,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 + "startIndex": 6, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "domElement", "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "error", "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 + "startIndex": 3, + "endIndex": 5 } } ], @@ -2101,32 +1652,21 @@ }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataSharedPropertyConfiguration:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface", "docComment": "/**\n * Configuration related to a shared property.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataSharedPropertyConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IDynamicDataSharedPropertyConfiguration extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IDynamicDataSharedPropertyConfiguration" + "text": "IDynamicDataSharedPropertyConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface" }, { "kind": "Content", @@ -2138,39 +1678,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataSharedPropertyFilters:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface", "docComment": "/**\n * Property pane dynamic data property filters.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataSharedPropertyFilters" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IDynamicDataSharedPropertyFilters extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IDynamicDataSharedPropertyFilters" + "text": "IDynamicDataSharedPropertyFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface" }, { "kind": "Content", @@ -2182,39 +1711,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataSharedSourceConfiguration:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface", "docComment": "/**\n * Configuration related to a shared source.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataSharedSourceConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IDynamicDataSharedSourceConfiguration extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IDynamicDataSharedSourceConfiguration" + "text": "IDynamicDataSharedSourceConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface" }, { "kind": "Content", @@ -2226,39 +1744,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IDynamicDataSharedSourceFilters:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface", "docComment": "/**\n * Property pane dynamic data source filters.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IDynamicDataSharedSourceFilters" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IDynamicDataSharedSourceFilters extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IDynamicDataSharedSourceFilters" + "text": "IDynamicDataSharedSourceFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface" }, { "kind": "Content", @@ -2270,27 +1777,19 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IMicrosoftTeams:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams:interface", "docComment": "/**\n * Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IMicrosoftTeams" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IMicrosoftTeams " } ], "releaseTag": "Public", @@ -2298,28 +1797,21 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "context", - "docComment": "/**\n * Microsoft Teams Context.\n * {@inheritDoc @microsoft/teams-js#Context}\n */\n", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams#context:member", + "docComment": "/**\n * {@inheritDoc @microsoft/teams-js#Context}\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "context" - }, { "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "microsoftTeams" + "text": "context: " }, { "kind": "Content", - "text": "." + "text": "microsoftTeams." }, { "kind": "Reference", - "text": "Context" + "text": "Context", + "canonicalReference": "@microsoft/teams-js!Context:interface" }, { "kind": "Content", @@ -2329,41 +1821,75 @@ "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } }, { "kind": "PropertySignature", - "canonicalReference": "teamsJs", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member", "docComment": "/**\n * Microsoft Teams SDK.\n */\n", "excerptTokens": [ { - "kind": "Reference", - "text": "teamsJs" + "kind": "Content", + "text": "teamsJs: " }, { "kind": "Content", - "text": ": " + "text": "typeof microsoftTeams" }, { "kind": "Content", - "text": "typeof " + "text": ";" + } + ], + "releaseTag": "Public", + "name": "teamsJs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-webpart-base!IOffice:interface", + "docComment": "/**\n * Provides access to the Office context. Only provided when the web part is loaded in Office.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IOffice " + } + ], + "releaseTag": "Beta", + "name": "IOffice", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IOffice#context:member", + "docComment": "/**\n * Microsoft Office SDK.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "context: " }, { "kind": "Reference", - "text": "microsoftTeams" + "text": "Office.Context", + "canonicalReference": "!Office.Context:interface" }, { "kind": "Content", "text": ";" } ], - "releaseTag": "Public", - "name": "teamsJs", + "releaseTag": "Beta", + "name": "context", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -2371,20 +1897,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneAccessor:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface", "docComment": "/**\n * Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneAccessor" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IPropertyPaneAccessor " } ], "releaseTag": "Public", @@ -2392,16 +1910,12 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "(close:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)", "docComment": "/**\n * This API should be used to close the PropertyPane to help configure the web part.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "close" - }, { "kind": "Content", - "text": "(): " + "text": "close(): " }, { "kind": "Content", @@ -2413,26 +1927,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "MethodSignature", - "canonicalReference": "(isPropertyPaneOpen:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)", "docComment": "/**\n * Returns true if the PropertyPane is open.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isPropertyPaneOpen" - }, { "kind": "Content", - "text": "(): " + "text": "isPropertyPaneOpen(): " }, { "kind": "Content", @@ -2444,26 +1954,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "isPropertyPaneOpen" }, { "kind": "MethodSignature", - "canonicalReference": "(isRenderedByWebPart:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)", "docComment": "/**\n * Indicates whether the PropertyPane was initially opened by the web part.\n *\n * @remarks\n *\n * For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isRenderedByWebPart" - }, { "kind": "Content", - "text": "(): " + "text": "isRenderedByWebPart(): " }, { "kind": "Content", @@ -2475,26 +1981,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "isRenderedByWebPart" }, { "kind": "MethodSignature", - "canonicalReference": "(open:0)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)", "docComment": "/**\n * This API should be used to open the PropertyPane to help configure the web part.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "open" - }, { "kind": "Content", - "text": "(): " + "text": "open(): " }, { "kind": "Content", @@ -2506,26 +2008,30 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "open" }, { "kind": "MethodSignature", - "canonicalReference": "(refresh:0)", - "docComment": "/**\n * This API should be used to invoke the PropertyPane to help configure the web part.\n *\n * @remarks\n *\n * This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact.\n */\n", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)", + "docComment": "/**\n * This API should be used to open the Details PropertyPane to help configure the items in the web part.\n *\n * @remarks\n *\n * This API is mainly used for configuring Details, which is different from configuring the web part itself.\n *\n * @param context - Add additional context for property pane\n */\n", "excerptTokens": [ { - "kind": "Reference", - "text": "refresh" + "kind": "Content", + "text": "openDetails(context?: " }, { "kind": "Content", - "text": "(): " + "text": "any" + }, + { + "kind": "Content", + "text": "): " }, { "kind": "Content", @@ -2537,11 +2043,46 @@ } ], "returnTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "openDetails" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)", + "docComment": "/**\n * This API should be used to invoke the PropertyPane to help configure the web part.\n *\n * @remarks\n *\n * This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "refresh(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, "parameters": [], "name": "refresh" } @@ -2550,32 +2091,21 @@ }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneButtonProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface", "docComment": "/**\n * PropertyPane button props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneButtonProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneButtonProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneButtonProps" + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface" }, { "kind": "Content", @@ -2587,39 +2117,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneCheckboxProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface", "docComment": "/**\n * PropertyPane CheckBox component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneCheckboxProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneCheckboxProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneCheckboxProps" + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface" }, { "kind": "Content", @@ -2631,39 +2150,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneChoiceGroupOption:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface", "docComment": "/**\n * PropertyPane ChoiceGroup option props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneChoiceGroupOption" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneChoiceGroupOption extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneChoiceGroupOption" + "text": "IPropertyPaneChoiceGroupOption", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface" }, { "kind": "Content", @@ -2675,39 +2183,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneChoiceGroupOptionIconProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface", "docComment": "/**\n * PropertyPane ChoiceGroup icon props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneChoiceGroupOptionIconProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneChoiceGroupOptionIconProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneChoiceGroupOptionIconProps" + "text": "IPropertyPaneChoiceGroupOptionIconProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface" }, { "kind": "Content", @@ -2719,39 +2216,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneChoiceGroupProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface", "docComment": "/**\n * PropertyPane ChoiceGroup props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneChoiceGroupProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneChoiceGroupProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneChoiceGroupProps" + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface" }, { "kind": "Content", @@ -2763,39 +2249,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneConditionalGroup:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface", "docComment": "/**\n * Property pane conditional group.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneConditionalGroup" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneConditionalGroup extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneConditionalGroup" + "text": "IPropertyPaneConditionalGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface" }, { "kind": "Content", @@ -2807,39 +2282,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneConfiguration:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface", "docComment": "/**\n * Web part configuration settings\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneConfiguration" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneConfiguration extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneConfiguration" + "text": "IPropertyPaneConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface" }, { "kind": "Content", @@ -2851,39 +2315,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneCustomFieldProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface", "docComment": "/**\n * PropertyPane CustomPropertyField props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneCustomFieldProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneCustomFieldProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneCustomFieldProps" + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface" }, { "kind": "Content", @@ -2895,39 +2348,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDropdownCalloutProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface", "docComment": "/**\n * PropertyPane dropdown callout properties.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDropdownCalloutProps" + "text": "export interface IPropertyPaneDropdownCalloutProps extends " }, { "kind": "Content", - "text": " extends " + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "SPPropertyPane" - }, - { - "kind": "Content", - "text": "." - }, - { - "kind": "Reference", - "text": "IPropertyPaneDropdownCalloutProps" + "text": "IPropertyPaneDropdownCalloutProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface" }, { "kind": "Content", @@ -2939,39 +2381,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDropdownOption:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface", "docComment": "/**\n * PropertyPane drop down options.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDropdownOption" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneDropdownOption extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneDropdownOption" + "text": "IPropertyPaneDropdownOption", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface" }, { "kind": "Content", @@ -2983,39 +2414,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDropdownProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface", "docComment": "/**\n * PropertyPane drop down component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDropdownProps" + "text": "export interface IPropertyPaneDropdownProps extends " }, { "kind": "Content", - "text": " extends " + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "SPPropertyPane" - }, - { - "kind": "Content", - "text": "." - }, - { - "kind": "Reference", - "text": "IPropertyPaneDropdownProps" + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface" }, { "kind": "Content", @@ -3027,39 +2447,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDynamicFieldFilters:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface", "docComment": "/**\n * Property pane dynamic field filters which is an intersection of both source and property filters.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDynamicFieldFilters" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneDynamicFieldFilters extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneDynamicFieldFilters" + "text": "IPropertyPaneDynamicFieldFilters", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type" }, { "kind": "Content", @@ -3071,39 +2480,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDynamicFieldProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface", "docComment": "/**\n * PropertyPaneDynamicField props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDynamicFieldProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneDynamicFieldProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneDynamicFieldProps" + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface" }, { "kind": "Content", @@ -3115,39 +2513,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDynamicFieldSetProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface", "docComment": "/**\n * PropertyPane DynamicFieldSet props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDynamicFieldSetProps" + "text": "export interface IPropertyPaneDynamicFieldSetProps extends " }, { "kind": "Content", - "text": " extends " + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "SPPropertyPane" - }, - { - "kind": "Content", - "text": "." - }, - { - "kind": "Reference", - "text": "IPropertyPaneDynamicFieldSetProps" + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface" }, { "kind": "Content", @@ -3159,39 +2546,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneDynamicTextFieldProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface", "docComment": "/**\n * `PropertyPaneDynamicData` component props.\n *\n * @deprecated\n *\n * - This has been replaced by IPropertyPaneDynamicFieldProps\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneDynamicTextFieldProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneDynamicTextFieldProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneDynamicTextFieldProps" + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface" }, { "kind": "Content", @@ -3203,99 +2579,74 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneField:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface", "docComment": "/**\n * PropertyPane field.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneField" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TProperties" - }, - { - "kind": "Content", - "text": "> extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" - }, - { - "kind": "Content", - "text": "." - }, - { - "kind": "Reference", - "text": "IPropertyPaneField" + "text": "export interface IPropertyPaneField extends " }, { "kind": "Content", - "text": "<" + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "TProperties" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" }, { "kind": "Content", - "text": "> " + "text": " " } ], "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], "name": "IPropertyPaneField", "members": [], "extendsTokenRanges": [ { - "startIndex": 5, - "endIndex": 11 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneGroup:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneGroup:interface", "docComment": "/**\n * PropertyPane group. Group is part of the PropertyPanePage.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneGroup" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneGroup extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneGroup" + "text": "IPropertyPaneGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup:interface" }, { "kind": "Content", @@ -3307,39 +2658,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneLabelProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface", "docComment": "/**\n * PropertyPaneLabel component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneLabelProps" + "text": "export interface IPropertyPaneLabelProps extends " }, { "kind": "Content", - "text": " extends " + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "SPPropertyPane" - }, - { - "kind": "Content", - "text": "." - }, - { - "kind": "Reference", - "text": "IPropertyPaneLabelProps" + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface" }, { "kind": "Content", @@ -3351,39 +2691,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneLinkProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface", "docComment": "/**\n * PropertyPaneLink component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneLinkProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneLinkProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneLinkProps" + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface" }, { "kind": "Content", @@ -3395,39 +2724,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPanePage:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPanePage:interface", "docComment": "/**\n * PropertyPanePage interface.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPanePage" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPanePage extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPanePage" + "text": "IPropertyPanePage", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage:interface" }, { "kind": "Content", @@ -3439,39 +2757,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPanePageHeader:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface", "docComment": "/**\n * PropertyPane header. This header remains same for all the pages.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPanePageHeader" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPanePageHeader extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPanePageHeader" + "text": "IPropertyPanePageHeader", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePageHeader:interface" }, { "kind": "Content", @@ -3483,39 +2790,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneSliderProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface", "docComment": "/**\n * PropertyPaneSliderProps component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneSliderProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneSliderProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneSliderProps" + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface" }, { "kind": "Content", @@ -3527,39 +2823,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneTextFieldProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface", "docComment": "/**\n * PropertyPaneTextField component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneTextFieldProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneTextFieldProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneTextFieldProps" + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface" }, { "kind": "Content", @@ -3571,39 +2856,28 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(IPropertyPaneToggleProps:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface", "docComment": "/**\n * PropertyPaneToggle component props.\n *\n * @deprecated\n *\n * This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IPropertyPaneToggleProps" - }, - { - "kind": "Content", - "text": " extends " - }, - { - "kind": "Reference", - "text": "SPPropertyPane" + "text": "export interface IPropertyPaneToggleProps extends " }, { "kind": "Content", - "text": "." + "text": "SPPropertyPane." }, { "kind": "Reference", - "text": "IPropertyPaneToggleProps" + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface" }, { "kind": "Content", @@ -3615,27 +2889,19 @@ "members": [], "extendsTokenRanges": [ { - "startIndex": 3, - "endIndex": 7 + "startIndex": 1, + "endIndex": 4 } ] }, { "kind": "Interface", - "canonicalReference": "(ISDKs:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!ISDKs:interface", "docComment": "/**\n * Conditional set of SDKs provided by SPFx dependent on the environment.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISDKs" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISDKs " } ], "releaseTag": "Public", @@ -3643,31 +2909,54 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "microsoftTeams", + "canonicalReference": "@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member", "docComment": "/**\n * Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest}\n */\n", "excerptTokens": [ + { + "kind": "Content", + "text": "microsoftTeams?: " + }, { "kind": "Reference", - "text": "microsoftTeams" + "text": "IMicrosoftTeams", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams:interface" }, { "kind": "Content", - "text": "?: " + "text": ";" + } + ], + "releaseTag": "Public", + "name": "microsoftTeams", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!ISDKs#office:member", + "docComment": "/**\n * Contextual information about the current Office app. This object will only be defined if a component is being hosted in an Office app.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office}\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "office?: " }, { "kind": "Reference", - "text": "IMicrosoftTeams" + "text": "IOffice", + "canonicalReference": "@microsoft/sp-webpart-base!IOffice:interface" }, { "kind": "Content", "text": ";" } ], - "releaseTag": "Public", - "name": "microsoftTeams", + "releaseTag": "Beta", + "name": "office", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3675,20 +2964,12 @@ }, { "kind": "Interface", - "canonicalReference": "(ISerializedServerProcessedData:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface", "docComment": "/**\n * Contains collections of data that can be processed by server side services like search index and link fixup\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISerializedServerProcessedData" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISerializedServerProcessedData " } ], "releaseTag": "Public", @@ -3696,28 +2977,16 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "htmlStrings", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData#htmlStrings:member", "docComment": "/**\n * A key-value map where keys are string identifiers and values are rich text with HTML format.\n *\n * @remarks\n *\n * SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myRichDescription': '
Some standard HTML contentA Link
'\n * 'anotherRichText':
Some red text
\n * }\n * ```\n *\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "htmlStrings" - }, - { - "kind": "Content", - "text": "?: " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "htmlStrings?: " }, { "kind": "Content", - "text": ": string]: string;\n }" + "text": "{\n [key: string]: string;\n }" }, { "kind": "Content", @@ -3727,34 +2996,22 @@ "releaseTag": "Public", "name": "htmlStrings", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } - }, - { - "kind": "PropertySignature", - "canonicalReference": "imageSources", - "docComment": "/**\n * A key-value map where keys are string identifiers and values are image sources.\n *\n * @remarks\n *\n * SharePoint servers treat the values as image sources and run services like search index and link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myImage1': 'http://res.contoso.com/path/to/file'\n * 'myImage2': 'https://res.contoso.com/someName.jpg'\n * }\n * ```\n *\n */\n", - "excerptTokens": [ - { - "kind": "Reference", - "text": "imageSources" - }, - { - "kind": "Content", - "text": "?: " - }, + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData#imageSources:member", + "docComment": "/**\n * A key-value map where keys are string identifiers and values are image sources.\n *\n * @remarks\n *\n * SharePoint servers treat the values as image sources and run services like search index and link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myImage1': 'http://res.contoso.com/path/to/file'\n * 'myImage2': 'https://res.contoso.com/someName.jpg'\n * }\n * ```\n *\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "imageSources?: " }, { "kind": "Content", - "text": ": string]: string;\n }" + "text": "{\n [key: string]: string;\n }" }, { "kind": "Content", @@ -3764,34 +3021,22 @@ "releaseTag": "Public", "name": "imageSources", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "links", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData#links:member", "docComment": "/**\n * A key-value map where keys are string identifiers and values are links.\n *\n * @remarks\n *\n * SharePoint servers treat the values as links and run services like link fixup on them.\n *\n * Example:\n * ```\n * {\n * 'myWebURL': 'http://contoso.com'\n * 'myFileLink': 'https://res.contoso.com/file.docx'\n * }\n * ```\n *\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "links" - }, - { - "kind": "Content", - "text": "?: " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "links?: " }, { "kind": "Content", - "text": ": string]: string;\n }" + "text": "{\n [key: string]: string;\n }" }, { "kind": "Content", @@ -3801,34 +3046,22 @@ "releaseTag": "Public", "name": "links", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "searchablePlainTexts", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData#searchablePlainTexts:member", "docComment": "/**\n * A key-value map where keys are string identifiers and values are strings that should be search indexed.\n *\n * @remarks\n *\n * The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, but are not treated as valid HTML. So, other services such as link fixup will not run on them.\n *\n * Example:\n * ```\n * {\n * 'justSomeText': 'This is some plain text',\n * 'anotherText': 'Can have characters here: \"<>&\\''\n * }\n * ```\n *\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "searchablePlainTexts" - }, { "kind": "Content", - "text": "?: " - }, - { - "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "key" + "text": "searchablePlainTexts?: " }, { "kind": "Content", - "text": ": string]: string;\n }" + "text": "{\n [key: string]: string;\n }" }, { "kind": "Content", @@ -3838,8 +3071,8 @@ "releaseTag": "Public", "name": "searchablePlainTexts", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } } ], @@ -3847,20 +3080,12 @@ }, { "kind": "Interface", - "canonicalReference": "(ISerializedWebPartData:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedWebPartData:interface", "docComment": "/**\n * This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "ISerializedWebPartData" - }, - { - "kind": "Content", - "text": " " + "text": "export interface ISerializedWebPartData " } ], "releaseTag": "Public", @@ -3868,20 +3093,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "dataVersion", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member", "docComment": "/**\n * Web part data version.\n *\n * @remarks\n *\n * Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information.\n *\n * Supported values: MAJOR.MINOR\n *\n * Example: `\"1.0\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dataVersion" - }, { "kind": "Content", - "text": ": " + "text": "dataVersion: " }, { "kind": "Reference", - "text": "Version" + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!Version:class" }, { "kind": "Content", @@ -3891,34 +3113,22 @@ "releaseTag": "Public", "name": "dataVersion", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "dynamicDataPaths", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member", "docComment": "/**\n * Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part.\n *\n * @remarks\n *\n * The key is the path within the web part properties, and the value is the dynamic data internal id.\n *\n * Example:\n * ```\n * {\n * 'pageContextUser':\n * 'PageContext:user',\n * 'anotherWebPartProperty':\n * 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n * }\n * ```\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dynamicDataPaths" - }, { "kind": "Content", - "text": "?: " + "text": "dynamicDataPaths?: " }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "path" - }, - { - "kind": "Content", - "text": ": string]: string;\n }" + "text": "{\n [path: string]: string;\n }" }, { "kind": "Content", @@ -3928,34 +3138,22 @@ "releaseTag": "Beta", "name": "dynamicDataPaths", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "dynamicDataValues", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member", "docComment": "/**\n * Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part.\n *\n * @remarks\n *\n * The key is the path within the web part properties, and the value is the dynamic data static value.\n *\n * Example:\n * ```\n * {\n * 'aStringProperty': 'thisIsAString',\n * 'aBooleanProperty': true\n * }\n * ```\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dynamicDataValues" - }, - { - "kind": "Content", - "text": "?: " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "path" + "text": "dynamicDataValues?: " }, { "kind": "Content", - "text": ": string]: any;\n }" + "text": "{\n [path: string]: any;\n }" }, { "kind": "Content", @@ -3965,22 +3163,18 @@ "releaseTag": "Beta", "name": "dynamicDataValues", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "properties", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member", "docComment": "/**\n * Web part specific properties. The individual web part owns the definition of these properties.\n *\n * @remarks\n *\n * Used by the web part to manage its internal metadata and config data. The framework code never touches these properties.\n *\n * Supported values: any JSON stringifiable object hierarchy.\n *\n * Example: `{ 'value': 'text value' }`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "properties" - }, { "kind": "Content", - "text": "?: " + "text": "properties?: " }, { "kind": "Content", @@ -3994,26 +3188,23 @@ "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "serverProcessedContent", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member", "docComment": "/**\n * The collections of data that can be processed by server side services like search index and link fixup.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "serverProcessedContent" - }, { "kind": "Content", - "text": "?: " + "text": "serverProcessedContent?: " }, { "kind": "Reference", - "text": "ISerializedServerProcessedData" + "text": "ISerializedServerProcessedData", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface" }, { "kind": "Content", @@ -4023,8 +3214,8 @@ "releaseTag": "Public", "name": "serverProcessedContent", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4032,20 +3223,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IWebPartContext:interface)", - "docComment": "/**\n * The base context interface for client-side web parts.\n *\n * @remarks\n *\n * A \"context\" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc.\n *\n * @deprecated\n *\n * This interface will be removed in an upcoming release. Use the {@link WebPartContext} class instead.\n *\n * @public\n */\n", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext:interface", + "docComment": "/**\n * The base context interface for client-side web parts.\n *\n * @remarks\n *\n * A \"context\" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc.\n *\n * @deprecated\n *\n * - This interface will be removed in an upcoming release. Use the {@link WebPartContext} class instead.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "interface " - }, - { - "kind": "Reference", - "text": "IWebPartContext" - }, - { - "kind": "Content", - "text": " " + "text": "interface IWebPartContext " } ], "releaseTag": "Public", @@ -4053,24 +3236,17 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "domElement", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#domElement:member", "docComment": "/**\n * Reference to the DOM element that hosts this client-side component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "domElement" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly domElement: " }, { "kind": "Reference", - "text": "HTMLElement" + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", @@ -4080,63 +3256,23 @@ "releaseTag": "Public", "name": "domElement", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "graphHttpClient", - "docComment": "/**\n * GraphHttpClient instance scoped to this web part.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "graphHttpClient" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "GraphHttpClient" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "graphHttpClient", - "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "httpClient", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#httpClient:member", "docComment": "/**\n * HttpClient instance scoped to this web part.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly httpClient: " }, { "kind": "Reference", - "text": "httpClient" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "HttpClient" + "text": "HttpClient", + "canonicalReference": "@microsoft/sp-http!HttpClient:class" }, { "kind": "Content", @@ -4146,26 +3282,18 @@ "releaseTag": "Public", "name": "httpClient", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "instanceId", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#instanceId:member", "docComment": "/**\n * Web part instance id. This is a globally unique value.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "instanceId" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly instanceId: " }, { "kind": "Content", @@ -4179,30 +3307,23 @@ "releaseTag": "Public", "name": "instanceId", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "manifest", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#manifest:member", "docComment": "/**\n * Manifest for the client-side web part.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly manifest: " }, { "kind": "Reference", - "text": "manifest" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IClientSideWebPartManifestInstance" + "text": "IClientSideWebPartManifestInstance", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface" }, { "kind": "Content", @@ -4216,30 +3337,23 @@ "releaseTag": "Public", "name": "manifest", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 } }, { "kind": "PropertySignature", - "canonicalReference": "pageContext", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#pageContext:member", "docComment": "/**\n * SharePoint page context.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly pageContext: " }, { "kind": "Reference", - "text": "pageContext" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "PageContext" + "text": "PageContext", + "canonicalReference": "@microsoft/sp-page-context!PageContext:class" }, { "kind": "Content", @@ -4249,30 +3363,23 @@ "releaseTag": "Public", "name": "pageContext", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "propertyPane", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member", "docComment": "/**\n * Accessor for common web part property pane operations.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly propertyPane: " }, { "kind": "Reference", - "text": "propertyPane" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IPropertyPaneAccessor" + "text": "IPropertyPaneAccessor", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface" }, { "kind": "Content", @@ -4282,30 +3389,23 @@ "releaseTag": "Public", "name": "propertyPane", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "spHttpClient", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member", "docComment": "/**\n * SPHttpClient instance scoped to this web part.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly spHttpClient: " }, { "kind": "Reference", - "text": "spHttpClient" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "SPHttpClient" + "text": "SPHttpClient", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:class" }, { "kind": "Content", @@ -4315,30 +3415,23 @@ "releaseTag": "Public", "name": "spHttpClient", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "statusRenderer", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member", "docComment": "/**\n * Web part status renderer.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly statusRenderer: " }, { "kind": "Reference", - "text": "statusRenderer" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IClientSideWebPartStatusRenderer" + "text": "IClientSideWebPartStatusRenderer", + "canonicalReference": "@microsoft/sp-webpart-base!default:interface" }, { "kind": "Content", @@ -4348,26 +3441,18 @@ "releaseTag": "Public", "name": "statusRenderer", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "webPartTag", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member", "docComment": "/**\n * Web part tag to be used for logging and telemetry.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "webPartTag" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly webPartTag: " }, { "kind": "Content", @@ -4381,8 +3466,8 @@ "releaseTag": "Public", "name": "webPartTag", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4390,20 +3475,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IWebPartData:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData:interface", "docComment": "/**\n * This structure represents the serialized state of a web part.\n *\n * @remarks\n *\n * When the `serialize()` API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "interface " - }, - { - "kind": "Reference", - "text": "IWebPartData" - }, - { - "kind": "Content", - "text": " " + "text": "interface IWebPartData " } ], "releaseTag": "Public", @@ -4411,16 +3488,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "dataVersion", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#dataVersion:member", "docComment": "/**\n * Web part data version\n *\n * @remarks\n *\n * Note that data version is different from the version field in the manifest. The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information.\n *\n * Supported values: MAJOR.MINOR\n *\n * Example: `\"1.0\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dataVersion" - }, { "kind": "Content", - "text": ": " + "text": "dataVersion: " }, { "kind": "Content", @@ -4434,22 +3507,18 @@ "releaseTag": "Public", "name": "dataVersion", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "description", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#description:member", "docComment": "/**\n * Web part description\n *\n * @remarks\n *\n * Used to display the description of the web part.\n *\n * Supported values: string with the description.\n *\n * Example: `\"Text\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "description" - }, { "kind": "Content", - "text": "?: " + "text": "description?: " }, { "kind": "Content", @@ -4463,34 +3532,22 @@ "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "dynamicDataPaths", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member", "docComment": "/**\n * Paths for the dynamic data.\n *\n * @remarks\n *\n * This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within the web part properties, and the value is the dynamic data internal id.\n *\n * Example:\n * ```\n * {\n * 'pageContextUser':\n * 'PageContext:user',\n * 'anotherWebPartProperty':\n * 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'\n * }\n * ```\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dynamicDataPaths" - }, - { - "kind": "Content", - "text": "?: " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "path" + "text": "dynamicDataPaths?: " }, { "kind": "Content", - "text": ": string]: string;\n }" + "text": "{\n [path: string]: string;\n }" }, { "kind": "Content", @@ -4500,34 +3557,22 @@ "releaseTag": "Beta", "name": "dynamicDataPaths", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "dynamicDataValues", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member", "docComment": "/**\n * Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part.\n *\n * @remarks\n *\n * The key is the path within the web part properties, and the value is the dynamic data static value.\n *\n * Example:\n * ```\n * {\n * 'aStringProperty': 'thisIsAString',\n * 'aBooleanProperty': true\n * }\n * ```\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dynamicDataValues" - }, - { - "kind": "Content", - "text": "?: " - }, { "kind": "Content", - "text": "{\n [" - }, - { - "kind": "Reference", - "text": "path" + "text": "dynamicDataValues?: " }, { "kind": "Content", - "text": ": string]: any;\n }" + "text": "{\n [path: string]: any;\n }" }, { "kind": "Content", @@ -4537,22 +3582,18 @@ "releaseTag": "Beta", "name": "dynamicDataValues", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 5 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "id", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#id:member", "docComment": "/**\n * Universally unique web part Type id.\n *\n * @remarks\n *\n * Example: `\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "id" - }, { "kind": "Content", - "text": ": " + "text": "id: " }, { "kind": "Content", @@ -4566,22 +3607,18 @@ "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "instanceId", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#instanceId:member", "docComment": "/**\n * Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries.\n *\n * @remarks\n *\n * supported values: a unique string. Could be GUID or other uniquely identifiable formats.\n *\n * example: `[\"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"]`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "instanceId" - }, { "kind": "Content", - "text": ": " + "text": "instanceId: " }, { "kind": "Content", @@ -4595,22 +3632,18 @@ "releaseTag": "Public", "name": "instanceId", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "properties", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#properties:member", "docComment": "/**\n * Web part specific properties. The individual web part owns the definition of these properties.\n *\n * @remarks\n *\n * Used by the web part to manage its internal metadata and config data. The framework code never touches these properties.\n *\n * Supported values: any object hierarchy that can be serialized using `JSON.stringify()`.\n *\n * Example: `{ 'value': 'text value' }`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "properties" - }, { "kind": "Content", - "text": "?: " + "text": "properties?: " }, { "kind": "Content", @@ -4624,26 +3657,23 @@ "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "serverProcessedContent", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member", "docComment": "/**\n * The collections of data that can be processed by server side services like search index and link fixup\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "serverProcessedContent" - }, { "kind": "Content", - "text": "?: " + "text": "serverProcessedContent?: " }, { "kind": "Reference", - "text": "ISerializedServerProcessedData" + "text": "ISerializedServerProcessedData", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface" }, { "kind": "Content", @@ -4653,22 +3683,18 @@ "releaseTag": "Public", "name": "serverProcessedContent", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "title", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartData#title:member", "docComment": "/**\n * Web part title\n *\n * @remarks\n *\n * Used to display the name of the web part in the toolbox, web part gallery and the page.\n *\n * Supported values: string less than 100 characters\n *\n * Example: `\"Text\"`\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "title" - }, { "kind": "Content", - "text": ": " + "text": "title: " }, { "kind": "Content", @@ -4682,8 +3708,8 @@ "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4691,20 +3717,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IWebPartPropertiesMetadata:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface", "docComment": "/**\n * This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata`\n *\n * @remarks\n *\n * The key should be a JSON path to the property in web part properties. The JSON path supports the following operators:\n *\n * - Dot `.` for selecting object members, for example `person.name`\n *\n * - Brackets `[]` for selecting array items, for example `person.photoURLs[0]`\n *\n * - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`.\n *\n * You can make combinations of these operators, for example `person.websites[*].url`\n *\n * Important Note: Only one wildcard per path is supported.\n *\n * Example: Let's assume we have a web part with properties that have the following schema:\n * ```\n * {\n * title: string;\n * person: {\n * name: string;\n * bio: string;\n * photoURLs: string[];\n * websites: { title: string; url: string; }[]\n * }\n * }\n * ```\n *\n * We can define the metadata for the desired properties as following:\n * ```\n * {\n * 'person.bio': { isRichContent: true },\n * 'person.photoURLs[*]': { isImageSource: true },\n * 'person.websites[*].url': { isLink: true }\n * }\n * ```\n *\n * This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "interface " - }, - { - "kind": "Reference", - "text": "IWebPartPropertiesMetadata" - }, - { - "kind": "Content", - "text": " " + "text": "interface IWebPartPropertiesMetadata " } ], "releaseTag": "Public", @@ -4712,20 +3730,12 @@ "members": [ { "kind": "IndexSignature", - "canonicalReference": "(:index,0)", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:index(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "[" - }, - { - "kind": "Reference", - "text": "key" - }, - { - "kind": "Content", - "text": ": " + "text": "[key: " }, { "kind": "Content", @@ -4737,7 +3747,8 @@ }, { "kind": "Reference", - "text": "IWebPartPropertyMetadata" + "text": "IWebPartPropertyMetadata", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface" }, { "kind": "Content", @@ -4745,17 +3756,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 3, + "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 } } ] @@ -4765,20 +3776,12 @@ }, { "kind": "Interface", - "canonicalReference": "(IWebPartPropertyMetadata:interface)", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface", "docComment": "/**\n * This is the structure used for map values in `IWebPartPropertiesMetadata`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export interface " - }, - { - "kind": "Reference", - "text": "IWebPartPropertyMetadata" - }, - { - "kind": "Content", - "text": " " + "text": "export interface IWebPartPropertyMetadata " } ], "releaseTag": "Public", @@ -4786,16 +3789,12 @@ "members": [ { "kind": "PropertySignature", - "canonicalReference": "dynamicPropertyType", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member", "docComment": "/**\n * If specified, indicates that the property is a dynamic property and the type of the dynamic property.\n *\n * @remarks\n *\n * If a web part has properties that are dynamically configurable, then use this flag to declare the property as a dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create the DynamicProperty themselves and assign it to the property.\n *\n * A web part can configure a default value for the property by specifying it in the properties section of the web part's manifest. This value will be used when a dynamic property is constructed for the property.\n *\n * Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs.\n *\n * @public\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "dynamicPropertyType" - }, { "kind": "Content", - "text": "?: " + "text": "dynamicPropertyType?: " }, { "kind": "Content", @@ -4809,22 +3808,18 @@ "releaseTag": "Public", "name": "dynamicPropertyType", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "isHtmlString", - "docComment": "/**\n * Indicates whether the property should be serialized as HTML.\n *\n * @remarks\n *\n * This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it:\n *\n * - normalizing HTML encodings\n *\n * - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML)\n *\n * - search indexing\n *\n * - SharePoint link fix-up\n *\n * Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead.\n */\n", - "excerptTokens": [ - { - "kind": "Reference", - "text": "isHtmlString" - }, + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member", + "docComment": "/**\n * Indicates whether the property should be serialized as HTML.\n *\n * @remarks\n *\n * This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on it:\n *\n * - normalizing HTML encodings\n *\n * - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML)\n *\n * - search indexing\n *\n * - SharePoint link fix-up\n *\n * Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead.\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": "?: " + "text": "isHtmlString?: " }, { "kind": "Content", @@ -4838,22 +3833,18 @@ "releaseTag": "Public", "name": "isHtmlString", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "isImageSource", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member", "docComment": "/**\n * Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isImageSource" - }, { "kind": "Content", - "text": "?: " + "text": "isImageSource?: " }, { "kind": "Content", @@ -4867,22 +3858,18 @@ "releaseTag": "Public", "name": "isImageSource", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "isLink", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member", "docComment": "/**\n * Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isLink" - }, { "kind": "Content", - "text": "?: " + "text": "isLink?: " }, { "kind": "Content", @@ -4896,22 +3883,18 @@ "releaseTag": "Public", "name": "isLink", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "isSearchablePlainText", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member", "docComment": "/**\n * Indicates if the property contains plain text that should be search-indexed by SharePoint.\n *\n * @remarks\n *\n * This flag instructs the framework to store the property in a representation that supports search indexing. The content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML characters may be stored encoded and appear in search results. If your string contains HTML markup, use the isHtmlString setting instead.\n *\n * Security note: For security reasons, never assign a plain text string to `Element.innerHTML`.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "isSearchablePlainText" - }, { "kind": "Content", - "text": "?: " + "text": "isSearchablePlainText?: " }, { "kind": "Content", @@ -4925,22 +3908,18 @@ "releaseTag": "Public", "name": "isSearchablePlainText", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "PropertySignature", - "canonicalReference": "shouldNotPersist", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member", "docComment": "/**\n * Indicates if the framework should persist the property on the server.\n *\n * @remarks\n *\n * Use this for properties that are only important in run-time, and do not need to persist on the server. This can reduce the size of the serialized data of the web part and optimize the web part load time. The property value will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared from the run-time property bag. The initial render of your web part should not depend on the value of the property. Setting a default value for the property can be done in `onInit()` method.\n *\n * Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "shouldNotPersist" - }, { "kind": "Content", - "text": "?: " + "text": "shouldNotPersist?: " }, { "kind": "Content", @@ -4954,8 +3933,8 @@ "releaseTag": "Public", "name": "shouldNotPersist", "propertyTypeTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ], @@ -4963,28 +3942,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneButton:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButton:function(1)", "docComment": "/**\n * Helper method to create a Button on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the Button is associated to.\n *\n * @param properties - Strongly typed Button properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneButton" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneButton(targetProperty: " }, { "kind": "Content", @@ -4992,19 +3955,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneButtonProps" + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface" }, { "kind": "Content", @@ -5012,7 +3968,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5020,7 +3977,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneButtonProps" + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface" }, { "kind": "Content", @@ -5032,24 +3990,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -5057,20 +4015,12 @@ }, { "kind": "Enum", - "canonicalReference": "(PropertyPaneButtonType:enum)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType:enum", "docComment": "/**\n * Enum for all the supported button types.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare enum " - }, - { - "kind": "Reference", - "text": "PropertyPaneButtonType" - }, - { - "kind": "Content", - "text": " " + "text": "export declare enum PropertyPaneButtonType " } ], "releaseTag": "Public", @@ -5078,16 +4028,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "Command", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member", "docComment": "/**\n * Optional actions.\n *\n * @remarks\n *\n * Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Command" - }, { "kind": "Content", - "text": " = " + "text": "Command = " }, { "kind": "Content", @@ -5097,22 +4043,18 @@ "releaseTag": "Public", "name": "Command", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Compound", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member", "docComment": "/**\n * Always used as a set with both Standard and Primary compound buttons.\n *\n * @remarks\n *\n * Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with a possible significant time investment such as an email or a complex form\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Compound" - }, { "kind": "Content", - "text": " = " + "text": "Compound = " }, { "kind": "Content", @@ -5122,22 +4064,18 @@ "releaseTag": "Public", "name": "Compound", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Hero", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member", "docComment": "/**\n * Hero button.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Hero" - }, { "kind": "Content", - "text": " = " + "text": "Hero = " }, { "kind": "Content", @@ -5147,22 +4085,18 @@ "releaseTag": "Public", "name": "Hero", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Icon", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member", "docComment": "/**\n * Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar.\n *\n * @remarks\n *\n * Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the bottom of an event creation Callout when clicking inside an empty time range.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Icon" - }, { "kind": "Content", - "text": " = " + "text": "Icon = " }, { "kind": "Content", @@ -5172,22 +4106,18 @@ "releaseTag": "Public", "name": "Icon", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Normal", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member", "docComment": "/**\n * Optional completion action.\n *\n * @remarks\n *\n * Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo an action. Examples: \"Done\" button which closes a container but doesn't make a server call or an \"Undo\" button when a user is uploading a file in OneDrive.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Normal" - }, { "kind": "Content", - "text": " = " + "text": "Normal = " }, { "kind": "Content", @@ -5197,22 +4127,18 @@ "releaseTag": "Public", "name": "Normal", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Primary", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member", "docComment": "/**\n * Preferred completion action when paired with a Standard button.\n *\n * @remarks\n *\n * Typically used at the end of a task or form. Examples: \"Create\", \"Save\", \"Send\" which makes a server call.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Primary" - }, { "kind": "Content", - "text": " = " + "text": "Primary = " }, { "kind": "Content", @@ -5222,36 +4148,20 @@ "releaseTag": "Public", "name": "Primary", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Function", - "canonicalReference": "(PropertyPaneCheckbox:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)", "docComment": "/**\n * Helper method to create a Checkbox on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the checkbox is associated to.\n *\n * @param properties - Strongly typed Checkbox properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneCheckbox" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneCheckbox(targetProperty: " }, { "kind": "Content", @@ -5259,19 +4169,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneCheckboxProps" + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface" }, { "kind": "Content", @@ -5279,7 +4182,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5287,7 +4191,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneCheckboxProps" + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface" }, { "kind": "Content", @@ -5299,24 +4204,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -5324,28 +4229,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneChoiceGroup:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)", "docComment": "/**\n * Helper method to create a Choice Group on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the choice group is associated to.\n *\n * @param properties - Strongly typed Choice Group properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneChoiceGroup" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneChoiceGroup(targetProperty: " }, { "kind": "Content", @@ -5353,19 +4242,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneChoiceGroupProps" + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface" }, { "kind": "Content", @@ -5373,7 +4255,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5381,7 +4264,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneChoiceGroupProps" + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface" }, { "kind": "Content", @@ -5393,24 +4277,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -5418,32 +4302,17 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneCustomField:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)", "docComment": "/**\n * Helper method to create a custom field on the PropertyPane.\n *\n * @remarks\n *\n * The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - target property for this field. This parameter is being deprecated in future releases.\n *\n * @param properties - Strongly typed Custom field properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneCustomField" - }, - { - "kind": "Content", - "text": "(" + "text": "export declare function PropertyPaneCustomField(properties: " }, { "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "IPropertyPaneCustomFieldProps" + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface" }, { "kind": "Content", @@ -5451,7 +4320,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5459,7 +4329,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneCustomFieldProps" + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface" }, { "kind": "Content", @@ -5471,17 +4342,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 11 + "startIndex": 3, + "endIndex": 7 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5489,28 +4360,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneDropdown:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)", "docComment": "/**\n * Helper method to create a Dropdown on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the dropdown is associated to.\n *\n * @param properties - Strongly typed Dropdown properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneDropdown" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneDropdown(targetProperty: " }, { "kind": "Content", @@ -5518,19 +4373,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneDropdownProps" + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface" }, { "kind": "Content", @@ -5538,7 +4386,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5546,7 +4395,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneDropdownProps" + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface" }, { "kind": "Content", @@ -5558,24 +4408,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -5583,20 +4433,12 @@ }, { "kind": "Enum", - "canonicalReference": "(PropertyPaneDropdownOptionType:enum)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum", "docComment": "/**\n * Specifies the type of option in a dropdown menu rendered by {@link PropertyPaneDropdown}.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare enum " - }, - { - "kind": "Reference", - "text": "PropertyPaneDropdownOptionType" - }, - { - "kind": "Content", - "text": " " + "text": "export declare enum PropertyPaneDropdownOptionType " } ], "releaseTag": "Public", @@ -5604,16 +4446,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "Divider", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member", "docComment": "/**\n * Render a divider.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Divider" - }, { "kind": "Content", - "text": " = " + "text": "Divider = " }, { "kind": "Content", @@ -5623,22 +4461,18 @@ "releaseTag": "Public", "name": "Divider", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Header", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member", "docComment": "/**\n * Render menu item as a header.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Header" - }, { "kind": "Content", - "text": " = " + "text": "Header = " }, { "kind": "Content", @@ -5648,22 +4482,18 @@ "releaseTag": "Public", "name": "Header", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Normal", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member", "docComment": "/**\n * Render normal menu item.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Normal" - }, { "kind": "Content", - "text": " = " + "text": "Normal = " }, { "kind": "Content", @@ -5673,36 +4503,20 @@ "releaseTag": "Public", "name": "Normal", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Function", - "canonicalReference": "(PropertyPaneDynamicField:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)", "docComment": "/**\n * Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the Dynamic Data widget is associated to.\n *\n * @param options - Options to enable customized values for callback, filters etc., for the dynamic field.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneDynamicField" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneDynamicField(targetProperty: " }, { "kind": "Content", @@ -5710,19 +4524,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneDynamicFieldProps" + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface" }, { "kind": "Content", @@ -5730,7 +4537,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5738,7 +4546,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneDynamicFieldProps" + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface" }, { "kind": "Content", @@ -5750,24 +4559,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -5775,32 +4584,17 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneDynamicFieldSet:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)", "docComment": "/**\n * Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source.\n *\n * These fields can possibly share the same property based on the associated filters.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param properties - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneDynamicFieldSet" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneDynamicFieldSet(properties: " }, { "kind": "Reference", - "text": "IPropertyPaneDynamicFieldSetProps" + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface" }, { "kind": "Content", @@ -5808,7 +4602,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5816,7 +4611,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneDynamicFieldSetProps" + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface" }, { "kind": "Content", @@ -5828,17 +4624,17 @@ } ], "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 11 + "startIndex": 3, + "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } } ], @@ -5846,28 +4642,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneDynamicTextField:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)", "docComment": "/**\n * Helper method to create a Dynamic TextField on the PropertyPane.\n *\n * @deprecated\n *\n * This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the dynamic textfield is associated to.\n *\n * @param properties - Properties of the PropertyPaneDynamicTextField.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneDynamicTextField" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneDynamicTextField(targetProperty: " }, { "kind": "Content", @@ -5875,19 +4655,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneDynamicTextFieldProps" + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface" }, { "kind": "Content", @@ -5895,7 +4668,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -5903,7 +4677,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneDynamicTextFieldProps" + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface" }, { "kind": "Content", @@ -5915,45 +4690,37 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], "name": "PropertyPaneDynamicTextField" - }, - { - "kind": "Enum", - "canonicalReference": "(PropertyPaneFieldType:enum)", - "docComment": "/**\n * Enum for all the supported PropertyPane field types.\n *\n * Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare enum " - }, - { - "kind": "Reference", - "text": "PropertyPaneFieldType" - }, + }, + { + "kind": "Enum", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType:enum", + "docComment": "/**\n * Enum for all the supported PropertyPane field types.\n *\n * Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct.\n *\n * @deprecated\n *\n * This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", + "excerptTokens": [ { "kind": "Content", - "text": " " + "text": "export declare enum PropertyPaneFieldType " } ], "releaseTag": "Public", @@ -5961,16 +4728,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "Button", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member", "docComment": "/**\n * Button field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Button" - }, { "kind": "Content", - "text": " = " + "text": "Button = " }, { "kind": "Content", @@ -5980,22 +4743,18 @@ "releaseTag": "Public", "name": "Button", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "CheckBox", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member", "docComment": "/**\n * Checkbox field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "CheckBox" - }, { "kind": "Content", - "text": " = " + "text": "CheckBox = " }, { "kind": "Content", @@ -6005,22 +4764,18 @@ "releaseTag": "Public", "name": "CheckBox", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "ChoiceGroup", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member", "docComment": "/**\n * Choice Group field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "ChoiceGroup" - }, { "kind": "Content", - "text": " = " + "text": "ChoiceGroup = " }, { "kind": "Content", @@ -6030,22 +4785,18 @@ "releaseTag": "Public", "name": "ChoiceGroup", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Custom", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member", "docComment": "/**\n * Custom field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Custom" - }, { "kind": "Content", - "text": " = " + "text": "Custom = " }, { "kind": "Content", @@ -6055,22 +4806,18 @@ "releaseTag": "Public", "name": "Custom", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Dropdown", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member", "docComment": "/**\n * Dropdown field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Dropdown" - }, { "kind": "Content", - "text": " = " + "text": "Dropdown = " }, { "kind": "Content", @@ -6080,22 +4827,18 @@ "releaseTag": "Public", "name": "Dropdown", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "DynamicField", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member", "docComment": "/**\n * Dynamic data field.\n *\n * @public\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "DynamicField" - }, { "kind": "Content", - "text": " = " + "text": "DynamicField = " }, { "kind": "Content", @@ -6105,22 +4848,18 @@ "releaseTag": "Public", "name": "DynamicField", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "DynamicFieldSet", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member", "docComment": "/**\n * A set of dynamic fields.\n *\n * @public\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "DynamicFieldSet" - }, { "kind": "Content", - "text": " = " + "text": "DynamicFieldSet = " }, { "kind": "Content", @@ -6130,22 +4869,18 @@ "releaseTag": "Public", "name": "DynamicFieldSet", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "DynamicTextField", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member", "docComment": "/**\n * Dynamic Text Field\n *\n * @deprecated\n *\n * - Please use DynamicField\n *\n * @beta\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "DynamicTextField" - }, { "kind": "Content", - "text": " = " + "text": "DynamicTextField = " }, { "kind": "Content", @@ -6155,22 +4890,18 @@ "releaseTag": "Beta", "name": "DynamicTextField", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Heading", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member", "docComment": "/**\n * Heading field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Heading" - }, { "kind": "Content", - "text": " = " + "text": "Heading = " }, { "kind": "Content", @@ -6180,22 +4911,18 @@ "releaseTag": "Public", "name": "Heading", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "HorizontalRule", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member", "docComment": "/**\n * Horizontal Rule field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "HorizontalRule" - }, { "kind": "Content", - "text": " = " + "text": "HorizontalRule = " }, { "kind": "Content", @@ -6205,22 +4932,18 @@ "releaseTag": "Public", "name": "HorizontalRule", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Label", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member", "docComment": "/**\n * Label field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Label" - }, { "kind": "Content", - "text": " = " + "text": "Label = " }, { "kind": "Content", @@ -6230,22 +4953,18 @@ "releaseTag": "Public", "name": "Label", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Link", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member", "docComment": "/**\n * Link field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Link" - }, { "kind": "Content", - "text": " = " + "text": "Link = " }, { "kind": "Content", @@ -6255,22 +4974,18 @@ "releaseTag": "Public", "name": "Link", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Slider", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member", "docComment": "/**\n * Slider field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Slider" - }, { "kind": "Content", - "text": " = " + "text": "Slider = " }, { "kind": "Content", @@ -6280,22 +4995,18 @@ "releaseTag": "Public", "name": "Slider", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "TextField", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member", "docComment": "/**\n * TextField field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "TextField" - }, { "kind": "Content", - "text": " = " + "text": "TextField = " }, { "kind": "Content", @@ -6305,22 +5016,18 @@ "releaseTag": "Public", "name": "TextField", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Toggle", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member", "docComment": "/**\n * Toggle field.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Toggle" - }, { "kind": "Content", - "text": " = " + "text": "Toggle = " }, { "kind": "Content", @@ -6330,32 +5037,25 @@ "releaseTag": "Public", "name": "Toggle", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] }, { "kind": "Function", - "canonicalReference": "(PropertyPaneHorizontalRule:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)", "docComment": "/**\n * Helper method to create a Horizontal Rule on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param properties - Strongly typed Horizontal Rule properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneHorizontalRule" - }, - { - "kind": "Content", - "text": "(): " + "text": "export declare function PropertyPaneHorizontalRule(): " }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -6367,38 +5067,22 @@ } ], "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "PropertyPaneHorizontalRule" }, { "kind": "Function", - "canonicalReference": "(PropertyPaneLabel:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)", "docComment": "/**\n * Helper method to create a Label on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the label is associated to.\n *\n * @param properties - Strongly typed Label properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneLabel" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneLabel(targetProperty: " }, { "kind": "Content", @@ -6406,19 +5090,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneLabelProps" + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface" }, { "kind": "Content", @@ -6426,7 +5103,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -6434,7 +5112,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneLabelProps" + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface" }, { "kind": "Content", @@ -6446,24 +5125,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -6471,28 +5150,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneLink:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneLink:function(1)", "docComment": "/**\n * Helper method to create a Link on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the Link is associated to.\n *\n * @param properties - Strongly typed Link properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneLink" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneLink(targetProperty: " }, { "kind": "Content", @@ -6500,19 +5163,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneLinkProps" + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface" }, { "kind": "Content", @@ -6520,7 +5176,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -6528,7 +5185,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneLinkProps" + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface" }, { "kind": "Content", @@ -6540,24 +5198,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -6565,28 +5223,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneSlider:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)", "docComment": "/**\n * Helper method to create a Slider on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the slider is associated to.\n *\n * @param properties - Strongly typed Slider properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneSlider" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneSlider(targetProperty: " }, { "kind": "Content", @@ -6594,19 +5236,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneSliderProps" + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface" }, { "kind": "Content", @@ -6614,7 +5249,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -6622,7 +5258,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneSliderProps" + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface" }, { "kind": "Content", @@ -6634,24 +5271,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -6659,28 +5296,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneTextField:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)", "docComment": "/**\n * Helper method to create a TextField on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the textfield is associated to.\n *\n * @param properties - Strongly typed TextField properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneTextField" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneTextField(targetProperty: " }, { "kind": "Content", @@ -6688,19 +5309,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneTextFieldProps" + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface" }, { "kind": "Content", @@ -6708,7 +5322,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -6716,7 +5331,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneTextFieldProps" + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface" }, { "kind": "Content", @@ -6728,24 +5344,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -6753,28 +5369,12 @@ }, { "kind": "Function", - "canonicalReference": "(PropertyPaneToggle:0)", + "canonicalReference": "@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)", "docComment": "/**\n * Helper method to create a Toggle on the PropertyPane.\n *\n * @deprecated\n *\n * This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it from there.\n *\n * @param targetProperty - Target property the toggle is associated to.\n *\n * @param properties - Strongly typed Toggle properties.\n *\n * @internalremarks\n *\n * We have left the original implementation here to avoid breaking the public API contract.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare function " - }, - { - "kind": "Reference", - "text": "PropertyPaneToggle" - }, - { - "kind": "Content", - "text": "(" - }, - { - "kind": "Reference", - "text": "targetProperty" - }, - { - "kind": "Content", - "text": ": " + "text": "export declare function PropertyPaneToggle(targetProperty: " }, { "kind": "Content", @@ -6782,19 +5382,12 @@ }, { "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "properties" - }, - { - "kind": "Content", - "text": ": " + "text": ", properties: " }, { "kind": "Reference", - "text": "IPropertyPaneToggleProps" + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface" }, { "kind": "Content", @@ -6802,7 +5395,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneField" + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" }, { "kind": "Content", @@ -6810,7 +5404,8 @@ }, { "kind": "Reference", - "text": "IPropertyPaneToggleProps" + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface" }, { "kind": "Content", @@ -6822,24 +5417,24 @@ } ], "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 + "startIndex": 5, + "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "targetProperty", "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 + "startIndex": 3, + "endIndex": 4 } } ], @@ -6847,24 +5442,17 @@ }, { "kind": "Class", - "canonicalReference": "(WebPartContext:class)", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartContext:class", "docComment": "/**\n * Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client.\n *\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebPartContext` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export default class " - }, - { - "kind": "Reference", - "text": "WebPartContext" - }, - { - "kind": "Content", - "text": " extends " + "text": "export default class WebPartContext extends " }, { "kind": "Reference", - "text": "BaseWebPartContext" + "text": "BaseWebPartContext", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" }, { "kind": "Content", @@ -6876,24 +5464,17 @@ "members": [ { "kind": "Property", - "canonicalReference": "(domElement:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartContext#domElement:member", "docComment": "/**\n * Reference to the DOM element that hosts this client-side component.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " + "text": "readonly domElement: " }, { "kind": "Reference", - "text": "domElement" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Reference", - "text": "HTMLElement" + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", @@ -6903,39 +5484,23 @@ "releaseTag": "Public", "name": "domElement", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(microsoftTeams:instance)", - "docComment": "/**\n * Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest}\n *\n * @deprecated\n *\n * @public\n */\n", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member", + "docComment": "/**\n * Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest}\n *\n * @deprecated\n *\n * - This function has been deprecated\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "microsoftTeams" - }, - { - "kind": "Content", - "text": ": " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "microsoftTeams" + "text": "readonly microsoftTeams: " }, { "kind": "Content", - "text": " | undefined" + "text": "typeof microsoftTeams | undefined" }, { "kind": "Content", @@ -6945,31 +5510,24 @@ "releaseTag": "Public", "name": "microsoftTeams", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(sdks:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartContext#sdks:member", "docComment": "/**\n * Conditional set of SDKs provided by SPFx dependent on the environment.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "sdks" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly sdks: " }, { "kind": "Reference", - "text": "ISDKs" + "text": "ISDKs", + "canonicalReference": "@microsoft/sp-webpart-base!ISDKs:interface" }, { "kind": "Content", @@ -6979,31 +5537,24 @@ "releaseTag": "Public", "name": "sdks", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false }, { "kind": "Property", - "canonicalReference": "(statusRenderer:instance)", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member", "docComment": "/**\n * Web part status renderer.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "readonly " - }, - { - "kind": "Reference", - "text": "statusRenderer" - }, - { - "kind": "Content", - "text": ": " + "text": "readonly statusRenderer: " }, { "kind": "Reference", - "text": "IClientSideWebPartStatusRenderer" + "text": "IClientSideWebPartStatusRenderer", + "canonicalReference": "@microsoft/sp-webpart-base!default:interface" }, { "kind": "Content", @@ -7013,34 +5564,26 @@ "releaseTag": "Public", "name": "statusRenderer", "propertyTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "isStatic": false } ], "extendsTokenRange": { - "startIndex": 3, - "endIndex": 5 + "startIndex": 1, + "endIndex": 3 }, "implementsTokenRanges": [] }, { "kind": "Enum", - "canonicalReference": "(WebPartFormFactor:enum)", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartFormFactor:enum", "docComment": "/**\n * Form factor of the web part.\n *\n * @remarks\n *\n * This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "export declare const enum " - }, - { - "kind": "Reference", - "text": "WebPartFormFactor" - }, - { - "kind": "Content", - "text": " " + "text": "export declare const enum WebPartFormFactor " } ], "releaseTag": "Beta", @@ -7048,16 +5591,12 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "FullSize", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member", "docComment": "/**\n * Full size form factor. This means the web part is rendered in full size, taking all space available in the page.\n *\n * @remarks\n *\n * This is the case for Teams tabs or single web part App pages.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "FullSize" - }, { "kind": "Content", - "text": " = " + "text": "FullSize = " }, { "kind": "Content", @@ -7067,22 +5606,18 @@ "releaseTag": "Beta", "name": "FullSize", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } }, { "kind": "EnumMember", - "canonicalReference": "Standard", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member", "docComment": "/**\n * Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height.\n */\n", "excerptTokens": [ - { - "kind": "Reference", - "text": "Standard" - }, { "kind": "Content", - "text": " = " + "text": "Standard = " }, { "kind": "Content", @@ -7092,8 +5627,8 @@ "releaseTag": "Beta", "name": "Standard", "initializerTokenRange": { - "startIndex": 2, - "endIndex": 3 + "startIndex": 1, + "endIndex": 2 } } ] From d18567d6ced58594b9d5d3322ef7f7a06fea675c Mon Sep 17 00:00:00 2001 From: John Nguyen Date: Thu, 16 Jan 2020 15:42:43 -0800 Subject: [PATCH 28/55] Update yaml and json API files --- SP-Framework/breadcrumb/toc.yml | 558 +++++++++++++- SP-Framework/decorators.yml | 47 +- SP-Framework/sp-application-base.yml | 30 +- .../applicationaccessor.yml | 44 +- .../applicationcustomizercontext.yml | 37 +- .../baseapplicationcustomizer.yml | 45 +- .../iplaceholdercreatecontentoptions.yml | 25 +- .../placeholdercontent.yml | 45 +- .../sp-application-base/placeholdername.yml | 14 +- .../placeholderprovider.yml | 97 ++- SP-Framework/sp-component-base.yml | 88 ++- .../sp-component-base/basecomponent.yml | 47 +- .../basecomponentcontext.yml | 101 +-- .../sp-component-base/dynamicdataprovider.yml | 76 +- .../dynamicdatasourcemanager.yml | 61 +- .../sp-component-base/dynamicproperty.yml | 81 ++- .../sp-component-base/ifontstyles.yml | 73 +- SP-Framework/sp-component-base/ipalette.yml | 200 +++--- SP-Framework/sp-component-base/irawstyle.yml | 49 +- .../sp-component-base/ireadonlyfontstyles.yml | 73 +- .../sp-component-base/ireadonlytheme.yml | 97 ++- .../sp-component-base/isemanticcolors.yml | 223 +++--- .../sp-component-base/isemantictextcolors.yml | 120 ++-- SP-Framework/sp-component-base/itheme.yml | 37 +- .../themechangedeventargs.yml | 26 +- .../sp-component-base/themeprovider.yml | 72 +- SP-Framework/sp-core-library.yml | 112 +-- SP-Framework/sp-core-library/displaymode.yml | 12 +- SP-Framework/sp-core-library/environment.yml | 13 +- .../sp-core-library/environmenttype.yml | 24 +- SP-Framework/sp-core-library/guid.yml | 58 +- SP-Framework/sp-core-library/idisposable.yml | 12 +- .../irandomnumbergenerator.yml | 19 +- .../sp-core-library/iservicecollection.yml | 13 +- .../sp-core-library/ispeventobserver.yml | 23 +- .../sp-core-library/itimeprovider.yml | 27 +- SP-Framework/sp-core-library/log.yml | 35 +- .../sp-core-library/randomnumbergenerator.yml | 46 +- SP-Framework/sp-core-library/servicekey.yml | 109 ++- SP-Framework/sp-core-library/servicescope.yml | 159 +++- SP-Framework/sp-core-library/session.yml | 23 +- SP-Framework/sp-core-library/spevent.yml | 19 +- SP-Framework/sp-core-library/speventargs.yml | 6 +- SP-Framework/sp-core-library/text.yml | 12 +- SP-Framework/sp-core-library/timeprovider.yml | 53 +- .../urlqueryparametercollection.yml | 16 +- SP-Framework/sp-core-library/validate.yml | 25 +- SP-Framework/sp-core-library/version.yml | 84 ++- SP-Framework/sp-diagnostics.yml | 30 +- SP-Framework/sp-dialog.yml | 38 +- SP-Framework/sp-dialog/basedialog.yml | 113 ++- SP-Framework/sp-dialog/dialog.yml | 43 +- SP-Framework/sp-dialog/ialertoptions.yml | 11 +- .../sp-dialog/idialogconfiguration.yml | 8 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 8 +- SP-Framework/sp-dialog/ipromptoptions.yml | 15 +- .../sp-dialog/isecondarydialogprovider.yml | 91 ++- SP-Framework/sp-dynamic-data.yml | 42 +- .../sp-dynamic-data/dynamicdatareference.yml | 24 +- .../idynamicdataannotatedpropertyvalue.yml | 17 +- .../sp-dynamic-data/idynamicdatacallables.yml | 68 +- .../idynamicdataeventdefinition.yml | 12 +- .../idynamicdatapropertydefinition.yml | 15 +- .../idynamicdatapropertymetadata.yml | 12 +- .../idynamicdatapropertyvaluemetadata.yml | 19 +- ...micdatapropertyvaluemetadatacollection.yml | 4 +- .../sp-dynamic-data/idynamicdatasource.yml | 224 ++++-- .../idynamicdatasourcemetadata.yml | 24 +- SP-Framework/sp-extension-base.yml | 10 +- .../sp-extension-base/baseextension.yml | 38 +- .../sp-extension-base/extensioncontext.yml | 11 +- SP-Framework/sp-http.yml | 161 ++--- SP-Framework/sp-http/aadhttpclient.yml | 106 ++- .../sp-http/aadhttpclientconfiguration.yml | 37 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 45 +- SP-Framework/sp-http/aadtokenprovider.yml | 44 +- .../sp-http/aadtokenproviderfactory.yml | 45 +- SP-Framework/sp-http/digestcache.yml | 64 +- SP-Framework/sp-http/graphrequest.yml | 307 +++++--- SP-Framework/sp-http/httpclient.yml | 139 +++- .../sp-http/httpclientconfiguration.yml | 37 +- SP-Framework/sp-http/httpclientresponse.yml | 153 ++-- .../sp-http/iaadhttpclientconfiguration.yml | 11 +- .../sp-http/iaadhttpclientconfigurations.yml | 13 +- .../sp-http/iaadhttpclientoptions.yml | 25 +- SP-Framework/sp-http/iaadtokenprovider.yml | 40 +- .../iaadtokenproviderconfiguration.yml | 32 +- SP-Framework/sp-http/idigestcache.yml | 32 +- .../sp-http/ihttpclientconfiguration.yml | 4 +- .../sp-http/ihttpclientconfigurations.yml | 13 +- SP-Framework/sp-http/ihttpclientoptions.yml | 11 +- .../isphttpclientbatchconfiguration.yml | 15 +- .../isphttpclientbatchconfigurations.yml | 13 +- .../isphttpclientbatchcreationoptions.yml | 8 +- .../sp-http/isphttpclientbatchoptions.yml | 15 +- .../isphttpclientcommonconfiguration.yml | 19 +- .../sp-http/isphttpclientconfiguration.yml | 31 +- .../sp-http/isphttpclientconfigurations.yml | 13 +- SP-Framework/sp-http/isphttpclientoptions.yml | 19 +- .../sp-http/itokenacquisitioneventargs.yml | 19 +- SP-Framework/sp-http/msgraphclient.yml | 17 +- SP-Framework/sp-http/msgraphclientfactory.yml | 45 +- SP-Framework/sp-http/odataversion.yml | 42 +- SP-Framework/sp-http/sphttpclient.yml | 161 +++-- SP-Framework/sp-http/sphttpclientbatch.yml | 127 +++- .../sphttpclientbatchconfiguration.yml | 41 +- .../sphttpclientcommonconfiguration.yml | 49 +- .../sp-http/sphttpclientconfiguration.yml | 57 +- SP-Framework/sp-http/sphttpclientresponse.yml | 40 +- SP-Framework/sp-http/sphttpheader.yml | 10 +- .../sp-http/tokenacquisitioneventargs.yml | 23 +- SP-Framework/sp-list-subscription.yml | 26 + .../icreatesubscriptionsettings.yml | 92 +++ .../ilistsubscription.yml | 27 + .../isubscriptioncallbacks.yml | 50 ++ .../listsubscriptionfactory.yml | 87 +++ SP-Framework/sp-listview-extensibility.yml | 54 +- .../basefieldcustomizer.yml | 49 +- .../baselistviewcommandset.yml | 57 +- .../columnaccessor.yml | 17 +- .../sp-listview-extensibility/command.yml | 26 +- .../fieldcustomizercontext.yml | 38 +- .../ifieldcustomizercelleventparameters.yml | 29 +- ...stviewcommandsetexecuteeventparameters.yml | 31 +- ...iewcommandsetlistviewupdatedparameters.yml | 27 +- .../listitemaccessor.yml | 37 +- .../listviewaccessor.yml | 60 +- .../listviewcommandsetcontext.yml | 31 +- .../sp-listview-extensibility/rowaccessor.yml | 11 +- .../selectedrowschangedeventargs.yml | 31 +- SP-Framework/sp-loader.yml | 20 + SP-Framework/sp-loader/iloadscriptoptions.yml | 24 + SP-Framework/sp-loader/spcomponentloader.yml | 164 +++++ SP-Framework/sp-lodash-subset.yml | 38 + SP-Framework/sp-module-interfaces.yml | 92 +++ .../iclientsideassemblymanifest.yml | 39 + ...clientsidecomponentloaderconfiguration.yml | 194 +++++ .../iclientsidecomponentmanifest.yml | 189 +++++ .../iclientsideextensionmanifest.yml | 39 + .../iclientsidelibrarymanifest.yml | 21 + .../iclientsidemanifestbase.yml | 64 ++ .../iclientsidewebpartmanifest.yml | 216 ++++++ .../iclientsidewebpartmanifestentry.yml | 282 ++++++++ .../iclientsidewebpartmanifestinstance.yml | 24 + .../icommanddefinition.yml | 78 ++ .../icommandsetextensionmanifest.yml | 87 +++ .../icomponentmoduleconfiguration.yml | 94 +++ .../ilocalizedpathmoduleconfiguration.yml | 128 ++++ .../sp-module-interfaces/ilocalizedstring.yml | 78 ++ .../imoduleconfiguration.yml | 61 ++ SP-Framework/sp-module-interfaces/ipath.yml | 60 ++ .../ipathmoduleconfiguration.yml | 119 +++ .../sp-module-interfaces/predefinedgroup.yml | 105 +++ SP-Framework/sp-odata-types.yml | 46 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 12 +- .../sp-odata-types/iodatabasepermission.yml | 12 +- .../sp-odata-types/iodatachangetoken.yml | 8 +- .../iodatacontextwebinformation.yml | 20 +- SP-Framework/sp-odata-types/iodatalist.yml | 61 +- .../sp-odata-types/iodatalistitem.yml | 20 +- .../sp-odata-types/iodatanavigationnode.yml | 44 +- .../iodatanavigationnodecollection.yml | 35 +- SP-Framework/sp-odata-types/iodatauser.yml | 37 +- .../sp-odata-types/iodatausercustomaction.yml | 81 ++- SP-Framework/sp-odata-types/iodataweb.yml | 81 ++- SP-Framework/sp-page-context.yml | 54 +- SP-Framework/sp-page-context/cultureinfo.yml | 16 +- .../sp-page-context/ispsystemtime.yml | 36 +- .../sp-page-context/isptimezonedata.yml | 39 +- SP-Framework/sp-page-context/pagecontext.yml | 112 ++- SP-Framework/sp-page-context/spdayofweek.yml | 32 +- SP-Framework/sp-page-context/spfield.yml | 48 +- SP-Framework/sp-page-context/splist.yml | 29 +- SP-Framework/sp-page-context/splistitem.yml | 8 +- SP-Framework/sp-page-context/sppermission.yml | 273 +++---- SP-Framework/sp-page-context/spsite.yml | 66 +- SP-Framework/sp-page-context/sptimezone.yml | 39 +- SP-Framework/sp-page-context/spuser.yml | 59 +- SP-Framework/sp-page-context/spweb.yml | 97 ++- SP-Framework/sp-property-pane.yml | 680 ++++++++++++++++++ .../dynamicdatashareddepth.yml | 38 + ...dynamicdatasharedpropertyconfiguration.yml | 27 + .../idynamicdatasharedpropertyfilters.yml | 35 + .../idynamicdatasharedsourceconfiguration.yml | 43 ++ .../idynamicdatasharedsourcefilters.yml | 68 ++ .../sp-property-pane/ipopupwindowprops.yml | 66 ++ .../ipropertypanebuttonprops.yml | 124 ++++ .../ipropertypanecheckboxprops.yml | 51 ++ .../ipropertypanechoicegroupoption.yml | 142 ++++ ...propertypanechoicegroupoptioniconprops.yml | 24 + .../ipropertypanechoicegroupprops.yml | 47 ++ .../ipropertypaneconditionalgroup.yml | 79 ++ .../ipropertypaneconfiguration.yml | 110 +++ .../ipropertypanecustomfieldprops.yml | 104 +++ .../ipropertypanedebounceproperty.yml | 43 ++ .../ipropertypanedropdowncalloutprops.yml | 24 + .../ipropertypanedropdownoption.yml | 66 ++ .../ipropertypanedropdownprops.yml | 143 ++++ .../ipropertypanedynamicfieldprops.yml | 78 ++ .../ipropertypanedynamicfieldsetprops.yml | 117 +++ .../ipropertypanedynamictextfieldprops.yml | 188 +++++ .../sp-property-pane/ipropertypanefield.yml | 71 ++ .../sp-property-pane/ipropertypanegroup.yml | 62 ++ .../ipropertypanelabelprops.yml | 38 + .../ipropertypanelinkprops.yml | 94 +++ .../sp-property-pane/ipropertypanepage.yml | 69 ++ .../ipropertypanepageheader.yml | 37 + .../ipropertypanesliderprops.yml | 140 ++++ .../ipropertypanetextfieldprops.yml | 301 ++++++++ .../ipropertypanetoggleprops.yml | 126 ++++ .../sp-property-pane/popupwindowposition.yml | 56 ++ .../propertypanebuttontype.yml | 84 +++ .../propertypanedropdownoptiontype.yml | 40 ++ .../propertypanefieldtype.yml | 152 ++++ SP-Framework/sp-search-extensibility.yml | 23 + .../basesearchquerymodifier.yml | 122 ++++ .../sp-search-extensibility/iquery.yml | 41 ++ .../searchquerymodifiercontext.yml | 22 + .../searchqueryscenario.yml | 32 + SP-Framework/sp-webpart-base.yml | 494 +++++++++---- .../sp-webpart-base/baseclientsidewebpart.yml | 97 ++- SP-Framework/sp-webpart-base/basewebpart.yml | 153 ++-- .../sp-webpart-base/basewebpartcontext.yml | 46 +- .../dynamicdatashareddepth.yml | 16 +- .../iclientsidewebpartstatusrenderer.yml | 44 +- ...dynamicdatasharedpropertyconfiguration.yml | 27 +- .../idynamicdatasharedpropertyfilters.yml | 27 +- .../idynamicdatasharedsourceconfiguration.yml | 27 +- .../idynamicdatasharedsourcefilters.yml | 27 +- .../sp-webpart-base/imicrosoftteams.yml | 29 +- SP-Framework/sp-webpart-base/ioffice.yml | 29 + .../sp-webpart-base/ipropertypaneaccessor.yml | 44 +- .../ipropertypanebuttonprops.yml | 27 +- .../ipropertypanecheckboxprops.yml | 27 +- .../ipropertypanechoicegroupoption.yml | 27 +- ...propertypanechoicegroupoptioniconprops.yml | 27 +- .../ipropertypanechoicegroupprops.yml | 27 +- .../ipropertypaneconditionalgroup.yml | 27 +- .../ipropertypaneconfiguration.yml | 27 +- .../ipropertypanecustomfieldprops.yml | 27 +- .../ipropertypanedropdowncalloutprops.yml | 27 +- .../ipropertypanedropdownoption.yml | 27 +- .../ipropertypanedropdownprops.yml | 27 +- .../ipropertypanedynamicfieldfilters.yml | 27 +- .../ipropertypanedynamicfieldprops.yml | 27 +- .../ipropertypanedynamicfieldsetprops.yml | 27 +- .../ipropertypanedynamictextfieldprops.yml | 27 +- .../sp-webpart-base/ipropertypanefield.yml | 34 +- .../sp-webpart-base/ipropertypanegroup.yml | 27 +- .../ipropertypanelabelprops.yml | 27 +- .../ipropertypanelinkprops.yml | 27 +- .../sp-webpart-base/ipropertypanepage.yml | 27 +- .../ipropertypanepageheader.yml | 27 +- .../ipropertypanesliderprops.yml | 27 +- .../ipropertypanetextfieldprops.yml | 27 +- .../ipropertypanetoggleprops.yml | 27 +- SP-Framework/sp-webpart-base/isdks.yml | 34 +- .../iserializedserverprocesseddata.yml | 20 +- .../iserializedwebpartdata.yml | 33 +- .../sp-webpart-base/iwebpartcontext.yml | 94 +-- SP-Framework/sp-webpart-base/iwebpartdata.yml | 45 +- .../iwebpartpropertiesmetadata.yml | 4 +- .../iwebpartpropertymetadata.yml | 28 +- .../propertypanebuttontype.yml | 28 +- .../propertypanedropdownoptiontype.yml | 18 +- .../sp-webpart-base/propertypanefieldtype.yml | 64 +- .../sp-webpart-base/webpartcontext.yml | 41 +- .../sp-webpart-base/webpartformfactor.yml | 12 +- generate-docs/json/sp-component-base.api.json | 2 +- generate-docs/json/sp-loader.api.json | 8 +- generate-docs/json/sp-webpart-base.api.json | 2 +- 271 files changed, 13303 insertions(+), 3239 deletions(-) create mode 100644 SP-Framework/sp-list-subscription.yml create mode 100644 SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml create mode 100644 SP-Framework/sp-list-subscription/ilistsubscription.yml create mode 100644 SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml create mode 100644 SP-Framework/sp-list-subscription/listsubscriptionfactory.yml create mode 100644 SP-Framework/sp-loader.yml create mode 100644 SP-Framework/sp-loader/iloadscriptoptions.yml create mode 100644 SP-Framework/sp-loader/spcomponentloader.yml create mode 100644 SP-Framework/sp-lodash-subset.yml create mode 100644 SP-Framework/sp-module-interfaces.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml create mode 100644 SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml create mode 100644 SP-Framework/sp-module-interfaces/icommanddefinition.yml create mode 100644 SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml create mode 100644 SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml create mode 100644 SP-Framework/sp-module-interfaces/ilocalizedstring.yml create mode 100644 SP-Framework/sp-module-interfaces/imoduleconfiguration.yml create mode 100644 SP-Framework/sp-module-interfaces/ipath.yml create mode 100644 SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml create mode 100644 SP-Framework/sp-module-interfaces/predefinedgroup.yml create mode 100644 SP-Framework/sp-property-pane.yml create mode 100644 SP-Framework/sp-property-pane/dynamicdatashareddepth.yml create mode 100644 SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml create mode 100644 SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml create mode 100644 SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml create mode 100644 SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml create mode 100644 SP-Framework/sp-property-pane/ipopupwindowprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanefield.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanegroup.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanelabelprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanelinkprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanepage.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanepageheader.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanesliderprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml create mode 100644 SP-Framework/sp-property-pane/popupwindowposition.yml create mode 100644 SP-Framework/sp-property-pane/propertypanebuttontype.yml create mode 100644 SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml create mode 100644 SP-Framework/sp-property-pane/propertypanefieldtype.yml create mode 100644 SP-Framework/sp-search-extensibility.yml create mode 100644 SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml create mode 100644 SP-Framework/sp-search-extensibility/iquery.yml create mode 100644 SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml create mode 100644 SP-Framework/sp-search-extensibility/searchqueryscenario.yml create mode 100644 SP-Framework/sp-webpart-base/ioffice.yml diff --git a/SP-Framework/breadcrumb/toc.yml b/SP-Framework/breadcrumb/toc.yml index ac02f441..d8b9f0ce 100644 --- a/SP-Framework/breadcrumb/toc.yml +++ b/SP-Framework/breadcrumb/toc.yml @@ -1,4 +1,554 @@ -- name: SharePoint - tocHref: /javascript/api/ - topicHref: /sharepoint/dev/index - +items: + - name: SharePoint Framework reference + href: ~/overview/sharepoint.md + items: + - name: decorators + uid: '@microsoft/decorators!' + - name: sp-application-base + uid: '@microsoft/sp-application-base!' + items: + - name: ApplicationAccessor + uid: '@microsoft/sp-application-base!ApplicationAccessor:class' + - name: ApplicationCustomizerContext + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + - name: BaseApplicationCustomizer + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + - name: IPlaceholderCreateContentOptions + uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + - name: PlaceholderContent + uid: '@microsoft/sp-application-base!PlaceholderContent:class' + - name: PlaceholderName + uid: '@microsoft/sp-application-base!PlaceholderName:enum' + - name: PlaceholderProvider + uid: '@microsoft/sp-application-base!PlaceholderProvider:class' + - name: sp-component-base + uid: '@microsoft/sp-component-base!' + items: + - name: BaseComponent + uid: '@microsoft/sp-component-base!BaseComponent:class' + - name: BaseComponentContext + uid: '@microsoft/sp-component-base!BaseComponentContext:class' + - name: DynamicDataProvider + uid: '@microsoft/sp-component-base!DynamicDataProvider:class' + - name: DynamicDataSourceManager + uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' + - name: DynamicProperty + uid: '@microsoft/sp-component-base!DynamicProperty:class' + - name: IFontStyles + uid: '@microsoft/sp-component-base!IFontStyles:interface' + - name: IPalette + uid: '@microsoft/sp-component-base!IPalette:interface' + - name: IRawStyle + uid: '@microsoft/sp-component-base!IRawStyle:interface' + - name: IReadonlyFontStyles + uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - name: IReadonlyTheme + uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + - name: ISemanticColors + uid: '@microsoft/sp-component-base!ISemanticColors:interface' + - name: ISemanticTextColors + uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' + - name: ITheme + uid: '@microsoft/sp-component-base!ITheme:interface' + - name: ThemeChangedEventArgs + uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + - name: ThemeProvider + uid: '@microsoft/sp-component-base!ThemeProvider:class' + - name: sp-core-library + uid: '@microsoft/sp-core-library!' + items: + - name: DisplayMode + uid: '@microsoft/sp-core-library!DisplayMode:enum' + - name: Environment + uid: '@microsoft/sp-core-library!Environment:class' + - name: EnvironmentType + uid: '@microsoft/sp-core-library!EnvironmentType:enum' + - name: Guid + uid: '@microsoft/sp-core-library!Guid:class' + - name: IDisposable + uid: '@microsoft/sp-core-library!IDisposable:interface' + - name: IRandomNumberGenerator + uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - name: IServiceCollection + uid: '@microsoft/sp-core-library!IServiceCollection:interface' + - name: ISPEventObserver + uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + - name: ITimeProvider + uid: '@microsoft/sp-core-library!ITimeProvider:interface' + - name: Log + uid: '@microsoft/sp-core-library!Log:class' + - name: RandomNumberGenerator + uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' + - name: ServiceKey + uid: '@microsoft/sp-core-library!ServiceKey:class' + - name: ServiceScope + uid: '@microsoft/sp-core-library!ServiceScope:class' + - name: Session + uid: '@microsoft/sp-core-library!Session:class' + - name: SPEvent + uid: '@microsoft/sp-core-library!SPEvent:class' + - name: SPEventArgs + uid: '@microsoft/sp-core-library!SPEventArgs:class' + - name: Text + uid: '@microsoft/sp-core-library!Text:class' + - name: TimeProvider + uid: '@microsoft/sp-core-library!TimeProvider:class' + - name: UrlQueryParameterCollection + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + - name: Validate + uid: '@microsoft/sp-core-library!Validate:class' + - name: Version + uid: '@microsoft/sp-core-library!Version:class' + - name: sp-diagnostics + uid: '@microsoft/sp-diagnostics!' + - name: sp-dialog + uid: '@microsoft/sp-dialog!' + items: + - name: BaseDialog + uid: '@microsoft/sp-dialog!BaseDialog:class' + - name: Dialog + uid: '@microsoft/sp-dialog!Dialog:class' + - name: IAlertOptions + uid: '@microsoft/sp-dialog!IAlertOptions:interface' + - name: IDialogConfiguration + uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' + - name: IDialogShowOptions + uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + - name: IPromptOptions + uid: '@microsoft/sp-dialog!IPromptOptions:interface' + - name: ISecondaryDialogProvider + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' + - name: sp-dynamic-data + uid: '@microsoft/sp-dynamic-data!' + items: + - name: DynamicDataReference + uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' + - name: IDynamicDataAnnotatedPropertyValue + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + - name: IDynamicDataCallables + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - name: IDynamicDataEventDefinition + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + - name: IDynamicDataPropertyDefinition + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + - name: IDynamicDataPropertyMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + - name: IDynamicDataPropertyValueMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + - name: IDynamicDataPropertyValueMetadataCollection + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - name: IDynamicDataSource + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + - name: IDynamicDataSourceMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + - name: sp-extension-base + uid: '@microsoft/sp-extension-base!' + items: + - name: BaseExtension + uid: '@microsoft/sp-extension-base!BaseExtension:class' + - name: ExtensionContext + uid: '@microsoft/sp-extension-base!ExtensionContext:class' + - name: sp-http + uid: '@microsoft/sp-http!' + items: + - name: AadHttpClient + uid: '@microsoft/sp-http!AadHttpClient:class' + - name: AadHttpClientConfiguration + uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' + - name: AadHttpClientFactory + uid: '@microsoft/sp-http!AadHttpClientFactory:class' + - name: AadTokenProvider + uid: '@microsoft/sp-http!AadTokenProvider:class' + - name: AadTokenProviderFactory + uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + - name: DigestCache + uid: '@microsoft/sp-http!DigestCache:class' + - name: GraphRequest + uid: '@microsoft/sp-http!GraphRequest:interface' + - name: HttpClient + uid: '@microsoft/sp-http!HttpClient:class' + - name: HttpClientConfiguration + uid: '@microsoft/sp-http!HttpClientConfiguration:class' + - name: HttpClientResponse + uid: '@microsoft/sp-http!HttpClientResponse:class' + - name: IAadHttpClientConfiguration + uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - name: IAadHttpClientConfigurations + uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - name: IAadHttpClientOptions + uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' + - name: IAadTokenProvider + uid: '@microsoft/sp-http!IAadTokenProvider:interface' + - name: IAadTokenProviderConfiguration + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - name: IDigestCache + uid: '@microsoft/sp-http!IDigestCache:interface' + - name: IHttpClientConfiguration + uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + - name: IHttpClientConfigurations + uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' + - name: IHttpClientOptions + uid: '@microsoft/sp-http!IHttpClientOptions:interface' + - name: ISPHttpClientBatchConfiguration + uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - name: ISPHttpClientBatchConfigurations + uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - name: ISPHttpClientBatchCreationOptions + uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - name: ISPHttpClientBatchOptions + uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - name: ISPHttpClientCommonConfiguration + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - name: ISPHttpClientConfiguration + uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - name: ISPHttpClientConfigurations + uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - name: ISPHttpClientOptions + uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' + - name: ITokenAcquisitionEventArgs + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + - name: MSGraphClient + uid: '@microsoft/sp-http!MSGraphClient:class' + - name: MSGraphClientFactory + uid: '@microsoft/sp-http!MSGraphClientFactory:class' + - name: ODataVersion + uid: '@microsoft/sp-http!ODataVersion:class' + - name: SPHttpClient + uid: '@microsoft/sp-http!SPHttpClient:class' + - name: SPHttpClientBatch + uid: '@microsoft/sp-http!SPHttpClientBatch:class' + - name: SPHttpClientBatchConfiguration + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + - name: SPHttpClientCommonConfiguration + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + - name: SPHttpClientConfiguration + uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' + - name: SPHttpClientResponse + uid: '@microsoft/sp-http!SPHttpClientResponse:class' + - name: SPHttpHeader + uid: '@microsoft/sp-http!SPHttpHeader:enum' + - name: TokenAcquisitionEventArgs + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + - name: sp-list-subscription + uid: '@microsoft/sp-list-subscription!' + items: + - name: ICreateSubscriptionSettings + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - name: IListSubscription + uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + - name: ISubscriptionCallbacks + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - name: ListSubscriptionFactory + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' + - name: sp-listview-extensibility + uid: '@microsoft/sp-listview-extensibility!' + items: + - name: BaseFieldCustomizer + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - name: BaseListViewCommandSet + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + - name: ColumnAccessor + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + - name: Command + uid: '@microsoft/sp-listview-extensibility!Command:class' + - name: FieldCustomizerContext + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - name: IFieldCustomizerCellEventParameters + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - name: IListViewCommandSetExecuteEventParameters + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - name: IListViewCommandSetListViewUpdatedParameters + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + - name: ListItemAccessor + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + - name: ListViewAccessor + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + - name: ListViewCommandSetContext + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - name: RowAccessor + uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + - name: SelectedRowsChangedEventArgs + uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + - name: sp-loader + uid: '@microsoft/sp-loader!' + items: + - name: ILoadScriptOptions + uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + - name: SPComponentLoader + uid: '@microsoft/sp-loader!SPComponentLoader:class' + - name: sp-lodash-subset + uid: '@microsoft/sp-lodash-subset!' + - name: sp-module-interfaces + uid: '@microsoft/sp-module-interfaces!' + items: + - name: IClientSideAssemblyManifest + uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - name: IClientSideComponentLoaderConfiguration + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - name: IClientSideComponentManifest + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - name: IClientSideExtensionManifest + uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - name: IClientSideLibraryManifest + uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - name: IClientSideManifestBase + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - name: IClientSideWebPartManifest + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - name: IClientSideWebPartManifestEntry + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - name: IClientSideWebPartManifestInstance + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - name: ICommandDefinition + uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - name: ICommandSetExtensionManifest + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - name: IComponentModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - name: ILocalizedPathModuleConfiguration + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - name: ILocalizedString + uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - name: IModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + - name: IPath + uid: '@microsoft/sp-module-interfaces!IPath:interface' + - name: IPathModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + - name: PredefinedGroup + uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + - name: sp-odata-types + uid: '@microsoft/sp-odata-types!' + items: + - name: _IODataUserId + uid: '@microsoft/sp-odata-types!_IODataUserId:interface' + - name: IODataBasePermission + uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + - name: IODataChangeToken + uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + - name: IODataContextWebInformation + uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - name: IODataList + uid: '@microsoft/sp-odata-types!IODataList:interface' + - name: IODataListItem + uid: '@microsoft/sp-odata-types!IODataListItem:interface' + - name: IODataNavigationNode + uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + - name: IODataNavigationNodeCollection + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + - name: IODataUser + uid: '@microsoft/sp-odata-types!IODataUser:interface' + - name: IODataUserCustomAction + uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + - name: IODataWeb + uid: '@microsoft/sp-odata-types!IODataWeb:interface' + - name: sp-page-context + uid: '@microsoft/sp-page-context!' + items: + - name: CultureInfo + uid: '@microsoft/sp-page-context!CultureInfo:class' + - name: ISPSystemTime + uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + - name: ISPTimeZoneData + uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' + - name: PageContext + uid: '@microsoft/sp-page-context!PageContext:class' + - name: SPDayOfWeek + uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' + - name: SPField + uid: '@microsoft/sp-page-context!SPField:class' + - name: SPList + uid: '@microsoft/sp-page-context!SPList:class' + - name: SPListItem + uid: '@microsoft/sp-page-context!SPListItem:class' + - name: SPPermission + uid: '@microsoft/sp-page-context!SPPermission:class' + - name: SPSite + uid: '@microsoft/sp-page-context!SPSite:class' + - name: SPTimeZone + uid: '@microsoft/sp-page-context!SPTimeZone:class' + - name: SPUser + uid: '@microsoft/sp-page-context!SPUser:class' + - name: SPWeb + uid: '@microsoft/sp-page-context!SPWeb:class' + - name: sp-property-pane + uid: '@microsoft/sp-property-pane!' + items: + - name: DynamicDataSharedDepth + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - name: IDynamicDataSharedPropertyConfiguration + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + - name: IDynamicDataSharedPropertyFilters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - name: IDynamicDataSharedSourceConfiguration + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - name: IDynamicDataSharedSourceFilters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - name: IPopupWindowProps + uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - name: IPropertyPaneButtonProps + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - name: IPropertyPaneCheckboxProps + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - name: IPropertyPaneChoiceGroupOption + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - name: IPropertyPaneChoiceGroupOptionIconProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - name: IPropertyPaneChoiceGroupProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - name: IPropertyPaneConditionalGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - name: IPropertyPaneConfiguration + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - name: IPropertyPaneCustomFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - name: IPropertyPaneDebounceProperty + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - name: IPropertyPaneDropdownCalloutProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - name: IPropertyPaneDropdownOption + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - name: IPropertyPaneDropdownProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - name: IPropertyPaneDynamicFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - name: IPropertyPaneDynamicFieldSetProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - name: IPropertyPaneDynamicTextFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - name: IPropertyPaneField + uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - name: IPropertyPaneGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - name: IPropertyPaneLabelProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - name: IPropertyPaneLinkProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - name: IPropertyPanePage + uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - name: IPropertyPanePageHeader + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - name: IPropertyPaneSliderProps + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - name: IPropertyPaneTextFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - name: IPropertyPaneToggleProps + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - name: PopupWindowPosition + uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - name: PropertyPaneButtonType + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - name: PropertyPaneDropdownOptionType + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - name: PropertyPaneFieldType + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - name: sp-search-extensibility + uid: '@microsoft/sp-search-extensibility!' + items: + - name: BaseSearchQueryModifier + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - name: IQuery + uid: '@microsoft/sp-search-extensibility!IQuery:interface' + - name: SearchQueryModifierContext + uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + - name: SearchQueryScenario + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + - name: sp-webpart-base + uid: '@microsoft/sp-webpart-base!' + items: + - name: BaseClientSideWebPart + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + - name: BaseWebPart + uid: '@microsoft/sp-webpart-base!BaseWebPart:class' + - name: BaseWebPartContext + uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' + - name: DynamicDataSharedDepth + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + - name: IClientSideWebPartStatusRenderer + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + - name: IDynamicDataSharedPropertyConfiguration + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + - name: IDynamicDataSharedPropertyFilters + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + - name: IDynamicDataSharedSourceConfiguration + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + - name: IDynamicDataSharedSourceFilters + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + - name: IMicrosoftTeams + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - name: IOffice + uid: '@microsoft/sp-webpart-base!IOffice:interface' + - name: IPropertyPaneAccessor + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - name: IPropertyPaneButtonProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - name: IPropertyPaneCheckboxProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - name: IPropertyPaneChoiceGroupOption + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + - name: IPropertyPaneChoiceGroupOptionIconProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + - name: IPropertyPaneChoiceGroupProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - name: IPropertyPaneConditionalGroup + uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + - name: IPropertyPaneConfiguration + uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + - name: IPropertyPaneCustomFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - name: IPropertyPaneDropdownCalloutProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + - name: IPropertyPaneDropdownOption + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + - name: IPropertyPaneDropdownProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - name: IPropertyPaneDynamicFieldFilters + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + - name: IPropertyPaneDynamicFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - name: IPropertyPaneDynamicFieldSetProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - name: IPropertyPaneDynamicTextFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - name: IPropertyPaneField + uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + - name: IPropertyPaneGroup + uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + - name: IPropertyPaneLabelProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - name: IPropertyPaneLinkProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - name: IPropertyPanePage + uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + - name: IPropertyPanePageHeader + uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + - name: IPropertyPaneSliderProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - name: IPropertyPaneTextFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - name: IPropertyPaneToggleProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + - name: ISDKs + uid: '@microsoft/sp-webpart-base!ISDKs:interface' + - name: ISerializedServerProcessedData + uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' + - name: ISerializedWebPartData + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + - name: IWebPartContext + uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' + - name: IWebPartData + uid: '@microsoft/sp-webpart-base!IWebPartData:interface' + - name: IWebPartPropertiesMetadata + uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + - name: IWebPartPropertyMetadata + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' + - name: PropertyPaneButtonType + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + - name: PropertyPaneDropdownOptionType + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + - name: PropertyPaneFieldType + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + - name: WebPartContext + uid: '@microsoft/sp-webpart-base!WebPartContext:class' + - name: WebPartFormFactor + uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 66664fa8..f0aa7b82 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: decorators + - uid: '@microsoft/decorators!' summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. remarks: >- This package provides a small set of decorators that enable more rigorous specification of API contracts when @@ -12,10 +12,10 @@ items: - typeScript type: package children: - - decorators.override - - decorators.sealed - - decorators.virtual - - uid: decorators.override + - '@microsoft/decorators!override:function(1)' + - '@microsoft/decorators!sealed:function(1)' + - '@microsoft/decorators!virtual:function(1)' + - uid: '@microsoft/decorators!override:function(1)' summary: >- This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as @virtual decorator is NOT applied to a @@ -91,7 +91,7 @@ items: - id: target description: '' type: - - Object + - '!Object:interface' - id: propertyKey description: '' type: @@ -99,4 +99,27 @@ items: - id: descriptor description: '' type: - - TypedPropertyDescriptor + - '@microsoft/decorators!virtual~0:complex' +references: + - uid: '!Object:interface' + name: Object + - uid: '@microsoft/decorators!override~0:complex' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + spec.typeScript: + - uid: '!TypedPropertyDescriptor:interface' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + - name: + fullName: + - uid: '!Function:interface' + name: Function + - uid: '@microsoft/decorators!virtual~0:complex' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + spec.typeScript: + - uid: '!TypedPropertyDescriptor:interface' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + - name: + fullName: diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index 9bba1312..94cdbe8c 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base + - uid: '@microsoft/sp-application-base!' summary: SharePoint Framework support for building and extending client-side applications. name: '@microsoft/sp-application-base' fullName: '@microsoft/sp-application-base' @@ -8,25 +8,25 @@ items: - typeScript type: package children: - - sp-application-base.ApplicationAccessor - - sp-application-base.ApplicationCustomizerContext - - sp-application-base.BaseApplicationCustomizer - - sp-application-base.IPlaceholderCreateContentOptions - - sp-application-base.PlaceholderContent - - sp-application-base.PlaceholderName - - sp-application-base.PlaceholderProvider + - '@microsoft/sp-application-base!ApplicationAccessor:class' + - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + - '@microsoft/sp-application-base!PlaceholderContent:class' + - '@microsoft/sp-application-base!PlaceholderName:enum' + - '@microsoft/sp-application-base!PlaceholderProvider:class' references: - - uid: sp-application-base.ApplicationAccessor + - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' name: ApplicationAccessor - - uid: sp-application-base.ApplicationCustomizerContext + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' name: ApplicationCustomizerContext - - uid: sp-application-base.BaseApplicationCustomizer + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' name: BaseApplicationCustomizer - - uid: sp-application-base.IPlaceholderCreateContentOptions + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' name: IPlaceholderCreateContentOptions - - uid: sp-application-base.PlaceholderContent + - uid: '@microsoft/sp-application-base!PlaceholderContent:class' name: PlaceholderContent - - uid: sp-application-base.PlaceholderName + - uid: '@microsoft/sp-application-base!PlaceholderName:enum' name: PlaceholderName - - uid: sp-application-base.PlaceholderProvider + - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' name: PlaceholderProvider diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index aaa3bf93..210861bd 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.ApplicationAccessor + - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' summary: Provides access to the client-side application that is currently running. remarks: >- The client-side application determines the user experience for an entire web page. (It is a client-side component @@ -19,16 +19,19 @@ items: langs: - typeScript type: class - package: sp-application-base + package: '@microsoft/sp-application-base!' children: - - sp-application-base.ApplicationAccessor.(constructor) - - sp-application-base.ApplicationAccessor.navigatedEvent - - uid: sp-application-base.ApplicationAccessor.(constructor) - summary: 'Constructs a new instance of the [ApplicationAccessor](xref:sp-application-base.ApplicationAccessor) class.' + - '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' + - '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' + - uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' + summary: >- + Constructs a new instance of the + [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) class. remarks: >- Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example - [BaseApplicationCustomizer.context](xref:sp-application-base.BaseApplicationCustomizer.context). + [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer#context:member). name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) langs: @@ -40,10 +43,12 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-application-base.ApplicationAccessor.navigatedEvent + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' summary: An event that is fired when the application's top-level page context navigates to a new page. - remarks: 'This event fires after the top-level [PageContext](xref:sp-page-context.PageContext) has navigated to a new page.' + remarks: >- + This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has + navigated to a new page. name: navigatedEvent fullName: navigatedEvent langs: @@ -53,4 +58,21 @@ items: content: 'readonly navigatedEvent: SPEvent;' return: type: - - SPEvent + - '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent~0:complex' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + fullName: SPEventArgs + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 4892dd6a..a7f80a4d 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -1,7 +1,9 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.ApplicationCustomizerContext - summary: 'The component context for [BaseApplicationCustomizer](xref:sp-application-base.BaseApplicationCustomizer).' + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + summary: >- + The component context for + [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class. @@ -11,13 +13,17 @@ items: - typeScript type: class extends: - - sp-extension-base.ExtensionContext - package: sp-application-base + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-application-base!' children: - - sp-application-base.ApplicationCustomizerContext.application - - sp-application-base.ApplicationCustomizerContext.dispose - - sp-application-base.ApplicationCustomizerContext.placeholderProvider - - uid: sp-application-base.ApplicationCustomizerContext.application + - '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' + - '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' + - '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' summary: Provides access to the client-side application that is currently running. name: application fullName: application @@ -28,8 +34,8 @@ items: content: 'readonly application: ApplicationAccessor;' return: type: - - sp-application-base.ApplicationAccessor - - uid: sp-application-base.ApplicationCustomizerContext.dispose + - '@microsoft/sp-application-base!default:class' + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' name: dispose() fullName: dispose() langs: @@ -43,7 +49,7 @@ items: type: - void description: '' - - uid: sp-application-base.ApplicationCustomizerContext.placeholderProvider + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' summary: Exposes a collection of content placeholders for use by third parties. name: placeholderProvider fullName: placeholderProvider @@ -54,4 +60,11 @@ items: content: 'readonly placeholderProvider: PlaceholderProvider;' return: type: - - sp-application-base.PlaceholderProvider + - '@microsoft/sp-application-base!default:class' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-application-base!default:class' + name: ApplicationAccessor diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index ea010bb2..484272c2 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.BaseApplicationCustomizer + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' summary: >- This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting. @@ -17,13 +17,15 @@ items: - typeScript type: class extends: - - 'BaseExtension ' - package: sp-application-base + - '@microsoft/sp-application-base!BaseApplicationCustomizer~0:complex' + inheritance: + - type: '@microsoft/sp-application-base!BaseApplicationCustomizer~1:complex' + package: '@microsoft/sp-application-base!' children: - - sp-application-base.BaseApplicationCustomizer.context - - sp-application-base.BaseApplicationCustomizer.dispose - - sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged - - uid: sp-application-base.BaseApplicationCustomizer.context + - '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' + - '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' + - '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' name: context fullName: context langs: @@ -33,8 +35,8 @@ items: content: 'protected readonly context: ApplicationCustomizerContext;' return: type: - - sp-application-base.ApplicationCustomizerContext - - uid: sp-application-base.BaseApplicationCustomizer.dispose + - '@microsoft/sp-application-base!default:class' + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' summary: Disposes the component. remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends @@ -50,7 +52,7 @@ items: type: - void description: '' - - uid: sp-application-base.BaseApplicationCustomizer.onPlaceholdersChanged + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' summary: >- This event method is called when the placeholders of the host application change, come into existence, or disappear. @@ -69,4 +71,25 @@ items: - id: placeholderProvider description: '' type: - - sp-application-base.PlaceholderProvider + - '@microsoft/sp-application-base!default:class' +references: + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer~0:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer~1:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-application-base!default:class' + name: ApplicationCustomizerContext diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index 4d650869..a4cd7ce6 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -1,18 +1,19 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.IPlaceholderCreateContentOptions + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' summary: >- Options for the - [PlaceholderProvider.tryCreateContent()](xref:sp-application-base.PlaceholderProvider.tryCreateContent) method. + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) + method. name: IPlaceholderCreateContentOptions fullName: IPlaceholderCreateContentOptions langs: - typeScript type: interface - package: sp-application-base + package: '@microsoft/sp-application-base!' children: - - sp-application-base.IPlaceholderCreateContentOptions.onDispose - - uid: sp-application-base.IPlaceholderCreateContentOptions.onDispose + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' summary: An optional callback that will be invoked when the PlaceholderContent object is disposed. remarks: >- To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content @@ -27,4 +28,16 @@ items: content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' return: type: - - '(placeholderContent: PlaceholderContent) => void' + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose~0:complex' +references: + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose~0:complex' + name: '(placeholderContent: PlaceholderContent) => void' + fullName: '(placeholderContent: default) => void' + spec.typeScript: + - name: '(placeholderContent: ' + fullName: '(placeholderContent: ' + - uid: '@microsoft/sp-application-base!default:class' + name: PlaceholderContent + fullName: default + - name: ) => void + fullName: ) => void diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 8f80c7fb..0289ba91 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -1,11 +1,11 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.PlaceholderContent + - uid: '@microsoft/sp-application-base!PlaceholderContent:class' summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. remarks: >- This object is returned by - [PlaceholderProvider.tryCreateContent()](xref:sp-application-base.PlaceholderProvider.tryCreateContent). - It provides access to a Document Object Model (DOM) element where the owner can render its custom content. + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -16,20 +16,20 @@ items: - typeScript type: class implements: - - sp-core-library.IDisposable - package: sp-application-base + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-application-base!' children: - - sp-application-base.PlaceholderContent.dispose - - sp-application-base.PlaceholderContent.domElement - - sp-application-base.PlaceholderContent.isDisposed - - sp-application-base.PlaceholderContent.isVisible - - sp-application-base.PlaceholderContent.name - - uid: sp-application-base.PlaceholderContent.dispose + - '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' + - '@microsoft/sp-application-base!PlaceholderContent#domElement:member' + - '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' + - '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' + - '@microsoft/sp-application-base!PlaceholderContent#name:member' + - uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. remarks: >- This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the application when the containing placeholder is disposed. Calling dispose() invokes the - [IPlaceholderCreateContentOptions.onDispose](xref:sp-application-base.IPlaceholderCreateContentOptions.onDispose) + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. name: dispose() fullName: dispose() @@ -42,11 +42,11 @@ items: type: - void description: '' - - uid: sp-application-base.PlaceholderContent.domElement + - uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' summary: The Document Object Model (DOM) element where the owner should render its custom content. remarks: >- If the caller needs to be notified when the DOM element is disposed, use the - [IPlaceholderCreateContentOptions.onDispose](xref:sp-application-base.IPlaceholderCreateContentOptions.onDispose) + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) callback. name: domElement fullName: domElement @@ -57,8 +57,8 @@ items: content: 'readonly domElement: HTMLDivElement;' return: type: - - HTMLDivElement - - uid: sp-application-base.PlaceholderContent.isDisposed + - '!HTMLDivElement:interface' + - uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' name: isDisposed fullName: isDisposed langs: @@ -69,7 +69,7 @@ items: return: type: - boolean - - uid: sp-application-base.PlaceholderContent.isVisible + - uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' summary: >- Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. @@ -83,7 +83,7 @@ items: return: type: - boolean - - uid: sp-application-base.PlaceholderContent.name + - uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' name: name @@ -95,4 +95,11 @@ items: content: 'readonly name: PlaceholderName;' return: type: - - sp-application-base.PlaceholderName + - '@microsoft/sp-application-base!~PlaceholderName:enum' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '!HTMLDivElement:interface' + name: HTMLDivElement + - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' + name: PlaceholderName diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index 90e7d986..f46b2010 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -1,22 +1,22 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.PlaceholderName + - uid: '@microsoft/sp-application-base!PlaceholderName:enum' summary: >- The identifier for a content placeholder, which is a region on the page where third-party extensibility components can render custom content. remarks: >- For more information about placeholders, see - [PlaceholderProvider](xref:sp-application-base.PlaceholderProvider). + [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). name: PlaceholderName fullName: PlaceholderName langs: - typeScript type: enum - package: sp-application-base + package: '@microsoft/sp-application-base!' children: - - sp-application-base.PlaceholderName.Bottom - - sp-application-base.PlaceholderName.Top - - uid: sp-application-base.PlaceholderName.Bottom + - '@microsoft/sp-application-base!PlaceholderName.Bottom:member' + - '@microsoft/sp-application-base!PlaceholderName.Top:member' + - uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' summary: A region at the bottom of the page. name: Bottom fullName: Bottom @@ -24,7 +24,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-application-base.PlaceholderName.Top + - uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' summary: A region at the top of the page. name: Top fullName: Top diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index f8139c55..3d75bec7 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -1,21 +1,22 @@ ### YamlMime:UniversalReference items: - - uid: sp-application-base.PlaceholderProvider + - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' summary: >- Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components to render custom content into designated regions on the page. remarks: >- Placeholders are designated regions on the page, identified by one of the predefined - [PlaceholderName](xref:sp-application-base.PlaceholderName) constants. Different applications and pages might - support different placeholder names. Placeholders can appear and disappear as the user interacts with the page, - for example via in-place navigation. Third-party components should not assume that a given placeholder will always - be available. + [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and + pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with + the page, for example via in-place navigation. Third-party components should not assume that a given placeholder + will always be available. - Use [PlaceholderProvider.tryCreateContent()](xref:sp-application-base.PlaceholderProvider.tryCreateContent) to - test whether a placeholder is available and add content to it. Use the - [PlaceholderProvider.changedEvent](xref:sp-application-base.PlaceholderProvider.changedEvent) event to discover - when new placeholders appear. + Use + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) + to test whether a placeholder is available and add content to it. Use the + [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member) + event to discover when new placeholders appear. The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -26,15 +27,15 @@ items: - typeScript type: class implements: - - sp-core-library.IDisposable - package: sp-application-base + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-application-base!' children: - - sp-application-base.PlaceholderProvider.changedEvent - - sp-application-base.PlaceholderProvider.dispose - - sp-application-base.PlaceholderProvider.isDisposed - - sp-application-base.PlaceholderProvider.placeholderNames - - sp-application-base.PlaceholderProvider.tryCreateContent - - uid: sp-application-base.PlaceholderProvider.changedEvent + - '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' + - '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' + - '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' + - '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' + - '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' summary: This event is raised when the list of currently available placeholders is changed. remarks: >- The application can change its list of available placeholders at any time. This means that the existing @@ -49,8 +50,8 @@ items: content: 'readonly changedEvent: SPEvent;' return: type: - - SPEvent - - uid: sp-application-base.PlaceholderProvider.dispose + - '@microsoft/sp-application-base!PlaceholderProvider#changedEvent~0:complex' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' name: dispose() fullName: dispose() langs: @@ -62,7 +63,7 @@ items: type: - void description: '' - - uid: sp-application-base.PlaceholderProvider.isDisposed + - uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' name: isDisposed fullName: isDisposed langs: @@ -73,7 +74,7 @@ items: return: type: - boolean - - uid: sp-application-base.PlaceholderProvider.placeholderNames + - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' summary: Returns the names of the currently available placeholders. name: placeholderNames fullName: placeholderNames @@ -84,8 +85,8 @@ items: content: 'readonly placeholderNames: ReadonlyArray;' return: type: - - ReadonlyArray - - uid: sp-application-base.PlaceholderProvider.tryCreateContent + - '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames~0:complex' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' summary: >- Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder. @@ -104,14 +105,58 @@ items: undefined; return: type: - - PlaceholderContent | undefined + - '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent~0:complex' description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' parameters: - id: name description: The requested placeholder type: - - sp-application-base.PlaceholderName + - '@microsoft/sp-application-base!~PlaceholderName:enum' - id: options description: 'Additional options, for example to detect when the placeholder is disposed.' type: - - sp-application-base.IPlaceholderCreateContentOptions + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + fullName: SPEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' + name: PlaceholderName + fullName: PlaceholderName + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent~0:complex' + name: PlaceholderContent | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-application-base!default:class' + name: PlaceholderContent + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' + name: PlaceholderName + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + name: IPlaceholderCreateContentOptions diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 3a2ff431..b48028ac 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base + - uid: '@microsoft/sp-component-base!' summary: SharePoint Framework support for building client-side components remarks: >- This package supports development of client-side components (e.g. web parts, client-side extensions, and @@ -12,49 +12,75 @@ items: - typeScript type: package children: - - sp-component-base.BaseComponent - - sp-component-base.BaseComponentContext - - sp-component-base.DynamicDataProvider - - sp-component-base.DynamicDataSourceManager - - sp-component-base.DynamicProperty - - sp-component-base.IFontStyles - - sp-component-base.IPalette - - sp-component-base.IRawStyle - - sp-component-base.IReadonlyFontStyles - - sp-component-base.IReadonlyTheme - - sp-component-base.ISemanticColors - - sp-component-base.ISemanticTextColors - - sp-component-base.ITheme - - sp-component-base.ThemeChangedEventArgs - - sp-component-base.ThemeProvider + - '@microsoft/sp-component-base!BaseComponent:class' + - '@microsoft/sp-component-base!BaseComponentContext:class' + - '@microsoft/sp-component-base!DynamicDataProvider:class' + - '@microsoft/sp-component-base!DynamicDataSourceManager:class' + - '@microsoft/sp-component-base!DynamicProperty:class' + - '@microsoft/sp-component-base!IFontStyles:interface' + - '@microsoft/sp-component-base!IPalette:interface' + - '@microsoft/sp-component-base!IRawStyle:interface' + - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - '@microsoft/sp-component-base!IReadonlyTheme:interface' + - '@microsoft/sp-component-base!ISemanticColors:interface' + - '@microsoft/sp-component-base!ISemanticTextColors:interface' + - '@microsoft/sp-component-base!ITheme:interface' + - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + - '@microsoft/sp-component-base!ThemeProvider:class' + - uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' + name: IReadonlyRawStyle + fullName: IReadonlyRawStyle + langs: + - typeScript + type: typealias + syntax: + content: export declare type IReadonlyRawStyle = Readonly; + return: + type: + - '@microsoft/sp-component-base!IReadonlyRawStyle~0:complex' references: - - uid: sp-component-base.BaseComponent + - uid: '@microsoft/sp-component-base!BaseComponent:class' name: BaseComponent - - uid: sp-component-base.BaseComponentContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' name: BaseComponentContext - - uid: sp-component-base.DynamicDataProvider + - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' name: DynamicDataProvider - - uid: sp-component-base.DynamicDataSourceManager + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' name: DynamicDataSourceManager - - uid: sp-component-base.DynamicProperty + - uid: '@microsoft/sp-component-base!DynamicProperty:class' name: DynamicProperty - - uid: sp-component-base.IFontStyles + - uid: '@microsoft/sp-component-base!IFontStyles:interface' name: IFontStyles - - uid: sp-component-base.IPalette + - uid: '@microsoft/sp-component-base!IPalette:interface' name: IPalette - - uid: sp-component-base.IRawStyle + - uid: '@microsoft/sp-component-base!IRawStyle:interface' name: IRawStyle - - uid: sp-component-base.IReadonlyFontStyles + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' name: IReadonlyFontStyles - - uid: sp-component-base.IReadonlyTheme + - uid: '@microsoft/sp-component-base!IReadonlyRawStyle~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!IRawStyle:interface' + name: IRawStyle + fullName: IRawStyle + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' name: IReadonlyTheme - - uid: sp-component-base.ISemanticColors + - uid: '@microsoft/sp-component-base!ISemanticColors:interface' name: ISemanticColors - - uid: sp-component-base.ISemanticTextColors + - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' name: ISemanticTextColors - - uid: sp-component-base.ITheme + - uid: '@microsoft/sp-component-base!ITheme:interface' name: ITheme - - uid: sp-component-base.ThemeChangedEventArgs + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' name: ThemeChangedEventArgs - - uid: sp-component-base.ThemeProvider + - uid: '@microsoft/sp-component-base!ThemeProvider:class' name: ThemeProvider diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 7b530eaf..7a4eda0a 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.BaseComponent + - uid: '@microsoft/sp-component-base!BaseComponent:class' summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -11,17 +11,17 @@ items: - typeScript type: class implements: - - sp-core-library.ISPEventObserver - package: sp-component-base + - '@microsoft/sp-core-library!ISPEventObserver:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.BaseComponent.componentId - - sp-component-base.BaseComponent.context - - sp-component-base.BaseComponent.dispose - - sp-component-base.BaseComponent.instanceId - - sp-component-base.BaseComponent.isDisposed - - sp-component-base.BaseComponent.manifest - - sp-component-base.BaseComponent.onDispose - - uid: sp-component-base.BaseComponent.componentId + - '@microsoft/sp-component-base!BaseComponent#componentId:member' + - '@microsoft/sp-component-base!BaseComponent#context:member' + - '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' + - '@microsoft/sp-component-base!BaseComponent#instanceId:member' + - '@microsoft/sp-component-base!BaseComponent#isDisposed:member' + - '@microsoft/sp-component-base!BaseComponent#manifest:member' + - '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' + - uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' summary: Returns the component identifier as defined in the component’s associated manifest. remarks: >- Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which @@ -37,7 +37,7 @@ items: return: type: - string - - uid: sp-component-base.BaseComponent.context + - uid: '@microsoft/sp-component-base!BaseComponent#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a @@ -52,13 +52,13 @@ items: content: 'protected context: BaseComponentContext;' return: type: - - sp-component-base.BaseComponentContext - - uid: sp-component-base.BaseComponent.dispose + - '@microsoft/sp-component-base!~BaseComponentContext:class' + - uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' summary: Disposes the component. remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the - [BaseComponent.onDispose()](xref:sp-component-base.BaseComponent.onDispose) method. + [onDispose()](xref:@microsoft/sp-component-base!BaseComponent#onDispose:member(1)) method. name: dispose() fullName: dispose() langs: @@ -70,7 +70,7 @@ items: type: - void description: '' - - uid: sp-component-base.BaseComponent.instanceId + - uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' summary: A unique identifier for the instance of the component. remarks: >- A component implementation can be loaded multiple times on the page. For example, if the component is a charting @@ -86,7 +86,7 @@ items: return: type: - string - - uid: sp-component-base.BaseComponent.isDisposed + - uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' summary: Returns true if the component has been already disposed. name: isDisposed fullName: isDisposed @@ -98,7 +98,7 @@ items: return: type: - boolean - - uid: sp-component-base.BaseComponent.manifest + - uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' summary: Provides access to the manifest for the client-side component. remarks: Child classes can override this with more specialized manifest types. name: manifest @@ -110,8 +110,8 @@ items: content: 'readonly manifest: IClientSideComponentManifest;' return: type: - - IClientSideComponentManifest - - uid: sp-component-base.BaseComponent.onDispose + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' summary: >- This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. @@ -126,3 +126,10 @@ items: type: - void description: '' +references: + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + name: ISPEventObserver + - uid: '@microsoft/sp-component-base!~BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 89d9f981..cc828e10 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.BaseComponentContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' summary: The base class for context objects for client-side components. remarks: >- A "context" object is a collection of well-known services and other objects that are likely to be needed by @@ -16,23 +16,23 @@ items: - typeScript type: class implements: - - sp-core-library.IDisposable - package: sp-component-base + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.BaseComponentContext.aadHttpClientFactory - - sp-component-base.BaseComponentContext.aadTokenProviderFactory - - sp-component-base.BaseComponentContext.dispose - - sp-component-base.BaseComponentContext.dynamicDataProvider - - sp-component-base.BaseComponentContext.dynamicDataSourceManager - - sp-component-base.BaseComponentContext.httpClient - - sp-component-base.BaseComponentContext.instanceId - - sp-component-base.BaseComponentContext.isDisposed - - sp-component-base.BaseComponentContext.manifest - - sp-component-base.BaseComponentContext.msGraphClientFactory - - sp-component-base.BaseComponentContext.pageContext - - sp-component-base.BaseComponentContext.serviceScope - - sp-component-base.BaseComponentContext.spHttpClient - - uid: sp-component-base.BaseComponentContext.aadHttpClientFactory + - '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' + - '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' + - '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' + - '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' + - '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' + - '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' + - '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' + - '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' + - '@microsoft/sp-component-base!BaseComponentContext#manifest:member' + - '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' + - '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' + - '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' + - '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' + - uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' summary: The instance of AadHttpClientFactory created for this instance of component name: aadHttpClientFactory fullName: aadHttpClientFactory @@ -43,8 +43,8 @@ items: content: 'readonly aadHttpClientFactory: AadHttpClientFactory;' return: type: - - sp-http.AadHttpClientFactory - - uid: sp-component-base.BaseComponentContext.aadTokenProviderFactory + - '@microsoft/sp-http!AadHttpClientFactory:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' summary: The instance of AadTokenProviderFactory created for this instance of component name: aadTokenProviderFactory fullName: aadTokenProviderFactory @@ -55,8 +55,8 @@ items: content: 'readonly aadTokenProviderFactory: AadTokenProviderFactory;' return: type: - - sp-http.AadTokenProviderFactory - - uid: sp-component-base.BaseComponentContext.dispose + - '@microsoft/sp-http!AadTokenProviderFactory:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' summary: Disposes the base component context. name: dispose() fullName: dispose() @@ -69,7 +69,7 @@ items: type: - void description: '' - - uid: sp-component-base.BaseComponentContext.dynamicDataProvider + - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' summary: Returns the Dynamic Data Provider associated with the component. name: dynamicDataProvider fullName: dynamicDataProvider @@ -80,8 +80,8 @@ items: content: 'readonly dynamicDataProvider: DynamicDataProvider;' return: type: - - sp-component-base.DynamicDataProvider - - uid: sp-component-base.BaseComponentContext.dynamicDataSourceManager + - '@microsoft/sp-component-base!default:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' summary: Returns the Dynamic Data Source Manager associated with the component. name: dynamicDataSourceManager fullName: dynamicDataSourceManager @@ -92,8 +92,8 @@ items: content: 'readonly dynamicDataSourceManager: DynamicDataSourceManager;' return: type: - - sp-component-base.DynamicDataSourceManager - - uid: sp-component-base.BaseComponentContext.httpClient + - '@microsoft/sp-component-base!default:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' summary: The instance of HttpClient created for this instance of component name: httpClient fullName: httpClient @@ -104,8 +104,8 @@ items: content: 'readonly httpClient: HttpClient;' return: type: - - sp-http.HttpClient - - uid: sp-component-base.BaseComponentContext.instanceId + - '@microsoft/sp-http!HttpClient:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' summary: A unique identifier for the instance of the component. remarks: >- A component implementation can be loaded multiple times on the page. For example, if the component is a charting @@ -121,7 +121,7 @@ items: return: type: - string - - uid: sp-component-base.BaseComponentContext.isDisposed + - uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' summary: Returns true if the context is disposed. name: isDisposed fullName: isDisposed @@ -133,7 +133,7 @@ items: return: type: - boolean - - uid: sp-component-base.BaseComponentContext.manifest + - uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' summary: Manifest for the client-side component. name: manifest fullName: manifest @@ -144,8 +144,8 @@ items: content: 'readonly manifest: IClientSideComponentManifest;' return: type: - - IClientSideComponentManifest - - uid: sp-component-base.BaseComponentContext.msGraphClientFactory + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' summary: The instance of MSGraphClientFactory created for this instance of component name: msGraphClientFactory fullName: msGraphClientFactory @@ -156,8 +156,8 @@ items: content: 'readonly msGraphClientFactory: MSGraphClientFactory;' return: type: - - sp-http.MSGraphClientFactory - - uid: sp-component-base.BaseComponentContext.pageContext + - '@microsoft/sp-http!MSGraphClientFactory:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' summary: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. @@ -170,9 +170,9 @@ items: content: 'readonly pageContext: PageContext;' return: type: - - sp-page-context.PageContext - - uid: sp-component-base.BaseComponentContext.serviceScope - summary: 'The associated [ServiceScope](xref:sp-core-library.ServiceScope) for this component.' + - '@microsoft/sp-page-context!PageContext:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' + summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. name: serviceScope fullName: serviceScope @@ -183,8 +183,8 @@ items: content: 'readonly serviceScope: ServiceScope;' return: type: - - sp-core-library.ServiceScope - - uid: sp-component-base.BaseComponentContext.spHttpClient + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' summary: The instance of SpHttpClient created for this instance of component name: spHttpClient fullName: spHttpClient @@ -195,4 +195,25 @@ items: content: 'readonly spHttpClient: SPHttpClient;' return: type: - - sp-http.SPHttpClient + - '@microsoft/sp-http!SPHttpClient:class' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-http!AadHttpClientFactory:class' + name: AadHttpClientFactory + - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + name: AadTokenProviderFactory + - uid: '@microsoft/sp-component-base!default:class' + name: DynamicDataProvider + - uid: '@microsoft/sp-http!HttpClient:class' + name: HttpClient + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-http!MSGraphClientFactory:class' + name: MSGraphClientFactory + - uid: '@microsoft/sp-page-context!PageContext:class' + name: PageContext + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!SPHttpClient:class' + name: SPHttpClient diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index a0aa4ead..a620f664 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.DynamicDataProvider + - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' summary: >- The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. @@ -10,20 +10,20 @@ items: - typeScript type: class implements: - - sp-core-library.IDisposable - package: sp-component-base + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.DynamicDataProvider.dispose - - sp-component-base.DynamicDataProvider.getAvailableSources - - sp-component-base.DynamicDataProvider.isDisposed - - sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged - - sp-component-base.DynamicDataProvider.registerPropertyChanged - - sp-component-base.DynamicDataProvider.registerSourceChanged - - sp-component-base.DynamicDataProvider.tryGetSource - - sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged - - sp-component-base.DynamicDataProvider.unregisterPropertyChanged - - sp-component-base.DynamicDataProvider.unregisterSourceChanged - - uid: sp-component-base.DynamicDataProvider.dispose + - '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' + - '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' + - uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' summary: Disposes the Dynamic Data Provider. name: dispose() fullName: dispose() @@ -36,7 +36,7 @@ items: type: - void description: '' - - uid: sp-component-base.DynamicDataProvider.getAvailableSources + - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' summary: Returns a list with all available Dynamic Data Sources. name: getAvailableSources() fullName: getAvailableSources() @@ -47,9 +47,9 @@ items: content: 'getAvailableSources(): ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' description: Read-only array with all available sources. - - uid: sp-component-base.DynamicDataProvider.isDisposed + - uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' summary: Returns true if the Dynamic Data Provider is disposed. name: isDisposed fullName: isDisposed @@ -61,7 +61,7 @@ items: return: type: - boolean - - uid: sp-component-base.DynamicDataProvider.registerAvailableSourcesChanged + - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. name: registerAvailableSourcesChanged(callback) fullName: registerAvailableSourcesChanged(callback) @@ -79,7 +79,7 @@ items: description: Function to execute when the sources are updated. type: - () => void - - uid: sp-component-base.DynamicDataProvider.registerPropertyChanged + - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' summary: Registers a callback for updates when a property is changed in a Dynamic Data source. name: 'registerPropertyChanged(sourceId, propertyId, callback)' fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' @@ -105,7 +105,7 @@ items: description: Function to execute when the source updates its data. type: - () => void - - uid: sp-component-base.DynamicDataProvider.registerSourceChanged + - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' summary: >- Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. @@ -129,7 +129,7 @@ items: description: Function to execute when the source updates its data. type: - () => void - - uid: sp-component-base.DynamicDataProvider.tryGetSource + - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' name: tryGetSource(id) fullName: tryGetSource(id) @@ -140,14 +140,14 @@ items: content: 'tryGetSource(id: string): IDynamicDataSource | undefined;' return: type: - - IDynamicDataSource | undefined + - '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource~0:complex' description: '' parameters: - id: id description: Id of the Dynamic Data Source. type: - string - - uid: sp-component-base.DynamicDataProvider.unregisterAvailableSourcesChanged + - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. name: unregisterAvailableSourcesChanged(callback) fullName: unregisterAvailableSourcesChanged(callback) @@ -165,7 +165,7 @@ items: description: Function to remove from the registration. Must be the same it was registered with. type: - () => void - - uid: sp-component-base.DynamicDataProvider.unregisterPropertyChanged + - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' @@ -191,7 +191,7 @@ items: description: Function to remove from the registration. Must be the same it was registered with. type: - () => void - - uid: sp-component-base.DynamicDataProvider.unregisterSourceChanged + - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. name: 'unregisterSourceChanged(sourceId, callback)' fullName: 'unregisterSourceChanged(sourceId, callback)' @@ -213,3 +213,29 @@ items: description: Function to remove from the registration. Must be the same it was registered with. type: - () => void +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + fullName: IDynamicDataSource + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource~0:complex' + name: IDynamicDataSource | undefined + fullName: IDynamicDataSource | undefined + spec.typeScript: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + fullName: IDynamicDataSource + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index d223202f..70dd4d0f 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.DynamicDataSourceManager + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' summary: >- The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify @@ -11,17 +11,17 @@ items: - typeScript type: class implements: - - sp-core-library.IDisposable - package: sp-component-base + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.DynamicDataSourceManager.dispose - - sp-component-base.DynamicDataSourceManager.initializeSource - - sp-component-base.DynamicDataSourceManager.isDisposed - - sp-component-base.DynamicDataSourceManager.notifyPropertyChanged - - sp-component-base.DynamicDataSourceManager.notifySourceChanged - - sp-component-base.DynamicDataSourceManager.sourceId - - sp-component-base.DynamicDataSourceManager.updateMetadata - - uid: sp-component-base.DynamicDataSourceManager.dispose + - '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' + - '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' + - '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' summary: Disposes the resources held by the Dynamic Data source. name: dispose() fullName: dispose() @@ -34,7 +34,7 @@ items: type: - void description: '' - - uid: sp-component-base.DynamicDataSourceManager.initializeSource + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' summary: Initializes the Dynamic Data Source for the component. name: initializeSource(callableFunctions) fullName: initializeSource(callableFunctions) @@ -51,8 +51,8 @@ items: - id: callableFunctions description: Set of methods that are exposed through the Dynamic Data Source type: - - sp-dynamic-data.IDynamicDataCallables - - uid: sp-component-base.DynamicDataSourceManager.isDisposed + - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' summary: Returns true if the DynamicDataSourceManager is disposed. name: isDisposed fullName: isDisposed @@ -64,7 +64,7 @@ items: return: type: - boolean - - uid: sp-component-base.DynamicDataSourceManager.notifyPropertyChanged + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' summary: >- Notifies that this source has updated a specific property. @@ -87,7 +87,7 @@ items: description: Id of the updated property in the source. type: - string - - uid: sp-component-base.DynamicDataSourceManager.notifySourceChanged + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' summary: >- Notifies that this source has updated its properties. @@ -105,8 +105,10 @@ items: type: - void description: '' - - uid: sp-component-base.DynamicDataSourceManager.sourceId - summary: Returns the Id of the current DataSource. + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' + summary: >- + Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it + returns an empty string. name: sourceId fullName: sourceId langs: @@ -117,7 +119,7 @@ items: return: type: - string - - uid: sp-component-base.DynamicDataSourceManager.updateMetadata + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' summary: >- Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. @@ -136,4 +138,23 @@ items: - id: metadata description: Partial of the metadata. type: - - Partial + - '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata~0:complex' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + name: IDynamicDataCallables + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata~0:complex' + name: Partial + fullName: Partial + spec.typeScript: + - uid: '!Partial:type' + name: Partial + fullName: Partial + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + name: IDynamicDataSourceMetadata + fullName: IDynamicDataSourceMetadata + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 43ea4755..daf57f26 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.DynamicProperty + - uid: '@microsoft/sp-component-base!DynamicProperty:class' summary: Serializable object that simplifies usage of a DynamicProperty. remarks: >- This is built for usage in web part properties, and modified through the property pane. Can be initialized with a @@ -12,23 +12,23 @@ items: - typeScript type: class implements: - - sp-core-library.IDisposable - package: sp-component-base + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.DynamicProperty.(constructor) - - sp-component-base.DynamicProperty.dispose - - sp-component-base.DynamicProperty.hasDefaultCallback - - sp-component-base.DynamicProperty.isDisposed - - sp-component-base.DynamicProperty.reference - - sp-component-base.DynamicProperty.register - - sp-component-base.DynamicProperty.removeDefaultCallback - - sp-component-base.DynamicProperty.setReference - - sp-component-base.DynamicProperty.setValue - - sp-component-base.DynamicProperty.tryGetSource - - sp-component-base.DynamicProperty.tryGetValue - - sp-component-base.DynamicProperty.tryGetValues - - sp-component-base.DynamicProperty.unregister - - uid: sp-component-base.DynamicProperty.(constructor) + - '@microsoft/sp-component-base!DynamicProperty:constructor(1)' + - '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' + - '@microsoft/sp-component-base!DynamicProperty#reference:member' + - '@microsoft/sp-component-base!DynamicProperty#register:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' + - uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' summary: Create a new DynamicProperty object. name: '(constructor)(provider, callback)' fullName: '(constructor)(provider, callback)' @@ -41,12 +41,12 @@ items: - id: provider description: DynamicDataProvider. type: - - sp-component-base.DynamicDataProvider + - '@microsoft/sp-component-base!default:class' - id: callback description: Optional. Default callback to be registered for updates in the DynamicDataSource. type: - () => void - - uid: sp-component-base.DynamicProperty.dispose + - uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: dispose() @@ -60,7 +60,7 @@ items: type: - void description: '' - - uid: sp-component-base.DynamicProperty.hasDefaultCallback + - uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' summary: Returns true if the object has a default callback. name: hasDefaultCallback() fullName: hasDefaultCallback() @@ -73,7 +73,7 @@ items: type: - boolean description: '' - - uid: sp-component-base.DynamicProperty.isDisposed + - uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' summary: >- Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. @@ -88,7 +88,7 @@ items: return: type: - boolean - - uid: sp-component-base.DynamicProperty.reference + - uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' summary: >- DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`. @@ -103,7 +103,7 @@ items: return: type: - string | undefined - - uid: sp-component-base.DynamicProperty.register + - uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' summary: Registers a callback function for updates on the associated DynamicDataSource. name: register(callback) fullName: register(callback) @@ -121,7 +121,7 @@ items: description: Callback function to register. type: - () => void - - uid: sp-component-base.DynamicProperty.removeDefaultCallback + - uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. name: removeDefaultCallback() @@ -135,7 +135,7 @@ items: type: - void description: '' - - uid: sp-component-base.DynamicProperty.setReference + - uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' summary: >- Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. @@ -155,7 +155,7 @@ items: description: Id of the DynamicDataSource and property. type: - string - - uid: sp-component-base.DynamicProperty.setValue + - uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' summary: Sets a static value in the DynamicProperty. name: setValue(value) fullName: setValue(value) @@ -173,7 +173,7 @@ items: description: Value for the DynamicProperty. type: - TValue - - uid: sp-component-base.DynamicProperty.tryGetSource + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' summary: >- Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. @@ -186,9 +186,9 @@ items: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: type: - - IDynamicDataSource | undefined + - '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' description: '' - - uid: sp-component-base.DynamicProperty.tryGetValue + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' summary: Returns the value of the object. remarks: >- If the value is an array, then the first element of the array is returned; otherwise, the value itself is @@ -196,7 +196,7 @@ items: NOTE: This api will never return an array. To retrieve an array value, use the - [DynamicProperty.tryGetValues()](xref:sp-component-base.DynamicProperty.tryGetValues) API. + [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)) API. name: tryGetValue() fullName: tryGetValue() langs: @@ -208,7 +208,7 @@ items: type: - TValue | undefined description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. - - uid: sp-component-base.DynamicProperty.tryGetValues + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' summary: Returns the value of the object. remarks: >- If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the @@ -216,7 +216,8 @@ items: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array - value, use the [DynamicProperty.tryGetValue()](xref:sp-component-base.DynamicProperty.tryGetValue) API. + value, use the + [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)) API. name: tryGetValues() fullName: tryGetValues() langs: @@ -228,7 +229,7 @@ items: type: - 'TValue[]' description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - - uid: sp-component-base.DynamicProperty.unregister + - uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' summary: >- Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. @@ -248,3 +249,17 @@ items: description: Callback function to unregister. type: - () => void +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-component-base!default:class' + name: DynamicDataProvider + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' + name: IDynamicDataSource | undefined + fullName: IDynamicDataSource | undefined + spec.typeScript: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + fullName: IDynamicDataSource + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-component-base/ifontstyles.yml b/SP-Framework/sp-component-base/ifontstyles.yml index 488c47e4..6f796e86 100644 --- a/SP-Framework/sp-component-base/ifontstyles.yml +++ b/SP-Framework/sp-component-base/ifontstyles.yml @@ -1,26 +1,26 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.IFontStyles + - uid: '@microsoft/sp-component-base!IFontStyles:interface' summary: Font styles for different sizes. name: IFontStyles fullName: IFontStyles langs: - typeScript type: interface - package: sp-component-base + package: '@microsoft/sp-component-base!' children: - - sp-component-base.IFontStyles.large - - sp-component-base.IFontStyles.medium - - sp-component-base.IFontStyles.mediumPlus - - sp-component-base.IFontStyles.mega - - sp-component-base.IFontStyles.small - - sp-component-base.IFontStyles.smallPlus - - sp-component-base.IFontStyles.superLarge - - sp-component-base.IFontStyles.tiny - - sp-component-base.IFontStyles.xLarge - - sp-component-base.IFontStyles.xSmall - - sp-component-base.IFontStyles.xxLarge - - uid: sp-component-base.IFontStyles.large + - '@microsoft/sp-component-base!IFontStyles#large:member' + - '@microsoft/sp-component-base!IFontStyles#medium:member' + - '@microsoft/sp-component-base!IFontStyles#mediumPlus:member' + - '@microsoft/sp-component-base!IFontStyles#mega:member' + - '@microsoft/sp-component-base!IFontStyles#small:member' + - '@microsoft/sp-component-base!IFontStyles#smallPlus:member' + - '@microsoft/sp-component-base!IFontStyles#superLarge:member' + - '@microsoft/sp-component-base!IFontStyles#tiny:member' + - '@microsoft/sp-component-base!IFontStyles#xLarge:member' + - '@microsoft/sp-component-base!IFontStyles#xSmall:member' + - '@microsoft/sp-component-base!IFontStyles#xxLarge:member' + - uid: '@microsoft/sp-component-base!IFontStyles#large:member' summary: Large font style. name: large fullName: large @@ -31,8 +31,8 @@ items: content: 'large: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.medium + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#medium:member' summary: Medium font style. name: medium fullName: medium @@ -43,8 +43,8 @@ items: content: 'medium: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.mediumPlus + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#mediumPlus:member' summary: Larger than medium but smaller than large font style. name: mediumPlus fullName: mediumPlus @@ -55,8 +55,8 @@ items: content: 'mediumPlus: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.mega + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#mega:member' summary: Mega sized font style. name: mega fullName: mega @@ -67,8 +67,8 @@ items: content: 'mega: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.small + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#small:member' summary: Small font style. name: small fullName: small @@ -79,8 +79,8 @@ items: content: 'small: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.smallPlus + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#smallPlus:member' summary: Larger than small but smaller than medium font style. name: smallPlus fullName: smallPlus @@ -91,8 +91,8 @@ items: content: 'smallPlus: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.superLarge + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#superLarge:member' summary: Super large font style. name: superLarge fullName: superLarge @@ -103,8 +103,8 @@ items: content: 'superLarge: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.tiny + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#tiny:member' summary: Tiny font style. name: tiny fullName: tiny @@ -115,8 +115,8 @@ items: content: 'tiny: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.xLarge + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#xLarge:member' summary: Extra large font style. name: xLarge fullName: xLarge @@ -127,8 +127,8 @@ items: content: 'xLarge: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.xSmall + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#xSmall:member' summary: Extra small font style. name: xSmall fullName: xSmall @@ -139,8 +139,8 @@ items: content: 'xSmall: IRawStyle;' return: type: - - sp-component-base.IRawStyle - - uid: sp-component-base.IFontStyles.xxLarge + - '@microsoft/sp-component-base!IRawStyle:interface' + - uid: '@microsoft/sp-component-base!IFontStyles#xxLarge:member' summary: Extra extra large font style. name: xxLarge fullName: xxLarge @@ -151,4 +151,7 @@ items: content: 'xxLarge: IRawStyle;' return: type: - - sp-component-base.IRawStyle + - '@microsoft/sp-component-base!IRawStyle:interface' +references: + - uid: '@microsoft/sp-component-base!IRawStyle:interface' + name: IRawStyle diff --git a/SP-Framework/sp-component-base/ipalette.yml b/SP-Framework/sp-component-base/ipalette.yml index ee5482b1..2ee753f5 100644 --- a/SP-Framework/sp-component-base/ipalette.yml +++ b/SP-Framework/sp-component-base/ipalette.yml @@ -1,64 +1,64 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.IPalette + - uid: '@microsoft/sp-component-base!IPalette:interface' summary: Color palette. name: IPalette fullName: IPalette langs: - typeScript type: interface - package: sp-component-base + package: '@microsoft/sp-component-base!' children: - - sp-component-base.IPalette.accent - - sp-component-base.IPalette.black - - sp-component-base.IPalette.blackTranslucent40 - - sp-component-base.IPalette.blue - - sp-component-base.IPalette.blueDark - - sp-component-base.IPalette.blueLight - - sp-component-base.IPalette.blueMid - - sp-component-base.IPalette.green - - sp-component-base.IPalette.greenDark - - sp-component-base.IPalette.greenLight - - sp-component-base.IPalette.magenta - - sp-component-base.IPalette.magentaDark - - sp-component-base.IPalette.magentaLight - - sp-component-base.IPalette.neutralDark - - sp-component-base.IPalette.neutralLight - - sp-component-base.IPalette.neutralLighter - - sp-component-base.IPalette.neutralLighterAlt - - sp-component-base.IPalette.neutralPrimary - - sp-component-base.IPalette.neutralPrimaryAlt - - sp-component-base.IPalette.neutralQuaternary - - sp-component-base.IPalette.neutralQuaternaryAlt - - sp-component-base.IPalette.neutralSecondary - - sp-component-base.IPalette.neutralSecondaryAlt - - sp-component-base.IPalette.neutralTertiary - - sp-component-base.IPalette.neutralTertiaryAlt - - sp-component-base.IPalette.orange - - sp-component-base.IPalette.orangeLight - - sp-component-base.IPalette.orangeLighter - - sp-component-base.IPalette.purple - - sp-component-base.IPalette.purpleDark - - sp-component-base.IPalette.purpleLight - - sp-component-base.IPalette.red - - sp-component-base.IPalette.redDark - - sp-component-base.IPalette.teal - - sp-component-base.IPalette.tealDark - - sp-component-base.IPalette.tealLight - - sp-component-base.IPalette.themeDark - - sp-component-base.IPalette.themeDarkAlt - - sp-component-base.IPalette.themeDarker - - sp-component-base.IPalette.themeLight - - sp-component-base.IPalette.themeLighter - - sp-component-base.IPalette.themeLighterAlt - - sp-component-base.IPalette.themePrimary - - sp-component-base.IPalette.themeSecondary - - sp-component-base.IPalette.themeTertiary - - sp-component-base.IPalette.white - - sp-component-base.IPalette.whiteTranslucent40 - - sp-component-base.IPalette.yellow - - sp-component-base.IPalette.yellowLight - - uid: sp-component-base.IPalette.accent + - '@microsoft/sp-component-base!IPalette#accent:member' + - '@microsoft/sp-component-base!IPalette#black:member' + - '@microsoft/sp-component-base!IPalette#blackTranslucent40:member' + - '@microsoft/sp-component-base!IPalette#blue:member' + - '@microsoft/sp-component-base!IPalette#blueDark:member' + - '@microsoft/sp-component-base!IPalette#blueLight:member' + - '@microsoft/sp-component-base!IPalette#blueMid:member' + - '@microsoft/sp-component-base!IPalette#green:member' + - '@microsoft/sp-component-base!IPalette#greenDark:member' + - '@microsoft/sp-component-base!IPalette#greenLight:member' + - '@microsoft/sp-component-base!IPalette#magenta:member' + - '@microsoft/sp-component-base!IPalette#magentaDark:member' + - '@microsoft/sp-component-base!IPalette#magentaLight:member' + - '@microsoft/sp-component-base!IPalette#neutralDark:member' + - '@microsoft/sp-component-base!IPalette#neutralLight:member' + - '@microsoft/sp-component-base!IPalette#neutralLighter:member' + - '@microsoft/sp-component-base!IPalette#neutralLighterAlt:member' + - '@microsoft/sp-component-base!IPalette#neutralPrimary:member' + - '@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member' + - '@microsoft/sp-component-base!IPalette#neutralQuaternary:member' + - '@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member' + - '@microsoft/sp-component-base!IPalette#neutralSecondary:member' + - '@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member' + - '@microsoft/sp-component-base!IPalette#neutralTertiary:member' + - '@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member' + - '@microsoft/sp-component-base!IPalette#orange:member' + - '@microsoft/sp-component-base!IPalette#orangeLight:member' + - '@microsoft/sp-component-base!IPalette#orangeLighter:member' + - '@microsoft/sp-component-base!IPalette#purple:member' + - '@microsoft/sp-component-base!IPalette#purpleDark:member' + - '@microsoft/sp-component-base!IPalette#purpleLight:member' + - '@microsoft/sp-component-base!IPalette#red:member' + - '@microsoft/sp-component-base!IPalette#redDark:member' + - '@microsoft/sp-component-base!IPalette#teal:member' + - '@microsoft/sp-component-base!IPalette#tealDark:member' + - '@microsoft/sp-component-base!IPalette#tealLight:member' + - '@microsoft/sp-component-base!IPalette#themeDark:member' + - '@microsoft/sp-component-base!IPalette#themeDarkAlt:member' + - '@microsoft/sp-component-base!IPalette#themeDarker:member' + - '@microsoft/sp-component-base!IPalette#themeLight:member' + - '@microsoft/sp-component-base!IPalette#themeLighter:member' + - '@microsoft/sp-component-base!IPalette#themeLighterAlt:member' + - '@microsoft/sp-component-base!IPalette#themePrimary:member' + - '@microsoft/sp-component-base!IPalette#themeSecondary:member' + - '@microsoft/sp-component-base!IPalette#themeTertiary:member' + - '@microsoft/sp-component-base!IPalette#white:member' + - '@microsoft/sp-component-base!IPalette#whiteTranslucent40:member' + - '@microsoft/sp-component-base!IPalette#yellow:member' + - '@microsoft/sp-component-base!IPalette#yellowLight:member' + - uid: '@microsoft/sp-component-base!IPalette#accent:member' summary: Color code for the accent. name: accent fullName: accent @@ -70,7 +70,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.black + - uid: '@microsoft/sp-component-base!IPalette#black:member' summary: >- Color code for the strongest color, which is black in the default theme. This is a very light color in inverted themes. @@ -84,7 +84,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.blackTranslucent40 + - uid: '@microsoft/sp-component-base!IPalette#blackTranslucent40:member' summary: Color code for blackTranslucent40. name: blackTranslucent40 fullName: blackTranslucent40 @@ -96,7 +96,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.blue + - uid: '@microsoft/sp-component-base!IPalette#blue:member' summary: Color code for blue. name: blue fullName: blue @@ -108,7 +108,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.blueDark + - uid: '@microsoft/sp-component-base!IPalette#blueDark:member' summary: Color code for blueDark. name: blueDark fullName: blueDark @@ -120,7 +120,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.blueLight + - uid: '@microsoft/sp-component-base!IPalette#blueLight:member' summary: Color code for blueLight. name: blueLight fullName: blueLight @@ -132,7 +132,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.blueMid + - uid: '@microsoft/sp-component-base!IPalette#blueMid:member' summary: Color code for blueMid. name: blueMid fullName: blueMid @@ -144,7 +144,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.green + - uid: '@microsoft/sp-component-base!IPalette#green:member' summary: Color code for green. name: green fullName: green @@ -156,7 +156,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.greenDark + - uid: '@microsoft/sp-component-base!IPalette#greenDark:member' summary: Color code for greenDark. name: greenDark fullName: greenDark @@ -168,7 +168,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.greenLight + - uid: '@microsoft/sp-component-base!IPalette#greenLight:member' summary: Color code for greenLight. name: greenLight fullName: greenLight @@ -180,7 +180,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.magenta + - uid: '@microsoft/sp-component-base!IPalette#magenta:member' summary: Color code for magenta. name: magenta fullName: magenta @@ -192,7 +192,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.magentaDark + - uid: '@microsoft/sp-component-base!IPalette#magentaDark:member' summary: Color code for magentaDark. name: magentaDark fullName: magentaDark @@ -204,7 +204,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.magentaLight + - uid: '@microsoft/sp-component-base!IPalette#magentaLight:member' summary: Color code for magentaLight. name: magentaLight fullName: magentaLight @@ -216,7 +216,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralDark + - uid: '@microsoft/sp-component-base!IPalette#neutralDark:member' summary: Color code for neutralDark. name: neutralDark fullName: neutralDark @@ -228,7 +228,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralLight + - uid: '@microsoft/sp-component-base!IPalette#neutralLight:member' summary: Color code for neutralLight. name: neutralLight fullName: neutralLight @@ -240,7 +240,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralLighter + - uid: '@microsoft/sp-component-base!IPalette#neutralLighter:member' summary: Color code for neutralLighter. name: neutralLighter fullName: neutralLighter @@ -252,7 +252,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralLighterAlt + - uid: '@microsoft/sp-component-base!IPalette#neutralLighterAlt:member' summary: Color code for neutralLighterAlt. name: neutralLighterAlt fullName: neutralLighterAlt @@ -264,7 +264,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralPrimary + - uid: '@microsoft/sp-component-base!IPalette#neutralPrimary:member' summary: Color code for neutralPrimary. name: neutralPrimary fullName: neutralPrimary @@ -276,7 +276,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralPrimaryAlt + - uid: '@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member' summary: Color code for neutralPrimaryAlt. name: neutralPrimaryAlt fullName: neutralPrimaryAlt @@ -288,7 +288,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralQuaternary + - uid: '@microsoft/sp-component-base!IPalette#neutralQuaternary:member' summary: Color code for neutralQuaternary. name: neutralQuaternary fullName: neutralQuaternary @@ -300,7 +300,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralQuaternaryAlt + - uid: '@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member' summary: Color code for neutralQuaternaryAlt. name: neutralQuaternaryAlt fullName: neutralQuaternaryAlt @@ -312,7 +312,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralSecondary + - uid: '@microsoft/sp-component-base!IPalette#neutralSecondary:member' summary: Color code for neutralSecondary. name: neutralSecondary fullName: neutralSecondary @@ -324,7 +324,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralSecondaryAlt + - uid: '@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member' summary: Color code for neutralSecondaryAlt. name: neutralSecondaryAlt fullName: neutralSecondaryAlt @@ -336,7 +336,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralTertiary + - uid: '@microsoft/sp-component-base!IPalette#neutralTertiary:member' summary: Color code for neutralTertiary. name: neutralTertiary fullName: neutralTertiary @@ -348,7 +348,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.neutralTertiaryAlt + - uid: '@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member' summary: Color code for neutralTertiaryAlt. name: neutralTertiaryAlt fullName: neutralTertiaryAlt @@ -360,7 +360,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.orange + - uid: '@microsoft/sp-component-base!IPalette#orange:member' summary: Color code for orange. name: orange fullName: orange @@ -372,7 +372,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.orangeLight + - uid: '@microsoft/sp-component-base!IPalette#orangeLight:member' summary: Color code for orangeLight. name: orangeLight fullName: orangeLight @@ -384,7 +384,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.orangeLighter + - uid: '@microsoft/sp-component-base!IPalette#orangeLighter:member' summary: Color code for orangeLighter. name: orangeLighter fullName: orangeLighter @@ -396,7 +396,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.purple + - uid: '@microsoft/sp-component-base!IPalette#purple:member' summary: Color code for purple. name: purple fullName: purple @@ -408,7 +408,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.purpleDark + - uid: '@microsoft/sp-component-base!IPalette#purpleDark:member' summary: Color code for purpleDark. name: purpleDark fullName: purpleDark @@ -420,7 +420,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.purpleLight + - uid: '@microsoft/sp-component-base!IPalette#purpleLight:member' summary: Color code for purpleLight. name: purpleLight fullName: purpleLight @@ -432,7 +432,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.red + - uid: '@microsoft/sp-component-base!IPalette#red:member' summary: Color code for red. name: red fullName: red @@ -444,7 +444,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.redDark + - uid: '@microsoft/sp-component-base!IPalette#redDark:member' summary: Color code for redDark. name: redDark fullName: redDark @@ -456,7 +456,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.teal + - uid: '@microsoft/sp-component-base!IPalette#teal:member' summary: Color code for teal. name: teal fullName: teal @@ -468,7 +468,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.tealDark + - uid: '@microsoft/sp-component-base!IPalette#tealDark:member' summary: Color code for tealDark. name: tealDark fullName: tealDark @@ -480,7 +480,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.tealLight + - uid: '@microsoft/sp-component-base!IPalette#tealLight:member' summary: Color code for tealLight. name: tealLight fullName: tealLight @@ -492,7 +492,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeDark + - uid: '@microsoft/sp-component-base!IPalette#themeDark:member' summary: Color code for themeDark. name: themeDark fullName: themeDark @@ -504,7 +504,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeDarkAlt + - uid: '@microsoft/sp-component-base!IPalette#themeDarkAlt:member' summary: Color code for themeDarkAlt. name: themeDarkAlt fullName: themeDarkAlt @@ -516,7 +516,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeDarker + - uid: '@microsoft/sp-component-base!IPalette#themeDarker:member' summary: Color code for themeDarker. name: themeDarker fullName: themeDarker @@ -528,7 +528,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeLight + - uid: '@microsoft/sp-component-base!IPalette#themeLight:member' summary: Color code for themeLight. name: themeLight fullName: themeLight @@ -540,7 +540,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeLighter + - uid: '@microsoft/sp-component-base!IPalette#themeLighter:member' summary: Color code for themeLighter. name: themeLighter fullName: themeLighter @@ -552,7 +552,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeLighterAlt + - uid: '@microsoft/sp-component-base!IPalette#themeLighterAlt:member' summary: Color code for themeLighterAlt. name: themeLighterAlt fullName: themeLighterAlt @@ -564,7 +564,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themePrimary + - uid: '@microsoft/sp-component-base!IPalette#themePrimary:member' summary: Color code for themePrimary. name: themePrimary fullName: themePrimary @@ -576,7 +576,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeSecondary + - uid: '@microsoft/sp-component-base!IPalette#themeSecondary:member' summary: Color code for themeSecondary. name: themeSecondary fullName: themeSecondary @@ -588,7 +588,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.themeTertiary + - uid: '@microsoft/sp-component-base!IPalette#themeTertiary:member' summary: Color code for themeTertiary. name: themeTertiary fullName: themeTertiary @@ -600,7 +600,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.white + - uid: '@microsoft/sp-component-base!IPalette#white:member' summary: >- Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. This is the page background. @@ -614,7 +614,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.whiteTranslucent40 + - uid: '@microsoft/sp-component-base!IPalette#whiteTranslucent40:member' summary: Color code for whiteTranslucent40 name: whiteTranslucent40 fullName: whiteTranslucent40 @@ -626,7 +626,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.yellow + - uid: '@microsoft/sp-component-base!IPalette#yellow:member' summary: Color code for yellow. name: yellow fullName: yellow @@ -638,7 +638,7 @@ items: return: type: - string - - uid: sp-component-base.IPalette.yellowLight + - uid: '@microsoft/sp-component-base!IPalette#yellowLight:member' summary: Color code for yellowLight. name: yellowLight fullName: yellowLight diff --git a/SP-Framework/sp-component-base/irawstyle.yml b/SP-Framework/sp-component-base/irawstyle.yml index 04ba0153..171ce204 100644 --- a/SP-Framework/sp-component-base/irawstyle.yml +++ b/SP-Framework/sp-component-base/irawstyle.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.IRawStyle + - uid: '@microsoft/sp-component-base!IRawStyle:interface' summary: 'IStyleObject extends a raw style objects, but allows selectors to be defined under the selectors node.' name: IRawStyle fullName: IRawStyle @@ -8,12 +8,14 @@ items: - typeScript type: interface extends: - - 'IRawStyleBase ' - package: sp-component-base + - '@microsoft/sp-component-base!IRawStyleBase:interface' + inheritance: + - type: '@microsoft/sp-component-base!IRawStyleBase:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.IRawStyle.displayName - - sp-component-base.IRawStyle.selectors - - uid: sp-component-base.IRawStyle.displayName + - '@microsoft/sp-component-base!IRawStyle#displayName:member' + - '@microsoft/sp-component-base!IRawStyle#selectors:member' + - uid: '@microsoft/sp-component-base!IRawStyle#displayName:member' summary: Display name for the style. name: displayName fullName: displayName @@ -25,7 +27,7 @@ items: return: type: - string - - uid: sp-component-base.IRawStyle.selectors + - uid: '@microsoft/sp-component-base!IRawStyle#selectors:member' summary: Custom selectors for the style. name: selectors fullName: selectors @@ -39,7 +41,32 @@ items: }; return: type: - - |- - { - [key: string]: IStyle; - } + - '@microsoft/sp-component-base!IRawStyle#selectors~0:complex' +references: + - uid: '@microsoft/sp-component-base!IRawStyleBase:interface' + name: IRawStyleBase + - uid: '@microsoft/sp-component-base!IRawStyle#selectors~0:complex' + name: |- + { + [key: string]: IStyle; + } + fullName: |- + { + [key: string]: IStyle; + } + spec.typeScript: + - name: |- + { + [key: string]: + fullName: |- + { + [key: string]: + - uid: '@microsoft/sp-component-base!IStyle:type' + name: IStyle + fullName: IStyle + - name: |- + ; + } + fullName: |- + ; + } diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index c8e61d5e..86ab44f5 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -1,26 +1,26 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.IReadonlyFontStyles + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' summary: Font styles for different sizes. name: IReadonlyFontStyles fullName: IReadonlyFontStyles langs: - typeScript type: interface - package: sp-component-base + package: '@microsoft/sp-component-base!' children: - - sp-component-base.IReadonlyFontStyles.large - - sp-component-base.IReadonlyFontStyles.medium - - sp-component-base.IReadonlyFontStyles.mediumPlus - - sp-component-base.IReadonlyFontStyles.mega - - sp-component-base.IReadonlyFontStyles.small - - sp-component-base.IReadonlyFontStyles.smallPlus - - sp-component-base.IReadonlyFontStyles.superLarge - - sp-component-base.IReadonlyFontStyles.tiny - - sp-component-base.IReadonlyFontStyles.xLarge - - sp-component-base.IReadonlyFontStyles.xSmall - - sp-component-base.IReadonlyFontStyles.xxLarge - - uid: sp-component-base.IReadonlyFontStyles.large + - '@microsoft/sp-component-base!IReadonlyFontStyles#large:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#medium:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#mega:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#small:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member' + - '@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#large:member' summary: Large font style. name: large fullName: large @@ -31,8 +31,8 @@ items: content: 'large: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.medium + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#medium:member' summary: Medium font style. name: medium fullName: medium @@ -43,8 +43,8 @@ items: content: 'medium: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.mediumPlus + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member' summary: Larger than medium but smaller than large font style. name: mediumPlus fullName: mediumPlus @@ -55,8 +55,8 @@ items: content: 'mediumPlus: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.mega + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mega:member' summary: Mega sized font style. name: mega fullName: mega @@ -67,8 +67,8 @@ items: content: 'mega: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.small + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#small:member' summary: Small font style. name: small fullName: small @@ -79,8 +79,8 @@ items: content: 'small: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.smallPlus + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member' summary: Larger than small but smaller than medium font style. name: smallPlus fullName: smallPlus @@ -91,8 +91,8 @@ items: content: 'smallPlus: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.superLarge + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member' summary: Super large font style. name: superLarge fullName: superLarge @@ -103,8 +103,8 @@ items: content: 'superLarge: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.tiny + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member' summary: Tiny font style. name: tiny fullName: tiny @@ -115,8 +115,8 @@ items: content: 'tiny: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.xLarge + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member' summary: Extra large font style. name: xLarge fullName: xLarge @@ -127,8 +127,8 @@ items: content: 'xLarge: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.xSmall + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member' summary: Extra small font style. name: xSmall fullName: xSmall @@ -139,8 +139,8 @@ items: content: 'xSmall: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle - - uid: sp-component-base.IReadonlyFontStyles.xxLarge + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member' summary: Extra extra large font style. name: xxLarge fullName: xxLarge @@ -151,4 +151,7 @@ items: content: 'xxLarge: IReadonlyRawStyle;' return: type: - - IReadonlyRawStyle + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' +references: + - uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' + name: IReadonlyRawStyle diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 7bb4b2e5..7cd3866e 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.IReadonlyTheme + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' summary: Immutable ITheme. name: IReadonlyTheme fullName: IReadonlyTheme @@ -8,13 +8,15 @@ items: - typeScript type: interface extends: - - 'Readonly ' - package: sp-component-base + - '@microsoft/sp-component-base!IReadonlyTheme~0:complex' + inheritance: + - type: '@microsoft/sp-component-base!IReadonlyTheme~1:complex' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.IReadonlyTheme.fonts - - sp-component-base.IReadonlyTheme.palette - - sp-component-base.IReadonlyTheme.semanticColors - - uid: sp-component-base.IReadonlyTheme.fonts + - '@microsoft/sp-component-base!IReadonlyTheme#fonts:member' + - '@microsoft/sp-component-base!IReadonlyTheme#palette:member' + - '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' + - uid: '@microsoft/sp-component-base!IReadonlyTheme#fonts:member' summary: Font styles for different sizes. name: fonts fullName: fonts @@ -25,8 +27,8 @@ items: content: 'readonly fonts: Readonly;' return: type: - - Readonly - - uid: sp-component-base.IReadonlyTheme.palette + - '@microsoft/sp-component-base!IReadonlyTheme#fonts~0:complex' + - uid: '@microsoft/sp-component-base!IReadonlyTheme#palette:member' summary: Color palette. name: palette fullName: palette @@ -37,8 +39,8 @@ items: content: 'readonly palette: Readonly;' return: type: - - Readonly - - uid: sp-component-base.IReadonlyTheme.semanticColors + - '@microsoft/sp-component-base!IReadonlyTheme#palette~0:complex' + - uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' summary: The collection of all semantic slots for colors used in themes. name: semanticColors fullName: semanticColors @@ -49,4 +51,75 @@ items: content: 'readonly semanticColors: Readonly;' return: type: - - Readonly + - '@microsoft/sp-component-base!IReadonlyTheme#semanticColors~0:complex' +references: + - uid: '@microsoft/sp-component-base!IReadonlyTheme~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + fullName: ITheme + - name: '> ' + fullName: '> ' + - uid: '@microsoft/sp-component-base!IReadonlyTheme~1:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + fullName: ITheme + - name: '> ' + fullName: '> ' + - uid: '@microsoft/sp-component-base!IReadonlyTheme#fonts~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + name: IReadonlyFontStyles + fullName: IReadonlyFontStyles + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!IReadonlyTheme#palette~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!IPalette:interface' + name: IPalette + fullName: IPalette + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ISemanticColors:interface' + name: ISemanticColors + fullName: ISemanticColors + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-component-base/isemanticcolors.yml b/SP-Framework/sp-component-base/isemanticcolors.yml index 19704dee..407ae35b 100644 --- a/SP-Framework/sp-component-base/isemanticcolors.yml +++ b/SP-Framework/sp-component-base/isemanticcolors.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.ISemanticColors + - uid: '@microsoft/sp-component-base!ISemanticColors:interface' summary: >- The collection of all semantic slots for colors used in themes. @@ -72,63 +72,65 @@ items: - typeScript type: interface extends: - - sp-component-base.ISemanticTextColors - package: sp-component-base + - '@microsoft/sp-component-base!ISemanticTextColors:interface' + inheritance: + - type: '@microsoft/sp-component-base!ISemanticTextColors:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.ISemanticColors.accentButtonBackground - - sp-component-base.ISemanticColors.blockingBackground - - sp-component-base.ISemanticColors.bodyBackground - - sp-component-base.ISemanticColors.bodyDivider - - sp-component-base.ISemanticColors.bodyFrameBackground - - sp-component-base.ISemanticColors.bodyFrameDivider - - sp-component-base.ISemanticColors.bodyStandoutBackground - - sp-component-base.ISemanticColors.buttonBackground - - sp-component-base.ISemanticColors.buttonBackgroundChecked - - sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered - - sp-component-base.ISemanticColors.buttonBackgroundDisabled - - sp-component-base.ISemanticColors.buttonBackgroundHovered - - sp-component-base.ISemanticColors.buttonBackgroundPressed - - sp-component-base.ISemanticColors.buttonBorder - - sp-component-base.ISemanticColors.buttonBorderDisabled - - sp-component-base.ISemanticColors.defaultStateBackground - - sp-component-base.ISemanticColors.disabledBackground - - sp-component-base.ISemanticColors.errorBackground - - sp-component-base.ISemanticColors.focusBorder - - sp-component-base.ISemanticColors.inputBackground - - sp-component-base.ISemanticColors.inputBackgroundChecked - - sp-component-base.ISemanticColors.inputBackgroundCheckedHovered - - sp-component-base.ISemanticColors.inputBorder - - sp-component-base.ISemanticColors.inputBorderHovered - - sp-component-base.ISemanticColors.inputFocusBorderAlt - - sp-component-base.ISemanticColors.inputForegroundChecked - - sp-component-base.ISemanticColors.listBackground - - sp-component-base.ISemanticColors.listHeaderBackgroundHovered - - sp-component-base.ISemanticColors.listHeaderBackgroundPressed - - sp-component-base.ISemanticColors.listItemBackgroundChecked - - sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered - - sp-component-base.ISemanticColors.listItemBackgroundHovered - - sp-component-base.ISemanticColors.listText - - sp-component-base.ISemanticColors.menuBackground - - sp-component-base.ISemanticColors.menuDivider - - sp-component-base.ISemanticColors.menuHeader - - sp-component-base.ISemanticColors.menuIcon - - sp-component-base.ISemanticColors.menuItemBackgroundChecked - - sp-component-base.ISemanticColors.menuItemBackgroundHovered - - sp-component-base.ISemanticColors.menuItemBackgroundPressed - - sp-component-base.ISemanticColors.menuItemText - - sp-component-base.ISemanticColors.menuItemTextHovered - - sp-component-base.ISemanticColors.primaryButtonBackground - - sp-component-base.ISemanticColors.primaryButtonBackgroundDisabled - - sp-component-base.ISemanticColors.primaryButtonBackgroundHovered - - sp-component-base.ISemanticColors.primaryButtonBackgroundPressed - - sp-component-base.ISemanticColors.primaryButtonBorder - - sp-component-base.ISemanticColors.smallInputBorder - - sp-component-base.ISemanticColors.successBackground - - sp-component-base.ISemanticColors.variantBorder - - sp-component-base.ISemanticColors.variantBorderHovered - - sp-component-base.ISemanticColors.warningBackground - - sp-component-base.ISemanticColors.warningHighlight - - uid: sp-component-base.ISemanticColors.accentButtonBackground + - '@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#blockingBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#bodyBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#bodyDivider:member' + - '@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#bodyFrameDivider:member' + - '@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBorder:member' + - '@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member' + - '@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#disabledBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#errorBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#focusBorder:member' + - '@microsoft/sp-component-base!ISemanticColors#inputBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member' + - '@microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#inputBorder:member' + - '@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member' + - '@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member' + - '@microsoft/sp-component-base!ISemanticColors#listBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member' + - '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member' + - '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#listText:member' + - '@microsoft/sp-component-base!ISemanticColors#menuBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#menuDivider:member' + - '@microsoft/sp-component-base!ISemanticColors#menuHeader:member' + - '@microsoft/sp-component-base!ISemanticColors#menuIcon:member' + - '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member' + - '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member' + - '@microsoft/sp-component-base!ISemanticColors#menuItemText:member' + - '@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member' + - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member' + - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member' + - '@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member' + - '@microsoft/sp-component-base!ISemanticColors#successBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#variantBorder:member' + - '@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member' + - '@microsoft/sp-component-base!ISemanticColors#warningBackground:member' + - '@microsoft/sp-component-base!ISemanticColors#warningHighlight:member' + - uid: '@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member' summary: Background of an accent button (kicker) name: accentButtonBackground fullName: accentButtonBackground @@ -140,7 +142,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.blockingBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#blockingBackground:member' summary: 'Background for blocking issues, which is more severe than a warning, but not as bad as an error.' name: blockingBackground fullName: blockingBackground @@ -152,7 +154,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.bodyBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#bodyBackground:member' summary: The default color for backgrounds. name: bodyBackground fullName: bodyBackground @@ -164,7 +166,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.bodyDivider + - uid: '@microsoft/sp-component-base!ISemanticColors#bodyDivider:member' summary: 'Divider lines; e.g. lines that separate sections in a menu, an
element.' name: bodyDivider fullName: bodyDivider @@ -176,7 +178,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.bodyFrameBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member' summary: >- The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the @@ -191,7 +193,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.bodyFrameDivider + - uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameDivider:member' summary: >- Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually @@ -206,7 +208,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.bodyStandoutBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member' summary: >- The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in @@ -221,7 +223,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackground:member' summary: Background of a standard button name: buttonBackground fullName: buttonBackground @@ -233,7 +235,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBackgroundChecked + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member' summary: Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar name: buttonBackgroundChecked fullName: buttonBackgroundChecked @@ -245,7 +247,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBackgroundCheckedHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member' summary: Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar name: buttonBackgroundCheckedHovered fullName: buttonBackgroundCheckedHovered @@ -257,7 +259,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBackgroundDisabled + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member' summary: Background of a disabled standard button name: buttonBackgroundDisabled fullName: buttonBackgroundDisabled @@ -269,7 +271,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBackgroundHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member' summary: Background of a hovered standard button name: buttonBackgroundHovered fullName: buttonBackgroundHovered @@ -281,7 +283,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBackgroundPressed + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member' summary: Background of a pressed standard button; i.e. currently being clicked by mouse name: buttonBackgroundPressed fullName: buttonBackgroundPressed @@ -293,7 +295,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBorder + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorder:member' summary: Border of a standard button name: buttonBorder fullName: buttonBorder @@ -305,7 +307,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.buttonBorderDisabled + - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member' summary: Border of a disabled standard button name: buttonBorderDisabled fullName: buttonBorderDisabled @@ -317,7 +319,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.defaultStateBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member' summary: >- Background color for default/empty state graphical elements; eg default icons, empty section that needs user to fill in content, placeholder graphics, empty seats, etc. @@ -331,7 +333,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.disabledBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#disabledBackground:member' summary: The default color for backgrounds of disabled controls; e.g. disabled text field. name: disabledBackground fullName: disabledBackground @@ -343,7 +345,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.errorBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#errorBackground:member' summary: 'The background for errors, if necessary, or highlighting the section of the page where the error is present.' name: errorBackground fullName: errorBackground @@ -355,7 +357,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.focusBorder + - uid: '@microsoft/sp-component-base!ISemanticColors#focusBorder:member' summary: The color of the outline around focused controls that don't already have a border; e.g. menu items name: focusBorder fullName: focusBorder @@ -367,7 +369,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#inputBackground:member' summary: 'The background color of an input, e.g. textbox background.' name: inputBackground fullName: inputBackground @@ -379,7 +381,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputBackgroundChecked + - uid: '@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member' summary: 'The background of a checked control; e.g. checked radio button''s dot, checked toggle''s background.' name: inputBackgroundChecked fullName: inputBackgroundChecked @@ -391,7 +393,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputBackgroundCheckedHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member' summary: The background of a checked and hovered control; e.g. checked checkbox's background color on hover. name: inputBackgroundCheckedHovered fullName: inputBackgroundCheckedHovered @@ -403,7 +405,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputBorder + - uid: '@microsoft/sp-component-base!ISemanticColors#inputBorder:member' summary: 'The border of a large input control in its resting, state; e.g. the box of dropdown.' name: inputBorder fullName: inputBorder @@ -415,7 +417,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputBorderHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member' summary: 'The border color of a large hovered input control, such as textbox.' name: inputBorderHovered fullName: inputBorderHovered @@ -427,7 +429,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputFocusBorderAlt + - uid: '@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member' summary: The alternate focus border color for elements that already have a border; e.g. text field borders on focus. name: inputFocusBorderAlt fullName: inputFocusBorderAlt @@ -439,7 +441,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.inputForegroundChecked + - uid: '@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member' summary: >- The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio button's background color around the dot. @@ -453,7 +455,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#listBackground:member' summary: The background color for the entire list. name: listBackground fullName: listBackground @@ -465,7 +467,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listHeaderBackgroundHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member' summary: The background color for a hovered list header. name: listHeaderBackgroundHovered fullName: listHeaderBackgroundHovered @@ -477,7 +479,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listHeaderBackgroundPressed + - uid: '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member' summary: The background color for a pressed list header. name: listHeaderBackgroundPressed fullName: listHeaderBackgroundPressed @@ -489,7 +491,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listItemBackgroundChecked + - uid: '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member' summary: The background color of a checked list item. name: listItemBackgroundChecked fullName: listItemBackgroundChecked @@ -501,7 +503,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listItemBackgroundCheckedHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member' summary: The background color of a checked and hovered list item. name: listItemBackgroundCheckedHovered fullName: listItemBackgroundCheckedHovered @@ -513,7 +515,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listItemBackgroundHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member' summary: The background color of a hovered list item. name: listItemBackgroundHovered fullName: listItemBackgroundHovered @@ -525,7 +527,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.listText + - uid: '@microsoft/sp-component-base!ISemanticColors#listText:member' summary: The default text color for list item titles and text in column fields. name: listText fullName: listText @@ -537,7 +539,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#menuBackground:member' summary: The background of a menu. name: menuBackground fullName: menuBackground @@ -549,7 +551,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuDivider + - uid: '@microsoft/sp-component-base!ISemanticColors#menuDivider:member' summary: The divider between menu items. name: menuDivider fullName: menuDivider @@ -561,7 +563,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuHeader + - uid: '@microsoft/sp-component-base!ISemanticColors#menuHeader:member' summary: The headers in menus that denote title of a section. name: menuHeader fullName: menuHeader @@ -573,7 +575,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuIcon + - uid: '@microsoft/sp-component-base!ISemanticColors#menuIcon:member' summary: The default colors of icons in menus. name: menuIcon fullName: menuIcon @@ -585,7 +587,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuItemBackgroundChecked + - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member' deprecated: content: >- (Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item @@ -600,7 +602,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuItemBackgroundHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member' summary: The background of a hovered menu item. name: menuItemBackgroundHovered fullName: menuItemBackgroundHovered @@ -612,7 +614,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuItemBackgroundPressed + - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member' summary: The background of a pressed menu item. name: menuItemBackgroundPressed fullName: menuItemBackgroundPressed @@ -624,7 +626,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuItemText + - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemText:member' summary: The text color of a menu item. name: menuItemText fullName: menuItemText @@ -636,7 +638,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.menuItemTextHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member' summary: The text color of a hovered menu item. name: menuItemTextHovered fullName: menuItemTextHovered @@ -648,7 +650,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member' summary: Background of a primary button name: primaryButtonBackground fullName: primaryButtonBackground @@ -660,7 +662,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundDisabled + - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member' summary: Background of a disabled primary button name: primaryButtonBackgroundDisabled fullName: primaryButtonBackgroundDisabled @@ -672,7 +674,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member' summary: Background of a hovered primary button name: primaryButtonBackgroundHovered fullName: primaryButtonBackgroundHovered @@ -684,7 +686,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBackgroundPressed + - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member' summary: Background of a pressed primary button; i.e. currently being clicked by mouse name: primaryButtonBackgroundPressed fullName: primaryButtonBackgroundPressed @@ -696,7 +698,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.primaryButtonBorder + - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member' summary: Border of a primary button name: primaryButtonBorder fullName: primaryButtonBorder @@ -708,7 +710,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.smallInputBorder + - uid: '@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member' summary: The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox. name: smallInputBorder fullName: smallInputBorder @@ -720,7 +722,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.successBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#successBackground:member' summary: Background for success name: successBackground fullName: successBackground @@ -732,7 +734,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.variantBorder + - uid: '@microsoft/sp-component-base!ISemanticColors#variantBorder:member' summary: 'The color of the border that provides contrast between an element, such as a card, and an emphasized background.' name: variantBorder fullName: variantBorder @@ -744,7 +746,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.variantBorderHovered + - uid: '@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member' summary: 'Hover color of border that provides contrast between an element, such as a card, and an emphasized background.' name: variantBorderHovered fullName: variantBorderHovered @@ -756,7 +758,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.warningBackground + - uid: '@microsoft/sp-component-base!ISemanticColors#warningBackground:member' summary: Background for warning messages. name: warningBackground fullName: warningBackground @@ -768,7 +770,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticColors.warningHighlight + - uid: '@microsoft/sp-component-base!ISemanticColors#warningHighlight:member' summary: Foreground color for warning highlights name: warningHighlight fullName: warningHighlight @@ -780,3 +782,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' + name: ISemanticTextColors diff --git a/SP-Framework/sp-component-base/isemantictextcolors.yml b/SP-Framework/sp-component-base/isemantictextcolors.yml index f71d0470..11b540b1 100644 --- a/SP-Framework/sp-component-base/isemantictextcolors.yml +++ b/SP-Framework/sp-component-base/isemantictextcolors.yml @@ -1,44 +1,44 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.ISemanticTextColors + - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' summary: Collection of semantic text colors. name: ISemanticTextColors fullName: ISemanticTextColors langs: - typeScript type: interface - package: sp-component-base + package: '@microsoft/sp-component-base!' children: - - sp-component-base.ISemanticTextColors.accentButtonText - - sp-component-base.ISemanticTextColors.actionLink - - sp-component-base.ISemanticTextColors.actionLinkHovered - - sp-component-base.ISemanticTextColors.bodySubtext - - sp-component-base.ISemanticTextColors.bodyText - - sp-component-base.ISemanticTextColors.bodyTextChecked - - sp-component-base.ISemanticTextColors.buttonText - - sp-component-base.ISemanticTextColors.buttonTextChecked - - sp-component-base.ISemanticTextColors.buttonTextCheckedHovered - - sp-component-base.ISemanticTextColors.buttonTextDisabled - - sp-component-base.ISemanticTextColors.buttonTextHovered - - sp-component-base.ISemanticTextColors.buttonTextPressed - - sp-component-base.ISemanticTextColors.disabledBodySubtext - - sp-component-base.ISemanticTextColors.disabledBodyText - - sp-component-base.ISemanticTextColors.disabledSubtext - - sp-component-base.ISemanticTextColors.disabledText - - sp-component-base.ISemanticTextColors.errorText - - sp-component-base.ISemanticTextColors.inputPlaceholderText - - sp-component-base.ISemanticTextColors.inputText - - sp-component-base.ISemanticTextColors.inputTextHovered - - sp-component-base.ISemanticTextColors.link - - sp-component-base.ISemanticTextColors.linkHovered - - sp-component-base.ISemanticTextColors.listText - - sp-component-base.ISemanticTextColors.listTextColor - - sp-component-base.ISemanticTextColors.primaryButtonText - - sp-component-base.ISemanticTextColors.primaryButtonTextDisabled - - sp-component-base.ISemanticTextColors.primaryButtonTextHovered - - sp-component-base.ISemanticTextColors.primaryButtonTextPressed - - sp-component-base.ISemanticTextColors.warningText - - uid: sp-component-base.ISemanticTextColors.accentButtonText + - '@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#actionLink:member' + - '@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member' + - '@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member' + - '@microsoft/sp-component-base!ISemanticTextColors#bodyText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member' + - '@microsoft/sp-component-base!ISemanticTextColors#buttonText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member' + - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member' + - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member' + - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member' + - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member' + - '@microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member' + - '@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member' + - '@microsoft/sp-component-base!ISemanticTextColors#disabledText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#errorText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#inputText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member' + - '@microsoft/sp-component-base!ISemanticTextColors#link:member' + - '@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member' + - '@microsoft/sp-component-base!ISemanticTextColors#listText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member' + - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member' + - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member' + - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member' + - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member' + - '@microsoft/sp-component-base!ISemanticTextColors#warningText:member' + - uid: '@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member' summary: Color of text for accent button (kicker) name: accentButtonText fullName: accentButtonText @@ -50,7 +50,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.actionLink + - uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLink:member' summary: Neutral colored links and links for action buttons. name: actionLink fullName: actionLink @@ -62,7 +62,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.actionLinkHovered + - uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member' summary: Hover state for neutral colored links and links for action buttons. name: actionLinkHovered fullName: actionLinkHovered @@ -74,7 +74,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.bodySubtext + - uid: '@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member' summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' name: bodySubtext fullName: bodySubtext @@ -86,7 +86,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.bodyText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyText:member' summary: The default color for text. name: bodyText fullName: bodyText @@ -98,7 +98,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.bodyTextChecked + - uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member' summary: 'Checked text color, e.g. selected menu item text.' name: bodyTextChecked fullName: bodyTextChecked @@ -110,7 +110,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.buttonText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonText:member' summary: Color of text in a standard button name: buttonText fullName: buttonText @@ -122,7 +122,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.buttonTextChecked + - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member' summary: Color of text in a checked standard button name: buttonTextChecked fullName: buttonTextChecked @@ -134,7 +134,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.buttonTextCheckedHovered + - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member' summary: Color of text in a checked and hovered standard button name: buttonTextCheckedHovered fullName: buttonTextCheckedHovered @@ -146,7 +146,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.buttonTextDisabled + - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member' summary: Color of text in a disabled standard button name: buttonTextDisabled fullName: buttonTextDisabled @@ -158,7 +158,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.buttonTextHovered + - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member' summary: Color of text in a hovered standard button name: buttonTextHovered fullName: buttonTextHovered @@ -170,7 +170,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.buttonTextPressed + - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member' summary: Color of text in a pressed standard button; i.e. currently being clicked by mouse name: buttonTextPressed fullName: buttonTextPressed @@ -182,7 +182,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.disabledBodySubtext + - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member' summary: 'Disabled de-emphasized text, for use on the default background (bodyBackground).' name: disabledBodySubtext fullName: disabledBodySubtext @@ -194,7 +194,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.disabledBodyText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member' summary: The default color for disabled text on the default background (bodyBackground). name: disabledBodyText fullName: disabledBodyText @@ -206,7 +206,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.disabledSubtext + - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member' summary: 'Disabled de-emphasized text, for use on disabledBackground.' name: disabledSubtext fullName: disabledSubtext @@ -218,7 +218,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.disabledText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledText:member' summary: >- The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled button text. @@ -232,7 +232,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.errorText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#errorText:member' summary: 'The default color of error text, used on bodyBackground.' name: errorText fullName: errorText @@ -244,7 +244,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.inputPlaceholderText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member' summary: The color of placeholder text. name: inputPlaceholderText fullName: inputPlaceholderText @@ -256,7 +256,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.inputText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#inputText:member' summary: The color of input text. name: inputText fullName: inputText @@ -268,7 +268,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.inputTextHovered + - uid: '@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member' summary: The color of input text on hover. name: inputTextHovered fullName: inputTextHovered @@ -280,7 +280,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.link + - uid: '@microsoft/sp-component-base!ISemanticTextColors#link:member' summary: The color of a link. name: link fullName: link @@ -292,7 +292,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.linkHovered + - uid: '@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member' summary: The color of a hovered link. Also used when the link is active. name: linkHovered fullName: linkHovered @@ -304,7 +304,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.listText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#listText:member' summary: The default text color for list item titles and text in column fields. name: listText fullName: listText @@ -316,7 +316,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.listTextColor + - uid: '@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member' deprecated: content: This slot was incorrectly named. Use listText instead. name: listTextColor @@ -329,7 +329,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.primaryButtonText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member' summary: Color of text in a primary button name: primaryButtonText fullName: primaryButtonText @@ -341,7 +341,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.primaryButtonTextDisabled + - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member' summary: Color of text in a disabled primary button name: primaryButtonTextDisabled fullName: primaryButtonTextDisabled @@ -353,7 +353,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.primaryButtonTextHovered + - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member' summary: Color of text in a hovered primary button name: primaryButtonTextHovered fullName: primaryButtonTextHovered @@ -365,7 +365,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.primaryButtonTextPressed + - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member' summary: Color of text in a pressed primary button; i.e. currently being clicked by mouse name: primaryButtonTextPressed fullName: primaryButtonTextPressed @@ -377,7 +377,7 @@ items: return: type: - string - - uid: sp-component-base.ISemanticTextColors.warningText + - uid: '@microsoft/sp-component-base!ISemanticTextColors#warningText:member' summary: 'The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.' name: warningText fullName: warningText diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index d6ca82af..2dc5875b 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -1,20 +1,20 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.ITheme + - uid: '@microsoft/sp-component-base!ITheme:interface' summary: 'Collection of theme values, which can be used to programatically style components.' name: ITheme fullName: ITheme langs: - typeScript type: interface - package: sp-component-base + package: '@microsoft/sp-component-base!' children: - - sp-component-base.ITheme.disableGlobalClassNames - - sp-component-base.ITheme.fonts - - sp-component-base.ITheme.isInverted - - sp-component-base.ITheme.palette - - sp-component-base.ITheme.semanticColors - - uid: sp-component-base.ITheme.disableGlobalClassNames + - '@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member' + - '@microsoft/sp-component-base!ITheme#fonts:member' + - '@microsoft/sp-component-base!ITheme#isInverted:member' + - '@microsoft/sp-component-base!ITheme#palette:member' + - '@microsoft/sp-component-base!ITheme#semanticColors:member' + - uid: '@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member' summary: >- Disables global styles on Fabric components. This will prevent global overrides that might have been set by other Fabric users from applying to your components. @@ -29,7 +29,7 @@ items: return: type: - boolean - - uid: sp-component-base.ITheme.fonts + - uid: '@microsoft/sp-component-base!ITheme#fonts:member' summary: Font styles for different sizes. name: fonts fullName: fonts @@ -40,8 +40,8 @@ items: content: 'fonts: IFontStyles;' return: type: - - sp-component-base.IFontStyles - - uid: sp-component-base.ITheme.isInverted + - '@microsoft/sp-component-base!IFontStyles:interface' + - uid: '@microsoft/sp-component-base!ITheme#isInverted:member' summary: Indicates whether the theme is inverted. name: isInverted fullName: isInverted @@ -53,7 +53,7 @@ items: return: type: - boolean - - uid: sp-component-base.ITheme.palette + - uid: '@microsoft/sp-component-base!ITheme#palette:member' summary: Color palette. name: palette fullName: palette @@ -64,8 +64,8 @@ items: content: 'palette: IPalette;' return: type: - - sp-component-base.IPalette - - uid: sp-component-base.ITheme.semanticColors + - '@microsoft/sp-component-base!IPalette:interface' + - uid: '@microsoft/sp-component-base!ITheme#semanticColors:member' summary: The collection of all semantic slots for colors used in themes. name: semanticColors fullName: semanticColors @@ -76,4 +76,11 @@ items: content: 'semanticColors: ISemanticColors;' return: type: - - sp-component-base.ISemanticColors + - '@microsoft/sp-component-base!ISemanticColors:interface' +references: + - uid: '@microsoft/sp-component-base!IFontStyles:interface' + name: IFontStyles + - uid: '@microsoft/sp-component-base!IPalette:interface' + name: IPalette + - uid: '@microsoft/sp-component-base!ISemanticColors:interface' + name: ISemanticColors diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index e733d4ed..81f70fb2 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.ThemeChangedEventArgs + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' summary: The object passed when the IThemeProvider.themeChangedEvent is raised. name: ThemeChangedEventArgs fullName: ThemeChangedEventArgs @@ -8,11 +8,13 @@ items: - typeScript type: class extends: - - sp-core-library.SPEventArgs - package: sp-component-base + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.ThemeChangedEventArgs.theme - - uid: sp-component-base.ThemeChangedEventArgs.theme + - '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' summary: 'The new theme. If the value is undefined, then the theme was cleared.' name: theme fullName: theme @@ -23,4 +25,16 @@ items: content: 'readonly theme: ITheme | undefined;' return: type: - - ITheme | undefined + - '@microsoft/sp-component-base!ThemeChangedEventArgs#theme~0:complex' +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme~0:complex' + name: ITheme | undefined + fullName: ITheme | undefined + spec.typeScript: + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + fullName: ITheme + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index dbded6c4..3e409459 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-component-base.ThemeProvider + - uid: '@microsoft/sp-component-base!ThemeProvider:class' summary: >- The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. @@ -9,13 +9,13 @@ items: langs: - typeScript type: class - package: sp-component-base + package: '@microsoft/sp-component-base!' children: - - sp-component-base.ThemeProvider.(constructor) - - sp-component-base.ThemeProvider.serviceKey - - sp-component-base.ThemeProvider.themeChangedEvent - - sp-component-base.ThemeProvider.tryGetTheme - - uid: sp-component-base.ThemeProvider.(constructor) + - '@microsoft/sp-component-base!ThemeProvider:constructor(1)' + - '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' + - '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' + - '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' + - uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' summary: Construct a new instance of the ThemeProvider class. name: '(constructor)(serviceScope, theme)' fullName: '(constructor)(serviceScope, theme)' @@ -28,12 +28,12 @@ items: - id: serviceScope description: The current service scope. type: - - sp-core-library.ServiceScope + - '@microsoft/sp-core-library!ServiceScope:class' - id: theme description: Theme to provide. type: - - sp-component-base.ITheme - - uid: sp-component-base.ThemeProvider.serviceKey + - '@microsoft/sp-component-base!ITheme:interface' + - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' summary: The service key for ThemeProvider. name: serviceKey fullName: serviceKey @@ -44,8 +44,8 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey - - uid: sp-component-base.ThemeProvider.themeChangedEvent + - '@microsoft/sp-component-base!ThemeProvider.serviceKey~0:complex' + - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' summary: Raised when the theme changes with the new theme as an argument. name: themeChangedEvent fullName: themeChangedEvent @@ -56,8 +56,8 @@ items: content: 'readonly themeChangedEvent: SPEvent;' return: type: - - SPEvent - - uid: sp-component-base.ThemeProvider.tryGetTheme + - '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent~0:complex' + - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' summary: 'If set, get the current scoped theme.' name: tryGetTheme() fullName: tryGetTheme() @@ -68,5 +68,47 @@ items: content: 'tryGetTheme(): IReadonlyTheme | undefined;' return: type: - - IReadonlyTheme | undefined + - '@microsoft/sp-component-base!ThemeProvider#tryGetTheme~0:complex' description: '' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ThemeProvider:class' + name: ThemeProvider + fullName: ThemeProvider + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + name: ThemeChangedEventArgs + fullName: ThemeChangedEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme~0:complex' + name: IReadonlyTheme | undefined + fullName: IReadonlyTheme | undefined + spec.typeScript: + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + name: IReadonlyTheme + fullName: IReadonlyTheme + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index 88a538cf..a0633a9d 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library + - uid: '@microsoft/sp-core-library!' summary: SharePoint Framework core libraries. remarks: >- This package provides a foundation of core classes that ensure a consistent character across all the other @@ -12,67 +12,93 @@ items: - typeScript type: package children: - - sp-core-library.DisplayMode - - sp-core-library.Environment - - sp-core-library.EnvironmentType - - sp-core-library.Guid - - sp-core-library.IDisposable - - sp-core-library.IRandomNumberGenerator - - sp-core-library.IServiceCollection - - sp-core-library.ISPEventObserver - - sp-core-library.ITimeProvider - - sp-core-library.Log - - sp-core-library.RandomNumberGenerator - - sp-core-library.ServiceKey - - sp-core-library.ServiceScope - - sp-core-library.Session - - sp-core-library.SPEvent - - sp-core-library.SPEventArgs - - sp-core-library.Text - - sp-core-library.TimeProvider - - sp-core-library.UrlQueryParameterCollection - - sp-core-library.Validate - - sp-core-library.Version + - '@microsoft/sp-core-library!DisplayMode:enum' + - '@microsoft/sp-core-library!Environment:class' + - '@microsoft/sp-core-library!EnvironmentType:enum' + - '@microsoft/sp-core-library!Guid:class' + - '@microsoft/sp-core-library!IDisposable:interface' + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - '@microsoft/sp-core-library!IServiceCollection:interface' + - '@microsoft/sp-core-library!ISPEventObserver:interface' + - '@microsoft/sp-core-library!ITimeProvider:interface' + - '@microsoft/sp-core-library!Log:class' + - '@microsoft/sp-core-library!RandomNumberGenerator:class' + - '@microsoft/sp-core-library!ServiceCreator:type' + - '@microsoft/sp-core-library!ServiceKey:class' + - '@microsoft/sp-core-library!ServiceScope:class' + - '@microsoft/sp-core-library!Session:class' + - '@microsoft/sp-core-library!SPEvent:class' + - '@microsoft/sp-core-library!SPEventArgs:class' + - '@microsoft/sp-core-library!Text:class' + - '@microsoft/sp-core-library!TimeProvider:class' + - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + - '@microsoft/sp-core-library!Validate:class' + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + summary: This is a callback that is used by ServiceKey.createCustom(). + name: ServiceCreator + fullName: ServiceCreator + langs: + - typeScript + type: typealias + syntax: + content: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' + typeParameters: + - id: T + return: + type: + - '@microsoft/sp-core-library!ServiceCreator~0:complex' references: - - uid: sp-core-library.DisplayMode + - uid: '@microsoft/sp-core-library!DisplayMode:enum' name: DisplayMode - - uid: sp-core-library.Environment + - uid: '@microsoft/sp-core-library!Environment:class' name: Environment - - uid: sp-core-library.EnvironmentType + - uid: '@microsoft/sp-core-library!EnvironmentType:enum' name: EnvironmentType - - uid: sp-core-library.Guid + - uid: '@microsoft/sp-core-library!Guid:class' name: Guid - - uid: sp-core-library.IDisposable + - uid: '@microsoft/sp-core-library!IDisposable:interface' name: IDisposable - - uid: sp-core-library.IRandomNumberGenerator + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' name: IRandomNumberGenerator - - uid: sp-core-library.IServiceCollection + - uid: '@microsoft/sp-core-library!IServiceCollection:interface' name: IServiceCollection - - uid: sp-core-library.ISPEventObserver + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' name: ISPEventObserver - - uid: sp-core-library.ITimeProvider + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' name: ITimeProvider - - uid: sp-core-library.Log + - uid: '@microsoft/sp-core-library!Log:class' name: Log - - uid: sp-core-library.RandomNumberGenerator + - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' name: RandomNumberGenerator - - uid: sp-core-library.ServiceKey + - uid: '@microsoft/sp-core-library!ServiceCreator~0:complex' + name: '(serviceScope: ServiceScope) => T' + fullName: '(serviceScope: default) => T' + spec.typeScript: + - name: '(serviceScope: ' + fullName: '(serviceScope: ' + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: ) => T + fullName: ) => T + - uid: '@microsoft/sp-core-library!ServiceKey:class' name: ServiceKey - - uid: sp-core-library.ServiceScope + - uid: '@microsoft/sp-core-library!ServiceScope:class' name: ServiceScope - - uid: sp-core-library.Session + - uid: '@microsoft/sp-core-library!Session:class' name: Session - - uid: sp-core-library.SPEvent + - uid: '@microsoft/sp-core-library!SPEvent:class' name: SPEvent - - uid: sp-core-library.SPEventArgs + - uid: '@microsoft/sp-core-library!SPEventArgs:class' name: SPEventArgs - - uid: sp-core-library.Text + - uid: '@microsoft/sp-core-library!Text:class' name: Text - - uid: sp-core-library.TimeProvider + - uid: '@microsoft/sp-core-library!TimeProvider:class' name: TimeProvider - - uid: sp-core-library.UrlQueryParameterCollection + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' name: UrlQueryParameterCollection - - uid: sp-core-library.Validate + - uid: '@microsoft/sp-core-library!Validate:class' name: Validate - - uid: sp-core-library.Version + - uid: '@microsoft/sp-core-library!Version:class' name: Version diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 558aaf01..2ff32dec 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.DisplayMode + - uid: '@microsoft/sp-core-library!DisplayMode:enum' summary: Indicates whether a visual control should display itself for reading or for editing. name: DisplayMode fullName: DisplayMode langs: - typeScript type: enum - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.DisplayMode.Edit - - sp-core-library.DisplayMode.Read - - uid: sp-core-library.DisplayMode.Edit + - '@microsoft/sp-core-library!DisplayMode.Edit:member' + - '@microsoft/sp-core-library!DisplayMode.Read:member' + - uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' summary: >- The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience. @@ -21,7 +21,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-core-library.DisplayMode.Read + - uid: '@microsoft/sp-core-library!DisplayMode.Read:member' summary: >- The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled. diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index f9040134..c852bf5b 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -1,16 +1,16 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Environment + - uid: '@microsoft/sp-core-library!Environment:class' summary: Information about the system environment where the SharePoint Framework is running. name: Environment fullName: Environment langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Environment.type - - uid: sp-core-library.Environment.type + - '@microsoft/sp-core-library!Environment.type:member' + - uid: '@microsoft/sp-core-library!Environment.type:member' summary: Indicates the general type of environment where the SharePoint Framework is running. name: type fullName: type @@ -21,4 +21,7 @@ items: content: 'static readonly type: EnvironmentType;' return: type: - - sp-core-library.EnvironmentType + - '@microsoft/sp-core-library!EnvironmentType:enum' +references: + - uid: '@microsoft/sp-core-library!EnvironmentType:enum' + name: EnvironmentType diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 7f8e2382..1b3c3609 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -1,22 +1,22 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.EnvironmentType + - uid: '@microsoft/sp-core-library!EnvironmentType:enum' summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: >- - This enum is used by the [Environment.type](xref:sp-core-library.Environment.type) property. It provides a way to - distinguish environments where certain functionality may be limited or disabled. + This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It + provides a way to distinguish environments where certain functionality may be limited or disabled. name: EnvironmentType fullName: EnvironmentType langs: - typeScript type: enum - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.EnvironmentType.ClassicSharePoint - - sp-core-library.EnvironmentType.Local - - sp-core-library.EnvironmentType.SharePoint - - sp-core-library.EnvironmentType.Test - - uid: sp-core-library.EnvironmentType.ClassicSharePoint + - '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' + - '@microsoft/sp-core-library!EnvironmentType.Local:member' + - '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' + - '@microsoft/sp-core-library!EnvironmentType.Test:member' + - uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' summary: >- Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported. @@ -26,7 +26,7 @@ items: - typeScript type: field numericValue: '3' - - uid: sp-core-library.EnvironmentType.Local + - uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' summary: >- Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the SharePoint Workbench when hosted via "gulp serve". SharePoint REST API calls will not be available, and in general @@ -38,7 +38,7 @@ items: - typeScript type: field numericValue: '1' - - uid: sp-core-library.EnvironmentType.SharePoint + - uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' summary: >- Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario. @@ -48,7 +48,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-core-library.EnvironmentType.Test + - uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' summary: >- Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled. diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index f6f93d00..7eb6110f 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Guid + - uid: '@microsoft/sp-core-library!Guid:class' summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' remarks: >- The input string is normalized and validated, which provides important guarantees that simplify other code that @@ -15,16 +15,16 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Guid.empty - - sp-core-library.Guid.equals - - sp-core-library.Guid.isValid - - sp-core-library.Guid.newGuid - - sp-core-library.Guid.parse - - sp-core-library.Guid.toString - - sp-core-library.Guid.tryParse - - uid: sp-core-library.Guid.empty + - '@microsoft/sp-core-library!Guid.empty:member' + - '@microsoft/sp-core-library!Guid#equals:member(1)' + - '@microsoft/sp-core-library!Guid.isValid:member(1)' + - '@microsoft/sp-core-library!Guid.newGuid:member(1)' + - '@microsoft/sp-core-library!Guid.parse:member(1)' + - '@microsoft/sp-core-library!Guid#toString:member(1)' + - '@microsoft/sp-core-library!Guid.tryParse:member(1)' + - uid: '@microsoft/sp-core-library!Guid.empty:member' summary: Returns a new empty Guid instance. name: empty fullName: empty @@ -35,8 +35,8 @@ items: content: 'static readonly empty: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-core-library.Guid.equals + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Guid#equals:member(1)' summary: Compare this instance to another Guid instance name: equals(guid) fullName: equals(guid) @@ -53,8 +53,8 @@ items: - id: guid description: '' type: - - sp-core-library.Guid - - uid: sp-core-library.Guid.isValid + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' summary: >- Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. @@ -74,7 +74,7 @@ items: description: The input string. type: - string | undefined | null - - uid: sp-core-library.Guid.newGuid + - uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' summary: >- Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. @@ -87,14 +87,14 @@ items: content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' return: type: - - sp-core-library.Guid + - '@microsoft/sp-core-library!default:class' description: A new unique Guid object parameters: - id: randomNumberGenerator description: '' type: - - sp-core-library.IRandomNumberGenerator - - uid: sp-core-library.Guid.parse + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - uid: '@microsoft/sp-core-library!Guid.parse:member(1)' summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' remarks: |- Example syntaxes accepted by this function: @@ -115,14 +115,14 @@ items: content: 'static parse(guidString: string | undefined | null): Guid;' return: type: - - sp-core-library.Guid + - '@microsoft/sp-core-library!default:class' description: A valid Guid object parameters: - id: guidString description: '' type: - string | undefined | null - - uid: sp-core-library.Guid.toString + - uid: '@microsoft/sp-core-library!Guid#toString:member(1)' summary: Returns a string representation of the GUID name: toString() fullName: toString() @@ -138,7 +138,7 @@ items: The GUID value in lowercase hexadecimal without braces. Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` - - uid: sp-core-library.Guid.tryParse + - uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' summary: >- Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned. @@ -161,10 +161,24 @@ items: content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' return: type: - - Guid | undefined + - '@microsoft/sp-core-library!Guid.tryParse~0:complex' description: 'The Guid object, or undefined if the string could not be parsed.' parameters: - id: guid description: The input string. type: - string | undefined | null +references: + - uid: '@microsoft/sp-core-library!default:class' + name: Guid + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + - uid: '@microsoft/sp-core-library!Guid.tryParse~0:complex' + name: Guid | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: Guid + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index c0792e98..41872079 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.IDisposable + - uid: '@microsoft/sp-core-library!IDisposable:interface' summary: Implemented by an object that supports a disposal lifecycle. remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. name: IDisposable @@ -8,11 +8,11 @@ items: langs: - typeScript type: interface - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.IDisposable.dispose - - sp-core-library.IDisposable.isDisposed - - uid: sp-core-library.IDisposable.dispose + - '@microsoft/sp-core-library!IDisposable#dispose:member(1)' + - '@microsoft/sp-core-library!IDisposable#isDisposed:member' + - uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' name: dispose() @@ -26,7 +26,7 @@ items: type: - void description: '' - - uid: sp-core-library.IDisposable.isDisposed + - uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' summary: >- Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 5401697f..01d02eaf 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -1,21 +1,24 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.IRandomNumberGenerator - summary: 'This is a [ServiceScope](xref:sp-core-library.ServiceScope) contract for generating pseudorandom random numbers.' + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + summary: >- + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom + random numbers. remarks: >- This interface abstracts the functionality of the system Math.random() API for usage with a - [ServiceScope](xref:sp-core-library.ServiceScope). For example, a unit test might replace the default - [RandomNumberGenerator](xref:sp-core-library.RandomNumberGenerator) service with a mock implementation that always - returns the same sequence of random numbers, in order to ensure that test failures are always repeatable. + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace + the default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a + mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures + are always repeatable. name: IRandomNumberGenerator fullName: IRandomNumberGenerator langs: - typeScript type: interface - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.IRandomNumberGenerator.generate - - uid: sp-core-library.IRandomNumberGenerator.generate + - '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' name: generate() fullName: generate() diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index 2039dce0..e4cfacf8 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.IServiceCollection + - uid: '@microsoft/sp-core-library!IServiceCollection:interface' summary: A shorthand pattern for extracting well-known services from a ServiceScope. deprecated: content: >- @@ -11,10 +11,10 @@ items: langs: - typeScript type: interface - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.IServiceCollection.serviceScope - - uid: sp-core-library.IServiceCollection.serviceScope + - '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' + - uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' summary: Returns the underlying ServiceScope that the members belong to. name: serviceScope fullName: serviceScope @@ -25,4 +25,7 @@ items: content: 'readonly serviceScope: ServiceScope;' return: type: - - sp-core-library.ServiceScope + - '@microsoft/sp-core-library!default:class' +references: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index c444c9ed..d58bbb41 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -1,9 +1,9 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.ISPEventObserver + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' summary: >- - Used with the [SPEvent](xref:sp-core-library.SPEvent) system, this interface is implemented by components that can - subscribe to events. + Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by + components that can subscribe to events. remarks: >- ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it @@ -15,12 +15,14 @@ items: - typeScript type: interface extends: - - sp-core-library.IDisposable - package: sp-core-library + - '@microsoft/sp-core-library!IDisposable:interface' + inheritance: + - type: '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-core-library!' children: - - sp-core-library.ISPEventObserver.componentId - - sp-core-library.ISPEventObserver.instanceId - - uid: sp-core-library.ISPEventObserver.componentId + - '@microsoft/sp-core-library!ISPEventObserver#componentId:member' + - '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' + - uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' name: componentId @@ -33,7 +35,7 @@ items: return: type: - string - - uid: sp-core-library.ISPEventObserver.instanceId + - uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' name: instanceId @@ -46,3 +48,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index a78899ac..6cf5fea3 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -1,22 +1,24 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.ITimeProvider - summary: 'This is a [ServiceScope](xref:sp-core-library.ServiceScope) contract for reading the system clock.' + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + summary: >- + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system + clock. remarks: >- This interface abstracts the functionality of the system time APIs for usage with a - [ServiceScope](xref:sp-core-library.ServiceScope). For example, a unit test might replace the default - [TimeProvider](xref:sp-core-library.TimeProvider) service with a mock implementation that follows a manually - incremented timeline, in order to ensure that test failures are always repeatable. + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace + the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation + that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. name: ITimeProvider fullName: ITimeProvider langs: - typeScript type: interface - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.ITimeProvider.getDate - - sp-core-library.ITimeProvider.getTimestamp - - uid: sp-core-library.ITimeProvider.getDate + - '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' + - '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' + - uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' summary: 'Returns the current date/time, similar to the Date class constructor.' name: getDate() fullName: getDate() @@ -27,9 +29,9 @@ items: content: 'getDate(): Date;' return: type: - - Date + - '!Date:interface' description: '' - - uid: sp-core-library.ITimeProvider.getTimestamp + - uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' name: getTimestamp() fullName: getTimestamp() @@ -42,3 +44,6 @@ items: type: - number description: '' +references: + - uid: '!Date:interface' + name: Date diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index e8955584..e3816859 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Log + - uid: '@microsoft/sp-core-library!Log:class' summary: A basic redirectable logging system. remarks: >- The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and @@ -12,13 +12,13 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Log.error - - sp-core-library.Log.info - - sp-core-library.Log.verbose - - sp-core-library.Log.warn - - uid: sp-core-library.Log.error + - '@microsoft/sp-core-library!Log.error:member(1)' + - '@microsoft/sp-core-library!Log.info:member(1)' + - '@microsoft/sp-core-library!Log.verbose:member(1)' + - '@microsoft/sp-core-library!Log.warn:member(1)' + - uid: '@microsoft/sp-core-library!Log.error:member(1)' summary: Logs an error. name: 'error(source, error, scope)' fullName: 'error(source, error, scope)' @@ -41,14 +41,14 @@ items: - id: error description: the error to be logged type: - - Error + - '!Error:interface' - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error. type: - - sp-core-library.ServiceScope - - uid: sp-core-library.Log.info + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Log.info:member(1)' summary: Logs a general informational message. name: 'info(source, message, scope)' fullName: 'info(source, message, scope)' @@ -77,8 +77,8 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. type: - - sp-core-library.ServiceScope - - uid: sp-core-library.Log.verbose + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Log.verbose:member(1)' summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. name: 'verbose(source, message, scope)' fullName: 'verbose(source, message, scope)' @@ -107,8 +107,8 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. type: - - sp-core-library.ServiceScope - - uid: sp-core-library.Log.warn + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Log.warn:member(1)' summary: Logs a warning. name: 'warn(source, message, scope)' fullName: 'warn(source, message, scope)' @@ -137,4 +137,9 @@ items: the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. type: - - sp-core-library.ServiceScope + - '@microsoft/sp-core-library!default:class' +references: + - uid: '!Error:interface' + name: Error + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 4eab7f6b..cd590253 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -1,22 +1,23 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.RandomNumberGenerator + - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' summary: >- - This is the default implementation of [IRandomNumberGenerator](xref:sp-core-library.IRandomNumberGenerator) that - simply calls Math.random(). + This is the default implementation of + [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls + Math.random(). name: RandomNumberGenerator fullName: RandomNumberGenerator langs: - typeScript type: class implements: - - sp-core-library.IRandomNumberGenerator - package: sp-core-library + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + package: '@microsoft/sp-core-library!' children: - - sp-core-library.RandomNumberGenerator.(constructor) - - sp-core-library.RandomNumberGenerator.generate - - sp-core-library.RandomNumberGenerator.serviceKey - - uid: sp-core-library.RandomNumberGenerator.(constructor) + - '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' + - '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' + - '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' + - uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' summary: Constructs a new instance of the `RandomNumberGenerator` class name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) @@ -29,8 +30,8 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-core-library.RandomNumberGenerator.generate + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' name: generate() fullName: generate() @@ -43,7 +44,7 @@ items: type: - number description: '' - - uid: sp-core-library.RandomNumberGenerator.serviceKey + - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' summary: The service key for IRandomNumberGenerator. name: serviceKey fullName: serviceKey @@ -54,4 +55,23 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + fullName: IRandomNumberGenerator + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 3a1490c5..b8c91791 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -1,9 +1,9 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.ServiceKey + - uid: '@microsoft/sp-core-library!ServiceKey:class' summary: >- The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume()](xref:sp-core-library.ServiceScope.consume) to fetch a dependency. + [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope#consume:member(1)) to fetch a dependency. remarks: >- Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies @@ -14,20 +14,20 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.ServiceKey.create - - sp-core-library.ServiceKey.createCustom - - sp-core-library.ServiceKey.defaultCreator - - sp-core-library.ServiceKey.id - - sp-core-library.ServiceKey.name - - uid: sp-core-library.ServiceKey.create + - '@microsoft/sp-core-library!ServiceKey.create:member(1)' + - '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' + - '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' + - '@microsoft/sp-core-library!ServiceKey#id:member' + - '@microsoft/sp-core-library!ServiceKey#name:member' + - uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' summary: >- Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter. remarks: >- If you want to specify custom constructor parameters, use - [ServiceKey.createCustom()](xref:sp-core-library.ServiceKey.createCustom) instead. + [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. name: 'create(name, serviceClass)' fullName: 'create(name, serviceClass)' langs: @@ -40,7 +40,7 @@ items: }): ServiceKey; return: type: - - ServiceKey + - '@microsoft/sp-core-library!ServiceKey.create~0:complex' description: the newly created ServiceKey parameters: - id: name @@ -50,11 +50,10 @@ items: - id: serviceClass description: the TypeScript class that implements the service. type: - - |- - { - new (serviceScope: ServiceScope): TKey; - } - - uid: sp-core-library.ServiceKey.createCustom + - '@microsoft/sp-core-library!ServiceKey.create~1:complex' + typeParameters: + - id: TKey + - uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. name: 'createCustom(name, defaultCreator)' fullName: 'createCustom(name, defaultCreator)' @@ -65,7 +64,7 @@ items: content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-core-library!ServiceKey.createCustom~0:complex' description: the newly created service key parameters: - id: name @@ -75,8 +74,10 @@ items: - id: defaultCreator description: a callback that returns an object that implements the T interface type: - - ServiceCreator - - uid: sp-core-library.ServiceKey.defaultCreator + - '@microsoft/sp-core-library!ServiceKey.createCustom~1:complex' + typeParameters: + - id: TKey + - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' summary: A callback function that constructs the default instance of this service. name: defaultCreator fullName: defaultCreator @@ -87,8 +88,8 @@ items: content: 'readonly defaultCreator: ServiceCreator;' return: type: - - ServiceCreator - - uid: sp-core-library.ServiceKey.id + - '@microsoft/sp-core-library!ServiceKey#defaultCreator~0:complex' + - uid: '@microsoft/sp-core-library!ServiceKey#id:member' summary: A unique identifier for this service key. remarks: >- This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers @@ -111,7 +112,7 @@ items: return: type: - string - - uid: sp-core-library.ServiceKey.name + - uid: '@microsoft/sp-core-library!ServiceKey#name:member' summary: The name of the service. remarks: >- This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the @@ -119,7 +120,7 @@ items: The system does not assume that this string is unique. Instead, the - [ServiceKey.id](xref:sp-core-library.ServiceKey.id) is used wherever a lookup key is needed. + [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey#id:member) is used wherever a lookup key is needed. name: name fullName: name langs: @@ -130,3 +131,65 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-core-library!ServiceKey.create~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceKey.create~1:complex' + name: |- + { + new (serviceScope: ServiceScope): TKey; + } + fullName: |- + { + new (serviceScope: default): TKey; + } + spec.typeScript: + - name: |- + { + new (serviceScope: + fullName: |- + { + new (serviceScope: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: |- + ): TKey; + } + fullName: |- + ): TKey; + } + - uid: '@microsoft/sp-core-library!ServiceKey.createCustom~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceKey.createCustom~1:complex' + name: ServiceCreator + fullName: ServiceCreator + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + name: ServiceCreator + fullName: ServiceCreator + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator~0:complex' + name: ServiceCreator + fullName: ServiceCreator + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + name: ServiceCreator + fullName: ServiceCreator + - name: + fullName: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index ba575ed1..8f2d67b5 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.ServiceScope + - uid: '@microsoft/sp-core-library!ServiceScope:class' summary: The service locator pattern used by the SharePoint Framework. remarks: >- ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to @@ -49,19 +49,19 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.ServiceScope.(constructor) - - sp-core-library.ServiceScope.consume - - sp-core-library.ServiceScope.createAndProvide - - sp-core-library.ServiceScope.createDefaultAndProvide - - sp-core-library.ServiceScope.finish - - sp-core-library.ServiceScope.getParent - - sp-core-library.ServiceScope.provide - - sp-core-library.ServiceScope.startNewChild - - sp-core-library.ServiceScope.startNewRoot - - sp-core-library.ServiceScope.whenFinished - - uid: sp-core-library.ServiceScope.(constructor) + - '@microsoft/sp-core-library!ServiceScope:constructor(1)' + - '@microsoft/sp-core-library!ServiceScope#consume:member(1)' + - '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' + - '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' + - '@microsoft/sp-core-library!ServiceScope#finish:member(1)' + - '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' + - '@microsoft/sp-core-library!ServiceScope#provide:member(1)' + - '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' + - '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' + - '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' + - uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' summary: Constructs a new instance of the `ServiceScope` class name: (constructor)(parent) fullName: (constructor)(parent) @@ -74,8 +74,8 @@ items: - id: parent description: '' type: - - ServiceScope | undefined - - uid: sp-core-library.ServiceScope.consume + - '@microsoft/sp-core-library!ServiceScope~0:complex' + - uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' summary: Consumes a service from the service scope. remarks: >- Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the @@ -96,8 +96,10 @@ items: - id: serviceKey description: the key that was used when provide() was called to register the service type: - - ServiceKey - - uid: sp-core-library.ServiceScope.createAndProvide + - '@microsoft/sp-core-library!ServiceScope#consume~0:complex' + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' summary: >- This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). @@ -119,15 +121,14 @@ items: - id: serviceKey description: the key that can be used later to consume the service type: - - ServiceKey + - '@microsoft/sp-core-library!ServiceScope#createAndProvide~0:complex' - id: simpleServiceClass description: the TypeScript class to be constructed type: - - |- - { - new (serviceScope: ServiceScope): T; - } - - uid: sp-core-library.ServiceScope.createDefaultAndProvide + - '@microsoft/sp-core-library!ServiceScope#createAndProvide~1:complex' + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' summary: >- This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). @@ -146,8 +147,10 @@ items: - id: serviceKey description: the key that can be used later to consume the service type: - - ServiceKey - - uid: sp-core-library.ServiceScope.finish + - '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide~0:complex' + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' summary: Completes the initialization sequence for a service scope. remarks: >- When a ServiceScope is first started, it is in an "unfinished" state where provide() is allowed but consume() is @@ -170,7 +173,7 @@ items: type: - void description: '' - - uid: sp-core-library.ServiceScope.getParent + - uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' name: getParent() fullName: getParent() @@ -181,9 +184,9 @@ items: content: 'getParent(): ServiceScope | undefined;' return: type: - - ServiceScope | undefined + - '@microsoft/sp-core-library!ServiceScope#getParent~0:complex' description: the parent service scope - - uid: sp-core-library.ServiceScope.provide + - uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' summary: Add a new service to a service scope. remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may @@ -203,12 +206,14 @@ items: - id: serviceKey description: the key that will later be used to consume the service type: - - ServiceKey + - '@microsoft/sp-core-library!ServiceScope#provide~0:complex' - id: service description: the service instance that is being registered type: - T - - uid: sp-core-library.ServiceScope.startNewChild + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' summary: Constructs a new ServiceScope that is a child of the current scope. remarks: >- The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly @@ -222,9 +227,9 @@ items: content: 'startNewChild(): ServiceScope;' return: type: - - sp-core-library.ServiceScope + - '@microsoft/sp-core-library!default:class' description: the newly created root ServiceScope - - uid: sp-core-library.ServiceScope.startNewRoot + - uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' summary: >- Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. @@ -237,10 +242,12 @@ items: content: 'static startNewRoot(): ServiceScope;' return: type: - - sp-core-library.ServiceScope + - '@microsoft/sp-core-library!default:class' description: the newly created root ServiceScope - - uid: sp-core-library.ServiceScope.whenFinished - summary: 'Defer an operation until after [ServiceScope.finish()](xref:sp-core-library.ServiceScope.finish) has completed.' + - uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' + summary: >- + Defer an operation until after + [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope#finish:member(1)) has completed. remarks: >- It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error is to perform the consume() calls inside a whenFinished() callback. If the @@ -267,3 +274,85 @@ items: description: A block of code that needs to call ServiceScope.consume() type: - () => void +references: + - uid: '@microsoft/sp-core-library!ServiceScope~0:complex' + name: ServiceScope | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!ServiceScope#consume~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide~1:complex' + name: |- + { + new (serviceScope: ServiceScope): T; + } + fullName: |- + { + new (serviceScope: default): T; + } + spec.typeScript: + - name: |- + { + new (serviceScope: + fullName: |- + { + new (serviceScope: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: |- + ): T; + } + fullName: |- + ): T; + } + - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceScope#getParent~0:complex' + name: ServiceScope | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!ServiceScope#provide~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index ab37add5..831dae4e 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Session + - uid: '@microsoft/sp-core-library!Session:class' summary: Provides access to the application's browser session and active page. name: Session fullName: Session langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Session.applicationId - - sp-core-library.Session.pageId - - uid: sp-core-library.Session.applicationId + - '@microsoft/sp-core-library!Session.applicationId:member' + - '@microsoft/sp-core-library!Session.pageId:member' + - uid: '@microsoft/sp-core-library!Session.applicationId:member' summary: A unique identifier for the current instance of the client-side application. remarks: >- A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the @@ -28,13 +28,13 @@ items: content: 'static readonly applicationId: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-core-library.Session.pageId + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Session.pageId:member' summary: A unique identifier for the current page within the client-side application. remarks: >- A unique identifier used to correlate logging and other diagnostic information. Whereas the - [Session.applicationId](xref:sp-core-library.Session.applicationId) tracks the entire lifetime of the client-side - application instance, the pageId tracks an individual "page" that is rendered. + [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) tracks the entire lifetime + of the client-side application instance, the pageId tracks an individual "page" that is rendered. For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the @@ -54,4 +54,7 @@ items: content: 'static readonly pageId: Guid;' return: type: - - sp-core-library.Guid + - '@microsoft/sp-core-library!default:class' +references: + - uid: '@microsoft/sp-core-library!default:class' + name: Guid diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index f5709b4f..411c0155 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.SPEvent + - uid: '@microsoft/sp-core-library!SPEvent:class' summary: Represents a framework event that components can subscribe to. remarks: >- Examples of events in a web application might include: the user clicking a button, the system navigating to @@ -27,11 +27,11 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.SPEvent.add - - sp-core-library.SPEvent.remove - - uid: sp-core-library.SPEvent.add + - '@microsoft/sp-core-library!SPEvent#add:member(1)' + - '@microsoft/sp-core-library!SPEvent#remove:member(1)' + - uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' summary: Registers a callback that will be invoked whenever the event occurs. remarks: >- The same object can add multiple event handlers to the same event. Since BaseComponent implements the @@ -55,12 +55,12 @@ items: be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception. type: - - sp-core-library.ISPEventObserver + - '@microsoft/sp-core-library!ISPEventObserver:interface' - id: eventHandler description: A callback function that will be invoked whenever the event occurs type: - '(eventArgs: TEventArgs) => void' - - uid: sp-core-library.SPEvent.remove + - uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' name: 'remove(observer, eventHandler)' @@ -78,8 +78,11 @@ items: - id: observer description: This must be the same observer that was passed to the add() function. type: - - sp-core-library.ISPEventObserver + - '@microsoft/sp-core-library!ISPEventObserver:interface' - id: eventHandler description: The event handler to remove; this must be the same object instance that was passed to the add() function. type: - '(eventArgs: TEventArgs) => void' +references: + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + name: ISPEventObserver diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 5c877c68..94aa1dd5 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -1,11 +1,11 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.SPEventArgs - summary: 'The base class for event arguments used with the [SPEvent](xref:sp-core-library.SPEvent) class.' + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' name: SPEventArgs fullName: SPEventArgs langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index 877e10cf..41a3a1a6 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Text + - uid: '@microsoft/sp-core-library!Text:class' summary: Operations for working with strings that contain text. remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' name: Text @@ -8,11 +8,11 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Text.format - - sp-core-library.Text.replaceAll - - uid: sp-core-library.Text.format + - '@microsoft/sp-core-library!Text.format:member(1)' + - '@microsoft/sp-core-library!Text.replaceAll:member(1)' + - uid: '@microsoft/sp-core-library!Text.format:member(1)' summary: Format a string by substituting parameters. remarks: >- This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the @@ -44,7 +44,7 @@ items: description: '' type: - 'any[]' - - uid: sp-core-library.Text.replaceAll + - uid: '@microsoft/sp-core-library!Text.replaceAll:member(1)' summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' name: 'replaceAll(input, searchValue, replaceValue)' diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 7829b695..43cb0472 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -1,23 +1,23 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.TimeProvider + - uid: '@microsoft/sp-core-library!TimeProvider:class' summary: >- - This is the default implementation of [ITimeProvider](xref:sp-core-library.ITimeProvider) that simply calls the - real browser APIs. + This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) + that simply calls the real browser APIs. name: TimeProvider fullName: TimeProvider langs: - typeScript type: class implements: - - sp-core-library.ITimeProvider - package: sp-core-library + - '@microsoft/sp-core-library!ITimeProvider:interface' + package: '@microsoft/sp-core-library!' children: - - sp-core-library.TimeProvider.(constructor) - - sp-core-library.TimeProvider.getDate - - sp-core-library.TimeProvider.getTimestamp - - sp-core-library.TimeProvider.serviceKey - - uid: sp-core-library.TimeProvider.(constructor) + - '@microsoft/sp-core-library!TimeProvider:constructor(1)' + - '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' + - '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' + - '@microsoft/sp-core-library!TimeProvider.serviceKey:member' + - uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' summary: Constructs a new instance of the `TimeProvider` class name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) @@ -30,8 +30,8 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-core-library.TimeProvider.getDate + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' summary: 'Returns the current date/time, similar to the Date class constructor.' name: getDate() fullName: getDate() @@ -42,9 +42,9 @@ items: content: 'getDate(): Date;' return: type: - - Date + - '!Date:interface' description: '' - - uid: sp-core-library.TimeProvider.getTimestamp + - uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' name: getTimestamp() fullName: getTimestamp() @@ -57,7 +57,7 @@ items: type: - number description: '' - - uid: sp-core-library.TimeProvider.serviceKey + - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' summary: The service key for ITimeProvider. name: serviceKey fullName: serviceKey @@ -68,4 +68,25 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-core-library!TimeProvider.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + name: ITimeProvider + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + - uid: '!Date:interface' + name: Date + - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + name: ITimeProvider + fullName: ITimeProvider + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index efd7ce25..24d7dae5 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.UrlQueryParameterCollection + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' summary: Provides features for storing and retrieving URL query parameters. remarks: >- The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with @@ -21,12 +21,12 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.UrlQueryParameterCollection.(constructor) - - sp-core-library.UrlQueryParameterCollection.getValue - - sp-core-library.UrlQueryParameterCollection.getValues - - uid: sp-core-library.UrlQueryParameterCollection.(constructor) + - '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' + - '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' + - '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' summary: Constructs a new instance of the `UrlQueryParameterCollection` class name: (constructor)(url) fullName: (constructor)(url) @@ -40,7 +40,7 @@ items: description: '' type: - string - - uid: sp-core-library.UrlQueryParameterCollection.getValue + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. remarks: |- Examples: @@ -71,7 +71,7 @@ items: description: the case insensitive key for the desired query parameter value. type: - string - - uid: sp-core-library.UrlQueryParameterCollection.getValues + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. remarks: |- Examples: diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 940cca1b..90eba21a 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Validate + - uid: '@microsoft/sp-core-library!Validate:class' summary: Performs common validation tests for properties and function parameters. remarks: >- This class implements provides a standard way to validate properties and function parameters. Unlike debug @@ -11,13 +11,13 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Validate.isNonemptyString - - sp-core-library.Validate.isNotDisposed - - sp-core-library.Validate.isNotNullOrUndefined - - sp-core-library.Validate.isTrue - - uid: sp-core-library.Validate.isNonemptyString + - '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' + - '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' + - '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' + - '@microsoft/sp-core-library!Validate.isTrue:member(1)' + - uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' name: 'isNonemptyString(value, variableName)' fullName: 'isNonemptyString(value, variableName)' @@ -39,7 +39,7 @@ items: description: 'the program variable name, which will be mentioned in the error message' type: - string - - uid: sp-core-library.Validate.isNotDisposed + - uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' summary: Throws an exception if the specified object has been disposed. name: 'isNotDisposed(value, className)' fullName: 'isNotDisposed(value, className)' @@ -56,12 +56,12 @@ items: - id: value description: the value to check type: - - sp-core-library.IDisposable + - '@microsoft/sp-core-library!IDisposable:interface' - id: className description: 'the class name, which will be mentioned in the error message' type: - string - - uid: sp-core-library.Validate.isNotNullOrUndefined + - uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' summary: Throws an exception if the specified value is null or undefined. name: 'isNotNullOrUndefined(value, variableName)' fullName: 'isNotNullOrUndefined(value, variableName)' @@ -83,7 +83,7 @@ items: description: 'the program variable name, which will be mentioned in the error message' type: - string - - uid: sp-core-library.Validate.isTrue + - uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' summary: Throws an exception if the specified value is not true. name: 'isTrue(value, variableName)' fullName: 'isTrue(value, variableName)' @@ -105,3 +105,6 @@ items: description: 'the program variable name, which will be mentioned in the error message' type: - string +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 6e6ca0ab..8c1926ba 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Version + - uid: '@microsoft/sp-core-library!Version:class' summary: 'Represents a version number with two, three, or four parts.' remarks: >- This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, @@ -14,22 +14,22 @@ items: langs: - typeScript type: class - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Version.compare - - sp-core-library.Version.equals - - sp-core-library.Version.greaterThan - - sp-core-library.Version.isValid - - sp-core-library.Version.lessThan - - sp-core-library.Version.major - - sp-core-library.Version.minor - - sp-core-library.Version.parse - - sp-core-library.Version.patch - - sp-core-library.Version.revision - - sp-core-library.Version.satisfies - - sp-core-library.Version.toString - - sp-core-library.Version.tryParse - - uid: sp-core-library.Version.compare + - '@microsoft/sp-core-library!Version.compare:member(1)' + - '@microsoft/sp-core-library!Version#equals:member(1)' + - '@microsoft/sp-core-library!Version#greaterThan:member(1)' + - '@microsoft/sp-core-library!Version.isValid:member(1)' + - '@microsoft/sp-core-library!Version#lessThan:member(1)' + - '@microsoft/sp-core-library!Version#major:member' + - '@microsoft/sp-core-library!Version#minor:member' + - '@microsoft/sp-core-library!Version.parse:member(1)' + - '@microsoft/sp-core-library!Version#patch:member' + - '@microsoft/sp-core-library!Version#revision:member' + - '@microsoft/sp-core-library!Version#satisfies:member(1)' + - '@microsoft/sp-core-library!Version#toString:member(1)' + - '@microsoft/sp-core-library!Version.tryParse:member(1)' + - uid: '@microsoft/sp-core-library!Version.compare:member(1)' summary: Compares two Version objects to determine which version is newer. name: 'compare(v1, v2)' fullName: 'compare(v1, v2)' @@ -48,12 +48,12 @@ items: - id: v1 description: The first version class for comparison type: - - sp-core-library.Version + - '@microsoft/sp-core-library!default:class' - id: v2 description: The second version class for comparison type: - - sp-core-library.Version - - uid: sp-core-library.Version.equals + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Version#equals:member(1)' summary: Tests whether this version is equal to the input parameter. remarks: |- Examples: @@ -80,8 +80,8 @@ items: - id: compareWith description: The version to compare with type: - - sp-core-library.Version - - uid: sp-core-library.Version.greaterThan + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' summary: Tests whether this version is greater than (i.e. newer than) the input parameter. remarks: |- Examples: @@ -107,8 +107,8 @@ items: - id: compareWith description: The version to compare with type: - - sp-core-library.Version - - uid: sp-core-library.Version.isValid + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Version.isValid:member(1)' summary: Test whether a string is a valid version specifier. name: isValid(versionString) fullName: isValid(versionString) @@ -126,7 +126,7 @@ items: description: The version string type: - string | undefined | null - - uid: sp-core-library.Version.lessThan + - uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' summary: Tests whether this version is less than (i.e. older than) the input parameter. remarks: |- Examples: @@ -153,8 +153,8 @@ items: - id: compareWith description: The version to compare with type: - - sp-core-library.Version - - uid: sp-core-library.Version.major + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Version#major:member' summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. name: major @@ -167,7 +167,7 @@ items: return: type: - number - - uid: sp-core-library.Version.minor + - uid: '@microsoft/sp-core-library!Version#minor:member' summary: Returns the second component of the version string. remarks: >- Typically a change in the minor version number indicates that new features were added, while remaining backwards @@ -182,7 +182,7 @@ items: return: type: - number - - uid: sp-core-library.Version.parse + - uid: '@microsoft/sp-core-library!Version.parse:member(1)' summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. name: parse(versionString) fullName: parse(versionString) @@ -193,14 +193,14 @@ items: content: 'static parse(versionString: string | undefined | null): Version;' return: type: - - sp-core-library.Version + - '@microsoft/sp-core-library!default:class' description: a new Version object parameters: - id: versionString description: A version string type: - string | undefined | null - - uid: sp-core-library.Version.patch + - uid: '@microsoft/sp-core-library!Version#patch:member' summary: 'The third number in the version string, or undefined if unspecified.' remarks: >- Typically a change in the patch version number indicates a small fix that does not affect the compatibility @@ -215,7 +215,7 @@ items: return: type: - number | undefined - - uid: sp-core-library.Version.revision + - uid: '@microsoft/sp-core-library!Version#revision:member' summary: 'The fourth number in the version string, or undefined if unspecified.' remarks: >- This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET @@ -230,7 +230,7 @@ items: return: type: - number | undefined - - uid: sp-core-library.Version.satisfies + - uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' summary: >- Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible. @@ -269,8 +269,8 @@ items: - id: compareWith description: The version to compare with type: - - sp-core-library.Version - - uid: sp-core-library.Version.toString + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Version#toString:member(1)' summary: Returns a string representation of the version. remarks: >- The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). @@ -286,7 +286,7 @@ items: type: - string description: '' - - uid: sp-core-library.Version.tryParse + - uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' summary: >- Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. @@ -299,10 +299,22 @@ items: content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' return: type: - - Version | undefined + - '@microsoft/sp-core-library!Version.tryParse~0:complex' description: 'The Version object, or undefined if the string could not be parsed.' parameters: - id: versionString description: A version string type: - string | undefined | null +references: + - uid: '@microsoft/sp-core-library!default:class' + name: Version + - uid: '@microsoft/sp-core-library!Version.tryParse~0:complex' + name: Version | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: Version + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index 524bdeb6..3609a3f4 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-diagnostics + - uid: '@microsoft/sp-diagnostics!' summary: >- This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user engagement and performance logging. @@ -9,3 +9,31 @@ items: langs: - typeScript type: package + children: + - '@microsoft/sp-diagnostics!_logSourceServiceKey:var' + - uid: '@microsoft/sp-diagnostics!_logSourceServiceKey:var' + name: _logSourceServiceKey + fullName: _logSourceServiceKey + langs: + - typeScript + type: variable + syntax: + content: 'logSourceServiceKey: ServiceKey' + return: + type: + - '@microsoft/sp-diagnostics!_logSourceServiceKey~0:complex' +references: + - uid: '@microsoft/sp-diagnostics!_logSourceServiceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-diagnostics!default:class' + name: LogSource + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index c07aa11f..5b84ac58 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -1,36 +1,38 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog + - uid: '@microsoft/sp-dialog!' summary: SharePoint Framework support for displaying pop-up dialog boxes. remarks: >- - This library provides simple stock dialogs such as [Dialog.alert()](xref:sp-dialog.Dialog.alert) and - [Dialog.prompt()](xref:sp-dialog.Dialog.prompt), along with a general framework for building custom dialog - boxes that participate in the focus management system for SharePoint Framework applications. + This library provides simple stock dialogs such as + [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)) and + [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)), along with a general framework for + building custom dialog boxes that participate in the focus management system for SharePoint Framework + applications. name: '@microsoft/sp-dialog' fullName: '@microsoft/sp-dialog' langs: - typeScript type: package children: - - sp-dialog.BaseDialog - - sp-dialog.Dialog - - sp-dialog.IAlertOptions - - sp-dialog.IDialogConfiguration - - sp-dialog.IDialogShowOptions - - sp-dialog.IPromptOptions - - sp-dialog.ISecondaryDialogProvider + - '@microsoft/sp-dialog!BaseDialog:class' + - '@microsoft/sp-dialog!Dialog:class' + - '@microsoft/sp-dialog!IAlertOptions:interface' + - '@microsoft/sp-dialog!IDialogConfiguration:interface' + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + - '@microsoft/sp-dialog!IPromptOptions:interface' + - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' references: - - uid: sp-dialog.BaseDialog + - uid: '@microsoft/sp-dialog!BaseDialog:class' name: BaseDialog - - uid: sp-dialog.Dialog + - uid: '@microsoft/sp-dialog!Dialog:class' name: Dialog - - uid: sp-dialog.IAlertOptions + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' name: IAlertOptions - - uid: sp-dialog.IDialogConfiguration + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' name: IDialogConfiguration - - uid: sp-dialog.IDialogShowOptions + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' name: IDialogShowOptions - - uid: sp-dialog.IPromptOptions + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' name: IPromptOptions - - uid: sp-dialog.ISecondaryDialogProvider + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' name: ISecondaryDialogProvider diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index d32107f8..589fb761 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.BaseDialog + - uid: '@microsoft/sp-dialog!BaseDialog:class' summary: >- The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to the user inside SharePoint Framework components. @@ -16,20 +16,20 @@ items: langs: - typeScript type: class - package: sp-dialog + package: '@microsoft/sp-dialog!' children: - - sp-dialog.BaseDialog.(constructor) - - sp-dialog.BaseDialog.close - - sp-dialog.BaseDialog.domElement - - sp-dialog.BaseDialog.isHidden - - sp-dialog.BaseDialog.isOpen - - sp-dialog.BaseDialog.isSecondary - - sp-dialog.BaseDialog.onAfterClose - - sp-dialog.BaseDialog.onBeforeOpen - - sp-dialog.BaseDialog.render - - sp-dialog.BaseDialog.secondaryDialogProvider - - sp-dialog.BaseDialog.show - - uid: sp-dialog.BaseDialog.(constructor) + - '@microsoft/sp-dialog!BaseDialog:constructor(1)' + - '@microsoft/sp-dialog!BaseDialog#close:member(1)' + - '@microsoft/sp-dialog!BaseDialog#domElement:member' + - '@microsoft/sp-dialog!BaseDialog#isHidden:member' + - '@microsoft/sp-dialog!BaseDialog#isOpen:member' + - '@microsoft/sp-dialog!BaseDialog#isSecondary:member' + - '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' + - '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' + - '@microsoft/sp-dialog!BaseDialog#render:member(1)' + - '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' + - '@microsoft/sp-dialog!BaseDialog#show:member(1)' + - uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' summary: Constructor for the `BaseDialog` class. remarks: >- It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization @@ -68,8 +68,8 @@ items: - id: config description: the dialog configuration that affects how the dialog is displayed \* type: - - sp-dialog.IDialogConfiguration - - uid: sp-dialog.BaseDialog.close + - '@microsoft/sp-dialog!IDialogConfiguration:interface' + - uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' summary: Close the dialog. remarks: >- This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to @@ -83,11 +83,13 @@ items: content: 'close(): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!BaseDialog#close~0:complex' description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - - uid: sp-dialog.BaseDialog.domElement + - uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' summary: Use this property to access the container element provided by the framework for rendering. - remarks: 'See [BaseDialog.render()](xref:sp-dialog.BaseDialog.render) for more information on rendering.' + remarks: >- + See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog#render:member(1)) for more information on + rendering. name: domElement fullName: domElement langs: @@ -97,8 +99,8 @@ items: content: 'protected readonly domElement: HTMLElement;' return: type: - - HTMLElement - - uid: sp-dialog.BaseDialog.isHidden + - '!HTMLElement:interface' + - uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' summary: If the dialog is visually hidden. remarks: >- This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the @@ -113,7 +115,7 @@ items: return: type: - boolean - - uid: sp-dialog.BaseDialog.isOpen + - uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' summary: >- If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. @@ -127,7 +129,7 @@ items: return: type: - boolean - - uid: sp-dialog.BaseDialog.isSecondary + - uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. name: isSecondary fullName: isSecondary @@ -139,7 +141,7 @@ items: return: type: - boolean - - uid: sp-dialog.BaseDialog.onAfterClose + - uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. remarks: >- The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though @@ -157,7 +159,7 @@ items: type: - void description: '' - - uid: sp-dialog.BaseDialog.onBeforeOpen + - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' summary: >- This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. @@ -171,11 +173,11 @@ items: content: 'protected onBeforeOpen(): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!BaseDialog#onBeforeOpen~0:complex' description: >- A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and `onAfterClose()` will not be called. - - uid: sp-dialog.BaseDialog.render + - uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' summary: Renders the contents of the dialog. remarks: >- The `render` method must be implemented to render the content of the dialog in the container element provided by @@ -200,7 +202,7 @@ items: type: - void description: '' - - uid: sp-dialog.BaseDialog.secondaryDialogProvider + - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' summary: >- An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs are permitted. @@ -217,8 +219,8 @@ items: content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' return: type: - - ISecondaryDialogProvider | undefined - - uid: sp-dialog.BaseDialog.show + - '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider~0:complex' + - uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' summary: Request the framework to show this dialog. name: show(options) fullName: show(options) @@ -229,12 +231,57 @@ items: content: 'show(options?: IDialogShowOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!BaseDialog#show~0:complex' description: >- A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or aborted. parameters: - id: options - description: 'Dialog showing options. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' + description: >- + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. type: - - sp-dialog.IDialogShowOptions + - '@microsoft/sp-dialog!IDialogShowOptions:interface' +references: + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' + name: IDialogConfiguration + - uid: '@microsoft/sp-dialog!BaseDialog#close~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider~0:complex' + name: ISecondaryDialogProvider | undefined + fullName: ISecondaryDialogProvider | undefined + spec.typeScript: + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' + name: ISecondaryDialogProvider + fullName: ISecondaryDialogProvider + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-dialog!BaseDialog#show~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index e352351d..6240d9b0 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.Dialog + - uid: '@microsoft/sp-dialog!Dialog:class' summary: A static class for showing stock dialogs such as an alert or prompt. name: Dialog fullName: Dialog langs: - typeScript type: class - package: sp-dialog + package: '@microsoft/sp-dialog!' children: - - sp-dialog.Dialog.alert - - sp-dialog.Dialog.prompt - - uid: sp-dialog.Dialog.alert + - '@microsoft/sp-dialog!Dialog.alert:member(1)' + - '@microsoft/sp-dialog!Dialog.prompt:member(1)' + - uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' summary: >- Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog. @@ -28,7 +28,7 @@ items: content: 'static alert(message: string, options?: IAlertOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!Dialog.alert~0:complex' description: '' parameters: - id: message @@ -38,8 +38,8 @@ items: - id: options description: '' type: - - sp-dialog.IAlertOptions - - uid: sp-dialog.Dialog.prompt + - '@microsoft/sp-dialog!IAlertOptions:interface' + - uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' summary: >- Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog. @@ -56,7 +56,7 @@ items: content: 'static prompt(message: string, options?: IPromptOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!Dialog.prompt~0:complex' description: The input string or undefined if the dialog was canceled parameters: - id: message @@ -66,4 +66,27 @@ items: - id: options description: '' type: - - sp-dialog.IPromptOptions + - '@microsoft/sp-dialog!IPromptOptions:interface' +references: + - uid: '@microsoft/sp-dialog!Dialog.alert~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' + name: IAlertOptions + - uid: '@microsoft/sp-dialog!Dialog.prompt~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' + name: IPromptOptions diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index e06e20cc..b1e708f8 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IAlertOptions + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' summary: Options for showing an alert dialog name: IAlertOptions fullName: IAlertOptions @@ -8,5 +8,10 @@ items: - typeScript type: interface extends: - - sp-dialog.IDialogShowOptions - package: sp-dialog + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + inheritance: + - type: '@microsoft/sp-dialog!IDialogShowOptions:interface' + package: '@microsoft/sp-dialog!' +references: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 06da012c..f5ad498b 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -1,16 +1,16 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IDialogConfiguration + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' summary: The interface for dialog configuration name: IDialogConfiguration fullName: IDialogConfiguration langs: - typeScript type: interface - package: sp-dialog + package: '@microsoft/sp-dialog!' children: - - sp-dialog.IDialogConfiguration.isBlocking - - uid: sp-dialog.IDialogConfiguration.isBlocking + - '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' + - uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). name: isBlocking fullName: isBlocking diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 9ace73be..9f9d920b 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -1,16 +1,16 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IDialogShowOptions + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' summary: Options for showing a dialog name: IDialogShowOptions fullName: IDialogShowOptions langs: - typeScript type: interface - package: sp-dialog + package: '@microsoft/sp-dialog!' children: - - sp-dialog.IDialogShowOptions.confirmOpen - - uid: sp-dialog.IDialogShowOptions.confirmOpen + - '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' + - uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' summary: A callback that is invoked immediately before the dialog receives focus. remarks: >- Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 9d4cc363..99101ec1 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IPromptOptions + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' summary: Options for showing a prompt dialog name: IPromptOptions fullName: IPromptOptions @@ -8,11 +8,13 @@ items: - typeScript type: interface extends: - - sp-dialog.IDialogShowOptions - package: sp-dialog + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + inheritance: + - type: '@microsoft/sp-dialog!IDialogShowOptions:interface' + package: '@microsoft/sp-dialog!' children: - - sp-dialog.IPromptOptions.defaultValue - - uid: sp-dialog.IPromptOptions.defaultValue + - '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' + - uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' summary: The default value for the input text field of prompt dialog name: defaultValue fullName: defaultValue @@ -24,3 +26,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 1f6239ee..c10c052d 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.ISecondaryDialogProvider + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' summary: >- This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider inside a dialog. @@ -11,21 +11,22 @@ items: show more secondary dialogs are rejected. - See [BaseDialog.secondaryDialogProvider](xref:sp-dialog.BaseDialog.secondaryDialogProvider) for how to use this. + See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member) for + how to use this. name: ISecondaryDialogProvider fullName: ISecondaryDialogProvider langs: - typeScript type: interface - package: sp-dialog + package: '@microsoft/sp-dialog!' children: - - sp-dialog.ISecondaryDialogProvider.alert - - sp-dialog.ISecondaryDialogProvider.prompt - - sp-dialog.ISecondaryDialogProvider.show - - uid: sp-dialog.ISecondaryDialogProvider.alert + - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' + - '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' + - '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' summary: >- - Similar to [Dialog.alert()](xref:sp-dialog.Dialog.alert). The only difference is that the dialog is - immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that + the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'alert(message, options)' fullName: 'alert(message, options)' langs: @@ -35,7 +36,7 @@ items: content: 'alert(message: string, options?: IAlertOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' description: '' parameters: - id: message @@ -43,13 +44,15 @@ items: type: - string - id: options - description: 'Dialog showing options. See [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information.' + description: >- + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. type: - - sp-dialog.IAlertOptions - - uid: sp-dialog.ISecondaryDialogProvider.prompt + - '@microsoft/sp-dialog!IAlertOptions:interface' + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' summary: >- - Similar to [Dialog.prompt()](xref:sp-dialog.Dialog.prompt). The only difference is that the dialog is - immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is + that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. name: 'prompt(message, options)' fullName: 'prompt(message, options)' langs: @@ -59,7 +62,7 @@ items: content: 'prompt(message: string, options?: IPromptOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt~0:complex' description: '' parameters: - id: message @@ -69,14 +72,14 @@ items: - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. type: - - sp-dialog.IPromptOptions - - uid: sp-dialog.ISecondaryDialogProvider.show + - '@microsoft/sp-dialog!IPromptOptions:interface' + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' summary: >- - Similar to [BaseDialog.show()](xref:sp-dialog.BaseDialog.show). The dialog to show is passed in as - parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise - rejects. + Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog#show:member(1)). The dialog to show is + passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the + promise rejects. name: 'show(dialog, options)' fullName: 'show(dialog, options)' langs: @@ -86,16 +89,52 @@ items: content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!ISecondaryDialogProvider#show~0:complex' description: '' parameters: - id: dialog description: '' type: - - sp-dialog.BaseDialog + - '@microsoft/sp-dialog!default:class' - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:sp-dialog.IDialogShowOptions) for more information. + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. type: - - sp-dialog.IDialogShowOptions + - '@microsoft/sp-dialog!IDialogShowOptions:interface' +references: + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' + name: IAlertOptions + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' + name: IPromptOptions + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!default:class' + name: BaseDialog + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index db6c2d21..fe2ef7e8 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data + - uid: '@microsoft/sp-dynamic-data!' summary: SharePoint Framework support for dynamic data bindings. remarks: >- This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and @@ -11,34 +11,34 @@ items: - typeScript type: package children: - - sp-dynamic-data.DynamicDataReference - - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue - - sp-dynamic-data.IDynamicDataCallables - - sp-dynamic-data.IDynamicDataEventDefinition - - sp-dynamic-data.IDynamicDataPropertyDefinition - - sp-dynamic-data.IDynamicDataPropertyMetadata - - sp-dynamic-data.IDynamicDataPropertyValueMetadata - - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection - - sp-dynamic-data.IDynamicDataSource - - sp-dynamic-data.IDynamicDataSourceMetadata + - '@microsoft/sp-dynamic-data!DynamicDataReference:class' + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' references: - - uid: sp-dynamic-data.DynamicDataReference + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' name: DynamicDataReference - - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' name: IDynamicDataAnnotatedPropertyValue - - uid: sp-dynamic-data.IDynamicDataCallables + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' name: IDynamicDataCallables - - uid: sp-dynamic-data.IDynamicDataEventDefinition + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' name: IDynamicDataEventDefinition - - uid: sp-dynamic-data.IDynamicDataPropertyDefinition + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' name: IDynamicDataPropertyDefinition - - uid: sp-dynamic-data.IDynamicDataPropertyMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' name: IDynamicDataPropertyMetadata - - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' name: IDynamicDataPropertyValueMetadata - - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' name: IDynamicDataPropertyValueMetadataCollection - - uid: sp-dynamic-data.IDynamicDataSource + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' name: IDynamicDataSource - - uid: sp-dynamic-data.IDynamicDataSourceMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' name: IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index fd893d62..250dc6e4 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.DynamicDataReference + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' summary: >- Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data @@ -13,14 +13,14 @@ items: langs: - typeScript type: class - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.DynamicDataReference.(constructor) - - sp-dynamic-data.DynamicDataReference.property - - sp-dynamic-data.DynamicDataReference.propertyPath - - sp-dynamic-data.DynamicDataReference.reference - - sp-dynamic-data.DynamicDataReference.sourceId - - uid: sp-dynamic-data.DynamicDataReference.(constructor) + - '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' + - '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' + - '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' + - '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' + - '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' summary: Constructs a new instance of the `DynamicDataReference` class name: (constructor)(reference) fullName: (constructor)(reference) @@ -34,7 +34,7 @@ items: description: '' type: - string - - uid: sp-dynamic-data.DynamicDataReference.property + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' summary: Returns the referred property of the Dynamic Data. name: property fullName: property @@ -46,7 +46,7 @@ items: return: type: - string - - uid: sp-dynamic-data.DynamicDataReference.propertyPath + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. name: propertyPath fullName: propertyPath @@ -58,7 +58,7 @@ items: return: type: - string | undefined - - uid: sp-dynamic-data.DynamicDataReference.reference + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' summary: Returns the full reference of the Dynamic Data object as a string. name: reference fullName: reference @@ -70,7 +70,7 @@ items: return: type: - string - - uid: sp-dynamic-data.DynamicDataReference.sourceId + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' summary: Returns the referred id of the Dynamic Data Source. name: sourceId fullName: sourceId diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index 5d0f7191..08a015b4 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' summary: >- Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value. @@ -9,11 +9,11 @@ items: langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata - - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue - - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.metadata + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' summary: Metadata describing the sample value of the property. name: metadata fullName: metadata @@ -24,8 +24,8 @@ items: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: type: - - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection - - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue.sampleValue + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' summary: Sample value of a property name: sampleValue fullName: sampleValue @@ -37,3 +37,6 @@ items: return: type: - any +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + name: IDynamicDataPropertyValueMetadataCollection diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 238d16e0..d90f3659 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataCallables + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. @@ -9,14 +9,14 @@ items: langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataCallables.allowedEvents - - sp-dynamic-data.IDynamicDataCallables.getAnnotatedPropertyValue - - sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions - - sp-dynamic-data.IDynamicDataCallables.getPropertyValue - - sp-dynamic-data.IDynamicDataCallables.sendEvent - - uid: sp-dynamic-data.IDynamicDataCallables.allowedEvents + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' summary: |- Returns list of allowed events on the dynamic data source. @@ -33,9 +33,9 @@ items: content: 'allowedEvents?(): ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' description: '' - - uid: sp-dynamic-data.IDynamicDataCallables.getAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' summary: >- Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. @@ -48,14 +48,14 @@ items: content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' return: type: - - IDynamicDataAnnotatedPropertyValue | undefined + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue~0:complex' description: '' parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. type: - string - - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyDefinitions + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' summary: Returns all the property definitions that the DataSource will provide. name: getPropertyDefinitions() fullName: getPropertyDefinitions() @@ -66,9 +66,9 @@ items: content: 'getPropertyDefinitions(): ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' description: '' - - uid: sp-dynamic-data.IDynamicDataCallables.getPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' name: getPropertyValue(propertyId) @@ -87,7 +87,7 @@ items: description: '' type: - string - - uid: sp-dynamic-data.IDynamicDataCallables.sendEvent + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' summary: >- If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly. @@ -115,3 +115,41 @@ items: description: Data to be sent to the dynamic data source. type: - any +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + name: IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue~0:complex' + name: IDynamicDataAnnotatedPropertyValue | undefined + fullName: IDynamicDataAnnotatedPropertyValue | undefined + spec.typeScript: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + fullName: IDynamicDataAnnotatedPropertyValue + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 6cdfebca..00d4b3b1 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataEventDefinition + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' summary: |- Definition of an event which a dynamic data source accepts. @@ -11,11 +11,11 @@ items: langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataEventDefinition.description - - sp-dynamic-data.IDynamicDataEventDefinition.name - - uid: sp-dynamic-data.IDynamicDataEventDefinition.description + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' summary: 'User-friendly, localized description of the event.' isPreview: true name: description @@ -28,7 +28,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataEventDefinition.name + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' summary: Event name isPreview: true name: name diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index b39f1ad7..110eb3db 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataPropertyDefinition + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' summary: >- Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. @@ -10,11 +10,13 @@ items: - typeScript type: interface extends: - - sp-dynamic-data.IDynamicDataPropertyMetadata - package: sp-dynamic-data + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + inheritance: + - type: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataPropertyDefinition.id - - uid: sp-dynamic-data.IDynamicDataPropertyDefinition.id + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' summary: >- Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" @@ -28,3 +30,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + name: IDynamicDataPropertyMetadata diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index 88b84573..64e505df 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataPropertyMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' summary: Metadata of a property name: IDynamicDataPropertyMetadata fullName: IDynamicDataPropertyMetadata langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataPropertyMetadata.description - - sp-dynamic-data.IDynamicDataPropertyMetadata.title - - uid: sp-dynamic-data.IDynamicDataPropertyMetadata.description + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' summary: >- User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" @@ -25,7 +25,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataPropertyMetadata.title + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' summary: >- User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 05a2f8e3..a9bf1cc3 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' summary: Metadata describing the sample value of the property. name: IDynamicDataPropertyValueMetadata fullName: IDynamicDataPropertyValueMetadata @@ -8,11 +8,13 @@ items: - typeScript type: interface extends: - - sp-dynamic-data.IDynamicDataPropertyMetadata - package: sp-dynamic-data + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + inheritance: + - type: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata - - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata.metadata + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' summary: Metadata describing the sample value of the property. name: metadata fullName: metadata @@ -23,4 +25,9 @@ items: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: type: - - sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + name: IDynamicDataPropertyMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + name: IDynamicDataPropertyValueMetadataCollection diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index b0d80744..c35b62ba 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' summary: >- A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value. @@ -78,4 +78,4 @@ items: langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 922f0d15..ead6663c 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataSource + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' summary: >- Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. @@ -9,16 +9,19 @@ items: langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataSource.allowedEvents - - sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue - - sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions - - sp-dynamic-data.IDynamicDataSource.getPropertyValue - - sp-dynamic-data.IDynamicDataSource.sendEvent - - sp-dynamic-data.IDynamicDataSource.id - - sp-dynamic-data.IDynamicDataSource.metadata - - uid: sp-dynamic-data.IDynamicDataSource.allowedEvents + - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' summary: >- Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source must define 'sendData' api. @@ -26,21 +29,23 @@ items: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. isPreview: true - name: allowedEvents() - fullName: allowedEvents() + name: allowedEventsAsync() + fullName: allowedEventsAsync() langs: - typeScript type: method syntax: - content: 'allowedEvents?(): ReadonlyArray;' + content: 'allowedEventsAsync?(): Promise>;' return: type: - - ReadonlyArray + - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' description: '' - - uid: sp-dynamic-data.IDynamicDataSource.getAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' summary: >- Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. + deprecated: + content: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' name: getAnnotatedPropertyValue(propertyId) fullName: getAnnotatedPropertyValue(propertyId) langs: @@ -50,17 +55,39 @@ items: content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' return: type: - - sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' description: '' parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. type: - string - - uid: sp-dynamic-data.IDynamicDataSource.getPropertyDefinitions + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' + summary: >- + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. + name: getAnnotatedPropertyValueAsync(propertyId) + fullName: getAnnotatedPropertyValueAsync(propertyId) + langs: + - typeScript + type: method + syntax: + content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync~0:complex' + description: '' + parameters: + - id: propertyId + description: Property id for which the value is requested. + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' summary: >- Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. + deprecated: + content: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' name: getPropertyDefinitions() fullName: getPropertyDefinitions() langs: @@ -70,12 +97,29 @@ items: content: 'getPropertyDefinitions(): ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' description: '' - - uid: sp-dynamic-data.IDynamicDataSource.getPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' + summary: >- + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. + name: getPropertyDefinitionsAsync() + fullName: getPropertyDefinitionsAsync() + langs: + - typeScript + type: method + syntax: + content: 'getPropertyDefinitionsAsync(): Promise>;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync~0:complex' + description: '' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' summary: >- Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. + deprecated: + content: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' name: getPropertyValue(propertyId) fullName: getPropertyValue(propertyId) langs: @@ -89,38 +133,30 @@ items: description: '' parameters: - id: propertyId - description: '' + description: Property id for which the value is requested. type: - string - - uid: sp-dynamic-data.IDynamicDataSource.sendEvent + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' summary: >- - If defined, enables the consumer to send data to the associated dynamic data source. Then source can act - accordingly. - - - Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. - isPreview: true - name: 'sendEvent(eventName, data)' - fullName: 'sendEvent(eventName, data)' + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. + name: getPropertyValueAsync(propertyId) + fullName: getPropertyValueAsync(propertyId) langs: - typeScript type: method syntax: - content: 'sendEvent?(eventName: string, data: any): void;' + content: 'getPropertyValueAsync(propertyId: string): Promise;' return: type: - - void + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync~0:complex' description: '' parameters: - - id: eventName - description: A case-sensitive string representing the name of the event. + - id: propertyId + description: Property id for which the value is requested. type: - string - - id: data - description: Data to be sent to the dynamic data source. - type: - - any - - uid: sp-dynamic-data.IDynamicDataSource.id + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' summary: Id of the Dynamic Data Source. name: id fullName: id @@ -132,7 +168,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataSource.metadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' summary: Metadata of the Dynamic Data Source. name: metadata fullName: metadata @@ -143,4 +179,112 @@ items: content: 'metadata: IDynamicDataSourceMetadata;' return: type: - - sp-dynamic-data.IDynamicDataSourceMetadata + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' + summary: >- + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. + + + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + isPreview: true + name: 'sendEvent(eventName, data)' + fullName: 'sendEvent(eventName, data)' + langs: + - typeScript + type: method + syntax: + content: 'sendEvent?(eventName: string, data: any): void;' + return: + type: + - void + description: '' + parameters: + - id: eventName + description: A case-sensitive string representing the name of the event. + type: + - string + - id: data + description: Data to be sent to the dynamic data source. + type: + - any +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' + name: Promise> + fullName: Promise> + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + name: IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition + - name: '>>' + fullName: '>>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + fullName: IDynamicDataAnnotatedPropertyValue + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync~0:complex' + name: Promise> + fullName: Promise> + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + - name: '>>' + fullName: '>>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + name: IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 0eb3aa32..7486b33c 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -1,20 +1,20 @@ ### YamlMime:UniversalReference items: - - uid: sp-dynamic-data.IDynamicDataSourceMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. name: IDynamicDataSourceMetadata fullName: IDynamicDataSourceMetadata langs: - typeScript type: interface - package: sp-dynamic-data + package: '@microsoft/sp-dynamic-data!' children: - - sp-dynamic-data.IDynamicDataSourceMetadata.alias - - sp-dynamic-data.IDynamicDataSourceMetadata.componentId - - sp-dynamic-data.IDynamicDataSourceMetadata.description - - sp-dynamic-data.IDynamicDataSourceMetadata.instanceId - - sp-dynamic-data.IDynamicDataSourceMetadata.title - - uid: sp-dynamic-data.IDynamicDataSourceMetadata.alias + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' summary: >- Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. @@ -28,7 +28,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataSourceMetadata.componentId + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' summary: >- Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. @@ -42,7 +42,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataSourceMetadata.description + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' summary: 'User-friendly, localized description of the Dynamic Data Source.' name: description fullName: description @@ -54,7 +54,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataSourceMetadata.instanceId + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' summary: >- Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a @@ -69,7 +69,7 @@ items: return: type: - string - - uid: sp-dynamic-data.IDynamicDataSourceMetadata.title + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' summary: >- User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index 903e22b3..95d38cc3 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-extension-base + - uid: '@microsoft/sp-extension-base!' summary: SharePoint Framework support for building client-side extensions. name: '@microsoft/sp-extension-base' fullName: '@microsoft/sp-extension-base' @@ -8,10 +8,10 @@ items: - typeScript type: package children: - - sp-extension-base.BaseExtension - - sp-extension-base.ExtensionContext + - '@microsoft/sp-extension-base!BaseExtension:class' + - '@microsoft/sp-extension-base!ExtensionContext:class' references: - - uid: sp-extension-base.BaseExtension + - uid: '@microsoft/sp-extension-base!BaseExtension:class' name: BaseExtension - - uid: sp-extension-base.ExtensionContext + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' name: ExtensionContext diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 59cc70cb..d7a4ed52 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-extension-base.BaseExtension + - uid: '@microsoft/sp-extension-base!BaseExtension:class' summary: The base class for all client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -11,13 +11,15 @@ items: - typeScript type: class extends: - - sp-component-base.BaseComponent - package: sp-extension-base + - '@microsoft/sp-component-base!BaseComponent:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' + package: '@microsoft/sp-extension-base!' children: - - sp-extension-base.BaseExtension.context - - sp-extension-base.BaseExtension.onInit - - sp-extension-base.BaseExtension.properties - - uid: sp-extension-base.BaseExtension.context + - '@microsoft/sp-extension-base!BaseExtension#context:member' + - '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' + - '@microsoft/sp-extension-base!BaseExtension#properties:member' + - uid: '@microsoft/sp-extension-base!BaseExtension#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a @@ -32,8 +34,8 @@ items: content: 'protected readonly context: ExtensionContext;' return: type: - - sp-extension-base.ExtensionContext - - uid: sp-extension-base.BaseExtension.onInit + - '@microsoft/sp-extension-base!default:class' + - uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' summary: This event method is called when the client-side extension is first activated on the page. name: onInit() fullName: onInit() @@ -44,9 +46,9 @@ items: content: 'protected onInit(): Promise;' return: type: - - Promise + - '@microsoft/sp-extension-base!BaseExtension#onInit~0:complex' description: '' - - uid: sp-extension-base.BaseExtension.properties + - uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' summary: Extension properties is a JavaScript object that are passed in by the application that initializes the extension. remarks: >- Properties can be used in the extension code to define configurable behaviors. The application has control over @@ -62,3 +64,17 @@ items: return: type: - TProperties +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-extension-base!default:class' + name: ExtensionContext + - uid: '@microsoft/sp-extension-base!BaseExtension#onInit~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 4df3a4aa..1c7a0a04 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-extension-base.ExtensionContext + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' summary: The base class for context objects for client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -11,5 +11,10 @@ items: - typeScript type: class extends: - - sp-component-base.BaseComponentContext - package: sp-extension-base + - '@microsoft/sp-component-base!BaseComponentContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-extension-base!' +references: + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 1a35c68c..9d049446 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http + - uid: '@microsoft/sp-http!' summary: Base communication layer for the SharePoint Framework remarks: >- This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles @@ -12,124 +12,121 @@ items: - typeScript type: package children: - - sp-http.AadHttpClient - - sp-http.AadHttpClientConfiguration - - sp-http.AadHttpClientFactory - - sp-http.AadTokenProvider - - sp-http.AadTokenProviderFactory - - sp-http.DigestCache - - sp-http.GraphRequest - - sp-http.HttpClient - - sp-http.HttpClientConfiguration - - sp-http.HttpClientResponse - - sp-http.IAadHttpClientConfiguration - - sp-http.IAadHttpClientConfigurations - - sp-http.IAadHttpClientOptions - - sp-http.IAadTokenProvider - - sp-http.IAadTokenProviderConfiguration - - sp-http.IDigestCache - - sp-http.IGraphHttpClientOptions - - sp-http.IHttpClientConfiguration - - sp-http.IHttpClientConfigurations - - sp-http.IHttpClientOptions - - sp-http.ISPHttpClientBatchConfiguration - - sp-http.ISPHttpClientBatchConfigurations - - sp-http.ISPHttpClientBatchCreationOptions - - sp-http.ISPHttpClientBatchOptions - - sp-http.ISPHttpClientCommonConfiguration - - sp-http.ISPHttpClientConfiguration - - sp-http.ISPHttpClientConfigurations - - sp-http.ISPHttpClientOptions - - sp-http.ITokenAcquisitionEventArgs - - sp-http.MSGraphClient - - sp-http.MSGraphClientFactory - - sp-http.ODataVersion - - sp-http.SPHttpClient - - sp-http.SPHttpClientBatch - - sp-http.SPHttpClientBatchConfiguration - - sp-http.SPHttpClientCommonConfiguration - - sp-http.SPHttpClientConfiguration - - sp-http.SPHttpClientResponse - - sp-http.SPHttpHeader - - sp-http.TokenAcquisitionEventArgs + - '@microsoft/sp-http!AadHttpClient:class' + - '@microsoft/sp-http!AadHttpClientConfiguration:class' + - '@microsoft/sp-http!AadHttpClientFactory:class' + - '@microsoft/sp-http!AadTokenProvider:class' + - '@microsoft/sp-http!AadTokenProviderFactory:class' + - '@microsoft/sp-http!DigestCache:class' + - '@microsoft/sp-http!GraphRequest:interface' + - '@microsoft/sp-http!HttpClient:class' + - '@microsoft/sp-http!HttpClientConfiguration:class' + - '@microsoft/sp-http!HttpClientResponse:class' + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - '@microsoft/sp-http!IAadHttpClientOptions:interface' + - '@microsoft/sp-http!IAadTokenProvider:interface' + - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - '@microsoft/sp-http!IDigestCache:interface' + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - '@microsoft/sp-http!IHttpClientConfigurations:interface' + - '@microsoft/sp-http!IHttpClientOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + - '@microsoft/sp-http!MSGraphClient:class' + - '@microsoft/sp-http!MSGraphClientFactory:class' + - '@microsoft/sp-http!ODataVersion:class' + - '@microsoft/sp-http!SPHttpClient:class' + - '@microsoft/sp-http!SPHttpClientBatch:class' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + - '@microsoft/sp-http!SPHttpClientConfiguration:class' + - '@microsoft/sp-http!SPHttpClientResponse:class' + - '@microsoft/sp-http!SPHttpHeader:enum' + - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' references: - - uid: sp-http.AadHttpClient + - uid: '@microsoft/sp-http!AadHttpClient:class' name: AadHttpClient - - uid: sp-http.AadHttpClientConfiguration + - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' name: AadHttpClientConfiguration - - uid: sp-http.AadHttpClientFactory + - uid: '@microsoft/sp-http!AadHttpClientFactory:class' name: AadHttpClientFactory - - uid: sp-http.AadTokenProvider + - uid: '@microsoft/sp-http!AadTokenProvider:class' name: AadTokenProvider - - uid: sp-http.AadTokenProviderFactory + - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' name: AadTokenProviderFactory - - uid: sp-http.DigestCache + - uid: '@microsoft/sp-http!DigestCache:class' name: DigestCache - - uid: sp-http.GraphRequest + - uid: '@microsoft/sp-http!GraphRequest:interface' name: GraphRequest - - uid: sp-http.HttpClient + - uid: '@microsoft/sp-http!HttpClient:class' name: HttpClient - - uid: sp-http.HttpClientConfiguration + - uid: '@microsoft/sp-http!HttpClientConfiguration:class' name: HttpClientConfiguration - - uid: sp-http.HttpClientResponse + - uid: '@microsoft/sp-http!HttpClientResponse:class' name: HttpClientResponse - - uid: sp-http.IAadHttpClientConfiguration + - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' name: IAadHttpClientConfiguration - - uid: sp-http.IAadHttpClientConfigurations + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' name: IAadHttpClientConfigurations - - uid: sp-http.IAadHttpClientOptions + - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' name: IAadHttpClientOptions - - uid: sp-http.IAadTokenProvider + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' name: IAadTokenProvider - - uid: sp-http.IAadTokenProviderConfiguration + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' name: IAadTokenProviderConfiguration - - uid: sp-http.IDigestCache + - uid: '@microsoft/sp-http!IDigestCache:interface' name: IDigestCache - - uid: sp-http.IGraphHttpClientOptions - name: IGraphHttpClientOptions - - uid: sp-http.IHttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' name: IHttpClientConfiguration - - uid: sp-http.IHttpClientConfigurations + - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' name: IHttpClientConfigurations - - uid: sp-http.IHttpClientOptions + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' name: IHttpClientOptions - - uid: sp-http.ISPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' name: ISPHttpClientBatchConfiguration - - uid: sp-http.ISPHttpClientBatchConfigurations + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' name: ISPHttpClientBatchConfigurations - - uid: sp-http.ISPHttpClientBatchCreationOptions + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' name: ISPHttpClientBatchCreationOptions - - uid: sp-http.ISPHttpClientBatchOptions + - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' name: ISPHttpClientBatchOptions - - uid: sp-http.ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' name: ISPHttpClientCommonConfiguration - - uid: sp-http.ISPHttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' name: ISPHttpClientConfiguration - - uid: sp-http.ISPHttpClientConfigurations + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' name: ISPHttpClientConfigurations - - uid: sp-http.ISPHttpClientOptions + - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' name: ISPHttpClientOptions - - uid: sp-http.ITokenAcquisitionEventArgs + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' name: ITokenAcquisitionEventArgs - - uid: sp-http.MSGraphClient + - uid: '@microsoft/sp-http!MSGraphClient:class' name: MSGraphClient - - uid: sp-http.MSGraphClientFactory + - uid: '@microsoft/sp-http!MSGraphClientFactory:class' name: MSGraphClientFactory - - uid: sp-http.ODataVersion + - uid: '@microsoft/sp-http!ODataVersion:class' name: ODataVersion - - uid: sp-http.SPHttpClient + - uid: '@microsoft/sp-http!SPHttpClient:class' name: SPHttpClient - - uid: sp-http.SPHttpClientBatch + - uid: '@microsoft/sp-http!SPHttpClientBatch:class' name: SPHttpClientBatch - - uid: sp-http.SPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' name: SPHttpClientBatchConfiguration - - uid: sp-http.SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' name: SPHttpClientCommonConfiguration - - uid: sp-http.SPHttpClientConfiguration + - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' name: SPHttpClientConfiguration - - uid: sp-http.SPHttpClientResponse + - uid: '@microsoft/sp-http!SPHttpClientResponse:class' name: SPHttpClientResponse - - uid: sp-http.SPHttpHeader + - uid: '@microsoft/sp-http!SPHttpHeader:enum' name: SPHttpHeader - - uid: sp-http.TokenAcquisitionEventArgs + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' name: TokenAcquisitionEventArgs diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index a49e37ed..992e27d2 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -1,26 +1,27 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.AadHttpClient + - uid: '@microsoft/sp-http!AadHttpClient:class' summary: AadHttpClient is used to perform REST calls against an Azure AD Application. remarks: >- This class is marked as `@sealed`. Subclasses should not extend it. - For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For - communicating with Microsoft Graph, use the [MSGraphClient](xref:sp-http.MSGraphClient) class. + For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class + instead. For communicating with Microsoft Graph, use the + [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. name: AadHttpClient fullName: AadHttpClient langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.AadHttpClient.(constructor) - - sp-http.AadHttpClient.configurations - - sp-http.AadHttpClient.fetch - - sp-http.AadHttpClient.get - - sp-http.AadHttpClient.post - - uid: sp-http.AadHttpClient.(constructor) + - '@microsoft/sp-http!AadHttpClient:constructor(1)' + - '@microsoft/sp-http!AadHttpClient.configurations:member' + - '@microsoft/sp-http!AadHttpClient#fetch:member(1)' + - '@microsoft/sp-http!AadHttpClient#get:member(1)' + - '@microsoft/sp-http!AadHttpClient#post:member(1)' + - uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' summary: Constructs a new instance of the `AadHttpClient` class name: '(constructor)(serviceScope, resourceEndpoint, options)' fullName: '(constructor)(serviceScope, resourceEndpoint, options)' @@ -33,7 +34,7 @@ items: - id: serviceScope description: The service scope is needed to retrieve some of the class's internal components. type: - - sp-core-library.ServiceScope + - '@microsoft/sp-core-library!ServiceScope:class' - id: resourceEndpoint description: '' type: @@ -41,8 +42,8 @@ items: - id: options description: Configuration options for the request to get an access token. type: - - sp-http.IAadHttpClientOptions - - uid: sp-http.AadHttpClient.configurations + - '@microsoft/sp-http!IAadHttpClientOptions:interface' + - uid: '@microsoft/sp-http!AadHttpClient.configurations:member' summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. name: configurations fullName: configurations @@ -53,8 +54,8 @@ items: content: 'static readonly configurations: IAadHttpClientConfigurations;' return: type: - - sp-http.IAadHttpClientConfigurations - - uid: sp-http.AadHttpClient.fetch + - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' summary: Performs a REST service call. remarks: >- Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for @@ -71,7 +72,7 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!AadHttpClient#fetch~0:complex' description: A promise that will return the result. parameters: - id: url @@ -83,12 +84,12 @@ items: Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. type: - - sp-http.AadHttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: Additional options that affect the request. type: - - sp-http.IHttpClientOptions - - uid: sp-http.AadHttpClient.get + - '@microsoft/sp-http!IHttpClientOptions:interface' + - uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' fullName: 'get(url, configuration, options)' @@ -101,7 +102,7 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!AadHttpClient#get~0:complex' description: A promise that will return the result. parameters: - id: url @@ -113,12 +114,12 @@ items: Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. type: - - sp-http.AadHttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: Additional options that affect the request. type: - - sp-http.IHttpClientOptions - - uid: sp-http.AadHttpClient.post + - '@microsoft/sp-http!IHttpClientOptions:interface' + - uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' fullName: 'post(url, configuration, options)' @@ -131,7 +132,7 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!AadHttpClient#post~0:complex' description: A promise that will return the result. parameters: - id: url @@ -143,8 +144,61 @@ items: Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. type: - - sp-http.AadHttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: Additional options that affect the request. type: - - sp-http.IHttpClientOptions + - '@microsoft/sp-http!IHttpClientOptions:interface' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' + name: IAadHttpClientOptions + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + name: IAadHttpClientConfigurations + - uid: '@microsoft/sp-http!AadHttpClient#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '@microsoft/sp-http!AadHttpClient#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadHttpClient#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index f859198f..a3837b75 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.AadHttpClientConfiguration + - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' summary: Configuration for HttpClient. remarks: >- The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the @@ -13,15 +13,17 @@ items: - typeScript type: class extends: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - sp-http.IAadHttpClientConfiguration - package: sp-http + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.AadHttpClientConfiguration.(constructor) - - sp-http.AadHttpClientConfiguration.flags - - sp-http.AadHttpClientConfiguration.overrideWith - - uid: sp-http.AadHttpClientConfiguration.(constructor) + - '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' + - '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' + - '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -36,12 +38,12 @@ items: - id: flags description: '' type: - - sp-http.IAadHttpClientConfiguration + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - id: overrideFlags description: '' type: - - sp-http.IAadHttpClientConfiguration - - uid: sp-http.AadHttpClientConfiguration.flags + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' name: flags fullName: flags langs: @@ -51,8 +53,8 @@ items: content: 'protected flags: IAadHttpClientConfiguration;' return: type: - - sp-http.IAadHttpClientConfiguration - - uid: sp-http.AadHttpClientConfiguration.overrideWith + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) langs: @@ -64,10 +66,15 @@ items: overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; return: type: - - sp-http.AadHttpClientConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - sp-http.IAadHttpClientConfiguration + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + name: IAadHttpClientConfiguration diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 4b3c4f0e..c19e4e03 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.AadHttpClientFactory + - uid: '@microsoft/sp-http!AadHttpClientFactory:class' summary: >- Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) @@ -12,11 +12,11 @@ items: langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.AadHttpClientFactory.getClient - - sp-http.AadHttpClientFactory.serviceKey - - uid: sp-http.AadHttpClientFactory.getClient + - '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' + - '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' + - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' summary: >- Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. @@ -29,14 +29,14 @@ items: content: 'getClient(resourceEndpoint: string): Promise;' return: type: - - Promise + - '@microsoft/sp-http!AadHttpClientFactory#getClient~0:complex' description: '' parameters: - id: resourceEndpoint description: The target AAD application's resource endpoint. type: - string - - uid: sp-http.AadHttpClientFactory.serviceKey + - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' summary: The service key for AadHttpClientFactory. name: serviceKey fullName: serviceKey @@ -47,4 +47,33 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-http!AadHttpClientFactory.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClient + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClientFactory + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 2ec27f72..9f9b6f7e 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.AadTokenProvider + - uid: '@microsoft/sp-http!AadTokenProvider:class' summary: >- This class allows a developer to obtain OAuth2 tokens from Azure AD. @@ -19,12 +19,12 @@ items: - typeScript type: class implements: - - sp-http.IAadTokenProvider - package: sp-http + - '@microsoft/sp-http!IAadTokenProvider:interface' + package: '@microsoft/sp-http!' children: - - sp-http.AadTokenProvider.getToken - - sp-http.AadTokenProvider.tokenAcquisitionEvent - - uid: sp-http.AadTokenProvider.getToken + - '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' + - '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' + - uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. @@ -38,7 +38,7 @@ items: content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' return: type: - - Promise + - '@microsoft/sp-http!AadTokenProvider#getToken~0:complex' description: A promise that will be fullfiled with the token or that will reject with an error message parameters: - id: resourceEndpoint @@ -51,7 +51,7 @@ items: be https://graph.microsoft.com type: - boolean - - uid: sp-http.AadTokenProvider.tokenAcquisitionEvent + - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' summary: Notifies the developer when Token Acquisition requires user action. name: tokenAcquisitionEvent fullName: tokenAcquisitionEvent @@ -62,4 +62,30 @@ items: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: type: - - SPEvent + - '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent~0:complex' +references: + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' + name: IAadTokenProvider + - uid: '@microsoft/sp-http!AadTokenProvider#getToken~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + name: TokenAcquisitionEventArgs + fullName: TokenAcquisitionEventArgs + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 368e0ff1..4fa9c796 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.AadTokenProviderFactory + - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' summary: Returns a preinitialized version of the AadTokenProviderFactory. name: AadTokenProviderFactory fullName: AadTokenProviderFactory langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.AadTokenProviderFactory.getTokenProvider - - sp-http.AadTokenProviderFactory.serviceKey - - uid: sp-http.AadTokenProviderFactory.getTokenProvider + - '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' + - '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' + - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' summary: >- Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. @@ -24,9 +24,9 @@ items: content: 'getTokenProvider(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider~0:complex' description: '' - - uid: sp-http.AadTokenProviderFactory.serviceKey + - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' summary: The service key for AadTokenProviderFactory. name: serviceKey fullName: serviceKey @@ -37,4 +37,33 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-http!AadTokenProviderFactory.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadTokenProvider + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadTokenProviderFactory + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index eb2766fb..127bf9ed 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.DigestCache + - uid: '@microsoft/sp-http!DigestCache:class' summary: >- IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, @@ -16,16 +16,16 @@ items: - typeScript type: class implements: - - sp-http.IDigestCache - package: sp-http + - '@microsoft/sp-http!IDigestCache:interface' + package: '@microsoft/sp-http!' children: - - sp-http.DigestCache.(constructor) - - sp-http.DigestCache.addDigestToCache - - sp-http.DigestCache.clearAllDigests - - sp-http.DigestCache.clearDigest - - sp-http.DigestCache.fetchDigest - - sp-http.DigestCache.serviceKey - - uid: sp-http.DigestCache.(constructor) + - '@microsoft/sp-http!DigestCache:constructor(1)' + - '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' + - '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' + - '@microsoft/sp-http!DigestCache#clearDigest:member(1)' + - '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' + - '@microsoft/sp-http!DigestCache.serviceKey:member' + - uid: '@microsoft/sp-http!DigestCache:constructor(1)' summary: Constructs a new instance of the `DigestCache` class name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) @@ -38,8 +38,8 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-http.DigestCache.addDigestToCache + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios @@ -73,7 +73,7 @@ items: example, to specify an expiration "5 seconds from right now", use performance.now()+5000. type: - number - - uid: sp-http.DigestCache.clearAllDigests + - uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' summary: Clears all values from the cache. name: clearAllDigests() fullName: clearAllDigests() @@ -86,7 +86,7 @@ items: type: - void description: '' - - uid: sp-http.DigestCache.clearDigest + - uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' summary: >- Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. @@ -106,7 +106,7 @@ items: description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. type: - string - - uid: sp-http.DigestCache.fetchDigest + - uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' summary: >- Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the @@ -120,14 +120,14 @@ items: content: 'fetchDigest(webUrl: string): Promise;' return: type: - - Promise + - '@microsoft/sp-http!DigestCache#fetchDigest~0:complex' description: A promise that is fulfilled with the digest value. parameters: - id: webUrl description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. type: - string - - uid: sp-http.DigestCache.serviceKey + - uid: '@microsoft/sp-http!DigestCache.serviceKey:member' summary: The service key for IDigestCache. name: serviceKey fullName: serviceKey @@ -138,4 +138,32 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-http!DigestCache.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!IDigestCache:interface' + name: IDigestCache + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!DigestCache#fetchDigest~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!DigestCache.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!IDigestCache:interface' + name: IDigestCache + fullName: IDigestCache + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index e1e26fb9..4517739b 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.GraphRequest + - uid: '@microsoft/sp-http!GraphRequest:interface' summary: >- Typings for the GraphRequest Object For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) @@ -9,39 +9,39 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.GraphRequest._headers - - sp-http.GraphRequest._responseType - - sp-http.GraphRequest.buildFullUrl - - sp-http.GraphRequest.constructor - - sp-http.GraphRequest.count - - sp-http.GraphRequest.create - - sp-http.GraphRequest.del - - sp-http.GraphRequest.delete - - sp-http.GraphRequest.expand - - sp-http.GraphRequest.filter - - sp-http.GraphRequest.get - - sp-http.GraphRequest.getStream - - sp-http.GraphRequest.header - - sp-http.GraphRequest.headers - - sp-http.GraphRequest.orderby - - sp-http.GraphRequest.parsePath - - sp-http.GraphRequest.patch - - sp-http.GraphRequest.post - - sp-http.GraphRequest.put - - sp-http.GraphRequest.putStream - - sp-http.GraphRequest.query - - sp-http.GraphRequest.responseType - - sp-http.GraphRequest.select - - sp-http.GraphRequest.skip - - sp-http.GraphRequest.skipToken - - sp-http.GraphRequest.top - - sp-http.GraphRequest.update - - sp-http.GraphRequest.version - - sp-http.GraphRequest.config - - sp-http.GraphRequest.urlComponents - - uid: sp-http.GraphRequest._headers + - '@microsoft/sp-http!GraphRequest#_headers:member' + - '@microsoft/sp-http!GraphRequest#_responseType:member' + - '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' + - '@microsoft/sp-http!GraphRequest#config:member' + - '@microsoft/sp-http!GraphRequest#constructor:member(1)' + - '@microsoft/sp-http!GraphRequest#count:member(1)' + - '@microsoft/sp-http!GraphRequest#create:member(1)' + - '@microsoft/sp-http!GraphRequest#del:member(1)' + - '@microsoft/sp-http!GraphRequest#delete:member(1)' + - '@microsoft/sp-http!GraphRequest#expand:member(1)' + - '@microsoft/sp-http!GraphRequest#filter:member(1)' + - '@microsoft/sp-http!GraphRequest#get:member(1)' + - '@microsoft/sp-http!GraphRequest#getStream:member(1)' + - '@microsoft/sp-http!GraphRequest#header:member(1)' + - '@microsoft/sp-http!GraphRequest#headers:member(1)' + - '@microsoft/sp-http!GraphRequest#orderby:member(1)' + - '@microsoft/sp-http!GraphRequest#parsePath:member(1)' + - '@microsoft/sp-http!GraphRequest#patch:member(1)' + - '@microsoft/sp-http!GraphRequest#post:member(1)' + - '@microsoft/sp-http!GraphRequest#put:member(1)' + - '@microsoft/sp-http!GraphRequest#putStream:member(1)' + - '@microsoft/sp-http!GraphRequest#query:member(1)' + - '@microsoft/sp-http!GraphRequest#responseType:member(1)' + - '@microsoft/sp-http!GraphRequest#select:member(1)' + - '@microsoft/sp-http!GraphRequest#skip:member(1)' + - '@microsoft/sp-http!GraphRequest#skipToken:member(1)' + - '@microsoft/sp-http!GraphRequest#top:member(1)' + - '@microsoft/sp-http!GraphRequest#update:member(1)' + - '@microsoft/sp-http!GraphRequest#urlComponents:member' + - '@microsoft/sp-http!GraphRequest#version:member(1)' + - uid: '@microsoft/sp-http!GraphRequest#_headers:member' name: _headers fullName: _headers langs: @@ -58,7 +58,7 @@ items: { [key: string]: string | number; } - - uid: sp-http.GraphRequest._responseType + - uid: '@microsoft/sp-http!GraphRequest#_responseType:member' name: _responseType fullName: _responseType langs: @@ -69,7 +69,7 @@ items: return: type: - string - - uid: sp-http.GraphRequest.buildFullUrl + - uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' name: buildFullUrl() fullName: buildFullUrl() langs: @@ -81,7 +81,18 @@ items: type: - string description: '' - - uid: sp-http.GraphRequest.constructor + - uid: '@microsoft/sp-http!GraphRequest#config:member' + name: config + fullName: config + langs: + - typeScript + type: property + syntax: + content: 'config: Options;' + return: + type: + - '@microsoft/microsoft-graph-client!Options:interface' + - uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' name: 'constructor(config, path)' fullName: 'constructor(config, path)' langs: @@ -91,18 +102,18 @@ items: content: 'constructor(config: Options, path: string): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: config description: '' type: - - Options + - '@microsoft/microsoft-graph-client!Options:interface' - id: path description: '' type: - string - - uid: sp-http.GraphRequest.count + - uid: '@microsoft/sp-http!GraphRequest#count:member(1)' name: count(count) fullName: count(count) langs: @@ -112,14 +123,14 @@ items: content: 'count(count: boolean): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: count description: '' type: - boolean - - uid: sp-http.GraphRequest.create + - uid: '@microsoft/sp-http!GraphRequest#create:member(1)' name: 'create(content, callback)' fullName: 'create(content, callback)' langs: @@ -129,7 +140,7 @@ items: content: 'create(content: any, callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#create~0:complex' description: '' parameters: - id: content @@ -139,8 +150,8 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.del + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#del:member(1)' name: del(callback) fullName: del(callback) langs: @@ -150,14 +161,14 @@ items: content: 'del(callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#del~0:complex' description: '' parameters: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.delete + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' name: delete(callback) fullName: delete(callback) langs: @@ -167,14 +178,14 @@ items: content: 'delete(callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#delete~0:complex' description: '' parameters: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.expand + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' name: expand(properties) fullName: expand(properties) langs: @@ -184,14 +195,14 @@ items: content: 'expand(properties: string | string[]): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: properties description: '' type: - 'string | string[]' - - uid: sp-http.GraphRequest.filter + - uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' name: filter(filterStr) fullName: filter(filterStr) langs: @@ -201,14 +212,14 @@ items: content: 'filter(filterStr: string): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: filterStr description: '' type: - string - - uid: sp-http.GraphRequest.get + - uid: '@microsoft/sp-http!GraphRequest#get:member(1)' name: get(callback) fullName: get(callback) langs: @@ -218,14 +229,14 @@ items: content: 'get(callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#get~0:complex' description: '' parameters: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.getStream + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' name: getStream(callback) fullName: getStream(callback) langs: @@ -241,8 +252,8 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.header + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#header:member(1)' name: 'header(headerKey, headerValue)' fullName: 'header(headerKey, headerValue)' langs: @@ -263,7 +274,7 @@ items: description: '' type: - string - - uid: sp-http.GraphRequest.headers + - uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' name: headers(headers) fullName: headers(headers) langs: @@ -286,7 +297,7 @@ items: { [key: string]: string | number; } - - uid: sp-http.GraphRequest.orderby + - uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' name: orderby(properties) fullName: orderby(properties) langs: @@ -296,14 +307,14 @@ items: content: 'orderby(properties: string | string[]): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: properties description: '' type: - 'string | string[]' - - uid: sp-http.GraphRequest.parsePath + - uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' name: parsePath(rawPath) fullName: parsePath(rawPath) langs: @@ -320,7 +331,7 @@ items: description: '' type: - string - - uid: sp-http.GraphRequest.patch + - uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' name: 'patch(content, callback)' fullName: 'patch(content, callback)' langs: @@ -330,7 +341,7 @@ items: content: 'patch(content: any, callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#patch~0:complex' description: '' parameters: - id: content @@ -340,8 +351,8 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.post + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#post:member(1)' name: 'post(content, callback)' fullName: 'post(content, callback)' langs: @@ -351,7 +362,7 @@ items: content: 'post(content: any, callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#post~0:complex' description: '' parameters: - id: content @@ -361,8 +372,8 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.put + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#put:member(1)' name: 'put(content, callback)' fullName: 'put(content, callback)' langs: @@ -372,7 +383,7 @@ items: content: 'put(content: any, callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#put~0:complex' description: '' parameters: - id: content @@ -382,8 +393,8 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.putStream + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' name: 'putStream(stream, callback)' fullName: 'putStream(stream, callback)' langs: @@ -403,8 +414,8 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.query + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#query:member(1)' name: query(queryDictionaryOrString) fullName: query(queryDictionaryOrString) langs: @@ -417,7 +428,7 @@ items: }): IGraphRequest; return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: queryDictionaryOrString @@ -427,7 +438,7 @@ items: string | { [key: string]: string | number; } - - uid: sp-http.GraphRequest.responseType + - uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' name: responseType(responseType) fullName: responseType(responseType) langs: @@ -437,14 +448,14 @@ items: content: 'responseType(responseType: string): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: responseType description: '' type: - string - - uid: sp-http.GraphRequest.select + - uid: '@microsoft/sp-http!GraphRequest#select:member(1)' name: select(properties) fullName: select(properties) langs: @@ -454,14 +465,14 @@ items: content: 'select(properties: string | string[]): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: properties description: '' type: - 'string | string[]' - - uid: sp-http.GraphRequest.skip + - uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' name: skip(n) fullName: skip(n) langs: @@ -471,14 +482,14 @@ items: content: 'skip(n: number): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: 'n' description: '' type: - number - - uid: sp-http.GraphRequest.skipToken + - uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' name: skipToken(token) fullName: skipToken(token) langs: @@ -488,14 +499,14 @@ items: content: 'skipToken(token: string): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: token description: '' type: - string - - uid: sp-http.GraphRequest.top + - uid: '@microsoft/sp-http!GraphRequest#top:member(1)' name: top(n) fullName: top(n) langs: @@ -505,14 +516,14 @@ items: content: 'top(n: number): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: 'n' description: '' type: - number - - uid: sp-http.GraphRequest.update + - uid: '@microsoft/sp-http!GraphRequest#update:member(1)' name: 'update(content, callback)' fullName: 'update(content, callback)' langs: @@ -522,7 +533,7 @@ items: content: 'update(content: any, callback?: GraphRequestCallback): Promise;' return: type: - - Promise + - '@microsoft/sp-http!GraphRequest#update~0:complex' description: '' parameters: - id: content @@ -532,8 +543,19 @@ items: - id: callback description: '' type: - - GraphRequestCallback - - uid: sp-http.GraphRequest.version + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + - uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' + name: urlComponents + fullName: urlComponents + langs: + - typeScript + type: property + syntax: + content: 'urlComponents: URLComponents;' + return: + type: + - '@microsoft/microsoft-graph-client!URLComponents:interface' + - uid: '@microsoft/sp-http!GraphRequest#version:member(1)' name: version(v) fullName: version(v) langs: @@ -543,32 +565,91 @@ items: content: 'version(v: string): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: v description: '' type: - string - - uid: sp-http.GraphRequest.config - name: config - fullName: config - langs: - - typeScript - type: property - syntax: - content: 'config: Options;' - return: - type: - - Options - - uid: sp-http.GraphRequest.urlComponents - name: urlComponents - fullName: urlComponents - langs: - - typeScript - type: property - syntax: - content: 'urlComponents: URLComponents;' - return: - type: - - URLComponents +references: + - uid: '@microsoft/microsoft-graph-client!Options:interface' + name: Options + - uid: '@microsoft/sp-http!IGraphRequest:interface' + name: IGraphRequest + - uid: '@microsoft/sp-http!GraphRequest#create~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + name: GraphRequestCallback + - uid: '@microsoft/sp-http!GraphRequest#del~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#delete~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#patch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#put~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#update~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/microsoft-graph-client!URLComponents:interface' + name: URLComponents diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 901a5a24..df13c335 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -1,22 +1,24 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.HttpClient + - uid: '@microsoft/sp-http!HttpClient:class' summary: HttpClient implements a basic set of features for performing REST operations against a generic service. - remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead.' + remarks: >- + For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class + instead. name: HttpClient fullName: HttpClient langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.HttpClient.(constructor) - - sp-http.HttpClient.configurations - - sp-http.HttpClient.fetch - - sp-http.HttpClient.get - - sp-http.HttpClient.post - - sp-http.HttpClient.serviceKey - - uid: sp-http.HttpClient.(constructor) + - '@microsoft/sp-http!HttpClient:constructor(1)' + - '@microsoft/sp-http!HttpClient.configurations:member' + - '@microsoft/sp-http!HttpClient#fetch:member(1)' + - '@microsoft/sp-http!HttpClient#get:member(1)' + - '@microsoft/sp-http!HttpClient#post:member(1)' + - '@microsoft/sp-http!HttpClient.serviceKey:member' + - uid: '@microsoft/sp-http!HttpClient:constructor(1)' summary: Constructs a new instance of the `HttpClient` class name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) @@ -29,8 +31,8 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-http.HttpClient.configurations + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-http!HttpClient.configurations:member' summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. name: configurations fullName: configurations @@ -41,8 +43,8 @@ items: content: 'static readonly configurations: IHttpClientConfigurations;' return: type: - - sp-http.IHttpClientConfigurations - - uid: sp-http.HttpClient.fetch + - '@microsoft/sp-http!IHttpClientConfigurations:interface' + - uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' summary: Performs a REST service call. remarks: >- Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for @@ -59,12 +61,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!HttpClient#fetch~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -75,12 +77,12 @@ items: determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.IHttpClientOptions - - uid: sp-http.HttpClient.get + - '@microsoft/sp-http!IHttpClientOptions:interface' + - uid: '@microsoft/sp-http!HttpClient#get:member(1)' summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' fullName: 'get(url, configuration, options)' @@ -93,12 +95,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!HttpClient#get~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -109,12 +111,12 @@ items: determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.IHttpClientOptions - - uid: sp-http.HttpClient.post + - '@microsoft/sp-http!IHttpClientOptions:interface' + - uid: '@microsoft/sp-http!HttpClient#post:member(1)' summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' fullName: 'post(url, configuration, options)' @@ -127,12 +129,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!HttpClient#post~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -143,12 +145,12 @@ items: determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.IHttpClientOptions - - uid: sp-http.HttpClient.serviceKey + - '@microsoft/sp-http!IHttpClientOptions:interface' + - uid: '@microsoft/sp-http!HttpClient.serviceKey:member' summary: The service key for HttpClient. name: serviceKey fullName: serviceKey @@ -159,4 +161,69 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-http!HttpClient.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' + name: IHttpClientConfigurations + - uid: '@microsoft/sp-http!HttpClient#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '@microsoft/sp-http!HttpClient#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!HttpClient#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!HttpClient.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClient + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index 33258cc7..3dabad58 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.HttpClientConfiguration + - uid: '@microsoft/sp-http!HttpClientConfiguration:class' summary: Configuration for HttpClient. remarks: >- The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the @@ -13,14 +13,14 @@ items: - typeScript type: class implements: - - sp-http.IHttpClientConfiguration - package: sp-http + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.HttpClientConfiguration.(constructor) - - sp-http.HttpClientConfiguration.flags - - sp-http.HttpClientConfiguration.initializeFlags - - sp-http.HttpClientConfiguration.overrideWith - - uid: sp-http.HttpClientConfiguration.(constructor) + - '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' + - '@microsoft/sp-http!HttpClientConfiguration#flags:member' + - '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -35,12 +35,12 @@ items: - id: flags description: '' type: - - sp-http.IHttpClientConfiguration + - '@microsoft/sp-http!IHttpClientConfiguration:interface' - id: overrideFlags description: '' type: - - sp-http.IHttpClientConfiguration - - uid: sp-http.HttpClientConfiguration.flags + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' name: flags fullName: flags langs: @@ -50,8 +50,8 @@ items: content: 'protected flags: IHttpClientConfiguration;' return: type: - - sp-http.IHttpClientConfiguration - - uid: sp-http.HttpClientConfiguration.initializeFlags + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' summary: Child classes should override this method to initialize the flags object. name: initializeFlags() fullName: initializeFlags() @@ -66,7 +66,7 @@ items: type: - void description: '' - - uid: sp-http.HttpClientConfiguration.overrideWith + - uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) @@ -79,10 +79,15 @@ items: overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; return: type: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - sp-http.IHttpClientConfiguration + - '@microsoft/sp-http!IHttpClientConfiguration:interface' +references: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 07764fc2..0805ca36 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.HttpClientResponse + - uid: '@microsoft/sp-http!HttpClientResponse:class' summary: The Response subclass returned by methods such as HttpClient.fetch(). remarks: >- This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. @@ -14,25 +14,25 @@ items: - typeScript type: class implements: - - Response - - 'Body ' - package: sp-http + - '!Response:interface' + - '!Body:interface' + package: '@microsoft/sp-http!' children: - - sp-http.HttpClientResponse.arrayBuffer - - sp-http.HttpClientResponse.blob - - sp-http.HttpClientResponse.bodyUsed - - sp-http.HttpClientResponse.clone - - sp-http.HttpClientResponse.formData - - sp-http.HttpClientResponse.headers - - sp-http.HttpClientResponse.json - - sp-http.HttpClientResponse.nativeResponse - - sp-http.HttpClientResponse.ok - - sp-http.HttpClientResponse.status - - sp-http.HttpClientResponse.statusText - - sp-http.HttpClientResponse.text - - sp-http.HttpClientResponse.type - - sp-http.HttpClientResponse.url - - uid: sp-http.HttpClientResponse.arrayBuffer + - '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' + - '@microsoft/sp-http!HttpClientResponse#blob:member(1)' + - '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' + - '@microsoft/sp-http!HttpClientResponse#clone:member(1)' + - '@microsoft/sp-http!HttpClientResponse#formData:member(1)' + - '@microsoft/sp-http!HttpClientResponse#headers:member' + - '@microsoft/sp-http!HttpClientResponse#json:member(1)' + - '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' + - '@microsoft/sp-http!HttpClientResponse#ok:member' + - '@microsoft/sp-http!HttpClientResponse#status:member' + - '@microsoft/sp-http!HttpClientResponse#statusText:member' + - '@microsoft/sp-http!HttpClientResponse#text:member(1)' + - '@microsoft/sp-http!HttpClientResponse#type:member' + - '@microsoft/sp-http!HttpClientResponse#url:member' + - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: arrayBuffer() fullName: arrayBuffer() @@ -43,9 +43,9 @@ items: content: 'arrayBuffer(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' description: '' - - uid: sp-http.HttpClientResponse.blob + - uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: blob() fullName: blob() @@ -56,9 +56,9 @@ items: content: 'blob(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#blob~0:complex' description: '' - - uid: sp-http.HttpClientResponse.bodyUsed + - uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: bodyUsed fullName: bodyUsed @@ -70,7 +70,7 @@ items: return: type: - boolean - - uid: sp-http.HttpClientResponse.clone + - uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' name: clone() fullName: clone() langs: @@ -82,9 +82,9 @@ items: clone(): HttpClientResponse; return: type: - - sp-http.HttpClientResponse + - '@microsoft/sp-http!default:class' description: '' - - uid: sp-http.HttpClientResponse.formData + - uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: formData() fullName: formData() @@ -95,9 +95,9 @@ items: content: 'formData(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#formData~0:complex' description: '' - - uid: sp-http.HttpClientResponse.headers + - uid: '@microsoft/sp-http!HttpClientResponse#headers:member' summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: headers fullName: headers @@ -108,8 +108,8 @@ items: content: 'readonly headers: Headers;' return: type: - - Headers - - uid: sp-http.HttpClientResponse.json + - '!Headers:interface' + - uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: json() fullName: json() @@ -120,9 +120,9 @@ items: content: 'json(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#json~0:complex' description: '' - - uid: sp-http.HttpClientResponse.nativeResponse + - uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' name: nativeResponse fullName: nativeResponse langs: @@ -132,8 +132,8 @@ items: content: 'protected nativeResponse: Response;' return: type: - - Response - - uid: sp-http.HttpClientResponse.ok + - '!Response:interface' + - uid: '@microsoft/sp-http!HttpClientResponse#ok:member' summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: ok fullName: ok @@ -145,7 +145,7 @@ items: return: type: - boolean - - uid: sp-http.HttpClientResponse.status + - uid: '@microsoft/sp-http!HttpClientResponse#status:member' summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: status fullName: status @@ -157,7 +157,7 @@ items: return: type: - number - - uid: sp-http.HttpClientResponse.statusText + - uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: statusText fullName: statusText @@ -169,7 +169,7 @@ items: return: type: - string - - uid: sp-http.HttpClientResponse.text + - uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' name: text() fullName: text() @@ -180,9 +180,9 @@ items: content: 'text(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#text~0:complex' description: '' - - uid: sp-http.HttpClientResponse.type + - uid: '@microsoft/sp-http!HttpClientResponse#type:member' summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: type fullName: type @@ -193,8 +193,8 @@ items: content: 'readonly type: ResponseType;' return: type: - - ResponseType - - uid: sp-http.HttpClientResponse.url + - '!ResponseType:type' + - uid: '@microsoft/sp-http!HttpClientResponse#url:member' summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' name: url fullName: url @@ -206,3 +206,74 @@ items: return: type: - string +references: + - uid: '!Response:interface' + name: Response + - uid: '!Body:interface' + name: Body + - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!ArrayBuffer:interface' + name: ArrayBuffer + fullName: ArrayBuffer + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!HttpClientResponse#blob~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!Blob:interface' + name: Blob + fullName: Blob + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + - uid: '@microsoft/sp-http!HttpClientResponse#formData~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!FormData:interface' + name: FormData + fullName: FormData + - name: '>' + fullName: '>' + - uid: '!Headers:interface' + name: Headers + - uid: '@microsoft/sp-http!HttpClientResponse#json~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!HttpClientResponse#text~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '!ResponseType:type' + name: ResponseType diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 1ba5db80..1d8bd79e 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IAadHttpClientConfiguration + - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' summary: Flags interface for HttpClientConfiguration. name: IAadHttpClientConfiguration fullName: IAadHttpClientConfiguration @@ -8,5 +8,10 @@ items: - typeScript type: interface extends: - - sp-http.IHttpClientConfiguration - package: sp-http + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' +references: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 507cd084..41293bf0 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IAadHttpClientConfigurations + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' summary: Standard configurations for AadHttpClient. remarks: >- This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient @@ -13,10 +13,10 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.IAadHttpClientConfigurations.v1 - - uid: sp-http.IAadHttpClientConfigurations.v1 + - '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' summary: >- This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ @@ -29,4 +29,7 @@ items: content: 'readonly v1: AadHttpClientConfiguration;' return: type: - - sp-http.AadHttpClientConfiguration + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClientConfiguration diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index acd57a7b..c1f31bd3 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -1,18 +1,18 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IAadHttpClientOptions + - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' summary: Interface for overriding the default behavior of AadHttpClient. name: IAadHttpClientOptions fullName: IAadHttpClientOptions langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.IAadHttpClientOptions.configuration - - sp-http.IAadHttpClientOptions.tokenProvider - - sp-http.IAadHttpClientOptions.useCachedToken - - uid: sp-http.IAadHttpClientOptions.configuration + - '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' + - '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' + - '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' + - uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' deprecated: content: '- AadHttpClient''s configuration cannot be altered' name: configuration @@ -24,8 +24,8 @@ items: content: 'configuration?: IAadTokenProviderConfiguration;' return: type: - - sp-http.IAadTokenProviderConfiguration - - uid: sp-http.IAadHttpClientOptions.tokenProvider + - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' deprecated: content: '- AadHttpClient does not support a custom tokenProvider.' name: tokenProvider @@ -37,8 +37,8 @@ items: content: 'tokenProvider?: IAadTokenProvider;' return: type: - - sp-http.IAadTokenProvider - - uid: sp-http.IAadHttpClientOptions.useCachedToken + - '@microsoft/sp-http!IAadTokenProvider:interface' + - uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' summary: Allows the developer to specify if cached tokens should be use for the current request. isPreview: true name: useCachedToken @@ -51,3 +51,8 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + name: IAadTokenProviderConfiguration + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' + name: IAadTokenProvider diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 937a5a57..3ccc3d5c 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IAadTokenProvider + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' summary: >- This class allows a developer to obtain OAuth2 tokens from Azure AD. @@ -16,11 +16,11 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.IAadTokenProvider.getToken - - sp-http.IAadTokenProvider.tokenAcquisitionEvent - - uid: sp-http.IAadTokenProvider.getToken + - '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' + - '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' + - uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. @@ -36,7 +36,7 @@ items: content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' return: type: - - Promise + - '@microsoft/sp-http!IAadTokenProvider#getToken~0:complex' description: A promise that will be fullfiled with the token or that will reject with an error message parameters: - id: resourceEndpoint @@ -47,7 +47,7 @@ items: description: Allows the developer to specify if cached tokens should be returned. type: - boolean - - uid: sp-http.IAadTokenProvider.tokenAcquisitionEvent + - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' summary: Notifies the developer when Token Acquistion requires user action. name: tokenAcquisitionEvent fullName: tokenAcquisitionEvent @@ -58,4 +58,28 @@ items: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: type: - - SPEvent + - '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent~0:complex' +references: + - uid: '@microsoft/sp-http!IAadTokenProvider#getToken~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + name: ITokenAcquisitionEventArgs + fullName: ITokenAcquisitionEventArgs + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index a72b133a..f28d96f7 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -1,22 +1,22 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IAadTokenProviderConfiguration + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' summary: Required strings for constructing an AadTokenProvider. name: IAadTokenProviderConfiguration fullName: IAadTokenProviderConfiguration langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.IAadTokenProviderConfiguration.aadInstanceUrl - - sp-http.IAadTokenProviderConfiguration.aadTenantId - - sp-http.IAadTokenProviderConfiguration.aadUserId - - sp-http.IAadTokenProviderConfiguration.redirectUri - - sp-http.IAadTokenProviderConfiguration.servicePrincipalId - - sp-http.IAadTokenProviderConfiguration.userEmail - - sp-http.IAadTokenProviderConfiguration.userPrincipalName - - uid: sp-http.IAadTokenProviderConfiguration.aadInstanceUrl + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. name: aadInstanceUrl fullName: aadInstanceUrl @@ -28,7 +28,7 @@ items: return: type: - string - - uid: sp-http.IAadTokenProviderConfiguration.aadTenantId + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' summary: The Azure Active Directory's tenant id. name: aadTenantId fullName: aadTenantId @@ -40,7 +40,7 @@ items: return: type: - string - - uid: sp-http.IAadTokenProviderConfiguration.aadUserId + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' summary: >- The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user. @@ -54,7 +54,7 @@ items: return: type: - string - - uid: sp-http.IAadTokenProviderConfiguration.redirectUri + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' summary: >- The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris. @@ -68,7 +68,7 @@ items: return: type: - string - - uid: sp-http.IAadTokenProviderConfiguration.servicePrincipalId + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' summary: The client ID of the developer's Azure Active Directory application. name: servicePrincipalId fullName: servicePrincipalId @@ -80,7 +80,7 @@ items: return: type: - string - - uid: sp-http.IAadTokenProviderConfiguration.userEmail + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' summary: >- The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens. @@ -96,7 +96,7 @@ items: return: type: - string - - uid: sp-http.IAadTokenProviderConfiguration.userPrincipalName + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' summary: >- The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index f3e79ff7..3244b37c 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IDigestCache + - uid: '@microsoft/sp-http!IDigestCache:interface' summary: >- IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, @@ -15,13 +15,13 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.IDigestCache.addDigestToCache - - sp-http.IDigestCache.clearAllDigests - - sp-http.IDigestCache.clearDigest - - sp-http.IDigestCache.fetchDigest - - uid: sp-http.IDigestCache.addDigestToCache + - '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' + - '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' + - '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' + - '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' + - uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios @@ -55,7 +55,7 @@ items: example, to specify an expiration "5 seconds from right now", use performance.now()+5000. type: - number - - uid: sp-http.IDigestCache.clearAllDigests + - uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' summary: Clears all values from the cache. name: clearAllDigests() fullName: clearAllDigests() @@ -68,7 +68,7 @@ items: type: - void description: '' - - uid: sp-http.IDigestCache.clearDigest + - uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' summary: >- Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. @@ -88,7 +88,7 @@ items: description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. type: - string - - uid: sp-http.IDigestCache.fetchDigest + - uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' summary: >- Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the @@ -102,10 +102,20 @@ items: content: 'fetchDigest(webUrl: string): Promise;' return: type: - - Promise + - '@microsoft/sp-http!IDigestCache#fetchDigest~0:complex' description: A promise that is fulfilled with the digest value. parameters: - id: webUrl description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. type: - string +references: + - uid: '@microsoft/sp-http!IDigestCache#fetchDigest~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index a702a6bd..5e5dae70 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -1,10 +1,10 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IHttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' summary: Flags interface for HttpClientConfiguration. name: IHttpClientConfiguration fullName: IHttpClientConfiguration langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 66ac6805..2bc42ed5 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IHttpClientConfigurations + - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' summary: Standard configurations for HttpClient. remarks: >- This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In @@ -13,10 +13,10 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.IHttpClientConfigurations.v1 - - uid: sp-http.IHttpClientConfigurations.v1 + - '@microsoft/sp-http!IHttpClientConfigurations#v1:member' + - uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' summary: >- This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ @@ -29,4 +29,7 @@ items: content: 'readonly v1: HttpClientConfiguration;' return: type: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index 55c85217..49fc4ffc 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.IHttpClientOptions + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' summary: Options for HttpClient remarks: >- This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based @@ -11,5 +11,10 @@ items: - typeScript type: interface extends: - - 'RequestInit ' - package: sp-http + - '!RequestInit:interface' + inheritance: + - type: '!RequestInit:interface' + package: '@microsoft/sp-http!' +references: + - uid: '!RequestInit:interface' + name: RequestInit diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index b7407467..fbff5992 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' summary: Flags interface for SPHttpClientBatchConfiguration. isPreview: true name: ISPHttpClientBatchConfiguration @@ -9,5 +9,14 @@ items: - typeScript type: interface extends: - - sp-http.ISPHttpClientCommonConfiguration - package: sp-http + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' +references: + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 1a3db2a8..2e88baac 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientBatchConfigurations + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' summary: Standard configurations for SPHttpClient. remarks: >- This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the @@ -14,10 +14,10 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.ISPHttpClientBatchConfigurations.v1 - - uid: sp-http.ISPHttpClientBatchConfigurations.v1 + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' isPreview: true name: v1 @@ -29,4 +29,7 @@ items: content: 'readonly v1: SPHttpClientBatchConfiguration;' return: type: - - sp-http.SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 9478aaee..77834e6d 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientBatchCreationOptions + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. isPreview: true name: ISPHttpClientBatchCreationOptions @@ -8,10 +8,10 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.ISPHttpClientBatchCreationOptions.webUrl - - uid: sp-http.ISPHttpClientBatchCreationOptions.webUrl + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' summary: >- SPHttpClientBatch will need to perform its POST to an endpoint such as "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 01bef9dd..422829a6 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientBatchOptions + - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' summary: >- This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ @@ -11,5 +11,14 @@ items: - typeScript type: interface extends: - - sp-http.IHttpClientOptions - package: sp-http + - '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '!RequestInit:interface' + package: '@microsoft/sp-http!' +references: + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '!RequestInit:interface' + name: RequestInit diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index ec8fdf96..cff46a69 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' summary: Flags interface for SPHttpClientCommonConfiguration name: ISPHttpClientCommonConfiguration fullName: ISPHttpClientCommonConfiguration @@ -8,12 +8,14 @@ items: - typeScript type: interface extends: - - sp-http.IHttpClientConfiguration - package: sp-http + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.ISPHttpClientCommonConfiguration.jsonRequest - - sp-http.ISPHttpClientCommonConfiguration.jsonResponse - - uid: sp-http.ISPHttpClientCommonConfiguration.jsonRequest + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' summary: Automatically configure the "Content-Type" header for a JSON payload. remarks: >- When this switch is true: @@ -37,7 +39,7 @@ items: return: type: - boolean - - uid: sp-http.ISPHttpClientCommonConfiguration.jsonResponse + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' summary: Automatically configure the "Accept" header for a JSON payload. remarks: |- When this switch is true: @@ -57,3 +59,6 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index e3b218ae..769ca429 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' summary: Flags interface for SPHttpClientConfiguration. name: ISPHttpClientConfiguration fullName: ISPHttpClientConfiguration @@ -8,13 +8,17 @@ items: - typeScript type: interface extends: - - sp-http.ISPHttpClientCommonConfiguration - package: sp-http + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.ISPHttpClientConfiguration.defaultODataVersion - - sp-http.ISPHttpClientConfiguration.defaultSameOriginCredentials - - sp-http.ISPHttpClientConfiguration.requestDigest - - uid: sp-http.ISPHttpClientConfiguration.defaultODataVersion + - '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' + - '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' + - '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' summary: Automatically configure the "OData-Version" header. remarks: >- When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the @@ -32,8 +36,8 @@ items: content: 'defaultODataVersion?: ODataVersion;' return: type: - - sp-http.ODataVersion - - uid: sp-http.ISPHttpClientConfiguration.defaultSameOriginCredentials + - '@microsoft/sp-http!default:class' + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' summary: Automatically configure the RequestInit.credentials. remarks: >- When this switch is true: @@ -54,7 +58,7 @@ items: return: type: - boolean - - uid: sp-http.ISPHttpClientConfiguration.requestDigest + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' summary: Automatically provide an "X-RequestDigest" header for authentication. remarks: >- When this switch is true: @@ -73,3 +77,10 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration + - uid: '@microsoft/sp-http!default:class' + name: ODataVersion diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 959e5405..8a319dc5 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientConfigurations + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' summary: Standard configurations for SPHttpClient. remarks: >- This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. @@ -13,10 +13,10 @@ items: langs: - typeScript type: interface - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.ISPHttpClientConfigurations.v1 - - uid: sp-http.ISPHttpClientConfigurations.v1 + - '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' summary: >- Version 1 enables these switches: @@ -32,4 +32,7 @@ items: content: 'readonly v1: SPHttpClientConfiguration;' return: type: - - sp-http.SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index a6d91187..7766f09b 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientOptions + - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' summary: >- This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ @@ -10,11 +10,15 @@ items: - typeScript type: interface extends: - - sp-http.IHttpClientOptions - package: sp-http + - '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '!RequestInit:interface' + package: '@microsoft/sp-http!' children: - - sp-http.ISPHttpClientOptions.webUrl - - uid: sp-http.ISPHttpClientOptions.webUrl + - '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' + - uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' summary: Configure the SPWeb URL for authentication. remarks: >- For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be @@ -32,3 +36,8 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '!RequestInit:interface' + name: RequestInit diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index 41253dc0..377c4481 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ITokenAcquisitionEventArgs + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' summary: Represents arguments used for raising a token acquisiton failure event. name: ITokenAcquisitionEventArgs fullName: ITokenAcquisitionEventArgs @@ -8,12 +8,14 @@ items: - typeScript type: interface extends: - - sp-core-library.SPEventArgs - package: sp-http + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' + package: '@microsoft/sp-http!' children: - - sp-http.ITokenAcquisitionEventArgs.message - - sp-http.ITokenAcquisitionEventArgs.redirectUrl - - uid: sp-http.ITokenAcquisitionEventArgs.message + - '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' + - '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' summary: The message returned from ADAL fails to retrieve a token from Azure AD. name: message fullName: message @@ -25,7 +27,7 @@ items: return: type: - string - - uid: sp-http.ITokenAcquisitionEventArgs.redirectUrl + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' summary: The url of the page for the end user to interact with Azure AD. name: redirectUrl fullName: redirectUrl @@ -37,3 +39,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 678194c8..0ba93d73 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.MSGraphClient + - uid: '@microsoft/sp-http!MSGraphClient:class' summary: MSGraphClient is used to perform REST calls against Microsoft Graph. remarks: >- The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class @@ -20,10 +20,10 @@ items: langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.MSGraphClient.api - - uid: sp-http.MSGraphClient.api + - '@microsoft/sp-http!MSGraphClient#api:member(1)' + - uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' summary: All calls to Microsoft Graph are chained together starting with the api function. remarks: >- Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* @@ -41,7 +41,7 @@ items: content: 'api(path: string, config?: Options): IGraphRequest;' return: type: - - IGraphRequest + - '@microsoft/sp-http!IGraphRequest:interface' description: '' parameters: - id: path @@ -51,4 +51,9 @@ items: - id: config description: Sets the configuration for this request. type: - - Options + - '@microsoft/microsoft-graph-client!Options:interface' +references: + - uid: '@microsoft/sp-http!IGraphRequest:interface' + name: IGraphRequest + - uid: '@microsoft/microsoft-graph-client!Options:interface' + name: Options diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 7b4bf1a0..e1ac3cc5 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.MSGraphClientFactory + - uid: '@microsoft/sp-http!MSGraphClientFactory:class' summary: >- Returns a preinitialized version of the MSGraphClient. For more information: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) @@ -12,11 +12,11 @@ items: langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.MSGraphClientFactory.getClient - - sp-http.MSGraphClientFactory.serviceKey - - uid: sp-http.MSGraphClientFactory.getClient + - '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' + - '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' summary: >- Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. @@ -29,9 +29,9 @@ items: content: 'getClient(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' description: '' - - uid: sp-http.MSGraphClientFactory.serviceKey + - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' summary: The service key for MSGraphClientFactory. name: serviceKey fullName: serviceKey @@ -42,4 +42,33 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-http!MSGraphClientFactory.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: MSGraphClient + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: MSGraphClientFactory + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 45af5730..cd0d6142 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -1,19 +1,19 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ODataVersion + - uid: '@microsoft/sp-http!ODataVersion:class' summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' name: ODataVersion fullName: ODataVersion langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.ODataVersion.toString - - sp-http.ODataVersion.tryParseFromHeaders - - sp-http.ODataVersion.v3 - - sp-http.ODataVersion.v4 - - uid: sp-http.ODataVersion.toString + - '@microsoft/sp-http!ODataVersion#toString:member(1)' + - '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' + - '@microsoft/sp-http!ODataVersion.v3:member' + - '@microsoft/sp-http!ODataVersion.v4:member' + - uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' summary: 'Returns the "OData-Version" value, for example "4.0".' name: toString() fullName: toString() @@ -26,7 +26,7 @@ items: type: - string description: '' - - uid: sp-http.ODataVersion.tryParseFromHeaders + - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' summary: Attempt to parse the "OData-Version" header. remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown @@ -40,14 +40,14 @@ items: content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' return: type: - - ODataVersion | undefined + - '@microsoft/sp-http!ODataVersion.tryParseFromHeaders~0:complex' description: '' parameters: - id: headers description: '' type: - - Headers - - uid: sp-http.ODataVersion.v3 + - '!Headers:interface' + - uid: '@microsoft/sp-http!ODataVersion.v3:member' summary: Represents version 3.0 for the "OData-Version" header name: v3 fullName: v3 @@ -58,8 +58,8 @@ items: content: 'static v3: ODataVersion;' return: type: - - sp-http.ODataVersion - - uid: sp-http.ODataVersion.v4 + - '@microsoft/sp-http!default:class' + - uid: '@microsoft/sp-http!ODataVersion.v4:member' summary: Represents version 4.0 for the "OData-Version" header name: v4 fullName: v4 @@ -70,4 +70,18 @@ items: content: 'static v4: ODataVersion;' return: type: - - sp-http.ODataVersion + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders~0:complex' + name: ODataVersion | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-http!default:class' + name: ODataVersion + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '!Headers:interface' + name: Headers + - uid: '@microsoft/sp-http!default:class' + name: ODataVersion diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index f87696cf..912b3184 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -1,29 +1,31 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClient + - uid: '@microsoft/sp-http!SPHttpClient:class' summary: >- SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for writes, and collects telemetry that helps the service to monitor the performance of an application. - remarks: |- + remarks: >- This class is marked as `@sealed`. Subclasses should not extend it. - For communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class. + + For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) + class. name: SPHttpClient fullName: SPHttpClient langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpClient.(constructor) - - sp-http.SPHttpClient.beginBatch - - sp-http.SPHttpClient.configurations - - sp-http.SPHttpClient.fetch - - sp-http.SPHttpClient.get - - sp-http.SPHttpClient.getWebUrlFromRequestUrl - - sp-http.SPHttpClient.post - - sp-http.SPHttpClient.serviceKey - - uid: sp-http.SPHttpClient.(constructor) + - '@microsoft/sp-http!SPHttpClient:constructor(1)' + - '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' + - '@microsoft/sp-http!SPHttpClient.configurations:member' + - '@microsoft/sp-http!SPHttpClient#fetch:member(1)' + - '@microsoft/sp-http!SPHttpClient#get:member(1)' + - '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' + - '@microsoft/sp-http!SPHttpClient#post:member(1)' + - '@microsoft/sp-http!SPHttpClient.serviceKey:member' + - uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' summary: Constructs a new instance of the `SPHttpClient` class name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) @@ -36,8 +38,8 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-http.SPHttpClient.beginBatch + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' isPreview: true name: beginBatch(batchCreationOptions) @@ -49,14 +51,16 @@ items: content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' return: type: - - sp-http.SPHttpClientBatch - description: 'An [SPHttpClientBatch](xref:sp-http.SPHttpClientBatch) object used to manage the batch operation.' + - '@microsoft/sp-http!default:class' + description: >- + An [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) object used to manage the batch + operation. parameters: - id: batchCreationOptions description: '' type: - - sp-http.ISPHttpClientBatchCreationOptions - - uid: sp-http.SPHttpClient.configurations + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - uid: '@microsoft/sp-http!SPHttpClient.configurations:member' summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. name: configurations fullName: configurations @@ -67,8 +71,8 @@ items: content: 'static readonly configurations: ISPHttpClientConfigurations;' return: type: - - sp-http.ISPHttpClientConfigurations - - uid: sp-http.SPHttpClient.fetch + - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' summary: Perform a REST service call. remarks: >- Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API @@ -89,7 +93,7 @@ items: For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be - obtained by issuing a seperate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the + obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. name: 'fetch(url, configuration, options)' @@ -103,12 +107,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!SPHttpClient#fetch~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -119,12 +123,12 @@ items: determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - sp-http.SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.ISPHttpClientOptions - - uid: sp-http.SPHttpClient.get + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' summary: 'Calls fetch(), but sets the method to "GET".' name: 'get(url, configuration, options)' fullName: 'get(url, configuration, options)' @@ -137,12 +141,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!SPHttpClient#get~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -153,12 +157,12 @@ items: determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - sp-http.SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.ISPHttpClientOptions - - uid: sp-http.SPHttpClient.getWebUrlFromRequestUrl + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' summary: Use a heuristic to infer the base URL for authentication. remarks: >- Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path @@ -188,7 +192,7 @@ items: description: The URL for a SharePoint REST service type: - string - - uid: sp-http.SPHttpClient.post + - uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' fullName: 'post(url, configuration, options)' @@ -201,12 +205,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!SPHttpClient#post~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -217,12 +221,12 @@ items: determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - sp-http.SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.ISPHttpClientOptions - - uid: sp-http.SPHttpClient.serviceKey + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' summary: The service key for SPHttpClient. name: serviceKey fullName: serviceKey @@ -233,4 +237,71 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@microsoft/sp-http!SPHttpClient.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatch + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + name: ISPHttpClientBatchCreationOptions + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + name: ISPHttpClientConfigurations + - uid: '@microsoft/sp-http!SPHttpClient#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' + name: ISPHttpClientOptions + - uid: '@microsoft/sp-http!SPHttpClient#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClient#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClient.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClient + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 0f4f6a9a..6dfa88c2 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClientBatch + - uid: '@microsoft/sp-http!SPHttpClientBatch:class' summary: >- The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html @@ -19,14 +19,14 @@ items: langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpClientBatch.configurations - - sp-http.SPHttpClientBatch.execute - - sp-http.SPHttpClientBatch.fetch - - sp-http.SPHttpClientBatch.get - - sp-http.SPHttpClientBatch.post - - uid: sp-http.SPHttpClientBatch.configurations + - '@microsoft/sp-http!SPHttpClientBatch.configurations:member' + - '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' + - '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' + - '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' + - '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' + - uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. isPreview: true name: configurations @@ -38,8 +38,8 @@ items: content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: type: - - sp-http.ISPHttpClientBatchConfigurations - - uid: sp-http.SPHttpClientBatch.execute + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). isPreview: true name: execute() @@ -51,9 +51,9 @@ items: content: 'execute(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!SPHttpClientBatch#execute~0:complex' description: '' - - uid: sp-http.SPHttpClientBatch.fetch + - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' summary: >- Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed). @@ -84,12 +84,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!SPHttpClientBatch#fetch~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -100,12 +100,12 @@ items: determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - sp-http.SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.ISPHttpClientBatchOptions - - uid: sp-http.SPHttpClientBatch.get + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' summary: 'Calls fetch(), but sets the method to ''GET''.' isPreview: true name: 'get(url, configuration, options)' @@ -119,12 +119,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!SPHttpClientBatch#get~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -135,12 +135,12 @@ items: determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - sp-http.SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.ISPHttpClientBatchOptions - - uid: sp-http.SPHttpClientBatch.post + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' summary: 'Calls fetch(), but sets the method to ''POST''.' isPreview: true name: 'post(url, configuration, options)' @@ -154,12 +154,12 @@ items: Promise; return: type: - - Promise + - '@microsoft/sp-http!SPHttpClientBatch#post~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:sp-http.HttpClientResponse.ok) being false) for error status codes such as HTTP - 404 or 500. The promise will only reject for network failures or other errors that prevent communication with - the server. + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch @@ -170,8 +170,71 @@ items: determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - sp-http.SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' - id: options description: additional options that affect the request type: - - sp-http.ISPHttpClientBatchOptions + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' +references: + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + name: ISPHttpClientBatchConfigurations + - uid: '@microsoft/sp-http!SPHttpClientBatch#execute~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatch + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + name: ISPHttpClientBatchOptions + - uid: '@microsoft/sp-http!SPHttpClientBatch#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClientBatch#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index ddd08ad4..42070683 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' summary: Configuration for SPHttpClientBatch. remarks: >- The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of @@ -14,16 +14,18 @@ items: - typeScript type: class extends: - - sp-http.SPHttpClientCommonConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - sp-http.ISPHttpClientBatchConfiguration - package: sp-http + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpClientBatchConfiguration.(constructor) - - sp-http.SPHttpClientBatchConfiguration.flags - - sp-http.SPHttpClientBatchConfiguration.initializeFlags - - sp-http.SPHttpClientBatchConfiguration.overrideWith - - uid: sp-http.SPHttpClientBatchConfiguration.(constructor) + - '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' summary: >- Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -39,12 +41,12 @@ items: - id: flags description: '' type: - - sp-http.ISPHttpClientBatchConfiguration + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - id: overrideFlags description: '' type: - - sp-http.ISPHttpClientBatchConfiguration - - uid: sp-http.SPHttpClientBatchConfiguration.flags + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' isPreview: true name: flags fullName: flags @@ -55,8 +57,8 @@ items: content: 'protected flags: ISPHttpClientBatchConfiguration;' return: type: - - sp-http.ISPHttpClientBatchConfiguration - - uid: sp-http.SPHttpClientBatchConfiguration.initializeFlags + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' isPreview: true name: initializeFlags() fullName: initializeFlags() @@ -71,7 +73,7 @@ items: type: - void description: '' - - uid: sp-http.SPHttpClientBatchConfiguration.overrideWith + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' isPreview: true name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) @@ -84,10 +86,15 @@ items: overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; return: type: - - sp-http.SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - sp-http.ISPHttpClientBatchConfiguration + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + name: ISPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 7968098f..d29ea6e5 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. name: SPHttpClientCommonConfiguration fullName: SPHttpClientCommonConfiguration @@ -8,18 +8,20 @@ items: - typeScript type: class extends: - - sp-http.HttpClientConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - sp-http.ISPHttpClientCommonConfiguration - package: sp-http + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpClientCommonConfiguration.(constructor) - - sp-http.SPHttpClientCommonConfiguration.flags - - sp-http.SPHttpClientCommonConfiguration.initializeFlags - - sp-http.SPHttpClientCommonConfiguration.jsonRequest - - sp-http.SPHttpClientCommonConfiguration.jsonResponse - - sp-http.SPHttpClientCommonConfiguration.overrideWith - - uid: sp-http.SPHttpClientCommonConfiguration.(constructor) + - '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it @@ -35,12 +37,12 @@ items: - id: flags description: '' type: - - sp-http.ISPHttpClientCommonConfiguration + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - id: overrideFlags description: '' type: - - sp-http.ISPHttpClientCommonConfiguration - - uid: sp-http.SPHttpClientCommonConfiguration.flags + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' name: flags fullName: flags langs: @@ -50,8 +52,8 @@ items: content: 'protected flags: ISPHttpClientCommonConfiguration;' return: type: - - sp-http.ISPHttpClientCommonConfiguration - - uid: sp-http.SPHttpClientCommonConfiguration.initializeFlags + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' name: initializeFlags() fullName: initializeFlags() langs: @@ -65,7 +67,7 @@ items: type: - void description: '' - - uid: sp-http.SPHttpClientCommonConfiguration.jsonRequest + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' summary: Automatically configure the "Content-Type" header for a JSON payload. remarks: >- When this switch is true: @@ -89,7 +91,7 @@ items: return: type: - boolean - - uid: sp-http.SPHttpClientCommonConfiguration.jsonResponse + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' summary: Automatically configure the "Accept" header for a JSON payload. remarks: |- When this switch is true: @@ -109,7 +111,7 @@ items: return: type: - boolean - - uid: sp-http.SPHttpClientCommonConfiguration.overrideWith + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) langs: @@ -121,10 +123,15 @@ items: overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; return: type: - - sp-http.SPHttpClientCommonConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - sp-http.ISPHttpClientCommonConfiguration + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index d43ed090..7074ce51 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -1,7 +1,7 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClientConfiguration - summary: 'Configuration for [SPHttpClient](xref:sp-http.SPHttpClient).' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' + summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' remarks: >- The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of @@ -13,19 +13,21 @@ items: - typeScript type: class extends: - - sp-http.SPHttpClientCommonConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - sp-http.ISPHttpClientConfiguration - package: sp-http + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpClientConfiguration.(constructor) - - sp-http.SPHttpClientConfiguration.defaultODataVersion - - sp-http.SPHttpClientConfiguration.defaultSameOriginCredentials - - sp-http.SPHttpClientConfiguration.flags - - sp-http.SPHttpClientConfiguration.initializeFlags - - sp-http.SPHttpClientConfiguration.overrideWith - - sp-http.SPHttpClientConfiguration.requestDigest - - uid: sp-http.SPHttpClientConfiguration.(constructor) + - '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' + - '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' + - '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' + - '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' + - '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' + - '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' summary: >- Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -40,12 +42,12 @@ items: - id: flags description: '' type: - - sp-http.ISPHttpClientConfiguration + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - id: overrideFlags description: '' type: - - sp-http.ISPHttpClientConfiguration - - uid: sp-http.SPHttpClientConfiguration.defaultODataVersion + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' summary: Automatically configure the "OData-Version" header. remarks: >- When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the @@ -63,8 +65,8 @@ items: content: 'readonly defaultODataVersion: ODataVersion;' return: type: - - sp-http.ODataVersion - - uid: sp-http.SPHttpClientConfiguration.defaultSameOriginCredentials + - '@microsoft/sp-http!default:class' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' summary: Automatically configure the RequestInit.credentials. remarks: >- When this switch is true: @@ -85,7 +87,7 @@ items: return: type: - boolean - - uid: sp-http.SPHttpClientConfiguration.flags + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' name: flags fullName: flags langs: @@ -95,8 +97,8 @@ items: content: 'protected flags: ISPHttpClientConfiguration;' return: type: - - sp-http.ISPHttpClientConfiguration - - uid: sp-http.SPHttpClientConfiguration.initializeFlags + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' name: initializeFlags() fullName: initializeFlags() langs: @@ -110,7 +112,7 @@ items: type: - void description: '' - - uid: sp-http.SPHttpClientConfiguration.overrideWith + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) langs: @@ -122,14 +124,14 @@ items: overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; return: type: - - sp-http.SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - sp-http.ISPHttpClientConfiguration - - uid: sp-http.SPHttpClientConfiguration.requestDigest + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' summary: Automatically provide an "X-RequestDigest" header for authentication. remarks: >- When this switch is true: @@ -148,3 +150,8 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + name: ISPHttpClientConfiguration diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index 143c6982..d361054b 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClientResponse + - uid: '@microsoft/sp-http!SPHttpClientResponse:class' summary: The Response subclass returned by methods such as SPHttpClient.fetch(). remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. @@ -12,13 +12,15 @@ items: - typeScript type: class extends: - - sp-http.HttpClientResponse - package: sp-http + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpClientResponse.(constructor) - - sp-http.SPHttpClientResponse.clone - - sp-http.SPHttpClientResponse.correlationId - - uid: sp-http.SPHttpClientResponse.(constructor) + - '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' + - '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' + - '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' + - uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' summary: Constructs a new instance of the `SPHttpClientResponse` class name: (constructor)(response) fullName: (constructor)(response) @@ -31,8 +33,8 @@ items: - id: response description: '' type: - - Response - - uid: sp-http.SPHttpClientResponse.clone + - '!Response:interface' + - uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' name: clone() fullName: clone() langs: @@ -44,9 +46,9 @@ items: clone(): SPHttpClientResponse; return: type: - - sp-http.SPHttpClientResponse + - '@microsoft/sp-http!default:class' description: '' - - uid: sp-http.SPHttpClientResponse.correlationId + - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' summary: Returns the SharePoint correlation ID. remarks: >- The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, @@ -62,4 +64,18 @@ items: content: 'readonly correlationId: Guid | undefined;' return: type: - - Guid | undefined + - '@microsoft/sp-http!SPHttpClientResponse#correlationId~0:complex' +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + - uid: '!Response:interface' + name: Response + - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId~0:complex' + name: Guid | undefined + fullName: Guid | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + fullName: Guid + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 63464a21..45eb0a18 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpHeader - summary: 'Standard HTTP headers used with [SPHttpClient](xref:sp-http.SPHttpClient)' + - uid: '@microsoft/sp-http!SPHttpHeader:enum' + summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' isPreview: true name: SPHttpHeader fullName: SPHttpHeader langs: - typeScript type: enum - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.SPHttpHeader.SPRequestGuid - - uid: sp-http.SPHttpHeader.SPRequestGuid + - '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' + - uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' summary: |- SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request. diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 139a8053..dda6fa0c 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.TokenAcquisitionEventArgs + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' summary: Arguments for a token acquisition failure event. name: TokenAcquisitionEventArgs fullName: TokenAcquisitionEventArgs @@ -8,13 +8,15 @@ items: - typeScript type: class extends: - - sp-core-library.SPEventArgs - package: sp-http + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' + package: '@microsoft/sp-http!' children: - - sp-http.TokenAcquisitionEventArgs.(constructor) - - sp-http.TokenAcquisitionEventArgs.message - - sp-http.TokenAcquisitionEventArgs.redirectUrl - - uid: sp-http.TokenAcquisitionEventArgs.(constructor) + - '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' + - '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' + - '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class name: '(constructor)(message, redirectUrl)' fullName: '(constructor)(message, redirectUrl)' @@ -32,7 +34,7 @@ items: description: '' type: - string - - uid: sp-http.TokenAcquisitionEventArgs.message + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' summary: The message returned from ADAL fails to retrieve a token from Azure AD. name: message fullName: message @@ -44,7 +46,7 @@ items: return: type: - string - - uid: sp-http.TokenAcquisitionEventArgs.redirectUrl + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' summary: The url of the page for the end user to perform Multi Factor Authentication name: redirectUrl fullName: redirectUrl @@ -56,3 +58,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs diff --git a/SP-Framework/sp-list-subscription.yml b/SP-Framework/sp-list-subscription.yml new file mode 100644 index 00000000..ae4dffc5 --- /dev/null +++ b/SP-Framework/sp-list-subscription.yml @@ -0,0 +1,26 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!' + summary: This package provides developer support for subscribing to changes in a SharePoint document library. + remarks: >- + This package creates and manages subscriptions to SharePoint document libraries. It registers callbacks provided + by the developer with the subscription to handle subscription events. + name: '@microsoft/sp-list-subscription' + fullName: '@microsoft/sp-list-subscription' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - '@microsoft/sp-list-subscription!IListSubscription:interface' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' +references: + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + name: ICreateSubscriptionSettings + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + name: IListSubscription + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + name: ISubscriptionCallbacks + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' + name: ListSubscriptionFactory diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml new file mode 100644 index 00000000..35db81df --- /dev/null +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -0,0 +1,92 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + summary: >- + A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a + web, you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you + will need to provide it as well. + + + In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, + and the current domain, site and web will be used. + name: ICreateSubscriptionSettings + fullName: ICreateSubscriptionSettings + langs: + - typeScript + type: interface + package: '@microsoft/sp-list-subscription!' + children: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' + summary: the list of callbacks + name: callbacks + fullName: callbacks + langs: + - typeScript + type: property + syntax: + content: 'callbacks: ISubscriptionCallbacks;' + return: + type: + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' + summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' + name: domain + fullName: domain + langs: + - typeScript + type: property + syntax: + content: 'domain?: string;' + return: + type: + - string + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' + summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' + name: listId + fullName: listId + langs: + - typeScript + type: property + syntax: + content: 'listId?: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' + summary: >- + The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current + site will be used. + name: siteId + fullName: siteId + langs: + - typeScript + type: property + syntax: + content: 'siteId?: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' + summary: >- + The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web + will be used. + name: webId + fullName: webId + langs: + - typeScript + type: property + syntax: + content: 'webId?: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' +references: + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + name: ISubscriptionCallbacks + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml new file mode 100644 index 00000000..94f11568 --- /dev/null +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -0,0 +1,27 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + summary: A subscription to a SharePoint list resource. Contains the id of the subscription. + name: IListSubscription + fullName: IListSubscription + langs: + - typeScript + type: interface + package: '@microsoft/sp-list-subscription!' + children: + - '@microsoft/sp-list-subscription!IListSubscription#id:member' + - uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' + summary: The id of the subscription. + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml new file mode 100644 index 00000000..fcac1ebc --- /dev/null +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -0,0 +1,50 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + summary: The callbacks that can be triggered by a subscription event. + name: ISubscriptionCallbacks + fullName: ISubscriptionCallbacks + langs: + - typeScript + type: interface + package: '@microsoft/sp-list-subscription!' + children: + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' + summary: The callback to invoke when a connection has been made to the list. + name: connect + fullName: connect + langs: + - typeScript + type: property + syntax: + content: 'connect?: () => void;' + return: + type: + - () => void + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' + summary: The callback to invoke when the subscription is disconnected from the list. + name: disconnect + fullName: disconnect + langs: + - typeScript + type: property + syntax: + content: 'disconnect?: (reason: string) => void;' + return: + type: + - '(reason: string) => void' + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' + summary: The callback to invoke when a change occurs in the list. + name: notification + fullName: notification + langs: + - typeScript + type: property + syntax: + content: 'notification: () => void;' + return: + type: + - () => void diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml new file mode 100644 index 00000000..ee5bce50 --- /dev/null +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -0,0 +1,87 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' + summary: >- + Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the + subscription to handle subscription events. + name: ListSubscriptionFactory + fullName: ListSubscriptionFactory + langs: + - typeScript + type: class + package: '@microsoft/sp-list-subscription!' + children: + - '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' + - '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' + - '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' + summary: Constructs a new instance of the `ListSubscriptionFactory` class + name: (constructor)(component) + fullName: (constructor)(component) + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(component: BaseComponent);' + parameters: + - id: component + description: '' + type: + - '@microsoft/sp-component-base!BaseComponent:class' + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' + summary: Creates a connection to the list specified by the site id and list id. + name: createSubscription(settings) + fullName: createSubscription(settings) + langs: + - typeScript + type: method + syntax: + content: 'createSubscription(settings: ICreateSubscriptionSettings): Promise;' + return: + type: + - '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription~0:complex' + description: Promise of the subscription to the list. + parameters: + - id: settings + description: The various parameters + type: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' + summary: Deletes the subscription's connection to the resource. + name: deleteSubscription(subscription) + fullName: deleteSubscription(subscription) + langs: + - typeScript + type: method + syntax: + content: 'deleteSubscription(subscription: IListSubscription): void;' + return: + type: + - void + description: '' + parameters: + - id: subscription + description: The subscription to delete. + type: + - '@microsoft/sp-list-subscription!IListSubscription:interface' +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + name: IListSubscription + fullName: IListSubscription + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + name: ICreateSubscriptionSettings + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + name: IListSubscription diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index 0982ff09..c8f37945 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility + - uid: '@microsoft/sp-listview-extensibility!' summary: SharePoint Framework support for customizing the list view. name: '@microsoft/sp-listview-extensibility' fullName: '@microsoft/sp-listview-extensibility' @@ -8,43 +8,43 @@ items: - typeScript type: package children: - - sp-listview-extensibility.BaseFieldCustomizer - - sp-listview-extensibility.BaseListViewCommandSet - - sp-listview-extensibility.ColumnAccessor - - sp-listview-extensibility.Command - - sp-listview-extensibility.FieldCustomizerContext - - sp-listview-extensibility.IFieldCustomizerCellEventParameters - - sp-listview-extensibility.IListViewCommandSetExecuteEventParameters - - sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters - - sp-listview-extensibility.ListItemAccessor - - sp-listview-extensibility.ListViewAccessor - - sp-listview-extensibility.ListViewCommandSetContext - - sp-listview-extensibility.RowAccessor - - sp-listview-extensibility.SelectedRowsChangedEventArgs + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + - '@microsoft/sp-listview-extensibility!Command:class' + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - '@microsoft/sp-listview-extensibility!RowAccessor:class' + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' references: - - uid: sp-listview-extensibility.BaseFieldCustomizer + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' name: BaseFieldCustomizer - - uid: sp-listview-extensibility.BaseListViewCommandSet + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' name: BaseListViewCommandSet - - uid: sp-listview-extensibility.ColumnAccessor + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' name: ColumnAccessor - - uid: sp-listview-extensibility.Command + - uid: '@microsoft/sp-listview-extensibility!Command:class' name: Command - - uid: sp-listview-extensibility.FieldCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' name: FieldCustomizerContext - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' name: IFieldCustomizerCellEventParameters - - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' name: IListViewCommandSetExecuteEventParameters - - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' name: IListViewCommandSetListViewUpdatedParameters - - uid: sp-listview-extensibility.ListItemAccessor + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' name: ListItemAccessor - - uid: sp-listview-extensibility.ListViewAccessor + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' name: ListViewAccessor - - uid: sp-listview-extensibility.ListViewCommandSetContext + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' name: ListViewCommandSetContext - - uid: sp-listview-extensibility.RowAccessor + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' name: RowAccessor - - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' name: SelectedRowsChangedEventArgs diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index feb7d2db..eab3d73a 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.BaseFieldCustomizer + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' summary: >- This is the base class that third parties should extend when implementing a client-side extension that customizes the appearance of fields in a SharePoint ListView. @@ -13,13 +13,15 @@ items: - typeScript type: class extends: - - 'BaseExtension ' - package: sp-listview-extensibility + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~0:complex' + inheritance: + - type: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~1:complex' + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.BaseFieldCustomizer.context - - sp-listview-extensibility.BaseFieldCustomizer.onDisposeCell - - sp-listview-extensibility.BaseFieldCustomizer.onRenderCell - - uid: sp-listview-extensibility.BaseFieldCustomizer.context + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a @@ -34,8 +36,8 @@ items: content: 'protected readonly context: FieldCustomizerContext;' return: type: - - sp-listview-extensibility.FieldCustomizerContext - - uid: sp-listview-extensibility.BaseFieldCustomizer.onDisposeCell + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' name: onDisposeCell(event) fullName: onDisposeCell(event) langs: @@ -51,8 +53,8 @@ items: - id: event description: '' type: - - sp-listview-extensibility.IFieldCustomizerCellEventParameters - - uid: sp-listview-extensibility.BaseFieldCustomizer.onRenderCell + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' name: onRenderCell(event) fullName: onRenderCell(event) langs: @@ -68,4 +70,27 @@ items: - id: event description: '' type: - - sp-listview-extensibility.IFieldCustomizerCellEventParameters + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' +references: + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~0:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~1:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: FieldCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + name: IFieldCustomizerCellEventParameters diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 50d67cf7..466f84a6 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.BaseListViewCommandSet + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' summary: >- This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view. @@ -16,14 +16,16 @@ items: - typeScript type: class extends: - - 'BaseExtension ' - package: sp-listview-extensibility + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~0:complex' + inheritance: + - type: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~1:complex' + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.BaseListViewCommandSet.context - - sp-listview-extensibility.BaseListViewCommandSet.onExecute - - sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated - - sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand - - uid: sp-listview-extensibility.BaseListViewCommandSet.context + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a @@ -38,8 +40,8 @@ items: content: 'readonly context: ListViewCommandSetContext;' return: type: - - sp-listview-extensibility.ListViewCommandSetContext - - uid: sp-listview-extensibility.BaseListViewCommandSet.onExecute + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' summary: 'This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item.' name: onExecute(event) fullName: onExecute(event) @@ -56,8 +58,8 @@ items: - id: event description: '' type: - - sp-listview-extensibility.IListViewCommandSetExecuteEventParameters - - uid: sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' summary: This event occurs whenever the ListView state changes. remarks: >- This event allows the implementor to tailor the appearance of the command. For example, to hide the command, @@ -77,8 +79,8 @@ items: - id: event description: '' type: - - sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters - - uid: sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' summary: Returns the command with the given id. Returns undefined if there is not command with the given id. name: tryGetCommand(id) fullName: tryGetCommand(id) @@ -89,10 +91,35 @@ items: content: 'tryGetCommand(id: string): Command;' return: type: - - sp-listview-extensibility.Command + - '@microsoft/sp-listview-extensibility!default:class' description: '' parameters: - id: id description: Id of the command type: - string +references: + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~0:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~1:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: ListViewCommandSetContext + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + name: IListViewCommandSetExecuteEventParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + name: IListViewCommandSetListViewUpdatedParameters diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index b59a5268..5947dc43 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.ColumnAccessor + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' summary: 'Provides access to a ListView column, which is the visual presentation of a field.' remarks: >- A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item @@ -17,11 +17,11 @@ items: langs: - typeScript type: class - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.ColumnAccessor.field - - sp-listview-extensibility.ColumnAccessor.visible - - uid: sp-listview-extensibility.ColumnAccessor.field + - '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' + - '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' summary: The server-side definition of the field. This property is read-only. name: field fullName: field @@ -32,8 +32,8 @@ items: content: 'abstract readonly field: SPField;' return: type: - - sp-page-context.SPField - - uid: sp-listview-extensibility.ColumnAccessor.visible + - '@microsoft/sp-page-context!SPField:class' + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' summary: Whether to show this column in the list view. This property is read-only. name: visible fullName: visible @@ -45,3 +45,6 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 57a02f46..26aafcde 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -1,12 +1,12 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.Command + - uid: '@microsoft/sp-listview-extensibility!Command:class' summary: Represents a command belonging to a command set. remarks: >- The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling - [BaseListViewCommandSet.tryGetCommand()](xref:sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. name: Command @@ -14,14 +14,14 @@ items: langs: - typeScript type: class - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.Command.ariaLabel - - sp-listview-extensibility.Command.iconImageUrl - - sp-listview-extensibility.Command.id - - sp-listview-extensibility.Command.title - - sp-listview-extensibility.Command.visible - - uid: sp-listview-extensibility.Command.ariaLabel + - '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' + - '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' + - '@microsoft/sp-listview-extensibility!Command#id:member' + - '@microsoft/sp-listview-extensibility!Command#title:member' + - '@microsoft/sp-listview-extensibility!Command#visible:member' + - uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' summary: >- Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." @@ -35,7 +35,7 @@ items: return: type: - string | undefined - - uid: sp-listview-extensibility.Command.iconImageUrl + - uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' summary: >- An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. @@ -50,7 +50,7 @@ items: return: type: - string | undefined - - uid: sp-listview-extensibility.Command.id + - uid: '@microsoft/sp-listview-extensibility!Command#id:member' summary: Id of the command. name: id fullName: id @@ -62,7 +62,7 @@ items: return: type: - string - - uid: sp-listview-extensibility.Command.title + - uid: '@microsoft/sp-listview-extensibility!Command#title:member' summary: 'A short label to be displayed by the associated button, menu item, etc.' remarks: >- Example: "Show information" @@ -82,7 +82,7 @@ items: return: type: - string - - uid: sp-listview-extensibility.Command.visible + - uid: '@microsoft/sp-listview-extensibility!Command#visible:member' summary: True if the command is visible. name: visible fullName: visible diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index c07a3a0d..1a95c9ec 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.FieldCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -11,12 +11,16 @@ items: - typeScript type: class extends: - - sp-extension-base.ExtensionContext - package: sp-listview-extensibility + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.FieldCustomizerContext.field - - sp-listview-extensibility.FieldCustomizerContext.tryGetListView - - uid: sp-listview-extensibility.FieldCustomizerContext.field + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' summary: Provides access to the SharePoint field that the customizer will operate on. name: field fullName: field @@ -27,8 +31,8 @@ items: content: 'readonly field: SPField;' return: type: - - sp-page-context.SPField - - uid: sp-listview-extensibility.FieldCustomizerContext.tryGetListView + - '@microsoft/sp-page-context!SPField:class' + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' summary: >- If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined. @@ -44,5 +48,21 @@ items: content: 'tryGetListView(): ListViewAccessor | undefined;' return: type: - - ListViewAccessor | undefined + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView~0:complex' description: 'the SharePoint list view, or undefined if there is none.' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView~0:complex' + name: ListViewAccessor | undefined + fullName: ListViewAccessor | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + name: ListViewAccessor + fullName: ListViewAccessor + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 1e17ebda..259f3c2e 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -1,19 +1,19 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' summary: Event parameters for BaseFieldCustomizer.onRenderCell() name: IFieldCustomizerCellEventParameters fullName: IFieldCustomizerCellEventParameters langs: - typeScript type: interface - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.IFieldCustomizerCellEventParameters.domElement - - sp-listview-extensibility.IFieldCustomizerCellEventParameters.fieldValue - - sp-listview-extensibility.IFieldCustomizerCellEventParameters.listItem - - sp-listview-extensibility.IFieldCustomizerCellEventParameters.userData - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.domElement + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' summary: >- The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. @@ -26,8 +26,8 @@ items: content: 'readonly domElement: HTMLDivElement;' return: type: - - HTMLDivElement - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.fieldValue + - '!HTMLDivElement:interface' + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' summary: The value of the field being rendered. name: fieldValue fullName: fieldValue @@ -39,7 +39,7 @@ items: return: type: - any - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.listItem + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' summary: The list item being edited. name: listItem fullName: listItem @@ -50,8 +50,8 @@ items: content: 'readonly listItem: ListItemAccessor;' return: type: - - sp-listview-extensibility.ListItemAccessor - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters.userData + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' summary: An implementation defined storage property. remarks: >- For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request @@ -67,3 +67,8 @@ items: return: type: - any +references: + - uid: '!HTMLDivElement:interface' + name: HTMLDivElement + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: ListItemAccessor diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index e5dac21e..2693be5e 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,19 +1,19 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' summary: >- Parameters for - [BaseListViewCommandSet.onExecute()](xref:sp-listview-extensibility.BaseListViewCommandSet.onExecute) + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)) name: IListViewCommandSetExecuteEventParameters fullName: IListViewCommandSetExecuteEventParameters langs: - typeScript type: interface - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.itemId - - sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.selectedRows - - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.itemId + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' summary: >- The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. @@ -27,7 +27,7 @@ items: return: type: - string - - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.selectedRows + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' summary: 'The currently selected ListView rows, at the time when the event occurred.' name: selectedRows fullName: selectedRows @@ -38,4 +38,19 @@ items: content: 'readonly selectedRows: ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows~0:complex' +references: + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 7f45f249..cde40dad 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -1,18 +1,18 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' summary: >- Parameters for - [BaseListViewCommandSet.onListViewUpdated()](xref:sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated) + [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)) name: IListViewCommandSetListViewUpdatedParameters fullName: IListViewCommandSetListViewUpdatedParameters langs: - typeScript type: interface - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters.selectedRows - - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters.selectedRows + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' summary: 'The currently selected ListView rows, at the time when the event occurred.' name: selectedRows fullName: selectedRows @@ -23,4 +23,19 @@ items: content: 'readonly selectedRows: ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows~0:complex' +references: + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index ba92f66f..d674d80e 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.ListItemAccessor + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' summary: >- When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated SharePoint list item. @@ -22,12 +22,12 @@ items: langs: - typeScript type: class - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.ListItemAccessor.fields - - sp-listview-extensibility.ListItemAccessor.getValue - - sp-listview-extensibility.ListItemAccessor.getValueByName - - uid: sp-listview-extensibility.ListItemAccessor.fields + - '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' + - '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' + - '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' summary: The SharePoint fields that are currently available in the editor for this list item. remarks: >- The set of available fields depends on the editing context. For example, if a list view column is hidden, the @@ -42,8 +42,8 @@ items: content: 'abstract readonly fields: ReadonlyArray;' return: type: - - ReadonlyArray - - uid: sp-listview-extensibility.ListItemAccessor.getValue + - '@microsoft/sp-listview-extensibility!ListItemAccessor#fields~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' summary: >- Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. @@ -62,8 +62,8 @@ items: - id: field description: '' type: - - sp-page-context.SPField - - uid: sp-listview-extensibility.ListItemAccessor.getValueByName + - '@microsoft/sp-page-context!SPField:class' + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' summary: >- Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. @@ -83,3 +83,20 @@ items: description: '' type: - string +references: + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField + fullName: SPField + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index e4375cd3..e52e10f8 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.ListViewAccessor + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' summary: Provides access to a SharePoint ListView control. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -10,12 +10,12 @@ items: langs: - typeScript type: class - package: sp-listview-extensibility + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.ListViewAccessor.columns - - sp-listview-extensibility.ListViewAccessor.selectedRowsChangedEvent - - sp-listview-extensibility.ListViewAccessor.tryGetColumnByName - - uid: sp-listview-extensibility.ListViewAccessor.columns + - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' summary: 'The columns in associated with this view, including hidden columns.' name: columns fullName: columns @@ -26,8 +26,8 @@ items: content: 'abstract readonly columns: ReadonlyArray;' return: type: - - ReadonlyArray - - uid: sp-listview-extensibility.ListViewAccessor.selectedRowsChangedEvent + - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' summary: Event that gets raised every time the selected items in the list view change. name: selectedRowsChangedEvent fullName: selectedRowsChangedEvent @@ -38,8 +38,8 @@ items: content: 'readonly selectedRowsChangedEvent: SPEvent;' return: type: - - SPEvent - - uid: sp-listview-extensibility.ListViewAccessor.tryGetColumnByName + - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' summary: >- Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. @@ -52,10 +52,48 @@ items: content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' return: type: - - ColumnAccessor | undefined + - '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName~0:complex' description: '' parameters: - id: internalName description: '' type: - string +references: + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + name: ColumnAccessor + fullName: ColumnAccessor + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + name: SelectedRowsChangedEventArgs + fullName: SelectedRowsChangedEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName~0:complex' + name: ColumnAccessor | undefined + fullName: ColumnAccessor | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + name: ColumnAccessor + fullName: ColumnAccessor + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index d30f8cef..2c1024ec 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.ListViewCommandSetContext + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or @@ -11,12 +11,16 @@ items: - typeScript type: class extends: - - sp-extension-base.ExtensionContext - package: sp-listview-extensibility + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.ListViewCommandSetContext.listView - - sp-listview-extensibility.ListViewCommandSetContext.manifest - - uid: sp-listview-extensibility.ListViewCommandSetContext.listView + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' summary: Provides access to the ListView control that the customizer will operate on. name: listView fullName: listView @@ -27,8 +31,8 @@ items: content: 'readonly listView: ListViewAccessor;' return: type: - - sp-listview-extensibility.ListViewAccessor - - uid: sp-listview-extensibility.ListViewCommandSetContext.manifest + - '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' summary: Manifest for the client-side component. name: manifest fullName: manifest @@ -39,4 +43,13 @@ items: content: 'readonly manifest: ICommandSetExtensionManifest;' return: type: - - ICommandSetExtensionManifest + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + name: ListViewAccessor + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + name: ICommandSetExtensionManifest diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 709c7fe8..90ecb9b7 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.RowAccessor + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' remarks: >- A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an @@ -19,5 +19,10 @@ items: - typeScript type: class extends: - - sp-listview-extensibility.ListItemAccessor - package: sp-listview-extensibility + - '@microsoft/sp-listview-extensibility!default:class' + inheritance: + - type: '@microsoft/sp-listview-extensibility!default:class' + package: '@microsoft/sp-listview-extensibility!' +references: + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: ListItemAccessor diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 8e43e00d..9388761f 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' summary: Arguments for the selected rows changed event. name: SelectedRowsChangedEventArgs fullName: SelectedRowsChangedEventArgs @@ -8,11 +8,13 @@ items: - typeScript type: class extends: - - sp-core-library.SPEventArgs - package: sp-listview-extensibility + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' + package: '@microsoft/sp-listview-extensibility!' children: - - sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows - - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' summary: The list of rows that were selected in the list view at the time when the event was fired. name: selectedRows fullName: selectedRows @@ -23,4 +25,21 @@ items: content: 'selectedRows: ReadonlyArray;' return: type: - - ReadonlyArray + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows~0:complex' +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-loader.yml b/SP-Framework/sp-loader.yml new file mode 100644 index 00000000..484f5bcb --- /dev/null +++ b/SP-Framework/sp-loader.yml @@ -0,0 +1,20 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-loader!' + summary: The SharePoint Framework loader + remarks: >- + Built on familiar standards such as RequireJS and WebPack, the loader is the first part of the SharePoint + Framework to load on a page. It manages versioning and loading of client-side components. + name: '@microsoft/sp-loader' + fullName: '@microsoft/sp-loader' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-loader!ILoadScriptOptions:interface' + - '@microsoft/sp-loader!SPComponentLoader:class' +references: + - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + name: ILoadScriptOptions + - uid: '@microsoft/sp-loader!SPComponentLoader:class' + name: SPComponentLoader diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml new file mode 100644 index 00000000..cee38bcc --- /dev/null +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -0,0 +1,24 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + summary: Options for the loadScript() method in ISPComponentLoader + name: ILoadScriptOptions + fullName: ILoadScriptOptions + langs: + - typeScript + type: interface + package: '@microsoft/sp-loader!' + children: + - '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' + - uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' + summary: 'If set, the loaded script will be stored in a global variable under this name.' + name: globalExportsName + fullName: globalExportsName + langs: + - typeScript + type: property + syntax: + content: 'globalExportsName?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml new file mode 100644 index 00000000..a7bffe30 --- /dev/null +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -0,0 +1,164 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-loader!SPComponentLoader:class' + summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. + name: SPComponentLoader + fullName: SPComponentLoader + langs: + - typeScript + type: class + package: '@microsoft/sp-loader!' + children: + - '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' + - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' + summary: Returns static copies of all the manifests. + name: getManifests() + fullName: getManifests() + langs: + - typeScript + type: method + syntax: + content: 'static getManifests(): IClientSideComponentManifest[];' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.getManifests~0:complex' + description: '' + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' + summary: Loads a component from a manifest. + name: loadComponent(manifest) + fullName: loadComponent(manifest) + langs: + - typeScript + type: method + syntax: + content: 'static loadComponent(manifest: IClientSideComponentManifest): Promise;' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.loadComponent~0:complex' + description: A promise containing the loaded module. + parameters: + - id: manifest + description: Manifest of the module to load. + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + typeParameters: + - id: TComponent + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' + summary: 'Resolve a component id and version, and load it.' + name: 'loadComponentById(id, version)' + fullName: 'loadComponentById(id, version)' + langs: + - typeScript + type: method + syntax: + content: 'static loadComponentById(id: string, version?: string): Promise;' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.loadComponentById~0:complex' + description: A promise containing the loaded module. + parameters: + - id: id + description: The id of the component to load. + type: + - string + - id: version + description: >- + The version of the component to load. If version is not defined, the method will load any version of the + component. + type: + - string + typeParameters: + - id: TComponent + - uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' + summary: Inserts a `` tag for a stylesheet. + name: loadCss(url) + fullName: loadCss(url) + langs: + - typeScript + type: method + syntax: + content: 'static loadCss(url: string): void;' + return: + type: + - void + description: '' + parameters: + - id: url + description: The CSS file URL. + type: + - string + - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' + summary: 'Given a URL, load a script.' + remarks: >- + If a script with a global variable is being loaded, the global variable already exists, and the script fails to + load (because of a syntax error, for example), the original global variable may be returned and an error may not + be propagated. + name: 'loadScript(url, options)' + fullName: 'loadScript(url, options)' + langs: + - typeScript + type: method + syntax: + content: 'static loadScript(url: string, options?: ILoadScriptOptions): Promise;' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.loadScript~0:complex' + description: A promise containing the loaded module. + parameters: + - id: url + description: The script URL. + type: + - string + - id: options + description: >- + globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the + global member's name. + type: + - '@microsoft/sp-loader!ILoadScriptOptions:interface' + typeParameters: + - id: TModule +references: + - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests~0:complex' + name: 'IClientSideComponentManifest[]' + fullName: 'IClientSideComponentManifest[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + fullName: IClientSideComponentManifest + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + name: ILoadScriptOptions diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml new file mode 100644 index 00000000..11bdd3bf --- /dev/null +++ b/SP-Framework/sp-lodash-subset.yml @@ -0,0 +1,38 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-lodash-subset!' + name: '@microsoft/sp-lodash-subset' + fullName: '@microsoft/sp-lodash-subset' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-lodash-subset!Cancelable:type' + - '@microsoft/sp-lodash-subset!ThrottleSettings:type' + - uid: '@microsoft/sp-lodash-subset!Cancelable:type' + name: Cancelable + fullName: Cancelable + langs: + - typeScript + type: typealias + syntax: + content: export declare type Cancelable = Cancelable2; + return: + type: + - '@types/lodash!~"\"../index\"".Cancelable:interface' + - uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' + name: ThrottleSettings + fullName: ThrottleSettings + langs: + - typeScript + type: typealias + syntax: + content: export declare type ThrottleSettings = ThrottleSettings2; + return: + type: + - '@types/lodash!~"\"../index\"".ThrottleSettings:interface' +references: + - uid: '@types/lodash!~"\"../index\"".Cancelable:interface' + name: Cancelable2 + - uid: '@types/lodash!~"\"../index\"".ThrottleSettings:interface' + name: ThrottleSettings2 diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml new file mode 100644 index 00000000..1f687277 --- /dev/null +++ b/SP-Framework/sp-module-interfaces.yml @@ -0,0 +1,92 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!' + name: '@microsoft/sp-module-interfaces' + fullName: '@microsoft/sp-module-interfaces' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-module-interfaces!ComponentType:type' + - '@microsoft/sp-module-interfaces!ExtensionType:type' + - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!IPath:interface' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + - uid: '@microsoft/sp-module-interfaces!ComponentType:type' + summary: Type of client-side component. + name: ComponentType + fullName: ComponentType + langs: + - typeScript + type: typealias + syntax: + content: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension'; + return: + type: + - '''Application'' | ''WebPart'' | ''Library'' | ''Extension''' + - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' + summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. + name: ExtensionType + fullName: ExtensionType + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | + 'ListViewCommandSet' | 'SearchQueryModifier'; + return: + type: + - '''Unknown'' | ''ApplicationCustomizer'' | ''FieldCustomizer'' | ''ListViewCommandSet'' | ''SearchQueryModifier''' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + name: IClientSideAssemblyManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + name: IClientSideComponentLoaderConfiguration + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + name: IClientSideExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + name: IClientSideLibraryManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + name: IClientSideWebPartManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + name: IClientSideWebPartManifestEntry + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + name: IClientSideWebPartManifestInstance + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + name: ICommandDefinition + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + name: ICommandSetExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + name: IComponentModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + name: ILocalizedPathModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + name: IModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!IPath:interface' + name: IPath + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + name: IPathModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + name: PredefinedGroup diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml new file mode 100644 index 00000000..249d3ce3 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -0,0 +1,39 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + summary: A library is defined by this manifest. Libraries currently do not have any additional properties. + name: IClientSideAssemblyManifest + fullName: IClientSideAssemblyManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' + summary: The ID of the component from which the assembly is built. + remarks: |- + Supported values: any GUID + + Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" + name: rootComponentId + fullName: rootComponentId + langs: + - typeScript + type: property + syntax: + content: 'rootComponentId: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml new file mode 100644 index 00000000..73d84cef --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -0,0 +1,194 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + summary: >- + This interface describes how a client-side component is to be loaded and initialized by a SharePoint client + framework. It contains all data for loading an entrypoint script and its dependency scripts. + isPreview: true + name: IClientSideComponentLoaderConfiguration + fullName: IClientSideComponentLoaderConfiguration + langs: + - typeScript + type: interface + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' + summary: This is the ID of one of the entries in the "scriptResources" dictionary. + remarks: >- + The loader will download and evaluate the script resource referenced in this field, resolve all dependencies + against the keys in the "scriptResources", and return the exported object to the loader's calling function. The + entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type. + + + Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the + component. + + + Example: `"myApplication.bundle"` + isPreview: true + name: entryModuleId + fullName: entryModuleId + langs: + - typeScript + type: property + syntax: + content: 'entryModuleId: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' + summary: The module referenced by the "entryModuleId" field may export an object with several fields. + remarks: >- + This value optionally references the name of a field on the object exported by the module referenced by the + `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported by + the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of the base + exported object. For example, if entryModuleId refers to a module with with a top-level export of `{ foo: 'bar', + baz: 123 }` and: + + + - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }` + + + - if this field is set to `foo`, the value returned by the module loader is `bar` + + + - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a + key in the top-level export). + + + Example: `mySpWebpart` + isPreview: true + name: exportName + fullName: exportName + langs: + - typeScript + type: property + syntax: + content: 'exportName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' + summary: >- + This is an array of fully-qualified paths to be prepended to each of the script resource paths with the "internal" + or "localized" type. If one fails to load, the loader will attempt to load from the next until there are no base + paths remaining. + remarks: >- + All "internal" and "localized" script resources that do not have fully-qualified URLs as their "path" field values + must be hosted under each of the paths listed in this property. For example, if an internal module's "path" field + value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's value is `[ + "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first + attempt to load this script resource from the URL + `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading + from that URL fails, the loader will then attempt to load this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL + fails to load, the component will fail to load and an error will be returned. It is important to note that the + support for multiple base URLs is purely for failover support. This means that all files must be present on all + hosts listed in this field. + + + Usage: Base URLs for script resources with the "internal" or "localized" type. + + + Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary. + + + Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` + isPreview: true + name: internalModuleBaseUrls + fullName: internalModuleBaseUrls + langs: + - typeScript + type: property + syntax: + content: 'internalModuleBaseUrls: string[];' + return: + type: + - 'string[]' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' + summary: >- + This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and + `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` + must contain the component's exported object. + remarks: |- + Supported values: A dictionary of named script resources. + + Example: + + ``` + { + "myApplication.bundle": { + "type": "path", + "path": "master_2015-04-20/my-application.bundle_1928f8a0.js" + }, + "@microsoft/sp-client-base": { + "type": "component", + "id": "af59c2b3-2da7-41fd-8b72-3939817960af", + "version": "latest" + }, + "@microsoft/sp-client-preview": { + "type": "component", + "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e", + "version": "latest" + }, + "jQuery": { + "type": "component", + "id": "00000000-0000-0000-0000-000000000000", + "version": "2.2.4", + "path": "https://code.jquery.com/jquery-2.2.4.min.js" + }, + "myApplication_strings": { + "type": "localizedPath", + "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js", + "paths": { + "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", + "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" + } + } + } + + ``` + isPreview: true + name: scriptResources + fullName: scriptResources + langs: + - typeScript + type: property + syntax: + content: |- + scriptResources: { + [name: string]: IModuleConfiguration; + }; + return: + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources~0:complex' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources~0:complex' + name: |- + { + [name: string]: IModuleConfiguration; + } + fullName: |- + { + [name: string]: IModuleConfiguration; + } + spec.typeScript: + - name: |- + { + [name: string]: + fullName: |- + { + [name: string]: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + name: IModuleConfiguration + fullName: IModuleConfiguration + - name: |- + ; + } + fullName: |- + ; + } diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml new file mode 100644 index 00000000..e9ecab4f --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -0,0 +1,189 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + summary: >- + All client-side components built on the SharePoint framework need a valid component manifest. This interface + represents properties that are required by all types of client-side components like Applications and Web Parts. + Component specific manifests will extend this interface to add properties required by that component type. + remarks: >- + The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing + this schema. This set of rules can also be called the "manifest upgrade rules". + + + - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that + processes the manifest should be able to handle the absence of those new properties. + + + - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they + impose a migration cost on developers. + + + - The `'manifestVersion'` should be bumped for all small or big changes. + name: IClientSideComponentManifest + fullName: IClientSideComponentManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' + summary: >- + A short name usually given by developer. It does not need to be localized and is expected to stay the same through + the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, + `ClientSideApplication.alias` is given precedence over the value provided in the manifest. + remarks: |- + Usage: A short name to identify a client-side component by developer. + + Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. + + Example: `"NewFeed"` + name: alias + fullName: alias + langs: + - typeScript + type: property + syntax: + content: 'alias: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' + summary: >- + Type of client-side component. Components with the "Application" type are defined by the + "IClientSideApplicationManifest" interface. Components with the "WebPart" type are defined by the + "IClientSideWebPartManifest" interface. Components with the "Library" type are defined by the + "IClientSideLibraryManifest" interface. + remarks: |- + Usage: To help bundling, loading, enumeration, and initialization of components based on their contents. + + Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"` + name: componentType + fullName: componentType + langs: + - typeScript + type: property + syntax: + content: 'componentType: ComponentType;' + return: + type: + - '@microsoft/sp-module-interfaces!ComponentType:type' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' + summary: >- + This portion of the configuration describes how the component is to be loaded and initialized by a client. It + contains an enumeration of scripts that the component requires along with a single entry point script. + remarks: |- + Usage: Loading a component. + + See `IClientSideComponentLoaderConfiguration` for more information and examples. + isPreview: true + name: loaderConfig + fullName: loaderConfig + langs: + - typeScript + type: property + syntax: + content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' + return: + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' + summary: >- + This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts + build after using spfx 1.1 don't need this. + name: loadLegacyFabricCss + fullName: loadLegacyFabricCss + langs: + - typeScript + type: property + syntax: + content: 'loadLegacyFabricCss?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' + summary: >- + If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true + if the component allows authors to execute arbitrary scripts on the page. + remarks: >- + Defaults to false. See + https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f + for more information. + + + Usage: Requires Custom Script to be allowed in order for this component to be installed and run. + name: requiresCustomScript + fullName: requiresCustomScript + langs: + - typeScript + type: property + syntax: + content: 'requiresCustomScript?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' + summary: This property is provided for backwards compatibility. It no longer has any effect. + deprecated: + content: Use requiresCustomScript instead of safeWithCustomScriptDisabled. + name: safeWithCustomScriptDisabled + fullName: safeWithCustomScriptDisabled + langs: + - typeScript + type: property + syntax: + content: 'safeWithCustomScriptDisabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' + summary: >- + Client-side component version. The value of this field is expected to be controlled by the developer of the + client-side component. + remarks: >- + The purpose of this field is to help client-side component developers upgrade their client-side components in a + managed way. This helps the consumers of the client-side component make decisions about when and how to upgrade + the client-side component. As the developer evolves the code for their client-side component, they can decide to + bump the MAJOR, MINOR or PATCH version of the component. + + + All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes + should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. + Please see [http://semver.org](http://semver.org) for more details on how to manage the version of your + components. + + + Usage: Versioning and evolving a client-side component safely in a controlled way. + + + Supported values: string representing a [semantic version](http://semver.org) i.e. MAJOR.MINOR.PATCH + + + Example: `"1.0.0"` + name: version + fullName: version + langs: + - typeScript + type: property + syntax: + content: 'version: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!ComponentType:type' + name: ComponentType + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + name: IClientSideComponentLoaderConfiguration diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml new file mode 100644 index 00000000..772c4abb --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -0,0 +1,39 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + summary: This is the manifest for a client-side extension. + name: IClientSideExtensionManifest + fullName: IClientSideExtensionManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' + summary: >- + Specifies the type of client-side extension. Some extension types support additional manifest fields beyond + SPClientSideExtensionManifest. + name: extensionType + fullName: extensionType + langs: + - typeScript + type: property + syntax: + content: 'extensionType: ExtensionType;' + return: + type: + - '@microsoft/sp-module-interfaces!ExtensionType:type' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' + name: ExtensionType diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml new file mode 100644 index 00000000..52f45f74 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -0,0 +1,21 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + summary: A library is defined by this manifest. Libraries currently do not have any additional properties. + name: IClientSideLibraryManifest + fullName: IClientSideLibraryManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + package: '@microsoft/sp-module-interfaces!' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml new file mode 100644 index 00000000..e0f405fa --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -0,0 +1,64 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + summary: This interface defines members that are common between all deployable manifests. + name: IClientSideManifestBase + fullName: IClientSideManifestBase + langs: + - typeScript + type: interface + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' + - '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' + summary: >- + A universally unique component id. Each client-side component is required to have this id. Once an id has been + used for a component, it cannot be changed. A change in this value is treated same as the creation of a new + component. Two components are never expected to have the same id. + + + Usage: Uniquely identify a client-side component. + + + Supported values: a GUID string + + + Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' + summary: >- + Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this + field is to help manage upgrades of the component manifest schema. + remarks: >- + A component developer needs to only confirm that they are using the correct value per the manifest schema. Please + read the "manifest upgrade rules" for more details on when the schema could change. Note, manifest schema version + upgrade will be considered a big API change event and will be advertised broadly. + + + Usage: To help support multiple manifest schema versions. + + + Supported values: A positive integer. + + + Example: `1` + name: manifestVersion + fullName: manifestVersion + langs: + - typeScript + type: property + syntax: + content: 'manifestVersion: number;' + return: + type: + - number diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml new file mode 100644 index 00000000..24cd3d6d --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -0,0 +1,216 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + summary: >- + The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a + manifest. + remarks: >- + The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to + identify, load and process a Web Part. The schema for this manifest is completely owned and versioned by + Microsoft. There are some required properties in the manifest and some optional properties. Optional properties + need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to + issues with Web Part loading and functionality problems. + name: IClientSideWebPartManifest + fullName: IClientSideWebPartManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' + summary: Indicates whether the web part uses the property pane to update the configuration of the web part. + remarks: Default value is `true` if the property is not explicitly defined. + name: canUpdateConfiguration + fullName: canUpdateConfiguration + langs: + - typeScript + type: property + syntax: + content: 'canUpdateConfiguration?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' + summary: 'If true, this web part is disabled on SharePoint classic pages' + remarks: >- + Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If + this flag is true, the web part will not appear in the classic page web part gallery. + name: disabledOnClassicSharepoint + fullName: disabledOnClassicSharepoint + langs: + - typeScript + type: property + syntax: + content: 'disabledOnClassicSharepoint?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' + summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' + remarks: >- + Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not + used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts + can be provisioned on pages though API or be added to the page in a pre configured way. + name: hiddenFromToolbox + fullName: hiddenFromToolbox + langs: + - typeScript + type: property + syntax: + content: 'hiddenFromToolbox?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' + summary: 'Definition: Url of the image image used for preview' + remarks: >- + Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web + part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module + url + name: imagePreviewUrl + fullName: imagePreviewUrl + langs: + - typeScript + type: property + syntax: + content: 'imagePreviewUrl?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' + summary: >- + A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part + specific custom properties. And there can be multiple instances of these pre-configured properties. + remarks: >- + This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web + Part in the Toolbox. Each entry is expected to configure the Web Part with a different set of pre-configured + properties. A developer may decide to seed some initial values for these properties but an organization admin can + go ahead and customize these properties per the needs of his/her organization. The properties can also be modified + by the author of the page. + + + Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. + + + Type: JSON object + + + Supported values: Array of `IClientSideWebPartManifestEntry` objects. + + + Example: + + + ``` + [{ + title:"Image Web Part", + description: "This Web Part displays an image", + group: "Media", + iconFontName: "image", + properties: { + imageSource: "https://contoso.akamaihd.net/files/mountRainier.jpg", + captionText: "Mount Rainier" + } + }] + + ``` + name: preconfiguredEntries + fullName: preconfiguredEntries + langs: + - typeScript + type: property + syntax: + content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' + return: + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' + summary: 'Definition: An array defining what host types are supported' + remarks: >- + Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is + provided. If SharePointFullPage is added the solution will be available when adding full page apps. If + SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab or + TeamsPersonalApp is added the solution will be available when using teams. + name: supportedHosts + fullName: supportedHosts + langs: + - typeScript + type: property + syntax: + content: 'supportedHosts?: Array<''SharePointFullPage'' | ''SharePointWebPart'' | ''TeamsTab'' | ''TeamsPersonalApp''>;' + return: + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' + summary: 'Definition: If true, this web part supports and has been tested for full bleed experience.' + remarks: >- + Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, + full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed + experiences require special treatment and testing. By default no web parts support full bleed experiences. + name: supportsFullBleed + fullName: supportsFullBleed + langs: + - typeScript + type: property + syntax: + content: 'supportsFullBleed?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' + summary: 'Definition: If true, this web part supports and has been tested for theme variants experience.' + remarks: >- + Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme + variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may + or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By + default no web parts support theme variants. + name: supportsThemeVariants + fullName: supportsThemeVariants + langs: + - typeScript + type: property + syntax: + content: 'supportsThemeVariants?: boolean;' + return: + type: + - boolean +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries~0:complex' + name: 'IClientSideWebPartManifestEntry[]' + fullName: 'IClientSideWebPartManifestEntry[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + name: IClientSideWebPartManifestEntry + fullName: IClientSideWebPartManifestEntry + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts~0:complex' + name: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> + fullName: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> + spec.typeScript: + - uid: '!Array:interface' + name: Array + fullName: Array + - name: <'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> + fullName: <'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml new file mode 100644 index 00000000..0bde97e3 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -0,0 +1,282 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + summary: >- + This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each + pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content + authors can modify these properties on a need basis. + name: IClientSideWebPartManifestEntry + fullName: IClientSideWebPartManifestEntry + langs: + - typeScript + type: interface + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' + summary: >- + Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note + that data version is different from the version field in the manifest. + remarks: >- + The manifest version is used to control the versioning of the web part code, while data version is used to control + the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more + information. + + + Usage: versioning and evolving the serialized data of the web part + + + Type: string representing a [semantic version](http://semver.org) with only two parts + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property + syntax: + content: 'dataVersion?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' + summary: >- + Description of the web part represented as a dictionary of locale keys to description values. This value will be + displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display + areas. + remarks: >- + The Web Part developer may give an initial description to the web part. The organization admin and page author + will have the ability to change this description as per need. + + + Usage: display the description of the web part in the toolbox tooltip, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"A tool for displaying neat information."` + + + ``` + { + "default": "A tool for displaying neat information.", + "en-us": "A tool for displaying neat information.", + "fr-fr": "Un outil d’affichage des informations soignées.", + "zh": "用於顯示整潔資訊的工具。" + } + + ``` + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description: ILocalizedString;' + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' + summary: >- + The group name in web part picker to contain the web part in the classic page. If no value is provided, then the + web part will be displayed in the Miscellaneous group. + remarks: 'Example: `{ "default": "Media and Content" }`' + isPreview: true + name: group + fullName: group + langs: + - typeScript + type: property + syntax: + content: 'group?: ILocalizedString;' + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' + summary: >- + The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework + reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an + id not in the predefined groups, it falls back to Other group. + remarks: |- + Supported values: the GUID from PredefinedGroup list + + Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` + isPreview: true + name: groupId + fullName: groupId + langs: + - typeScript + type: property + syntax: + content: 'groupId: PredefinedGroup | string;' + return: + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' + summary: >- + The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be + exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). + remarks: >- + If the + [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member) + field does not have a value, this field must have a value. This value can be an absolute URL (e.g. + `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). + In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file + will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). + + + Supported values: Any absolute URL. + + + Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property + syntax: + content: 'iconImageUrl?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' + summary: >- + The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon + font file. + remarks: >- + The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has + a value, the + [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member) + field will be ignored. + + + Supported values: Any character name in the Office 365 Icon Font. + + + Example: "graph" + name: officeFabricIconFontName + fullName: officeFabricIconFontName + langs: + - typeScript + type: property + syntax: + content: 'officeFabricIconFontName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' + summary: >- + Every web part is expected to have some custom properties. For example, an image web part might define properties + for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so + on. + remarks: >- + The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer + fully controls the schema for these properties. The web part developer should follow versioning rules when + updating the properties. + + + Usage: rendering of the web part + + + Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` + name: properties + fullName: properties + langs: + - typeScript + type: property + syntax: + content: 'properties: TProperties;' + return: + type: + - TProperties + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' + summary: >- + This field is used to tag a web part with keywords that are different from the web part group name. Tags can be + used for categorization and searching of web parts. For example, in the web part toolbox. + remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + isPreview: true + name: tags + fullName: tags + langs: + - typeScript + type: property + syntax: + content: 'tags?: ILocalizedString[];' + return: + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' + summary: >- + Title of the web part represented as a single a dictionary of locale keys to title values. This value will be + displayed to the user in the toolbox. + remarks: >- + This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title + to the web part. The organization admin and page author will have the ability to change this title as per need. + + + Usage: display the name of the web part in the toolbox, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"My Webpart"` + + + ``` + { + "default": "My WebPart" + "en-us": "My WebPart", + "fr-fr": "Ma WebPart", + "zh": "我的 web 部件" + } + + ``` + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'title: ILocalizedString;' + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' +references: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId~0:complex' + name: PredefinedGroup | string + fullName: PredefinedGroup | string + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + name: PredefinedGroup + fullName: PredefinedGroup + - name: ' | string' + fullName: ' | string' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags~0:complex' + name: 'ILocalizedString[]' + fullName: 'ILocalizedString[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + fullName: ILocalizedString + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml new file mode 100644 index 00000000..505a16fa --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -0,0 +1,24 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + summary: Manifest that is relevant to a Web Part instance. + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-module-interfaces!' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml new file mode 100644 index 00000000..b1071873 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -0,0 +1,78 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + summary: >- + Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool + bar, etc. + name: ICommandDefinition + fullName: ICommandDefinition + langs: + - typeScript + type: interface + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' + - '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' + - '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' + - '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' + summary: >- + Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by + default. Example: "Show information. Press ENTER to select." + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: ILocalizedString;' + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' + summary: >- + An optional URL for an image to be displayed next to the command. The requirements for this image are defined by + the type of extension; some extension types may not display the image at all. + remarks: >- + This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. + "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input + manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s + iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the + loaderConfig.internalModuleBaseUrls property). + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property + syntax: + content: 'iconImageUrl?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' + summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'title: ILocalizedString;' + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' + summary: Type of the item. Currently only "command" is allowed. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''command'';' + return: + type: + - '''command''' +references: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml new file mode 100644 index 00000000..265dea4f --- /dev/null +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -0,0 +1,87 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + summary: >- + This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a + menu, tool bar, etc. + name: ICommandSetExtensionManifest + fullName: ICommandSetExtensionManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' + summary: >- + Specifies the type of client-side extension. Some extension types support additional manifest fields beyond + SPClientSideExtensionManifest. + name: extensionType + fullName: extensionType + langs: + - typeScript + type: property + syntax: + content: 'extensionType: ''ListViewCommandSet'';' + return: + type: + - '''ListViewCommandSet''' + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' + summary: A table of items defined by this command set. The object key is the Item ID. + remarks: >- + The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of + upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" + name: items + fullName: items + langs: + - typeScript + type: property + syntax: + content: |- + items: { + [itemId: string]: ICommandDefinition; + }; + return: + type: + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items~0:complex' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + name: IClientSideExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items~0:complex' + name: |- + { + [itemId: string]: ICommandDefinition; + } + fullName: |- + { + [itemId: string]: ICommandDefinition; + } + spec.typeScript: + - name: |- + { + [itemId: string]: + fullName: |- + { + [itemId: string]: + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + name: ICommandDefinition + fullName: ICommandDefinition + - name: |- + ; + } + fullName: |- + ; + } diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml new file mode 100644 index 00000000..c0514547 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -0,0 +1,94 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + summary: >- + This is the interface for a script module with the "component" type. Modules of this type will be provided via + manifests. In order for the dependency to be loaded, the manifest must be available on the site. + isPreview: true + name: IComponentModuleConfiguration + fullName: IComponentModuleConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' + summary: A path to the framework-supplied component in case the framework fails to load the requested version. + remarks: >- + This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` + field. If this field is not specified and the version is not available in the framework runtime, the closest + matching version of the component will be provided instead. + + + Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided + in the "internalModuleBaseUrls" field. + + + Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` + isPreview: true + name: failoverPath + fullName: failoverPath + langs: + - typeScript + type: property + syntax: + content: 'failoverPath?: string | IPath;' + return: + type: + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath~0:complex' + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' + summary: The ID of the framework-supplied component to be loaded. + remarks: |- + Supported values: string representing a component's ID. + + Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` + isPreview: true + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' + summary: >- + The version of the framework-supplied component to be loaded. For framework runtime component such as + `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was + developed against be specified. + remarks: |- + Supported values: string representing a [semantic version](http://semver.org), or "latest". + + Example: `"2.2.4"` + isPreview: true + name: version + fullName: version + langs: + - typeScript + type: property + syntax: + content: 'version: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + name: IModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath~0:complex' + name: string | IPath + fullName: string | IPath + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@microsoft/sp-module-interfaces!IPath:interface' + name: IPath + fullName: IPath diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml new file mode 100644 index 00000000..710688f2 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -0,0 +1,128 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + summary: This is the interface for a script module with the "localizedPath" type. + remarks: >- + Modules of this type must be provided by the component developer. These script resources are similar to those of + the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. + Paths in this module type are loaded exactly the same way as "internal" modules are. + isPreview: true + name: ILocalizedPathModuleConfiguration + fullName: ILocalizedPathModuleConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' + summary: >- + A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the + paths provided in the "internalModuleBaseUrls" field. + remarks: >- + If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this field + is used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are + treated. + + + Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a + path under the paths provided in the "internalModuleBaseUrls" field. + + + Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` + isPreview: true + name: defaultPath + fullName: defaultPath + langs: + - typeScript + type: property + syntax: + content: 'defaultPath: string | IPath;' + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath~0:complex' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' + summary: >- + This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale javascript resource + either as a fully-qualified URL or as a path under the paths provided in the `"internalModuleBaseUrls"` field. + remarks: >- + The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the + script resource under that path. If the user's locale does not resolve to one of the paths specified in this + field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this + field's value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key + will be used. If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this + field's value contains the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will + be used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are + treated. + + + Supported values: A dictionary of locale-to-path mappings. + + + Example: + + + ``` + { + "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", + "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" + } + + ``` + isPreview: true + name: paths + fullName: paths + langs: + - typeScript + type: property + syntax: + content: |- + paths?: { + [locale: string]: string | IPath; + }; + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + name: IModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath~0:complex' + name: string | IPath + fullName: string | IPath + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@microsoft/sp-module-interfaces!IPath:interface' + name: IPath + fullName: IPath + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' + name: |- + { + [locale: string]: string | IPath; + } + fullName: |- + { + [locale: string]: string | IPath; + } + spec.typeScript: + - name: |- + { + [locale: string]: string | + fullName: |- + { + [locale: string]: string | + - uid: '@microsoft/sp-module-interfaces!IPath:interface' + name: IPath + fullName: IPath + - name: |- + ; + } + fullName: |- + ; + } diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml new file mode 100644 index 00000000..19a154ca --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -0,0 +1,78 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + summary: A set of localized strings. + remarks: >- + Supported values: + + + - An Id referring to a localized resource. In this case it requires an 'id' key. + + + - A dictionary of locale keys to strings. In this case it requires a 'default' key. + + + ``` + + Example 1: "My Application" + { + "id": "$myStrings:myStrings.MyApplication;" + } + Example 2: "My Application" + { + "default": "My Application" + "en-us": "My Application", + "fr-fr": "Ma demande", + "zh": "我的應用程式" + } + + ``` + + Notes on string ids: + + + - Ids have the following structure: `$:;` + + + - `resourceName` needs to be a `localizedResource` in the config.json. + + + - `expression` is an expression that will be evaluated to access the string from the resource module. + + + If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or + `"$resource:resource[\"MyString\"];"` + + + For more complex cases, run an appropriate expression to access your resource and return the string. + name: ILocalizedString + fullName: ILocalizedString + langs: + - typeScript + type: interface + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!ILocalizedString#default:member' + - '@microsoft/sp-module-interfaces!ILocalizedString#id:member' + - uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' + name: default + fullName: default + langs: + - typeScript + type: property + syntax: + content: 'default?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml new file mode 100644 index 00000000..63141ae1 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -0,0 +1,61 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + summary: This is the base interface for a script module's definition. + isPreview: true + name: IModuleConfiguration + fullName: IModuleConfiguration + langs: + - typeScript + type: interface + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' + - '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' + summary: 'If set to `true`, this module should not be preloaded when loading the component.' + remarks: >- + The most common case for setting this property to "true" is when a module is defined in a manifest, but is not + required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded + asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. + + + Usage: Instructs the module loader to not preload this module. + isPreview: true + name: shouldNotPreload + fullName: shouldNotPreload + langs: + - typeScript + type: property + syntax: + content: 'shouldNotPreload?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' + summary: >- + The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules + must be available on the paths provided in the `"internalModuleBaseUrls"` field. + remarks: >- + Modules with the `"path"` type use the `IPathModuleConfiguration` interface. + + + Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the + "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. + + + Supported values: `"component"`, `"path"`, `"localizedPath"` + + + Example: `"localized"` + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''component'' | ''path'' | ''localizedPath'';' + return: + type: + - '''component'' | ''path'' | ''localizedPath''' diff --git a/SP-Framework/sp-module-interfaces/ipath.yml b/SP-Framework/sp-module-interfaces/ipath.yml new file mode 100644 index 00000000..88cdb3c8 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -0,0 +1,60 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IPath:interface' + summary: >- + This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded + in exactly the same way as any other internal path. + isPreview: true + name: IPath + fullName: IPath + langs: + - typeScript + type: interface + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IPath#debug:member' + - '@microsoft/sp-module-interfaces!IPath#default:member' + - uid: '@microsoft/sp-module-interfaces!IPath#debug:member' + summary: >- + A path to this module's debug javascript resource either as a fully-qualified URL or as a path under the paths + provided in the "internalModuleBaseUrls" field. The script referenced by this field is only loaded if it is + present and debug scripts are explicitly requested. + remarks: >- + Supported values: The path to the debug script either as a fully-qualified URL or as a path under the paths + provided in the `"internalModuleBaseUrls"` field. + + + Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` + isPreview: true + name: debug + fullName: debug + langs: + - typeScript + type: property + syntax: + content: 'debug?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IPath#default:member' + summary: >- + A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided + in the "internalModuleBaseUrls" field. The script referenced by this field is loaded by default unless a debug + version of the script is provided and explicitly requested. + remarks: >- + Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the + paths provided in the "internalModuleBaseUrls" field. + + + Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` + isPreview: true + name: default + fullName: default + langs: + - typeScript + type: property + syntax: + content: 'default: string;' + return: + type: + - string diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml new file mode 100644 index 00000000..45ba1c68 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -0,0 +1,119 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + summary: >- + This is the interface for a script module with the "path" type. Modules of this type must be provided by the + component developer. + isPreview: true + name: IPathModuleConfiguration + fullName: IPathModuleConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' + summary: >- + For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will + ensure that those dependencies are already loaded. + remarks: >- + Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is + not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules + in the same component manifest that this module is specified, the module loader will throw an exception and the + component will fail to load. + + + Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key + `IClientSideComponentLoaderConfiguration.scriptResources[]` + + + Example: `["jquery"]` + isPreview: true + name: globalDependencies + fullName: globalDependencies + langs: + - typeScript + type: property + syntax: + content: 'globalDependencies?: string[];' + return: + type: + - 'string[]' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' + summary: >- + If this property is specified, this module is considered non-AMD and the module loader will not expect "define" or + "require" to be called. + remarks: >- + In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is called and + dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which + global variable must be examined. If this property is specified, this module is considered non-AMD and the module + loader will not expect "define" or "require" to be called. Instead, it will wait for the script to finish loading + and examine the global variable specified in this field. + + + Supported values: Variable names that are expected to be populated after this module is loaded. For example, if + this module is describing jQuery, this value should probably be "$". If an empty string is specified, the module + loader will throw an exception and the component will fail to load. + + + Example: `"$"` + isPreview: true + name: globalName + fullName: globalName + langs: + - typeScript + type: property + syntax: + content: 'globalName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' + summary: >- + A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided + in the `internalModuleBaseUrls` field. + remarks: >- + For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the + `"internalModuleBaseUrls"` field's value is `[ "https://contoso.akamaihd.net/files/", + "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from + the URL `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If + loading from that URL fails, the loader will then attempt to load this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL + fails to load, the component will fail to load and an error will be returned. + + + Supported values: The path to the module either as a fully-qualified URL or as a path under the paths provided in + the "internalModuleBaseUrls" field. + + + Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` + isPreview: true + name: path + fullName: path + langs: + - typeScript + type: property + syntax: + content: 'path: string | IPath;' + return: + type: + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + name: IModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' + name: string | IPath + fullName: string | IPath + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@microsoft/sp-module-interfaces!IPath:interface' + name: IPath + fullName: IPath diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml new file mode 100644 index 00000000..03744b37 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -0,0 +1,105 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + summary: Predefined web part group. + isPreview: true + name: PredefinedGroup + fullName: PredefinedGroup + langs: + - typeScript + type: enum + package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' + summary: |- + Business and intelligence. + + This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. + isPreview: true + name: BusinessAndIntelligence + fullName: BusinessAndIntelligence + langs: + - typeScript + type: field + numericValue: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' + summary: |- + Communication and collaboration. + + This group includes web parts that facilitate information sharing, team work, and social interactions. + isPreview: true + name: CommunicationAndCollaboration + fullName: CommunicationAndCollaboration + langs: + - typeScript + type: field + numericValue: '"75e22ed5-fa14-4829-850a-c890608aca2d"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' + summary: |- + Discovery. + + This group includes web parts that organize, group, and filter content to help users discover information. + isPreview: true + name: Discovery + fullName: Discovery + langs: + - typeScript + type: field + numericValue: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' + summary: |- + Other. + + This group includes web parts not in other groups. + isPreview: true + name: Other + fullName: Other + langs: + - typeScript + type: field + numericValue: '"5c03119e-3074-46fd-976b-c60198311f70"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' + summary: |- + Planning and process. + + This group includes web parts that empower team productivity with the use of planning and process tools. + isPreview: true + name: PlanningAndProcess + fullName: PlanningAndProcess + langs: + - typeScript + type: field + numericValue: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' + summary: |- + Site tools. + + This group includes web parts for site information and management. + isPreview: true + name: SiteTools + fullName: SiteTools + langs: + - typeScript + type: field + numericValue: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' + summary: >- + Text, media and content. + + + This group includes web parts that display text, multi-media, documents, information from the web, and other rich + content. + isPreview: true + name: TextMediaAndContent + fullName: TextMediaAndContent + langs: + - typeScript + type: field + numericValue: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index 16c9cb49..bf066b18 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types + - uid: '@microsoft/sp-odata-types!' summary: TypeScript interfaces for working with SharePoint REST APIs. remarks: >- This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. @@ -12,37 +12,37 @@ items: - typeScript type: package children: - - sp-odata-types._IODataUserId - - sp-odata-types.IODataBasePermission - - sp-odata-types.IODataChangeToken - - sp-odata-types.IODataContextWebInformation - - sp-odata-types.IODataList - - sp-odata-types.IODataListItem - - sp-odata-types.IODataNavigationNode - - sp-odata-types.IODataNavigationNodeCollection - - sp-odata-types.IODataUser - - sp-odata-types.IODataUserCustomAction - - sp-odata-types.IODataWeb + - '@microsoft/sp-odata-types!_IODataUserId:interface' + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - '@microsoft/sp-odata-types!IODataList:interface' + - '@microsoft/sp-odata-types!IODataListItem:interface' + - '@microsoft/sp-odata-types!IODataNavigationNode:interface' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + - '@microsoft/sp-odata-types!IODataUser:interface' + - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + - '@microsoft/sp-odata-types!IODataWeb:interface' references: - - uid: sp-odata-types._IODataUserId + - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' name: _IODataUserId - - uid: sp-odata-types.IODataBasePermission + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' name: IODataBasePermission - - uid: sp-odata-types.IODataChangeToken + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' name: IODataChangeToken - - uid: sp-odata-types.IODataContextWebInformation + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' name: IODataContextWebInformation - - uid: sp-odata-types.IODataList + - uid: '@microsoft/sp-odata-types!IODataList:interface' name: IODataList - - uid: sp-odata-types.IODataListItem + - uid: '@microsoft/sp-odata-types!IODataListItem:interface' name: IODataListItem - - uid: sp-odata-types.IODataNavigationNode + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' name: IODataNavigationNode - - uid: sp-odata-types.IODataNavigationNodeCollection + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' name: IODataNavigationNodeCollection - - uid: sp-odata-types.IODataUser + - uid: '@microsoft/sp-odata-types!IODataUser:interface' name: IODataUser - - uid: sp-odata-types.IODataUserCustomAction + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' name: IODataUserCustomAction - - uid: sp-odata-types.IODataWeb + - uid: '@microsoft/sp-odata-types!IODataWeb:interface' name: IODataWeb diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 4318c32a..cf3ef575 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types._IODataUserId + - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' summary: >- Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,11 +9,11 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types._IODataUserId.NameId - - sp-odata-types._IODataUserId.NameIdIssuer - - uid: sp-odata-types._IODataUserId.NameId + - '@microsoft/sp-odata-types!_IODataUserId#NameId:member' + - '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' + - uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' name: NameId fullName: NameId @@ -25,7 +25,7 @@ items: return: type: - string - - uid: sp-odata-types._IODataUserId.NameIdIssuer + - uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' summary: 'Example: `"urn:office:idp:activedirectory"`' name: NameIdIssuer fullName: NameIdIssuer diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 82310c1e..ad3379fd 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -1,17 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataBasePermission + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' summary: Data used for creating a SPPermission object. name: IODataBasePermission fullName: IODataBasePermission langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataBasePermission.High - - sp-odata-types.IODataBasePermission.Low - - uid: sp-odata-types.IODataBasePermission.High + - '@microsoft/sp-odata-types!IODataBasePermission#High:member' + - '@microsoft/sp-odata-types!IODataBasePermission#Low:member' + - uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' name: High fullName: High langs: @@ -22,7 +22,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataBasePermission.Low + - uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' name: Low fullName: Low langs: diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index af54d375..c9d15958 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataChangeToken + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' summary: >- Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,10 +9,10 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataChangeToken.StringValue - - uid: sp-odata-types.IODataChangeToken.StringValue + - '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' + - uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' name: StringValue fullName: StringValue diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 5876e51b..8efafecf 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataContextWebInformation + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' summary: >- Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,13 +9,13 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataContextWebInformation.LibraryVersion - - sp-odata-types.IODataContextWebInformation.SiteFullUrl - - sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions - - sp-odata-types.IODataContextWebInformation.WebFullUrl - - uid: sp-odata-types.IODataContextWebInformation.LibraryVersion + - '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' + - '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' + - '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' + - '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' summary: 'Example: `"16.0.4919.3000"`' name: LibraryVersion fullName: LibraryVersion @@ -27,7 +27,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataContextWebInformation.SiteFullUrl + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: SiteFullUrl fullName: SiteFullUrl @@ -39,7 +39,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' name: SupportedSchemaVersions fullName: SupportedSchemaVersions @@ -51,7 +51,7 @@ items: return: type: - 'string[]' - - uid: sp-odata-types.IODataContextWebInformation.WebFullUrl + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: WebFullUrl fullName: WebFullUrl diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 862fb675..30e0936b 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataList + - uid: '@microsoft/sp-odata-types!IODataList:interface' summary: >- Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,22 +9,22 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataList.BaseTemplate - - sp-odata-types.IODataList.Created - - sp-odata-types.IODataList.CurrentChangeToken - - sp-odata-types.IODataList.Description - - sp-odata-types.IODataList.EntityTypeName - - sp-odata-types.IODataList.Hidden - - sp-odata-types.IODataList.Id - - sp-odata-types.IODataList.LastItemDeletedDate - - sp-odata-types.IODataList.LastItemModifiedDate - - sp-odata-types.IODataList.ListItemEntityTypeFullName - - sp-odata-types.IODataList.ParentWebUrl - - sp-odata-types.IODataList.TemplateFeatureId - - sp-odata-types.IODataList.Title - - uid: sp-odata-types.IODataList.BaseTemplate + - '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' + - '@microsoft/sp-odata-types!IODataList#Created:member' + - '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' + - '@microsoft/sp-odata-types!IODataList#Description:member' + - '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' + - '@microsoft/sp-odata-types!IODataList#Hidden:member' + - '@microsoft/sp-odata-types!IODataList#Id:member' + - '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' + - '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' + - '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' + - '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' + - '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' + - '@microsoft/sp-odata-types!IODataList#Title:member' + - uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' summary: The list definition type on which the list is based. name: BaseTemplate fullName: BaseTemplate @@ -36,7 +36,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataList.Created + - uid: '@microsoft/sp-odata-types!IODataList#Created:member' summary: 'Example: `"/Date(1453294804000)/"`' name: Created fullName: Created @@ -48,7 +48,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.CurrentChangeToken + - uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' summary: The change token that will be used in logging the next change to the list. name: CurrentChangeToken fullName: CurrentChangeToken @@ -59,8 +59,8 @@ items: content: 'CurrentChangeToken: IODataChangeToken;' return: type: - - sp-odata-types.IODataChangeToken - - uid: sp-odata-types.IODataList.Description + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - uid: '@microsoft/sp-odata-types!IODataList#Description:member' summary: A description of the List. name: Description fullName: Description @@ -72,7 +72,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.EntityTypeName + - uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' summary: 'Example: `"MyListTitleList"`' name: EntityTypeName fullName: EntityTypeName @@ -84,7 +84,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.Hidden + - uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' summary: >- A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. @@ -98,7 +98,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataList.Id + - uid: '@microsoft/sp-odata-types!IODataList#Id:member' summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' name: Id fullName: Id @@ -110,7 +110,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.LastItemDeletedDate + - uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemDeletedDate fullName: LastItemDeletedDate @@ -122,7 +122,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.LastItemModifiedDate + - uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemModifiedDate fullName: LastItemModifiedDate @@ -134,7 +134,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.ListItemEntityTypeFullName + - uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' summary: 'Example: `"SP.Data.MyListTitleListItem"`' name: ListItemEntityTypeFullName fullName: ListItemEntityTypeFullName @@ -146,7 +146,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.ParentWebUrl + - uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' summary: 'Example: `"/sites/PubSite"`' name: ParentWebUrl fullName: ParentWebUrl @@ -158,7 +158,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.TemplateFeatureId + - uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' name: TemplateFeatureId fullName: TemplateFeatureId @@ -170,7 +170,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.Title + - uid: '@microsoft/sp-odata-types!IODataList#Title:member' summary: 'Example: `"Pages"`' name: Title fullName: Title @@ -182,3 +182,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + name: IODataChangeToken diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 3524afe6..3579d6a0 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataListItem + - uid: '@microsoft/sp-odata-types!IODataListItem:interface' summary: >- Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,13 +9,13 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataListItem.ContentTypeId - - sp-odata-types.IODataListItem.ID - - sp-odata-types.IODataListItem.Title - - sp-odata-types.IODataListItem.UniqueId - - uid: sp-odata-types.IODataListItem.ContentTypeId + - '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' + - '@microsoft/sp-odata-types!IODataListItem#ID:member' + - '@microsoft/sp-odata-types!IODataListItem#Title:member' + - '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' + - uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' summary: 'Example: `{ StringValue: "0x010100C5..." }`' name: ContentTypeId fullName: ContentTypeId @@ -33,7 +33,7 @@ items: { StringValue: string; } - - uid: sp-odata-types.IODataListItem.ID + - uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' name: ID fullName: ID langs: @@ -44,7 +44,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataListItem.Title + - uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' summary: Title of the List Item name: Title fullName: Title @@ -56,7 +56,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataListItem.UniqueId + - uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' name: UniqueId fullName: UniqueId diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index e684029c..bfe4eb27 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataNavigationNode + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' summary: >- Represents an OData SP.NavigationNode object. [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) @@ -9,16 +9,16 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataNavigationNode.Children - - sp-odata-types.IODataNavigationNode.Id - - sp-odata-types.IODataNavigationNode.IsDocLib - - sp-odata-types.IODataNavigationNode.IsExternal - - sp-odata-types.IODataNavigationNode.IsVisible - - sp-odata-types.IODataNavigationNode.Title - - sp-odata-types.IODataNavigationNode.Url - - uid: sp-odata-types.IODataNavigationNode.Children + - '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' summary: Gets or sets an array of Navigation Nodes that are children to the current node. name: Children fullName: Children @@ -29,8 +29,8 @@ items: content: 'Children?: IODataNavigationNode[];' return: type: - - 'IODataNavigationNode[]' - - uid: sp-odata-types.IODataNavigationNode.Id + - '@microsoft/sp-odata-types!IODataNavigationNode#Children~0:complex' + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' summary: Gets a value that specifies the identifier for the navigation node. name: Id fullName: Id @@ -42,7 +42,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataNavigationNode.IsDocLib + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' name: IsDocLib fullName: IsDocLib langs: @@ -53,7 +53,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataNavigationNode.IsExternal + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' summary: >- Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. @@ -67,7 +67,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataNavigationNode.IsVisible + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' summary: Gets or sets a value that specifies if the node navigation link should be visible. name: IsVisible fullName: IsVisible @@ -79,7 +79,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataNavigationNode.Title + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' summary: Gets or sets a value that specifies the anchor text for the node navigation link. name: Title fullName: Title @@ -91,7 +91,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataNavigationNode.Url + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' summary: >- Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. @@ -105,3 +105,13 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children~0:complex' + name: 'IODataNavigationNode[]' + fullName: 'IODataNavigationNode[]' + spec.typeScript: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + fullName: IODataNavigationNode + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 1b621a5a..1a73ca6b 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataNavigationNodeCollection + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) @@ -9,11 +9,11 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataNavigationNodeCollection.quickLaunch - - sp-odata-types.IODataNavigationNodeCollection.topNav - - uid: sp-odata-types.IODataNavigationNodeCollection.quickLaunch + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. name: quickLaunch fullName: quickLaunch @@ -24,8 +24,8 @@ items: content: 'quickLaunch: IODataNavigationNode[];' return: type: - - 'IODataNavigationNode[]' - - uid: sp-odata-types.IODataNavigationNodeCollection.topNav + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch~0:complex' + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. name: topNav fullName: topNav @@ -36,4 +36,23 @@ items: content: 'topNav: IODataNavigationNode[];' return: type: - - 'IODataNavigationNode[]' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav~0:complex' +references: + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch~0:complex' + name: 'IODataNavigationNode[]' + fullName: 'IODataNavigationNode[]' + spec.typeScript: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + fullName: IODataNavigationNode + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav~0:complex' + name: 'IODataNavigationNode[]' + fullName: 'IODataNavigationNode[]' + spec.typeScript: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + fullName: IODataNavigationNode + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index fae5d743..b906f692 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataUser + - uid: '@microsoft/sp-odata-types!IODataUser:interface' summary: >- Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,16 +9,16 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataUser.Email - - sp-odata-types.IODataUser.Id - - sp-odata-types.IODataUser.IsSiteAdmin - - sp-odata-types.IODataUser.LoginName - - sp-odata-types.IODataUser.PrincipalType - - sp-odata-types.IODataUser.Title - - sp-odata-types.IODataUser.UserId - - uid: sp-odata-types.IODataUser.Email + - '@microsoft/sp-odata-types!IODataUser#Email:member' + - '@microsoft/sp-odata-types!IODataUser#Id:member' + - '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' + - '@microsoft/sp-odata-types!IODataUser#LoginName:member' + - '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' + - '@microsoft/sp-odata-types!IODataUser#Title:member' + - '@microsoft/sp-odata-types!IODataUser#UserId:member' + - uid: '@microsoft/sp-odata-types!IODataUser#Email:member' summary: 'Example: `"someone@example.com"`' name: Email fullName: Email @@ -30,7 +30,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUser.Id + - uid: '@microsoft/sp-odata-types!IODataUser#Id:member' name: Id fullName: Id langs: @@ -41,7 +41,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataUser.IsSiteAdmin + - uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' summary: Boolean value that specifies whether the user is a site collection administrator. name: IsSiteAdmin fullName: IsSiteAdmin @@ -53,7 +53,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataUser.LoginName + - uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' summary: 'Example: `"i:0#.w|domain\user"`' name: LoginName fullName: LoginName @@ -65,7 +65,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUser.PrincipalType + - uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' summary: This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. remarks: |- Values: @@ -91,7 +91,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataUser.Title + - uid: '@microsoft/sp-odata-types!IODataUser#Title:member' summary: 'Example: `"DOMAIN\user"`' name: Title fullName: Title @@ -103,7 +103,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUser.UserId + - uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' summary: >- Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. @@ -116,4 +116,7 @@ items: content: 'UserId: IODataUserId;' return: type: - - IODataUserId + - '@microsoft/sp-odata-types!IODataUserId:interface' +references: + - uid: '@microsoft/sp-odata-types!IODataUserId:interface' + name: IODataUserId diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index 4b579165..74421167 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataUserCustomAction + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' summary: >- Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: @@ -10,27 +10,27 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataUserCustomAction.ClientSideComponentId - - sp-odata-types.IODataUserCustomAction.ClientSideComponentProperties - - sp-odata-types.IODataUserCustomAction.CommandUIExtension - - sp-odata-types.IODataUserCustomAction.Description - - sp-odata-types.IODataUserCustomAction.Group - - sp-odata-types.IODataUserCustomAction.Id - - sp-odata-types.IODataUserCustomAction.ImageUrl - - sp-odata-types.IODataUserCustomAction.Location - - sp-odata-types.IODataUserCustomAction.RegistrationId - - sp-odata-types.IODataUserCustomAction.RegistrationType - - sp-odata-types.IODataUserCustomAction.Rights - - sp-odata-types.IODataUserCustomAction.Scope - - sp-odata-types.IODataUserCustomAction.ScriptBlock - - sp-odata-types.IODataUserCustomAction.ScriptSrc - - sp-odata-types.IODataUserCustomAction.Sequence - - sp-odata-types.IODataUserCustomAction.Title - - sp-odata-types.IODataUserCustomAction.Url - - sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction - - uid: sp-odata-types.IODataUserCustomAction.ClientSideComponentId + - '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' name: ClientSideComponentId @@ -43,7 +43,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.ClientSideComponentProperties + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' summary: Custom initialization properties for the client-side component. remarks: >- This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string @@ -62,7 +62,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.CommandUIExtension + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' summary: >- Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. @@ -76,7 +76,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.Description + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' summary: Gets or sets the description of the custom action. name: Description fullName: Description @@ -88,7 +88,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.Group + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' summary: >- Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. @@ -102,7 +102,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.Id + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' summary: >- Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` @@ -116,7 +116,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.ImageUrl + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' summary: Gets or sets the URL of the image associated with the custom action. name: ImageUrl fullName: ImageUrl @@ -128,7 +128,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.Location + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' name: Location @@ -141,7 +141,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.RegistrationId + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. name: RegistrationId fullName: RegistrationId @@ -153,7 +153,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.RegistrationType + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' summary: Gets or sets the value that specifies the type of object associated with the custom action. remarks: >- Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType @@ -168,7 +168,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataUserCustomAction.Rights + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' summary: Gets or sets the value that specifies the permissions needed for the custom action. name: Rights fullName: Rights @@ -179,8 +179,8 @@ items: content: 'Rights: IODataBasePermission;' return: type: - - sp-odata-types.IODataBasePermission - - uid: sp-odata-types.IODataUserCustomAction.Scope + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' summary: Gets a value that specifies the scope of the custom action. name: Scope fullName: Scope @@ -192,7 +192,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataUserCustomAction.ScriptBlock + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. name: ScriptBlock fullName: ScriptBlock @@ -204,7 +204,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.ScriptSrc + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. name: ScriptSrc fullName: ScriptSrc @@ -216,7 +216,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.Sequence + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' summary: >- Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. @@ -230,7 +230,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataUserCustomAction.Title + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' summary: Gets or sets the display title of the custom action. name: Title fullName: Title @@ -242,7 +242,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.Url + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' name: Url fullName: Url @@ -254,7 +254,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' name: VersionOfUserCustomAction @@ -267,3 +267,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + name: IODataBasePermission diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 296da4fd..e6352b65 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-odata-types.IODataWeb + - uid: '@microsoft/sp-odata-types!IODataWeb:interface' summary: >- Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) @@ -9,27 +9,27 @@ items: langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/sp-odata-types!' children: - - sp-odata-types.IODataWeb.Created - - sp-odata-types.IODataWeb.CurrentChangeToken - - sp-odata-types.IODataWeb.CustomMasterUrl - - sp-odata-types.IODataWeb.Description - - sp-odata-types.IODataWeb.Id - - sp-odata-types.IODataWeb.IsMultilingual - - sp-odata-types.IODataWeb.Language - - sp-odata-types.IODataWeb.LastItemModifiedDate - - sp-odata-types.IODataWeb.MasterUrl - - sp-odata-types.IODataWeb.NoCrawl - - sp-odata-types.IODataWeb.QuickLaunchEnabled - - sp-odata-types.IODataWeb.RecycleBinEnabled - - sp-odata-types.IODataWeb.ServerRelativeUrl - - sp-odata-types.IODataWeb.SiteLogoUrl - - sp-odata-types.IODataWeb.Title - - sp-odata-types.IODataWeb.UIVersion - - sp-odata-types.IODataWeb.Url - - sp-odata-types.IODataWeb.WebTemplate - - uid: sp-odata-types.IODataWeb.Created + - '@microsoft/sp-odata-types!IODataWeb#Created:member' + - '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' + - '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#Description:member' + - '@microsoft/sp-odata-types!IODataWeb#Id:member' + - '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' + - '@microsoft/sp-odata-types!IODataWeb#Language:member' + - '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' + - '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' + - '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' + - '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' + - '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#Title:member' + - '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' + - '@microsoft/sp-odata-types!IODataWeb#Url:member' + - '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' + - uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' summary: |- Gets a value that specifies when the site was created. @@ -44,7 +44,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.CurrentChangeToken + - uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' summary: Represents the unique sequential location of a change within the change log. name: CurrentChangeToken fullName: CurrentChangeToken @@ -55,8 +55,8 @@ items: content: 'CurrentChangeToken?: IODataChangeToken;' return: type: - - sp-odata-types.IODataChangeToken - - uid: sp-odata-types.IODataWeb.CustomMasterUrl + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' summary: |- Gets or sets the URL for a custom master page file to apply to the website. @@ -71,7 +71,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.Description + - uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' summary: Gets or sets the description for the site. name: Description fullName: Description @@ -83,7 +83,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.Id + - uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' summary: |- Gets a value that specifies the site identifier for the site. @@ -98,7 +98,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.IsMultilingual + - uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' summary: Value that represents if the web was name: IsMultilingual fullName: IsMultilingual @@ -110,7 +110,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataWeb.Language + - uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' summary: |- Gets a value that specifies the LCID for the language that is used on the site. @@ -125,7 +125,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataWeb.LastItemModifiedDate + - uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' summary: |- Gets a value that specifies when an item was last modified in the site. @@ -140,7 +140,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.MasterUrl + - uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' summary: |- Gets or sets the URL of the master page that is used for the website. @@ -155,7 +155,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.NoCrawl + - uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' summary: Determines if a particular web will be crawled by search or not. name: NoCrawl fullName: NoCrawl @@ -167,7 +167,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataWeb.QuickLaunchEnabled + - uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. name: QuickLaunchEnabled fullName: QuickLaunchEnabled @@ -179,7 +179,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataWeb.RecycleBinEnabled + - uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. name: RecycleBinEnabled fullName: RecycleBinEnabled @@ -191,7 +191,7 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataWeb.ServerRelativeUrl + - uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' summary: |- Gets or sets the server-relative URL for the Web site. @@ -206,7 +206,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.SiteLogoUrl + - uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' summary: Gets the url for the logo of this particular site. name: SiteLogoUrl fullName: SiteLogoUrl @@ -218,7 +218,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.Title + - uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' summary: The title of the web. name: Title fullName: Title @@ -230,7 +230,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.UIVersion + - uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' summary: |- Gets or sets the user interface (UI) version of the Web site. @@ -245,7 +245,7 @@ items: return: type: - number - - uid: sp-odata-types.IODataWeb.Url + - uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' summary: |- Gets the absolute URL for the website. @@ -260,7 +260,7 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.WebTemplate + - uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' summary: |- Gets the name of the site definition or site template that was used to create the site. @@ -275,3 +275,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + name: IODataChangeToken diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index f670d678..2c81e720 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context + - uid: '@microsoft/sp-page-context!' summary: Page context services for the SharePoint Framework remarks: >- The page context allows an application and its web parts to share common data about the current page, such as its @@ -11,43 +11,43 @@ items: - typeScript type: package children: - - sp-page-context.CultureInfo - - sp-page-context.ISPSystemTime - - sp-page-context.ISPTimeZoneData - - sp-page-context.PageContext - - sp-page-context.SPDayOfWeek - - sp-page-context.SPField - - sp-page-context.SPList - - sp-page-context.SPListItem - - sp-page-context.SPPermission - - sp-page-context.SPSite - - sp-page-context.SPTimeZone - - sp-page-context.SPUser - - sp-page-context.SPWeb + - '@microsoft/sp-page-context!CultureInfo:class' + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - '@microsoft/sp-page-context!ISPTimeZoneData:interface' + - '@microsoft/sp-page-context!PageContext:class' + - '@microsoft/sp-page-context!SPDayOfWeek:enum' + - '@microsoft/sp-page-context!SPField:class' + - '@microsoft/sp-page-context!SPList:class' + - '@microsoft/sp-page-context!SPListItem:class' + - '@microsoft/sp-page-context!SPPermission:class' + - '@microsoft/sp-page-context!SPSite:class' + - '@microsoft/sp-page-context!SPTimeZone:class' + - '@microsoft/sp-page-context!SPUser:class' + - '@microsoft/sp-page-context!SPWeb:class' references: - - uid: sp-page-context.CultureInfo + - uid: '@microsoft/sp-page-context!CultureInfo:class' name: CultureInfo - - uid: sp-page-context.ISPSystemTime + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' name: ISPSystemTime - - uid: sp-page-context.ISPTimeZoneData + - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' name: ISPTimeZoneData - - uid: sp-page-context.PageContext + - uid: '@microsoft/sp-page-context!PageContext:class' name: PageContext - - uid: sp-page-context.SPDayOfWeek + - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' name: SPDayOfWeek - - uid: sp-page-context.SPField + - uid: '@microsoft/sp-page-context!SPField:class' name: SPField - - uid: sp-page-context.SPList + - uid: '@microsoft/sp-page-context!SPList:class' name: SPList - - uid: sp-page-context.SPListItem + - uid: '@microsoft/sp-page-context!SPListItem:class' name: SPListItem - - uid: sp-page-context.SPPermission + - uid: '@microsoft/sp-page-context!SPPermission:class' name: SPPermission - - uid: sp-page-context.SPSite + - uid: '@microsoft/sp-page-context!SPSite:class' name: SPSite - - uid: sp-page-context.SPTimeZone + - uid: '@microsoft/sp-page-context!SPTimeZone:class' name: SPTimeZone - - uid: sp-page-context.SPUser + - uid: '@microsoft/sp-page-context!SPUser:class' name: SPUser - - uid: sp-page-context.SPWeb + - uid: '@microsoft/sp-page-context!SPWeb:class' name: SPWeb diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 44994052..76ac90ca 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.CultureInfo + - uid: '@microsoft/sp-page-context!CultureInfo:class' summary: >- This class is primarily used with the `PageContext` class. It provides culture info for the current user of the application. @@ -12,12 +12,12 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.CultureInfo.currentCultureName - - sp-page-context.CultureInfo.currentUICultureName - - sp-page-context.CultureInfo.isRightToLeft - - uid: sp-page-context.CultureInfo.currentCultureName + - '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' + - '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' + - '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' + - uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' summary: >- This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons. @@ -37,7 +37,7 @@ items: return: type: - string - - uid: sp-page-context.CultureInfo.currentUICultureName + - uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' summary: This string determines the default user interface language. This used for localization and translation of text. remarks: >- This property may have an empty string, but will never be undefined. @@ -55,7 +55,7 @@ items: return: type: - string - - uid: sp-page-context.CultureInfo.isRightToLeft + - uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' summary: This boolean represents the dominant direction of written text for the default user interface language. name: isRightToLeft fullName: isRightToLeft diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index 70b4b6fd..c9d1d5da 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.ISPSystemTime + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' summary: Interface that represents a `SPSystemTime` structure. isPreview: true name: ISPSystemTime @@ -8,17 +8,17 @@ items: langs: - typeScript type: interface - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.ISPSystemTime.Day - - sp-page-context.ISPSystemTime.DayOfWeek - - sp-page-context.ISPSystemTime.Hour - - sp-page-context.ISPSystemTime.Milliseconds - - sp-page-context.ISPSystemTime.Minute - - sp-page-context.ISPSystemTime.Month - - sp-page-context.ISPSystemTime.Second - - sp-page-context.ISPSystemTime.Year - - uid: sp-page-context.ISPSystemTime.Day + - '@microsoft/sp-page-context!ISPSystemTime#Day:member' + - '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' + - '@microsoft/sp-page-context!ISPSystemTime#Hour:member' + - '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' + - '@microsoft/sp-page-context!ISPSystemTime#Minute:member' + - '@microsoft/sp-page-context!ISPSystemTime#Month:member' + - '@microsoft/sp-page-context!ISPSystemTime#Second:member' + - '@microsoft/sp-page-context!ISPSystemTime#Year:member' + - uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' isPreview: true name: Day fullName: Day @@ -30,7 +30,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.DayOfWeek + - uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' isPreview: true name: DayOfWeek fullName: DayOfWeek @@ -42,7 +42,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.Hour + - uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' isPreview: true name: Hour fullName: Hour @@ -54,7 +54,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.Milliseconds + - uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' isPreview: true name: Milliseconds fullName: Milliseconds @@ -66,7 +66,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.Minute + - uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' isPreview: true name: Minute fullName: Minute @@ -78,7 +78,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.Month + - uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' isPreview: true name: Month fullName: Month @@ -90,7 +90,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.Second + - uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' isPreview: true name: Second fullName: Second @@ -102,7 +102,7 @@ items: return: type: - number - - uid: sp-page-context.ISPSystemTime.Year + - uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' isPreview: true name: Year fullName: Year diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index e6a54be5..15bed4cb 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.ISPTimeZoneData + - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' summary: Interface that represents the data necessary to build an `TimeZone` object. isPreview: true name: ISPTimeZoneData @@ -8,16 +8,16 @@ items: langs: - typeScript type: interface - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.ISPTimeZoneData.daylightDate - - sp-page-context.ISPTimeZoneData.daylightOffset - - sp-page-context.ISPTimeZoneData.description - - sp-page-context.ISPTimeZoneData.id - - sp-page-context.ISPTimeZoneData.offset - - sp-page-context.ISPTimeZoneData.standardDate - - sp-page-context.ISPTimeZoneData.standardOffset - - uid: sp-page-context.ISPTimeZoneData.daylightDate + - '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#description:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#id:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' isPreview: true name: daylightDate fullName: daylightDate @@ -28,8 +28,8 @@ items: content: 'daylightDate: ISPSystemTime;' return: type: - - sp-page-context.ISPSystemTime - - uid: sp-page-context.ISPTimeZoneData.daylightOffset + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' isPreview: true name: daylightOffset fullName: daylightOffset @@ -41,7 +41,7 @@ items: return: type: - number - - uid: sp-page-context.ISPTimeZoneData.description + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' isPreview: true name: description fullName: description @@ -53,7 +53,7 @@ items: return: type: - string - - uid: sp-page-context.ISPTimeZoneData.id + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' isPreview: true name: id fullName: id @@ -65,7 +65,7 @@ items: return: type: - number - - uid: sp-page-context.ISPTimeZoneData.offset + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' isPreview: true name: offset fullName: offset @@ -77,7 +77,7 @@ items: return: type: - number - - uid: sp-page-context.ISPTimeZoneData.standardDate + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' isPreview: true name: standardDate fullName: standardDate @@ -88,8 +88,8 @@ items: content: 'standardDate: ISPSystemTime;' return: type: - - sp-page-context.ISPSystemTime - - uid: sp-page-context.ISPTimeZoneData.standardOffset + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' isPreview: true name: standardOffset fullName: standardOffset @@ -101,3 +101,6 @@ items: return: type: - number +references: + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + name: ISPSystemTime diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 13984901..30872d08 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.PageContext + - uid: '@microsoft/sp-page-context!PageContext:class' summary: The SharePoint page context object. remarks: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the @@ -12,20 +12,20 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.PageContext.(constructor) - - sp-page-context.PageContext.aadInfo - - sp-page-context.PageContext.cultureInfo - - sp-page-context.PageContext.isInitialized - - sp-page-context.PageContext.legacyPageContext - - sp-page-context.PageContext.list - - sp-page-context.PageContext.listItem - - sp-page-context.PageContext.serviceKey - - sp-page-context.PageContext.site - - sp-page-context.PageContext.user - - sp-page-context.PageContext.web - - uid: sp-page-context.PageContext.(constructor) + - '@microsoft/sp-page-context!PageContext:constructor(1)' + - '@microsoft/sp-page-context!PageContext#aadInfo:member' + - '@microsoft/sp-page-context!PageContext#cultureInfo:member' + - '@microsoft/sp-page-context!PageContext#isInitialized:member' + - '@microsoft/sp-page-context!PageContext#legacyPageContext:member' + - '@microsoft/sp-page-context!PageContext#list:member' + - '@microsoft/sp-page-context!PageContext#listItem:member' + - '@microsoft/sp-page-context!PageContext.serviceKey:member' + - '@microsoft/sp-page-context!PageContext#site:member' + - '@microsoft/sp-page-context!PageContext#user:member' + - '@microsoft/sp-page-context!PageContext#web:member' + - uid: '@microsoft/sp-page-context!PageContext:constructor(1)' summary: Constructs a new instance of the `PageContext` class name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) @@ -38,8 +38,8 @@ items: - id: serviceScope description: '' type: - - sp-core-library.ServiceScope - - uid: sp-page-context.PageContext.aadInfo + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' summary: >- Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. @@ -52,8 +52,8 @@ items: content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' return: type: - - AzureActiveDirectoryInfo | undefined - - uid: sp-page-context.PageContext.cultureInfo + - '@microsoft/sp-page-context!PageContext#aadInfo~0:complex' + - uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' summary: >- It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. @@ -66,8 +66,8 @@ items: content: 'readonly cultureInfo: CultureInfo;' return: type: - - sp-page-context.CultureInfo - - uid: sp-page-context.PageContext.isInitialized + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' summary: Returns whether the `PageContext` has been initialized. name: isInitialized fullName: isInitialized @@ -79,7 +79,7 @@ items: return: type: - boolean - - uid: sp-page-context.PageContext.legacyPageContext + - uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. remarks: >- This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents @@ -102,7 +102,7 @@ items: return: type: - any - - uid: sp-page-context.PageContext.list + - uid: '@microsoft/sp-page-context!PageContext#list:member' summary: >- Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. @@ -115,8 +115,8 @@ items: content: 'readonly list: SPList | undefined;' return: type: - - SPList | undefined - - uid: sp-page-context.PageContext.listItem + - '@microsoft/sp-page-context!PageContext#list~0:complex' + - uid: '@microsoft/sp-page-context!PageContext#listItem:member' summary: >- Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. @@ -129,8 +129,8 @@ items: content: 'readonly listItem: SPListItem | undefined;' return: type: - - SPListItem | undefined - - uid: sp-page-context.PageContext.serviceKey + - '@microsoft/sp-page-context!PageContext#listItem~0:complex' + - uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' summary: The service key for PageContext. name: serviceKey fullName: serviceKey @@ -141,8 +141,8 @@ items: content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey - - uid: sp-page-context.PageContext.site + - '@microsoft/sp-page-context!PageContext.serviceKey~0:complex' + - uid: '@microsoft/sp-page-context!PageContext#site:member' summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. name: site fullName: site @@ -153,8 +153,8 @@ items: content: 'readonly site: SPSite;' return: type: - - sp-page-context.SPSite - - uid: sp-page-context.PageContext.user + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!PageContext#user:member' summary: >- It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. @@ -167,8 +167,8 @@ items: content: 'readonly user: SPUser;' return: type: - - sp-page-context.SPUser - - uid: sp-page-context.PageContext.web + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!PageContext#web:member' summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. name: web fullName: web @@ -179,4 +179,50 @@ items: content: 'readonly web: SPWeb;' return: type: - - sp-page-context.SPWeb + - '@microsoft/sp-page-context!default:class' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-page-context!PageContext#aadInfo~0:complex' + name: AzureActiveDirectoryInfo | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: AzureActiveDirectoryInfo + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!default:class' + name: CultureInfo + - uid: '@microsoft/sp-page-context!PageContext#list~0:complex' + name: SPList | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPList + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!PageContext#listItem~0:complex' + name: SPListItem | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPListItem + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!PageContext.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-page-context!default:class' + name: PageContext + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-page-context/spdayofweek.yml b/SP-Framework/sp-page-context/spdayofweek.yml index 98bd5197..5b9fddfb 100644 --- a/SP-Framework/sp-page-context/spdayofweek.yml +++ b/SP-Framework/sp-page-context/spdayofweek.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPDayOfWeek + - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' summary: The enum members represent the seven days of a week. isPreview: true name: SPDayOfWeek @@ -8,16 +8,16 @@ items: langs: - typeScript type: enum - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPDayOfWeek.Friday - - sp-page-context.SPDayOfWeek.Monday - - sp-page-context.SPDayOfWeek.Saturday - - sp-page-context.SPDayOfWeek.Sunday - - sp-page-context.SPDayOfWeek.Thursday - - sp-page-context.SPDayOfWeek.Tuesday - - sp-page-context.SPDayOfWeek.Wednesday - - uid: sp-page-context.SPDayOfWeek.Friday + - '@microsoft/sp-page-context!SPDayOfWeek.Friday:member' + - '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' + - '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' + - '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' + - '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' + - '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' + - '@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member' + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Friday:member' isPreview: true name: Friday fullName: Friday @@ -25,7 +25,7 @@ items: - typeScript type: field numericValue: '5' - - uid: sp-page-context.SPDayOfWeek.Monday + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' isPreview: true name: Monday fullName: Monday @@ -33,7 +33,7 @@ items: - typeScript type: field numericValue: '1' - - uid: sp-page-context.SPDayOfWeek.Saturday + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' isPreview: true name: Saturday fullName: Saturday @@ -41,7 +41,7 @@ items: - typeScript type: field numericValue: '6' - - uid: sp-page-context.SPDayOfWeek.Sunday + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' isPreview: true name: Sunday fullName: Sunday @@ -49,7 +49,7 @@ items: - typeScript type: field numericValue: '0' - - uid: sp-page-context.SPDayOfWeek.Thursday + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' isPreview: true name: Thursday fullName: Thursday @@ -57,7 +57,7 @@ items: - typeScript type: field numericValue: '4' - - uid: sp-page-context.SPDayOfWeek.Tuesday + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' isPreview: true name: Tuesday fullName: Tuesday @@ -65,7 +65,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-page-context.SPDayOfWeek.Wednesday + - uid: '@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member' isPreview: true name: Wednesday fullName: Wednesday diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index c36406aa..2bfb06ba 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPField + - uid: '@microsoft/sp-page-context!SPField:class' summary: A field represents the data model for a column in SharePoint list view. remarks: >- This is the client-side equivalent for SharePoint `SPField` class. It is used with the @@ -14,16 +14,16 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPField.clientSideComponentId - - sp-page-context.SPField.clientSideComponentProperties - - sp-page-context.SPField.displayName - - sp-page-context.SPField.fieldType - - sp-page-context.SPField.id - - sp-page-context.SPField.internalName - - sp-page-context.SPField.isRequired - - uid: sp-page-context.SPField.clientSideComponentId + - '@microsoft/sp-page-context!SPField#clientSideComponentId:member' + - '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' + - '@microsoft/sp-page-context!SPField#displayName:member' + - '@microsoft/sp-page-context!SPField#fieldType:member' + - '@microsoft/sp-page-context!SPField#id:member' + - '@microsoft/sp-page-context!SPField#internalName:member' + - '@microsoft/sp-page-context!SPField#isRequired:member' + - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' summary: The unique identifier of the client-side component associated with the field. name: clientSideComponentId fullName: clientSideComponentId @@ -34,8 +34,8 @@ items: content: 'readonly clientSideComponentId: Guid | undefined;' return: type: - - Guid | undefined - - uid: sp-page-context.SPField.clientSideComponentProperties + - '@microsoft/sp-page-context!SPField#clientSideComponentId~0:complex' + - uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning @@ -50,7 +50,7 @@ items: return: type: - string - - uid: sp-page-context.SPField.displayName + - uid: '@microsoft/sp-page-context!SPField#displayName:member' summary: The display name of the field. This name is shown as column name in UI. name: displayName fullName: displayName @@ -62,7 +62,7 @@ items: return: type: - string - - uid: sp-page-context.SPField.fieldType + - uid: '@microsoft/sp-page-context!SPField#fieldType:member' summary: The type of the field represented as a string name: fieldType fullName: fieldType @@ -74,7 +74,7 @@ items: return: type: - string - - uid: sp-page-context.SPField.id + - uid: '@microsoft/sp-page-context!SPField#id:member' summary: The GUID identifier for this field. name: id fullName: id @@ -85,8 +85,8 @@ items: content: 'readonly id: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-page-context.SPField.internalName + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPField#internalName:member' summary: The internal name of the field. This name is usually used to find the field. name: internalName fullName: internalName @@ -98,7 +98,7 @@ items: return: type: - string - - uid: sp-page-context.SPField.isRequired + - uid: '@microsoft/sp-page-context!SPField#isRequired:member' summary: Whether the field is required for each list item in the list name: isRequired fullName: isRequired @@ -110,3 +110,15 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId~0:complex' + name: Guid | undefined + fullName: Guid | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + fullName: Guid + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 4181ea69..7902dcfc 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPList + - uid: '@microsoft/sp-page-context!SPList:class' summary: >- This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list that hosts the page. @@ -12,13 +12,13 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPList.id - - sp-page-context.SPList.permissions - - sp-page-context.SPList.serverRelativeUrl - - sp-page-context.SPList.title - - uid: sp-page-context.SPList.id + - '@microsoft/sp-page-context!SPList#id:member' + - '@microsoft/sp-page-context!SPList#permissions:member' + - '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' + - '@microsoft/sp-page-context!SPList#title:member' + - uid: '@microsoft/sp-page-context!SPList#id:member' summary: >- The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. @@ -31,8 +31,8 @@ items: content: 'readonly id: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-page-context.SPList.permissions + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPList#permissions:member' summary: >- Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. @@ -45,8 +45,8 @@ items: content: 'readonly permissions: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPList.serverRelativeUrl + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' name: serverRelativeUrl @@ -59,7 +59,7 @@ items: return: type: - string - - uid: sp-page-context.SPList.title + - uid: '@microsoft/sp-page-context!SPList#title:member' summary: Returns the title for this `SPList`. name: title fullName: title @@ -71,3 +71,8 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index b9bdb3a3..dd81f8eb 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPListItem + - uid: '@microsoft/sp-page-context!SPListItem:class' summary: >- This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list item that hosts the page. @@ -12,10 +12,10 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPListItem.id - - uid: sp-page-context.SPListItem.id + - '@microsoft/sp-page-context!SPListItem#id:member' + - uid: '@microsoft/sp-page-context!SPListItem#id:member' summary: The number that identifies the `SPListItem` on the server. name: id fullName: id diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 632d49a8..5309e300 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPPermission + - uid: '@microsoft/sp-page-context!SPPermission:class' summary: Used to test whether the current user has a requested set of permissions. remarks: >- Specifies the built-in permissions available in SharePoint Foundation @@ -13,50 +13,50 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPPermission.(constructor) - - sp-page-context.SPPermission.addAndCustomizePages - - sp-page-context.SPPermission.addDelPrivateWebParts - - sp-page-context.SPPermission.addListItems - - sp-page-context.SPPermission.applyStyleSheets - - sp-page-context.SPPermission.applyThemeAndBorder - - sp-page-context.SPPermission.approveItems - - sp-page-context.SPPermission.browseDirectories - - sp-page-context.SPPermission.browserUserInfo - - sp-page-context.SPPermission.cancelCheckout - - sp-page-context.SPPermission.createAlerts - - sp-page-context.SPPermission.createGroups - - sp-page-context.SPPermission.createSSCSite - - sp-page-context.SPPermission.deleteListItems - - sp-page-context.SPPermission.deleteVersions - - sp-page-context.SPPermission.editListItems - - sp-page-context.SPPermission.editMyUserInfo - - sp-page-context.SPPermission.emptyMask - - sp-page-context.SPPermission.enumeratePermissions - - sp-page-context.SPPermission.fullMask - - sp-page-context.SPPermission.hasAllPermissions - - sp-page-context.SPPermission.hasAnyPermissions - - sp-page-context.SPPermission.hasPermission - - sp-page-context.SPPermission.layoutsPage - - sp-page-context.SPPermission.manageAlerts - - sp-page-context.SPPermission.manageLists - - sp-page-context.SPPermission.managePermissions - - sp-page-context.SPPermission.managePersonalViews - - sp-page-context.SPPermission.manageSubwebs - - sp-page-context.SPPermission.manageWeb - - sp-page-context.SPPermission.open - - sp-page-context.SPPermission.openItems - - sp-page-context.SPPermission.updatePersonalWebParts - - sp-page-context.SPPermission.useClientIntegration - - sp-page-context.SPPermission.useRemoteAPIs - - sp-page-context.SPPermission.value - - sp-page-context.SPPermission.viewFormPages - - sp-page-context.SPPermission.viewListItems - - sp-page-context.SPPermission.viewPages - - sp-page-context.SPPermission.viewUsageData - - sp-page-context.SPPermission.viewVersions - - uid: sp-page-context.SPPermission.(constructor) + - '@microsoft/sp-page-context!SPPermission:constructor(1)' + - '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' + - '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' + - '@microsoft/sp-page-context!SPPermission.addListItems:member' + - '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' + - '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' + - '@microsoft/sp-page-context!SPPermission.approveItems:member' + - '@microsoft/sp-page-context!SPPermission.browseDirectories:member' + - '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' + - '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' + - '@microsoft/sp-page-context!SPPermission.createAlerts:member' + - '@microsoft/sp-page-context!SPPermission.createGroups:member' + - '@microsoft/sp-page-context!SPPermission.createSSCSite:member' + - '@microsoft/sp-page-context!SPPermission.deleteListItems:member' + - '@microsoft/sp-page-context!SPPermission.deleteVersions:member' + - '@microsoft/sp-page-context!SPPermission.editListItems:member' + - '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' + - '@microsoft/sp-page-context!SPPermission.emptyMask:member' + - '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' + - '@microsoft/sp-page-context!SPPermission.fullMask:member' + - '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' + - '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' + - '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' + - '@microsoft/sp-page-context!SPPermission.layoutsPage:member' + - '@microsoft/sp-page-context!SPPermission.manageAlerts:member' + - '@microsoft/sp-page-context!SPPermission.manageLists:member' + - '@microsoft/sp-page-context!SPPermission.managePermissions:member' + - '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' + - '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' + - '@microsoft/sp-page-context!SPPermission.manageWeb:member' + - '@microsoft/sp-page-context!SPPermission.open:member' + - '@microsoft/sp-page-context!SPPermission.openItems:member' + - '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' + - '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' + - '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' + - '@microsoft/sp-page-context!SPPermission#value:member' + - '@microsoft/sp-page-context!SPPermission.viewFormPages:member' + - '@microsoft/sp-page-context!SPPermission.viewListItems:member' + - '@microsoft/sp-page-context!SPPermission.viewPages:member' + - '@microsoft/sp-page-context!SPPermission.viewUsageData:member' + - '@microsoft/sp-page-context!SPPermission.viewVersions:member' + - uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' summary: Constructs a new instance of the `SPPermission` class name: (constructor)(value) fullName: (constructor)(value) @@ -69,8 +69,8 @@ items: - id: value description: '' type: - - sp-odata-types.IODataBasePermission - - uid: sp-page-context.SPPermission.addAndCustomizePages + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' summary: >- Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor. @@ -83,8 +83,8 @@ items: content: 'static readonly addAndCustomizePages: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.addDelPrivateWebParts + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' summary: Add or remove personal web parts on a web part Page. name: addDelPrivateWebParts fullName: addDelPrivateWebParts @@ -95,8 +95,8 @@ items: content: 'static readonly addDelPrivateWebParts: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.addListItems + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' name: addListItems fullName: addListItems @@ -107,8 +107,8 @@ items: content: 'static readonly addListItems: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.applyStyleSheets + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' summary: Apply a style sheet (.css file) to the Web site. name: applyStyleSheets fullName: applyStyleSheets @@ -119,8 +119,8 @@ items: content: 'static readonly applyStyleSheets: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.applyThemeAndBorder + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' summary: Apply a theme or borders to the entire Web site. name: applyThemeAndBorder fullName: applyThemeAndBorder @@ -131,8 +131,8 @@ items: content: 'static readonly applyThemeAndBorder: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.approveItems + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' summary: Approve a minor version of a list item or document. name: approveItems fullName: approveItems @@ -143,8 +143,8 @@ items: content: 'static readonly approveItems: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.browseDirectories + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. name: browseDirectories fullName: browseDirectories @@ -155,8 +155,8 @@ items: content: 'static readonly browseDirectories: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.browserUserInfo + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' summary: View information about users of the Web site. name: browserUserInfo fullName: browserUserInfo @@ -167,8 +167,8 @@ items: content: 'static readonly browserUserInfo: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.cancelCheckout + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' summary: Discard or check in a document which is checked out to another user. name: cancelCheckout fullName: cancelCheckout @@ -179,8 +179,8 @@ items: content: 'static readonly cancelCheckout: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.createAlerts + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' summary: Create e-mail alerts. name: createAlerts fullName: createAlerts @@ -191,8 +191,8 @@ items: content: 'static readonly createAlerts: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.createGroups + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' summary: Create a group of users that can be used anywhere within the site collection. name: createGroups fullName: createGroups @@ -203,8 +203,8 @@ items: content: 'static readonly createGroups: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.createSSCSite + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' summary: Create a Web site using Self-Service Site Creation. name: createSSCSite fullName: createSSCSite @@ -215,8 +215,8 @@ items: content: 'static readonly createSSCSite: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.deleteListItems + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' name: deleteListItems fullName: deleteListItems @@ -227,8 +227,8 @@ items: content: 'static readonly deleteListItems: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.deleteVersions + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' summary: Delete past versions of a list item or document. name: deleteVersions fullName: deleteVersions @@ -239,8 +239,8 @@ items: content: 'static readonly deleteVersions: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.editListItems + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' summary: >- Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. @@ -253,8 +253,8 @@ items: content: 'static readonly editListItems: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.editMyUserInfo + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' summary: 'Allows a user to change his or her user information, such as adding a picture.' name: editMyUserInfo fullName: editMyUserInfo @@ -265,8 +265,8 @@ items: content: 'static readonly editMyUserInfo: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.emptyMask + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' summary: Has no permissions on the Web site. Not available through the user interface. name: emptyMask fullName: emptyMask @@ -277,8 +277,8 @@ items: content: 'static readonly emptyMask: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.enumeratePermissions + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' name: enumeratePermissions fullName: enumeratePermissions @@ -289,8 +289,8 @@ items: content: 'static readonly enumeratePermissions: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.fullMask + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' summary: Has all permissions on the Web site. Not available through the user interface. name: fullMask fullName: fullMask @@ -301,8 +301,8 @@ items: content: 'static readonly fullMask: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.hasAllPermissions + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' summary: Function for testing whether a given permission mask has all of the requested permissions. name: hasAllPermissions(requestedPerms) fullName: hasAllPermissions(requestedPerms) @@ -319,8 +319,8 @@ items: - id: requestedPerms description: Any number of SPPermission objects to be compared against the original type: - - 'SPPermission[]' - - uid: sp-page-context.SPPermission.hasAnyPermissions + - '@microsoft/sp-page-context!SPPermission#hasAllPermissions~0:complex' + - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' summary: Function for testing whether a given permission mask has any of the requested permissions. name: hasAnyPermissions(requestedPerms) fullName: hasAnyPermissions(requestedPerms) @@ -337,8 +337,8 @@ items: - id: requestedPerms description: Any number of SPPermission objects to be compared against the original type: - - 'SPPermission[]' - - uid: sp-page-context.SPPermission.hasPermission + - '@microsoft/sp-page-context!SPPermission#hasAnyPermissions~0:complex' + - uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' summary: Function for testing whether a given permission mask has the requested permission. name: hasPermission(requestedPerm) fullName: hasPermission(requestedPerm) @@ -355,8 +355,8 @@ items: - id: requestedPerm description: The SPPermission object to be compared against the original type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.layoutsPage + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' summary: View the layouts page? name: layoutsPage fullName: layoutsPage @@ -367,8 +367,8 @@ items: content: 'static readonly layoutsPage: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.manageAlerts + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' summary: Manage alerts for all users of the Web site. name: manageAlerts fullName: manageAlerts @@ -379,8 +379,8 @@ items: content: 'static readonly manageAlerts: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.manageLists + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' name: manageLists fullName: manageLists @@ -391,8 +391,8 @@ items: content: 'static readonly manageLists: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.managePermissions + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' summary: Create and change permission levels on the Web site and assign permissions to users and groups. name: managePermissions fullName: managePermissions @@ -403,8 +403,8 @@ items: content: 'static readonly managePermissions: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.managePersonalViews + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' summary: 'Create, change, and delete personal views of lists.' name: managePersonalViews fullName: managePersonalViews @@ -415,8 +415,8 @@ items: content: 'static readonly managePersonalViews: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.manageSubwebs + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' name: manageSubwebs fullName: manageSubwebs @@ -427,8 +427,8 @@ items: content: 'static readonly manageSubwebs: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.manageWeb + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. remarks: >- Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user @@ -445,8 +445,8 @@ items: content: 'static readonly manageWeb: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.open + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.open:member' summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' name: open fullName: open @@ -457,8 +457,8 @@ items: content: 'static readonly open: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.openItems + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.openItems:member' summary: View the source of documents with server-side file handlers. name: openItems fullName: openItems @@ -469,8 +469,8 @@ items: content: 'static readonly openItems: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.updatePersonalWebParts + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' summary: Update web parts to display personalized information. name: updatePersonalWebParts fullName: updatePersonalWebParts @@ -481,8 +481,8 @@ items: content: 'static readonly updatePersonalWebParts: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.useClientIntegration + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' name: useClientIntegration fullName: useClientIntegration @@ -493,8 +493,8 @@ items: content: 'static readonly useClientIntegration: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.useRemoteAPIs + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' name: useRemoteAPIs fullName: useRemoteAPIs @@ -505,8 +505,8 @@ items: content: 'static readonly useRemoteAPIs: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.value + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission#value:member' summary: Returns the value of this SPPermission object name: value fullName: value @@ -517,8 +517,8 @@ items: content: 'readonly value: IODataBasePermission;' return: type: - - sp-odata-types.IODataBasePermission - - uid: sp-page-context.SPPermission.viewFormPages + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' summary: 'View forms, views, and application pages, and enumerate lists.' name: viewFormPages fullName: viewFormPages @@ -529,8 +529,8 @@ items: content: 'static readonly viewFormPages: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.viewListItems + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' name: viewListItems fullName: viewListItems @@ -541,8 +541,8 @@ items: content: 'static readonly viewListItems: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.viewPages + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' summary: View pages in a Web site. name: viewPages fullName: viewPages @@ -553,8 +553,8 @@ items: content: 'static readonly viewPages: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.viewUsageData + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' summary: View reports on Web site usage. name: viewUsageData fullName: viewUsageData @@ -565,8 +565,8 @@ items: content: 'static readonly viewUsageData: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPPermission.viewVersions + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' summary: View past versions of a list item or document. name: viewVersions fullName: viewVersions @@ -577,4 +577,27 @@ items: content: 'static readonly viewVersions: SPPermission;' return: type: - - sp-page-context.SPPermission + - '@microsoft/sp-page-context!default:class' +references: + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + name: IODataBasePermission + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions~0:complex' + name: 'SPPermission[]' + fullName: 'default[]' + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + fullName: default + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions~0:complex' + name: 'SPPermission[]' + fullName: 'default[]' + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + fullName: default + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index b61046c1..d59fabc0 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPSite + - uid: '@microsoft/sp-page-context!SPSite:class' summary: >- This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site collection ("SPSite") that hosts the page. @@ -12,20 +12,20 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPSite.absoluteUrl - - sp-page-context.SPSite.cdnPrefix - - sp-page-context.SPSite.classification - - sp-page-context.SPSite.correlationId - - sp-page-context.SPSite.group - - sp-page-context.SPSite.id - - sp-page-context.SPSite.isNoScriptEnabled - - sp-page-context.SPSite.recycleBinItemCount - - sp-page-context.SPSite.serverRelativeUrl - - sp-page-context.SPSite.serverRequestPath - - sp-page-context.SPSite.sitePagesEnabled - - uid: sp-page-context.SPSite.absoluteUrl + - '@microsoft/sp-page-context!SPSite#absoluteUrl:member' + - '@microsoft/sp-page-context!SPSite#cdnPrefix:member' + - '@microsoft/sp-page-context!SPSite#classification:member' + - '@microsoft/sp-page-context!SPSite#correlationId:member' + - '@microsoft/sp-page-context!SPSite#group:member' + - '@microsoft/sp-page-context!SPSite#id:member' + - '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' + - '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' + - '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' + - '@microsoft/sp-page-context!SPSite#serverRequestPath:member' + - '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' + - uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' name: absoluteUrl @@ -38,7 +38,7 @@ items: return: type: - string - - uid: sp-page-context.SPSite.cdnPrefix + - uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. name: cdnPrefix fullName: cdnPrefix @@ -50,7 +50,7 @@ items: return: type: - string - - uid: sp-page-context.SPSite.classification + - uid: '@microsoft/sp-page-context!SPSite#classification:member' summary: Returns the classification of the site. name: classification fullName: classification @@ -62,7 +62,7 @@ items: return: type: - string - - uid: sp-page-context.SPSite.correlationId + - uid: '@microsoft/sp-page-context!SPSite#correlationId:member' summary: Returns the correlation id to the current server request. name: correlationId fullName: correlationId @@ -73,8 +73,8 @@ items: content: 'readonly correlationId: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-page-context.SPSite.group + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPSite#group:member' summary: >- Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. @@ -87,8 +87,8 @@ items: content: 'readonly group: O365GroupAssociation | undefined;' return: type: - - O365GroupAssociation | undefined - - uid: sp-page-context.SPSite.id + - '@microsoft/sp-page-context!SPSite#group~0:complex' + - uid: '@microsoft/sp-page-context!SPSite#id:member' summary: The GUID that identifies the SPSite on the server. name: id fullName: id @@ -99,8 +99,8 @@ items: content: 'readonly id: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-page-context.SPSite.isNoScriptEnabled + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' summary: Returns true if isNoScript has been enabled on the SPSite. name: isNoScriptEnabled fullName: isNoScriptEnabled @@ -112,7 +112,7 @@ items: return: type: - boolean - - uid: sp-page-context.SPSite.recycleBinItemCount + - uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' summary: The amount of items in the recycle bin. name: recycleBinItemCount fullName: recycleBinItemCount @@ -124,7 +124,7 @@ items: return: type: - number - - uid: sp-page-context.SPSite.serverRelativeUrl + - uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' name: serverRelativeUrl @@ -137,7 +137,7 @@ items: return: type: - string - - uid: sp-page-context.SPSite.serverRequestPath + - uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' name: serverRequestPath @@ -150,7 +150,7 @@ items: return: type: - string - - uid: sp-page-context.SPSite.sitePagesEnabled + - uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' summary: Returns true if SitePages are enabled on this SPSite. name: sitePagesEnabled fullName: sitePagesEnabled @@ -162,3 +162,15 @@ items: return: type: - boolean +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-page-context!SPSite#group~0:complex' + name: O365GroupAssociation | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: O365GroupAssociation + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 96f17dc1..15eff414 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPTimeZone + - uid: '@microsoft/sp-page-context!SPTimeZone:class' summary: >- It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula. @@ -24,16 +24,16 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPTimeZone.daylightDate - - sp-page-context.SPTimeZone.daylightOffset - - sp-page-context.SPTimeZone.description - - sp-page-context.SPTimeZone.id - - sp-page-context.SPTimeZone.offset - - sp-page-context.SPTimeZone.standardDate - - sp-page-context.SPTimeZone.standardOffset - - uid: sp-page-context.SPTimeZone.daylightDate + - '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' + - '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' + - '@microsoft/sp-page-context!SPTimeZone#description:member' + - '@microsoft/sp-page-context!SPTimeZone#id:member' + - '@microsoft/sp-page-context!SPTimeZone#offset:member' + - '@microsoft/sp-page-context!SPTimeZone#standardDate:member' + - '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' + - uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' summary: Gets the date on which daylight time begins for the time zone. isPreview: true name: daylightDate @@ -45,8 +45,8 @@ items: content: 'readonly daylightDate: ISPSystemTime;' return: type: - - sp-page-context.ISPSystemTime - - uid: sp-page-context.SPTimeZone.daylightOffset + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' summary: >- Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC). @@ -61,7 +61,7 @@ items: return: type: - number - - uid: sp-page-context.SPTimeZone.description + - uid: '@microsoft/sp-page-context!SPTimeZone#description:member' summary: Gets the description for the time zone. isPreview: true name: description @@ -74,7 +74,7 @@ items: return: type: - string - - uid: sp-page-context.SPTimeZone.id + - uid: '@microsoft/sp-page-context!SPTimeZone#id:member' summary: Gets the ID of the time zone. isPreview: true name: id @@ -87,7 +87,7 @@ items: return: type: - number - - uid: sp-page-context.SPTimeZone.offset + - uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). isPreview: true name: offset @@ -100,7 +100,7 @@ items: return: type: - number - - uid: sp-page-context.SPTimeZone.standardDate + - uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' summary: Gets the date on which standard time begins for the time zone. isPreview: true name: standardDate @@ -112,8 +112,8 @@ items: content: 'readonly standardDate: ISPSystemTime;' return: type: - - sp-page-context.ISPSystemTime - - uid: sp-page-context.SPTimeZone.standardOffset + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' summary: >- Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC). @@ -128,3 +128,6 @@ items: return: type: - number +references: + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + name: ISPSystemTime diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 50048e6d..e82df982 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPUser + - uid: '@microsoft/sp-page-context!SPUser:class' summary: >- This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user that is accessing the page. @@ -12,17 +12,17 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPUser.displayName - - sp-page-context.SPUser.email - - sp-page-context.SPUser.firstDayOfWeek - - sp-page-context.SPUser.isAnonymousGuestUser - - sp-page-context.SPUser.isExternalGuestUser - - sp-page-context.SPUser.loginName - - sp-page-context.SPUser.preferUserTimeZone - - sp-page-context.SPUser.timeZoneInfo - - uid: sp-page-context.SPUser.displayName + - '@microsoft/sp-page-context!SPUser#displayName:member' + - '@microsoft/sp-page-context!SPUser#email:member' + - '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' + - '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' + - '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' + - '@microsoft/sp-page-context!SPUser#loginName:member' + - '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' + - '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' + - uid: '@microsoft/sp-page-context!SPUser#displayName:member' summary: The display name for the current user. remarks: 'Example: `"John Doe"`' name: displayName @@ -35,7 +35,7 @@ items: return: type: - string - - uid: sp-page-context.SPUser.email + - uid: '@microsoft/sp-page-context!SPUser#email:member' summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' name: email @@ -48,7 +48,7 @@ items: return: type: - string - - uid: sp-page-context.SPUser.firstDayOfWeek + - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. isPreview: true name: firstDayOfWeek @@ -60,8 +60,8 @@ items: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: type: - - SPDayOfWeek | undefined - - uid: sp-page-context.SPUser.isAnonymousGuestUser + - '@microsoft/sp-page-context!SPUser#firstDayOfWeek~0:complex' + - uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' summary: Returns if the current user is an anonymous guest. name: isAnonymousGuestUser fullName: isAnonymousGuestUser @@ -73,7 +73,7 @@ items: return: type: - boolean - - uid: sp-page-context.SPUser.isExternalGuestUser + - uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' summary: Returns true if the current user is an external guest. name: isExternalGuestUser fullName: isExternalGuestUser @@ -85,7 +85,7 @@ items: return: type: - boolean - - uid: sp-page-context.SPUser.loginName + - uid: '@microsoft/sp-page-context!SPUser#loginName:member' summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' name: loginName @@ -98,7 +98,7 @@ items: return: type: - string - - uid: sp-page-context.SPUser.preferUserTimeZone + - uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. name: preferUserTimeZone fullName: preferUserTimeZone @@ -110,7 +110,7 @@ items: return: type: - boolean - - uid: sp-page-context.SPUser.timeZoneInfo + - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' summary: Returns the user's regional timezone settings or undefined if they haven't been set. isPreview: true name: timeZoneInfo @@ -122,4 +122,23 @@ items: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: type: - - SPTimeZone | undefined + - '@microsoft/sp-page-context!SPUser#timeZoneInfo~0:complex' +references: + - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek~0:complex' + name: SPDayOfWeek | undefined + fullName: SPDayOfWeek | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' + name: SPDayOfWeek + fullName: SPDayOfWeek + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo~0:complex' + name: SPTimeZone | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPTimeZone + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 6a65cd99..098e51ea 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.SPWeb + - uid: '@microsoft/sp-page-context!SPWeb:class' summary: >- This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site ("SPWeb") that hosts the page. @@ -12,21 +12,22 @@ items: langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.SPWeb.absoluteUrl - - sp-page-context.SPWeb.description - - sp-page-context.SPWeb.firstDayOfWeek - - sp-page-context.SPWeb.id - - sp-page-context.SPWeb.isAppWeb - - sp-page-context.SPWeb.language - - sp-page-context.SPWeb.logoUrl - - sp-page-context.SPWeb.permissions - - sp-page-context.SPWeb.serverRelativeUrl - - sp-page-context.SPWeb.templateName - - sp-page-context.SPWeb.timeZoneInfo - - sp-page-context.SPWeb.title - - uid: sp-page-context.SPWeb.absoluteUrl + - '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' + - '@microsoft/sp-page-context!SPWeb#description:member' + - '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' + - '@microsoft/sp-page-context!SPWeb#id:member' + - '@microsoft/sp-page-context!SPWeb#isAppWeb:member' + - '@microsoft/sp-page-context!SPWeb#language:member' + - '@microsoft/sp-page-context!SPWeb#languageName:member' + - '@microsoft/sp-page-context!SPWeb#logoUrl:member' + - '@microsoft/sp-page-context!SPWeb#permissions:member' + - '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' + - '@microsoft/sp-page-context!SPWeb#templateName:member' + - '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' + - '@microsoft/sp-page-context!SPWeb#title:member' + - uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' name: absoluteUrl fullName: absoluteUrl @@ -38,7 +39,7 @@ items: return: type: - string - - uid: sp-page-context.SPWeb.description + - uid: '@microsoft/sp-page-context!SPWeb#description:member' summary: Returns the description of the current SPWeb. name: description fullName: description @@ -50,7 +51,7 @@ items: return: type: - string - - uid: sp-page-context.SPWeb.firstDayOfWeek + - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. isPreview: true name: firstDayOfWeek @@ -62,8 +63,8 @@ items: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: type: - - SPDayOfWeek | undefined - - uid: sp-page-context.SPWeb.id + - '@microsoft/sp-page-context!SPWeb#firstDayOfWeek~0:complex' + - uid: '@microsoft/sp-page-context!SPWeb#id:member' summary: The GUID that identifies the SPWeb on the server. name: id fullName: id @@ -74,8 +75,8 @@ items: content: 'readonly id: Guid;' return: type: - - sp-core-library.Guid - - uid: sp-page-context.SPWeb.isAppWeb + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' summary: Returns true if this `SPWeb` the container web for an `SPApp`. name: isAppWeb fullName: isAppWeb @@ -87,7 +88,7 @@ items: return: type: - boolean - - uid: sp-page-context.SPWeb.language + - uid: '@microsoft/sp-page-context!SPWeb#language:member' summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' name: language @@ -100,7 +101,20 @@ items: return: type: - number - - uid: sp-page-context.SPWeb.logoUrl + - uid: '@microsoft/sp-page-context!SPWeb#languageName:member' + summary: Returns the language name for the default language of the website. + remarks: 'Example: en-US represents the English language in the US locale.' + name: languageName + fullName: languageName + langs: + - typeScript + type: property + syntax: + content: 'readonly languageName: string;' + return: + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' name: logoUrl @@ -113,7 +127,7 @@ items: return: type: - string - - uid: sp-page-context.SPWeb.permissions + - uid: '@microsoft/sp-page-context!SPWeb#permissions:member' summary: >- Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. @@ -126,8 +140,8 @@ items: content: 'readonly permissions: SPPermission;' return: type: - - sp-page-context.SPPermission - - uid: sp-page-context.SPWeb.serverRelativeUrl + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' name: serverRelativeUrl @@ -140,7 +154,7 @@ items: return: type: - string - - uid: sp-page-context.SPWeb.templateName + - uid: '@microsoft/sp-page-context!SPWeb#templateName:member' summary: >- Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. @@ -155,7 +169,7 @@ items: return: type: - string - - uid: sp-page-context.SPWeb.timeZoneInfo + - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' summary: Returns the web's regional timezone settings or undefined if they haven't been set. isPreview: true name: timeZoneInfo @@ -167,8 +181,8 @@ items: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: type: - - SPTimeZone | undefined - - uid: sp-page-context.SPWeb.title + - '@microsoft/sp-page-context!SPWeb#timeZoneInfo~0:complex' + - uid: '@microsoft/sp-page-context!SPWeb#title:member' summary: Returns the title of the current SPWeb. name: title fullName: title @@ -180,3 +194,26 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek~0:complex' + name: SPDayOfWeek | undefined + fullName: SPDayOfWeek | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' + name: SPDayOfWeek + fullName: SPDayOfWeek + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo~0:complex' + name: SPTimeZone | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPTimeZone + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml new file mode 100644 index 00000000..b46d0ddd --- /dev/null +++ b/SP-Framework/sp-property-pane.yml @@ -0,0 +1,680 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!' + summary: SharePoint Framework property pane. + remarks: 'Helps create the property pane for the SharePoint components such as web parts, canvas etc.,' + name: '@microsoft/sp-property-pane' + fullName: '@microsoft/sp-property-pane' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + summary: Property pane dynamic field filters which is an intersection of both source and property filters. + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type IPropertyPaneDynamicFieldFilters = IDynamicDataSharedSourceFilters & + IDynamicDataSharedPropertyFilters; + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters~0:complex' + - uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' + summary: Helper method to create a Button on the PropertyPane. + name: 'PropertyPaneButton(targetProperty, properties)' + fullName: 'PropertyPaneButton(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneButton~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the Button is associated to. + type: + - string + - id: properties + description: Strongly typed Button properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' + summary: Helper method to create a Checkbox on the PropertyPane. + name: 'PropertyPaneCheckbox(targetProperty, properties)' + fullName: 'PropertyPaneCheckbox(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneCheckbox~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the checkbox is associated to. + type: + - string + - id: properties + description: Strongly typed Checkbox properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' + summary: Helper method to create a Choice Group on the PropertyPane. + name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneChoiceGroup~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the choice group is associated to. + type: + - string + - id: properties + description: Strongly typed Choice Group properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' + summary: Helper method to create a custom field on the PropertyPane. + remarks: >- + The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The + PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but + there are exceptional cases when web parts have special needs and need a special control. The custom field helps + fill that gap. + isPreview: true + name: PropertyPaneCustomField(properties) + fullName: PropertyPaneCustomField(properties) + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneCustomField~0:complex' + description: '' + parameters: + - id: properties + description: Strongly typed Custom field properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' + summary: Helper method to create a Dropdown on the PropertyPane. + name: 'PropertyPaneDropdown(targetProperty, properties)' + fullName: 'PropertyPaneDropdown(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDropdown~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the dropdown is associated to. + type: + - string + - id: properties + description: Strongly typed Dropdown properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' + summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. + name: 'PropertyPaneDynamicField(targetProperty, properties)' + fullName: 'PropertyPaneDynamicField(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneDynamicField(targetProperty: string, properties: + IPropertyPaneDynamicFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDynamicField~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the Dynamic Data widget is associated to. + type: + - string + - id: properties + description: '' + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' + summary: >- + Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data + source. + + + These fields can possibly share the same property based on the associated filters. + name: PropertyPaneDynamicFieldSet(properties) + fullName: PropertyPaneDynamicFieldSet(properties) + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet~0:complex' + description: '' + parameters: + - id: properties + description: >- + Contains entries and options, described as below: entries - A set of entries to be configured by the widget. + Each entry includes the target property and, optionally, the label to show. options - Options enabling + customized values for callback, filters etc., for the given set of dynamic fields. + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' + summary: Helper method to create a Dynamic TextField on the PropertyPane. + deprecated: + content: '- This has been replaced by PropertyPaneDynamicField' + isPreview: true + name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + fullName: 'PropertyPaneDynamicTextField(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: + IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDynamicTextField~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the dynamic textfield is associated to. + type: + - string + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' + summary: Helper method to create a Horizontal Rule on the PropertyPane. + name: PropertyPaneHorizontalRule() + fullName: PropertyPaneHorizontalRule() + langs: + - typeScript + type: function + syntax: + content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneHorizontalRule~0:complex' + description: '' + - uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' + summary: Helper method to create a Label on the PropertyPane. + name: 'PropertyPaneLabel(targetProperty, properties)' + fullName: 'PropertyPaneLabel(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneLabel~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the label is associated to. + type: + - string + - id: properties + description: Strongly typed Label properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' + summary: Helper method to create a Link on the PropertyPane. + name: 'PropertyPaneLink(targetProperty, properties)' + fullName: 'PropertyPaneLink(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneLink~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the Link is associated to. + type: + - string + - id: properties + description: Strongly typed Link properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' + summary: Helper method to create a Slider on the PropertyPane. + name: 'PropertyPaneSlider(targetProperty, properties)' + fullName: 'PropertyPaneSlider(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneSlider~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the slider is associated to. + type: + - string + - id: properties + description: Strongly typed Slider properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' + summary: Helper method to create a TextField on the PropertyPane. + name: 'PropertyPaneTextField(targetProperty, properties)' + fullName: 'PropertyPaneTextField(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneTextField~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the textfield is associated to. + type: + - string + - id: properties + description: Strongly typed TextField properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' + summary: Helper method to create a Toggle on the PropertyPane. + name: 'PropertyPaneToggle(targetProperty, properties)' + fullName: 'PropertyPaneToggle(targetProperty, properties)' + langs: + - typeScript + type: function + syntax: + content: >- + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneToggle~0:complex' + description: '' + parameters: + - id: targetProperty + description: Target property the toggle is associated to. + type: + - string + - id: properties + description: Strongly typed Toggle properties. + type: + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' +references: + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + name: DynamicDataSharedDepth + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + name: IPopupWindowProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + name: IPropertyPaneDebounceProperty + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters~0:complex' + name: IDynamicDataSharedSourceFilters & IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedSourceFilters & IDynamicDataSharedPropertyFilters + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + - name: ' & ' + fullName: ' & ' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + name: PopupWindowPosition + - uid: '@microsoft/sp-property-pane!PropertyPaneButton~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + name: PropertyPaneButtonType + - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + name: PropertyPaneDropdownOptionType + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + name: PropertyPaneFieldType + - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: + fullName: + - uid: '@microsoft/sp-property-pane!PropertyPaneLabel~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneLink~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneSlider~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneToggle~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml new file mode 100644 index 00000000..6f36b6e1 --- /dev/null +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -0,0 +1,38 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + summary: Enum for the possible values of shared depth of the dynamic data reference. + name: DynamicDataSharedDepth + fullName: DynamicDataSharedDepth + langs: + - typeScript + type: enum + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' + - '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' + - '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' + summary: Indicates that nothing is shared. + name: None + fullName: None + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' + summary: Indicates that both the dynamic data source and the property are shared. + name: Property + fullName: Property + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' + summary: Indicates that the dynamic data source is shared. + name: Source + fullName: Source + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml new file mode 100644 index 00000000..5ad62caf --- /dev/null +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -0,0 +1,27 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + summary: Configuration related to a shared property. + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' + summary: Filters for the shared property. + name: filters + fullName: filters + langs: + - typeScript + type: property + syntax: + content: 'filters?: IDynamicDataSharedPropertyFilters;' + return: + type: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' +references: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml new file mode 100644 index 00000000..fc628eda --- /dev/null +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -0,0 +1,35 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + summary: Property pane dynamic data property filters. + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' + summary: |- + Property Id + + Usage: Use this filter when the author can only to connect to a specific property from the selected source. + remarks: >- + This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the + dynamic data widget. + + + When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. + Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is + pre-selected, the control will be disabled to ensure that authors can not change it. + name: propertyId + fullName: propertyId + langs: + - typeScript + type: property + syntax: + content: 'propertyId?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml new file mode 100644 index 00000000..702506d2 --- /dev/null +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -0,0 +1,43 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + summary: Configuration related to a shared source. + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' + summary: Filters for the shared source. + name: filters + fullName: filters + langs: + - typeScript + type: property + syntax: + content: 'filters?: IDynamicDataSharedSourceFilters;' + return: + type: + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' + summary: |- + User-friendly, localized label for the sources dropdown. + + default value - 'Connect to source' + name: sourcesLabel + fullName: sourcesLabel + langs: + - typeScript + type: property + syntax: + content: 'sourcesLabel?: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml new file mode 100644 index 00000000..ae17e24a --- /dev/null +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -0,0 +1,68 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + summary: Property pane dynamic data source filters. + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' + summary: |- + Component Id. + + Usage: Use this filter when the author should only be able to connect to a specific type of source. + remarks: >- + This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic + data widget. + + + When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources + matching the given component id. + + + Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only + shows document library web parts on the page which are registered dynamic sources. + name: componentId + fullName: componentId + langs: + - typeScript + type: property + syntax: + content: 'componentId?: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' + summary: |- + Source Id + + Usage: Use this filter, when the author can only to connect to a specific data source. + remarks: >- + This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the + dynamic data widget. + + + When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if + available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is + pre-selected, the control will be disabled to ensure that authors can not change it. + + + The source id for a web part will be of the form WebPart.. + name: sourceId + fullName: sourceId + langs: + - typeScript + type: property + syntax: + content: 'sourceId?: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml new file mode 100644 index 00000000..257be078 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -0,0 +1,66 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + summary: Popup window props. + name: IPopupWindowProps + fullName: IPopupWindowProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPopupWindowProps#height:member' + - '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' + - '@microsoft/sp-property-pane!IPopupWindowProps#title:member' + - '@microsoft/sp-property-pane!IPopupWindowProps#width:member' + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' + summary: Height of pop up window. + name: height + fullName: height + langs: + - typeScript + type: property + syntax: + content: 'height: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' + summary: The position of pop up window. + name: positionWindowPosition + fullName: positionWindowPosition + langs: + - typeScript + type: property + syntax: + content: 'positionWindowPosition: PopupWindowPosition;' + return: + type: + - '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' + summary: Title of pop up window. + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'title: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' + summary: Width of pop up window. + name: width + fullName: width + langs: + - typeScript + type: property + syntax: + content: 'width: number;' + return: + type: + - number +references: + - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + name: PopupWindowPosition diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml new file mode 100644 index 00000000..638498a5 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -0,0 +1,124 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + summary: PropertyPane button props. + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' + summary: |- + Detailed description of the button for the benefit of screen readers. + + Besides the compound button, other button types will need more information provided to screen reader. + name: ariaDescription + fullName: ariaDescription + langs: + - typeScript + type: property + syntax: + content: 'ariaDescription?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' + summary: The aria label of the button for the benefit of screen readers. + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' + summary: The type of button to render. Default value is ButtonType.normal. + name: buttonType + fullName: buttonType + langs: + - typeScript + type: property + syntax: + content: 'buttonType?: PropertyPaneButtonType;' + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' + summary: Description of the action this button takes. Only used for compound buttons. + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' + summary: Whether the button is disabled. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' + summary: The button icon shown in command or hero type. + name: icon + fullName: icon + langs: + - typeScript + type: property + syntax: + content: 'icon?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' + summary: >- + A callback which is invoked on the button click, which takes in the existing value for the bound property and + returns the new value and which is then used to update the properties bag. This update will result in the + re-render of the PropertyPane with the new props. + name: onClick + fullName: onClick + langs: + - typeScript + type: property + syntax: + content: 'onClick: (value: any) => any;' + return: + type: + - '(value: any) => any' + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' + summary: Display text of the element. + name: text + fullName: text + langs: + - typeScript + type: property + syntax: + content: 'text: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + name: PropertyPaneButtonType diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml new file mode 100644 index 00000000..b5f627f8 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -0,0 +1,51 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + summary: PropertyPane CheckBox component props. + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' + summary: Whether the property pane checkbox is checked or not. + remarks: The default value is false. + name: checked + fullName: checked + langs: + - typeScript + type: property + syntax: + content: 'checked?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' + summary: Whether the property pane checkbox is disabled or not. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' + summary: Label to display next to the checkbox. + name: text + fullName: text + langs: + - typeScript + type: property + syntax: + content: 'text?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml new file mode 100644 index 00000000..dd39410a --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -0,0 +1,142 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + summary: PropertyPane ChoiceGroup option props. + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' + summary: The aria label of the property pane choice group option for the benefit of screen readers. + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' + summary: |- + Whether the property pane choice group option is checked or not. + + Default value is false. + name: checked + fullName: checked + langs: + - typeScript + type: property + syntax: + content: 'checked?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' + summary: Whether the property pane choice group option is disabled or not. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' + summary: The Icon component props for choice field. + name: iconProps + fullName: iconProps + langs: + - typeScript + type: property + syntax: + content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' + summary: The width and height of the image in px for choice field. + name: imageSize + fullName: imageSize + langs: + - typeScript + type: property + syntax: + content: |- + imageSize?: { + width: number; + height: number; + }; + return: + type: + - |- + { + width: number; + height: number; + } + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' + summary: The src of image for choice field. + name: imageSrc + fullName: imageSrc + langs: + - typeScript + type: property + syntax: + content: 'imageSrc?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' + summary: A required key to uniquely identify the option. + name: key + fullName: key + langs: + - typeScript + type: property + syntax: + content: 'key: string | number;' + return: + type: + - string | number + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' + summary: The src of image for choice field which is selected. + name: selectedImageSrc + fullName: selectedImageSrc + langs: + - typeScript + type: property + syntax: + content: 'selectedImageSrc?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' + summary: The text string for the option. + name: text + fullName: text + langs: + - typeScript + type: property + syntax: + content: 'text: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml new file mode 100644 index 00000000..84edeebb --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -0,0 +1,24 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + summary: PropertyPane ChoiceGroup icon props. + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' + summary: The name of the icon to use from the Office Fabric icon set. + name: officeFabricIconFontName + fullName: officeFabricIconFontName + langs: + - typeScript + type: property + syntax: + content: 'officeFabricIconFontName?: string | null;' + return: + type: + - string | null diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml new file mode 100644 index 00000000..7dcdb4df --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -0,0 +1,47 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + summary: PropertyPane ChoiceGroup props. + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' + summary: Descriptive label for the choice group. + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' + summary: The options for the choice group. + name: options + fullName: options + langs: + - typeScript + type: property + syntax: + content: 'options: IPropertyPaneChoiceGroupOption[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options~0:complex' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options~0:complex' + name: 'IPropertyPaneChoiceGroupOption[]' + fullName: 'IPropertyPaneChoiceGroupOption[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml new file mode 100644 index 00000000..1bb393d2 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -0,0 +1,79 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + summary: Property pane conditional group. + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' + summary: Callback when user clicks to show primary group. + name: onShowPrimaryGroup + fullName: onShowPrimaryGroup + langs: + - typeScript + type: property + syntax: + content: 'onShowPrimaryGroup?: () => void;' + return: + type: + - () => void + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' + summary: Callback when user clicks to show secondary group. + name: onShowSecondaryGroup + fullName: onShowSecondaryGroup + langs: + - typeScript + type: property + syntax: + content: 'onShowSecondaryGroup?: () => void;' + return: + type: + - () => void + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' + summary: Primary group to show + name: primaryGroup + fullName: primaryGroup + langs: + - typeScript + type: property + syntax: + content: 'primaryGroup: IPropertyPaneGroup;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' + summary: Secondary group to show + name: secondaryGroup + fullName: secondaryGroup + langs: + - typeScript + type: property + syntax: + content: 'secondaryGroup: IPropertyPaneGroup;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' + summary: Indicating whether the property pane should show primary group or the secondary group. + name: showSecondaryGroup + fullName: showSecondaryGroup + langs: + - typeScript + type: property + syntax: + content: 'showSecondaryGroup: boolean;' + return: + type: + - boolean +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml new file mode 100644 index 00000000..9f8566b9 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -0,0 +1,110 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + summary: Web part configuration settings + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' + summary: Page to be displayed on the PropertyPane. + name: currentPage + fullName: currentPage + langs: + - typeScript + type: property + syntax: + content: 'currentPage?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' + summary: List of properties to debounce the `onPropertyPaneFieldChanged` event. + remarks: >- + If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web + part properties. This may lead to jank for some property pane controls or web parts. You can use this + configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other + properties will be unaffected. + isPreview: true + name: debounceProperties + fullName: debounceProperties + langs: + - typeScript + type: property + syntax: + content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' + summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. + remarks: The default value is 500. + name: loadingIndicatorDelayTime + fullName: loadingIndicatorDelayTime + langs: + - typeScript + type: property + syntax: + content: 'loadingIndicatorDelayTime?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' + summary: Total number of pages on the PropertyPane. + name: pages + fullName: pages + langs: + - typeScript + type: property + syntax: + content: 'pages: IPropertyPanePage[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' + summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. + remarks: >- + This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay + loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator + property). + + + The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in + real life async requests could take long and it becomes necessary to display a loading indicator to the end user. + name: showLoadingIndicator + fullName: showLoadingIndicator + langs: + - typeScript + type: property + syntax: + content: 'showLoadingIndicator?: boolean;' + return: + type: + - boolean +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties~0:complex' + name: 'IPropertyPaneDebounceProperty[]' + fullName: 'IPropertyPaneDebounceProperty[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + name: IPropertyPaneDebounceProperty + fullName: IPropertyPaneDebounceProperty + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages~0:complex' + name: 'IPropertyPanePage[]' + fullName: 'IPropertyPanePage[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + fullName: IPropertyPanePage + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml new file mode 100644 index 00000000..b76385f7 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -0,0 +1,104 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + summary: PropertyPane CustomPropertyField props. + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' + summary: >- + Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web + part can use this context to manage state information. + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'context?: any;' + return: + type: + - any + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' + summary: >- + An UNIQUE key indicates the identity of this contorl. + + + The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should + be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how + to pick the value of the key. + + + For more information, see the [React + documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). + name: key + fullName: key + langs: + - typeScript + type: property + syntax: + content: 'key: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' + summary: This API is called when the component is unmounted from the host element. + name: onDispose + fullName: onDispose + langs: + - typeScript + type: property + syntax: + content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' + summary: This API will be called once the custom field is mounted on the host element. + name: onRender + fullName: onRender + langs: + - typeScript + type: property + syntax: + content: >- + onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => + void) => void; + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender~0:complex' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose~0:complex' + name: '(domElement: HTMLElement, context?: any) => void' + fullName: '(domElement: HTMLElement, context?: any) => void' + spec.typeScript: + - name: '(domElement: ' + fullName: '(domElement: ' + - uid: '!HTMLElement:interface' + name: HTMLElement + fullName: HTMLElement + - name: ', context?: any) => void' + fullName: ', context?: any) => void' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender~0:complex' + name: >- + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => + void + fullName: >- + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => + void + spec.typeScript: + - name: '(domElement: ' + fullName: '(domElement: ' + - uid: '!HTMLElement:interface' + name: HTMLElement + fullName: HTMLElement + - name: ', context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void' + fullName: ', context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void' diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml new file mode 100644 index 00000000..bdf4d9f5 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -0,0 +1,43 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' + isPreview: true + name: IPropertyPaneDebounceProperty + fullName: IPropertyPaneDebounceProperty + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' + summary: >- + Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired + for this property. + remarks: The default value is 500. + isPreview: true + name: debouncePeriod + fullName: debouncePeriod + langs: + - typeScript + type: property + syntax: + content: 'debouncePeriod?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' + summary: Property to debounce. + isPreview: true + name: propertyName + fullName: propertyName + langs: + - typeScript + type: property + syntax: + content: 'propertyName: string;' + return: + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml new file mode 100644 index 00000000..3141d69c --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -0,0 +1,24 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + summary: PropertyPane dropdown callout properties. + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' + summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen + name: calloutMaxHeight + fullName: calloutMaxHeight + langs: + - typeScript + type: property + syntax: + content: 'calloutMaxHeight?: number;' + return: + type: + - number diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml new file mode 100644 index 00000000..e4ce9296 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -0,0 +1,66 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + summary: PropertyPane drop down options. + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' + summary: Index for this option. + name: index + fullName: index + langs: + - typeScript + type: property + syntax: + content: 'index?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' + summary: A key to uniquely identify this option. + name: key + fullName: key + langs: + - typeScript + type: property + syntax: + content: 'key: string | number;' + return: + type: + - string | number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' + summary: Text to render for this option. + name: text + fullName: text + langs: + - typeScript + type: property + syntax: + content: 'text: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' + summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type?: PropertyPaneDropdownOptionType;' + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' +references: + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + name: PropertyPaneDropdownOptionType diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml new file mode 100644 index 00000000..64c61ce0 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -0,0 +1,143 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + summary: PropertyPane drop down component props. + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' + summary: A description of the dropdown for the benefit of screen reader users. + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' + summary: >- + Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It + starts from 1. + name: ariaPositionInSet + fullName: ariaPositionInSet + langs: + - typeScript + type: property + syntax: + content: 'ariaPositionInSet?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' + summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. + name: ariaSetSize + fullName: ariaSetSize + langs: + - typeScript + type: property + syntax: + content: 'ariaSetSize?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' + summary: Custom properties for Dropdown's Callout used to render options. + name: calloutProps + fullName: calloutProps + langs: + - typeScript + type: property + syntax: + content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' + summary: Whether the property pane dropdown option is disabled or not. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' + summary: 'If set, this will be displayed as an error message.' + isPreview: true + name: errorMessage + fullName: errorMessage + langs: + - typeScript + type: property + syntax: + content: 'errorMessage?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' + summary: Descriptive label for the Dropdown. + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' + summary: Collection of options for this Dropdown. + name: options + fullName: options + langs: + - typeScript + type: property + syntax: + content: 'options?: IPropertyPaneDropdownOption[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' + summary: The key of the initially selected option. + name: selectedKey + fullName: selectedKey + langs: + - typeScript + type: property + syntax: + content: 'selectedKey?: string | number;' + return: + type: + - string | number +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options~0:complex' + name: 'IPropertyPaneDropdownOption[]' + fullName: 'IPropertyPaneDropdownOption[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml new file mode 100644 index 00000000..86d3e22a --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -0,0 +1,78 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + summary: PropertyPaneDynamicField props. + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' + summary: Filters for the property pane dynamic field. + name: filters + fullName: filters + langs: + - typeScript + type: property + syntax: + content: 'filters?: IPropertyPaneDynamicFieldFilters;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' + summary: 'User-friendly, localized label to identify the field.' + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' + summary: |- + Indicates to what depth of property values are shown on the property pane dynamic data widget. + + If not specified, then max of 2 levels of property value will be shown. + remarks: >- + It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only + source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., + the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two + levels of property value will be shown i.e., the widget will display two levels after the source and property for + this field. + name: propertyValueDepth + fullName: propertyValueDepth + langs: + - typeScript + type: property + syntax: + content: 'propertyValueDepth?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' + summary: |- + User-friendly, localized label for the sources dropdown. + + default value - 'Connect to source' + name: sourcesLabel + fullName: sourcesLabel + langs: + - typeScript + type: property + syntax: + content: 'sourcesLabel?: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml new file mode 100644 index 00000000..ed219f04 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -0,0 +1,117 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + summary: PropertyPane DynamicFieldSet props. + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' + summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. + name: fields + fullName: fields + langs: + - typeScript + type: property + syntax: + content: 'fields: IPropertyPaneField[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' + summary: 'User-friendly, localized label to identify the property.' + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' + summary: Configuration shared between all the entries of the set. + name: sharedConfiguration + fullName: sharedConfiguration + langs: + - typeScript + type: property + syntax: + content: |- + sharedConfiguration?: { + depth: DynamicDataSharedDepth; + source?: IDynamicDataSharedSourceConfiguration; + property?: IDynamicDataSharedPropertyConfiguration; + }; + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration~0:complex' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields~0:complex' + name: 'IPropertyPaneField[]' + fullName: 'IPropertyPaneField[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - name: '>[]' + fullName: '>[]' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration~0:complex' + name: |- + { + depth: DynamicDataSharedDepth; + source?: IDynamicDataSharedSourceConfiguration; + property?: IDynamicDataSharedPropertyConfiguration; + } + fullName: |- + { + depth: DynamicDataSharedDepth; + source?: IDynamicDataSharedSourceConfiguration; + property?: IDynamicDataSharedPropertyConfiguration; + } + spec.typeScript: + - name: |- + { + depth: + fullName: |- + { + depth: + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + name: DynamicDataSharedDepth + fullName: DynamicDataSharedDepth + - name: |- + ; + source?: + fullName: |- + ; + source?: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + - name: |- + ; + property?: + fullName: |- + ; + property?: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + - name: |- + ; + } + fullName: |- + ; + } diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml new file mode 100644 index 00000000..c44d4bcc --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -0,0 +1,188 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + summary: '`PropertyPaneDynamicData` component props.' + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' + isPreview: true + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' + summary: 'ARIA Label for text field, if any.' + isPreview: true + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' + summary: The text field input description. + isPreview: true + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' + summary: Whether the property pane text field is enabled or not. + isPreview: true + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' + summary: 'If set, this will be displayed as an error message.' + remarks: >- + When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the + error message. + + + Make sure to set this only if you want to see an error message displayed for the text field. + isPreview: true + name: errorMessage + fullName: errorMessage + langs: + - typeScript + type: property + syntax: + content: 'errorMessage?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' + summary: Label for the text field. + isPreview: true + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' + summary: This method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- + When it returns string: + + - If valid, it returns empty string. + + - If invalid, it returns the error message string and an error message is displayed below the text field. + + When it returns `Promise`: + + - The resolved value is display as error message. + + - The rejected, the value is thrown away. + isPreview: true + name: onGetErrorMessage + fullName: onGetErrorMessage + langs: + - typeScript + type: property + syntax: + content: 'onGetErrorMessage?: (value: string) => string | Promise;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' + summary: Placeholder text to be displayed in the text field. + isPreview: true + name: placeholder + fullName: placeholder + langs: + - typeScript + type: property + syntax: + content: 'placeholder?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' + summary: Run validation when the PropertyPaneTextField is focused. + remarks: The default value is false. + isPreview: true + name: validateOnFocusIn + fullName: validateOnFocusIn + langs: + - typeScript + type: property + syntax: + content: 'validateOnFocusIn?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' + summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. + remarks: The default value is false. + isPreview: true + name: validateOnFocusOut + fullName: validateOnFocusOut + langs: + - typeScript + type: property + syntax: + content: 'validateOnFocusOut?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' + summary: >- + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. + isPreview: true + name: value + fullName: value + langs: + - typeScript + type: property + syntax: + content: 'value?: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage~0:complex' + name: '(value: string) => string | Promise' + fullName: '(value: string) => string | Promise' + spec.typeScript: + - name: '(value: string) => string | ' + fullName: '(value: string) => string | ' + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml new file mode 100644 index 00000000..6d89d875 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -0,0 +1,71 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + summary: PropertyPane field. + name: IPropertyPaneField + fullName: IPropertyPaneField + langs: + - typeScript + type: interface + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' + - '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' + - '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' + - '@microsoft/sp-property-pane!IPropertyPaneField#type:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' + summary: Strongly typed properties object. Specific to each field type. + remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' + name: properties + fullName: properties + langs: + - typeScript + type: property + syntax: + content: 'properties: TProperties;' + return: + type: + - TProperties + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' + summary: Whether this control should be focused. + remarks: The default value is false. + name: shouldFocus + fullName: shouldFocus + langs: + - typeScript + type: property + syntax: + content: 'shouldFocus?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' + summary: Target property from the web part's property bag. + name: targetProperty + fullName: targetProperty + langs: + - typeScript + type: property + syntax: + content: 'targetProperty: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' + summary: Type of the PropertyPane field. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: PropertyPaneFieldType;' + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' +references: + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + name: PropertyPaneFieldType diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml new file mode 100644 index 00000000..80c86228 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -0,0 +1,62 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + summary: PropertyPane group. Group is part of the PropertyPanePage. + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' + - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' + - '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' + summary: List of PropertyPane fields. + name: groupFields + fullName: groupFields + langs: + - typeScript + type: property + syntax: + content: 'groupFields: IPropertyPaneField[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' + summary: Display name for the group. + remarks: 'For performance reasons, it''s highly recommended to keep this name unique within the property pane page.' + name: groupName + fullName: groupName + langs: + - typeScript + type: property + syntax: + content: 'groupName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' + summary: Indicates whether the PropertyPane group is collapsed or not. + remarks: The default value is false. + name: isCollapsed + fullName: isCollapsed + langs: + - typeScript + type: property + syntax: + content: 'isCollapsed?: boolean;' + return: + type: + - boolean +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields~0:complex' + name: 'IPropertyPaneField[]' + fullName: 'IPropertyPaneField[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml new file mode 100644 index 00000000..71f03713 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -0,0 +1,38 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + summary: PropertyPaneLabel component props. + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' + summary: Whether the associated form field is required or not. + remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' + name: required + fullName: required + langs: + - typeScript + type: property + syntax: + content: 'required?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' + summary: Display text fot the label. + name: text + fullName: text + langs: + - typeScript + type: property + syntax: + content: 'text: string;' + return: + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml new file mode 100644 index 00000000..2cc978af --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -0,0 +1,94 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + summary: PropertyPaneLink component props. + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' + summary: Whether the property pane link is disabled or not. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' + summary: Location to which the link is targeted to. + name: href + fullName: href + langs: + - typeScript + type: property + syntax: + content: 'href: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' + summary: The props of pop up window. + name: popupWindowProps + fullName: popupWindowProps + langs: + - typeScript + type: property + syntax: + content: 'popupWindowProps?: IPopupWindowProps;' + return: + type: + - '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' + summary: This attribute specifies where to display the linked resource. + remarks: >- + Following values can be used: + + + \_self - (default) Load the response in the current page. + + + \_blank - Load the response into a new unnamed tab. + + + \_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same + as "\_self" + + + \_top - Load the response into the original window. + name: target + fullName: target + langs: + - typeScript + type: property + syntax: + content: 'target?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' + summary: Display text for the link. + name: text + fullName: text + langs: + - typeScript + type: property + syntax: + content: 'text: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + name: IPopupWindowProps diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml new file mode 100644 index 00000000..f47fb329 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -0,0 +1,69 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + summary: PropertyPanePage interface. + name: IPropertyPanePage + fullName: IPropertyPanePage + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' + - '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' + - '@microsoft/sp-property-pane!IPropertyPanePage#header:member' + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' + summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. + name: displayGroupsAsAccordion + fullName: displayGroupsAsAccordion + langs: + - typeScript + type: property + syntax: + content: 'displayGroupsAsAccordion?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' + summary: List of groups to be displayed on the PropertyPane page. + name: groups + fullName: groups + langs: + - typeScript + type: property + syntax: + content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPanePage#groups~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' + summary: PropertyPane page header. + name: header + fullName: header + langs: + - typeScript + type: property + syntax: + content: 'header?: IPropertyPanePageHeader;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups~0:complex' + name: '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' + fullName: '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' + spec.typeScript: + - name: ( + fullName: ( + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + - name: ')[]' + fullName: ')[]' + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml new file mode 100644 index 00000000..e99406e0 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -0,0 +1,37 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + summary: PropertyPane header. This header remains same for all the pages. + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' + - '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' + summary: Header to display. + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' + summary: Image url for the background image. + name: image + fullName: image + langs: + - typeScript + type: property + syntax: + content: 'image?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml new file mode 100644 index 00000000..91e02b60 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -0,0 +1,140 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + summary: PropertyPaneSliderProps component props. + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' + summary: A description of the Slider for the benefit of screen readers. + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' + summary: Whether or not the Slider is disabled. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' + summary: Description label of the Slider. + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' + summary: The max value of the Slider. + name: max + fullName: max + langs: + - typeScript + type: property + syntax: + content: 'max: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' + summary: The min value of the Slider. + name: min + fullName: min + langs: + - typeScript + type: property + syntax: + content: 'min: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' + summary: Whether to show the value on the right of the Slider. + remarks: 'If you want to show the value by yourself, you may want to set this value to false.' + name: showValue + fullName: showValue + langs: + - typeScript + type: property + syntax: + content: 'showValue?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' + summary: The difference between the two adjacent values of the Slider. Defaults to 1. + name: step + fullName: step + langs: + - typeScript + type: property + syntax: + content: 'step?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' + summary: |- + The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. + + Defaults to min. + name: value + fullName: value + langs: + - typeScript + type: property + syntax: + content: 'value?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' + summary: |- + Callback to format the Slider value. For example, if + + ```typescript + (value) => `${value}%` + + ``` + is specified, the value of the Slider has % after it. + isPreview: true + name: valueFormat + fullName: valueFormat + langs: + - typeScript + type: property + syntax: + content: 'valueFormat?: (value: number) => string;' + return: + type: + - '(value: number) => string' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml new file mode 100644 index 00000000..bee09b6a --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -0,0 +1,301 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + summary: PropertyPaneTextField component props. + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' + summary: 'Aria Label for text field, if any.' + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property + syntax: + content: 'ariaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' + summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. + remarks: The default value is 200. + name: deferredValidationTime + fullName: deferredValidationTime + langs: + - typeScript + type: property + syntax: + content: 'deferredValidationTime?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' + summary: The text field input description. + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' + summary: Whether the property pane text field is enabled or not. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' + summary: 'If set, this will be displayed as an error message.' + remarks: >- + When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the + error message. + + + So, make sure to set this only if you want to see an error message displayed for the text field. + name: errorMessage + fullName: errorMessage + langs: + - typeScript + type: property + syntax: + content: 'errorMessage?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' + summary: Label for the text field. + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' + summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. + remarks: >- + The messages will be logged with a format such as `.`. + + + For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might + contain: + + + 1. The action type: + + + `Add`: change from initial/unset state to customized content. (first edit) + + + `Clear`: reset the content of caption element to initial/unset state. + + + `Edit`: any edition that changes the content apart from add and clear + + + 2. The text length after each edit + name: logName + fullName: logName + langs: + - typeScript + type: property + syntax: + content: |- + logName?: { + moduleName: string; + controlName: string; + }; + return: + type: + - |- + { + moduleName: string; + controlName: string; + } + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' + summary: Maximum number of characters that the PropertyPaneTextField can have. + remarks: 'If the value is set to a negative number, an exception will be thrown.' + name: maxLength + fullName: maxLength + langs: + - typeScript + type: property + syntax: + content: 'maxLength?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' + summary: Whether or not the text field is a multiline text field. + remarks: The default value is false. + name: multiline + fullName: multiline + langs: + - typeScript + type: property + syntax: + content: 'multiline?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' + summary: The method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- + When it returns string: + + - If valid, it returns empty string. + + - If invalid, it returns the error message string and an error message is displayed below the text field. + + When it returns `Promise`: + + - The resolved value is display as error message. + + - The rejected, the value is thrown away. + name: onGetErrorMessage + fullName: onGetErrorMessage + langs: + - typeScript + type: property + syntax: + content: 'onGetErrorMessage?: (value: string) => string | Promise;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' + summary: placeholder text to be displayed in the text field. + name: placeholder + fullName: placeholder + langs: + - typeScript + type: property + syntax: + content: 'placeholder?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' + summary: Whether or not the multiline text field is resizable. + remarks: The default value is true. + name: resizable + fullName: resizable + langs: + - typeScript + type: property + syntax: + content: 'resizable?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' + summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' + remarks: This prop is used only when the multiline prop is set to true. + name: rows + fullName: rows + langs: + - typeScript + type: property + syntax: + content: 'rows?: number;' + return: + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' + summary: Whether or not the text field is underlined. + remarks: The default value is false. + name: underlined + fullName: underlined + langs: + - typeScript + type: property + syntax: + content: 'underlined?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' + summary: Run validation when the PropertyPaneTextField is focused. + remarks: The default value is false. + name: validateOnFocusIn + fullName: validateOnFocusIn + langs: + - typeScript + type: property + syntax: + content: 'validateOnFocusIn?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' + summary: Run validation when the PropertyPaneTextField is out of focus or on blur. + remarks: The default value is false. + name: validateOnFocusOut + fullName: validateOnFocusOut + langs: + - typeScript + type: property + syntax: + content: 'validateOnFocusOut?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' + summary: >- + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. + name: value + fullName: value + langs: + - typeScript + type: property + syntax: + content: 'value?: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage~0:complex' + name: '(value: string) => string | Promise' + fullName: '(value: string) => string | Promise' + spec.typeScript: + - name: '(value: string) => string | ' + fullName: '(value: string) => string | ' + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml new file mode 100644 index 00000000..fe3685e0 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -0,0 +1,126 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + summary: PropertyPaneToggle component props. + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + langs: + - typeScript + type: interface + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' + summary: Checked state of the toggle. + remarks: 'If you are maintaining state yourself, use this property.' + name: checked + fullName: checked + langs: + - typeScript + type: property + syntax: + content: 'checked?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' + summary: Optional disabled flag. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' + summary: A key to uniquely identify the field. + name: key + fullName: key + langs: + - typeScript + type: property + syntax: + content: 'key?: string | number;' + return: + type: + - string | number + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' + summary: A label for the toggle. + name: label + fullName: label + langs: + - typeScript + type: property + syntax: + content: 'label: string | JSX.Element;' + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' + summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. + name: offAriaLabel + fullName: offAriaLabel + langs: + - typeScript + type: property + syntax: + content: 'offAriaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' + summary: Test display when toggle is OFF. + name: offText + fullName: offText + langs: + - typeScript + type: property + syntax: + content: 'offText?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' + summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. + name: onAriaLabel + fullName: onAriaLabel + langs: + - typeScript + type: property + syntax: + content: 'onAriaLabel?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' + summary: Text to display when toggle is ON. + name: onText + fullName: onText + langs: + - typeScript + type: property + syntax: + content: 'onText?: string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label~0:complex' + name: string | JSX.Element + fullName: string | __global.JSX.Element + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@types/react!~__global.JSX.Element:interface' + name: JSX.Element + fullName: __global.JSX.Element diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml new file mode 100644 index 00000000..32fc2c01 --- /dev/null +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -0,0 +1,56 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + summary: The position of pop up window. + name: PopupWindowPosition + fullName: PopupWindowPosition + langs: + - typeScript + type: enum + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PopupWindowPosition.center:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' + summary: PopupWindowPosition would be located in center of screen. + name: center + fullName: center + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' + summary: PopupWindowPosition would be located in left bottom of screen. + name: leftBottom + fullName: leftBottom + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' + summary: PopupWindowPosition would be located in left top of screen. + name: leftTop + fullName: leftTop + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' + summary: PopupWindowPosition would be located in right bottom of screen. + name: rightBottom + fullName: rightBottom + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' + summary: PopupWindowPosition would be located in right top of screen. + name: rightTop + fullName: rightTop + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml new file mode 100644 index 00000000..c9f81d55 --- /dev/null +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -0,0 +1,84 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + summary: Enum for all the supported button types. + name: PropertyPaneButtonType + fullName: PropertyPaneButtonType + langs: + - typeScript + type: enum + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' + summary: Optional actions. + remarks: >- + Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command + bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts. + name: Command + fullName: Command + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' + summary: Always used as a set with both Standard and Primary compound buttons. + remarks: >- + Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with + a possible significant time investment such as an email or a complex form + name: Compound + fullName: Compound + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' + summary: Hero button. + name: Hero + fullName: Hero + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' + summary: >- + Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within + the command bar. + remarks: >- + Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: + OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In + SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In + SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the + bottom of an event creation Callout when clicking inside an empty time range. + name: Icon + fullName: Icon + langs: + - typeScript + type: field + numericValue: '5' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' + summary: Optional completion action. + remarks: >- + Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo + an action. Examples: "Done" button which closes a container but doesn't make a server call or an "Undo" button + when a user is uploading a file in OneDrive. + name: Normal + fullName: Normal + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' + summary: Preferred completion action when paired with a Standard button. + remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' + name: Primary + fullName: Primary + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml new file mode 100644 index 00000000..82d41fd2 --- /dev/null +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -0,0 +1,40 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). + name: PropertyPaneDropdownOptionType + fullName: PropertyPaneDropdownOptionType + langs: + - typeScript + type: enum + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' + summary: Render a divider. + name: Divider + fullName: Divider + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' + summary: Render menu item as a header. + name: Header + fullName: Header + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' + summary: Render normal menu item. + name: Normal + fullName: Normal + langs: + - typeScript + type: field + numericValue: '0' diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml new file mode 100644 index 00000000..b0b2832c --- /dev/null +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -0,0 +1,152 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + summary: |- + Enum for all the supported PropertyPane field types. + + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. + name: PropertyPaneFieldType + fullName: PropertyPaneFieldType + langs: + - typeScript + type: enum + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' + summary: Button field. + name: Button + fullName: Button + langs: + - typeScript + type: field + numericValue: '11' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' + summary: Checkbox field. + name: CheckBox + fullName: CheckBox + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' + summary: Choice Group field. + name: ChoiceGroup + fullName: ChoiceGroup + langs: + - typeScript + type: field + numericValue: '10' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' + summary: Custom field. + name: Custom + fullName: Custom + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' + summary: Dropdown field. + name: Dropdown + fullName: Dropdown + langs: + - typeScript + type: field + numericValue: '6' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' + summary: Dynamic data field. + name: DynamicField + fullName: DynamicField + langs: + - typeScript + type: field + numericValue: '14' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' + summary: A set of dynamic fields. + name: DynamicFieldSet + fullName: DynamicFieldSet + langs: + - typeScript + type: field + numericValue: '16' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' + summary: Dynamic Text Field + deprecated: + content: '- Please use DynamicField' + isPreview: true + name: DynamicTextField + fullName: DynamicTextField + langs: + - typeScript + type: field + numericValue: '15' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' + summary: Heading field. + name: Heading + fullName: Heading + langs: + - typeScript + type: field + numericValue: '9' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' + summary: Horizontal Rule field. + name: HorizontalRule + fullName: HorizontalRule + langs: + - typeScript + type: field + numericValue: '12' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' + summary: Label field. + name: Label + fullName: Label + langs: + - typeScript + type: field + numericValue: '7' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' + summary: Link field. + name: Link + fullName: Link + langs: + - typeScript + type: field + numericValue: '13' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' + summary: Slider field. + name: Slider + fullName: Slider + langs: + - typeScript + type: field + numericValue: '8' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' + summary: TextField field. + name: TextField + fullName: TextField + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' + summary: Toggle field. + name: Toggle + fullName: Toggle + langs: + - typeScript + type: field + numericValue: '5' diff --git a/SP-Framework/sp-search-extensibility.yml b/SP-Framework/sp-search-extensibility.yml new file mode 100644 index 00000000..80e26e37 --- /dev/null +++ b/SP-Framework/sp-search-extensibility.yml @@ -0,0 +1,23 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!' + summary: SharePoint Framework developer support for customizing search. + name: '@microsoft/sp-search-extensibility' + fullName: '@microsoft/sp-search-extensibility' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - '@microsoft/sp-search-extensibility!IQuery:interface' + - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' +references: + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + name: BaseSearchQueryModifier + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + name: IQuery + - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + name: SearchQueryModifierContext + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + name: SearchQueryScenario diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml new file mode 100644 index 00000000..49929a13 --- /dev/null +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -0,0 +1,122 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + summary: >- + This is the base class that third parties should extend when implementing a client-side extension that can modify + the search query. + + + In the component manifest, the "extensionType" should be set to "SearchQueryModifier". + isPreview: true + name: BaseSearchQueryModifier + fullName: BaseSearchQueryModifier + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~0:complex' + inheritance: + - type: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~1:complex' + package: '@microsoft/sp-search-extensibility!' + children: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: true + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'protected readonly context: SearchQueryModifierContext;' + return: + type: + - '@microsoft/sp-search-extensibility!default:class' + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' + summary: Returns a modified search query. + isPreview: true + name: 'modifySearchQuery(query, scenario)' + fullName: 'modifySearchQuery(query, scenario)' + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise; + return: + type: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery~0:complex' + description: Modified query. + parameters: + - id: query + description: Query to modify. + type: + - '@microsoft/sp-search-extensibility!IQuery:interface' + - id: scenario + description: Search scenario. + type: + - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' + summary: >- + Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the + original query will be used instead of the modified one. + isPreview: true + name: timeout + fullName: timeout + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + readonly timeout: number; + return: + type: + - number +references: + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~0:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~1:complex' + name: BaseExtension + fullName: BaseExtension + spec.typeScript: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + fullName: BaseExtension + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-search-extensibility!default:class' + name: SearchQueryModifierContext + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + name: IQuery + fullName: IQuery + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + name: IQuery + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + name: SearchQueryScenario diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml new file mode 100644 index 00000000..5bc98c67 --- /dev/null +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -0,0 +1,41 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. + remarks: Additional properties can be added to the object to pass data between extensions. + isPreview: true + name: IQuery + fullName: IQuery + langs: + - typeScript + type: interface + package: '@microsoft/sp-search-extensibility!' + children: + - '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' + - '@microsoft/sp-search-extensibility!IQuery#queryText:member' + - uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' + summary: Query text that the user provided. + isPreview: true + name: originalQueryText + fullName: originalQueryText + langs: + - typeScript + type: property + syntax: + content: 'originalQueryText: string;' + return: + type: + - string + - uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' + summary: Text of the query. + isPreview: true + name: queryText + fullName: queryText + langs: + - typeScript + type: property + syntax: + content: 'queryText: string;' + return: + type: + - string diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml new file mode 100644 index 00000000..14b38e78 --- /dev/null +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -0,0 +1,22 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + summary: Context for the search query modifier extensions. + isPreview: true + name: SearchQueryModifierContext + fullName: SearchQueryModifierContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-search-extensibility!' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml new file mode 100644 index 00000000..1d0fd2d7 --- /dev/null +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -0,0 +1,32 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + summary: Scenario for the search query modifier. + isPreview: true + name: SearchQueryScenario + fullName: SearchQueryScenario + langs: + - typeScript + type: enum + package: '@microsoft/sp-search-extensibility!' + children: + - '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' + - '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' + summary: Search results scenario. + isPreview: true + name: SearchResults + fullName: SearchResults + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' + summary: Search suggestions scenario. + isPreview: true + name: SearchSuggestions + fullName: SearchSuggestions + langs: + - typeScript + type: field + numericValue: '2' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 30f91500..7a33c80d 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base + - uid: '@microsoft/sp-webpart-base!' summary: SharePoint Framework support for building web parts. remarks: >- This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual @@ -12,68 +12,69 @@ items: - typeScript type: package children: - - sp-webpart-base.BaseClientSideWebPart - - sp-webpart-base.BaseWebPart - - sp-webpart-base.BaseWebPartContext - - sp-webpart-base.DynamicDataSharedDepth - - sp-webpart-base.IClientSideWebPartStatusRenderer - - sp-webpart-base.IDynamicDataSharedPropertyConfiguration - - sp-webpart-base.IDynamicDataSharedPropertyFilters - - sp-webpart-base.IDynamicDataSharedSourceConfiguration - - sp-webpart-base.IDynamicDataSharedSourceFilters - - sp-webpart-base.IMicrosoftTeams - - sp-webpart-base.IPropertyPaneAccessor - - sp-webpart-base.IPropertyPaneButtonProps - - sp-webpart-base.IPropertyPaneCheckboxProps - - sp-webpart-base.IPropertyPaneChoiceGroupOption - - sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps - - sp-webpart-base.IPropertyPaneChoiceGroupProps - - sp-webpart-base.IPropertyPaneConditionalGroup - - sp-webpart-base.IPropertyPaneConfiguration - - sp-webpart-base.IPropertyPaneCustomFieldProps - - sp-webpart-base.IPropertyPaneDropdownCalloutProps - - sp-webpart-base.IPropertyPaneDropdownOption - - sp-webpart-base.IPropertyPaneDropdownProps - - sp-webpart-base.IPropertyPaneDynamicFieldFilters - - sp-webpart-base.IPropertyPaneDynamicFieldProps - - sp-webpart-base.IPropertyPaneDynamicFieldSetProps - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps - - sp-webpart-base.IPropertyPaneField - - sp-webpart-base.IPropertyPaneGroup - - sp-webpart-base.IPropertyPaneLabelProps - - sp-webpart-base.IPropertyPaneLinkProps - - sp-webpart-base.IPropertyPanePage - - sp-webpart-base.IPropertyPanePageHeader - - sp-webpart-base.IPropertyPaneSliderProps - - sp-webpart-base.IPropertyPaneTextFieldProps - - sp-webpart-base.IPropertyPaneToggleProps - - sp-webpart-base.ISDKs - - sp-webpart-base.ISerializedServerProcessedData - - sp-webpart-base.ISerializedWebPartData - - sp-webpart-base.IWebPartContext - - sp-webpart-base.IWebPartData - - sp-webpart-base.IWebPartPropertiesMetadata - - sp-webpart-base.IWebPartPropertyMetadata - - sp-webpart-base.PropertyPaneButton - - sp-webpart-base.PropertyPaneButtonType - - sp-webpart-base.PropertyPaneCheckbox - - sp-webpart-base.PropertyPaneChoiceGroup - - sp-webpart-base.PropertyPaneCustomField - - sp-webpart-base.PropertyPaneDropdown - - sp-webpart-base.PropertyPaneDropdownOptionType - - sp-webpart-base.PropertyPaneDynamicField - - sp-webpart-base.PropertyPaneDynamicFieldSet - - sp-webpart-base.PropertyPaneDynamicTextField - - sp-webpart-base.PropertyPaneFieldType - - sp-webpart-base.PropertyPaneHorizontalRule - - sp-webpart-base.PropertyPaneLabel - - sp-webpart-base.PropertyPaneLink - - sp-webpart-base.PropertyPaneSlider - - sp-webpart-base.PropertyPaneTextField - - sp-webpart-base.PropertyPaneToggle - - sp-webpart-base.WebPartContext - - sp-webpart-base.WebPartFormFactor - - uid: sp-webpart-base.PropertyPaneButton + - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPartContext:class' + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - '@microsoft/sp-webpart-base!IOffice:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-webpart-base!ISDKs:interface' + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' + - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartContext:interface' + - '@microsoft/sp-webpart-base!IWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' + - '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' + - '@microsoft/sp-webpart-base!WebPartContext:class' + - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' summary: Helper method to create a Button on the PropertyPane. deprecated: content: >- @@ -90,7 +91,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' description: '' parameters: - id: targetProperty @@ -100,8 +101,8 @@ items: - id: properties description: Strongly typed Button properties. type: - - sp-webpart-base.IPropertyPaneButtonProps - - uid: sp-webpart-base.PropertyPaneCheckbox + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' summary: Helper method to create a Checkbox on the PropertyPane. deprecated: content: >- @@ -118,7 +119,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' description: '' parameters: - id: targetProperty @@ -128,8 +129,8 @@ items: - id: properties description: Strongly typed Checkbox properties. type: - - sp-webpart-base.IPropertyPaneCheckboxProps - - uid: sp-webpart-base.PropertyPaneChoiceGroup + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' summary: Helper method to create a Choice Group on the PropertyPane. deprecated: content: >- @@ -146,7 +147,7 @@ items: IPropertyPaneChoiceGroupProps): IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' description: '' parameters: - id: targetProperty @@ -156,8 +157,8 @@ items: - id: properties description: Strongly typed Choice Group properties. type: - - sp-webpart-base.IPropertyPaneChoiceGroupProps - - uid: sp-webpart-base.PropertyPaneCustomField + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' summary: Helper method to create a custom field on the PropertyPane. remarks: >- The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The @@ -180,14 +181,14 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' description: '' parameters: - id: properties description: Strongly typed Custom field properties. type: - - sp-webpart-base.IPropertyPaneCustomFieldProps - - uid: sp-webpart-base.PropertyPaneDropdown + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' summary: Helper method to create a Dropdown on the PropertyPane. deprecated: content: >- @@ -204,7 +205,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' description: '' parameters: - id: targetProperty @@ -214,8 +215,8 @@ items: - id: properties description: Strongly typed Dropdown properties. type: - - sp-webpart-base.IPropertyPaneDropdownProps - - uid: sp-webpart-base.PropertyPaneDynamicField + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. deprecated: content: >- @@ -232,7 +233,7 @@ items: IPropertyPaneDynamicFieldProps): IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneDynamicField~0:complex' description: '' parameters: - id: targetProperty @@ -242,8 +243,8 @@ items: - id: properties description: '' type: - - sp-webpart-base.IPropertyPaneDynamicFieldProps - - uid: sp-webpart-base.PropertyPaneDynamicFieldSet + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' summary: >- Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source. @@ -265,7 +266,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet~0:complex' description: '' parameters: - id: properties @@ -274,8 +275,8 @@ items: Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields. type: - - sp-webpart-base.IPropertyPaneDynamicFieldSetProps - - uid: sp-webpart-base.PropertyPaneDynamicTextField + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' summary: Helper method to create a Dynamic TextField on the PropertyPane. deprecated: content: >- @@ -293,7 +294,7 @@ items: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField~0:complex' description: '' parameters: - id: targetProperty @@ -303,8 +304,8 @@ items: - id: properties description: Properties of the PropertyPaneDynamicTextField. type: - - sp-webpart-base.IPropertyPaneDynamicTextFieldProps - - uid: sp-webpart-base.PropertyPaneHorizontalRule + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' summary: Helper method to create a Horizontal Rule on the PropertyPane. deprecated: content: >- @@ -319,9 +320,9 @@ items: content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule~0:complex' description: '' - - uid: sp-webpart-base.PropertyPaneLabel + - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' summary: Helper method to create a Label on the PropertyPane. deprecated: content: >- @@ -338,7 +339,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' description: '' parameters: - id: targetProperty @@ -348,8 +349,8 @@ items: - id: properties description: Strongly typed Label properties. type: - - sp-webpart-base.IPropertyPaneLabelProps - - uid: sp-webpart-base.PropertyPaneLink + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' summary: Helper method to create a Link on the PropertyPane. deprecated: content: >- @@ -366,7 +367,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' description: '' parameters: - id: targetProperty @@ -376,8 +377,8 @@ items: - id: properties description: Strongly typed Link properties. type: - - sp-webpart-base.IPropertyPaneLinkProps - - uid: sp-webpart-base.PropertyPaneSlider + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' summary: Helper method to create a Slider on the PropertyPane. deprecated: content: >- @@ -394,7 +395,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' description: '' parameters: - id: targetProperty @@ -404,8 +405,8 @@ items: - id: properties description: Strongly typed Slider properties. type: - - sp-webpart-base.IPropertyPaneSliderProps - - uid: sp-webpart-base.PropertyPaneTextField + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' summary: Helper method to create a TextField on the PropertyPane. deprecated: content: >- @@ -422,7 +423,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' description: '' parameters: - id: targetProperty @@ -432,8 +433,8 @@ items: - id: properties description: Strongly typed TextField properties. type: - - sp-webpart-base.IPropertyPaneTextFieldProps - - uid: sp-webpart-base.PropertyPaneToggle + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' summary: Helper method to create a Toggle on the PropertyPane. deprecated: content: >- @@ -450,7 +451,7 @@ items: IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' description: '' parameters: - id: targetProperty @@ -460,99 +461,292 @@ items: - id: properties description: Strongly typed Toggle properties. type: - - sp-webpart-base.IPropertyPaneToggleProps + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' references: - - uid: sp-webpart-base.BaseClientSideWebPart + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' name: BaseClientSideWebPart - - uid: sp-webpart-base.BaseWebPart + - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' name: BaseWebPart - - uid: sp-webpart-base.BaseWebPartContext + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' name: BaseWebPartContext - - uid: sp-webpart-base.DynamicDataSharedDepth + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' name: DynamicDataSharedDepth - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' name: IClientSideWebPartStatusRenderer - - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' name: IDynamicDataSharedPropertyConfiguration - - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' name: IDynamicDataSharedPropertyFilters - - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' name: IDynamicDataSharedSourceConfiguration - - uid: sp-webpart-base.IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' name: IDynamicDataSharedSourceFilters - - uid: sp-webpart-base.IMicrosoftTeams + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' name: IMicrosoftTeams - - uid: sp-webpart-base.IPropertyPaneAccessor + - uid: '@microsoft/sp-webpart-base!IOffice:interface' + name: IOffice + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' name: IPropertyPaneAccessor - - uid: sp-webpart-base.IPropertyPaneButtonProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' name: IPropertyPaneButtonProps - - uid: sp-webpart-base.IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' name: IPropertyPaneCheckboxProps - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' name: IPropertyPaneChoiceGroupOption - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' name: IPropertyPaneChoiceGroupOptionIconProps - - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' name: IPropertyPaneChoiceGroupProps - - uid: sp-webpart-base.IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' name: IPropertyPaneConditionalGroup - - uid: sp-webpart-base.IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' name: IPropertyPaneConfiguration - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' name: IPropertyPaneCustomFieldProps - - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' name: IPropertyPaneDropdownCalloutProps - - uid: sp-webpart-base.IPropertyPaneDropdownOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' name: IPropertyPaneDropdownOption - - uid: sp-webpart-base.IPropertyPaneDropdownProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' name: IPropertyPaneDropdownProps - - uid: sp-webpart-base.IPropertyPaneDynamicFieldFilters + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' name: IPropertyPaneDynamicFieldFilters - - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' name: IPropertyPaneDynamicFieldProps - - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' name: IPropertyPaneDynamicFieldSetProps - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' name: IPropertyPaneDynamicTextFieldProps - - uid: sp-webpart-base.IPropertyPaneField + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' name: IPropertyPaneField - - uid: sp-webpart-base.IPropertyPaneGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' name: IPropertyPaneGroup - - uid: sp-webpart-base.IPropertyPaneLabelProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' name: IPropertyPaneLabelProps - - uid: sp-webpart-base.IPropertyPaneLinkProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' name: IPropertyPaneLinkProps - - uid: sp-webpart-base.IPropertyPanePage + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' name: IPropertyPanePage - - uid: sp-webpart-base.IPropertyPanePageHeader + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' name: IPropertyPanePageHeader - - uid: sp-webpart-base.IPropertyPaneSliderProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' name: IPropertyPaneSliderProps - - uid: sp-webpart-base.IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' name: IPropertyPaneTextFieldProps - - uid: sp-webpart-base.IPropertyPaneToggleProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' name: IPropertyPaneToggleProps - - uid: sp-webpart-base.ISDKs + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' name: ISDKs - - uid: sp-webpart-base.ISerializedServerProcessedData + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' name: ISerializedServerProcessedData - - uid: sp-webpart-base.ISerializedWebPartData + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' name: ISerializedWebPartData - - uid: sp-webpart-base.IWebPartContext + - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' name: IWebPartContext - - uid: sp-webpart-base.IWebPartData + - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' name: IWebPartData - - uid: sp-webpart-base.IWebPartPropertiesMetadata + - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' name: IWebPartPropertiesMetadata - - uid: sp-webpart-base.IWebPartPropertyMetadata + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' name: IWebPartPropertyMetadata - - uid: sp-webpart-base.PropertyPaneButtonType + - uid: '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' name: PropertyPaneButtonType - - uid: sp-webpart-base.PropertyPaneDropdownOptionType + - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' name: PropertyPaneDropdownOptionType - - uid: sp-webpart-base.PropertyPaneFieldType + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' name: PropertyPaneFieldType - - uid: sp-webpart-base.WebPartContext + - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!WebPartContext:class' name: WebPartContext - - uid: sp-webpart-base.WebPartFormFactor + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' name: WebPartFormFactor diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 638aad76..8f4f7cc1 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.BaseClientSideWebPart + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' summary: >- This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs to inherit from this class. @@ -23,23 +23,25 @@ items: - typeScript type: class extends: - - 'BaseWebPart ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!BaseClientSideWebPart~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!BaseClientSideWebPart~1:complex' + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.BaseClientSideWebPart.(constructor) - - sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender - - sp-webpart-base.BaseClientSideWebPart.clearError - - sp-webpart-base.BaseClientSideWebPart.context - - sp-webpart-base.BaseClientSideWebPart.domElement - - sp-webpart-base.BaseClientSideWebPart.isRenderAsync - - sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged - - sp-webpart-base.BaseClientSideWebPart.onDispose - - sp-webpart-base.BaseClientSideWebPart.render - - sp-webpart-base.BaseClientSideWebPart.renderCompleted - - sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData - - sp-webpart-base.BaseClientSideWebPart.renderedOnce - - sp-webpart-base.BaseClientSideWebPart.renderError - - uid: sp-webpart-base.BaseClientSideWebPart.(constructor) + - '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' summary: Constructor for the BaseClientSideWebPart class. remarks: >- It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. @@ -52,7 +54,7 @@ items: type: constructor syntax: content: constructor(); - - uid: sp-webpart-base.BaseClientSideWebPart.canOpenPopupOnRender + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' summary: This property indicates whether a web part can open a popup on initial render. remarks: >- In some environments the host re-renders the web parts frequently, and therefore opening popups during render will @@ -74,7 +76,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.BaseClientSideWebPart.clearError + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' summary: This API should be used to clear the error message from the web part display area. name: clearError() fullName: clearError() @@ -87,7 +89,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.context + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a @@ -99,11 +101,11 @@ items: - typeScript type: property syntax: - content: 'protected readonly context: WebPartContext;' + content: 'readonly context: WebPartContext;' return: type: - - sp-webpart-base.WebPartContext - - uid: sp-webpart-base.BaseClientSideWebPart.domElement + - '@microsoft/sp-webpart-base!default:class' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' summary: >- This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. @@ -116,8 +118,8 @@ items: content: 'protected readonly domElement: HTMLElement;' return: type: - - HTMLElement - - uid: sp-webpart-base.BaseClientSideWebPart.isRenderAsync + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' summary: Indicates whether the web part is rendering in Async mode. remarks: >- If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part @@ -137,7 +139,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' summary: This event method is called when the display mode of a web part is changed. remarks: >- The default implementation of this API calls the web part render method to re-render the web part with the new @@ -160,8 +162,8 @@ items: - id: oldDisplayMode description: The old display mode. type: - - sp-core-library.DisplayMode - - uid: sp-webpart-base.BaseClientSideWebPart.onDispose + - '@microsoft/sp-core-library!DisplayMode:enum' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local @@ -181,7 +183,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.render + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' summary: >- This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. @@ -196,7 +198,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.renderCompleted + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' summary: >- This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part @@ -213,7 +215,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' summary: >- This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not. @@ -228,7 +230,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.BaseClientSideWebPart.renderedOnce + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' summary: >- This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens. @@ -242,7 +244,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.BaseClientSideWebPart.renderError + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' summary: >- This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. @@ -261,4 +263,31 @@ items: - id: error description: An error object containing the error message to render. type: - - Error + - '!Error:interface' +references: + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart~0:complex' + name: BaseWebPart + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPart + fullName: default + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart~1:complex' + name: BaseWebPart + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPart + fullName: default + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-webpart-base!default:class' + name: WebPartContext + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + name: DisplayMode + - uid: '!Error:interface' + name: Error diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index ed2b8fdd..893c3548 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.BaseWebPart + - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' summary: >- This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. @@ -10,34 +10,36 @@ items: - typeScript type: class extends: - - sp-component-base.BaseComponent + - '@microsoft/sp-component-base!BaseComponent:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' implements: - - 'IPropertyPaneConsumer ' - package: sp-webpart-base + - '@microsoft/sp-property-pane!IPropertyPaneConsumer:interface' + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.BaseWebPart.(constructor) - - sp-webpart-base.BaseWebPart.accessibleTitle - - sp-webpart-base.BaseWebPart.context - - sp-webpart-base.BaseWebPart.dataVersion - - sp-webpart-base.BaseWebPart.description - - sp-webpart-base.BaseWebPart.disableReactivePropertyChanges - - sp-webpart-base.BaseWebPart.displayMode - - sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration - - sp-webpart-base.BaseWebPart.onAfterDeserialize - - sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied - - sp-webpart-base.BaseWebPart.onBeforeSerialize - - sp-webpart-base.BaseWebPart.onDisplayModeChanged - - sp-webpart-base.BaseWebPart.onDispose - - sp-webpart-base.BaseWebPart.onInit - - sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationComplete - - sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationStart - - sp-webpart-base.BaseWebPart.onPropertyPaneFieldChanged - - sp-webpart-base.BaseWebPart.onPropertyPaneRendered - - sp-webpart-base.BaseWebPart.previewImageUrl - - sp-webpart-base.BaseWebPart.properties - - sp-webpart-base.BaseWebPart.propertiesMetadata - - sp-webpart-base.BaseWebPart.title - - uid: sp-webpart-base.BaseWebPart.(constructor) + - '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' + - '@microsoft/sp-webpart-base!BaseWebPart#context:member' + - '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' + - '@microsoft/sp-webpart-base!BaseWebPart#description:member' + - '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' + - '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' + - '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' + - '@microsoft/sp-webpart-base!BaseWebPart#properties:member' + - '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' + - '@microsoft/sp-webpart-base!BaseWebPart#title:member' + - uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' summary: Constructor for the `BaseWebPart` class. remarks: >- It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. @@ -50,7 +52,7 @@ items: type: constructor syntax: content: constructor(); - - uid: sp-webpart-base.BaseWebPart.accessibleTitle + - uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' summary: >- This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing @@ -65,7 +67,7 @@ items: return: type: - string - - uid: sp-webpart-base.BaseWebPart.context + - uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a @@ -77,11 +79,11 @@ items: - typeScript type: property syntax: - content: 'protected readonly context: BaseWebPartContext;' + content: 'readonly context: BaseWebPartContext;' return: type: - - sp-webpart-base.BaseWebPartContext - - uid: sp-webpart-base.BaseWebPart.dataVersion + - '@microsoft/sp-webpart-base!default:class' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' summary: >- The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 @@ -94,8 +96,8 @@ items: content: 'protected readonly dataVersion: Version;' return: type: - - sp-core-library.Version - - uid: sp-webpart-base.BaseWebPart.description + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' summary: Description of the WebPart name: description fullName: description @@ -107,7 +109,7 @@ items: return: type: - string - - uid: sp-webpart-base.BaseWebPart.disableReactivePropertyChanges + - uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. remarks: >- The default behavior is Reactive. @@ -130,7 +132,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.BaseWebPart.displayMode + - uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' summary: This property is the current display mode of the web part. name: displayMode fullName: displayMode @@ -141,8 +143,8 @@ items: content: 'protected readonly displayMode: DisplayMode;' return: type: - - sp-core-library.DisplayMode - - uid: sp-webpart-base.BaseWebPart.getPropertyPaneConfiguration + - '@microsoft/sp-core-library!DisplayMode:enum' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' summary: >- This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the @@ -162,9 +164,9 @@ items: content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: type: - - sp-webpart-base.IPropertyPaneConfiguration + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' description: '' - - uid: sp-webpart-base.BaseWebPart.onAfterDeserialize + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' summary: 'This API is called after the web part is deserialized to an object, right before the property bag is populated.' remarks: >- The default implementation is a no-op. A web part developer can override this API if the deserialized object does @@ -201,8 +203,8 @@ items: serialized by an older web part. Web parts can define their data version by overriding the dataVersion property. type: - - sp-core-library.Version - - uid: sp-webpart-base.BaseWebPart.onAfterPropertyPaneChangesApplied + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' summary: >- This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. @@ -217,7 +219,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseWebPart.onBeforeSerialize + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' summary: This event method is called before the web part is serialized. remarks: >- The default implementation is a no-op. The serialization process serializes the web part property bag i.e. @@ -237,7 +239,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseWebPart.onDisplayModeChanged + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' summary: This event method is called when the display mode of a web part is changed. remarks: >- The default implementation of this API calls the web part render method to re-render the web part with the new @@ -258,8 +260,8 @@ items: - id: oldDisplayMode description: The old display mode. type: - - sp-core-library.DisplayMode - - uid: sp-webpart-base.BaseWebPart.onDispose + - '@microsoft/sp-core-library!DisplayMode:enum' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local @@ -277,7 +279,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseWebPart.onInit + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' summary: This event method is called when the web part is initialized. remarks: >- This API should be overridden to perform long running operations e.g. data fetching from a remote service before @@ -292,9 +294,9 @@ items: content: 'protected onInit(): Promise;' return: type: - - Promise + - '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' description: '' - - uid: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationComplete + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' summary: This API is invoked when the configuration is completed on the PropertyPane. remarks: |- This event method is invoked in the following cases: @@ -317,7 +319,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseWebPart.onPropertyPaneConfigurationStart + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' summary: This event method is invoked when the configuration starts on the PropertyPane. remarks: |- This event method is invoked in the following cases: @@ -336,7 +338,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseWebPart.onPropertyPaneFieldChanged + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' summary: >- This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. @@ -367,7 +369,7 @@ items: description: New value of the property. This value could be undefined/empty in the case of custom field. type: - any - - uid: sp-webpart-base.BaseWebPart.onPropertyPaneRendered + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' summary: This API is invoked when the PropertyPane is rendered. name: onPropertyPaneRendered() fullName: onPropertyPaneRendered() @@ -380,7 +382,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.BaseWebPart.previewImageUrl + - uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' summary: >- This property points to the preview image for the web part. The base implementation returns undefined. Web parts that want to provide a valid preview image url need to override this API. The preview image url can be used to @@ -391,11 +393,11 @@ items: - typeScript type: property syntax: - content: 'protected readonly previewImageUrl: string | undefined;' + content: 'readonly previewImageUrl: string | undefined;' return: type: - string | undefined - - uid: sp-webpart-base.BaseWebPart.properties + - uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' summary: This property is the pointer to the custom property bag of the web part. name: properties fullName: properties @@ -407,13 +409,13 @@ items: return: type: - TProperties - - uid: sp-webpart-base.BaseWebPart.propertiesMetadata + - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' summary: >- This property defines metadata for the web part property bag. The metadata can help SharePoint understand the content of the properties better and perform relevant services on the data. remarks: >- - See [IWebPartPropertiesMetadata](xref:sp-webpart-base.IWebPartPropertiesMetadata) for more information about how - to define metadata + See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more + information about how to define metadata name: propertiesMetadata fullName: propertiesMetadata langs: @@ -423,8 +425,8 @@ items: content: 'protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;' return: type: - - IWebPartPropertiesMetadata | undefined - - uid: sp-webpart-base.BaseWebPart.title + - '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata~0:complex' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' summary: Title of the WebPart name: title fullName: title @@ -436,3 +438,34 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-property-pane!IPropertyPaneConsumer:interface' + name: IPropertyPaneConsumer + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPartContext + - uid: '@microsoft/sp-core-library!Version:class' + name: Version + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + name: DisplayMode + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:class' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata~0:complex' + name: IWebPartPropertiesMetadata | undefined + fullName: IWebPartPropertiesMetadata | undefined + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!~IWebPartPropertiesMetadata:interface' + name: IWebPartPropertiesMetadata + fullName: IWebPartPropertiesMetadata + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 5c0cdbfb..ae2d8cc0 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.BaseWebPartContext + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' summary: >- Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client. @@ -16,14 +16,16 @@ items: - typeScript type: class extends: - - sp-component-base.BaseComponentContext - package: sp-webpart-base + - '@microsoft/sp-component-base!BaseComponentContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.BaseWebPartContext.formFactor - - sp-webpart-base.BaseWebPartContext.manifest - - sp-webpart-base.BaseWebPartContext.propertyPane - - sp-webpart-base.BaseWebPartContext.webPartTag - - uid: sp-webpart-base.BaseWebPartContext.formFactor + - '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' + - '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' + - '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' + - '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' summary: Form factor of the web part. remarks: >- Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set @@ -38,8 +40,8 @@ items: content: 'readonly formFactor: WebPartFormFactor;' return: type: - - sp-webpart-base.WebPartFormFactor - - uid: sp-webpart-base.BaseWebPartContext.manifest + - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' summary: Manifest for the client-side component. name: manifest fullName: manifest @@ -50,8 +52,8 @@ items: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: type: - - IClientSideWebPartManifestInstance - - uid: sp-webpart-base.BaseWebPartContext.propertyPane + - '@microsoft/sp-webpart-base!BaseWebPartContext#manifest~0:complex' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' summary: Accessor for common web part property pane operations. name: propertyPane fullName: propertyPane @@ -62,8 +64,8 @@ items: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: type: - - sp-webpart-base.IPropertyPaneAccessor - - uid: sp-webpart-base.BaseWebPartContext.webPartTag + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' summary: Web part tag to be used for logging and telemetry. name: webPartTag fullName: webPartTag @@ -75,3 +77,19 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + name: WebPartFormFactor + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest~0:complex' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + name: IPropertyPaneAccessor diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 280bd790..250216c3 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.DynamicDataSharedDepth + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' summary: Enum for the possible values of shared depth of the dynamic data reference. deprecated: content: >- @@ -11,12 +11,12 @@ items: langs: - typeScript type: enum - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.DynamicDataSharedDepth.None - - sp-webpart-base.DynamicDataSharedDepth.Property - - sp-webpart-base.DynamicDataSharedDepth.Source - - uid: sp-webpart-base.DynamicDataSharedDepth.None + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' summary: Indicates that nothing is shared. name: None fullName: None @@ -24,7 +24,7 @@ items: - typeScript type: field numericValue: '0' - - uid: sp-webpart-base.DynamicDataSharedDepth.Property + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' summary: Indicates that both the dynamic data source and the property are shared. name: Property fullName: Property @@ -32,7 +32,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-webpart-base.DynamicDataSharedDepth.Source + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' summary: Indicates that the dynamic data source is shared. name: Source fullName: Source diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index b4a1e349..73622b7a 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' summary: >- Interface to be implemented by a component that should display the loading indicator and error messages for a web part. @@ -9,13 +9,13 @@ items: langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.IClientSideWebPartStatusRenderer.clearError - - sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator - - sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator - - sp-webpart-base.IClientSideWebPartStatusRenderer.renderError - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearError + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' summary: Clear the webpart error message. name: clearError(domElement) fullName: clearError(domElement) @@ -32,8 +32,8 @@ items: - id: domElement description: the web part container div. type: - - HTMLElement - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' summary: Clear the loading indicator. name: clearLoadingIndicator(domElement) fullName: clearLoadingIndicator(domElement) @@ -50,8 +50,8 @@ items: - id: domElement description: the web part container div. type: - - Element - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator + - '!Element:interface' + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' summary: Display a loading spinner. name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' @@ -68,7 +68,7 @@ items: - id: domElement description: the web part container div. type: - - Element + - '!Element:interface' - id: loadingMessage description: the message to be displayed when the loading spinner id displayed. type: @@ -77,7 +77,7 @@ items: description: timeout to render the loading indicator. Default is 1500ms. type: - number - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.renderError + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' summary: Render the provided error message in the webpart container div. name: 'renderError(domElement, error)' fullName: 'renderError(domElement, error)' @@ -94,8 +94,22 @@ items: - id: domElement description: the web part container div. type: - - HTMLElement + - '!HTMLElement:interface' - id: error description: the error message. type: - - Error | string + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError~0:complex' +references: + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '!Element:interface' + name: Element + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError~0:complex' + name: Error | string + fullName: Error | string + spec.typeScript: + - uid: '!Error:interface' + name: Error + fullName: Error + - name: ' | string' + fullName: ' | string' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index b160aee7..c426b3d1 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' summary: Configuration related to a shared property. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IDynamicDataSharedPropertyConfiguration ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~0:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + fullName: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~1:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + fullName: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index db560354..e2776324 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' summary: Property pane dynamic data property filters. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IDynamicDataSharedPropertyFilters ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~0:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyFilters + fullName: SPPropertyPane.IDynamicDataSharedPropertyFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~1:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyFilters + fullName: SPPropertyPane.IDynamicDataSharedPropertyFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index bc2677d3..656caef3 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' summary: Configuration related to a shared source. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IDynamicDataSharedSourceConfiguration ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~0:complex' + name: SPPropertyPane.IDynamicDataSharedSourceConfiguration + fullName: SPPropertyPane.IDynamicDataSharedSourceConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~1:complex' + name: SPPropertyPane.IDynamicDataSharedSourceConfiguration + fullName: SPPropertyPane.IDynamicDataSharedSourceConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index 382eae8a..c8a4b63c 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' summary: Property pane dynamic data source filters. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IDynamicDataSharedSourceFilters ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~0:complex' + name: SPPropertyPane.IDynamicDataSharedSourceFilters + fullName: SPPropertyPane.IDynamicDataSharedSourceFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~1:complex' + name: SPPropertyPane.IDynamicDataSharedSourceFilters + fullName: SPPropertyPane.IDynamicDataSharedSourceFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index b5d0a2d3..b37d462c 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -1,18 +1,21 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IMicrosoftTeams + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. name: IMicrosoftTeams fullName: IMicrosoftTeams langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.IMicrosoftTeams.context - - sp-webpart-base.IMicrosoftTeams.teamsJs - - uid: sp-webpart-base.IMicrosoftTeams.context - summary: Microsoft Teams Context. + - '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' + - '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' + summary: Microsoft Teams' Context. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) name: context fullName: context langs: @@ -22,8 +25,8 @@ items: content: 'context: microsoftTeams.Context;' return: type: - - microsoftTeams.Context - - uid: sp-webpart-base.IMicrosoftTeams.teamsJs + - '@microsoft/sp-webpart-base!IMicrosoftTeams#context~0:complex' + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' summary: Microsoft Teams SDK. name: teamsJs fullName: teamsJs @@ -35,3 +38,13 @@ items: return: type: - typeof microsoftTeams +references: + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context~0:complex' + name: microsoftTeams.Context + fullName: microsoftTeams.Context + spec.typeScript: + - name: microsoftTeams. + fullName: microsoftTeams. + - uid: '@microsoft/teams-js!Context:interface' + name: Context + fullName: Context diff --git a/SP-Framework/sp-webpart-base/ioffice.yml b/SP-Framework/sp-webpart-base/ioffice.yml new file mode 100644 index 00000000..49aba95f --- /dev/null +++ b/SP-Framework/sp-webpart-base/ioffice.yml @@ -0,0 +1,29 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IOffice:interface' + summary: Provides access to the Office context. Only provided when the web part is loaded in Office. + isPreview: true + name: IOffice + fullName: IOffice + langs: + - typeScript + type: interface + package: '@microsoft/sp-webpart-base!' + children: + - '@microsoft/sp-webpart-base!IOffice#context:member' + - uid: '@microsoft/sp-webpart-base!IOffice#context:member' + summary: Microsoft Office SDK. + isPreview: true + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'context: Office.Context;' + return: + type: + - '!Office.Context:interface' +references: + - uid: '!Office.Context:interface' + name: Office.Context diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index f712d2a2..0fae5444 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneAccessor + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' summary: >- Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane. @@ -9,14 +9,15 @@ items: langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.IPropertyPaneAccessor.close - - sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen - - sp-webpart-base.IPropertyPaneAccessor.isRenderedByWebPart - - sp-webpart-base.IPropertyPaneAccessor.open - - sp-webpart-base.IPropertyPaneAccessor.refresh - - uid: sp-webpart-base.IPropertyPaneAccessor.close + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' summary: This API should be used to close the PropertyPane to help configure the web part. name: close() fullName: close() @@ -29,7 +30,7 @@ items: type: - void description: '' - - uid: sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' summary: Returns true if the PropertyPane is open. name: isPropertyPaneOpen() fullName: isPropertyPaneOpen() @@ -42,7 +43,7 @@ items: type: - boolean description: '' - - uid: sp-webpart-base.IPropertyPaneAccessor.isRenderedByWebPart + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' summary: Indicates whether the PropertyPane was initially opened by the web part. remarks: >- For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if @@ -58,7 +59,7 @@ items: type: - boolean description: '' - - uid: sp-webpart-base.IPropertyPaneAccessor.open + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' summary: This API should be used to open the PropertyPane to help configure the web part. name: open() fullName: open() @@ -71,7 +72,26 @@ items: type: - void description: '' - - uid: sp-webpart-base.IPropertyPaneAccessor.refresh + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' + summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. + remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' + name: openDetails(context) + fullName: openDetails(context) + langs: + - typeScript + type: method + syntax: + content: 'openDetails(context?: any): void;' + return: + type: + - void + description: '' + parameters: + - id: context + description: Add additional context for property pane + type: + - any + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' summary: This API should be used to invoke the PropertyPane to help configure the web part. remarks: >- This operation only works when the PropertyPane is already open for the currently active web part. If the diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 542f3236..5dc9e106 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneButtonProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' summary: PropertyPane button props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneButtonProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~0:complex' + name: SPPropertyPane.IPropertyPaneButtonProps + fullName: SPPropertyPane.IPropertyPaneButtonProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~1:complex' + name: SPPropertyPane.IPropertyPaneButtonProps + fullName: SPPropertyPane.IPropertyPaneButtonProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 771df1e2..b033ef96 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' summary: PropertyPane CheckBox component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneCheckboxProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~0:complex' + name: SPPropertyPane.IPropertyPaneCheckboxProps + fullName: SPPropertyPane.IPropertyPaneCheckboxProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~1:complex' + name: SPPropertyPane.IPropertyPaneCheckboxProps + fullName: SPPropertyPane.IPropertyPaneCheckboxProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 3603db65..017aa245 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' summary: PropertyPane ChoiceGroup option props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneChoiceGroupOption ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~0:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOption + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~1:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOption + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 2fbac45d..4d8e935b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' summary: PropertyPane ChoiceGroup icon props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~0:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~1:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 03733e3c..67219ec4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' summary: PropertyPane ChoiceGroup props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneChoiceGroupProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~0:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~1:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 1a6fbdff..32c230c9 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' summary: Property pane conditional group. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneConditionalGroup ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~0:complex' + name: SPPropertyPane.IPropertyPaneConditionalGroup + fullName: SPPropertyPane.IPropertyPaneConditionalGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~1:complex' + name: SPPropertyPane.IPropertyPaneConditionalGroup + fullName: SPPropertyPane.IPropertyPaneConditionalGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 4773c73b..afd5af58 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' summary: Web part configuration settings deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneConfiguration ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~0:complex' + name: SPPropertyPane.IPropertyPaneConfiguration + fullName: SPPropertyPane.IPropertyPaneConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~1:complex' + name: SPPropertyPane.IPropertyPaneConfiguration + fullName: SPPropertyPane.IPropertyPaneConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 27a58657..f72ac2a1 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' summary: PropertyPane CustomPropertyField props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneCustomFieldProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneCustomFieldProps + fullName: SPPropertyPane.IPropertyPaneCustomFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneCustomFieldProps + fullName: SPPropertyPane.IPropertyPaneCustomFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 894b9e91..8f39e09d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' summary: PropertyPane dropdown callout properties. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDropdownCalloutProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~0:complex' + name: SPPropertyPane.IPropertyPaneDropdownCalloutProps + fullName: SPPropertyPane.IPropertyPaneDropdownCalloutProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~1:complex' + name: SPPropertyPane.IPropertyPaneDropdownCalloutProps + fullName: SPPropertyPane.IPropertyPaneDropdownCalloutProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 010a6618..e805a06b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDropdownOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' summary: PropertyPane drop down options. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDropdownOption ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~0:complex' + name: SPPropertyPane.IPropertyPaneDropdownOption + fullName: SPPropertyPane.IPropertyPaneDropdownOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~1:complex' + name: SPPropertyPane.IPropertyPaneDropdownOption + fullName: SPPropertyPane.IPropertyPaneDropdownOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 1e21e8b6..2e643bb7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDropdownProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' summary: PropertyPane drop down component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDropdownProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~0:complex' + name: SPPropertyPane.IPropertyPaneDropdownProps + fullName: SPPropertyPane.IPropertyPaneDropdownProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~1:complex' + name: SPPropertyPane.IPropertyPaneDropdownProps + fullName: SPPropertyPane.IPropertyPaneDropdownProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 9c8fa22d..18ae1fe2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDynamicFieldFilters + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' summary: Property pane dynamic field filters which is an intersection of both source and property filters. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDynamicFieldFilters ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldFilters + fullName: SPPropertyPane.IPropertyPaneDynamicFieldFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldFilters + fullName: SPPropertyPane.IPropertyPaneDynamicFieldFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 2a49daa9..4b891b82 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' summary: PropertyPaneDynamicField props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDynamicFieldProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 072f7b74..9740264d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' summary: PropertyPane DynamicFieldSet props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDynamicFieldSetProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 78ebd98c..d231515f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' summary: '`PropertyPaneDynamicData` component props.' deprecated: content: '- This has been replaced by IPropertyPaneDynamicFieldProps' @@ -11,5 +11,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneDynamicTextFieldProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 718f56f7..205f229d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneField + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' summary: PropertyPane field. deprecated: content: >- @@ -12,5 +12,33 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneField ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' + name: SPPropertyPane.IPropertyPaneField + fullName: SPPropertyPane.IPropertyPaneField + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: ' ' + fullName: ' ' + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' + name: SPPropertyPane.IPropertyPaneField + fullName: SPPropertyPane.IPropertyPaneField + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: ' ' + fullName: ' ' diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index babfea52..b985779f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' summary: PropertyPane group. Group is part of the PropertyPanePage. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneGroup ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneGroup~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneGroup~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup~0:complex' + name: SPPropertyPane.IPropertyPaneGroup + fullName: SPPropertyPane.IPropertyPaneGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup~1:complex' + name: SPPropertyPane.IPropertyPaneGroup + fullName: SPPropertyPane.IPropertyPaneGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index 33c7008b..18f19d3e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneLabelProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' summary: PropertyPaneLabel component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneLabelProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~0:complex' + name: SPPropertyPane.IPropertyPaneLabelProps + fullName: SPPropertyPane.IPropertyPaneLabelProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~1:complex' + name: SPPropertyPane.IPropertyPaneLabelProps + fullName: SPPropertyPane.IPropertyPaneLabelProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 3065f52e..c67f348e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneLinkProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' summary: PropertyPaneLink component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneLinkProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~0:complex' + name: SPPropertyPane.IPropertyPaneLinkProps + fullName: SPPropertyPane.IPropertyPaneLinkProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~1:complex' + name: SPPropertyPane.IPropertyPaneLinkProps + fullName: SPPropertyPane.IPropertyPaneLinkProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index 1435109e..cb73d7e8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPanePage + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' summary: PropertyPanePage interface. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPanePage ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPanePage~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPanePage~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage~0:complex' + name: SPPropertyPane.IPropertyPanePage + fullName: SPPropertyPane.IPropertyPanePage + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + fullName: IPropertyPanePage + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage~1:complex' + name: SPPropertyPane.IPropertyPanePage + fullName: SPPropertyPane.IPropertyPanePage + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + fullName: IPropertyPanePage diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index e5e78a5b..e498c3aa 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPanePageHeader + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' summary: PropertyPane header. This header remains same for all the pages. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPanePageHeader ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPanePageHeader~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~0:complex' + name: SPPropertyPane.IPropertyPanePageHeader + fullName: SPPropertyPane.IPropertyPanePageHeader + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~1:complex' + name: SPPropertyPane.IPropertyPanePageHeader + fullName: SPPropertyPane.IPropertyPanePageHeader + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index c3a04b83..d73275cf 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneSliderProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' summary: PropertyPaneSliderProps component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneSliderProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~0:complex' + name: SPPropertyPane.IPropertyPaneSliderProps + fullName: SPPropertyPane.IPropertyPaneSliderProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~1:complex' + name: SPPropertyPane.IPropertyPaneSliderProps + fullName: SPPropertyPane.IPropertyPaneSliderProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 1c94fb9a..7a252708 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' summary: PropertyPaneTextField component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneTextFieldProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneTextFieldProps + fullName: SPPropertyPane.IPropertyPaneTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneTextFieldProps + fullName: SPPropertyPane.IPropertyPaneTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index cc39aa3a..e6445ba8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneToggleProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' summary: PropertyPaneToggle component props. deprecated: content: >- @@ -12,5 +12,26 @@ items: - typeScript type: interface extends: - - 'SPPropertyPane.IPropertyPaneToggleProps ' - package: sp-webpart-base + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~0:complex' + name: SPPropertyPane.IPropertyPaneToggleProps + fullName: SPPropertyPane.IPropertyPaneToggleProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~1:complex' + name: SPPropertyPane.IPropertyPaneToggleProps + fullName: SPPropertyPane.IPropertyPaneToggleProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index b57dfe04..6d89dbbe 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -1,16 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.ISDKs + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' summary: Conditional set of SDKs provided by SPFx dependent on the environment. name: ISDKs fullName: ISDKs langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.ISDKs.microsoftTeams - - uid: sp-webpart-base.ISDKs.microsoftTeams + - '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' + - '@microsoft/sp-webpart-base!ISDKs#office:member' + - uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' summary: >- Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams. @@ -26,4 +27,27 @@ items: content: 'microsoftTeams?: IMicrosoftTeams;' return: type: - - sp-webpart-base.IMicrosoftTeams + - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - uid: '@microsoft/sp-webpart-base!ISDKs#office:member' + summary: >- + Contextual information about the current Office app. This object will only be defined if a component is being + hosted in an Office app. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office](https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office) + isPreview: true + name: office + fullName: office + langs: + - typeScript + type: property + syntax: + content: 'office?: IOffice;' + return: + type: + - '@microsoft/sp-webpart-base!IOffice:interface' +references: + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + name: IMicrosoftTeams + - uid: '@microsoft/sp-webpart-base!IOffice:interface' + name: IOffice diff --git a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index 42b55b2f..7409a7ec 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -1,19 +1,19 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.ISerializedServerProcessedData + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' summary: Contains collections of data that can be processed by server side services like search index and link fixup name: ISerializedServerProcessedData fullName: ISerializedServerProcessedData langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.ISerializedServerProcessedData.htmlStrings - - sp-webpart-base.ISerializedServerProcessedData.imageSources - - sp-webpart-base.ISerializedServerProcessedData.links - - sp-webpart-base.ISerializedServerProcessedData.searchablePlainTexts - - uid: sp-webpart-base.ISerializedServerProcessedData.htmlStrings + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#htmlStrings:member' + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#imageSources:member' + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#links:member' + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#searchablePlainTexts:member' + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#htmlStrings:member' summary: A key-value map where keys are string identifiers and values are rich text with HTML format. remarks: >- SharePoint servers treat the values as HTML content and run services like safety checks, search index and link @@ -48,7 +48,7 @@ items: { [key: string]: string; } - - uid: sp-webpart-base.ISerializedServerProcessedData.imageSources + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#imageSources:member' summary: A key-value map where keys are string identifiers and values are image sources. remarks: |- SharePoint servers treat the values as image sources and run services like search index and link fixup on them. @@ -78,7 +78,7 @@ items: { [key: string]: string; } - - uid: sp-webpart-base.ISerializedServerProcessedData.links + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#links:member' summary: A key-value map where keys are string identifiers and values are links. remarks: |- SharePoint servers treat the values as links and run services like link fixup on them. @@ -108,7 +108,7 @@ items: { [key: string]: string; } - - uid: sp-webpart-base.ISerializedServerProcessedData.searchablePlainTexts + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#searchablePlainTexts:member' summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. remarks: >- The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index ae5140ff..0d25d154 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.ISerializedWebPartData + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' summary: >- This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data. @@ -9,14 +9,14 @@ items: langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.ISerializedWebPartData.dataVersion - - sp-webpart-base.ISerializedWebPartData.dynamicDataPaths - - sp-webpart-base.ISerializedWebPartData.dynamicDataValues - - sp-webpart-base.ISerializedWebPartData.properties - - sp-webpart-base.ISerializedWebPartData.serverProcessedContent - - uid: sp-webpart-base.ISerializedWebPartData.dataVersion + - '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' summary: Web part data version. remarks: >- Note that data version is different from the version field in the manifest. The manifest version is used to @@ -37,8 +37,8 @@ items: content: 'dataVersion: Version;' return: type: - - sp-core-library.Version - - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataPaths + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. remarks: |- The key is the path within the web part properties, and the value is the dynamic data internal id. @@ -71,7 +71,7 @@ items: { [path: string]: string; } - - uid: sp-webpart-base.ISerializedWebPartData.dynamicDataValues + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' summary: >- Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. @@ -104,7 +104,7 @@ items: { [path: string]: any; } - - uid: sp-webpart-base.ISerializedWebPartData.properties + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- Used by the web part to manage its internal metadata and config data. The framework code never touches these @@ -125,7 +125,7 @@ items: return: type: - any - - uid: sp-webpart-base.ISerializedWebPartData.serverProcessedContent + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' summary: The collections of data that can be processed by server side services like search index and link fixup. name: serverProcessedContent fullName: serverProcessedContent @@ -136,4 +136,9 @@ items: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: type: - - sp-webpart-base.ISerializedServerProcessedData + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' +references: + - uid: '@microsoft/sp-core-library!Version:class' + name: Version + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' + name: ISerializedServerProcessedData diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index ba0fffc4..3625e532 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IWebPartContext + - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' summary: The base context interface for client-side web parts. remarks: >- A "context" object is a collection of well-known services and other objects that are likely to be needed by any @@ -8,26 +8,25 @@ items: e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. deprecated: content: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:sp-webpart-base.WebPartContext) class instead. + - This interface will be removed in an upcoming release. Use the + [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. name: IWebPartContext fullName: IWebPartContext langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.IWebPartContext.domElement - - sp-webpart-base.IWebPartContext.graphHttpClient - - sp-webpart-base.IWebPartContext.httpClient - - sp-webpart-base.IWebPartContext.instanceId - - sp-webpart-base.IWebPartContext.manifest - - sp-webpart-base.IWebPartContext.pageContext - - sp-webpart-base.IWebPartContext.propertyPane - - sp-webpart-base.IWebPartContext.spHttpClient - - sp-webpart-base.IWebPartContext.statusRenderer - - sp-webpart-base.IWebPartContext.webPartTag - - uid: sp-webpart-base.IWebPartContext.domElement + - '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' + - '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' + - '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' + - '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' + - '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' + - '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' + - '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' + - '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' + - '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' summary: Reference to the DOM element that hosts this client-side component. name: domElement fullName: domElement @@ -38,21 +37,8 @@ items: content: 'readonly domElement: HTMLElement;' return: type: - - HTMLElement - - uid: sp-webpart-base.IWebPartContext.graphHttpClient - summary: GraphHttpClient instance scoped to this web part. - isPreview: true - name: graphHttpClient - fullName: graphHttpClient - langs: - - typeScript - type: property - syntax: - content: 'readonly graphHttpClient: GraphHttpClient;' - return: - type: - - GraphHttpClient - - uid: sp-webpart-base.IWebPartContext.httpClient + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' summary: HttpClient instance scoped to this web part. name: httpClient fullName: httpClient @@ -63,8 +49,8 @@ items: content: 'readonly httpClient: HttpClient;' return: type: - - sp-http.HttpClient - - uid: sp-webpart-base.IWebPartContext.instanceId + - '@microsoft/sp-http!HttpClient:class' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' summary: Web part instance id. This is a globally unique value. name: instanceId fullName: instanceId @@ -76,7 +62,7 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartContext.manifest + - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' summary: Manifest for the client-side web part. name: manifest fullName: manifest @@ -87,8 +73,8 @@ items: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: type: - - IClientSideWebPartManifestInstance - - uid: sp-webpart-base.IWebPartContext.pageContext + - '@microsoft/sp-webpart-base!IWebPartContext#manifest~0:complex' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' summary: SharePoint page context. name: pageContext fullName: pageContext @@ -99,8 +85,8 @@ items: content: 'readonly pageContext: PageContext;' return: type: - - sp-page-context.PageContext - - uid: sp-webpart-base.IWebPartContext.propertyPane + - '@microsoft/sp-page-context!PageContext:class' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' summary: Accessor for common web part property pane operations. name: propertyPane fullName: propertyPane @@ -111,8 +97,8 @@ items: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: type: - - sp-webpart-base.IPropertyPaneAccessor - - uid: sp-webpart-base.IWebPartContext.spHttpClient + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' summary: SPHttpClient instance scoped to this web part. name: spHttpClient fullName: spHttpClient @@ -123,8 +109,8 @@ items: content: 'readonly spHttpClient: SPHttpClient;' return: type: - - sp-http.SPHttpClient - - uid: sp-webpart-base.IWebPartContext.statusRenderer + - '@microsoft/sp-http!SPHttpClient:class' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' summary: Web part status renderer. name: statusRenderer fullName: statusRenderer @@ -135,8 +121,8 @@ items: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: type: - - sp-webpart-base.IClientSideWebPartStatusRenderer - - uid: sp-webpart-base.IWebPartContext.webPartTag + - '@microsoft/sp-webpart-base!default:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' summary: Web part tag to be used for logging and telemetry. name: webPartTag fullName: webPartTag @@ -148,3 +134,25 @@ items: return: type: - string +references: + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-http!HttpClient:class' + name: HttpClient + - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest~0:complex' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + - name: + fullName: + - uid: '@microsoft/sp-page-context!PageContext:class' + name: PageContext + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + name: IPropertyPaneAccessor + - uid: '@microsoft/sp-http!SPHttpClient:class' + name: SPHttpClient + - uid: '@microsoft/sp-webpart-base!default:interface' + name: IClientSideWebPartStatusRenderer diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index c1a16d61..7ca29c43 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IWebPartData + - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' summary: This structure represents the serialized state of a web part. remarks: >- When the `serialize()` API is called on a web part, the output should be this structure. The structure of the @@ -11,18 +11,18 @@ items: langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.IWebPartData.dataVersion - - sp-webpart-base.IWebPartData.description - - sp-webpart-base.IWebPartData.dynamicDataPaths - - sp-webpart-base.IWebPartData.dynamicDataValues - - sp-webpart-base.IWebPartData.id - - sp-webpart-base.IWebPartData.instanceId - - sp-webpart-base.IWebPartData.properties - - sp-webpart-base.IWebPartData.serverProcessedContent - - sp-webpart-base.IWebPartData.title - - uid: sp-webpart-base.IWebPartData.dataVersion + - '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' + - '@microsoft/sp-webpart-base!IWebPartData#description:member' + - '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' + - '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' + - '@microsoft/sp-webpart-base!IWebPartData#id:member' + - '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' + - '@microsoft/sp-webpart-base!IWebPartData#properties:member' + - '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' + - '@microsoft/sp-webpart-base!IWebPartData#title:member' + - uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' summary: Web part data version remarks: >- Note that data version is different from the version field in the manifest. The manifest version is used to @@ -44,7 +44,7 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartData.description + - uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' summary: Web part description remarks: |- Used to display the description of the web part. @@ -62,7 +62,7 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartData.dynamicDataPaths + - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' summary: Paths for the dynamic data. remarks: >- This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within @@ -100,7 +100,7 @@ items: { [path: string]: string; } - - uid: sp-webpart-base.IWebPartData.dynamicDataValues + - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' summary: >- Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part. @@ -133,7 +133,7 @@ items: { [path: string]: any; } - - uid: sp-webpart-base.IWebPartData.id + - uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' name: id @@ -146,7 +146,7 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartData.instanceId + - uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' summary: >- Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries. @@ -164,7 +164,7 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartData.properties + - uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- Used by the web part to manage its internal metadata and config data. The framework code never touches these @@ -185,7 +185,7 @@ items: return: type: - any - - uid: sp-webpart-base.IWebPartData.serverProcessedContent + - uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' summary: The collections of data that can be processed by server side services like search index and link fixup name: serverProcessedContent fullName: serverProcessedContent @@ -196,8 +196,8 @@ items: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: type: - - sp-webpart-base.ISerializedServerProcessedData - - uid: sp-webpart-base.IWebPartData.title + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' summary: Web part title remarks: |- Used to display the name of the web part in the toolbox, web part gallery and the page. @@ -215,3 +215,6 @@ items: return: type: - string +references: + - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' + name: ISerializedServerProcessedData diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 621cc990..40c309bb 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IWebPartPropertiesMetadata + - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` remarks: >- The key should be a JSON path to the property in web part properties. The JSON path supports the following @@ -62,4 +62,4 @@ items: langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 6e72ed64..247fd3be 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -1,21 +1,21 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IWebPartPropertyMetadata + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' summary: This is the structure used for map values in `IWebPartPropertiesMetadata` name: IWebPartPropertyMetadata fullName: IWebPartPropertyMetadata langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.IWebPartPropertyMetadata.dynamicPropertyType - - sp-webpart-base.IWebPartPropertyMetadata.isHtmlString - - sp-webpart-base.IWebPartPropertyMetadata.isImageSource - - sp-webpart-base.IWebPartPropertyMetadata.isLink - - sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText - - sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist - - uid: sp-webpart-base.IWebPartPropertyMetadata.dynamicPropertyType + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member' + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' remarks: >- If a web part has properties that are dynamically configurable, then use this flag to declare the property as a @@ -41,7 +41,7 @@ items: return: type: - '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' - - uid: sp-webpart-base.IWebPartPropertyMetadata.isHtmlString + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member' summary: Indicates whether the property should be serialized as HTML. remarks: >- This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on @@ -73,7 +73,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.IWebPartPropertyMetadata.isImageSource + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member' summary: >- Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. @@ -87,7 +87,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.IWebPartPropertyMetadata.isLink + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member' summary: >- Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. @@ -101,7 +101,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.IWebPartPropertyMetadata.isSearchablePlainText + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member' summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. remarks: >- This flag instructs the framework to store the property in a representation that supports search indexing. The @@ -121,7 +121,7 @@ items: return: type: - boolean - - uid: sp-webpart-base.IWebPartPropertyMetadata.shouldNotPersist + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member' summary: Indicates if the framework should persist the property on the server. remarks: >- Use this for properties that are only important in run-time, and do not need to persist on the server. This can diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 559aec7c..aeda8e30 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.PropertyPaneButtonType + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' summary: Enum for all the supported button types. deprecated: content: >- @@ -11,15 +11,15 @@ items: langs: - typeScript type: enum - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.PropertyPaneButtonType.Command - - sp-webpart-base.PropertyPaneButtonType.Compound - - sp-webpart-base.PropertyPaneButtonType.Hero - - sp-webpart-base.PropertyPaneButtonType.Icon - - sp-webpart-base.PropertyPaneButtonType.Normal - - sp-webpart-base.PropertyPaneButtonType.Primary - - uid: sp-webpart-base.PropertyPaneButtonType.Command + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' summary: Optional actions. remarks: >- Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command @@ -30,7 +30,7 @@ items: - typeScript type: field numericValue: '4' - - uid: sp-webpart-base.PropertyPaneButtonType.Compound + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' summary: Always used as a set with both Standard and Primary compound buttons. remarks: >- Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with @@ -41,7 +41,7 @@ items: - typeScript type: field numericValue: '3' - - uid: sp-webpart-base.PropertyPaneButtonType.Hero + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' summary: Hero button. name: Hero fullName: Hero @@ -49,7 +49,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-webpart-base.PropertyPaneButtonType.Icon + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' summary: >- Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar. @@ -65,7 +65,7 @@ items: - typeScript type: field numericValue: '5' - - uid: sp-webpart-base.PropertyPaneButtonType.Normal + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' summary: Optional completion action. remarks: >- Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo @@ -77,7 +77,7 @@ items: - typeScript type: field numericValue: '0' - - uid: sp-webpart-base.PropertyPaneButtonType.Primary + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' summary: Preferred completion action when paired with a Standard button. remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' name: Primary diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 69259dad..5c32748a 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -1,9 +1,9 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.PropertyPaneDropdownOptionType + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' summary: >- Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:sp-webpart-base.PropertyPaneDropdown). + [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). deprecated: content: >- This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from @@ -13,12 +13,12 @@ items: langs: - typeScript type: enum - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.PropertyPaneDropdownOptionType.Divider - - sp-webpart-base.PropertyPaneDropdownOptionType.Header - - sp-webpart-base.PropertyPaneDropdownOptionType.Normal - - uid: sp-webpart-base.PropertyPaneDropdownOptionType.Divider + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' summary: Render a divider. name: Divider fullName: Divider @@ -26,7 +26,7 @@ items: - typeScript type: field numericValue: '1' - - uid: sp-webpart-base.PropertyPaneDropdownOptionType.Header + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' summary: Render menu item as a header. name: Header fullName: Header @@ -34,7 +34,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-webpart-base.PropertyPaneDropdownOptionType.Normal + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' summary: Render normal menu item. name: Normal fullName: Normal diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 695b6462..cca1d134 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.PropertyPaneFieldType + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' summary: |- Enum for all the supported PropertyPane field types. @@ -14,24 +14,24 @@ items: langs: - typeScript type: enum - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.PropertyPaneFieldType.Button - - sp-webpart-base.PropertyPaneFieldType.CheckBox - - sp-webpart-base.PropertyPaneFieldType.ChoiceGroup - - sp-webpart-base.PropertyPaneFieldType.Custom - - sp-webpart-base.PropertyPaneFieldType.Dropdown - - sp-webpart-base.PropertyPaneFieldType.DynamicField - - sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet - - sp-webpart-base.PropertyPaneFieldType.DynamicTextField - - sp-webpart-base.PropertyPaneFieldType.Heading - - sp-webpart-base.PropertyPaneFieldType.HorizontalRule - - sp-webpart-base.PropertyPaneFieldType.Label - - sp-webpart-base.PropertyPaneFieldType.Link - - sp-webpart-base.PropertyPaneFieldType.Slider - - sp-webpart-base.PropertyPaneFieldType.TextField - - sp-webpart-base.PropertyPaneFieldType.Toggle - - uid: sp-webpart-base.PropertyPaneFieldType.Button + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' summary: Button field. name: Button fullName: Button @@ -39,7 +39,7 @@ items: - typeScript type: field numericValue: '11' - - uid: sp-webpart-base.PropertyPaneFieldType.CheckBox + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' summary: Checkbox field. name: CheckBox fullName: CheckBox @@ -47,7 +47,7 @@ items: - typeScript type: field numericValue: '2' - - uid: sp-webpart-base.PropertyPaneFieldType.ChoiceGroup + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' summary: Choice Group field. name: ChoiceGroup fullName: ChoiceGroup @@ -55,7 +55,7 @@ items: - typeScript type: field numericValue: '10' - - uid: sp-webpart-base.PropertyPaneFieldType.Custom + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' summary: Custom field. name: Custom fullName: Custom @@ -63,7 +63,7 @@ items: - typeScript type: field numericValue: '1' - - uid: sp-webpart-base.PropertyPaneFieldType.Dropdown + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' summary: Dropdown field. name: Dropdown fullName: Dropdown @@ -71,7 +71,7 @@ items: - typeScript type: field numericValue: '6' - - uid: sp-webpart-base.PropertyPaneFieldType.DynamicField + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' summary: Dynamic data field. name: DynamicField fullName: DynamicField @@ -79,7 +79,7 @@ items: - typeScript type: field numericValue: '14' - - uid: sp-webpart-base.PropertyPaneFieldType.DynamicFieldSet + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' summary: A set of dynamic fields. name: DynamicFieldSet fullName: DynamicFieldSet @@ -87,7 +87,7 @@ items: - typeScript type: field numericValue: '16' - - uid: sp-webpart-base.PropertyPaneFieldType.DynamicTextField + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' summary: Dynamic Text Field deprecated: content: '- Please use DynamicField' @@ -98,7 +98,7 @@ items: - typeScript type: field numericValue: '15' - - uid: sp-webpart-base.PropertyPaneFieldType.Heading + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' summary: Heading field. name: Heading fullName: Heading @@ -106,7 +106,7 @@ items: - typeScript type: field numericValue: '9' - - uid: sp-webpart-base.PropertyPaneFieldType.HorizontalRule + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' summary: Horizontal Rule field. name: HorizontalRule fullName: HorizontalRule @@ -114,7 +114,7 @@ items: - typeScript type: field numericValue: '12' - - uid: sp-webpart-base.PropertyPaneFieldType.Label + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' summary: Label field. name: Label fullName: Label @@ -122,7 +122,7 @@ items: - typeScript type: field numericValue: '7' - - uid: sp-webpart-base.PropertyPaneFieldType.Link + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' summary: Link field. name: Link fullName: Link @@ -130,7 +130,7 @@ items: - typeScript type: field numericValue: '13' - - uid: sp-webpart-base.PropertyPaneFieldType.Slider + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' summary: Slider field. name: Slider fullName: Slider @@ -138,7 +138,7 @@ items: - typeScript type: field numericValue: '8' - - uid: sp-webpart-base.PropertyPaneFieldType.TextField + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' summary: TextField field. name: TextField fullName: TextField @@ -146,7 +146,7 @@ items: - typeScript type: field numericValue: '3' - - uid: sp-webpart-base.PropertyPaneFieldType.Toggle + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' summary: Toggle field. name: Toggle fullName: Toggle diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index e30261e7..d01b7610 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.WebPartContext + - uid: '@microsoft/sp-webpart-base!WebPartContext:class' summary: >- Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client. @@ -13,14 +13,16 @@ items: - typeScript type: class extends: - - sp-webpart-base.BaseWebPartContext - package: sp-webpart-base + - '@microsoft/sp-webpart-base!default:class' + inheritance: + - type: '@microsoft/sp-webpart-base!default:class' + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.WebPartContext.domElement - - sp-webpart-base.WebPartContext.microsoftTeams - - sp-webpart-base.WebPartContext.sdks - - sp-webpart-base.WebPartContext.statusRenderer - - uid: sp-webpart-base.WebPartContext.domElement + - '@microsoft/sp-webpart-base!WebPartContext#domElement:member' + - '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' + - '@microsoft/sp-webpart-base!WebPartContext#sdks:member' + - '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' + - uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' summary: Reference to the DOM element that hosts this client-side component. name: domElement fullName: domElement @@ -31,14 +33,16 @@ items: content: 'readonly domElement: HTMLElement;' return: type: - - HTMLElement - - uid: sp-webpart-base.WebPartContext.microsoftTeams + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' summary: >- Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + deprecated: + content: '- This function has been deprecated' name: microsoftTeams fullName: microsoftTeams langs: @@ -49,7 +53,7 @@ items: return: type: - typeof microsoftTeams | undefined - - uid: sp-webpart-base.WebPartContext.sdks + - uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' summary: Conditional set of SDKs provided by SPFx dependent on the environment. name: sdks fullName: sdks @@ -60,8 +64,8 @@ items: content: 'readonly sdks: ISDKs;' return: type: - - sp-webpart-base.ISDKs - - uid: sp-webpart-base.WebPartContext.statusRenderer + - '@microsoft/sp-webpart-base!ISDKs:interface' + - uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' summary: Web part status renderer. name: statusRenderer fullName: statusRenderer @@ -72,4 +76,13 @@ items: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: type: - - sp-webpart-base.IClientSideWebPartStatusRenderer + - '@microsoft/sp-webpart-base!default:interface' +references: + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPartContext + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' + name: ISDKs + - uid: '@microsoft/sp-webpart-base!default:interface' + name: IClientSideWebPartStatusRenderer diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index 60fc3323..9002fa19 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -1,6 +1,6 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.WebPartFormFactor + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' summary: Form factor of the web part. remarks: >- This will change based on how the web part is used, not by the web part itself. In cases like web parts used in @@ -12,11 +12,11 @@ items: langs: - typeScript type: enum - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.WebPartFormFactor.FullSize - - sp-webpart-base.WebPartFormFactor.Standard - - uid: sp-webpart-base.WebPartFormFactor.FullSize + - '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' + - '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' summary: 'Full size form factor. This means the web part is rendered in full size, taking all space available in the page.' remarks: This is the case for Teams tabs or single web part App pages. isPreview: true @@ -26,7 +26,7 @@ items: - typeScript type: field numericValue: '1' - - uid: sp-webpart-base.WebPartFormFactor.Standard + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' summary: >- Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height. diff --git a/generate-docs/json/sp-component-base.api.json b/generate-docs/json/sp-component-base.api.json index 6b62d508..f7c1e511 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -93,7 +93,7 @@ { "kind": "Method", "canonicalReference": "@microsoft/sp-component-base!BaseComponent#dispose:member(1)", - "docComment": "/**\n * Disposes the component.\n *\n * @remarks\n *\n * Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the {@link BaseComponent.onDispose} method.\n */\n", + "docComment": "/**\n * Disposes the component.\n *\n * @remarks\n *\n * Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the {@link BaseComponent.onDispose | onDispose()} method.\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/generate-docs/json/sp-loader.api.json b/generate-docs/json/sp-loader.api.json index 659628fa..5dcd2932 100644 --- a/generate-docs/json/sp-loader.api.json +++ b/generate-docs/json/sp-loader.api.json @@ -105,7 +105,7 @@ { "kind": "Method", "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)", - "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadComponent}\n */\n", + "docComment": "/**\n * Loads a component from a manifest.\n *\n * @param manifest - Manifest of the module to load.\n *\n * @returns A promise containing the loaded module.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -168,7 +168,7 @@ { "kind": "Method", "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)", - "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadComponentById}\n *\n * @public\n */\n", + "docComment": "/**\n * Resolve a component id and version, and load it.\n *\n * @param id - The id of the component to load.\n *\n * @param version - The version of the component to load. If version is not defined, the method will load any version of the component.\n *\n * @returns A promise containing the loaded module.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -245,7 +245,7 @@ { "kind": "Method", "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)", - "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadCss}\n */\n", + "docComment": "/**\n * Inserts a `` tag for a stylesheet.\n *\n * @param url - The CSS file URL.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -289,7 +289,7 @@ { "kind": "Method", "canonicalReference": "@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)", - "docComment": "/**\n * {@inheritDoc ISPComponentLoader.loadScript}\n */\n", + "docComment": "/**\n * Given a URL, load a script.\n *\n * @remarks\n *\n * If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not be propagated.\n *\n * @param url - The script URL.\n *\n * @param options - globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the global member's name.\n *\n * @returns A promise containing the loaded module.\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/generate-docs/json/sp-webpart-base.api.json b/generate-docs/json/sp-webpart-base.api.json index 135fe782..b9f23b16 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -1798,7 +1798,7 @@ { "kind": "PropertySignature", "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams#context:member", - "docComment": "/**\n * {@inheritDoc @microsoft/teams-js#Context}\n */\n", + "docComment": "/**\n * Microsoft Teams' Context.\n *\n * @remarks\n *\n * For more information, please see: {@link https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest}\n */\n", "excerptTokens": [ { "kind": "Content", From bd5f77efea259fea87e92f728d9ca40a27c4322d Mon Sep 17 00:00:00 2001 From: John Nguyen Date: Thu, 16 Jan 2020 17:08:21 -0800 Subject: [PATCH 29/55] Update the correct toc yaml file --- SP-Framework/breadcrumb/toc.yml | 557 +------------------------------- SP-Framework/spfx-toc/toc.yml | 541 +++++++++++++++++++------------ 2 files changed, 344 insertions(+), 754 deletions(-) diff --git a/SP-Framework/breadcrumb/toc.yml b/SP-Framework/breadcrumb/toc.yml index d8b9f0ce..4754f2e1 100644 --- a/SP-Framework/breadcrumb/toc.yml +++ b/SP-Framework/breadcrumb/toc.yml @@ -1,554 +1,3 @@ -items: - - name: SharePoint Framework reference - href: ~/overview/sharepoint.md - items: - - name: decorators - uid: '@microsoft/decorators!' - - name: sp-application-base - uid: '@microsoft/sp-application-base!' - items: - - name: ApplicationAccessor - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' - - name: ApplicationCustomizerContext - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - - name: BaseApplicationCustomizer - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - - name: IPlaceholderCreateContentOptions - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' - - name: PlaceholderContent - uid: '@microsoft/sp-application-base!PlaceholderContent:class' - - name: PlaceholderName - uid: '@microsoft/sp-application-base!PlaceholderName:enum' - - name: PlaceholderProvider - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' - - name: sp-component-base - uid: '@microsoft/sp-component-base!' - items: - - name: BaseComponent - uid: '@microsoft/sp-component-base!BaseComponent:class' - - name: BaseComponentContext - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - - name: DynamicDataProvider - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' - - name: DynamicDataSourceManager - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' - - name: DynamicProperty - uid: '@microsoft/sp-component-base!DynamicProperty:class' - - name: IFontStyles - uid: '@microsoft/sp-component-base!IFontStyles:interface' - - name: IPalette - uid: '@microsoft/sp-component-base!IPalette:interface' - - name: IRawStyle - uid: '@microsoft/sp-component-base!IRawStyle:interface' - - name: IReadonlyFontStyles - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - - name: IReadonlyTheme - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - - name: ISemanticColors - uid: '@microsoft/sp-component-base!ISemanticColors:interface' - - name: ISemanticTextColors - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' - - name: ITheme - uid: '@microsoft/sp-component-base!ITheme:interface' - - name: ThemeChangedEventArgs - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - - name: ThemeProvider - uid: '@microsoft/sp-component-base!ThemeProvider:class' - - name: sp-core-library - uid: '@microsoft/sp-core-library!' - items: - - name: DisplayMode - uid: '@microsoft/sp-core-library!DisplayMode:enum' - - name: Environment - uid: '@microsoft/sp-core-library!Environment:class' - - name: EnvironmentType - uid: '@microsoft/sp-core-library!EnvironmentType:enum' - - name: Guid - uid: '@microsoft/sp-core-library!Guid:class' - - name: IDisposable - uid: '@microsoft/sp-core-library!IDisposable:interface' - - name: IRandomNumberGenerator - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - - name: IServiceCollection - uid: '@microsoft/sp-core-library!IServiceCollection:interface' - - name: ISPEventObserver - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' - - name: ITimeProvider - uid: '@microsoft/sp-core-library!ITimeProvider:interface' - - name: Log - uid: '@microsoft/sp-core-library!Log:class' - - name: RandomNumberGenerator - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' - - name: ServiceKey - uid: '@microsoft/sp-core-library!ServiceKey:class' - - name: ServiceScope - uid: '@microsoft/sp-core-library!ServiceScope:class' - - name: Session - uid: '@microsoft/sp-core-library!Session:class' - - name: SPEvent - uid: '@microsoft/sp-core-library!SPEvent:class' - - name: SPEventArgs - uid: '@microsoft/sp-core-library!SPEventArgs:class' - - name: Text - uid: '@microsoft/sp-core-library!Text:class' - - name: TimeProvider - uid: '@microsoft/sp-core-library!TimeProvider:class' - - name: UrlQueryParameterCollection - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - - name: Validate - uid: '@microsoft/sp-core-library!Validate:class' - - name: Version - uid: '@microsoft/sp-core-library!Version:class' - - name: sp-diagnostics - uid: '@microsoft/sp-diagnostics!' - - name: sp-dialog - uid: '@microsoft/sp-dialog!' - items: - - name: BaseDialog - uid: '@microsoft/sp-dialog!BaseDialog:class' - - name: Dialog - uid: '@microsoft/sp-dialog!Dialog:class' - - name: IAlertOptions - uid: '@microsoft/sp-dialog!IAlertOptions:interface' - - name: IDialogConfiguration - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' - - name: IDialogShowOptions - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - - name: IPromptOptions - uid: '@microsoft/sp-dialog!IPromptOptions:interface' - - name: ISecondaryDialogProvider - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' - - name: sp-dynamic-data - uid: '@microsoft/sp-dynamic-data!' - items: - - name: DynamicDataReference - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' - - name: IDynamicDataAnnotatedPropertyValue - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - - name: IDynamicDataCallables - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - - name: IDynamicDataEventDefinition - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - - name: IDynamicDataPropertyDefinition - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - - name: IDynamicDataPropertyMetadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - - name: IDynamicDataPropertyValueMetadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - - name: IDynamicDataPropertyValueMetadataCollection - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - - name: IDynamicDataSource - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - - name: IDynamicDataSourceMetadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - - name: sp-extension-base - uid: '@microsoft/sp-extension-base!' - items: - - name: BaseExtension - uid: '@microsoft/sp-extension-base!BaseExtension:class' - - name: ExtensionContext - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - - name: sp-http - uid: '@microsoft/sp-http!' - items: - - name: AadHttpClient - uid: '@microsoft/sp-http!AadHttpClient:class' - - name: AadHttpClientConfiguration - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' - - name: AadHttpClientFactory - uid: '@microsoft/sp-http!AadHttpClientFactory:class' - - name: AadTokenProvider - uid: '@microsoft/sp-http!AadTokenProvider:class' - - name: AadTokenProviderFactory - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' - - name: DigestCache - uid: '@microsoft/sp-http!DigestCache:class' - - name: GraphRequest - uid: '@microsoft/sp-http!GraphRequest:interface' - - name: HttpClient - uid: '@microsoft/sp-http!HttpClient:class' - - name: HttpClientConfiguration - uid: '@microsoft/sp-http!HttpClientConfiguration:class' - - name: HttpClientResponse - uid: '@microsoft/sp-http!HttpClientResponse:class' - - name: IAadHttpClientConfiguration - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - - name: IAadHttpClientConfigurations - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - - name: IAadHttpClientOptions - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' - - name: IAadTokenProvider - uid: '@microsoft/sp-http!IAadTokenProvider:interface' - - name: IAadTokenProviderConfiguration - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - - name: IDigestCache - uid: '@microsoft/sp-http!IDigestCache:interface' - - name: IHttpClientConfiguration - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - - name: IHttpClientConfigurations - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' - - name: IHttpClientOptions - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - - name: ISPHttpClientBatchConfiguration - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - name: ISPHttpClientBatchConfigurations - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - - name: ISPHttpClientBatchCreationOptions - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - - name: ISPHttpClientBatchOptions - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - - name: ISPHttpClientCommonConfiguration - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - name: ISPHttpClientConfiguration - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - name: ISPHttpClientConfigurations - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - - name: ISPHttpClientOptions - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' - - name: ITokenAcquisitionEventArgs - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' - - name: MSGraphClient - uid: '@microsoft/sp-http!MSGraphClient:class' - - name: MSGraphClientFactory - uid: '@microsoft/sp-http!MSGraphClientFactory:class' - - name: ODataVersion - uid: '@microsoft/sp-http!ODataVersion:class' - - name: SPHttpClient - uid: '@microsoft/sp-http!SPHttpClient:class' - - name: SPHttpClientBatch - uid: '@microsoft/sp-http!SPHttpClientBatch:class' - - name: SPHttpClientBatchConfiguration - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - - name: SPHttpClientCommonConfiguration - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - - name: SPHttpClientConfiguration - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' - - name: SPHttpClientResponse - uid: '@microsoft/sp-http!SPHttpClientResponse:class' - - name: SPHttpHeader - uid: '@microsoft/sp-http!SPHttpHeader:enum' - - name: TokenAcquisitionEventArgs - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' - - name: sp-list-subscription - uid: '@microsoft/sp-list-subscription!' - items: - - name: ICreateSubscriptionSettings - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - - name: IListSubscription - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' - - name: ISubscriptionCallbacks - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' - - name: ListSubscriptionFactory - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' - - name: sp-listview-extensibility - uid: '@microsoft/sp-listview-extensibility!' - items: - - name: BaseFieldCustomizer - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - - name: BaseListViewCommandSet - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - - name: ColumnAccessor - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - - name: Command - uid: '@microsoft/sp-listview-extensibility!Command:class' - - name: FieldCustomizerContext - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - - name: IFieldCustomizerCellEventParameters - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - - name: IListViewCommandSetExecuteEventParameters - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - - name: IListViewCommandSetListViewUpdatedParameters - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - - name: ListItemAccessor - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - - name: ListViewAccessor - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - - name: ListViewCommandSetContext - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - - name: RowAccessor - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - - name: SelectedRowsChangedEventArgs - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' - - name: sp-loader - uid: '@microsoft/sp-loader!' - items: - - name: ILoadScriptOptions - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' - - name: SPComponentLoader - uid: '@microsoft/sp-loader!SPComponentLoader:class' - - name: sp-lodash-subset - uid: '@microsoft/sp-lodash-subset!' - - name: sp-module-interfaces - uid: '@microsoft/sp-module-interfaces!' - items: - - name: IClientSideAssemblyManifest - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - - name: IClientSideComponentLoaderConfiguration - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - - name: IClientSideComponentManifest - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - - name: IClientSideExtensionManifest - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - - name: IClientSideLibraryManifest - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' - - name: IClientSideManifestBase - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - - name: IClientSideWebPartManifest - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' - - name: IClientSideWebPartManifestEntry - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - - name: IClientSideWebPartManifestInstance - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - - name: ICommandDefinition - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - - name: ICommandSetExtensionManifest - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - - name: IComponentModuleConfiguration - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' - - name: ILocalizedPathModuleConfiguration - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - - name: ILocalizedString - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - name: IModuleConfiguration - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - - name: IPath - uid: '@microsoft/sp-module-interfaces!IPath:interface' - - name: IPathModuleConfiguration - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' - - name: PredefinedGroup - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' - - name: sp-odata-types - uid: '@microsoft/sp-odata-types!' - items: - - name: _IODataUserId - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' - - name: IODataBasePermission - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - - name: IODataChangeToken - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' - - name: IODataContextWebInformation - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - - name: IODataList - uid: '@microsoft/sp-odata-types!IODataList:interface' - - name: IODataListItem - uid: '@microsoft/sp-odata-types!IODataListItem:interface' - - name: IODataNavigationNode - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - - name: IODataNavigationNodeCollection - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - - name: IODataUser - uid: '@microsoft/sp-odata-types!IODataUser:interface' - - name: IODataUserCustomAction - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - - name: IODataWeb - uid: '@microsoft/sp-odata-types!IODataWeb:interface' - - name: sp-page-context - uid: '@microsoft/sp-page-context!' - items: - - name: CultureInfo - uid: '@microsoft/sp-page-context!CultureInfo:class' - - name: ISPSystemTime - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' - - name: ISPTimeZoneData - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' - - name: PageContext - uid: '@microsoft/sp-page-context!PageContext:class' - - name: SPDayOfWeek - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - - name: SPField - uid: '@microsoft/sp-page-context!SPField:class' - - name: SPList - uid: '@microsoft/sp-page-context!SPList:class' - - name: SPListItem - uid: '@microsoft/sp-page-context!SPListItem:class' - - name: SPPermission - uid: '@microsoft/sp-page-context!SPPermission:class' - - name: SPSite - uid: '@microsoft/sp-page-context!SPSite:class' - - name: SPTimeZone - uid: '@microsoft/sp-page-context!SPTimeZone:class' - - name: SPUser - uid: '@microsoft/sp-page-context!SPUser:class' - - name: SPWeb - uid: '@microsoft/sp-page-context!SPWeb:class' - - name: sp-property-pane - uid: '@microsoft/sp-property-pane!' - items: - - name: DynamicDataSharedDepth - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - - name: IDynamicDataSharedPropertyConfiguration - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - - name: IDynamicDataSharedPropertyFilters - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - - name: IDynamicDataSharedSourceConfiguration - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - - name: IDynamicDataSharedSourceFilters - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - - name: IPopupWindowProps - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' - - name: IPropertyPaneButtonProps - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - - name: IPropertyPaneCheckboxProps - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - - name: IPropertyPaneChoiceGroupOption - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - - name: IPropertyPaneChoiceGroupOptionIconProps - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - - name: IPropertyPaneChoiceGroupProps - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - - name: IPropertyPaneConditionalGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - - name: IPropertyPaneConfiguration - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - - name: IPropertyPaneCustomFieldProps - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - - name: IPropertyPaneDebounceProperty - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - - name: IPropertyPaneDropdownCalloutProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - - name: IPropertyPaneDropdownOption - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - - name: IPropertyPaneDropdownProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - - name: IPropertyPaneDynamicFieldProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - - name: IPropertyPaneDynamicFieldSetProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - - name: IPropertyPaneDynamicTextFieldProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - - name: IPropertyPaneField - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - - name: IPropertyPaneGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - - name: IPropertyPaneLabelProps - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - - name: IPropertyPaneLinkProps - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - - name: IPropertyPanePage - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' - - name: IPropertyPanePageHeader - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - - name: IPropertyPaneSliderProps - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - - name: IPropertyPaneTextFieldProps - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - - name: IPropertyPaneToggleProps - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - - name: PopupWindowPosition - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' - - name: PropertyPaneButtonType - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - - name: PropertyPaneDropdownOptionType - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - - name: PropertyPaneFieldType - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' - - name: sp-search-extensibility - uid: '@microsoft/sp-search-extensibility!' - items: - - name: BaseSearchQueryModifier - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' - - name: IQuery - uid: '@microsoft/sp-search-extensibility!IQuery:interface' - - name: SearchQueryModifierContext - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' - - name: SearchQueryScenario - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' - - name: sp-webpart-base - uid: '@microsoft/sp-webpart-base!' - items: - - name: BaseClientSideWebPart - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - - name: BaseWebPart - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' - - name: BaseWebPartContext - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' - - name: DynamicDataSharedDepth - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - - name: IClientSideWebPartStatusRenderer - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - - name: IDynamicDataSharedPropertyConfiguration - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - - name: IDynamicDataSharedPropertyFilters - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - - name: IDynamicDataSharedSourceConfiguration - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - - name: IDynamicDataSharedSourceFilters - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - - name: IMicrosoftTeams - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - - name: IOffice - uid: '@microsoft/sp-webpart-base!IOffice:interface' - - name: IPropertyPaneAccessor - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - - name: IPropertyPaneButtonProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - - name: IPropertyPaneCheckboxProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - - name: IPropertyPaneChoiceGroupOption - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - - name: IPropertyPaneChoiceGroupOptionIconProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - - name: IPropertyPaneChoiceGroupProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - - name: IPropertyPaneConditionalGroup - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - - name: IPropertyPaneConfiguration - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - - name: IPropertyPaneCustomFieldProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - - name: IPropertyPaneDropdownCalloutProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - - name: IPropertyPaneDropdownOption - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - - name: IPropertyPaneDropdownProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - - name: IPropertyPaneDynamicFieldFilters - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - - name: IPropertyPaneDynamicFieldProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - - name: IPropertyPaneDynamicFieldSetProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - - name: IPropertyPaneDynamicTextFieldProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - - name: IPropertyPaneField - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - - name: IPropertyPaneGroup - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - - name: IPropertyPaneLabelProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - - name: IPropertyPaneLinkProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - - name: IPropertyPanePage - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - - name: IPropertyPanePageHeader - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - - name: IPropertyPaneSliderProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - - name: IPropertyPaneTextFieldProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - - name: IPropertyPaneToggleProps - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - - name: ISDKs - uid: '@microsoft/sp-webpart-base!ISDKs:interface' - - name: ISerializedServerProcessedData - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - - name: ISerializedWebPartData - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - - name: IWebPartContext - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' - - name: IWebPartData - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' - - name: IWebPartPropertiesMetadata - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - - name: IWebPartPropertyMetadata - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' - - name: PropertyPaneButtonType - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - - name: PropertyPaneDropdownOptionType - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - - name: PropertyPaneFieldType - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - - name: WebPartContext - uid: '@microsoft/sp-webpart-base!WebPartContext:class' - - name: WebPartFormFactor - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' +- name: SharePoint + tocHref: /javascript/api/ + topicHref: /sharepoint/dev/index diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index e65041d8..5565cf60 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -3,411 +3,552 @@ items: href: ~/overview/sharepoint.md items: - name: decorators - uid: decorators + uid: '@microsoft/decorators!' - name: sp-application-base - uid: sp-application-base + uid: '@microsoft/sp-application-base!' items: - name: ApplicationAccessor - uid: sp-application-base.ApplicationAccessor + uid: '@microsoft/sp-application-base!ApplicationAccessor:class' - name: ApplicationCustomizerContext - uid: sp-application-base.ApplicationCustomizerContext + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - name: BaseApplicationCustomizer - uid: sp-application-base.BaseApplicationCustomizer + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - name: IPlaceholderCreateContentOptions - uid: sp-application-base.IPlaceholderCreateContentOptions + uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' - name: PlaceholderContent - uid: sp-application-base.PlaceholderContent + uid: '@microsoft/sp-application-base!PlaceholderContent:class' - name: PlaceholderName - uid: sp-application-base.PlaceholderName + uid: '@microsoft/sp-application-base!PlaceholderName:enum' - name: PlaceholderProvider - uid: sp-application-base.PlaceholderProvider + uid: '@microsoft/sp-application-base!PlaceholderProvider:class' - name: sp-component-base - uid: sp-component-base + uid: '@microsoft/sp-component-base!' items: - name: BaseComponent - uid: sp-component-base.BaseComponent + uid: '@microsoft/sp-component-base!BaseComponent:class' - name: BaseComponentContext - uid: sp-component-base.BaseComponentContext + uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: DynamicDataProvider - uid: sp-component-base.DynamicDataProvider + uid: '@microsoft/sp-component-base!DynamicDataProvider:class' - name: DynamicDataSourceManager - uid: sp-component-base.DynamicDataSourceManager + uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' - name: DynamicProperty - uid: sp-component-base.DynamicProperty + uid: '@microsoft/sp-component-base!DynamicProperty:class' - name: IFontStyles - uid: sp-component-base.IFontStyles + uid: '@microsoft/sp-component-base!IFontStyles:interface' - name: IPalette - uid: sp-component-base.IPalette + uid: '@microsoft/sp-component-base!IPalette:interface' - name: IRawStyle - uid: sp-component-base.IRawStyle + uid: '@microsoft/sp-component-base!IRawStyle:interface' - name: IReadonlyFontStyles - uid: sp-component-base.IReadonlyFontStyles + uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - name: IReadonlyTheme - uid: sp-component-base.IReadonlyTheme + uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - name: ISemanticColors - uid: sp-component-base.ISemanticColors + uid: '@microsoft/sp-component-base!ISemanticColors:interface' - name: ISemanticTextColors - uid: sp-component-base.ISemanticTextColors + uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' - name: ITheme - uid: sp-component-base.ITheme + uid: '@microsoft/sp-component-base!ITheme:interface' - name: ThemeChangedEventArgs - uid: sp-component-base.ThemeChangedEventArgs + uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - name: ThemeProvider - uid: sp-component-base.ThemeProvider + uid: '@microsoft/sp-component-base!ThemeProvider:class' - name: sp-core-library - uid: sp-core-library + uid: '@microsoft/sp-core-library!' items: - name: DisplayMode - uid: sp-core-library.DisplayMode + uid: '@microsoft/sp-core-library!DisplayMode:enum' - name: Environment - uid: sp-core-library.Environment + uid: '@microsoft/sp-core-library!Environment:class' - name: EnvironmentType - uid: sp-core-library.EnvironmentType + uid: '@microsoft/sp-core-library!EnvironmentType:enum' - name: Guid - uid: sp-core-library.Guid + uid: '@microsoft/sp-core-library!Guid:class' - name: IDisposable - uid: sp-core-library.IDisposable + uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IRandomNumberGenerator - uid: sp-core-library.IRandomNumberGenerator + uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - name: IServiceCollection - uid: sp-core-library.IServiceCollection + uid: '@microsoft/sp-core-library!IServiceCollection:interface' - name: ISPEventObserver - uid: sp-core-library.ISPEventObserver + uid: '@microsoft/sp-core-library!ISPEventObserver:interface' - name: ITimeProvider - uid: sp-core-library.ITimeProvider + uid: '@microsoft/sp-core-library!ITimeProvider:interface' - name: Log - uid: sp-core-library.Log + uid: '@microsoft/sp-core-library!Log:class' - name: RandomNumberGenerator - uid: sp-core-library.RandomNumberGenerator + uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' - name: ServiceKey - uid: sp-core-library.ServiceKey + uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceScope - uid: sp-core-library.ServiceScope + uid: '@microsoft/sp-core-library!ServiceScope:class' - name: Session - uid: sp-core-library.Session + uid: '@microsoft/sp-core-library!Session:class' - name: SPEvent - uid: sp-core-library.SPEvent + uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEventArgs - uid: sp-core-library.SPEventArgs + uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: Text - uid: sp-core-library.Text + uid: '@microsoft/sp-core-library!Text:class' - name: TimeProvider - uid: sp-core-library.TimeProvider + uid: '@microsoft/sp-core-library!TimeProvider:class' - name: UrlQueryParameterCollection - uid: sp-core-library.UrlQueryParameterCollection + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - name: Validate - uid: sp-core-library.Validate + uid: '@microsoft/sp-core-library!Validate:class' - name: Version - uid: sp-core-library.Version + uid: '@microsoft/sp-core-library!Version:class' - name: sp-diagnostics - uid: sp-diagnostics + uid: '@microsoft/sp-diagnostics!' - name: sp-dialog - uid: sp-dialog + uid: '@microsoft/sp-dialog!' items: - name: BaseDialog - uid: sp-dialog.BaseDialog + uid: '@microsoft/sp-dialog!BaseDialog:class' - name: Dialog - uid: sp-dialog.Dialog + uid: '@microsoft/sp-dialog!Dialog:class' - name: IAlertOptions - uid: sp-dialog.IAlertOptions + uid: '@microsoft/sp-dialog!IAlertOptions:interface' - name: IDialogConfiguration - uid: sp-dialog.IDialogConfiguration + uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' - name: IDialogShowOptions - uid: sp-dialog.IDialogShowOptions + uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - name: IPromptOptions - uid: sp-dialog.IPromptOptions + uid: '@microsoft/sp-dialog!IPromptOptions:interface' - name: ISecondaryDialogProvider - uid: sp-dialog.ISecondaryDialogProvider + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' - name: sp-dynamic-data - uid: sp-dynamic-data + uid: '@microsoft/sp-dynamic-data!' items: - name: DynamicDataReference - uid: sp-dynamic-data.DynamicDataReference + uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' - name: IDynamicDataAnnotatedPropertyValue - uid: sp-dynamic-data.IDynamicDataAnnotatedPropertyValue + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - name: IDynamicDataCallables - uid: sp-dynamic-data.IDynamicDataCallables + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - name: IDynamicDataEventDefinition - uid: sp-dynamic-data.IDynamicDataEventDefinition + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - name: IDynamicDataPropertyDefinition - uid: sp-dynamic-data.IDynamicDataPropertyDefinition + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - name: IDynamicDataPropertyMetadata - uid: sp-dynamic-data.IDynamicDataPropertyMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - name: IDynamicDataPropertyValueMetadata - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - name: IDynamicDataPropertyValueMetadataCollection - uid: sp-dynamic-data.IDynamicDataPropertyValueMetadataCollection + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - name: IDynamicDataSource - uid: sp-dynamic-data.IDynamicDataSource + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - name: IDynamicDataSourceMetadata - uid: sp-dynamic-data.IDynamicDataSourceMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - name: sp-extension-base - uid: sp-extension-base + uid: '@microsoft/sp-extension-base!' items: - name: BaseExtension - uid: sp-extension-base.BaseExtension + uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: ExtensionContext - uid: sp-extension-base.ExtensionContext + uid: '@microsoft/sp-extension-base!ExtensionContext:class' - name: sp-http - uid: sp-http + uid: '@microsoft/sp-http!' items: - name: AadHttpClient - uid: sp-http.AadHttpClient + uid: '@microsoft/sp-http!AadHttpClient:class' - name: AadHttpClientConfiguration - uid: sp-http.AadHttpClientConfiguration + uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' - name: AadHttpClientFactory - uid: sp-http.AadHttpClientFactory + uid: '@microsoft/sp-http!AadHttpClientFactory:class' - name: AadTokenProvider - uid: sp-http.AadTokenProvider + uid: '@microsoft/sp-http!AadTokenProvider:class' - name: AadTokenProviderFactory - uid: sp-http.AadTokenProviderFactory + uid: '@microsoft/sp-http!AadTokenProviderFactory:class' - name: DigestCache - uid: sp-http.DigestCache + uid: '@microsoft/sp-http!DigestCache:class' - name: GraphRequest - uid: sp-http.GraphRequest + uid: '@microsoft/sp-http!GraphRequest:interface' - name: HttpClient - uid: sp-http.HttpClient + uid: '@microsoft/sp-http!HttpClient:class' - name: HttpClientConfiguration - uid: sp-http.HttpClientConfiguration + uid: '@microsoft/sp-http!HttpClientConfiguration:class' - name: HttpClientResponse - uid: sp-http.HttpClientResponse + uid: '@microsoft/sp-http!HttpClientResponse:class' - name: IAadHttpClientConfiguration - uid: sp-http.IAadHttpClientConfiguration + uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - name: IAadHttpClientConfigurations - uid: sp-http.IAadHttpClientConfigurations + uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - name: IAadHttpClientOptions - uid: sp-http.IAadHttpClientOptions + uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' - name: IAadTokenProvider - uid: sp-http.IAadTokenProvider + uid: '@microsoft/sp-http!IAadTokenProvider:interface' - name: IAadTokenProviderConfiguration - uid: sp-http.IAadTokenProviderConfiguration + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - name: IDigestCache - uid: sp-http.IDigestCache - - name: IGraphHttpClientOptions - uid: sp-http.IGraphHttpClientOptions + uid: '@microsoft/sp-http!IDigestCache:interface' - name: IHttpClientConfiguration - uid: sp-http.IHttpClientConfiguration + uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfigurations - uid: sp-http.IHttpClientConfigurations + uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' - name: IHttpClientOptions - uid: sp-http.IHttpClientOptions + uid: '@microsoft/sp-http!IHttpClientOptions:interface' - name: ISPHttpClientBatchConfiguration - uid: sp-http.ISPHttpClientBatchConfiguration + uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - name: ISPHttpClientBatchConfigurations - uid: sp-http.ISPHttpClientBatchConfigurations + uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - name: ISPHttpClientBatchCreationOptions - uid: sp-http.ISPHttpClientBatchCreationOptions + uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - name: ISPHttpClientBatchOptions - uid: sp-http.ISPHttpClientBatchOptions + uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - name: ISPHttpClientCommonConfiguration - uid: sp-http.ISPHttpClientCommonConfiguration + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - name: ISPHttpClientConfiguration - uid: sp-http.ISPHttpClientConfiguration + uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - name: ISPHttpClientConfigurations - uid: sp-http.ISPHttpClientConfigurations + uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - name: ISPHttpClientOptions - uid: sp-http.ISPHttpClientOptions + uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' - name: ITokenAcquisitionEventArgs - uid: sp-http.ITokenAcquisitionEventArgs + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' - name: MSGraphClient - uid: sp-http.MSGraphClient + uid: '@microsoft/sp-http!MSGraphClient:class' - name: MSGraphClientFactory - uid: sp-http.MSGraphClientFactory + uid: '@microsoft/sp-http!MSGraphClientFactory:class' - name: ODataVersion - uid: sp-http.ODataVersion + uid: '@microsoft/sp-http!ODataVersion:class' - name: SPHttpClient - uid: sp-http.SPHttpClient + uid: '@microsoft/sp-http!SPHttpClient:class' - name: SPHttpClientBatch - uid: sp-http.SPHttpClientBatch + uid: '@microsoft/sp-http!SPHttpClientBatch:class' - name: SPHttpClientBatchConfiguration - uid: sp-http.SPHttpClientBatchConfiguration + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - name: SPHttpClientCommonConfiguration - uid: sp-http.SPHttpClientCommonConfiguration + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - name: SPHttpClientConfiguration - uid: sp-http.SPHttpClientConfiguration + uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' - name: SPHttpClientResponse - uid: sp-http.SPHttpClientResponse + uid: '@microsoft/sp-http!SPHttpClientResponse:class' - name: SPHttpHeader - uid: sp-http.SPHttpHeader + uid: '@microsoft/sp-http!SPHttpHeader:enum' - name: TokenAcquisitionEventArgs - uid: sp-http.TokenAcquisitionEventArgs + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + - name: sp-list-subscription + uid: '@microsoft/sp-list-subscription!' + items: + - name: ICreateSubscriptionSettings + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - name: IListSubscription + uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + - name: ISubscriptionCallbacks + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - name: ListSubscriptionFactory + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' - name: sp-listview-extensibility - uid: sp-listview-extensibility + uid: '@microsoft/sp-listview-extensibility!' items: - name: BaseFieldCustomizer - uid: sp-listview-extensibility.BaseFieldCustomizer + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - name: BaseListViewCommandSet - uid: sp-listview-extensibility.BaseListViewCommandSet + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - name: ColumnAccessor - uid: sp-listview-extensibility.ColumnAccessor + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - name: Command - uid: sp-listview-extensibility.Command + uid: '@microsoft/sp-listview-extensibility!Command:class' - name: FieldCustomizerContext - uid: sp-listview-extensibility.FieldCustomizerContext + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - name: IFieldCustomizerCellEventParameters - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - name: IListViewCommandSetExecuteEventParameters - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - name: IListViewCommandSetListViewUpdatedParameters - uid: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - name: ListItemAccessor - uid: sp-listview-extensibility.ListItemAccessor + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - name: ListViewAccessor - uid: sp-listview-extensibility.ListViewAccessor + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - name: ListViewCommandSetContext - uid: sp-listview-extensibility.ListViewCommandSetContext + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - name: RowAccessor - uid: sp-listview-extensibility.RowAccessor + uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - name: SelectedRowsChangedEventArgs - uid: sp-listview-extensibility.SelectedRowsChangedEventArgs + uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + - name: sp-loader + uid: '@microsoft/sp-loader!' + items: + - name: ILoadScriptOptions + uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + - name: SPComponentLoader + uid: '@microsoft/sp-loader!SPComponentLoader:class' + - name: sp-lodash-subset + uid: '@microsoft/sp-lodash-subset!' + - name: sp-module-interfaces + uid: '@microsoft/sp-module-interfaces!' + items: + - name: IClientSideAssemblyManifest + uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - name: IClientSideComponentLoaderConfiguration + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - name: IClientSideComponentManifest + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - name: IClientSideExtensionManifest + uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - name: IClientSideLibraryManifest + uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - name: IClientSideManifestBase + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - name: IClientSideWebPartManifest + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - name: IClientSideWebPartManifestEntry + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - name: IClientSideWebPartManifestInstance + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - name: ICommandDefinition + uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - name: ICommandSetExtensionManifest + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - name: IComponentModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - name: ILocalizedPathModuleConfiguration + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - name: ILocalizedString + uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - name: IModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + - name: IPath + uid: '@microsoft/sp-module-interfaces!IPath:interface' + - name: IPathModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + - name: PredefinedGroup + uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' - name: sp-odata-types - uid: sp-odata-types + uid: '@microsoft/sp-odata-types!' items: - name: _IODataUserId - uid: sp-odata-types._IODataUserId + uid: '@microsoft/sp-odata-types!_IODataUserId:interface' - name: IODataBasePermission - uid: sp-odata-types.IODataBasePermission + uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - name: IODataChangeToken - uid: sp-odata-types.IODataChangeToken + uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' - name: IODataContextWebInformation - uid: sp-odata-types.IODataContextWebInformation + uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - name: IODataList - uid: sp-odata-types.IODataList + uid: '@microsoft/sp-odata-types!IODataList:interface' - name: IODataListItem - uid: sp-odata-types.IODataListItem + uid: '@microsoft/sp-odata-types!IODataListItem:interface' - name: IODataNavigationNode - uid: sp-odata-types.IODataNavigationNode + uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - name: IODataNavigationNodeCollection - uid: sp-odata-types.IODataNavigationNodeCollection + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - name: IODataUser - uid: sp-odata-types.IODataUser + uid: '@microsoft/sp-odata-types!IODataUser:interface' - name: IODataUserCustomAction - uid: sp-odata-types.IODataUserCustomAction + uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - name: IODataWeb - uid: sp-odata-types.IODataWeb + uid: '@microsoft/sp-odata-types!IODataWeb:interface' - name: sp-page-context - uid: sp-page-context + uid: '@microsoft/sp-page-context!' items: - name: CultureInfo - uid: sp-page-context.CultureInfo + uid: '@microsoft/sp-page-context!CultureInfo:class' - name: ISPSystemTime - uid: sp-page-context.ISPSystemTime + uid: '@microsoft/sp-page-context!ISPSystemTime:interface' - name: ISPTimeZoneData - uid: sp-page-context.ISPTimeZoneData + uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' - name: PageContext - uid: sp-page-context.PageContext + uid: '@microsoft/sp-page-context!PageContext:class' - name: SPDayOfWeek - uid: sp-page-context.SPDayOfWeek + uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - name: SPField - uid: sp-page-context.SPField + uid: '@microsoft/sp-page-context!SPField:class' - name: SPList - uid: sp-page-context.SPList + uid: '@microsoft/sp-page-context!SPList:class' - name: SPListItem - uid: sp-page-context.SPListItem + uid: '@microsoft/sp-page-context!SPListItem:class' - name: SPPermission - uid: sp-page-context.SPPermission + uid: '@microsoft/sp-page-context!SPPermission:class' - name: SPSite - uid: sp-page-context.SPSite + uid: '@microsoft/sp-page-context!SPSite:class' - name: SPTimeZone - uid: sp-page-context.SPTimeZone + uid: '@microsoft/sp-page-context!SPTimeZone:class' - name: SPUser - uid: sp-page-context.SPUser + uid: '@microsoft/sp-page-context!SPUser:class' - name: SPWeb - uid: sp-page-context.SPWeb + uid: '@microsoft/sp-page-context!SPWeb:class' + - name: sp-property-pane + uid: '@microsoft/sp-property-pane!' + items: + - name: DynamicDataSharedDepth + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - name: IDynamicDataSharedPropertyConfiguration + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + - name: IDynamicDataSharedPropertyFilters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - name: IDynamicDataSharedSourceConfiguration + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - name: IDynamicDataSharedSourceFilters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - name: IPopupWindowProps + uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - name: IPropertyPaneButtonProps + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - name: IPropertyPaneCheckboxProps + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - name: IPropertyPaneChoiceGroupOption + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - name: IPropertyPaneChoiceGroupOptionIconProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - name: IPropertyPaneChoiceGroupProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - name: IPropertyPaneConditionalGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - name: IPropertyPaneConfiguration + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - name: IPropertyPaneCustomFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - name: IPropertyPaneDebounceProperty + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - name: IPropertyPaneDropdownCalloutProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - name: IPropertyPaneDropdownOption + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - name: IPropertyPaneDropdownProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - name: IPropertyPaneDynamicFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - name: IPropertyPaneDynamicFieldSetProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - name: IPropertyPaneDynamicTextFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - name: IPropertyPaneField + uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - name: IPropertyPaneGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - name: IPropertyPaneLabelProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - name: IPropertyPaneLinkProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - name: IPropertyPanePage + uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - name: IPropertyPanePageHeader + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - name: IPropertyPaneSliderProps + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - name: IPropertyPaneTextFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - name: IPropertyPaneToggleProps + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - name: PopupWindowPosition + uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - name: PropertyPaneButtonType + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - name: PropertyPaneDropdownOptionType + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - name: PropertyPaneFieldType + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - name: sp-search-extensibility + uid: '@microsoft/sp-search-extensibility!' + items: + - name: BaseSearchQueryModifier + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - name: IQuery + uid: '@microsoft/sp-search-extensibility!IQuery:interface' + - name: SearchQueryModifierContext + uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + - name: SearchQueryScenario + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' - name: sp-webpart-base - uid: sp-webpart-base + uid: '@microsoft/sp-webpart-base!' items: - name: BaseClientSideWebPart - uid: sp-webpart-base.BaseClientSideWebPart + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - name: BaseWebPart - uid: sp-webpart-base.BaseWebPart + uid: '@microsoft/sp-webpart-base!BaseWebPart:class' - name: BaseWebPartContext - uid: sp-webpart-base.BaseWebPartContext + uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' - name: DynamicDataSharedDepth - uid: sp-webpart-base.DynamicDataSharedDepth + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - name: IClientSideWebPartStatusRenderer - uid: sp-webpart-base.IClientSideWebPartStatusRenderer + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - name: IDynamicDataSharedPropertyConfiguration - uid: sp-webpart-base.IDynamicDataSharedPropertyConfiguration + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - name: IDynamicDataSharedPropertyFilters - uid: sp-webpart-base.IDynamicDataSharedPropertyFilters + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedSourceConfiguration - uid: sp-webpart-base.IDynamicDataSharedSourceConfiguration + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceFilters - uid: sp-webpart-base.IDynamicDataSharedSourceFilters + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - name: IMicrosoftTeams - uid: sp-webpart-base.IMicrosoftTeams + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - name: IOffice + uid: '@microsoft/sp-webpart-base!IOffice:interface' - name: IPropertyPaneAccessor - uid: sp-webpart-base.IPropertyPaneAccessor + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - name: IPropertyPaneButtonProps - uid: sp-webpart-base.IPropertyPaneButtonProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - name: IPropertyPaneCheckboxProps - uid: sp-webpart-base.IPropertyPaneCheckboxProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneChoiceGroupOption - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - name: IPropertyPaneChoiceGroupOptionIconProps - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - name: IPropertyPaneChoiceGroupProps - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneConditionalGroup - uid: sp-webpart-base.IPropertyPaneConditionalGroup + uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - name: IPropertyPaneConfiguration - uid: sp-webpart-base.IPropertyPaneConfiguration + uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - name: IPropertyPaneCustomFieldProps - uid: sp-webpart-base.IPropertyPaneCustomFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneDropdownCalloutProps - uid: sp-webpart-base.IPropertyPaneDropdownCalloutProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - name: IPropertyPaneDropdownOption - uid: sp-webpart-base.IPropertyPaneDropdownOption + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownProps - uid: sp-webpart-base.IPropertyPaneDropdownProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDynamicFieldFilters - uid: sp-webpart-base.IPropertyPaneDynamicFieldFilters + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - name: IPropertyPaneDynamicFieldProps - uid: sp-webpart-base.IPropertyPaneDynamicFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldSetProps - uid: sp-webpart-base.IPropertyPaneDynamicFieldSetProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicTextFieldProps - uid: sp-webpart-base.IPropertyPaneDynamicTextFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneField - uid: sp-webpart-base.IPropertyPaneField + uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneGroup - uid: sp-webpart-base.IPropertyPaneGroup + uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - name: IPropertyPaneLabelProps - uid: sp-webpart-base.IPropertyPaneLabelProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLinkProps - uid: sp-webpart-base.IPropertyPaneLinkProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - name: IPropertyPanePage - uid: sp-webpart-base.IPropertyPanePage + uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - name: IPropertyPanePageHeader - uid: sp-webpart-base.IPropertyPanePageHeader + uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - name: IPropertyPaneSliderProps - uid: sp-webpart-base.IPropertyPaneSliderProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - name: IPropertyPaneTextFieldProps - uid: sp-webpart-base.IPropertyPaneTextFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneToggleProps - uid: sp-webpart-base.IPropertyPaneToggleProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - name: ISDKs - uid: sp-webpart-base.ISDKs + uid: '@microsoft/sp-webpart-base!ISDKs:interface' - name: ISerializedServerProcessedData - uid: sp-webpart-base.ISerializedServerProcessedData + uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - name: ISerializedWebPartData - uid: sp-webpart-base.ISerializedWebPartData + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - name: IWebPartContext - uid: sp-webpart-base.IWebPartContext + uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' - name: IWebPartData - uid: sp-webpart-base.IWebPartData + uid: '@microsoft/sp-webpart-base!IWebPartData:interface' - name: IWebPartPropertiesMetadata - uid: sp-webpart-base.IWebPartPropertiesMetadata + uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - name: IWebPartPropertyMetadata - uid: sp-webpart-base.IWebPartPropertyMetadata + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' - name: PropertyPaneButtonType - uid: sp-webpart-base.PropertyPaneButtonType + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - name: PropertyPaneDropdownOptionType - uid: sp-webpart-base.PropertyPaneDropdownOptionType + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - name: PropertyPaneFieldType - uid: sp-webpart-base.PropertyPaneFieldType + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - name: WebPartContext - uid: sp-webpart-base.WebPartContext + uid: '@microsoft/sp-webpart-base!WebPartContext:class' - name: WebPartFormFactor - uid: sp-webpart-base.WebPartFormFactor + uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' From da82fcebf4bc206591c698a7de386704d3cec5a7 Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Fri, 17 Jan 2020 10:26:05 +0200 Subject: [PATCH 30/55] Updating date for the overview doc --- SP-Framework/overview/sharepoint.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SP-Framework/overview/sharepoint.md b/SP-Framework/overview/sharepoint.md index 617f5738..225113d2 100644 --- a/SP-Framework/overview/sharepoint.md +++ b/SP-Framework/overview/sharepoint.md @@ -1,7 +1,7 @@ --- title: SharePoint Framework TypeScript Reference description: The SharePoint Framework object model is built in TypeScript. -ms.date: 08/20/2019 +ms.date: 01/17/2020 ms.prod: sharepoint --- From 0c88c800892892135745082ce5b86e868d79c27e Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Fri, 17 Jan 2020 11:21:57 +0200 Subject: [PATCH 31/55] Adding links to the overview page for the conceptual documentation --- SP-Framework/overview/sharepoint.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/SP-Framework/overview/sharepoint.md b/SP-Framework/overview/sharepoint.md index 225113d2..81142358 100644 --- a/SP-Framework/overview/sharepoint.md +++ b/SP-Framework/overview/sharepoint.md @@ -8,3 +8,9 @@ ms.prod: sharepoint # SharePoint Framework Reference The SharePoint Framework object model is built in TypeScript. Use this section to learn more about the classes, methods, and other types available for building your SharePoint Framework solutions. + +## See also + +- [Overview of SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview) +- [Getting started with SharePoint Framework web parts](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) +- [Getting started with SharePoint Framework Extensions](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/extensions/get-started/build-a-hello-world-extension) \ No newline at end of file From b478c63bb3edf2091f2e8ae64c0dee0d61622d3a Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Fri, 17 Jan 2020 11:37:26 +0200 Subject: [PATCH 32/55] Removing localization section from links --- SP-Framework/overview/sharepoint.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SP-Framework/overview/sharepoint.md b/SP-Framework/overview/sharepoint.md index 81142358..f21b44a9 100644 --- a/SP-Framework/overview/sharepoint.md +++ b/SP-Framework/overview/sharepoint.md @@ -11,6 +11,6 @@ The SharePoint Framework object model is built in TypeScript. Use this section t ## See also -- [Overview of SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview) -- [Getting started with SharePoint Framework web parts](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) -- [Getting started with SharePoint Framework Extensions](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/extensions/get-started/build-a-hello-world-extension) \ No newline at end of file +- [Overview of SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) +- [Getting started with SharePoint Framework web parts](https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) +- [Getting started with SharePoint Framework Extensions](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/build-a-hello-world-extension) \ No newline at end of file From c2031d6fb3801a849b6f28aac6bac4fbaa1b05f1 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:01:24 +0800 Subject: [PATCH 33/55] change sdp config --- .openpublishing.publish.config.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 0b0ae5a2..0c74bb8a 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -17,7 +17,10 @@ "open_to_public_contributors": true, "type_mapping": { "Conceptual": "Content", - "UniversalReference": "Content" + "TSType": "Content", + "TSPackage": "Content", + "TSEnum": "Content", + "TSTypeAlias": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", From 4a7f3ab1fc8b55df74b31aad491f2fbabd4cbd42 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:01:44 +0800 Subject: [PATCH 34/55] change ur to sdp --- SP-Framework/decorators.yml | 212 ++- SP-Framework/sp-application-base.yml | 49 +- .../applicationaccessor.yml | 143 +- .../applicationcustomizercontext.yml | 131 +- .../baseapplicationcustomizer.yml | 170 +-- .../iplaceholdercreatecontentoptions.yml | 78 +- .../placeholdercontent.yml | 205 ++- .../sp-application-base/placeholdername.yml | 59 +- .../placeholderprovider.yml | 294 ++-- SP-Framework/sp-component-base.yml | 110 +- .../sp-component-base/basecomponent.yml | 268 ++-- .../basecomponentcontext.yml | 422 +++--- .../sp-component-base/dynamicdataprovider.yml | 343 +++-- .../dynamicdatasourcemanager.yml | 226 ++- .../sp-component-base/dynamicproperty.yml | 384 +++--- .../sp-component-base/ifontstyles.yml | 210 ++- SP-Framework/sp-component-base/ipalette.yml | 863 ++++++------ SP-Framework/sp-component-base/irawstyle.yml | 91 +- .../sp-component-base/ireadonlyfontstyles.yml | 210 ++- .../sp-component-base/ireadonlytheme.yml | 153 +-- .../sp-component-base/isemanticcolors.yml | 1086 +++++++-------- .../sp-component-base/isemantictextcolors.yml | 535 ++++---- SP-Framework/sp-component-base/itheme.yml | 118 +- .../themechangedeventargs.yml | 56 +- .../sp-component-base/themeprovider.yml | 146 +- SP-Framework/sp-core-library.yml | 135 +- SP-Framework/sp-core-library/displaymode.yml | 61 +- SP-Framework/sp-core-library/environment.yml | 54 +- .../sp-core-library/environmenttype.yml | 110 +- SP-Framework/sp-core-library/guid.yml | 350 +++-- SP-Framework/sp-core-library/idisposable.yml | 88 +- .../irandomnumbergenerator.yml | 69 +- .../sp-core-library/iservicecollection.yml | 57 +- .../sp-core-library/ispeventobserver.yml | 84 +- .../sp-core-library/itimeprovider.yml | 97 +- SP-Framework/sp-core-library/log.yml | 295 ++-- .../sp-core-library/randomnumbergenerator.yml | 136 +- SP-Framework/sp-core-library/servicekey.yml | 338 ++--- SP-Framework/sp-core-library/servicescope.yml | 650 ++++----- SP-Framework/sp-core-library/session.yml | 124 +- SP-Framework/sp-core-library/spevent.yml | 147 +- SP-Framework/sp-core-library/speventargs.yml | 25 +- SP-Framework/sp-core-library/text.yml | 145 +- SP-Framework/sp-core-library/timeprovider.yml | 164 +-- .../urlqueryparametercollection.yml | 209 +-- SP-Framework/sp-core-library/validate.yml | 218 ++- SP-Framework/sp-core-library/version.yml | 618 ++++----- SP-Framework/sp-diagnostics.yml | 47 +- SP-Framework/sp-dialog.yml | 52 +- SP-Framework/sp-dialog/basedialog.yml | 550 ++++---- SP-Framework/sp-dialog/dialog.yml | 159 +-- SP-Framework/sp-dialog/ialertoptions.yml | 28 +- .../sp-dialog/idialogconfiguration.yml | 49 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 60 +- SP-Framework/sp-dialog/ipromptoptions.yml | 55 +- .../sp-dialog/isecondarydialogprovider.yml | 192 ++- SP-Framework/sp-dynamic-data.yml | 62 +- .../sp-dynamic-data/dynamicdatareference.yml | 120 +- .../idynamicdataannotatedpropertyvalue.yml | 66 +- .../sp-dynamic-data/idynamicdatacallables.yml | 205 ++- .../idynamicdataeventdefinition.yml | 59 +- .../idynamicdatapropertydefinition.yml | 56 +- .../idynamicdatapropertymetadata.yml | 62 +- .../idynamicdatapropertyvaluemetadata.yml | 53 +- ...micdatapropertyvaluemetadatacollection.yml | 125 +- .../sp-dynamic-data/idynamicdatasource.yml | 417 +++--- .../idynamicdatasourcemetadata.yml | 127 +- SP-Framework/sp-extension-base.yml | 25 +- .../sp-extension-base/baseextension.yml | 151 +- .../sp-extension-base/extensioncontext.yml | 34 +- SP-Framework/sp-http.yml | 179 +-- SP-Framework/sp-http/aadhttpclient.yml | 255 ++-- .../sp-http/aadhttpclientconfiguration.yml | 126 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 118 +- SP-Framework/sp-http/aadtokenprovider.yml | 135 +- .../sp-http/aadtokenproviderfactory.yml | 100 +- SP-Framework/sp-http/digestcache.yml | 246 ++-- SP-Framework/sp-http/graphhttpclient.yml | 353 +++-- .../sp-http/graphhttpclientconfiguration.yml | 121 +- .../sp-http/graphhttpclientresponse.yml | 139 +- SP-Framework/sp-http/graphrequest.yml | 850 ++++++------ SP-Framework/sp-http/httpclient.yml | 389 +++--- .../sp-http/httpclientconfiguration.yml | 183 ++- SP-Framework/sp-http/httpclientresponse.yml | 502 +++---- .../sp-http/iaadhttpclientconfiguration.yml | 28 +- .../sp-http/iaadhttpclientconfigurations.yml | 57 +- .../sp-http/iaadhttpclientoptions.yml | 85 +- SP-Framework/sp-http/iaadtokenprovider.yml | 130 +- .../iaadtokenproviderconfiguration.yml | 164 ++- SP-Framework/sp-http/idigestcache.yml | 184 ++- .../sp-http/igraphhttpclientconfiguration.yml | 27 +- .../igraphhttpclientconfigurations.yml | 73 +- .../sp-http/igraphhttpclientoptions.yml | 30 +- .../sp-http/ihttpclientconfiguration.yml | 20 +- .../sp-http/ihttpclientconfigurations.yml | 67 +- SP-Framework/sp-http/ihttpclientoptions.yml | 34 +- .../isphttpclientbatchconfiguration.yml | 33 +- .../isphttpclientbatchconfigurations.yml | 67 +- .../isphttpclientbatchcreationoptions.yml | 61 +- .../sp-http/isphttpclientbatchoptions.yml | 38 +- .../isphttpclientcommonconfiguration.yml | 124 +- .../sp-http/isphttpclientconfiguration.yml | 160 +-- .../sp-http/isphttpclientconfigurations.yml | 73 +- SP-Framework/sp-http/isphttpclientoptions.yml | 78 +- .../sp-http/itokenacquisitioneventargs.yml | 62 +- SP-Framework/sp-http/msgraphclient.yml | 84 +- SP-Framework/sp-http/msgraphclientfactory.yml | 112 +- SP-Framework/sp-http/odataversion.yml | 160 +-- SP-Framework/sp-http/sphttpclient.yml | 555 ++++---- SP-Framework/sp-http/sphttpclientbatch.yml | 424 +++--- .../sphttpclientbatchconfiguration.yml | 203 +-- .../sphttpclientcommonconfiguration.yml | 284 ++-- .../sp-http/sphttpclientconfiguration.yml | 316 ++--- SP-Framework/sp-http/sphttpclientresponse.yml | 147 +- SP-Framework/sp-http/sphttpheader.yml | 47 +- .../sp-http/tokenacquisitioneventargs.yml | 85 +- SP-Framework/sp-list-subscription.yml | 39 +- .../icreatesubscriptionsettings.yml | 138 +- .../ilistsubscription.yml | 42 +- .../isubscriptioncallbacks.yml | 73 +- .../listsubscriptionfactory.yml | 124 +- SP-Framework/sp-listview-extensibility.yml | 73 +- .../basefieldcustomizer.yml | 179 ++- .../baselistviewcommandset.yml | 237 ++-- .../columnaccessor.yml | 99 +- .../sp-listview-extensibility/command.yml | 190 ++- .../fieldcustomizercontext.yml | 121 +- .../ifieldcustomizercelleventparameters.yml | 145 +- ...stviewcommandsetexecuteeventparameters.yml | 101 +- ...iewcommandsetlistviewupdatedparameters.yml | 71 +- .../listitemaccessor.yml | 190 ++- .../listviewaccessor.yml | 171 +-- .../listviewcommandsetcontext.yml | 103 +- .../sp-listview-extensibility/rowaccessor.yml | 52 +- .../selectedrowschangedeventargs.yml | 74 +- SP-Framework/sp-loader.yml | 29 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 39 +- SP-Framework/sp-loader/spcomponentloader.yml | 225 ++- SP-Framework/sp-lodash-subset.yml | 46 +- SP-Framework/sp-module-interfaces.yml | 121 +- .../iclientsideassemblymanifest.yml | 54 +- ...clientsidecomponentloaderconfiguration.yml | 205 ++- .../iclientsidecomponentmanifest.yml | 280 ++-- .../iclientsideextensionmanifest.yml | 59 +- .../iclientsidelibrarymanifest.yml | 37 +- .../iclientsidemanifestbase.yml | 74 +- .../iclientsidewebpartmanifest.yml | 301 ++-- .../iclientsidewebpartmanifestentry.yml | 327 ++--- .../iclientsidewebpartmanifestinstance.yml | 38 +- .../icommanddefinition.yml | 123 +- .../icommandsetextensionmanifest.yml | 117 +- .../icomponentmoduleconfiguration.yml | 121 +- .../ilocalizedpathmoduleconfiguration.yml | 152 +- .../sp-module-interfaces/ilocalizedstring.yml | 103 +- .../imoduleconfiguration.yml | 81 +- SP-Framework/sp-module-interfaces/ipath.yml | 80 +- .../ipathmoduleconfiguration.yml | 159 +-- .../sp-module-interfaces/predefinedgroup.yml | 127 +- SP-Framework/sp-odata-types.yml | 65 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 60 +- .../sp-odata-types/iodatabasepermission.yml | 70 +- .../sp-odata-types/iodatachangetoken.yml | 55 +- .../iodatacontextwebinformation.yml | 130 +- SP-Framework/sp-odata-types/iodatalist.yml | 361 +++-- .../sp-odata-types/iodatalistitem.yml | 139 +- .../sp-odata-types/iodatanavigationnode.yml | 228 ++- .../iodatanavigationnodecollection.yml | 106 +- SP-Framework/sp-odata-types/iodatauser.yml | 240 ++-- .../sp-odata-types/iodatausercustomaction.yml | 540 ++++---- SP-Framework/sp-odata-types/iodataweb.yml | 553 ++++---- SP-Framework/sp-page-context.yml | 74 +- SP-Framework/sp-page-context/cultureinfo.yml | 139 +- .../sp-page-context/ispsystemtime.yml | 157 +-- .../sp-page-context/isptimezonedata.yml | 143 +- SP-Framework/sp-page-context/pagecontext.yml | 418 +++--- SP-Framework/sp-page-context/spdayofweek.yml | 104 +- SP-Framework/sp-page-context/spfield.yml | 237 ++-- SP-Framework/sp-page-context/splist.yml | 146 +- SP-Framework/sp-page-context/splistitem.yml | 57 +- SP-Framework/sp-page-context/sppermission.yml | 1192 ++++++++-------- SP-Framework/sp-page-context/spsite.yml | 330 +++-- SP-Framework/sp-page-context/sptimezone.yml | 170 ++- SP-Framework/sp-page-context/spuser.yml | 268 ++-- SP-Framework/sp-page-context/spweb.yml | 409 +++--- SP-Framework/sp-property-pane.yml | 870 +++++------- .../dynamicdatashareddepth.yml | 49 +- ...dynamicdatasharedpropertyconfiguration.yml | 44 +- .../idynamicdatasharedpropertyfilters.yml | 55 +- .../idynamicdatasharedsourceconfiguration.yml | 62 +- .../idynamicdatasharedsourcefilters.yml | 98 +- .../sp-property-pane/ipopupwindowprops.yml | 92 +- .../ipropertypanebuttonprops.yml | 173 ++- .../ipropertypanecheckboxprops.yml | 70 +- .../ipropertypanechoicegroupoption.yml | 193 ++- ...propertypanechoicegroupoptioniconprops.yml | 38 +- .../ipropertypanechoicegroupprops.yml | 66 +- .../ipropertypaneconditionalgroup.yml | 119 +- .../ipropertypaneconfiguration.yml | 157 +-- .../ipropertypanecustomfieldprops.yml | 142 +- .../ipropertypanedebounceproperty.yml | 60 +- .../ipropertypanedropdowncalloutprops.yml | 40 +- .../ipropertypanedropdownoption.yml | 96 +- .../ipropertypanedropdownprops.yml | 196 ++- .../ipropertypanedynamicfieldprops.yml | 113 +- .../ipropertypanedynamicfieldsetprops.yml | 141 +- .../ipropertypanedynamictextfieldprops.yml | 234 ++-- .../sp-property-pane/ipropertypanefield.yml | 92 +- .../sp-property-pane/ipropertypanegroup.yml | 85 +- .../ipropertypanelabelprops.yml | 57 +- .../ipropertypanelinkprops.yml | 111 +- .../sp-property-pane/ipropertypanepage.yml | 97 +- .../ipropertypanepageheader.yml | 54 +- .../ipropertypanesliderprops.yml | 185 ++- .../ipropertypanetextfieldprops.yml | 379 +++-- .../ipropertypanetoggleprops.yml | 171 ++- .../sp-property-pane/popupwindowposition.yml | 69 +- .../propertypanebuttontype.yml | 100 +- .../propertypanedropdownoptiontype.yml | 55 +- .../propertypanefieldtype.yml | 178 +-- SP-Framework/sp-search-extensibility.yml | 35 +- .../basesearchquerymodifier.yml | 170 +-- .../sp-search-extensibility/iquery.yml | 58 +- .../searchquerymodifiercontext.yml | 33 +- .../searchqueryscenario.yml | 44 +- SP-Framework/sp-webpart-base.yml | 1222 +++++++---------- .../sp-webpart-base/baseclientsidewebpart.yml | 565 ++++---- SP-Framework/sp-webpart-base/basewebpart.yml | 714 +++++----- .../sp-webpart-base/basewebpartcontext.yml | 128 +- .../dynamicdatashareddepth.yml | 56 +- .../iclientsidewebpartstatusrenderer.yml | 213 ++- ...dynamicdatasharedpropertyconfiguration.yml | 54 +- .../idynamicdatasharedpropertyfilters.yml | 54 +- .../idynamicdatasharedsourceconfiguration.yml | 54 +- .../idynamicdatasharedsourcefilters.yml | 53 +- .../sp-webpart-base/imicrosoftteams.yml | 67 +- SP-Framework/sp-webpart-base/ioffice.yml | 42 +- .../iplaceholderspinnerprops.yml | 76 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 222 +-- .../ipropertypanebuttonprops.yml | 51 +- .../ipropertypanecheckboxprops.yml | 51 +- .../ipropertypanechoicegroupoption.yml | 53 +- ...propertypanechoicegroupoptioniconprops.yml | 54 +- .../ipropertypanechoicegroupprops.yml | 53 +- .../ipropertypaneconditionalgroup.yml | 53 +- .../ipropertypaneconfiguration.yml | 51 +- .../ipropertypanecustomfieldprops.yml | 53 +- .../ipropertypanedropdowncalloutprops.yml | 54 +- .../ipropertypanedropdownoption.yml | 53 +- .../ipropertypanedropdownprops.yml | 51 +- .../ipropertypanedynamicfieldfilters.yml | 55 +- .../ipropertypanedynamicfieldprops.yml | 53 +- .../ipropertypanedynamicfieldsetprops.yml | 54 +- .../ipropertypanedynamictextfieldprops.yml | 51 +- .../sp-webpart-base/ipropertypanefield.yml | 58 +- .../sp-webpart-base/ipropertypanegroup.yml | 51 +- .../ipropertypanelabelprops.yml | 51 +- .../ipropertypanelinkprops.yml | 51 +- .../sp-webpart-base/ipropertypanepage.yml | 51 +- .../ipropertypanepageheader.yml | 51 +- .../ipropertypanesliderprops.yml | 51 +- .../ipropertypanetextfieldprops.yml | 53 +- .../ipropertypanetoggleprops.yml | 51 +- SP-Framework/sp-webpart-base/isdks.yml | 64 +- .../iserializedserverprocesseddata.yml | 304 ++-- .../iserializedwebpartdata.yml | 295 ++-- .../sp-webpart-base/iwebpartcontext.yml | 290 ++-- SP-Framework/sp-webpart-base/iwebpartdata.yml | 440 +++--- .../iwebpartpropertiesmetadata.yml | 135 +- .../iwebpartpropertymetadata.yml | 227 +-- .../propertypanebuttontype.yml | 133 +- .../propertypanedropdownoptiontype.yml | 76 +- .../sp-webpart-base/propertypanefieldtype.yml | 249 ++-- .../sp-webpart-base/webpartcontext.yml | 158 +-- .../sp-webpart-base/webpartformfactor.yml | 60 +- 274 files changed, 20279 insertions(+), 24720 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index f0aa7b82..63e00650 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -1,125 +1,87 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/decorators!' - summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. - remarks: >- - This package provides a small set of decorators that enable more rigorous specification of API contracts when - using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This - package is not intended to be a general toolkit of language extensions or helpful macros. - name: '@microsoft/decorators' - fullName: '@microsoft/decorators' - langs: - - typeScript - type: package - children: - - '@microsoft/decorators!override:function(1)' - - '@microsoft/decorators!sealed:function(1)' - - '@microsoft/decorators!virtual:function(1)' - - uid: '@microsoft/decorators!override:function(1)' - summary: >- - This decorator is applied to a class's member function or property. It indicates that the definition overrides - another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at - runtime. - name: 'override(target, propertyKey, descriptor)' - fullName: 'override(target, propertyKey, descriptor)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function override(target: Object, propertyKey: string | symbol, descriptor: - TypedPropertyDescriptor): void; - return: - type: - - void - description: '' - parameters: - - id: target - description: '' - type: - - '!Object:interface' - - id: propertyKey - description: '' - type: - - string | symbol - - id: descriptor - description: '' - type: - - '@microsoft/decorators!override~0:complex' - - uid: '@microsoft/decorators!sealed:function(1)' - summary: >- - This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not - inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may - be enforced at runtime. - name: sealed(target) - fullName: sealed(target) - langs: - - typeScript - type: function - syntax: - content: 'export declare function sealed(target: Function): void;' - return: - type: - - void - description: '' - parameters: - - id: target - description: '' - type: - - '!Function:interface' - - uid: '@microsoft/decorators!virtual:function(1)' - summary: >- - This decorator is applied to a class's member function or property. It indicates that the definition may - optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a - definition, then child classes may NOT override it. This decorator is currently used for documentation purposes - only. In the future, it may be enforced at runtime. - name: 'virtual(target, propertyKey, descriptor)' - fullName: 'virtual(target, propertyKey, descriptor)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: - TypedPropertyDescriptor): void; - return: - type: - - void - description: '' - parameters: - - id: target - description: '' - type: - - '!Object:interface' - - id: propertyKey - description: '' - type: - - string | symbol - - id: descriptor - description: '' - type: - - '@microsoft/decorators!virtual~0:complex' -references: - - uid: '!Object:interface' - name: Object - - uid: '@microsoft/decorators!override~0:complex' - name: TypedPropertyDescriptor - fullName: TypedPropertyDescriptor - spec.typeScript: - - uid: '!TypedPropertyDescriptor:interface' - name: TypedPropertyDescriptor - fullName: TypedPropertyDescriptor - - name: - fullName: - - uid: '!Function:interface' - name: Function - - uid: '@microsoft/decorators!virtual~0:complex' - name: TypedPropertyDescriptor - fullName: TypedPropertyDescriptor - spec.typeScript: - - uid: '!TypedPropertyDescriptor:interface' - name: TypedPropertyDescriptor - fullName: TypedPropertyDescriptor - - name: - fullName: +### YamlMime:TSPacakge +uid: '@microsoft/decorators!' +name: '@microsoft/decorators' +type: package +summary: >- + A conservative set of decorators intended for use in both NodeJS and web + browser projects. +functions: + - name: 'override(target, propertyKey, descriptor)' + uid: '@microsoft/decorators!override:function(1)' + package: '@microsoft/decorators' + summary: >- + This decorator is applied to a class's member function or property. It + indicates that the definition overrides another defintion (of the same + name) from the base class. The base class definition must be marked as + @<!-- -->virtual. This decorator is currently used for documentation + purposes only. In the future, it may be enforced at runtime. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function override(target: Object, propertyKey: string | + symbol, descriptor: TypedPropertyDescriptor): void; + parameters: + - id: target + description: '' + type: '' + - id: propertyKey + description: '' + type: string | symbol + - id: descriptor + description: '' + type: '' + return: + type: void + description: '' + - name: sealed(target) + uid: '@microsoft/decorators!sealed:function(1)' + package: '@microsoft/decorators' + summary: >- + This decorator is applied to a class (but NOT member function or + property). It indicates that subclasses must not inherit from this class. + This decorator is currently used for documentation purposes only. In the + future, it may be enforced at runtime. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'export declare function sealed(target: Function): void;' + parameters: + - id: target + description: '' + type: '' + return: + type: void + description: '' + - name: 'virtual(target, propertyKey, descriptor)' + uid: '@microsoft/decorators!virtual:function(1)' + package: '@microsoft/decorators' + summary: >- + This decorator is applied to a class's member function or property. It + indicates that the definition may optionally be overridden in a child + class. Conversely, if the @<!-- -->virtual decorator is NOT applied + to a definition, then child classes may NOT override it. This decorator is + currently used for documentation purposes only. In the future, it may be + enforced at runtime. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function virtual(target: Object, propertyKey: string | + symbol, descriptor: TypedPropertyDescriptor): void; + parameters: + - id: target + description: '' + type: '' + - id: propertyKey + description: '' + type: string | symbol + - id: descriptor + description: '' + type: '' + return: + type: void + description: '' diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index 94cdbe8c..54f58e06 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -1,32 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!' - summary: SharePoint Framework support for building and extending client-side applications. - name: '@microsoft/sp-application-base' - fullName: '@microsoft/sp-application-base' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-application-base!ApplicationAccessor:class' - - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' - - '@microsoft/sp-application-base!PlaceholderContent:class' - - '@microsoft/sp-application-base!PlaceholderName:enum' - - '@microsoft/sp-application-base!PlaceholderProvider:class' -references: - - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' - name: ApplicationAccessor - - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - name: ApplicationCustomizerContext - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - name: BaseApplicationCustomizer - - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' - name: IPlaceholderCreateContentOptions - - uid: '@microsoft/sp-application-base!PlaceholderContent:class' - name: PlaceholderContent - - uid: '@microsoft/sp-application-base!PlaceholderName:enum' - name: PlaceholderName - - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' - name: PlaceholderProvider +### YamlMime:TSPacakge +uid: '@microsoft/sp-application-base!' +name: '@microsoft/sp-application-base' +type: package +summary: >- + SharePoint Framework support for building and extending client-side + applications. +classes: + - '@microsoft/sp-application-base!ApplicationAccessor:class' + - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + - '@microsoft/sp-application-base!PlaceholderContent:class' + - '@microsoft/sp-application-base!PlaceholderProvider:class' +interfaces: + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' +enums: + - '@microsoft/sp-application-base!PlaceholderName:enum' diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 210861bd..314e11f7 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -1,78 +1,65 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' - summary: Provides access to the client-side application that is currently running. - remarks: >- - The client-side application determines the user experience for an entire web page. (It is a client-side component - with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side - applications at this time.) Within a web page, at most one client-side application will be running at a time. - Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different - application. - - - The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with - the currently running application. It acts as a proxy for the real application object (the BaseApplication - subclass), to ensure that extensibility components only rely on interactions that would be portable across all - applications. - name: ApplicationAccessor - fullName: ApplicationAccessor - langs: - - typeScript - type: class - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' - - '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' - - uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' - summary: >- - Constructs a new instance of the - [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) class. - remarks: >- - Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component - context, for example - [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer#context:member). - name: (constructor)(serviceScope) - fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - '@microsoft/sp-core-library!ServiceScope:class' - - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' - summary: An event that is fired when the application's top-level page context navigates to a new page. - remarks: >- - This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has - navigated to a new page. - name: navigatedEvent - fullName: navigatedEvent - langs: - - typeScript - type: event - syntax: - content: 'readonly navigatedEvent: SPEvent;' - return: - type: - - '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent~0:complex' -references: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent~0:complex' - name: SPEvent - fullName: SPEvent - spec.typeScript: - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - fullName: SPEvent - - name: < - fullName: < - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs - fullName: SPEventArgs - - name: '>' - fullName: '>' +### YamlMime:TSType +name: ApplicationAccessor +uid: '@microsoft/sp-application-base!ApplicationAccessor:class' +package: '@microsoft/sp-application-base!' +fullName: ApplicationAccessor +summary: Provides access to the client-side application that is currently running. +remarks: >- + The client-side application determines the user experience for an entire web + page. (It is a client-side component with a manifest; however, the SharePoint + Framework does not enable third parties to create their own client-side + applications at this time.) Within a web page, at most one client-side + application will be running at a time. Certain in-place navigation transitions + can cause the application to be unloaded and replaced by a different + application. + + + The ApplicationAccessor class enables extensibility components such as + extensions and web parts to interact with the currently running application. + It acts as a proxy for the real application object (the BaseApplication + subclass), to ensure that extensibility components only rely on interactions + that would be portable across all applications. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' + package: '@microsoft/sp-application-base!' + fullName: (constructor)(serviceScope) + summary: >- + Constructs a new instance of the [ApplicationAccessor](xref:) class. + remarks: >- + Third parties should not call this constructor. Instead, use the + ApplicationAccessor instance from the component context, for example + [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer#context:member). + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: navigatedEvent + uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' + package: '@microsoft/sp-application-base!' + fullName: navigatedEvent + summary: >- + An event that is fired when the application's top-level page context + navigates to a new page. + remarks: >- + This event fires after the top-level + [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has + navigated to a new page. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly navigatedEvent: SPEvent;' + return: + type: >- + @microsoft/sp-application-base!ApplicationAccessor# diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index a7f80a4d..237e6fda 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -1,70 +1,61 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - summary: >- - The component context for - [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ApplicationCustomizerContext` class. - name: ApplicationCustomizerContext - fullName: ApplicationCustomizerContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponentContext:class' - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' - - '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' - - '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' - - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' - summary: Provides access to the client-side application that is currently running. - name: application - fullName: application - langs: - - typeScript - type: property - syntax: - content: 'readonly application: ApplicationAccessor;' - return: - type: - - '@microsoft/sp-application-base!default:class' - - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - dispose(): void; - return: - type: - - void - description: '' - - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' - summary: Exposes a collection of content placeholders for use by third parties. - name: placeholderProvider - fullName: placeholderProvider - langs: - - typeScript - type: property - syntax: - content: 'readonly placeholderProvider: PlaceholderProvider;' - return: - type: - - '@microsoft/sp-application-base!default:class' -references: - - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - name: ExtensionContext - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext - - uid: '@microsoft/sp-application-base!default:class' - name: ApplicationAccessor +### YamlMime:TSType +name: ApplicationCustomizerContext +uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' +package: '@microsoft/sp-application-base!' +fullName: ApplicationCustomizerContext +summary: >- + The component context for [BaseApplicationCustomizer](xref:)<!-- -->. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `ApplicationCustomizerContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: application + uid: >- + @microsoft/sp-application-base!ApplicationCustomizerContext#application:member + package: '@microsoft/sp-application-base!' + fullName: application + summary: Provides access to the client-side application that is currently running. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly application: ApplicationAccessor;' + return: + type: '' + - name: placeholderProvider + uid: >- + @microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member + package: '@microsoft/sp-application-base!' + fullName: placeholderProvider + summary: Exposes a collection of content placeholders for use by third parties. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly placeholderProvider: PlaceholderProvider;' + return: + type: '' +methods: + - name: dispose() + uid: >- + @microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1) + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + dispose(): void; + return: + type: void + description: '' +extends: '' diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index 484272c2..1d0337f9 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -1,95 +1,75 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - summary: >- - This is the base class that third parties should extend when implementing a client-side extension that runs when - an application is first starting. - remarks: >- - In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - - - Example usage scenarios for an application customizer might include: rendering custom UI elements inside a - SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a - certain time period. - name: BaseApplicationCustomizer - fullName: BaseApplicationCustomizer - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-application-base!BaseApplicationCustomizer~0:complex' - inheritance: - - type: '@microsoft/sp-application-base!BaseApplicationCustomizer~1:complex' - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' - - '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' - - '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'protected readonly context: ApplicationCustomizerContext;' - return: - type: - - '@microsoft/sp-application-base!default:class' - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' - summary: Disposes the component. - remarks: >- - Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends - for a web part or extension. To perform custom cleanup when your component is disposed, override the method. - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: 'dispose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' - summary: >- - This event method is called when the placeholders of the host application change, come into existence, or - disappear. - name: onPlaceholdersChanged(placeholderProvider) - fullName: onPlaceholdersChanged(placeholderProvider) - langs: - - typeScript - type: method - syntax: - content: 'protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;' - return: - type: - - void - description: '' - parameters: - - id: placeholderProvider - description: '' - type: - - '@microsoft/sp-application-base!default:class' -references: - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer~0:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer~1:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-application-base!default:class' - name: ApplicationCustomizerContext +### YamlMime:TSType +name: BaseApplicationCustomizer +uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' +package: '@microsoft/sp-application-base!' +fullName: BaseApplicationCustomizer +summary: >- + This is the base class that third parties should extend when implementing a + client-side extension that runs when an application is first starting. +remarks: >- + In the component manifest, the "extensionType" should be set to + "ApplicationCustomizer". + + + Example usage scenarios for an application customizer might include: rendering + custom UI elements inside a SharePoint content placeholder, tracking page load + statistics, or automatically logging the user out after a certain time period. +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' + package: '@microsoft/sp-application-base!' + fullName: context + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly context: ApplicationCustomizerContext;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: Disposes the component. + remarks: >- + Third-party code generally does not need to call this method; it's invoked + automatically when the lifecycle ends for a web part or extension. To + perform custom cleanup when your component is disposed, override the + method. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: onPlaceholdersChanged(placeholderProvider) + uid: >- + @microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1) + package: '@microsoft/sp-application-base!' + fullName: onPlaceholdersChanged(placeholderProvider) + summary: >- + This event method is called when the placeholders of the host application + change, come into existence, or disappear. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + protected onPlaceholdersChanged(placeholderProvider: + PlaceholderProvider): void; + parameters: + - id: placeholderProvider + description: '' + type: '' + return: + type: void + description: '' +extends: >- + diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index a4cd7ce6..babb9317 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -1,43 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' - summary: >- - Options for the - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) - method. - name: IPlaceholderCreateContentOptions - fullName: IPlaceholderCreateContentOptions - langs: - - typeScript - type: interface - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' - - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' - summary: An optional callback that will be invoked when the PlaceholderContent object is disposed. - remarks: >- - To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content - was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler - might call ReactDOM.unmountComponentAtNode() to unmount it. - name: onDispose - fullName: onDispose - langs: - - typeScript - type: property - syntax: - content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' - return: - type: - - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose~0:complex' -references: - - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose~0:complex' - name: '(placeholderContent: PlaceholderContent) => void' - fullName: '(placeholderContent: default) => void' - spec.typeScript: - - name: '(placeholderContent: ' - fullName: '(placeholderContent: ' - - uid: '@microsoft/sp-application-base!default:class' - name: PlaceholderContent - fullName: default - - name: ) => void - fullName: ) => void +### YamlMime:TSType +name: IPlaceholderCreateContentOptions +uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' +package: '@microsoft/sp-application-base!' +fullName: IPlaceholderCreateContentOptions +summary: >- + Options for the + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#)) method. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: onDispose + uid: >- + @microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member + package: '@microsoft/sp-application-base!' + fullName: onDispose + summary: >- + An optional callback that will be invoked when the PlaceholderContent + object is disposed. + remarks: >- + To avoid a resource leak, use this callback to free any resources that + were allocated when the placeholder content was rendered. For example, if + ReactDOM.render() was used to mount a React component, then the onDispose + handler might call ReactDOM.unmountComponentAtNode() to unmount it. + isPreview: false + isDeprecated: false + syntax: + content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' + return: + type: >- + @microsoft/sp-application-base!IPlaceholderCreateContentOptions# diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 0289ba91..22425fb0 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -1,105 +1,100 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!PlaceholderContent:class' - summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. - remarks: >- - This object is returned by - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `PlaceholderContent` class. - name: PlaceholderContent - fullName: PlaceholderContent - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IDisposable:interface' - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' - - '@microsoft/sp-application-base!PlaceholderContent#domElement:member' - - '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' - - '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' - - '@microsoft/sp-application-base!PlaceholderContent#name:member' - - uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' - summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. - remarks: >- - This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the - application when the containing placeholder is disposed. Calling dispose() invokes the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) - callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: 'dispose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' - summary: The Document Object Model (DOM) element where the owner should render its custom content. - remarks: >- - If the caller needs to be notified when the DOM element is disposed, use the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) - callback. - name: domElement - fullName: domElement - langs: - - typeScript - type: property - syntax: - content: 'readonly domElement: HTMLDivElement;' - return: - type: - - '!HTMLDivElement:interface' - - uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' - summary: >- - Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't - displaying it, this will return false. - name: isVisible - fullName: isVisible - langs: - - typeScript - type: property - syntax: - content: 'readonly isVisible: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' - summary: Identifies the placeholder that this content was added to. - remarks: 'Example: PlaceholderName.Top' - name: name - fullName: name - langs: - - typeScript - type: property - syntax: - content: 'readonly name: PlaceholderName;' - return: - type: - - '@microsoft/sp-application-base!~PlaceholderName:enum' -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '!HTMLDivElement:interface' - name: HTMLDivElement - - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' - name: PlaceholderName +### YamlMime:TSType +name: PlaceholderContent +uid: '@microsoft/sp-application-base!PlaceholderContent:class' +package: '@microsoft/sp-application-base!' +fullName: PlaceholderContent +summary: >- + Represents custom content that is rendered inside a placeholder on a + SharePoint page. +remarks: >- + This object is returned by + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the + owner can render its custom content. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `PlaceholderContent` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: domElement + uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' + package: '@microsoft/sp-application-base!' + fullName: domElement + summary: >- + The Document Object Model (DOM) element where the owner should render its + custom content. + remarks: >- + If the caller needs to be notified when the DOM element is disposed, use + the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) + callback. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLDivElement;' + return: + type: '' + - name: isDisposed + uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' + package: '@microsoft/sp-application-base!' + fullName: isDisposed + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean + - name: isVisible + uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' + package: '@microsoft/sp-application-base!' + fullName: isVisible + summary: >- + Return true if this PlacholderContent object is visible. If you create a + placeholder and the host page isn't displaying it, this will return false. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isVisible: boolean;' + return: + type: boolean + - name: name + uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' + package: '@microsoft/sp-application-base!' + fullName: name + summary: Identifies the placeholder that this content was added to. + remarks: 'Example: PlaceholderName.Top' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: PlaceholderName;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: >- + Disposes the PlaceholderContent object and removes its attached DOM + element from the page. + remarks: >- + This method can be called to immediately dispose the attached DOM element. + Otherwise, it will be disposed by the application when the containing + placeholder is disposed. Calling dispose() invokes the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) + callback, removes the associated DOM element from the page, and disposes + the PlaceholderContent object. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index f46b2010..8bd05116 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -1,34 +1,25 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!PlaceholderName:enum' - summary: >- - The identifier for a content placeholder, which is a region on the page where third-party extensibility components - can render custom content. - remarks: >- - For more information about placeholders, see - [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). - name: PlaceholderName - fullName: PlaceholderName - langs: - - typeScript - type: enum - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!PlaceholderName.Bottom:member' - - '@microsoft/sp-application-base!PlaceholderName.Top:member' - - uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' - summary: A region at the bottom of the page. - name: Bottom - fullName: Bottom - langs: - - typeScript - type: field - numericValue: '2' - - uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' - summary: A region at the top of the page. - name: Top - fullName: Top - langs: - - typeScript - type: field - numericValue: '1' +### YamlMime:TSEnum +name: PlaceholderName +uid: '@microsoft/sp-application-base!PlaceholderName:enum' +package: '@microsoft/sp-application-base!' +fullName: PlaceholderName +summary: >- + The identifier for a content placeholder, which is a region on the page where + third-party extensibility components can render custom content. +remarks: >- + For more information about placeholders, see + [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). +isPreview: false +isDeprecated: false +fields: + - name: Bottom + uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' + package: '@microsoft/sp-application-base!' + summary: A region at the bottom of the page. + numericValue: '2' + - name: Top + uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' + package: '@microsoft/sp-application-base!' + summary: A region at the top of the page. + numericValue: '1' diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 3d75bec7..c9fe6eda 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -1,162 +1,132 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' - summary: >- - Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party - components to render custom content into designated regions on the page. - remarks: >- - Placeholders are designated regions on the page, identified by one of the predefined - [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and - pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with - the page, for example via in-place navigation. Third-party components should not assume that a given placeholder - will always be available. - - - Use - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) - to test whether a placeholder is available and add content to it. Use the - [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member) - event to discover when new placeholders appear. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `PlaceholderProvider` class. - name: PlaceholderProvider - fullName: PlaceholderProvider - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IDisposable:interface' - package: '@microsoft/sp-application-base!' - children: - - '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' - - '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' - - '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' - - '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' - - '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' - - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' - summary: This event is raised when the list of currently available placeholders is changed. - remarks: >- - The application can change its list of available placeholders at any time. This means that the existing - placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when - they appear. - name: changedEvent - fullName: changedEvent - langs: - - typeScript - type: event - syntax: - content: 'readonly changedEvent: SPEvent;' - return: - type: - - '@microsoft/sp-application-base!PlaceholderProvider#changedEvent~0:complex' - - uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: 'dispose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' - summary: Returns the names of the currently available placeholders. - name: placeholderNames - fullName: placeholderNames - langs: - - typeScript - type: property - syntax: - content: 'readonly placeholderNames: ReadonlyArray;' - return: - type: - - '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames~0:complex' - - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' - summary: >- - Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, - which allows the caller to render custom content inside the placeholder. - remarks: >- - The host application makes no guarantees about the availability of a given placeholder. In situations where an - expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering - anything, or by choosing an alternative placeholder. - name: 'tryCreateContent(name, options)' - fullName: 'tryCreateContent(name, options)' - langs: - - typeScript - type: method - syntax: - content: >- - tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | - undefined; - return: - type: - - '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent~0:complex' - description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' - parameters: - - id: name - description: The requested placeholder - type: - - '@microsoft/sp-application-base!~PlaceholderName:enum' - - id: options - description: 'Additional options, for example to detect when the placeholder is disposed.' - type: - - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent~0:complex' - name: SPEvent - fullName: SPEvent - spec.typeScript: - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - fullName: SPEvent - - name: < - fullName: < - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs - fullName: SPEventArgs - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' - name: PlaceholderName - fullName: PlaceholderName - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent~0:complex' - name: PlaceholderContent | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-application-base!default:class' - name: PlaceholderContent - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' - name: PlaceholderName - - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' - name: IPlaceholderCreateContentOptions +### YamlMime:TSType +name: PlaceholderProvider +uid: '@microsoft/sp-application-base!PlaceholderProvider:class' +package: '@microsoft/sp-application-base!' +fullName: PlaceholderProvider +summary: >- + Allows third-party components to discover and use SharePoint placeholders. + Placeholders enable third-party components to render custom content into + designated regions on the page. +remarks: >- + Placeholders are designated regions on the page, identified by one of the + predefined + [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) + constants. Different applications and pages might support different + placeholder names. Placeholders can appear and disappear as the user interacts + with the page, for example via in-place navigation. Third-party components + should not assume that a given placeholder will always be available. + + + Use + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) + to test whether a placeholder is available and add content to it. Use the + [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member) + event to discover when new placeholders appear. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `PlaceholderProvider` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: changedEvent + uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' + package: '@microsoft/sp-application-base!' + fullName: changedEvent + summary: >- + This event is raised when the list of currently available placeholders is + changed. + remarks: >- + The application can change its list of available placeholders at any time. + This means that the existing placeholders may get disposed or new + placeholders may be added. Use this event to discover new placeholders + when they appear. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly changedEvent: SPEvent;' + return: + type: >- + @microsoft/sp-application-base!PlaceholderProvider# + - name: isDisposed + uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' + package: '@microsoft/sp-application-base!' + fullName: isDisposed + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean + - name: placeholderNames + uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' + package: '@microsoft/sp-application-base!' + fullName: placeholderNames + summary: Returns the names of the currently available placeholders. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly placeholderNames: ReadonlyArray;' + return: + type: >- + @microsoft/sp-application-base!PlaceholderProvider# +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: 'tryCreateContent(name, options)' + uid: >- + @microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1) + package: '@microsoft/sp-application-base!' + fullName: 'tryCreateContent(name, options)' + summary: >- + Tests whether the page contains the specified placeholder. If so, a new + PlaceholderContent object is created, which allows the caller to render + custom content inside the placeholder. + remarks: >- + The host application makes no guarantees about the availability of a given + placeholder. In situations where an expected placeholder is not available, + the third-party extension must handle it gracefully, e.g. by not rendering + anything, or by choosing an alternative placeholder. + isPreview: false + isDeprecated: false + syntax: + content: >- + tryCreateContent(name: PlaceholderName, options?: + IPlaceholderCreateContentOptions): PlaceholderContent | undefined; + parameters: + - id: name + description: The requested placeholder + type: '' + - id: options + description: >- + Additional options, for example to detect when the placeholder is + disposed. + type: >- + + return: + type: >- + @microsoft/sp-application-base!PlaceholderProvider# + description: >- + A new PlaceholderContent object, or undefined if the requested + placeholder does not exist. diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index b48028ac..45323f90 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -1,86 +1,24 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!' - summary: SharePoint Framework support for building client-side components - remarks: >- - This package supports development of client-side components (e.g. web parts, client-side extensions, and - applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality - that is common across all client-side component types. - name: '@microsoft/sp-component-base' - fullName: '@microsoft/sp-component-base' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-component-base!BaseComponent:class' - - '@microsoft/sp-component-base!BaseComponentContext:class' - - '@microsoft/sp-component-base!DynamicDataProvider:class' - - '@microsoft/sp-component-base!DynamicDataSourceManager:class' - - '@microsoft/sp-component-base!DynamicProperty:class' - - '@microsoft/sp-component-base!IFontStyles:interface' - - '@microsoft/sp-component-base!IPalette:interface' - - '@microsoft/sp-component-base!IRawStyle:interface' - - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - '@microsoft/sp-component-base!IReadonlyTheme:interface' - - '@microsoft/sp-component-base!ISemanticColors:interface' - - '@microsoft/sp-component-base!ISemanticTextColors:interface' - - '@microsoft/sp-component-base!ITheme:interface' - - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - - '@microsoft/sp-component-base!ThemeProvider:class' - - uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' - name: IReadonlyRawStyle - fullName: IReadonlyRawStyle - langs: - - typeScript - type: typealias - syntax: - content: export declare type IReadonlyRawStyle = Readonly; - return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle~0:complex' -references: - - uid: '@microsoft/sp-component-base!BaseComponent:class' - name: BaseComponent - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext - - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' - name: DynamicDataProvider - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' - name: DynamicDataSourceManager - - uid: '@microsoft/sp-component-base!DynamicProperty:class' - name: DynamicProperty - - uid: '@microsoft/sp-component-base!IFontStyles:interface' - name: IFontStyles - - uid: '@microsoft/sp-component-base!IPalette:interface' - name: IPalette - - uid: '@microsoft/sp-component-base!IRawStyle:interface' - name: IRawStyle - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - name: IReadonlyFontStyles - - uid: '@microsoft/sp-component-base!IReadonlyRawStyle~0:complex' - name: Readonly - fullName: Readonly - spec.typeScript: - - uid: '!Readonly:type' - name: Readonly - fullName: Readonly - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!IRawStyle:interface' - name: IRawStyle - fullName: IRawStyle - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - name: IReadonlyTheme - - uid: '@microsoft/sp-component-base!ISemanticColors:interface' - name: ISemanticColors - - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' - name: ISemanticTextColors - - uid: '@microsoft/sp-component-base!ITheme:interface' - name: ITheme - - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - name: ThemeChangedEventArgs - - uid: '@microsoft/sp-component-base!ThemeProvider:class' - name: ThemeProvider +### YamlMime:TSPacakge +uid: '@microsoft/sp-component-base!' +name: '@microsoft/sp-component-base' +type: package +summary: SharePoint Framework support for building client-side components +classes: + - '@microsoft/sp-component-base!BaseComponent:class' + - '@microsoft/sp-component-base!BaseComponentContext:class' + - '@microsoft/sp-component-base!DynamicDataProvider:class' + - '@microsoft/sp-component-base!DynamicDataSourceManager:class' + - '@microsoft/sp-component-base!DynamicProperty:class' + - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + - '@microsoft/sp-component-base!ThemeProvider:class' +interfaces: + - '@microsoft/sp-component-base!IFontStyles:interface' + - '@microsoft/sp-component-base!IPalette:interface' + - '@microsoft/sp-component-base!IRawStyle:interface' + - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - '@microsoft/sp-component-base!IReadonlyTheme:interface' + - '@microsoft/sp-component-base!ISemanticColors:interface' + - '@microsoft/sp-component-base!ISemanticTextColors:interface' + - '@microsoft/sp-component-base!ITheme:interface' +typeAliases: + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 7a4eda0a..9ba57911 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -1,135 +1,133 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!BaseComponent:class' - summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseComponent` class. - name: BaseComponent - fullName: BaseComponent - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!ISPEventObserver:interface' - package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!BaseComponent#componentId:member' - - '@microsoft/sp-component-base!BaseComponent#context:member' - - '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' - - '@microsoft/sp-component-base!BaseComponent#instanceId:member' - - '@microsoft/sp-component-base!BaseComponent#isDisposed:member' - - '@microsoft/sp-component-base!BaseComponent#manifest:member' - - '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' - - uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' - summary: Returns the component identifier as defined in the component’s associated manifest. - remarks: >- - Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which - may include additional metadata about the component. The manifest is uniquely identified using a text string - containing a lower case GUID value. - name: componentId - fullName: componentId - langs: - - typeScript - type: property - syntax: - content: 'readonly componentId: string;' - return: - type: - - string - - uid: '@microsoft/sp-component-base!BaseComponent#context:member' - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'protected context: BaseComponentContext;' - return: - type: - - '@microsoft/sp-component-base!~BaseComponentContext:class' - - uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' - summary: Disposes the component. - remarks: >- - Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends - for a web part or extension. To perform custom cleanup when your component is disposed, override the - [onDispose()](xref:@microsoft/sp-component-base!BaseComponent#onDispose:member(1)) method. - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: 'dispose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' - summary: A unique identifier for the instance of the component. - remarks: >- - A component implementation can be loaded multiple times on the page. For example, if the component is a charting - web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely - identifies each of these instances. - name: instanceId - fullName: instanceId - langs: - - typeScript - type: property - syntax: - content: 'readonly instanceId: string;' - return: - type: - - string - - uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' - summary: Returns true if the component has been already disposed. - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' - summary: Provides access to the manifest for the client-side component. - remarks: Child classes can override this with more specialized manifest types. - name: manifest - fullName: manifest - langs: - - typeScript - type: property - syntax: - content: 'readonly manifest: IClientSideComponentManifest;' - return: - type: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - - uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' - summary: >- - This event method is called at the end of the component's lifecycle. It provides an opportunity to release any - associated resources, cancel any outstanding requests, etc. - name: onDispose() - fullName: onDispose() - langs: - - typeScript - type: method - syntax: - content: 'protected onDispose(): void;' - return: - type: - - void - description: '' -references: - - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' - name: ISPEventObserver - - uid: '@microsoft/sp-component-base!~BaseComponentContext:class' - name: BaseComponentContext - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest +### YamlMime:TSType +name: BaseComponent +uid: '@microsoft/sp-component-base!BaseComponent:class' +package: '@microsoft/sp-component-base!' +fullName: BaseComponent +summary: >- + The base class for client-side components such as BaseClientSideWebPart or + BaseExtension. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `BaseComponent` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: componentId + uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' + package: '@microsoft/sp-component-base!' + fullName: componentId + summary: >- + Returns the component identifier as defined in the component’s associated + manifest. + remarks: >- + Each client-side component has an associated manifest that is used by the + sp-loader to load its scripts, and which may include additional metadata + about the component. The manifest is uniquely identified using a text + string containing a lower case GUID value. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly componentId: string;' + return: + type: string + - name: context + uid: '@microsoft/sp-component-base!BaseComponent#context:member' + package: '@microsoft/sp-component-base!' + fullName: context + summary: >- + Use the context object to access common services and state associated with + the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'protected context: BaseComponentContext;' + return: + type: >- + + - name: instanceId + uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' + package: '@microsoft/sp-component-base!' + fullName: instanceId + summary: A unique identifier for the instance of the component. + remarks: >- + A component implementation can be loaded multiple times on the page. For + example, if the component is a charting web part, multiple instances of + this web part could be added to the SharePoint canvas. The instanceId + uniquely identifies each of these instances. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly instanceId: string;' + return: + type: string + - name: isDisposed + uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the component has been already disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean + - name: manifest + uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' + package: '@microsoft/sp-component-base!' + fullName: manifest + summary: Provides access to the manifest for the client-side component. + remarks: Child classes can override this with more specialized manifest types. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IClientSideComponentManifest;' + return: + type: >- + +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: Disposes the component. + remarks: >- + Third-party code generally does not need to call this method; it's invoked + automatically when the lifecycle ends for a web part or extension. To + perform custom cleanup when your component is disposed, override the + [onDispose()](xref:@microsoft/sp-component-base!BaseComponent#onDispose:member(1)) + method. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: onDispose() + summary: >- + This event method is called at the end of the component's lifecycle. It + provides an opportunity to release any associated resources, cancel any + outstanding requests, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onDispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index cc828e10..8392c6d6 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -1,219 +1,203 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - summary: The base class for context objects for client-side components. - remarks: >- - A "context" object is a collection of well-known services and other objects that are likely to be needed by - business logic that interacts with a associated component. Each component type has its own specialized subclass of - BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseComponentContext` class. - name: BaseComponentContext - fullName: BaseComponentContext - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IDisposable:interface' - package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' - - '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' - - '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' - - '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' - - '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' - - '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' - - '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' - - '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' - - '@microsoft/sp-component-base!BaseComponentContext#manifest:member' - - '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' - - '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' - - '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' - - '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' - - uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' - summary: The instance of AadHttpClientFactory created for this instance of component - name: aadHttpClientFactory - fullName: aadHttpClientFactory - langs: - - typeScript - type: property - syntax: - content: 'readonly aadHttpClientFactory: AadHttpClientFactory;' - return: - type: - - '@microsoft/sp-http!AadHttpClientFactory:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' - summary: The instance of AadTokenProviderFactory created for this instance of component - name: aadTokenProviderFactory - fullName: aadTokenProviderFactory - langs: - - typeScript - type: property - syntax: - content: 'readonly aadTokenProviderFactory: AadTokenProviderFactory;' - return: - type: - - '@microsoft/sp-http!AadTokenProviderFactory:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' - summary: Disposes the base component context. - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: 'dispose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' - summary: Returns the Dynamic Data Provider associated with the component. - name: dynamicDataProvider - fullName: dynamicDataProvider - langs: - - typeScript - type: property - syntax: - content: 'readonly dynamicDataProvider: DynamicDataProvider;' - return: - type: - - '@microsoft/sp-component-base!default:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' - summary: Returns the Dynamic Data Source Manager associated with the component. - name: dynamicDataSourceManager - fullName: dynamicDataSourceManager - langs: - - typeScript - type: property - syntax: - content: 'readonly dynamicDataSourceManager: DynamicDataSourceManager;' - return: - type: - - '@microsoft/sp-component-base!default:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' - summary: The instance of HttpClient created for this instance of component - name: httpClient - fullName: httpClient - langs: - - typeScript - type: property - syntax: - content: 'readonly httpClient: HttpClient;' - return: - type: - - '@microsoft/sp-http!HttpClient:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' - summary: A unique identifier for the instance of the component. - remarks: >- - A component implementation can be loaded multiple times on the page. For example, if the component is a charting - web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely - identifies each of these instances. - name: instanceId - fullName: instanceId - langs: - - typeScript - type: property - syntax: - content: 'readonly instanceId: string;' - return: - type: - - string - - uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' - summary: Returns true if the context is disposed. - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' - summary: Manifest for the client-side component. - name: manifest - fullName: manifest - langs: - - typeScript - type: property - syntax: - content: 'readonly manifest: IClientSideComponentManifest;' - return: - type: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - - uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' - summary: The instance of MSGraphClientFactory created for this instance of component - name: msGraphClientFactory - fullName: msGraphClientFactory - langs: - - typeScript - type: property - syntax: - content: 'readonly msGraphClientFactory: MSGraphClientFactory;' - return: - type: - - '@microsoft/sp-http!MSGraphClientFactory:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' - summary: >- - The page context provides standard definitions for common SharePoint objects that need to be shared between the - client-side application, web parts, and other components. - name: pageContext - fullName: pageContext - langs: - - typeScript - type: property - syntax: - content: 'readonly pageContext: PageContext;' - return: - type: - - '@microsoft/sp-page-context!PageContext:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' - summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' - remarks: A child service scope is created for each client-side component. - name: serviceScope - fullName: serviceScope - langs: - - typeScript - type: property - syntax: - content: 'readonly serviceScope: ServiceScope;' - return: - type: - - '@microsoft/sp-core-library!ServiceScope:class' - - uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' - summary: The instance of SpHttpClient created for this instance of component - name: spHttpClient - fullName: spHttpClient - langs: - - typeScript - type: property - syntax: - content: 'readonly spHttpClient: SPHttpClient;' - return: - type: - - '@microsoft/sp-http!SPHttpClient:class' -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '@microsoft/sp-http!AadHttpClientFactory:class' - name: AadHttpClientFactory - - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' - name: AadTokenProviderFactory - - uid: '@microsoft/sp-component-base!default:class' - name: DynamicDataProvider - - uid: '@microsoft/sp-http!HttpClient:class' - name: HttpClient - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-http!MSGraphClientFactory:class' - name: MSGraphClientFactory - - uid: '@microsoft/sp-page-context!PageContext:class' - name: PageContext - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-http!SPHttpClient:class' - name: SPHttpClient +### YamlMime:TSType +name: BaseComponentContext +uid: '@microsoft/sp-component-base!BaseComponentContext:class' +package: '@microsoft/sp-component-base!' +fullName: BaseComponentContext +summary: The base class for context objects for client-side components. +remarks: >- + A "context" object is a collection of well-known services and other objects + that are likely to be needed by business logic that interacts with a + associated component. Each component type has its own specialized subclass of + BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for + client-side extensions, and so on. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `BaseComponentContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: aadHttpClientFactory + uid: >- + @microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member + package: '@microsoft/sp-component-base!' + fullName: aadHttpClientFactory + summary: >- + The instance of AadHttpClientFactory created for this instance of + component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly aadHttpClientFactory: AadHttpClientFactory;' + return: + type: '' + - name: aadTokenProviderFactory + uid: >- + @microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member + package: '@microsoft/sp-component-base!' + fullName: aadTokenProviderFactory + summary: >- + The instance of AadTokenProviderFactory created for this instance of + component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly aadTokenProviderFactory: AadTokenProviderFactory;' + return: + type: '' + - name: dynamicDataProvider + uid: >- + @microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member + package: '@microsoft/sp-component-base!' + fullName: dynamicDataProvider + summary: Returns the Dynamic Data Provider associated with the component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dynamicDataProvider: DynamicDataProvider;' + return: + type: '' + - name: dynamicDataSourceManager + uid: >- + @microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member + package: '@microsoft/sp-component-base!' + fullName: dynamicDataSourceManager + summary: Returns the Dynamic Data Source Manager associated with the component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dynamicDataSourceManager: DynamicDataSourceManager;' + return: + type: '' + - name: httpClient + uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' + package: '@microsoft/sp-component-base!' + fullName: httpClient + summary: The instance of HttpClient created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly httpClient: HttpClient;' + return: + type: '' + - name: instanceId + uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' + package: '@microsoft/sp-component-base!' + fullName: instanceId + summary: A unique identifier for the instance of the component. + remarks: >- + A component implementation can be loaded multiple times on the page. For + example, if the component is a charting web part, multiple instances of + this web part could be added to the SharePoint canvas. The instanceId + uniquely identifies each of these instances. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly instanceId: string;' + return: + type: string + - name: isDisposed + uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the context is disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean + - name: manifest + uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' + package: '@microsoft/sp-component-base!' + fullName: manifest + summary: Manifest for the client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IClientSideComponentManifest;' + return: + type: >- + + - name: msGraphClientFactory + uid: >- + @microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member + package: '@microsoft/sp-component-base!' + fullName: msGraphClientFactory + summary: >- + The instance of MSGraphClientFactory created for this instance of + component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly msGraphClientFactory: MSGraphClientFactory;' + return: + type: '' + - name: pageContext + uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' + package: '@microsoft/sp-component-base!' + fullName: pageContext + summary: >- + The page context provides standard definitions for common SharePoint + objects that need to be shared between the client-side application, web + parts, and other components. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pageContext: PageContext;' + return: + type: '' + - name: serviceScope + uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' + package: '@microsoft/sp-component-base!' + fullName: serviceScope + summary: >- + The associated [ServiceScope](xref:) for this + component. + remarks: A child service scope is created for each client-side component. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serviceScope: ServiceScope;' + return: + type: '' + - name: spHttpClient + uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' + package: '@microsoft/sp-component-base!' + fullName: spHttpClient + summary: The instance of SpHttpClient created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly spHttpClient: SPHttpClient;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: Disposes the base component context. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index a620f664..353cb2bb 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -1,241 +1,222 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' - summary: >- - The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data - sources and register/unregister to those. - name: DynamicDataProvider - fullName: DynamicDataProvider - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IDisposable:interface' +### YamlMime:TSType +name: DynamicDataProvider +uid: '@microsoft/sp-component-base!DynamicDataProvider:class' +package: '@microsoft/sp-component-base!' +fullName: DynamicDataProvider +summary: >- + The Dynamic Data Provider allows components to consume Dynamic Data. It allows + components to request Dynamic Data sources and register/unregister to those. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: isDisposed + uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the Dynamic Data Provider is disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' - - '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' - - uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' - summary: Disposes the Dynamic Data Provider. - name: dispose() fullName: dispose() - langs: - - typeScript - type: method + summary: Disposes the Dynamic Data Provider. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'dispose(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' - summary: Returns a list with all available Dynamic Data Sources. - name: getAvailableSources() + - name: getAvailableSources() + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1) + package: '@microsoft/sp-component-base!' fullName: getAvailableSources() - langs: - - typeScript - type: method + summary: Returns a list with all available Dynamic Data Sources. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getAvailableSources(): ReadonlyArray;' return: - type: - - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' + type: >- + @microsoft/sp-component-base!DynamicDataProvider# description: Read-only array with all available sources. - - uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' - summary: Returns true if the Dynamic Data Provider is disposed. - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' - summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. - name: registerAvailableSourcesChanged(callback) + - name: registerAvailableSourcesChanged(callback) + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1) + package: '@microsoft/sp-component-base!' fullName: registerAvailableSourcesChanged(callback) - langs: - - typeScript - type: method + summary: >- + Registers a callback to an event that raises when the list of available + Dynamic Data Sources is updated. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'registerAvailableSourcesChanged(callback: () => void): void;' - return: - type: - - void - description: '' parameters: - id: callback description: Function to execute when the sources are updated. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' - summary: Registers a callback for updates when a property is changed in a Dynamic Data source. - name: 'registerPropertyChanged(sourceId, propertyId, callback)' - fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' - langs: - - typeScript - type: method - syntax: - content: 'registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + type: () => void return: - type: - - void + type: void description: '' + - name: 'registerPropertyChanged(sourceId, propertyId, callback)' + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1) + package: '@microsoft/sp-component-base!' + fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' + summary: >- + Registers a callback for updates when a property is changed in a Dynamic + Data source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + registerPropertyChanged(sourceId: string, propertyId: string, callback: + () => void): void; parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: - - string + type: string - id: propertyId description: Id of the property of the source. - type: - - string + type: string - id: callback description: Function to execute when the source updates its data. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' - summary: >- - Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated - within the source. - name: 'registerSourceChanged(sourceId, callback)' + type: () => void + return: + type: void + description: '' + - name: 'registerSourceChanged(sourceId, callback)' + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1) + package: '@microsoft/sp-component-base!' fullName: 'registerSourceChanged(sourceId, callback)' - langs: - - typeScript - type: method + summary: >- + Registers a callback for updates when a Dynamic Data source is changed. + This happens when any property is updated within the source. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'registerSourceChanged(sourceId: string, callback: () => void): void;' - return: - type: - - void - description: '' parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: - - string + type: string - id: callback description: Function to execute when the source updates its data. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' - summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' - name: tryGetSource(id) + type: () => void + return: + type: void + description: '' + - name: tryGetSource(id) + uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' + package: '@microsoft/sp-component-base!' fullName: tryGetSource(id) - langs: - - typeScript - type: method + summary: >- + Returns a Dynamic Data Source, by its id. If the source is not present, it + returns undefined. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tryGetSource(id: string): IDynamicDataSource | undefined;' - return: - type: - - '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource~0:complex' - description: '' parameters: - id: id description: Id of the Dynamic Data Source. - type: - - string - - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' - summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. - name: unregisterAvailableSourcesChanged(callback) + type: string + return: + type: >- + @microsoft/sp-component-base!DynamicDataProvider# + description: '' + - name: unregisterAvailableSourcesChanged(callback) + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1) + package: '@microsoft/sp-component-base!' fullName: unregisterAvailableSourcesChanged(callback) - langs: - - typeScript - type: method + summary: >- + Unregisters a callback to an event that raises when the list of available + Dynamic Data Sources is updated. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'unregisterAvailableSourcesChanged(callback: () => void): void;' - return: - type: - - void - description: '' parameters: - id: callback - description: Function to remove from the registration. Must be the same it was registered with. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' - summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - langs: - - typeScript - type: method - syntax: - content: 'unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + description: >- + Function to remove from the registration. Must be the same it was + registered with. + type: () => void return: - type: - - void + type: void description: '' + - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1) + package: '@microsoft/sp-component-base!' + fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + summary: >- + Unregisters a callback for updates when a property is changed in a Dynamic + Data source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + unregisterPropertyChanged(sourceId: string, propertyId: string, + callback: () => void): void; parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: - - string + type: string - id: propertyId description: Id of the property of the source. - type: - - string + type: string - id: callback - description: Function to remove from the registration. Must be the same it was registered with. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' - summary: Unregisters a callback for updates when a Dynamic Data source is changed. - name: 'unregisterSourceChanged(sourceId, callback)' + description: >- + Function to remove from the registration. Must be the same it was + registered with. + type: () => void + return: + type: void + description: '' + - name: 'unregisterSourceChanged(sourceId, callback)' + uid: >- + @microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1) + package: '@microsoft/sp-component-base!' fullName: 'unregisterSourceChanged(sourceId, callback)' - langs: - - typeScript - type: method + summary: Unregisters a callback for updates when a Dynamic Data source is changed. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'unregisterSourceChanged(sourceId: string, callback: () => void): void;' - return: - type: - - void - description: '' parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: - - string + type: string - id: callback - description: Function to remove from the registration. Must be the same it was registered with. - type: - - () => void -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - name: IDynamicDataSource - fullName: IDynamicDataSource - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource~0:complex' - name: IDynamicDataSource | undefined - fullName: IDynamicDataSource | undefined - spec.typeScript: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - name: IDynamicDataSource - fullName: IDynamicDataSource - - name: ' | undefined' - fullName: ' | undefined' + description: >- + Function to remove from the registration. Must be the same it was + registered with. + type: () => void + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 70dd4d0f..dd07f2ca 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -1,160 +1,140 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' +### YamlMime:TSType +name: DynamicDataSourceManager +uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' +package: '@microsoft/sp-component-base!' +fullName: DynamicDataSourceManager +summary: >- + The Dynamic Data Source Manager is responsible for: - Constructing the dynamic + data source - Allowing initialization of the dynamic data source by a + component - Allowing data source to update its metadata and notify when data + has been updated. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: isDisposed + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the DynamicDataSourceManager is disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean + - name: sourceId + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' + package: '@microsoft/sp-component-base!' + fullName: sourceId summary: >- - The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing - initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify - when data has been updated. - name: DynamicDataSourceManager - fullName: DynamicDataSourceManager - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IDisposable:interface' + Returns the Id of the current DataSource. If the component did not + initialize as a dynamic data source, then it returns an empty string. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sourceId: string;' + return: + type: string +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' - - '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' - - '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' - - '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' - - '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' - - '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' - summary: Disposes the resources held by the Dynamic Data source. - name: dispose() fullName: dispose() - langs: - - typeScript - type: method + summary: Disposes the resources held by the Dynamic Data source. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'dispose(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' - summary: Initializes the Dynamic Data Source for the component. - name: initializeSource(callableFunctions) + - name: initializeSource(callableFunctions) + uid: >- + @microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1) + package: '@microsoft/sp-component-base!' fullName: initializeSource(callableFunctions) - langs: - - typeScript - type: method + summary: Initializes the Dynamic Data Source for the component. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'initializeSource(callableFunctions: IDynamicDataCallables): void;' - return: - type: - - void - description: '' parameters: - id: callableFunctions description: Set of methods that are exposed through the Dynamic Data Source - type: - - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' - summary: Returns true if the DynamicDataSourceManager is disposed. - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' + type: >- + return: - type: - - boolean - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' + type: void + description: '' + - name: notifyPropertyChanged(propertyId) + uid: >- + @microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1) + package: '@microsoft/sp-component-base!' + fullName: notifyPropertyChanged(propertyId) summary: >- Notifies that this source has updated a specific property. - When invoked, it enables to broadcast the notification to all the consumers who have registered to this - notification from this source. - name: notifyPropertyChanged(propertyId) - fullName: notifyPropertyChanged(propertyId) - langs: - - typeScript - type: method + When invoked, it enables to broadcast the notification to all the + consumers who have registered to this notification from this source. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'notifyPropertyChanged(propertyId: string): void;' - return: - type: - - void - description: '' parameters: - id: propertyId description: Id of the updated property in the source. - type: - - string - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' + type: string + return: + type: void + description: '' + - name: notifySourceChanged() + uid: >- + @microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1) + package: '@microsoft/sp-component-base!' + fullName: notifySourceChanged() summary: >- Notifies that this source has updated its properties. - When invoked, it enables to broadcast the notification to all the consumers who have registered to this - notification from this source. - name: notifySourceChanged() - fullName: notifySourceChanged() - langs: - - typeScript - type: method + When invoked, it enables to broadcast the notification to all the + consumers who have registered to this notification from this source. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'notifySourceChanged(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' - summary: >- - Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it - returns an empty string. - name: sourceId - fullName: sourceId - langs: - - typeScript - type: property - syntax: - content: 'readonly sourceId: string;' - return: - type: - - string - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' - summary: >- - Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. - Auto-generated fields like alias, componentId or instanceId cannot be updated. - name: updateMetadata(metadata) + - name: updateMetadata(metadata) + uid: >- + @microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1) + package: '@microsoft/sp-component-base!' fullName: updateMetadata(metadata) - langs: - - typeScript - type: method + summary: >- + Updates the metadata of the Dynamic Data Source. It allows to update + fields like title or description. Auto-generated fields like alias, + componentId or instanceId cannot be updated. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'updateMetadata(metadata: Partial): void;' - return: - type: - - void - description: '' parameters: - id: metadata description: Partial of the metadata. - type: - - '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata~0:complex' -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - name: IDynamicDataCallables - - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata~0:complex' - name: Partial - fullName: Partial - spec.typeScript: - - uid: '!Partial:type' - name: Partial - fullName: Partial - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - name: IDynamicDataSourceMetadata - fullName: IDynamicDataSourceMetadata - - name: '>' - fullName: '>' + type: >- + @microsoft/sp-component-base!DynamicDataSourceManager# + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index daf57f26..5a469aaf 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -1,265 +1,251 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!DynamicProperty:class' - summary: Serializable object that simplifies usage of a DynamicProperty. - remarks: >- - This is built for usage in web part properties, and modified through the property pane. Can be initialized with a - default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change - in the DynamicProperty will re-render the web part automatically. - name: DynamicProperty - fullName: DynamicProperty - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IDisposable:interface' +### YamlMime:TSType +name: DynamicProperty +uid: '@microsoft/sp-component-base!DynamicProperty:class' +package: '@microsoft/sp-component-base!' +fullName: DynamicProperty +summary: Serializable object that simplifies usage of a DynamicProperty. +remarks: >- + This is built for usage in web part properties, and modified through the + property pane. Can be initialized with a default callback. Web parts + initialize with the render method so if the 3rd party developer does nothing, + a change in the DynamicProperty will re-render the web part automatically. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(provider, callback)' + uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!DynamicProperty:constructor(1)' - - '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' - - '@microsoft/sp-component-base!DynamicProperty#reference:member' - - '@microsoft/sp-component-base!DynamicProperty#register:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' - - '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' - - uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' - summary: Create a new DynamicProperty object. - name: '(constructor)(provider, callback)' fullName: '(constructor)(provider, callback)' - langs: - - typeScript - type: constructor + summary: Create a new DynamicProperty object. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' parameters: - id: provider description: DynamicDataProvider. - type: - - '@microsoft/sp-component-base!default:class' + type: '' - id: callback - description: Optional. Default callback to be registered for updates in the DynamicDataSource. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' - summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - name: dispose() + description: >- + Optional. Default callback to be registered for updates in the + DynamicDataSource. + type: () => void +properties: + - name: isDisposed + uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: >- + Returns true if the dispose() method has been called. Once an object is + disposed, it remains in this state permanently. + remarks: >- + After the object has been disposed, do not call its methods or access its + properties. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDisposed: boolean;' + return: + type: boolean + - name: reference + uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' + package: '@microsoft/sp-component-base!' + fullName: reference + summary: >- + DynamicDataReference string that the DynamicProperty object points to. The + reference is of the form + `<source>:<property>:<path>`<!-- -->. + remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly reference: string | undefined;' + return: + type: string | undefined +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' + package: '@microsoft/sp-component-base!' fullName: dispose() - langs: - - typeScript - type: method + summary: This method is called to permanently dispose the object. + remarks: >- + After the object has been disposed, do not call its methods or access its + properties. + isPreview: false + isDeprecated: false syntax: content: 'dispose(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' - summary: Returns true if the object has a default callback. - name: hasDefaultCallback() + - name: hasDefaultCallback() + uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' + package: '@microsoft/sp-component-base!' fullName: hasDefaultCallback() - langs: - - typeScript - type: method + summary: Returns true if the object has a default callback. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'hasDefaultCallback(): boolean;' return: - type: - - boolean + type: boolean description: '' - - uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' - summary: >- - Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state - permanently. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'readonly isDisposed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' - summary: >- - DynamicDataReference string that the DynamicProperty object points to. The reference is of the form - `::`. - remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' - name: reference - fullName: reference - langs: - - typeScript - type: property - syntax: - content: 'readonly reference: string | undefined;' - return: - type: - - string | undefined - - uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' - summary: Registers a callback function for updates on the associated DynamicDataSource. - name: register(callback) + - name: register(callback) + uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' + package: '@microsoft/sp-component-base!' fullName: register(callback) - langs: - - typeScript - type: method + summary: >- + Registers a callback function for updates on the associated + DynamicDataSource. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'register(callback: () => void): void;' - return: - type: - - void - description: '' parameters: - id: callback description: Callback function to register. - type: - - () => void - - uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' - summary: Removes the registration for the default callback. - remarks: This can be useful for advanced users who only want their custom callbacks. - name: removeDefaultCallback() + type: () => void + return: + type: void + description: '' + - name: removeDefaultCallback() + uid: >- + @microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1) + package: '@microsoft/sp-component-base!' fullName: removeDefaultCallback() - langs: - - typeScript - type: method + summary: Removes the registration for the default callback. + remarks: >- + This can be useful for advanced users who only want their custom + callbacks. + isPreview: false + isDeprecated: false syntax: content: 'removeDefaultCallback(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' - summary: >- - Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is - of the form `::`. - name: setReference(reference) + - name: setReference(reference) + uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' + package: '@microsoft/sp-component-base!' fullName: setReference(reference) - langs: - - typeScript - type: method + summary: >- + Sets the value of the DynamicProperty to be a reference to a + DynamicDynamicSource and property. The reference is of the form + `<source>:<property>:<path>`<!-- -->. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'setReference(reference: string): void;' - return: - type: - - void - description: '' parameters: - id: reference description: Id of the DynamicDataSource and property. - type: - - string - - uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' - summary: Sets a static value in the DynamicProperty. - name: setValue(value) + type: string + return: + type: void + description: '' + - name: setValue(value) + uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' + package: '@microsoft/sp-component-base!' fullName: setValue(value) - langs: - - typeScript - type: method + summary: Sets a static value in the DynamicProperty. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'setValue(value: TValue): void;' - return: - type: - - void - description: '' parameters: - id: value description: Value for the DynamicProperty. - type: - - TValue - - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' - summary: >- - Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't - exist. - name: tryGetSource() + type: TValue + return: + type: void + description: '' + - name: tryGetSource() + uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' + package: '@microsoft/sp-component-base!' fullName: tryGetSource() - langs: - - typeScript - type: method + summary: >- + Returns the DynamicDataSource that the DynamicProperty object refers to. + Returns undefined if the source doesn't exist. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: - type: - - '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' + type: >- + @microsoft/sp-component-base!DynamicProperty# description: '' - - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' + - name: tryGetValue() + uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetValue() summary: Returns the value of the object. remarks: >- - If the value is an array, then the first element of the array is returned; otherwise, the value itself is - returned. + If the value is an array, then the first element of the array is returned; + otherwise, the value itself is returned. - NOTE: This api will never return an array. To retrieve an array value, use the - [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)) API. - name: tryGetValue() - fullName: tryGetValue() - langs: - - typeScript - type: method + NOTE: This api will never return an array. To retrieve an array value, use + the + [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)) + API. + isPreview: false + isDeprecated: false syntax: content: 'tryGetValue(): TValue | undefined;' return: - type: - - TValue | undefined - description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. - - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' + type: TValue | undefined + description: >- + the value associated with the dynamic property or undefined if the + source or the data doesn't exist. + - name: tryGetValues() + uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetValues() summary: Returns the value of the object. remarks: >- - If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the - value itself is returned. If the property is undefined or cannot be found, an empty array will be returned. + If the value is NOT an array, then an array is returned with the value + being the single entry; otherwise, the value itself is returned. If the + property is undefined or cannot be found, an empty array will be returned. - NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array - value, use the - [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)) API. - name: tryGetValues() - fullName: tryGetValues() - langs: - - typeScript - type: method + NOTE: This api will always return an array and it assumes that the array + is homogeneous. To retrieve a non-array value, use the + [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)) + API. + isPreview: false + isDeprecated: false syntax: content: 'tryGetValues(): TValue[];' return: - type: - - 'TValue[]' - description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - - uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' - summary: >- - Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the - same it was registered with. - name: unregister(callback) + type: 'TValue[]' + description: >- + the value associated with the dynamic property or an empty array if + the source or the data doesn't exist. + - name: unregister(callback) + uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' + package: '@microsoft/sp-component-base!' fullName: unregister(callback) - langs: - - typeScript - type: method + summary: >- + Unregisters a callback function for updates on the associated + DynamicDataSource. The callback function must be the same it was + registered with. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'unregister(callback: () => void): void;' - return: - type: - - void - description: '' parameters: - id: callback description: Callback function to unregister. - type: - - () => void -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '@microsoft/sp-component-base!default:class' - name: DynamicDataProvider - - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' - name: IDynamicDataSource | undefined - fullName: IDynamicDataSource | undefined - spec.typeScript: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - name: IDynamicDataSource - fullName: IDynamicDataSource - - name: ' | undefined' - fullName: ' | undefined' + type: () => void + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/ifontstyles.yml b/SP-Framework/sp-component-base/ifontstyles.yml index 6f796e86..54c4e77c 100644 --- a/SP-Framework/sp-component-base/ifontstyles.yml +++ b/SP-Framework/sp-component-base/ifontstyles.yml @@ -1,157 +1,143 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!IFontStyles:interface' - summary: Font styles for different sizes. - name: IFontStyles - fullName: IFontStyles - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IFontStyles +uid: '@microsoft/sp-component-base!IFontStyles:interface' +package: '@microsoft/sp-component-base!' +fullName: IFontStyles +summary: Font styles for different sizes. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: large + uid: '@microsoft/sp-component-base!IFontStyles#large:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!IFontStyles#large:member' - - '@microsoft/sp-component-base!IFontStyles#medium:member' - - '@microsoft/sp-component-base!IFontStyles#mediumPlus:member' - - '@microsoft/sp-component-base!IFontStyles#mega:member' - - '@microsoft/sp-component-base!IFontStyles#small:member' - - '@microsoft/sp-component-base!IFontStyles#smallPlus:member' - - '@microsoft/sp-component-base!IFontStyles#superLarge:member' - - '@microsoft/sp-component-base!IFontStyles#tiny:member' - - '@microsoft/sp-component-base!IFontStyles#xLarge:member' - - '@microsoft/sp-component-base!IFontStyles#xSmall:member' - - '@microsoft/sp-component-base!IFontStyles#xxLarge:member' - - uid: '@microsoft/sp-component-base!IFontStyles#large:member' - summary: Large font style. - name: large fullName: large - langs: - - typeScript - type: property + summary: Large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'large: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#medium:member' - summary: Medium font style. - name: medium + type: '' + - name: medium + uid: '@microsoft/sp-component-base!IFontStyles#medium:member' + package: '@microsoft/sp-component-base!' fullName: medium - langs: - - typeScript - type: property + summary: Medium font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'medium: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#mediumPlus:member' - summary: Larger than medium but smaller than large font style. - name: mediumPlus + type: '' + - name: mediumPlus + uid: '@microsoft/sp-component-base!IFontStyles#mediumPlus:member' + package: '@microsoft/sp-component-base!' fullName: mediumPlus - langs: - - typeScript - type: property + summary: Larger than medium but smaller than large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'mediumPlus: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#mega:member' - summary: Mega sized font style. - name: mega + type: '' + - name: mega + uid: '@microsoft/sp-component-base!IFontStyles#mega:member' + package: '@microsoft/sp-component-base!' fullName: mega - langs: - - typeScript - type: property + summary: Mega sized font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'mega: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#small:member' - summary: Small font style. - name: small + type: '' + - name: small + uid: '@microsoft/sp-component-base!IFontStyles#small:member' + package: '@microsoft/sp-component-base!' fullName: small - langs: - - typeScript - type: property + summary: Small font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'small: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#smallPlus:member' - summary: Larger than small but smaller than medium font style. - name: smallPlus + type: '' + - name: smallPlus + uid: '@microsoft/sp-component-base!IFontStyles#smallPlus:member' + package: '@microsoft/sp-component-base!' fullName: smallPlus - langs: - - typeScript - type: property + summary: Larger than small but smaller than medium font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'smallPlus: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#superLarge:member' - summary: Super large font style. - name: superLarge + type: '' + - name: superLarge + uid: '@microsoft/sp-component-base!IFontStyles#superLarge:member' + package: '@microsoft/sp-component-base!' fullName: superLarge - langs: - - typeScript - type: property + summary: Super large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'superLarge: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#tiny:member' - summary: Tiny font style. - name: tiny + type: '' + - name: tiny + uid: '@microsoft/sp-component-base!IFontStyles#tiny:member' + package: '@microsoft/sp-component-base!' fullName: tiny - langs: - - typeScript - type: property + summary: Tiny font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tiny: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#xLarge:member' - summary: Extra large font style. - name: xLarge + type: '' + - name: xLarge + uid: '@microsoft/sp-component-base!IFontStyles#xLarge:member' + package: '@microsoft/sp-component-base!' fullName: xLarge - langs: - - typeScript - type: property + summary: Extra large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'xLarge: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#xSmall:member' - summary: Extra small font style. - name: xSmall + type: '' + - name: xSmall + uid: '@microsoft/sp-component-base!IFontStyles#xSmall:member' + package: '@microsoft/sp-component-base!' fullName: xSmall - langs: - - typeScript - type: property + summary: Extra small font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'xSmall: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' - - uid: '@microsoft/sp-component-base!IFontStyles#xxLarge:member' - summary: Extra extra large font style. - name: xxLarge + type: '' + - name: xxLarge + uid: '@microsoft/sp-component-base!IFontStyles#xxLarge:member' + package: '@microsoft/sp-component-base!' fullName: xxLarge - langs: - - typeScript - type: property + summary: Extra extra large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'xxLarge: IRawStyle;' return: - type: - - '@microsoft/sp-component-base!IRawStyle:interface' -references: - - uid: '@microsoft/sp-component-base!IRawStyle:interface' - name: IRawStyle + type: '' diff --git a/SP-Framework/sp-component-base/ipalette.yml b/SP-Framework/sp-component-base/ipalette.yml index 2ee753f5..14120567 100644 --- a/SP-Framework/sp-component-base/ipalette.yml +++ b/SP-Framework/sp-component-base/ipalette.yml @@ -1,652 +1,603 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!IPalette:interface' - summary: Color palette. - name: IPalette - fullName: IPalette - langs: - - typeScript - type: interface - package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!IPalette#accent:member' - - '@microsoft/sp-component-base!IPalette#black:member' - - '@microsoft/sp-component-base!IPalette#blackTranslucent40:member' - - '@microsoft/sp-component-base!IPalette#blue:member' - - '@microsoft/sp-component-base!IPalette#blueDark:member' - - '@microsoft/sp-component-base!IPalette#blueLight:member' - - '@microsoft/sp-component-base!IPalette#blueMid:member' - - '@microsoft/sp-component-base!IPalette#green:member' - - '@microsoft/sp-component-base!IPalette#greenDark:member' - - '@microsoft/sp-component-base!IPalette#greenLight:member' - - '@microsoft/sp-component-base!IPalette#magenta:member' - - '@microsoft/sp-component-base!IPalette#magentaDark:member' - - '@microsoft/sp-component-base!IPalette#magentaLight:member' - - '@microsoft/sp-component-base!IPalette#neutralDark:member' - - '@microsoft/sp-component-base!IPalette#neutralLight:member' - - '@microsoft/sp-component-base!IPalette#neutralLighter:member' - - '@microsoft/sp-component-base!IPalette#neutralLighterAlt:member' - - '@microsoft/sp-component-base!IPalette#neutralPrimary:member' - - '@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member' - - '@microsoft/sp-component-base!IPalette#neutralQuaternary:member' - - '@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member' - - '@microsoft/sp-component-base!IPalette#neutralSecondary:member' - - '@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member' - - '@microsoft/sp-component-base!IPalette#neutralTertiary:member' - - '@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member' - - '@microsoft/sp-component-base!IPalette#orange:member' - - '@microsoft/sp-component-base!IPalette#orangeLight:member' - - '@microsoft/sp-component-base!IPalette#orangeLighter:member' - - '@microsoft/sp-component-base!IPalette#purple:member' - - '@microsoft/sp-component-base!IPalette#purpleDark:member' - - '@microsoft/sp-component-base!IPalette#purpleLight:member' - - '@microsoft/sp-component-base!IPalette#red:member' - - '@microsoft/sp-component-base!IPalette#redDark:member' - - '@microsoft/sp-component-base!IPalette#teal:member' - - '@microsoft/sp-component-base!IPalette#tealDark:member' - - '@microsoft/sp-component-base!IPalette#tealLight:member' - - '@microsoft/sp-component-base!IPalette#themeDark:member' - - '@microsoft/sp-component-base!IPalette#themeDarkAlt:member' - - '@microsoft/sp-component-base!IPalette#themeDarker:member' - - '@microsoft/sp-component-base!IPalette#themeLight:member' - - '@microsoft/sp-component-base!IPalette#themeLighter:member' - - '@microsoft/sp-component-base!IPalette#themeLighterAlt:member' - - '@microsoft/sp-component-base!IPalette#themePrimary:member' - - '@microsoft/sp-component-base!IPalette#themeSecondary:member' - - '@microsoft/sp-component-base!IPalette#themeTertiary:member' - - '@microsoft/sp-component-base!IPalette#white:member' - - '@microsoft/sp-component-base!IPalette#whiteTranslucent40:member' - - '@microsoft/sp-component-base!IPalette#yellow:member' - - '@microsoft/sp-component-base!IPalette#yellowLight:member' - - uid: '@microsoft/sp-component-base!IPalette#accent:member' - summary: Color code for the accent. - name: accent +### YamlMime:TSType +name: IPalette +uid: '@microsoft/sp-component-base!IPalette:interface' +package: '@microsoft/sp-component-base!' +fullName: IPalette +summary: Color palette. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: accent + uid: '@microsoft/sp-component-base!IPalette#accent:member' + package: '@microsoft/sp-component-base!' fullName: accent - langs: - - typeScript - type: property + summary: Color code for the accent. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'accent: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#black:member' - summary: >- - Color code for the strongest color, which is black in the default theme. This is a very light color in inverted - themes. - name: black + type: string + - name: black + uid: '@microsoft/sp-component-base!IPalette#black:member' + package: '@microsoft/sp-component-base!' fullName: black - langs: - - typeScript - type: property + summary: >- + Color code for the strongest color, which is black in the default theme. + This is a very light color in inverted themes. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'black: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#blackTranslucent40:member' - summary: Color code for blackTranslucent40. - name: blackTranslucent40 + type: string + - name: blackTranslucent40 + uid: '@microsoft/sp-component-base!IPalette#blackTranslucent40:member' + package: '@microsoft/sp-component-base!' fullName: blackTranslucent40 - langs: - - typeScript - type: property + summary: Color code for blackTranslucent40. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'blackTranslucent40: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#blue:member' - summary: Color code for blue. - name: blue + type: string + - name: blue + uid: '@microsoft/sp-component-base!IPalette#blue:member' + package: '@microsoft/sp-component-base!' fullName: blue - langs: - - typeScript - type: property + summary: Color code for blue. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'blue: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#blueDark:member' - summary: Color code for blueDark. - name: blueDark + type: string + - name: blueDark + uid: '@microsoft/sp-component-base!IPalette#blueDark:member' + package: '@microsoft/sp-component-base!' fullName: blueDark - langs: - - typeScript - type: property + summary: Color code for blueDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'blueDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#blueLight:member' - summary: Color code for blueLight. - name: blueLight + type: string + - name: blueLight + uid: '@microsoft/sp-component-base!IPalette#blueLight:member' + package: '@microsoft/sp-component-base!' fullName: blueLight - langs: - - typeScript - type: property + summary: Color code for blueLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'blueLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#blueMid:member' - summary: Color code for blueMid. - name: blueMid + type: string + - name: blueMid + uid: '@microsoft/sp-component-base!IPalette#blueMid:member' + package: '@microsoft/sp-component-base!' fullName: blueMid - langs: - - typeScript - type: property + summary: Color code for blueMid. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'blueMid: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#green:member' - summary: Color code for green. - name: green + type: string + - name: green + uid: '@microsoft/sp-component-base!IPalette#green:member' + package: '@microsoft/sp-component-base!' fullName: green - langs: - - typeScript - type: property + summary: Color code for green. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'green: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#greenDark:member' - summary: Color code for greenDark. - name: greenDark + type: string + - name: greenDark + uid: '@microsoft/sp-component-base!IPalette#greenDark:member' + package: '@microsoft/sp-component-base!' fullName: greenDark - langs: - - typeScript - type: property + summary: Color code for greenDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'greenDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#greenLight:member' - summary: Color code for greenLight. - name: greenLight + type: string + - name: greenLight + uid: '@microsoft/sp-component-base!IPalette#greenLight:member' + package: '@microsoft/sp-component-base!' fullName: greenLight - langs: - - typeScript - type: property + summary: Color code for greenLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'greenLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#magenta:member' - summary: Color code for magenta. - name: magenta + type: string + - name: magenta + uid: '@microsoft/sp-component-base!IPalette#magenta:member' + package: '@microsoft/sp-component-base!' fullName: magenta - langs: - - typeScript - type: property + summary: Color code for magenta. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'magenta: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#magentaDark:member' - summary: Color code for magentaDark. - name: magentaDark + type: string + - name: magentaDark + uid: '@microsoft/sp-component-base!IPalette#magentaDark:member' + package: '@microsoft/sp-component-base!' fullName: magentaDark - langs: - - typeScript - type: property + summary: Color code for magentaDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'magentaDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#magentaLight:member' - summary: Color code for magentaLight. - name: magentaLight + type: string + - name: magentaLight + uid: '@microsoft/sp-component-base!IPalette#magentaLight:member' + package: '@microsoft/sp-component-base!' fullName: magentaLight - langs: - - typeScript - type: property + summary: Color code for magentaLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'magentaLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralDark:member' - summary: Color code for neutralDark. - name: neutralDark + type: string + - name: neutralDark + uid: '@microsoft/sp-component-base!IPalette#neutralDark:member' + package: '@microsoft/sp-component-base!' fullName: neutralDark - langs: - - typeScript - type: property + summary: Color code for neutralDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralLight:member' - summary: Color code for neutralLight. - name: neutralLight + type: string + - name: neutralLight + uid: '@microsoft/sp-component-base!IPalette#neutralLight:member' + package: '@microsoft/sp-component-base!' fullName: neutralLight - langs: - - typeScript - type: property + summary: Color code for neutralLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralLighter:member' - summary: Color code for neutralLighter. - name: neutralLighter + type: string + - name: neutralLighter + uid: '@microsoft/sp-component-base!IPalette#neutralLighter:member' + package: '@microsoft/sp-component-base!' fullName: neutralLighter - langs: - - typeScript - type: property + summary: Color code for neutralLighter. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralLighter: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralLighterAlt:member' - summary: Color code for neutralLighterAlt. - name: neutralLighterAlt + type: string + - name: neutralLighterAlt + uid: '@microsoft/sp-component-base!IPalette#neutralLighterAlt:member' + package: '@microsoft/sp-component-base!' fullName: neutralLighterAlt - langs: - - typeScript - type: property + summary: Color code for neutralLighterAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralLighterAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralPrimary:member' - summary: Color code for neutralPrimary. - name: neutralPrimary + type: string + - name: neutralPrimary + uid: '@microsoft/sp-component-base!IPalette#neutralPrimary:member' + package: '@microsoft/sp-component-base!' fullName: neutralPrimary - langs: - - typeScript - type: property + summary: Color code for neutralPrimary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralPrimary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member' - summary: Color code for neutralPrimaryAlt. - name: neutralPrimaryAlt + type: string + - name: neutralPrimaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member' + package: '@microsoft/sp-component-base!' fullName: neutralPrimaryAlt - langs: - - typeScript - type: property + summary: Color code for neutralPrimaryAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralPrimaryAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralQuaternary:member' - summary: Color code for neutralQuaternary. - name: neutralQuaternary + type: string + - name: neutralQuaternary + uid: '@microsoft/sp-component-base!IPalette#neutralQuaternary:member' + package: '@microsoft/sp-component-base!' fullName: neutralQuaternary - langs: - - typeScript - type: property + summary: Color code for neutralQuaternary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralQuaternary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member' - summary: Color code for neutralQuaternaryAlt. - name: neutralQuaternaryAlt + type: string + - name: neutralQuaternaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member' + package: '@microsoft/sp-component-base!' fullName: neutralQuaternaryAlt - langs: - - typeScript - type: property + summary: Color code for neutralQuaternaryAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralQuaternaryAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralSecondary:member' - summary: Color code for neutralSecondary. - name: neutralSecondary + type: string + - name: neutralSecondary + uid: '@microsoft/sp-component-base!IPalette#neutralSecondary:member' + package: '@microsoft/sp-component-base!' fullName: neutralSecondary - langs: - - typeScript - type: property + summary: Color code for neutralSecondary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralSecondary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member' - summary: Color code for neutralSecondaryAlt. - name: neutralSecondaryAlt + type: string + - name: neutralSecondaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member' + package: '@microsoft/sp-component-base!' fullName: neutralSecondaryAlt - langs: - - typeScript - type: property + summary: Color code for neutralSecondaryAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralSecondaryAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralTertiary:member' - summary: Color code for neutralTertiary. - name: neutralTertiary + type: string + - name: neutralTertiary + uid: '@microsoft/sp-component-base!IPalette#neutralTertiary:member' + package: '@microsoft/sp-component-base!' fullName: neutralTertiary - langs: - - typeScript - type: property + summary: Color code for neutralTertiary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralTertiary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member' - summary: Color code for neutralTertiaryAlt. - name: neutralTertiaryAlt + type: string + - name: neutralTertiaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member' + package: '@microsoft/sp-component-base!' fullName: neutralTertiaryAlt - langs: - - typeScript - type: property + summary: Color code for neutralTertiaryAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'neutralTertiaryAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#orange:member' - summary: Color code for orange. - name: orange + type: string + - name: orange + uid: '@microsoft/sp-component-base!IPalette#orange:member' + package: '@microsoft/sp-component-base!' fullName: orange - langs: - - typeScript - type: property + summary: Color code for orange. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'orange: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#orangeLight:member' - summary: Color code for orangeLight. - name: orangeLight + type: string + - name: orangeLight + uid: '@microsoft/sp-component-base!IPalette#orangeLight:member' + package: '@microsoft/sp-component-base!' fullName: orangeLight - langs: - - typeScript - type: property + summary: Color code for orangeLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'orangeLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#orangeLighter:member' - summary: Color code for orangeLighter. - name: orangeLighter + type: string + - name: orangeLighter + uid: '@microsoft/sp-component-base!IPalette#orangeLighter:member' + package: '@microsoft/sp-component-base!' fullName: orangeLighter - langs: - - typeScript - type: property + summary: Color code for orangeLighter. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'orangeLighter: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#purple:member' - summary: Color code for purple. - name: purple + type: string + - name: purple + uid: '@microsoft/sp-component-base!IPalette#purple:member' + package: '@microsoft/sp-component-base!' fullName: purple - langs: - - typeScript - type: property + summary: Color code for purple. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'purple: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#purpleDark:member' - summary: Color code for purpleDark. - name: purpleDark + type: string + - name: purpleDark + uid: '@microsoft/sp-component-base!IPalette#purpleDark:member' + package: '@microsoft/sp-component-base!' fullName: purpleDark - langs: - - typeScript - type: property + summary: Color code for purpleDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'purpleDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#purpleLight:member' - summary: Color code for purpleLight. - name: purpleLight + type: string + - name: purpleLight + uid: '@microsoft/sp-component-base!IPalette#purpleLight:member' + package: '@microsoft/sp-component-base!' fullName: purpleLight - langs: - - typeScript - type: property + summary: Color code for purpleLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'purpleLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#red:member' - summary: Color code for red. - name: red + type: string + - name: red + uid: '@microsoft/sp-component-base!IPalette#red:member' + package: '@microsoft/sp-component-base!' fullName: red - langs: - - typeScript - type: property + summary: Color code for red. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'red: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#redDark:member' - summary: Color code for redDark. - name: redDark + type: string + - name: redDark + uid: '@microsoft/sp-component-base!IPalette#redDark:member' + package: '@microsoft/sp-component-base!' fullName: redDark - langs: - - typeScript - type: property + summary: Color code for redDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'redDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#teal:member' - summary: Color code for teal. - name: teal + type: string + - name: teal + uid: '@microsoft/sp-component-base!IPalette#teal:member' + package: '@microsoft/sp-component-base!' fullName: teal - langs: - - typeScript - type: property + summary: Color code for teal. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'teal: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#tealDark:member' - summary: Color code for tealDark. - name: tealDark + type: string + - name: tealDark + uid: '@microsoft/sp-component-base!IPalette#tealDark:member' + package: '@microsoft/sp-component-base!' fullName: tealDark - langs: - - typeScript - type: property + summary: Color code for tealDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tealDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#tealLight:member' - summary: Color code for tealLight. - name: tealLight + type: string + - name: tealLight + uid: '@microsoft/sp-component-base!IPalette#tealLight:member' + package: '@microsoft/sp-component-base!' fullName: tealLight - langs: - - typeScript - type: property + summary: Color code for tealLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tealLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeDark:member' - summary: Color code for themeDark. - name: themeDark + type: string + - name: themeDark + uid: '@microsoft/sp-component-base!IPalette#themeDark:member' + package: '@microsoft/sp-component-base!' fullName: themeDark - langs: - - typeScript - type: property + summary: Color code for themeDark. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeDark: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeDarkAlt:member' - summary: Color code for themeDarkAlt. - name: themeDarkAlt + type: string + - name: themeDarkAlt + uid: '@microsoft/sp-component-base!IPalette#themeDarkAlt:member' + package: '@microsoft/sp-component-base!' fullName: themeDarkAlt - langs: - - typeScript - type: property + summary: Color code for themeDarkAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeDarkAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeDarker:member' - summary: Color code for themeDarker. - name: themeDarker + type: string + - name: themeDarker + uid: '@microsoft/sp-component-base!IPalette#themeDarker:member' + package: '@microsoft/sp-component-base!' fullName: themeDarker - langs: - - typeScript - type: property + summary: Color code for themeDarker. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeDarker: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeLight:member' - summary: Color code for themeLight. - name: themeLight + type: string + - name: themeLight + uid: '@microsoft/sp-component-base!IPalette#themeLight:member' + package: '@microsoft/sp-component-base!' fullName: themeLight - langs: - - typeScript - type: property + summary: Color code for themeLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeLight: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeLighter:member' - summary: Color code for themeLighter. - name: themeLighter + type: string + - name: themeLighter + uid: '@microsoft/sp-component-base!IPalette#themeLighter:member' + package: '@microsoft/sp-component-base!' fullName: themeLighter - langs: - - typeScript - type: property + summary: Color code for themeLighter. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeLighter: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeLighterAlt:member' - summary: Color code for themeLighterAlt. - name: themeLighterAlt + type: string + - name: themeLighterAlt + uid: '@microsoft/sp-component-base!IPalette#themeLighterAlt:member' + package: '@microsoft/sp-component-base!' fullName: themeLighterAlt - langs: - - typeScript - type: property + summary: Color code for themeLighterAlt. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeLighterAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themePrimary:member' - summary: Color code for themePrimary. - name: themePrimary + type: string + - name: themePrimary + uid: '@microsoft/sp-component-base!IPalette#themePrimary:member' + package: '@microsoft/sp-component-base!' fullName: themePrimary - langs: - - typeScript - type: property + summary: Color code for themePrimary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themePrimary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeSecondary:member' - summary: Color code for themeSecondary. - name: themeSecondary + type: string + - name: themeSecondary + uid: '@microsoft/sp-component-base!IPalette#themeSecondary:member' + package: '@microsoft/sp-component-base!' fullName: themeSecondary - langs: - - typeScript - type: property + summary: Color code for themeSecondary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeSecondary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#themeTertiary:member' - summary: Color code for themeTertiary. - name: themeTertiary + type: string + - name: themeTertiary + uid: '@microsoft/sp-component-base!IPalette#themeTertiary:member' + package: '@microsoft/sp-component-base!' fullName: themeTertiary - langs: - - typeScript - type: property + summary: Color code for themeTertiary. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'themeTertiary: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#white:member' - summary: >- - Color code for the softest color, which is white in the default theme. This is a very dark color in dark themes. - This is the page background. - name: white + type: string + - name: white + uid: '@microsoft/sp-component-base!IPalette#white:member' + package: '@microsoft/sp-component-base!' fullName: white - langs: - - typeScript - type: property + summary: >- + Color code for the softest color, which is white in the default theme. + This is a very dark color in dark themes. This is the page background. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'white: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#whiteTranslucent40:member' - summary: Color code for whiteTranslucent40 - name: whiteTranslucent40 + type: string + - name: whiteTranslucent40 + uid: '@microsoft/sp-component-base!IPalette#whiteTranslucent40:member' + package: '@microsoft/sp-component-base!' fullName: whiteTranslucent40 - langs: - - typeScript - type: property + summary: Color code for whiteTranslucent40 + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'whiteTranslucent40: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#yellow:member' - summary: Color code for yellow. - name: yellow + type: string + - name: yellow + uid: '@microsoft/sp-component-base!IPalette#yellow:member' + package: '@microsoft/sp-component-base!' fullName: yellow - langs: - - typeScript - type: property + summary: Color code for yellow. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'yellow: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IPalette#yellowLight:member' - summary: Color code for yellowLight. - name: yellowLight + type: string + - name: yellowLight + uid: '@microsoft/sp-component-base!IPalette#yellowLight:member' + package: '@microsoft/sp-component-base!' fullName: yellowLight - langs: - - typeScript - type: property + summary: Color code for yellowLight. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'yellowLight: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-component-base/irawstyle.yml b/SP-Framework/sp-component-base/irawstyle.yml index 171ce204..d000b65d 100644 --- a/SP-Framework/sp-component-base/irawstyle.yml +++ b/SP-Framework/sp-component-base/irawstyle.yml @@ -1,72 +1,43 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!IRawStyle:interface' - summary: 'IStyleObject extends a raw style objects, but allows selectors to be defined under the selectors node.' - name: IRawStyle - fullName: IRawStyle - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-component-base!IRawStyleBase:interface' - inheritance: - - type: '@microsoft/sp-component-base!IRawStyleBase:interface' +### YamlMime:TSType +name: IRawStyle +uid: '@microsoft/sp-component-base!IRawStyle:interface' +package: '@microsoft/sp-component-base!' +fullName: IRawStyle +summary: >- + IStyleObject extends a raw style objects, but allows selectors to be defined + under the selectors node. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: displayName + uid: '@microsoft/sp-component-base!IRawStyle#displayName:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!IRawStyle#displayName:member' - - '@microsoft/sp-component-base!IRawStyle#selectors:member' - - uid: '@microsoft/sp-component-base!IRawStyle#displayName:member' - summary: Display name for the style. - name: displayName fullName: displayName - langs: - - typeScript - type: property + summary: Display name for the style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'displayName?: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!IRawStyle#selectors:member' - summary: Custom selectors for the style. - name: selectors + type: string + - name: selectors + uid: '@microsoft/sp-component-base!IRawStyle#selectors:member' + package: '@microsoft/sp-component-base!' fullName: selectors - langs: - - typeScript - type: property + summary: Custom selectors for the style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: |- selectors?: { [key: string]: IStyle; }; return: - type: - - '@microsoft/sp-component-base!IRawStyle#selectors~0:complex' -references: - - uid: '@microsoft/sp-component-base!IRawStyleBase:interface' - name: IRawStyleBase - - uid: '@microsoft/sp-component-base!IRawStyle#selectors~0:complex' - name: |- - { - [key: string]: IStyle; - } - fullName: |- - { - [key: string]: IStyle; - } - spec.typeScript: - - name: |- - { - [key: string]: - fullName: |- - { - [key: string]: - - uid: '@microsoft/sp-component-base!IStyle:type' - name: IStyle - fullName: IStyle - - name: |- - ; - } - fullName: |- - ; - } + type: >- + @microsoft/sp-component-base!IRawStyle# +extends: '' diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 86ab44f5..66c306f8 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -1,157 +1,143 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - summary: Font styles for different sizes. - name: IReadonlyFontStyles - fullName: IReadonlyFontStyles - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IReadonlyFontStyles +uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' +package: '@microsoft/sp-component-base!' +fullName: IReadonlyFontStyles +summary: Font styles for different sizes. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: large + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#large:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!IReadonlyFontStyles#large:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#medium:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#mega:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#small:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member' - - '@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#large:member' - summary: Large font style. - name: large fullName: large - langs: - - typeScript - type: property + summary: Large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'large: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#medium:member' - summary: Medium font style. - name: medium + type: '' + - name: medium + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#medium:member' + package: '@microsoft/sp-component-base!' fullName: medium - langs: - - typeScript - type: property + summary: Medium font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'medium: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member' - summary: Larger than medium but smaller than large font style. - name: mediumPlus + type: '' + - name: mediumPlus + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member' + package: '@microsoft/sp-component-base!' fullName: mediumPlus - langs: - - typeScript - type: property + summary: Larger than medium but smaller than large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'mediumPlus: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mega:member' - summary: Mega sized font style. - name: mega + type: '' + - name: mega + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mega:member' + package: '@microsoft/sp-component-base!' fullName: mega - langs: - - typeScript - type: property + summary: Mega sized font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'mega: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#small:member' - summary: Small font style. - name: small + type: '' + - name: small + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#small:member' + package: '@microsoft/sp-component-base!' fullName: small - langs: - - typeScript - type: property + summary: Small font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'small: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member' - summary: Larger than small but smaller than medium font style. - name: smallPlus + type: '' + - name: smallPlus + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member' + package: '@microsoft/sp-component-base!' fullName: smallPlus - langs: - - typeScript - type: property + summary: Larger than small but smaller than medium font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'smallPlus: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member' - summary: Super large font style. - name: superLarge + type: '' + - name: superLarge + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member' + package: '@microsoft/sp-component-base!' fullName: superLarge - langs: - - typeScript - type: property + summary: Super large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'superLarge: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member' - summary: Tiny font style. - name: tiny + type: '' + - name: tiny + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member' + package: '@microsoft/sp-component-base!' fullName: tiny - langs: - - typeScript - type: property + summary: Tiny font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tiny: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member' - summary: Extra large font style. - name: xLarge + type: '' + - name: xLarge + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member' + package: '@microsoft/sp-component-base!' fullName: xLarge - langs: - - typeScript - type: property + summary: Extra large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'xLarge: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member' - summary: Extra small font style. - name: xSmall + type: '' + - name: xSmall + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member' + package: '@microsoft/sp-component-base!' fullName: xSmall - langs: - - typeScript - type: property + summary: Extra small font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'xSmall: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member' - summary: Extra extra large font style. - name: xxLarge + type: '' + - name: xxLarge + uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member' + package: '@microsoft/sp-component-base!' fullName: xxLarge - langs: - - typeScript - type: property + summary: Extra extra large font style. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'xxLarge: IReadonlyRawStyle;' return: - type: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' -references: - - uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' - name: IReadonlyRawStyle + type: '' diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 7cd3866e..c20c2943 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -1,125 +1,54 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - summary: Immutable ITheme. - name: IReadonlyTheme - fullName: IReadonlyTheme - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-component-base!IReadonlyTheme~0:complex' - inheritance: - - type: '@microsoft/sp-component-base!IReadonlyTheme~1:complex' +### YamlMime:TSType +name: IReadonlyTheme +uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' +package: '@microsoft/sp-component-base!' +fullName: IReadonlyTheme +summary: Immutable ITheme. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fonts + uid: '@microsoft/sp-component-base!IReadonlyTheme#fonts:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!IReadonlyTheme#fonts:member' - - '@microsoft/sp-component-base!IReadonlyTheme#palette:member' - - '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' - - uid: '@microsoft/sp-component-base!IReadonlyTheme#fonts:member' - summary: Font styles for different sizes. - name: fonts fullName: fonts - langs: - - typeScript - type: property + summary: Font styles for different sizes. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly fonts: Readonly;' return: - type: - - '@microsoft/sp-component-base!IReadonlyTheme#fonts~0:complex' - - uid: '@microsoft/sp-component-base!IReadonlyTheme#palette:member' - summary: Color palette. - name: palette + type: >- + @microsoft/sp-component-base!IReadonlyTheme# + - name: palette + uid: '@microsoft/sp-component-base!IReadonlyTheme#palette:member' + package: '@microsoft/sp-component-base!' fullName: palette - langs: - - typeScript - type: property + summary: Color palette. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly palette: Readonly;' return: - type: - - '@microsoft/sp-component-base!IReadonlyTheme#palette~0:complex' - - uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' - summary: The collection of all semantic slots for colors used in themes. - name: semanticColors + type: >- + @microsoft/sp-component-base!IReadonlyTheme# + - name: semanticColors + uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' + package: '@microsoft/sp-component-base!' fullName: semanticColors - langs: - - typeScript - type: property + summary: The collection of all semantic slots for colors used in themes. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly semanticColors: Readonly;' return: - type: - - '@microsoft/sp-component-base!IReadonlyTheme#semanticColors~0:complex' -references: - - uid: '@microsoft/sp-component-base!IReadonlyTheme~0:complex' - name: Readonly - fullName: Readonly - spec.typeScript: - - uid: '!Readonly:type' - name: Readonly - fullName: Readonly - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!ITheme:interface' - name: ITheme - fullName: ITheme - - name: '> ' - fullName: '> ' - - uid: '@microsoft/sp-component-base!IReadonlyTheme~1:complex' - name: Readonly - fullName: Readonly - spec.typeScript: - - uid: '!Readonly:type' - name: Readonly - fullName: Readonly - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!ITheme:interface' - name: ITheme - fullName: ITheme - - name: '> ' - fullName: '> ' - - uid: '@microsoft/sp-component-base!IReadonlyTheme#fonts~0:complex' - name: Readonly - fullName: Readonly - spec.typeScript: - - uid: '!Readonly:type' - name: Readonly - fullName: Readonly - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - name: IReadonlyFontStyles - fullName: IReadonlyFontStyles - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-component-base!IReadonlyTheme#palette~0:complex' - name: Readonly - fullName: Readonly - spec.typeScript: - - uid: '!Readonly:type' - name: Readonly - fullName: Readonly - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!IPalette:interface' - name: IPalette - fullName: IPalette - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors~0:complex' - name: Readonly - fullName: Readonly - spec.typeScript: - - uid: '!Readonly:type' - name: Readonly - fullName: Readonly - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!ISemanticColors:interface' - name: ISemanticColors - fullName: ISemanticColors - - name: '>' - fullName: '>' + type: >- + @microsoft/sp-component-base!IReadonlyTheme# +extends: '' diff --git a/SP-Framework/sp-component-base/isemanticcolors.yml b/SP-Framework/sp-component-base/isemanticcolors.yml index 407ae35b..484d87de 100644 --- a/SP-Framework/sp-component-base/isemanticcolors.yml +++ b/SP-Framework/sp-component-base/isemanticcolors.yml @@ -1,787 +1,791 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!ISemanticColors:interface' - summary: >- - The collection of all semantic slots for colors used in themes. +### YamlMime:TSType +name: ISemanticColors +uid: '@microsoft/sp-component-base!ISemanticColors:interface' +package: '@microsoft/sp-component-base!' +fullName: ISemanticColors +summary: >- + The collection of all semantic slots for colors used in themes. - Note: text colors are defined in ISemanticTextColors.ts. + Note: text colors are defined in ISemanticTextColors.ts. - \#\# Naming Convention + \#\# Naming Convention - The name of a semantic slot can quickly tell you how it’s meant to be used. It generally follows this format: + The name of a semantic slot can quickly tell you how it’s meant to be used. It + generally follows this format: - \[category name\]\[element name\]\[checked state\]\[hovered/pressed/disabled state\] \[category name\] – The - “family” that this slot belongs to. \[element name\] – The name of the thing being targeted, such as the - background or border. \[checked state\] – Whether the thing is checked. We assume things are unchecked by default, - so no need to specify the unchecked state. (We used “checked” to refer to anything that is on, selected, toggled, - highlighted, emphasized, etc.) \[hovered/pressed/disabled state\] – One of these states, if applicable. Each of - these states are mutually exclusive. Pressed styles overwrite hovered styles, and disabled elements cannot be - hovered or pressed. + \[category name\]\[element name\]\[checked state\]\[hovered/pressed/disabled + state\] \[category name\] – The “family” that this slot belongs to. \[element + name\] – The name of the thing being targeted, such as the background or + border. \[checked state\] – Whether the thing is checked. We assume things are + unchecked by default, so no need to specify the unchecked state. (We used + “checked” to refer to anything that is on, selected, toggled, highlighted, + emphasized, etc.) \[hovered/pressed/disabled state\] – One of these states, if + applicable. Each of these states are mutually exclusive. Pressed styles + overwrite hovered styles, and disabled elements cannot be hovered or pressed. - \#\# Base Slots + \#\# Base Slots - A basic set of slots that provide many default body styles, such as text, subtext, disabled colors, and so on. If - a category doesn't provide the slot you're looking for, use one from this category. For example, the placeholder - text on a text input field has no corresponding slot in its category, so you'd use the bodySubtextColor from this - category. + A basic set of slots that provide many default body styles, such as text, + subtext, disabled colors, and so on. If a category doesn't provide the slot + you're looking for, use one from this category. For example, the placeholder + text on a text input field has no corresponding slot in its category, so you'd + use the bodySubtextColor from this category. - \#\# Invariants + \#\# Invariants - When color has meaning, we do not want to change the color much theme to theme. For example, we will always want - errors to be some shade of red, but we will need to tweak the exact shade so it's legible depending on whether - it's an inverted theme or not. Invariant colors should almost never be changed by the theme, the defaults should - suffice. + When color has meaning, we do not want to change the color much theme to + theme. For example, we will always want errors to be some shade of red, but we + will need to tweak the exact shade so it's legible depending on whether it's + an inverted theme or not. Invariant colors should almost never be changed by + the theme, the defaults should suffice. - \#\# Input Controls + \#\# Input Controls - This category contains input components commonly used to denote state, including radio buttons, check boxes, - toggle switches, sliders, progress bars, and more. + This category contains input components commonly used to denote state, + including radio buttons, check boxes, toggle switches, sliders, progress bars, + and more. - \#\# Buttons + \#\# Buttons - Buttons! And all the flavors thereof. + Buttons! And all the flavors thereof. - \#\# Menus + \#\# Menus - Any kind of popup menus uses this category. + Any kind of popup menus uses this category. - \#\# Lists + \#\# Lists - Lists differ from menus in that they are designed to show infinite amounts of items, often scroll, and have a - large and complex interaction surface. This category covers all kinds of lists, whether they're typical - one-item-per-row lists (like DetailsList) or ones with a tiled layout. - name: ISemanticColors - fullName: ISemanticColors - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-component-base!ISemanticTextColors:interface' - inheritance: - - type: '@microsoft/sp-component-base!ISemanticTextColors:interface' + Lists differ from menus in that they are designed to show infinite amounts of + items, often scroll, and have a large and complex interaction surface. This + category covers all kinds of lists, whether they're typical one-item-per-row + lists (like DetailsList) or ones with a tiled layout. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: accentButtonBackground + uid: '@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#blockingBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#bodyBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#bodyDivider:member' - - '@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#bodyFrameDivider:member' - - '@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBorder:member' - - '@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member' - - '@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#disabledBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#errorBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#focusBorder:member' - - '@microsoft/sp-component-base!ISemanticColors#inputBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member' - - '@microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#inputBorder:member' - - '@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member' - - '@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member' - - '@microsoft/sp-component-base!ISemanticColors#listBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member' - - '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member' - - '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#listText:member' - - '@microsoft/sp-component-base!ISemanticColors#menuBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#menuDivider:member' - - '@microsoft/sp-component-base!ISemanticColors#menuHeader:member' - - '@microsoft/sp-component-base!ISemanticColors#menuIcon:member' - - '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member' - - '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member' - - '@microsoft/sp-component-base!ISemanticColors#menuItemText:member' - - '@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member' - - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member' - - '@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member' - - '@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member' - - '@microsoft/sp-component-base!ISemanticColors#successBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#variantBorder:member' - - '@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member' - - '@microsoft/sp-component-base!ISemanticColors#warningBackground:member' - - '@microsoft/sp-component-base!ISemanticColors#warningHighlight:member' - - uid: '@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member' - summary: Background of an accent button (kicker) - name: accentButtonBackground fullName: accentButtonBackground - langs: - - typeScript - type: property + summary: Background of an accent button (kicker) + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'accentButtonBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#blockingBackground:member' - summary: 'Background for blocking issues, which is more severe than a warning, but not as bad as an error.' - name: blockingBackground + type: string + - name: blockingBackground + uid: '@microsoft/sp-component-base!ISemanticColors#blockingBackground:member' + package: '@microsoft/sp-component-base!' fullName: blockingBackground - langs: - - typeScript - type: property + summary: >- + Background for blocking issues, which is more severe than a warning, but + not as bad as an error. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'blockingBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#bodyBackground:member' - summary: The default color for backgrounds. - name: bodyBackground + type: string + - name: bodyBackground + uid: '@microsoft/sp-component-base!ISemanticColors#bodyBackground:member' + package: '@microsoft/sp-component-base!' fullName: bodyBackground - langs: - - typeScript - type: property + summary: The default color for backgrounds. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#bodyDivider:member' - summary: 'Divider lines; e.g. lines that separate sections in a menu, an
element.' - name: bodyDivider + type: string + - name: bodyDivider + uid: '@microsoft/sp-component-base!ISemanticColors#bodyDivider:member' + package: '@microsoft/sp-component-base!' fullName: bodyDivider - langs: - - typeScript - type: property + summary: >- + Divider lines; e.g. lines that separate sections in a menu, an <HR> + element. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyDivider: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member' - summary: >- - The color for chrome adjacent to an area with bodyBackground. This can be used to provide visual separation of - zones when using stronger colors, when using a divider line is not desired. In most themes, this should match the - color of bodyBackground. See also: bodyFrameDivider - name: bodyFrameBackground + type: string + - name: bodyFrameBackground + uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member' + package: '@microsoft/sp-component-base!' fullName: bodyFrameBackground - langs: - - typeScript - type: property + summary: >- + The color for chrome adjacent to an area with bodyBackground. This can be + used to provide visual separation of zones when using stronger colors, + when using a divider line is not desired. In most themes, this should + match the color of bodyBackground. See also: bodyFrameDivider + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyFrameBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameDivider:member' + type: string + - name: bodyFrameDivider + uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameDivider:member' + package: '@microsoft/sp-component-base!' + fullName: bodyFrameDivider summary: >- - Used as the border between a zone with bodyFrameBackground and a zone with bodyBackground. If bodyBackground and - bodyFrameBackground are different, this should be the same color as bodyFrameBackground in order to visually + Used as the border between a zone with bodyFrameBackground and a zone with + bodyBackground. If bodyBackground and bodyFrameBackground are different, + this should be the same color as bodyFrameBackground in order to visually disappear. See also: bodyFrameBackground - name: bodyFrameDivider - fullName: bodyFrameDivider - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyFrameDivider: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member' - summary: >- - The standout color for highlighted content backgrounds. For highlighted content when there is no emphasis, use the - neutral variant instead. This should be a shade darker than bodyBackground in light themes, and a shade lighter in - inverted themes. - name: bodyStandoutBackground + type: string + - name: bodyStandoutBackground + uid: '@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member' + package: '@microsoft/sp-component-base!' fullName: bodyStandoutBackground - langs: - - typeScript - type: property + summary: >- + The standout color for highlighted content backgrounds. For highlighted + content when there is no emphasis, use the neutral variant instead. This + should be a shade darker than bodyBackground in light themes, and a shade + lighter in inverted themes. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyStandoutBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackground:member' - summary: Background of a standard button - name: buttonBackground + type: string + - name: buttonBackground + uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackground:member' + package: '@microsoft/sp-component-base!' fullName: buttonBackground - langs: - - typeScript - type: property + summary: Background of a standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member' - summary: Background of a checked standard button; e.g. bold/italicize/underline text button in toolbar - name: buttonBackgroundChecked + type: string + - name: buttonBackgroundChecked + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member + package: '@microsoft/sp-component-base!' fullName: buttonBackgroundChecked - langs: - - typeScript - type: property + summary: >- + Background of a checked standard button; e.g. bold/italicize/underline + text button in toolbar + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBackgroundChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member' - summary: Background of a checked and hovered standard button; e.g. bold/italicize/underline text button in toolbar - name: buttonBackgroundCheckedHovered + type: string + - name: buttonBackgroundCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member + package: '@microsoft/sp-component-base!' fullName: buttonBackgroundCheckedHovered - langs: - - typeScript - type: property + summary: >- + Background of a checked and hovered standard button; e.g. + bold/italicize/underline text button in toolbar + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBackgroundCheckedHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member' - summary: Background of a disabled standard button - name: buttonBackgroundDisabled + type: string + - name: buttonBackgroundDisabled + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member + package: '@microsoft/sp-component-base!' fullName: buttonBackgroundDisabled - langs: - - typeScript - type: property + summary: Background of a disabled standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBackgroundDisabled: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member' - summary: Background of a hovered standard button - name: buttonBackgroundHovered + type: string + - name: buttonBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member + package: '@microsoft/sp-component-base!' fullName: buttonBackgroundHovered - langs: - - typeScript - type: property + summary: Background of a hovered standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBackgroundHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member' - summary: Background of a pressed standard button; i.e. currently being clicked by mouse - name: buttonBackgroundPressed + type: string + - name: buttonBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member + package: '@microsoft/sp-component-base!' fullName: buttonBackgroundPressed - langs: - - typeScript - type: property + summary: >- + Background of a pressed standard button; i.e. currently being clicked by + mouse + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBackgroundPressed: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorder:member' - summary: Border of a standard button - name: buttonBorder + type: string + - name: buttonBorder + uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorder:member' + package: '@microsoft/sp-component-base!' fullName: buttonBorder - langs: - - typeScript - type: property + summary: Border of a standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBorder: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member' - summary: Border of a disabled standard button - name: buttonBorderDisabled + type: string + - name: buttonBorderDisabled + uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member' + package: '@microsoft/sp-component-base!' fullName: buttonBorderDisabled - langs: - - typeScript - type: property + summary: Border of a disabled standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonBorderDisabled: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member' - summary: >- - Background color for default/empty state graphical elements; eg default icons, empty section that needs user to - fill in content, placeholder graphics, empty seats, etc. - name: defaultStateBackground + type: string + - name: defaultStateBackground + uid: '@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member' + package: '@microsoft/sp-component-base!' fullName: defaultStateBackground - langs: - - typeScript - type: property + summary: >- + Background color for default/empty state graphical elements; eg default + icons, empty section that needs user to fill in content, placeholder + graphics, empty seats, etc. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'defaultStateBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#disabledBackground:member' - summary: The default color for backgrounds of disabled controls; e.g. disabled text field. - name: disabledBackground + type: string + - name: disabledBackground + uid: '@microsoft/sp-component-base!ISemanticColors#disabledBackground:member' + package: '@microsoft/sp-component-base!' fullName: disabledBackground - langs: - - typeScript - type: property + summary: >- + The default color for backgrounds of disabled controls; e.g. disabled text + field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabledBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#errorBackground:member' - summary: 'The background for errors, if necessary, or highlighting the section of the page where the error is present.' - name: errorBackground + type: string + - name: errorBackground + uid: '@microsoft/sp-component-base!ISemanticColors#errorBackground:member' + package: '@microsoft/sp-component-base!' fullName: errorBackground - langs: - - typeScript - type: property + summary: >- + The background for errors, if necessary, or highlighting the section of + the page where the error is present. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'errorBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#focusBorder:member' - summary: The color of the outline around focused controls that don't already have a border; e.g. menu items - name: focusBorder + type: string + - name: focusBorder + uid: '@microsoft/sp-component-base!ISemanticColors#focusBorder:member' + package: '@microsoft/sp-component-base!' fullName: focusBorder - langs: - - typeScript - type: property + summary: >- + The color of the outline around focused controls that don't already have a + border; e.g. menu items + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'focusBorder: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputBackground:member' - summary: 'The background color of an input, e.g. textbox background.' - name: inputBackground + type: string + - name: inputBackground + uid: '@microsoft/sp-component-base!ISemanticColors#inputBackground:member' + package: '@microsoft/sp-component-base!' fullName: inputBackground - langs: - - typeScript - type: property + summary: 'The background color of an input, e.g. textbox background.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member' - summary: 'The background of a checked control; e.g. checked radio button''s dot, checked toggle''s background.' - name: inputBackgroundChecked + type: string + - name: inputBackgroundChecked + uid: '@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member' + package: '@microsoft/sp-component-base!' fullName: inputBackgroundChecked - langs: - - typeScript - type: property + summary: >- + The background of a checked control; e.g. checked radio button's dot, + checked toggle's background. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputBackgroundChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member' - summary: The background of a checked and hovered control; e.g. checked checkbox's background color on hover. - name: inputBackgroundCheckedHovered + type: string + - name: inputBackgroundCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member + package: '@microsoft/sp-component-base!' fullName: inputBackgroundCheckedHovered - langs: - - typeScript - type: property + summary: >- + The background of a checked and hovered control; e.g. checked checkbox's + background color on hover. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputBackgroundCheckedHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputBorder:member' - summary: 'The border of a large input control in its resting, state; e.g. the box of dropdown.' - name: inputBorder + type: string + - name: inputBorder + uid: '@microsoft/sp-component-base!ISemanticColors#inputBorder:member' + package: '@microsoft/sp-component-base!' fullName: inputBorder - langs: - - typeScript - type: property + summary: >- + The border of a large input control in its resting, state; e.g. the box of + dropdown. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputBorder: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member' - summary: 'The border color of a large hovered input control, such as textbox.' - name: inputBorderHovered + type: string + - name: inputBorderHovered + uid: '@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member' + package: '@microsoft/sp-component-base!' fullName: inputBorderHovered - langs: - - typeScript - type: property + summary: 'The border color of a large hovered input control, such as textbox.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputBorderHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member' - summary: The alternate focus border color for elements that already have a border; e.g. text field borders on focus. - name: inputFocusBorderAlt + type: string + - name: inputFocusBorderAlt + uid: '@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member' + package: '@microsoft/sp-component-base!' fullName: inputFocusBorderAlt - langs: - - typeScript - type: property + summary: >- + The alternate focus border color for elements that already have a border; + e.g. text field borders on focus. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputFocusBorderAlt: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member' - summary: >- - The foreground of a checked control; e.g. checked checkbox's checkmark color, checked toggle's thumb color, radio - button's background color around the dot. - name: inputForegroundChecked + type: string + - name: inputForegroundChecked + uid: '@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member' + package: '@microsoft/sp-component-base!' fullName: inputForegroundChecked - langs: - - typeScript - type: property + summary: >- + The foreground of a checked control; e.g. checked checkbox's checkmark + color, checked toggle's thumb color, radio button's background color + around the dot. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputForegroundChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listBackground:member' - summary: The background color for the entire list. - name: listBackground + type: string + - name: listBackground + uid: '@microsoft/sp-component-base!ISemanticColors#listBackground:member' + package: '@microsoft/sp-component-base!' fullName: listBackground - langs: - - typeScript - type: property + summary: The background color for the entire list. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member' - summary: The background color for a hovered list header. - name: listHeaderBackgroundHovered + type: string + - name: listHeaderBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member + package: '@microsoft/sp-component-base!' fullName: listHeaderBackgroundHovered - langs: - - typeScript - type: property + summary: The background color for a hovered list header. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listHeaderBackgroundHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member' - summary: The background color for a pressed list header. - name: listHeaderBackgroundPressed + type: string + - name: listHeaderBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member + package: '@microsoft/sp-component-base!' fullName: listHeaderBackgroundPressed - langs: - - typeScript - type: property + summary: The background color for a pressed list header. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listHeaderBackgroundPressed: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member' - summary: The background color of a checked list item. - name: listItemBackgroundChecked + type: string + - name: listItemBackgroundChecked + uid: >- + @microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member + package: '@microsoft/sp-component-base!' fullName: listItemBackgroundChecked - langs: - - typeScript - type: property + summary: The background color of a checked list item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listItemBackgroundChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member' - summary: The background color of a checked and hovered list item. - name: listItemBackgroundCheckedHovered + type: string + - name: listItemBackgroundCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member + package: '@microsoft/sp-component-base!' fullName: listItemBackgroundCheckedHovered - langs: - - typeScript - type: property + summary: The background color of a checked and hovered list item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listItemBackgroundCheckedHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member' - summary: The background color of a hovered list item. - name: listItemBackgroundHovered + type: string + - name: listItemBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member + package: '@microsoft/sp-component-base!' fullName: listItemBackgroundHovered - langs: - - typeScript - type: property + summary: The background color of a hovered list item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listItemBackgroundHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#listText:member' - summary: The default text color for list item titles and text in column fields. - name: listText + type: string + - name: listText + uid: '@microsoft/sp-component-base!ISemanticColors#listText:member' + package: '@microsoft/sp-component-base!' fullName: listText - langs: - - typeScript - type: property + summary: The default text color for list item titles and text in column fields. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuBackground:member' - summary: The background of a menu. - name: menuBackground + type: string + - name: menuBackground + uid: '@microsoft/sp-component-base!ISemanticColors#menuBackground:member' + package: '@microsoft/sp-component-base!' fullName: menuBackground - langs: - - typeScript - type: property + summary: The background of a menu. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuDivider:member' - summary: The divider between menu items. - name: menuDivider + type: string + - name: menuDivider + uid: '@microsoft/sp-component-base!ISemanticColors#menuDivider:member' + package: '@microsoft/sp-component-base!' fullName: menuDivider - langs: - - typeScript - type: property + summary: The divider between menu items. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuDivider: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuHeader:member' - summary: The headers in menus that denote title of a section. - name: menuHeader + type: string + - name: menuHeader + uid: '@microsoft/sp-component-base!ISemanticColors#menuHeader:member' + package: '@microsoft/sp-component-base!' fullName: menuHeader - langs: - - typeScript - type: property + summary: The headers in menus that denote title of a section. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuHeader: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuIcon:member' - summary: The default colors of icons in menus. - name: menuIcon + type: string + - name: menuIcon + uid: '@microsoft/sp-component-base!ISemanticColors#menuIcon:member' + package: '@microsoft/sp-component-base!' fullName: menuIcon - langs: - - typeScript - type: property + summary: The default colors of icons in menus. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuIcon: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member' - deprecated: - content: >- - (Checked menu items no longer get a background color.) The background of checked menu item; e.g. a menu item - whose submenu is open, a selected dropdown item. - name: menuItemBackgroundChecked + type: string + - name: menuItemBackgroundChecked + uid: >- + @microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member + package: '@microsoft/sp-component-base!' fullName: menuItemBackgroundChecked - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + (Checked menu items no longer get a background color.) The background of + checked menu item; e.g. a menu item whose submenu is open, a selected + dropdown item. syntax: content: 'menuItemBackgroundChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member' - summary: The background of a hovered menu item. - name: menuItemBackgroundHovered + type: string + - name: menuItemBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member + package: '@microsoft/sp-component-base!' fullName: menuItemBackgroundHovered - langs: - - typeScript - type: property + summary: The background of a hovered menu item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuItemBackgroundHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member' - summary: The background of a pressed menu item. - name: menuItemBackgroundPressed + type: string + - name: menuItemBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member + package: '@microsoft/sp-component-base!' fullName: menuItemBackgroundPressed - langs: - - typeScript - type: property + summary: The background of a pressed menu item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuItemBackgroundPressed: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemText:member' - summary: The text color of a menu item. - name: menuItemText + type: string + - name: menuItemText + uid: '@microsoft/sp-component-base!ISemanticColors#menuItemText:member' + package: '@microsoft/sp-component-base!' fullName: menuItemText - langs: - - typeScript - type: property + summary: The text color of a menu item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuItemText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member' - summary: The text color of a hovered menu item. - name: menuItemTextHovered + type: string + - name: menuItemTextHovered + uid: '@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member' + package: '@microsoft/sp-component-base!' fullName: menuItemTextHovered - langs: - - typeScript - type: property + summary: The text color of a hovered menu item. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'menuItemTextHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member' - summary: Background of a primary button - name: primaryButtonBackground + type: string + - name: primaryButtonBackground + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonBackground - langs: - - typeScript - type: property + summary: Background of a primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member' - summary: Background of a disabled primary button - name: primaryButtonBackgroundDisabled + type: string + - name: primaryButtonBackgroundDisabled + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonBackgroundDisabled - langs: - - typeScript - type: property + summary: Background of a disabled primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonBackgroundDisabled: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member' - summary: Background of a hovered primary button - name: primaryButtonBackgroundHovered + type: string + - name: primaryButtonBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonBackgroundHovered - langs: - - typeScript - type: property + summary: Background of a hovered primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonBackgroundHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member' - summary: Background of a pressed primary button; i.e. currently being clicked by mouse - name: primaryButtonBackgroundPressed + type: string + - name: primaryButtonBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonBackgroundPressed - langs: - - typeScript - type: property + summary: >- + Background of a pressed primary button; i.e. currently being clicked by + mouse + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonBackgroundPressed: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member' - summary: Border of a primary button - name: primaryButtonBorder + type: string + - name: primaryButtonBorder + uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member' + package: '@microsoft/sp-component-base!' fullName: primaryButtonBorder - langs: - - typeScript - type: property + summary: Border of a primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonBorder: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member' - summary: The border of a small input control in its resting unchecked state; e.g. the box of an unchecked checkbox. - name: smallInputBorder + type: string + - name: smallInputBorder + uid: '@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member' + package: '@microsoft/sp-component-base!' fullName: smallInputBorder - langs: - - typeScript - type: property + summary: >- + The border of a small input control in its resting unchecked state; e.g. + the box of an unchecked checkbox. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'smallInputBorder: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#successBackground:member' - summary: Background for success - name: successBackground + type: string + - name: successBackground + uid: '@microsoft/sp-component-base!ISemanticColors#successBackground:member' + package: '@microsoft/sp-component-base!' fullName: successBackground - langs: - - typeScript - type: property + summary: Background for success + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'successBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#variantBorder:member' - summary: 'The color of the border that provides contrast between an element, such as a card, and an emphasized background.' - name: variantBorder + type: string + - name: variantBorder + uid: '@microsoft/sp-component-base!ISemanticColors#variantBorder:member' + package: '@microsoft/sp-component-base!' fullName: variantBorder - langs: - - typeScript - type: property + summary: >- + The color of the border that provides contrast between an element, such as + a card, and an emphasized background. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'variantBorder: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member' - summary: 'Hover color of border that provides contrast between an element, such as a card, and an emphasized background.' - name: variantBorderHovered + type: string + - name: variantBorderHovered + uid: '@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member' + package: '@microsoft/sp-component-base!' fullName: variantBorderHovered - langs: - - typeScript - type: property + summary: >- + Hover color of border that provides contrast between an element, such as a + card, and an emphasized background. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'variantBorderHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#warningBackground:member' - summary: Background for warning messages. - name: warningBackground + type: string + - name: warningBackground + uid: '@microsoft/sp-component-base!ISemanticColors#warningBackground:member' + package: '@microsoft/sp-component-base!' fullName: warningBackground - langs: - - typeScript - type: property + summary: Background for warning messages. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'warningBackground: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticColors#warningHighlight:member' - summary: Foreground color for warning highlights - name: warningHighlight + type: string + - name: warningHighlight + uid: '@microsoft/sp-component-base!ISemanticColors#warningHighlight:member' + package: '@microsoft/sp-component-base!' fullName: warningHighlight - langs: - - typeScript - type: property + summary: Foreground color for warning highlights + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'warningHighlight: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' - name: ISemanticTextColors + type: string +extends: '' diff --git a/SP-Framework/sp-component-base/isemantictextcolors.yml b/SP-Framework/sp-component-base/isemantictextcolors.yml index 11b540b1..cbe8c7f3 100644 --- a/SP-Framework/sp-component-base/isemantictextcolors.yml +++ b/SP-Framework/sp-component-base/isemantictextcolors.yml @@ -1,391 +1,378 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' - summary: Collection of semantic text colors. - name: ISemanticTextColors - fullName: ISemanticTextColors - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ISemanticTextColors +uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' +package: '@microsoft/sp-component-base!' +fullName: ISemanticTextColors +summary: Collection of semantic text colors. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: accentButtonText + uid: '@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#actionLink:member' - - '@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member' - - '@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member' - - '@microsoft/sp-component-base!ISemanticTextColors#bodyText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member' - - '@microsoft/sp-component-base!ISemanticTextColors#buttonText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member' - - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member' - - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member' - - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member' - - '@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member' - - '@microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member' - - '@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member' - - '@microsoft/sp-component-base!ISemanticTextColors#disabledText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#errorText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#inputText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member' - - '@microsoft/sp-component-base!ISemanticTextColors#link:member' - - '@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member' - - '@microsoft/sp-component-base!ISemanticTextColors#listText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member' - - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member' - - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member' - - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member' - - '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member' - - '@microsoft/sp-component-base!ISemanticTextColors#warningText:member' - - uid: '@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member' - summary: Color of text for accent button (kicker) - name: accentButtonText fullName: accentButtonText - langs: - - typeScript - type: property + summary: Color of text for accent button (kicker) + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'accentButtonText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLink:member' - summary: Neutral colored links and links for action buttons. - name: actionLink + type: string + - name: actionLink + uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLink:member' + package: '@microsoft/sp-component-base!' fullName: actionLink - langs: - - typeScript - type: property + summary: Neutral colored links and links for action buttons. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'actionLink: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member' - summary: Hover state for neutral colored links and links for action buttons. - name: actionLinkHovered + type: string + - name: actionLinkHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member' + package: '@microsoft/sp-component-base!' fullName: actionLinkHovered - langs: - - typeScript - type: property + summary: Hover state for neutral colored links and links for action buttons. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'actionLinkHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member' - summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' - name: bodySubtext + type: string + - name: bodySubtext + uid: '@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member' + package: '@microsoft/sp-component-base!' fullName: bodySubtext - langs: - - typeScript - type: property + summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodySubtext: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyText:member' - summary: The default color for text. - name: bodyText + type: string + - name: bodyText + uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyText:member' + package: '@microsoft/sp-component-base!' fullName: bodyText - langs: - - typeScript - type: property + summary: The default color for text. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member' - summary: 'Checked text color, e.g. selected menu item text.' - name: bodyTextChecked + type: string + - name: bodyTextChecked + uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member' + package: '@microsoft/sp-component-base!' fullName: bodyTextChecked - langs: - - typeScript - type: property + summary: 'Checked text color, e.g. selected menu item text.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'bodyTextChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonText:member' - summary: Color of text in a standard button - name: buttonText + type: string + - name: buttonText + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonText:member' + package: '@microsoft/sp-component-base!' fullName: buttonText - langs: - - typeScript - type: property + summary: Color of text in a standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member' - summary: Color of text in a checked standard button - name: buttonTextChecked + type: string + - name: buttonTextChecked + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member' + package: '@microsoft/sp-component-base!' fullName: buttonTextChecked - langs: - - typeScript - type: property + summary: Color of text in a checked standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonTextChecked: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member' - summary: Color of text in a checked and hovered standard button - name: buttonTextCheckedHovered + type: string + - name: buttonTextCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member + package: '@microsoft/sp-component-base!' fullName: buttonTextCheckedHovered - langs: - - typeScript - type: property + summary: Color of text in a checked and hovered standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonTextCheckedHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member' - summary: Color of text in a disabled standard button - name: buttonTextDisabled + type: string + - name: buttonTextDisabled + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member' + package: '@microsoft/sp-component-base!' fullName: buttonTextDisabled - langs: - - typeScript - type: property + summary: Color of text in a disabled standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonTextDisabled: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member' - summary: Color of text in a hovered standard button - name: buttonTextHovered + type: string + - name: buttonTextHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member' + package: '@microsoft/sp-component-base!' fullName: buttonTextHovered - langs: - - typeScript - type: property + summary: Color of text in a hovered standard button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonTextHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member' - summary: Color of text in a pressed standard button; i.e. currently being clicked by mouse - name: buttonTextPressed + type: string + - name: buttonTextPressed + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member' + package: '@microsoft/sp-component-base!' fullName: buttonTextPressed - langs: - - typeScript - type: property + summary: >- + Color of text in a pressed standard button; i.e. currently being clicked + by mouse + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonTextPressed: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member' - summary: 'Disabled de-emphasized text, for use on the default background (bodyBackground).' - name: disabledBodySubtext + type: string + - name: disabledBodySubtext + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member + package: '@microsoft/sp-component-base!' fullName: disabledBodySubtext - langs: - - typeScript - type: property + summary: >- + Disabled de-emphasized text, for use on the default background + (bodyBackground). + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabledBodySubtext: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member' - summary: The default color for disabled text on the default background (bodyBackground). - name: disabledBodyText + type: string + - name: disabledBodyText + uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member' + package: '@microsoft/sp-component-base!' fullName: disabledBodyText - langs: - - typeScript - type: property + summary: >- + The default color for disabled text on the default background + (bodyBackground). + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabledBodyText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member' - summary: 'Disabled de-emphasized text, for use on disabledBackground.' - name: disabledSubtext + type: string + - name: disabledSubtext + uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member' + package: '@microsoft/sp-component-base!' fullName: disabledSubtext - langs: - - typeScript - type: property + summary: 'Disabled de-emphasized text, for use on disabledBackground.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabledSubtext: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledText:member' - summary: >- - The default color for disabled text on top of disabledBackground; e.g. text in a disabled text field, disabled - button text. - name: disabledText + type: string + - name: disabledText + uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledText:member' + package: '@microsoft/sp-component-base!' fullName: disabledText - langs: - - typeScript - type: property + summary: >- + The default color for disabled text on top of disabledBackground; e.g. + text in a disabled text field, disabled button text. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabledText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#errorText:member' - summary: 'The default color of error text, used on bodyBackground.' - name: errorText + type: string + - name: errorText + uid: '@microsoft/sp-component-base!ISemanticTextColors#errorText:member' + package: '@microsoft/sp-component-base!' fullName: errorText - langs: - - typeScript - type: property + summary: 'The default color of error text, used on bodyBackground.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'errorText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member' - summary: The color of placeholder text. - name: inputPlaceholderText + type: string + - name: inputPlaceholderText + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member + package: '@microsoft/sp-component-base!' fullName: inputPlaceholderText - langs: - - typeScript - type: property + summary: The color of placeholder text. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputPlaceholderText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#inputText:member' - summary: The color of input text. - name: inputText + type: string + - name: inputText + uid: '@microsoft/sp-component-base!ISemanticTextColors#inputText:member' + package: '@microsoft/sp-component-base!' fullName: inputText - langs: - - typeScript - type: property + summary: The color of input text. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member' - summary: The color of input text on hover. - name: inputTextHovered + type: string + - name: inputTextHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member' + package: '@microsoft/sp-component-base!' fullName: inputTextHovered - langs: - - typeScript - type: property + summary: The color of input text on hover. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'inputTextHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#link:member' - summary: The color of a link. - name: link + type: string + - name: link + uid: '@microsoft/sp-component-base!ISemanticTextColors#link:member' + package: '@microsoft/sp-component-base!' fullName: link - langs: - - typeScript - type: property + summary: The color of a link. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'link: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member' - summary: The color of a hovered link. Also used when the link is active. - name: linkHovered + type: string + - name: linkHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member' + package: '@microsoft/sp-component-base!' fullName: linkHovered - langs: - - typeScript - type: property + summary: The color of a hovered link. Also used when the link is active. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'linkHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#listText:member' - summary: The default text color for list item titles and text in column fields. - name: listText + type: string + - name: listText + uid: '@microsoft/sp-component-base!ISemanticTextColors#listText:member' + package: '@microsoft/sp-component-base!' fullName: listText - langs: - - typeScript - type: property + summary: The default text color for list item titles and text in column fields. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member' - deprecated: - content: This slot was incorrectly named. Use listText instead. - name: listTextColor + type: string + - name: listTextColor + uid: '@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member' + package: '@microsoft/sp-component-base!' fullName: listTextColor - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: This slot was incorrectly named. Use listText instead. syntax: content: 'listTextColor: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member' - summary: Color of text in a primary button - name: primaryButtonText + type: string + - name: primaryButtonText + uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member' + package: '@microsoft/sp-component-base!' fullName: primaryButtonText - langs: - - typeScript - type: property + summary: Color of text in a primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonText: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member' - summary: Color of text in a disabled primary button - name: primaryButtonTextDisabled + type: string + - name: primaryButtonTextDisabled + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonTextDisabled - langs: - - typeScript - type: property + summary: Color of text in a disabled primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonTextDisabled: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member' - summary: Color of text in a hovered primary button - name: primaryButtonTextHovered + type: string + - name: primaryButtonTextHovered + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonTextHovered - langs: - - typeScript - type: property + summary: Color of text in a hovered primary button + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonTextHovered: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member' - summary: Color of text in a pressed primary button; i.e. currently being clicked by mouse - name: primaryButtonTextPressed + type: string + - name: primaryButtonTextPressed + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member + package: '@microsoft/sp-component-base!' fullName: primaryButtonTextPressed - langs: - - typeScript - type: property + summary: >- + Color of text in a pressed primary button; i.e. currently being clicked by + mouse + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryButtonTextPressed: string;' return: - type: - - string - - uid: '@microsoft/sp-component-base!ISemanticTextColors#warningText:member' - summary: 'The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.' - name: warningText + type: string + - name: warningText + uid: '@microsoft/sp-component-base!ISemanticTextColors#warningText:member' + package: '@microsoft/sp-component-base!' fullName: warningText - langs: - - typeScript - type: property + summary: >- + The color of text on errorBackground, warningBackground, + blockingBackground, or successBackground. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'warningText: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index 2dc5875b..d2f3e7de 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -1,86 +1,76 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!ITheme:interface' - summary: 'Collection of theme values, which can be used to programatically style components.' - name: ITheme - fullName: ITheme - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ITheme +uid: '@microsoft/sp-component-base!ITheme:interface' +package: '@microsoft/sp-component-base!' +fullName: ITheme +summary: >- + Collection of theme values, which can be used to programatically style + components. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: disableGlobalClassNames + uid: '@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member' - - '@microsoft/sp-component-base!ITheme#fonts:member' - - '@microsoft/sp-component-base!ITheme#isInverted:member' - - '@microsoft/sp-component-base!ITheme#palette:member' - - '@microsoft/sp-component-base!ITheme#semanticColors:member' - - uid: '@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member' + fullName: disableGlobalClassNames summary: >- - Disables global styles on Fabric components. This will prevent global overrides that might have been set by other - Fabric users from applying to your components. + Disables global styles on Fabric components. This will prevent global + overrides that might have been set by other Fabric users from applying to + your components. remarks: This has a vary narrow use case and most likely should be avoided. - name: disableGlobalClassNames - fullName: disableGlobalClassNames - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'disableGlobalClassNames: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-component-base!ITheme#fonts:member' - summary: Font styles for different sizes. - name: fonts + type: boolean + - name: fonts + uid: '@microsoft/sp-component-base!ITheme#fonts:member' + package: '@microsoft/sp-component-base!' fullName: fonts - langs: - - typeScript - type: property + summary: Font styles for different sizes. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'fonts: IFontStyles;' return: - type: - - '@microsoft/sp-component-base!IFontStyles:interface' - - uid: '@microsoft/sp-component-base!ITheme#isInverted:member' - summary: Indicates whether the theme is inverted. - name: isInverted + type: '' + - name: isInverted + uid: '@microsoft/sp-component-base!ITheme#isInverted:member' + package: '@microsoft/sp-component-base!' fullName: isInverted - langs: - - typeScript - type: property + summary: Indicates whether the theme is inverted. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'isInverted: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-component-base!ITheme#palette:member' - summary: Color palette. - name: palette + type: boolean + - name: palette + uid: '@microsoft/sp-component-base!ITheme#palette:member' + package: '@microsoft/sp-component-base!' fullName: palette - langs: - - typeScript - type: property + summary: Color palette. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'palette: IPalette;' return: - type: - - '@microsoft/sp-component-base!IPalette:interface' - - uid: '@microsoft/sp-component-base!ITheme#semanticColors:member' - summary: The collection of all semantic slots for colors used in themes. - name: semanticColors + type: '' + - name: semanticColors + uid: '@microsoft/sp-component-base!ITheme#semanticColors:member' + package: '@microsoft/sp-component-base!' fullName: semanticColors - langs: - - typeScript - type: property + summary: The collection of all semantic slots for colors used in themes. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'semanticColors: ISemanticColors;' return: - type: - - '@microsoft/sp-component-base!ISemanticColors:interface' -references: - - uid: '@microsoft/sp-component-base!IFontStyles:interface' - name: IFontStyles - - uid: '@microsoft/sp-component-base!IPalette:interface' - name: IPalette - - uid: '@microsoft/sp-component-base!ISemanticColors:interface' - name: ISemanticColors + type: '' diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index 81f70fb2..2ac729f3 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -1,40 +1,26 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - summary: The object passed when the IThemeProvider.themeChangedEvent is raised. - name: ThemeChangedEventArgs - fullName: ThemeChangedEventArgs - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-core-library!SPEventArgs:class' - inheritance: - - type: '@microsoft/sp-core-library!SPEventArgs:class' +### YamlMime:TSType +name: ThemeChangedEventArgs +uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' +package: '@microsoft/sp-component-base!' +fullName: ThemeChangedEventArgs +summary: The object passed when the IThemeProvider.themeChangedEvent is raised. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: theme + uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' - - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' - summary: 'The new theme. If the value is undefined, then the theme was cleared.' - name: theme fullName: theme - langs: - - typeScript - type: property + summary: 'The new theme. If the value is undefined, then the theme was cleared.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly theme: ITheme | undefined;' return: - type: - - '@microsoft/sp-component-base!ThemeChangedEventArgs#theme~0:complex' -references: - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs - - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme~0:complex' - name: ITheme | undefined - fullName: ITheme | undefined - spec.typeScript: - - uid: '@microsoft/sp-component-base!ITheme:interface' - name: ITheme - fullName: ITheme - - name: ' | undefined' - fullName: ' | undefined' + type: >- + @microsoft/sp-component-base!ThemeChangedEventArgs# +extends: '' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index 3e409459..72b25a66 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -1,114 +1,76 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-component-base!ThemeProvider:class' - summary: >- - The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided - in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. - name: ThemeProvider - fullName: ThemeProvider - langs: - - typeScript - type: class +### YamlMime:TSType +name: ThemeProvider +uid: '@microsoft/sp-component-base!ThemeProvider:class' +package: '@microsoft/sp-component-base!' +fullName: ThemeProvider +summary: >- + The ThemeProvider class provides the capability to get different themes from + the Framework. Themes can be provided in different contexts, e.g. Canvas + sections may provide a variant of the global theme in some contexts. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(serviceScope, theme)' + uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' package: '@microsoft/sp-component-base!' - children: - - '@microsoft/sp-component-base!ThemeProvider:constructor(1)' - - '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' - - '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' - - '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' - - uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' - summary: Construct a new instance of the ThemeProvider class. - name: '(constructor)(serviceScope, theme)' fullName: '(constructor)(serviceScope, theme)' - langs: - - typeScript - type: constructor + summary: Construct a new instance of the ThemeProvider class. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' parameters: - id: serviceScope description: The current service scope. - type: - - '@microsoft/sp-core-library!ServiceScope:class' + type: '' - id: theme description: Theme to provide. - type: - - '@microsoft/sp-component-base!ITheme:interface' - - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' - summary: The service key for ThemeProvider. - name: serviceKey + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' + package: '@microsoft/sp-component-base!' fullName: serviceKey - langs: - - typeScript - type: property + summary: The service key for ThemeProvider. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'static readonly serviceKey: ServiceKey;' return: - type: - - '@microsoft/sp-component-base!ThemeProvider.serviceKey~0:complex' - - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' - summary: Raised when the theme changes with the new theme as an argument. - name: themeChangedEvent + type: >- + @microsoft/sp-component-base!ThemeProvider. + - name: themeChangedEvent + uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' + package: '@microsoft/sp-component-base!' fullName: themeChangedEvent - langs: - - typeScript - type: event + summary: Raised when the theme changes with the new theme as an argument. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly themeChangedEvent: SPEvent;' return: - type: - - '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent~0:complex' - - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' - summary: 'If set, get the current scoped theme.' - name: tryGetTheme() + type: >- + @microsoft/sp-component-base!ThemeProvider# +methods: + - name: tryGetTheme() + uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' + package: '@microsoft/sp-component-base!' fullName: tryGetTheme() - langs: - - typeScript - type: method + summary: 'If set, get the current scoped theme.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'tryGetTheme(): IReadonlyTheme | undefined;' return: - type: - - '@microsoft/sp-component-base!ThemeProvider#tryGetTheme~0:complex' + type: >- + @microsoft/sp-component-base!ThemeProvider# description: '' -references: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-component-base!ITheme:interface' - name: ITheme - - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!ThemeProvider:class' - name: ThemeProvider - fullName: ThemeProvider - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent~0:complex' - name: SPEvent - fullName: SPEvent - spec.typeScript: - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - fullName: SPEvent - - name: < - fullName: < - - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - name: ThemeChangedEventArgs - fullName: ThemeChangedEventArgs - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme~0:complex' - name: IReadonlyTheme | undefined - fullName: IReadonlyTheme | undefined - spec.typeScript: - - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - name: IReadonlyTheme - fullName: IReadonlyTheme - - name: ' | undefined' - fullName: ' | undefined' diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index a0633a9d..251b208a 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -1,104 +1,31 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!' - summary: SharePoint Framework core libraries. - remarks: >- - This package provides a foundation of core classes that ensure a consistent character across all the other - SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes - small code size and broad applicability, versus flexibility or richness of features. - name: '@microsoft/sp-core-library' - fullName: '@microsoft/sp-core-library' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-core-library!DisplayMode:enum' - - '@microsoft/sp-core-library!Environment:class' - - '@microsoft/sp-core-library!EnvironmentType:enum' - - '@microsoft/sp-core-library!Guid:class' - - '@microsoft/sp-core-library!IDisposable:interface' - - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - - '@microsoft/sp-core-library!IServiceCollection:interface' - - '@microsoft/sp-core-library!ISPEventObserver:interface' - - '@microsoft/sp-core-library!ITimeProvider:interface' - - '@microsoft/sp-core-library!Log:class' - - '@microsoft/sp-core-library!RandomNumberGenerator:class' - - '@microsoft/sp-core-library!ServiceCreator:type' - - '@microsoft/sp-core-library!ServiceKey:class' - - '@microsoft/sp-core-library!ServiceScope:class' - - '@microsoft/sp-core-library!Session:class' - - '@microsoft/sp-core-library!SPEvent:class' - - '@microsoft/sp-core-library!SPEventArgs:class' - - '@microsoft/sp-core-library!Text:class' - - '@microsoft/sp-core-library!TimeProvider:class' - - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - - '@microsoft/sp-core-library!Validate:class' - - '@microsoft/sp-core-library!Version:class' - - uid: '@microsoft/sp-core-library!ServiceCreator:type' - summary: This is a callback that is used by ServiceKey.createCustom(). - name: ServiceCreator - fullName: ServiceCreator - langs: - - typeScript - type: typealias - syntax: - content: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' - typeParameters: - - id: T - return: - type: - - '@microsoft/sp-core-library!ServiceCreator~0:complex' -references: - - uid: '@microsoft/sp-core-library!DisplayMode:enum' - name: DisplayMode - - uid: '@microsoft/sp-core-library!Environment:class' - name: Environment - - uid: '@microsoft/sp-core-library!EnvironmentType:enum' - name: EnvironmentType - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable - - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - name: IRandomNumberGenerator - - uid: '@microsoft/sp-core-library!IServiceCollection:interface' - name: IServiceCollection - - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' - name: ISPEventObserver - - uid: '@microsoft/sp-core-library!ITimeProvider:interface' - name: ITimeProvider - - uid: '@microsoft/sp-core-library!Log:class' - name: Log - - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' - name: RandomNumberGenerator - - uid: '@microsoft/sp-core-library!ServiceCreator~0:complex' - name: '(serviceScope: ServiceScope) => T' - fullName: '(serviceScope: default) => T' - spec.typeScript: - - name: '(serviceScope: ' - fullName: '(serviceScope: ' - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - fullName: default - - name: ) => T - fullName: ) => T - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-core-library!Session:class' - name: Session - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs - - uid: '@microsoft/sp-core-library!Text:class' - name: Text - - uid: '@microsoft/sp-core-library!TimeProvider:class' - name: TimeProvider - - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - name: UrlQueryParameterCollection - - uid: '@microsoft/sp-core-library!Validate:class' - name: Validate - - uid: '@microsoft/sp-core-library!Version:class' - name: Version +### YamlMime:TSPacakge +uid: '@microsoft/sp-core-library!' +name: '@microsoft/sp-core-library' +type: package +summary: SharePoint Framework core libraries. +enums: + - '@microsoft/sp-core-library!DisplayMode:enum' + - '@microsoft/sp-core-library!EnvironmentType:enum' +classes: + - '@microsoft/sp-core-library!Environment:class' + - '@microsoft/sp-core-library!Guid:class' + - '@microsoft/sp-core-library!Log:class' + - '@microsoft/sp-core-library!RandomNumberGenerator:class' + - '@microsoft/sp-core-library!ServiceKey:class' + - '@microsoft/sp-core-library!ServiceScope:class' + - '@microsoft/sp-core-library!Session:class' + - '@microsoft/sp-core-library!SPEvent:class' + - '@microsoft/sp-core-library!SPEventArgs:class' + - '@microsoft/sp-core-library!Text:class' + - '@microsoft/sp-core-library!TimeProvider:class' + - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + - '@microsoft/sp-core-library!Validate:class' + - '@microsoft/sp-core-library!Version:class' +interfaces: + - '@microsoft/sp-core-library!IDisposable:interface' + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - '@microsoft/sp-core-library!IServiceCollection:interface' + - '@microsoft/sp-core-library!ISPEventObserver:interface' + - '@microsoft/sp-core-library!ITimeProvider:interface' +typeAliases: + - '@microsoft/sp-core-library!ServiceCreator:type' diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 2ff32dec..b557a188 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -1,33 +1,28 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!DisplayMode:enum' - summary: Indicates whether a visual control should display itself for reading or for editing. - name: DisplayMode - fullName: DisplayMode - langs: - - typeScript - type: enum - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!DisplayMode.Edit:member' - - '@microsoft/sp-core-library!DisplayMode.Read:member' - - uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' - summary: >- - The page, control, or editing surface is in a mode intended for authoring new content. It may display editing - panels or other controls that are not part of the normal reading experience. - name: Edit - fullName: Edit - langs: - - typeScript - type: field - numericValue: '2' - - uid: '@microsoft/sp-core-library!DisplayMode.Read:member' - summary: >- - The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, - but the authoring controls are not enabled. - name: Read - fullName: Read - langs: - - typeScript - type: field - numericValue: '1' +### YamlMime:TSEnum +name: DisplayMode +uid: '@microsoft/sp-core-library!DisplayMode:enum' +package: '@microsoft/sp-core-library!' +fullName: DisplayMode +summary: >- + Indicates whether a visual control should display itself for reading or for + editing. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Edit + uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' + package: '@microsoft/sp-core-library!' + summary: >- + The page, control, or editing surface is in a mode intended for authoring + new content. It may display editing panels or other controls that are not + part of the normal reading experience. + numericValue: '2' + - name: Read + uid: '@microsoft/sp-core-library!DisplayMode.Read:member' + package: '@microsoft/sp-core-library!' + summary: >- + The page, control, or editing surface is in a mode intended for reading. + It may have some interactive features, but the authoring controls are not + enabled. + numericValue: '1' diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index c852bf5b..b9e16e31 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -1,27 +1,27 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Environment:class' - summary: Information about the system environment where the SharePoint Framework is running. - name: Environment - fullName: Environment - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Environment.type:member' - - uid: '@microsoft/sp-core-library!Environment.type:member' - summary: Indicates the general type of environment where the SharePoint Framework is running. - name: type - fullName: type - langs: - - typeScript - type: property - syntax: - content: 'static readonly type: EnvironmentType;' - return: - type: - - '@microsoft/sp-core-library!EnvironmentType:enum' -references: - - uid: '@microsoft/sp-core-library!EnvironmentType:enum' - name: EnvironmentType +### YamlMime:TSType +name: Environment +uid: '@microsoft/sp-core-library!Environment:class' +package: '@microsoft/sp-core-library!' +fullName: Environment +summary: >- + Information about the system environment where the SharePoint Framework is + running. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: type + uid: '@microsoft/sp-core-library!Environment.type:member' + package: '@microsoft/sp-core-library!' + fullName: type + summary: >- + Indicates the general type of environment where the SharePoint Framework + is running. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly type: EnvironmentType;' + return: + type: '' diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 1b3c3609..77445de7 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -1,60 +1,50 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!EnvironmentType:enum' - summary: Indicates the general type of environment where the SharePoint Framework is running. - remarks: >- - This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It - provides a way to distinguish environments where certain functionality may be limited or disabled. - name: EnvironmentType - fullName: EnvironmentType - langs: - - typeScript - type: enum - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' - - '@microsoft/sp-core-library!EnvironmentType.Local:member' - - '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' - - '@microsoft/sp-core-library!EnvironmentType.Test:member' - - uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' - summary: >- - Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be - limited, e.g. various extensibility APIs may not be supported. - name: ClassicSharePoint - fullName: ClassicSharePoint - langs: - - typeScript - type: field - numericValue: '3' - - uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' - summary: >- - Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the - SharePoint Workbench when hosted via "gulp serve". SharePoint REST API calls will not be available, and in general - network access may not authenticate properly. Certain page context information may be using mock values for - testing. - name: Local - fullName: Local - langs: - - typeScript - type: field - numericValue: '1' - - uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' - summary: >- - Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework - functionality. This is the normal usage scenario. - name: SharePoint - fullName: SharePoint - langs: - - typeScript - type: field - numericValue: '2' - - uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' - summary: >- - Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user - interaction at all, and network access in general may be disabled. - name: Test - fullName: Test - langs: - - typeScript - type: field - numericValue: '0' +### YamlMime:TSEnum +name: EnvironmentType +uid: '@microsoft/sp-core-library!EnvironmentType:enum' +package: '@microsoft/sp-core-library!' +fullName: EnvironmentType +summary: >- + Indicates the general type of environment where the SharePoint Framework is + running. +remarks: >- + This enum is used by the + [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) + property. It provides a way to distinguish environments where certain + functionality may be limited or disabled. +isPreview: false +isDeprecated: false +fields: + - name: ClassicSharePoint + uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the framework was hosted by a classic server-rendered + SharePoint page. Some functionality may be limited, e.g. various + extensibility APIs may not be supported. + numericValue: '3' + - name: Local + uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the SharePoint Framework is running on a page from a + "localhost" web server, for example the SharePoint Workbench when hosted + via "gulp serve". SharePoint REST API calls will not be available, and in + general network access may not authenticate properly. Certain page context + information may be using mock values for testing. + numericValue: '1' + - name: SharePoint + uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the SharePoint Framework is running on a modern SharePoint + web page, with full framework functionality. This is the normal usage + scenario. + numericValue: '2' + - name: Test + uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the SharePoint Framework is running inside a test harness, + e.g. a unit test. There may be no user interaction at all, and network + access in general may be disabled. + numericValue: '0' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 7eb6110f..25fe7def 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -1,184 +1,166 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Guid:class' - summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' - remarks: >- - The input string is normalized and validated, which provides important guarantees that simplify other code that - works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware - that the uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some - applications. - - - See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. - name: Guid - fullName: Guid - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Guid.empty:member' - - '@microsoft/sp-core-library!Guid#equals:member(1)' - - '@microsoft/sp-core-library!Guid.isValid:member(1)' - - '@microsoft/sp-core-library!Guid.newGuid:member(1)' - - '@microsoft/sp-core-library!Guid.parse:member(1)' - - '@microsoft/sp-core-library!Guid#toString:member(1)' - - '@microsoft/sp-core-library!Guid.tryParse:member(1)' - - uid: '@microsoft/sp-core-library!Guid.empty:member' - summary: Returns a new empty Guid instance. - name: empty - fullName: empty - langs: - - typeScript - type: property - syntax: - content: 'static readonly empty: Guid;' - return: - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Guid#equals:member(1)' - summary: Compare this instance to another Guid instance - name: equals(guid) - fullName: equals(guid) - langs: - - typeScript - type: method - syntax: - content: 'equals(guid: Guid): boolean;' - return: - type: - - boolean - description: True if this instance and the specified Guid object represent the same value. - parameters: - - id: guid - description: '' - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' - summary: >- - Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This - function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. - name: isValid(guid) - fullName: isValid(guid) - langs: - - typeScript - type: method - syntax: - content: 'static isValid(guid: string | undefined | null): boolean;' - return: - type: - - boolean - description: 'true, if the Guid is valid.' - parameters: - - id: guid - description: The input string. - type: - - string | undefined | null - - uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' - summary: >- - Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from - RFC 4122. - name: newGuid(randomNumberGenerator) - fullName: newGuid(randomNumberGenerator) - langs: - - typeScript - type: method - syntax: - content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' - return: - type: - - '@microsoft/sp-core-library!default:class' - description: A new unique Guid object - parameters: - - id: randomNumberGenerator - description: '' - type: - - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - - uid: '@microsoft/sp-core-library!Guid.parse:member(1)' - summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' - remarks: |- - Example syntaxes accepted by this function: - - - `"d5369f3bbd7a412a9c0f7f0650bb5489"` - - - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` - - - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - - - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - name: parse(guidString) - fullName: parse(guidString) - langs: - - typeScript - type: method - syntax: - content: 'static parse(guidString: string | undefined | null): Guid;' - return: - type: - - '@microsoft/sp-core-library!default:class' - description: A valid Guid object - parameters: - - id: guidString - description: '' - type: - - string | undefined | null - - uid: '@microsoft/sp-core-library!Guid#toString:member(1)' - summary: Returns a string representation of the GUID - name: toString() - fullName: toString() - langs: - - typeScript - type: method - syntax: - content: 'toString(): string;' - return: - type: - - string - description: |- - The GUID value in lowercase hexadecimal without braces. - - Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` - - uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' - summary: >- - Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined - is returned. - remarks: |- - Example syntaxes accepted by this function: - - - `"d5369f3bbd7a412a9c0f7f0650bb5489"` - - - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` - - - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - - - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - name: tryParse(guid) - fullName: tryParse(guid) - langs: - - typeScript - type: method - syntax: - content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' - return: - type: - - '@microsoft/sp-core-library!Guid.tryParse~0:complex' - description: 'The Guid object, or undefined if the string could not be parsed.' - parameters: - - id: guid - description: The input string. - type: - - string | undefined | null -references: - - uid: '@microsoft/sp-core-library!default:class' - name: Guid - - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - name: IRandomNumberGenerator - - uid: '@microsoft/sp-core-library!Guid.tryParse~0:complex' - name: Guid | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: Guid - fullName: default - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: Guid +uid: '@microsoft/sp-core-library!Guid:class' +package: '@microsoft/sp-core-library!' +fullName: Guid +summary: >- + This class represents a globally unique identifier, as described by IETF RFC + 4122. +remarks: >- + The input string is normalized and validated, which provides important + guarantees that simplify other code that works with the GUID. This class also + provides basic support for generating a pseudo-random GUID; however, be aware + that the uniqueness depends on the browser's `Math.random()` function and may + be not be suitable for some applications. + + + See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. +isPreview: false +isDeprecated: false +type: class +properties: + - name: empty + uid: '@microsoft/sp-core-library!Guid.empty:member' + package: '@microsoft/sp-core-library!' + fullName: empty + summary: Returns a new empty Guid instance. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly empty: Guid;' + return: + type: '' +methods: + - name: equals(guid) + uid: '@microsoft/sp-core-library!Guid#equals:member(1)' + package: '@microsoft/sp-core-library!' + fullName: equals(guid) + summary: Compare this instance to another Guid instance + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'equals(guid: Guid): boolean;' + parameters: + - id: guid + description: '' + type: '' + return: + type: boolean + description: >- + True if this instance and the specified Guid object represent the same + value. + - name: isValid(guid) + uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' + package: '@microsoft/sp-core-library!' + fullName: isValid(guid) + summary: >- + Indicates whether a GUID is valid, i.e. whether it would be successfully + parsed by `Guid.tryParse()`<!-- -->. This function is cheaper than + `Guid.tryParse()` because it does not construct a Guid object. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isValid(guid: string | undefined | null): boolean;' + parameters: + - id: guid + description: The input string. + type: string | undefined | null + return: + type: boolean + description: 'true, if the Guid is valid.' + - name: newGuid(randomNumberGenerator) + uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' + package: '@microsoft/sp-core-library!' + fullName: newGuid(randomNumberGenerator) + summary: >- + Returns a new Guid instance with a pseudo-randomly generated GUID, + according to the version 4 UUID algorithm from RFC 4122. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' + parameters: + - id: randomNumberGenerator + description: '' + type: >- + + return: + type: '' + description: A new unique Guid object + - name: parse(guidString) + uid: '@microsoft/sp-core-library!Guid.parse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: parse(guidString) + summary: >- + Parses the input string to construct a new Guid object. If the string + cannot be parsed, then an error is thrown. + remarks: |- + Example syntaxes accepted by this function: + + - `"d5369f3bbd7a412a9c0f7f0650bb5489"` + + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` + + - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` + + - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` + isPreview: false + isDeprecated: false + syntax: + content: 'static parse(guidString: string | undefined | null): Guid;' + parameters: + - id: guidString + description: '' + type: string | undefined | null + return: + type: '' + description: A valid Guid object + - name: toString() + uid: '@microsoft/sp-core-library!Guid#toString:member(1)' + package: '@microsoft/sp-core-library!' + fullName: toString() + summary: Returns a string representation of the GUID + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'toString(): string;' + return: + type: string + description: |- + The GUID value in lowercase hexadecimal without braces. + + Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` + - name: tryParse(guid) + uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: tryParse(guid) + summary: >- + Attempts to parse the input string to construct a new Guid object. If the + string cannot be parsed, then undefined is returned. + remarks: |- + Example syntaxes accepted by this function: + + - `"d5369f3bbd7a412a9c0f7f0650bb5489"` + + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` + + - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` + + - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` + isPreview: false + isDeprecated: false + syntax: + content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' + parameters: + - id: guid + description: The input string. + type: string | undefined | null + return: + type: '@microsoft/sp-core-library!Guid.' + description: 'The Guid object, or undefined if the string could not be parsed.' diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 41872079..33dbb983 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -1,43 +1,45 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - summary: Implemented by an object that supports a disposal lifecycle. - remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. - name: IDisposable - fullName: IDisposable - langs: - - typeScript - type: interface - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!IDisposable#dispose:member(1)' - - '@microsoft/sp-core-library!IDisposable#isDisposed:member' - - uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' - summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - name: dispose() - fullName: dispose() - langs: - - typeScript - type: method - syntax: - content: 'dispose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' - summary: >- - Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state - permanently. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - name: isDisposed - fullName: isDisposed - langs: - - typeScript - type: property - syntax: - content: 'isDisposed: boolean;' - return: - type: - - boolean +### YamlMime:TSType +name: IDisposable +uid: '@microsoft/sp-core-library!IDisposable:interface' +package: '@microsoft/sp-core-library!' +fullName: IDisposable +summary: Implemented by an object that supports a disposal lifecycle. +remarks: >- + The dispose event allows an object to free any resources that it allocated + before its lifecycle ends. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isDisposed + uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' + package: '@microsoft/sp-core-library!' + fullName: isDisposed + summary: >- + Returns true if the dispose() method has been called. Once an object is + disposed, it remains in this state permanently. + remarks: >- + After the object has been disposed, do not call its methods or access its + properties. + isPreview: false + isDeprecated: false + syntax: + content: 'isDisposed: boolean;' + return: + type: boolean +methods: + - name: dispose() + uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' + package: '@microsoft/sp-core-library!' + fullName: dispose() + summary: This method is called to permanently dispose the object. + remarks: >- + After the object has been disposed, do not call its methods or access its + properties. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 01d02eaf..3ec3de4d 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -1,33 +1,36 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - summary: >- - This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom - random numbers. - remarks: >- - This interface abstracts the functionality of the system Math.random() API for usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace - the default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a - mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures - are always repeatable. - name: IRandomNumberGenerator - fullName: IRandomNumberGenerator - langs: - - typeScript - type: interface - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' - - uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' - summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' - name: generate() - fullName: generate() - langs: - - typeScript - type: method - syntax: - content: 'generate(): number;' - return: - type: - - number - description: '' +### YamlMime:TSType +name: IRandomNumberGenerator +uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' +package: '@microsoft/sp-core-library!' +fullName: IRandomNumberGenerator +summary: >- + This is a [ServiceScope](xref:) contract for + generating pseudorandom random numbers. +remarks: >- + This interface abstracts the functionality of the system Math.random() API for + usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). + For example, a unit test might replace the default + [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) + service with a mock implementation that always returns the same sequence of + random numbers, in order to ensure that test failures are always repeatable. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: generate() + uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: generate() + summary: >- + Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), + following the contract of Math.random(). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'generate(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index e4cfacf8..9dec7676 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -1,31 +1,26 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!IServiceCollection:interface' - summary: A shorthand pattern for extracting well-known services from a ServiceScope. - deprecated: - content: >- - This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future - release. - name: IServiceCollection - fullName: IServiceCollection - langs: - - typeScript - type: interface - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' - - uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' - summary: Returns the underlying ServiceScope that the members belong to. - name: serviceScope - fullName: serviceScope - langs: - - typeScript - type: property - syntax: - content: 'readonly serviceScope: ServiceScope;' - return: - type: - - '@microsoft/sp-core-library!default:class' -references: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope +### YamlMime:TSType +name: IServiceCollection +uid: '@microsoft/sp-core-library!IServiceCollection:interface' +package: '@microsoft/sp-core-library!' +fullName: IServiceCollection +summary: A shorthand pattern for extracting well-known services from a ServiceScope. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This pattern has been superceded by the BaseComponentContext pattern. This + interface will be removed in a future release. +type: interface +properties: + - name: serviceScope + uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' + package: '@microsoft/sp-core-library!' + fullName: serviceScope + summary: Returns the underlying ServiceScope that the members belong to. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serviceScope: ServiceScope;' + return: + type: '' diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index d58bbb41..69481302 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -1,53 +1,49 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' - summary: >- - Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by - components that can subscribe to events. - remarks: >- - ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a - SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it - must have a way to notify the event system when the component is disposed, so that its handlers can be - automatically removed. Other objects may implement this contract, as long as they meet these requirements. - name: ISPEventObserver - fullName: ISPEventObserver - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-core-library!IDisposable:interface' - inheritance: - - type: '@microsoft/sp-core-library!IDisposable:interface' +### YamlMime:TSType +name: ISPEventObserver +uid: '@microsoft/sp-core-library!ISPEventObserver:interface' +package: '@microsoft/sp-core-library!' +fullName: ISPEventObserver +summary: >- + Used with the [SPEvent](xref:) system, this interface is + implemented by components that can subscribe to events. +remarks: >- + ISPEventObserver is an abstraction of the key features that a component must + have in order to subscribe to a SharePoint Framework event: It must have + instanceId and componentId information for diagnostics reporting, and it must + have a way to notify the event system when the component is disposed, so that + its handlers can be automatically removed. Other objects may implement this + contract, as long as they meet these requirements. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: componentId + uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!ISPEventObserver#componentId:member' - - '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' - - uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' - summary: 'The component identifier, from the component''s manifest.' - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - name: componentId fullName: componentId - langs: - - typeScript - type: property + summary: 'The component identifier, from the component''s manifest.' + remarks: >- + This will be used for diagnostic reporting, e.g. if the callback function + has an uncaught exception + isPreview: false + isDeprecated: false syntax: content: 'readonly componentId: string;' return: - type: - - string - - uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' - summary: The instance identifier for the component. - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - name: instanceId + type: string + - name: instanceId + uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' + package: '@microsoft/sp-core-library!' fullName: instanceId - langs: - - typeScript - type: property + summary: The instance identifier for the component. + remarks: >- + This will be used for diagnostic reporting, e.g. if the callback function + has an uncaught exception + isPreview: false + isDeprecated: false syntax: content: 'readonly instanceId: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable + type: string +extends: '' diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 6cf5fea3..4eedc152 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -1,49 +1,48 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!ITimeProvider:interface' - summary: >- - This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system - clock. - remarks: >- - This interface abstracts the functionality of the system time APIs for usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace - the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation - that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. - name: ITimeProvider - fullName: ITimeProvider - langs: - - typeScript - type: interface - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' - - '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' - - uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' - summary: 'Returns the current date/time, similar to the Date class constructor.' - name: getDate() - fullName: getDate() - langs: - - typeScript - type: method - syntax: - content: 'getDate(): Date;' - return: - type: - - '!Date:interface' - description: '' - - uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' - summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' - name: getTimestamp() - fullName: getTimestamp() - langs: - - typeScript - type: method - syntax: - content: 'getTimestamp(): number;' - return: - type: - - number - description: '' -references: - - uid: '!Date:interface' - name: Date +### YamlMime:TSType +name: ITimeProvider +uid: '@microsoft/sp-core-library!ITimeProvider:interface' +package: '@microsoft/sp-core-library!' +fullName: ITimeProvider +summary: >- + This is a [ServiceScope](xref:) contract for reading + the system clock. +remarks: >- + This interface abstracts the functionality of the system time APIs for usage + with a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the default + [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service + with a mock implementation that follows a manually incremented timeline, in + order to ensure that test failures are always repeatable. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: getDate() + uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getDate() + summary: 'Returns the current date/time, similar to the Date class constructor.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getDate(): Date;' + return: + type: '' + description: '' + - name: getTimestamp() + uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getTimestamp() + summary: >- + Returns a DOMHighResTimeStamp timing measurement, as defined by the + standard performance.now() API. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getTimestamp(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index e3816859..f0a0c4f0 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -1,145 +1,150 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Log:class' - summary: A basic redirectable logging system. - remarks: >- - The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and - with context information. Context information helps identify which component generated the messages and allows for - filtering of log events. In a SharePoint Framework application, these messages will appear on the developer - dashboard. - name: Log - fullName: Log - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Log.error:member(1)' - - '@microsoft/sp-core-library!Log.info:member(1)' - - '@microsoft/sp-core-library!Log.verbose:member(1)' - - '@microsoft/sp-core-library!Log.warn:member(1)' - - uid: '@microsoft/sp-core-library!Log.error:member(1)' - summary: Logs an error. - name: 'error(source, error, scope)' - fullName: 'error(source, error, scope)' - langs: - - typeScript - type: method - syntax: - content: 'static error(source: string, error: Error, scope?: ServiceScope): void;' - return: - type: - - void - description: '' - parameters: - - id: source - description: >- - the source from where the error is logged, e.g., the class name. The source provides context information for - the logged error. If the source's length is more than 20, only the first 20 characters are kept. - type: - - string - - id: error - description: the error to be logged - type: - - '!Error:interface' - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged error. - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Log.info:member(1)' - summary: Logs a general informational message. - name: 'info(source, message, scope)' - fullName: 'info(source, message, scope)' - langs: - - typeScript - type: method - syntax: - content: 'static info(source: string, message: string, scope?: ServiceScope): void;' - return: - type: - - void - description: '' - parameters: - - id: source - description: >- - the source from where the message is logged, e.g., the class name. The source provides context information - for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: - - string - - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: - - string - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged message. - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Log.verbose:member(1)' - summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. - name: 'verbose(source, message, scope)' - fullName: 'verbose(source, message, scope)' - langs: - - typeScript - type: method - syntax: - content: 'static verbose(source: string, message: string, scope?: ServiceScope): void;' - return: - type: - - void - description: '' - parameters: - - id: source - description: >- - the source from where the message is logged, e.g., the class name. The source provides context information - for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: - - string - - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: - - string - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged message. - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Log.warn:member(1)' - summary: Logs a warning. - name: 'warn(source, message, scope)' - fullName: 'warn(source, message, scope)' - langs: - - typeScript - type: method - syntax: - content: 'static warn(source: string, message: string, scope?: ServiceScope): void;' - return: - type: - - void - description: '' - parameters: - - id: source - description: >- - the source from where the message is logged, e.g., the class name. The source provides context information - for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: - - string - - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: - - string - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged message. - type: - - '@microsoft/sp-core-library!default:class' -references: - - uid: '!Error:interface' - name: Error - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope +### YamlMime:TSType +name: Log +uid: '@microsoft/sp-core-library!Log:class' +package: '@microsoft/sp-core-library!' +fullName: Log +summary: A basic redirectable logging system. +remarks: >- + The Log class provides static methods for logging messages at different levels + (verbose, info, warning, error) and with context information. Context + information helps identify which component generated the messages and allows + for filtering of log events. In a SharePoint Framework application, these + messages will appear on the developer dashboard. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'error(source, error, scope)' + uid: '@microsoft/sp-core-library!Log.error:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'error(source, error, scope)' + summary: Logs an error. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static error(source: string, error: Error, scope?: ServiceScope): void;' + parameters: + - id: source + description: >- + the source from where the error is logged, e.g., the class name. The + source provides context information for the logged error. If the + source's length is more than 20, only the first 20 characters are + kept. + type: string + - id: error + description: the error to be logged + type: '' + - id: scope + description: >- + the service scope that the source uses. A service scope can provide + more context information (e.g., web part information) to the logged + error. + type: '' + return: + type: void + description: '' + - name: 'info(source, message, scope)' + uid: '@microsoft/sp-core-library!Log.info:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'info(source, message, scope)' + summary: Logs a general informational message. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static info(source: string, message: string, scope?: ServiceScope): + void; + parameters: + - id: source + description: >- + the source from where the message is logged, e.g., the class name. + The source provides context information for the logged message. If + the source's length is more than 20, only the first 20 characters + are kept. + type: string + - id: message + description: >- + the message to be logged If the message's length is more than 100, + only the first 100 characters are kept. + type: string + - id: scope + description: >- + the service scope that the source uses. A service scope can provide + more context information (e.g., web part information) to the logged + message. + type: '' + return: + type: void + description: '' + - name: 'verbose(source, message, scope)' + uid: '@microsoft/sp-core-library!Log.verbose:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'verbose(source, message, scope)' + summary: >- + Logs a message which contains detailed information that is generally only + needed for troubleshooting. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static verbose(source: string, message: string, scope?: ServiceScope): + void; + parameters: + - id: source + description: >- + the source from where the message is logged, e.g., the class name. + The source provides context information for the logged message. If + the source's length is more than 20, only the first 20 characters + are kept. + type: string + - id: message + description: >- + the message to be logged If the message's length is more than 100, + only the first 100 characters are kept. + type: string + - id: scope + description: >- + the service scope that the source uses. A service scope can provide + more context information (e.g., web part information) to the logged + message. + type: '' + return: + type: void + description: '' + - name: 'warn(source, message, scope)' + uid: '@microsoft/sp-core-library!Log.warn:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'warn(source, message, scope)' + summary: Logs a warning. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static warn(source: string, message: string, scope?: ServiceScope): + void; + parameters: + - id: source + description: >- + the source from where the message is logged, e.g., the class name. + The source provides context information for the logged message. If + the source's length is more than 20, only the first 20 characters + are kept. + type: string + - id: message + description: >- + the message to be logged If the message's length is more than 100, + only the first 100 characters are kept. + type: string + - id: scope + description: >- + the service scope that the source uses. A service scope can provide + more context information (e.g., web part information) to the logged + message. + type: '' + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index cd590253..3a6ed9a3 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -1,77 +1,59 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' - summary: >- - This is the default implementation of - [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls - Math.random(). - name: RandomNumberGenerator - fullName: RandomNumberGenerator - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' - - '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' - - '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' - - uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' - summary: Constructs a new instance of the `RandomNumberGenerator` class - name: (constructor)(serviceScope) - fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' - summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' - name: generate() - fullName: generate() - langs: - - typeScript - type: method - syntax: - content: 'generate(): number;' - return: - type: - - number - description: '' - - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' - summary: The service key for IRandomNumberGenerator. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - name: IRandomNumberGenerator - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: < - fullName: < - - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - name: IRandomNumberGenerator - fullName: IRandomNumberGenerator - - name: '>' - fullName: '>' +### YamlMime:TSType +name: RandomNumberGenerator +uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' +package: '@microsoft/sp-core-library!' +fullName: RandomNumberGenerator +summary: >- + This is the default implementation of [IRandomNumberGenerator](xref:) that + simply calls Math.random(). +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `RandomNumberGenerator` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' + package: '@microsoft/sp-core-library!' + fullName: serviceKey + summary: The service key for IRandomNumberGenerator. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + @microsoft/sp-core-library!RandomNumberGenerator. +methods: + - name: generate() + uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: generate() + summary: >- + Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), + following the contract of Math.random(). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'generate(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index b8c91791..dd035efb 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -1,195 +1,143 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - summary: >- - The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope#consume:member(1)) to fetch a dependency. - remarks: >- - Every service key also provides a default implementation of the dependency, which will be automatically created in - the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies - can be safely introduced without inadvertently breaking components that are loaded by an older host that does not - provide the new dependency. - name: ServiceKey - fullName: ServiceKey - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!ServiceKey.create:member(1)' - - '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' - - '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' - - '@microsoft/sp-core-library!ServiceKey#id:member' - - '@microsoft/sp-core-library!ServiceKey#name:member' - - uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' - summary: >- - Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts - the standard constructor parameter. - remarks: >- - If you want to specify custom constructor parameters, use - [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. - name: 'create(name, serviceClass)' - fullName: 'create(name, serviceClass)' - langs: - - typeScript - type: method - syntax: - content: |- - static create(name: string, serviceClass: { - new (serviceScope: ServiceScope): TKey; - }): ServiceKey; - return: - type: - - '@microsoft/sp-core-library!ServiceKey.create~0:complex' - description: the newly created ServiceKey - parameters: - - id: name - description: A name such as "my-package.IMyService" which should be unique across packages. - type: - - string - - id: serviceClass - description: the TypeScript class that implements the service. - type: - - '@microsoft/sp-core-library!ServiceKey.create~1:complex' - typeParameters: - - id: TKey - - uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' - summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. - name: 'createCustom(name, defaultCreator)' - fullName: 'createCustom(name, defaultCreator)' - langs: - - typeScript - type: method - syntax: - content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' - return: - type: - - '@microsoft/sp-core-library!ServiceKey.createCustom~0:complex' - description: the newly created service key - parameters: - - id: name - description: A name such as "my-package.IMyService" which should be unique across packages. - type: - - string - - id: defaultCreator - description: a callback that returns an object that implements the T interface - type: - - '@microsoft/sp-core-library!ServiceKey.createCustom~1:complex' - typeParameters: - - id: TKey - - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' - summary: A callback function that constructs the default instance of this service. - name: defaultCreator - fullName: defaultCreator - langs: - - typeScript - type: property - syntax: - content: 'readonly defaultCreator: ServiceCreator;' - return: - type: - - '@microsoft/sp-core-library!ServiceKey#defaultCreator~0:complex' - - uid: '@microsoft/sp-core-library!ServiceKey#id:member' - summary: A unique identifier for this service key. - remarks: >- - This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers - should not make assumptions about the formatting of this string. It is currently based on a global counter, but - this may change in the future. - - - The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant - to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name - was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a - different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in - which libraries are loaded should never affect the resulting tree of scopes. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'readonly id: string;' - return: - type: - - string - - uid: '@microsoft/sp-core-library!ServiceKey#name:member' - summary: The name of the service. - remarks: >- - This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the - package name, followed by a period, followed by the class or interface name. - - - The system does not assume that this string is unique. Instead, the - [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey#id:member) is used wherever a lookup key is needed. - name: name - fullName: name - langs: - - typeScript - type: property - syntax: - content: 'readonly name: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-core-library!ServiceKey.create~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: - fullName: - - uid: '@microsoft/sp-core-library!ServiceKey.create~1:complex' - name: |- - { - new (serviceScope: ServiceScope): TKey; - } - fullName: |- - { - new (serviceScope: default): TKey; - } - spec.typeScript: - - name: |- - { - new (serviceScope: - fullName: |- - { - new (serviceScope: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - fullName: default - - name: |- - ): TKey; - } - fullName: |- - ): TKey; - } - - uid: '@microsoft/sp-core-library!ServiceKey.createCustom~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: - fullName: - - uid: '@microsoft/sp-core-library!ServiceKey.createCustom~1:complex' - name: ServiceCreator - fullName: ServiceCreator - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceCreator:type' - name: ServiceCreator - fullName: ServiceCreator - - name: - fullName: - - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator~0:complex' - name: ServiceCreator - fullName: ServiceCreator - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceCreator:type' - name: ServiceCreator - fullName: ServiceCreator - - name: - fullName: +### YamlMime:TSType +name: ServiceKey +uid: '@microsoft/sp-core-library!ServiceKey:class' +package: '@microsoft/sp-core-library!' +fullName: ServiceKey +summary: >- + The ServiceKey is a lookup key that is used when calling + [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope#)) to fetch a dependency. +remarks: >- + Every service key also provides a default implementation of the dependency, + which will be automatically created in the root scope if the dependency is not + found. Providing a default implementation ensures that new dependencies can be + safely introduced without inadvertently breaking components that are loaded by + an older host that does not provide the new dependency. +isPreview: false +isDeprecated: false +type: class +properties: + - name: defaultCreator + uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' + package: '@microsoft/sp-core-library!' + fullName: defaultCreator + summary: A callback function that constructs the default instance of this service. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly defaultCreator: ServiceCreator;' + return: + type: >- + @microsoft/sp-core-library!ServiceKey# + - name: id + uid: '@microsoft/sp-core-library!ServiceKey#id:member' + package: '@microsoft/sp-core-library!' + fullName: id + summary: A unique identifier for this service key. + remarks: >- + This identifier is an automatically generated string that will be unique + for the lifetime of the page. Callers should not make assumptions about + the formatting of this string. It is currently based on a global counter, + but this may change in the future. + + + The ServiceScope uses this identifier internally as a dictionary key for + finding services. The ServiceKey is meant to be unique, even if multiple + instances of the same library are loaded on the same page, even if the + same name was passed to ServiceKey.create(). This is because each call to + ServiceKey.create() could potentially provide a different defaultCreator + implementation, whereas one of the design goals of ServiceScope is that + the order in which libraries are loaded should never affect the resulting + tree of scopes. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: '@microsoft/sp-core-library!ServiceKey#name:member' + package: '@microsoft/sp-core-library!' + fullName: name + summary: The name of the service. + remarks: >- + This name is used for logging and diagnostic purposes only. To make it + unique, the recommended convention is the package name, followed by a + period, followed by the class or interface name. + + + The system does not assume that this string is unique. Instead, the + [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey#id:member) is + used wherever a lookup key is needed. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string +methods: + - name: 'create(name, serviceClass)' + uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'create(name, serviceClass)' + summary: >- + Constructs a new ServiceKey whose default implementation will be a new + instance of a TypeScript class that accepts the standard constructor + parameter. + remarks: >- + If you want to specify custom constructor parameters, use + [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) + instead. + isPreview: false + isDeprecated: false + syntax: + content: |- + static create(name: string, serviceClass: { + new (serviceScope: ServiceScope): TKey; + }): ServiceKey; + parameters: + - id: name + description: >- + A name such as "my-package.IMyService" which should be unique across + packages. + type: string + - id: serviceClass + description: the TypeScript class that implements the service. + type: >- + @microsoft/sp-core-library!ServiceKey. + return: + type: '@microsoft/sp-core-library!ServiceKey.' + description: the newly created ServiceKey + - name: 'createCustom(name, defaultCreator)' + uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'createCustom(name, defaultCreator)' + summary: >- + Constructs a new ServiceKey whose default implementation will be obtained + by invoking the specified callback. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static createCustom(name: string, defaultCreator: + ServiceCreator): ServiceKey; + parameters: + - id: name + description: >- + A name such as "my-package.IMyService" which should be unique across + packages. + type: string + - id: defaultCreator + description: a callback that returns an object that implements the T interface + type: >- + @microsoft/sp-core-library!ServiceKey. + return: + type: >- + @microsoft/sp-core-library!ServiceKey. + description: the newly created service key diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 8f2d67b5..9d3203d9 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -1,358 +1,292 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - summary: The service locator pattern used by the SharePoint Framework. - remarks: >- - ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to - enable different implementations to be registered in different scopes. This improves modularity by decoupling - components from their dependencies in an extensible way. - - - For example, suppose that various components need access to an IPageManager instance. We could simply make the - PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog - that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor - parameter for each component that requires it, however then we immediately face the problem that any code that - calls these constructors also needs a PageManager parameter. In an application with many such dependencies, - business logic that ties together many subsystems would eventually pick up a constructor parameter for every - possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with - name like "ApplicationContext", and then pass this around as our constructor parameter. This enables the - PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, - it still has a design problem that "ApplicationContext" has hard-coded dependencies on many unrelated things. A - more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the - right lookup key (i.e. ServiceKey). This is the popular "service locator" design pattern, familiar from the - SPContext API in classic SharePoint. - - - ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that - e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other - common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. - This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 - of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to - consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by - requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of - checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial - behavior, so that components can assume that consume() will always return some object that implements the - contract. - - - Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or - ServiceScope.startNewChild(). They are initially in an "unfinished" state, during which provide() can be called to - register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed - and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result - for the same key, and does not depend on order of initialization. It also allows us to support circular - dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is - difficult to guarantee when working with components that were contributed by various third parties without any - coordination.) To avoid mistakes, it's best to always call consume() inside a callback from - serviceScope.whenFinished(). - name: ServiceScope - fullName: ServiceScope - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!ServiceScope:constructor(1)' - - '@microsoft/sp-core-library!ServiceScope#consume:member(1)' - - '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' - - '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' - - '@microsoft/sp-core-library!ServiceScope#finish:member(1)' - - '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' - - '@microsoft/sp-core-library!ServiceScope#provide:member(1)' - - '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' - - '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' - - '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' - - uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' - summary: Constructs a new instance of the `ServiceScope` class - name: (constructor)(parent) - fullName: (constructor)(parent) - langs: - - typeScript - type: constructor - syntax: - content: 'protected constructor(parent: ServiceScope | undefined);' - parameters: - - id: parent - description: '' - type: - - '@microsoft/sp-core-library!ServiceScope~0:complex' - - uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' - summary: Consumes a service from the service scope. - remarks: >- - Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the - registered service instance. If the instance cannot be found, then a default instance will be automatically - created and registered with the root ServiceScope. - name: consume(serviceKey) - fullName: consume(serviceKey) - langs: - - typeScript - type: method - syntax: - content: 'consume(serviceKey: ServiceKey): T;' - return: - type: - - T - description: the service instance - parameters: - - id: serviceKey - description: the key that was used when provide() was called to register the service - type: - - '@microsoft/sp-core-library!ServiceScope#consume~0:complex' - typeParameters: - - id: T - - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' - summary: >- - This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then - registering it by calling ServiceScope.provide(). - name: 'createAndProvide(serviceKey, simpleServiceClass)' - fullName: 'createAndProvide(serviceKey, simpleServiceClass)' - langs: - - typeScript - type: method - syntax: - content: |- - createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { - new (serviceScope: ServiceScope): T; - }): T; - return: - type: - - T - description: a newly constructed instance of simpleServiceClass - parameters: - - id: serviceKey - description: the key that can be used later to consume the service - type: - - '@microsoft/sp-core-library!ServiceScope#createAndProvide~0:complex' - - id: simpleServiceClass - description: the TypeScript class to be constructed - type: - - '@microsoft/sp-core-library!ServiceScope#createAndProvide~1:complex' - typeParameters: - - id: T - - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' - summary: >- - This is a shorthand function that constructs the default implementation of the specified serviceKey, and then - registers it by calling ServiceScope.provide(). - name: createDefaultAndProvide(serviceKey) - fullName: createDefaultAndProvide(serviceKey) - langs: - - typeScript - type: method - syntax: - content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' - return: - type: - - T - description: a service instance that was constructed using ServiceKey.defaultCreator - parameters: - - id: serviceKey - description: the key that can be used later to consume the service - type: - - '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide~0:complex' - typeParameters: - - id: T - - uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' - summary: Completes the initialization sequence for a service scope. - remarks: >- - When a ServiceScope is first started, it is in an "unfinished" state where provide() is allowed but consume() is - disallowed. After calling finish(), then consume() is allowed but provide() is disallowed. - - - This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 - is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via - inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a - different result than the previous call. This nondeterminism could cause unpredictable results that are difficult - to diagnose. - name: finish() - fullName: finish() - langs: - - typeScript - type: method - syntax: - content: 'finish(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' - summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' - name: getParent() - fullName: getParent() - langs: - - typeScript - type: method - syntax: - content: 'getParent(): ServiceScope | undefined;' - return: - type: - - '@microsoft/sp-core-library!ServiceScope#getParent~0:complex' - description: the parent service scope - - uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' - summary: Add a new service to a service scope. - remarks: >- - ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may - only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. - name: 'provide(serviceKey, service)' - fullName: 'provide(serviceKey, service)' - langs: - - typeScript - type: method - syntax: - content: 'provide(serviceKey: ServiceKey, service: T): T;' - return: - type: - - T - description: the same object that was passed as the "service" parameter - parameters: - - id: serviceKey - description: the key that will later be used to consume the service - type: - - '@microsoft/sp-core-library!ServiceScope#provide~0:complex' - - id: service - description: the service instance that is being registered - type: - - T - typeParameters: - - id: T - - uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' - summary: Constructs a new ServiceScope that is a child of the current scope. - remarks: >- - The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly - provided by a child scope, the parent hierarchy will be consulted. - name: startNewChild() - fullName: startNewChild() - langs: - - typeScript - type: method - syntax: - content: 'startNewChild(): ServiceScope;' - return: - type: - - '@microsoft/sp-core-library!default:class' - description: the newly created root ServiceScope - - uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' - summary: >- - Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default - implementations of ServiceKeys. - name: startNewRoot() - fullName: startNewRoot() - langs: - - typeScript - type: method - syntax: - content: 'static startNewRoot(): ServiceScope;' - return: - type: - - '@microsoft/sp-core-library!default:class' - description: the newly created root ServiceScope - - uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' - summary: >- - Defer an operation until after - [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope#finish:member(1)) has completed. - remarks: >- - It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect - your component against this error is to perform the consume() calls inside a whenFinished() callback. If the - service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed - later when the scope is finished. - - - NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. - However, the control flow often threads through numerous constructors and base classes, which can be simplified - using whenFinished(). - name: whenFinished(callback) - fullName: whenFinished(callback) - langs: - - typeScript - type: method - syntax: - content: 'whenFinished(callback: () => void): void;' - return: - type: - - void - description: '' - parameters: - - id: callback - description: A block of code that needs to call ServiceScope.consume() - type: - - () => void -references: - - uid: '@microsoft/sp-core-library!ServiceScope~0:complex' - name: ServiceScope | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-core-library!ServiceScope#consume~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: - fullName: - - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: - fullName: - - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide~1:complex' - name: |- - { - new (serviceScope: ServiceScope): T; - } - fullName: |- - { - new (serviceScope: default): T; - } - spec.typeScript: - - name: |- - { - new (serviceScope: - fullName: |- - { - new (serviceScope: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - fullName: default - - name: |- - ): T; - } - fullName: |- - ): T; - } - - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: - fullName: - - uid: '@microsoft/sp-core-library!ServiceScope#getParent~0:complex' - name: ServiceScope | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-core-library!ServiceScope#provide~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: - fullName: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope +### YamlMime:TSType +name: ServiceScope +uid: '@microsoft/sp-core-library!ServiceScope:class' +package: '@microsoft/sp-core-library!' +fullName: ServiceScope +summary: The service locator pattern used by the SharePoint Framework. +remarks: >- + ServiceScope provides a formalized way for components to register and consume + dependencies ("services"), and to enable different implementations to be + registered in different scopes. This improves modularity by decoupling + components from their dependencies in an extensible way. + + + For example, suppose that various components need access to an IPageManager + instance. We could simply make the PageManager a singleton (i.e. global + variable), but this will not work e.g. if we need to create a pop-up dialog + that requires a second PageManager instance. A better solution would be to add + the PageManager as a constructor parameter for each component that requires + it, however then we immediately face the problem that any code that calls + these constructors also needs a PageManager parameter. In an application with + many such dependencies, business logic that ties together many subsystems + would eventually pick up a constructor parameter for every possible + dependency, which is awkward. A natural solution would be to move all the + dependencies into a class with name like "ApplicationContext", and then pass + this around as our constructor parameter. This enables the PageManager to be + passed to classes that need it without cluttering the intermediary classes + that don't. However, it still has a design problem that "ApplicationContext" + has hard-coded dependencies on many unrelated things. A more flexible approach + is to make it a dictionary that can look up items for consumers/providers who + know the right lookup key (i.e. ServiceKey). This is the popular "service + locator" design pattern, familiar from the SPContext API in classic + SharePoint. + + + ServiceScope takes this idea a step further in two important ways: First, it + provides a scoping mechanism so that e.g. if we have two different pages, they + can each provide a unique PageManager instance while still sharing other + common dependencies. Secondly, it allows for a ServiceKey to provide a default + implementation of the dependency. This is important for API stability in our + modular client-side environment: For example, suppose that version 2.0 of our + application introduced a new IDiagnosticTracing interface that a version 2.0 + component will expect to consume. If the version 2.0 component gets loaded by + an older 1.0 application, it would fail. We could fix this by requiring each + consumer to check for any missing dependencies and handle that case, but it + would require a lot of checks. A better solution is to ensure that a default + implementation always exists, perhaps just a trivial behavior, so that + components can assume that consume() will always return some object that + implements the contract. + + + Usage: ServiceScope instances are created by calling either + ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are + initially in an "unfinished" state, during which provide() can be called to + register service keys, but consume() is disallowed. After + ServiceScope.finish() is called, consume() is allowed and provide() is now + disallowed. These semantics ensure that ServiceScope.consume() always returns + the same result for the same key, and does not depend on order of + initialization. It also allows us to support circular dependencies without + worrying about infinite loops. (Circular dependencies are best avoided, + however this is difficult to guarantee when working with components that were + contributed by various third parties without any coordination.) To avoid + mistakes, it's best to always call consume() inside a callback from + serviceScope.whenFinished(). +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(parent) + uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(parent) + summary: Constructs a new instance of the `ServiceScope` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected constructor(parent: ServiceScope | undefined);' + parameters: + - id: parent + description: '' + type: '' +methods: + - name: consume(serviceKey) + uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' + package: '@microsoft/sp-core-library!' + fullName: consume(serviceKey) + summary: Consumes a service from the service scope. + remarks: >- + Components should call this function to "consume" a dependency, i.e. look + up the serviceKey and return the registered service instance. If the + instance cannot be found, then a default instance will be automatically + created and registered with the root ServiceScope. + isPreview: false + isDeprecated: false + syntax: + content: 'consume(serviceKey: ServiceKey): T;' + parameters: + - id: serviceKey + description: >- + the key that was used when provide() was called to register the + service + type: >- + @microsoft/sp-core-library!ServiceScope# + return: + type: T + description: the service instance + - name: 'createAndProvide(serviceKey, simpleServiceClass)' + uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'createAndProvide(serviceKey, simpleServiceClass)' + summary: >- + This is a shorthand function that is equivalent to constructing a new + instance of the simpleServiceClass, then registering it by calling + ServiceScope.provide(). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { + new (serviceScope: ServiceScope): T; + }): T; + parameters: + - id: serviceKey + description: the key that can be used later to consume the service + type: >- + @microsoft/sp-core-library!ServiceScope# + - id: simpleServiceClass + description: the TypeScript class to be constructed + type: >- + @microsoft/sp-core-library!ServiceScope# + return: + type: T + description: a newly constructed instance of simpleServiceClass + - name: createDefaultAndProvide(serviceKey) + uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' + package: '@microsoft/sp-core-library!' + fullName: createDefaultAndProvide(serviceKey) + summary: >- + This is a shorthand function that constructs the default implementation of + the specified serviceKey, and then registers it by calling + ServiceScope.provide(). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' + parameters: + - id: serviceKey + description: the key that can be used later to consume the service + type: >- + @microsoft/sp-core-library!ServiceScope# + return: + type: T + description: >- + a service instance that was constructed using + ServiceKey.defaultCreator + - name: finish() + uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' + package: '@microsoft/sp-core-library!' + fullName: finish() + summary: Completes the initialization sequence for a service scope. + remarks: >- + When a ServiceScope is first started, it is in an "unfinished" state where + provide() is allowed but consume() is disallowed. After calling finish(), + then consume() is allowed but provide() is disallowed. + + + This formalism prevents a number of complex situations that could lead to + bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 + provides instance A1 of interface A. If someone consumes A1 from Scope2 + (via inheritance) before Scope2.provide() is called with A2, then a + subsequent call to Scope2.consume() might return a different result than + the previous call. This nondeterminism could cause unpredictable results + that are difficult to diagnose. + isPreview: false + isDeprecated: false + syntax: + content: 'finish(): void;' + return: + type: void + description: '' + - name: getParent() + uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getParent() + summary: >- + Returns the parent of the current ServiceScope, or undefined if this is a + root scope. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getParent(): ServiceScope | undefined;' + return: + type: >- + @microsoft/sp-core-library!ServiceScope# + description: the parent service scope + - name: 'provide(serviceKey, service)' + uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'provide(serviceKey, service)' + summary: Add a new service to a service scope. + remarks: >- + ServiceScope.provide() is used to register an implementation of the given + serviceKey for the current scope. It may only be used when the + ServiceScope is in an "unfinished" state, i.e. before finish() has been + called. + isPreview: false + isDeprecated: false + syntax: + content: 'provide(serviceKey: ServiceKey, service: T): T;' + parameters: + - id: serviceKey + description: the key that will later be used to consume the service + type: >- + @microsoft/sp-core-library!ServiceScope# + - id: service + description: the service instance that is being registered + type: T + return: + type: T + description: the same object that was passed as the "service" parameter + - name: startNewChild() + uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' + package: '@microsoft/sp-core-library!' + fullName: startNewChild() + summary: Constructs a new ServiceScope that is a child of the current scope. + remarks: >- + The service scopes form a tree structure, such that when consuming a + service, if the key is not explicitly provided by a child scope, the + parent hierarchy will be consulted. + isPreview: false + isDeprecated: false + syntax: + content: 'startNewChild(): ServiceScope;' + return: + type: '' + description: the newly created root ServiceScope + - name: startNewRoot() + uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' + package: '@microsoft/sp-core-library!' + fullName: startNewRoot() + summary: >- + Create a new root-level ServiceScope. Only root-level scopes have the + ability to autocreate default implementations of ServiceKeys. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static startNewRoot(): ServiceScope;' + return: + type: '' + description: the newly created root ServiceScope + - name: whenFinished(callback) + uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' + package: '@microsoft/sp-core-library!' + fullName: whenFinished(callback) + summary: >- + Defer an operation until after + [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope#)) has completed. + remarks: >- + It is an error to call ServiceScope.consume() before finish() has been + called. The most reliable way to protect your component against this error + is to perform the consume() calls inside a whenFinished() callback. If the + service scope is already finished, then the callback will be executed + immediately; otherwise, it will be executed later when the scope is + finished. + + + NOTE: This is not an asynchronous callback. ServiceScope initialization is + typically inexpensive and short lived. However, the control flow often + threads through numerous constructors and base classes, which can be + simplified using whenFinished(). + isPreview: false + isDeprecated: false + syntax: + content: 'whenFinished(callback: () => void): void;' + parameters: + - id: callback + description: A block of code that needs to call ServiceScope.consume() + type: () => void + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 831dae4e..66c8f995 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -1,60 +1,64 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Session:class' - summary: Provides access to the application's browser session and active page. - name: Session - fullName: Session - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Session.applicationId:member' - - '@microsoft/sp-core-library!Session.pageId:member' - - uid: '@microsoft/sp-core-library!Session.applicationId:member' - summary: A unique identifier for the current instance of the client-side application. - remarks: >- - A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the - duration of the client-side application instance, i.e. it begins with the server request that renders the page, - and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's - router supports in-place navigation (via the history.pushState() API), the application session persists across - these transitions. - name: applicationId - fullName: applicationId - langs: - - typeScript - type: property - syntax: - content: 'static readonly applicationId: Guid;' - return: - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Session.pageId:member' - summary: A unique identifier for the current page within the client-side application. - remarks: >- - A unique identifier used to correlate logging and other diagnostic information. Whereas the - [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) tracks the entire lifetime - of the client-side application instance, the pageId tracks an individual "page" that is rendered. - - - For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the - history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During - this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 - different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA - independently of PageB. - - - The concept of a page is subjective and defined by the router for a particular application. - name: pageId - fullName: pageId - langs: - - typeScript - type: property - syntax: - content: 'static readonly pageId: Guid;' - return: - type: - - '@microsoft/sp-core-library!default:class' -references: - - uid: '@microsoft/sp-core-library!default:class' - name: Guid +### YamlMime:TSType +name: Session +uid: '@microsoft/sp-core-library!Session:class' +package: '@microsoft/sp-core-library!' +fullName: Session +summary: Provides access to the application's browser session and active page. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: applicationId + uid: '@microsoft/sp-core-library!Session.applicationId:member' + package: '@microsoft/sp-core-library!' + fullName: applicationId + summary: >- + A unique identifier for the current instance of the client-side + application. + remarks: >- + A unique identifier used to correlate logging and other diagnostic + information. Its lifetime persists for the duration of the client-side + application instance, i.e. it begins with the server request that renders + the page, and ends e.g. when the browser tab is closed or F5 is pressed to + reload the page. Note that if the application's router supports in-place + navigation (via the history.pushState() API), the application session + persists across these transitions. + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly applicationId: Guid;' + return: + type: '' + - name: pageId + uid: '@microsoft/sp-core-library!Session.pageId:member' + package: '@microsoft/sp-core-library!' + fullName: pageId + summary: >- + A unique identifier for the current page within the client-side + application. + remarks: >- + A unique identifier used to correlate logging and other diagnostic + information. Whereas the + [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) + tracks the entire lifetime of the client-side application instance, the + pageId tracks an individual "page" that is rendered. + + + For example, suppose that the application initially loads PageA, then the + user does in-place navigation (via the history.pushState() API) to PageB, + then navigates back to PageA, and finally they close the browser tab. + During this sequence, the applicationId will remain the same, however the + pageId will change on each navigation. The 3 different pageId values are + used by the diagnostics e.g. to track success/failure statistics for PageA + independently of PageB. + + + The concept of a page is subjective and defined by the router for a + particular application. + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly pageId: Guid;' + return: + type: '' diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index 411c0155..a429a490 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -1,88 +1,95 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!SPEvent:class' - summary: Represents a framework event that components can subscribe to. - remarks: >- - Examples of events in a web application might include: the user clicking a button, the system navigating to - another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents - events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed - as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an - event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The - handler receives an SPEventArgs parameter that may provide additional details about what happened. This is - analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver - feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when - the component is disposed. +### YamlMime:TSType +name: SPEvent +uid: '@microsoft/sp-core-library!SPEvent:class' +package: '@microsoft/sp-core-library!' +fullName: SPEvent +summary: Represents a framework event that components can subscribe to. +remarks: >- + Examples of events in a web application might include: the user clicking a + button, the system navigating to another page, or an item being added/removed + from an abstract collection. The SharePoint Framework represents events using + instances of the SPEvent object, one for each kind of event. The SPEvent + object is typically exposed as a property of an associated class (e.g. the + button that can be clicked). When a component is interested in an event, it + calls add() to register an event handler callback that will be invoked each + time the event occurs. The handler receives an SPEventArgs parameter that may + provide additional details about what happened. This is analogous to the + browser's Document Object Model (DOM) events. The main difference is the + ISPEventObserver feature, which tracks which component subscribed to each + event, and automatically unsubscribes the handler when the component is + disposed. - When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is - unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught - exception will not prevent other handlers from executing, but it will be reported as a problem with the associated - component. + When an event is raised, all handlers are invoked synchronously. The order in + which event handlers are called is unspecified. The event handler callback + must catch any exceptions that occur during processing; an uncaught exception + will not prevent other handlers from executing, but it will be reported as a + problem with the associated component. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPEvent` class. - name: SPEvent - fullName: SPEvent - langs: - - typeScript - type: class + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPEvent` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'add(observer, eventHandler)' + uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!SPEvent#add:member(1)' - - '@microsoft/sp-core-library!SPEvent#remove:member(1)' - - uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' + fullName: 'add(observer, eventHandler)' summary: Registers a callback that will be invoked whenever the event occurs. remarks: >- - The same object can add multiple event handlers to the same event. Since BaseComponent implements the - ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event - handler to be automatically unsubscribed when the web part or extension is disposed. - name: 'add(observer, eventHandler)' - fullName: 'add(observer, eventHandler)' - langs: - - typeScript - type: method + The same object can add multiple event handlers to the same event. Since + BaseComponent implements the ISPEventObserver interface, a web part or + extension can pass itself as the observer. This will cause the event + handler to be automatically unsubscribed when the web part or extension is + disposed. + isPreview: false + isDeprecated: false syntax: - content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' - return: - type: - - void - description: '' + content: >- + add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => + void): void; parameters: - id: observer description: >- - Indicates the object that is subscribing to the event: When the object is disposed, the event handler will - be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event - handler failed to catch an exception. - type: - - '@microsoft/sp-core-library!ISPEventObserver:interface' + Indicates the object that is subscribing to the event: When the + object is disposed, the event handler will be automatically removed. + This object is also used for diagnostic purposes, e.g. detecting if + the event handler failed to catch an exception. + type: '' - id: eventHandler description: A callback function that will be invoked whenever the event occurs - type: - - '(eventArgs: TEventArgs) => void' - - uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' - summary: Unregisters a callback that was registered using add(). - remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - name: 'remove(observer, eventHandler)' - fullName: 'remove(observer, eventHandler)' - langs: - - typeScript - type: method - syntax: - content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + type: '(eventArgs: TEventArgs) => void' return: - type: - - void + type: void description: '' + - name: 'remove(observer, eventHandler)' + uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'remove(observer, eventHandler)' + summary: Unregisters a callback that was registered using add(). + remarks: >- + If the event handler has already been removed, or if it was never added, + then this method has no effect. + isPreview: false + isDeprecated: false + syntax: + content: >- + remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) + => void): void; parameters: - id: observer - description: This must be the same observer that was passed to the add() function. - type: - - '@microsoft/sp-core-library!ISPEventObserver:interface' + description: >- + This must be the same observer that was passed to the add() + function. + type: '' - id: eventHandler - description: The event handler to remove; this must be the same object instance that was passed to the add() function. - type: - - '(eventArgs: TEventArgs) => void' -references: - - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' - name: ISPEventObserver + description: >- + The event handler to remove; this must be the same object instance + that was passed to the add() function. + type: '(eventArgs: TEventArgs) => void' + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 94aa1dd5..6cb1de10 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -1,11 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' - remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' - name: SPEventArgs - fullName: SPEventArgs - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' +### YamlMime:TSType +name: SPEventArgs +uid: '@microsoft/sp-core-library!SPEventArgs:class' +package: '@microsoft/sp-core-library!' +fullName: SPEventArgs +summary: >- + The base class for event arguments used with the [SPEvent](xref:) class. +remarks: >- + If certain event types need to provide additional details, they will define a + subclass of SPEventArgs. +isPreview: false +isDeprecated: false +type: class diff --git a/SP-Framework/sp-core-library/text.yml b/SP-Framework/sp-core-library/text.yml index 41a3a1a6..5b2b3b80 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -1,73 +1,72 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Text:class' - summary: Operations for working with strings that contain text. - remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' - name: Text - fullName: Text - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Text.format:member(1)' - - '@microsoft/sp-core-library!Text.replaceAll:member(1)' - - uid: '@microsoft/sp-core-library!Text.format:member(1)' - summary: Format a string by substituting parameters. - remarks: >- - This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the - value is null or undefined, it will be replaced by the word `"null"` or `"undefined"`. The format string s - must not be null or undefined. - - - Usage example: - - - `Text.format("hello {0}!", "world")` will return `"hello world!"` - name: 'format(s, values)' - fullName: 'format(s, values)' - langs: - - typeScript - type: method - syntax: - content: 'static format(s: string, ...values: any[]): string;' - return: - type: - - string - description: '' - parameters: - - id: s - description: '' - type: - - string - - id: values - description: '' - type: - - 'any[]' - - uid: '@microsoft/sp-core-library!Text.replaceAll:member(1)' - summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' - remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' - name: 'replaceAll(input, searchValue, replaceValue)' - fullName: 'replaceAll(input, searchValue, replaceValue)' - langs: - - typeScript - type: method - syntax: - content: 'static replaceAll(input: string, searchValue: string, replaceValue: string): string;' - return: - type: - - string - description: '' - parameters: - - id: input - description: The string to be modified - type: - - string - - id: searchValue - description: The value to search for - type: - - string - - id: replaceValue - description: The replacement text - type: - - string +### YamlMime:TSType +name: Text +uid: '@microsoft/sp-core-library!Text:class' +package: '@microsoft/sp-core-library!' +fullName: Text +summary: Operations for working with strings that contain text. +remarks: >- + The utilities provided by this class are intended to be simple, small, and + very broadly applicable. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'format(s, values)' + uid: '@microsoft/sp-core-library!Text.format:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'format(s, values)' + summary: Format a string by substituting parameters. + remarks: >- + This function replaces template parameters such as `"{0}"` or `"{1}"` with + the corresponding argument. If the value is null or undefined, it will be + replaced by the word `"null"` or `"undefined"`. The format string + s must not be null or undefined. + + + Usage example: + + + `Text.format("hello {0}!", "world")` will return `"hello world!"` + isPreview: false + isDeprecated: false + syntax: + content: 'static format(s: string, ...values: any[]): string;' + parameters: + - id: s + description: '' + type: string + - id: values + description: '' + type: 'any[]' + return: + type: string + description: '' + - name: 'replaceAll(input, searchValue, replaceValue)' + uid: '@microsoft/sp-core-library!Text.replaceAll:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'replaceAll(input, searchValue, replaceValue)' + summary: >- + Returns the input string, with all instances of `searchValue` replaced by + `replaceValue`<!-- -->. + remarks: >- + Note that JavaScript's `string.replace()` only replaces the first match, + unless a global RegExp is provided. + isPreview: false + isDeprecated: false + syntax: + content: >- + static replaceAll(input: string, searchValue: string, replaceValue: + string): string; + parameters: + - id: input + description: The string to be modified + type: string + - id: searchValue + description: The value to search for + type: string + - id: replaceValue + description: The replacement text + type: string + return: + type: string + description: '' diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 43cb0472..e92e95ba 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -1,92 +1,72 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!TimeProvider:class' - summary: >- - This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) - that simply calls the real browser APIs. - name: TimeProvider - fullName: TimeProvider - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-core-library!ITimeProvider:interface' - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!TimeProvider:constructor(1)' - - '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' - - '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' - - '@microsoft/sp-core-library!TimeProvider.serviceKey:member' - - uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' - summary: Constructs a new instance of the `TimeProvider` class - name: (constructor)(serviceScope) - fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' - summary: 'Returns the current date/time, similar to the Date class constructor.' - name: getDate() - fullName: getDate() - langs: - - typeScript - type: method - syntax: - content: 'getDate(): Date;' - return: - type: - - '!Date:interface' - description: '' - - uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' - summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' - name: getTimestamp() - fullName: getTimestamp() - langs: - - typeScript - type: method - syntax: - content: 'getTimestamp(): number;' - return: - type: - - number - description: '' - - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' - summary: The service key for ITimeProvider. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-core-library!TimeProvider.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-core-library!ITimeProvider:interface' - name: ITimeProvider - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceScope - - uid: '!Date:interface' - name: Date - - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey~0:complex' - name: ServiceKey - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: ServiceKey - fullName: default - - name: < - fullName: < - - uid: '@microsoft/sp-core-library!ITimeProvider:interface' - name: ITimeProvider - fullName: ITimeProvider - - name: '>' - fullName: '>' +### YamlMime:TSType +name: TimeProvider +uid: '@microsoft/sp-core-library!TimeProvider:class' +package: '@microsoft/sp-core-library!' +fullName: TimeProvider +summary: >- + This is the default implementation of [ITimeProvider](xref:) that simply calls + the real browser APIs. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `TimeProvider` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' + package: '@microsoft/sp-core-library!' + fullName: serviceKey + summary: The service key for ITimeProvider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + @microsoft/sp-core-library!TimeProvider. +methods: + - name: getDate() + uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getDate() + summary: 'Returns the current date/time, similar to the Date class constructor.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getDate(): Date;' + return: + type: '' + description: '' + - name: getTimestamp() + uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getTimestamp() + summary: >- + Returns a DOMHighResTimeStamp timing measurement, as defined by the + standard performance.now() API. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getTimestamp(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 24d7dae5..0ece8ba3 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -1,104 +1,105 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - summary: Provides features for storing and retrieving URL query parameters. - remarks: >- - The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with - "?" to indicate the first query parameter and use "&" for all subsequent parameters. The class also supports - fragments. - - - Edge case behavior: - - - Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) - stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value - Query param with only equals (www.example.com/?=&debug=on stores empty string key and value - deprecated: - content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. - name: UrlQueryParameterCollection - fullName: UrlQueryParameterCollection - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' - - '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' - - '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' - - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' - summary: Constructs a new instance of the `UrlQueryParameterCollection` class - name: (constructor)(url) - fullName: (constructor)(url) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(url: string);' - parameters: - - id: url - description: '' - type: - - string - - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' - summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. - remarks: |- - Examples: - - ``` - this._queryParameterList = [ - {key: TEST, value: done}, - {key: DEBUG, value: false}, - {key: TEST, value: notdone}] - getValue('TEST') ---> 'done' - getValue('debug') ---> 'false' - getValue('lost') ---> undefined - - ``` - name: getValue(param) - fullName: getValue(param) - langs: - - typeScript - type: method - syntax: - content: 'getValue(param: string): string | undefined;' - return: - type: - - string | undefined - description: '' - parameters: - - id: param - description: the case insensitive key for the desired query parameter value. - type: - - string - - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' - summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. - remarks: |- - Examples: - - ``` - this._queryParameterList = [ - {key: TEST, value: done}, - {key: DEBUG, value: false}, - {key: TEST, value: notdone}] - getValues('TEST') ---> ['done', 'notdone'] - getValues('debug') ---> ['false'] - getValues('lost') ---> undefined - - ``` - name: getValues(param) - fullName: getValues(param) - langs: - - typeScript - type: method - syntax: - content: 'getValues(param: string): (string | undefined)[] | undefined;' - return: - type: - - '(string | undefined)[] | undefined' - description: '' - parameters: - - id: param - description: the case insensitive key for the desired query parameter value. - type: - - string +### YamlMime:TSType +name: UrlQueryParameterCollection +uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' +package: '@microsoft/sp-core-library!' +fullName: UrlQueryParameterCollection +summary: Provides features for storing and retrieving URL query parameters. +remarks: >- + The URL can be server-relative, and it can also be an empty or null string. + The query parameters must start with "?" to indicate the first query parameter + and use "&" for all subsequent parameters. The class also supports + fragments. + + + Edge case behavior: + + + Empty value (www.example.com/?test=) stores key and empty value No equals in + queryParam (www.example.com/?test) stores key and undefined value Empty + queryParam (www.example.com/?&debug=on) stores undefined key and value + Query param with only equals (www.example.com/?=&debug=on stores empty + string key and value +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + Use the URLSearchParams browser API instead. The SharePoint Framework includes + a polyfill for older browsers. +type: class +constructors: + - name: (constructor)(url) + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(url) + summary: Constructs a new instance of the `UrlQueryParameterCollection` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(url: string);' + parameters: + - id: url + description: '' + type: string +methods: + - name: getValue(param) + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getValue(param) + summary: >- + Returns the value of the first matching query parameter or undefined if + the key doesn't exist. + remarks: |- + Examples: + + ``` + this._queryParameterList = [ + {key: TEST, value: done}, + {key: DEBUG, value: false}, + {key: TEST, value: notdone}] + getValue('TEST') ---> 'done' + getValue('debug') ---> 'false' + getValue('lost') ---> undefined + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'getValue(param: string): string | undefined;' + parameters: + - id: param + description: the case insensitive key for the desired query parameter value. + type: string + return: + type: string | undefined + description: '' + - name: getValues(param) + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getValues(param) + summary: >- + Returns the values of all of the matching query parameters or undefined if + the key doesn't exist. + remarks: |- + Examples: + + ``` + this._queryParameterList = [ + {key: TEST, value: done}, + {key: DEBUG, value: false}, + {key: TEST, value: notdone}] + getValues('TEST') ---> ['done', 'notdone'] + getValues('debug') ---> ['false'] + getValues('lost') ---> undefined + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'getValues(param: string): (string | undefined)[] | undefined;' + parameters: + - id: param + description: the case insensitive key for the desired query parameter value. + type: string + return: + type: '(string | undefined)[] | undefined' + description: '' diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 90eba21a..c10e7005 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -1,110 +1,108 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Validate:class' - summary: Performs common validation tests for properties and function parameters. - remarks: >- - This class implements provides a standard way to validate properties and function parameters. Unlike debug - assertions, Validate checks are always performed and will always throw an error, even in a production release. As - such, be careful not to overuse these checks in a way that might impact performance. - name: Validate - fullName: Validate - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' - - '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' - - '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' - - '@microsoft/sp-core-library!Validate.isTrue:member(1)' - - uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' - summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' - name: 'isNonemptyString(value, variableName)' - fullName: 'isNonemptyString(value, variableName)' - langs: - - typeScript - type: method - syntax: - content: 'static isNonemptyString(value: string | undefined | null, variableName: string): void;' - return: - type: - - void - description: '' - parameters: - - id: value - description: the value to check - type: - - string | undefined | null - - id: variableName - description: 'the program variable name, which will be mentioned in the error message' - type: - - string - - uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' - summary: Throws an exception if the specified object has been disposed. - name: 'isNotDisposed(value, className)' - fullName: 'isNotDisposed(value, className)' - langs: - - typeScript - type: method - syntax: - content: 'static isNotDisposed(value: IDisposable, className: string): void;' - return: - type: - - void - description: '' - parameters: - - id: value - description: the value to check - type: - - '@microsoft/sp-core-library!IDisposable:interface' - - id: className - description: 'the class name, which will be mentioned in the error message' - type: - - string - - uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' - summary: Throws an exception if the specified value is null or undefined. - name: 'isNotNullOrUndefined(value, variableName)' - fullName: 'isNotNullOrUndefined(value, variableName)' - langs: - - typeScript - type: method - syntax: - content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' - return: - type: - - void - description: '' - parameters: - - id: value - description: the value to check - type: - - any - - id: variableName - description: 'the program variable name, which will be mentioned in the error message' - type: - - string - - uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' - summary: Throws an exception if the specified value is not true. - name: 'isTrue(value, variableName)' - fullName: 'isTrue(value, variableName)' - langs: - - typeScript - type: method - syntax: - content: 'static isTrue(value: boolean | undefined | null, variableName: string): void;' - return: - type: - - void - description: '' - parameters: - - id: value - description: the value to check - type: - - boolean | undefined | null - - id: variableName - description: 'the program variable name, which will be mentioned in the error message' - type: - - string -references: - - uid: '@microsoft/sp-core-library!IDisposable:interface' - name: IDisposable +### YamlMime:TSType +name: Validate +uid: '@microsoft/sp-core-library!Validate:class' +package: '@microsoft/sp-core-library!' +fullName: Validate +summary: Performs common validation tests for properties and function parameters. +remarks: >- + This class implements provides a standard way to validate properties and + function parameters. Unlike debug assertions, Validate checks are always + performed and will always throw an error, even in a production release. As + such, be careful not to overuse these checks in a way that might impact + performance. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'isNonemptyString(value, variableName)' + uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isNonemptyString(value, variableName)' + summary: >- + Throws an exception if the specified string is null, undefined, or an + empty string. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static isNonemptyString(value: string | undefined | null, variableName: + string): void; + parameters: + - id: value + description: the value to check + type: string | undefined | null + - id: variableName + description: >- + the program variable name, which will be mentioned in the error + message + type: string + return: + type: void + description: '' + - name: 'isNotDisposed(value, className)' + uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isNotDisposed(value, className)' + summary: Throws an exception if the specified object has been disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isNotDisposed(value: IDisposable, className: string): void;' + parameters: + - id: value + description: the value to check + type: '' + - id: className + description: 'the class name, which will be mentioned in the error message' + type: string + return: + type: void + description: '' + - name: 'isNotNullOrUndefined(value, variableName)' + uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isNotNullOrUndefined(value, variableName)' + summary: Throws an exception if the specified value is null or undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' + parameters: + - id: value + description: the value to check + type: any + - id: variableName + description: >- + the program variable name, which will be mentioned in the error + message + type: string + return: + type: void + description: '' + - name: 'isTrue(value, variableName)' + uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isTrue(value, variableName)' + summary: Throws an exception if the specified value is not true. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static isTrue(value: boolean | undefined | null, variableName: string): + void; + parameters: + - id: value + description: the value to check + type: boolean | undefined | null + - id: variableName + description: >- + the program variable name, which will be mentioned in the error + message + type: string + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 8c1926ba..d0e288dd 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -1,320 +1,298 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-core-library!Version:class' - summary: 'Represents a version number with two, three, or four parts.' - remarks: >- - This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, - MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, - but they are discarded. Missing parts are treated as zeroes for comparisons. - - - Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` - name: Version - fullName: Version - langs: - - typeScript - type: class - package: '@microsoft/sp-core-library!' - children: - - '@microsoft/sp-core-library!Version.compare:member(1)' - - '@microsoft/sp-core-library!Version#equals:member(1)' - - '@microsoft/sp-core-library!Version#greaterThan:member(1)' - - '@microsoft/sp-core-library!Version.isValid:member(1)' - - '@microsoft/sp-core-library!Version#lessThan:member(1)' - - '@microsoft/sp-core-library!Version#major:member' - - '@microsoft/sp-core-library!Version#minor:member' - - '@microsoft/sp-core-library!Version.parse:member(1)' - - '@microsoft/sp-core-library!Version#patch:member' - - '@microsoft/sp-core-library!Version#revision:member' - - '@microsoft/sp-core-library!Version#satisfies:member(1)' - - '@microsoft/sp-core-library!Version#toString:member(1)' - - '@microsoft/sp-core-library!Version.tryParse:member(1)' - - uid: '@microsoft/sp-core-library!Version.compare:member(1)' - summary: Compares two Version objects to determine which version is newer. - name: 'compare(v1, v2)' - fullName: 'compare(v1, v2)' - langs: - - typeScript - type: method - syntax: - content: 'static compare(v1: Version, v2: Version): number;' - return: - type: - - number - description: >- - -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if - the first input is greater than the second input. - parameters: - - id: v1 - description: The first version class for comparison - type: - - '@microsoft/sp-core-library!default:class' - - id: v2 - description: The second version class for comparison - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Version#equals:member(1)' - summary: Tests whether this version is equal to the input parameter. - remarks: |- - Examples: - - ``` - 1.0.0 equals 1.0.0 -> true; - 2.0.1 equals 2.0.0 -> false; - 3.0 equals 3.0.0 -> true; - 04.01 equals 4.1 -> true - - ``` - name: equals(compareWith) - fullName: equals(compareWith) - langs: - - typeScript - type: method - syntax: - content: 'equals(compareWith: Version): boolean;' - return: - type: - - boolean - description: A boolean indicating if this version is equal to the input parameter - parameters: - - id: compareWith - description: The version to compare with - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' - summary: Tests whether this version is greater than (i.e. newer than) the input parameter. - remarks: |- - Examples: - - ``` - 1.0.0 greaterThan 0.0.9 -> true; - 2.0 greaterThan 2.0.0 -> false; - 3.0.1 greaterThan 3.0 -> true - - ``` - name: greaterThan(compareWith) - fullName: greaterThan(compareWith) - langs: - - typeScript - type: method - syntax: - content: 'greaterThan(compareWith: Version): boolean;' - return: - type: - - boolean - description: A boolean indicating if this version is greater than the input parameter - parameters: - - id: compareWith - description: The version to compare with - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Version.isValid:member(1)' - summary: Test whether a string is a valid version specifier. - name: isValid(versionString) - fullName: isValid(versionString) - langs: - - typeScript - type: method - syntax: - content: 'static isValid(versionString: string | undefined | null): boolean;' - return: - type: - - boolean - description: true if the versionString is a valid version specifier - parameters: - - id: versionString - description: The version string - type: - - string | undefined | null - - uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' - summary: Tests whether this version is less than (i.e. older than) the input parameter. - remarks: |- - Examples: - - ``` - 0.9.9 lessThan 1.0.0 -> true; - 2.0 lessThan 2.0.0 -> false; - 3.0 lessThan 3.0.1 -> true; - 04.01 lessThan 4.1 -> false - - ``` - name: lessThan(compareWith) - fullName: lessThan(compareWith) - langs: - - typeScript - type: method - syntax: - content: 'lessThan(compareWith: Version): boolean;' - return: - type: - - boolean - description: A boolean indicating if this version is less than the input parameter - parameters: - - id: compareWith - description: The version to compare with - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Version#major:member' - summary: Returns the first component of the version string. - remarks: Typically a change in the major version number indicates a compatibility break with previous versions. - name: major - fullName: major - langs: - - typeScript - type: property - syntax: - content: 'readonly major: number;' - return: - type: - - number - - uid: '@microsoft/sp-core-library!Version#minor:member' - summary: Returns the second component of the version string. - remarks: >- - Typically a change in the minor version number indicates that new features were added, while remaining backwards - compatible with previous releases. - name: minor - fullName: minor - langs: - - typeScript - type: property - syntax: - content: 'readonly minor: number;' - return: - type: - - number - - uid: '@microsoft/sp-core-library!Version.parse:member(1)' - summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. - name: parse(versionString) - fullName: parse(versionString) - langs: - - typeScript - type: method - syntax: - content: 'static parse(versionString: string | undefined | null): Version;' - return: - type: - - '@microsoft/sp-core-library!default:class' - description: a new Version object - parameters: - - id: versionString - description: A version string - type: - - string | undefined | null - - uid: '@microsoft/sp-core-library!Version#patch:member' - summary: 'The third number in the version string, or undefined if unspecified.' - remarks: >- - Typically a change in the patch version number indicates a small fix that does not affect the compatibility - contract for the library. For a .NET System.Version object, this is referred to as the "build" number. - name: patch - fullName: patch - langs: - - typeScript - type: property - syntax: - content: 'readonly patch: number | undefined;' - return: - type: - - number | undefined - - uid: '@microsoft/sp-core-library!Version#revision:member' - summary: 'The fourth number in the version string, or undefined if unspecified.' - remarks: >- - This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET - version numbers. - name: revision - fullName: revision - langs: - - typeScript - type: property - syntax: - content: 'readonly revision: number | undefined;' - return: - type: - - number | undefined - - uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' - summary: >- - Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards - compatible. - remarks: >- - In order to satisfy the compatibility requirements, this object must have the same major version number as the - input parameter, and it must NOT be older than the input parameter. - - - Examples: - - - ``` - - 1.0.0 satisfies 1.0.0 -> true; - - 1.1.0 satisfies 1.0.0 -> true; - - 2.0.0 satisfies 1.0.0 -> false; - - 1.0.0 satisfies 1.1.0 -> false - - - ``` - name: satisfies(compareWith) - fullName: satisfies(compareWith) - langs: - - typeScript - type: method - syntax: - content: 'satisfies(compareWith: Version): boolean;' - return: - type: - - boolean - description: A boolean indicating if this version is compatible with the input parameter - parameters: - - id: compareWith - description: The version to compare with - type: - - '@microsoft/sp-core-library!default:class' - - uid: '@microsoft/sp-core-library!Version#toString:member(1)' - summary: Returns a string representation of the version. - remarks: >- - The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). - However, the number of version parts will be unchanged. - name: toString() - fullName: toString() - langs: - - typeScript - type: method - syntax: - content: 'toString(): string;' - return: - type: - - string - description: '' - - uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' - summary: >- - Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then - undefined is returned. - name: tryParse(versionString) - fullName: tryParse(versionString) - langs: - - typeScript - type: method - syntax: - content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' - return: - type: - - '@microsoft/sp-core-library!Version.tryParse~0:complex' - description: 'The Version object, or undefined if the string could not be parsed.' - parameters: - - id: versionString - description: A version string - type: - - string | undefined | null -references: - - uid: '@microsoft/sp-core-library!default:class' - name: Version - - uid: '@microsoft/sp-core-library!Version.tryParse~0:complex' - name: Version | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-core-library!default:class' - name: Version - fullName: default - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: Version +uid: '@microsoft/sp-core-library!Version:class' +package: '@microsoft/sp-core-library!' +fullName: Version +summary: 'Represents a version number with two, three, or four parts.' +remarks: >- + This class represents versions that follow the string format of + `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, MINOR, PATCH and REVISION + parts are integers. PATCH and REVISION are optional. Leading zero digits are + allowed, but they are discarded. Missing parts are treated as zeroes for + comparisons. + + + Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, + `01.02.03`, `001.002.003.004` +isPreview: false +isDeprecated: false +type: class +properties: + - name: major + uid: '@microsoft/sp-core-library!Version#major:member' + package: '@microsoft/sp-core-library!' + fullName: major + summary: Returns the first component of the version string. + remarks: >- + Typically a change in the major version number indicates a compatibility + break with previous versions. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly major: number;' + return: + type: number + - name: minor + uid: '@microsoft/sp-core-library!Version#minor:member' + package: '@microsoft/sp-core-library!' + fullName: minor + summary: Returns the second component of the version string. + remarks: >- + Typically a change in the minor version number indicates that new features + were added, while remaining backwards compatible with previous releases. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly minor: number;' + return: + type: number + - name: patch + uid: '@microsoft/sp-core-library!Version#patch:member' + package: '@microsoft/sp-core-library!' + fullName: patch + summary: 'The third number in the version string, or undefined if unspecified.' + remarks: >- + Typically a change in the patch version number indicates a small fix that + does not affect the compatibility contract for the library. For a .NET + System.Version object, this is referred to as the "build" number. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly patch: number | undefined;' + return: + type: number | undefined + - name: revision + uid: '@microsoft/sp-core-library!Version#revision:member' + package: '@microsoft/sp-core-library!' + fullName: revision + summary: 'The fourth number in the version string, or undefined if unspecified.' + remarks: >- + This number is not part of the Semantic Versioning (SemVer) standard used + in JavaScript, but it is used by .NET version numbers. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly revision: number | undefined;' + return: + type: number | undefined +methods: + - name: 'compare(v1, v2)' + uid: '@microsoft/sp-core-library!Version.compare:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'compare(v1, v2)' + summary: Compares two Version objects to determine which version is newer. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static compare(v1: Version, v2: Version): number;' + parameters: + - id: v1 + description: The first version class for comparison + type: '' + - id: v2 + description: The second version class for comparison + type: '' + return: + type: number + description: >- + -1 if the first input is less than the second input; 0 if the first + input is equal to the second input; 1 if the first input is greater + than the second input. + - name: equals(compareWith) + uid: '@microsoft/sp-core-library!Version#equals:member(1)' + package: '@microsoft/sp-core-library!' + fullName: equals(compareWith) + summary: Tests whether this version is equal to the input parameter. + remarks: |- + Examples: + + ``` + 1.0.0 equals 1.0.0 -> true; + 2.0.1 equals 2.0.0 -> false; + 3.0 equals 3.0.0 -> true; + 04.01 equals 4.1 -> true + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'equals(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: A boolean indicating if this version is equal to the input parameter + - name: greaterThan(compareWith) + uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' + package: '@microsoft/sp-core-library!' + fullName: greaterThan(compareWith) + summary: >- + Tests whether this version is greater than (i.e. newer than) the input + parameter. + remarks: |- + Examples: + + ``` + 1.0.0 greaterThan 0.0.9 -> true; + 2.0 greaterThan 2.0.0 -> false; + 3.0.1 greaterThan 3.0 -> true + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'greaterThan(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: >- + A boolean indicating if this version is greater than the input + parameter + - name: isValid(versionString) + uid: '@microsoft/sp-core-library!Version.isValid:member(1)' + package: '@microsoft/sp-core-library!' + fullName: isValid(versionString) + summary: Test whether a string is a valid version specifier. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isValid(versionString: string | undefined | null): boolean;' + parameters: + - id: versionString + description: The version string + type: string | undefined | null + return: + type: boolean + description: true if the versionString is a valid version specifier + - name: lessThan(compareWith) + uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' + package: '@microsoft/sp-core-library!' + fullName: lessThan(compareWith) + summary: >- + Tests whether this version is less than (i.e. older than) the input + parameter. + remarks: |- + Examples: + + ``` + 0.9.9 lessThan 1.0.0 -> true; + 2.0 lessThan 2.0.0 -> false; + 3.0 lessThan 3.0.1 -> true; + 04.01 lessThan 4.1 -> false + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'lessThan(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: A boolean indicating if this version is less than the input parameter + - name: parse(versionString) + uid: '@microsoft/sp-core-library!Version.parse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: parse(versionString) + summary: >- + Constructs a new Version instance using the version string. An exception + is thrown if the string cannot be parsed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static parse(versionString: string | undefined | null): Version;' + parameters: + - id: versionString + description: A version string + type: string | undefined | null + return: + type: '' + description: a new Version object + - name: satisfies(compareWith) + uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' + package: '@microsoft/sp-core-library!' + fullName: satisfies(compareWith) + summary: >- + Tests whether this version satisfies the compatibility requirements of the + input version, i.e. is backwards compatible. + remarks: >- + In order to satisfy the compatibility requirements, this object must have + the same major version number as the input parameter, and it must NOT be + older than the input parameter. + + + Examples: + + + ``` + + 1.0.0 satisfies 1.0.0 -> true; + + 1.1.0 satisfies 1.0.0 -> true; + + 2.0.0 satisfies 1.0.0 -> false; + + 1.0.0 satisfies 1.1.0 -> false + + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'satisfies(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: >- + A boolean indicating if this version is compatible with the input + parameter + - name: toString() + uid: '@microsoft/sp-core-library!Version#toString:member(1)' + package: '@microsoft/sp-core-library!' + fullName: toString() + summary: Returns a string representation of the version. + remarks: >- + The value is normalized and may be different from the original string + (e.g. leading zeroes may be removed). However, the number of version parts + will be unchanged. + isPreview: false + isDeprecated: false + syntax: + content: 'toString(): string;' + return: + type: string + description: '' + - name: tryParse(versionString) + uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: tryParse(versionString) + summary: >- + Attempts to parse the input string to construct a new Version object. If + the string cannot be parsed, then undefined is returned. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static tryParse(versionString: string | undefined | null): Version | + undefined; + parameters: + - id: versionString + description: A version string + type: string | undefined | null + return: + type: '@microsoft/sp-core-library!Version.' + description: 'The Version object, or undefined if the string could not be parsed.' diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index 3609a3f4..2e318354 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -1,39 +1,8 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-diagnostics!' - summary: >- - This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, - user engagement and performance logging. - name: '@microsoft/sp-diagnostics' - fullName: '@microsoft/sp-diagnostics' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-diagnostics!_logSourceServiceKey:var' - - uid: '@microsoft/sp-diagnostics!_logSourceServiceKey:var' - name: _logSourceServiceKey - fullName: _logSourceServiceKey - langs: - - typeScript - type: variable - syntax: - content: 'logSourceServiceKey: ServiceKey' - return: - type: - - '@microsoft/sp-diagnostics!_logSourceServiceKey~0:complex' -references: - - uid: '@microsoft/sp-diagnostics!_logSourceServiceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-diagnostics!default:class' - name: LogSource - fullName: default - - name: '>' - fullName: '>' +### YamlMime:TSPacakge +uid: '@microsoft/sp-diagnostics!' +name: '@microsoft/sp-diagnostics' +type: package +summary: >- + This package defines the internal diagnostics tools for the SharePoint + Framework, including monitoring, trace, user engagement and performance + logging. diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index 5b84ac58..dd638b6a 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -1,38 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!' - summary: SharePoint Framework support for displaying pop-up dialog boxes. - remarks: >- - This library provides simple stock dialogs such as - [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)) and - [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)), along with a general framework for - building custom dialog boxes that participate in the focus management system for SharePoint Framework - applications. - name: '@microsoft/sp-dialog' - fullName: '@microsoft/sp-dialog' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-dialog!BaseDialog:class' - - '@microsoft/sp-dialog!Dialog:class' - - '@microsoft/sp-dialog!IAlertOptions:interface' - - '@microsoft/sp-dialog!IDialogConfiguration:interface' - - '@microsoft/sp-dialog!IDialogShowOptions:interface' - - '@microsoft/sp-dialog!IPromptOptions:interface' - - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' -references: - - uid: '@microsoft/sp-dialog!BaseDialog:class' - name: BaseDialog - - uid: '@microsoft/sp-dialog!Dialog:class' - name: Dialog - - uid: '@microsoft/sp-dialog!IAlertOptions:interface' - name: IAlertOptions - - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' - name: IDialogConfiguration - - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - name: IDialogShowOptions - - uid: '@microsoft/sp-dialog!IPromptOptions:interface' - name: IPromptOptions - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' - name: ISecondaryDialogProvider +### YamlMime:TSPacakge +uid: '@microsoft/sp-dialog!' +name: '@microsoft/sp-dialog' +type: package +summary: SharePoint Framework support for displaying pop-up dialog boxes. +classes: + - '@microsoft/sp-dialog!BaseDialog:class' + - '@microsoft/sp-dialog!Dialog:class' +interfaces: + - '@microsoft/sp-dialog!IAlertOptions:interface' + - '@microsoft/sp-dialog!IDialogConfiguration:interface' + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + - '@microsoft/sp-dialog!IPromptOptions:interface' + - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 589fb761..2790bfaf 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -1,287 +1,263 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!BaseDialog:class' - summary: >- - The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs - to the user inside SharePoint Framework components. - remarks: >- - Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the - framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is - controlled by this class by implementing the render method, the framework can decide when to show the dialog and - how to render the overlay and modal. The application on the page can also have control on allowing dialogs to - show. Refer to the documentation of the individual methods and properties to learn more about how to extend and - use this class. - name: BaseDialog - fullName: BaseDialog - langs: - - typeScript - type: class - package: '@microsoft/sp-dialog!' - children: - - '@microsoft/sp-dialog!BaseDialog:constructor(1)' - - '@microsoft/sp-dialog!BaseDialog#close:member(1)' - - '@microsoft/sp-dialog!BaseDialog#domElement:member' - - '@microsoft/sp-dialog!BaseDialog#isHidden:member' - - '@microsoft/sp-dialog!BaseDialog#isOpen:member' - - '@microsoft/sp-dialog!BaseDialog#isSecondary:member' - - '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' - - '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' - - '@microsoft/sp-dialog!BaseDialog#render:member(1)' - - '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' - - '@microsoft/sp-dialog!BaseDialog#show:member(1)' - - uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' - summary: Constructor for the `BaseDialog` class. - remarks: >- - It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization - that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can - use the constructor to set initial parameters of your dialog such as references to resources in your application. - The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog - may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user - experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects - it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric - `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak - because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to - dispose. - - - Example: - - - ``` - constructor(cacheReference: any) { - super(); - - this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. - this._cache.refresh(); // This is bad practice. - // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() - } - - ``` - name: (constructor)(config) - fullName: (constructor)(config) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(config?: IDialogConfiguration);' - parameters: - - id: config - description: the dialog configuration that affects how the dialog is displayed \* - type: - - '@microsoft/sp-dialog!IDialogConfiguration:interface' - - uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' - summary: Close the dialog. - remarks: >- - This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to - avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - name: close() - fullName: close() - langs: - - typeScript - type: method - syntax: - content: 'close(): Promise;' - return: - type: - - '@microsoft/sp-dialog!BaseDialog#close~0:complex' - description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - - uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' - summary: Use this property to access the container element provided by the framework for rendering. - remarks: >- - See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog#render:member(1)) for more information on - rendering. - name: domElement - fullName: domElement - langs: - - typeScript - type: property - syntax: - content: 'protected readonly domElement: HTMLElement;' - return: - type: - - '!HTMLElement:interface' - - uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' - summary: If the dialog is visually hidden. - remarks: >- - This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the - dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - name: isHidden - fullName: isHidden - langs: - - typeScript - type: property - syntax: - content: 'readonly isHidden: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' - summary: >- - If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It - returns false when the dialog is hidden. - name: isOpen - fullName: isOpen - langs: - - typeScript - type: property - syntax: - content: 'readonly isOpen: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' - summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. - name: isSecondary - fullName: isSecondary - langs: - - typeScript - type: property - syntax: - content: 'readonly isSecondary: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' - summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. - remarks: >- - The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though - the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle - that should reallocate its own resources. If there are any resources that you would like to keep for multiple - lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - name: onAfterClose() - fullName: onAfterClose() - langs: - - typeScript - type: method - syntax: - content: 'protected onAfterClose(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' - summary: >- - This method is called before the render method and can be overridden to make preparations for rendering. The - loading indicator is displayed during the lifetime of this method. - remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. - name: onBeforeOpen() - fullName: onBeforeOpen() - langs: - - typeScript - type: method - syntax: - content: 'protected onBeforeOpen(): Promise;' - return: - type: - - '@microsoft/sp-dialog!BaseDialog#onBeforeOpen~0:complex' - description: >- - A promise that resolves when the operations are done and the dialog is ready to render. If the promise is - rejected, the dialog will not be rendered and `onAfterClose()` will not be called. - - uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' - summary: Renders the contents of the dialog. - remarks: >- - The `render` method must be implemented to render the content of the dialog in the container element provided by - the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the - center of the page on top of a dark overlay. - - - The render method is called once after the modal element is created and opened. It is recommended to use - `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that - the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If - you choose to do your initialization or other costly operations inside render method, make sure to have a friendly - UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which - is a bad user experience practice. - name: render() - fullName: render() - langs: - - typeScript - type: method - syntax: - content: 'protected abstract render(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' - summary: >- - An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs - are permitted. - remarks: >- - Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show - a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a - secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - name: secondaryDialogProvider - fullName: secondaryDialogProvider - langs: - - typeScript - type: property - syntax: - content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' - return: - type: - - '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider~0:complex' - - uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' - summary: Request the framework to show this dialog. - name: show(options) - fullName: show(options) - langs: - - typeScript - type: method - syntax: - content: 'show(options?: IDialogShowOptions): Promise;' - return: - type: - - '@microsoft/sp-dialog!BaseDialog#show~0:complex' - description: >- - A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the - request is rejected or aborted. - parameters: - - id: options - description: >- - Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for - more information. - type: - - '@microsoft/sp-dialog!IDialogShowOptions:interface' -references: - - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' - name: IDialogConfiguration - - uid: '@microsoft/sp-dialog!BaseDialog#close~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '!HTMLElement:interface' - name: HTMLElement - - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider~0:complex' - name: ISecondaryDialogProvider | undefined - fullName: ISecondaryDialogProvider | undefined - spec.typeScript: - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' - name: ISecondaryDialogProvider - fullName: ISecondaryDialogProvider - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-dialog!BaseDialog#show~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - name: IDialogShowOptions +### YamlMime:TSType +name: BaseDialog +uid: '@microsoft/sp-dialog!BaseDialog:class' +package: '@microsoft/sp-dialog!' +fullName: BaseDialog +summary: >- + The base class for implementing dialogs in SharePoint Framework. This provides + a supported way for showing dialogs to the user inside SharePoint Framework + components. +remarks: >- + Extend this class to create dialogs for SharePoint Framework. By following the + guidelines in implementation, the framework can ensure that the dialogs are + shown in a user-friendly manner. While the content of the dialog is controlled + by this class by implementing the render method, the framework can decide when + to show the dialog and how to render the overlay and modal. The application on + the page can also have control on allowing dialogs to show. Refer to the + documentation of the individual methods and properties to learn more about how + to extend and use this class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(config) + uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' + package: '@microsoft/sp-dialog!' + fullName: (constructor)(config) + summary: Constructor for the `BaseDialog` class. + remarks: >- + It is important to keep the constructor lightweight. Use `onBeforeOpen()` + for doing heavy-weight initialization that is needed for rendering the + dialog such as resource allocations and asynchronous calls to fetch data. + You can use the constructor to set initial parameters of your dialog such + as references to resources in your application. The reason for this is + that dialogs are usually constructed upon a UI event e.g. a button click, + but the dialog may not always be shown right after construction. Keeping + the constructor lightweight ensures smooth user experience and avoids + doing throw-away work in case the dialog is not shown later e.g. if the + framework rejects it. Another benefit of doing this is avoiding memory + leaks by doing all the allocations and disposals in symmetric + `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in + the constructor, you have a memory leak because there is no guarantee + onAfterClose() will get called, and onAfterClose() is your only + opportunity to dispose. + + + Example: + + + ``` + constructor(cacheReference: any) { + super(); + + this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. + this._cache.refresh(); // This is bad practice. + // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() + } + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(config?: IDialogConfiguration);' + parameters: + - id: config + description: the dialog configuration that affects how the dialog is displayed \* + type: '' +properties: + - name: domElement + uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' + package: '@microsoft/sp-dialog!' + fullName: domElement + summary: >- + Use this property to access the container element provided by the + framework for rendering. + remarks: >- + See + [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog#render:member(1)) + for more information on rendering. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly domElement: HTMLElement;' + return: + type: '' + - name: isHidden + uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' + package: '@microsoft/sp-dialog!' + fullName: isHidden + summary: If the dialog is visually hidden. + remarks: >- + This happens when the dialog goes behind a secondary dialog. Note that + this is different from closed, because the dialog still has the permission + to show and will eventually unhide. This returns false if the dialog is + closed. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isHidden: boolean;' + return: + type: boolean + - name: isOpen + uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' + package: '@microsoft/sp-dialog!' + fullName: isOpen + summary: >- + If the dialog is visually open. This returns true during onBeforeOpen() + because there is a visual component. It returns false when the dialog is + hidden. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isOpen: boolean;' + return: + type: boolean + - name: isSecondary + uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' + package: '@microsoft/sp-dialog!' + fullName: isSecondary + summary: >- + If the dialog is a secondary dialog. This means that there is another + dialog hidden behind this dialog. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isSecondary: boolean;' + return: + type: boolean + - name: secondaryDialogProvider + uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' + package: '@microsoft/sp-dialog!' + fullName: secondaryDialogProvider + summary: >- + An active dialog is permitted to show a secondary dialog on top of itself. + By design, only two layers of dialogs are permitted. + remarks: >- + Secondary dialogs do not have to wait for permission and will immediately + be shown or rejected. All calls to show a secondary dialog reject while + there is already a secondary dialog showing. This property may be + undefined if a secondary dialog is not available i.e. the current dialog + is secondary itself or the dialog is not active. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' + return: + type: >- + @microsoft/sp-dialog!BaseDialog# +methods: + - name: close() + uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' + package: '@microsoft/sp-dialog!' + fullName: close() + summary: Close the dialog. + remarks: >- + This will void the permission to show for this dialog. Every dialog should + have a mechanism to eventually close to avoid blocking the user interface. + If called on an inactive dialog it will abort the request to show. + isPreview: false + isDeprecated: false + syntax: + content: 'close(): Promise;' + return: + type: '@microsoft/sp-dialog!BaseDialog#' + description: >- + A promise that resolves when the dialog is visually closed, or if it + was already closed + - name: onAfterClose() + uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' + package: '@microsoft/sp-dialog!' + fullName: onAfterClose() + summary: >- + This method is called after the dialog is visually closed and gives an + opportunity for doing clean up. + remarks: >- + The dialog lifecycle completes after closing and there should be no + resources left inside the object. Even though the dialog may be revived + again for a new lifecycle using show() method, this is considered a whole + new lifecycle that should reallocate its own resources. If there are any + resources that you would like to keep for multiple lifecycles, consider + allocating it outside the dialog object and passing its reference to the + dialog constructor. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onAfterClose(): void;' + return: + type: void + description: '' + - name: onBeforeOpen() + uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' + package: '@microsoft/sp-dialog!' + fullName: onBeforeOpen() + summary: >- + This method is called before the render method and can be overridden to + make preparations for rendering. The loading indicator is displayed during + the lifetime of this method. + remarks: >- + All resource allocations in onBeforeOpen() should be properly disposed in + `onAfterClose()` to a avoid memory leak. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onBeforeOpen(): Promise;' + return: + type: '@microsoft/sp-dialog!BaseDialog#' + description: >- + A promise that resolves when the operations are done and the dialog is + ready to render. If the promise is rejected, the dialog will not be + rendered and `onAfterClose()` will not be called. + - name: render() + uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' + package: '@microsoft/sp-dialog!' + fullName: render() + summary: Renders the contents of the dialog. + remarks: >- + The `render` method must be implemented to render the content of the + dialog in the container element provided by the framework. Use + `this.domElement` to access this container. The container is inside a + modal rendered in the center of the page on top of a dark overlay. + + + The render method is called once after the modal element is created and + opened. It is recommended to use `onBeforeOpen()` for doing non-UI + operations for your rendering that might take a long time. This will + ensure that the framework can show a friendly UI such as a spinner to let + the user know that the dialog is being prepared. If you choose to do your + initialization or other costly operations inside render method, make sure + to have a friendly UI so the user is informed about the state of your + dialog. Otherwise, an empty element is shown to the user which is a bad + user experience practice. + isPreview: false + isDeprecated: false + syntax: + content: 'protected abstract render(): void;' + return: + type: void + description: '' + - name: show(options) + uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' + package: '@microsoft/sp-dialog!' + fullName: show(options) + summary: Request the framework to show this dialog. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'show(options?: IDialogShowOptions): Promise;' + parameters: + - id: options + description: >- + Dialog showing options. See + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) + for more information. + type: '' + return: + type: '@microsoft/sp-dialog!BaseDialog#' + description: >- + A promise that resolves once the dialog is successfully closed (after + being shown). The promise rejects if the request is rejected or + aborted. diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 6240d9b0..2bacd43a 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -1,92 +1,67 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!Dialog:class' - summary: A static class for showing stock dialogs such as an alert or prompt. - name: Dialog - fullName: Dialog - langs: - - typeScript - type: class - package: '@microsoft/sp-dialog!' - children: - - '@microsoft/sp-dialog!Dialog.alert:member(1)' - - '@microsoft/sp-dialog!Dialog.prompt:member(1)' - - uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' - summary: >- - Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to - show the alert dialog. - remarks: >- - There might be a delay until the dialog is approved and shown by the application, for example, if there is another - dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The - promise rejects if the application rejects the request for any reason. - name: 'alert(message, options)' - fullName: 'alert(message, options)' - langs: - - typeScript - type: method - syntax: - content: 'static alert(message: string, options?: IAlertOptions): Promise;' - return: - type: - - '@microsoft/sp-dialog!Dialog.alert~0:complex' - description: '' - parameters: - - id: message - description: The message to alert - type: - - string - - id: options - description: '' - type: - - '@microsoft/sp-dialog!IAlertOptions:interface' - - uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' - summary: >- - Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to - application to show the dialog. - remarks: >- - There might be a delay until the dialog is approved and shown by the application, for example, if there is another - dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The - promise rejects if the application rejects the request for any reason. - name: 'prompt(message, options)' - fullName: 'prompt(message, options)' - langs: - - typeScript - type: method - syntax: - content: 'static prompt(message: string, options?: IPromptOptions): Promise;' - return: - type: - - '@microsoft/sp-dialog!Dialog.prompt~0:complex' - description: The input string or undefined if the dialog was canceled - parameters: - - id: message - description: The message for prompt dialog - type: - - string - - id: options - description: '' - type: - - '@microsoft/sp-dialog!IPromptOptions:interface' -references: - - uid: '@microsoft/sp-dialog!Dialog.alert~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!IAlertOptions:interface' - name: IAlertOptions - - uid: '@microsoft/sp-dialog!Dialog.prompt~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!IPromptOptions:interface' - name: IPromptOptions +### YamlMime:TSType +name: Dialog +uid: '@microsoft/sp-dialog!Dialog:class' +package: '@microsoft/sp-dialog!' +fullName: Dialog +summary: A static class for showing stock dialogs such as an alert or prompt. +remarks: '' +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'alert(message, options)' + uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'alert(message, options)' + summary: >- + Alerts a message to the user with a user-friendly interface. Calling this + method sends a request to application to show the alert dialog. + remarks: >- + There might be a delay until the dialog is approved and shown by the + application, for example, if there is another dialog currently being + shown. The returned promise resolves when the dialog is successfully shown + and closed. The promise rejects if the application rejects the request for + any reason. + isPreview: false + isDeprecated: false + syntax: + content: 'static alert(message: string, options?: IAlertOptions): Promise;' + parameters: + - id: message + description: The message to alert + type: string + - id: options + description: '' + type: '' + return: + type: '@microsoft/sp-dialog!Dialog.' + description: '' + - name: 'prompt(message, options)' + uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'prompt(message, options)' + summary: >- + Prompts the user for a string value with a user-friendly interface. + Calling this method sends a request to application to show the dialog. + remarks: >- + There might be a delay until the dialog is approved and shown by the + application, for example, if there is another dialog currently being + shown. The returned promise resolves when the dialog is successfully shown + and closed. The promise rejects if the application rejects the request for + any reason. + isPreview: false + isDeprecated: false + syntax: + content: >- + static prompt(message: string, options?: IPromptOptions): Promise; + parameters: + - id: message + description: The message for prompt dialog + type: string + - id: options + description: '' + type: '' + return: + type: '@microsoft/sp-dialog!Dialog.' + description: The input string or undefined if the dialog was canceled diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index b1e708f8..c3320646 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -1,17 +1,11 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!IAlertOptions:interface' - summary: Options for showing an alert dialog - name: IAlertOptions - fullName: IAlertOptions - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-dialog!IDialogShowOptions:interface' - inheritance: - - type: '@microsoft/sp-dialog!IDialogShowOptions:interface' - package: '@microsoft/sp-dialog!' -references: - - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - name: IDialogShowOptions +### YamlMime:TSType +name: IAlertOptions +uid: '@microsoft/sp-dialog!IAlertOptions:interface' +package: '@microsoft/sp-dialog!' +fullName: IAlertOptions +summary: Options for showing an alert dialog +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index f5ad498b..662bc5cb 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -1,24 +1,25 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' - summary: The interface for dialog configuration - name: IDialogConfiguration - fullName: IDialogConfiguration - langs: - - typeScript - type: interface - package: '@microsoft/sp-dialog!' - children: - - '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' - - uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' - summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). - name: isBlocking - fullName: isBlocking - langs: - - typeScript - type: property - syntax: - content: 'isBlocking?: boolean;' - return: - type: - - boolean +### YamlMime:TSType +name: IDialogConfiguration +uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' +package: '@microsoft/sp-dialog!' +fullName: IDialogConfiguration +summary: The interface for dialog configuration +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isBlocking + uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' + package: '@microsoft/sp-dialog!' + fullName: isBlocking + summary: >- + Whether the dialog can be closed by clicking outside the dialog (on the + overlay). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isBlocking?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 9f9d920b..81ee54bd 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -1,30 +1,30 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - summary: Options for showing a dialog - name: IDialogShowOptions - fullName: IDialogShowOptions - langs: - - typeScript - type: interface - package: '@microsoft/sp-dialog!' - children: - - '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' - - uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' - summary: A callback that is invoked immediately before the dialog receives focus. - remarks: >- - Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the - framework. For example, you can check if a long time has passed since the request was made or the the component - requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this - callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long - time for it. - name: confirmOpen - fullName: confirmOpen - langs: - - typeScript - type: property - syntax: - content: 'confirmOpen?: () => boolean;' - return: - type: - - () => boolean +### YamlMime:TSType +name: IDialogShowOptions +uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' +package: '@microsoft/sp-dialog!' +fullName: IDialogShowOptions +summary: Options for showing a dialog +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: confirmOpen + uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' + package: '@microsoft/sp-dialog!' + fullName: confirmOpen + summary: A callback that is invoked immediately before the dialog receives focus. + remarks: >- + Provide this callback if there is a case when you want to abort showing + the dialog before it's approved by the framework. For example, you can + check if a long time has passed since the request was made or the the + component requesting the dialog is disposed and you don't want to show the + dialog anymore. It is important to keep this callback lightweight so the + framework can resolve it quickly and the user interface does not have to + wait a long time for it. + isPreview: false + isDeprecated: false + syntax: + content: 'confirmOpen?: () => boolean;' + return: + type: () => boolean diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 99101ec1..f9971bce 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -1,31 +1,24 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!IPromptOptions:interface' - summary: Options for showing a prompt dialog - name: IPromptOptions - fullName: IPromptOptions - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-dialog!IDialogShowOptions:interface' - inheritance: - - type: '@microsoft/sp-dialog!IDialogShowOptions:interface' - package: '@microsoft/sp-dialog!' - children: - - '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' - - uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' - summary: The default value for the input text field of prompt dialog - name: defaultValue - fullName: defaultValue - langs: - - typeScript - type: property - syntax: - content: 'defaultValue?: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - name: IDialogShowOptions +### YamlMime:TSType +name: IPromptOptions +uid: '@microsoft/sp-dialog!IPromptOptions:interface' +package: '@microsoft/sp-dialog!' +fullName: IPromptOptions +summary: Options for showing a prompt dialog +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: defaultValue + uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' + package: '@microsoft/sp-dialog!' + fullName: defaultValue + summary: The default value for the input text field of prompt dialog + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'defaultValue?: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index c10c052d..e0ead467 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -1,140 +1,110 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' - summary: >- - This interface handles calls to show a secondary dialog. It's only available by calling - this.secondaryManagerProvider inside a dialog. - remarks: >- - Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has - permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide - until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to - show more secondary dialogs are rejected. +### YamlMime:TSType +name: ISecondaryDialogProvider +uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' +package: '@microsoft/sp-dialog!' +fullName: ISecondaryDialogProvider +summary: >- + This interface handles calls to show a secondary dialog. It's only available + by calling this.secondaryManagerProvider inside a dialog. +remarks: >- + Secondary dialogs do not need to request permission from dialog manager, + because the primary dialog already has permission. Therefore, the secondary + dialog will be immediately shown. This causes the primary dialog to hide until + the secondary dialog is closed. There can be only one secondary dialog at a + time. Additional requests to show more secondary dialogs are rejected. - See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member) for - how to use this. - name: ISecondaryDialogProvider - fullName: ISecondaryDialogProvider - langs: - - typeScript - type: interface + See + [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member) + for how to use this. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: 'alert(message, options)' + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' package: '@microsoft/sp-dialog!' - children: - - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' - - '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' - - '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' - summary: >- - Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that - the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - name: 'alert(message, options)' fullName: 'alert(message, options)' - langs: - - typeScript - type: method + summary: >- + Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.))<!-- -->. The only difference is that the + dialog is immediately shown if there are no other secondary dialogs. + Otherwise, the promise rejects. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'alert(message: string, options?: IAlertOptions): Promise;' - return: - type: - - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' - description: '' parameters: - id: message description: '' - type: - - string + type: string - id: options description: >- - Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for - more information. - type: - - '@microsoft/sp-dialog!IAlertOptions:interface' - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' - summary: >- - Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is - that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - name: 'prompt(message, options)' + Dialog showing options. See + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) + for more information. + type: '' + return: + type: >- + @microsoft/sp-dialog!ISecondaryDialogProvider# + description: '' + - name: 'prompt(message, options)' + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' + package: '@microsoft/sp-dialog!' fullName: 'prompt(message, options)' - langs: - - typeScript - type: method + summary: >- + Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.))<!-- -->. The only difference is that the + dialog is immediately shown if there are no other secondary dialogs. + Otherwise, the promise rejects. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'prompt(message: string, options?: IPromptOptions): Promise;' - return: - type: - - '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt~0:complex' - description: '' parameters: - id: message description: '' - type: - - string + type: string - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: - - '@microsoft/sp-dialog!IPromptOptions:interface' - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' - summary: >- - Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog#show:member(1)). The dialog to show is - passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the - promise rejects. - name: 'show(dialog, options)' + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) + for more information. + type: '' + return: + type: >- + @microsoft/sp-dialog!ISecondaryDialogProvider# + description: '' + - name: 'show(dialog, options)' + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' + package: '@microsoft/sp-dialog!' fullName: 'show(dialog, options)' - langs: - - typeScript - type: method + summary: >- + Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog#))<!-- -->. The dialog to show is passed in as + parameter and the dialog is immediately shown if there are no other + secondary dialogs. Otherwise, the promise rejects. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' - return: - type: - - '@microsoft/sp-dialog!ISecondaryDialogProvider#show~0:complex' - description: '' parameters: - id: dialog description: '' - type: - - '@microsoft/sp-dialog!default:class' + type: '' - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: - - '@microsoft/sp-dialog!IDialogShowOptions:interface' -references: - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!IAlertOptions:interface' - name: IAlertOptions - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!IPromptOptions:interface' - name: IPromptOptions - - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dialog!default:class' - name: BaseDialog - - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' - name: IDialogShowOptions + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) + for more information. + type: '' + return: + type: >- + @microsoft/sp-dialog!ISecondaryDialogProvider# + description: '' diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index fe2ef7e8..3f2694a2 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -1,44 +1,18 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!' - summary: SharePoint Framework support for dynamic data bindings. - remarks: >- - This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and - implement components that use it. - name: '@microsoft/sp-dynamic-data' - fullName: '@microsoft/sp-dynamic-data' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-dynamic-data!DynamicDataReference:class' - - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' -references: - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' - name: DynamicDataReference - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - name: IDynamicDataAnnotatedPropertyValue - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - name: IDynamicDataCallables - - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - name: IDynamicDataEventDefinition - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - name: IDynamicDataPropertyDefinition - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - name: IDynamicDataPropertyMetadata - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - name: IDynamicDataPropertyValueMetadata - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - name: IDynamicDataPropertyValueMetadataCollection - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - name: IDynamicDataSource - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - name: IDynamicDataSourceMetadata +### YamlMime:TSPacakge +uid: '@microsoft/sp-dynamic-data!' +name: '@microsoft/sp-dynamic-data' +type: package +summary: SharePoint Framework support for dynamic data bindings. +classes: + - '@microsoft/sp-dynamic-data!DynamicDataReference:class' +interfaces: + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + - >- + @microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface + - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 250dc6e4..6aec09b5 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -1,84 +1,84 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' - summary: >- - Class that contains the Dynamic Data reference. This includes the source, property, and property path (if - applicable) of Dynamic Data - remarks: |- - The reference string is of the form `:` or `::` +### YamlMime:TSType +name: DynamicDataReference +uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' +package: '@microsoft/sp-dynamic-data!' +fullName: DynamicDataReference +summary: >- + Class that contains the Dynamic Data reference. This includes the source, + property, and property path (if applicable) of Dynamic Data +remarks: >- + The reference string is of the form `:` or + `::` + - Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` - name: DynamicDataReference - fullName: DynamicDataReference - langs: - - typeScript - type: class + Examples of references are: + `WebPart..:myComplexProperty:myArray[0].lastName` +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(reference) + uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' - - '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' - - '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' - - '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' - - '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' - summary: Constructs a new instance of the `DynamicDataReference` class - name: (constructor)(reference) fullName: (constructor)(reference) - langs: - - typeScript - type: constructor + summary: Constructs a new instance of the `DynamicDataReference` class + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(reference: string);' parameters: - id: reference description: '' - type: - - string - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' - summary: Returns the referred property of the Dynamic Data. - name: property + type: string +properties: + - name: property + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' + package: '@microsoft/sp-dynamic-data!' fullName: property - langs: - - typeScript - type: property + summary: Returns the referred property of the Dynamic Data. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly property: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' - summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. - name: propertyPath + type: string + - name: propertyPath + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' + package: '@microsoft/sp-dynamic-data!' fullName: propertyPath - langs: - - typeScript - type: property + summary: >- + Returns the referred property path of the Dynamic Data. Returns undefined + if there is no property path. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly propertyPath: string | undefined;' return: - type: - - string | undefined - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' - summary: Returns the full reference of the Dynamic Data object as a string. - name: reference + type: string | undefined + - name: reference + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' + package: '@microsoft/sp-dynamic-data!' fullName: reference - langs: - - typeScript - type: property + summary: Returns the full reference of the Dynamic Data object as a string. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly reference: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' - summary: Returns the referred id of the Dynamic Data Source. - name: sourceId + type: string + - name: sourceId + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' + package: '@microsoft/sp-dynamic-data!' fullName: sourceId - langs: - - typeScript - type: property + summary: Returns the referred id of the Dynamic Data Source. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly sourceId: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index 08a015b4..9f8cedb1 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -1,42 +1,42 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - summary: >- - Describes the value and the structure of a property value. It contains sample value of the property and the - metadata describing the structure of that value. - name: IDynamicDataAnnotatedPropertyValue - fullName: IDynamicDataAnnotatedPropertyValue - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataAnnotatedPropertyValue +uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataAnnotatedPropertyValue +summary: >- + Describes the value and the structure of a property value. It contains sample + value of the property and the metadata describing the structure of that value. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: metadata + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' - - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' - summary: Metadata describing the sample value of the property. - name: metadata fullName: metadata - langs: - - typeScript - type: property + summary: Metadata describing the sample value of the property. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' - summary: Sample value of a property - name: sampleValue + type: >- + + - name: sampleValue + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member + package: '@microsoft/sp-dynamic-data!' fullName: sampleValue - langs: - - typeScript - type: property + summary: Sample value of a property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'sampleValue: any;' return: - type: - - any -references: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - name: IDynamicDataPropertyValueMetadataCollection + type: any diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index d90f3659..4855a6bf 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -1,155 +1,124 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - summary: >- - Interface for components to implement in order to be dynamic data sources. This can be implemented as an object - with state, or a set of loose functions that returns the data. - name: IDynamicDataCallables - fullName: IDynamicDataCallables - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataCallables +uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataCallables +summary: >- + Interface for components to implement in order to be dynamic data sources. + This can be implemented as an object with state, or a set of loose functions + that returns the data. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: allowedEvents() + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' - summary: |- + fullName: allowedEvents() + summary: >- Returns list of allowed events on the dynamic data source. - When this function returns a non-empty result, then source must define 'sendEvent' api. - If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. + When this function returns a non-empty result, then source must define + 'sendEvent' api. + + + If this api is not defined or returns an empty array, then no consumer + will be able to talk to this source. + remarks: '' isPreview: true - name: allowedEvents() - fullName: allowedEvents() - langs: - - typeScript - type: method + isDeprecated: false syntax: content: 'allowedEvents?(): ReadonlyArray;' return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' + type: >- + @microsoft/sp-dynamic-data!IDynamicDataCallables# description: '' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' - summary: >- - Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls - back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. - name: getAnnotatedPropertyValue(propertyId) + - name: getAnnotatedPropertyValue(propertyId) + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1) + package: '@microsoft/sp-dynamic-data!' fullName: getAnnotatedPropertyValue(propertyId) - langs: - - typeScript - type: method + summary: >- + Given a property id, returns its annotated value. If the source doesn't + supply the annotated value, then it falls back to whatever + 'getPropertyValue' returns as the sample value and metadata would be + undefined. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' - return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue~0:complex' - description: '' + content: >- + getAnnotatedPropertyValue?(propertyId: string): + IDynamicDataAnnotatedPropertyValue | undefined; parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' - summary: Returns all the property definitions that the DataSource will provide. - name: getPropertyDefinitions() + type: string + return: + type: >- + @microsoft/sp-dynamic-data!IDynamicDataCallables# + description: '' + - name: getPropertyDefinitions() + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1) + package: '@microsoft/sp-dynamic-data!' fullName: getPropertyDefinitions() - langs: - - typeScript - type: method + summary: Returns all the property definitions that the DataSource will provide. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' + type: >- + @microsoft/sp-dynamic-data!IDynamicDataCallables# description: '' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' + - name: getPropertyValue(propertyId) + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1) + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyValue(propertyId) summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' - name: getPropertyValue(propertyId) - fullName: getPropertyValue(propertyId) - langs: - - typeScript - type: method + isPreview: false + isDeprecated: false syntax: content: 'getPropertyValue(propertyId: string): any;' - return: - type: - - any - description: '' parameters: - id: propertyId description: '' - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' + type: string + return: + type: any + description: '' + - name: 'sendEvent(eventName, data)' + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: 'sendEvent(eventName, data)' summary: >- - If defined, enables the consumer to send data to the associated dynamic data source. Then source can act - accordingly. + If defined, enables the consumer to send data to the associated dynamic + data source. Then source can act accordingly. - Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + Invoking this api throws an error when the passed in 'eventName' is not + one of the allowed events on the source. + remarks: '' isPreview: true - name: 'sendEvent(eventName, data)' - fullName: 'sendEvent(eventName, data)' - langs: - - typeScript - type: method + isDeprecated: false syntax: content: 'sendEvent?(eventName: string, data: any): void;' - return: - type: - - void - description: '' parameters: - id: eventName description: A case-sensitive string representing the name of the event. - type: - - string + type: string - id: data description: Data to be sent to the dynamic data source. - type: - - any -references: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - name: IDynamicDataEventDefinition - fullName: IDynamicDataEventDefinition - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue~0:complex' - name: IDynamicDataAnnotatedPropertyValue | undefined - fullName: IDynamicDataAnnotatedPropertyValue | undefined - spec.typeScript: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - name: IDynamicDataAnnotatedPropertyValue - fullName: IDynamicDataAnnotatedPropertyValue - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - name: IDynamicDataPropertyDefinition - fullName: IDynamicDataPropertyDefinition - - name: '>' - fullName: '>' + type: any + return: + type: void + description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 00d4b3b1..959f321b 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -1,43 +1,40 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - summary: |- - Definition of an event which a dynamic data source accepts. +### YamlMime:TSType +name: IDynamicDataEventDefinition +uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataEventDefinition +summary: >- + Definition of an event which a dynamic data source accepts. - It includes the name of the event and description to be seen and used by end users. - isPreview: true - name: IDynamicDataEventDefinition - fullName: IDynamicDataEventDefinition - langs: - - typeScript - type: interface + + It includes the name of the event and description to be seen and used by end + users. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' - - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' + fullName: description summary: 'User-friendly, localized description of the event.' + remarks: '' isPreview: true - name: description - fullName: description - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'description?: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' + type: string + - name: name + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' + package: '@microsoft/sp-dynamic-data!' + fullName: name summary: Event name + remarks: '' isPreview: true - name: name - fullName: name - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'name: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 110eb3db..75fca41a 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -1,35 +1,31 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - summary: >- - Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, - localized title and description to be seen and used by end users. - name: IDynamicDataPropertyDefinition - fullName: IDynamicDataPropertyDefinition - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - inheritance: - - type: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' +### YamlMime:TSType +name: IDynamicDataPropertyDefinition +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyDefinition +summary: >- + Definition of a property. It includes the id of the property to be used with + the APIs, along with a user-friendly, localized title and description to be + seen and used by end users. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' - summary: >- - Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or - "time\_in\_24-hour\_clock" - name: id fullName: id - langs: - - typeScript - type: property + summary: >- + Id of the property. This can only contains letters, numbers, dashes and + underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'id: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - name: IDynamicDataPropertyMetadata + type: string +extends: >- + diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index 64e505df..e374ca84 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -1,41 +1,39 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - summary: Metadata of a property - name: IDynamicDataPropertyMetadata - fullName: IDynamicDataPropertyMetadata - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataPropertyMetadata +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyMetadata +summary: Metadata of a property +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' - summary: >- - User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the - current user" - name: description fullName: description - langs: - - typeScript - type: property + summary: >- + User-friendly, localized description of the property. Example: "Contains a + list of ids with the files of the current user" + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'description?: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' - summary: >- - User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current - language) - name: title + type: string + - name: title + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' + package: '@microsoft/sp-dynamic-data!' fullName: title - langs: - - typeScript - type: property + summary: >- + User-friendly, localized title of the property. Example: "My files" / "Mis + archivos" (depending of current language) + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'title: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index a9bf1cc3..0a881408 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -1,33 +1,30 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - summary: Metadata describing the sample value of the property. - name: IDynamicDataPropertyValueMetadata - fullName: IDynamicDataPropertyValueMetadata - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - inheritance: - - type: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' +### YamlMime:TSType +name: IDynamicDataPropertyValueMetadata +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyValueMetadata +summary: Metadata describing the sample value of the property. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: metadata + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' - summary: Metadata describing the sample value of the property. - name: metadata fullName: metadata - langs: - - typeScript - type: property + summary: Metadata describing the sample value of the property. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' -references: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - name: IDynamicDataPropertyMetadata - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - name: IDynamicDataPropertyValueMetadataCollection + type: >- + +extends: >- + diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index c35b62ba..4746b4ed 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -1,81 +1,82 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - summary: >- - A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the - metadata describing the 'key' and its value. - remarks: >- - Important note: +### YamlMime:TSType +name: IDynamicDataPropertyValueMetadataCollection +uid: >- + @microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyValueMetadataCollection +summary: >- + A collection of key value pairs, where 'key' is one of the keys from the + property value object and 'value' is the metadata describing the 'key' and its + value. +remarks: >- + Important note: - 1. Key in the metadata should match the key in the sample value object. + 1. Key in the metadata should match the key in the sample value object. - 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below - example for more details. + 2. For arrays, metadataCollection would be same as describing the element of + the array, only once. See below example for more details. - For example: + For example: - ``` + ``` - case 1: With simple values - Sample Property Id value - { - firstName: 'Bob', - lastName: 'Smith', - age: 30 + case 1: With simple values + Sample Property Id value - { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + } + + MetadataCollection for the above object would be - + metadataCollection: { + 'firstName': { title: 'First Name' }, + 'lastName': { title: 'Last Name' }, + 'age': { title: 'Age' } + } + + Case 2: With complex values + Sample Property Id value - { + person: { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + }, + visitedLocations: [ + { + city: 'Redmond', + state: 'WA' + }, + { + city: 'New York City', + state: 'NY' } + ] + } - MetadataCollection for the above object would be - + MetadataCollection for the above object would be - + metadataCollection: { + 'person': { + title: 'Person', metadataCollection: { 'firstName': { title: 'First Name' }, 'lastName': { title: 'Last Name' }, 'age': { title: 'Age' } } - - Case 2: With complex values - Sample Property Id value - { - person: { - firstName: 'Bob', - lastName: 'Smith', - age: 30 - }, - visitedLocations: [ - { - city: 'Redmond', - state: 'WA' - }, - { - city: 'New York City', - state: 'NY' - } - ] - } - - MetadataCollection for the above object would be - + }, + 'vistedLocations': { + title: 'Visted Locations', metadataCollection: { - 'person': { - title: 'Person', - metadataCollection: { - 'firstName': { title: 'First Name' }, - 'lastName': { title: 'Last Name' }, - 'age': { title: 'Age' } - } - }, - 'vistedLocations': { - title: 'Visted Locations', - metadataCollection: { - 'city': { title: 'City' }, - 'state': { title: 'State' } - } - } + 'city': { title: 'City' }, + 'state': { title: 'State' } } + } + } - ``` - name: IDynamicDataPropertyValueMetadataCollection - fullName: IDynamicDataPropertyValueMetadataCollection - langs: - - typeScript - type: interface - package: '@microsoft/sp-dynamic-data!' + ``` +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index ead6663c..6c90b904 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -1,290 +1,229 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - summary: >- - Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API - to get the data. - name: IDynamicDataSource - fullName: IDynamicDataSource - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataSource +uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataSource +summary: >- + Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to + identify the data sources and API to get the data. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' + package: '@microsoft/sp-dynamic-data!' + fullName: id + summary: Id of the Dynamic Data Source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: metadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' + package: '@microsoft/sp-dynamic-data!' + fullName: metadata + summary: Metadata of the Dynamic Data Source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'metadata: IDynamicDataSourceMetadata;' + return: + type: >- + +methods: + - name: allowedEventsAsync() + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' - - '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' + fullName: allowedEventsAsync() summary: >- - Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source - must define 'sendData' api. + Returns list of allowed events on the dynamic data source. When this api + returns a non-empty result, then source must define 'sendData' api. - If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. + If this api is not defined or returns an empty map, then no consumer will + be able to talk to this source. + remarks: '' isPreview: true - name: allowedEventsAsync() - fullName: allowedEventsAsync() - langs: - - typeScript - type: method + isDeprecated: false syntax: - content: 'allowedEventsAsync?(): Promise>;' + content: >- + allowedEventsAsync?(): + Promise>; return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' + type: >- + @microsoft/sp-dynamic-data!IDynamicDataSource# description: '' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' - summary: >- - Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls - back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. - deprecated: - content: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' - name: getAnnotatedPropertyValue(propertyId) + - name: getAnnotatedPropertyValue(propertyId) + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1) + package: '@microsoft/sp-dynamic-data!' fullName: getAnnotatedPropertyValue(propertyId) - langs: - - typeScript - type: method + summary: >- + Given a property id, returns its annotated value. If the source doesn't + supply the annotated value, then it falls back to whatever + 'getPropertyValue' as the sample value and metadata would be undefined. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + - This API is deprecated. Please use the asynchronous version + `getAsyncAnnotatedPropertyValue` syntax: - content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' - return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - description: '' + content: >- + getAnnotatedPropertyValue(propertyId: string): + IDynamicDataAnnotatedPropertyValue; parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' - summary: >- - Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls - back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. - name: getAnnotatedPropertyValueAsync(propertyId) - fullName: getAnnotatedPropertyValueAsync(propertyId) - langs: - - typeScript - type: method - syntax: - content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise;' + type: string return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync~0:complex' + type: >- + description: '' + - name: getAnnotatedPropertyValueAsync(propertyId) + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1) + package: '@microsoft/sp-dynamic-data!' + fullName: getAnnotatedPropertyValueAsync(propertyId) + summary: >- + Given a property id, returns its annotated value. If the source doesn't + supply the annotated value, then it falls back to whatever + 'getPropertyValue' as the sample value and metadata would be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + getAnnotatedPropertyValueAsync(propertyId: string): + Promise; parameters: - id: propertyId description: Property id for which the value is requested. - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' - summary: >- - Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the - component. - deprecated: - content: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' - name: getPropertyDefinitions() + type: string + return: + type: >- + @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' + - name: getPropertyDefinitions() + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1) + package: '@microsoft/sp-dynamic-data!' fullName: getPropertyDefinitions() - langs: - - typeScript - type: method + summary: >- + Returns all the property definitions for dynamic data. This needs to be + overriden by the implementation of the component. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + - This API is deprecated. Please use the asynchronous version + `getPropertyDefinitionsAsync` syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' + type: >- + @microsoft/sp-dynamic-data!IDynamicDataSource# description: '' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' - summary: >- - Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the - component. - name: getPropertyDefinitionsAsync() + - name: getPropertyDefinitionsAsync() + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1) + package: '@microsoft/sp-dynamic-data!' fullName: getPropertyDefinitionsAsync() - langs: - - typeScript - type: method + summary: >- + Returns all the property definitions for dynamic data. This needs to be + overriden by the implementation of the component. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'getPropertyDefinitionsAsync(): Promise>;' + content: >- + getPropertyDefinitionsAsync(): + Promise>; return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync~0:complex' + type: >- + @microsoft/sp-dynamic-data!IDynamicDataSource# description: '' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' - summary: >- - Given a property id, returns the value of the property. This needs to be overriden by the implementation of the - component. - deprecated: - content: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' - name: getPropertyValue(propertyId) + - name: getPropertyValue(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' + package: '@microsoft/sp-dynamic-data!' fullName: getPropertyValue(propertyId) - langs: - - typeScript - type: method + summary: >- + Given a property id, returns the value of the property. This needs to be + overriden by the implementation of the component. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + - This API is deprecated. Please use the asynchronous version + `getAsyncPropertyValue` syntax: content: 'getPropertyValue(propertyId: string): any;' - return: - type: - - any - description: '' parameters: - id: propertyId description: Property id for which the value is requested. - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' - summary: >- - Given a property id, returns the value of the property. This needs to be overriden by the implementation of the - component. - name: getPropertyValueAsync(propertyId) + type: string + return: + type: any + description: '' + - name: getPropertyValueAsync(propertyId) + uid: >- + @microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1) + package: '@microsoft/sp-dynamic-data!' fullName: getPropertyValueAsync(propertyId) - langs: - - typeScript - type: method + summary: >- + Given a property id, returns the value of the property. This needs to be + overriden by the implementation of the component. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getPropertyValueAsync(propertyId: string): Promise;' - return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync~0:complex' - description: '' parameters: - id: propertyId description: Property id for which the value is requested. - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' - summary: Id of the Dynamic Data Source. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'id: string;' - return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' - summary: Metadata of the Dynamic Data Source. - name: metadata - fullName: metadata - langs: - - typeScript - type: property - syntax: - content: 'metadata: IDynamicDataSourceMetadata;' + type: string return: - type: - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' + type: >- + @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' + - name: 'sendEvent(eventName, data)' + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: 'sendEvent(eventName, data)' summary: >- - If defined, enables the consumer to send data to the associated dynamic data source. Then source can act - accordingly. + If defined, enables the consumer to send data to the associated dynamic + data source. Then source can act accordingly. - Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + Invoking this api throws an error when the passed in 'eventName' is not + one of the allowed events on the source. + remarks: '' isPreview: true - name: 'sendEvent(eventName, data)' - fullName: 'sendEvent(eventName, data)' - langs: - - typeScript - type: method + isDeprecated: false syntax: content: 'sendEvent?(eventName: string, data: any): void;' - return: - type: - - void - description: '' parameters: - id: eventName description: A case-sensitive string representing the name of the event. - type: - - string + type: string - id: data description: Data to be sent to the dynamic data source. - type: - - any -references: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' - name: Promise> - fullName: Promise> - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - name: IDynamicDataEventDefinition - fullName: IDynamicDataEventDefinition - - name: '>>' - fullName: '>>' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - name: IDynamicDataAnnotatedPropertyValue - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - name: IDynamicDataAnnotatedPropertyValue - fullName: IDynamicDataAnnotatedPropertyValue - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - name: IDynamicDataPropertyDefinition - fullName: IDynamicDataPropertyDefinition - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync~0:complex' - name: Promise> - fullName: Promise> - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - name: IDynamicDataPropertyDefinition - fullName: IDynamicDataPropertyDefinition - - name: '>>' - fullName: '>>' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - name: IDynamicDataSourceMetadata + type: any + return: + type: void + description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 7486b33c..6badb0b0 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -1,85 +1,86 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' - summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. - name: IDynamicDataSourceMetadata - fullName: IDynamicDataSourceMetadata - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataSourceMetadata +uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataSourceMetadata +summary: >- + Metadata of the Dynamic Data Source. It allows consumers to easily distinguish + Dynamic Data Sources. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: alias + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' package: '@microsoft/sp-dynamic-data!' - children: - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' - summary: >- - Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come - from a component, for example framework level data sources. - name: alias fullName: alias - langs: - - typeScript - type: property + summary: >- + Alias of the component that the Dynamic Data Source refers to. It can be + undefined when the sources doesn't come from a component, for example + framework level data sources. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'alias?: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' - summary: >- - Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from - a component, for example framework level data sources. - name: componentId + type: string + - name: componentId + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' + package: '@microsoft/sp-dynamic-data!' fullName: componentId - langs: - - typeScript - type: property + summary: >- + Id of the component that the Dynamic Data Source refers to. It can be + undefined when the sources doesn't come from a component, for example + framework level data sources. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'componentId?: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' - summary: 'User-friendly, localized description of the Dynamic Data Source.' - name: description + type: string + - name: description + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' + package: '@microsoft/sp-dynamic-data!' fullName: description - langs: - - typeScript - type: property + summary: 'User-friendly, localized description of the Dynamic Data Source.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'description?: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' + type: string + - name: instanceId + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' + package: '@microsoft/sp-dynamic-data!' + fullName: instanceId summary: >- - Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for - example, between two web parts with the same type. It can be undefined when the sources doesn't come from a + Id of the instance of the component that the Dynamic Data Source refers + to. This allows to distinguish, for example, between two web parts with + the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - name: instanceId - fullName: instanceId - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'instanceId?: string;' return: - type: - - string - - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' - summary: >- - User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. - By default it's the alias of the component. - name: title + type: string + - name: title + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' + package: '@microsoft/sp-dynamic-data!' fullName: title - langs: - - typeScript - type: property + summary: >- + User-friendly, localized title of the Dynamic Data Source. This can be + customized by the component it refers to. By default it's the alias of the + component. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'title: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index 95d38cc3..67746770 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -1,17 +1,8 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-extension-base!' - summary: SharePoint Framework support for building client-side extensions. - name: '@microsoft/sp-extension-base' - fullName: '@microsoft/sp-extension-base' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-extension-base!BaseExtension:class' - - '@microsoft/sp-extension-base!ExtensionContext:class' -references: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - name: ExtensionContext +### YamlMime:TSPacakge +uid: '@microsoft/sp-extension-base!' +name: '@microsoft/sp-extension-base' +type: package +summary: SharePoint Framework support for building client-side extensions. +classes: + - '@microsoft/sp-extension-base!BaseExtension:class' + - '@microsoft/sp-extension-base!ExtensionContext:class' diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index d7a4ed52..518e8461 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -1,80 +1,71 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - summary: The base class for all client-side extensions. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseExtension` class. - name: BaseExtension - fullName: BaseExtension - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-component-base!BaseComponent:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponent:class' - package: '@microsoft/sp-extension-base!' - children: - - '@microsoft/sp-extension-base!BaseExtension#context:member' - - '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' - - '@microsoft/sp-extension-base!BaseExtension#properties:member' - - uid: '@microsoft/sp-extension-base!BaseExtension#context:member' - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'protected readonly context: ExtensionContext;' - return: - type: - - '@microsoft/sp-extension-base!default:class' - - uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' - summary: This event method is called when the client-side extension is first activated on the page. - name: onInit() - fullName: onInit() - langs: - - typeScript - type: method - syntax: - content: 'protected onInit(): Promise;' - return: - type: - - '@microsoft/sp-extension-base!BaseExtension#onInit~0:complex' - description: '' - - uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' - summary: Extension properties is a JavaScript object that are passed in by the application that initializes the extension. - remarks: >- - Properties can be used in the extension code to define configurable behaviors. The application has control over - what properties to provide to an instance of the extension, however the most common way would be to have it stored - on the server as JSON and pass it as is to the extension on initialization. - name: properties - fullName: properties - langs: - - typeScript - type: property - syntax: - content: 'protected readonly properties: TProperties;' - return: - type: - - TProperties -references: - - uid: '@microsoft/sp-component-base!BaseComponent:class' - name: BaseComponent - - uid: '@microsoft/sp-extension-base!default:class' - name: ExtensionContext - - uid: '@microsoft/sp-extension-base!BaseExtension#onInit~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: +### YamlMime:TSType +name: BaseExtension +uid: '@microsoft/sp-extension-base!BaseExtension:class' +package: '@microsoft/sp-extension-base!' +fullName: BaseExtension +summary: The base class for all client-side extensions. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `BaseExtension` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-extension-base!BaseExtension#context:member' + package: '@microsoft/sp-extension-base!' + fullName: context + summary: >- + Use the context object to access common services and state associated with + the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly context: ExtensionContext;' + return: + type: '' + - name: properties + uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' + package: '@microsoft/sp-extension-base!' + fullName: properties + summary: >- + Extension properties is a JavaScript object that are passed in by the + application that initializes the extension. + remarks: >- + Properties can be used in the extension code to define configurable + behaviors. The application has control over what properties to provide to + an instance of the extension, however the most common way would be to have + it stored on the server as JSON and pass it as is to the extension on + initialization. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly properties: TProperties;' + return: + type: TProperties +methods: + - name: onInit() + uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' + package: '@microsoft/sp-extension-base!' + fullName: onInit() + summary: >- + This event method is called when the client-side extension is first + activated on the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onInit(): Promise;' + return: + type: >- + @microsoft/sp-extension-base!BaseExtension# + description: '' +extends: '' diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 1c7a0a04..8ebac63f 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -1,20 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - summary: The base class for context objects for client-side extensions. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ExtensionContext` class. - name: ExtensionContext - fullName: ExtensionContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-component-base!BaseComponentContext:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponentContext:class' - package: '@microsoft/sp-extension-base!' -references: - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext +### YamlMime:TSType +name: ExtensionContext +uid: '@microsoft/sp-extension-base!ExtensionContext:class' +package: '@microsoft/sp-extension-base!' +fullName: ExtensionContext +summary: The base class for context objects for client-side extensions. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `ExtensionContext` class. +isPreview: false +isDeprecated: false +type: class +extends: '' diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 9d049446..7f890040 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -1,132 +1,47 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!' - summary: Base communication layer for the SharePoint Framework - remarks: >- - This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles - authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that - follow the recommended best practices. - name: '@microsoft/sp-http' - fullName: '@microsoft/sp-http' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-http!AadHttpClient:class' - - '@microsoft/sp-http!AadHttpClientConfiguration:class' - - '@microsoft/sp-http!AadHttpClientFactory:class' - - '@microsoft/sp-http!AadTokenProvider:class' - - '@microsoft/sp-http!AadTokenProviderFactory:class' - - '@microsoft/sp-http!DigestCache:class' - - '@microsoft/sp-http!GraphRequest:interface' - - '@microsoft/sp-http!HttpClient:class' - - '@microsoft/sp-http!HttpClientConfiguration:class' - - '@microsoft/sp-http!HttpClientResponse:class' - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - - '@microsoft/sp-http!IAadHttpClientOptions:interface' - - '@microsoft/sp-http!IAadTokenProvider:interface' - - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - - '@microsoft/sp-http!IDigestCache:interface' - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - - '@microsoft/sp-http!IHttpClientConfigurations:interface' - - '@microsoft/sp-http!IHttpClientOptions:interface' - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - - '@microsoft/sp-http!ISPHttpClientOptions:interface' - - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' - - '@microsoft/sp-http!MSGraphClient:class' - - '@microsoft/sp-http!MSGraphClientFactory:class' - - '@microsoft/sp-http!ODataVersion:class' - - '@microsoft/sp-http!SPHttpClient:class' - - '@microsoft/sp-http!SPHttpClientBatch:class' - - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - - '@microsoft/sp-http!SPHttpClientConfiguration:class' - - '@microsoft/sp-http!SPHttpClientResponse:class' - - '@microsoft/sp-http!SPHttpHeader:enum' - - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' -references: - - uid: '@microsoft/sp-http!AadHttpClient:class' - name: AadHttpClient - - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' - name: AadHttpClientConfiguration - - uid: '@microsoft/sp-http!AadHttpClientFactory:class' - name: AadHttpClientFactory - - uid: '@microsoft/sp-http!AadTokenProvider:class' - name: AadTokenProvider - - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' - name: AadTokenProviderFactory - - uid: '@microsoft/sp-http!DigestCache:class' - name: DigestCache - - uid: '@microsoft/sp-http!GraphRequest:interface' - name: GraphRequest - - uid: '@microsoft/sp-http!HttpClient:class' - name: HttpClient - - uid: '@microsoft/sp-http!HttpClientConfiguration:class' - name: HttpClientConfiguration - - uid: '@microsoft/sp-http!HttpClientResponse:class' - name: HttpClientResponse - - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - name: IAadHttpClientConfiguration - - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - name: IAadHttpClientConfigurations - - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' - name: IAadHttpClientOptions - - uid: '@microsoft/sp-http!IAadTokenProvider:interface' - name: IAadTokenProvider - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - name: IAadTokenProviderConfiguration - - uid: '@microsoft/sp-http!IDigestCache:interface' - name: IDigestCache - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfiguration - - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' - name: IHttpClientConfigurations - - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - name: IHttpClientOptions - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - name: ISPHttpClientBatchConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - name: ISPHttpClientBatchConfigurations - - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - name: ISPHttpClientBatchCreationOptions - - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - name: ISPHttpClientBatchOptions - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - name: ISPHttpClientCommonConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - name: ISPHttpClientConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - name: ISPHttpClientConfigurations - - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' - name: ISPHttpClientOptions - - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' - name: ITokenAcquisitionEventArgs - - uid: '@microsoft/sp-http!MSGraphClient:class' - name: MSGraphClient - - uid: '@microsoft/sp-http!MSGraphClientFactory:class' - name: MSGraphClientFactory - - uid: '@microsoft/sp-http!ODataVersion:class' - name: ODataVersion - - uid: '@microsoft/sp-http!SPHttpClient:class' - name: SPHttpClient - - uid: '@microsoft/sp-http!SPHttpClientBatch:class' - name: SPHttpClientBatch - - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - name: SPHttpClientBatchConfiguration - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - name: SPHttpClientCommonConfiguration - - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' - name: SPHttpClientConfiguration - - uid: '@microsoft/sp-http!SPHttpClientResponse:class' - name: SPHttpClientResponse - - uid: '@microsoft/sp-http!SPHttpHeader:enum' - name: SPHttpHeader - - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' - name: TokenAcquisitionEventArgs +### YamlMime:TSPacakge +uid: '@microsoft/sp-http!' +name: '@microsoft/sp-http' +type: package +summary: Base communication layer for the SharePoint Framework +classes: + - '@microsoft/sp-http!AadHttpClient:class' + - '@microsoft/sp-http!AadHttpClientConfiguration:class' + - '@microsoft/sp-http!AadHttpClientFactory:class' + - '@microsoft/sp-http!AadTokenProvider:class' + - '@microsoft/sp-http!AadTokenProviderFactory:class' + - '@microsoft/sp-http!DigestCache:class' + - '@microsoft/sp-http!HttpClient:class' + - '@microsoft/sp-http!HttpClientConfiguration:class' + - '@microsoft/sp-http!HttpClientResponse:class' + - '@microsoft/sp-http!MSGraphClient:class' + - '@microsoft/sp-http!MSGraphClientFactory:class' + - '@microsoft/sp-http!ODataVersion:class' + - '@microsoft/sp-http!SPHttpClient:class' + - '@microsoft/sp-http!SPHttpClientBatch:class' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + - '@microsoft/sp-http!SPHttpClientConfiguration:class' + - '@microsoft/sp-http!SPHttpClientResponse:class' + - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' +interfaces: + - '@microsoft/sp-http!GraphRequest:interface' + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - '@microsoft/sp-http!IAadHttpClientOptions:interface' + - '@microsoft/sp-http!IAadTokenProvider:interface' + - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - '@microsoft/sp-http!IDigestCache:interface' + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - '@microsoft/sp-http!IHttpClientConfigurations:interface' + - '@microsoft/sp-http!IHttpClientOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' +enums: + - '@microsoft/sp-http!SPHttpHeader:enum' diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 992e27d2..ec1bde7a 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -1,204 +1,145 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!AadHttpClient:class' - summary: AadHttpClient is used to perform REST calls against an Azure AD Application. - remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. +### YamlMime:TSType +name: AadHttpClient +uid: '@microsoft/sp-http!AadHttpClient:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClient +summary: AadHttpClient is used to perform REST calls against an Azure AD Application. +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. - For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class - instead. For communicating with Microsoft Graph, use the - [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. - name: AadHttpClient - fullName: AadHttpClient - langs: - - typeScript - type: class + For communicating with SharePoint, use the + [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. For + communicating with Microsoft Graph, use the + [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(serviceScope, resourceEndpoint, options)' + uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!AadHttpClient:constructor(1)' - - '@microsoft/sp-http!AadHttpClient.configurations:member' - - '@microsoft/sp-http!AadHttpClient#fetch:member(1)' - - '@microsoft/sp-http!AadHttpClient#get:member(1)' - - '@microsoft/sp-http!AadHttpClient#post:member(1)' - - uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' - summary: Constructs a new instance of the `AadHttpClient` class - name: '(constructor)(serviceScope, resourceEndpoint, options)' fullName: '(constructor)(serviceScope, resourceEndpoint, options)' - langs: - - typeScript - type: constructor + summary: Constructs a new instance of the `AadHttpClient` class + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);' + content: >- + constructor(serviceScope: ServiceScope, resourceEndpoint: string, + options?: IAadHttpClientOptions); parameters: - id: serviceScope - description: The service scope is needed to retrieve some of the class's internal components. - type: - - '@microsoft/sp-core-library!ServiceScope:class' + description: >- + The service scope is needed to retrieve some of the class's internal + components. + type: '' - id: resourceEndpoint description: '' - type: - - string + type: string - id: options description: Configuration options for the request to get an access token. - type: - - '@microsoft/sp-http!IAadHttpClientOptions:interface' - - uid: '@microsoft/sp-http!AadHttpClient.configurations:member' - summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. - name: configurations + type: '' +properties: + - name: configurations + uid: '@microsoft/sp-http!AadHttpClient.configurations:member' + package: '@microsoft/sp-http!' fullName: configurations - langs: - - typeScript - type: property + summary: >- + The standard predefined AadHttpClientConfiguration objects for use with + the AadHttpClient class. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'static readonly configurations: IAadHttpClientConfigurations;' return: - type: - - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - - uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' + type: >- + +methods: + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' summary: Performs a REST service call. remarks: >- - Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for - HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: + Although the AadHttpClient subclass adds additional enhancements, the + parameters and semantics for HttpClient.fetch() are essentially the same + as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - name: 'fetch(url, configuration, options)' - fullName: 'fetch(url, configuration, options)' - langs: - - typeScript - type: method + isPreview: false + isDeprecated: false syntax: content: >- - fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!AadHttpClient#fetch~0:complex' - description: A promise that will return the result. + fetch(url: string, configuration: AadHttpClientConfiguration, options: + IHttpClientOptions): Promise; parameters: - id: url description: The endpoint URL that fetch will be called on. - type: - - string + type: string - id: configuration description: >- - Determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations. - type: - - '@microsoft/sp-http!default:class' + Determines the default behavior of HttpClient; normally this should + be the latest version number from HttpClientConfigurations. + type: '' - id: options description: Additional options that affect the request. - type: - - '@microsoft/sp-http!IHttpClientOptions:interface' - - uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' - summary: 'Calls fetch(), but sets the method to "GET".' - name: 'get(url, configuration, options)' + type: '' + return: + type: '@microsoft/sp-http!AadHttpClient#' + description: A promise that will return the result. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' + package: '@microsoft/sp-http!' fullName: 'get(url, configuration, options)' - langs: - - typeScript - type: method + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!AadHttpClient#get~0:complex' - description: A promise that will return the result. + get(url: string, configuration: AadHttpClientConfiguration, options?: + IHttpClientOptions): Promise; parameters: - id: url description: The endpoint URL that fetch will be called on. - type: - - string + type: string - id: configuration description: >- - Determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations. - type: - - '@microsoft/sp-http!default:class' + Determines the default behavior of HttpClient; normally this should + be the latest version number from HttpClientConfigurations. + type: '' - id: options description: Additional options that affect the request. - type: - - '@microsoft/sp-http!IHttpClientOptions:interface' - - uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' - summary: 'Calls fetch(), but sets the method to "POST".' - name: 'post(url, configuration, options)' + type: '' + return: + type: '@microsoft/sp-http!AadHttpClient#' + description: A promise that will return the result. + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' + package: '@microsoft/sp-http!' fullName: 'post(url, configuration, options)' - langs: - - typeScript - type: method + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!AadHttpClient#post~0:complex' - description: A promise that will return the result. + post(url: string, configuration: AadHttpClientConfiguration, options: + IHttpClientOptions): Promise; parameters: - id: url description: The endpoint URL that fetch will be called on. - type: - - string + type: string - id: configuration description: >- - Determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations. - type: - - '@microsoft/sp-http!default:class' + Determines the default behavior of HttpClient; normally this should + be the latest version number from HttpClientConfigurations. + type: '' - id: options description: Additional options that affect the request. - type: - - '@microsoft/sp-http!IHttpClientOptions:interface' -references: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' - name: IAadHttpClientOptions - - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - name: IAadHttpClientConfigurations - - uid: '@microsoft/sp-http!AadHttpClient#fetch~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!default:class' - name: AadHttpClientConfiguration - - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - name: IHttpClientOptions - - uid: '@microsoft/sp-http!AadHttpClient#get~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!AadHttpClient#post~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - fullName: default - - name: '>' - fullName: '>' + type: '' + return: + type: '@microsoft/sp-http!AadHttpClient#' + description: A promise that will return the result. diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index a3837b75..db528a30 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -1,80 +1,82 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' - summary: Configuration for HttpClient. - remarks: >- - The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the - predefined defaults from HttpClientConfigurations, however switches can also be changed via the - HttpClientConfiguration.overrideWith() method. - name: AadHttpClientConfiguration - fullName: AadHttpClientConfiguration - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-http!default:class' - inheritance: - - type: '@microsoft/sp-http!default:class' - implements: - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' +### YamlMime:TSType +name: AadHttpClientConfiguration +uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClientConfiguration +summary: Configuration for HttpClient. +remarks: >- + The HttpClientConfiguration object provides a set of switches for + enabling/disabling various features of the HttpClient class. Normally these + switches are set (e.g. when calling HttpClient.fetch()) by providing one of + the predefined defaults from HttpClientConfigurations, however switches can + also be changed via the HttpClientConfiguration.overrideWith() method. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' - - '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' - - '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' - - uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' - summary: >- - Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for - any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: '(constructor)(flags, overrideFlags)' fullName: '(constructor)(flags, overrideFlags)' - langs: - - typeScript - type: constructor + summary: >- + Constructs a new instance of HttpClientConfiguration with the specified + flags. The default values will be used for any flags that are missing or + undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' + content: >- + constructor(flags: IAadHttpClientConfiguration, overrideFlags?: + IAadHttpClientConfiguration); parameters: - id: flags description: '' - type: - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + type: >- + - id: overrideFlags description: '' - type: - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' - name: flags + type: >- + +properties: + - name: flags + uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' + package: '@microsoft/sp-http!' fullName: flags - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected flags: IAadHttpClientConfiguration;' return: - type: - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' - name: overrideWith(sourceFlags) + type: >- + +methods: + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' fullName: overrideWith(sourceFlags) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: |- + content: >- /** @override */ - overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' + + overrideWith(sourceFlags: IAadHttpClientConfiguration): + AadHttpClientConfiguration; parameters: - id: sourceFlags description: '' - type: - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' -references: - - uid: '@microsoft/sp-http!default:class' - name: HttpClientConfiguration - - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - name: IAadHttpClientConfiguration + type: >- + + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index c19e4e03..618e854d 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -1,79 +1,55 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!AadHttpClientFactory:class' - summary: >- - Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: - [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AadHttpClientFactory` class. - name: AadHttpClientFactory - fullName: AadHttpClientFactory - langs: - - typeScript - type: class +### YamlMime:TSType +name: AadHttpClientFactory +uid: '@microsoft/sp-http!AadHttpClientFactory:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClientFactory +summary: >- + Returns a preinitialized version of the AadHttpClient for a given resource + url. For more information: [.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `AadHttpClientFactory` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: serviceKey + uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for AadHttpClientFactory. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + @microsoft/sp-http!AadHttpClientFactory. +methods: + - name: getClient(resourceEndpoint) + uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' - - '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' - - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' - summary: >- - Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service - Principal. - name: getClient(resourceEndpoint) fullName: getClient(resourceEndpoint) - langs: - - typeScript - type: method + summary: >- + Returns an instance of the AadHttpClient that communicates with the + current tenant's configurable Service Principal. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getClient(resourceEndpoint: string): Promise;' - return: - type: - - '@microsoft/sp-http!AadHttpClientFactory#getClient~0:complex' - description: '' parameters: - id: resourceEndpoint description: The target AAD application's resource endpoint. - type: - - string - - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' - summary: The service key for AadHttpClientFactory. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' + type: string return: - type: - - '@microsoft/sp-http!AadHttpClientFactory.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: AadHttpClient - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: AadHttpClientFactory - fullName: default - - name: '>' - fullName: '>' + type: >- + @microsoft/sp-http!AadHttpClientFactory# + description: '' diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 9f9b6f7e..6f83fe8d 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -1,91 +1,70 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!AadTokenProvider:class' - summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. +### YamlMime:TSType +name: AadTokenProvider +uid: '@microsoft/sp-http!AadTokenProvider:class' +package: '@microsoft/sp-http!' +fullName: AadTokenProvider +summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. - remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. + OAuth2 tokens are used to authenticate the user from the SharePoint page to + other services such as PowerBI, Sway, Exchange, Yammer, etc. +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AadTokenProvider` class. - name: AadTokenProvider - fullName: AadTokenProvider - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-http!IAadTokenProvider:interface' + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `AadTokenProvider` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: tokenAcquisitionEvent + uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' - - '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' - - uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' - summary: |- - Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. - - The OAuth2 token should not be cached by the caller since it is already cached by the method itself. - name: 'getToken(resourceEndpoint, useCachedToken)' - fullName: 'getToken(resourceEndpoint, useCachedToken)' - langs: - - typeScript - type: method + fullName: tokenAcquisitionEvent + summary: Notifies the developer when Token Acquisition requires user action. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' + content: 'readonly tokenAcquisitionEvent: SPEvent;' return: - type: - - '@microsoft/sp-http!AadTokenProvider#getToken~0:complex' - description: A promise that will be fullfiled with the token or that will reject with an error message + type: >- + @microsoft/sp-http!AadTokenProvider# +methods: + - name: 'getToken(resourceEndpoint, useCachedToken)' + uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' + package: '@microsoft/sp-http!' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + summary: >- + Fetches the AAD OAuth2 token for a resource if the user that's currently + logged in has access to that resource. + + + The OAuth2 token should not be cached by the caller since it is already + cached by the method itself. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + getToken(resourceEndpoint: string, useCachedToken?: boolean): + Promise; parameters: - id: resourceEndpoint description: the resource for which the token should be obtained - type: - - string + type: string - id: useCachedToken description: >- - Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would - be https://graph.microsoft.com - type: - - boolean - - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' - summary: Notifies the developer when Token Acquisition requires user action. - name: tokenAcquisitionEvent - fullName: tokenAcquisitionEvent - langs: - - typeScript - type: event - syntax: - content: 'readonly tokenAcquisitionEvent: SPEvent;' + Allows the developer to specify if cached tokens should be returned. + An example of a resourceEndpoint would be + https://graph.microsoft.com + type: boolean return: - type: - - '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent~0:complex' -references: - - uid: '@microsoft/sp-http!IAadTokenProvider:interface' - name: IAadTokenProvider - - uid: '@microsoft/sp-http!AadTokenProvider#getToken~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent~0:complex' - name: SPEvent - fullName: SPEvent - spec.typeScript: - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - fullName: SPEvent - - name: < - fullName: < - - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' - name: TokenAcquisitionEventArgs - fullName: TokenAcquisitionEventArgs - - name: '>' - fullName: '>' + type: '@microsoft/sp-http!AadTokenProvider#' + description: >- + A promise that will be fullfiled with the token or that will reject + with an error message diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 4fa9c796..8a518f86 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -1,69 +1,43 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' - summary: Returns a preinitialized version of the AadTokenProviderFactory. - name: AadTokenProviderFactory - fullName: AadTokenProviderFactory - langs: - - typeScript - type: class +### YamlMime:TSType +name: AadTokenProviderFactory +uid: '@microsoft/sp-http!AadTokenProviderFactory:class' +package: '@microsoft/sp-http!' +fullName: AadTokenProviderFactory +summary: Returns a preinitialized version of the AadTokenProviderFactory. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: serviceKey + uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for AadTokenProviderFactory. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + @microsoft/sp-http!AadTokenProviderFactory. +methods: + - name: getTokenProvider() + uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' - - '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' - - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' - summary: >- - Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service - Principal. - name: getTokenProvider() fullName: getTokenProvider() - langs: - - typeScript - type: method + summary: >- + Returns an instance of the AadTokenProvider that communicates with the + current tenant's configurable Service Principal. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getTokenProvider(): Promise;' return: - type: - - '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider~0:complex' + type: >- + @microsoft/sp-http!AadTokenProviderFactory# description: '' - - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' - summary: The service key for AadTokenProviderFactory. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-http!AadTokenProviderFactory.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: AadTokenProvider - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: AadTokenProviderFactory - fullName: default - - name: '>' - fullName: '>' diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 127bf9ed..f2087996 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -1,169 +1,147 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!DigestCache:class' - summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb - URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, - specified via the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, - and expires after a server configurable amount of time. +### YamlMime:TSType +name: DigestCache +uid: '@microsoft/sp-http!DigestCache:class' +package: '@microsoft/sp-http!' +fullName: DigestCache +summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache + of request digests for each SPWeb URL. A request digest is a security token + that the SharePoint server requires for for any REST write operation, + specified via the "X-RequestDigest" HTTP header. It is obtained by calling the + "/\_api/contextinfo" REST endpoint, and expires after a server configurable + amount of time. - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) - name: DigestCache - fullName: DigestCache - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-http!IDigestCache:interface' + For more information, see the MSDN article ["Complete basic operations using + SharePoint 2013 REST endpoints"](.microsoft.com/en-us/library/office/jj164022.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-http!DigestCache:constructor(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!DigestCache:constructor(1)' - - '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' - - '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' - - '@microsoft/sp-http!DigestCache#clearDigest:member(1)' - - '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' - - '@microsoft/sp-http!DigestCache.serviceKey:member' - - uid: '@microsoft/sp-http!DigestCache:constructor(1)' - summary: Constructs a new instance of the `DigestCache` class - name: (constructor)(serviceScope) fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor + summary: Constructs a new instance of the `DigestCache` class + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: - - '@microsoft/sp-core-library!ServiceScope:class' - - uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-http!DigestCache.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for IDigestCache. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: '@microsoft/sp-http!DigestCache.' +methods: + - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' + package: '@microsoft/sp-http!' + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' summary: >- - Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will - automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios + Inserts a specific request digest value into the cache. Normally this is + unnecessary because the framework will automatically issue a REST request + to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - langs: - - typeScript - type: method + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' - return: - type: - - void - description: '' + content: >- + addDigestToCache(webUrl: string, digestValue: string, + expirationTimestamp: number): void; parameters: - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: - - string + description: >- + The URL of the SPWeb that the API call will be issued to. This may + be a server-relative or absolute URL. + type: string - id: digestValue description: >- - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look - something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" - type: - - string + The digest value, which is an opaque that must be generated by the + SharePoint server. The syntax will look something like this: + "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + type: string - id: expirationTimestamp description: >- - A future point in time, as measured by performance.now(), after which the digest value will no longer be - valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for - example, to specify an expiration "5 seconds from right now", use performance.now()+5000. - type: - - number - - uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' - summary: Clears all values from the cache. - name: clearAllDigests() + A future point in time, as measured by performance.now(), after + which the digest value will no longer be valid. NOTE: The + expirationTime is a DOMHighResTimeStamp value whose units are + fractional milliseconds; for example, to specify an expiration "5 + seconds from right now", use performance.now()+5000. + type: number + return: + type: void + description: '' + - name: clearAllDigests() + uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' + package: '@microsoft/sp-http!' fullName: clearAllDigests() - langs: - - typeScript - type: method + summary: Clears all values from the cache. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'clearAllDigests(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' - summary: >- - Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a - digest was invalidated prior to its expiration time. - name: clearDigest(webUrl) + - name: clearDigest(webUrl) + uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' + package: '@microsoft/sp-http!' fullName: clearDigest(webUrl) - langs: - - typeScript - type: method + summary: >- + Clears the cached digest for the specified SPWeb URL. This operation is + useful e.g. if an error indicates that a digest was invalidated prior to + its expiration time. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'clearDigest(webUrl: string): boolean;' - return: - type: - - boolean - description: Returns true if a cache entry was found and deleted; false otherwise. parameters: - id: webUrl - description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. - type: - - string - - uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' + description: >- + The URL of the SPWeb whose digest should be cleared. This may be a + server-relative or absolute URL. + type: string + return: + type: boolean + description: Returns true if a cache entry was found and deleted; false otherwise. + - name: fetchDigest(webUrl) + uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' + package: '@microsoft/sp-http!' + fullName: fetchDigest(webUrl) summary: >- - Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is - fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the + Returns a digest string for the specified SPWeb URL. If the cache already + contains a usable value, the promise is fulfilled immediately. Otherwise, + the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. - name: fetchDigest(webUrl) - fullName: fetchDigest(webUrl) - langs: - - typeScript - type: method + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'fetchDigest(webUrl: string): Promise;' - return: - type: - - '@microsoft/sp-http!DigestCache#fetchDigest~0:complex' - description: A promise that is fulfilled with the digest value. parameters: - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: - - string - - uid: '@microsoft/sp-http!DigestCache.serviceKey:member' - summary: The service key for IDigestCache. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' + description: >- + The URL of the SPWeb that the API call will be issued to. This may + be a server-relative or absolute URL. + type: string return: - type: - - '@microsoft/sp-http!DigestCache.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-http!IDigestCache:interface' - name: IDigestCache - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-http!DigestCache#fetchDigest~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!DigestCache.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-http!IDigestCache:interface' - name: IDigestCache - fullName: IDigestCache - - name: '>' - fullName: '>' + type: '@microsoft/sp-http!DigestCache#' + description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml index fbd01f4e..e9856b9d 100644 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ b/SP-Framework/sp-http/graphhttpclient.yml @@ -1,184 +1,169 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.GraphHttpClient - summary: >- - GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds default headers and collects - telemetry that helps the service to monitor the performance of an application. - https://developer.microsoft.com/en-us/graph/ - remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - For communicating with SharePoint, use the [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For - communicating with other internet services, use the [HttpClient](xref:sp-http.HttpClient) class instead. - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - isPreview: true - name: GraphHttpClient - fullName: GraphHttpClient - langs: - - typeScript - type: class - package: sp-http - children: - - sp-http.GraphHttpClient.constructor - - sp-http.GraphHttpClient.configurations - - sp-http.GraphHttpClient.fetch - - sp-http.GraphHttpClient.get - - sp-http.GraphHttpClient.post - - sp-http.GraphHttpClient.serviceKey - - uid: sp-http.GraphHttpClient.constructor - summary: 'Constructs a new instance of the [GraphHttpClient](xref:sp-http.GraphHttpClient) class' - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - name: constructor(serviceScope) - fullName: constructor - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - ServiceScope - - uid: sp-http.GraphHttpClient.configurations - summary: The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class. - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - isPreview: true - name: configurations - fullName: configurations - langs: - - typeScript - type: property - syntax: - content: 'static readonly configurations: IGraphHttpClientConfigurations;' - return: - type: - - IGraphHttpClientConfigurations - - uid: sp-http.GraphHttpClient.fetch - summary: Perform a REST service call. - remarks: >- - Generally, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard - that is documented here: https://fetch.spec.whatwg.org/ - - - The GraphHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA - API's (which can be avoided by using HttpClient instead): - Default "Accept" and "Content-Type" headers are added - if not explicitly specified. - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - isPreview: true - name: 'fetch(url, configuration, options)' - fullName: fetch - langs: - - typeScript - type: method - syntax: - content: >- - fetch(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): - Promise; - return: - type: - - Promise - description: a promise that will return the result - parameters: - - id: url - description: >- - The url string should be relative to the graph server. Good: 'v1.0/me/events' Bad: '/v1.0/me/events', - 'https://graph.microsoft.com/v1.0/me/events' - type: - - string - - id: configuration - description: >- - determines the default behavior of GraphHttpClient; normally this should be the latest version number from - GraphHttpClientConfigurations - type: - - GraphHttpClientConfiguration - - id: options - description: additional options that affect the request - type: - - IGraphHttpClientOptions - - uid: sp-http.GraphHttpClient.get - summary: 'Calls fetch(), but sets the method to "GET".' - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - isPreview: true - name: 'get(url, configuration, options)' - fullName: get - langs: - - typeScript - type: method - syntax: - content: >- - get(url: string, configuration: GraphHttpClientConfiguration, options?: IGraphHttpClientOptions): - Promise; - return: - type: - - Promise - description: a promise that will return the result - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of GraphHttpClient; normally this should be the latest version number from - GraphHttpClientConfigurations - type: - - GraphHttpClientConfiguration - - id: options - description: additional options that affect the request - type: - - IGraphHttpClientOptions - - uid: sp-http.GraphHttpClient.post - summary: 'Calls fetch(), but sets the method to "POST".' - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - isPreview: true - name: 'post(url, configuration, options)' - fullName: post - langs: - - typeScript - type: method - syntax: - content: >- - post(url: string, configuration: GraphHttpClientConfiguration, options: IGraphHttpClientOptions): - Promise; - return: - type: - - Promise - description: a promise that will return the result - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of GraphHttpClient; normally this should be the latest version number from - GraphHttpClientConfigurations - type: - - GraphHttpClientConfiguration - - id: options - description: additional options that affect the request - type: - - IGraphHttpClientOptions - - uid: sp-http.GraphHttpClient.serviceKey - summary: The service key for GraphHttpClient. - deprecated: - content: The GraphHttpClient class has been superseded by the MSGraphClient class. - isPreview: true - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - ServiceKey +### YamlMime:TSType +name: GraphHttpClient +uid: sp-http.GraphHttpClient +package: sp-http +fullName: GraphHttpClient +summary: >- + GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds + default headers and collects telemetry that helps the service to monitor the + performance of an application. .microsoft.com/en-us/graph/ +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + For communicating with SharePoint, use the + [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For communicating + with other internet services, use the [HttpClient](xref:sp-http.HttpClient) + class instead. +isPreview: true +isDeprecated: true +customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. +type: class +constructors: + - name: constructor(serviceScope) + uid: sp-http.GraphHttpClient.constructor + package: sp-http + fullName: constructor + summary: >- + Constructs a new instance of the [GraphHttpClient](.GraphHttpClient) class + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: ServiceScope +properties: + - name: configurations + uid: sp-http.GraphHttpClient.configurations + package: sp-http + fullName: configurations + summary: >- + The standard predefined GraphHttpClientConfiguration objects for use with + the GraphHttpClient class. + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. + syntax: + content: 'static readonly configurations: IGraphHttpClientConfigurations;' + return: + type: IGraphHttpClientConfigurations + - name: serviceKey + uid: sp-http.GraphHttpClient.serviceKey + package: sp-http + fullName: serviceKey + summary: The service key for GraphHttpClient. + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: ServiceKey<GraphHttpClient> +methods: + - name: 'fetch(url, configuration, options)' + uid: sp-http.GraphHttpClient.fetch + package: sp-http + fullName: fetch + summary: Perform a REST service call. + remarks: >- + Generally, the parameters and semantics for HttpClient.fetch() are + essentially the same as the WHATWG API standard that is documented here: + https://fetch.spec.whatwg.org/ + + + The GraphHttpClient subclass adds some additional behaviors that are + convenient when working with SharePoint ODATA API's (which can be avoided + by using HttpClient instead): - Default "Accept" and "Content-Type" + headers are added if not explicitly specified. + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. + syntax: + content: >- + fetch(url: string, configuration: GraphHttpClientConfiguration, options: + IGraphHttpClientOptions): Promise; + parameters: + - id: url + description: >- + The url string should be relative to the graph server. Good: + 'v1.0/me/events' Bad: '/v1.0/me/events', + 'https://graph.microsoft.com/v1.0/me/events' + type: string + - id: configuration + description: >- + determines the default behavior of GraphHttpClient; normally this + should be the latest version number from + GraphHttpClientConfigurations + type: GraphHttpClientConfiguration + - id: options + description: additional options that affect the request + type: IGraphHttpClientOptions + return: + type: Promise<GraphHttpClientResponse> + description: a promise that will return the result + - name: 'get(url, configuration, options)' + uid: sp-http.GraphHttpClient.get + package: sp-http + fullName: get + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. + syntax: + content: >- + get(url: string, configuration: GraphHttpClientConfiguration, options?: + IGraphHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of GraphHttpClient; normally this + should be the latest version number from + GraphHttpClientConfigurations + type: GraphHttpClientConfiguration + - id: options + description: additional options that affect the request + type: IGraphHttpClientOptions + return: + type: Promise<GraphHttpClientResponse> + description: a promise that will return the result + - name: 'post(url, configuration, options)' + uid: sp-http.GraphHttpClient.post + package: sp-http + fullName: post + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. + syntax: + content: >- + post(url: string, configuration: GraphHttpClientConfiguration, options: + IGraphHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of GraphHttpClient; normally this + should be the latest version number from + GraphHttpClientConfigurations + type: GraphHttpClientConfiguration + - id: options + description: additional options that affect the request + type: IGraphHttpClientOptions + return: + type: Promise<GraphHttpClientResponse> + description: a promise that will return the result diff --git a/SP-Framework/sp-http/graphhttpclientconfiguration.yml b/SP-Framework/sp-http/graphhttpclientconfiguration.yml index 651833c0..8283d695 100644 --- a/SP-Framework/sp-http/graphhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/graphhttpclientconfiguration.yml @@ -1,62 +1,59 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.GraphHttpClientConfiguration - summary: 'Configuration for [GraphHttpClient](xref:sp-http.GraphHttpClient).' - remarks: >- - The GraphHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - GraphHttpClient class. Normally these switches are set (e.g. when calling GraphHttpClient.fetch()) by providing - one of the predefined defaults from GraphHttpClientConfigurations, however switches can also be changed via the - GraphHttpClientConfiguration.overrideWith() method. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: GraphHttpClientConfiguration - fullName: GraphHttpClientConfiguration - langs: - - typeScript - type: class - extends: - - HttpClientConfiguration - implements: - - IGraphHttpClientConfiguration - package: sp-http - children: - - sp-http.GraphHttpClientConfiguration.constructor - - sp-http.GraphHttpClientConfiguration.flags - - uid: sp-http.GraphHttpClientConfiguration.constructor - summary: Constructs a new instance of GraphHttpClientCommonConfiguration with the specified flags. - remarks: >- - The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it - takes precedence over flags. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - name: 'constructor(flags, overrideFlags)' - fullName: constructor - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(flags: IGraphHttpClientConfiguration, overrideFlags?: IGraphHttpClientConfiguration);' - parameters: - - id: flags - description: '' - type: - - IGraphHttpClientConfiguration - - id: overrideFlags - description: '' - type: - - IGraphHttpClientConfiguration - - uid: sp-http.GraphHttpClientConfiguration.flags - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: flags - fullName: flags - langs: - - typeScript - type: property - syntax: - content: 'protected flags: IGraphHttpClientConfiguration;' - return: - type: - - IGraphHttpClientConfiguration +### YamlMime:TSType +name: GraphHttpClientConfiguration +uid: sp-http.GraphHttpClientConfiguration +package: sp-http +fullName: GraphHttpClientConfiguration +summary: >- + Configuration for [GraphHttpClient](.GraphHttpClient)<!-- -->. +remarks: >- + The GraphHttpClientConfiguration object provides a set of switches for + enabling/disabling various features of the GraphHttpClient class. Normally + these switches are set (e.g. when calling GraphHttpClient.fetch()) by + providing one of the predefined defaults from GraphHttpClientConfigurations, + however switches can also be changed via the + GraphHttpClientConfiguration.overrideWith() method. +isPreview: true +isDeprecated: true +customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. +type: class +constructors: + - name: 'constructor(flags, overrideFlags)' + uid: sp-http.GraphHttpClientConfiguration.constructor + package: sp-http + fullName: constructor + summary: >- + Constructs a new instance of GraphHttpClientCommonConfiguration with the + specified flags. + remarks: >- + The default values will be used for any flags that are missing or + undefined. If overrideFlags is specified, it takes precedence over flags. + isPreview: false + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. + syntax: + content: >- + constructor(flags: IGraphHttpClientConfiguration, overrideFlags?: + IGraphHttpClientConfiguration); + parameters: + - id: flags + description: '' + type: IGraphHttpClientConfiguration + - id: overrideFlags + description: '' + type: IGraphHttpClientConfiguration +properties: + - name: flags + uid: sp-http.GraphHttpClientConfiguration.flags + package: sp-http + fullName: flags + summary: '' + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. + syntax: + content: 'protected flags: IGraphHttpClientConfiguration;' + return: + type: IGraphHttpClientConfiguration +extends: HttpClientConfiguration diff --git a/SP-Framework/sp-http/graphhttpclientresponse.yml b/SP-Framework/sp-http/graphhttpclientresponse.yml index 3d737943..5cfc74db 100644 --- a/SP-Framework/sp-http/graphhttpclientresponse.yml +++ b/SP-Framework/sp-http/graphhttpclientresponse.yml @@ -1,73 +1,66 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.GraphHttpClientResponse - summary: The Response subclass returned by methods such as GraphHttpClient.fetch(). - remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - This is a placeholder. In the future, additional GraphHttpClient-specific functionality may be added to this - class. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: GraphHttpClientResponse - fullName: GraphHttpClientResponse - langs: - - typeScript - type: class - extends: - - HttpClientResponse - package: sp-http - children: - - sp-http.GraphHttpClientResponse.constructor - - sp-http.GraphHttpClientResponse.clone - - sp-http.GraphHttpClientResponse.correlationId - - uid: sp-http.GraphHttpClientResponse.constructor - summary: 'Constructs a new instance of the [GraphHttpClientResponse](xref:sp-http.GraphHttpClientResponse) class' - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - name: constructor(response) - fullName: constructor - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(response: Response);' - parameters: - - id: response - description: '' - type: - - Response - - uid: sp-http.GraphHttpClientResponse.clone - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: clone() - fullName: clone - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - clone(): GraphHttpClientResponse; - return: - type: - - GraphHttpClientResponse - description: '' - - uid: sp-http.GraphHttpClientResponse.correlationId - summary: Returns the Graph API correlation ID. - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: correlationId - fullName: correlationId - langs: - - typeScript - type: property - syntax: - content: 'readonly correlationId: Guid | undefined;' - return: - type: - - Guid | undefined +### YamlMime:TSType +name: GraphHttpClientResponse +uid: sp-http.GraphHttpClientResponse +package: sp-http +fullName: GraphHttpClientResponse +summary: The Response subclass returned by methods such as GraphHttpClient.fetch(). +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + This is a placeholder. In the future, additional GraphHttpClient-specific + functionality may be added to this class. +isPreview: true +isDeprecated: true +customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. +type: class +constructors: + - name: constructor(response) + uid: sp-http.GraphHttpClientResponse.constructor + package: sp-http + fullName: constructor + summary: >- + Constructs a new instance of the [GraphHttpClientResponse](.GraphHttpClientResponse) class + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. + syntax: + content: 'constructor(response: Response);' + parameters: + - id: response + description: '' + type: Response +properties: + - name: correlationId + uid: sp-http.GraphHttpClientResponse.correlationId + package: sp-http + fullName: correlationId + summary: Returns the Graph API correlation ID. + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. + syntax: + content: 'readonly correlationId: Guid | undefined;' + return: + type: Guid | undefined +methods: + - name: clone() + uid: sp-http.GraphHttpClientResponse.clone + package: sp-http + fullName: clone + summary: '' + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. + syntax: + content: |- + /** @override */ + clone(): GraphHttpClientResponse; + return: + type: GraphHttpClientResponse + description: '' +extends: HttpClientResponse diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 4517739b..93b7e92b 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -1,655 +1,575 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!GraphRequest:interface' - summary: >- - Typings for the GraphRequest Object For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) - name: GraphRequest - fullName: GraphRequest - langs: - - typeScript - type: interface +### YamlMime:TSType +name: GraphRequest +uid: '@microsoft/sp-http!GraphRequest:interface' +package: '@microsoft/sp-http!' +fullName: GraphRequest +summary: >- + Typings for the GraphRequest Object For more information: [.com/microsoftgraph/msgraph-sdk-javascript](.com/microsoftgraph/msgraph-sdk-javascript) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: _headers + uid: '@microsoft/sp-http!GraphRequest#_headers:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!GraphRequest#_headers:member' - - '@microsoft/sp-http!GraphRequest#_responseType:member' - - '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' - - '@microsoft/sp-http!GraphRequest#config:member' - - '@microsoft/sp-http!GraphRequest#constructor:member(1)' - - '@microsoft/sp-http!GraphRequest#count:member(1)' - - '@microsoft/sp-http!GraphRequest#create:member(1)' - - '@microsoft/sp-http!GraphRequest#del:member(1)' - - '@microsoft/sp-http!GraphRequest#delete:member(1)' - - '@microsoft/sp-http!GraphRequest#expand:member(1)' - - '@microsoft/sp-http!GraphRequest#filter:member(1)' - - '@microsoft/sp-http!GraphRequest#get:member(1)' - - '@microsoft/sp-http!GraphRequest#getStream:member(1)' - - '@microsoft/sp-http!GraphRequest#header:member(1)' - - '@microsoft/sp-http!GraphRequest#headers:member(1)' - - '@microsoft/sp-http!GraphRequest#orderby:member(1)' - - '@microsoft/sp-http!GraphRequest#parsePath:member(1)' - - '@microsoft/sp-http!GraphRequest#patch:member(1)' - - '@microsoft/sp-http!GraphRequest#post:member(1)' - - '@microsoft/sp-http!GraphRequest#put:member(1)' - - '@microsoft/sp-http!GraphRequest#putStream:member(1)' - - '@microsoft/sp-http!GraphRequest#query:member(1)' - - '@microsoft/sp-http!GraphRequest#responseType:member(1)' - - '@microsoft/sp-http!GraphRequest#select:member(1)' - - '@microsoft/sp-http!GraphRequest#skip:member(1)' - - '@microsoft/sp-http!GraphRequest#skipToken:member(1)' - - '@microsoft/sp-http!GraphRequest#top:member(1)' - - '@microsoft/sp-http!GraphRequest#update:member(1)' - - '@microsoft/sp-http!GraphRequest#urlComponents:member' - - '@microsoft/sp-http!GraphRequest#version:member(1)' - - uid: '@microsoft/sp-http!GraphRequest#_headers:member' - name: _headers fullName: _headers - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: |- _headers: { [key: string]: string | number; }; return: - type: - - |- - { - [key: string]: string | number; - } - - uid: '@microsoft/sp-http!GraphRequest#_responseType:member' - name: _responseType + type: |- + { + [key: string]: string | number; + } + - name: _responseType + uid: '@microsoft/sp-http!GraphRequest#_responseType:member' + package: '@microsoft/sp-http!' fullName: _responseType - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: '_responseType: string;' return: - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' - name: buildFullUrl() + type: string + - name: config + uid: '@microsoft/sp-http!GraphRequest#config:member' + package: '@microsoft/sp-http!' + fullName: config + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'config: Options;' + return: + type: '' + - name: urlComponents + uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' + package: '@microsoft/sp-http!' + fullName: urlComponents + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'urlComponents: URLComponents;' + return: + type: >- + +methods: + - name: buildFullUrl() + uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' + package: '@microsoft/sp-http!' fullName: buildFullUrl() - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buildFullUrl(): string;' return: - type: - - string + type: string description: '' - - uid: '@microsoft/sp-http!GraphRequest#config:member' - name: config - fullName: config - langs: - - typeScript - type: property - syntax: - content: 'config: Options;' - return: - type: - - '@microsoft/microsoft-graph-client!Options:interface' - - uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' - name: 'constructor(config, path)' + - name: 'constructor(config, path)' + uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' + package: '@microsoft/sp-http!' fullName: 'constructor(config, path)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(config: Options, path: string): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: config description: '' - type: - - '@microsoft/microsoft-graph-client!Options:interface' + type: '' - id: path description: '' - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#count:member(1)' - name: count(count) + type: string + return: + type: '' + description: '' + - name: count(count) + uid: '@microsoft/sp-http!GraphRequest#count:member(1)' + package: '@microsoft/sp-http!' fullName: count(count) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'count(count: boolean): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: count description: '' - type: - - boolean - - uid: '@microsoft/sp-http!GraphRequest#create:member(1)' - name: 'create(content, callback)' + type: boolean + return: + type: '' + description: '' + - name: 'create(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#create:member(1)' + package: '@microsoft/sp-http!' fullName: 'create(content, callback)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'create(content: any, callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#create~0:complex' - description: '' parameters: - id: content description: '' - type: - - any + type: any - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#del:member(1)' - name: del(callback) + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: del(callback) + uid: '@microsoft/sp-http!GraphRequest#del:member(1)' + package: '@microsoft/sp-http!' fullName: del(callback) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'del(callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#del~0:complex' - description: '' parameters: - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' - name: delete(callback) + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: delete(callback) + uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' + package: '@microsoft/sp-http!' fullName: delete(callback) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'delete(callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#delete~0:complex' - description: '' parameters: - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' - name: expand(properties) + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: expand(properties) + uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' + package: '@microsoft/sp-http!' fullName: expand(properties) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'expand(properties: string | string[]): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: properties description: '' - type: - - 'string | string[]' - - uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' - name: filter(filterStr) + type: 'string | string[]' + return: + type: '' + description: '' + - name: filter(filterStr) + uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' + package: '@microsoft/sp-http!' fullName: filter(filterStr) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'filter(filterStr: string): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: filterStr description: '' - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#get:member(1)' - name: get(callback) + type: string + return: + type: '' + description: '' + - name: get(callback) + uid: '@microsoft/sp-http!GraphRequest#get:member(1)' + package: '@microsoft/sp-http!' fullName: get(callback) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'get(callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#get~0:complex' - description: '' parameters: - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' - name: getStream(callback) + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: getStream(callback) + uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' + package: '@microsoft/sp-http!' fullName: getStream(callback) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getStream(callback: GraphRequestCallback): void;' - return: - type: - - void - description: '' parameters: - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#header:member(1)' - name: 'header(headerKey, headerValue)' + type: >- + + return: + type: void + description: '' + - name: 'header(headerKey, headerValue)' + uid: '@microsoft/sp-http!GraphRequest#header:member(1)' + package: '@microsoft/sp-http!' fullName: 'header(headerKey, headerValue)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'header(headerKey: string, headerValue: string): this;' - return: - type: - - this - description: '' parameters: - id: headerKey description: '' - type: - - string + type: string - id: headerValue description: '' - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' - name: headers(headers) + type: string + return: + type: this + description: '' + - name: headers(headers) + uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' + package: '@microsoft/sp-http!' fullName: headers(headers) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: |- headers(headers: { [key: string]: string | number; }): this; - return: - type: - - this - description: '' parameters: - id: headers description: '' - type: - - |- - { - [key: string]: string | number; - } - - uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' - name: orderby(properties) + type: |- + { + [key: string]: string | number; + } + return: + type: this + description: '' + - name: orderby(properties) + uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' + package: '@microsoft/sp-http!' fullName: orderby(properties) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'orderby(properties: string | string[]): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: properties description: '' - type: - - 'string | string[]' - - uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' - name: parsePath(rawPath) + type: 'string | string[]' + return: + type: '' + description: '' + - name: parsePath(rawPath) + uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' + package: '@microsoft/sp-http!' fullName: parsePath(rawPath) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'parsePath(rawPath: string): void;' - return: - type: - - void - description: '' parameters: - id: rawPath description: '' - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' - name: 'patch(content, callback)' + type: string + return: + type: void + description: '' + - name: 'patch(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' + package: '@microsoft/sp-http!' fullName: 'patch(content, callback)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'patch(content: any, callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#patch~0:complex' - description: '' parameters: - id: content description: '' - type: - - any + type: any - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#post:member(1)' - name: 'post(content, callback)' + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: 'post(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#post:member(1)' + package: '@microsoft/sp-http!' fullName: 'post(content, callback)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'post(content: any, callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#post~0:complex' - description: '' parameters: - id: content description: '' - type: - - any + type: any - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#put:member(1)' - name: 'put(content, callback)' + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: 'put(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#put:member(1)' + package: '@microsoft/sp-http!' fullName: 'put(content, callback)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'put(content: any, callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#put~0:complex' - description: '' parameters: - id: content description: '' - type: - - any + type: any - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' - name: 'putStream(stream, callback)' + type: >- + + return: + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: 'putStream(stream, callback)' + uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' + package: '@microsoft/sp-http!' fullName: 'putStream(stream, callback)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'putStream(stream: any, callback: GraphRequestCallback): void;' - return: - type: - - void - description: '' parameters: - id: stream description: '' - type: - - any + type: any - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#query:member(1)' - name: query(queryDictionaryOrString) + type: >- + + return: + type: void + description: '' + - name: query(queryDictionaryOrString) + uid: '@microsoft/sp-http!GraphRequest#query:member(1)' + package: '@microsoft/sp-http!' fullName: query(queryDictionaryOrString) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: |- query(queryDictionaryOrString: string | { [key: string]: string | number; }): IGraphRequest; - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: queryDictionaryOrString description: '' - type: - - |- - string | { - [key: string]: string | number; - } - - uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' - name: responseType(responseType) + type: |- + string | { + [key: string]: string | number; + } + return: + type: '' + description: '' + - name: responseType(responseType) + uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' + package: '@microsoft/sp-http!' fullName: responseType(responseType) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'responseType(responseType: string): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: responseType description: '' - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#select:member(1)' - name: select(properties) + type: string + return: + type: '' + description: '' + - name: select(properties) + uid: '@microsoft/sp-http!GraphRequest#select:member(1)' + package: '@microsoft/sp-http!' fullName: select(properties) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'select(properties: string | string[]): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: properties description: '' - type: - - 'string | string[]' - - uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' - name: skip(n) + type: 'string | string[]' + return: + type: '' + description: '' + - name: skip(n) + uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' + package: '@microsoft/sp-http!' fullName: skip(n) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'skip(n: number): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: 'n' description: '' - type: - - number - - uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' - name: skipToken(token) + type: number + return: + type: '' + description: '' + - name: skipToken(token) + uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' + package: '@microsoft/sp-http!' fullName: skipToken(token) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'skipToken(token: string): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: token description: '' - type: - - string - - uid: '@microsoft/sp-http!GraphRequest#top:member(1)' - name: top(n) + type: string + return: + type: '' + description: '' + - name: top(n) + uid: '@microsoft/sp-http!GraphRequest#top:member(1)' + package: '@microsoft/sp-http!' fullName: top(n) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'top(n: number): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: 'n' description: '' - type: - - number - - uid: '@microsoft/sp-http!GraphRequest#update:member(1)' - name: 'update(content, callback)' + type: number + return: + type: '' + description: '' + - name: 'update(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#update:member(1)' + package: '@microsoft/sp-http!' fullName: 'update(content, callback)' - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'update(content: any, callback?: GraphRequestCallback): Promise;' - return: - type: - - '@microsoft/sp-http!GraphRequest#update~0:complex' - description: '' parameters: - id: content description: '' - type: - - any + type: any - id: callback description: '' - type: - - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - - uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' - name: urlComponents - fullName: urlComponents - langs: - - typeScript - type: property - syntax: - content: 'urlComponents: URLComponents;' + type: >- + return: - type: - - '@microsoft/microsoft-graph-client!URLComponents:interface' - - uid: '@microsoft/sp-http!GraphRequest#version:member(1)' - name: version(v) + type: '@microsoft/sp-http!GraphRequest#' + description: '' + - name: version(v) + uid: '@microsoft/sp-http!GraphRequest#version:member(1)' + package: '@microsoft/sp-http!' fullName: version(v) - langs: - - typeScript - type: method + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'version(v: string): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: v description: '' - type: - - string -references: - - uid: '@microsoft/microsoft-graph-client!Options:interface' - name: Options - - uid: '@microsoft/sp-http!IGraphRequest:interface' - name: IGraphRequest - - uid: '@microsoft/sp-http!GraphRequest#create~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' - name: GraphRequestCallback - - uid: '@microsoft/sp-http!GraphRequest#del~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!GraphRequest#delete~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!GraphRequest#get~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!GraphRequest#patch~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!GraphRequest#post~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!GraphRequest#put~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!GraphRequest#update~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/microsoft-graph-client!URLComponents:interface' - name: URLComponents + type: string + return: + type: '' + description: '' diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index df13c335..81773058 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -1,229 +1,160 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!HttpClient:class' - summary: HttpClient implements a basic set of features for performing REST operations against a generic service. - remarks: >- - For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class - instead. - name: HttpClient - fullName: HttpClient - langs: - - typeScript - type: class - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!HttpClient:constructor(1)' - - '@microsoft/sp-http!HttpClient.configurations:member' - - '@microsoft/sp-http!HttpClient#fetch:member(1)' - - '@microsoft/sp-http!HttpClient#get:member(1)' - - '@microsoft/sp-http!HttpClient#post:member(1)' - - '@microsoft/sp-http!HttpClient.serviceKey:member' - - uid: '@microsoft/sp-http!HttpClient:constructor(1)' - summary: Constructs a new instance of the `HttpClient` class - name: (constructor)(serviceScope) - fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - '@microsoft/sp-core-library!ServiceScope:class' - - uid: '@microsoft/sp-http!HttpClient.configurations:member' - summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. - name: configurations - fullName: configurations - langs: - - typeScript - type: property - syntax: - content: 'static readonly configurations: IHttpClientConfigurations;' - return: - type: - - '@microsoft/sp-http!IHttpClientConfigurations:interface' - - uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' - summary: Performs a REST service call. - remarks: >- - Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for - HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: - https://fetch.spec.whatwg.org/ - name: 'fetch(url, configuration, options)' - fullName: 'fetch(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!HttpClient#fetch~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!IHttpClientOptions:interface' - - uid: '@microsoft/sp-http!HttpClient#get:member(1)' - summary: 'Calls fetch(), but sets the method to "GET".' - name: 'get(url, configuration, options)' - fullName: 'get(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!HttpClient#get~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!IHttpClientOptions:interface' - - uid: '@microsoft/sp-http!HttpClient#post:member(1)' - summary: 'Calls fetch(), but sets the method to "POST".' - name: 'post(url, configuration, options)' - fullName: 'post(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!HttpClient#post~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!IHttpClientOptions:interface' - - uid: '@microsoft/sp-http!HttpClient.serviceKey:member' - summary: The service key for HttpClient. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-http!HttpClient.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' - name: IHttpClientConfigurations - - uid: '@microsoft/sp-http!HttpClient#fetch~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!default:class' - name: HttpClientConfiguration - - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - name: IHttpClientOptions - - uid: '@microsoft/sp-http!HttpClient#get~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!HttpClient#post~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!HttpClient.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: HttpClient - fullName: default - - name: '>' - fullName: '>' +### YamlMime:TSType +name: HttpClient +uid: '@microsoft/sp-http!HttpClient:class' +package: '@microsoft/sp-http!' +fullName: HttpClient +summary: >- + HttpClient implements a basic set of features for performing REST operations + against a generic service. +remarks: >- + For communicating with SharePoint, use the + [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-http!HttpClient:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `HttpClient` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: configurations + uid: '@microsoft/sp-http!HttpClient.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: >- + The standard predefined HttpClientConfiguration objects for use with the + HttpClient class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly configurations: IHttpClientConfigurations;' + return: + type: '' + - name: serviceKey + uid: '@microsoft/sp-http!HttpClient.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for HttpClient. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: '@microsoft/sp-http!HttpClient.' +methods: + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: Performs a REST service call. + remarks: >- + Although the SPHttpClient subclass adds additional enhancements, the + parameters and semantics for HttpClient.fetch() are essentially the same + as the WHATWG API standard that is documented here: + https://fetch.spec.whatwg.org/ + isPreview: false + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: HttpClientConfiguration, options: + IHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should + be the latest version number from HttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: '@microsoft/sp-http!HttpClient#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!HttpClient#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: HttpClientConfiguration, options?: + IHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should + be the latest version number from HttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: '@microsoft/sp-http!HttpClient#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!HttpClient#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: HttpClientConfiguration, options: + IHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should + be the latest version number from HttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: '@microsoft/sp-http!HttpClient#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index 3dabad58..ad06305e 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -1,93 +1,90 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!HttpClientConfiguration:class' - summary: Configuration for HttpClient. - remarks: >- - The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the - predefined defaults from HttpClientConfigurations, however switches can also be changed via the - HttpClientConfiguration.overrideWith() method. - name: HttpClientConfiguration - fullName: HttpClientConfiguration - langs: - - typeScript - type: class - implements: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' - - '@microsoft/sp-http!HttpClientConfiguration#flags:member' - - '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' - - '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' - - uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' - summary: >- - Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for - any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: '(constructor)(flags, overrideFlags)' - fullName: '(constructor)(flags, overrideFlags)' - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);' - parameters: - - id: flags - description: '' - type: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - - id: overrideFlags - description: '' - type: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' - name: flags - fullName: flags - langs: - - typeScript - type: property - syntax: - content: 'protected flags: IHttpClientConfiguration;' - return: - type: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' - summary: Child classes should override this method to initialize the flags object. - name: initializeFlags() - fullName: initializeFlags() - langs: - - typeScript - type: method - syntax: - content: |- - /** @virtual */ - protected initializeFlags(): void; - return: - type: - - void - description: '' - - uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' - summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' - name: overrideWith(sourceFlags) - fullName: overrideWith(sourceFlags) - langs: - - typeScript - type: method - syntax: - content: |- - /** @virtual */ - overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' - parameters: - - id: sourceFlags - description: '' - type: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' -references: - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfiguration - - uid: '@microsoft/sp-http!default:class' - name: HttpClientConfiguration +### YamlMime:TSType +name: HttpClientConfiguration +uid: '@microsoft/sp-http!HttpClientConfiguration:class' +package: '@microsoft/sp-http!' +fullName: HttpClientConfiguration +summary: Configuration for HttpClient. +remarks: >- + The HttpClientConfiguration object provides a set of switches for + enabling/disabling various features of the HttpClient class. Normally these + switches are set (e.g. when calling HttpClient.fetch()) by providing one of + the predefined defaults from HttpClientConfigurations, however switches can + also be changed via the HttpClientConfiguration.overrideWith() method. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of HttpClientConfiguration with the specified + flags. The default values will be used for any flags that are missing or + undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + constructor(flags: IHttpClientConfiguration, overrideFlags?: + IHttpClientConfiguration); + parameters: + - id: flags + description: '' + type: '' + - id: overrideFlags + description: '' + type: '' +properties: + - name: flags + uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: IHttpClientConfiguration;' + return: + type: '' +methods: + - name: initializeFlags() + uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: Child classes should override this method to initialize the flags object. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: >- + Child classes should override this method to construct the child class + type, rather than the base class type. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + /** @virtual */ + + overrideWith(sourceFlags: IHttpClientConfiguration): + HttpClientConfiguration; + parameters: + - id: sourceFlags + description: '' + type: '' + return: + type: '' + description: '' diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 0805ca36..8b46b7b3 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -1,279 +1,223 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!HttpClientResponse:class' - summary: The Response subclass returned by methods such as HttpClient.fetch(). - remarks: >- - This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `HttpClientResponse` class. - name: HttpClientResponse - fullName: HttpClientResponse - langs: - - typeScript - type: class - implements: - - '!Response:interface' - - '!Body:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' - - '@microsoft/sp-http!HttpClientResponse#blob:member(1)' - - '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' - - '@microsoft/sp-http!HttpClientResponse#clone:member(1)' - - '@microsoft/sp-http!HttpClientResponse#formData:member(1)' - - '@microsoft/sp-http!HttpClientResponse#headers:member' - - '@microsoft/sp-http!HttpClientResponse#json:member(1)' - - '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' - - '@microsoft/sp-http!HttpClientResponse#ok:member' - - '@microsoft/sp-http!HttpClientResponse#status:member' - - '@microsoft/sp-http!HttpClientResponse#statusText:member' - - '@microsoft/sp-http!HttpClientResponse#text:member(1)' - - '@microsoft/sp-http!HttpClientResponse#type:member' - - '@microsoft/sp-http!HttpClientResponse#url:member' - - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - name: arrayBuffer() - fullName: arrayBuffer() - langs: - - typeScript - type: method - syntax: - content: 'arrayBuffer(): Promise;' - return: - type: - - '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' - description: '' - - uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - name: blob() - fullName: blob() - langs: - - typeScript - type: method - syntax: - content: 'blob(): Promise;' - return: - type: - - '@microsoft/sp-http!HttpClientResponse#blob~0:complex' - description: '' - - uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - name: bodyUsed - fullName: bodyUsed - langs: - - typeScript - type: property - syntax: - content: 'readonly bodyUsed: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' - name: clone() - fullName: clone() - langs: - - typeScript - type: method - syntax: - content: |- - /** @virtual */ - clone(): HttpClientResponse; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' - - uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - name: formData() - fullName: formData() - langs: - - typeScript - type: method - syntax: - content: 'formData(): Promise;' - return: - type: - - '@microsoft/sp-http!HttpClientResponse#formData~0:complex' - description: '' - - uid: '@microsoft/sp-http!HttpClientResponse#headers:member' - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - name: headers - fullName: headers - langs: - - typeScript - type: property - syntax: - content: 'readonly headers: Headers;' - return: - type: - - '!Headers:interface' - - uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - name: json() - fullName: json() - langs: - - typeScript - type: method - syntax: - content: 'json(): Promise;' - return: - type: - - '@microsoft/sp-http!HttpClientResponse#json~0:complex' - description: '' - - uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' - name: nativeResponse - fullName: nativeResponse - langs: - - typeScript - type: property - syntax: - content: 'protected nativeResponse: Response;' - return: - type: - - '!Response:interface' - - uid: '@microsoft/sp-http!HttpClientResponse#ok:member' - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - name: ok - fullName: ok - langs: - - typeScript - type: property - syntax: - content: 'readonly ok: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!HttpClientResponse#status:member' - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - name: status - fullName: status - langs: - - typeScript - type: property - syntax: - content: 'readonly status: number;' - return: - type: - - number - - uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - name: statusText - fullName: statusText - langs: - - typeScript - type: property - syntax: - content: 'readonly statusText: string;' - return: - type: - - string - - uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - name: text() - fullName: text() - langs: - - typeScript - type: method - syntax: - content: 'text(): Promise;' - return: - type: - - '@microsoft/sp-http!HttpClientResponse#text~0:complex' - description: '' - - uid: '@microsoft/sp-http!HttpClientResponse#type:member' - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - name: type - fullName: type - langs: - - typeScript - type: property - syntax: - content: 'readonly type: ResponseType;' - return: - type: - - '!ResponseType:type' - - uid: '@microsoft/sp-http!HttpClientResponse#url:member' - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - name: url - fullName: url - langs: - - typeScript - type: property - syntax: - content: 'readonly url: string;' - return: - type: - - string -references: - - uid: '!Response:interface' - name: Response - - uid: '!Body:interface' - name: Body - - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '!ArrayBuffer:interface' - name: ArrayBuffer - fullName: ArrayBuffer - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!HttpClientResponse#blob~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '!Blob:interface' - name: Blob - fullName: Blob - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - - uid: '@microsoft/sp-http!HttpClientResponse#formData~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '!FormData:interface' - name: FormData - fullName: FormData - - name: '>' - fullName: '>' - - uid: '!Headers:interface' - name: Headers - - uid: '@microsoft/sp-http!HttpClientResponse#json~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!HttpClientResponse#text~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '!ResponseType:type' - name: ResponseType +### YamlMime:TSType +name: HttpClientResponse +uid: '@microsoft/sp-http!HttpClientResponse:class' +package: '@microsoft/sp-http!' +fullName: HttpClientResponse +summary: The Response subclass returned by methods such as HttpClient.fetch(). +remarks: >- + This is a placeholder. In the future, additional HttpClient-specific + functionality may be added to this class. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `HttpClientResponse` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: bodyUsed + uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' + package: '@microsoft/sp-http!' + fullName: bodyUsed + summary: >- + See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly bodyUsed: boolean;' + return: + type: boolean + - name: headers + uid: '@microsoft/sp-http!HttpClientResponse#headers:member' + package: '@microsoft/sp-http!' + fullName: headers + summary: >- + See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly headers: Headers;' + return: + type: '' + - name: nativeResponse + uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' + package: '@microsoft/sp-http!' + fullName: nativeResponse + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected nativeResponse: Response;' + return: + type: '' + - name: ok + uid: '@microsoft/sp-http!HttpClientResponse#ok:member' + package: '@microsoft/sp-http!' + fullName: ok + summary: >- + See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly ok: boolean;' + return: + type: boolean + - name: status + uid: '@microsoft/sp-http!HttpClientResponse#status:member' + package: '@microsoft/sp-http!' + fullName: status + summary: >- + See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly status: number;' + return: + type: number + - name: statusText + uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' + package: '@microsoft/sp-http!' + fullName: statusText + summary: >- + See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly statusText: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-http!HttpClientResponse#type:member' + package: '@microsoft/sp-http!' + fullName: type + summary: >- + See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly type: ResponseType;' + return: + type: '' + - name: url + uid: '@microsoft/sp-http!HttpClientResponse#url:member' + package: '@microsoft/sp-http!' + fullName: url + summary: >- + See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly url: string;' + return: + type: string +methods: + - name: arrayBuffer() + uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' + package: '@microsoft/sp-http!' + fullName: arrayBuffer() + summary: >- + See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'arrayBuffer(): Promise;' + return: + type: >- + @microsoft/sp-http!HttpClientResponse# + description: '' + - name: blob() + uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' + package: '@microsoft/sp-http!' + fullName: blob() + summary: >- + See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blob(): Promise;' + return: + type: '@microsoft/sp-http!HttpClientResponse#' + description: '' + - name: clone() + uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' + package: '@microsoft/sp-http!' + fullName: clone() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + clone(): HttpClientResponse; + return: + type: '' + description: '' + - name: formData() + uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' + package: '@microsoft/sp-http!' + fullName: formData() + summary: >- + See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'formData(): Promise;' + return: + type: >- + @microsoft/sp-http!HttpClientResponse# + description: '' + - name: json() + uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' + package: '@microsoft/sp-http!' + fullName: json() + summary: >- + See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'json(): Promise;' + return: + type: '@microsoft/sp-http!HttpClientResponse#' + description: '' + - name: text() + uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' + package: '@microsoft/sp-http!' + fullName: text() + summary: >- + See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text(): Promise;' + return: + type: '@microsoft/sp-http!HttpClientResponse#' + description: '' diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 1d8bd79e..bf7709f7 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -1,17 +1,11 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - summary: Flags interface for HttpClientConfiguration. - name: IAadHttpClientConfiguration - fullName: IAadHttpClientConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - inheritance: - - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' - package: '@microsoft/sp-http!' -references: - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfiguration +### YamlMime:TSType +name: IAadHttpClientConfiguration +uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: IAadHttpClientConfiguration +summary: Flags interface for HttpClientConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 41293bf0..875e758e 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -1,35 +1,32 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - summary: Standard configurations for AadHttpClient. - remarks: >- - This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient - class. In general, clients should choose the latest available version number, which enables all the switches that - are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was - tested.) - name: IAadHttpClientConfigurations - fullName: IAadHttpClientConfigurations - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IAadHttpClientConfigurations +uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: IAadHttpClientConfigurations +summary: Standard configurations for AadHttpClient. +remarks: >- + This interface provides standard predefined AadHttpClientConfiguration objects + for use with the AadHttpClient class. In general, clients should choose the + latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the + future, a new version number will be introduced, which ensures that existing + code will continue to function the way it did at the time when it was tested.) +isPreview: false +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' - - uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' - summary: >- - This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially - identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - name: v1 fullName: v1 - langs: - - typeScript - type: property + summary: >- + This configuration turns off every feature switch for AadHttpClient. The + fetch() behavior will be essentially identical to the WHATWG standard API + that is documented here: .spec.whatwg.org/ + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly v1: AadHttpClientConfiguration;' return: - type: - - '@microsoft/sp-http!default:class' -references: - - uid: '@microsoft/sp-http!default:class' - name: AadHttpClientConfiguration + type: '' diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index c1f31bd3..a8a89fe2 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -1,58 +1,53 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' - summary: Interface for overriding the default behavior of AadHttpClient. - name: IAadHttpClientOptions - fullName: IAadHttpClientOptions - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IAadHttpClientOptions +uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' +package: '@microsoft/sp-http!' +fullName: IAadHttpClientOptions +summary: Interface for overriding the default behavior of AadHttpClient. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: configuration + uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' - - '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' - - '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' - - uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' - deprecated: - content: '- AadHttpClient''s configuration cannot be altered' - name: configuration fullName: configuration - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' syntax: content: 'configuration?: IAadTokenProviderConfiguration;' return: - type: - - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - - uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' - deprecated: - content: '- AadHttpClient does not support a custom tokenProvider.' - name: tokenProvider + type: >- + + - name: tokenProvider + uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' + package: '@microsoft/sp-http!' fullName: tokenProvider - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' syntax: content: 'tokenProvider?: IAadTokenProvider;' return: - type: - - '@microsoft/sp-http!IAadTokenProvider:interface' - - uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' - summary: Allows the developer to specify if cached tokens should be use for the current request. - isPreview: true - name: useCachedToken + type: '' + - name: useCachedToken + uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' + package: '@microsoft/sp-http!' fullName: useCachedToken - langs: - - typeScript - type: property + summary: >- + Allows the developer to specify if cached tokens should be use for the + current request. + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'useCachedToken?: boolean;' return: - type: - - boolean -references: - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - name: IAadTokenProviderConfiguration - - uid: '@microsoft/sp-http!IAadTokenProvider:interface' - name: IAadTokenProvider + type: boolean diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 3ccc3d5c..1f12d9e8 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -1,85 +1,69 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IAadTokenProvider:interface' - summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. +### YamlMime:TSType +name: IAadTokenProvider +uid: '@microsoft/sp-http!IAadTokenProvider:interface' +package: '@microsoft/sp-http!' +fullName: IAadTokenProvider +summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. - remarks: >- - AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some - point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will - switch to MSAL. - name: IAadTokenProvider - fullName: IAadTokenProvider - langs: - - typeScript - type: interface + OAuth2 tokens are used to authenticate the user from the SharePoint page to + other services such as PowerBI, Sway, Exchange, Yammer, etc. +remarks: >- + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for + authentication with ADAL.js. At some point in the near future, when Azure AD + v2.0 can support the same scenarios as the original version, we will switch to + MSAL. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: tokenAcquisitionEvent + uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' - - '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' - - uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' - summary: |- - Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + fullName: tokenAcquisitionEvent + summary: Notifies the developer when Token Acquistion requires user action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tokenAcquisitionEvent: SPEvent;' + return: + type: >- + @microsoft/sp-http!IAadTokenProvider# +methods: + - name: 'getToken(resourceEndpoint, useCachedToken)' + uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' + package: '@microsoft/sp-http!' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + summary: >- + Fetches the AAD OAuth2 token for a resource if the user that's currently + logged in has access to that resource. - The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. - An example of a resourceEndpoint would be https://sdfpilot.outlook.com - name: 'getToken(resourceEndpoint, useCachedToken)' - fullName: 'getToken(resourceEndpoint, useCachedToken)' - langs: - - typeScript - type: method + The OAuth2 token SHOULD NOT be cached by the caller since it is already + cached by the method itself. + + + An example of a resourceEndpoint would be .outlook.com + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' - return: - type: - - '@microsoft/sp-http!IAadTokenProvider#getToken~0:complex' - description: A promise that will be fullfiled with the token or that will reject with an error message + content: >- + getToken(resourceEndpoint: string, useCachedToken?: boolean): + Promise; parameters: - id: resourceEndpoint description: the resource for which the token should be obtained - type: - - string + type: string - id: useCachedToken description: Allows the developer to specify if cached tokens should be returned. - type: - - boolean - - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' - summary: Notifies the developer when Token Acquistion requires user action. - name: tokenAcquisitionEvent - fullName: tokenAcquisitionEvent - langs: - - typeScript - type: event - syntax: - content: 'readonly tokenAcquisitionEvent: SPEvent;' + type: boolean return: - type: - - '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent~0:complex' -references: - - uid: '@microsoft/sp-http!IAadTokenProvider#getToken~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent~0:complex' - name: SPEvent - fullName: SPEvent - spec.typeScript: - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - fullName: SPEvent - - name: < - fullName: < - - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' - name: ITokenAcquisitionEventArgs - fullName: ITokenAcquisitionEventArgs - - name: '>' - fullName: '>' + type: '@microsoft/sp-http!IAadTokenProvider#' + description: >- + A promise that will be fullfiled with the token or that will reject + with an error message diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index f28d96f7..a8c9f085 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -1,113 +1,109 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - summary: Required strings for constructing an AadTokenProvider. - name: IAadTokenProviderConfiguration - fullName: IAadTokenProviderConfiguration - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IAadTokenProviderConfiguration +uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: IAadTokenProviderConfiguration +summary: Required strings for constructing an AadTokenProvider. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: aadInstanceUrl + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' - - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' - - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' - - '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' - - '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' - - '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' - - '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' - summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. - name: aadInstanceUrl fullName: aadInstanceUrl - langs: - - typeScript - type: property + summary: >- + The sign in page used to authenticate with Azure Active Directory. + Trailing slashes are forbidden. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'aadInstanceUrl: string;' return: - type: - - string - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' - summary: The Azure Active Directory's tenant id. - name: aadTenantId + type: string + - name: aadTenantId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' + package: '@microsoft/sp-http!' fullName: aadTenantId - langs: - - typeScript - type: property + summary: The Azure Active Directory's tenant id. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'aadTenantId: string;' return: - type: - - string - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' - summary: >- - The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current - user. - name: aadUserId + type: string + - name: aadUserId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' + package: '@microsoft/sp-http!' fullName: aadUserId - langs: - - typeScript - type: property + summary: >- + The user's Azure Active Directory id. This will be used to ensure that a + valid cached token is for the current user. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'aadUserId?: string;' return: - type: - - string - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' - summary: >- - The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's - application redirect uris. - name: redirectUri + type: string + - name: redirectUri + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' + package: '@microsoft/sp-http!' fullName: redirectUri - langs: - - typeScript - type: property + summary: >- + The page used to retrieve tokens from Azure Active Directory. This url + must be listed in the developer's application redirect uris. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'redirectUri: string;' return: - type: - - string - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' - summary: The client ID of the developer's Azure Active Directory application. - name: servicePrincipalId + type: string + - name: servicePrincipalId + uid: >- + @microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member + package: '@microsoft/sp-http!' fullName: servicePrincipalId - langs: - - typeScript - type: property + summary: The client ID of the developer's Azure Active Directory application. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'servicePrincipalId: string;' return: - type: - - string - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' - summary: >- - The user's email address. This will be used to ensure that the current user's identity is used for fetching auth - tokens. - deprecated: - content: This parameter will be ignored. Use userPrincipalName instead - name: userEmail + type: string + - name: userEmail + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' + package: '@microsoft/sp-http!' fullName: userEmail - langs: - - typeScript - type: property + summary: >- + The user's email address. This will be used to ensure that the current + user's identity is used for fetching auth tokens. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead syntax: content: 'userEmail?: string;' return: - type: - - string - - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' - summary: >- - The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth - tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the - current request" error. - name: userPrincipalName + type: string + - name: userPrincipalName + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' + package: '@microsoft/sp-http!' fullName: userPrincipalName - langs: - - typeScript - type: property + summary: >- + The user's principal name. This will be used to ensure that the current + user's identity is used for fetching auth tokens. This parameter will + avoid the "Request is ambiguous: multiple user identities are avaliable + for the current request" error. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'userPrincipalName?: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 3244b37c..42a1a340 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -1,121 +1,119 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IDigestCache:interface' - summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb - URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, - specified via the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, - and expires after a server configurable amount of time. +### YamlMime:TSType +name: IDigestCache +uid: '@microsoft/sp-http!IDigestCache:interface' +package: '@microsoft/sp-http!' +fullName: IDigestCache +summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache + of request digests for each SPWeb URL. A request digest is a security token + that the SharePoint server requires for for any REST write operation, + specified via the "X-RequestDigest" HTTP header. It is obtained by calling the + "/\_api/contextinfo" REST endpoint, and expires after a server configurable + amount of time. - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) - name: IDigestCache - fullName: IDigestCache - langs: - - typeScript - type: interface + For more information, see the MSDN article ["Complete basic operations using + SharePoint 2013 REST endpoints"](.microsoft.com/en-us/library/office/jj164022.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' - - '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' - - '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' - - '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' - - uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' summary: >- - Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will - automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios + Inserts a specific request digest value into the cache. Normally this is + unnecessary because the framework will automatically issue a REST request + to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - langs: - - typeScript - type: method + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' - return: - type: - - void - description: '' + content: >- + addDigestToCache(webUrl: string, digestValue: string, + expirationTimestamp: number): void; parameters: - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: - - string + description: >- + The URL of the SPWeb that the API call will be issued to. This may + be a server-relative or absolute URL. + type: string - id: digestValue description: >- - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look - something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" - type: - - string + The digest value, which is an opaque that must be generated by the + SharePoint server. The syntax will look something like this: + "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + type: string - id: expirationTimestamp description: >- - A future point in time, as measured by performance.now(), after which the digest value will no longer be - valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for - example, to specify an expiration "5 seconds from right now", use performance.now()+5000. - type: - - number - - uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' - summary: Clears all values from the cache. - name: clearAllDigests() + A future point in time, as measured by performance.now(), after + which the digest value will no longer be valid. NOTE: The + expirationTime is a DOMHighResTimeStamp value whose units are + fractional milliseconds; for example, to specify an expiration "5 + seconds from right now", use performance.now()+5000. + type: number + return: + type: void + description: '' + - name: clearAllDigests() + uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' + package: '@microsoft/sp-http!' fullName: clearAllDigests() - langs: - - typeScript - type: method + summary: Clears all values from the cache. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'clearAllDigests(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' - summary: >- - Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a - digest was invalidated prior to its expiration time. - name: clearDigest(webUrl) + - name: clearDigest(webUrl) + uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' + package: '@microsoft/sp-http!' fullName: clearDigest(webUrl) - langs: - - typeScript - type: method + summary: >- + Clears the cached digest for the specified SPWeb URL. This operation is + useful e.g. if an error indicates that a digest was invalidated prior to + its expiration time. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'clearDigest(webUrl: string): boolean;' - return: - type: - - boolean - description: Returns true if a cache entry was found and deleted; false otherwise. parameters: - id: webUrl - description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. - type: - - string - - uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' + description: >- + The URL of the SPWeb whose digest should be cleared. This may be a + server-relative or absolute URL. + type: string + return: + type: boolean + description: Returns true if a cache entry was found and deleted; false otherwise. + - name: fetchDigest(webUrl) + uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' + package: '@microsoft/sp-http!' + fullName: fetchDigest(webUrl) summary: >- - Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is - fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the + Returns a digest string for the specified SPWeb URL. If the cache already + contains a usable value, the promise is fulfilled immediately. Otherwise, + the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. - name: fetchDigest(webUrl) - fullName: fetchDigest(webUrl) - langs: - - typeScript - type: method + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'fetchDigest(webUrl: string): Promise;' - return: - type: - - '@microsoft/sp-http!IDigestCache#fetchDigest~0:complex' - description: A promise that is fulfilled with the digest value. parameters: - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: - - string -references: - - uid: '@microsoft/sp-http!IDigestCache#fetchDigest~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: + description: >- + The URL of the SPWeb that the API call will be issued to. This may + be a server-relative or absolute URL. + type: string + return: + type: '@microsoft/sp-http!IDigestCache#' + description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml b/SP-Framework/sp-http/igraphhttpclientconfiguration.yml index 9de703ee..962d2d30 100644 --- a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/igraphhttpclientconfiguration.yml @@ -1,15 +1,12 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.IGraphHttpClientConfiguration - summary: Flags interface for GraphHttpClientCommonConfiguration - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: IGraphHttpClientConfiguration - fullName: IGraphHttpClientConfiguration - langs: - - typeScript - type: interface - extends: - - IHttpClientConfiguration - package: sp-http +### YamlMime:TSType +name: IGraphHttpClientConfiguration +uid: sp-http.IGraphHttpClientConfiguration +package: sp-http +fullName: IGraphHttpClientConfiguration +summary: Flags interface for GraphHttpClientCommonConfiguration +remarks: '' +isPreview: true +isDeprecated: true +customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. +type: interface +extends: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml index 5a1d6c4d..692150af 100644 --- a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml @@ -1,38 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.IGraphHttpClientConfigurations - summary: Standard configurations for GraphHttpClient. - remarks: >- - This interface provides standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient - class. In general, clients should choose the latest available version number, which enables all the switches that - are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was - tested.) - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: IGraphHttpClientConfigurations - fullName: IGraphHttpClientConfigurations - langs: - - typeScript - type: interface - package: sp-http - children: - - sp-http.IGraphHttpClientConfigurations.v1 - - uid: sp-http.IGraphHttpClientConfigurations.v1 - summary: >- - This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially - identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - deprecated: - content: The GraphHttpClient class has been superceded by the MSGraphClient class. - isPreview: true - name: v1 - fullName: v1 - langs: - - typeScript - type: property - syntax: - content: 'readonly v1: GraphHttpClientConfiguration;' - return: - type: - - GraphHttpClientConfiguration +### YamlMime:TSType +name: IGraphHttpClientConfigurations +uid: sp-http.IGraphHttpClientConfigurations +package: sp-http +fullName: IGraphHttpClientConfigurations +summary: Standard configurations for GraphHttpClient. +remarks: >- + This interface provides standard predefined GraphHttpClientConfiguration + objects for use with the GraphHttpClient class. In general, clients should + choose the latest available version number, which enables all the switches + that are recommended for typical scenarios. (If new switches are introduced in + the future, a new version number will be introduced, which ensures that + existing code will continue to function the way it did at the time when it was + tested.) +isPreview: true +isDeprecated: true +customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. +type: interface +properties: + - name: v1 + uid: sp-http.IGraphHttpClientConfigurations.v1 + package: sp-http + fullName: v1 + summary: >- + This configuration turns off every feature switch for HttpClient. The + fetch() behavior will be essentially identical to the WHATWG standard API + that is documented here: .spec.whatwg.org/ + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. + syntax: + content: 'readonly v1: GraphHttpClientConfiguration;' + return: + type: GraphHttpClientConfiguration diff --git a/SP-Framework/sp-http/igraphhttpclientoptions.yml b/SP-Framework/sp-http/igraphhttpclientoptions.yml index 0a844bab..f7aa9687 100644 --- a/SP-Framework/sp-http/igraphhttpclientoptions.yml +++ b/SP-Framework/sp-http/igraphhttpclientoptions.yml @@ -1,16 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.IGraphHttpClientOptions - summary: Options for HttpClient - remarks: >- - This interface defines the options for the GraphHttpClient operations such as get(), post(), fetch(), etc. It is - based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ - isPreview: true - name: IGraphHttpClientOptions - fullName: IGraphHttpClientOptions - langs: - - typeScript - type: interface - extends: - - sp-http.IHttpClientOptions - package: sp-http +### YamlMime:TSType +name: IGraphHttpClientOptions +uid: sp-http.IGraphHttpClientOptions +package: sp-http +fullName: IGraphHttpClientOptions +summary: Options for HttpClient +remarks: >- + This interface defines the options for the GraphHttpClient operations such as + get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters + that are documented here: https://fetch.spec.whatwg.org/ +isPreview: true +isDeprecated: false +type: interface +extends: sp-http.IHttpClientOptions diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index 5e5dae70..df0a8fce 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -1,10 +1,10 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - summary: Flags interface for HttpClientConfiguration. - name: IHttpClientConfiguration - fullName: IHttpClientConfiguration - langs: - - typeScript - type: interface - package: '@microsoft/sp-http!' +### YamlMime:TSType +name: IHttpClientConfiguration +uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: IHttpClientConfiguration +summary: Flags interface for HttpClientConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 2bc42ed5..1cdcad57 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -1,35 +1,32 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' - summary: Standard configurations for HttpClient. - remarks: >- - This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In - general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was - tested.) - name: IHttpClientConfigurations - fullName: IHttpClientConfigurations - langs: - - typeScript - type: interface - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!IHttpClientConfigurations#v1:member' - - uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' - summary: >- - This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially - identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - name: v1 - fullName: v1 - langs: - - typeScript - type: property - syntax: - content: 'readonly v1: HttpClientConfiguration;' - return: - type: - - '@microsoft/sp-http!default:class' -references: - - uid: '@microsoft/sp-http!default:class' - name: HttpClientConfiguration +### YamlMime:TSType +name: IHttpClientConfigurations +uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: IHttpClientConfigurations +summary: Standard configurations for HttpClient. +remarks: >- + This interface provides standard predefined HttpClientConfiguration objects + for use with the HttpClient class. In general, clients should choose the + latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the + future, a new version number will be introduced, which ensures that existing + code will continue to function the way it did at the time when it was tested.) +isPreview: false +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: >- + This configuration turns off every feature switch for HttpClient. The + fetch() behavior will be essentially identical to the WHATWG standard API + that is documented here: .spec.whatwg.org/ + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly v1: HttpClientConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index 49fc4ffc..b74eb3bf 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -1,20 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - summary: Options for HttpClient - remarks: >- - This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based - on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ - name: IHttpClientOptions - fullName: IHttpClientOptions - langs: - - typeScript - type: interface - extends: - - '!RequestInit:interface' - inheritance: - - type: '!RequestInit:interface' - package: '@microsoft/sp-http!' -references: - - uid: '!RequestInit:interface' - name: RequestInit +### YamlMime:TSType +name: IHttpClientOptions +uid: '@microsoft/sp-http!IHttpClientOptions:interface' +package: '@microsoft/sp-http!' +fullName: IHttpClientOptions +summary: Options for HttpClient +remarks: >- + This interface defines the options for the HttpClient operations such as + get(), post(), fetch(), etc. It is based on the whatwg API standard parameters + that are documented here: https://fetch.spec.whatwg.org/ +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index fbff5992..030db3fd 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -1,22 +1,11 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - summary: Flags interface for SPHttpClientBatchConfiguration. - isPreview: true - name: ISPHttpClientBatchConfiguration - fullName: ISPHttpClientBatchConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - inheritance: - - type: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - inheritance: - - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' - package: '@microsoft/sp-http!' -references: - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - name: ISPHttpClientCommonConfiguration - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfiguration +### YamlMime:TSType +name: ISPHttpClientBatchConfiguration +uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchConfiguration +summary: Flags interface for SPHttpClientBatchConfiguration. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 2e88baac..fd1262db 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -1,35 +1,32 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - summary: Standard configurations for SPHttpClient. - remarks: >- - This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the - SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all - the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new - version number will be introduced, which ensures that existing code will continue to function the way it did at - the time when it was tested.) - isPreview: true - name: ISPHttpClientBatchConfigurations - fullName: ISPHttpClientBatchConfigurations - langs: - - typeScript - type: interface - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' - summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' - isPreview: true - name: v1 - fullName: v1 - langs: - - typeScript - type: property - syntax: - content: 'readonly v1: SPHttpClientBatchConfiguration;' - return: - type: - - '@microsoft/sp-http!default:class' -references: - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientBatchConfiguration +### YamlMime:TSType +name: ISPHttpClientBatchConfigurations +uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchConfigurations +summary: Standard configurations for SPHttpClient. +remarks: >- + This interface provides standard predefined SPHttpClientBatchConfiguration + objects for use with the SPHttpClientBatch class. In general, clients should + choose the latest available version number, which enables all the switches + that are recommended for typical scenarios. (If new switches are introduced in + the future, a new version number will be introduced, which ensures that + existing code will continue to function the way it did at the time when it was + tested.) +isPreview: true +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: >- + Version 1 enables these switches: consoleLogging = true; jsonRequest = + true; jsonResponse = true + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly v1: SPHttpClientBatchConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 77834e6d..b81937e5 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -1,30 +1,31 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. - isPreview: true - name: ISPHttpClientBatchCreationOptions - fullName: ISPHttpClientBatchCreationOptions - langs: - - typeScript - type: interface - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' - - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' - summary: >- - SPHttpClientBatch will need to perform its POST to an endpoint such as - "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in - this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to - fetch(), but if not, the webUrl can be explicitly specified using this option. - isPreview: true - name: webUrl - fullName: webUrl - langs: - - typeScript - type: property - syntax: - content: 'webUrl?: string;' - return: - type: - - string +### YamlMime:TSType +name: ISPHttpClientBatchCreationOptions +uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchCreationOptions +summary: >- + This interface is passed to the SPHttpClientBatch constructor. It specifies + options that affect the entire batch. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: webUrl + uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' + package: '@microsoft/sp-http!' + fullName: webUrl + summary: >- + SPHttpClientBatch will need to perform its POST to an endpoint such as + ".com/sites/sample/\_api/$batch". Typically + the SPWeb URL (".com/sites/sample" in this + example) can be guessed by looking for a reserved URL segment such as + "\_api" in the first URL passed to fetch(), but if not, the webUrl can be + explicitly specified using this option. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'webUrl?: string;' + return: + type: string diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 422829a6..d185979e 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -1,24 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - summary: >- - This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is - based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ - isPreview: true - name: ISPHttpClientBatchOptions - fullName: ISPHttpClientBatchOptions - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-http!IHttpClientOptions:interface' - inheritance: - - type: '@microsoft/sp-http!IHttpClientOptions:interface' - inheritance: - - type: '!RequestInit:interface' - package: '@microsoft/sp-http!' -references: - - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - name: IHttpClientOptions - - uid: '!RequestInit:interface' - name: RequestInit +### YamlMime:TSType +name: ISPHttpClientBatchOptions +uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchOptions +summary: >- + This interface defines the options for an individual REST request that is part + of an SPHttpClientBatch. It is based on the WHATWG API standard parameters + that are documented here: .spec.whatwg.org/ +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index cff46a69..9a8b7338 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -1,64 +1,60 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - summary: Flags interface for SPHttpClientCommonConfiguration - name: ISPHttpClientCommonConfiguration - fullName: ISPHttpClientCommonConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - inheritance: - - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' - summary: Automatically configure the "Content-Type" header for a JSON payload. - remarks: >- - When this switch is true: - - - If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). - - - For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. - - - For OData 4.0, the value is 'application/json;charset=utf-8'. - name: jsonRequest - fullName: jsonRequest - langs: - - typeScript - type: property - syntax: - content: 'jsonRequest?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' - summary: Automatically configure the "Accept" header for a JSON payload. - remarks: |- - When this switch is true: - - If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. - - For OData 3.0, the value is 'application/json'. - - For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - name: jsonResponse - fullName: jsonResponse - langs: - - typeScript - type: property - syntax: - content: 'jsonResponse?: boolean;' - return: - type: - - boolean -references: - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfiguration +### YamlMime:TSType +name: ISPHttpClientCommonConfiguration +uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientCommonConfiguration +summary: Flags interface for SPHttpClientCommonConfiguration +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: jsonRequest + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' + package: '@microsoft/sp-http!' + fullName: jsonRequest + summary: Automatically configure the "Content-Type" header for a JSON payload. + remarks: >- + When this switch is true: + + + If the "Content-Type" header was not explicitly added for the request, + then SPHttpClient will add it if the request is a write operation (i.e. an + HTTP method other than "GET", "HEAD", or "OPTIONS"). + + + For OData 3.0, the value is + 'application/json;odata=verbose;charset=utf-8'. + + + For OData 4.0, the value is 'application/json;charset=utf-8'. + isPreview: false + isDeprecated: false + syntax: + content: 'jsonRequest?: boolean;' + return: + type: boolean + - name: jsonResponse + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' + package: '@microsoft/sp-http!' + fullName: jsonResponse + summary: Automatically configure the "Accept" header for a JSON payload. + remarks: >- + When this switch is true: + + + If the "Accept" header was not explicitly added for the request, then + SPHttpClient will add it. + + + For OData 3.0, the value is 'application/json'. + + + For OData 4.0, the value is 'application/json;odata.metadata=minimal'. + isPreview: false + isDeprecated: false + syntax: + content: 'jsonResponse?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 769ca429..8baf0251 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -1,86 +1,74 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - summary: Flags interface for SPHttpClientConfiguration. - name: ISPHttpClientConfiguration - fullName: ISPHttpClientConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - inheritance: - - type: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - inheritance: - - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' - - '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' - - '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' - - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' - summary: Automatically configure the "OData-Version" header. - remarks: >- - When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the - request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. - - - NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. - The recommended version is 4.0. - name: defaultODataVersion - fullName: defaultODataVersion - langs: - - typeScript - type: property - syntax: - content: 'defaultODataVersion?: ODataVersion;' - return: - type: - - '@microsoft/sp-http!default:class' - - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' - summary: Automatically configure the RequestInit.credentials. - remarks: >- - When this switch is true: - - - If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be - "same-origin". Without this switch, different web browsers may apply different defaults. - - - For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - name: defaultSameOriginCredentials - fullName: defaultSameOriginCredentials - langs: - - typeScript - type: property - syntax: - content: 'defaultSameOriginCredentials?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' - summary: Automatically provide an "X-RequestDigest" header for authentication. - remarks: >- - When this switch is true: - - - If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - name: requestDigest - fullName: requestDigest - langs: - - typeScript - type: property - syntax: - content: 'requestDigest?: boolean;' - return: - type: - - boolean -references: - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - name: ISPHttpClientCommonConfiguration - - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' - name: IHttpClientConfiguration - - uid: '@microsoft/sp-http!default:class' - name: ODataVersion +### YamlMime:TSType +name: ISPHttpClientConfiguration +uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientConfiguration +summary: Flags interface for SPHttpClientConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: defaultODataVersion + uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' + package: '@microsoft/sp-http!' + fullName: defaultODataVersion + summary: Automatically configure the "OData-Version" header. + remarks: >- + When this switch is specified (i.e. not undefined): If the "OData-Version" + header was not explicitly added for the request, then SPHttpClient will + add the header to specify the version indicated by defaultODataVersion. + + + NOTE: Without an 'OData-Version' header, the SharePoint server currently + defaults to Version 3.0 in most cases. The recommended version is 4.0. + isPreview: false + isDeprecated: false + syntax: + content: 'defaultODataVersion?: ODataVersion;' + return: + type: '' + - name: defaultSameOriginCredentials + uid: >- + @microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member + package: '@microsoft/sp-http!' + fullName: defaultSameOriginCredentials + summary: Automatically configure the RequestInit.credentials. + remarks: >- + When this switch is true: + + + If RequestInit.credentials is not explicitly specified for the request, + then SPHttpClient will assign it to be "same-origin". Without this switch, + different web browsers may apply different defaults. + + + For more information, see the spec: + https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + isPreview: false + isDeprecated: false + syntax: + content: 'defaultSameOriginCredentials?: boolean;' + return: + type: boolean + - name: requestDigest + uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' + package: '@microsoft/sp-http!' + fullName: requestDigest + summary: Automatically provide an "X-RequestDigest" header for authentication. + remarks: >- + When this switch is true: + + + If the "X-RequestDigest" header was not explicitly added for the request, + then SPHttpClient will add it if the request is a write operation (i.e. an + HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an + additional network request may be performed. + isPreview: false + isDeprecated: false + syntax: + content: 'requestDigest?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 8a319dc5..db70bb9b 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -1,38 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - summary: Standard configurations for SPHttpClient. - remarks: >- - This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. - In general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was - tested.) - name: ISPHttpClientConfigurations - fullName: ISPHttpClientConfigurations - langs: - - typeScript - type: interface - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' - - uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' - summary: >- - Version 1 enables these switches: - - - consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; - defaultODataVersion = ODataVersion.v4; requestDigest = true - name: v1 - fullName: v1 - langs: - - typeScript - type: property - syntax: - content: 'readonly v1: SPHttpClientConfiguration;' - return: - type: - - '@microsoft/sp-http!default:class' -references: - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientConfiguration +### YamlMime:TSType +name: ISPHttpClientConfigurations +uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientConfigurations +summary: Standard configurations for SPHttpClient. +remarks: >- + This interface provides standard predefined SPHttpClientConfiguration objects + for use with the SPHttpClient class. In general, clients should choose the + latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the + future, a new version number will be introduced, which ensures that existing + code will continue to function the way it did at the time when it was tested.) +isPreview: false +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: >- + Version 1 enables these switches: + + + consoleLogging = true; jsonRequest = true; jsonResponse = true; + defaultSameOriginCredentials = true; defaultODataVersion = + ODataVersion.v4; requestDigest = true + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly v1: SPHttpClientConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 7766f09b..ad735ad9 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -1,43 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' - summary: >- - This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is - based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ - name: ISPHttpClientOptions - fullName: ISPHttpClientOptions - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-http!IHttpClientOptions:interface' - inheritance: - - type: '@microsoft/sp-http!IHttpClientOptions:interface' - inheritance: - - type: '!RequestInit:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' - - uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' - summary: Configure the SPWeb URL for authentication. - remarks: >- - For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be - fetched using a seperate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the SPWeb - URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such - as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in - this case, the webUrl can be explicitly specified using this option. - name: webUrl - fullName: webUrl - langs: - - typeScript - type: property - syntax: - content: 'webUrl?: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-http!IHttpClientOptions:interface' - name: IHttpClientOptions - - uid: '!RequestInit:interface' - name: RequestInit +### YamlMime:TSType +name: ISPHttpClientOptions +uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientOptions +summary: >- + This interface defines the options for the SPHttpClient operations such as + get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters + that are documented here: .spec.whatwg.org/ +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: webUrl + uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' + package: '@microsoft/sp-http!' + fullName: webUrl + summary: Configure the SPWeb URL for authentication. + remarks: >- + For a write operation, SPHttpClient will automatically add the + "X-RequestDigest" header, which may need to be fetched using a seperate + request such as "https://example.com/sites/sample/\_api/contextinfo". + Typically the SPWeb URL ("https://example.com/sites/sample" in this + example) can be guessed by looking for a reserved URL segment such as + "\_api" in the original REST query, however certain REST endpoints do not + contain a reserved URL segment; in this case, the webUrl can be explicitly + specified using this option. + isPreview: false + isDeprecated: false + syntax: + content: 'webUrl?: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index 377c4481..dc3d4742 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -1,44 +1,36 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' - summary: Represents arguments used for raising a token acquisiton failure event. - name: ITokenAcquisitionEventArgs - fullName: ITokenAcquisitionEventArgs - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-core-library!SPEventArgs:class' - inheritance: - - type: '@microsoft/sp-core-library!SPEventArgs:class' +### YamlMime:TSType +name: ITokenAcquisitionEventArgs +uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' +package: '@microsoft/sp-http!' +fullName: ITokenAcquisitionEventArgs +summary: Represents arguments used for raising a token acquisiton failure event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: message + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' - - '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' - - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' - summary: The message returned from ADAL fails to retrieve a token from Azure AD. - name: message fullName: message - langs: - - typeScript - type: property + summary: The message returned from ADAL fails to retrieve a token from Azure AD. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'message: string;' return: - type: - - string - - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' - summary: The url of the page for the end user to interact with Azure AD. - name: redirectUrl + type: string + - name: redirectUrl + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' fullName: redirectUrl - langs: - - typeScript - type: property + summary: The url of the page for the end user to interact with Azure AD. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'redirectUrl?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs + type: string +extends: '' diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 0ba93d73..2e224bf8 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -1,59 +1,55 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!MSGraphClient:class' - summary: MSGraphClient is used to perform REST calls against Microsoft Graph. - remarks: >- - The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class - allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client - library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that - custom configuration for every request. +### YamlMime:TSType +name: MSGraphClient +uid: '@microsoft/sp-http!MSGraphClient:class' +package: '@microsoft/sp-http!' +fullName: MSGraphClient +summary: MSGraphClient is used to perform REST calls against Microsoft Graph. +remarks: >- + The Microsoft Graph JavaScript client library is a lightweight wrapper around + the Microsoft Graph API. This class allows developers to start making REST + calls to MSGraph without needing to initialize the the MSGraph client library. + If a custom configuration is desired, the MSGraphClient api function needs to + be provided with that custom configuration for every request. - For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClient` class. - name: MSGraphClient - fullName: MSGraphClient - langs: - - typeScript - type: class + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `MSGraphClient` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'api(path, config)' + uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!MSGraphClient#api:member(1)' - - uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' - summary: All calls to Microsoft Graph are chained together starting with the api function. + fullName: 'api(path, config)' + summary: >- + All calls to Microsoft Graph are chained together starting with the api + function. remarks: >- - Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* - https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship') + Path supports the following formats: \* me \* /me \* + https://graph.microsoft.com/v1.0/me \* https://graph.microsoft.com/beta/me + \* me/events?$filter=startswith(subject, 'ship') - The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See - the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - name: 'api(path, config)' - fullName: 'api(path, config)' - langs: - - typeScript - type: method + The authProvider and baseUrl option should not be used, as they have + already been provided by the framework. See the official documentation + here: https://github.com/microsoftgraph/msgraph-sdk-javascript + isPreview: false + isDeprecated: false syntax: content: 'api(path: string, config?: Options): IGraphRequest;' - return: - type: - - '@microsoft/sp-http!IGraphRequest:interface' - description: '' parameters: - id: path description: The path for the request to MSGraph. - type: - - string + type: string - id: config description: Sets the configuration for this request. - type: - - '@microsoft/microsoft-graph-client!Options:interface' -references: - - uid: '@microsoft/sp-http!IGraphRequest:interface' - name: IGraphRequest - - uid: '@microsoft/microsoft-graph-client!Options:interface' - name: Options + type: '' + return: + type: '' + description: '' diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index e1ac3cc5..5509db72 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -1,74 +1,50 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!MSGraphClientFactory:class' - summary: >- - Returns a preinitialized version of the MSGraphClient. For more information: - [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClientFactory` class. - name: MSGraphClientFactory - fullName: MSGraphClientFactory - langs: - - typeScript - type: class +### YamlMime:TSType +name: MSGraphClientFactory +uid: '@microsoft/sp-http!MSGraphClientFactory:class' +package: '@microsoft/sp-http!' +fullName: MSGraphClientFactory +summary: >- + Returns a preinitialized version of the MSGraphClient. For more information: + [.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `MSGraphClientFactory` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: serviceKey + uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for MSGraphClientFactory. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + @microsoft/sp-http!MSGraphClientFactory. +methods: + - name: getClient() + uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' - - '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' - - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' - summary: >- - Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service - Principal. - name: getClient() fullName: getClient() - langs: - - typeScript - type: method + summary: >- + Returns an instance of the MSGraphClient that communicates with the + current tenant's configurable Service Principal. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'getClient(): Promise;' return: - type: - - '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' + type: >- + @microsoft/sp-http!MSGraphClientFactory# description: '' - - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' - summary: The service key for MSGraphClientFactory. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-http!MSGraphClientFactory.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: MSGraphClient - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: MSGraphClientFactory - fullName: default - - name: '>' - fullName: '>' diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index cd0d6142..8a74a359 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -1,87 +1,73 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!ODataVersion:class' - summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' - name: ODataVersion - fullName: ODataVersion - langs: - - typeScript - type: class - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!ODataVersion#toString:member(1)' - - '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' - - '@microsoft/sp-http!ODataVersion.v3:member' - - '@microsoft/sp-http!ODataVersion.v4:member' - - uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' - summary: 'Returns the "OData-Version" value, for example "4.0".' - name: toString() - fullName: toString() - langs: - - typeScript - type: method - syntax: - content: 'toString(): string;' - return: - type: - - string - description: '' - - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' - summary: Attempt to parse the "OData-Version" header. - remarks: >- - If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown - if the version number is not supported. If the header is missing, then undefined is returned. - name: tryParseFromHeaders(headers) - fullName: tryParseFromHeaders(headers) - langs: - - typeScript - type: method - syntax: - content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' - return: - type: - - '@microsoft/sp-http!ODataVersion.tryParseFromHeaders~0:complex' - description: '' - parameters: - - id: headers - description: '' - type: - - '!Headers:interface' - - uid: '@microsoft/sp-http!ODataVersion.v3:member' - summary: Represents version 3.0 for the "OData-Version" header - name: v3 - fullName: v3 - langs: - - typeScript - type: property - syntax: - content: 'static v3: ODataVersion;' - return: - type: - - '@microsoft/sp-http!default:class' - - uid: '@microsoft/sp-http!ODataVersion.v4:member' - summary: Represents version 4.0 for the "OData-Version" header - name: v4 - fullName: v4 - langs: - - typeScript - type: property - syntax: - content: 'static v4: ODataVersion;' - return: - type: - - '@microsoft/sp-http!default:class' -references: - - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders~0:complex' - name: ODataVersion | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-http!default:class' - name: ODataVersion - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '!Headers:interface' - name: Headers - - uid: '@microsoft/sp-http!default:class' - name: ODataVersion +### YamlMime:TSType +name: ODataVersion +uid: '@microsoft/sp-http!ODataVersion:class' +package: '@microsoft/sp-http!' +fullName: ODataVersion +summary: >- + Represents supported version of the "OData-Version" header, which is part of + the Open Data Protocol standard. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: v3 + uid: '@microsoft/sp-http!ODataVersion.v3:member' + package: '@microsoft/sp-http!' + fullName: v3 + summary: Represents version 3.0 for the "OData-Version" header + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static v3: ODataVersion;' + return: + type: '' + - name: v4 + uid: '@microsoft/sp-http!ODataVersion.v4:member' + package: '@microsoft/sp-http!' + fullName: v4 + summary: Represents version 4.0 for the "OData-Version" header + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static v4: ODataVersion;' + return: + type: '' +methods: + - name: toString() + uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' + package: '@microsoft/sp-http!' + fullName: toString() + summary: 'Returns the "OData-Version" value, for example "4.0".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'toString(): string;' + return: + type: string + description: '' + - name: tryParseFromHeaders(headers) + uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' + package: '@microsoft/sp-http!' + fullName: tryParseFromHeaders(headers) + summary: Attempt to parse the "OData-Version" header. + remarks: >- + If the "OData-Version" header is present, this returns the corresponding + ODataVersion constant. An error is thrown if the version number is not + supported. If the header is missing, then undefined is returned. + isPreview: false + isDeprecated: false + syntax: + content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' + parameters: + - id: headers + description: '' + type: '' + return: + type: >- + @microsoft/sp-http!ODataVersion. + description: '' diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 912b3184..05e1d98f 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -1,307 +1,248 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpClient:class' - summary: >- - SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed - for writes, and collects telemetry that helps the service to monitor the performance of an application. - remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) - class. - name: SPHttpClient - fullName: SPHttpClient - langs: - - typeScript - type: class - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpClient:constructor(1)' - - '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' - - '@microsoft/sp-http!SPHttpClient.configurations:member' - - '@microsoft/sp-http!SPHttpClient#fetch:member(1)' - - '@microsoft/sp-http!SPHttpClient#get:member(1)' - - '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' - - '@microsoft/sp-http!SPHttpClient#post:member(1)' - - '@microsoft/sp-http!SPHttpClient.serviceKey:member' - - uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' - summary: Constructs a new instance of the `SPHttpClient` class - name: (constructor)(serviceScope) - fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - '@microsoft/sp-core-library!ServiceScope:class' - - uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' - summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' - isPreview: true - name: beginBatch(batchCreationOptions) - fullName: beginBatch(batchCreationOptions) - langs: - - typeScript - type: method - syntax: - content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' - return: - type: - - '@microsoft/sp-http!default:class' - description: >- - An [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) object used to manage the batch - operation. - parameters: - - id: batchCreationOptions - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - - uid: '@microsoft/sp-http!SPHttpClient.configurations:member' - summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. - name: configurations - fullName: configurations - langs: - - typeScript - type: property - syntax: - content: 'static readonly configurations: ISPHttpClientConfigurations;' - return: - type: - - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - - uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' - summary: Perform a REST service call. - remarks: >- - Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API - standard that is documented here: https://fetch.spec.whatwg.org/ - - - The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA - API's (which can be avoided by using HttpClient instead): - - - - Default "Accept" and "Content-Type" headers are added if not explicitly specified. - - - - For write operations, an "X-RequestDigest" header is automatically added - - - - The request digest token is automatically fetched and stored in a cache, with support for preloading - - - For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be - obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the - appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL - passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. - name: 'fetch(url, configuration, options)' - fullName: 'fetch(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!SPHttpClient#fetch~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of SPHttpClient; normally this should be the latest version number from - SPHttpClientConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!ISPHttpClientOptions:interface' - - uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' - summary: 'Calls fetch(), but sets the method to "GET".' - name: 'get(url, configuration, options)' - fullName: 'get(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!SPHttpClient#get~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of SPHttpClient; normally this should be the latest version number from - SPHttpClientConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!ISPHttpClientOptions:interface' - - uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' - summary: Use a heuristic to infer the base URL for authentication. - remarks: >- - Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path - components such as "\_api", "\_layouts", or "\_vit\_bin". This is necessary for operations such as the - X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a - request. - - - For example, if the requestUrl is "/sites/site/web/\_api/service", the returned URL would be "/sites/site/web". Or - if the requestUrl is "http://example.com/\_layouts/service", the returned URL would be "http://example.com". - - - If the URL cannot be determined, an exception is thrown. - name: getWebUrlFromRequestUrl(requestUrl) - fullName: getWebUrlFromRequestUrl(requestUrl) - langs: - - typeScript - type: method - syntax: - content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' - return: - type: - - string - description: the inferred SPWeb URL - parameters: - - id: requestUrl - description: The URL for a SharePoint REST service - type: - - string - - uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' - summary: 'Calls fetch(), but sets the method to "POST".' - name: 'post(url, configuration, options)' - fullName: 'post(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): - Promise; - return: - type: - - '@microsoft/sp-http!SPHttpClient#post~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of SPHttpClient; normally this should be the latest version number from - SPHttpClientConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!ISPHttpClientOptions:interface' - - uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' - summary: The service key for SPHttpClient. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-http!SPHttpClient.serviceKey~0:complex' -references: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientBatch - - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - name: ISPHttpClientBatchCreationOptions - - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - name: ISPHttpClientConfigurations - - uid: '@microsoft/sp-http!SPHttpClient#fetch~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' - name: ISPHttpClientOptions - - uid: '@microsoft/sp-http!SPHttpClient#get~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!SPHttpClient#post~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!SPHttpClient.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClient - fullName: default - - name: '>' - fullName: '>' +### YamlMime:TSType +name: SPHttpClient +uid: '@microsoft/sp-http!SPHttpClient:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClient +summary: >- + SPHttpClient is used to perform REST calls against SharePoint. It adds default + headers, manages the digest needed for writes, and collects telemetry that + helps the service to monitor the performance of an application. +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + For communicating with other internet services, use the + [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `SPHttpClient` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: configurations + uid: '@microsoft/sp-http!SPHttpClient.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: >- + The standard predefined SPHttpClientConfiguration objects for use with the + SPHttpClient class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly configurations: ISPHttpClientConfigurations;' + return: + type: >- + + - name: serviceKey + uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for SPHttpClient. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: '@microsoft/sp-http!SPHttpClient.' +methods: + - name: beginBatch(batchCreationOptions) + uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' + package: '@microsoft/sp-http!' + fullName: beginBatch(batchCreationOptions) + summary: >- + Begins an ODATA batch, which allows multiple REST queries to be bundled + into a single web request. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): + SPHttpClientBatch; + parameters: + - id: batchCreationOptions + description: '' + type: >- + + return: + type: '' + description: >- + An + [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) + object used to manage the batch operation. + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: Perform a REST service call. + remarks: >- + Generally, the parameters and semantics for SPHttpClient.fetch() are + essentially the same as the WHATWG API standard that is documented here: + https://fetch.spec.whatwg.org/ + + + The SPHttpClient subclass adds some additional behaviors that are + convenient when working with SharePoint ODATA API's (which can be avoided + by using HttpClient instead): + + + - Default "Accept" and "Content-Type" headers are added if not explicitly + specified. + + + - For write operations, an "X-RequestDigest" header is automatically added + + + - The request digest token is automatically fetched and stored in a cache, + with support for preloading + + + For a write operation, SPHttpClient will automatically add the + "X-RequestDigest" header, which may need to be obtained by issuing a + separate request such as + "https://example.com/sites/sample/\_api/contextinfo". Typically the + appropriate SPWeb URL can be guessed by looking for a reserved URL segment + such as "\_api" in the original URL passed to fetch(); if not, use + ISPHttpClientOptions.webUrl to specify it explicitly. + isPreview: false + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: SPHttpClientConfiguration, options: + ISPHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of SPHttpClient; normally this + should be the latest version number from SPHttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: '@microsoft/sp-http!SPHttpClient#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: SPHttpClientConfiguration, options?: + ISPHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of SPHttpClient; normally this + should be the latest version number from SPHttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: '@microsoft/sp-http!SPHttpClient#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. + - name: getWebUrlFromRequestUrl(requestUrl) + uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' + package: '@microsoft/sp-http!' + fullName: getWebUrlFromRequestUrl(requestUrl) + summary: Use a heuristic to infer the base URL for authentication. + remarks: >- + Attempts to infer the SPWeb URL associated with the provided REST URL, by + looking for common SharePoint path components such as "\_api", + "\_layouts", or "\_vit\_bin". This is necessary for operations such as the + X-RequestDigest and ODATA batching, which require POSTing to a separate + REST endpoint in order to complete a request. + + + For example, if the requestUrl is "/sites/site/web/\_api/service", the + returned URL would be "/sites/site/web". Or if the requestUrl is + "http://example.com/\_layouts/service", the returned URL would be + "http://example.com". + + + If the URL cannot be determined, an exception is thrown. + isPreview: false + isDeprecated: false + syntax: + content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' + parameters: + - id: requestUrl + description: The URL for a SharePoint REST service + type: string + return: + type: string + description: the inferred SPWeb URL + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: SPHttpClientConfiguration, options: + ISPHttpClientOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of SPHttpClient; normally this + should be the latest version number from SPHttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: '@microsoft/sp-http!SPHttpClient#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 6dfa88c2..72694cfc 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -1,240 +1,184 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpClientBatch:class' - summary: >- - The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. - This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html - - - The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call - SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves - when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an - SPHttpClientResponse object for that particular request. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPHttpClientBatch` class. - isPreview: true - name: SPHttpClientBatch - fullName: SPHttpClientBatch - langs: - - typeScript - type: class - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpClientBatch.configurations:member' - - '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' - - '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' - - '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' - - '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' - - uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' - summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. - isPreview: true - name: configurations - fullName: configurations - langs: - - typeScript - type: property - syntax: - content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' - return: - type: - - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - - uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' - summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). - isPreview: true - name: execute() - fullName: execute() - langs: - - typeScript - type: method - syntax: - content: 'execute(): Promise;' - return: - type: - - '@microsoft/sp-http!SPHttpClientBatch#execute~0:complex' - description: '' - - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' - summary: >- - Queues a new request, and returns a promise that can be used to access the server response (after execute() has - completed). - remarks: >- - The parameters for this function are basically the same as the WHATWG API standard documented here: - - - [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/) - - - However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation - for details. - - - When execute() is called, it will POST to a URL such as "http://example.com/sites/sample/\_api/$batch". Typically - SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as - "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it - explicitly. - isPreview: true - name: 'fetch(url, configuration, options)' - fullName: 'fetch(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): - Promise; - return: - type: - - '@microsoft/sp-http!SPHttpClientBatch#fetch~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of this request; normally this should be the latest version number from - SPHttpClientBatchConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - - uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' - summary: 'Calls fetch(), but sets the method to ''GET''.' - isPreview: true - name: 'get(url, configuration, options)' - fullName: 'get(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): - Promise; - return: - type: - - '@microsoft/sp-http!SPHttpClientBatch#get~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of this request; normally this should be the latest version number from - SPHttpClientBatchConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - - uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' - summary: 'Calls fetch(), but sets the method to ''POST''.' - isPreview: true - name: 'post(url, configuration, options)' - fullName: 'post(url, configuration, options)' - langs: - - typeScript - type: method - syntax: - content: >- - post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): - Promise; - return: - type: - - '@microsoft/sp-http!SPHttpClientBatch#post~0:complex' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - parameters: - - id: url - description: the URL to fetch - type: - - string - - id: configuration - description: >- - determines the default behavior of this request; normally this should be the latest version number from - SPHttpClientBatchConfigurations - type: - - '@microsoft/sp-http!default:class' - - id: options - description: additional options that affect the request - type: - - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' -references: - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - name: ISPHttpClientBatchConfigurations - - uid: '@microsoft/sp-http!SPHttpClientBatch#execute~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientBatch - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientBatchConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - name: ISPHttpClientBatchOptions - - uid: '@microsoft/sp-http!SPHttpClientBatch#get~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientResponse - fullName: default - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-http!SPHttpClientBatch#post~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientResponse - fullName: default - - name: '>' - fullName: '>' +### YamlMime:TSType +name: SPHttpClientBatch +uid: '@microsoft/sp-http!SPHttpClientBatch:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientBatch +summary: >- + The SPHttpClientBatch class accumulates a number of REST service calls and + transmits them as a single ODATA batch. This protocol is documented here: + .oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html + + + The usage is to call SPHttpClientBatch.fetch() to queue each individual + request, and then call SPHttpClientBatch.execute() to execute the batch + operation. The execute() method returns a promise that resolves when the real + REST call has completed. Each call to fetch() also returns a promise that will + resolve with an SPHttpClientResponse object for that particular request. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPHttpClientBatch` class. +isPreview: true +isDeprecated: false +type: class +properties: + - name: configurations + uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: >- + The standard predefined SPHttpClientBatchConfigurations objects for use + with the SPHttpClientBatch class. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' + return: + type: >- + +methods: + - name: execute() + uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' + package: '@microsoft/sp-http!' + fullName: execute() + summary: >- + Executes the batched queries that were queued using + SPHttpClientBatch.fetch(). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'execute(): Promise;' + return: + type: '@microsoft/sp-http!SPHttpClientBatch#' + description: '' + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: >- + Queues a new request, and returns a promise that can be used to access the + server response (after execute() has completed). + remarks: >- + The parameters for this function are basically the same as the WHATWG API + standard documented here: + + + [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/) + + + However, be aware that certain REST headers are ignored or not allowed + inside a batch. See the ODATA documentation for details. + + + When execute() is called, it will POST to a URL such as + "http://example.com/sites/sample/\_api/$batch". Typically + SPHttpClientBatch can successfully guess the appropriate SPWeb URL by + looking for a reserved URL segment such as "\_api" in the first URL passed + to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to + specify it explicitly. + isPreview: true + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: SPHttpClientBatchConfiguration, + options?: ISPHttpClientBatchOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of this request; normally this + should be the latest version number from + SPHttpClientBatchConfigurations + type: '' + - id: options + description: additional options that affect the request + type: >- + + return: + type: '@microsoft/sp-http!SPHttpClientBatch#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to ''GET''.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: SPHttpClientBatchConfiguration, + options?: ISPHttpClientBatchOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of this request; normally this + should be the latest version number from + SPHttpClientBatchConfigurations + type: '' + - id: options + description: additional options that affect the request + type: >- + + return: + type: '@microsoft/sp-http!SPHttpClientBatch#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to ''POST''.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: SPHttpClientBatchConfiguration, + options: ISPHttpClientBatchOptions): Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of this request; normally this + should be the latest version number from + SPHttpClientBatchConfigurations + type: '' + - id: options + description: additional options that affect the request + type: >- + + return: + type: '@microsoft/sp-http!SPHttpClientBatch#' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will + resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) + being false) for error status codes such as HTTP 404 or 500. The + promise will only reject for network failures or other errors that + prevent communication with the server. diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 42070683..629579d1 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -1,100 +1,103 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - summary: Configuration for SPHttpClientBatch. - remarks: >- - The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of - the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by - providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be - changed via the SPHttpClientBatchConfiguration.overrideWith() method. - isPreview: true - name: SPHttpClientBatchConfiguration - fullName: SPHttpClientBatchConfiguration - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-http!default:class' - inheritance: - - type: '@microsoft/sp-http!default:class' - implements: - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' - - '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' - - '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' - - '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' - - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' - summary: >- - Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be - used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - isPreview: true - name: '(constructor)(flags, overrideFlags)' - fullName: '(constructor)(flags, overrideFlags)' - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);' - parameters: - - id: flags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - id: overrideFlags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' - isPreview: true - name: flags - fullName: flags - langs: - - typeScript - type: property - syntax: - content: 'protected flags: ISPHttpClientBatchConfiguration;' - return: - type: - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' - isPreview: true - name: initializeFlags() - fullName: initializeFlags() - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: - - void - description: '' - - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' - isPreview: true - name: overrideWith(sourceFlags) - fullName: overrideWith(sourceFlags) - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' - parameters: - - id: sourceFlags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' -references: - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientCommonConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - name: ISPHttpClientBatchConfiguration +### YamlMime:TSType +name: SPHttpClientBatchConfiguration +uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientBatchConfiguration +summary: Configuration for SPHttpClientBatch. +remarks: >- + The SPHttpClientBatchConfiguration object provides a set of switches for + enabling/disabling various features of the SPHttpClientBatch class. Normally + these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by + providing one of the predefined defaults from SPHttpClientBatchConfigurations, + however switches can also be changed via the + SPHttpClientBatchConfiguration.overrideWith() method. +isPreview: true +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of SPHttpClientBatchConfiguration with the + specified flags. The default values will be used for any flags that are + missing or undefined. If overrideFlags is specified, it takes precedence + over flags. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: + ISPHttpClientBatchConfiguration); + parameters: + - id: flags + description: '' + type: >- + + - id: overrideFlags + description: '' + type: >- + +properties: + - name: flags + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'protected flags: ISPHttpClientBatchConfiguration;' + return: + type: >- + +methods: + - name: initializeFlags() + uid: >- + @microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1) + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + /** @override */ + + overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): + SPHttpClientBatchConfiguration; + parameters: + - id: sourceFlags + description: '' + type: >- + + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index d29ea6e5..ac5fbb35 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -1,137 +1,147 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. - name: SPHttpClientCommonConfiguration - fullName: SPHttpClientCommonConfiguration - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-http!default:class' - inheritance: - - type: '@microsoft/sp-http!default:class' - implements: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' - summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. - remarks: >- - The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it - takes precedence over flags. - name: '(constructor)(flags, overrideFlags)' - fullName: '(constructor)(flags, overrideFlags)' - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);' - parameters: - - id: flags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - id: overrideFlags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' - name: flags - fullName: flags - langs: - - typeScript - type: property - syntax: - content: 'protected flags: ISPHttpClientCommonConfiguration;' - return: - type: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' - name: initializeFlags() - fullName: initializeFlags() - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: - - void - description: '' - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' - summary: Automatically configure the "Content-Type" header for a JSON payload. - remarks: >- - When this switch is true: - - - If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). - - - For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. - - - For OData 4.0, the value is 'application/json;charset=utf-8'. - name: jsonRequest - fullName: jsonRequest - langs: - - typeScript - type: property - syntax: - content: 'readonly jsonRequest: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' - summary: Automatically configure the "Accept" header for a JSON payload. - remarks: |- - When this switch is true: - - If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. - - For OData 3.0, the value is 'application/json'. - - For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - name: jsonResponse - fullName: jsonResponse - langs: - - typeScript - type: property - syntax: - content: 'readonly jsonResponse: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' - name: overrideWith(sourceFlags) - fullName: overrideWith(sourceFlags) - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' - parameters: - - id: sourceFlags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' -references: - - uid: '@microsoft/sp-http!default:class' - name: HttpClientConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - name: ISPHttpClientCommonConfiguration +### YamlMime:TSType +name: SPHttpClientCommonConfiguration +uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientCommonConfiguration +summary: >- + Common base class for SPHttpClientConfiguration and + SPHttpClientBatchConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of SPHttpClientCommonConfiguration with the + specified flags. + remarks: >- + The default values will be used for any flags that are missing or + undefined. If overrideFlags is specified, it takes precedence over flags. + isPreview: false + isDeprecated: false + syntax: + content: >- + constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: + ISPHttpClientCommonConfiguration); + parameters: + - id: flags + description: '' + type: >- + + - id: overrideFlags + description: '' + type: >- + +properties: + - name: flags + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: ISPHttpClientCommonConfiguration;' + return: + type: >- + + - name: jsonRequest + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' + package: '@microsoft/sp-http!' + fullName: jsonRequest + summary: Automatically configure the "Content-Type" header for a JSON payload. + remarks: >- + When this switch is true: + + + If the "Content-Type" header was not explicitly added for the request, + then SPHttpClient will add it if the request is a write operation (i.e. an + HTTP method other than "GET", "HEAD", or "OPTIONS"). + + + For OData 3.0, the value is + 'application/json;odata=verbose;charset=utf-8'. + + + For OData 4.0, the value is 'application/json;charset=utf-8'. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly jsonRequest: boolean;' + return: + type: boolean + - name: jsonResponse + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' + package: '@microsoft/sp-http!' + fullName: jsonResponse + summary: Automatically configure the "Accept" header for a JSON payload. + remarks: >- + When this switch is true: + + + If the "Accept" header was not explicitly added for the request, then + SPHttpClient will add it. + + + For OData 3.0, the value is 'application/json'. + + + For OData 4.0, the value is 'application/json;odata.metadata=minimal'. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly jsonResponse: boolean;' + return: + type: boolean +methods: + - name: initializeFlags() + uid: >- + @microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1) + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + /** @override */ + + overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): + SPHttpClientCommonConfiguration; + parameters: + - id: sourceFlags + description: '' + type: >- + + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 7074ce51..79db0ffb 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -1,157 +1,159 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' - summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' - remarks: >- - The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of - the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the - SPHttpClientConfiguration.overrideWith() method. - name: SPHttpClientConfiguration - fullName: SPHttpClientConfiguration - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-http!default:class' - inheritance: - - type: '@microsoft/sp-http!default:class' - implements: - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' - - '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' - - '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' - - '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' - - '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' - - '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' - - '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' - - uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' - summary: >- - Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used - for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - name: '(constructor)(flags, overrideFlags)' - fullName: '(constructor)(flags, overrideFlags)' - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);' - parameters: - - id: flags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - id: overrideFlags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' - summary: Automatically configure the "OData-Version" header. - remarks: >- - When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the - request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. - - - NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. - The recommended version is 4.0. - name: defaultODataVersion - fullName: defaultODataVersion - langs: - - typeScript - type: property - syntax: - content: 'readonly defaultODataVersion: ODataVersion;' - return: - type: - - '@microsoft/sp-http!default:class' - - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' - summary: Automatically configure the RequestInit.credentials. - remarks: >- - When this switch is true: - - - If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be - "same-origin". Without this switch, different web browsers may apply different defaults. - - - For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - name: defaultSameOriginCredentials - fullName: defaultSameOriginCredentials - langs: - - typeScript - type: property - syntax: - content: 'readonly defaultSameOriginCredentials: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' - name: flags - fullName: flags - langs: - - typeScript - type: property - syntax: - content: 'protected flags: ISPHttpClientConfiguration;' - return: - type: - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' - name: initializeFlags() - fullName: initializeFlags() - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: - - void - description: '' - - uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' - name: overrideWith(sourceFlags) - fullName: overrideWith(sourceFlags) - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' - parameters: - - id: sourceFlags - description: '' - type: - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' - summary: Automatically provide an "X-RequestDigest" header for authentication. - remarks: >- - When this switch is true: - - - If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - name: requestDigest - fullName: requestDigest - langs: - - typeScript - type: property - syntax: - content: 'readonly requestDigest: boolean;' - return: - type: - - boolean -references: - - uid: '@microsoft/sp-http!default:class' - name: SPHttpClientCommonConfiguration - - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - name: ISPHttpClientConfiguration +### YamlMime:TSType +name: SPHttpClientConfiguration +uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientConfiguration +summary: >- + Configuration for [SPHttpClient](xref:)<!-- -->. +remarks: >- + The SPHttpClientConfiguration object provides a set of switches for + enabling/disabling various features of the SPHttpClient class. Normally these + switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of + the predefined defaults from SPHttpClientConfigurations, however switches can + also be changed via the SPHttpClientConfiguration.overrideWith() method. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of SPHttpClientConfiguration with the specified + flags. The default values will be used for any flags that are missing or + undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + constructor(flags: ISPHttpClientConfiguration, overrideFlags?: + ISPHttpClientConfiguration); + parameters: + - id: flags + description: '' + type: >- + + - id: overrideFlags + description: '' + type: >- + +properties: + - name: defaultODataVersion + uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' + package: '@microsoft/sp-http!' + fullName: defaultODataVersion + summary: Automatically configure the "OData-Version" header. + remarks: >- + When this switch is specified (i.e. not undefined): If the "OData-Version" + header was not explicitly added for the request, then SPHttpClient will + add the header to specify the version indicated by defaultODataVersion. + + + NOTE: Without an 'OData-Version' header, the SharePoint server currently + defaults to Version 3.0 in most cases. The recommended version is 4.0. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly defaultODataVersion: ODataVersion;' + return: + type: '' + - name: defaultSameOriginCredentials + uid: >- + @microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member + package: '@microsoft/sp-http!' + fullName: defaultSameOriginCredentials + summary: Automatically configure the RequestInit.credentials. + remarks: >- + When this switch is true: + + + If RequestInit.credentials is not explicitly specified for the request, + then SPHttpClient will assign it to be "same-origin". Without this switch, + different web browsers may apply different defaults. + + + For more information, see the spec: + https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + isPreview: false + isDeprecated: false + syntax: + content: 'readonly defaultSameOriginCredentials: boolean;' + return: + type: boolean + - name: flags + uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: ISPHttpClientConfiguration;' + return: + type: '' + - name: requestDigest + uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' + package: '@microsoft/sp-http!' + fullName: requestDigest + summary: Automatically provide an "X-RequestDigest" header for authentication. + remarks: >- + When this switch is true: + + + If the "X-RequestDigest" header was not explicitly added for the request, + then SPHttpClient will add it if the request is a write operation (i.e. an + HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an + additional network request may be performed. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly requestDigest: boolean;' + return: + type: boolean +methods: + - name: initializeFlags() + uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + /** @override */ + + overrideWith(sourceFlags: ISPHttpClientConfiguration): + SPHttpClientConfiguration; + parameters: + - id: sourceFlags + description: '' + type: >- + + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index d361054b..d0661487 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -1,81 +1,66 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpClientResponse:class' - summary: The Response subclass returned by methods such as SPHttpClient.fetch(). - remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. - - This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. - name: SPHttpClientResponse - fullName: SPHttpClientResponse - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-http!default:class' - inheritance: - - type: '@microsoft/sp-http!default:class' - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' - - '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' - - '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' - - uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' - summary: Constructs a new instance of the `SPHttpClientResponse` class - name: (constructor)(response) - fullName: (constructor)(response) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(response: Response);' - parameters: - - id: response - description: '' - type: - - '!Response:interface' - - uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' - name: clone() - fullName: clone() - langs: - - typeScript - type: method - syntax: - content: |- - /** @override */ - clone(): SPHttpClientResponse; - return: - type: - - '@microsoft/sp-http!default:class' - description: '' - - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' - summary: Returns the SharePoint correlation ID. - remarks: >- - The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, - but may originate from different services or components. SharePoint REST operations return the server's - correlation ID as the "sprequestguid" header. - isPreview: true - name: correlationId - fullName: correlationId - langs: - - typeScript - type: property - syntax: - content: 'readonly correlationId: Guid | undefined;' - return: - type: - - '@microsoft/sp-http!SPHttpClientResponse#correlationId~0:complex' -references: - - uid: '@microsoft/sp-http!default:class' - name: HttpClientResponse - - uid: '!Response:interface' - name: Response - - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId~0:complex' - name: Guid | undefined - fullName: Guid | undefined - spec.typeScript: - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid - fullName: Guid - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: SPHttpClientResponse +uid: '@microsoft/sp-http!SPHttpClientResponse:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientResponse +summary: The Response subclass returned by methods such as SPHttpClient.fetch(). +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + This is a placeholder. In the future, additional SPHttpClient-specific + functionality may be added to this class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(response) + uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(response) + summary: Constructs a new instance of the `SPHttpClientResponse` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(response: Response);' + parameters: + - id: response + description: '' + type: '' +properties: + - name: correlationId + uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' + package: '@microsoft/sp-http!' + fullName: correlationId + summary: Returns the SharePoint correlation ID. + remarks: >- + The correlation ID is a Guid that can be used to associate log events that + are part of the same overall operation, but may originate from different + services or components. SharePoint REST operations return the server's + correlation ID as the "sprequestguid" header. + isPreview: true + isDeprecated: false + syntax: + content: 'readonly correlationId: Guid | undefined;' + return: + type: >- + @microsoft/sp-http!SPHttpClientResponse# +methods: + - name: clone() + uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' + package: '@microsoft/sp-http!' + fullName: clone() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + clone(): SPHttpClientResponse; + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 45eb0a18..0f960351 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -1,25 +1,22 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!SPHttpHeader:enum' - summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' - isPreview: true - name: SPHttpHeader - fullName: SPHttpHeader - langs: - - typeScript - type: enum - package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' - - uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' - summary: |- - SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request. - - Example value: "9417279e-40e1-0000-2465-306ba786bfd7" - isPreview: true - name: SPRequestGuid - fullName: SPRequestGuid - langs: - - typeScript - type: field - numericValue: '"SPRequestGuid"' +### YamlMime:TSEnum +name: SPHttpHeader +uid: '@microsoft/sp-http!SPHttpHeader:enum' +package: '@microsoft/sp-http!' +fullName: SPHttpHeader +summary: >- + Standard HTTP headers used with [SPHttpClient](xref:) +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: SPRequestGuid + uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' + package: '@microsoft/sp-http!' + summary: >- + SharePoint uses the 'SPRequestGuid' header to return the server's + correlation ID for a request. + + + Example value: "9417279e-40e1-0000-2465-306ba786bfd7" + numericValue: '"SPRequestGuid"' diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index dda6fa0c..18593f96 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -1,63 +1,56 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' - summary: Arguments for a token acquisition failure event. - name: TokenAcquisitionEventArgs - fullName: TokenAcquisitionEventArgs - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-core-library!SPEventArgs:class' - inheritance: - - type: '@microsoft/sp-core-library!SPEventArgs:class' +### YamlMime:TSType +name: TokenAcquisitionEventArgs +uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' +package: '@microsoft/sp-http!' +fullName: TokenAcquisitionEventArgs +summary: Arguments for a token acquisition failure event. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(message, redirectUrl)' + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' package: '@microsoft/sp-http!' - children: - - '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' - - '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' - - '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' - - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' - summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class - name: '(constructor)(message, redirectUrl)' fullName: '(constructor)(message, redirectUrl)' - langs: - - typeScript - type: constructor + summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(message: string, redirectUrl?: string);' parameters: - id: message description: '' - type: - - string + type: string - id: redirectUrl description: '' - type: - - string - - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' - summary: The message returned from ADAL fails to retrieve a token from Azure AD. - name: message + type: string +properties: + - name: message + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' + package: '@microsoft/sp-http!' fullName: message - langs: - - typeScript - type: property + summary: The message returned from ADAL fails to retrieve a token from Azure AD. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'message: string;' return: - type: - - string - - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' - summary: The url of the page for the end user to perform Multi Factor Authentication - name: redirectUrl + type: string + - name: redirectUrl + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' fullName: redirectUrl - langs: - - typeScript - type: property + summary: >- + The url of the page for the end user to perform Multi Factor + Authentication + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'redirectUrl?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs + type: string +extends: '' diff --git a/SP-Framework/sp-list-subscription.yml b/SP-Framework/sp-list-subscription.yml index ae4dffc5..346b6d88 100644 --- a/SP-Framework/sp-list-subscription.yml +++ b/SP-Framework/sp-list-subscription.yml @@ -1,26 +1,13 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-list-subscription!' - summary: This package provides developer support for subscribing to changes in a SharePoint document library. - remarks: >- - This package creates and manages subscriptions to SharePoint document libraries. It registers callbacks provided - by the developer with the subscription to handle subscription events. - name: '@microsoft/sp-list-subscription' - fullName: '@microsoft/sp-list-subscription' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - - '@microsoft/sp-list-subscription!IListSubscription:interface' - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' - - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' -references: - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - name: ICreateSubscriptionSettings - - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' - name: IListSubscription - - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' - name: ISubscriptionCallbacks - - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' - name: ListSubscriptionFactory +### YamlMime:TSPacakge +uid: '@microsoft/sp-list-subscription!' +name: '@microsoft/sp-list-subscription' +type: package +summary: >- + This package provides developer support for subscribing to changes in a + SharePoint document library. +interfaces: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - '@microsoft/sp-list-subscription!IListSubscription:interface' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' +classes: + - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 35db81df..8f68bb93 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -1,92 +1,92 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - summary: >- - A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a - web, you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you - will need to provide it as well. +### YamlMime:TSType +name: ICreateSubscriptionSettings +uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' +package: '@microsoft/sp-list-subscription!' +fullName: ICreateSubscriptionSettings +summary: >- + A list subscription requires at least a site ID and list ID. If the list is + not contained in the root site of a web, you need to pass in the subweb id. If + the domain you are accessing is different than the current domain, you will + need to provide it as well. - In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, - and the current domain, site and web will be used. - name: ICreateSubscriptionSettings - fullName: ICreateSubscriptionSettings - langs: - - typeScript - type: interface + In the simple case (say a teamsite document library) in the current site, you + can simply provide the library ID, and the current domain, site and web will + be used. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: callbacks + uid: >- + @microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member package: '@microsoft/sp-list-subscription!' - children: - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' - summary: the list of callbacks - name: callbacks fullName: callbacks - langs: - - typeScript - type: property + summary: the list of callbacks + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'callbacks: ISubscriptionCallbacks;' return: - type: - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' - summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' - name: domain + type: >- + + - name: domain + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' + package: '@microsoft/sp-list-subscription!' fullName: domain - langs: - - typeScript - type: property + summary: >- + In the case of a multi-geography tenancy, you need to provide the domain + that the site collection lives in. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'domain?: string;' return: - type: - - string - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' - summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' - name: listId + type: string + - name: listId + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' + package: '@microsoft/sp-list-subscription!' fullName: listId - langs: - - typeScript - type: property + summary: >- + The Guid of the Sharepoint List. At this point, it needs to be a document + library, and not just a list. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'listId?: Guid;' return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' - summary: >- - The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current - site will be used. - name: siteId + type: '' + - name: siteId + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' + package: '@microsoft/sp-list-subscription!' fullName: siteId - langs: - - typeScript - type: property + summary: >- + The SharePoint Site Id (assuming it is not the current site) If the siteId + parameter is not provided, the current site will be used. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'siteId?: Guid;' return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' - summary: >- - The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web - will be used. - name: webId + type: '' + - name: webId + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' + package: '@microsoft/sp-list-subscription!' fullName: webId - langs: - - typeScript - type: property + summary: >- + The SharePoint Web Id (assuming it is not the current web) If the webId + parameter is not provided, the current web will be used. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'webId?: Guid;' return: - type: - - '@microsoft/sp-core-library!Guid:class' -references: - - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' - name: ISubscriptionCallbacks - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid + type: '' diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index 94f11568..cc5a9a7d 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -1,27 +1,25 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' - summary: A subscription to a SharePoint list resource. Contains the id of the subscription. - name: IListSubscription - fullName: IListSubscription - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IListSubscription +uid: '@microsoft/sp-list-subscription!IListSubscription:interface' +package: '@microsoft/sp-list-subscription!' +fullName: IListSubscription +summary: >- + A subscription to a SharePoint list resource. Contains the id of the + subscription. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' package: '@microsoft/sp-list-subscription!' - children: - - '@microsoft/sp-list-subscription!IListSubscription#id:member' - - uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' - summary: The id of the subscription. - name: id fullName: id - langs: - - typeScript - type: property + summary: The id of the subscription. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'id: Guid;' return: - type: - - '@microsoft/sp-core-library!Guid:class' -references: - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid + type: '' diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index fcac1ebc..0fda4eff 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -1,50 +1,49 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' - summary: The callbacks that can be triggered by a subscription event. - name: ISubscriptionCallbacks - fullName: ISubscriptionCallbacks - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ISubscriptionCallbacks +uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' +package: '@microsoft/sp-list-subscription!' +fullName: ISubscriptionCallbacks +summary: The callbacks that can be triggered by a subscription event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: connect + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' package: '@microsoft/sp-list-subscription!' - children: - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' - - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' - summary: The callback to invoke when a connection has been made to the list. - name: connect fullName: connect - langs: - - typeScript - type: property + summary: The callback to invoke when a connection has been made to the list. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'connect?: () => void;' return: - type: - - () => void - - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' - summary: The callback to invoke when the subscription is disconnected from the list. - name: disconnect + type: () => void + - name: disconnect + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' + package: '@microsoft/sp-list-subscription!' fullName: disconnect - langs: - - typeScript - type: property + summary: >- + The callback to invoke when the subscription is disconnected from the + list. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disconnect?: (reason: string) => void;' return: - type: - - '(reason: string) => void' - - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' - summary: The callback to invoke when a change occurs in the list. - name: notification + type: '(reason: string) => void' + - name: notification + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' + package: '@microsoft/sp-list-subscription!' fullName: notification - langs: - - typeScript - type: property + summary: The callback to invoke when a change occurs in the list. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'notification: () => void;' return: - type: - - () => void + type: () => void diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index ee5bce50..aae20977 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -1,87 +1,73 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' - summary: >- - Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the - subscription to handle subscription events. - name: ListSubscriptionFactory - fullName: ListSubscriptionFactory - langs: - - typeScript - type: class +### YamlMime:TSType +name: ListSubscriptionFactory +uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' +package: '@microsoft/sp-list-subscription!' +fullName: ListSubscriptionFactory +summary: >- + Creates and manages subscriptions to list resources. Registers callbacks + provided by the developer with the subscription to handle subscription events. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(component) + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' package: '@microsoft/sp-list-subscription!' - children: - - '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' - - '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' - - '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' - - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' - summary: Constructs a new instance of the `ListSubscriptionFactory` class - name: (constructor)(component) fullName: (constructor)(component) - langs: - - typeScript - type: constructor + summary: Constructs a new instance of the `ListSubscriptionFactory` class + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'constructor(component: BaseComponent);' parameters: - id: component description: '' - type: - - '@microsoft/sp-component-base!BaseComponent:class' - - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' - summary: Creates a connection to the list specified by the site id and list id. - name: createSubscription(settings) + type: '' +methods: + - name: createSubscription(settings) + uid: >- + @microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1) + package: '@microsoft/sp-list-subscription!' fullName: createSubscription(settings) - langs: - - typeScript - type: method + summary: Creates a connection to the list specified by the site id and list id. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'createSubscription(settings: ICreateSubscriptionSettings): Promise;' - return: - type: - - '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription~0:complex' - description: Promise of the subscription to the list. + content: >- + createSubscription(settings: ICreateSubscriptionSettings): + Promise; parameters: - id: settings description: The various parameters - type: - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' - summary: Deletes the subscription's connection to the resource. - name: deleteSubscription(subscription) + type: >- + + return: + type: >- + @microsoft/sp-list-subscription!ListSubscriptionFactory# + description: Promise of the subscription to the list. + - name: deleteSubscription(subscription) + uid: >- + @microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1) + package: '@microsoft/sp-list-subscription!' fullName: deleteSubscription(subscription) - langs: - - typeScript - type: method + summary: Deletes the subscription's connection to the resource. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'deleteSubscription(subscription: IListSubscription): void;' - return: - type: - - void - description: '' parameters: - id: subscription description: The subscription to delete. - type: - - '@microsoft/sp-list-subscription!IListSubscription:interface' -references: - - uid: '@microsoft/sp-component-base!BaseComponent:class' - name: BaseComponent - - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' - name: IListSubscription - fullName: IListSubscription - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - name: ICreateSubscriptionSettings - - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' - name: IListSubscription + type: >- + + return: + type: void + description: '' diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index c8f37945..8a1b8855 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -1,50 +1,23 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!' - summary: SharePoint Framework support for customizing the list view. - name: '@microsoft/sp-listview-extensibility' - fullName: '@microsoft/sp-listview-extensibility' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - - '@microsoft/sp-listview-extensibility!Command:class' - - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - - '@microsoft/sp-listview-extensibility!RowAccessor:class' - - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' -references: - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - name: BaseFieldCustomizer - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - name: BaseListViewCommandSet - - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - name: ColumnAccessor - - uid: '@microsoft/sp-listview-extensibility!Command:class' - name: Command - - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - name: FieldCustomizerContext - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - name: IFieldCustomizerCellEventParameters - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - name: IListViewCommandSetExecuteEventParameters - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - name: IListViewCommandSetListViewUpdatedParameters - - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - name: ListItemAccessor - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - name: ListViewAccessor - - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - name: ListViewCommandSetContext - - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - name: RowAccessor - - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' - name: SelectedRowsChangedEventArgs +### YamlMime:TSPacakge +uid: '@microsoft/sp-listview-extensibility!' +name: '@microsoft/sp-listview-extensibility' +type: package +summary: SharePoint Framework support for customizing the list view. +classes: + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + - '@microsoft/sp-listview-extensibility!Command:class' + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - '@microsoft/sp-listview-extensibility!RowAccessor:class' + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' +interfaces: + - >- + @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface + - >- + @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface + - >- + @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index eab3d73a..965c7c20 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -1,96 +1,83 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - summary: >- - This is the base class that third parties should extend when implementing a client-side extension that customizes - the appearance of fields in a SharePoint ListView. - - - In the component manifest, the "extensionType" should be set to "FieldCustomizer". - name: BaseFieldCustomizer - fullName: BaseFieldCustomizer - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~0:complex' - inheritance: - - type: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~1:complex' - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'protected readonly context: FieldCustomizerContext;' - return: - type: - - '@microsoft/sp-listview-extensibility!default:class' - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' - name: onDisposeCell(event) - fullName: onDisposeCell(event) - langs: - - typeScript - type: method - syntax: - content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' - return: - type: - - void - description: '' - parameters: - - id: event - description: '' - type: - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' - name: onRenderCell(event) - fullName: onRenderCell(event) - langs: - - typeScript - type: method - syntax: - content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' - return: - type: - - void - description: '' - parameters: - - id: event - description: '' - type: - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' -references: - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~0:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer~1:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-listview-extensibility!default:class' - name: FieldCustomizerContext - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - name: IFieldCustomizerCellEventParameters +### YamlMime:TSType +name: BaseFieldCustomizer +uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: BaseFieldCustomizer +summary: >- + This is the base class that third parties should extend when implementing a + client-side extension that customizes the appearance of fields in a SharePoint + ListView. + + + In the component manifest, the "extensionType" should be set to + "FieldCustomizer". +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: context + summary: >- + Use the context object to access common services and state associated with + the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly context: FieldCustomizerContext;' + return: + type: '' +methods: + - name: onDisposeCell(event) + uid: >- + @microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: onDisposeCell(event) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' + parameters: + - id: event + description: '' + type: >- + + return: + type: void + description: '' + - name: onRenderCell(event) + uid: >- + @microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: onRenderCell(event) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' + parameters: + - id: event + description: '' + type: >- + + return: + type: void + description: '' +extends: >- + diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 466f84a6..a5617e19 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -1,125 +1,112 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - summary: >- - This is the base class that third parties should extend when implementing a client-side extension that provides a - command set for a SharePoint list view. - remarks: >- - In the component manifest, the "extensionType" should be set to "ListViewCommandSet". - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseListViewCommandSet` class. - name: BaseListViewCommandSet - fullName: BaseListViewCommandSet - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~0:complex' - inheritance: - - type: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~1:complex' - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'readonly context: ListViewCommandSetContext;' - return: - type: - - '@microsoft/sp-listview-extensibility!default:class' - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' - summary: 'This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item.' - name: onExecute(event) - fullName: onExecute(event) - langs: - - typeScript - type: method - syntax: - content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' - return: - type: - - void - description: '' - parameters: - - id: event - description: '' - type: - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' - summary: This event occurs whenever the ListView state changes. - remarks: >- - This event allows the implementor to tailor the appearance of the command. For example, to hide the command, - assign its property visible = false. To customize the title, modify the command property title. - name: onListViewUpdated(event) - fullName: onListViewUpdated(event) - langs: - - typeScript - type: method - syntax: - content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' - return: - type: - - void - description: '' - parameters: - - id: event - description: '' - type: - - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' - summary: Returns the command with the given id. Returns undefined if there is not command with the given id. - name: tryGetCommand(id) - fullName: tryGetCommand(id) - langs: - - typeScript - type: method - syntax: - content: 'tryGetCommand(id: string): Command;' - return: - type: - - '@microsoft/sp-listview-extensibility!default:class' - description: '' - parameters: - - id: id - description: Id of the command - type: - - string -references: - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~0:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet~1:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-listview-extensibility!default:class' - name: ListViewCommandSetContext - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - name: IListViewCommandSetExecuteEventParameters - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - name: IListViewCommandSetListViewUpdatedParameters +### YamlMime:TSType +name: BaseListViewCommandSet +uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: BaseListViewCommandSet +summary: >- + This is the base class that third parties should extend when implementing a + client-side extension that provides a command set for a SharePoint list view. +remarks: >- + In the component manifest, the "extensionType" should be set to + "ListViewCommandSet". + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `BaseListViewCommandSet` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: context + summary: >- + Use the context object to access common services and state associated with + the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly context: ListViewCommandSetContext;' + return: + type: '' +methods: + - name: onExecute(event) + uid: >- + @microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: onExecute(event) + summary: >- + This event occurs when the command is invoked, e.g. because the user + clicked on the toolbar button or menu item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' + parameters: + - id: event + description: '' + type: >- + + return: + type: void + description: '' + - name: onListViewUpdated(event) + uid: >- + @microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: onListViewUpdated(event) + summary: This event occurs whenever the ListView state changes. + remarks: >- + This event allows the implementor to tailor the appearance of the command. + For example, to hide the command, assign its property visible = false. To + customize the title, modify the command property title. + isPreview: false + isDeprecated: false + syntax: + content: >- + onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): + void; + parameters: + - id: event + description: '' + type: >- + + return: + type: void + description: '' + - name: tryGetCommand(id) + uid: >- + @microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: tryGetCommand(id) + summary: >- + Returns the command with the given id. Returns undefined if there is not + command with the given id. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetCommand(id: string): Command;' + parameters: + - id: id + description: Id of the command + type: string + return: + type: '' + description: '' +extends: >- + diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 5947dc43..8404cd02 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -1,50 +1,49 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - summary: 'Provides access to a ListView column, which is the visual presentation of a field.' - remarks: >- - A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item - represents a document, then the field is sometimes called a "property".) - - - A "column" is the visual presentation of a field, when displayed by the ListView. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ColumnAccessor` class. - name: ColumnAccessor - fullName: ColumnAccessor - langs: - - typeScript - type: class - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' - - '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' - - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' - summary: The server-side definition of the field. This property is read-only. - name: field - fullName: field - langs: - - typeScript - type: property - syntax: - content: 'abstract readonly field: SPField;' - return: - type: - - '@microsoft/sp-page-context!SPField:class' - - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' - summary: Whether to show this column in the list view. This property is read-only. - name: visible - fullName: visible - langs: - - typeScript - type: property - syntax: - content: 'abstract readonly visible: boolean;' - return: - type: - - boolean -references: - - uid: '@microsoft/sp-page-context!SPField:class' - name: SPField +### YamlMime:TSType +name: ColumnAccessor +uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ColumnAccessor +summary: >- + Provides access to a ListView column, which is the visual presentation of a + field. +remarks: >- + A SharePoint "field" (SPField) defines the data storage for a property of a + list item. (If the list item represents a document, then the field is + sometimes called a "property".) + + + A "column" is the visual presentation of a field, when displayed by the + ListView. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `ColumnAccessor` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: field + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: field + summary: The server-side definition of the field. This property is read-only. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract readonly field: SPField;' + return: + type: '' + - name: visible + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: visible + summary: Whether to show this column in the list view. This property is read-only. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract readonly visible: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 26aafcde..01485294 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -1,96 +1,94 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!Command:class' - summary: Represents a command belonging to a command set. - remarks: >- - The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, - context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the - corresponding Command object can be obtained by calling - [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, for example to hide a command that is - not contextually relevant, or to pluralize the title based on the number of selected items. - name: Command - fullName: Command - langs: - - typeScript - type: class - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' - - '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' - - '@microsoft/sp-listview-extensibility!Command#id:member' - - '@microsoft/sp-listview-extensibility!Command#title:member' - - '@microsoft/sp-listview-extensibility!Command#visible:member' - - uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' - summary: >- - Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by - default. Example: "Show information. Press ENTER to select." - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel: string | undefined;' - return: - type: - - string | undefined - - uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' - summary: >- - An optional URL for an image to be displayed next to the command. The requirements for this image are defined by - the type of extension; some extension types may not display the image at all. - remarks: This must be a absolute URL. - name: iconImageUrl - fullName: iconImageUrl - langs: - - typeScript - type: property - syntax: - content: 'iconImageUrl: string | undefined;' - return: - type: - - string | undefined - - uid: '@microsoft/sp-listview-extensibility!Command#id:member' - summary: Id of the command. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'id: string;' - return: - type: - - string - - uid: '@microsoft/sp-listview-extensibility!Command#title:member' - summary: 'A short label to be displayed by the associated button, menu item, etc.' - remarks: >- - Example: "Show information" - - - Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or - toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically - alters the meaning of the command, because administrators should be able to examine the extension manifest to - understand which commands are being implemented by a given extension. - name: title - fullName: title - langs: - - typeScript - type: property - syntax: - content: 'title: string;' - return: - type: - - string - - uid: '@microsoft/sp-listview-extensibility!Command#visible:member' - summary: True if the command is visible. - name: visible - fullName: visible - langs: - - typeScript - type: property - syntax: - content: 'visible: boolean;' - return: - type: - - boolean +### YamlMime:TSType +name: Command +uid: '@microsoft/sp-listview-extensibility!Command:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: Command +summary: Represents a command belonging to a command set. +remarks: >- + The BaseListViewCommandSet extension type exposes generalized commands that + may be displayed as tool bar buttons, context menu items, etc. These commands + are initially defined in the extension’s manifest file. At runtime, the + corresponding Command object can be obtained by calling + [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, + for example to hide a command that is not contextually relevant, or to + pluralize the title based on the number of selected items. +isPreview: false +isDeprecated: false +type: class +properties: + - name: ariaLabel + uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: ariaLabel + summary: >- + Custom accessibility text for the browser's "aria-label" attribute. If + omitted, the title property will be used by default. Example: "Show + information. Press ENTER to select." + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel: string | undefined;' + return: + type: string | undefined + - name: iconImageUrl + uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: iconImageUrl + summary: >- + An optional URL for an image to be displayed next to the command. The + requirements for this image are defined by the type of extension; some + extension types may not display the image at all. + remarks: This must be a absolute URL. + isPreview: false + isDeprecated: false + syntax: + content: 'iconImageUrl: string | undefined;' + return: + type: string | undefined + - name: id + uid: '@microsoft/sp-listview-extensibility!Command#id:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: id + summary: Id of the command. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-listview-extensibility!Command#title:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: title + summary: 'A short label to be displayed by the associated button, menu item, etc.' + remarks: >- + Example: "Show information" + + + Altering the title property is intended to allow minor changes to the + title, e.g. “Submit these 3 items” or toggling between “Schedule” and + “Unschedule”. Developers are discouraged from assigning a title that + radically alters the meaning of the command, because administrators should + be able to examine the extension manifest to understand which commands are + being implemented by a given extension. + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string + - name: visible + uid: '@microsoft/sp-listview-extensibility!Command#visible:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: visible + summary: True if the command is visible. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 1a95c9ec..3fdc3dda 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -1,68 +1,53 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - summary: This object provides contextual information for BaseFieldCustomizer. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `FieldCustomizerContext` class. - name: FieldCustomizerContext - fullName: FieldCustomizerContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponentContext:class' - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' - - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' - - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' - summary: Provides access to the SharePoint field that the customizer will operate on. - name: field - fullName: field - langs: - - typeScript - type: property - syntax: - content: 'readonly field: SPField;' - return: - type: - - '@microsoft/sp-page-context!SPField:class' - - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' - summary: >- - If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific - functionality; otherwise the value is undefined. - remarks: >- - Although the SharePoint list view is the main usage scenario, field customizers can be used by other user - interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. - name: tryGetListView() - fullName: tryGetListView() - langs: - - typeScript - type: method - syntax: - content: 'tryGetListView(): ListViewAccessor | undefined;' - return: - type: - - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView~0:complex' - description: 'the SharePoint list view, or undefined if there is none.' -references: - - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - name: ExtensionContext - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext - - uid: '@microsoft/sp-page-context!SPField:class' - name: SPField - - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView~0:complex' - name: ListViewAccessor | undefined - fullName: ListViewAccessor | undefined - spec.typeScript: - - uid: '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' - name: ListViewAccessor - fullName: ListViewAccessor - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: FieldCustomizerContext +uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: FieldCustomizerContext +summary: This object provides contextual information for BaseFieldCustomizer. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `FieldCustomizerContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: field + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: field + summary: >- + Provides access to the SharePoint field that the customizer will operate + on. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly field: SPField;' + return: + type: '' +methods: + - name: tryGetListView() + uid: >- + @microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: tryGetListView() + summary: >- + If the field customizer is bounded to the SharePoint list view, this + provides access to the list view specific functionality; otherwise the + value is undefined. + remarks: >- + Although the SharePoint list view is the main usage scenario, field + customizers can be used by other user interface surfaces. For example, in + the future SharePoint may support field customizers on a display/edit + form. + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetListView(): ListViewAccessor | undefined;' + return: + type: >- + @microsoft/sp-listview-extensibility!FieldCustomizerContext# + description: 'the SharePoint list view, or undefined if there is none.' +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 259f3c2e..a56b6908 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -1,74 +1,71 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - summary: Event parameters for BaseFieldCustomizer.onRenderCell() - name: IFieldCustomizerCellEventParameters - fullName: IFieldCustomizerCellEventParameters - langs: - - typeScript - type: interface - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' - summary: >- - The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is - called. - name: domElement - fullName: domElement - langs: - - typeScript - type: property - syntax: - content: 'readonly domElement: HTMLDivElement;' - return: - type: - - '!HTMLDivElement:interface' - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' - summary: The value of the field being rendered. - name: fieldValue - fullName: fieldValue - langs: - - typeScript - type: property - syntax: - content: 'readonly fieldValue: any;' - return: - type: - - any - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' - summary: The list item being edited. - name: listItem - fullName: listItem - langs: - - typeScript - type: property - syntax: - content: 'readonly listItem: ListItemAccessor;' - return: - type: - - '@microsoft/sp-listview-extensibility!default:class' - - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' - summary: An implementation defined storage property. - remarks: >- - For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request - to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this - property, and then onDisposeCell() can use this key to find the resource to be freed. - name: userData - fullName: userData - langs: - - typeScript - type: property - syntax: - content: 'userData: any;' - return: - type: - - any -references: - - uid: '!HTMLDivElement:interface' - name: HTMLDivElement - - uid: '@microsoft/sp-listview-extensibility!default:class' - name: ListItemAccessor +### YamlMime:TSType +name: IFieldCustomizerCellEventParameters +uid: >- + @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface +package: '@microsoft/sp-listview-extensibility!' +fullName: IFieldCustomizerCellEventParameters +summary: Event parameters for BaseFieldCustomizer.onRenderCell() +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: domElement + uid: >- + @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member + package: '@microsoft/sp-listview-extensibility!' + fullName: domElement + summary: >- + The HTML "div" element that the extension will take ownership of. This + ownership will end when onDisposeCell() is called. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLDivElement;' + return: + type: '' + - name: fieldValue + uid: >- + @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member + package: '@microsoft/sp-listview-extensibility!' + fullName: fieldValue + summary: The value of the field being rendered. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fieldValue: any;' + return: + type: any + - name: listItem + uid: >- + @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member + package: '@microsoft/sp-listview-extensibility!' + fullName: listItem + summary: The list item being edited. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly listItem: ListItemAccessor;' + return: + type: '' + - name: userData + uid: >- + @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member + package: '@microsoft/sp-listview-extensibility!' + fullName: userData + summary: An implementation defined storage property. + remarks: >- + For example, suppose that resources need to be allocated during rendering + (e.g. a renderer object, an HTTP request to be canceled, a cache slot, + etc). The onRenderCell() implementation could store a key or handle in + this property, and then onDisposeCell() can use this key to find the + resource to be freed. + isPreview: false + isDeprecated: false + syntax: + content: 'userData: any;' + return: + type: any diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index 2693be5e..86ead6a5 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,56 +1,45 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - summary: >- - Parameters for - [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)) - name: IListViewCommandSetExecuteEventParameters - fullName: IListViewCommandSetExecuteEventParameters - langs: - - typeScript - type: interface - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' - summary: >- - The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component - manifest. - name: itemId - fullName: itemId - langs: - - typeScript - type: property - syntax: - content: 'readonly itemId: string;' - return: - type: - - string - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' - summary: 'The currently selected ListView rows, at the time when the event occurred.' - name: selectedRows - fullName: selectedRows - langs: - - typeScript - type: property - syntax: - content: 'readonly selectedRows: ReadonlyArray;' - return: - type: - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows~0:complex' -references: - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - name: RowAccessor - fullName: RowAccessor - - name: '>' - fullName: '>' +### YamlMime:TSType +name: IListViewCommandSetExecuteEventParameters +uid: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface +package: '@microsoft/sp-listview-extensibility!' +fullName: IListViewCommandSetExecuteEventParameters +summary: >- + Parameters for + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#)) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: itemId + uid: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member + package: '@microsoft/sp-listview-extensibility!' + fullName: itemId + summary: >- + The unique identifier for the command. This is specified as + ICommandDefinition.commandId in the component manifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly itemId: string;' + return: + type: string + - name: selectedRows + uid: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: 'The currently selected ListView rows, at the time when the event occurred.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly selectedRows: ReadonlyArray;' + return: + type: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters# diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index cde40dad..cea3a1bc 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -1,41 +1,30 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - summary: >- - Parameters for - [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)) - name: IListViewCommandSetListViewUpdatedParameters - fullName: IListViewCommandSetListViewUpdatedParameters - langs: - - typeScript - type: interface - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' - summary: 'The currently selected ListView rows, at the time when the event occurred.' - name: selectedRows - fullName: selectedRows - langs: - - typeScript - type: property - syntax: - content: 'readonly selectedRows: ReadonlyArray;' - return: - type: - - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows~0:complex' -references: - - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - name: RowAccessor - fullName: RowAccessor - - name: '>' - fullName: '>' +### YamlMime:TSType +name: IListViewCommandSetListViewUpdatedParameters +uid: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface +package: '@microsoft/sp-listview-extensibility!' +fullName: IListViewCommandSetListViewUpdatedParameters +summary: >- + Parameters for + [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#)) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: selectedRows + uid: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: 'The currently selected ListView rows, at the time when the event occurred.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly selectedRows: ReadonlyArray;' + return: + type: >- + @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters# diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index d674d80e..587c9305 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -1,102 +1,88 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - summary: >- - When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated - SharePoint list item. - remarks: >- - ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and - retrieve the current values for those fields. In the future, it may also support validation and editing - operations. - - - When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the - ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether - the associated table row is selected or not. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListItemAccessor` class. - name: ListItemAccessor - fullName: ListItemAccessor - langs: - - typeScript - type: class - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' - - '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' - - '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' - - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' - summary: The SharePoint fields that are currently available in the editor for this list item. - remarks: >- - The set of available fields depends on the editing context. For example, if a list view column is hidden, the - corresponding field definition may not be loaded. Field customizers should not assume that a given field will be - available, even if it is defined in the content type. - name: fields - fullName: fields - langs: - - typeScript - type: property - syntax: - content: 'abstract readonly fields: ReadonlyArray;' - return: - type: - - '@microsoft/sp-listview-extensibility!ListItemAccessor#fields~0:complex' - - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' - summary: >- - Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as - a string, number, etc. - name: getValue(field) - fullName: getValue(field) - langs: - - typeScript - type: method - syntax: - content: 'abstract getValue(field: SPField): any;' - return: - type: - - any - description: '' - parameters: - - id: field - description: '' - type: - - '@microsoft/sp-page-context!SPField:class' - - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' - summary: >- - Retrieves the current data value for the field with the specified internal name. The value will be a primitive - JavaScript object such as a string, number, etc. - name: getValueByName(internalName) - fullName: getValueByName(internalName) - langs: - - typeScript - type: method - syntax: - content: 'abstract getValueByName(internalName: string): any;' - return: - type: - - any - description: '' - parameters: - - id: internalName - description: '' - type: - - string -references: - - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-page-context!SPField:class' - name: SPField - fullName: SPField - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-page-context!SPField:class' - name: SPField +### YamlMime:TSType +name: ListItemAccessor +uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListItemAccessor +summary: >- + When a field customizer extension is rendering a field, the ListItemAccessor + provides access to the associated SharePoint list item. +remarks: >- + ListItemAccessor allows a field customizer extension to determine which fields + are available in the editor and retrieve the current values for those fields. + In the future, it may also support validation and editing operations. + + + When the editor is the SharePoint list view, the ListViewAccessor uses the + RowAccessor subclass instead of the ListItemAccessor base class. This allows + additional functionality to be exposed, for example determining whether the + associated table row is selected or not. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `ListItemAccessor` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: fields + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: fields + summary: >- + The SharePoint fields that are currently available in the editor for this + list item. + remarks: >- + The set of available fields depends on the editing context. For example, + if a list view column is hidden, the corresponding field definition may + not be loaded. Field customizers should not assume that a given field will + be available, even if it is defined in the content type. + isPreview: false + isDeprecated: false + syntax: + content: 'abstract readonly fields: ReadonlyArray;' + return: + type: >- + @microsoft/sp-listview-extensibility!ListItemAccessor# +methods: + - name: getValue(field) + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: getValue(field) + summary: >- + Retrieves the current data value for the specified field. The value will + be a primitive JavaScript object such as a string, number, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract getValue(field: SPField): any;' + parameters: + - id: field + description: '' + type: '' + return: + type: any + description: '' + - name: getValueByName(internalName) + uid: >- + @microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: getValueByName(internalName) + summary: >- + Retrieves the current data value for the field with the specified internal + name. The value will be a primitive JavaScript object such as a string, + number, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract getValueByName(internalName: string): any;' + parameters: + - id: internalName + description: '' + type: string + return: + type: any + description: '' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index e52e10f8..34d79186 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -1,99 +1,72 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - summary: Provides access to a SharePoint ListView control. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListViewAccessor` class. - name: ListViewAccessor - fullName: ListViewAccessor - langs: - - typeScript - type: class - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' - - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' - - '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' - summary: 'The columns in associated with this view, including hidden columns.' - name: columns - fullName: columns - langs: - - typeScript - type: property - syntax: - content: 'abstract readonly columns: ReadonlyArray;' - return: - type: - - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' - summary: Event that gets raised every time the selected items in the list view change. - name: selectedRowsChangedEvent - fullName: selectedRowsChangedEvent - langs: - - typeScript - type: event - syntax: - content: 'readonly selectedRowsChangedEvent: SPEvent;' - return: - type: - - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent~0:complex' - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' - summary: >- - Returns the list view column corresponding to the field with the specified internal name, or undefined if none is - found. - name: tryGetColumnByName(internalName) - fullName: tryGetColumnByName(internalName) - langs: - - typeScript - type: method - syntax: - content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' - return: - type: - - '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName~0:complex' - description: '' - parameters: - - id: internalName - description: '' - type: - - string -references: - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - name: ColumnAccessor - fullName: ColumnAccessor - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent~0:complex' - name: SPEvent - fullName: SPEvent - spec.typeScript: - - uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEvent - fullName: SPEvent - - name: < - fullName: < - - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' - name: SelectedRowsChangedEventArgs - fullName: SelectedRowsChangedEventArgs - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName~0:complex' - name: ColumnAccessor | undefined - fullName: ColumnAccessor | undefined - spec.typeScript: - - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - name: ColumnAccessor - fullName: ColumnAccessor - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: ListViewAccessor +uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListViewAccessor +summary: Provides access to a SharePoint ListView control. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `ListViewAccessor` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: columns + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: columns + summary: 'The columns in associated with this view, including hidden columns.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract readonly columns: ReadonlyArray;' + return: + type: >- + @microsoft/sp-listview-extensibility!ListViewAccessor# + - name: selectedRowsChangedEvent + uid: >- + @microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRowsChangedEvent + summary: >- + Event that gets raised every time the selected items in the list view + change. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly selectedRowsChangedEvent: + SPEvent; + return: + type: >- + @microsoft/sp-listview-extensibility!ListViewAccessor# +methods: + - name: tryGetColumnByName(internalName) + uid: >- + @microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1) + package: '@microsoft/sp-listview-extensibility!' + fullName: tryGetColumnByName(internalName) + summary: >- + Returns the list view column corresponding to the field with the specified + internal name, or undefined if none is found. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + abstract tryGetColumnByName(internalName: string): ColumnAccessor | + undefined; + parameters: + - id: internalName + description: '' + type: string + return: + type: >- + @microsoft/sp-listview-extensibility!ListViewAccessor# + description: '' diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index 2c1024ec..c283af70 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -1,55 +1,48 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - summary: This object provides contextual information for BaseListViewCommandSet. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListViewCommandSetContext` class. - name: ListViewCommandSetContext - fullName: ListViewCommandSetContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponentContext:class' - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' - - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' - - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' - summary: Provides access to the ListView control that the customizer will operate on. - name: listView - fullName: listView - langs: - - typeScript - type: property - syntax: - content: 'readonly listView: ListViewAccessor;' - return: - type: - - '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' - - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' - summary: Manifest for the client-side component. - name: manifest - fullName: manifest - langs: - - typeScript - type: property - syntax: - content: 'readonly manifest: ICommandSetExtensionManifest;' - return: - type: - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' -references: - - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - name: ExtensionContext - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext - - uid: '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' - name: ListViewAccessor - - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - name: ICommandSetExtensionManifest +### YamlMime:TSType +name: ListViewCommandSetContext +uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListViewCommandSetContext +summary: This object provides contextual information for BaseListViewCommandSet. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `ListViewCommandSetContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: listView + uid: >- + @microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member + package: '@microsoft/sp-listview-extensibility!' + fullName: listView + summary: >- + Provides access to the ListView control that the customizer will operate + on. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly listView: ListViewAccessor;' + return: + type: >- + + - name: manifest + uid: >- + @microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member + package: '@microsoft/sp-listview-extensibility!' + fullName: manifest + summary: Manifest for the client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: ICommandSetExtensionManifest;' + return: + type: >- + +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 90ecb9b7..e5e754ff 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -1,28 +1,24 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' - remarks: >- - A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an - array of values for the associated fields. - - - A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell - values for the associated columns. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `RowAccessor` class. - name: RowAccessor - fullName: RowAccessor - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-listview-extensibility!default:class' - inheritance: - - type: '@microsoft/sp-listview-extensibility!default:class' - package: '@microsoft/sp-listview-extensibility!' -references: - - uid: '@microsoft/sp-listview-extensibility!default:class' - name: ListItemAccessor +### YamlMime:TSType +name: RowAccessor +uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: RowAccessor +summary: >- + Provides access to a ListView row, which is the visual presentation of a + SharePoint list item. +remarks: >- + A SharePoint "list item" (SPListItem) is a data storage record in the content + management system; it stores an array of values for the associated fields. + + + A "row" is the visual presentation of a list item, when displayed by the + ListView; it stores an array of cell values for the associated columns. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `RowAccessor` class. +isPreview: false +isDeprecated: false +type: class +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 9388761f..e1c7b152 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -1,45 +1,29 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' - summary: Arguments for the selected rows changed event. - name: SelectedRowsChangedEventArgs - fullName: SelectedRowsChangedEventArgs - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-core-library!SPEventArgs:class' - inheritance: - - type: '@microsoft/sp-core-library!SPEventArgs:class' - package: '@microsoft/sp-listview-extensibility!' - children: - - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' - - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' - summary: The list of rows that were selected in the list view at the time when the event was fired. - name: selectedRows - fullName: selectedRows - langs: - - typeScript - type: property - syntax: - content: 'selectedRows: ReadonlyArray;' - return: - type: - - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows~0:complex' -references: - - uid: '@microsoft/sp-core-library!SPEventArgs:class' - name: SPEventArgs - - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows~0:complex' - name: ReadonlyArray - fullName: ReadonlyArray - spec.typeScript: - - uid: '!ReadonlyArray:interface' - name: ReadonlyArray - fullName: ReadonlyArray - - name: < - fullName: < - - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' - name: RowAccessor - fullName: RowAccessor - - name: '>' - fullName: '>' +### YamlMime:TSType +name: SelectedRowsChangedEventArgs +uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: SelectedRowsChangedEventArgs +summary: Arguments for the selected rows changed event. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: selectedRows + uid: >- + @microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: >- + The list of rows that were selected in the list view at the time when the + event was fired. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'selectedRows: ReadonlyArray;' + return: + type: >- + @microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs# +extends: '' diff --git a/SP-Framework/sp-loader.yml b/SP-Framework/sp-loader.yml index 484f5bcb..ee1006ba 100644 --- a/SP-Framework/sp-loader.yml +++ b/SP-Framework/sp-loader.yml @@ -1,20 +1,9 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-loader!' - summary: The SharePoint Framework loader - remarks: >- - Built on familiar standards such as RequireJS and WebPack, the loader is the first part of the SharePoint - Framework to load on a page. It manages versioning and loading of client-side components. - name: '@microsoft/sp-loader' - fullName: '@microsoft/sp-loader' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-loader!ILoadScriptOptions:interface' - - '@microsoft/sp-loader!SPComponentLoader:class' -references: - - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' - name: ILoadScriptOptions - - uid: '@microsoft/sp-loader!SPComponentLoader:class' - name: SPComponentLoader +### YamlMime:TSPacakge +uid: '@microsoft/sp-loader!' +name: '@microsoft/sp-loader' +type: package +summary: The SharePoint Framework loader +interfaces: + - '@microsoft/sp-loader!ILoadScriptOptions:interface' +classes: + - '@microsoft/sp-loader!SPComponentLoader:class' diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index cee38bcc..141faf18 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -1,24 +1,25 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' - summary: Options for the loadScript() method in ISPComponentLoader - name: ILoadScriptOptions - fullName: ILoadScriptOptions - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ILoadScriptOptions +uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' +package: '@microsoft/sp-loader!' +fullName: ILoadScriptOptions +summary: Options for the loadScript() method in ISPComponentLoader +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: globalExportsName + uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' package: '@microsoft/sp-loader!' - children: - - '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' - - uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' - summary: 'If set, the loaded script will be stored in a global variable under this name.' - name: globalExportsName fullName: globalExportsName - langs: - - typeScript - type: property + summary: >- + If set, the loaded script will be stored in a global variable under this + name. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'globalExportsName?: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index a7bffe30..7bb783bf 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -1,164 +1,125 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-loader!SPComponentLoader:class' - summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. - name: SPComponentLoader - fullName: SPComponentLoader - langs: - - typeScript - type: class +### YamlMime:TSType +name: SPComponentLoader +uid: '@microsoft/sp-loader!SPComponentLoader:class' +package: '@microsoft/sp-loader!' +fullName: SPComponentLoader +summary: >- + Component loader. Needs to be initialized with an implemented + `ISPComponentLoader`<!-- -->. +remarks: '' +isPreview: false +isDeprecated: false +type: class +methods: + - name: getManifests() + uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' package: '@microsoft/sp-loader!' - children: - - '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' - - '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' - - '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' - - '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' - - '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' - - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' - summary: Returns static copies of all the manifests. - name: getManifests() fullName: getManifests() - langs: - - typeScript - type: method + summary: Returns static copies of all the manifests. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'static getManifests(): IClientSideComponentManifest[];' return: - type: - - '@microsoft/sp-loader!SPComponentLoader.getManifests~0:complex' + type: >- + @microsoft/sp-loader!SPComponentLoader. description: '' - - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' - summary: Loads a component from a manifest. - name: loadComponent(manifest) + - name: loadComponent(manifest) + uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' + package: '@microsoft/sp-loader!' fullName: loadComponent(manifest) - langs: - - typeScript - type: method + summary: Loads a component from a manifest. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'static loadComponent(manifest: IClientSideComponentManifest): Promise;' - return: - type: - - '@microsoft/sp-loader!SPComponentLoader.loadComponent~0:complex' - description: A promise containing the loaded module. + content: >- + static loadComponent(manifest: + IClientSideComponentManifest): Promise; parameters: - id: manifest description: Manifest of the module to load. - type: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - typeParameters: - - id: TComponent - - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' - summary: 'Resolve a component id and version, and load it.' - name: 'loadComponentById(id, version)' - fullName: 'loadComponentById(id, version)' - langs: - - typeScript - type: method - syntax: - content: 'static loadComponentById(id: string, version?: string): Promise;' + type: >- + return: - type: - - '@microsoft/sp-loader!SPComponentLoader.loadComponentById~0:complex' + type: >- + @microsoft/sp-loader!SPComponentLoader. description: A promise containing the loaded module. + - name: 'loadComponentById(id, version)' + uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' + package: '@microsoft/sp-loader!' + fullName: 'loadComponentById(id, version)' + summary: 'Resolve a component id and version, and load it.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + static loadComponentById(id: string, version?: string): + Promise; parameters: - id: id description: The id of the component to load. - type: - - string + type: string - id: version description: >- - The version of the component to load. If version is not defined, the method will load any version of the - component. - type: - - string - typeParameters: - - id: TComponent - - uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' - summary: Inserts a `` tag for a stylesheet. - name: loadCss(url) + The version of the component to load. If version is not defined, the + method will load any version of the component. + type: string + return: + type: >- + @microsoft/sp-loader!SPComponentLoader. + description: A promise containing the loaded module. + - name: loadCss(url) + uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' + package: '@microsoft/sp-loader!' fullName: loadCss(url) - langs: - - typeScript - type: method + summary: Inserts a `<link ... />` tag for a stylesheet. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'static loadCss(url: string): void;' - return: - type: - - void - description: '' parameters: - id: url description: The CSS file URL. - type: - - string - - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' + type: string + return: + type: void + description: '' + - name: 'loadScript(url, options)' + uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' + package: '@microsoft/sp-loader!' + fullName: 'loadScript(url, options)' summary: 'Given a URL, load a script.' remarks: >- - If a script with a global variable is being loaded, the global variable already exists, and the script fails to - load (because of a syntax error, for example), the original global variable may be returned and an error may not - be propagated. - name: 'loadScript(url, options)' - fullName: 'loadScript(url, options)' - langs: - - typeScript - type: method + If a script with a global variable is being loaded, the global variable + already exists, and the script fails to load (because of a syntax error, + for example), the original global variable may be returned and an error + may not be propagated. + isPreview: false + isDeprecated: false syntax: - content: 'static loadScript(url: string, options?: ILoadScriptOptions): Promise;' - return: - type: - - '@microsoft/sp-loader!SPComponentLoader.loadScript~0:complex' - description: A promise containing the loaded module. + content: >- + static loadScript(url: string, options?: ILoadScriptOptions): + Promise; parameters: - id: url description: The script URL. - type: - - string + type: string - id: options description: >- - globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the - global member's name. - type: - - '@microsoft/sp-loader!ILoadScriptOptions:interface' - typeParameters: - - id: TModule -references: - - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests~0:complex' - name: 'IClientSideComponentManifest[]' - fullName: 'IClientSideComponentManifest[]' - spec.typeScript: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - fullName: IClientSideComponentManifest - - name: '[]' - fullName: '[]' - - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' - name: ILoadScriptOptions + globalExportsName: If the script isn't an AMD module and loads a + global member on the page, specify the global member's name. + type: '' + return: + type: >- + @microsoft/sp-loader!SPComponentLoader. + description: A promise containing the loaded module. diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml index 11bdd3bf..28fcac39 100644 --- a/SP-Framework/sp-lodash-subset.yml +++ b/SP-Framework/sp-lodash-subset.yml @@ -1,38 +1,8 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-lodash-subset!' - name: '@microsoft/sp-lodash-subset' - fullName: '@microsoft/sp-lodash-subset' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-lodash-subset!Cancelable:type' - - '@microsoft/sp-lodash-subset!ThrottleSettings:type' - - uid: '@microsoft/sp-lodash-subset!Cancelable:type' - name: Cancelable - fullName: Cancelable - langs: - - typeScript - type: typealias - syntax: - content: export declare type Cancelable = Cancelable2; - return: - type: - - '@types/lodash!~"\"../index\"".Cancelable:interface' - - uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' - name: ThrottleSettings - fullName: ThrottleSettings - langs: - - typeScript - type: typealias - syntax: - content: export declare type ThrottleSettings = ThrottleSettings2; - return: - type: - - '@types/lodash!~"\"../index\"".ThrottleSettings:interface' -references: - - uid: '@types/lodash!~"\"../index\"".Cancelable:interface' - name: Cancelable2 - - uid: '@types/lodash!~"\"../index\"".ThrottleSettings:interface' - name: ThrottleSettings2 +### YamlMime:TSPacakge +uid: '@microsoft/sp-lodash-subset!' +name: '@microsoft/sp-lodash-subset' +type: package +summary: '' +typeAliases: + - '@microsoft/sp-lodash-subset!Cancelable:type' + - '@microsoft/sp-lodash-subset!ThrottleSettings:type' diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index 1f687277..b534c13f 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -1,92 +1,29 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!' - name: '@microsoft/sp-module-interfaces' - fullName: '@microsoft/sp-module-interfaces' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-module-interfaces!ComponentType:type' - - '@microsoft/sp-module-interfaces!ExtensionType:type' - - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!IPath:interface' - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' - - uid: '@microsoft/sp-module-interfaces!ComponentType:type' - summary: Type of client-side component. - name: ComponentType - fullName: ComponentType - langs: - - typeScript - type: typealias - syntax: - content: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension'; - return: - type: - - '''Application'' | ''WebPart'' | ''Library'' | ''Extension''' - - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' - summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. - name: ExtensionType - fullName: ExtensionType - langs: - - typeScript - type: typealias - syntax: - content: >- - export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | - 'ListViewCommandSet' | 'SearchQueryModifier'; - return: - type: - - '''Unknown'' | ''ApplicationCustomizer'' | ''FieldCustomizer'' | ''ListViewCommandSet'' | ''SearchQueryModifier''' -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - name: IClientSideAssemblyManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - name: IClientSideComponentLoaderConfiguration - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - name: IClientSideExtensionManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' - name: IClientSideLibraryManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' - name: IClientSideWebPartManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - name: IClientSideWebPartManifestEntry - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - name: IClientSideWebPartManifestInstance - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - name: ICommandDefinition - - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - name: ICommandSetExtensionManifest - - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' - name: IComponentModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - name: ILocalizedPathModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - name: ILocalizedString - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - name: IModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!IPath:interface' - name: IPath - - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' - name: IPathModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' - name: PredefinedGroup +### YamlMime:TSPacakge +uid: '@microsoft/sp-module-interfaces!' +name: '@microsoft/sp-module-interfaces' +type: package +summary: '' +typeAliases: + - '@microsoft/sp-module-interfaces!ComponentType:type' + - '@microsoft/sp-module-interfaces!ExtensionType:type' +interfaces: + - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!IPath:interface' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' +enums: + - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 249d3ce3..e16ecea8 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -1,39 +1,33 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - summary: A library is defined by this manifest. Libraries currently do not have any additional properties. - name: IClientSideAssemblyManifest - fullName: IClientSideAssemblyManifest - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' +### YamlMime:TSType +name: IClientSideAssemblyManifest +uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideAssemblyManifest +summary: >- + A library is defined by this manifest. Libraries currently do not have any + additional properties. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: rootComponentId + uid: >- + @microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' + fullName: rootComponentId summary: The ID of the component from which the assembly is built. remarks: |- Supported values: any GUID Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" - name: rootComponentId - fullName: rootComponentId - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'rootComponentId: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase + type: string +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 73d84cef..9e1a5913 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -1,119 +1,135 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - summary: >- - This interface describes how a client-side component is to be loaded and initialized by a SharePoint client - framework. It contains all data for loading an entrypoint script and its dependency scripts. - isPreview: true - name: IClientSideComponentLoaderConfiguration - fullName: IClientSideComponentLoaderConfiguration - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IClientSideComponentLoaderConfiguration +uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideComponentLoaderConfiguration +summary: >- + This interface describes how a client-side component is to be loaded and + initialized by a SharePoint client framework. It contains all data for loading + an entrypoint script and its dependency scripts. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: entryModuleId + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' + fullName: entryModuleId summary: This is the ID of one of the entries in the "scriptResources" dictionary. remarks: >- - The loader will download and evaluate the script resource referenced in this field, resolve all dependencies - against the keys in the "scriptResources", and return the exported object to the loader's calling function. The - entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type. + The loader will download and evaluate the script resource referenced in + this field, resolve all dependencies against the keys in the + "scriptResources", and return the exported object to the loader's calling + function. The entry referenced in the "scriptResources" dictionary must be + of the "internal" or the "localized" type. - Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the - component. + Supported values: An entry in the "scriptResources" dictionary that + defines the base exported module of the component. Example: `"myApplication.bundle"` isPreview: true - name: entryModuleId - fullName: entryModuleId - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'entryModuleId: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' - summary: The module referenced by the "entryModuleId" field may export an object with several fields. + type: string + - name: exportName + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member + package: '@microsoft/sp-module-interfaces!' + fullName: exportName + summary: >- + The module referenced by the "entryModuleId" field may export an object + with several fields. remarks: >- - This value optionally references the name of a field on the object exported by the module referenced by the - `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported by - the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of the base - exported object. For example, if entryModuleId refers to a module with with a top-level export of `{ foo: 'bar', - baz: 123 }` and: + This value optionally references the name of a field on the object + exported by the module referenced by the `entryModuleId` field. When this + field has a value, the value of the referenced field on the object + exported by the module referenced by the `entryModuleId` field is returned + when this manifest is loaded instead of the base exported object. For + example, if entryModuleId refers to a module with with a top-level export + of `{ foo: 'bar', baz: 123 }` and: - - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }` + - if this field is unset, the value returned by the module loader is `{ + foo: 'bar', baz: 123 }` - - if this field is set to `foo`, the value returned by the module loader is `bar` + - if this field is set to `foo`, the value returned by the module + loader is `bar` - - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a - key in the top-level export). + - if this field is set to `bar`, the value returned by the module + loader is undefined (as `bar` is not a key in the top-level export). Example: `mySpWebpart` isPreview: true - name: exportName - fullName: exportName - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'exportName?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' + type: string + - name: internalModuleBaseUrls + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member + package: '@microsoft/sp-module-interfaces!' + fullName: internalModuleBaseUrls summary: >- - This is an array of fully-qualified paths to be prepended to each of the script resource paths with the "internal" - or "localized" type. If one fails to load, the loader will attempt to load from the next until there are no base - paths remaining. + This is an array of fully-qualified paths to be prepended to each of the + script resource paths with the "internal" or "localized" type. If one + fails to load, the loader will attempt to load from the next until there + are no base paths remaining. remarks: >- - All "internal" and "localized" script resources that do not have fully-qualified URLs as their "path" field values - must be hosted under each of the paths listed in this property. For example, if an internal module's "path" field - value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's value is `[ - "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first + All "internal" and "localized" script resources that do not have + fully-qualified URLs as their "path" field values must be hosted under + each of the paths listed in this property. For example, if an internal + module's "path" field value is + `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's + value is `[ "https://contoso.akamaihd.net/files/", + "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from the URL - `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading - from that URL fails, the loader will then attempt to load this script resource from - `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL - fails to load, the component will fail to load and an error will be returned. It is important to note that the - support for multiple base URLs is purely for failover support. This means that all files must be present on all - hosts listed in this field. + `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading from that URL fails, the loader will then attempt to load + this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL fails to load, the component will fail to load and an + error will be returned. It is important to note that the support for + multiple base URLs is purely for failover support. This means that all + files must be present on all hosts listed in this field. - Usage: Base URLs for script resources with the "internal" or "localized" type. + Usage: Base URLs for script resources with the "internal" or "localized" + type. - Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary. + Supported values: Any URL that contains all internal scripts referenced in + the "scriptResources" dictionary. - Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` + Example: `[ "https://contoso.akamaihd.net/files/", + "https://contoso.msecnd.net/files/" ]` isPreview: true - name: internalModuleBaseUrls - fullName: internalModuleBaseUrls - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'internalModuleBaseUrls: string[];' return: - type: - - 'string[]' - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' + type: 'string[]' + - name: scriptResources + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member + package: '@microsoft/sp-module-interfaces!' + fullName: scriptResources summary: >- - This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and - `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` - must contain the component's exported object. + This is a dictionary of named script resources. `path` and `localizedPath` + modules may reference each other and `manifest` modules are expected to be + provided by the framework runtime. The resource named in the + `entryModuleId` must contain the component's exported object. remarks: |- Supported values: A dictionary of named script resources. @@ -153,42 +169,13 @@ items: ``` isPreview: true - name: scriptResources - fullName: scriptResources - langs: - - typeScript - type: property + isDeprecated: false syntax: content: |- scriptResources: { [name: string]: IModuleConfiguration; }; return: - type: - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources~0:complex' -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources~0:complex' - name: |- - { - [name: string]: IModuleConfiguration; - } - fullName: |- - { - [name: string]: IModuleConfiguration; - } - spec.typeScript: - - name: |- - { - [name: string]: - fullName: |- - { - [name: string]: - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - name: IModuleConfiguration - fullName: IModuleConfiguration - - name: |- - ; - } - fullName: |- - ; - } + type: >- + @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration# diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index e9ecab4f..31430925 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -1,189 +1,201 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' +### YamlMime:TSType +name: IClientSideComponentManifest +uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideComponentManifest +summary: >- + All client-side components built on the SharePoint framework need a valid + component manifest. This interface represents properties that are required by + all types of client-side components like Applications and Web Parts. Component + specific manifests will extend this interface to add properties required by + that component type. +remarks: >- + The schema of this manifest is owned and versioned by Microsoft. Following + rules should be followed while changing this schema. This set of rules can + also be called the "manifest upgrade rules". + + + - For minor changes, new properties can be added to this schema in a + backwards-compatible way. i.e. the code that processes the manifest should be + able to handle the absence of those new properties. + + + - Try to model your changes as minor SemVer increments. Major version changes + should be avoided because they impose a migration cost on developers. + + + - The `'manifestVersion'` should be bumped for all small or big changes. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: alias + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' + package: '@microsoft/sp-module-interfaces!' + fullName: alias summary: >- - All client-side components built on the SharePoint framework need a valid component manifest. This interface - represents properties that are required by all types of client-side components like Applications and Web Parts. - Component specific manifests will extend this interface to add properties required by that component type. + A short name usually given by developer. It does not need to be localized + and is expected to stay the same through the lifetime of the component. If + an application overrides the `ClientSideApplication.alias` property, + `ClientSideApplication.alias` is given precedence over the value provided + in the manifest. remarks: >- - The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing - this schema. This set of rules can also be called the "manifest upgrade rules". - - - - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that - processes the manifest should be able to handle the absence of those new properties. - - - - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they - impose a migration cost on developers. + Usage: A short name to identify a client-side component by developer. - - The `'manifestVersion'` should be bumped for all small or big changes. - name: IClientSideComponentManifest - fullName: IClientSideComponentManifest - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' - summary: >- - A short name usually given by developer. It does not need to be localized and is expected to stay the same through - the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, - `ClientSideApplication.alias` is given precedence over the value provided in the manifest. - remarks: |- - Usage: A short name to identify a client-side component by developer. + Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer + than 40 characters. - Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` - name: alias - fullName: alias - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'alias: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' + type: string + - name: componentType + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member + package: '@microsoft/sp-module-interfaces!' + fullName: componentType summary: >- - Type of client-side component. Components with the "Application" type are defined by the - "IClientSideApplicationManifest" interface. Components with the "WebPart" type are defined by the - "IClientSideWebPartManifest" interface. Components with the "Library" type are defined by the + Type of client-side component. Components with the "Application" type are + defined by the "IClientSideApplicationManifest" interface. Components with + the "WebPart" type are defined by the "IClientSideWebPartManifest" + interface. Components with the "Library" type are defined by the "IClientSideLibraryManifest" interface. - remarks: |- - Usage: To help bundling, loading, enumeration, and initialization of components based on their contents. + remarks: >- + Usage: To help bundling, loading, enumeration, and initialization of + components based on their contents. - Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"` - name: componentType - fullName: componentType - langs: - - typeScript - type: property + + Supported values: `"Application"`, `"WebPart"`, + `"Library"`, `"Extension"` + isPreview: false + isDeprecated: false syntax: content: 'componentType: ComponentType;' return: - type: - - '@microsoft/sp-module-interfaces!ComponentType:type' - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' + type: '' + - name: loaderConfig + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member + package: '@microsoft/sp-module-interfaces!' + fullName: loaderConfig summary: >- - This portion of the configuration describes how the component is to be loaded and initialized by a client. It - contains an enumeration of scripts that the component requires along with a single entry point script. - remarks: |- + This portion of the configuration describes how the component is to be + loaded and initialized by a client. It contains an enumeration of scripts + that the component requires along with a single entry point script. + remarks: >- Usage: Loading a component. - See `IClientSideComponentLoaderConfiguration` for more information and examples. + + See `IClientSideComponentLoaderConfiguration` for more information and + examples. isPreview: true - name: loaderConfig - fullName: loaderConfig - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' return: - type: - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' - summary: >- - This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts - build after using spfx 1.1 don't need this. - name: loadLegacyFabricCss + type: >- + + - name: loadLegacyFabricCss + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member + package: '@microsoft/sp-module-interfaces!' fullName: loadLegacyFabricCss - langs: - - typeScript - type: property + summary: >- + This property is used to keep older components that don't explicitly use + fabric CSS. For the most part, webparts build after using spfx 1.1 don't + need this. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'loadLegacyFabricCss?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' + type: boolean + - name: requiresCustomScript + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member + package: '@microsoft/sp-module-interfaces!' + fullName: requiresCustomScript summary: >- - If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true - if the component allows authors to execute arbitrary scripts on the page. + If true, the component can only be installed on sites where Custom Script + is enabled. This should be set to true if the component allows authors to + execute arbitrary scripts on the page. remarks: >- Defaults to false. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. - Usage: Requires Custom Script to be allowed in order for this component to be installed and run. - name: requiresCustomScript - fullName: requiresCustomScript - langs: - - typeScript - type: property + Usage: Requires Custom Script to be allowed in order for this component to + be installed and run. + isPreview: false + isDeprecated: false syntax: content: 'requiresCustomScript?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' - summary: This property is provided for backwards compatibility. It no longer has any effect. - deprecated: - content: Use requiresCustomScript instead of safeWithCustomScriptDisabled. - name: safeWithCustomScriptDisabled + type: boolean + - name: safeWithCustomScriptDisabled + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member + package: '@microsoft/sp-module-interfaces!' fullName: safeWithCustomScriptDisabled - langs: - - typeScript - type: property + summary: >- + This property is provided for backwards compatibility. It no longer has + any effect. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. syntax: content: 'safeWithCustomScriptDisabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' + type: boolean + - name: version + uid: >- + @microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member + package: '@microsoft/sp-module-interfaces!' + fullName: version summary: >- - Client-side component version. The value of this field is expected to be controlled by the developer of the - client-side component. + Client-side component version. The value of this field is expected to be + controlled by the developer of the client-side component. remarks: >- - The purpose of this field is to help client-side component developers upgrade their client-side components in a - managed way. This helps the consumers of the client-side component make decisions about when and how to upgrade - the client-side component. As the developer evolves the code for their client-side component, they can decide to - bump the MAJOR, MINOR or PATCH version of the component. + The purpose of this field is to help client-side component developers + upgrade their client-side components in a managed way. This helps the + consumers of the client-side component make decisions about when and how + to upgrade the client-side component. As the developer evolves the code + for their client-side component, they can decide to bump the MAJOR, MINOR + or PATCH version of the component. - All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes - should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. - Please see [http://semver.org](http://semver.org) for more details on how to manage the version of your - components. + All incompatible API changes should result in a MAJOR version bump. + Backwards compatible functionality changes should result in a MINOR + version bump, and backwards compatible bug fixes should result in a PATCH + version bump. Please see [http://semver.org](http://semver.org) for more + details on how to manage the version of your components. - Usage: Versioning and evolving a client-side component safely in a controlled way. + Usage: Versioning and evolving a client-side component safely in a + controlled way. - Supported values: string representing a [semantic version](http://semver.org) i.e. MAJOR.MINOR.PATCH + Supported values: string representing a [semantic + version](http://semver.org) i.e. MAJOR.MINOR.PATCH Example: `"1.0.0"` - name: version - fullName: version - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'version: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase - - uid: '@microsoft/sp-module-interfaces!ComponentType:type' - name: ComponentType - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - name: IClientSideComponentLoaderConfiguration + type: string +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index 772c4abb..de1cf9cc 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -1,39 +1,30 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - summary: This is the manifest for a client-side extension. - name: IClientSideExtensionManifest - fullName: IClientSideExtensionManifest - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' +### YamlMime:TSType +name: IClientSideExtensionManifest +uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideExtensionManifest +summary: This is the manifest for a client-side extension. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: extensionType + uid: >- + @microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' - summary: >- - Specifies the type of client-side extension. Some extension types support additional manifest fields beyond - SPClientSideExtensionManifest. - name: extensionType fullName: extensionType - langs: - - typeScript - type: property + summary: >- + Specifies the type of client-side extension. Some extension types support + additional manifest fields beyond SPClientSideExtensionManifest. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'extensionType: ExtensionType;' return: - type: - - '@microsoft/sp-module-interfaces!ExtensionType:type' -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase - - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' - name: ExtensionType + type: '' +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index 52f45f74..44fe5321 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -1,21 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' - summary: A library is defined by this manifest. Libraries currently do not have any additional properties. - name: IClientSideLibraryManifest - fullName: IClientSideLibraryManifest - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - package: '@microsoft/sp-module-interfaces!' -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase +### YamlMime:TSType +name: IClientSideLibraryManifest +uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideLibraryManifest +summary: >- + A library is defined by this manifest. Libraries currently do not have any + additional properties. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index e0f405fa..bfe23b40 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -1,20 +1,24 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - summary: This interface defines members that are common between all deployable manifests. - name: IClientSideManifestBase - fullName: IClientSideManifestBase - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IClientSideManifestBase +uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideManifestBase +summary: >- + This interface defines members that are common between all deployable + manifests. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' - - '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' + fullName: id summary: >- - A universally unique component id. Each client-side component is required to have this id. Once an id has been - used for a component, it cannot be changed. A change in this value is treated same as the creation of a new + A universally unique component id. Each client-side component is required + to have this id. Once an id has been used for a component, it cannot be + changed. A change in this value is treated same as the creation of a new component. Two components are never expected to have the same id. @@ -25,24 +29,28 @@ items: Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` - name: id - fullName: id - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'id: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' + type: string + - name: manifestVersion + uid: >- + @microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member + package: '@microsoft/sp-module-interfaces!' + fullName: manifestVersion summary: >- - Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this - field is to help manage upgrades of the component manifest schema. + Version of the component manifest schema. The value of this field is + controlled by Microsoft. The purpose of this field is to help manage + upgrades of the component manifest schema. remarks: >- - A component developer needs to only confirm that they are using the correct value per the manifest schema. Please - read the "manifest upgrade rules" for more details on when the schema could change. Note, manifest schema version - upgrade will be considered a big API change event and will be advertised broadly. + A component developer needs to only confirm that they are using the + correct value per the manifest schema. Please read the "manifest upgrade + rules" for more details on when the schema could change. Note, manifest + schema version upgrade will be considered a big API change event and will + be advertised broadly. Usage: To help support multiple manifest schema versions. @@ -52,13 +60,9 @@ items: Example: `1` - name: manifestVersion - fullName: manifestVersion - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'manifestVersion: number;' return: - type: - - number + type: number diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 24cd3d6d..6b7787de 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -1,112 +1,112 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' - summary: >- - The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a - manifest. - remarks: >- - The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to - identify, load and process a Web Part. The schema for this manifest is completely owned and versioned by - Microsoft. There are some required properties in the manifest and some optional properties. Optional properties - need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to - issues with Web Part loading and functionality problems. - name: IClientSideWebPartManifest - fullName: IClientSideWebPartManifest - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - syntax: - typeParameters: - - id: TProperties +### YamlMime:TSType +name: IClientSideWebPartManifest +uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideWebPartManifest +summary: >- + The client-side SharePoint framework identifies a Web Part by its manifest. + All Web Parts are expected to have a manifest. +remarks: >- + The manifest is a schematized JSON blob that is used in multiple parts of the + SharePoint infrastructure to identify, load and process a Web Part. The schema + for this manifest is completely owned and versioned by Microsoft. There are + some required properties in the manifest and some optional properties. + Optional properties need to be provided only if the Web Part needs the + specific functionality. An invalid manifest could lead to issues with Web Part + loading and functionality problems. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: canUpdateConfiguration + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' - summary: Indicates whether the web part uses the property pane to update the configuration of the web part. - remarks: Default value is `true` if the property is not explicitly defined. - name: canUpdateConfiguration fullName: canUpdateConfiguration - langs: - - typeScript - type: property + summary: >- + Indicates whether the web part uses the property pane to update the + configuration of the web part. + remarks: Default value is `true` if the property is not explicitly defined. + isPreview: false + isDeprecated: false syntax: content: 'canUpdateConfiguration?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' + type: boolean + - name: disabledOnClassicSharepoint + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member + package: '@microsoft/sp-module-interfaces!' + fullName: disabledOnClassicSharepoint summary: 'If true, this web part is disabled on SharePoint classic pages' remarks: >- - Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If - this flag is true, the web part will not appear in the classic page web part gallery. - name: disabledOnClassicSharepoint - fullName: disabledOnClassicSharepoint - langs: - - typeScript - type: property + Certain web parts may not be required on or apply to SharePoint classic + pages. This flag helps control that. If this flag is true, the web part + will not appear in the classic page web part gallery. + isPreview: false + isDeprecated: false syntax: content: 'disabledOnClassicSharepoint?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' - summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' - remarks: >- - Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not - used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts - can be provisioned on pages though API or be added to the page in a pre configured way. - name: hiddenFromToolbox + type: boolean + - name: hiddenFromToolbox + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member + package: '@microsoft/sp-module-interfaces!' fullName: hiddenFromToolbox - langs: - - typeScript - type: property + summary: >- + If true, this web part should not be displayed in the modern SharePoint + toolbox. + remarks: >- + Usage: Use this flag if it is not appropriate to display a web part in the + modern toolbox. This property is not used in Classic SharePoint. By + default, all web parts are enabled to be displayed in the toolbox. Such + web parts can be provisioned on pages though API or be added to the page + in a pre configured way. + isPreview: false + isDeprecated: false syntax: content: 'hiddenFromToolbox?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' + type: boolean + - name: imagePreviewUrl + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member + package: '@microsoft/sp-module-interfaces!' + fullName: imagePreviewUrl summary: 'Definition: Url of the image image used for preview' remarks: >- - Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web - part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module - url - name: imagePreviewUrl - fullName: imagePreviewUrl - langs: - - typeScript - type: property + Usage: Use this string to specify that a preview image should be used + instead of a preview rendering of the web part. This can either be a + absolute url or a relative URL which will be resolved based on the + internal base module url + isPreview: false + isDeprecated: false syntax: content: 'imagePreviewUrl?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' + type: string + - name: preconfiguredEntries + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member + package: '@microsoft/sp-module-interfaces!' + fullName: preconfiguredEntries summary: >- - A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part - specific custom properties. And there can be multiple instances of these pre-configured properties. + A Web Part can have pre-configured properties like the title, description, + toolbox group name and Web Part specific custom properties. And there can + be multiple instances of these pre-configured properties. remarks: >- - This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web - Part in the Toolbox. Each entry is expected to configure the Web Part with a different set of pre-configured - properties. A developer may decide to seed some initial values for these properties but an organization admin can - go ahead and customize these properties per the needs of his/her organization. The properties can also be modified - by the author of the page. + This helps support scenarios where an organization may want to present + multiple pre-configured entries for a Web Part in the Toolbox. Each entry + is expected to configure the Web Part with a different set of + pre-configured properties. A developer may decide to seed some initial + values for these properties but an organization admin can go ahead and + customize these properties per the needs of his/her organization. The + properties can also be modified by the author of the page. - Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. + Usage: help display a Web Part in the Toolbox, PropertyPane and the + initial rendering of the Web Part. Type: JSON object @@ -131,86 +131,79 @@ items: }] ``` - name: preconfiguredEntries - fullName: preconfiguredEntries - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' return: - type: - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries~0:complex' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' + type: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest# + - name: supportedHosts + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member + package: '@microsoft/sp-module-interfaces!' + fullName: supportedHosts summary: 'Definition: An array defining what host types are supported' remarks: >- - Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is - provided. If SharePointFullPage is added the solution will be available when adding full page apps. If - SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab or - TeamsPersonalApp is added the solution will be available when using teams. - name: supportedHosts - fullName: supportedHosts - langs: - - typeScript - type: property + Usage: Use this array to define all hosts that are supported. The default + value is SharePointWebPart if nothing is provided. If SharePointFullPage + is added the solution will be available when adding full page apps. If + SharePointWebPart is added the solution will be available when adding + webparts to a page. If TeamsTab or TeamsPersonalApp is added the solution + will be available when using teams. + isPreview: false + isDeprecated: false syntax: - content: 'supportedHosts?: Array<''SharePointFullPage'' | ''SharePointWebPart'' | ''TeamsTab'' | ''TeamsPersonalApp''>;' + content: >- + supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | + 'TeamsTab' | 'TeamsPersonalApp'>; return: - type: - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts~0:complex' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' - summary: 'Definition: If true, this web part supports and has been tested for full bleed experience.' - remarks: >- - Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, - full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed - experiences require special treatment and testing. By default no web parts support full bleed experiences. - name: supportsFullBleed + type: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest# + - name: supportsFullBleed + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member + package: '@microsoft/sp-module-interfaces!' fullName: supportsFullBleed - langs: - - typeScript - type: property + summary: >- + Definition: If true, this web part supports and has been tested for full + bleed experience. + remarks: >- + Usage: Use this flag if a web part supports full bleed experience and has + been tested as such. In this context, full bleed is a term used to denote + that the web part takes the whole width of the containing page. Full bleed + experiences require special treatment and testing. By default no web parts + support full bleed experiences. + isPreview: false + isDeprecated: false syntax: content: 'supportsFullBleed?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' - summary: 'Definition: If true, this web part supports and has been tested for theme variants experience.' - remarks: >- - Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme - variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may - or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By - default no web parts support theme variants. - name: supportsThemeVariants + type: boolean + - name: supportsThemeVariants + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member + package: '@microsoft/sp-module-interfaces!' fullName: supportsThemeVariants - langs: - - typeScript - type: property + summary: >- + Definition: If true, this web part supports and has been tested for theme + variants experience. + remarks: >- + Usage: Use this flag if a web part supports theme variants and has been + tested as such. In order to support theme variants, web parts must have + the capability to render correctly in the context of a theme variant. A + web part may or may not need to be updated to support theme variants, but + should always be tested before enabling this flag. By default no web parts + support theme variants. + isPreview: false + isDeprecated: false syntax: content: 'supportsThemeVariants?: boolean;' return: - type: - - boolean -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries~0:complex' - name: 'IClientSideWebPartManifestEntry[]' - fullName: 'IClientSideWebPartManifestEntry[]' - spec.typeScript: - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - name: IClientSideWebPartManifestEntry - fullName: IClientSideWebPartManifestEntry - - name: '[]' - fullName: '[]' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts~0:complex' - name: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> - fullName: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> - spec.typeScript: - - uid: '!Array:interface' - name: Array - fullName: Array - - name: <'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> - fullName: <'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> + type: boolean +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 0bde97e3..09c91ade 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -1,73 +1,73 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - summary: >- - This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each - pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content - authors can modify these properties on a need basis. - name: IClientSideWebPartManifestEntry - fullName: IClientSideWebPartManifestEntry - langs: - - typeScript - type: interface - syntax: - typeParameters: - - id: TProperties +### YamlMime:TSType +name: IClientSideWebPartManifestEntry +uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideWebPartManifestEntry +summary: >- + This interface specifies the set of properties that can be pre-configured by a + Web Part developer. Each pre-configured instance of the Web Part will need a + copy of these properties. Organization admins and content authors can modify + these properties on a need basis. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataVersion + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' + fullName: dataVersion summary: >- - Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note - that data version is different from the version field in the manifest. + Definition: Use this field to specify the data version of the + pre-configured data provided to the web part. Note that data version is + different from the version field in the manifest. remarks: >- - The manifest version is used to control the versioning of the web part code, while data version is used to control - the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more - information. + The manifest version is used to control the versioning of the web part + code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web + part for more information. Usage: versioning and evolving the serialized data of the web part - Type: string representing a [semantic version](http://semver.org) with only two parts + Type: string representing a [semantic version](http://semver.org) with + only two parts Supported values: MAJOR.MINOR Example: `"1.0"` - name: dataVersion - fullName: dataVersion - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'dataVersion?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' + type: string + - name: description + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member + package: '@microsoft/sp-module-interfaces!' + fullName: description summary: >- - Description of the web part represented as a dictionary of locale keys to description values. This value will be - displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display - areas. + Description of the web part represented as a dictionary of locale keys to + description values. This value will be displayed to the user in the + toolbox. This description should be used in the Toolbox tooltip and other + display areas. remarks: >- - The Web Part developer may give an initial description to the web part. The organization admin and page author - will have the ability to change this description as per need. + The Web Part developer may give an initial description to the web part. + The organization admin and page author will have the ability to change + this description as per need. - Usage: display the description of the web part in the toolbox tooltip, web part gallery and the page. + Usage: display the description of the web part in the toolbox tooltip, web + part gallery and the page. - Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + Supported values: a dictionary of locale keys to strings. Should always + have a `'default'` key. Example: `"A tool for displaying neat information."` @@ -82,87 +82,99 @@ items: } ``` - name: description - fullName: description - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' + type: >- + + - name: group + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member + package: '@microsoft/sp-module-interfaces!' + fullName: group summary: >- - The group name in web part picker to contain the web part in the classic page. If no value is provided, then the - web part will be displayed in the Miscellaneous group. + The group name in web part picker to contain the web part in the classic + page. If no value is provided, then the web part will be displayed in the + Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' isPreview: true - name: group - fullName: group - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'group?: ILocalizedString;' return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' + type: >- + + - name: groupId + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member + package: '@microsoft/sp-module-interfaces!' + fullName: groupId summary: >- - The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework - reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an - id not in the predefined groups, it falls back to Other group. + The group id to determine which modern group contains the web part in + modern site page. The SharePoint Framework reserves group ids for + predefined groups. The developer can pick one from those groups. If the + developer fills an id not in the predefined groups, it falls back to Other + group. remarks: |- Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` isPreview: true - name: groupId - fullName: groupId - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'groupId: PredefinedGroup | string;' return: - type: - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId~0:complex' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' + type: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry# + - name: iconImageUrl + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member + package: '@microsoft/sp-module-interfaces!' + fullName: iconImageUrl summary: >- - The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be - exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). + The icon for the web part, to be displayed in the toolbox, represented an + image URL. The image at the URL must be exactly 40x28 px (SPPPLAT + VSO\#218660 to fix the size of the icon image). remarks: >- If the [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member) - field does not have a value, this field must have a value. This value can be an absolute URL (e.g. - `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). - In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file - will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced - with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). + field does not have a value, this field must have a value. This value can + be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) + or a relative file path (e.g. `"./icons/my-icon.png"`). In the + latter case, the path will be resolved relative to the folder containing + the input manifest. The icon file will be copied to the deployment folder + like an asset, and the output manifest’s iconImageUrl will be replaced + with a URL relative to the URL used to load all other assets (the + loaderConfig.internalModuleBaseUrls property). Supported values: Any absolute URL. Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - name: iconImageUrl - fullName: iconImageUrl - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'iconImageUrl?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' + type: string + - name: officeFabricIconFontName + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member + package: '@microsoft/sp-module-interfaces!' + fullName: officeFabricIconFontName summary: >- - The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon - font file. + The icon for the Web Part, to be displayed in the toolbox, represented as + a character name in the Office 365 icon font file. remarks: >- - The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has - a value, the + The icon font is specified here: + [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this + field has a value, the [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member) field will be ignored. @@ -171,70 +183,82 @@ items: Example: "graph" - name: officeFabricIconFontName - fullName: officeFabricIconFontName - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'officeFabricIconFontName?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' + type: string + - name: properties + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member + package: '@microsoft/sp-module-interfaces!' + fullName: properties summary: >- - Every web part is expected to have some custom properties. For example, an image web part might define properties - for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so - on. + Every web part is expected to have some custom properties. For example, an + image web part might define properties for the image URL and caption text. + A list web part may have the list ID and list title as its properties, and + so on. remarks: >- - The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer - fully controls the schema for these properties. The web part developer should follow versioning rules when - updating the properties. + The SharePoint Framework passes these properties to the web parts when + they are loaded. The web part developer fully controls the schema for + these properties. The web part developer should follow versioning rules + when updating the properties. Usage: rendering of the web part - Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - name: properties - fullName: properties - langs: - - typeScript - type: property + Example: `{"imageSource": + "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": + "Contoso logo"}"` + isPreview: false + isDeprecated: false syntax: content: 'properties: TProperties;' return: - type: - - TProperties - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' + type: TProperties + - name: tags + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member + package: '@microsoft/sp-module-interfaces!' + fullName: tags summary: >- - This field is used to tag a web part with keywords that are different from the web part group name. Tags can be - used for categorization and searching of web parts. For example, in the web part toolbox. - remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + This field is used to tag a web part with keywords that are different from + the web part group name. Tags can be used for categorization and searching + of web parts. For example, in the web part toolbox. + remarks: >- + Example `[{ "default": "image" }, { "default": "media" }, { "default": + "picture" }, ...]` isPreview: true - name: tags - fullName: tags - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'tags?: ILocalizedString[];' return: - type: - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags~0:complex' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' + type: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry# + - name: title + uid: >- + @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member + package: '@microsoft/sp-module-interfaces!' + fullName: title summary: >- - Title of the web part represented as a single a dictionary of locale keys to title values. This value will be - displayed to the user in the toolbox. + Title of the web part represented as a single a dictionary of locale keys + to title values. This value will be displayed to the user in the toolbox. remarks: >- - This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title - to the web part. The organization admin and page author will have the ability to change this title as per need. + This title should be used in the Toolbox and other display areas. The Web + Part developer may give an initial title to the web part. The organization + admin and page author will have the ability to change this title as per + need. - Usage: display the name of the web part in the toolbox, web part gallery and the page. + Usage: display the name of the web part in the toolbox, web part gallery + and the page. - Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + Supported values: a dictionary of locale keys to strings. Should always + have a `'default'` key. Example: `"My Webpart"` @@ -249,34 +273,11 @@ items: } ``` - name: title - fullName: title - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' -references: - - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - name: ILocalizedString - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId~0:complex' - name: PredefinedGroup | string - fullName: PredefinedGroup | string - spec.typeScript: - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' - name: PredefinedGroup - fullName: PredefinedGroup - - name: ' | string' - fullName: ' | string' - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags~0:complex' - name: 'ILocalizedString[]' - fullName: 'ILocalizedString[]' - spec.typeScript: - - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - name: ILocalizedString - fullName: ILocalizedString - - name: '[]' - fullName: '[]' + type: >- + diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 505a16fa..12856c5f 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -1,24 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - summary: Manifest that is relevant to a Web Part instance. - name: IClientSideWebPartManifestInstance - fullName: IClientSideWebPartManifestInstance - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - syntax: - typeParameters: - - id: TProperties - package: '@microsoft/sp-module-interfaces!' -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase +### YamlMime:TSType +name: IClientSideWebPartManifestInstance +uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideWebPartManifestInstance +summary: Manifest that is relevant to a Web Part instance. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index b1071873..e8dbdd86 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -1,78 +1,81 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - summary: >- - Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool - bar, etc. - name: ICommandDefinition - fullName: ICommandDefinition - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ICommandDefinition +uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ICommandDefinition +summary: >- + Used by ICommandSetExtensionManifest, this defines a command to be displayed + by a UI surface such as a menu, tool bar, etc. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' - - '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' - - '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' - - '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' - summary: >- - Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by - default. Example: "Show information. Press ENTER to select." - name: ariaLabel fullName: ariaLabel - langs: - - typeScript - type: property + summary: >- + Custom accessibility text for the browser's "aria-label" attribute. If + omitted, the title property will be used by default. Example: "Show + information. Press ENTER to select." + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaLabel?: ILocalizedString;' return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' + type: >- + + - name: iconImageUrl + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: iconImageUrl summary: >- - An optional URL for an image to be displayed next to the command. The requirements for this image are defined by - the type of extension; some extension types may not display the image at all. + An optional URL for an image to be displayed next to the command. The + requirements for this image are defined by the type of extension; some + extension types may not display the image at all. remarks: >- - This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. - "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input - manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s - iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the - loaderConfig.internalModuleBaseUrls property). - name: iconImageUrl - fullName: iconImageUrl - langs: - - typeScript - type: property + This value can be an absolute URL (e.g. + "http://example.com/icons/my-icon.png") or a relative file path (e.g. + "./icons/my-icon.png"). In the latter case, the path will be resolved + relative to the folder containing the input manifest. The icon file will + be copied to the deployment folder like an asset, and the output + manifest’s iconImageUrl will be replaced with a URL relative to the URL + used to load all other assets (the loaderConfig.internalModuleBaseUrls + property). + isPreview: false + isDeprecated: false syntax: content: 'iconImageUrl?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' - summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' - name: title + type: string + - name: title + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' + package: '@microsoft/sp-module-interfaces!' fullName: title - langs: - - typeScript - type: property + summary: >- + A short label to be displayed by the associated button, menu item, etc. + Example: "Show information" + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' - summary: Type of the item. Currently only "command" is allowed. - name: type + type: >- + + - name: type + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' + package: '@microsoft/sp-module-interfaces!' fullName: type - langs: - - typeScript - type: property + summary: Type of the item. Currently only "command" is allowed. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'type: ''command'';' return: - type: - - '''command''' -references: - - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - name: ILocalizedString + type: '''command''' diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index 265dea4f..cabca070 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -1,87 +1,54 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - summary: >- - This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a - menu, tool bar, etc. - name: ICommandSetExtensionManifest - fullName: ICommandSetExtensionManifest - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' +### YamlMime:TSType +name: ICommandSetExtensionManifest +uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ICommandSetExtensionManifest +summary: >- + This is the manifest for a client-side extension that defines a set of custom + commands that can be shown in a menu, tool bar, etc. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: extensionType + uid: >- + @microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' - - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' - summary: >- - Specifies the type of client-side extension. Some extension types support additional manifest fields beyond - SPClientSideExtensionManifest. - name: extensionType fullName: extensionType - langs: - - typeScript - type: property + summary: >- + Specifies the type of client-side extension. Some extension types support + additional manifest fields beyond SPClientSideExtensionManifest. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'extensionType: ''ListViewCommandSet'';' return: - type: - - '''ListViewCommandSet''' - - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' - summary: A table of items defined by this command set. The object key is the Item ID. - remarks: >- - The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of - upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" - name: items + type: '''ListViewCommandSet''' + - name: items + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' + package: '@microsoft/sp-module-interfaces!' fullName: items - langs: - - typeScript - type: property + summary: >- + A table of items defined by this command set. The object key is the Item + ID. + remarks: >- + The Item ID is a unique identifier that event handlers use to recognize + the command The identifier must consist of upper-case letters, numbers, + and underscores. Example: "SHOW\_INFO" + isPreview: false + isDeprecated: false syntax: content: |- items: { [itemId: string]: ICommandDefinition; }; return: - type: - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items~0:complex' -references: - - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - name: IClientSideExtensionManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - name: IClientSideComponentManifest - - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - name: IClientSideManifestBase - - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items~0:complex' - name: |- - { - [itemId: string]: ICommandDefinition; - } - fullName: |- - { - [itemId: string]: ICommandDefinition; - } - spec.typeScript: - - name: |- - { - [itemId: string]: - fullName: |- - { - [itemId: string]: - - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - name: ICommandDefinition - fullName: ICommandDefinition - - name: |- - ; - } - fullName: |- - ; - } + type: >- + @microsoft/sp-module-interfaces!ICommandSetExtensionManifest# +extends: >- + diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index c0514547..996a25a4 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -1,94 +1,81 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' - summary: >- - This is the interface for a script module with the "component" type. Modules of this type will be provided via - manifests. In order for the dependency to be loaded, the manifest must be available on the site. - isPreview: true - name: IComponentModuleConfiguration - fullName: IComponentModuleConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' +### YamlMime:TSType +name: IComponentModuleConfiguration +uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IComponentModuleConfiguration +summary: >- + This is the interface for a script module with the "component" type. Modules + of this type will be provided via manifests. In order for the dependency to be + loaded, the manifest must be available on the site. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: failoverPath + uid: >- + @microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' - - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' - summary: A path to the framework-supplied component in case the framework fails to load the requested version. + fullName: failoverPath + summary: >- + A path to the framework-supplied component in case the framework fails to + load the requested version. remarks: >- - This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` - field. If this field is not specified and the version is not available in the framework runtime, the closest - matching version of the component will be provided instead. + This must be either a fully-qualified URL, or a path under the paths + specified in the `internalModuleBaseUrls` field. If this field is not + specified and the version is not available in the framework runtime, the + closest matching version of the component will be provided instead. - Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided - in the "internalModuleBaseUrls" field. + Supported values: The path to the component either as a fully-qualified + URL or as a path under the paths provided in the "internalModuleBaseUrls" + field. Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` isPreview: true - name: failoverPath - fullName: failoverPath - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'failoverPath?: string | IPath;' return: - type: - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath~0:complex' - - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' + type: >- + @microsoft/sp-module-interfaces!IComponentModuleConfiguration# + - name: id + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' + package: '@microsoft/sp-module-interfaces!' + fullName: id summary: The ID of the framework-supplied component to be loaded. remarks: |- Supported values: string representing a component's ID. Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` isPreview: true - name: id - fullName: id - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'id: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' + type: string + - name: version + uid: >- + @microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member + package: '@microsoft/sp-module-interfaces!' + fullName: version summary: >- - The version of the framework-supplied component to be loaded. For framework runtime component such as - `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was - developed against be specified. - remarks: |- - Supported values: string representing a [semantic version](http://semver.org), or "latest". + The version of the framework-supplied component to be loaded. For + framework runtime component such as `@microsoft/sp-client-base`<!-- + -->, it is recommended the version of the framework component the + component was developed against be specified. + remarks: >- + Supported values: string representing a [semantic + version](http://semver.org), or "latest". + Example: `"2.2.4"` isPreview: true - name: version - fullName: version - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'version: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - name: IModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath~0:complex' - name: string | IPath - fullName: string | IPath - spec.typeScript: - - name: 'string | ' - fullName: 'string | ' - - uid: '@microsoft/sp-module-interfaces!IPath:interface' - name: IPath - fullName: IPath + type: string +extends: '' diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 710688f2..39b3567b 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -1,65 +1,72 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - summary: This is the interface for a script module with the "localizedPath" type. - remarks: >- - Modules of this type must be provided by the component developer. These script resources are similar to those of - the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. - Paths in this module type are loaded exactly the same way as "internal" modules are. - isPreview: true - name: ILocalizedPathModuleConfiguration - fullName: ILocalizedPathModuleConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' +### YamlMime:TSType +name: ILocalizedPathModuleConfiguration +uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ILocalizedPathModuleConfiguration +summary: This is the interface for a script module with the "localizedPath" type. +remarks: >- + Modules of this type must be provided by the component developer. These script + resources are similar to those of the "path" type, but they may be present at + a number of different paths, to be selected by the user's locale. Paths in + this module type are loaded exactly the same way as "internal" modules are. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: defaultPath + uid: >- + @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' - - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' + fullName: defaultPath summary: >- - A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the - paths provided in the "internalModuleBaseUrls" field. + A path to this module's default locale javascript resource either as a + fully-qualified URL or as a path under the paths provided in the + "internalModuleBaseUrls" field. remarks: >- - If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this field - is used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are - treated. + If the user's locale does not resolve to one of the paths specified in the + "paths" field, the path in this field is used. Paths in this module type + are treated exactly the same way paths in modules of the "internal" type + are treated. - Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a - path under the paths provided in the "internalModuleBaseUrls" field. + Supported values: The path to the default locale version of the module + either as a fully-qualified URL or as a path under the paths provided in + the "internalModuleBaseUrls" field. Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` isPreview: true - name: defaultPath - fullName: defaultPath - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'defaultPath: string | IPath;' return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath~0:complex' - - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' + type: >- + @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration# + - name: paths + uid: >- + @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member + package: '@microsoft/sp-module-interfaces!' + fullName: paths summary: >- - This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale javascript resource - either as a fully-qualified URL or as a path under the paths provided in the `"internalModuleBaseUrls"` field. + This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to + this module's locale javascript resource either as a fully-qualified URL + or as a path under the paths provided in the `"internalModuleBaseUrls"` + field. remarks: >- - The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the - script resource under that path. If the user's locale does not resolve to one of the paths specified in this - field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this - field's value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key - will be used. If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this - field's value contains the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will - be used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are - treated. + The loader will attempt to resolve the user's locale to one of the paths + provided by this field, and will load the script resource under that path. + If the user's locale does not resolve to one of the paths specified in + this field, the path in `"defaultPath"` field is used. For example, if the + user's locale is `"en-gb"`, and this field's value contains the + keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the + `"en-gb"` key will be used. If the user's locale is "en-gb", and this + field's value contains the keys `[ "en-us", "fr-fr" ]`, the path + specified by the `"en-us"` key will be used. If the user's locale is + `"en-gb"`, and this field's value contains the keys `[ "es-es", + "fr-fr" ]`, the path specified by the "defaultPath" field will be + used. Paths in this module type are treated exactly the same way paths in + modules of the "internal" type are treated. Supported values: A dictionary of locale-to-path mappings. @@ -76,53 +83,14 @@ items: ``` isPreview: true - name: paths - fullName: paths - langs: - - typeScript - type: property + isDeprecated: false syntax: content: |- paths?: { [locale: string]: string | IPath; }; return: - type: - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' -references: - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - name: IModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath~0:complex' - name: string | IPath - fullName: string | IPath - spec.typeScript: - - name: 'string | ' - fullName: 'string | ' - - uid: '@microsoft/sp-module-interfaces!IPath:interface' - name: IPath - fullName: IPath - - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' - name: |- - { - [locale: string]: string | IPath; - } - fullName: |- - { - [locale: string]: string | IPath; - } - spec.typeScript: - - name: |- - { - [locale: string]: string | - fullName: |- - { - [locale: string]: string | - - uid: '@microsoft/sp-module-interfaces!IPath:interface' - name: IPath - fullName: IPath - - name: |- - ; - } - fullName: |- - ; - } + type: >- + @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration# +extends: '' diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index 19a154ca..1811cd34 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -1,78 +1,81 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - summary: A set of localized strings. - remarks: >- - Supported values: +### YamlMime:TSType +name: ILocalizedString +uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ILocalizedString +summary: A set of localized strings. +remarks: >- + Supported values: - - An Id referring to a localized resource. In this case it requires an 'id' key. + - An Id referring to a localized resource. In this case it requires an 'id' + key. - - A dictionary of locale keys to strings. In this case it requires a 'default' key. + - A dictionary of locale keys to strings. In this case it requires a 'default' + key. - ``` + ``` - Example 1: "My Application" - { - "id": "$myStrings:myStrings.MyApplication;" - } - Example 2: "My Application" - { - "default": "My Application" - "en-us": "My Application", - "fr-fr": "Ma demande", - "zh": "我的應用程式" - } + Example 1: "My Application" + { + "id": "$myStrings:myStrings.MyApplication;" + } + Example 2: "My Application" + { + "default": "My Application" + "en-us": "My Application", + "fr-fr": "Ma demande", + "zh": "我的應用程式" + } - ``` + ``` - Notes on string ids: + Notes on string ids: - - Ids have the following structure: `$:;` + - Ids have the following structure: `$:;` - - `resourceName` needs to be a `localizedResource` in the config.json. + - `resourceName` needs to be a `localizedResource` in the config.json. - - `expression` is an expression that will be evaluated to access the string from the resource module. + - `expression` is an expression that will be evaluated to access the string + from the resource module. - If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or - `"$resource:resource[\"MyString\"];"` + If your resource is a dictionary, access it through + `"$resource:resource.MyString;"` or `"$resource:resource[\"MyString\"];"` - For more complex cases, run an appropriate expression to access your resource and return the string. - name: ILocalizedString - fullName: ILocalizedString - langs: - - typeScript - type: interface + For more complex cases, run an appropriate expression to access your resource + and return the string. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: default + uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!ILocalizedString#default:member' - - '@microsoft/sp-module-interfaces!ILocalizedString#id:member' - - uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' - name: default fullName: default - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'default?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' - name: id + type: string + - name: id + uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' + package: '@microsoft/sp-module-interfaces!' fullName: id - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'id?: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index 63141ae1..3eb20db0 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -1,61 +1,64 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - summary: This is the base interface for a script module's definition. - isPreview: true - name: IModuleConfiguration - fullName: IModuleConfiguration - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IModuleConfiguration +uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IModuleConfiguration +summary: This is the base interface for a script module's definition. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: shouldNotPreload + uid: >- + @microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' - - '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' - summary: 'If set to `true`, this module should not be preloaded when loading the component.' + fullName: shouldNotPreload + summary: >- + If set to `true`<!-- -->, this module should not be preloaded when + loading the component. remarks: >- - The most common case for setting this property to "true" is when a module is defined in a manifest, but is not - required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded - asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. + The most common case for setting this property to "true" is when a module + is defined in a manifest, but is not required for the module referenced in + "entryModuleId" to load. Modules may be defined that are loaded + asynchronously, and these modules do not need to be preloaded. This field + implicitly defaults to `false`. Usage: Instructs the module loader to not preload this module. isPreview: true - name: shouldNotPreload - fullName: shouldNotPreload - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'shouldNotPreload?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' + type: boolean + - name: type + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type summary: >- - The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules - must be available on the paths provided in the `"internalModuleBaseUrls"` field. + The type of the script block. `"component"` modules come from a component, + `"path"` and `"localizedPath"` modules must be available on the paths + provided in the `"internalModuleBaseUrls"` field. remarks: >- - Modules with the `"path"` type use the `IPathModuleConfiguration` interface. + Modules with the `"path"` type use the `IPathModuleConfiguration` + interface. - Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the - "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. + Modules with the `"component"` type use the + `IComponentModuleConfiguration` interface. Modules with the + "localizedPath" type use the `ILocalizedPathModuleConfiguration` + interface. - Supported values: `"component"`, `"path"`, `"localizedPath"` + Supported values: `"component"`, `"path"`, + `"localizedPath"` Example: `"localized"` isPreview: true - name: type - fullName: type - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'type: ''component'' | ''path'' | ''localizedPath'';' return: - type: - - '''component'' | ''path'' | ''localizedPath''' + type: '''component'' | ''path'' | ''localizedPath''' diff --git a/SP-Framework/sp-module-interfaces/ipath.yml b/SP-Framework/sp-module-interfaces/ipath.yml index 88cdb3c8..689e54f2 100644 --- a/SP-Framework/sp-module-interfaces/ipath.yml +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -1,60 +1,58 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IPath:interface' - summary: >- - This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded - in exactly the same way as any other internal path. - isPreview: true - name: IPath - fullName: IPath - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPath +uid: '@microsoft/sp-module-interfaces!IPath:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IPath +summary: >- + This is the base interface for a set of debug and non-debug/minimized paths. + The paths in this object are loaded in exactly the same way as any other + internal path. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: debug + uid: '@microsoft/sp-module-interfaces!IPath#debug:member' package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IPath#debug:member' - - '@microsoft/sp-module-interfaces!IPath#default:member' - - uid: '@microsoft/sp-module-interfaces!IPath#debug:member' + fullName: debug summary: >- - A path to this module's debug javascript resource either as a fully-qualified URL or as a path under the paths - provided in the "internalModuleBaseUrls" field. The script referenced by this field is only loaded if it is - present and debug scripts are explicitly requested. + A path to this module's debug javascript resource either as a + fully-qualified URL or as a path under the paths provided in the + "internalModuleBaseUrls" field. The script referenced by this field is + only loaded if it is present and debug scripts are explicitly requested. remarks: >- - Supported values: The path to the debug script either as a fully-qualified URL or as a path under the paths - provided in the `"internalModuleBaseUrls"` field. + Supported values: The path to the debug script either as a fully-qualified + URL or as a path under the paths provided in the + `"internalModuleBaseUrls"` field. Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` isPreview: true - name: debug - fullName: debug - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'debug?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IPath#default:member' + type: string + - name: default + uid: '@microsoft/sp-module-interfaces!IPath#default:member' + package: '@microsoft/sp-module-interfaces!' + fullName: default summary: >- - A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided - in the "internalModuleBaseUrls" field. The script referenced by this field is loaded by default unless a debug - version of the script is provided and explicitly requested. + A path to this module's javascript resource either as a fully-qualified + URL or as a path under the paths provided in the "internalModuleBaseUrls" + field. The script referenced by this field is loaded by default unless a + debug version of the script is provided and explicitly requested. remarks: >- - Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the - paths provided in the "internalModuleBaseUrls" field. + Supported values: The path to the default/non-debug script either as a + fully-qualified URL or as a path under the paths provided in the + "internalModuleBaseUrls" field. Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` isPreview: true - name: default - fullName: default - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'default: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 45ba1c68..6baff21a 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -1,119 +1,110 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' - summary: >- - This is the interface for a script module with the "path" type. Modules of this type must be provided by the - component developer. - isPreview: true - name: IPathModuleConfiguration - fullName: IPathModuleConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - inheritance: - - type: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' +### YamlMime:TSType +name: IPathModuleConfiguration +uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IPathModuleConfiguration +summary: >- + This is the interface for a script module with the "path" type. Modules of + this type must be provided by the component developer. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: globalDependencies + uid: >- + @microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' - - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' + fullName: globalDependencies summary: >- - For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will - ensure that those dependencies are already loaded. + For non-AMD/module-pattern scripts that have dependencies (for example, + jQuery plugins), the module loader will ensure that those dependencies are + already loaded. remarks: >- - Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is - not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules - in the same component manifest that this module is specified, the module loader will throw an exception and the - component will fail to load. + Entries in the array specified in this field must refer to other non-AMD + modules in this component. This field is not required to have a value for + non-AMD modules. If any values are specified that do not refer to other + modules in the same component manifest that this module is specified, the + module loader will throw an exception and the component will fail to load. - Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key + Supported values: Names of other non-AMD-pattern modules in this loader + configuration, as specified by the key `IClientSideComponentLoaderConfiguration.scriptResources[]` Example: `["jquery"]` isPreview: true - name: globalDependencies - fullName: globalDependencies - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'globalDependencies?: string[];' return: - type: - - 'string[]' - - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' + type: 'string[]' + - name: globalName + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' + package: '@microsoft/sp-module-interfaces!' + fullName: globalName summary: >- - If this property is specified, this module is considered non-AMD and the module loader will not expect "define" or - "require" to be called. + If this property is specified, this module is considered non-AMD and the + module loader will not expect "define" or "require" to be called. remarks: >- - In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is called and - dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which - global variable must be examined. If this property is specified, this module is considered non-AMD and the module - loader will not expect "define" or "require" to be called. Instead, it will wait for the script to finish loading - and examine the global variable specified in this field. + In order to load scripts that don't follow the AMD/module-pattern where + "define" or "require" is called and dependencies are explicitly listed and + exports are explicitly returned, the module loader needs to know which + global variable must be examined. If this property is specified, this + module is considered non-AMD and the module loader will not expect + "define" or "require" to be called. Instead, it will wait for the script + to finish loading and examine the global variable specified in this field. - Supported values: Variable names that are expected to be populated after this module is loaded. For example, if - this module is describing jQuery, this value should probably be "$". If an empty string is specified, the module - loader will throw an exception and the component will fail to load. + Supported values: Variable names that are expected to be populated after + this module is loaded. For example, if this module is describing jQuery, + this value should probably be "$". If an empty string is specified, the + module loader will throw an exception and the component will fail to load. Example: `"$"` isPreview: true - name: globalName - fullName: globalName - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'globalName?: string;' return: - type: - - string - - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' + type: string + - name: path + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' + package: '@microsoft/sp-module-interfaces!' + fullName: path summary: >- - A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided - in the `internalModuleBaseUrls` field. + A path to this module's javascript resource either as a fully-qualified + URL or as a path under the paths provided in the `internalModuleBaseUrls` + field. remarks: >- - For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the - `"internalModuleBaseUrls"` field's value is `[ "https://contoso.akamaihd.net/files/", - "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from - the URL `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If - loading from that URL fails, the loader will then attempt to load this script resource from - `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL - fails to load, the component will fail to load and an error will be returned. + For example, if this field's value is + `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the + `"internalModuleBaseUrls"` field's value is `[ + "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" + ]`, the loader will first attempt to load this script resource + from the URL + `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading from that URL fails, the loader will then attempt to load + this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL fails to load, the component will fail to load and an + error will be returned. - Supported values: The path to the module either as a fully-qualified URL or as a path under the paths provided in - the "internalModuleBaseUrls" field. + Supported values: The path to the module either as a fully-qualified URL + or as a path under the paths provided in the "internalModuleBaseUrls" + field. Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` isPreview: true - name: path - fullName: path - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'path: string | IPath;' return: - type: - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' -references: - - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - name: IModuleConfiguration - - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' - name: string | IPath - fullName: string | IPath - spec.typeScript: - - name: 'string | ' - fullName: 'string | ' - - uid: '@microsoft/sp-module-interfaces!IPath:interface' - name: IPath - fullName: IPath + type: >- + @microsoft/sp-module-interfaces!IPathModuleConfiguration# +extends: '' diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index 03744b37..cb6ac347 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -1,105 +1,78 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' - summary: Predefined web part group. - isPreview: true - name: PredefinedGroup - fullName: PredefinedGroup - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: PredefinedGroup +uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' +package: '@microsoft/sp-module-interfaces!' +fullName: PredefinedGroup +summary: Predefined web part group. +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: BusinessAndIntelligence + uid: >- + @microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member package: '@microsoft/sp-module-interfaces!' - children: - - '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' - - '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' - - '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' - - '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' - - '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' - - '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' - - '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' - summary: |- + summary: >- Business and intelligence. - This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. - isPreview: true - name: BusinessAndIntelligence - fullName: BusinessAndIntelligence - langs: - - typeScript - type: field + + This group includes web parts for tracking and analyzing data, and for + integrating business flow with pages. numericValue: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' - summary: |- + - name: CommunicationAndCollaboration + uid: >- + @microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member + package: '@microsoft/sp-module-interfaces!' + summary: >- Communication and collaboration. - This group includes web parts that facilitate information sharing, team work, and social interactions. - isPreview: true - name: CommunicationAndCollaboration - fullName: CommunicationAndCollaboration - langs: - - typeScript - type: field + + This group includes web parts that facilitate information sharing, team + work, and social interactions. numericValue: '"75e22ed5-fa14-4829-850a-c890608aca2d"' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' - summary: |- + - name: Discovery + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' + package: '@microsoft/sp-module-interfaces!' + summary: >- Discovery. - This group includes web parts that organize, group, and filter content to help users discover information. - isPreview: true - name: Discovery - fullName: Discovery - langs: - - typeScript - type: field + + This group includes web parts that organize, group, and filter content to + help users discover information. numericValue: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' + - name: Other + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' + package: '@microsoft/sp-module-interfaces!' summary: |- Other. This group includes web parts not in other groups. - isPreview: true - name: Other - fullName: Other - langs: - - typeScript - type: field numericValue: '"5c03119e-3074-46fd-976b-c60198311f70"' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' - summary: |- + - name: PlanningAndProcess + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' + package: '@microsoft/sp-module-interfaces!' + summary: >- Planning and process. - This group includes web parts that empower team productivity with the use of planning and process tools. - isPreview: true - name: PlanningAndProcess - fullName: PlanningAndProcess - langs: - - typeScript - type: field + + This group includes web parts that empower team productivity with the use + of planning and process tools. numericValue: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' + - name: SiteTools + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' + package: '@microsoft/sp-module-interfaces!' summary: |- Site tools. This group includes web parts for site information and management. - isPreview: true - name: SiteTools - fullName: SiteTools - langs: - - typeScript - type: field numericValue: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' - - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' + - name: TextMediaAndContent + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' + package: '@microsoft/sp-module-interfaces!' summary: >- Text, media and content. - This group includes web parts that display text, multi-media, documents, information from the web, and other rich - content. - isPreview: true - name: TextMediaAndContent - fullName: TextMediaAndContent - langs: - - typeScript - type: field + This group includes web parts that display text, multi-media, documents, + information from the web, and other rich content. numericValue: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index bf066b18..1c46a875 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -1,48 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!' - summary: TypeScript interfaces for working with SharePoint REST APIs. - remarks: >- - This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. - It is useful when implementing data layers that interpret these types. This package does not contain any runtime - code; it consists only of type definitions. - name: '@microsoft/sp-odata-types' - fullName: '@microsoft/sp-odata-types' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-odata-types!_IODataUserId:interface' - - '@microsoft/sp-odata-types!IODataBasePermission:interface' - - '@microsoft/sp-odata-types!IODataChangeToken:interface' - - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - - '@microsoft/sp-odata-types!IODataList:interface' - - '@microsoft/sp-odata-types!IODataListItem:interface' - - '@microsoft/sp-odata-types!IODataNavigationNode:interface' - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - - '@microsoft/sp-odata-types!IODataUser:interface' - - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - - '@microsoft/sp-odata-types!IODataWeb:interface' -references: - - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' - name: _IODataUserId - - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - name: IODataBasePermission - - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' - name: IODataChangeToken - - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - name: IODataContextWebInformation - - uid: '@microsoft/sp-odata-types!IODataList:interface' - name: IODataList - - uid: '@microsoft/sp-odata-types!IODataListItem:interface' - name: IODataListItem - - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - name: IODataNavigationNode - - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - name: IODataNavigationNodeCollection - - uid: '@microsoft/sp-odata-types!IODataUser:interface' - name: IODataUser - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - name: IODataUserCustomAction - - uid: '@microsoft/sp-odata-types!IODataWeb:interface' - name: IODataWeb +### YamlMime:TSPacakge +uid: '@microsoft/sp-odata-types!' +name: '@microsoft/sp-odata-types' +type: package +summary: TypeScript interfaces for working with SharePoint REST APIs. +interfaces: + - '@microsoft/sp-odata-types!_IODataUserId:interface' + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - '@microsoft/sp-odata-types!IODataList:interface' + - '@microsoft/sp-odata-types!IODataListItem:interface' + - '@microsoft/sp-odata-types!IODataNavigationNode:interface' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + - '@microsoft/sp-odata-types!IODataUser:interface' + - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + - '@microsoft/sp-odata-types!IODataWeb:interface' diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index cf3ef575..c0518b2d 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -1,39 +1,39 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' - summary: >- - Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: _IODataUserId - fullName: _IODataUserId - langs: - - typeScript - type: interface +### YamlMime:TSType +name: _IODataUserId +uid: '@microsoft/sp-odata-types!_IODataUserId:interface' +package: '@microsoft/sp-odata-types!' +fullName: _IODataUserId +summary: >- + Represents an OData SP.UserId object. For more information about this object + see the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: NameId + uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!_IODataUserId#NameId:member' - - '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' - - uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' - summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' - name: NameId fullName: NameId - langs: - - typeScript - type: property + summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'NameId: string;' return: - type: - - string - - uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' - summary: 'Example: `"urn:office:idp:activedirectory"`' - name: NameIdIssuer + type: string + - name: NameIdIssuer + uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' + package: '@microsoft/sp-odata-types!' fullName: NameIdIssuer - langs: - - typeScript - type: property + summary: 'Example: `":"`' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'NameIdIssuer: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index ad3379fd..4f66a557 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -1,35 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - summary: Data used for creating a SPPermission object. - name: IODataBasePermission - fullName: IODataBasePermission - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataBasePermission#High:member' - - '@microsoft/sp-odata-types!IODataBasePermission#Low:member' - - uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' - name: High - fullName: High - langs: - - typeScript - type: property - syntax: - content: 'High: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' - name: Low - fullName: Low - langs: - - typeScript - type: property - syntax: - content: 'Low: number;' - return: - type: - - number +### YamlMime:TSType +name: IODataBasePermission +uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataBasePermission +summary: Data used for creating a SPPermission object. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: High + uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' + package: '@microsoft/sp-odata-types!' + fullName: High + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'High: number;' + return: + type: number + - name: Low + uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' + package: '@microsoft/sp-odata-types!' + fullName: Low + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Low: number;' + return: + type: number diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index c9d15958..353aaea7 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -1,26 +1,29 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' - summary: >- - Represents an OData SP.ChangeToken object. For more information about this object, see - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: IODataChangeToken - fullName: IODataChangeToken - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' - - uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' - summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' - name: StringValue - fullName: StringValue - langs: - - typeScript - type: property - syntax: - content: 'StringValue: string;' - return: - type: - - string +### YamlMime:TSType +name: IODataChangeToken +uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataChangeToken +summary: >- + Represents an OData SP.ChangeToken object. For more information about this + object, see [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: StringValue + uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' + package: '@microsoft/sp-odata-types!' + fullName: StringValue + summary: >- + Example: `{ StringValue: + "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'StringValue: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 8efafecf..b2498ee3 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -1,65 +1,65 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - summary: >- - Represents an OData SP.ContextWebInformation object. For more information about this object, see - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: IODataContextWebInformation - fullName: IODataContextWebInformation - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' - - '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' - - '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' - - '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' - - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' - summary: 'Example: `"16.0.4919.3000"`' - name: LibraryVersion - fullName: LibraryVersion - langs: - - typeScript - type: property - syntax: - content: 'LibraryVersion: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' - summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' - name: SiteFullUrl - fullName: SiteFullUrl - langs: - - typeScript - type: property - syntax: - content: 'SiteFullUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' - summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' - name: SupportedSchemaVersions - fullName: SupportedSchemaVersions - langs: - - typeScript - type: property - syntax: - content: 'SupportedSchemaVersions: string[];' - return: - type: - - 'string[]' - - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' - summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' - name: WebFullUrl - fullName: WebFullUrl - langs: - - typeScript - type: property - syntax: - content: 'WebFullUrl: string;' - return: - type: - - string +### YamlMime:TSType +name: IODataContextWebInformation +uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataContextWebInformation +summary: >- + Represents an OData SP.ContextWebInformation object. For more information + about this object, see [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: LibraryVersion + uid: >- + @microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member + package: '@microsoft/sp-odata-types!' + fullName: LibraryVersion + summary: 'Example: `"16.0.4919.3000"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LibraryVersion: string;' + return: + type: string + - name: SiteFullUrl + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: SiteFullUrl + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'SiteFullUrl: string;' + return: + type: string + - name: SupportedSchemaVersions + uid: >- + @microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member + package: '@microsoft/sp-odata-types!' + fullName: SupportedSchemaVersions + summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'SupportedSchemaVersions: string[];' + return: + type: 'string[]' + - name: WebFullUrl + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: WebFullUrl + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'WebFullUrl: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 30e0936b..3a7a0f03 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -1,187 +1,174 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataList:interface' - summary: >- - Represents an OData SP.List object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: IODataList - fullName: IODataList - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' - - '@microsoft/sp-odata-types!IODataList#Created:member' - - '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' - - '@microsoft/sp-odata-types!IODataList#Description:member' - - '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' - - '@microsoft/sp-odata-types!IODataList#Hidden:member' - - '@microsoft/sp-odata-types!IODataList#Id:member' - - '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' - - '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' - - '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' - - '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' - - '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' - - '@microsoft/sp-odata-types!IODataList#Title:member' - - uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' - summary: The list definition type on which the list is based. - name: BaseTemplate - fullName: BaseTemplate - langs: - - typeScript - type: property - syntax: - content: 'BaseTemplate: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataList#Created:member' - summary: 'Example: `"/Date(1453294804000)/"`' - name: Created - fullName: Created - langs: - - typeScript - type: property - syntax: - content: 'Created: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' - summary: The change token that will be used in logging the next change to the list. - name: CurrentChangeToken - fullName: CurrentChangeToken - langs: - - typeScript - type: property - syntax: - content: 'CurrentChangeToken: IODataChangeToken;' - return: - type: - - '@microsoft/sp-odata-types!IODataChangeToken:interface' - - uid: '@microsoft/sp-odata-types!IODataList#Description:member' - summary: A description of the List. - name: Description - fullName: Description - langs: - - typeScript - type: property - syntax: - content: 'Description: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' - summary: 'Example: `"MyListTitleList"`' - name: EntityTypeName - fullName: EntityTypeName - langs: - - typeScript - type: property - syntax: - content: 'EntityTypeName: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' - summary: >- - A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or - the Add Column page as an option for lookup fields. - name: Hidden - fullName: Hidden - langs: - - typeScript - type: property - syntax: - content: 'Hidden: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataList#Id:member' - summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' - name: Id - fullName: Id - langs: - - typeScript - type: property - syntax: - content: 'Id: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' - summary: 'Example: `"/Date(1453294809000)/"`' - name: LastItemDeletedDate - fullName: LastItemDeletedDate - langs: - - typeScript - type: property - syntax: - content: 'LastItemDeletedDate: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' - summary: 'Example: `"/Date(1453294809000)/"`' - name: LastItemModifiedDate - fullName: LastItemModifiedDate - langs: - - typeScript - type: property - syntax: - content: 'LastItemModifiedDate: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' - summary: 'Example: `"SP.Data.MyListTitleListItem"`' - name: ListItemEntityTypeFullName - fullName: ListItemEntityTypeFullName - langs: - - typeScript - type: property - syntax: - content: 'ListItemEntityTypeFullName: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' - summary: 'Example: `"/sites/PubSite"`' - name: ParentWebUrl - fullName: ParentWebUrl - langs: - - typeScript - type: property - syntax: - content: 'ParentWebUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' - summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' - name: TemplateFeatureId - fullName: TemplateFeatureId - langs: - - typeScript - type: property - syntax: - content: 'TemplateFeatureId: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataList#Title:member' - summary: 'Example: `"Pages"`' - name: Title - fullName: Title - langs: - - typeScript - type: property - syntax: - content: 'Title: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' - name: IODataChangeToken +### YamlMime:TSType +name: IODataList +uid: '@microsoft/sp-odata-types!IODataList:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataList +summary: >- + Represents an OData SP.List object. For more information about this object see + the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: BaseTemplate + uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' + package: '@microsoft/sp-odata-types!' + fullName: BaseTemplate + summary: The list definition type on which the list is based. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'BaseTemplate: number;' + return: + type: number + - name: Created + uid: '@microsoft/sp-odata-types!IODataList#Created:member' + package: '@microsoft/sp-odata-types!' + fullName: Created + summary: 'Example: `"/Date(1453294804000)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Created: string;' + return: + type: string + - name: CurrentChangeToken + uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' + package: '@microsoft/sp-odata-types!' + fullName: CurrentChangeToken + summary: The change token that will be used in logging the next change to the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CurrentChangeToken: IODataChangeToken;' + return: + type: '' + - name: Description + uid: '@microsoft/sp-odata-types!IODataList#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: A description of the List. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Description: string;' + return: + type: string + - name: EntityTypeName + uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' + package: '@microsoft/sp-odata-types!' + fullName: EntityTypeName + summary: 'Example: `"MyListTitleList"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'EntityTypeName: string;' + return: + type: string + - name: Hidden + uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' + package: '@microsoft/sp-odata-types!' + fullName: Hidden + summary: >- + A hidden list does not appear on the Documents and Lists page, Quick + Launch bar, the Modify Site Content page, or the Add Column page as an + option for lookup fields. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Hidden: boolean;' + return: + type: boolean + - name: Id + uid: '@microsoft/sp-odata-types!IODataList#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id: string;' + return: + type: string + - name: LastItemDeletedDate + uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' + package: '@microsoft/sp-odata-types!' + fullName: LastItemDeletedDate + summary: 'Example: `"/Date(1453294809000)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LastItemDeletedDate: string;' + return: + type: string + - name: LastItemModifiedDate + uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' + package: '@microsoft/sp-odata-types!' + fullName: LastItemModifiedDate + summary: 'Example: `"/Date(1453294809000)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LastItemModifiedDate: string;' + return: + type: string + - name: ListItemEntityTypeFullName + uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' + package: '@microsoft/sp-odata-types!' + fullName: ListItemEntityTypeFullName + summary: 'Example: `"SP.Data.MyListTitleListItem"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ListItemEntityTypeFullName: string;' + return: + type: string + - name: ParentWebUrl + uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: ParentWebUrl + summary: 'Example: `"/sites/PubSite"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ParentWebUrl: string;' + return: + type: string + - name: TemplateFeatureId + uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' + package: '@microsoft/sp-odata-types!' + fullName: TemplateFeatureId + summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'TemplateFeatureId: string;' + return: + type: string + - name: Title + uid: '@microsoft/sp-odata-types!IODataList#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: 'Example: `"Pages"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 3579d6a0..d01087a0 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -1,70 +1,69 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataListItem:interface' - summary: >- - Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: IODataListItem - fullName: IODataListItem - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' - - '@microsoft/sp-odata-types!IODataListItem#ID:member' - - '@microsoft/sp-odata-types!IODataListItem#Title:member' - - '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' - - uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' - summary: 'Example: `{ StringValue: "0x010100C5..." }`' - name: ContentTypeId - fullName: ContentTypeId - langs: - - typeScript - type: property - syntax: - content: |- - ContentTypeId: { - StringValue: string; - }; - return: - type: - - |- - { - StringValue: string; - } - - uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' - name: ID - fullName: ID - langs: - - typeScript - type: property - syntax: - content: 'ID: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' - summary: Title of the List Item - name: Title - fullName: Title - langs: - - typeScript - type: property - syntax: - content: 'Title: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' - summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' - name: UniqueId - fullName: UniqueId - langs: - - typeScript - type: property - syntax: - content: 'UniqueId: string;' - return: - type: - - string +### YamlMime:TSType +name: IODataListItem +uid: '@microsoft/sp-odata-types!IODataListItem:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataListItem +summary: >- + Represents an OData SP.ListItem object. For more information about this object + see the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ContentTypeId + uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' + package: '@microsoft/sp-odata-types!' + fullName: ContentTypeId + summary: 'Example: `{ StringValue: "0x010100C5..." }`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + ContentTypeId: { + StringValue: string; + }; + return: + type: |- + { + StringValue: string; + } + - name: ID + uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' + package: '@microsoft/sp-odata-types!' + fullName: ID + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ID: number;' + return: + type: number + - name: Title + uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: Title of the List Item + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string + - name: UniqueId + uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' + package: '@microsoft/sp-odata-types!' + fullName: UniqueId + summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'UniqueId: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index bfe4eb27..ee29c28f 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -1,117 +1,111 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - summary: >- - Represents an OData SP.NavigationNode object. - [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) - name: IODataNavigationNode - fullName: IODataNavigationNode - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' - - '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' - - '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' - - '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' - - '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' - - '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' - - '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' - summary: Gets or sets an array of Navigation Nodes that are children to the current node. - name: Children - fullName: Children - langs: - - typeScript - type: property - syntax: - content: 'Children?: IODataNavigationNode[];' - return: - type: - - '@microsoft/sp-odata-types!IODataNavigationNode#Children~0:complex' - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' - summary: Gets a value that specifies the identifier for the navigation node. - name: Id - fullName: Id - langs: - - typeScript - type: property - syntax: - content: 'Id?: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' - name: IsDocLib - fullName: IsDocLib - langs: - - typeScript - type: property - syntax: - content: 'IsDocLib?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' - summary: >- - Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of - the site collection. - name: IsExternal - fullName: IsExternal - langs: - - typeScript - type: property - syntax: - content: 'IsExternal?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' - summary: Gets or sets a value that specifies if the node navigation link should be visible. - name: IsVisible - fullName: IsVisible - langs: - - typeScript - type: property - syntax: - content: 'IsVisible?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' - summary: Gets or sets a value that specifies the anchor text for the node navigation link. - name: Title - fullName: Title - langs: - - typeScript - type: property - syntax: - content: 'Title?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' - summary: >- - Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative - form if IsExternal is false. It must be a URL of relative or absolute form. - name: Url - fullName: Url - langs: - - typeScript - type: property - syntax: - content: 'Url?: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children~0:complex' - name: 'IODataNavigationNode[]' - fullName: 'IODataNavigationNode[]' - spec.typeScript: - - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - name: IODataNavigationNode - fullName: IODataNavigationNode - - name: '[]' - fullName: '[]' +### YamlMime:TSType +name: IODataNavigationNode +uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataNavigationNode +summary: >- + Represents an OData SP.NavigationNode object. [.microsoft.com/en-us/library/office/jj246311.aspx](.microsoft.com/en-us/library/office/jj246311.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: Children + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' + package: '@microsoft/sp-odata-types!' + fullName: Children + summary: >- + Gets or sets an array of Navigation Nodes that are children to the current + node. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Children?: IODataNavigationNode[];' + return: + type: >- + @microsoft/sp-odata-types!IODataNavigationNode# + - name: Id + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: Gets a value that specifies the identifier for the navigation node. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id?: number;' + return: + type: number + - name: IsDocLib + uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' + package: '@microsoft/sp-odata-types!' + fullName: IsDocLib + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsDocLib?: boolean;' + return: + type: boolean + - name: IsExternal + uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' + package: '@microsoft/sp-odata-types!' + fullName: IsExternal + summary: >- + Gets or sets a value that specifies whether the navigation node URL + potentially corresponds to pages outside of the site collection. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsExternal?: boolean;' + return: + type: boolean + - name: IsVisible + uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' + package: '@microsoft/sp-odata-types!' + fullName: IsVisible + summary: >- + Gets or sets a value that specifies if the node navigation link should be + visible. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsVisible?: boolean;' + return: + type: boolean + - name: Title + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: >- + Gets or sets a value that specifies the anchor text for the node + navigation link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title?: string;' + return: + type: string + - name: Url + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' + package: '@microsoft/sp-odata-types!' + fullName: Url + summary: >- + Gets or sets a value that specifies the URL to be stored with the + navigation node. It must be a URL of relative form if IsExternal is false. + It must be a URL of relative or absolute form. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Url?: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 1a73ca6b..d7b29d74 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -1,58 +1,48 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - summary: >- - Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. - [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) - name: IODataNavigationNodeCollection - fullName: IODataNavigationNodeCollection - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' - - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' - summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. - name: quickLaunch - fullName: quickLaunch - langs: - - typeScript - type: property - syntax: - content: 'quickLaunch: IODataNavigationNode[];' - return: - type: - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch~0:complex' - - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' - summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. - name: topNav - fullName: topNav - langs: - - typeScript - type: property - syntax: - content: 'topNav: IODataNavigationNode[];' - return: - type: - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav~0:complex' -references: - - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch~0:complex' - name: 'IODataNavigationNode[]' - fullName: 'IODataNavigationNode[]' - spec.typeScript: - - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - name: IODataNavigationNode - fullName: IODataNavigationNode - - name: '[]' - fullName: '[]' - - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav~0:complex' - name: 'IODataNavigationNode[]' - fullName: 'IODataNavigationNode[]' - spec.typeScript: - - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' - name: IODataNavigationNode - fullName: IODataNavigationNode - - name: '[]' - fullName: '[]' +### YamlMime:TSType +name: IODataNavigationNodeCollection +uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataNavigationNodeCollection +summary: >- + Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. + [.microsoft.com/en-us/library/office/ee557907.aspx](.microsoft.com/en-us/library/office/ee557907.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: quickLaunch + uid: >- + @microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member + package: '@microsoft/sp-odata-types!' + fullName: quickLaunch + summary: >- + Gets an SPNavigationNode object that contains the nodes in the Quick + Launch area of the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'quickLaunch: IODataNavigationNode[];' + return: + type: >- + @microsoft/sp-odata-types!IODataNavigationNodeCollection# + - name: topNav + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' + package: '@microsoft/sp-odata-types!' + fullName: topNav + summary: >- + Gets an SPNavigationNode object that contains the nodes in the top link + bar for the website. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'topNav: IODataNavigationNode[];' + return: + type: >- + @microsoft/sp-odata-types!IODataNavigationNodeCollection# diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index b906f692..c3b4aa0f 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -1,122 +1,118 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataUser:interface' - summary: >- - Represents an OData SP.User object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: IODataUser - fullName: IODataUser - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataUser#Email:member' - - '@microsoft/sp-odata-types!IODataUser#Id:member' - - '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' - - '@microsoft/sp-odata-types!IODataUser#LoginName:member' - - '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' - - '@microsoft/sp-odata-types!IODataUser#Title:member' - - '@microsoft/sp-odata-types!IODataUser#UserId:member' - - uid: '@microsoft/sp-odata-types!IODataUser#Email:member' - summary: 'Example: `"someone@example.com"`' - name: Email - fullName: Email - langs: - - typeScript - type: property - syntax: - content: 'Email: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUser#Id:member' - name: Id - fullName: Id - langs: - - typeScript - type: property - syntax: - content: 'Id: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' - summary: Boolean value that specifies whether the user is a site collection administrator. - name: IsSiteAdmin - fullName: IsSiteAdmin - langs: - - typeScript - type: property - syntax: - content: 'IsSiteAdmin: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' - summary: 'Example: `"i:0#.w|domain\user"`' - name: LoginName - fullName: LoginName - langs: - - typeScript - type: property - syntax: - content: 'LoginName: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' - summary: This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. - remarks: |- - Values: - - None: 0 - - User: 1 - - DistributionList: 2 - - SecurityGroup: 4 - - SharePointGroup: 8 - - All: 15 - name: PrincipalType - fullName: PrincipalType - langs: - - typeScript - type: property - syntax: - content: 'PrincipalType: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataUser#Title:member' - summary: 'Example: `"DOMAIN\user"`' - name: Title - fullName: Title - langs: - - typeScript - type: property - syntax: - content: 'Title: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' - summary: >- - Gets the information of the user that contains the user's name identifier and the issuer of the user's name - identifier. - name: UserId - fullName: UserId - langs: - - typeScript - type: property - syntax: - content: 'UserId: IODataUserId;' - return: - type: - - '@microsoft/sp-odata-types!IODataUserId:interface' -references: - - uid: '@microsoft/sp-odata-types!IODataUserId:interface' - name: IODataUserId +### YamlMime:TSType +name: IODataUser +uid: '@microsoft/sp-odata-types!IODataUser:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataUser +summary: >- + Represents an OData SP.User object. For more information about this object see + the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: Email + uid: '@microsoft/sp-odata-types!IODataUser#Email:member' + package: '@microsoft/sp-odata-types!' + fullName: Email + summary: 'Example: `"someone@example.com"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Email: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataUser#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id: number;' + return: + type: number + - name: IsSiteAdmin + uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' + package: '@microsoft/sp-odata-types!' + fullName: IsSiteAdmin + summary: >- + Boolean value that specifies whether the user is a site collection + administrator. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsSiteAdmin: boolean;' + return: + type: boolean + - name: LoginName + uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' + package: '@microsoft/sp-odata-types!' + fullName: LoginName + summary: 'Example: `"#.w|domain\user"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LoginName: string;' + return: + type: string + - name: PrincipalType + uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' + package: '@microsoft/sp-odata-types!' + fullName: PrincipalType + summary: >- + This enumeration has a FlagsAttribute attribute that allows a bitwise + combination of its member values. + remarks: |- + Values: + + None: 0 + + User: 1 + + DistributionList: 2 + + SecurityGroup: 4 + + SharePointGroup: 8 + + All: 15 + isPreview: false + isDeprecated: false + syntax: + content: 'PrincipalType: number;' + return: + type: number + - name: Title + uid: '@microsoft/sp-odata-types!IODataUser#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: 'Example: `"DOMAIN\user"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string + - name: UserId + uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' + package: '@microsoft/sp-odata-types!' + fullName: UserId + summary: >- + Gets the information of the user that contains the user's name identifier + and the issuer of the user's name identifier. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'UserId: IODataUserId;' + return: + type: '' diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index 74421167..ad5a9aff 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -1,272 +1,268 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - summary: >- - Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation - here: - [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) - name: IODataUserCustomAction - fullName: IODataUserCustomAction - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' - - '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' - summary: The unique identifier of the client-side component defined with SharePoint Framework - remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' - name: ClientSideComponentId - fullName: ClientSideComponentId - langs: - - typeScript - type: property - syntax: - content: 'ClientSideComponentId: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' - summary: Custom initialization properties for the client-side component. - remarks: >- - This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string - must contain a JSON object with custom initialization properties whose format and meaning are defined by the - client-side component. - - - Example: `"{ \"maxItemsToShow\": 123 }"` - name: ClientSideComponentProperties - fullName: ClientSideComponentProperties - langs: - - typeScript - type: property - syntax: - content: 'ClientSideComponentProperties: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' - summary: >- - Gets or sets a value that specifies an implementation specific XML fragment that determines user interface - properties of the custom action. - name: CommandUIExtension - fullName: CommandUIExtension - langs: - - typeScript - type: property - syntax: - content: 'CommandUIExtension: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' - summary: Gets or sets the description of the custom action. - name: Description - fullName: Description - langs: - - typeScript - type: property - syntax: - content: 'Description: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' - summary: >- - Gets or sets a value that specifies an implementation-specific value that determines the position of the custom - action in the page. - name: Group - fullName: Group - langs: - - typeScript - type: property - syntax: - content: 'Group: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' - summary: >- - Gets a value that specifies the identifier (GUID) of the custom action. Example: - `"48309f28-53aa-43ed-b113-625120e5af6f"` - name: Id - fullName: Id - langs: - - typeScript - type: property - syntax: - content: 'Id: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' - summary: Gets or sets the URL of the image associated with the custom action. - name: ImageUrl - fullName: ImageUrl - langs: - - typeScript - type: property - syntax: - content: 'ImageUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' - summary: Gets or sets the location of the custom action. - remarks: 'Example: `"ClientSide.Application"`' - name: Location - fullName: Location - langs: - - typeScript - type: property - syntax: - content: 'Location: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' - summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. - name: RegistrationId - fullName: RegistrationId - langs: - - typeScript - type: property - syntax: - content: 'RegistrationId: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' - summary: Gets or sets the value that specifies the type of object associated with the custom action. - remarks: >- - Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType - = 4. - name: RegistrationType - fullName: RegistrationType - langs: - - typeScript - type: property - syntax: - content: 'RegistrationType: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' - summary: Gets or sets the value that specifies the permissions needed for the custom action. - name: Rights - fullName: Rights - langs: - - typeScript - type: property - syntax: - content: 'Rights: IODataBasePermission;' - return: - type: - - '@microsoft/sp-odata-types!IODataBasePermission:interface' - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' - summary: Gets a value that specifies the scope of the custom action. - name: Scope - fullName: Scope - langs: - - typeScript - type: property - syntax: - content: 'Scope: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' - summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. - name: ScriptBlock - fullName: ScriptBlock - langs: - - typeScript - type: property - syntax: - content: 'ScriptBlock: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' - summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. - name: ScriptSrc - fullName: ScriptSrc - langs: - - typeScript - type: property - syntax: - content: 'ScriptSrc: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' - summary: >- - Gets or sets the value that specifies an implementation-specific value that determines the order of the custom - action that appears on the page. - name: Sequence - fullName: Sequence - langs: - - typeScript - type: property - syntax: - content: 'Sequence: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' - summary: Gets or sets the display title of the custom action. - name: Title - fullName: Title - langs: - - typeScript - type: property - syntax: - content: 'Title: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' - summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' - name: Url - fullName: Url - langs: - - typeScript - type: property - syntax: - content: 'Url: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' - summary: Gets a value that specifies an implementation specific version identifier. - remarks: 'Example: `"16.0.1.0"`' - name: VersionOfUserCustomAction - fullName: VersionOfUserCustomAction - langs: - - typeScript - type: property - syntax: - content: 'VersionOfUserCustomAction: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - name: IODataBasePermission +### YamlMime:TSType +name: IODataUserCustomAction +uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataUserCustomAction +summary: >- + Represents an OData SP.UserCustomAction object. For more information about + this object see the MSDN documentation here: [.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ClientSideComponentId + uid: >- + @microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member + package: '@microsoft/sp-odata-types!' + fullName: ClientSideComponentId + summary: >- + The unique identifier of the client-side component defined with SharePoint + Framework + remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' + isPreview: false + isDeprecated: false + syntax: + content: 'ClientSideComponentId: string;' + return: + type: string + - name: ClientSideComponentProperties + uid: >- + @microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member + package: '@microsoft/sp-odata-types!' + fullName: ClientSideComponentProperties + summary: Custom initialization properties for the client-side component. + remarks: >- + This property is only used when a ClientSideComponentId is specified. It + is optional. If non-empty, the string must contain a JSON object with + custom initialization properties whose format and meaning are defined by + the client-side component. + + + Example: `"{ \"maxItemsToShow\": 123 }"` + isPreview: false + isDeprecated: false + syntax: + content: 'ClientSideComponentProperties: string;' + return: + type: string + - name: CommandUIExtension + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' + package: '@microsoft/sp-odata-types!' + fullName: CommandUIExtension + summary: >- + Gets or sets a value that specifies an implementation specific XML + fragment that determines user interface properties of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CommandUIExtension: string;' + return: + type: string + - name: Description + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: Gets or sets the description of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Description: string;' + return: + type: string + - name: Group + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' + package: '@microsoft/sp-odata-types!' + fullName: Group + summary: >- + Gets or sets a value that specifies an implementation-specific value that + determines the position of the custom action in the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Group: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: >- + Gets a value that specifies the identifier (GUID) of the custom action. + Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id: string;' + return: + type: string + - name: ImageUrl + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: ImageUrl + summary: Gets or sets the URL of the image associated with the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ImageUrl: string;' + return: + type: string + - name: Location + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' + package: '@microsoft/sp-odata-types!' + fullName: Location + summary: Gets or sets the location of the custom action. + remarks: 'Example: `"ClientSide.Application"`' + isPreview: false + isDeprecated: false + syntax: + content: 'Location: string;' + return: + type: string + - name: RegistrationId + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' + package: '@microsoft/sp-odata-types!' + fullName: RegistrationId + summary: >- + Gets or sets the value that specifies the identifier of the object + associated with the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'RegistrationId: string;' + return: + type: string + - name: RegistrationType + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' + package: '@microsoft/sp-odata-types!' + fullName: RegistrationType + summary: >- + Gets or sets the value that specifies the type of object associated with + the custom action. + remarks: >- + Represents an SP.UserCustomActionRegistrationType value: None = 0; List = + 1; ContentType = 2; ProgId = 3; FileType = 4. + isPreview: false + isDeprecated: false + syntax: + content: 'RegistrationType: number;' + return: + type: number + - name: Rights + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' + package: '@microsoft/sp-odata-types!' + fullName: Rights + summary: >- + Gets or sets the value that specifies the permissions needed for the + custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Rights: IODataBasePermission;' + return: + type: >- + + - name: Scope + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' + package: '@microsoft/sp-odata-types!' + fullName: Scope + summary: Gets a value that specifies the scope of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Scope: number;' + return: + type: number + - name: ScriptBlock + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' + package: '@microsoft/sp-odata-types!' + fullName: ScriptBlock + summary: >- + Gets or sets the value that specifies the ECMAScript to be executed when + the custom action is performed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ScriptBlock: string;' + return: + type: string + - name: ScriptSrc + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' + package: '@microsoft/sp-odata-types!' + fullName: ScriptSrc + summary: >- + Gets or sets a value that specifies the URI of a file which contains the + ECMAScript to execute on the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ScriptSrc: string;' + return: + type: string + - name: Sequence + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' + package: '@microsoft/sp-odata-types!' + fullName: Sequence + summary: >- + Gets or sets the value that specifies an implementation-specific value + that determines the order of the custom action that appears on the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Sequence: number;' + return: + type: number + - name: Title + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: Gets or sets the display title of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string + - name: Url + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' + package: '@microsoft/sp-odata-types!' + fullName: Url + summary: >- + Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function + associated with the action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Url: string;' + return: + type: string + - name: VersionOfUserCustomAction + uid: >- + @microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member + package: '@microsoft/sp-odata-types!' + fullName: VersionOfUserCustomAction + summary: Gets a value that specifies an implementation specific version identifier. + remarks: 'Example: `"16.0.1.0"`' + isPreview: false + isDeprecated: false + syntax: + content: 'VersionOfUserCustomAction: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index e6352b65..8cea1ef2 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -1,280 +1,273 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-odata-types!IODataWeb:interface' - summary: >- - Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) - name: IODataWeb - fullName: IODataWeb - langs: - - typeScript - type: interface - package: '@microsoft/sp-odata-types!' - children: - - '@microsoft/sp-odata-types!IODataWeb#Created:member' - - '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' - - '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' - - '@microsoft/sp-odata-types!IODataWeb#Description:member' - - '@microsoft/sp-odata-types!IODataWeb#Id:member' - - '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' - - '@microsoft/sp-odata-types!IODataWeb#Language:member' - - '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' - - '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' - - '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' - - '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' - - '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' - - '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' - - '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' - - '@microsoft/sp-odata-types!IODataWeb#Title:member' - - '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' - - '@microsoft/sp-odata-types!IODataWeb#Url:member' - - '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' - - uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' - summary: |- - Gets a value that specifies when the site was created. - - Example: `"/Date(2016,0,20,12,58,7,0)/"` - name: Created - fullName: Created - langs: - - typeScript - type: property - syntax: - content: 'Created?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' - summary: Represents the unique sequential location of a change within the change log. - name: CurrentChangeToken - fullName: CurrentChangeToken - langs: - - typeScript - type: property - syntax: - content: 'CurrentChangeToken?: IODataChangeToken;' - return: - type: - - '@microsoft/sp-odata-types!IODataChangeToken:interface' - - uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' - summary: |- - Gets or sets the URL for a custom master page file to apply to the website. - - Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` - name: CustomMasterUrl - fullName: CustomMasterUrl - langs: - - typeScript - type: property - syntax: - content: 'CustomMasterUrl?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' - summary: Gets or sets the description for the site. - name: Description - fullName: Description - langs: - - typeScript - type: property - syntax: - content: 'Description?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' - summary: |- - Gets a value that specifies the site identifier for the site. - - Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` - name: Id - fullName: Id - langs: - - typeScript - type: property - syntax: - content: 'Id?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' - summary: Value that represents if the web was - name: IsMultilingual - fullName: IsMultilingual - langs: - - typeScript - type: property - syntax: - content: 'IsMultilingual?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' - summary: |- - Gets a value that specifies the LCID for the language that is used on the site. - - Example: `1033` - name: Language - fullName: Language - langs: - - typeScript - type: property - syntax: - content: 'Language?: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' - summary: |- - Gets a value that specifies when an item was last modified in the site. - - Example: `"/Date(1453618828000)/"` - name: LastItemModifiedDate - fullName: LastItemModifiedDate - langs: - - typeScript - type: property - syntax: - content: 'LastItemModifiedDate?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' - summary: |- - Gets or sets the URL of the master page that is used for the website. - - Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` - name: MasterUrl - fullName: MasterUrl - langs: - - typeScript - type: property - syntax: - content: 'MasterUrl?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' - summary: Determines if a particular web will be crawled by search or not. - name: NoCrawl - fullName: NoCrawl - langs: - - typeScript - type: property - syntax: - content: 'NoCrawl?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' - summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. - name: QuickLaunchEnabled - fullName: QuickLaunchEnabled - langs: - - typeScript - type: property - syntax: - content: 'QuickLaunchEnabled?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' - summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. - name: RecycleBinEnabled - fullName: RecycleBinEnabled - langs: - - typeScript - type: property - syntax: - content: 'RecycleBinEnabled?: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' - summary: |- - Gets or sets the server-relative URL for the Web site. - - Example: `"/sites/PubSite"` - name: ServerRelativeUrl - fullName: ServerRelativeUrl - langs: - - typeScript - type: property - syntax: - content: 'ServerRelativeUrl?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' - summary: Gets the url for the logo of this particular site. - name: SiteLogoUrl - fullName: SiteLogoUrl - langs: - - typeScript - type: property - syntax: - content: 'SiteLogoUrl?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' - summary: The title of the web. - name: Title - fullName: Title - langs: - - typeScript - type: property - syntax: - content: 'Title?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' - summary: |- - Gets or sets the user interface (UI) version of the Web site. - - Example: `15` - name: UIVersion - fullName: UIVersion - langs: - - typeScript - type: property - syntax: - content: 'UIVersion?: number;' - return: - type: - - number - - uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' - summary: |- - Gets the absolute URL for the website. - - Example: `"http://example.com/sites/PubSite"` - name: Url - fullName: Url - langs: - - typeScript - type: property - syntax: - content: 'Url?: string;' - return: - type: - - string - - uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' - summary: |- - Gets the name of the site definition or site template that was used to create the site. - - Example: `"BLANKINTERNET"` - name: WebTemplate - fullName: WebTemplate - langs: - - typeScript - type: property - syntax: - content: 'WebTemplate?: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' - name: IODataChangeToken +### YamlMime:TSType +name: IODataWeb +uid: '@microsoft/sp-odata-types!IODataWeb:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataWeb +summary: >- + Represents an OData SP.Web object. For more information about this object see + the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: Created + uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' + package: '@microsoft/sp-odata-types!' + fullName: Created + summary: |- + Gets a value that specifies when the site was created. + + Example: `"/Date(2016,0,20,12,58,7,0)/"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Created?: string;' + return: + type: string + - name: CurrentChangeToken + uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' + package: '@microsoft/sp-odata-types!' + fullName: CurrentChangeToken + summary: >- + Represents the unique sequential location of a change within the change + log. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CurrentChangeToken?: IODataChangeToken;' + return: + type: '' + - name: CustomMasterUrl + uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: CustomMasterUrl + summary: >- + Gets or sets the URL for a custom master page file to apply to the + website. + + + Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CustomMasterUrl?: string;' + return: + type: string + - name: Description + uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: Gets or sets the description for the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Description?: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: |- + Gets a value that specifies the site identifier for the site. + + Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id?: string;' + return: + type: string + - name: IsMultilingual + uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' + package: '@microsoft/sp-odata-types!' + fullName: IsMultilingual + summary: Value that represents if the web was + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsMultilingual?: boolean;' + return: + type: boolean + - name: Language + uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' + package: '@microsoft/sp-odata-types!' + fullName: Language + summary: >- + Gets a value that specifies the LCID for the language that is used on the + site. + + + Example: `1033` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Language?: number;' + return: + type: number + - name: LastItemModifiedDate + uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' + package: '@microsoft/sp-odata-types!' + fullName: LastItemModifiedDate + summary: |- + Gets a value that specifies when an item was last modified in the site. + + Example: `"/Date(1453618828000)/"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LastItemModifiedDate?: string;' + return: + type: string + - name: MasterUrl + uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: MasterUrl + summary: |- + Gets or sets the URL of the master page that is used for the website. + + Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'MasterUrl?: string;' + return: + type: string + - name: NoCrawl + uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' + package: '@microsoft/sp-odata-types!' + fullName: NoCrawl + summary: Determines if a particular web will be crawled by search or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'NoCrawl?: boolean;' + return: + type: boolean + - name: QuickLaunchEnabled + uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' + package: '@microsoft/sp-odata-types!' + fullName: QuickLaunchEnabled + summary: >- + Gets or sets a value that specifies whether the Quick Launch area is + enabled on the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'QuickLaunchEnabled?: boolean;' + return: + type: boolean + - name: RecycleBinEnabled + uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' + package: '@microsoft/sp-odata-types!' + fullName: RecycleBinEnabled + summary: >- + Gets or sets a value that determines whether the recycle bin is enabled + for the website. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'RecycleBinEnabled?: boolean;' + return: + type: boolean + - name: ServerRelativeUrl + uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: ServerRelativeUrl + summary: |- + Gets or sets the server-relative URL for the Web site. + + Example: `"/sites/PubSite"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ServerRelativeUrl?: string;' + return: + type: string + - name: SiteLogoUrl + uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: SiteLogoUrl + summary: Gets the url for the logo of this particular site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'SiteLogoUrl?: string;' + return: + type: string + - name: Title + uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: The title of the web. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title?: string;' + return: + type: string + - name: UIVersion + uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' + package: '@microsoft/sp-odata-types!' + fullName: UIVersion + summary: |- + Gets or sets the user interface (UI) version of the Web site. + + Example: `15` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'UIVersion?: number;' + return: + type: number + - name: Url + uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' + package: '@microsoft/sp-odata-types!' + fullName: Url + summary: |- + Gets the absolute URL for the website. + + Example: `".com/sites/PubSite"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Url?: string;' + return: + type: string + - name: WebTemplate + uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' + package: '@microsoft/sp-odata-types!' + fullName: WebTemplate + summary: >- + Gets the name of the site definition or site template that was used to + create the site. + + + Example: `"BLANKINTERNET"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'WebTemplate?: string;' + return: + type: string diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index 2c81e720..00d036bd 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -1,53 +1,21 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!' - summary: Page context services for the SharePoint Framework - remarks: >- - The page context allows an application and its web parts to share common data about the current page, such as its - contents, URL, list, user, permissions, navigation menu, etc. - name: '@microsoft/sp-page-context' - fullName: '@microsoft/sp-page-context' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-page-context!CultureInfo:class' - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - '@microsoft/sp-page-context!ISPTimeZoneData:interface' - - '@microsoft/sp-page-context!PageContext:class' - - '@microsoft/sp-page-context!SPDayOfWeek:enum' - - '@microsoft/sp-page-context!SPField:class' - - '@microsoft/sp-page-context!SPList:class' - - '@microsoft/sp-page-context!SPListItem:class' - - '@microsoft/sp-page-context!SPPermission:class' - - '@microsoft/sp-page-context!SPSite:class' - - '@microsoft/sp-page-context!SPTimeZone:class' - - '@microsoft/sp-page-context!SPUser:class' - - '@microsoft/sp-page-context!SPWeb:class' -references: - - uid: '@microsoft/sp-page-context!CultureInfo:class' - name: CultureInfo - - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' - name: ISPSystemTime - - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' - name: ISPTimeZoneData - - uid: '@microsoft/sp-page-context!PageContext:class' - name: PageContext - - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - name: SPDayOfWeek - - uid: '@microsoft/sp-page-context!SPField:class' - name: SPField - - uid: '@microsoft/sp-page-context!SPList:class' - name: SPList - - uid: '@microsoft/sp-page-context!SPListItem:class' - name: SPListItem - - uid: '@microsoft/sp-page-context!SPPermission:class' - name: SPPermission - - uid: '@microsoft/sp-page-context!SPSite:class' - name: SPSite - - uid: '@microsoft/sp-page-context!SPTimeZone:class' - name: SPTimeZone - - uid: '@microsoft/sp-page-context!SPUser:class' - name: SPUser - - uid: '@microsoft/sp-page-context!SPWeb:class' - name: SPWeb +### YamlMime:TSPacakge +uid: '@microsoft/sp-page-context!' +name: '@microsoft/sp-page-context' +type: package +summary: Page context services for the SharePoint Framework +classes: + - '@microsoft/sp-page-context!CultureInfo:class' + - '@microsoft/sp-page-context!PageContext:class' + - '@microsoft/sp-page-context!SPField:class' + - '@microsoft/sp-page-context!SPList:class' + - '@microsoft/sp-page-context!SPListItem:class' + - '@microsoft/sp-page-context!SPPermission:class' + - '@microsoft/sp-page-context!SPSite:class' + - '@microsoft/sp-page-context!SPTimeZone:class' + - '@microsoft/sp-page-context!SPUser:class' + - '@microsoft/sp-page-context!SPWeb:class' +interfaces: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - '@microsoft/sp-page-context!ISPTimeZoneData:interface' +enums: + - '@microsoft/sp-page-context!SPDayOfWeek:enum' diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 76ac90ca..2d553c98 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -1,69 +1,70 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!CultureInfo:class' - summary: >- - This class is primarily used with the `PageContext` class. It provides culture info for the current user of the - application. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `CultureInfo` class. - name: CultureInfo - fullName: CultureInfo - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' - - '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' - - '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' - - uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' - summary: >- - This string determines the language default format for dates, times, numbers, currency values, the sorting order - of text, casing conventions, and string comparisons. - remarks: >- - This property may be an empty string, but it will never be undefined. - - - Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the - date as 1/8 instead of 8/1. - name: currentCultureName - fullName: currentCultureName - langs: - - typeScript - type: property - syntax: - content: 'readonly currentCultureName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' - summary: This string determines the default user interface language. This used for localization and translation of text. - remarks: >- - This property may have an empty string, but will never be undefined. - - - Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to - translate the word "hello" to "hola". - name: currentUICultureName - fullName: currentUICultureName - langs: - - typeScript - type: property - syntax: - content: 'readonly currentUICultureName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' - summary: This boolean represents the dominant direction of written text for the default user interface language. - name: isRightToLeft - fullName: isRightToLeft - langs: - - typeScript - type: property - syntax: - content: 'readonly isRightToLeft: boolean;' - return: - type: - - boolean +### YamlMime:TSType +name: CultureInfo +uid: '@microsoft/sp-page-context!CultureInfo:class' +package: '@microsoft/sp-page-context!' +fullName: CultureInfo +summary: >- + This class is primarily used with the `PageContext` class. It provides culture + info for the current user of the application. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `CultureInfo` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: currentCultureName + uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' + package: '@microsoft/sp-page-context!' + fullName: currentCultureName + summary: >- + This string determines the language default format for dates, times, + numbers, currency values, the sorting order of text, casing conventions, + and string comparisons. + remarks: >- + This property may be an empty string, but it will never be undefined. + + + Example: If the currentCultureName is `"en-AU"` then the application could + use this information to display the date as 1/8 instead of 8/1. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly currentCultureName: string;' + return: + type: string + - name: currentUICultureName + uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' + package: '@microsoft/sp-page-context!' + fullName: currentUICultureName + summary: >- + This string determines the default user interface language. This used for + localization and translation of text. + remarks: >- + This property may have an empty string, but will never be undefined. + + + Example: If the currentUICultureName is `"es-MX"`, then the + application could use this information to translate the word "hello" to + "hola". + isPreview: false + isDeprecated: false + syntax: + content: 'readonly currentUICultureName: string;' + return: + type: string + - name: isRightToLeft + uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' + package: '@microsoft/sp-page-context!' + fullName: isRightToLeft + summary: >- + This boolean represents the dominant direction of written text for the + default user interface language. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isRightToLeft: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index c9d1d5da..2c5d8f3d 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -1,116 +1,107 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' - summary: Interface that represents a `SPSystemTime` structure. - isPreview: true - name: ISPSystemTime - fullName: ISPSystemTime - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ISPSystemTime +uid: '@microsoft/sp-page-context!ISPSystemTime:interface' +package: '@microsoft/sp-page-context!' +fullName: ISPSystemTime +summary: Interface that represents a `SPSystemTime` structure. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: Day + uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!ISPSystemTime#Day:member' - - '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' - - '@microsoft/sp-page-context!ISPSystemTime#Hour:member' - - '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' - - '@microsoft/sp-page-context!ISPSystemTime#Minute:member' - - '@microsoft/sp-page-context!ISPSystemTime#Month:member' - - '@microsoft/sp-page-context!ISPSystemTime#Second:member' - - '@microsoft/sp-page-context!ISPSystemTime#Year:member' - - uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' - isPreview: true - name: Day fullName: Day - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Day: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' - isPreview: true - name: DayOfWeek + type: number + - name: DayOfWeek + uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' + package: '@microsoft/sp-page-context!' fullName: DayOfWeek - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'DayOfWeek: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' - isPreview: true - name: Hour + type: number + - name: Hour + uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' + package: '@microsoft/sp-page-context!' fullName: Hour - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Hour: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' - isPreview: true - name: Milliseconds + type: number + - name: Milliseconds + uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' + package: '@microsoft/sp-page-context!' fullName: Milliseconds - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Milliseconds: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' - isPreview: true - name: Minute + type: number + - name: Minute + uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' + package: '@microsoft/sp-page-context!' fullName: Minute - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Minute: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' - isPreview: true - name: Month + type: number + - name: Month + uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' + package: '@microsoft/sp-page-context!' fullName: Month - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Month: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' - isPreview: true - name: Second + type: number + - name: Second + uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' + package: '@microsoft/sp-page-context!' fullName: Second - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Second: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' - isPreview: true - name: Year + type: number + - name: Year + uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' + package: '@microsoft/sp-page-context!' fullName: Year - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'Year: number;' return: - type: - - number + type: number diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 15bed4cb..64feba8b 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -1,106 +1,95 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' - summary: Interface that represents the data necessary to build an `TimeZone` object. - isPreview: true - name: ISPTimeZoneData - fullName: ISPTimeZoneData - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ISPTimeZoneData +uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' +package: '@microsoft/sp-page-context!' +fullName: ISPTimeZoneData +summary: Interface that represents the data necessary to build an `TimeZone` object. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: daylightDate + uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' - - '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' - - '@microsoft/sp-page-context!ISPTimeZoneData#description:member' - - '@microsoft/sp-page-context!ISPTimeZoneData#id:member' - - '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' - - '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' - - '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' - isPreview: true - name: daylightDate fullName: daylightDate - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'daylightDate: ISPSystemTime;' return: - type: - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' - isPreview: true - name: daylightOffset + type: '' + - name: daylightOffset + uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' + package: '@microsoft/sp-page-context!' fullName: daylightOffset - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'daylightOffset: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' - isPreview: true - name: description + type: number + - name: description + uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' + package: '@microsoft/sp-page-context!' fullName: description - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'description: string;' return: - type: - - string - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' - isPreview: true - name: id + type: string + - name: id + uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' + package: '@microsoft/sp-page-context!' fullName: id - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'id: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' - isPreview: true - name: offset + type: number + - name: offset + uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' + package: '@microsoft/sp-page-context!' fullName: offset - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'offset: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' - isPreview: true - name: standardDate + type: number + - name: standardDate + uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' + package: '@microsoft/sp-page-context!' fullName: standardDate - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'standardDate: ISPSystemTime;' return: - type: - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' - isPreview: true - name: standardOffset + type: '' + - name: standardOffset + uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' + package: '@microsoft/sp-page-context!' fullName: standardOffset - langs: - - typeScript - type: property + summary: '' + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'standardOffset: number;' return: - type: - - number -references: - - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' - name: ISPSystemTime + type: number diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 30872d08..31c9ca51 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -1,228 +1,190 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!PageContext:class' - summary: The SharePoint page context object. - remarks: >- - The page context provides standard definitions for common SharePoint objects that need to be shared between the - client-side application, web parts, and other components. Typically the data is fetched via REST queries when - navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application - cache. - name: PageContext - fullName: PageContext - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!PageContext:constructor(1)' - - '@microsoft/sp-page-context!PageContext#aadInfo:member' - - '@microsoft/sp-page-context!PageContext#cultureInfo:member' - - '@microsoft/sp-page-context!PageContext#isInitialized:member' - - '@microsoft/sp-page-context!PageContext#legacyPageContext:member' - - '@microsoft/sp-page-context!PageContext#list:member' - - '@microsoft/sp-page-context!PageContext#listItem:member' - - '@microsoft/sp-page-context!PageContext.serviceKey:member' - - '@microsoft/sp-page-context!PageContext#site:member' - - '@microsoft/sp-page-context!PageContext#user:member' - - '@microsoft/sp-page-context!PageContext#web:member' - - uid: '@microsoft/sp-page-context!PageContext:constructor(1)' - summary: Constructs a new instance of the `PageContext` class - name: (constructor)(serviceScope) - fullName: (constructor)(serviceScope) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: - - '@microsoft/sp-core-library!ServiceScope:class' - - uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' - summary: >- - Contextual information for communicating with Azure Active Directory. If the current page doesn't have an - associated Azure Active Directory tenant, this property will be undefined. - name: aadInfo - fullName: aadInfo - langs: - - typeScript - type: property - syntax: - content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' - return: - type: - - '@microsoft/sp-page-context!PageContext#aadInfo~0:complex' - - uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' - summary: >- - It provides culture info for the current user of the application. This class is primarily used with the - `PageContext` class. - name: cultureInfo - fullName: cultureInfo - langs: - - typeScript - type: property - syntax: - content: 'readonly cultureInfo: CultureInfo;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' - summary: Returns whether the `PageContext` has been initialized. - name: isInitialized - fullName: isInitialized - langs: - - typeScript - type: property - syntax: - content: 'readonly isInitialized: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' - summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. - remarks: >- - This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents - are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may - change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint - Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility - guarantees. - - - NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript - API, please file an issue on GitHub. The intention is that no modern application should need to rely on the - `legacyPageContext` object. - name: legacyPageContext - fullName: legacyPageContext - langs: - - typeScript - type: property - syntax: - content: 'readonly legacyPageContext: any;' - return: - type: - - any - - uid: '@microsoft/sp-page-context!PageContext#list:member' - summary: >- - Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the - current page, this property will be undefined. - name: list - fullName: list - langs: - - typeScript - type: property - syntax: - content: 'readonly list: SPList | undefined;' - return: - type: - - '@microsoft/sp-page-context!PageContext#list~0:complex' - - uid: '@microsoft/sp-page-context!PageContext#listItem:member' - summary: >- - Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated - to the current page, this property will be undefined. - name: listItem - fullName: listItem - langs: - - typeScript - type: property - syntax: - content: 'readonly listItem: SPListItem | undefined;' - return: - type: - - '@microsoft/sp-page-context!PageContext#listItem~0:complex' - - uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' - summary: The service key for PageContext. - name: serviceKey - fullName: serviceKey - langs: - - typeScript - type: property - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: - - '@microsoft/sp-page-context!PageContext.serviceKey~0:complex' - - uid: '@microsoft/sp-page-context!PageContext#site:member' - summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. - name: site - fullName: site - langs: - - typeScript - type: property - syntax: - content: 'readonly site: SPSite;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!PageContext#user:member' - summary: >- - It provides contextual information for the SharePoint user that is accessing the page. This class is primarily - used with the `PageContext` class. - name: user - fullName: user - langs: - - typeScript - type: property - syntax: - content: 'readonly user: SPUser;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!PageContext#web:member' - summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. - name: web - fullName: web - langs: - - typeScript - type: property - syntax: - content: 'readonly web: SPWeb;' - return: - type: - - '@microsoft/sp-page-context!default:class' -references: - - uid: '@microsoft/sp-core-library!ServiceScope:class' - name: ServiceScope - - uid: '@microsoft/sp-page-context!PageContext#aadInfo~0:complex' - name: AzureActiveDirectoryInfo | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: AzureActiveDirectoryInfo - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-page-context!default:class' - name: CultureInfo - - uid: '@microsoft/sp-page-context!PageContext#list~0:complex' - name: SPList | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: SPList - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-page-context!PageContext#listItem~0:complex' - name: SPListItem | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: SPListItem - fullName: default - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-page-context!PageContext.serviceKey~0:complex' - name: ServiceKey - fullName: ServiceKey - spec.typeScript: - - uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceKey - fullName: ServiceKey - - name: < - fullName: < - - uid: '@microsoft/sp-page-context!default:class' - name: PageContext - fullName: default - - name: '>' - fullName: '>' +### YamlMime:TSType +name: PageContext +uid: '@microsoft/sp-page-context!PageContext:class' +package: '@microsoft/sp-page-context!' +fullName: PageContext +summary: The SharePoint page context object. +remarks: >- + The page context provides standard definitions for common SharePoint objects + that need to be shared between the client-side application, web parts, and + other components. Typically the data is fetched via REST queries when + navigating to a new page, but it can also be preloaded by the web server, or + filled from a custom application cache. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-page-context!PageContext:constructor(1)' + package: '@microsoft/sp-page-context!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `PageContext` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: aadInfo + uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' + package: '@microsoft/sp-page-context!' + fullName: aadInfo + summary: >- + Contextual information for communicating with Azure Active Directory. If + the current page doesn't have an associated Azure Active Directory tenant, + this property will be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' + return: + type: >- + @microsoft/sp-page-context!PageContext# + - name: cultureInfo + uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' + package: '@microsoft/sp-page-context!' + fullName: cultureInfo + summary: >- + It provides culture info for the current user of the application. This + class is primarily used with the `PageContext` class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cultureInfo: CultureInfo;' + return: + type: '' + - name: isInitialized + uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' + package: '@microsoft/sp-page-context!' + fullName: isInitialized + summary: Returns whether the `PageContext` has been initialized. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isInitialized: boolean;' + return: + type: boolean + - name: legacyPageContext + uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' + package: '@microsoft/sp-page-context!' + fullName: legacyPageContext + summary: >- + An object providing classic SharePoint properties that may be required by + certain legacy scripts. + remarks: >- + This property is provided to facilitate migration of legacy code. It + returns a JavaScript object whose contents are similar to the + `_spPageContextInfo` window variable from classic pages. The contents of + this variable may change in future releases of SharePoint. For this + reason, new projects are encouraged to use the SharePoint Framework + TypeScript APIs instead, since they are fully documented and provide + reliable backwards compatibility guarantees. + + + NOTE: If certain functionality is exposed in the `legacyPageContext` but + does not seem to have a proper TypeScript API, please file an issue on + GitHub. The intention is that no modern application should need to rely on + the `legacyPageContext` object. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly legacyPageContext: any;' + return: + type: any + - name: list + uid: '@microsoft/sp-page-context!PageContext#list:member' + package: '@microsoft/sp-page-context!' + fullName: list + summary: >- + Contextual information for the SharePoint list that is hosting the page. + If there is no list associated to the current page, this property will be + undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly list: SPList | undefined;' + return: + type: '@microsoft/sp-page-context!PageContext#' + - name: listItem + uid: '@microsoft/sp-page-context!PageContext#listItem:member' + package: '@microsoft/sp-page-context!' + fullName: listItem + summary: >- + Contextual information for the SharePoint list item that is hosting the + page. If there is no list item associated to the current page, this + property will be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly listItem: SPListItem | undefined;' + return: + type: >- + @microsoft/sp-page-context!PageContext# + - name: serviceKey + uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' + package: '@microsoft/sp-page-context!' + fullName: serviceKey + summary: The service key for PageContext. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + @microsoft/sp-page-context!PageContext. + - name: site + uid: '@microsoft/sp-page-context!PageContext#site:member' + package: '@microsoft/sp-page-context!' + fullName: site + summary: >- + Contextual information for the SharePoint site collection ("SPSite") that + is hosting the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly site: SPSite;' + return: + type: '' + - name: user + uid: '@microsoft/sp-page-context!PageContext#user:member' + package: '@microsoft/sp-page-context!' + fullName: user + summary: >- + It provides contextual information for the SharePoint user that is + accessing the page. This class is primarily used with the `PageContext` + class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly user: SPUser;' + return: + type: '' + - name: web + uid: '@microsoft/sp-page-context!PageContext#web:member' + package: '@microsoft/sp-page-context!' + fullName: web + summary: >- + Contextual information for the SharePoint site ("SPWeb") that is hosting + the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly web: SPWeb;' + return: + type: '' diff --git a/SP-Framework/sp-page-context/spdayofweek.yml b/SP-Framework/sp-page-context/spdayofweek.yml index 5b9fddfb..141ff7f1 100644 --- a/SP-Framework/sp-page-context/spdayofweek.yml +++ b/SP-Framework/sp-page-context/spdayofweek.yml @@ -1,75 +1,45 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - summary: The enum members represent the seven days of a week. - isPreview: true - name: SPDayOfWeek - fullName: SPDayOfWeek - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: SPDayOfWeek +uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' +package: '@microsoft/sp-page-context!' +fullName: SPDayOfWeek +summary: The enum members represent the seven days of a week. +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: Friday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Friday:member' package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPDayOfWeek.Friday:member' - - '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' - - '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' - - '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' - - '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' - - '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' - - '@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Friday:member' - isPreview: true - name: Friday - fullName: Friday - langs: - - typeScript - type: field + summary: '' numericValue: '5' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' - isPreview: true - name: Monday - fullName: Monday - langs: - - typeScript - type: field + - name: Monday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' + package: '@microsoft/sp-page-context!' + summary: '' numericValue: '1' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' - isPreview: true - name: Saturday - fullName: Saturday - langs: - - typeScript - type: field + - name: Saturday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' + package: '@microsoft/sp-page-context!' + summary: '' numericValue: '6' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' - isPreview: true - name: Sunday - fullName: Sunday - langs: - - typeScript - type: field + - name: Sunday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' + package: '@microsoft/sp-page-context!' + summary: '' numericValue: '0' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' - isPreview: true - name: Thursday - fullName: Thursday - langs: - - typeScript - type: field + - name: Thursday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' + package: '@microsoft/sp-page-context!' + summary: '' numericValue: '4' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' - isPreview: true - name: Tuesday - fullName: Tuesday - langs: - - typeScript - type: field + - name: Tuesday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' + package: '@microsoft/sp-page-context!' + summary: '' numericValue: '2' - - uid: '@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member' - isPreview: true - name: Wednesday - fullName: Wednesday - langs: - - typeScript - type: field + - name: Wednesday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member' + package: '@microsoft/sp-page-context!' + summary: '' numericValue: '3' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 2bfb06ba..fab135f0 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -1,124 +1,113 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPField:class' - summary: A field represents the data model for a column in SharePoint list view. - remarks: >- - This is the client-side equivalent for SharePoint `SPField` class. It is used with the - `@microsoft/sp-listview-extensibility` package. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPField` class. - name: SPField - fullName: SPField - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPField#clientSideComponentId:member' - - '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' - - '@microsoft/sp-page-context!SPField#displayName:member' - - '@microsoft/sp-page-context!SPField#fieldType:member' - - '@microsoft/sp-page-context!SPField#id:member' - - '@microsoft/sp-page-context!SPField#internalName:member' - - '@microsoft/sp-page-context!SPField#isRequired:member' - - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' - summary: The unique identifier of the client-side component associated with the field. - name: clientSideComponentId - fullName: clientSideComponentId - langs: - - typeScript - type: property - syntax: - content: 'readonly clientSideComponentId: Guid | undefined;' - return: - type: - - '@microsoft/sp-page-context!SPField#clientSideComponentId~0:complex' - - uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' - summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. - remarks: >- - If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning - are defined by the client-side component. - name: clientSideComponentProperties - fullName: clientSideComponentProperties - langs: - - typeScript - type: property - syntax: - content: 'readonly clientSideComponentProperties: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPField#displayName:member' - summary: The display name of the field. This name is shown as column name in UI. - name: displayName - fullName: displayName - langs: - - typeScript - type: property - syntax: - content: 'readonly displayName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPField#fieldType:member' - summary: The type of the field represented as a string - name: fieldType - fullName: fieldType - langs: - - typeScript - type: property - syntax: - content: 'readonly fieldType: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPField#id:member' - summary: The GUID identifier for this field. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'readonly id: Guid;' - return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-page-context!SPField#internalName:member' - summary: The internal name of the field. This name is usually used to find the field. - name: internalName - fullName: internalName - langs: - - typeScript - type: property - syntax: - content: 'readonly internalName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPField#isRequired:member' - summary: Whether the field is required for each list item in the list - name: isRequired - fullName: isRequired - langs: - - typeScript - type: property - syntax: - content: 'readonly isRequired: boolean;' - return: - type: - - boolean -references: - - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId~0:complex' - name: Guid | undefined - fullName: Guid | undefined - spec.typeScript: - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid - fullName: Guid - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid +### YamlMime:TSType +name: SPField +uid: '@microsoft/sp-page-context!SPField:class' +package: '@microsoft/sp-page-context!' +fullName: SPField +summary: A field represents the data model for a column in SharePoint list view. +remarks: >- + This is the client-side equivalent for SharePoint `SPField` class. It is used + with the `@microsoft/sp-listview-extensibility` package. + + + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPField` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: clientSideComponentId + uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' + package: '@microsoft/sp-page-context!' + fullName: clientSideComponentId + summary: >- + The unique identifier of the client-side component associated with the + field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly clientSideComponentId: Guid | undefined;' + return: + type: >- + @microsoft/sp-page-context!SPField# + - name: clientSideComponentProperties + uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' + package: '@microsoft/sp-page-context!' + fullName: clientSideComponentProperties + summary: >- + This property is only used when a `ClientSideComponentId` is specified. It + is optional. + remarks: >- + If non-empty, the string must contain a JSON object with custom + initialization properties whose format and meaning are defined by the + client-side component. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly clientSideComponentProperties: string;' + return: + type: string + - name: displayName + uid: '@microsoft/sp-page-context!SPField#displayName:member' + package: '@microsoft/sp-page-context!' + fullName: displayName + summary: The display name of the field. This name is shown as column name in UI. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly displayName: string;' + return: + type: string + - name: fieldType + uid: '@microsoft/sp-page-context!SPField#fieldType:member' + package: '@microsoft/sp-page-context!' + fullName: fieldType + summary: The type of the field represented as a string + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fieldType: string;' + return: + type: string + - name: id + uid: '@microsoft/sp-page-context!SPField#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The GUID identifier for this field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: internalName + uid: '@microsoft/sp-page-context!SPField#internalName:member' + package: '@microsoft/sp-page-context!' + fullName: internalName + summary: >- + The internal name of the field. This name is usually used to find the + field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly internalName: string;' + return: + type: string + - name: isRequired + uid: '@microsoft/sp-page-context!SPField#isRequired:member' + package: '@microsoft/sp-page-context!' + fullName: isRequired + summary: Whether the field is required for each list item in the list + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isRequired: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 7902dcfc..2d8928fa 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -1,78 +1,68 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPList:class' - summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint - list that hosts the page. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPList` class. - name: SPList - fullName: SPList - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPList#id:member' - - '@microsoft/sp-page-context!SPList#permissions:member' - - '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' - - '@microsoft/sp-page-context!SPList#title:member' - - uid: '@microsoft/sp-page-context!SPList#id:member' - summary: >- - The GUID that identifies the SPList on the server. This property could be undefined if the information isn't - available. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'readonly id: Guid;' - return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-page-context!SPList#permissions:member' - summary: >- - Return the SPPermission object that represents the set of permissions that the current user has for interacting - with the list. - name: permissions - fullName: permissions - langs: - - typeScript - type: property - syntax: - content: 'readonly permissions: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' - summary: Returns the server-relative URL for this `SPList`. - remarks: 'Example: "/sites/PubSite"' - name: serverRelativeUrl - fullName: serverRelativeUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly serverRelativeUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPList#title:member' - summary: Returns the title for this `SPList`. - name: title - fullName: title - langs: - - typeScript - type: property - syntax: - content: 'readonly title: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid - - uid: '@microsoft/sp-page-context!default:class' - name: SPPermission +### YamlMime:TSType +name: SPList +uid: '@microsoft/sp-page-context!SPList:class' +package: '@microsoft/sp-page-context!' +fullName: SPList +summary: >- + This class is primarily used with the `PageContext` class. It provides + contextual information for the SharePoint list that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPList` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: id + uid: '@microsoft/sp-page-context!SPList#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: >- + The GUID that identifies the SPList on the server. This property could be + undefined if the information isn't available. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: permissions + uid: '@microsoft/sp-page-context!SPList#permissions:member' + package: '@microsoft/sp-page-context!' + fullName: permissions + summary: >- + Return the SPPermission object that represents the set of permissions that + the current user has for interacting with the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly permissions: SPPermission;' + return: + type: '' + - name: serverRelativeUrl + uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' + package: '@microsoft/sp-page-context!' + fullName: serverRelativeUrl + summary: Returns the server-relative URL for this `SPList`<!-- -->. + remarks: 'Example: "/sites/PubSite"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-page-context!SPList#title:member' + package: '@microsoft/sp-page-context!' + fullName: title + summary: Returns the title for this `SPList`<!-- -->. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly title: string;' + return: + type: string diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index dd81f8eb..58c494b0 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -1,29 +1,28 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPListItem:class' - summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint - list item that hosts the page. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPListItem` class. - name: SPListItem - fullName: SPListItem - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPListItem#id:member' - - uid: '@microsoft/sp-page-context!SPListItem#id:member' - summary: The number that identifies the `SPListItem` on the server. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'readonly id: number;' - return: - type: - - number +### YamlMime:TSType +name: SPListItem +uid: '@microsoft/sp-page-context!SPListItem:class' +package: '@microsoft/sp-page-context!' +fullName: SPListItem +summary: >- + This class is primarily used with the `PageContext` class. It provides + contextual information for the SharePoint list item that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPListItem` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: id + uid: '@microsoft/sp-page-context!SPListItem#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The number that identifies the `SPListItem` on the server. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: number;' + return: + type: number diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 5309e300..581732e0 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -1,603 +1,589 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPPermission:class' - summary: Used to test whether the current user has a requested set of permissions. - remarks: >- - Specifies the built-in permissions available in SharePoint Foundation - - - For more information, see: - [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) - name: SPPermission - fullName: SPPermission - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPPermission:constructor(1)' - - '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' - - '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' - - '@microsoft/sp-page-context!SPPermission.addListItems:member' - - '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' - - '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' - - '@microsoft/sp-page-context!SPPermission.approveItems:member' - - '@microsoft/sp-page-context!SPPermission.browseDirectories:member' - - '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' - - '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' - - '@microsoft/sp-page-context!SPPermission.createAlerts:member' - - '@microsoft/sp-page-context!SPPermission.createGroups:member' - - '@microsoft/sp-page-context!SPPermission.createSSCSite:member' - - '@microsoft/sp-page-context!SPPermission.deleteListItems:member' - - '@microsoft/sp-page-context!SPPermission.deleteVersions:member' - - '@microsoft/sp-page-context!SPPermission.editListItems:member' - - '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' - - '@microsoft/sp-page-context!SPPermission.emptyMask:member' - - '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' - - '@microsoft/sp-page-context!SPPermission.fullMask:member' - - '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' - - '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' - - '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' - - '@microsoft/sp-page-context!SPPermission.layoutsPage:member' - - '@microsoft/sp-page-context!SPPermission.manageAlerts:member' - - '@microsoft/sp-page-context!SPPermission.manageLists:member' - - '@microsoft/sp-page-context!SPPermission.managePermissions:member' - - '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' - - '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' - - '@microsoft/sp-page-context!SPPermission.manageWeb:member' - - '@microsoft/sp-page-context!SPPermission.open:member' - - '@microsoft/sp-page-context!SPPermission.openItems:member' - - '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' - - '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' - - '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' - - '@microsoft/sp-page-context!SPPermission#value:member' - - '@microsoft/sp-page-context!SPPermission.viewFormPages:member' - - '@microsoft/sp-page-context!SPPermission.viewListItems:member' - - '@microsoft/sp-page-context!SPPermission.viewPages:member' - - '@microsoft/sp-page-context!SPPermission.viewUsageData:member' - - '@microsoft/sp-page-context!SPPermission.viewVersions:member' - - uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' - summary: Constructs a new instance of the `SPPermission` class - name: (constructor)(value) - fullName: (constructor)(value) - langs: - - typeScript - type: constructor - syntax: - content: 'constructor(value: IODataBasePermission);' - parameters: - - id: value - description: '' - type: - - '@microsoft/sp-odata-types!IODataBasePermission:interface' - - uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' - summary: >- - Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint - Foundation–compatible editor. - name: addAndCustomizePages - fullName: addAndCustomizePages - langs: - - typeScript - type: property - syntax: - content: 'static readonly addAndCustomizePages: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' - summary: Add or remove personal web parts on a web part Page. - name: addDelPrivateWebParts - fullName: addDelPrivateWebParts - langs: - - typeScript - type: property - syntax: - content: 'static readonly addDelPrivateWebParts: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' - summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' - name: addListItems - fullName: addListItems - langs: - - typeScript - type: property - syntax: - content: 'static readonly addListItems: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' - summary: Apply a style sheet (.css file) to the Web site. - name: applyStyleSheets - fullName: applyStyleSheets - langs: - - typeScript - type: property - syntax: - content: 'static readonly applyStyleSheets: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' - summary: Apply a theme or borders to the entire Web site. - name: applyThemeAndBorder - fullName: applyThemeAndBorder - langs: - - typeScript - type: property - syntax: - content: 'static readonly applyThemeAndBorder: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' - summary: Approve a minor version of a list item or document. - name: approveItems - fullName: approveItems - langs: - - typeScript - type: property - syntax: - content: 'static readonly approveItems: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' - summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. - name: browseDirectories - fullName: browseDirectories - langs: - - typeScript - type: property - syntax: - content: 'static readonly browseDirectories: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' - summary: View information about users of the Web site. - name: browserUserInfo - fullName: browserUserInfo - langs: - - typeScript - type: property - syntax: - content: 'static readonly browserUserInfo: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' - summary: Discard or check in a document which is checked out to another user. - name: cancelCheckout - fullName: cancelCheckout - langs: - - typeScript - type: property - syntax: - content: 'static readonly cancelCheckout: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' - summary: Create e-mail alerts. - name: createAlerts - fullName: createAlerts - langs: - - typeScript - type: property - syntax: - content: 'static readonly createAlerts: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' - summary: Create a group of users that can be used anywhere within the site collection. - name: createGroups - fullName: createGroups - langs: - - typeScript - type: property - syntax: - content: 'static readonly createGroups: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' - summary: Create a Web site using Self-Service Site Creation. - name: createSSCSite - fullName: createSSCSite - langs: - - typeScript - type: property - syntax: - content: 'static readonly createSSCSite: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' - summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' - name: deleteListItems - fullName: deleteListItems - langs: - - typeScript - type: property - syntax: - content: 'static readonly deleteListItems: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' - summary: Delete past versions of a list item or document. - name: deleteVersions - fullName: deleteVersions - langs: - - typeScript - type: property - syntax: - content: 'static readonly deleteVersions: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' - summary: >- - Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and - customize web part Pages in document libraries. - name: editListItems - fullName: editListItems - langs: - - typeScript - type: property - syntax: - content: 'static readonly editListItems: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' - summary: 'Allows a user to change his or her user information, such as adding a picture.' - name: editMyUserInfo - fullName: editMyUserInfo - langs: - - typeScript - type: property - syntax: - content: 'static readonly editMyUserInfo: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' - summary: Has no permissions on the Web site. Not available through the user interface. - name: emptyMask - fullName: emptyMask - langs: - - typeScript - type: property - syntax: - content: 'static readonly emptyMask: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' - summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' - name: enumeratePermissions - fullName: enumeratePermissions - langs: - - typeScript - type: property - syntax: - content: 'static readonly enumeratePermissions: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' - summary: Has all permissions on the Web site. Not available through the user interface. - name: fullMask - fullName: fullMask - langs: - - typeScript - type: property - syntax: - content: 'static readonly fullMask: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' - summary: Function for testing whether a given permission mask has all of the requested permissions. - name: hasAllPermissions(requestedPerms) - fullName: hasAllPermissions(requestedPerms) - langs: - - typeScript - type: method - syntax: - content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' - return: - type: - - boolean - description: '' - parameters: - - id: requestedPerms - description: Any number of SPPermission objects to be compared against the original - type: - - '@microsoft/sp-page-context!SPPermission#hasAllPermissions~0:complex' - - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' - summary: Function for testing whether a given permission mask has any of the requested permissions. - name: hasAnyPermissions(requestedPerms) - fullName: hasAnyPermissions(requestedPerms) - langs: - - typeScript - type: method - syntax: - content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' - return: - type: - - boolean - description: '' - parameters: - - id: requestedPerms - description: Any number of SPPermission objects to be compared against the original - type: - - '@microsoft/sp-page-context!SPPermission#hasAnyPermissions~0:complex' - - uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' - summary: Function for testing whether a given permission mask has the requested permission. - name: hasPermission(requestedPerm) - fullName: hasPermission(requestedPerm) - langs: - - typeScript - type: method - syntax: - content: 'hasPermission(requestedPerm: SPPermission): boolean;' - return: - type: - - boolean - description: '' - parameters: - - id: requestedPerm - description: The SPPermission object to be compared against the original - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' - summary: View the layouts page? - name: layoutsPage - fullName: layoutsPage - langs: - - typeScript - type: property - syntax: - content: 'static readonly layoutsPage: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' - summary: Manage alerts for all users of the Web site. - name: manageAlerts - fullName: manageAlerts - langs: - - typeScript - type: property - syntax: - content: 'static readonly manageAlerts: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' - summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' - name: manageLists - fullName: manageLists - langs: - - typeScript - type: property - syntax: - content: 'static readonly manageLists: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' - summary: Create and change permission levels on the Web site and assign permissions to users and groups. - name: managePermissions - fullName: managePermissions - langs: - - typeScript - type: property - syntax: - content: 'static readonly managePermissions: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' - summary: 'Create, change, and delete personal views of lists.' - name: managePersonalViews - fullName: managePersonalViews - langs: - - typeScript - type: property - syntax: - content: 'static readonly managePersonalViews: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' - summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' - name: manageSubwebs - fullName: manageSubwebs - langs: - - typeScript - type: property - syntax: - content: 'static readonly manageSubwebs: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' - summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. - remarks: >- - Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user - interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties - of site collection scoped Features through the object model. To browse to the Site Collection Features page and - activate or deactivate site collection scoped Features through the UI, you must be a site collection - administrator. - name: manageWeb - fullName: manageWeb - langs: - - typeScript - type: property - syntax: - content: 'static readonly manageWeb: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.open:member' - summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' - name: open - fullName: open - langs: - - typeScript - type: property - syntax: - content: 'static readonly open: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.openItems:member' - summary: View the source of documents with server-side file handlers. - name: openItems - fullName: openItems - langs: - - typeScript - type: property - syntax: - content: 'static readonly openItems: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' - summary: Update web parts to display personalized information. - name: updatePersonalWebParts - fullName: updatePersonalWebParts - langs: - - typeScript - type: property - syntax: - content: 'static readonly updatePersonalWebParts: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' - summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' - name: useClientIntegration - fullName: useClientIntegration - langs: - - typeScript - type: property - syntax: - content: 'static readonly useClientIntegration: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' - summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' - name: useRemoteAPIs - fullName: useRemoteAPIs - langs: - - typeScript - type: property - syntax: - content: 'static readonly useRemoteAPIs: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission#value:member' - summary: Returns the value of this SPPermission object - name: value - fullName: value - langs: - - typeScript - type: property - syntax: - content: 'readonly value: IODataBasePermission;' - return: - type: - - '@microsoft/sp-odata-types!IODataBasePermission:interface' - - uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' - summary: 'View forms, views, and application pages, and enumerate lists.' - name: viewFormPages - fullName: viewFormPages - langs: - - typeScript - type: property - syntax: - content: 'static readonly viewFormPages: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' - summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' - name: viewListItems - fullName: viewListItems - langs: - - typeScript - type: property - syntax: - content: 'static readonly viewListItems: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' - summary: View pages in a Web site. - name: viewPages - fullName: viewPages - langs: - - typeScript - type: property - syntax: - content: 'static readonly viewPages: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' - summary: View reports on Web site usage. - name: viewUsageData - fullName: viewUsageData - langs: - - typeScript - type: property - syntax: - content: 'static readonly viewUsageData: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' - summary: View past versions of a list item or document. - name: viewVersions - fullName: viewVersions - langs: - - typeScript - type: property - syntax: - content: 'static readonly viewVersions: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' -references: - - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - name: IODataBasePermission - - uid: '@microsoft/sp-page-context!default:class' - name: SPPermission - - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions~0:complex' - name: 'SPPermission[]' - fullName: 'default[]' - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: SPPermission - fullName: default - - name: '[]' - fullName: '[]' - - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions~0:complex' - name: 'SPPermission[]' - fullName: 'default[]' - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: SPPermission - fullName: default - - name: '[]' - fullName: '[]' +### YamlMime:TSType +name: SPPermission +uid: '@microsoft/sp-page-context!SPPermission:class' +package: '@microsoft/sp-page-context!' +fullName: SPPermission +summary: Used to test whether the current user has a requested set of permissions. +remarks: >- + Specifies the built-in permissions available in SharePoint Foundation + + + For more information, see: + [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(value) + uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' + package: '@microsoft/sp-page-context!' + fullName: (constructor)(value) + summary: Constructs a new instance of the `SPPermission` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(value: IODataBasePermission);' + parameters: + - id: value + description: '' + type: >- + +properties: + - name: addAndCustomizePages + uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' + package: '@microsoft/sp-page-context!' + fullName: addAndCustomizePages + summary: >- + Add, change, or delete HTML pages or web part Pages, and edit the Web site + using a SharePoint Foundation–compatible editor. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly addAndCustomizePages: SPPermission;' + return: + type: '' + - name: addDelPrivateWebParts + uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' + package: '@microsoft/sp-page-context!' + fullName: addDelPrivateWebParts + summary: Add or remove personal web parts on a web part Page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly addDelPrivateWebParts: SPPermission;' + return: + type: '' + - name: addListItems + uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' + package: '@microsoft/sp-page-context!' + fullName: addListItems + summary: >- + Add items to lists, add documents to document libraries, and add Web + discussion comments. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly addListItems: SPPermission;' + return: + type: '' + - name: applyStyleSheets + uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' + package: '@microsoft/sp-page-context!' + fullName: applyStyleSheets + summary: Apply a style sheet (.css file) to the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly applyStyleSheets: SPPermission;' + return: + type: '' + - name: applyThemeAndBorder + uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' + package: '@microsoft/sp-page-context!' + fullName: applyThemeAndBorder + summary: Apply a theme or borders to the entire Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly applyThemeAndBorder: SPPermission;' + return: + type: '' + - name: approveItems + uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' + package: '@microsoft/sp-page-context!' + fullName: approveItems + summary: Approve a minor version of a list item or document. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly approveItems: SPPermission;' + return: + type: '' + - name: browseDirectories + uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' + package: '@microsoft/sp-page-context!' + fullName: browseDirectories + summary: >- + Enumerate files and folders in a Web site using Microsoft Office + SharePoint Designer 2007 and WebDAV interfaces. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly browseDirectories: SPPermission;' + return: + type: '' + - name: browserUserInfo + uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' + package: '@microsoft/sp-page-context!' + fullName: browserUserInfo + summary: View information about users of the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly browserUserInfo: SPPermission;' + return: + type: '' + - name: cancelCheckout + uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' + package: '@microsoft/sp-page-context!' + fullName: cancelCheckout + summary: Discard or check in a document which is checked out to another user. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly cancelCheckout: SPPermission;' + return: + type: '' + - name: createAlerts + uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' + package: '@microsoft/sp-page-context!' + fullName: createAlerts + summary: Create e-mail alerts. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly createAlerts: SPPermission;' + return: + type: '' + - name: createGroups + uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' + package: '@microsoft/sp-page-context!' + fullName: createGroups + summary: >- + Create a group of users that can be used anywhere within the site + collection. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly createGroups: SPPermission;' + return: + type: '' + - name: createSSCSite + uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' + package: '@microsoft/sp-page-context!' + fullName: createSSCSite + summary: Create a Web site using Self-Service Site Creation. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly createSSCSite: SPPermission;' + return: + type: '' + - name: deleteListItems + uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' + package: '@microsoft/sp-page-context!' + fullName: deleteListItems + summary: >- + Delete items from a list, documents from a document library, and Web + discussion comments in documents. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly deleteListItems: SPPermission;' + return: + type: '' + - name: deleteVersions + uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' + package: '@microsoft/sp-page-context!' + fullName: deleteVersions + summary: Delete past versions of a list item or document. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly deleteVersions: SPPermission;' + return: + type: '' + - name: editListItems + uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' + package: '@microsoft/sp-page-context!' + fullName: editListItems + summary: >- + Edit items in lists, edit documents in document libraries, edit Web + discussion comments in documents, and customize web part Pages in document + libraries. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly editListItems: SPPermission;' + return: + type: '' + - name: editMyUserInfo + uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' + package: '@microsoft/sp-page-context!' + fullName: editMyUserInfo + summary: >- + Allows a user to change his or her user information, such as adding a + picture. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly editMyUserInfo: SPPermission;' + return: + type: '' + - name: emptyMask + uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' + package: '@microsoft/sp-page-context!' + fullName: emptyMask + summary: >- + Has no permissions on the Web site. Not available through the user + interface. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly emptyMask: SPPermission;' + return: + type: '' + - name: enumeratePermissions + uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' + package: '@microsoft/sp-page-context!' + fullName: enumeratePermissions + summary: >- + Enumerate permissions on the Web site, list, folder, document, or list + item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly enumeratePermissions: SPPermission;' + return: + type: '' + - name: fullMask + uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' + package: '@microsoft/sp-page-context!' + fullName: fullMask + summary: >- + Has all permissions on the Web site. Not available through the user + interface. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly fullMask: SPPermission;' + return: + type: '' + - name: layoutsPage + uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' + package: '@microsoft/sp-page-context!' + fullName: layoutsPage + summary: View the layouts page? + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly layoutsPage: SPPermission;' + return: + type: '' + - name: manageAlerts + uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' + package: '@microsoft/sp-page-context!' + fullName: manageAlerts + summary: Manage alerts for all users of the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageAlerts: SPPermission;' + return: + type: '' + - name: manageLists + uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' + package: '@microsoft/sp-page-context!' + fullName: manageLists + summary: >- + Create and delete lists, add or remove columns in a list, and add or + remove public views of a list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageLists: SPPermission;' + return: + type: '' + - name: managePermissions + uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' + package: '@microsoft/sp-page-context!' + fullName: managePermissions + summary: >- + Create and change permission levels on the Web site and assign permissions + to users and groups. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly managePermissions: SPPermission;' + return: + type: '' + - name: managePersonalViews + uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' + package: '@microsoft/sp-page-context!' + fullName: managePersonalViews + summary: 'Create, change, and delete personal views of lists.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly managePersonalViews: SPPermission;' + return: + type: '' + - name: manageSubwebs + uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' + package: '@microsoft/sp-page-context!' + fullName: manageSubwebs + summary: >- + Create subsites such as team sites, Meeting Workspace sites, and Document + Workspace sites. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageSubwebs: SPPermission;' + return: + type: '' + - name: manageWeb + uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' + package: '@microsoft/sp-page-context!' + fullName: manageWeb + summary: >- + Grant the ability to perform all administration tasks for the Web site as + well as manage content. + remarks: >- + Activate, deactivate, or edit properties of Web site scoped Features + through the object model or through the user interface (UI). When granted + on the root Web site of a site collection, activate, deactivate, or edit + properties of site collection scoped Features through the object model. To + browse to the Site Collection Features page and activate or deactivate + site collection scoped Features through the UI, you must be a site + collection administrator. + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageWeb: SPPermission;' + return: + type: '' + - name: open + uid: '@microsoft/sp-page-context!SPPermission.open:member' + package: '@microsoft/sp-page-context!' + fullName: open + summary: >- + Allow users to open a Web site, list, or folder to access items inside + that container. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly open: SPPermission;' + return: + type: '' + - name: openItems + uid: '@microsoft/sp-page-context!SPPermission.openItems:member' + package: '@microsoft/sp-page-context!' + fullName: openItems + summary: View the source of documents with server-side file handlers. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly openItems: SPPermission;' + return: + type: '' + - name: updatePersonalWebParts + uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' + package: '@microsoft/sp-page-context!' + fullName: updatePersonalWebParts + summary: Update web parts to display personalized information. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly updatePersonalWebParts: SPPermission;' + return: + type: '' + - name: useClientIntegration + uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' + package: '@microsoft/sp-page-context!' + fullName: useClientIntegration + summary: >- + Use features that launch client applications; otherwise, users must work + on documents locally and upload changes. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly useClientIntegration: SPPermission;' + return: + type: '' + - name: useRemoteAPIs + uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' + package: '@microsoft/sp-page-context!' + fullName: useRemoteAPIs + summary: >- + Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces + to access the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly useRemoteAPIs: SPPermission;' + return: + type: '' + - name: value + uid: '@microsoft/sp-page-context!SPPermission#value:member' + package: '@microsoft/sp-page-context!' + fullName: value + summary: Returns the value of this SPPermission object + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly value: IODataBasePermission;' + return: + type: >- + + - name: viewFormPages + uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' + package: '@microsoft/sp-page-context!' + fullName: viewFormPages + summary: 'View forms, views, and application pages, and enumerate lists.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewFormPages: SPPermission;' + return: + type: '' + - name: viewListItems + uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' + package: '@microsoft/sp-page-context!' + fullName: viewListItems + summary: >- + View items in lists, documents in document libraries, and view Web + discussion comments. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewListItems: SPPermission;' + return: + type: '' + - name: viewPages + uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' + package: '@microsoft/sp-page-context!' + fullName: viewPages + summary: View pages in a Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewPages: SPPermission;' + return: + type: '' + - name: viewUsageData + uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' + package: '@microsoft/sp-page-context!' + fullName: viewUsageData + summary: View reports on Web site usage. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewUsageData: SPPermission;' + return: + type: '' + - name: viewVersions + uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' + package: '@microsoft/sp-page-context!' + fullName: viewVersions + summary: View past versions of a list item or document. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewVersions: SPPermission;' + return: + type: '' +methods: + - name: hasAllPermissions(requestedPerms) + uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' + package: '@microsoft/sp-page-context!' + fullName: hasAllPermissions(requestedPerms) + summary: >- + Function for testing whether a given permission mask has all of the + requested permissions. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' + parameters: + - id: requestedPerms + description: >- + Any number of SPPermission objects to be compared against the + original + type: >- + @microsoft/sp-page-context!SPPermission# + return: + type: boolean + description: '' + - name: hasAnyPermissions(requestedPerms) + uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' + package: '@microsoft/sp-page-context!' + fullName: hasAnyPermissions(requestedPerms) + summary: >- + Function for testing whether a given permission mask has any of the + requested permissions. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' + parameters: + - id: requestedPerms + description: >- + Any number of SPPermission objects to be compared against the + original + type: >- + @microsoft/sp-page-context!SPPermission# + return: + type: boolean + description: '' + - name: hasPermission(requestedPerm) + uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' + package: '@microsoft/sp-page-context!' + fullName: hasPermission(requestedPerm) + summary: >- + Function for testing whether a given permission mask has the requested + permission. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasPermission(requestedPerm: SPPermission): boolean;' + parameters: + - id: requestedPerm + description: The SPPermission object to be compared against the original + type: '' + return: + type: boolean + description: '' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index d59fabc0..af97bb5e 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -1,176 +1,154 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPSite:class' - summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint - site collection ("SPSite") that hosts the page. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPSite` class. - name: SPSite - fullName: SPSite - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPSite#absoluteUrl:member' - - '@microsoft/sp-page-context!SPSite#cdnPrefix:member' - - '@microsoft/sp-page-context!SPSite#classification:member' - - '@microsoft/sp-page-context!SPSite#correlationId:member' - - '@microsoft/sp-page-context!SPSite#group:member' - - '@microsoft/sp-page-context!SPSite#id:member' - - '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' - - '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' - - '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' - - '@microsoft/sp-page-context!SPSite#serverRequestPath:member' - - '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' - - uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' - summary: Returns the absolute URL for this SPSite. - remarks: 'Example: "https://example.com/sites/PubSite"' - name: absoluteUrl - fullName: absoluteUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly absoluteUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' - summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. - name: cdnPrefix - fullName: cdnPrefix - langs: - - typeScript - type: property - syntax: - content: 'readonly cdnPrefix: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPSite#classification:member' - summary: Returns the classification of the site. - name: classification - fullName: classification - langs: - - typeScript - type: property - syntax: - content: 'readonly classification: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPSite#correlationId:member' - summary: Returns the correlation id to the current server request. - name: correlationId - fullName: correlationId - langs: - - typeScript - type: property - syntax: - content: 'readonly correlationId: Guid;' - return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-page-context!SPSite#group:member' - summary: >- - Contextual information about the O365 Group associated with this site. If there is no O365Group associated with - the current site, this property will be undefined. - name: group - fullName: group - langs: - - typeScript - type: property - syntax: - content: 'readonly group: O365GroupAssociation | undefined;' - return: - type: - - '@microsoft/sp-page-context!SPSite#group~0:complex' - - uid: '@microsoft/sp-page-context!SPSite#id:member' - summary: The GUID that identifies the SPSite on the server. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'readonly id: Guid;' - return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' - summary: Returns true if isNoScript has been enabled on the SPSite. - name: isNoScriptEnabled - fullName: isNoScriptEnabled - langs: - - typeScript - type: property - syntax: - content: 'readonly isNoScriptEnabled: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' - summary: The amount of items in the recycle bin. - name: recycleBinItemCount - fullName: recycleBinItemCount - langs: - - typeScript - type: property - syntax: - content: 'readonly recycleBinItemCount: number;' - return: - type: - - number - - uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' - summary: Returns the server-relative URL for this SPSite. - remarks: 'Example: "/sites/PubSite"' - name: serverRelativeUrl - fullName: serverRelativeUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly serverRelativeUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' - summary: Returns serverRelativeUrl of the original request. - remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' - name: serverRequestPath - fullName: serverRequestPath - langs: - - typeScript - type: property - syntax: - content: 'readonly serverRequestPath: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' - summary: Returns true if SitePages are enabled on this SPSite. - name: sitePagesEnabled - fullName: sitePagesEnabled - langs: - - typeScript - type: property - syntax: - content: 'readonly sitePagesEnabled: boolean;' - return: - type: - - boolean -references: - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid - - uid: '@microsoft/sp-page-context!SPSite#group~0:complex' - name: O365GroupAssociation | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: O365GroupAssociation - fullName: default - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: SPSite +uid: '@microsoft/sp-page-context!SPSite:class' +package: '@microsoft/sp-page-context!' +fullName: SPSite +summary: >- + This class is primarily used with the `PageContext` class. It provides + contextual information for the SharePoint site collection ("SPSite") that + hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPSite` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: absoluteUrl + uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' + package: '@microsoft/sp-page-context!' + fullName: absoluteUrl + summary: Returns the absolute URL for this SPSite. + remarks: 'Example: "https://example.com/sites/PubSite"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly absoluteUrl: string;' + return: + type: string + - name: cdnPrefix + uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' + package: '@microsoft/sp-page-context!' + fullName: cdnPrefix + summary: >- + Returns the prefix of the application's specified cdn or an empty string + if there isn't one. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cdnPrefix: string;' + return: + type: string + - name: classification + uid: '@microsoft/sp-page-context!SPSite#classification:member' + package: '@microsoft/sp-page-context!' + fullName: classification + summary: Returns the classification of the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly classification: string;' + return: + type: string + - name: correlationId + uid: '@microsoft/sp-page-context!SPSite#correlationId:member' + package: '@microsoft/sp-page-context!' + fullName: correlationId + summary: Returns the correlation id to the current server request. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly correlationId: Guid;' + return: + type: '' + - name: group + uid: '@microsoft/sp-page-context!SPSite#group:member' + package: '@microsoft/sp-page-context!' + fullName: group + summary: >- + Contextual information about the O365 Group associated with this site. If + there is no O365Group associated with the current site, this property will + be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly group: O365GroupAssociation | undefined;' + return: + type: '@microsoft/sp-page-context!SPSite#' + - name: id + uid: '@microsoft/sp-page-context!SPSite#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The GUID that identifies the SPSite on the server. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: isNoScriptEnabled + uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' + package: '@microsoft/sp-page-context!' + fullName: isNoScriptEnabled + summary: Returns true if isNoScript has been enabled on the SPSite. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isNoScriptEnabled: boolean;' + return: + type: boolean + - name: recycleBinItemCount + uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' + package: '@microsoft/sp-page-context!' + fullName: recycleBinItemCount + summary: The amount of items in the recycle bin. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly recycleBinItemCount: number;' + return: + type: number + - name: serverRelativeUrl + uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' + package: '@microsoft/sp-page-context!' + fullName: serverRelativeUrl + summary: Returns the server-relative URL for this SPSite. + remarks: 'Example: "/sites/PubSite"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: serverRequestPath + uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' + package: '@microsoft/sp-page-context!' + fullName: serverRequestPath + summary: Returns serverRelativeUrl of the original request. + remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRequestPath: string;' + return: + type: string + - name: sitePagesEnabled + uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' + package: '@microsoft/sp-page-context!' + fullName: sitePagesEnabled + summary: Returns true if SitePages are enabled on this SPSite. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sitePagesEnabled: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 15eff414..29d6ae5e 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -1,133 +1,119 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPTimeZone:class' - summary: >- - It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using - the following formula. - remarks: >- - ``` +### YamlMime:TSType +name: SPTimeZone +uid: '@microsoft/sp-page-context!SPTimeZone:class' +package: '@microsoft/sp-page-context!' +fullName: SPTimeZone +summary: >- + It provides timezone information from SharePoint. A conversion from UTC to + local time can be calculated by using the following formula. +remarks: >- + ``` - isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate + isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the + StandardDate - LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) + LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : + standardOffset) - June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) + June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) - ``` + ``` - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPTimeZone` class. - isPreview: true - name: SPTimeZone - fullName: SPTimeZone - langs: - - typeScript - type: class + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPTimeZone` class. +isPreview: true +isDeprecated: false +type: class +properties: + - name: daylightDate + uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' - - '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' - - '@microsoft/sp-page-context!SPTimeZone#description:member' - - '@microsoft/sp-page-context!SPTimeZone#id:member' - - '@microsoft/sp-page-context!SPTimeZone#offset:member' - - '@microsoft/sp-page-context!SPTimeZone#standardDate:member' - - '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' - - uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' + fullName: daylightDate summary: Gets the date on which daylight time begins for the time zone. + remarks: '' isPreview: true - name: daylightDate - fullName: daylightDate - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly daylightDate: ISPSystemTime;' return: - type: - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' + type: '' + - name: daylightOffset + uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' + package: '@microsoft/sp-page-context!' + fullName: daylightOffset summary: >- - Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal - Time (UTC). + Gets the offset in the number of minutes that daylight time for the time + zone differs from Coordinated Universal Time (UTC). + remarks: '' isPreview: true - name: daylightOffset - fullName: daylightOffset - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly daylightOffset: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!SPTimeZone#description:member' + type: number + - name: description + uid: '@microsoft/sp-page-context!SPTimeZone#description:member' + package: '@microsoft/sp-page-context!' + fullName: description summary: Gets the description for the time zone. + remarks: '' isPreview: true - name: description - fullName: description - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly description: string;' return: - type: - - string - - uid: '@microsoft/sp-page-context!SPTimeZone#id:member' + type: string + - name: id + uid: '@microsoft/sp-page-context!SPTimeZone#id:member' + package: '@microsoft/sp-page-context!' + fullName: id summary: Gets the ID of the time zone. + remarks: '' isPreview: true - name: id - fullName: id - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly id: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' - summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). - isPreview: true - name: offset + type: number + - name: offset + uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' + package: '@microsoft/sp-page-context!' fullName: offset - langs: - - typeScript - type: property + summary: >- + Gets the offset in the number of minutes that the time zone differs from + Coordinated Universal Time (UTC). + remarks: '' + isPreview: true + isDeprecated: false syntax: content: 'readonly offset: number;' return: - type: - - number - - uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' + type: number + - name: standardDate + uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' + package: '@microsoft/sp-page-context!' + fullName: standardDate summary: Gets the date on which standard time begins for the time zone. + remarks: '' isPreview: true - name: standardDate - fullName: standardDate - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly standardDate: ISPSystemTime;' return: - type: - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' + type: '' + - name: standardOffset + uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' + package: '@microsoft/sp-page-context!' + fullName: standardOffset summary: >- - Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal - time (UTC). + Gets the offset in the number of minutes that standard time for the time + zone differs from coordinated universal time (UTC). + remarks: '' isPreview: true - name: standardOffset - fullName: standardOffset - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly standardOffset: number;' return: - type: - - number -references: - - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' - name: ISPSystemTime + type: number diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index e82df982..3bdcc82b 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -1,144 +1,124 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPUser:class' - summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint - user that is accessing the page. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPUser` class. - name: SPUser - fullName: SPUser - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPUser#displayName:member' - - '@microsoft/sp-page-context!SPUser#email:member' - - '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' - - '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' - - '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' - - '@microsoft/sp-page-context!SPUser#loginName:member' - - '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' - - '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' - - uid: '@microsoft/sp-page-context!SPUser#displayName:member' - summary: The display name for the current user. - remarks: 'Example: `"John Doe"`' - name: displayName - fullName: displayName - langs: - - typeScript - type: property - syntax: - content: 'readonly displayName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPUser#email:member' - summary: The email address for the current user. - remarks: 'Example: `"example@contoso.com"`' - name: email - fullName: email - langs: - - typeScript - type: property - syntax: - content: 'readonly email: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' - summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. - isPreview: true - name: firstDayOfWeek - fullName: firstDayOfWeek - langs: - - typeScript - type: property - syntax: - content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' - return: - type: - - '@microsoft/sp-page-context!SPUser#firstDayOfWeek~0:complex' - - uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' - summary: Returns if the current user is an anonymous guest. - name: isAnonymousGuestUser - fullName: isAnonymousGuestUser - langs: - - typeScript - type: property - syntax: - content: 'readonly isAnonymousGuestUser: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' - summary: Returns true if the current user is an external guest. - name: isExternalGuestUser - fullName: isExternalGuestUser - langs: - - typeScript - type: property - syntax: - content: 'readonly isExternalGuestUser: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-page-context!SPUser#loginName:member' - summary: The login name for current user. - remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' - name: loginName - fullName: loginName - langs: - - typeScript - type: property - syntax: - content: 'readonly loginName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' - summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. - name: preferUserTimeZone - fullName: preferUserTimeZone - langs: - - typeScript - type: property - syntax: - content: 'readonly preferUserTimeZone: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' - summary: Returns the user's regional timezone settings or undefined if they haven't been set. - isPreview: true - name: timeZoneInfo - fullName: timeZoneInfo - langs: - - typeScript - type: property - syntax: - content: 'readonly timeZoneInfo: SPTimeZone | undefined;' - return: - type: - - '@microsoft/sp-page-context!SPUser#timeZoneInfo~0:complex' -references: - - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek~0:complex' - name: SPDayOfWeek | undefined - fullName: SPDayOfWeek | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - name: SPDayOfWeek - fullName: SPDayOfWeek - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo~0:complex' - name: SPTimeZone | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: SPTimeZone - fullName: default - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: SPUser +uid: '@microsoft/sp-page-context!SPUser:class' +package: '@microsoft/sp-page-context!' +fullName: SPUser +summary: >- + This class is primarily used with the `PageContext` class. It provides + contextual information for the SharePoint user that is accessing the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `SPUser` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: displayName + uid: '@microsoft/sp-page-context!SPUser#displayName:member' + package: '@microsoft/sp-page-context!' + fullName: displayName + summary: The display name for the current user. + remarks: 'Example: `"John Doe"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly displayName: string;' + return: + type: string + - name: email + uid: '@microsoft/sp-page-context!SPUser#email:member' + package: '@microsoft/sp-page-context!' + fullName: email + summary: The email address for the current user. + remarks: 'Example: `"example@contoso.com"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly email: string;' + return: + type: string + - name: firstDayOfWeek + uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' + package: '@microsoft/sp-page-context!' + fullName: firstDayOfWeek + summary: >- + Returns the user's regional first day of week setting or undefined if it + hasn't been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' + return: + type: >- + @microsoft/sp-page-context!SPUser# + - name: isAnonymousGuestUser + uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' + package: '@microsoft/sp-page-context!' + fullName: isAnonymousGuestUser + summary: Returns if the current user is an anonymous guest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isAnonymousGuestUser: boolean;' + return: + type: boolean + - name: isExternalGuestUser + uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' + package: '@microsoft/sp-page-context!' + fullName: isExternalGuestUser + summary: Returns true if the current user is an external guest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isExternalGuestUser: boolean;' + return: + type: boolean + - name: loginName + uid: '@microsoft/sp-page-context!SPUser#loginName:member' + package: '@microsoft/sp-page-context!' + fullName: loginName + summary: The login name for current user. + remarks: >- + Example: on-premise user: `"domain\user"`, online user: + `"user@domain.com"` + isPreview: false + isDeprecated: false + syntax: + content: 'readonly loginName: string;' + return: + type: string + - name: preferUserTimeZone + uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' + package: '@microsoft/sp-page-context!' + fullName: preferUserTimeZone + summary: >- + This boolean represents if a the user or web's time zone settings should + be used to display the current time. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly preferUserTimeZone: boolean;' + return: + type: boolean + - name: timeZoneInfo + uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' + package: '@microsoft/sp-page-context!' + fullName: timeZoneInfo + summary: >- + Returns the user's regional timezone settings or undefined if they haven't + been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly timeZoneInfo: SPTimeZone | undefined;' + return: + type: >- + @microsoft/sp-page-context!SPUser# diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 098e51ea..8625281f 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -1,219 +1,190 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-page-context!SPWeb:class' - summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint - site ("SPWeb") that hosts the page. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPWeb` class. - name: SPWeb - fullName: SPWeb - langs: - - typeScript - type: class - package: '@microsoft/sp-page-context!' - children: - - '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' - - '@microsoft/sp-page-context!SPWeb#description:member' - - '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' - - '@microsoft/sp-page-context!SPWeb#id:member' - - '@microsoft/sp-page-context!SPWeb#isAppWeb:member' - - '@microsoft/sp-page-context!SPWeb#language:member' - - '@microsoft/sp-page-context!SPWeb#languageName:member' - - '@microsoft/sp-page-context!SPWeb#logoUrl:member' - - '@microsoft/sp-page-context!SPWeb#permissions:member' - - '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' - - '@microsoft/sp-page-context!SPWeb#templateName:member' - - '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' - - '@microsoft/sp-page-context!SPWeb#title:member' - - uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' - summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' - name: absoluteUrl - fullName: absoluteUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly absoluteUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPWeb#description:member' - summary: Returns the description of the current SPWeb. - name: description - fullName: description - langs: - - typeScript - type: property - syntax: - content: 'readonly description: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' - summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. - isPreview: true - name: firstDayOfWeek - fullName: firstDayOfWeek - langs: - - typeScript - type: property - syntax: - content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' - return: - type: - - '@microsoft/sp-page-context!SPWeb#firstDayOfWeek~0:complex' - - uid: '@microsoft/sp-page-context!SPWeb#id:member' - summary: The GUID that identifies the SPWeb on the server. - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'readonly id: Guid;' - return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' - summary: Returns true if this `SPWeb` the container web for an `SPApp`. - name: isAppWeb - fullName: isAppWeb - langs: - - typeScript - type: property - syntax: - content: 'readonly isAppWeb: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-page-context!SPWeb#language:member' - summary: Returns the locale identifier (LCID) for the default language of the website. - remarks: 'Example: 1033 represents the locale identifier for en-US.' - name: language - fullName: language - langs: - - typeScript - type: property - syntax: - content: 'readonly language: number;' - return: - type: - - number - - uid: '@microsoft/sp-page-context!SPWeb#languageName:member' - summary: Returns the language name for the default language of the website. - remarks: 'Example: en-US represents the English language in the US locale.' - name: languageName - fullName: languageName - langs: - - typeScript - type: property - syntax: - content: 'readonly languageName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' - summary: Returns the absolute URL of the website logo. - remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' - name: logoUrl - fullName: logoUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly logoUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPWeb#permissions:member' - summary: >- - Return the SPPermission object that represents the set of permissions that the current user has for interacting - with the web. - name: permissions - fullName: permissions - langs: - - typeScript - type: property - syntax: - content: 'readonly permissions: SPPermission;' - return: - type: - - '@microsoft/sp-page-context!default:class' - - uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' - summary: Returns the server-relative URL for this SPWeb. - remarks: 'Example: `"/sites/PubSite/SubWeb"`' - name: serverRelativeUrl - fullName: serverRelativeUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly serverRelativeUrl: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPWeb#templateName:member' - summary: >- - Returns the string representing the numeric identifier for the site definition or site template that was used to - create the site. - remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' - name: templateName - fullName: templateName - langs: - - typeScript - type: property - syntax: - content: 'readonly templateName: string;' - return: - type: - - string - - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' - summary: Returns the web's regional timezone settings or undefined if they haven't been set. - isPreview: true - name: timeZoneInfo - fullName: timeZoneInfo - langs: - - typeScript - type: property - syntax: - content: 'readonly timeZoneInfo: SPTimeZone | undefined;' - return: - type: - - '@microsoft/sp-page-context!SPWeb#timeZoneInfo~0:complex' - - uid: '@microsoft/sp-page-context!SPWeb#title:member' - summary: Returns the title of the current SPWeb. - name: title - fullName: title - langs: - - typeScript - type: property - syntax: - content: 'readonly title: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek~0:complex' - name: SPDayOfWeek | undefined - fullName: SPDayOfWeek | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - name: SPDayOfWeek - fullName: SPDayOfWeek - - name: ' | undefined' - fullName: ' | undefined' - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid - - uid: '@microsoft/sp-page-context!default:class' - name: SPPermission - - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo~0:complex' - name: SPTimeZone | undefined - fullName: default | undefined - spec.typeScript: - - uid: '@microsoft/sp-page-context!default:class' - name: SPTimeZone - fullName: default - - name: ' | undefined' - fullName: ' | undefined' +### YamlMime:TSType +name: SPWeb +uid: '@microsoft/sp-page-context!SPWeb:class' +package: '@microsoft/sp-page-context!' +fullName: SPWeb +summary: >- + This class is primarily used with the `PageContext` class. It provides + contextual information for the SharePoint site ("SPWeb") that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the `SPWeb` + class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: absoluteUrl + uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' + package: '@microsoft/sp-page-context!' + fullName: absoluteUrl + summary: >- + Returns the absolute URL for this SPWeb. Example: `".com/sites/PubSite/SubWeb"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly absoluteUrl: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-page-context!SPWeb#description:member' + package: '@microsoft/sp-page-context!' + fullName: description + summary: Returns the description of the current SPWeb. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly description: string;' + return: + type: string + - name: firstDayOfWeek + uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' + package: '@microsoft/sp-page-context!' + fullName: firstDayOfWeek + summary: >- + Returns the web's regional first day of week setting or undefined if it + hasn't been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' + return: + type: >- + @microsoft/sp-page-context!SPWeb# + - name: id + uid: '@microsoft/sp-page-context!SPWeb#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The GUID that identifies the SPWeb on the server. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: isAppWeb + uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' + package: '@microsoft/sp-page-context!' + fullName: isAppWeb + summary: >- + Returns true if this `SPWeb` the container web for an `SPApp`<!-- + -->. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isAppWeb: boolean;' + return: + type: boolean + - name: language + uid: '@microsoft/sp-page-context!SPWeb#language:member' + package: '@microsoft/sp-page-context!' + fullName: language + summary: >- + Returns the locale identifier (LCID) for the default language of the + website. + remarks: 'Example: 1033 represents the locale identifier for en-US.' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly language: number;' + return: + type: number + - name: languageName + uid: '@microsoft/sp-page-context!SPWeb#languageName:member' + package: '@microsoft/sp-page-context!' + fullName: languageName + summary: Returns the language name for the default language of the website. + remarks: 'Example: en-US represents the English language in the US locale.' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly languageName: string;' + return: + type: string + - name: logoUrl + uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' + package: '@microsoft/sp-page-context!' + fullName: logoUrl + summary: Returns the absolute URL of the website logo. + remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly logoUrl: string;' + return: + type: string + - name: permissions + uid: '@microsoft/sp-page-context!SPWeb#permissions:member' + package: '@microsoft/sp-page-context!' + fullName: permissions + summary: >- + Return the SPPermission object that represents the set of permissions that + the current user has for interacting with the web. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly permissions: SPPermission;' + return: + type: '' + - name: serverRelativeUrl + uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' + package: '@microsoft/sp-page-context!' + fullName: serverRelativeUrl + summary: Returns the server-relative URL for this SPWeb. + remarks: 'Example: `"/sites/PubSite/SubWeb"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: templateName + uid: '@microsoft/sp-page-context!SPWeb#templateName:member' + package: '@microsoft/sp-page-context!' + fullName: templateName + summary: >- + Returns the string representing the numeric identifier for the site + definition or site template that was used to create the site. + remarks: >- + Example: `"1"` represents the team site template when creating a new site + on SharePoint. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly templateName: string;' + return: + type: string + - name: timeZoneInfo + uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' + package: '@microsoft/sp-page-context!' + fullName: timeZoneInfo + summary: >- + Returns the web's regional timezone settings or undefined if they haven't + been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly timeZoneInfo: SPTimeZone | undefined;' + return: + type: '@microsoft/sp-page-context!SPWeb#' + - name: title + uid: '@microsoft/sp-page-context!SPWeb#title:member' + package: '@microsoft/sp-page-context!' + fullName: title + summary: Returns the title of the current SPWeb. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly title: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index b46d0ddd..ab95d560 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -1,680 +1,426 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!' - summary: SharePoint Framework property pane. - remarks: 'Helps create the property pane for the SharePoint components such as web parts, canvas etc.,' - name: '@microsoft/sp-property-pane' - fullName: '@microsoft/sp-property-pane' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - - '@microsoft/sp-property-pane!IPopupWindowProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneField:interface' - - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - - '@microsoft/sp-property-pane!IPropertyPanePage:interface' - - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - - '@microsoft/sp-property-pane!PopupWindowPosition:enum' - - '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - - '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - - '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' - - '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' - - '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - summary: Property pane dynamic field filters which is an intersection of both source and property filters. - name: IPropertyPaneDynamicFieldFilters - fullName: IPropertyPaneDynamicFieldFilters - langs: - - typeScript - type: typealias - syntax: - content: >- - export declare type IPropertyPaneDynamicFieldFilters = IDynamicDataSharedSourceFilters & - IDynamicDataSharedPropertyFilters; - return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters~0:complex' - - uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' +### YamlMime:TSPacakge +uid: '@microsoft/sp-property-pane!' +name: '@microsoft/sp-property-pane' +type: package +summary: SharePoint Framework property pane. +enums: + - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' +interfaces: + - >- + @microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' +typeAliases: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' +functions: + - name: 'PropertyPaneButton(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Button on the PropertyPane. - name: 'PropertyPaneButton(targetProperty, properties)' - fullName: 'PropertyPaneButton(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + export declare function PropertyPaneButton(targetProperty: string, + properties: IPropertyPaneButtonProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneButton~0:complex' - description: '' parameters: - id: targetProperty description: Target property the Button is associated to. - type: - - string + type: string - id: properties description: Strongly typed Button properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneCheckbox(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Checkbox on the PropertyPane. - name: 'PropertyPaneCheckbox(targetProperty, properties)' - fullName: 'PropertyPaneCheckbox(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + export declare function PropertyPaneCheckbox(targetProperty: string, + properties: IPropertyPaneCheckboxProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneCheckbox~0:complex' - description: '' parameters: - id: targetProperty description: Target property the checkbox is associated to. - type: - - string + type: string - id: properties description: Strongly typed Checkbox properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Choice Group on the PropertyPane. - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: - IPropertyPaneChoiceGroupProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneChoiceGroup~0:complex' - description: '' + export declare function PropertyPaneChoiceGroup(targetProperty: string, + properties: IPropertyPaneChoiceGroupProps): + IPropertyPaneField; parameters: - id: targetProperty description: Target property the choice group is associated to. - type: - - string + type: string - id: properties description: Strongly typed Choice Group properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: PropertyPaneCustomField(properties) + uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a custom field on the PropertyPane. remarks: >- - The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The - PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but - there are exceptional cases when web parts have special needs and need a special control. The custom field helps - fill that gap. + The purpose of the custom field is to help the web part developer to add a + custom control to the PropertyPane. The PropertyPane supports a host of + inbuilt field types. While this list meets the demands of most web parts, + but there are exceptional cases when web parts have special needs and need + a special control. The custom field helps fill that gap. isPreview: true - name: PropertyPaneCustomField(properties) - fullName: PropertyPaneCustomField(properties) - langs: - - typeScript - type: function + isDeprecated: false syntax: content: >- - export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): + export declare function PropertyPaneCustomField(properties: + IPropertyPaneCustomFieldProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneCustomField~0:complex' - description: '' parameters: - id: properties description: Strongly typed Custom field properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneDropdown(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Dropdown on the PropertyPane. - name: 'PropertyPaneDropdown(targetProperty, properties)' - fullName: 'PropertyPaneDropdown(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + export declare function PropertyPaneDropdown(targetProperty: string, + properties: IPropertyPaneDropdownProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneDropdown~0:complex' - description: '' parameters: - id: targetProperty description: Target property the dropdown is associated to. - type: - - string + type: string - id: properties description: Strongly typed Dropdown properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' - summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. - name: 'PropertyPaneDynamicField(targetProperty, properties)' - fullName: 'PropertyPaneDynamicField(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneDynamicField(targetProperty: string, properties: - IPropertyPaneDynamicFieldProps): IPropertyPaneField; + type: >- + return: - type: - - '@microsoft/sp-property-pane!PropertyPaneDynamicField~0:complex' + type: >- + description: '' + - name: 'PropertyPaneDynamicField(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' + package: '@microsoft/sp-property-pane' + summary: >- + Helper method to create a Dynamic Data widget on the PropertyPane for a + dynamic field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneDynamicField(targetProperty: string, + properties: IPropertyPaneDynamicFieldProps): + IPropertyPaneField; parameters: - id: targetProperty description: Target property the Dynamic Data widget is associated to. - type: - - string + type: string - id: properties description: '' - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: PropertyPaneDynamicFieldSet(properties) + uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' + package: '@microsoft/sp-property-pane' summary: >- - Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data - source. + Helper method to create a Dynamic Data widget on the Property Pane for a + set of dynamic fields with a common data source. - These fields can possibly share the same property based on the associated filters. - name: PropertyPaneDynamicFieldSet(properties) - fullName: PropertyPaneDynamicFieldSet(properties) - langs: - - typeScript - type: function + These fields can possibly share the same property based on the associated + filters. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): + export declare function PropertyPaneDynamicFieldSet(properties: + IPropertyPaneDynamicFieldSetProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet~0:complex' - description: '' parameters: - id: properties description: >- - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. - Each entry includes the target property and, optionally, the label to show. options - Options enabling - customized values for callback, filters etc., for the given set of dynamic fields. - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' + Contains entries and options, described as below: entries - A set of + entries to be configured by the widget. Each entry includes the + target property and, optionally, the label to show. options - + Options enabling customized values for callback, filters etc., for + the given set of dynamic fields. + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Dynamic TextField on the PropertyPane. - deprecated: - content: '- This has been replaced by PropertyPaneDynamicField' + remarks: '' isPreview: true - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - fullName: 'PropertyPaneDynamicTextField(targetProperty, properties)' - langs: - - typeScript - type: function + isDeprecated: true + customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' syntax: content: >- - export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: - IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneDynamicTextField~0:complex' - description: '' + export declare function PropertyPaneDynamicTextField(targetProperty: + string, properties: IPropertyPaneDynamicTextFieldProps): + IPropertyPaneField; parameters: - id: targetProperty description: Target property the dynamic textfield is associated to. - type: - - string + type: string - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: PropertyPaneHorizontalRule() + uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Horizontal Rule on the PropertyPane. - name: PropertyPaneHorizontalRule() - fullName: PropertyPaneHorizontalRule() - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' + content: >- + export declare function PropertyPaneHorizontalRule(): + IPropertyPaneField; return: - type: - - '@microsoft/sp-property-pane!PropertyPaneHorizontalRule~0:complex' + type: >- + description: '' - - uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' + - name: 'PropertyPaneLabel(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Label on the PropertyPane. - name: 'PropertyPaneLabel(targetProperty, properties)' - fullName: 'PropertyPaneLabel(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + export declare function PropertyPaneLabel(targetProperty: string, + properties: IPropertyPaneLabelProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneLabel~0:complex' - description: '' parameters: - id: targetProperty description: Target property the label is associated to. - type: - - string + type: string - id: properties description: Strongly typed Label properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' + type: >- + + return: + type: '' + description: '' + - name: 'PropertyPaneLink(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Link on the PropertyPane. - name: 'PropertyPaneLink(targetProperty, properties)' - fullName: 'PropertyPaneLink(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + export declare function PropertyPaneLink(targetProperty: string, + properties: IPropertyPaneLinkProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneLink~0:complex' - description: '' parameters: - id: targetProperty description: Target property the Link is associated to. - type: - - string + type: string - id: properties description: Strongly typed Link properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' + type: >- + + return: + type: '' + description: '' + - name: 'PropertyPaneSlider(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Slider on the PropertyPane. - name: 'PropertyPaneSlider(targetProperty, properties)' - fullName: 'PropertyPaneSlider(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + export declare function PropertyPaneSlider(targetProperty: string, + properties: IPropertyPaneSliderProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneSlider~0:complex' - description: '' parameters: - id: targetProperty description: Target property the slider is associated to. - type: - - string + type: string - id: properties description: Strongly typed Slider properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneTextField(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a TextField on the PropertyPane. - name: 'PropertyPaneTextField(targetProperty, properties)' - fullName: 'PropertyPaneTextField(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + export declare function PropertyPaneTextField(targetProperty: string, + properties: IPropertyPaneTextFieldProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneTextField~0:complex' - description: '' parameters: - id: targetProperty description: Target property the textfield is associated to. - type: - - string + type: string - id: properties description: Strongly typed TextField properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - - uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneToggle(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' + package: '@microsoft/sp-property-pane' summary: Helper method to create a Toggle on the PropertyPane. - name: 'PropertyPaneToggle(targetProperty, properties)' - fullName: 'PropertyPaneToggle(targetProperty, properties)' - langs: - - typeScript - type: function + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + export declare function PropertyPaneToggle(targetProperty: string, + properties: IPropertyPaneToggleProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-property-pane!PropertyPaneToggle~0:complex' - description: '' parameters: - id: targetProperty description: Target property the toggle is associated to. - type: - - string + type: string - id: properties description: Strongly typed Toggle properties. - type: - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' -references: - - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - name: DynamicDataSharedDepth - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - name: IDynamicDataSharedPropertyConfiguration - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedPropertyFilters - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceConfiguration - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - name: IDynamicDataSharedSourceFilters - - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' - name: IPopupWindowProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - name: IPropertyPaneButtonProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneCheckboxProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - name: IPropertyPaneChoiceGroupOption - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - name: IPropertyPaneChoiceGroupOptionIconProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneChoiceGroupProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - name: IPropertyPaneConditionalGroup - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - name: IPropertyPaneConfiguration - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneCustomFieldProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - name: IPropertyPaneDebounceProperty - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - name: IPropertyPaneDropdownCalloutProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownOption - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDropdownProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters~0:complex' - name: IDynamicDataSharedSourceFilters & IDynamicDataSharedPropertyFilters - fullName: IDynamicDataSharedSourceFilters & IDynamicDataSharedPropertyFilters - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - name: IDynamicDataSharedSourceFilters - fullName: IDynamicDataSharedSourceFilters - - name: ' & ' - fullName: ' & ' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedPropertyFilters - fullName: IDynamicDataSharedPropertyFilters - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicFieldSetProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneDynamicTextFieldProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - name: IPropertyPaneGroup - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLabelProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - name: IPropertyPaneLinkProps - - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' - name: IPropertyPanePage - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - name: IPropertyPanePageHeader - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - name: IPropertyPaneSliderProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneTextFieldProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - name: IPropertyPaneToggleProps - - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' - name: PopupWindowPosition - - uid: '@microsoft/sp-property-pane!PropertyPaneButton~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - name: IPropertyPaneButtonProps - fullName: IPropertyPaneButtonProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - name: PropertyPaneButtonType - - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneCheckboxProps - fullName: IPropertyPaneCheckboxProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneChoiceGroupProps - fullName: IPropertyPaneChoiceGroupProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneCustomFieldProps - fullName: IPropertyPaneCustomFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDropdownProps - fullName: IPropertyPaneDropdownProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - name: PropertyPaneDropdownOptionType - - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicFieldSetProps - fullName: IPropertyPaneDynamicFieldSetProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneDynamicTextFieldProps - fullName: IPropertyPaneDynamicTextFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' - name: PropertyPaneFieldType - - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: - fullName: - - uid: '@microsoft/sp-property-pane!PropertyPaneLabel~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLabelProps - fullName: IPropertyPaneLabelProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneLink~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - name: IPropertyPaneLinkProps - fullName: IPropertyPaneLinkProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneSlider~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - name: IPropertyPaneSliderProps - fullName: IPropertyPaneSliderProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneTextField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneTextFieldProps - fullName: IPropertyPaneTextFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-property-pane!PropertyPaneToggle~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - name: IPropertyPaneToggleProps - fullName: IPropertyPaneToggleProps - - name: '>' - fullName: '>' + type: >- + + return: + type: >- + + description: '' diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 6f36b6e1..53c7d2d5 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -1,38 +1,25 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - summary: Enum for the possible values of shared depth of the dynamic data reference. - name: DynamicDataSharedDepth - fullName: DynamicDataSharedDepth - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: DynamicDataSharedDepth +uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' +package: '@microsoft/sp-property-pane!' +fullName: DynamicDataSharedDepth +summary: Enum for the possible values of shared depth of the dynamic data reference. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: None + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' - - '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' - - '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' - - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' summary: Indicates that nothing is shared. - name: None - fullName: None - langs: - - typeScript - type: field numericValue: '0' - - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' + - name: Property + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' + package: '@microsoft/sp-property-pane!' summary: Indicates that both the dynamic data source and the property are shared. - name: Property - fullName: Property - langs: - - typeScript - type: field numericValue: '2' - - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' + - name: Source + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' + package: '@microsoft/sp-property-pane!' summary: Indicates that the dynamic data source is shared. - name: Source - fullName: Source - langs: - - typeScript - type: field numericValue: '1' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 5ad62caf..73b1d2d2 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -1,27 +1,27 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - summary: Configuration related to a shared property. - name: IDynamicDataSharedPropertyConfiguration - fullName: IDynamicDataSharedPropertyConfiguration - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataSharedPropertyConfiguration +uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedPropertyConfiguration +summary: Configuration related to a shared property. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filters + uid: >- + @microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' - summary: Filters for the shared property. - name: filters fullName: filters - langs: - - typeScript - type: property + summary: Filters for the shared property. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'filters?: IDynamicDataSharedPropertyFilters;' return: - type: - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' -references: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedPropertyFilters + type: >- + diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index fc628eda..2a1e9e98 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -1,35 +1,38 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - summary: Property pane dynamic data property filters. - name: IDynamicDataSharedPropertyFilters - fullName: IDynamicDataSharedPropertyFilters - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataSharedPropertyFilters +uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedPropertyFilters +summary: Property pane dynamic data property filters. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: propertyId + uid: >- + @microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' - summary: |- + fullName: propertyId + summary: >- Property Id - Usage: Use this filter when the author can only to connect to a specific property from the selected source. + + Usage: Use this filter when the author can only to connect to a specific + property from the selected source. remarks: >- - This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the - dynamic data widget. + This is to filter which specific property is to be pre-selected in the + properties dropdown(second level) on the dynamic data widget. - When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. - Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is - pre-selected, the control will be disabled to ensure that authors can not change it. - name: propertyId - fullName: propertyId - langs: - - typeScript - type: property + When provided, the dynamic data properties dropdown is pre-selected to + show the specific property, if avaialble. Otherwise the dropdown will fall + back to show all the exposed properties from the source. If a property is + pre-selected, the control will be disabled to ensure that authors can not + change it. + isPreview: false + isDeprecated: false syntax: content: 'propertyId?: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index 702506d2..ab0d3e19 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -1,43 +1,43 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - summary: Configuration related to a shared source. - name: IDynamicDataSharedSourceConfiguration - fullName: IDynamicDataSharedSourceConfiguration - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataSharedSourceConfiguration +uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedSourceConfiguration +summary: Configuration related to a shared source. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filters + uid: >- + @microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' - summary: Filters for the shared source. - name: filters fullName: filters - langs: - - typeScript - type: property + summary: Filters for the shared source. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'filters?: IDynamicDataSharedSourceFilters;' return: - type: - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' + type: >- + + - name: sourcesLabel + uid: >- + @microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member + package: '@microsoft/sp-property-pane!' + fullName: sourcesLabel summary: |- User-friendly, localized label for the sources dropdown. default value - 'Connect to source' - name: sourcesLabel - fullName: sourcesLabel - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'sourcesLabel?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - name: IDynamicDataSharedSourceFilters + type: string diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index ae17e24a..0981e281 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -1,68 +1,72 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - summary: Property pane dynamic data source filters. - name: IDynamicDataSharedSourceFilters - fullName: IDynamicDataSharedSourceFilters - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IDynamicDataSharedSourceFilters +uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedSourceFilters +summary: Property pane dynamic data source filters. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: componentId + uid: >- + @microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' - summary: |- + fullName: componentId + summary: >- Component Id. - Usage: Use this filter when the author should only be able to connect to a specific type of source. + + Usage: Use this filter when the author should only be able to connect to a + specific type of source. remarks: >- - This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic - data widget. + This is to filter what type of source needs to be shown in the data + sources dropdown (first level) on the dynamic data widget. - When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources - matching the given component id. + When provided, the dynamic data sources dropdown in the dynamic data + widget is filtered to only show the sources matching the given component + id. - Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only - shows document library web parts on the page which are registered dynamic sources. - name: componentId - fullName: componentId - langs: - - typeScript - type: property + Example - If the document library web part component id is supplied, then + the dynamic data sources dropdown only shows document library web parts on + the page which are registered dynamic sources. + isPreview: false + isDeprecated: false syntax: content: 'componentId?: Guid;' return: - type: - - '@microsoft/sp-core-library!Guid:class' - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' - summary: |- + type: '' + - name: sourceId + uid: >- + @microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member + package: '@microsoft/sp-property-pane!' + fullName: sourceId + summary: >- Source Id - Usage: Use this filter, when the author can only to connect to a specific data source. + + Usage: Use this filter, when the author can only to connect to a specific + data source. remarks: >- - This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the - dynamic data widget. + This is to filter which specific source is to be pre-selected in the data + sources dropdown (first level) on the dynamic data widget. - When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if - available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is - pre-selected, the control will be disabled to ensure that authors can not change it. + When provided, the dynamic data sources dropdown is pre-selected to show + the source with the provided id, if available. Otherwise the dropdown will + fall back to show all the existing data sources on the page. If a source + is pre-selected, the control will be disabled to ensure that authors can + not change it. - The source id for a web part will be of the form WebPart.. - name: sourceId - fullName: sourceId - langs: - - typeScript - type: property + The source id for a web part will be of the form + WebPart.. + isPreview: false + isDeprecated: false syntax: content: 'sourceId?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-core-library!Guid:class' - name: Guid + type: string diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index 257be078..9a75174d 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -1,66 +1,60 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' - summary: Popup window props. - name: IPopupWindowProps - fullName: IPopupWindowProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPopupWindowProps +uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPopupWindowProps +summary: Popup window props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: height + uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPopupWindowProps#height:member' - - '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' - - '@microsoft/sp-property-pane!IPopupWindowProps#title:member' - - '@microsoft/sp-property-pane!IPopupWindowProps#width:member' - - uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' - summary: Height of pop up window. - name: height fullName: height - langs: - - typeScript - type: property + summary: Height of pop up window. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'height: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' - summary: The position of pop up window. - name: positionWindowPosition + type: number + - name: positionWindowPosition + uid: >- + @microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member + package: '@microsoft/sp-property-pane!' fullName: positionWindowPosition - langs: - - typeScript - type: property + summary: The position of pop up window. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'positionWindowPosition: PopupWindowPosition;' return: - type: - - '@microsoft/sp-property-pane!PopupWindowPosition:enum' - - uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' - summary: Title of pop up window. - name: title + type: '' + - name: title + uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' + package: '@microsoft/sp-property-pane!' fullName: title - langs: - - typeScript - type: property + summary: Title of pop up window. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'title: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' - summary: Width of pop up window. - name: width + type: string + - name: width + uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' + package: '@microsoft/sp-property-pane!' fullName: width - langs: - - typeScript - type: property + summary: Width of pop up window. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'width: number;' return: - type: - - number -references: - - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' - name: PopupWindowPosition + type: number diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index 638498a5..3a72c38a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -1,124 +1,119 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - summary: PropertyPane button props. - name: IPropertyPaneButtonProps - fullName: IPropertyPaneButtonProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneButtonProps +uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneButtonProps +summary: PropertyPane button props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaDescription + uid: >- + @microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' - summary: |- + fullName: ariaDescription + summary: >- Detailed description of the button for the benefit of screen readers. - Besides the compound button, other button types will need more information provided to screen reader. - name: ariaDescription - fullName: ariaDescription - langs: - - typeScript - type: property + + Besides the compound button, other button types will need more information + provided to screen reader. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaDescription?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' - summary: The aria label of the button for the benefit of screen readers. - name: ariaLabel + type: string + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' + package: '@microsoft/sp-property-pane!' fullName: ariaLabel - langs: - - typeScript - type: property + summary: The aria label of the button for the benefit of screen readers. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' - summary: The type of button to render. Default value is ButtonType.normal. - name: buttonType + type: string + - name: buttonType + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' + package: '@microsoft/sp-property-pane!' fullName: buttonType - langs: - - typeScript - type: property + summary: The type of button to render. Default value is ButtonType.normal. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'buttonType?: PropertyPaneButtonType;' return: - type: - - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' - summary: Description of the action this button takes. Only used for compound buttons. - name: description + type: '' + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' + package: '@microsoft/sp-property-pane!' fullName: description - langs: - - typeScript - type: property + summary: >- + Description of the action this button takes. Only used for compound + buttons. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'description?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' - summary: Whether the button is disabled. - name: disabled + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Whether the button is disabled. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' - summary: The button icon shown in command or hero type. - name: icon + type: boolean + - name: icon + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' + package: '@microsoft/sp-property-pane!' fullName: icon - langs: - - typeScript - type: property + summary: The button icon shown in command or hero type. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'icon?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' + type: string + - name: onClick + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' + package: '@microsoft/sp-property-pane!' + fullName: onClick summary: >- - A callback which is invoked on the button click, which takes in the existing value for the bound property and - returns the new value and which is then used to update the properties bag. This update will result in the + A callback which is invoked on the button click, which takes in the + existing value for the bound property and returns the new value and which + is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. - name: onClick - fullName: onClick - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'onClick: (value: any) => any;' return: - type: - - '(value: any) => any' - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' - summary: Display text of the element. - name: text + type: '(value: any) => any' + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' + package: '@microsoft/sp-property-pane!' fullName: text - langs: - - typeScript - type: property + summary: Display text of the element. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'text: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - name: PropertyPaneButtonType + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index b5f627f8..73e11b1b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -1,51 +1,47 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - summary: PropertyPane CheckBox component props. - name: IPropertyPaneCheckboxProps - fullName: IPropertyPaneCheckboxProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneCheckboxProps +uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneCheckboxProps +summary: PropertyPane CheckBox component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: checked + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' + fullName: checked summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. - name: checked - fullName: checked - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'checked?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' - summary: Whether the property pane checkbox is disabled or not. - name: disabled + type: boolean + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Whether the property pane checkbox is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' - summary: Label to display next to the checkbox. - name: text + type: boolean + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' + package: '@microsoft/sp-property-pane!' fullName: text - langs: - - typeScript - type: property + summary: Label to display next to the checkbox. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'text?: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index dd39410a..bc5cdfca 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -1,81 +1,81 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - summary: PropertyPane ChoiceGroup option props. - name: IPropertyPaneChoiceGroupOption - fullName: IPropertyPaneChoiceGroupOption - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOption +uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneChoiceGroupOption +summary: PropertyPane ChoiceGroup option props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' - summary: The aria label of the property pane choice group option for the benefit of screen readers. - name: ariaLabel fullName: ariaLabel - langs: - - typeScript - type: property + summary: >- + The aria label of the property pane choice group option for the benefit of + screen readers. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' + type: string + - name: checked + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' + package: '@microsoft/sp-property-pane!' + fullName: checked summary: |- Whether the property pane choice group option is checked or not. Default value is false. - name: checked - fullName: checked - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'checked?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' - summary: Whether the property pane choice group option is disabled or not. - name: disabled + type: boolean + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Whether the property pane choice group option is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' - summary: The Icon component props for choice field. - name: iconProps + type: boolean + - name: iconProps + uid: >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member + package: '@microsoft/sp-property-pane!' fullName: iconProps - langs: - - typeScript - type: property + summary: The Icon component props for choice field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' - summary: The width and height of the image in px for choice field. - name: imageSize + type: >- + + - name: imageSize + uid: >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member + package: '@microsoft/sp-property-pane!' fullName: imageSize - langs: - - typeScript - type: property + summary: The width and height of the image in px for choice field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: |- imageSize?: { @@ -83,60 +83,57 @@ items: height: number; }; return: - type: - - |- - { - width: number; - height: number; - } - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' - summary: The src of image for choice field. - name: imageSrc + type: |- + { + width: number; + height: number; + } + - name: imageSrc + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' + package: '@microsoft/sp-property-pane!' fullName: imageSrc - langs: - - typeScript - type: property + summary: The src of image for choice field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'imageSrc?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' - summary: A required key to uniquely identify the option. - name: key + type: string + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' + package: '@microsoft/sp-property-pane!' fullName: key - langs: - - typeScript - type: property + summary: A required key to uniquely identify the option. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'key: string | number;' return: - type: - - string | number - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' - summary: The src of image for choice field which is selected. - name: selectedImageSrc + type: string | number + - name: selectedImageSrc + uid: >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member + package: '@microsoft/sp-property-pane!' fullName: selectedImageSrc - langs: - - typeScript - type: property + summary: The src of image for choice field which is selected. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'selectedImageSrc?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' - summary: The text string for the option. - name: text + type: string + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' + package: '@microsoft/sp-property-pane!' fullName: text - langs: - - typeScript - type: property + summary: The text string for the option. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'text: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - name: IPropertyPaneChoiceGroupOptionIconProps + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index 84edeebb..1fd4c91a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -1,24 +1,24 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - summary: PropertyPane ChoiceGroup icon props. - name: IPropertyPaneChoiceGroupOptionIconProps - fullName: IPropertyPaneChoiceGroupOptionIconProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOptionIconProps +uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneChoiceGroupOptionIconProps +summary: PropertyPane ChoiceGroup icon props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: officeFabricIconFontName + uid: >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' - summary: The name of the icon to use from the Office Fabric icon set. - name: officeFabricIconFontName fullName: officeFabricIconFontName - langs: - - typeScript - type: property + summary: The name of the icon to use from the Office Fabric icon set. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'officeFabricIconFontName?: string | null;' return: - type: - - string | null + type: string | null diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 7dcdb4df..d15f4ad2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -1,47 +1,37 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - summary: PropertyPane ChoiceGroup props. - name: IPropertyPaneChoiceGroupProps - fullName: IPropertyPaneChoiceGroupProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneChoiceGroupProps +uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneChoiceGroupProps +summary: PropertyPane ChoiceGroup props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' - summary: Descriptive label for the choice group. - name: label fullName: label - langs: - - typeScript - type: property + summary: Descriptive label for the choice group. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' - summary: The options for the choice group. - name: options + type: string + - name: options + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' + package: '@microsoft/sp-property-pane!' fullName: options - langs: - - typeScript - type: property + summary: The options for the choice group. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'options: IPropertyPaneChoiceGroupOption[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options~0:complex' -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options~0:complex' - name: 'IPropertyPaneChoiceGroupOption[]' - fullName: 'IPropertyPaneChoiceGroupOption[]' - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - name: IPropertyPaneChoiceGroupOption - fullName: IPropertyPaneChoiceGroupOption - - name: '[]' - fullName: '[]' + type: >- + @microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps# diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index 1bb393d2..5938652d 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -1,79 +1,82 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - summary: Property pane conditional group. - name: IPropertyPaneConditionalGroup - fullName: IPropertyPaneConditionalGroup - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneConditionalGroup +uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneConditionalGroup +summary: Property pane conditional group. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: onShowPrimaryGroup + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' - summary: Callback when user clicks to show primary group. - name: onShowPrimaryGroup fullName: onShowPrimaryGroup - langs: - - typeScript - type: property + summary: Callback when user clicks to show primary group. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'onShowPrimaryGroup?: () => void;' return: - type: - - () => void - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' - summary: Callback when user clicks to show secondary group. - name: onShowSecondaryGroup + type: () => void + - name: onShowSecondaryGroup + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member + package: '@microsoft/sp-property-pane!' fullName: onShowSecondaryGroup - langs: - - typeScript - type: property + summary: Callback when user clicks to show secondary group. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'onShowSecondaryGroup?: () => void;' return: - type: - - () => void - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' - summary: Primary group to show - name: primaryGroup + type: () => void + - name: primaryGroup + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member + package: '@microsoft/sp-property-pane!' fullName: primaryGroup - langs: - - typeScript - type: property + summary: Primary group to show + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'primaryGroup: IPropertyPaneGroup;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' - summary: Secondary group to show - name: secondaryGroup + type: >- + + - name: secondaryGroup + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member + package: '@microsoft/sp-property-pane!' fullName: secondaryGroup - langs: - - typeScript - type: property + summary: Secondary group to show + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'secondaryGroup: IPropertyPaneGroup;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' - summary: Indicating whether the property pane should show primary group or the secondary group. - name: showSecondaryGroup + type: >- + + - name: showSecondaryGroup + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member + package: '@microsoft/sp-property-pane!' fullName: showSecondaryGroup - langs: - - typeScript - type: property + summary: >- + Indicating whether the property pane should show primary group or the + secondary group. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'showSecondaryGroup: boolean;' return: - type: - - boolean -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - name: IPropertyPaneGroup + type: boolean diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 9f8566b9..1765874c 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -1,110 +1,97 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - summary: Web part configuration settings - name: IPropertyPaneConfiguration - fullName: IPropertyPaneConfiguration - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneConfiguration +uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneConfiguration +summary: Web part configuration settings +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: currentPage + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' - summary: Page to be displayed on the PropertyPane. - name: currentPage fullName: currentPage - langs: - - typeScript - type: property + summary: Page to be displayed on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'currentPage?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' + type: number + - name: debounceProperties + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member + package: '@microsoft/sp-property-pane!' + fullName: debounceProperties summary: List of properties to debounce the `onPropertyPaneFieldChanged` event. remarks: >- - If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web - part properties. This may lead to jank for some property pane controls or web parts. You can use this - configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other - properties will be unaffected. + If your property pane is reactive, the `onPropertyPaneFieldChanged` event + will fire with any change to the web part properties. This may lead to + jank for some property pane controls or web parts. You can use this + configuration property to debounce the `onPropertyPaneFieldChanged` event + for the properties listed; other properties will be unaffected. isPreview: true - name: debounceProperties - fullName: debounceProperties - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' - summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. - remarks: The default value is 500. - name: loadingIndicatorDelayTime + type: >- + @microsoft/sp-property-pane!IPropertyPaneConfiguration# + - name: loadingIndicatorDelayTime + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member + package: '@microsoft/sp-property-pane!' fullName: loadingIndicatorDelayTime - langs: - - typeScript - type: property + summary: >- + Number of milliseconds to be delayed before the loading indicator is shown + on the property pane. + remarks: The default value is 500. + isPreview: false + isDeprecated: false syntax: content: 'loadingIndicatorDelayTime?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' - summary: Total number of pages on the PropertyPane. - name: pages + type: number + - name: pages + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' + package: '@microsoft/sp-property-pane!' fullName: pages - langs: - - typeScript - type: property + summary: Total number of pages on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'pages: IPropertyPanePage[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' - summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. + type: >- + @microsoft/sp-property-pane!IPropertyPaneConfiguration# + - name: showLoadingIndicator + uid: >- + @microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member + package: '@microsoft/sp-property-pane!' + fullName: showLoadingIndicator + summary: >- + Indicates whether the loading indicator should be displayed on top of the + property pane or not. remarks: >- - This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay - loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator - property). + This feature is intended to be used when the user is waiting on a promise + to resolve. If set to true, overlay loading indicator appears after 500ms + (web part author can override this behavior by using + overlayLoadingIndicator property). - The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in - real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - name: showLoadingIndicator - fullName: showLoadingIndicator - langs: - - typeScript - type: property + The reason why we are not showing it immediately is that our intent is to + never show the loading indicator. But in real life async requests could + take long and it becomes necessary to display a loading indicator to the + end user. + isPreview: false + isDeprecated: false syntax: content: 'showLoadingIndicator?: boolean;' return: - type: - - boolean -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties~0:complex' - name: 'IPropertyPaneDebounceProperty[]' - fullName: 'IPropertyPaneDebounceProperty[]' - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - name: IPropertyPaneDebounceProperty - fullName: IPropertyPaneDebounceProperty - - name: '[]' - fullName: '[]' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages~0:complex' - name: 'IPropertyPanePage[]' - fullName: 'IPropertyPanePage[]' - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' - name: IPropertyPanePage - fullName: IPropertyPanePage - - name: '[]' - fullName: '[]' + type: boolean diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index b76385f7..b4975380 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -1,104 +1,82 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - summary: PropertyPane CustomPropertyField props. - name: IPropertyPaneCustomFieldProps - fullName: IPropertyPaneCustomFieldProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneCustomFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneCustomFieldProps +summary: PropertyPane CustomPropertyField props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: context + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' - summary: >- - Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web - part can use this context to manage state information. - name: context fullName: context - langs: - - typeScript - type: property + summary: >- + Instance specific context. This context is passed back to the web part in + the onRender and onDispose APIs. The web part can use this context to + manage state information. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'context?: any;' return: - type: - - any - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' + type: any + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' + package: '@microsoft/sp-property-pane!' + fullName: key summary: >- An UNIQUE key indicates the identity of this contorl. - The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should - be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how - to pick the value of the key. + The PropertyPane uses ReactJS to render its components. ReactJS uses keys + to identify a component and if it should be re-rendered or not. This is a + performance feature in ReactJS. Please read the following link to + understand how to pick the value of the key. - For more information, see the [React - documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). - name: key - fullName: key - langs: - - typeScript - type: property + For more information, see the [React documentation](.github.io/react/docs/lists-and-keys.html#keys)<!-- -->. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'key: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' - summary: This API is called when the component is unmounted from the host element. - name: onDispose + type: string + - name: onDispose + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' + package: '@microsoft/sp-property-pane!' fullName: onDispose - langs: - - typeScript - type: property + summary: This API is called when the component is unmounted from the host element. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' - summary: This API will be called once the custom field is mounted on the host element. - name: onRender + type: >- + @microsoft/sp-property-pane!IPropertyPaneCustomFieldProps# + - name: onRender + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' + package: '@microsoft/sp-property-pane!' fullName: onRender - langs: - - typeScript - type: property + summary: >- + This API will be called once the custom field is mounted on the host + element. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: >- - onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => - void) => void; + onRender: (domElement: HTMLElement, context?: any, changeCallback?: + (targetProperty?: string, newValue?: any) => void) => void; return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender~0:complex' -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose~0:complex' - name: '(domElement: HTMLElement, context?: any) => void' - fullName: '(domElement: HTMLElement, context?: any) => void' - spec.typeScript: - - name: '(domElement: ' - fullName: '(domElement: ' - - uid: '!HTMLElement:interface' - name: HTMLElement - fullName: HTMLElement - - name: ', context?: any) => void' - fullName: ', context?: any) => void' - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender~0:complex' - name: >- - (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => - void - fullName: >- - (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => - void - spec.typeScript: - - name: '(domElement: ' - fullName: '(domElement: ' - - uid: '!HTMLElement:interface' - name: HTMLElement - fullName: HTMLElement - - name: ', context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void' - fullName: ', context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void' + type: >- + @microsoft/sp-property-pane!IPropertyPaneCustomFieldProps# diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index bdf4d9f5..0621253f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -1,43 +1,41 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' - isPreview: true - name: IPropertyPaneDebounceProperty - fullName: IPropertyPaneDebounceProperty - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDebounceProperty +uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDebounceProperty +summary: >- + Definition of a Property Pane property, which should have the + `onPropertyPaneFieldChanged` event be debounced. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: debouncePeriod + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' - - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' + fullName: debouncePeriod summary: >- - Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired - for this property. + Number of milliseconds to delay the next `onPropertyPaneFieldChanged` + event since the last time the event fired for this property. remarks: The default value is 500. isPreview: true - name: debouncePeriod - fullName: debouncePeriod - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'debouncePeriod?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' + type: number + - name: propertyName + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member + package: '@microsoft/sp-property-pane!' + fullName: propertyName summary: Property to debounce. + remarks: '' isPreview: true - name: propertyName - fullName: propertyName - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'propertyName: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index 3141d69c..37222b9a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -1,24 +1,26 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - summary: PropertyPane dropdown callout properties. - name: IPropertyPaneDropdownCalloutProps - fullName: IPropertyPaneDropdownCalloutProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDropdownCalloutProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDropdownCalloutProps +summary: PropertyPane dropdown callout properties. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: calloutMaxHeight + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' - summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen - name: calloutMaxHeight fullName: calloutMaxHeight - langs: - - typeScript - type: property + summary: >- + Set max height of callout When not set the callout will expand with + contents up to the bottom of the screen + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'calloutMaxHeight?: number;' return: - type: - - number + type: number diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index e4ce9296..33e20434 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -1,66 +1,64 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - summary: PropertyPane drop down options. - name: IPropertyPaneDropdownOption - fullName: IPropertyPaneDropdownOption - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDropdownOption +uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDropdownOption +summary: PropertyPane drop down options. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: index + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' - summary: Index for this option. - name: index fullName: index - langs: - - typeScript - type: property + summary: Index for this option. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'index?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' - summary: A key to uniquely identify this option. - name: key + type: number + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' + package: '@microsoft/sp-property-pane!' fullName: key - langs: - - typeScript - type: property + summary: A key to uniquely identify this option. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'key: string | number;' return: - type: - - string | number - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' - summary: Text to render for this option. - name: text + type: string | number + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' + package: '@microsoft/sp-property-pane!' fullName: text - langs: - - typeScript - type: property + summary: Text to render for this option. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'text: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' - summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' - name: type + type: string + - name: type + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' + package: '@microsoft/sp-property-pane!' fullName: type - langs: - - typeScript - type: property + summary: >- + The type of option. If omitted, the default is + PropertyPaneDropdownMenuItemType.Normal + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'type?: PropertyPaneDropdownOptionType;' return: - type: - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' -references: - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - name: PropertyPaneDropdownOptionType + type: >- + diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index 64c61ce0..a4e673b3 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -1,143 +1,129 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - summary: PropertyPane drop down component props. - name: IPropertyPaneDropdownProps - fullName: IPropertyPaneDropdownProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDropdownProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDropdownProps +summary: PropertyPane drop down component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' - summary: A description of the dropdown for the benefit of screen reader users. - name: ariaLabel fullName: ariaLabel - langs: - - typeScript - type: property + summary: A description of the dropdown for the benefit of screen reader users. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' - summary: >- - Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It - starts from 1. - name: ariaPositionInSet + type: string + - name: ariaPositionInSet + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member + package: '@microsoft/sp-property-pane!' fullName: ariaPositionInSet - langs: - - typeScript - type: property + summary: >- + Defines an element's number or position in the current set of controls. + Maps to native aria-posinset attribute. It starts from 1. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaPositionInSet?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' - summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. - name: ariaSetSize + type: number + - name: ariaSetSize + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' + package: '@microsoft/sp-property-pane!' fullName: ariaSetSize - langs: - - typeScript - type: property + summary: >- + Defines the number of items in the current set of controls. Maps to native + aria-setsize attribute. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaSetSize?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' - summary: Custom properties for Dropdown's Callout used to render options. - name: calloutProps + type: number + - name: calloutProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' + package: '@microsoft/sp-property-pane!' fullName: calloutProps - langs: - - typeScript - type: property + summary: Custom properties for Dropdown's Callout used to render options. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' - summary: Whether the property pane dropdown option is disabled or not. - name: disabled + type: >- + + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Whether the property pane dropdown option is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' + type: boolean + - name: errorMessage + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' + package: '@microsoft/sp-property-pane!' + fullName: errorMessage summary: 'If set, this will be displayed as an error message.' + remarks: '' isPreview: true - name: errorMessage - fullName: errorMessage - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'errorMessage?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' - summary: Descriptive label for the Dropdown. - name: label + type: string + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' + package: '@microsoft/sp-property-pane!' fullName: label - langs: - - typeScript - type: property + summary: Descriptive label for the Dropdown. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' - summary: Collection of options for this Dropdown. - name: options + type: string + - name: options + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' + package: '@microsoft/sp-property-pane!' fullName: options - langs: - - typeScript - type: property + summary: Collection of options for this Dropdown. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'options?: IPropertyPaneDropdownOption[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' - summary: The key of the initially selected option. - name: selectedKey + type: >- + @microsoft/sp-property-pane!IPropertyPaneDropdownProps# + - name: selectedKey + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' + package: '@microsoft/sp-property-pane!' fullName: selectedKey - langs: - - typeScript - type: property + summary: The key of the initially selected option. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'selectedKey?: string | number;' return: - type: - - string | number -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - name: IPropertyPaneDropdownCalloutProps - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options~0:complex' - name: 'IPropertyPaneDropdownOption[]' - fullName: 'IPropertyPaneDropdownOption[]' - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownOption - fullName: IPropertyPaneDropdownOption - - name: '[]' - fullName: '[]' + type: string | number diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index 86d3e22a..690f926d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -1,78 +1,79 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - summary: PropertyPaneDynamicField props. - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDynamicFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicFieldProps +summary: PropertyPaneDynamicField props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filters + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' - summary: Filters for the property pane dynamic field. - name: filters fullName: filters - langs: - - typeScript - type: property + summary: Filters for the property pane dynamic field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'filters?: IPropertyPaneDynamicFieldFilters;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' - summary: 'User-friendly, localized label to identify the field.' - name: label + type: >- + + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' + package: '@microsoft/sp-property-pane!' fullName: label - langs: - - typeScript - type: property + summary: 'User-friendly, localized label to identify the field.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' - summary: |- - Indicates to what depth of property values are shown on the property pane dynamic data widget. + type: string + - name: propertyValueDepth + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member + package: '@microsoft/sp-property-pane!' + fullName: propertyValueDepth + summary: >- + Indicates to what depth of property values are shown on the property pane + dynamic data widget. + If not specified, then max of 2 levels of property value will be shown. remarks: >- - It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only - source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., - the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two - levels of property value will be shown i.e., the widget will display two levels after the source and property for - this field. - name: propertyValueDepth - fullName: propertyValueDepth - langs: - - typeScript - type: property + It takes following values - - 0: Indicates that no property value will be + shown i.e., the widget will display only source and property for this + field. - 1: Indicates that a depth of one level of property value will be + shown i.e., the widget will display one level after the source and + property for this field. - 2: Indicates that a depth of two levels of + property value will be shown i.e., the widget will display two levels + after the source and property for this field. + isPreview: false + isDeprecated: false syntax: content: 'propertyValueDepth?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' + type: number + - name: sourcesLabel + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member + package: '@microsoft/sp-property-pane!' + fullName: sourcesLabel summary: |- User-friendly, localized label for the sources dropdown. default value - 'Connect to source' - name: sourcesLabel - fullName: sourcesLabel - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'sourcesLabel?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - name: IPropertyPaneDynamicFieldFilters + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index ed219f04..208c74b6 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -1,48 +1,52 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - summary: PropertyPane DynamicFieldSet props. - name: IPropertyPaneDynamicFieldSetProps - fullName: IPropertyPaneDynamicFieldSetProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDynamicFieldSetProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicFieldSetProps +summary: PropertyPane DynamicFieldSet props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fields + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' - summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. - name: fields fullName: fields - langs: - - typeScript - type: property + summary: >- + List of property pane dynamic fields to be configured on the Dynamic Data + Widget. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'fields: IPropertyPaneField[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' - summary: 'User-friendly, localized label to identify the property.' - name: label + type: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps# + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' + package: '@microsoft/sp-property-pane!' fullName: label - langs: - - typeScript - type: property + summary: 'User-friendly, localized label to identify the property.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' - summary: Configuration shared between all the entries of the set. - name: sharedConfiguration + type: string + - name: sharedConfiguration + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member + package: '@microsoft/sp-property-pane!' fullName: sharedConfiguration - langs: - - typeScript - type: property + summary: Configuration shared between all the entries of the set. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: |- sharedConfiguration?: { @@ -51,67 +55,6 @@ items: property?: IDynamicDataSharedPropertyConfiguration; }; return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration~0:complex' -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields~0:complex' - name: 'IPropertyPaneField[]' - fullName: 'IPropertyPaneField[]' - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps - - name: '>[]' - fullName: '>[]' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration~0:complex' - name: |- - { - depth: DynamicDataSharedDepth; - source?: IDynamicDataSharedSourceConfiguration; - property?: IDynamicDataSharedPropertyConfiguration; - } - fullName: |- - { - depth: DynamicDataSharedDepth; - source?: IDynamicDataSharedSourceConfiguration; - property?: IDynamicDataSharedPropertyConfiguration; - } - spec.typeScript: - - name: |- - { - depth: - fullName: |- - { - depth: - - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - name: DynamicDataSharedDepth - fullName: DynamicDataSharedDepth - - name: |- - ; - source?: - fullName: |- - ; - source?: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceConfiguration - fullName: IDynamicDataSharedSourceConfiguration - - name: |- - ; - property?: - fullName: |- - ; - property?: - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - name: IDynamicDataSharedPropertyConfiguration - fullName: IDynamicDataSharedPropertyConfiguration - - name: |- - ; - } - fullName: |- - ; - } + type: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps# diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index c44d4bcc..b0b36abd 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -1,188 +1,174 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - summary: '`PropertyPaneDynamicData` component props.' - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: IPropertyPaneDynamicTextFieldProps - fullName: IPropertyPaneDynamicTextFieldProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneDynamicTextFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicTextFieldProps +summary: '`PropertyPaneDynamicData` component props.' +remarks: '' +isPreview: true +isDeprecated: true +customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' +type: interface +properties: + - name: ariaLabel + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' + fullName: ariaLabel summary: 'ARIA Label for text field, if any.' + remarks: '' isPreview: true - name: ariaLabel - fullName: ariaLabel - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'ariaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' + type: string + - name: description + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member + package: '@microsoft/sp-property-pane!' + fullName: description summary: The text field input description. + remarks: '' isPreview: true - name: description - fullName: description - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'description?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' + type: string + - name: disabled + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member + package: '@microsoft/sp-property-pane!' + fullName: disabled summary: Whether the property pane text field is enabled or not. + remarks: '' isPreview: true - name: disabled - fullName: disabled - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' + type: boolean + - name: errorMessage + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member + package: '@microsoft/sp-property-pane!' + fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: >- - When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the - error message. + When `onGetErrorMessage` returns empty string, if this property has a + value set then this will be displayed as the error message. - Make sure to set this only if you want to see an error message displayed for the text field. + Make sure to set this only if you want to see an error message displayed + for the text field. isPreview: true - name: errorMessage - fullName: errorMessage - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'errorMessage?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' + type: string + - name: label + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member + package: '@microsoft/sp-property-pane!' + fullName: label summary: Label for the text field. + remarks: '' isPreview: true - name: label - fullName: label - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'label?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' - summary: This method is used to get the validation error message and determine whether the input value is valid or not. - remarks: |- + type: string + - name: onGetErrorMessage + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member + package: '@microsoft/sp-property-pane!' + fullName: onGetErrorMessage + summary: >- + This method is used to get the validation error message and determine + whether the input value is valid or not. + remarks: >- When it returns string: + - If valid, it returns empty string. - - If invalid, it returns the error message string and an error message is displayed below the text field. + + - If invalid, it returns the error message string and an error message is + displayed below the text field. + When it returns `Promise`: + - The resolved value is display as error message. + - The rejected, the value is thrown away. isPreview: true - name: onGetErrorMessage - fullName: onGetErrorMessage - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' + type: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps# + - name: placeholder + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member + package: '@microsoft/sp-property-pane!' + fullName: placeholder summary: Placeholder text to be displayed in the text field. + remarks: '' isPreview: true - name: placeholder - fullName: placeholder - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'placeholder?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' + type: string + - name: validateOnFocusIn + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. isPreview: true - name: validateOnFocusIn - fullName: validateOnFocusIn - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'validateOnFocusIn?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' - summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. + type: boolean + - name: validateOnFocusOut + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusOut + summary: >- + Run validation when the `PropertyPaneTextField` is out of focus or on + blur. remarks: The default value is false. isPreview: true - name: validateOnFocusOut - fullName: validateOnFocusOut - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'validateOnFocusOut?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' + type: boolean + - name: value + uid: >- + @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member + package: '@microsoft/sp-property-pane!' + fullName: value summary: >- - Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is - empty or contains null value. + Value to be displayed in the text field when the value of the + targetProperty in the manifest's property bag is empty or contains null + value. + remarks: '' isPreview: true - name: value - fullName: value - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'value?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage~0:complex' - name: '(value: string) => string | Promise' - fullName: '(value: string) => string | Promise' - spec.typeScript: - - name: '(value: string) => string | ' - fullName: '(value: string) => string | ' - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 6d89d875..e0b9674a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -1,71 +1,59 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - summary: PropertyPane field. - name: IPropertyPaneField - fullName: IPropertyPaneField - langs: - - typeScript - type: interface - syntax: - typeParameters: - - id: TProperties +### YamlMime:TSType +name: IPropertyPaneField +uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneField +summary: PropertyPane field. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: properties + uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' - - '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' - - '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' - - '@microsoft/sp-property-pane!IPropertyPaneField#type:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' + fullName: properties summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - name: properties - fullName: properties - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'properties: TProperties;' return: - type: - - TProperties - - uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' + type: TProperties + - name: shouldFocus + uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' + package: '@microsoft/sp-property-pane!' + fullName: shouldFocus summary: Whether this control should be focused. remarks: The default value is false. - name: shouldFocus - fullName: shouldFocus - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'shouldFocus?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' - summary: Target property from the web part's property bag. - name: targetProperty + type: boolean + - name: targetProperty + uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' + package: '@microsoft/sp-property-pane!' fullName: targetProperty - langs: - - typeScript - type: property + summary: Target property from the web part's property bag. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'targetProperty: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' - summary: Type of the PropertyPane field. - name: type + type: string + - name: type + uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' + package: '@microsoft/sp-property-pane!' fullName: type - langs: - - typeScript - type: property + summary: Type of the PropertyPane field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'type: PropertyPaneFieldType;' return: - type: - - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' -references: - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' - name: PropertyPaneFieldType + type: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 80c86228..1c226576 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -1,62 +1,51 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - summary: PropertyPane group. Group is part of the PropertyPanePage. - name: IPropertyPaneGroup - fullName: IPropertyPaneGroup - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneGroup +uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneGroup +summary: PropertyPane group. Group is part of the PropertyPanePage. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: groupFields + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' - - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' - - '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' - summary: List of PropertyPane fields. - name: groupFields fullName: groupFields - langs: - - typeScript - type: property + summary: List of PropertyPane fields. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'groupFields: IPropertyPaneField[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' - summary: Display name for the group. - remarks: 'For performance reasons, it''s highly recommended to keep this name unique within the property pane page.' - name: groupName + type: >- + @microsoft/sp-property-pane!IPropertyPaneGroup# + - name: groupName + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' + package: '@microsoft/sp-property-pane!' fullName: groupName - langs: - - typeScript - type: property + summary: Display name for the group. + remarks: >- + For performance reasons, it's highly recommended to keep this name unique + within the property pane page. + isPreview: false + isDeprecated: false syntax: content: 'groupName?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' + type: string + - name: isCollapsed + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' + package: '@microsoft/sp-property-pane!' + fullName: isCollapsed summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. - name: isCollapsed - fullName: isCollapsed - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'isCollapsed?: boolean;' return: - type: - - boolean -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields~0:complex' - name: 'IPropertyPaneField[]' - fullName: 'IPropertyPaneField[]' - spec.typeScript: - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: '[]' - fullName: '[]' + type: boolean diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index 71f03713..f2975965 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -1,38 +1,37 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - summary: PropertyPaneLabel component props. - name: IPropertyPaneLabelProps - fullName: IPropertyPaneLabelProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneLabelProps +uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneLabelProps +summary: PropertyPaneLabel component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: required + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' - - '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' - summary: Whether the associated form field is required or not. - remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - name: required fullName: required - langs: - - typeScript - type: property + summary: Whether the associated form field is required or not. + remarks: >- + If true, a red asterisk is displayed to the right of the label. Default + value is false. + isPreview: false + isDeprecated: false syntax: content: 'required?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' - summary: Display text fot the label. - name: text + type: boolean + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' + package: '@microsoft/sp-property-pane!' fullName: text - langs: - - typeScript - type: property + summary: Display text fot the label. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'text: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 2cc978af..230206c2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -1,56 +1,54 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - summary: PropertyPaneLink component props. - name: IPropertyPaneLinkProps - fullName: IPropertyPaneLinkProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneLinkProps +uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneLinkProps +summary: PropertyPaneLink component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' - summary: Whether the property pane link is disabled or not. - name: disabled fullName: disabled - langs: - - typeScript - type: property + summary: Whether the property pane link is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' - summary: Location to which the link is targeted to. - name: href + type: boolean + - name: href + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' + package: '@microsoft/sp-property-pane!' fullName: href - langs: - - typeScript - type: property + summary: Location to which the link is targeted to. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'href: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' - summary: The props of pop up window. - name: popupWindowProps + type: string + - name: popupWindowProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' + package: '@microsoft/sp-property-pane!' fullName: popupWindowProps - langs: - - typeScript - type: property + summary: The props of pop up window. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'popupWindowProps?: IPopupWindowProps;' return: - type: - - '@microsoft/sp-property-pane!IPopupWindowProps:interface' - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' + type: '' + - name: target + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' + package: '@microsoft/sp-property-pane!' + fullName: target summary: This attribute specifies where to display the linked resource. remarks: >- Following values can be used: @@ -62,33 +60,26 @@ items: \_blank - Load the response into a new unnamed tab. - \_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same - as "\_self" + \_parent - Load the response in the parent of the current page. If no + parent exists, then this option behaves same as "\_self" \_top - Load the response into the original window. - name: target - fullName: target - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'target?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' - summary: Display text for the link. - name: text + type: string + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' + package: '@microsoft/sp-property-pane!' fullName: text - langs: - - typeScript - type: property + summary: Display text for the link. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'text: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' - name: IPopupWindowProps + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index f47fb329..250024ca 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -1,69 +1,54 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' - summary: PropertyPanePage interface. - name: IPropertyPanePage - fullName: IPropertyPanePage - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPanePage +uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPanePage +summary: PropertyPanePage interface. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: displayGroupsAsAccordion + uid: >- + @microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' - - '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' - - '@microsoft/sp-property-pane!IPropertyPanePage#header:member' - - uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' - summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. - name: displayGroupsAsAccordion fullName: displayGroupsAsAccordion - langs: - - typeScript - type: property + summary: >- + Indicates whether the groups on the PropertyPanePage are displayed as + accordion or not. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'displayGroupsAsAccordion?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' - summary: List of groups to be displayed on the PropertyPane page. - name: groups + type: boolean + - name: groups + uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' + package: '@microsoft/sp-property-pane!' fullName: groups - langs: - - typeScript - type: property + summary: List of groups to be displayed on the PropertyPane page. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' return: - type: - - '@microsoft/sp-property-pane!IPropertyPanePage#groups~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' - summary: PropertyPane page header. - name: header + type: >- + @microsoft/sp-property-pane!IPropertyPanePage# + - name: header + uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' + package: '@microsoft/sp-property-pane!' fullName: header - langs: - - typeScript - type: property + summary: PropertyPane page header. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'header?: IPropertyPanePageHeader;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' -references: - - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups~0:complex' - name: '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' - fullName: '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' - spec.typeScript: - - name: ( - fullName: ( - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - name: IPropertyPaneGroup - fullName: IPropertyPaneGroup - - name: ' | ' - fullName: ' | ' - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - name: IPropertyPaneConditionalGroup - fullName: IPropertyPaneConditionalGroup - - name: ')[]' - fullName: ')[]' - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - name: IPropertyPanePageHeader + type: >- + diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index e99406e0..cdde7863 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -1,37 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - summary: PropertyPane header. This header remains same for all the pages. - name: IPropertyPanePageHeader - fullName: IPropertyPanePageHeader - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPanePageHeader +uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPanePageHeader +summary: PropertyPane header. This header remains same for all the pages. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' - - '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' - summary: Header to display. - name: description fullName: description - langs: - - typeScript - type: property + summary: Header to display. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'description: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' - summary: Image url for the background image. - name: image + type: string + - name: image + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' + package: '@microsoft/sp-property-pane!' fullName: image - langs: - - typeScript - type: property + summary: Image url for the background image. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'image?: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index 91e02b60..9c48e2c3 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -1,140 +1,135 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - summary: PropertyPaneSliderProps component props. - name: IPropertyPaneSliderProps - fullName: IPropertyPaneSliderProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneSliderProps +uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneSliderProps +summary: PropertyPaneSliderProps component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' - summary: A description of the Slider for the benefit of screen readers. - name: ariaLabel fullName: ariaLabel - langs: - - typeScript - type: property + summary: A description of the Slider for the benefit of screen readers. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' - summary: Whether or not the Slider is disabled. - name: disabled + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Whether or not the Slider is disabled. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' - summary: Description label of the Slider. - name: label + type: boolean + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' + package: '@microsoft/sp-property-pane!' fullName: label - langs: - - typeScript - type: property + summary: Description label of the Slider. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' - summary: The max value of the Slider. - name: max + type: string + - name: max + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' + package: '@microsoft/sp-property-pane!' fullName: max - langs: - - typeScript - type: property + summary: The max value of the Slider. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'max: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' - summary: The min value of the Slider. - name: min + type: number + - name: min + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' + package: '@microsoft/sp-property-pane!' fullName: min - langs: - - typeScript - type: property + summary: The min value of the Slider. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'min: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' - summary: Whether to show the value on the right of the Slider. - remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - name: showValue + type: number + - name: showValue + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' + package: '@microsoft/sp-property-pane!' fullName: showValue - langs: - - typeScript - type: property + summary: Whether to show the value on the right of the Slider. + remarks: >- + If you want to show the value by yourself, you may want to set this value + to false. + isPreview: false + isDeprecated: false syntax: content: 'showValue?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' - summary: The difference between the two adjacent values of the Slider. Defaults to 1. - name: step + type: boolean + - name: step + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' + package: '@microsoft/sp-property-pane!' fullName: step - langs: - - typeScript - type: property + summary: >- + The difference between the two adjacent values of the Slider. Defaults to + 1. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'step?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' - summary: |- - The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. + type: number + - name: value + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' + package: '@microsoft/sp-property-pane!' + fullName: value + summary: >- + The initial value of the Slider. Use this if you intend to pass in a new + value as a result of onChange events. + Defaults to min. - name: value - fullName: value - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'value?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' + type: number + - name: valueFormat + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' + package: '@microsoft/sp-property-pane!' + fullName: valueFormat summary: |- Callback to format the Slider value. For example, if ```typescript - (value) => `${value}%` + (value) => `${value}%` ``` is specified, the value of the Slider has % after it. + remarks: '' isPreview: true - name: valueFormat - fullName: valueFormat - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'valueFormat?: (value: number) => string;' return: - type: - - '(value: number) => string' + type: '(value: number) => string' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index bee09b6a..875b350b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -1,138 +1,130 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - summary: PropertyPaneTextField component props. - name: IPropertyPaneTextFieldProps - fullName: IPropertyPaneTextFieldProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneTextFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneTextFieldProps +summary: PropertyPaneTextField component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' - summary: 'Aria Label for text field, if any.' - name: ariaLabel fullName: ariaLabel - langs: - - typeScript - type: property + summary: 'Aria Label for text field, if any.' + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'ariaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' - summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. - remarks: The default value is 200. - name: deferredValidationTime + type: string + - name: deferredValidationTime + uid: >- + @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member + package: '@microsoft/sp-property-pane!' fullName: deferredValidationTime - langs: - - typeScript - type: property + summary: >- + Text field will start to validate after users stop typing for + `deferredValidationTime` milliseconds. + remarks: The default value is 200. + isPreview: false + isDeprecated: false syntax: content: 'deferredValidationTime?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' - summary: The text field input description. - name: description + type: number + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' + package: '@microsoft/sp-property-pane!' fullName: description - langs: - - typeScript - type: property + summary: The text field input description. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'description?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' - summary: Whether the property pane text field is enabled or not. - name: disabled + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Whether the property pane text field is enabled or not. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' + type: boolean + - name: errorMessage + uid: >- + @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member + package: '@microsoft/sp-property-pane!' + fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: >- - When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the - error message. + When onGetErrorMessage returns empty string, if this property has a value + set then this will be displayed as the error message. - So, make sure to set this only if you want to see an error message displayed for the text field. - name: errorMessage - fullName: errorMessage - langs: - - typeScript - type: property + So, make sure to set this only if you want to see an error message + displayed for the text field. + isPreview: false + isDeprecated: false syntax: content: 'errorMessage?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' - summary: Label for the text field. - name: label + type: string + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' + package: '@microsoft/sp-property-pane!' fullName: label - langs: - - typeScript - type: property + summary: Label for the text field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' - summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. + type: string + - name: logName + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' + package: '@microsoft/sp-property-pane!' + fullName: logName + summary: >- + Name used to log `PropertyPaneTextField` value changes for engagement + tracking. remarks: >- - The messages will be logged with a format such as `.`. + The messages will be logged with a format such as + `.`. - For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might - contain: + For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` + is specified, the engagement log might contain: 1. The action type: - `Add`: change from initial/unset state to customized content. (first edit) + `Add`: change from initial/unset state to customized content. + (first edit) - `Clear`: reset the content of caption element to initial/unset state. + `Clear`: reset the content of caption element to initial/unset + state. - `Edit`: any edition that changes the content apart from add and clear + `Edit`: any edition that changes the content apart from add and + clear 2. The text length after each edit - name: logName - fullName: logName - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: |- logName?: { @@ -140,162 +132,157 @@ items: controlName: string; }; return: - type: - - |- - { - moduleName: string; - controlName: string; - } - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' + type: |- + { + moduleName: string; + controlName: string; + } + - name: maxLength + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' + package: '@microsoft/sp-property-pane!' + fullName: maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' - name: maxLength - fullName: maxLength - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'maxLength?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' + type: number + - name: multiline + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' + package: '@microsoft/sp-property-pane!' + fullName: multiline summary: Whether or not the text field is a multiline text field. remarks: The default value is false. - name: multiline - fullName: multiline - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'multiline?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' - summary: The method is used to get the validation error message and determine whether the input value is valid or not. - remarks: |- + type: boolean + - name: onGetErrorMessage + uid: >- + @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member + package: '@microsoft/sp-property-pane!' + fullName: onGetErrorMessage + summary: >- + The method is used to get the validation error message and determine + whether the input value is valid or not. + remarks: >- When it returns string: + - If valid, it returns empty string. - - If invalid, it returns the error message string and an error message is displayed below the text field. + + - If invalid, it returns the error message string and an error message is + displayed below the text field. + When it returns `Promise`: + - The resolved value is display as error message. + - The rejected, the value is thrown away. - name: onGetErrorMessage - fullName: onGetErrorMessage - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' - summary: placeholder text to be displayed in the text field. - name: placeholder + type: >- + @microsoft/sp-property-pane!IPropertyPaneTextFieldProps# + - name: placeholder + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' + package: '@microsoft/sp-property-pane!' fullName: placeholder - langs: - - typeScript - type: property + summary: placeholder text to be displayed in the text field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'placeholder?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' + type: string + - name: resizable + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' + package: '@microsoft/sp-property-pane!' + fullName: resizable summary: Whether or not the multiline text field is resizable. remarks: The default value is true. - name: resizable - fullName: resizable - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'resizable?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' - summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' - remarks: This prop is used only when the multiline prop is set to true. - name: rows + type: boolean + - name: rows + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' + package: '@microsoft/sp-property-pane!' fullName: rows - langs: - - typeScript - type: property + summary: >- + Specifies the visible height of a text area(multiline text TextField), in + lines. + remarks: This prop is used only when the multiline prop is set to true. + isPreview: false + isDeprecated: false syntax: content: 'rows?: number;' return: - type: - - number - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' + type: number + - name: underlined + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' + package: '@microsoft/sp-property-pane!' + fullName: underlined summary: Whether or not the text field is underlined. remarks: The default value is false. - name: underlined - fullName: underlined - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'underlined?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' + type: boolean + - name: validateOnFocusIn + uid: >- + @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - name: validateOnFocusIn - fullName: validateOnFocusIn - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'validateOnFocusIn?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' + type: boolean + - name: validateOnFocusOut + uid: >- + @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusOut summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. - name: validateOnFocusOut - fullName: validateOnFocusOut - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'validateOnFocusOut?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' - summary: >- - Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is - empty or contains null value. - name: value + type: boolean + - name: value + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' + package: '@microsoft/sp-property-pane!' fullName: value - langs: - - typeScript - type: property + summary: >- + Value to be displayed in the text field when the value of the + targetProperty in the manifest's property bag is empty or contains null + value. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'value?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage~0:complex' - name: '(value: string) => string | Promise' - fullName: '(value: string) => string | Promise' - spec.typeScript: - - name: '(value: string) => string | ' - fullName: '(value: string) => string | ' - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index fe3685e0..e7f46157 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -1,126 +1,113 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - summary: PropertyPaneToggle component props. - name: IPropertyPaneToggleProps - fullName: IPropertyPaneToggleProps - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IPropertyPaneToggleProps +uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneToggleProps +summary: PropertyPaneToggle component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: checked + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' + fullName: checked summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' - name: checked - fullName: checked - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'checked?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' - summary: Optional disabled flag. - name: disabled + type: boolean + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' + package: '@microsoft/sp-property-pane!' fullName: disabled - langs: - - typeScript - type: property + summary: Optional disabled flag. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'disabled?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' - summary: A key to uniquely identify the field. - name: key + type: boolean + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' + package: '@microsoft/sp-property-pane!' fullName: key - langs: - - typeScript - type: property + summary: A key to uniquely identify the field. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'key?: string | number;' return: - type: - - string | number - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' - summary: A label for the toggle. - name: label + type: string | number + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' + package: '@microsoft/sp-property-pane!' fullName: label - langs: - - typeScript - type: property + summary: A label for the toggle. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'label: string | JSX.Element;' return: - type: - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label~0:complex' - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' - summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. - name: offAriaLabel + type: >- + @microsoft/sp-property-pane!IPropertyPaneToggleProps# + - name: offAriaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' + package: '@microsoft/sp-property-pane!' fullName: offAriaLabel - langs: - - typeScript - type: property + summary: >- + Optional offAriaLabel flag. Text for screen-reader to announce when toggle + is OFF. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'offAriaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' - summary: Test display when toggle is OFF. - name: offText + type: string + - name: offText + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' + package: '@microsoft/sp-property-pane!' fullName: offText - langs: - - typeScript - type: property + summary: Test display when toggle is OFF. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'offText?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' - summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. - name: onAriaLabel + type: string + - name: onAriaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' + package: '@microsoft/sp-property-pane!' fullName: onAriaLabel - langs: - - typeScript - type: property + summary: >- + Optional onAriaLabel flag. Text for screen-reader to announce when toggle + is ON. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'onAriaLabel?: string;' return: - type: - - string - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' - summary: Text to display when toggle is ON. - name: onText + type: string + - name: onText + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' + package: '@microsoft/sp-property-pane!' fullName: onText - langs: - - typeScript - type: property + summary: Text to display when toggle is ON. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'onText?: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label~0:complex' - name: string | JSX.Element - fullName: string | __global.JSX.Element - spec.typeScript: - - name: 'string | ' - fullName: 'string | ' - - uid: '@types/react!~__global.JSX.Element:interface' - name: JSX.Element - fullName: __global.JSX.Element + type: string diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index 32fc2c01..743b5280 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -1,56 +1,35 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' - summary: The position of pop up window. - name: PopupWindowPosition - fullName: PopupWindowPosition - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: PopupWindowPosition +uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' +package: '@microsoft/sp-property-pane!' +fullName: PopupWindowPosition +summary: The position of pop up window. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: center + uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!PopupWindowPosition.center:member' - - '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' - - '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' - - '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' - - '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' - - uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' summary: PopupWindowPosition would be located in center of screen. - name: center - fullName: center - langs: - - typeScript - type: field numericValue: '0' - - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' + - name: leftBottom + uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' + package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in left bottom of screen. - name: leftBottom - fullName: leftBottom - langs: - - typeScript - type: field numericValue: '4' - - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' + - name: leftTop + uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' + package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in left top of screen. - name: leftTop - fullName: leftTop - langs: - - typeScript - type: field numericValue: '2' - - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' + - name: rightBottom + uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' + package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in right bottom of screen. - name: rightBottom - fullName: rightBottom - langs: - - typeScript - type: field numericValue: '3' - - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' + - name: rightTop + uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' + package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in right top of screen. - name: rightTop - fullName: rightTop - langs: - - typeScript - type: field numericValue: '1' diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index c9f81d55..f29d32e0 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -1,84 +1,42 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - summary: Enum for all the supported button types. - name: PropertyPaneButtonType - fullName: PropertyPaneButtonType - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: PropertyPaneButtonType +uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' +package: '@microsoft/sp-property-pane!' +fullName: PropertyPaneButtonType +summary: Enum for all the supported button types. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Command + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' - - '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' - - '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' - - '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' - - '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' - - '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' summary: Optional actions. - remarks: >- - Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command - bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts. - name: Command - fullName: Command - langs: - - typeScript - type: field numericValue: '4' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' + - name: Compound + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' + package: '@microsoft/sp-property-pane!' summary: Always used as a set with both Standard and Primary compound buttons. - remarks: >- - Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with - a possible significant time investment such as an email or a complex form - name: Compound - fullName: Compound - langs: - - typeScript - type: field numericValue: '3' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' + - name: Hero + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' + package: '@microsoft/sp-property-pane!' summary: Hero button. - name: Hero - fullName: Hero - langs: - - typeScript - type: field numericValue: '2' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' + - name: Icon + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' + package: '@microsoft/sp-property-pane!' summary: >- - Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within - the command bar. - remarks: >- - Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: - OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In - SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In - SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the - bottom of an event creation Callout when clicking inside an empty time range. - name: Icon - fullName: Icon - langs: - - typeScript - type: field + Same usage as Command button, when real estate does not allow for icons + + labels or as secondary actions within the command bar. numericValue: '5' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' + - name: Normal + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' + package: '@microsoft/sp-property-pane!' summary: Optional completion action. - remarks: >- - Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo - an action. Examples: "Done" button which closes a container but doesn't make a server call or an "Undo" button - when a user is uploading a file in OneDrive. - name: Normal - fullName: Normal - langs: - - typeScript - type: field numericValue: '0' - - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' + - name: Primary + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' + package: '@microsoft/sp-property-pane!' summary: Preferred completion action when paired with a Standard button. - remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' - name: Primary - fullName: Primary - langs: - - typeScript - type: field numericValue: '1' diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 82d41fd2..26c8ad84 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -1,40 +1,29 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - summary: >- - Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). - name: PropertyPaneDropdownOptionType - fullName: PropertyPaneDropdownOptionType - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: PropertyPaneDropdownOptionType +uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' +package: '@microsoft/sp-property-pane!' +fullName: PropertyPaneDropdownOptionType +summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:))<!-- + -->. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Divider + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' summary: Render a divider. - name: Divider - fullName: Divider - langs: - - typeScript - type: field numericValue: '1' - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' + - name: Header + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' + package: '@microsoft/sp-property-pane!' summary: Render menu item as a header. - name: Header - fullName: Header - langs: - - typeScript - type: field numericValue: '2' - - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' + - name: Normal + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' + package: '@microsoft/sp-property-pane!' summary: Render normal menu item. - name: Normal - fullName: Normal - langs: - - typeScript - type: field numericValue: '0' diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index b0b2832c..9295fe3b 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -1,152 +1,90 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' - summary: |- - Enum for all the supported PropertyPane field types. +### YamlMime:TSEnum +name: PropertyPaneFieldType +uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' +package: '@microsoft/sp-property-pane!' +fullName: PropertyPaneFieldType +summary: >- + Enum for all the supported PropertyPane field types. - Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. - name: PropertyPaneFieldType - fullName: PropertyPaneFieldType - langs: - - typeScript - type: enum + + Names should be consistent with those in office-ui-fabric-react, be careful to + get letter casing correct. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Button + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' package: '@microsoft/sp-property-pane!' - children: - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' - - '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' summary: Button field. - name: Button - fullName: Button - langs: - - typeScript - type: field numericValue: '11' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' + - name: CheckBox + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' + package: '@microsoft/sp-property-pane!' summary: Checkbox field. - name: CheckBox - fullName: CheckBox - langs: - - typeScript - type: field numericValue: '2' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' + - name: ChoiceGroup + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' + package: '@microsoft/sp-property-pane!' summary: Choice Group field. - name: ChoiceGroup - fullName: ChoiceGroup - langs: - - typeScript - type: field numericValue: '10' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' + - name: Custom + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' + package: '@microsoft/sp-property-pane!' summary: Custom field. - name: Custom - fullName: Custom - langs: - - typeScript - type: field numericValue: '1' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' + - name: Dropdown + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' + package: '@microsoft/sp-property-pane!' summary: Dropdown field. - name: Dropdown - fullName: Dropdown - langs: - - typeScript - type: field numericValue: '6' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' + - name: DynamicField + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' + package: '@microsoft/sp-property-pane!' summary: Dynamic data field. - name: DynamicField - fullName: DynamicField - langs: - - typeScript - type: field numericValue: '14' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' + - name: DynamicFieldSet + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' + package: '@microsoft/sp-property-pane!' summary: A set of dynamic fields. - name: DynamicFieldSet - fullName: DynamicFieldSet - langs: - - typeScript - type: field numericValue: '16' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' + - name: DynamicTextField + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' + package: '@microsoft/sp-property-pane!' summary: Dynamic Text Field - deprecated: - content: '- Please use DynamicField' - isPreview: true - name: DynamicTextField - fullName: DynamicTextField - langs: - - typeScript - type: field numericValue: '15' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' + - name: Heading + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' + package: '@microsoft/sp-property-pane!' summary: Heading field. - name: Heading - fullName: Heading - langs: - - typeScript - type: field numericValue: '9' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' + - name: HorizontalRule + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' + package: '@microsoft/sp-property-pane!' summary: Horizontal Rule field. - name: HorizontalRule - fullName: HorizontalRule - langs: - - typeScript - type: field numericValue: '12' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' + - name: Label + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' + package: '@microsoft/sp-property-pane!' summary: Label field. - name: Label - fullName: Label - langs: - - typeScript - type: field numericValue: '7' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' + - name: Link + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' + package: '@microsoft/sp-property-pane!' summary: Link field. - name: Link - fullName: Link - langs: - - typeScript - type: field numericValue: '13' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' + - name: Slider + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' + package: '@microsoft/sp-property-pane!' summary: Slider field. - name: Slider - fullName: Slider - langs: - - typeScript - type: field numericValue: '8' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' + - name: TextField + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' + package: '@microsoft/sp-property-pane!' summary: TextField field. - name: TextField - fullName: TextField - langs: - - typeScript - type: field numericValue: '3' - - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' + - name: Toggle + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' + package: '@microsoft/sp-property-pane!' summary: Toggle field. - name: Toggle - fullName: Toggle - langs: - - typeScript - type: field numericValue: '5' diff --git a/SP-Framework/sp-search-extensibility.yml b/SP-Framework/sp-search-extensibility.yml index 80e26e37..e63b2803 100644 --- a/SP-Framework/sp-search-extensibility.yml +++ b/SP-Framework/sp-search-extensibility.yml @@ -1,23 +1,12 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-search-extensibility!' - summary: SharePoint Framework developer support for customizing search. - name: '@microsoft/sp-search-extensibility' - fullName: '@microsoft/sp-search-extensibility' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' - - '@microsoft/sp-search-extensibility!IQuery:interface' - - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' - - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' -references: - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' - name: BaseSearchQueryModifier - - uid: '@microsoft/sp-search-extensibility!IQuery:interface' - name: IQuery - - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' - name: SearchQueryModifierContext - - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' - name: SearchQueryScenario +### YamlMime:TSPacakge +uid: '@microsoft/sp-search-extensibility!' +name: '@microsoft/sp-search-extensibility' +type: package +summary: SharePoint Framework developer support for customizing search. +classes: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' +interfaces: + - '@microsoft/sp-search-extensibility!IQuery:interface' +enums: + - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 49929a13..055b602f 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -1,122 +1,86 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' - summary: >- - This is the base class that third parties should extend when implementing a client-side extension that can modify - the search query. +### YamlMime:TSType +name: BaseSearchQueryModifier +uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' +package: '@microsoft/sp-search-extensibility!' +fullName: BaseSearchQueryModifier +summary: >- + This is the base class that third parties should extend when implementing a + client-side extension that can modify the search query. - In the component manifest, the "extensionType" should be set to "SearchQueryModifier". - isPreview: true - name: BaseSearchQueryModifier - fullName: BaseSearchQueryModifier - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~0:complex' - inheritance: - - type: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~1:complex' + In the component manifest, the "extensionType" should be set to + "SearchQueryModifier". +remarks: '' +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' package: '@microsoft/sp-search-extensibility!' - children: - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' - summary: Use the context object to access common services and state associated with the component. + fullName: context + summary: >- + Use the context object to access common services and state associated with + the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. isPreview: true - name: context - fullName: context - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'protected readonly context: SearchQueryModifierContext;' return: - type: - - '@microsoft/sp-search-extensibility!default:class' - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' - summary: Returns a modified search query. + type: '' + - name: timeout + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' + package: '@microsoft/sp-search-extensibility!' + fullName: timeout + summary: >- + Timeout for the search query modifier in milliseconds. If the execution + takes longer than the timeout, the original query will be used instead of + the modified one. + remarks: '' isPreview: true - name: 'modifySearchQuery(query, scenario)' - fullName: 'modifySearchQuery(query, scenario)' - langs: - - typeScript - type: method + isDeprecated: false syntax: content: |- /** @virtual */ - modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise; + readonly timeout: number; return: - type: - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery~0:complex' - description: Modified query. + type: number +methods: + - name: 'modifySearchQuery(query, scenario)' + uid: >- + @microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1) + package: '@microsoft/sp-search-extensibility!' + fullName: 'modifySearchQuery(query, scenario)' + summary: Returns a modified search query. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + /** @virtual */ + + modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): + Promise; parameters: - id: query description: Query to modify. - type: - - '@microsoft/sp-search-extensibility!IQuery:interface' + type: '' - id: scenario description: Search scenario. - type: - - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' - summary: >- - Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the - original query will be used instead of the modified one. - isPreview: true - name: timeout - fullName: timeout - langs: - - typeScript - type: property - syntax: - content: |- - /** @virtual */ - readonly timeout: number; + type: >- + return: - type: - - number -references: - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~0:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier~1:complex' - name: BaseExtension - fullName: BaseExtension - spec.typeScript: - - uid: '@microsoft/sp-extension-base!BaseExtension:class' - name: BaseExtension - fullName: BaseExtension - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-search-extensibility!default:class' - name: SearchQueryModifierContext - - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: < - fullName: < - - uid: '@microsoft/sp-search-extensibility!IQuery:interface' - name: IQuery - fullName: IQuery - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-search-extensibility!IQuery:interface' - name: IQuery - - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' - name: SearchQueryScenario + type: >- + @microsoft/sp-search-extensibility!BaseSearchQueryModifier# + description: Modified query. +extends: >- + diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index 5bc98c67..4cdb0676 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -1,41 +1,39 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-search-extensibility!IQuery:interface' - summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. - remarks: Additional properties can be added to the object to pass data between extensions. - isPreview: true - name: IQuery - fullName: IQuery - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IQuery +uid: '@microsoft/sp-search-extensibility!IQuery:interface' +package: '@microsoft/sp-search-extensibility!' +fullName: IQuery +summary: >- + Query object. Includes the query text that will be used for search and exposed + through dynamic data. +remarks: >- + Additional properties can be added to the object to pass data between + extensions. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: originalQueryText + uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' package: '@microsoft/sp-search-extensibility!' - children: - - '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' - - '@microsoft/sp-search-extensibility!IQuery#queryText:member' - - uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' + fullName: originalQueryText summary: Query text that the user provided. + remarks: '' isPreview: true - name: originalQueryText - fullName: originalQueryText - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'originalQueryText: string;' return: - type: - - string - - uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' + type: string + - name: queryText + uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' + package: '@microsoft/sp-search-extensibility!' + fullName: queryText summary: Text of the query. + remarks: '' isPreview: true - name: queryText - fullName: queryText - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'queryText: string;' return: - type: - - string + type: string diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index 14b38e78..f46dfd15 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -1,22 +1,11 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' - summary: Context for the search query modifier extensions. - isPreview: true - name: SearchQueryModifierContext - fullName: SearchQueryModifierContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-extension-base!ExtensionContext:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponentContext:class' - package: '@microsoft/sp-search-extensibility!' -references: - - uid: '@microsoft/sp-extension-base!ExtensionContext:class' - name: ExtensionContext - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext +### YamlMime:TSType +name: SearchQueryModifierContext +uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' +package: '@microsoft/sp-search-extensibility!' +fullName: SearchQueryModifierContext +summary: Context for the search query modifier extensions. +remarks: '' +isPreview: true +isDeprecated: false +type: class +extends: '' diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index 1d0fd2d7..4488291f 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -1,32 +1,22 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' - summary: Scenario for the search query modifier. - isPreview: true - name: SearchQueryScenario - fullName: SearchQueryScenario - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: SearchQueryScenario +uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' +package: '@microsoft/sp-search-extensibility!' +fullName: SearchQueryScenario +summary: Scenario for the search query modifier. +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: SearchResults + uid: >- + @microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member package: '@microsoft/sp-search-extensibility!' - children: - - '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' - - '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' - - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' summary: Search results scenario. - isPreview: true - name: SearchResults - fullName: SearchResults - langs: - - typeScript - type: field numericValue: '1' - - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' + - name: SearchSuggestions + uid: >- + @microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member + package: '@microsoft/sp-search-extensibility!' summary: Search suggestions scenario. - isPreview: true - name: SearchSuggestions - fullName: SearchSuggestions - langs: - - typeScript - type: field numericValue: '2' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 7a33c80d..276692fe 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -1,752 +1,470 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!' - summary: SharePoint Framework support for building web parts. - remarks: >- - This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual - object that a page author can add to their content, and customize using a property pane. Examples of web parts - include an embedded video player, a map, a group calendar, a chart, etc. - name: '@microsoft/sp-webpart-base' - fullName: '@microsoft/sp-webpart-base' - langs: - - typeScript - type: package - children: - - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - - '@microsoft/sp-webpart-base!BaseWebPart:class' - - '@microsoft/sp-webpart-base!BaseWebPartContext:class' - - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - - '@microsoft/sp-webpart-base!IOffice:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - - '@microsoft/sp-webpart-base!ISDKs:interface' - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - - '@microsoft/sp-webpart-base!IWebPartContext:interface' - - '@microsoft/sp-webpart-base!IWebPartData:interface' - - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' - - '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' - - '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' - - '@microsoft/sp-webpart-base!WebPartContext:class' - - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' - summary: Helper method to create a Button on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneButton(targetProperty, properties)' - fullName: 'PropertyPaneButton(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the Button is associated to. - type: - - string - - id: properties - description: Strongly typed Button properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' - summary: Helper method to create a Checkbox on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneCheckbox(targetProperty, properties)' - fullName: 'PropertyPaneCheckbox(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the checkbox is associated to. - type: - - string - - id: properties - description: Strongly typed Checkbox properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' - summary: Helper method to create a Choice Group on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: - IPropertyPaneChoiceGroupProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the choice group is associated to. - type: - - string - - id: properties - description: Strongly typed Choice Group properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' - summary: Helper method to create a custom field on the PropertyPane. - remarks: >- - The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The - PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but - there are exceptional cases when web parts have special needs and need a special control. The custom field helps - fill that gap. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - isPreview: true - name: PropertyPaneCustomField(properties) - fullName: PropertyPaneCustomField(properties) - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' - description: '' - parameters: - - id: properties - description: Strongly typed Custom field properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' - summary: Helper method to create a Dropdown on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneDropdown(targetProperty, properties)' - fullName: 'PropertyPaneDropdown(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the dropdown is associated to. - type: - - string - - id: properties - description: Strongly typed Dropdown properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' - summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneDynamicField(targetProperty, properties)' - fullName: 'PropertyPaneDynamicField(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneDynamicField(targetProperty: string, properties: - IPropertyPaneDynamicFieldProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneDynamicField~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the Dynamic Data widget is associated to. - type: - - string - - id: properties - description: '' - type: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' - summary: >- - Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data - source. - - - These fields can possibly share the same property based on the associated filters. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: PropertyPaneDynamicFieldSet(properties) - fullName: PropertyPaneDynamicFieldSet(properties) - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet~0:complex' - description: '' - parameters: - - id: properties - description: >- - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. - Each entry includes the target property and, optionally, the label to show. options - Options enabling - customized values for callback, filters etc., for the given set of dynamic fields. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' - summary: Helper method to create a Dynamic TextField on the PropertyPane. - deprecated: - content: >- - This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please - consume it from there. - isPreview: true - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - fullName: 'PropertyPaneDynamicTextField(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: - IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the dynamic textfield is associated to. - type: - - string - - id: properties - description: Properties of the PropertyPaneDynamicTextField. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' - summary: Helper method to create a Horizontal Rule on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: PropertyPaneHorizontalRule() - fullName: PropertyPaneHorizontalRule() - langs: - - typeScript - type: function - syntax: - content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule~0:complex' - description: '' - - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' - summary: Helper method to create a Label on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneLabel(targetProperty, properties)' - fullName: 'PropertyPaneLabel(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the label is associated to. - type: - - string - - id: properties - description: Strongly typed Label properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' - summary: Helper method to create a Link on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneLink(targetProperty, properties)' - fullName: 'PropertyPaneLink(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the Link is associated to. - type: - - string - - id: properties - description: Strongly typed Link properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' - summary: Helper method to create a Slider on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneSlider(targetProperty, properties)' - fullName: 'PropertyPaneSlider(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the slider is associated to. - type: - - string - - id: properties - description: Strongly typed Slider properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' - summary: Helper method to create a TextField on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneTextField(targetProperty, properties)' - fullName: 'PropertyPaneTextField(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the textfield is associated to. - type: - - string - - id: properties - description: Strongly typed TextField properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' - summary: Helper method to create a Toggle on the PropertyPane. - deprecated: - content: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: 'PropertyPaneToggle(targetProperty, properties)' - fullName: 'PropertyPaneToggle(targetProperty, properties)' - langs: - - typeScript - type: function - syntax: - content: >- - export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): - IPropertyPaneField; - return: - type: - - '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' - description: '' - parameters: - - id: targetProperty - description: Target property the toggle is associated to. - type: - - string - - id: properties - description: Strongly typed Toggle properties. - type: - - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' -references: - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - name: BaseClientSideWebPart - - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' - name: BaseWebPart - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' - name: BaseWebPartContext - - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - name: DynamicDataSharedDepth - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - name: IClientSideWebPartStatusRenderer - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - name: IDynamicDataSharedPropertyConfiguration - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedPropertyFilters - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceConfiguration - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - name: IDynamicDataSharedSourceFilters - - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - name: IMicrosoftTeams - - uid: '@microsoft/sp-webpart-base!IOffice:interface' - name: IOffice - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - name: IPropertyPaneAccessor - - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - name: IPropertyPaneButtonProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneCheckboxProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - name: IPropertyPaneChoiceGroupOption - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - name: IPropertyPaneChoiceGroupOptionIconProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneChoiceGroupProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - name: IPropertyPaneConditionalGroup - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - name: IPropertyPaneConfiguration - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneCustomFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - name: IPropertyPaneDropdownCalloutProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownOption - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDropdownProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - name: IPropertyPaneDynamicFieldFilters - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicFieldSetProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneDynamicTextFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - name: IPropertyPaneGroup - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLabelProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - name: IPropertyPaneLinkProps - - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - name: IPropertyPanePage - - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - name: IPropertyPanePageHeader - - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - name: IPropertyPaneSliderProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneTextFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - name: IPropertyPaneToggleProps - - uid: '@microsoft/sp-webpart-base!ISDKs:interface' - name: ISDKs - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - name: ISerializedServerProcessedData - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - name: ISerializedWebPartData - - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' - name: IWebPartContext - - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' - name: IWebPartData - - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - name: IWebPartPropertiesMetadata - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' - name: IWebPartPropertyMetadata - - uid: '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - name: IPropertyPaneButtonProps - fullName: IPropertyPaneButtonProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - name: PropertyPaneButtonType - - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneCheckboxProps - fullName: IPropertyPaneCheckboxProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneChoiceGroupProps - fullName: IPropertyPaneChoiceGroupProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneCustomFieldProps - fullName: IPropertyPaneCustomFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDropdownProps - fullName: IPropertyPaneDropdownProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - name: PropertyPaneDropdownOptionType - - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicFieldSetProps - fullName: IPropertyPaneDynamicFieldSetProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneDynamicTextFieldProps - fullName: IPropertyPaneDynamicTextFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - name: PropertyPaneFieldType - - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: - fullName: - - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLabelProps - fullName: IPropertyPaneLabelProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - name: IPropertyPaneLinkProps - fullName: IPropertyPaneLinkProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - name: IPropertyPaneSliderProps - fullName: IPropertyPaneSliderProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneTextFieldProps - fullName: IPropertyPaneTextFieldProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' - name: IPropertyPaneField - fullName: IPropertyPaneField - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: < - fullName: < - - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - name: IPropertyPaneToggleProps - fullName: IPropertyPaneToggleProps - - name: '>' - fullName: '>' - - uid: '@microsoft/sp-webpart-base!WebPartContext:class' - name: WebPartContext - - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' - name: WebPartFormFactor +### YamlMime:TSPacakge +uid: '@microsoft/sp-webpart-base!' +name: '@microsoft/sp-webpart-base' +type: package +summary: SharePoint Framework support for building web parts. +classes: + - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPartContext:class' + - '@microsoft/sp-webpart-base!WebPartContext:class' +enums: + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' +interfaces: + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - '@microsoft/sp-webpart-base!IOffice:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-webpart-base!ISDKs:interface' + - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' + - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartContext:interface' + - '@microsoft/sp-webpart-base!IWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' +functions: + - name: 'PropertyPaneButton(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Button on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneButton(targetProperty: string, + properties: IPropertyPaneButtonProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Button is associated to. + type: string + - id: properties + description: Strongly typed Button properties. + type: >- + + return: + type: '' + description: '' + - name: 'PropertyPaneCheckbox(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Checkbox on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneCheckbox(targetProperty: string, + properties: IPropertyPaneCheckboxProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the checkbox is associated to. + type: string + - id: properties + description: Strongly typed Checkbox properties. + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Choice Group on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneChoiceGroup(targetProperty: string, + properties: IPropertyPaneChoiceGroupProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the choice group is associated to. + type: string + - id: properties + description: Strongly typed Choice Group properties. + type: >- + + return: + type: >- + + description: '' + - name: PropertyPaneCustomField(properties) + uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a custom field on the PropertyPane. + remarks: >- + The purpose of the custom field is to help the web part developer to add a + custom control to the PropertyPane. The PropertyPane supports a host of + inbuilt field types. While this list meets the demands of most web parts, + but there are exceptional cases when web parts have special needs and need + a special control. The custom field helps fill that gap. + isPreview: true + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneCustomField(properties: + IPropertyPaneCustomFieldProps): + IPropertyPaneField; + parameters: + - id: properties + description: Strongly typed Custom field properties. + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneDropdown(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Dropdown on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneDropdown(targetProperty: string, + properties: IPropertyPaneDropdownProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the dropdown is associated to. + type: string + - id: properties + description: Strongly typed Dropdown properties. + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneDynamicField(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' + package: '@microsoft/sp-webpart-base' + summary: >- + Helper method to create a Dynamic Data widget on the PropertyPane for a + dynamic field. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneDynamicField(targetProperty: string, + properties: IPropertyPaneDynamicFieldProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Dynamic Data widget is associated to. + type: string + - id: properties + description: '' + type: >- + + return: + type: >- + + description: '' + - name: PropertyPaneDynamicFieldSet(properties) + uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' + package: '@microsoft/sp-webpart-base' + summary: >- + Helper method to create a Dynamic Data widget on the Property Pane for a + set of dynamic fields with a common data source. + + + These fields can possibly share the same property based on the associated + filters. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneDynamicFieldSet(properties: + IPropertyPaneDynamicFieldSetProps): + IPropertyPaneField; + parameters: + - id: properties + description: >- + Contains entries and options, described as below: entries - A set of + entries to be configured by the widget. Each entry includes the + target property and, optionally, the label to show. options - + Options enabling customized values for callback, filters etc., for + the given set of dynamic fields. + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Dynamic TextField on the PropertyPane. + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: >- + This has been replaced by PropertyPaneDynamicField and moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneDynamicTextField(targetProperty: + string, properties: IPropertyPaneDynamicTextFieldProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the dynamic textfield is associated to. + type: string + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + type: >- + + return: + type: >- + + description: '' + - name: PropertyPaneHorizontalRule() + uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Horizontal Rule on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneHorizontalRule(): + IPropertyPaneField; + return: + type: >- + + description: '' + - name: 'PropertyPaneLabel(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Label on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneLabel(targetProperty: string, + properties: IPropertyPaneLabelProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the label is associated to. + type: string + - id: properties + description: Strongly typed Label properties. + type: >- + + return: + type: '' + description: '' + - name: 'PropertyPaneLink(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Link on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneLink(targetProperty: string, + properties: IPropertyPaneLinkProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Link is associated to. + type: string + - id: properties + description: Strongly typed Link properties. + type: >- + + return: + type: '' + description: '' + - name: 'PropertyPaneSlider(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Slider on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneSlider(targetProperty: string, + properties: IPropertyPaneSliderProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the slider is associated to. + type: string + - id: properties + description: Strongly typed Slider properties. + type: >- + + return: + type: '' + description: '' + - name: 'PropertyPaneTextField(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a TextField on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneTextField(targetProperty: string, + properties: IPropertyPaneTextFieldProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the textfield is associated to. + type: string + - id: properties + description: Strongly typed TextField properties. + type: >- + + return: + type: >- + + description: '' + - name: 'PropertyPaneToggle(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' + package: '@microsoft/sp-webpart-base' + summary: Helper method to create a Toggle on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. + syntax: + content: >- + export declare function PropertyPaneToggle(targetProperty: string, + properties: IPropertyPaneToggleProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the toggle is associated to. + type: string + - id: properties + description: Strongly typed Toggle properties. + type: >- + + return: + type: '' + description: '' diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 8f4f7cc1..03221585 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -1,293 +1,272 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - summary: >- - This abstract class implements the the base functionality for a client-side web part. Every client-side web part - needs to inherit from this class. - remarks: >- - Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall - in two catagories. - - - The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This - API should be used to access contextual data relevant to this web part instance. - - - The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an - updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web - part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web - part. Please refer to the documentation of the individual APIs to make the right decision. - name: BaseClientSideWebPart - fullName: BaseClientSideWebPart - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-webpart-base!BaseClientSideWebPart~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!BaseClientSideWebPart~1:complex' - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' - - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' - summary: Constructor for the BaseClientSideWebPart class. - remarks: >- - It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. - Most of the web part features like this.context and `this.properties` are not available to be used before the the - `onInit()` part of the web part loading lifecycle. - name: (constructor)() - fullName: (constructor)() - langs: - - typeScript - type: constructor - syntax: - content: constructor(); - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' - summary: This property indicates whether a web part can open a popup on initial render. - remarks: >- - In some environments the host re-renders the web parts frequently, and therefore opening popups during render will - cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages - perform postbacks causing the page to re-render on all button clicks. - - - If a web part needs to open a popup on render, it should use this API before opening the popup. If this API - returns false, the web part should not open popup on initial render. Some web parts that open popups during render - are the document embed web part that pops up the file picker on initial render, embedded video web part that pops - up the PropertyPane on initial render. - name: canOpenPopupOnRender - fullName: canOpenPopupOnRender - langs: - - typeScript - type: property - syntax: - content: 'protected readonly canOpenPopupOnRender: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' - summary: This API should be used to clear the error message from the web part display area. - name: clearError() - fullName: clearError() - langs: - - typeScript - type: method - syntax: - content: 'protected clearError(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - name: context - fullName: context - langs: - - typeScript - type: property - syntax: - content: 'readonly context: WebPartContext;' - return: - type: - - '@microsoft/sp-webpart-base!default:class' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' - summary: >- - This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole - DOM subtree of the web part. - name: domElement - fullName: domElement - langs: - - typeScript - type: property - syntax: - content: 'protected readonly domElement: HTMLElement;' - return: - type: - - '!HTMLElement:interface' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' - summary: Indicates whether the web part is rendering in Async mode. - remarks: >- - If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part - rendering is complete. - - - The default value is false. - name: isRenderAsync - fullName: isRenderAsync - langs: - - typeScript - type: property - syntax: - content: |- - /** @virtual */ - protected readonly isRenderAsync: boolean; - return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' - summary: This event method is called when the display mode of a web part is changed. - remarks: >- - The default implementation of this API calls the web part render method to re-render the web part with the new - display mode. If a web part developer does not want a full re-render to happen on display mode change, they can - override this API and perform specific updates to the web part DOM to switch its display mode. - name: onDisplayModeChanged(oldDisplayMode) - fullName: onDisplayModeChanged(oldDisplayMode) - langs: - - typeScript - type: method - syntax: - content: |- - /** @virtual */ - protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; - return: - type: - - void - description: '' - parameters: - - id: oldDisplayMode - description: The old display mode. - type: - - '@microsoft/sp-core-library!DisplayMode:enum' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' - summary: This API should be used to refresh the contents of the PropertyPane. - remarks: >- - This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local - resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios - like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being - transitioned out. - name: onDispose() - fullName: onDispose() - langs: - - typeScript - type: method - syntax: - content: |- - /** @virtual */ - protected onDispose(): void; - return: - type: - - void - description: '' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' - summary: >- - This API is called to render the web part. There is no base implementation of this API and the web part is - required to override this API. - name: render() - fullName: render() - langs: - - typeScript - type: method - syntax: - content: 'protected abstract render(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' - summary: >- - This API should be called by web parts that perform Async rendering. Those web part are required to override the - isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part - initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe - loading completes. - name: renderCompleted() - fullName: renderCompleted() - langs: - - typeScript - type: method - syntax: - content: 'protected renderCompleted(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' - summary: >- - This property indicates whether the web part was rendered from the persisted data (serialized state from the last - time that the web part was saved) or not. - remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' - name: renderedFromPersistedData - fullName: renderedFromPersistedData - langs: - - typeScript - type: property - syntax: - content: 'protected readonly renderedFromPersistedData: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' - summary: >- - This property indicates whether the web part has been rendered once or not. After the first time rendering, the - value of this property is always true until a full re-render of the web part happens. - name: renderedOnce - fullName: renderedOnce - langs: - - typeScript - type: property - syntax: - content: 'protected readonly renderedOnce: boolean;' - return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' - summary: >- - This API should be used to render an error message in the web part display area. Also logs the error message using - the trace logger. - name: renderError(error) - fullName: renderError(error) - langs: - - typeScript - type: method - syntax: - content: 'protected renderError(error: Error): void;' - return: - type: - - void - description: '' - parameters: - - id: error - description: An error object containing the error message to render. - type: - - '!Error:interface' -references: - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart~0:complex' - name: BaseWebPart - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!default:class' - name: BaseWebPart - fullName: default - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart~1:complex' - name: BaseWebPart - fullName: default - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!default:class' - name: BaseWebPart - fullName: default - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-webpart-base!default:class' - name: WebPartContext - - uid: '!HTMLElement:interface' - name: HTMLElement - - uid: '@microsoft/sp-core-library!DisplayMode:enum' - name: DisplayMode - - uid: '!Error:interface' - name: Error +### YamlMime:TSType +name: BaseClientSideWebPart +uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' +package: '@microsoft/sp-webpart-base!' +fullName: BaseClientSideWebPart +summary: >- + This abstract class implements the the base functionality for a client-side + web part. Every client-side web part needs to inherit from this class. +remarks: >- + Along with the base functionality, this class provides some APIs that can be + used by the web part. These APIs fall in two catagories. + + + The first category of APIs provide data and functionality. Example, the web + part context (i.e. this.context). This API should be used to access contextual + data relevant to this web part instance. + + + The second category of APIs provide a base implementation for the web part + lifecycle and can be overridden for an updated implementation. The render() + API is the only API that is mandatory to be implemented/overridden by a web + part. All other life cycle APIs have a base implementation and can be + overridden based on the needs of the web part. Please refer to the + documentation of the individual APIs to make the right decision. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' + package: '@microsoft/sp-webpart-base!' + fullName: (constructor)() + summary: Constructor for the BaseClientSideWebPart class. + remarks: >- + It is highly recommended that the web part use the `onInit()` API to + perform any web part specific initialization. Most of the web part + features like this.context and `this.properties` are not available to be + used before the the `onInit()` part of the web part loading lifecycle. + isPreview: false + isDeprecated: false + syntax: + content: constructor(); +properties: + - name: canOpenPopupOnRender + uid: >- + @microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member + package: '@microsoft/sp-webpart-base!' + fullName: canOpenPopupOnRender + summary: >- + This property indicates whether a web part can open a popup on initial + render. + remarks: >- + In some environments the host re-renders the web parts frequently, and + therefore opening popups during render will cause popups to open + repeatedly, which is a poor user experience. As an example, the classic + SharePoint pages perform postbacks causing the page to re-render on all + button clicks. + + + If a web part needs to open a popup on render, it should use this API + before opening the popup. If this API returns false, the web part should + not open popup on initial render. Some web parts that open popups during + render are the document embed web part that pops up the file picker on + initial render, embedded video web part that pops up the PropertyPane on + initial render. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly canOpenPopupOnRender: boolean;' + return: + type: boolean + - name: context + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' + package: '@microsoft/sp-webpart-base!' + fullName: context + summary: >- + Use the context object to access common services and state associated with + the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly context: WebPartContext;' + return: + type: '' + - name: domElement + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' + package: '@microsoft/sp-webpart-base!' + fullName: domElement + summary: >- + This property is a pointer to the root DOM element of the web part. This + is a DIV element and contains the whole DOM subtree of the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly domElement: HTMLElement;' + return: + type: '' + - name: isRenderAsync + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' + package: '@microsoft/sp-webpart-base!' + fullName: isRenderAsync + summary: Indicates whether the web part is rendering in Async mode. + remarks: >- + If the web part overrides this field to return true, then it needs to call + renderCompleted API after the web part rendering is complete. + + + The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected readonly isRenderAsync: boolean; + return: + type: boolean + - name: renderedFromPersistedData + uid: >- + @microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member + package: '@microsoft/sp-webpart-base!' + fullName: renderedFromPersistedData + summary: >- + This property indicates whether the web part was rendered from the + persisted data (serialized state from the last time that the web part was + saved) or not. + remarks: >- + Example: When web part is added for the first time using toolbox then the + value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly renderedFromPersistedData: boolean;' + return: + type: boolean + - name: renderedOnce + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' + package: '@microsoft/sp-webpart-base!' + fullName: renderedOnce + summary: >- + This property indicates whether the web part has been rendered once or + not. After the first time rendering, the value of this property is always + true until a full re-render of the web part happens. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly renderedOnce: boolean;' + return: + type: boolean +methods: + - name: clearError() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: clearError() + summary: >- + This API should be used to clear the error message from the web part + display area. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected clearError(): void;' + return: + type: void + description: '' + - name: onDisplayModeChanged(oldDisplayMode) + uid: >- + @microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: onDisplayModeChanged(oldDisplayMode) + summary: >- + This event method is called when the display mode of a web part is + changed. + remarks: >- + The default implementation of this API calls the web part render method to + re-render the web part with the new display mode. If a web part developer + does not want a full re-render to happen on display mode change, they can + override this API and perform specific updates to the web part DOM to + switch its display mode. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; + parameters: + - id: oldDisplayMode + description: The old display mode. + type: '' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onDispose() + summary: This API should be used to refresh the contents of the PropertyPane. + remarks: >- + This API is called at the end of the web part lifecycle on a page. It + should be used to dispose any local resources (i.e. DOM elements) that the + web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to + another and disposes the page that is being transitioned out. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onDispose(): void; + return: + type: void + description: '' + - name: render() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: render() + summary: >- + This API is called to render the web part. There is no base implementation + of this API and the web part is required to override this API. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected abstract render(): void;' + return: + type: void + description: '' + - name: renderCompleted() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: renderCompleted() + summary: >- + This API should be called by web parts that perform Async rendering. Those + web part are required to override the isRenderAsync API and return true. + One such example is web parts that render content in an IFrame. The web + part initiates the IFrame rendering in the `render()` API but the actual + rendering is complete only after the iframe loading completes. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected renderCompleted(): void;' + return: + type: void + description: '' + - name: renderError(error) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: renderError(error) + summary: >- + This API should be used to render an error message in the web part display + area. Also logs the error message using the trace logger. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected renderError(error: Error): void;' + parameters: + - id: error + description: An error object containing the error message to render. + type: '' + return: + type: void + description: '' +extends: '' diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 893c3548..f62b6c61 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -1,471 +1,469 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' - summary: >- - This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to - allow a common core between 2D and MR WebParts. - name: BaseWebPart - fullName: BaseWebPart - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-component-base!BaseComponent:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponent:class' - implements: - - '@microsoft/sp-property-pane!IPropertyPaneConsumer:interface' +### YamlMime:TSType +name: BaseWebPart +uid: '@microsoft/sp-webpart-base!BaseWebPart:class' +package: '@microsoft/sp-webpart-base!' +fullName: BaseWebPart +summary: >- + This abstract class implements the UI-agnostic base functionality for a + client-side web part. The purpose is to allow a common core between 2D and MR + WebParts. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)() + uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' - - '@microsoft/sp-webpart-base!BaseWebPart#context:member' - - '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' - - '@microsoft/sp-webpart-base!BaseWebPart#description:member' - - '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' - - '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' - - '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' - - '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' - - '@microsoft/sp-webpart-base!BaseWebPart#properties:member' - - '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' - - '@microsoft/sp-webpart-base!BaseWebPart#title:member' - - uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' + fullName: (constructor)() summary: Constructor for the `BaseWebPart` class. remarks: >- - It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. - Most of the web part features like this.context and this.properties are not available to be used before the the - onInit part of the web part loading lifecycle. - name: (constructor)() - fullName: (constructor)() - langs: - - typeScript - type: constructor + It is highly recommended that the web part use the OnInit API to perform + any web part specific initialization. Most of the web part features like + this.context and this.properties are not available to be used before the + the onInit part of the web part loading lifecycle. + isPreview: false + isDeprecated: false syntax: content: constructor(); - - uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' +properties: + - name: accessibleTitle + uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' + package: '@microsoft/sp-webpart-base!' + fullName: accessibleTitle summary: >- - This property points to the accessible title of web part made available to screen readers. The base implementation - returns that default title in the manifest. Web parts that want to provide more descriptive title containing + This property points to the accessible title of web part made available to + screen readers. The base implementation returns that default title in the + manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. - name: accessibleTitle - fullName: accessibleTitle - langs: - - typeScript - type: property + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected readonly accessibleTitle: string;' return: - type: - - string - - uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - name: context + type: string + - name: context + uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' + package: '@microsoft/sp-webpart-base!' fullName: context - langs: - - typeScript - type: property + summary: >- + Use the context object to access common services and state associated with + the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a + specialized type. It is meant to be a read-only property; the type cannot + be declared as read-only in the base class (because it is initialized + outside the constructor), but child classes should redeclare it as + readonly. + isPreview: false + isDeprecated: false syntax: content: 'readonly context: BaseWebPartContext;' return: - type: - - '@microsoft/sp-webpart-base!default:class' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' - summary: >- - The value of this property is stored in the serialized data of the web part to allow developers to manage - versioning of their web part. The default version is 1.0 - name: dataVersion + type: '' + - name: dataVersion + uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' + package: '@microsoft/sp-webpart-base!' fullName: dataVersion - langs: - - typeScript - type: property + summary: >- + The value of this property is stored in the serialized data of the web + part to allow developers to manage versioning of their web part. The + default version is 1.0 + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected readonly dataVersion: Version;' return: - type: - - '@microsoft/sp-core-library!Version:class' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' - summary: Description of the WebPart - name: description + type: '' + - name: description + uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' + package: '@microsoft/sp-webpart-base!' fullName: description - langs: - - typeScript - type: property + summary: Description of the WebPart + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected readonly description: string;' return: - type: - - string - - uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' - summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. + type: string + - name: disableReactivePropertyChanges + uid: >- + @microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member + package: '@microsoft/sp-webpart-base!' + fullName: disableReactivePropertyChanges + summary: >- + This property is used to change the web part's property pane interaction + from Reactive to NonReactive. remarks: >- The default behavior is Reactive. - Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can - see instant updates. This helps the page creator get instant feedback and decide if they should keep the new - configuration changes or not. + Reactive implies that changes made in the PropertyPane are transmitted to + the web part instantly and the user can see instant updates. This helps + the page creator get instant feedback and decide if they should keep the + new configuration changes or not. - NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane - button is clicked. - name: disableReactivePropertyChanges - fullName: disableReactivePropertyChanges - langs: - - typeScript - type: property + NonReactive implies that the configuration changes are transmitted to the + web part only after "Apply" PropertyPane button is clicked. + isPreview: false + isDeprecated: false syntax: content: 'protected readonly disableReactivePropertyChanges: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' - summary: This property is the current display mode of the web part. - name: displayMode + type: boolean + - name: displayMode + uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' + package: '@microsoft/sp-webpart-base!' fullName: displayMode - langs: - - typeScript - type: property + summary: This property is the current display mode of the web part. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected readonly displayMode: DisplayMode;' return: - type: - - '@microsoft/sp-core-library!DisplayMode:enum' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' + type: '' + - name: previewImageUrl + uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' + package: '@microsoft/sp-webpart-base!' + fullName: previewImageUrl + summary: >- + This property points to the preview image for the web part. The base + implementation returns undefined. Web parts that want to provide a valid + preview image url need to override this API. The preview image url can be + used to create a preview of the web part or of the page on which the web + part is present. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly previewImageUrl: string | undefined;' + return: + type: string | undefined + - name: properties + uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' + package: '@microsoft/sp-webpart-base!' + fullName: properties + summary: This property is the pointer to the custom property bag of the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly properties: TProperties;' + return: + type: TProperties + - name: propertiesMetadata + uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' + package: '@microsoft/sp-webpart-base!' + fullName: propertiesMetadata summary: >- - This API is used to ger the configuration to build the property pane for the web part. If the web part wants to - use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the - configuration for the PropertyPane. + This property defines metadata for the web part property bag. The metadata + can help SharePoint understand the content of the properties better and + perform relevant services on the data. + remarks: >- + See + [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) + for more information about how to define metadata + isPreview: false + isDeprecated: false + syntax: + content: >- + protected readonly propertiesMetadata: IWebPartPropertiesMetadata | + undefined; + return: + type: >- + @microsoft/sp-webpart-base!BaseWebPart# + - name: title + uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' + package: '@microsoft/sp-webpart-base!' + fullName: title + summary: Title of the WebPart + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly title: string;' + return: + type: string +methods: + - name: getPropertyPaneConfiguration() + uid: >- + @microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: getPropertyPaneConfiguration() + summary: >- + This API is used to ger the configuration to build the property pane for + the web part. If the web part wants to use the PropertyPane for + configuration, this API needs to be overridden and the web part needs to + return the configuration for the PropertyPane. - This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. + This API is not invoked until the 'loadPropertyPaneResources' promise is + resolved. - See IPropertyPane and other PropertyPane integration wiki documentation for more details. - name: getPropertyPaneConfiguration() - fullName: getPropertyPaneConfiguration() - langs: - - typeScript - type: method + See IPropertyPane and other PropertyPane integration wiki documentation + for more details. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: - type: - - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + type: >- + description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' - summary: 'This API is called after the web part is deserialized to an object, right before the property bag is populated.' + - name: 'onAfterDeserialize(deserializedObject, dataVersion)' + uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' + summary: >- + This API is called after the web part is deserialized to an object, right + before the property bag is populated. remarks: >- - The default implementation is a no-op. A web part developer can override this API if the deserialized object does - not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate - the property bag right after the data is deserialized to an object. + The default implementation is a no-op. A web part developer can override + this API if the deserialized object does not fully reflect the initial + state of the property bag. This gives the web part developer a chance to + populate the property bag right after the data is deserialized to an + object. - An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized - by an older version of the web part that supported a different schema of the property bag, resulting the - deserialized object to be incosistent with the current schema of the property bag. The developer can use - `onAfterDeserialize` to check the dataVersion and fix the property bag. - name: 'onAfterDeserialize(deserializedObject, dataVersion)' - fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' - langs: - - typeScript - type: method + An important scenario to use deserialize is upgrading. An upgraded web + part may load the data that was serialized by an older version of the web + part that supported a different schema of the property bag, resulting the + deserialized object to be incosistent with the current schema of the + property bag. The developer can use `onAfterDeserialize` to check the + dataVersion and fix the property bag. + isPreview: false + isDeprecated: false syntax: - content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' - return: - type: - - TProperties - description: The property bag of the web part + content: >- + protected onAfterDeserialize(deserializedObject: any, dataVersion: + Version): TProperties; parameters: - id: deserializedObject description: >- - The object deserialized from the stored data. Note that the schema of this object is not necessarily - consistent with the current property bag, because the serialization could have been done by an older version - of the web part - type: - - any + The object deserialized from the stored data. Note that the schema + of this object is not necessarily consistent with the current + property bag, because the serialization could have been done by an + older version of the web part + type: any - id: dataVersion description: >- - The data version of the stored data being deserialized. You can use this value to determine if the data was - serialized by an older web part. Web parts can define their data version by overriding the dataVersion - property. - type: - - '@microsoft/sp-core-library!Version:class' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' - summary: >- - This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in - Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. - name: onAfterPropertyPaneChangesApplied() + The data version of the stored data being deserialized. You can use + this value to determine if the data was serialized by an older web + part. Web parts can define their data version by overriding the + dataVersion property. + type: '' + return: + type: TProperties + description: The property bag of the web part + - name: onAfterPropertyPaneChangesApplied() + uid: >- + @microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1) + package: '@microsoft/sp-webpart-base!' fullName: onAfterPropertyPaneChangesApplied() - langs: - - typeScript - type: method + summary: >- + This API is invoked after the changes made on the PropertyPane are applied + when the PropertyPane is used in Non-Reactive mode. This API is not + invoked when the PropertyPane is used in Reactive mode. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected onAfterPropertyPaneChangesApplied(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' + - name: onBeforeSerialize() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onBeforeSerialize() summary: This event method is called before the web part is serialized. remarks: >- - The default implementation is a no-op. The serialization process serializes the web part property bag i.e. - this.properties. This API gives the web part a chance to update it's property bag before the serialization - happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist - some of that state, it needs to override this API and update the web part property bag to the latest state. If a - web part updates the property bag with invalid property values, those will get persisted. So that should be - avoided. The web part property bag should always contain valid property values. - name: onBeforeSerialize() - fullName: onBeforeSerialize() - langs: - - typeScript - type: method + The default implementation is a no-op. The serialization process + serializes the web part property bag i.e. this.properties. This API gives + the web part a chance to update it's property bag before the serialization + happens. Some web part's may keep their state other objects or even in the + DOM. If a web part needs to persist some of that state, it needs to + override this API and update the web part property bag to the latest + state. If a web part updates the property bag with invalid property + values, those will get persisted. So that should be avoided. The web part + property bag should always contain valid property values. + isPreview: false + isDeprecated: false syntax: content: 'protected onBeforeSerialize(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' - summary: This event method is called when the display mode of a web part is changed. - remarks: >- - The default implementation of this API calls the web part render method to re-render the web part with the new - display mode. If a web part developer does not want a full re-render to happen on display mode change, they can - override this API and perform specific updates to the web part DOM to switch its display mode. - name: onDisplayModeChanged(oldDisplayMode) + - name: onDisplayModeChanged(oldDisplayMode) + uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' + package: '@microsoft/sp-webpart-base!' fullName: onDisplayModeChanged(oldDisplayMode) - langs: - - typeScript - type: method + summary: >- + This event method is called when the display mode of a web part is + changed. + remarks: >- + The default implementation of this API calls the web part render method to + re-render the web part with the new display mode. If a web part developer + does not want a full re-render to happen on display mode change, they can + override this API and perform specific updates to the web part DOM to + switch its display mode. + isPreview: false + isDeprecated: false syntax: content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' - return: - type: - - void - description: '' parameters: - id: oldDisplayMode description: The old display mode. - type: - - '@microsoft/sp-core-library!DisplayMode:enum' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' + type: '' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onDispose() summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- - This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local - resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios - like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being - transitioned out. - name: onDispose() - fullName: onDispose() - langs: - - typeScript - type: method + This API is called at the end of the web part lifecycle on a page. It + should be used to dispose any local resources (i.e. DOM elements) that the + web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to + another and disposes the page that is being transitioned out. + isPreview: false + isDeprecated: false syntax: content: 'protected onDispose(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' + - name: onInit() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onInit() summary: This event method is called when the web part is initialized. remarks: >- - This API should be overridden to perform long running operations e.g. data fetching from a remote service before - the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This - API is called only once during the lifecycle of a web part. - name: onInit() - fullName: onInit() - langs: - - typeScript - type: method + This API should be overridden to perform long running operations e.g. data + fetching from a remote service before the initial rendering of the web + part. The loading indicator is displayed during the lifetime of this + method. This API is called only once during the lifecycle of a web part. + isPreview: false + isDeprecated: false syntax: content: 'protected onInit(): Promise;' return: - type: - - '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' + type: '@microsoft/sp-webpart-base!BaseWebPart#' description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' - summary: This API is invoked when the configuration is completed on the PropertyPane. - remarks: |- + - name: onPropertyPaneConfigurationComplete() + uid: >- + @microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: onPropertyPaneConfigurationComplete() + summary: >- + This API is invoked when the configuration is completed on the + PropertyPane. + remarks: >- This event method is invoked in the following cases: - - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. - - When user clicks the "X" (close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 + secs) elapses after the last change. - - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - When the user switches web parts then the current web part gets this event. - name: onPropertyPaneConfigurationComplete() - fullName: onPropertyPaneConfigurationComplete() - langs: - - typeScript - type: method + - When user clicks the "X" (close) button before the + CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + + + - When user clicks the 'Apply' button before the + CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + + + - When the user switches web parts then the current web part gets this + event. + isPreview: false + isDeprecated: false syntax: content: 'protected onPropertyPaneConfigurationComplete(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' - summary: This event method is invoked when the configuration starts on the PropertyPane. + - name: onPropertyPaneConfigurationStart() + uid: >- + @microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: onPropertyPaneConfigurationStart() + summary: >- + This event method is invoked when the configuration starts on the + PropertyPane. remarks: |- This event method is invoked in the following cases: - When the PropertyPane is opened. - When the user switches web parts then the new web part gets this event. - name: onPropertyPaneConfigurationStart() - fullName: onPropertyPaneConfigurationStart() - langs: - - typeScript - type: method + isPreview: false + isDeprecated: false syntax: content: 'protected onPropertyPaneConfigurationStart(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' - summary: >- - This API is invoked after updating the new value of the property in the property bag when the PropertyPane is - being used in Reactive mode. - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + uid: >- + @microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1) + package: '@microsoft/sp-webpart-base!' fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - langs: - - typeScript - type: method + summary: >- + This API is invoked after updating the new value of the property in the + property bag when the PropertyPane is being used in Reactive mode. + remarks: '' + isPreview: false + isDeprecated: false syntax: - content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' - return: - type: - - void - description: '' + content: >- + protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: + any, newValue: any): void; parameters: - id: propertyPath description: >- - JSON path of the property in the property bag. In the case of custom field, if no target property is - provided then a custom value is assigned, which will be in the form of `__CustomField_`. - type: - - string + JSON path of the property in the property bag. In the case of custom + field, if no target property is provided then a custom value is + assigned, which will be in the form of `__CustomField_`. + type: string - id: oldValue - description: Old value of the property. This value could be undefined/empty in the case of custom field. - type: - - any + description: >- + Old value of the property. This value could be undefined/empty in + the case of custom field. + type: any - id: newValue - description: New value of the property. This value could be undefined/empty in the case of custom field. - type: - - any - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' - summary: This API is invoked when the PropertyPane is rendered. - name: onPropertyPaneRendered() + description: >- + New value of the property. This value could be undefined/empty in + the case of custom field. + type: any + return: + type: void + description: '' + - name: onPropertyPaneRendered() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' + package: '@microsoft/sp-webpart-base!' fullName: onPropertyPaneRendered() - langs: - - typeScript - type: method + summary: This API is invoked when the PropertyPane is rendered. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'protected onPropertyPaneRendered(): void;' return: - type: - - void + type: void description: '' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' - summary: >- - This property points to the preview image for the web part. The base implementation returns undefined. Web parts - that want to provide a valid preview image url need to override this API. The preview image url can be used to - create a preview of the web part or of the page on which the web part is present. - name: previewImageUrl - fullName: previewImageUrl - langs: - - typeScript - type: property - syntax: - content: 'readonly previewImageUrl: string | undefined;' - return: - type: - - string | undefined - - uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' - summary: This property is the pointer to the custom property bag of the web part. - name: properties - fullName: properties - langs: - - typeScript - type: property - syntax: - content: 'protected readonly properties: TProperties;' - return: - type: - - TProperties - - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' - summary: >- - This property defines metadata for the web part property bag. The metadata can help SharePoint understand the - content of the properties better and perform relevant services on the data. - remarks: >- - See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more - information about how to define metadata - name: propertiesMetadata - fullName: propertiesMetadata - langs: - - typeScript - type: property - syntax: - content: 'protected readonly propertiesMetadata: IWebPartPropertiesMetadata | undefined;' - return: - type: - - '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata~0:complex' - - uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' - summary: Title of the WebPart - name: title - fullName: title - langs: - - typeScript - type: property - syntax: - content: 'protected readonly title: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-component-base!BaseComponent:class' - name: BaseComponent - - uid: '@microsoft/sp-property-pane!IPropertyPaneConsumer:interface' - name: IPropertyPaneConsumer - - uid: '@microsoft/sp-webpart-base!default:class' - name: BaseWebPartContext - - uid: '@microsoft/sp-core-library!Version:class' - name: Version - - uid: '@microsoft/sp-core-library!DisplayMode:enum' - name: DisplayMode - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - name: IPropertyPaneConfiguration - - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' - name: Promise - fullName: Promise - spec.typeScript: - - uid: '!Promise:class' - name: Promise - fullName: Promise - - name: - fullName: - - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata~0:complex' - name: IWebPartPropertiesMetadata | undefined - fullName: IWebPartPropertiesMetadata | undefined - spec.typeScript: - - uid: '@microsoft/sp-webpart-base!~IWebPartPropertiesMetadata:interface' - name: IWebPartPropertiesMetadata - fullName: IWebPartPropertiesMetadata - - name: ' | undefined' - fullName: ' | undefined' +extends: '' diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index ae2d8cc0..e29cf15f 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -1,95 +1,75 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' - summary: >- - Web part context object. This object contains the contextual services available to a web part. e.g. a contextual - instance to the http client. +### YamlMime:TSType +name: BaseWebPartContext +uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' +package: '@microsoft/sp-webpart-base!' +fullName: BaseWebPartContext +summary: >- + Web part context object. This object contains the contextual services + available to a web part. e.g. a contextual instance to the http client. - This base is to be extended by UI-specific WebPart's base. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseWebPartContext` class. - name: BaseWebPartContext - fullName: BaseWebPartContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-component-base!BaseComponentContext:class' - inheritance: - - type: '@microsoft/sp-component-base!BaseComponentContext:class' + This base is to be extended by UI-specific WebPart's base. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `BaseWebPartContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: formFactor + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' - - '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' - - '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' - - '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' + fullName: formFactor summary: Form factor of the web part. remarks: >- - Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set - up different margins that when rendering in a canvas. + Web parts may behave differently based on its form factor. E.g. a web part + rendering as full size may want to set up different margins that when + rendering in a canvas. isPreview: true - name: formFactor - fullName: formFactor - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'readonly formFactor: WebPartFormFactor;' return: - type: - - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' - summary: Manifest for the client-side component. - name: manifest + type: '' + - name: manifest + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' + package: '@microsoft/sp-webpart-base!' fullName: manifest - langs: - - typeScript - type: property + summary: Manifest for the client-side component. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: - - '@microsoft/sp-webpart-base!BaseWebPartContext#manifest~0:complex' - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' - summary: Accessor for common web part property pane operations. - name: propertyPane + type: >- + @microsoft/sp-webpart-base!BaseWebPartContext# + - name: propertyPane + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' + package: '@microsoft/sp-webpart-base!' fullName: propertyPane - langs: - - typeScript - type: property + summary: Accessor for common web part property pane operations. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: - type: - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' - summary: Web part tag to be used for logging and telemetry. - name: webPartTag + type: >- + + - name: webPartTag + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' + package: '@microsoft/sp-webpart-base!' fullName: webPartTag - langs: - - typeScript - type: property + summary: Web part tag to be used for logging and telemetry. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'readonly webPartTag: string;' return: - type: - - string -references: - - uid: '@microsoft/sp-component-base!BaseComponentContext:class' - name: BaseComponentContext - - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' - name: WebPartFormFactor - - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest~0:complex' - name: IClientSideWebPartManifestInstance - fullName: IClientSideWebPartManifestInstance - spec.typeScript: - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - name: IClientSideWebPartManifestInstance - fullName: IClientSideWebPartManifestInstance - - name: - fullName: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - name: IPropertyPaneAccessor + type: string +extends: '' diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 250216c3..5275715a 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -1,42 +1,28 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - summary: Enum for the possible values of shared depth of the dynamic data reference. - deprecated: - content: >- - This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. - name: DynamicDataSharedDepth - fullName: DynamicDataSharedDepth - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: DynamicDataSharedDepth +uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' +package: '@microsoft/sp-webpart-base!' +fullName: DynamicDataSharedDepth +summary: Enum for the possible values of shared depth of the dynamic data reference. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This enum has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: None + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' - - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' - - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' - - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' summary: Indicates that nothing is shared. - name: None - fullName: None - langs: - - typeScript - type: field numericValue: '0' - - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' + - name: Property + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' + package: '@microsoft/sp-webpart-base!' summary: Indicates that both the dynamic data source and the property are shared. - name: Property - fullName: Property - langs: - - typeScript - type: field numericValue: '2' - - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' + - name: Source + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' + package: '@microsoft/sp-webpart-base!' summary: Indicates that the dynamic data source is shared. - name: Source - fullName: Source - langs: - - typeScript - type: field numericValue: '1' diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 73622b7a..71361900 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -1,115 +1,98 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - summary: >- - Interface to be implemented by a component that should display the loading indicator and error messages for a web - part. - name: IClientSideWebPartStatusRenderer - fullName: IClientSideWebPartStatusRenderer - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' - summary: Clear the webpart error message. - name: clearError(domElement) - fullName: clearError(domElement) - langs: - - typeScript - type: method - syntax: - content: 'clearError(domElement: HTMLElement): void;' - return: - type: - - void - description: '' - parameters: - - id: domElement - description: the web part container div. - type: - - '!HTMLElement:interface' - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' - summary: Clear the loading indicator. - name: clearLoadingIndicator(domElement) - fullName: clearLoadingIndicator(domElement) - langs: - - typeScript - type: method - syntax: - content: 'clearLoadingIndicator(domElement: Element): void;' - return: - type: - - void - description: '' - parameters: - - id: domElement - description: the web part container div. - type: - - '!Element:interface' - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' - summary: Display a loading spinner. - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - langs: - - typeScript - type: method - syntax: - content: 'displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;' - return: - type: - - void - description: '' - parameters: - - id: domElement - description: the web part container div. - type: - - '!Element:interface' - - id: loadingMessage - description: the message to be displayed when the loading spinner id displayed. - type: - - string - - id: timeout - description: timeout to render the loading indicator. Default is 1500ms. - type: - - number - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' - summary: Render the provided error message in the webpart container div. - name: 'renderError(domElement, error)' - fullName: 'renderError(domElement, error)' - langs: - - typeScript - type: method - syntax: - content: 'renderError(domElement: HTMLElement, error: Error | string): void;' - return: - type: - - void - description: '' - parameters: - - id: domElement - description: the web part container div. - type: - - '!HTMLElement:interface' - - id: error - description: the error message. - type: - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError~0:complex' -references: - - uid: '!HTMLElement:interface' - name: HTMLElement - - uid: '!Element:interface' - name: Element - - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError~0:complex' - name: Error | string - fullName: Error | string - spec.typeScript: - - uid: '!Error:interface' - name: Error - fullName: Error - - name: ' | string' - fullName: ' | string' +### YamlMime:TSType +name: IClientSideWebPartStatusRenderer +uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IClientSideWebPartStatusRenderer +summary: >- + Interface to be implemented by a component that should display the loading + indicator and error messages for a web part. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: clearError(domElement) + uid: >- + @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: clearError(domElement) + summary: Clear the webpart error message. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearError(domElement: HTMLElement): void;' + parameters: + - id: domElement + description: the web part container div. + type: '' + return: + type: void + description: '' + - name: clearLoadingIndicator(domElement) + uid: >- + @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: clearLoadingIndicator(domElement) + summary: Clear the loading indicator. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearLoadingIndicator(domElement: Element): void;' + parameters: + - id: domElement + description: the web part container div. + type: '' + return: + type: void + description: '' + - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' + uid: >- + @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' + summary: Display a loading spinner. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + displayLoadingIndicator(domElement: Element, loadingMessage: string, + timeout?: number): void; + parameters: + - id: domElement + description: the web part container div. + type: '' + - id: loadingMessage + description: the message to be displayed when the loading spinner id displayed. + type: string + - id: timeout + description: timeout to render the loading indicator. Default is 1500ms. + type: number + return: + type: void + description: '' + - name: 'renderError(domElement, error)' + uid: >- + @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: 'renderError(domElement, error)' + summary: Render the provided error message in the webpart container div. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'renderError(domElement: HTMLElement, error: Error | string): void;' + parameters: + - id: domElement + description: the web part container div. + type: '' + - id: error + description: the error message. + type: >- + @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer# + return: + type: void + description: '' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index c426b3d1..57dc3154 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -1,37 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - summary: Configuration related to a shared property. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IDynamicDataSharedPropertyConfiguration - fullName: IDynamicDataSharedPropertyConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~0:complex' - name: SPPropertyPane.IDynamicDataSharedPropertyConfiguration - fullName: SPPropertyPane.IDynamicDataSharedPropertyConfiguration - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - name: IDynamicDataSharedPropertyConfiguration - fullName: IDynamicDataSharedPropertyConfiguration - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~1:complex' - name: SPPropertyPane.IDynamicDataSharedPropertyConfiguration - fullName: SPPropertyPane.IDynamicDataSharedPropertyConfiguration - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - name: IDynamicDataSharedPropertyConfiguration - fullName: IDynamicDataSharedPropertyConfiguration +### YamlMime:TSType +name: IDynamicDataSharedPropertyConfiguration +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedPropertyConfiguration +summary: Configuration related to a shared property. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index e2776324..9201036a 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -1,37 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - summary: Property pane dynamic data property filters. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IDynamicDataSharedPropertyFilters - fullName: IDynamicDataSharedPropertyFilters - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~0:complex' - name: SPPropertyPane.IDynamicDataSharedPropertyFilters - fullName: SPPropertyPane.IDynamicDataSharedPropertyFilters - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedPropertyFilters - fullName: IDynamicDataSharedPropertyFilters - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~1:complex' - name: SPPropertyPane.IDynamicDataSharedPropertyFilters - fullName: SPPropertyPane.IDynamicDataSharedPropertyFilters - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - name: IDynamicDataSharedPropertyFilters - fullName: IDynamicDataSharedPropertyFilters +### YamlMime:TSType +name: IDynamicDataSharedPropertyFilters +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedPropertyFilters +summary: Property pane dynamic data property filters. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 656caef3..7053a543 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -1,37 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - summary: Configuration related to a shared source. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IDynamicDataSharedSourceConfiguration - fullName: IDynamicDataSharedSourceConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~0:complex' - name: SPPropertyPane.IDynamicDataSharedSourceConfiguration - fullName: SPPropertyPane.IDynamicDataSharedSourceConfiguration - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceConfiguration - fullName: IDynamicDataSharedSourceConfiguration - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~1:complex' - name: SPPropertyPane.IDynamicDataSharedSourceConfiguration - fullName: SPPropertyPane.IDynamicDataSharedSourceConfiguration - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceConfiguration - fullName: IDynamicDataSharedSourceConfiguration +### YamlMime:TSType +name: IDynamicDataSharedSourceConfiguration +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedSourceConfiguration +summary: Configuration related to a shared source. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index c8a4b63c..b99f3ad7 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - summary: Property pane dynamic data source filters. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IDynamicDataSharedSourceFilters - fullName: IDynamicDataSharedSourceFilters - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~0:complex' - name: SPPropertyPane.IDynamicDataSharedSourceFilters - fullName: SPPropertyPane.IDynamicDataSharedSourceFilters - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - name: IDynamicDataSharedSourceFilters - fullName: IDynamicDataSharedSourceFilters - - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~1:complex' - name: SPPropertyPane.IDynamicDataSharedSourceFilters - fullName: SPPropertyPane.IDynamicDataSharedSourceFilters - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - name: IDynamicDataSharedSourceFilters - fullName: IDynamicDataSharedSourceFilters +### YamlMime:TSType +name: IDynamicDataSharedSourceFilters +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedSourceFilters +summary: Property pane dynamic data source filters. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index b37d462c..b71273c2 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -1,50 +1,41 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. - name: IMicrosoftTeams - fullName: IMicrosoftTeams - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IMicrosoftTeams +uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IMicrosoftTeams +summary: >- + Provides access to the Teams SDK and Teams context. Only provided when the web + part is loaded in Teams. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: context + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' - - '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' - - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' + fullName: context summary: Microsoft Teams' Context. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) - name: context - fullName: context - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'context: microsoftTeams.Context;' return: - type: - - '@microsoft/sp-webpart-base!IMicrosoftTeams#context~0:complex' - - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' - summary: Microsoft Teams SDK. - name: teamsJs + type: >- + @microsoft/sp-webpart-base!IMicrosoftTeams# + - name: teamsJs + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' + package: '@microsoft/sp-webpart-base!' fullName: teamsJs - langs: - - typeScript - type: property + summary: Microsoft Teams SDK. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'teamsJs: typeof microsoftTeams;' return: - type: - - typeof microsoftTeams -references: - - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context~0:complex' - name: microsoftTeams.Context - fullName: microsoftTeams.Context - spec.typeScript: - - name: microsoftTeams. - fullName: microsoftTeams. - - uid: '@microsoft/teams-js!Context:interface' - name: Context - fullName: Context + type: typeof microsoftTeams diff --git a/SP-Framework/sp-webpart-base/ioffice.yml b/SP-Framework/sp-webpart-base/ioffice.yml index 49aba95f..c0cfe174 100644 --- a/SP-Framework/sp-webpart-base/ioffice.yml +++ b/SP-Framework/sp-webpart-base/ioffice.yml @@ -1,29 +1,25 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IOffice:interface' - summary: Provides access to the Office context. Only provided when the web part is loaded in Office. - isPreview: true - name: IOffice - fullName: IOffice - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IOffice +uid: '@microsoft/sp-webpart-base!IOffice:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IOffice +summary: >- + Provides access to the Office context. Only provided when the web part is + loaded in Office. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: context + uid: '@microsoft/sp-webpart-base!IOffice#context:member' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IOffice#context:member' - - uid: '@microsoft/sp-webpart-base!IOffice#context:member' + fullName: context summary: Microsoft Office SDK. + remarks: '' isPreview: true - name: context - fullName: context - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'context: Office.Context;' return: - type: - - '!Office.Context:interface' -references: - - uid: '!Office.Context:interface' - name: Office.Context + type: '!Office.' diff --git a/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml b/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml index 1dbec14c..028493c7 100644 --- a/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml +++ b/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml @@ -1,37 +1,39 @@ -### YamlMime:UniversalReference -items: - - uid: sp-webpart-base.IPlaceholderSpinnerProps - summary: Interface for properties used to display the loading spinner in the web part display area. - name: IPlaceholderSpinnerProps - fullName: IPlaceholderSpinnerProps - langs: - - typeScript - type: interface - package: sp-webpart-base - children: - - sp-webpart-base.IPlaceholderSpinnerProps.hideSpinner - - sp-webpart-base.IPlaceholderSpinnerProps.label - - uid: sp-webpart-base.IPlaceholderSpinnerProps.hideSpinner - summary: 'Hide spinner at start if set to true. In such case, use state showSpinner to true when to show the spinner' - name: hideSpinner - fullName: hideSpinner - langs: - - typeScript - type: property - syntax: - content: 'hideSpinner?: boolean;' - return: - type: - - boolean - - uid: sp-webpart-base.IPlaceholderSpinnerProps.label - summary: Label associated with the spinner. - name: label - fullName: label - langs: - - typeScript - type: property - syntax: - content: 'label: string;' - return: - type: - - string +### YamlMime:TSType +name: IPlaceholderSpinnerProps +uid: sp-webpart-base.IPlaceholderSpinnerProps +package: sp-webpart-base +fullName: IPlaceholderSpinnerProps +summary: >- + Interface for properties used to display the loading spinner in the web part + display area. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: hideSpinner + uid: sp-webpart-base.IPlaceholderSpinnerProps.hideSpinner + package: sp-webpart-base + fullName: hideSpinner + summary: >- + Hide spinner at start if set to true. In such case, use state showSpinner + to true when to show the spinner + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hideSpinner?: boolean;' + return: + type: boolean + - name: label + uid: sp-webpart-base.IPlaceholderSpinnerProps.label + package: sp-webpart-base + fullName: label + summary: Label associated with the spinner. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label: string;' + return: + type: string diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 0fae5444..1124d56d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -1,109 +1,113 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - summary: >- - Web part context property pane accessor interface. Provides some most commonly used operations to access the - property pane. - name: IPropertyPaneAccessor - fullName: IPropertyPaneAccessor - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' - summary: This API should be used to close the PropertyPane to help configure the web part. - name: close() - fullName: close() - langs: - - typeScript - type: method - syntax: - content: 'close(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' - summary: Returns true if the PropertyPane is open. - name: isPropertyPaneOpen() - fullName: isPropertyPaneOpen() - langs: - - typeScript - type: method - syntax: - content: 'isPropertyPaneOpen(): boolean;' - return: - type: - - boolean - description: '' - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' - summary: Indicates whether the PropertyPane was initially opened by the web part. - remarks: >- - For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if - the property pane was opened by the host, then the value will be false. - name: isRenderedByWebPart() - fullName: isRenderedByWebPart() - langs: - - typeScript - type: method - syntax: - content: 'isRenderedByWebPart(): boolean;' - return: - type: - - boolean - description: '' - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' - summary: This API should be used to open the PropertyPane to help configure the web part. - name: open() - fullName: open() - langs: - - typeScript - type: method - syntax: - content: 'open(): void;' - return: - type: - - void - description: '' - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' - summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. - remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' - name: openDetails(context) - fullName: openDetails(context) - langs: - - typeScript - type: method - syntax: - content: 'openDetails(context?: any): void;' - return: - type: - - void - description: '' - parameters: - - id: context - description: Add additional context for property pane - type: - - any - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' - summary: This API should be used to invoke the PropertyPane to help configure the web part. - remarks: >- - This operation only works when the PropertyPane is already open for the currently active web part. If the - PropertyPane is opened for another web part, calling the refresh API will have no impact. - name: refresh() - fullName: refresh() - langs: - - typeScript - type: method - syntax: - content: 'refresh(): void;' - return: - type: - - void - description: '' +### YamlMime:TSType +name: IPropertyPaneAccessor +uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneAccessor +summary: >- + Web part context property pane accessor interface. Provides some most commonly + used operations to access the property pane. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: close() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: close() + summary: >- + This API should be used to close the PropertyPane to help configure the + web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'close(): void;' + return: + type: void + description: '' + - name: isPropertyPaneOpen() + uid: >- + @microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: isPropertyPaneOpen() + summary: Returns true if the PropertyPane is open. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isPropertyPaneOpen(): boolean;' + return: + type: boolean + description: '' + - name: isRenderedByWebPart() + uid: >- + @microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1) + package: '@microsoft/sp-webpart-base!' + fullName: isRenderedByWebPart() + summary: Indicates whether the PropertyPane was initially opened by the web part. + remarks: >- + For example, if the web part calls this.context.propertyPane.open() then + the property would be true, whereas if the property pane was opened by the + host, then the value will be false. + isPreview: false + isDeprecated: false + syntax: + content: 'isRenderedByWebPart(): boolean;' + return: + type: boolean + description: '' + - name: open() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: open() + summary: >- + This API should be used to open the PropertyPane to help configure the web + part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'open(): void;' + return: + type: void + description: '' + - name: openDetails(context) + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: openDetails(context) + summary: >- + This API should be used to open the Details PropertyPane to help configure + the items in the web part. + remarks: >- + This API is mainly used for configuring Details, which is different from + configuring the web part itself. + isPreview: false + isDeprecated: false + syntax: + content: 'openDetails(context?: any): void;' + parameters: + - id: context + description: Add additional context for property pane + type: any + return: + type: void + description: '' + - name: refresh() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: refresh() + summary: >- + This API should be used to invoke the PropertyPane to help configure the + web part. + remarks: >- + This operation only works when the PropertyPane is already open for the + currently active web part. If the PropertyPane is opened for another web + part, calling the refresh API will have no impact. + isPreview: false + isDeprecated: false + syntax: + content: 'refresh(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 5dc9e106..a4d3e109 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - summary: PropertyPane button props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneButtonProps - fullName: IPropertyPaneButtonProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~0:complex' - name: SPPropertyPane.IPropertyPaneButtonProps - fullName: SPPropertyPane.IPropertyPaneButtonProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - name: IPropertyPaneButtonProps - fullName: IPropertyPaneButtonProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~1:complex' - name: SPPropertyPane.IPropertyPaneButtonProps - fullName: SPPropertyPane.IPropertyPaneButtonProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - name: IPropertyPaneButtonProps - fullName: IPropertyPaneButtonProps +### YamlMime:TSType +name: IPropertyPaneButtonProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneButtonProps +summary: PropertyPane button props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index b033ef96..b138991b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - summary: PropertyPane CheckBox component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneCheckboxProps - fullName: IPropertyPaneCheckboxProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~0:complex' - name: SPPropertyPane.IPropertyPaneCheckboxProps - fullName: SPPropertyPane.IPropertyPaneCheckboxProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneCheckboxProps - fullName: IPropertyPaneCheckboxProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~1:complex' - name: SPPropertyPane.IPropertyPaneCheckboxProps - fullName: SPPropertyPane.IPropertyPaneCheckboxProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - name: IPropertyPaneCheckboxProps - fullName: IPropertyPaneCheckboxProps +### YamlMime:TSType +name: IPropertyPaneCheckboxProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneCheckboxProps +summary: PropertyPane CheckBox component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 017aa245..d2630d48 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - summary: PropertyPane ChoiceGroup option props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneChoiceGroupOption - fullName: IPropertyPaneChoiceGroupOption - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~0:complex' - name: SPPropertyPane.IPropertyPaneChoiceGroupOption - fullName: SPPropertyPane.IPropertyPaneChoiceGroupOption - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - name: IPropertyPaneChoiceGroupOption - fullName: IPropertyPaneChoiceGroupOption - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~1:complex' - name: SPPropertyPane.IPropertyPaneChoiceGroupOption - fullName: SPPropertyPane.IPropertyPaneChoiceGroupOption - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - name: IPropertyPaneChoiceGroupOption - fullName: IPropertyPaneChoiceGroupOption +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOption +uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneChoiceGroupOption +summary: PropertyPane ChoiceGroup option props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 4d8e935b..07e02702 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -1,37 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - summary: PropertyPane ChoiceGroup icon props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneChoiceGroupOptionIconProps - fullName: IPropertyPaneChoiceGroupOptionIconProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~0:complex' - name: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps - fullName: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - name: IPropertyPaneChoiceGroupOptionIconProps - fullName: IPropertyPaneChoiceGroupOptionIconProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~1:complex' - name: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps - fullName: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - name: IPropertyPaneChoiceGroupOptionIconProps - fullName: IPropertyPaneChoiceGroupOptionIconProps +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOptionIconProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneChoiceGroupOptionIconProps +summary: PropertyPane ChoiceGroup icon props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 67219ec4..aacc1648 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - summary: PropertyPane ChoiceGroup props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneChoiceGroupProps - fullName: IPropertyPaneChoiceGroupProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~0:complex' - name: SPPropertyPane.IPropertyPaneChoiceGroupProps - fullName: SPPropertyPane.IPropertyPaneChoiceGroupProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneChoiceGroupProps - fullName: IPropertyPaneChoiceGroupProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~1:complex' - name: SPPropertyPane.IPropertyPaneChoiceGroupProps - fullName: SPPropertyPane.IPropertyPaneChoiceGroupProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - name: IPropertyPaneChoiceGroupProps - fullName: IPropertyPaneChoiceGroupProps +### YamlMime:TSType +name: IPropertyPaneChoiceGroupProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneChoiceGroupProps +summary: PropertyPane ChoiceGroup props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 32c230c9..3648170a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - summary: Property pane conditional group. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneConditionalGroup - fullName: IPropertyPaneConditionalGroup - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~0:complex' - name: SPPropertyPane.IPropertyPaneConditionalGroup - fullName: SPPropertyPane.IPropertyPaneConditionalGroup - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - name: IPropertyPaneConditionalGroup - fullName: IPropertyPaneConditionalGroup - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~1:complex' - name: SPPropertyPane.IPropertyPaneConditionalGroup - fullName: SPPropertyPane.IPropertyPaneConditionalGroup - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - name: IPropertyPaneConditionalGroup - fullName: IPropertyPaneConditionalGroup +### YamlMime:TSType +name: IPropertyPaneConditionalGroup +uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneConditionalGroup +summary: Property pane conditional group. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index afd5af58..1c85ccdf 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - summary: Web part configuration settings - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneConfiguration - fullName: IPropertyPaneConfiguration - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~0:complex' - name: SPPropertyPane.IPropertyPaneConfiguration - fullName: SPPropertyPane.IPropertyPaneConfiguration - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - name: IPropertyPaneConfiguration - fullName: IPropertyPaneConfiguration - - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~1:complex' - name: SPPropertyPane.IPropertyPaneConfiguration - fullName: SPPropertyPane.IPropertyPaneConfiguration - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - name: IPropertyPaneConfiguration - fullName: IPropertyPaneConfiguration +### YamlMime:TSType +name: IPropertyPaneConfiguration +uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneConfiguration +summary: Web part configuration settings +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index f72ac2a1..ccfbc995 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - summary: PropertyPane CustomPropertyField props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneCustomFieldProps - fullName: IPropertyPaneCustomFieldProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~0:complex' - name: SPPropertyPane.IPropertyPaneCustomFieldProps - fullName: SPPropertyPane.IPropertyPaneCustomFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneCustomFieldProps - fullName: IPropertyPaneCustomFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~1:complex' - name: SPPropertyPane.IPropertyPaneCustomFieldProps - fullName: SPPropertyPane.IPropertyPaneCustomFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - name: IPropertyPaneCustomFieldProps - fullName: IPropertyPaneCustomFieldProps +### YamlMime:TSType +name: IPropertyPaneCustomFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneCustomFieldProps +summary: PropertyPane CustomPropertyField props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 8f39e09d..44cdd169 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -1,37 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - summary: PropertyPane dropdown callout properties. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneDropdownCalloutProps - fullName: IPropertyPaneDropdownCalloutProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~0:complex' - name: SPPropertyPane.IPropertyPaneDropdownCalloutProps - fullName: SPPropertyPane.IPropertyPaneDropdownCalloutProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - name: IPropertyPaneDropdownCalloutProps - fullName: IPropertyPaneDropdownCalloutProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~1:complex' - name: SPPropertyPane.IPropertyPaneDropdownCalloutProps - fullName: SPPropertyPane.IPropertyPaneDropdownCalloutProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - name: IPropertyPaneDropdownCalloutProps - fullName: IPropertyPaneDropdownCalloutProps +### YamlMime:TSType +name: IPropertyPaneDropdownCalloutProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDropdownCalloutProps +summary: PropertyPane dropdown callout properties. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index e805a06b..dd9ec41c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - summary: PropertyPane drop down options. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneDropdownOption - fullName: IPropertyPaneDropdownOption - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~0:complex' - name: SPPropertyPane.IPropertyPaneDropdownOption - fullName: SPPropertyPane.IPropertyPaneDropdownOption - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownOption - fullName: IPropertyPaneDropdownOption - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~1:complex' - name: SPPropertyPane.IPropertyPaneDropdownOption - fullName: SPPropertyPane.IPropertyPaneDropdownOption - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownOption - fullName: IPropertyPaneDropdownOption +### YamlMime:TSType +name: IPropertyPaneDropdownOption +uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDropdownOption +summary: PropertyPane drop down options. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 2e643bb7..49329048 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - summary: PropertyPane drop down component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneDropdownProps - fullName: IPropertyPaneDropdownProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~0:complex' - name: SPPropertyPane.IPropertyPaneDropdownProps - fullName: SPPropertyPane.IPropertyPaneDropdownProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDropdownProps - fullName: IPropertyPaneDropdownProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~1:complex' - name: SPPropertyPane.IPropertyPaneDropdownProps - fullName: SPPropertyPane.IPropertyPaneDropdownProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - name: IPropertyPaneDropdownProps - fullName: IPropertyPaneDropdownProps +### YamlMime:TSType +name: IPropertyPaneDropdownProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDropdownProps +summary: PropertyPane drop down component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 18ae1fe2..a44c59bd 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -1,37 +1,18 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - summary: Property pane dynamic field filters which is an intersection of both source and property filters. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneDynamicFieldFilters - fullName: IPropertyPaneDynamicFieldFilters - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~0:complex' - name: SPPropertyPane.IPropertyPaneDynamicFieldFilters - fullName: SPPropertyPane.IPropertyPaneDynamicFieldFilters - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - name: IPropertyPaneDynamicFieldFilters - fullName: IPropertyPaneDynamicFieldFilters - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~1:complex' - name: SPPropertyPane.IPropertyPaneDynamicFieldFilters - fullName: SPPropertyPane.IPropertyPaneDynamicFieldFilters - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - name: IPropertyPaneDynamicFieldFilters - fullName: IPropertyPaneDynamicFieldFilters +### YamlMime:TSType +name: IPropertyPaneDynamicFieldFilters +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicFieldFilters +summary: >- + Property pane dynamic field filters which is an intersection of both source + and property filters. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 4b891b82..2a36b8c5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - summary: PropertyPaneDynamicField props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~0:complex' - name: SPPropertyPane.IPropertyPaneDynamicFieldProps - fullName: SPPropertyPane.IPropertyPaneDynamicFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~1:complex' - name: SPPropertyPane.IPropertyPaneDynamicFieldProps - fullName: SPPropertyPane.IPropertyPaneDynamicFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldProps - fullName: IPropertyPaneDynamicFieldProps +### YamlMime:TSType +name: IPropertyPaneDynamicFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicFieldProps +summary: PropertyPaneDynamicField props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 9740264d..f6d107ba 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -1,37 +1,17 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - summary: PropertyPane DynamicFieldSet props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneDynamicFieldSetProps - fullName: IPropertyPaneDynamicFieldSetProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~0:complex' - name: SPPropertyPane.IPropertyPaneDynamicFieldSetProps - fullName: SPPropertyPane.IPropertyPaneDynamicFieldSetProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicFieldSetProps - fullName: IPropertyPaneDynamicFieldSetProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~1:complex' - name: SPPropertyPane.IPropertyPaneDynamicFieldSetProps - fullName: SPPropertyPane.IPropertyPaneDynamicFieldSetProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - name: IPropertyPaneDynamicFieldSetProps - fullName: IPropertyPaneDynamicFieldSetProps +### YamlMime:TSType +name: IPropertyPaneDynamicFieldSetProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicFieldSetProps +summary: PropertyPane DynamicFieldSet props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index d231515f..949af5f4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -1,36 +1,15 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - summary: '`PropertyPaneDynamicData` component props.' - deprecated: - content: '- This has been replaced by IPropertyPaneDynamicFieldProps' - isPreview: true - name: IPropertyPaneDynamicTextFieldProps - fullName: IPropertyPaneDynamicTextFieldProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~0:complex' - name: SPPropertyPane.IPropertyPaneDynamicTextFieldProps - fullName: SPPropertyPane.IPropertyPaneDynamicTextFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneDynamicTextFieldProps - fullName: IPropertyPaneDynamicTextFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~1:complex' - name: SPPropertyPane.IPropertyPaneDynamicTextFieldProps - fullName: SPPropertyPane.IPropertyPaneDynamicTextFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - name: IPropertyPaneDynamicTextFieldProps - fullName: IPropertyPaneDynamicTextFieldProps +### YamlMime:TSType +name: IPropertyPaneDynamicTextFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicTextFieldProps +summary: '`PropertyPaneDynamicData` component props.' +remarks: '' +isPreview: true +isDeprecated: true +customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 205f229d..4eae167c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -1,44 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - summary: PropertyPane field. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneField - fullName: IPropertyPaneField - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' - syntax: - typeParameters: - - id: TProperties - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' - name: SPPropertyPane.IPropertyPaneField - fullName: SPPropertyPane.IPropertyPaneField - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: ' ' - fullName: ' ' - - uid: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' - name: SPPropertyPane.IPropertyPaneField - fullName: SPPropertyPane.IPropertyPaneField - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneField - fullName: IPropertyPaneField - - name: ' ' - fullName: ' ' +### YamlMime:TSType +name: IPropertyPaneField +uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneField +summary: PropertyPane field. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index b985779f..bf2955dc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - summary: PropertyPane group. Group is part of the PropertyPanePage. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneGroup - fullName: IPropertyPaneGroup - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneGroup~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneGroup~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup~0:complex' - name: SPPropertyPane.IPropertyPaneGroup - fullName: SPPropertyPane.IPropertyPaneGroup - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - name: IPropertyPaneGroup - fullName: IPropertyPaneGroup - - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup~1:complex' - name: SPPropertyPane.IPropertyPaneGroup - fullName: SPPropertyPane.IPropertyPaneGroup - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - name: IPropertyPaneGroup - fullName: IPropertyPaneGroup +### YamlMime:TSType +name: IPropertyPaneGroup +uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneGroup +summary: PropertyPane group. Group is part of the PropertyPanePage. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index 18f19d3e..9c0cf506 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - summary: PropertyPaneLabel component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneLabelProps - fullName: IPropertyPaneLabelProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~0:complex' - name: SPPropertyPane.IPropertyPaneLabelProps - fullName: SPPropertyPane.IPropertyPaneLabelProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLabelProps - fullName: IPropertyPaneLabelProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~1:complex' - name: SPPropertyPane.IPropertyPaneLabelProps - fullName: SPPropertyPane.IPropertyPaneLabelProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLabelProps - fullName: IPropertyPaneLabelProps +### YamlMime:TSType +name: IPropertyPaneLabelProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneLabelProps +summary: PropertyPaneLabel component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index c67f348e..25eab8db 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - summary: PropertyPaneLink component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneLinkProps - fullName: IPropertyPaneLinkProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~0:complex' - name: SPPropertyPane.IPropertyPaneLinkProps - fullName: SPPropertyPane.IPropertyPaneLinkProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - name: IPropertyPaneLinkProps - fullName: IPropertyPaneLinkProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~1:complex' - name: SPPropertyPane.IPropertyPaneLinkProps - fullName: SPPropertyPane.IPropertyPaneLinkProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - name: IPropertyPaneLinkProps - fullName: IPropertyPaneLinkProps +### YamlMime:TSType +name: IPropertyPaneLinkProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneLinkProps +summary: PropertyPaneLink component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index cb73d7e8..e4a4f806 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - summary: PropertyPanePage interface. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPanePage - fullName: IPropertyPanePage - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPanePage~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPanePage~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPanePage~0:complex' - name: SPPropertyPane.IPropertyPanePage - fullName: SPPropertyPane.IPropertyPanePage - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' - name: IPropertyPanePage - fullName: IPropertyPanePage - - uid: '@microsoft/sp-webpart-base!IPropertyPanePage~1:complex' - name: SPPropertyPane.IPropertyPanePage - fullName: SPPropertyPane.IPropertyPanePage - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' - name: IPropertyPanePage - fullName: IPropertyPanePage +### YamlMime:TSType +name: IPropertyPanePage +uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPanePage +summary: PropertyPanePage interface. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index e498c3aa..9c39d8c8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - summary: PropertyPane header. This header remains same for all the pages. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPanePageHeader - fullName: IPropertyPanePageHeader - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPanePageHeader~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~0:complex' - name: SPPropertyPane.IPropertyPanePageHeader - fullName: SPPropertyPane.IPropertyPanePageHeader - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - name: IPropertyPanePageHeader - fullName: IPropertyPanePageHeader - - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~1:complex' - name: SPPropertyPane.IPropertyPanePageHeader - fullName: SPPropertyPane.IPropertyPanePageHeader - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - name: IPropertyPanePageHeader - fullName: IPropertyPanePageHeader +### YamlMime:TSType +name: IPropertyPanePageHeader +uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPanePageHeader +summary: PropertyPane header. This header remains same for all the pages. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index d73275cf..0d93a267 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - summary: PropertyPaneSliderProps component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneSliderProps - fullName: IPropertyPaneSliderProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~0:complex' - name: SPPropertyPane.IPropertyPaneSliderProps - fullName: SPPropertyPane.IPropertyPaneSliderProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - name: IPropertyPaneSliderProps - fullName: IPropertyPaneSliderProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~1:complex' - name: SPPropertyPane.IPropertyPaneSliderProps - fullName: SPPropertyPane.IPropertyPaneSliderProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - name: IPropertyPaneSliderProps - fullName: IPropertyPaneSliderProps +### YamlMime:TSType +name: IPropertyPaneSliderProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneSliderProps +summary: PropertyPaneSliderProps component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 7a252708..050c6dae 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -1,37 +1,16 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - summary: PropertyPaneTextField component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneTextFieldProps - fullName: IPropertyPaneTextFieldProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~0:complex' - name: SPPropertyPane.IPropertyPaneTextFieldProps - fullName: SPPropertyPane.IPropertyPaneTextFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneTextFieldProps - fullName: IPropertyPaneTextFieldProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~1:complex' - name: SPPropertyPane.IPropertyPaneTextFieldProps - fullName: SPPropertyPane.IPropertyPaneTextFieldProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - name: IPropertyPaneTextFieldProps - fullName: IPropertyPaneTextFieldProps +### YamlMime:TSType +name: IPropertyPaneTextFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneTextFieldProps +summary: PropertyPaneTextField component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: >- + diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index e6445ba8..71ba55e7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -1,37 +1,14 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - summary: PropertyPaneToggle component props. - deprecated: - content: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - name: IPropertyPaneToggleProps - fullName: IPropertyPaneToggleProps - langs: - - typeScript - type: interface - extends: - - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~0:complex' - inheritance: - - type: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~1:complex' - package: '@microsoft/sp-webpart-base!' -references: - - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~0:complex' - name: SPPropertyPane.IPropertyPaneToggleProps - fullName: SPPropertyPane.IPropertyPaneToggleProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - name: IPropertyPaneToggleProps - fullName: IPropertyPaneToggleProps - - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~1:complex' - name: SPPropertyPane.IPropertyPaneToggleProps - fullName: SPPropertyPane.IPropertyPaneToggleProps - spec.typeScript: - - name: SPPropertyPane. - fullName: SPPropertyPane. - - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - name: IPropertyPaneToggleProps - fullName: IPropertyPaneToggleProps +### YamlMime:TSType +name: IPropertyPaneToggleProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneToggleProps +summary: PropertyPaneToggle component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +type: interface +extends: '' diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index 6d89dbbe..72a9c1ec 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -1,53 +1,43 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!ISDKs:interface' - summary: Conditional set of SDKs provided by SPFx dependent on the environment. - name: ISDKs - fullName: ISDKs - langs: - - typeScript - type: interface +### YamlMime:TSType +name: ISDKs +uid: '@microsoft/sp-webpart-base!ISDKs:interface' +package: '@microsoft/sp-webpart-base!' +fullName: ISDKs +summary: Conditional set of SDKs provided by SPFx dependent on the environment. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: microsoftTeams + uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' - - '@microsoft/sp-webpart-base!ISDKs#office:member' - - uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' + fullName: microsoftTeams summary: >- - Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is - being hosted in Microsoft Teams. + Contextual information about the current Microsoft Teams tab. This object + will only be defined if a component is being hosted in Microsoft Teams. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - name: microsoftTeams - fullName: microsoftTeams - langs: - - typeScript - type: property + isPreview: false + isDeprecated: false syntax: content: 'microsoftTeams?: IMicrosoftTeams;' return: - type: - - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - - uid: '@microsoft/sp-webpart-base!ISDKs#office:member' + type: '' + - name: office + uid: '@microsoft/sp-webpart-base!ISDKs#office:member' + package: '@microsoft/sp-webpart-base!' + fullName: office summary: >- - Contextual information about the current Office app. This object will only be defined if a component is being - hosted in an Office app. + Contextual information about the current Office app. This object will only + be defined if a component is being hosted in an Office app. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office](https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office) isPreview: true - name: office - fullName: office - langs: - - typeScript - type: property + isDeprecated: false syntax: content: 'office?: IOffice;' return: - type: - - '@microsoft/sp-webpart-base!IOffice:interface' -references: - - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - name: IMicrosoftTeams - - uid: '@microsoft/sp-webpart-base!IOffice:interface' - name: IOffice + type: '' diff --git a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index 7409a7ec..3eb0dd0f 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -1,145 +1,159 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - summary: Contains collections of data that can be processed by server side services like search index and link fixup - name: ISerializedServerProcessedData - fullName: ISerializedServerProcessedData - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#htmlStrings:member' - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#imageSources:member' - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#links:member' - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData#searchablePlainTexts:member' - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#htmlStrings:member' - summary: A key-value map where keys are string identifiers and values are rich text with HTML format. - remarks: >- - SharePoint servers treat the values as HTML content and run services like safety checks, search index and link - fixup on them. - - - Example: - - - ``` - - { - 'myRichDescription': '
Some standard HTML contentA Link
' - 'anotherRichText':
Some red text
- } - - - ``` - name: htmlStrings - fullName: htmlStrings - langs: - - typeScript - type: property - syntax: - content: |- - htmlStrings?: { - [key: string]: string; - }; - return: - type: - - |- - { - [key: string]: string; - } - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#imageSources:member' - summary: A key-value map where keys are string identifiers and values are image sources. - remarks: |- - SharePoint servers treat the values as image sources and run services like search index and link fixup on them. - - Example: - - ``` - { - 'myImage1': 'http://res.contoso.com/path/to/file' - 'myImage2': 'https://res.contoso.com/someName.jpg' - } - - ``` - name: imageSources - fullName: imageSources - langs: - - typeScript - type: property - syntax: - content: |- - imageSources?: { - [key: string]: string; - }; - return: - type: - - |- - { - [key: string]: string; - } - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#links:member' - summary: A key-value map where keys are string identifiers and values are links. - remarks: |- - SharePoint servers treat the values as links and run services like link fixup on them. - - Example: - - ``` - { - 'myWebURL': 'http://contoso.com' - 'myFileLink': 'https://res.contoso.com/file.docx' - } - - ``` - name: links - fullName: links - langs: - - typeScript - type: property - syntax: - content: |- - links?: { - [key: string]: string; - }; - return: - type: - - |- - { - [key: string]: string; - } - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#searchablePlainTexts:member' - summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. - remarks: >- - The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, - but are not treated as valid HTML. So, other services such as link fixup will not run on them. - - - Example: - - - ``` - - { - 'justSomeText': 'This is some plain text', - 'anotherText': 'Can have characters here: "<>&\'' - } - - - ``` - name: searchablePlainTexts - fullName: searchablePlainTexts - langs: - - typeScript - type: property - syntax: - content: |- - searchablePlainTexts?: { - [key: string]: string; - }; - return: - type: - - |- - { - [key: string]: string; - } +### YamlMime:TSType +name: ISerializedServerProcessedData +uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' +package: '@microsoft/sp-webpart-base!' +fullName: ISerializedServerProcessedData +summary: >- + Contains collections of data that can be processed by server side services + like search index and link fixup +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: htmlStrings + uid: >- + @microsoft/sp-webpart-base!ISerializedServerProcessedData#htmlStrings:member + package: '@microsoft/sp-webpart-base!' + fullName: htmlStrings + summary: >- + A key-value map where keys are string identifiers and values are rich text + with HTML format. + remarks: >- + SharePoint servers treat the values as HTML content and run services like + safety checks, search index and link fixup on them. + + + Example: + + + ``` + + { + 'myRichDescription': '
Some standard HTML contentA Link
' + 'anotherRichText':
Some red text
+ } + + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + htmlStrings?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: imageSources + uid: >- + @microsoft/sp-webpart-base!ISerializedServerProcessedData#imageSources:member + package: '@microsoft/sp-webpart-base!' + fullName: imageSources + summary: >- + A key-value map where keys are string identifiers and values are image + sources. + remarks: >- + SharePoint servers treat the values as image sources and run services like + search index and link fixup on them. + + + Example: + + + ``` + + { + 'myImage1': 'http://res.contoso.com/path/to/file' + 'myImage2': 'https://res.contoso.com/someName.jpg' + } + + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + imageSources?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: links + uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData#links:member' + package: '@microsoft/sp-webpart-base!' + fullName: links + summary: A key-value map where keys are string identifiers and values are links. + remarks: >- + SharePoint servers treat the values as links and run services like link + fixup on them. + + + Example: + + + ``` + + { + 'myWebURL': 'http://contoso.com' + 'myFileLink': 'https://res.contoso.com/file.docx' + } + + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + links?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: searchablePlainTexts + uid: >- + @microsoft/sp-webpart-base!ISerializedServerProcessedData#searchablePlainTexts:member + package: '@microsoft/sp-webpart-base!' + fullName: searchablePlainTexts + summary: >- + A key-value map where keys are string identifiers and values are strings + that should be search indexed. + remarks: >- + The values are HTML-encoded before being sent to the server. The encoded + values are visible to the search indexer, but are not treated as valid + HTML. So, other services such as link fixup will not run on them. + + + Example: + + + ``` + + { + 'justSomeText': 'This is some plain text', + 'anotherText': 'Can have characters here: "<>&\'' + } + + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + searchablePlainTexts?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index 0d25d154..d4f47ee2 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -1,144 +1,151 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - summary: >- - This structure represents the part of the serialized state of a web part which is controlled by the web part. It - is extended by IWebPartData which contains additional data added by the framework to the serialized data. - name: ISerializedWebPartData - fullName: ISerializedWebPartData - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' - - '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' - - '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' - - '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' - - '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' - summary: Web part data version. - remarks: >- - Note that data version is different from the version field in the manifest. The manifest version is used to - control the versioning of the web part code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web part for more information. - - - Supported values: MAJOR.MINOR - - - Example: `"1.0"` - name: dataVersion - fullName: dataVersion - langs: - - typeScript - type: property - syntax: - content: 'dataVersion: Version;' - return: - type: - - '@microsoft/sp-core-library!Version:class' - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' - summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. - remarks: |- - The key is the path within the web part properties, and the value is the dynamic data internal id. - - Example: - - ``` - { - 'pageContextUser': - 'PageContext:user', - 'anotherWebPartProperty': - 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' - } - - ``` - isPreview: true - name: dynamicDataPaths - fullName: dynamicDataPaths - langs: - - typeScript - type: property - syntax: - content: |- - dynamicDataPaths?: { - [path: string]: string; - }; - return: - type: - - |- - { - [path: string]: string; - } - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' - summary: >- - Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the - web part. - remarks: |- - The key is the path within the web part properties, and the value is the dynamic data static value. - - Example: - - ``` - { - 'aStringProperty': 'thisIsAString', - 'aBooleanProperty': true - } - - ``` - isPreview: true - name: dynamicDataValues - fullName: dynamicDataValues - langs: - - typeScript - type: property - syntax: - content: |- - dynamicDataValues?: { - [path: string]: any; - }; - return: - type: - - |- - { - [path: string]: any; - } - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' - summary: Web part specific properties. The individual web part owns the definition of these properties. - remarks: >- - Used by the web part to manage its internal metadata and config data. The framework code never touches these - properties. - - - Supported values: any JSON stringifiable object hierarchy. - - - Example: `{ 'value': 'text value' }` - name: properties - fullName: properties - langs: - - typeScript - type: property - syntax: - content: 'properties?: any;' - return: - type: - - any - - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' - summary: The collections of data that can be processed by server side services like search index and link fixup. - name: serverProcessedContent - fullName: serverProcessedContent - langs: - - typeScript - type: property - syntax: - content: 'serverProcessedContent?: ISerializedServerProcessedData;' - return: - type: - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' -references: - - uid: '@microsoft/sp-core-library!Version:class' - name: Version - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - name: ISerializedServerProcessedData +### YamlMime:TSType +name: ISerializedWebPartData +uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' +package: '@microsoft/sp-webpart-base!' +fullName: ISerializedWebPartData +summary: >- + This structure represents the part of the serialized state of a web part which + is controlled by the web part. It is extended by IWebPartData which contains + additional data added by the framework to the serialized data. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataVersion + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' + package: '@microsoft/sp-webpart-base!' + fullName: dataVersion + summary: Web part data version. + remarks: >- + Note that data version is different from the version field in the + manifest. The manifest version is used to control the versioning of the + web part code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web + part for more information. + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: false + isDeprecated: false + syntax: + content: 'dataVersion: Version;' + return: + type: '' + - name: dynamicDataPaths + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataPaths + summary: >- + Paths for the dynamic data. This is used to reconstruct the dynamic data + objects when deserializing the web part. + remarks: >- + The key is the path within the web part properties, and the value is the + dynamic data internal id. + + + Example: + + + ``` + + { + 'pageContextUser': + 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' + } + + + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataPaths?: { + [path: string]: string; + }; + return: + type: |- + { + [path: string]: string; + } + - name: dynamicDataValues + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataValues + summary: >- + Static values for the dynamic data. This is used to reconstruct the + dynamic data objects when deserializing the web part. + remarks: >- + The key is the path within the web part properties, and the value is the + dynamic data static value. + + + Example: + + + ``` + + { + 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true + } + + + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataValues?: { + [path: string]: any; + }; + return: + type: |- + { + [path: string]: any; + } + - name: properties + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' + package: '@microsoft/sp-webpart-base!' + fullName: properties + summary: >- + Web part specific properties. The individual web part owns the definition + of these properties. + remarks: >- + Used by the web part to manage its internal metadata and config data. The + framework code never touches these properties. + + + Supported values: any JSON stringifiable object hierarchy. + + + Example: `{ 'value': 'text value' }` + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: any;' + return: + type: any + - name: serverProcessedContent + uid: >- + @microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member + package: '@microsoft/sp-webpart-base!' + fullName: serverProcessedContent + summary: >- + The collections of data that can be processed by server side services like + search index and link fixup. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'serverProcessedContent?: ISerializedServerProcessedData;' + return: + type: >- + diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 3625e532..4f9c7772 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -1,158 +1,132 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' - summary: The base context interface for client-side web parts. - remarks: >- - A "context" object is a collection of well-known services and other objects that are likely to be needed by any - business logic working with a component. Each component type has its own specialized extension of this interface, - e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. - deprecated: - content: >- - - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. - name: IWebPartContext - fullName: IWebPartContext - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' - - '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' - - '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' - - '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' - - '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' - - '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' - - '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' - - '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' - - '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' - summary: Reference to the DOM element that hosts this client-side component. - name: domElement - fullName: domElement - langs: - - typeScript - type: property - syntax: - content: 'readonly domElement: HTMLElement;' - return: - type: - - '!HTMLElement:interface' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' - summary: HttpClient instance scoped to this web part. - name: httpClient - fullName: httpClient - langs: - - typeScript - type: property - syntax: - content: 'readonly httpClient: HttpClient;' - return: - type: - - '@microsoft/sp-http!HttpClient:class' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' - summary: Web part instance id. This is a globally unique value. - name: instanceId - fullName: instanceId - langs: - - typeScript - type: property - syntax: - content: 'readonly instanceId: string;' - return: - type: - - string - - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' - summary: Manifest for the client-side web part. - name: manifest - fullName: manifest - langs: - - typeScript - type: property - syntax: - content: 'readonly manifest: IClientSideWebPartManifestInstance;' - return: - type: - - '@microsoft/sp-webpart-base!IWebPartContext#manifest~0:complex' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' - summary: SharePoint page context. - name: pageContext - fullName: pageContext - langs: - - typeScript - type: property - syntax: - content: 'readonly pageContext: PageContext;' - return: - type: - - '@microsoft/sp-page-context!PageContext:class' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' - summary: Accessor for common web part property pane operations. - name: propertyPane - fullName: propertyPane - langs: - - typeScript - type: property - syntax: - content: 'readonly propertyPane: IPropertyPaneAccessor;' - return: - type: - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' - summary: SPHttpClient instance scoped to this web part. - name: spHttpClient - fullName: spHttpClient - langs: - - typeScript - type: property - syntax: - content: 'readonly spHttpClient: SPHttpClient;' - return: - type: - - '@microsoft/sp-http!SPHttpClient:class' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' - summary: Web part status renderer. - name: statusRenderer - fullName: statusRenderer - langs: - - typeScript - type: property - syntax: - content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' - return: - type: - - '@microsoft/sp-webpart-base!default:interface' - - uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' - summary: Web part tag to be used for logging and telemetry. - name: webPartTag - fullName: webPartTag - langs: - - typeScript - type: property - syntax: - content: 'readonly webPartTag: string;' - return: - type: - - string -references: - - uid: '!HTMLElement:interface' - name: HTMLElement - - uid: '@microsoft/sp-http!HttpClient:class' - name: HttpClient - - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest~0:complex' - name: IClientSideWebPartManifestInstance - fullName: IClientSideWebPartManifestInstance - spec.typeScript: - - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - name: IClientSideWebPartManifestInstance - fullName: IClientSideWebPartManifestInstance - - name: - fullName: - - uid: '@microsoft/sp-page-context!PageContext:class' - name: PageContext - - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - name: IPropertyPaneAccessor - - uid: '@microsoft/sp-http!SPHttpClient:class' - name: SPHttpClient - - uid: '@microsoft/sp-webpart-base!default:interface' - name: IClientSideWebPartStatusRenderer +### YamlMime:TSType +name: IWebPartContext +uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartContext +summary: The base context interface for client-side web parts. +remarks: >- + A "context" object is a collection of well-known services and other objects + that are likely to be needed by any business logic working with a component. + Each component type has its own specialized extension of this interface, e.g. + IWebPartContext for web parts, IExtensionContext for client-side extensions, + etc. +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + - This interface will be removed in an upcoming release. Use the + [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class + instead. +type: interface +properties: + - name: domElement + uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' + package: '@microsoft/sp-webpart-base!' + fullName: domElement + summary: Reference to the DOM element that hosts this client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLElement;' + return: + type: '' + - name: httpClient + uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' + package: '@microsoft/sp-webpart-base!' + fullName: httpClient + summary: HttpClient instance scoped to this web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly httpClient: HttpClient;' + return: + type: '' + - name: instanceId + uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' + package: '@microsoft/sp-webpart-base!' + fullName: instanceId + summary: Web part instance id. This is a globally unique value. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly instanceId: string;' + return: + type: string + - name: manifest + uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' + package: '@microsoft/sp-webpart-base!' + fullName: manifest + summary: Manifest for the client-side web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IClientSideWebPartManifestInstance;' + return: + type: >- + @microsoft/sp-webpart-base!IWebPartContext# + - name: pageContext + uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' + package: '@microsoft/sp-webpart-base!' + fullName: pageContext + summary: SharePoint page context. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pageContext: PageContext;' + return: + type: '' + - name: propertyPane + uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' + package: '@microsoft/sp-webpart-base!' + fullName: propertyPane + summary: Accessor for common web part property pane operations. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly propertyPane: IPropertyPaneAccessor;' + return: + type: >- + + - name: spHttpClient + uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' + package: '@microsoft/sp-webpart-base!' + fullName: spHttpClient + summary: SPHttpClient instance scoped to this web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly spHttpClient: SPHttpClient;' + return: + type: '' + - name: statusRenderer + uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' + package: '@microsoft/sp-webpart-base!' + fullName: statusRenderer + summary: Web part status renderer. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' + return: + type: '' + - name: webPartTag + uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' + package: '@microsoft/sp-webpart-base!' + fullName: webPartTag + summary: Web part tag to be used for logging and telemetry. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly webPartTag: string;' + return: + type: string diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 7ca29c43..187c84d5 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -1,220 +1,220 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' - summary: This structure represents the serialized state of a web part. - remarks: >- - When the `serialize()` API is called on a web part, the output should be this structure. The structure of the - 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of - properties it wants to serialize. - name: IWebPartData - fullName: IWebPartData - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' - - '@microsoft/sp-webpart-base!IWebPartData#description:member' - - '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' - - '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' - - '@microsoft/sp-webpart-base!IWebPartData#id:member' - - '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' - - '@microsoft/sp-webpart-base!IWebPartData#properties:member' - - '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' - - '@microsoft/sp-webpart-base!IWebPartData#title:member' - - uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' - summary: Web part data version - remarks: >- - Note that data version is different from the version field in the manifest. The manifest version is used to - control the versioning of the web part code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web part for more information. - - - Supported values: MAJOR.MINOR - - - Example: `"1.0"` - name: dataVersion - fullName: dataVersion - langs: - - typeScript - type: property - syntax: - content: 'dataVersion: string;' - return: - type: - - string - - uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' - summary: Web part description - remarks: |- - Used to display the description of the web part. - - Supported values: string with the description. - - Example: `"Text"` - name: description - fullName: description - langs: - - typeScript - type: property - syntax: - content: 'description?: string;' - return: - type: - - string - - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' - summary: Paths for the dynamic data. - remarks: >- - This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within - the web part properties, and the value is the dynamic data internal id. - - - Example: - - - ``` - - { - 'pageContextUser': - 'PageContext:user', - 'anotherWebPartProperty': - 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' - } - - - ``` - isPreview: true - name: dynamicDataPaths - fullName: dynamicDataPaths - langs: - - typeScript - type: property - syntax: - content: |- - dynamicDataPaths?: { - [path: string]: string; - }; - return: - type: - - |- - { - [path: string]: string; - } - - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' - summary: >- - Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web - part. - remarks: |- - The key is the path within the web part properties, and the value is the dynamic data static value. - - Example: - - ``` - { - 'aStringProperty': 'thisIsAString', - 'aBooleanProperty': true - } - - ``` - isPreview: true - name: dynamicDataValues - fullName: dynamicDataValues - langs: - - typeScript - type: property - syntax: - content: |- - dynamicDataValues?: { - [path: string]: any; - }; - return: - type: - - |- - { - [path: string]: any; - } - - uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' - summary: Universally unique web part Type id. - remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' - name: id - fullName: id - langs: - - typeScript - type: property - syntax: - content: 'id: string;' - return: - type: - - string - - uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' - summary: >- - Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is - expected to be universally unique across time and page boundaries. - remarks: |- - supported values: a unique string. Could be GUID or other uniquely identifiable formats. - - example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` - name: instanceId - fullName: instanceId - langs: - - typeScript - type: property - syntax: - content: 'instanceId: string;' - return: - type: - - string - - uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' - summary: Web part specific properties. The individual web part owns the definition of these properties. - remarks: >- - Used by the web part to manage its internal metadata and config data. The framework code never touches these - properties. - - - Supported values: any object hierarchy that can be serialized using `JSON.stringify()`. - - - Example: `{ 'value': 'text value' }` - name: properties - fullName: properties - langs: - - typeScript - type: property - syntax: - content: 'properties?: any;' - return: - type: - - any - - uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' - summary: The collections of data that can be processed by server side services like search index and link fixup - name: serverProcessedContent - fullName: serverProcessedContent - langs: - - typeScript - type: property - syntax: - content: 'serverProcessedContent?: ISerializedServerProcessedData;' - return: - type: - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - - uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' - summary: Web part title - remarks: |- - Used to display the name of the web part in the toolbox, web part gallery and the page. - - Supported values: string less than 100 characters - - Example: `"Text"` - name: title - fullName: title - langs: - - typeScript - type: property - syntax: - content: 'title: string;' - return: - type: - - string -references: - - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - name: ISerializedServerProcessedData +### YamlMime:TSType +name: IWebPartData +uid: '@microsoft/sp-webpart-base!IWebPartData:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartData +summary: This structure represents the serialized state of a web part. +remarks: >- + When the `serialize()` API is called on a web part, the output should be this + structure. The structure of the 'properties' field is owned by the web part + and is specific to the web part. Each web part can decide the set of + properties it wants to serialize. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataVersion + uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' + package: '@microsoft/sp-webpart-base!' + fullName: dataVersion + summary: Web part data version + remarks: >- + Note that data version is different from the version field in the + manifest. The manifest version is used to control the versioning of the + web part code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web + part for more information. + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: false + isDeprecated: false + syntax: + content: 'dataVersion: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' + package: '@microsoft/sp-webpart-base!' + fullName: description + summary: Web part description + remarks: |- + Used to display the description of the web part. + + Supported values: string with the description. + + Example: `"Text"` + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: dynamicDataPaths + uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataPaths + summary: Paths for the dynamic data. + remarks: >- + This is used to reconstruct the dynamic data objects when deserializing + the web part. The key is the path within the web part properties, and the + value is the dynamic data internal id. + + + Example: + + + ``` + + { + 'pageContextUser': + 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' + } + + + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataPaths?: { + [path: string]: string; + }; + return: + type: |- + { + [path: string]: string; + } + - name: dynamicDataValues + uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataValues + summary: >- + Static values for the dynamic data.This is used to reconstruct the dynamic + data objects when deserializing the web part. + remarks: >- + The key is the path within the web part properties, and the value is the + dynamic data static value. + + + Example: + + + ``` + + { + 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true + } + + + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataValues?: { + [path: string]: any; + }; + return: + type: |- + { + [path: string]: any; + } + - name: id + uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' + package: '@microsoft/sp-webpart-base!' + fullName: id + summary: Universally unique web part Type id. + remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: instanceId + uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' + package: '@microsoft/sp-webpart-base!' + fullName: instanceId + summary: >- + Universally unique instance id of the web part. A web part can have + multiple instances on a page. This id is expected to be universally unique + across time and page boundaries. + remarks: >- + supported values: a unique string. Could be GUID or other uniquely + identifiable formats. + + + example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` + isPreview: false + isDeprecated: false + syntax: + content: 'instanceId: string;' + return: + type: string + - name: properties + uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' + package: '@microsoft/sp-webpart-base!' + fullName: properties + summary: >- + Web part specific properties. The individual web part owns the definition + of these properties. + remarks: >- + Used by the web part to manage its internal metadata and config data. The + framework code never touches these properties. + + + Supported values: any object hierarchy that can be serialized using + `JSON.stringify()`. + + + Example: `{ 'value': 'text value' }` + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: any;' + return: + type: any + - name: serverProcessedContent + uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' + package: '@microsoft/sp-webpart-base!' + fullName: serverProcessedContent + summary: >- + The collections of data that can be processed by server side services like + search index and link fixup + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'serverProcessedContent?: ISerializedServerProcessedData;' + return: + type: >- + + - name: title + uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' + package: '@microsoft/sp-webpart-base!' + fullName: title + summary: Web part title + remarks: >- + Used to display the name of the web part in the toolbox, web part gallery + and the page. + + + Supported values: string less than 100 characters + + + Example: `"Text"` + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 40c309bb..363d133e 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -1,65 +1,70 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` - remarks: >- - The key should be a JSON path to the property in web part properties. The JSON path supports the following - operators: - - - - Dot `.` for selecting object members, for example `person.name` - - - - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` - - - - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. - - - You can make combinations of these operators, for example `person.websites[*].url` - - - Important Note: Only one wildcard per path is supported. - - - Example: Let's assume we have a web part with properties that have the following schema: - - - ``` - - { - title: string; - person: { - name: string; - bio: string; - photoURLs: string[]; - websites: { title: string; url: string; }[] - } - } - - - ``` - - We can define the metadata for the desired properties as following: - - - ``` - - { - 'person.bio': { isRichContent: true }, - 'person.photoURLs[*]': { isImageSource: true }, - 'person.websites[*].url': { isLink: true } - } - - - ``` - - This will make SharePoint servers aware of the content of your properties and run services such as search - indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link - fix-up, the web part property bag is automatically updated. - name: IWebPartPropertiesMetadata - fullName: IWebPartPropertiesMetadata - langs: - - typeScript - type: interface - package: '@microsoft/sp-webpart-base!' +### YamlMime:TSType +name: IWebPartPropertiesMetadata +uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartPropertiesMetadata +summary: >- + This structure is used to define metadata for web part properties as a map of + string to `IWebPartPropertyMetadata` +remarks: >- + The key should be a JSON path to the property in web part properties. The JSON + path supports the following operators: + + + - Dot `.` for selecting object members, for example `person.name` + + + - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` + + + - Bracketed asterisk `[*]` for array elements wildcard, for example + `person.websites[*]`. + + + You can make combinations of these operators, for example + `person.websites[*].url` + + + Important Note: Only one wildcard per path is supported. + + + Example: Let's assume we have a web part with properties that have the + following schema: + + + ``` + + { + title: string; + person: { + name: string; + bio: string; + photoURLs: string[]; + websites: { title: string; url: string; }[] + } + } + + + ``` + + We can define the metadata for the desired properties as following: + + + ``` + + { + 'person.bio': { isRichContent: true }, + 'person.photoURLs[*]': { isImageSource: true }, + 'person.websites[*].url': { isLink: true } + } + + + ``` + + This will make SharePoint servers aware of the content of your properties and + run services such as search indexing, link fix-up, etc on the data. In case + any of the values needs to update by these services, e.g link fix-up, the web + part property bag is automatically updated. +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 247fd3be..b7a4f5d4 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -1,51 +1,57 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' - summary: This is the structure used for map values in `IWebPartPropertiesMetadata` - name: IWebPartPropertyMetadata - fullName: IWebPartPropertyMetadata - langs: - - typeScript - type: interface +### YamlMime:TSType +name: IWebPartPropertyMetadata +uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartPropertyMetadata +summary: This is the structure used for map values in `IWebPartPropertiesMetadata` +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dynamicPropertyType + uid: >- + @microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member' - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' - summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' - remarks: >- - If a web part has properties that are dynamically configurable, then use this flag to declare the property as a - dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework - ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a - property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the - IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create - the DynamicProperty themselves and assign it to the property. - - - A web part can configure a default value for the property by specifying it in the properties section of the web - part's manifest. This value will be used when a dynamic property is constructed for the property. - - - Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. - name: dynamicPropertyType fullName: dynamicPropertyType - langs: - - typeScript - type: property + summary: >- + If specified, indicates that the property is a dynamic property and the + type of the dynamic property. + remarks: >- + If a web part has properties that are dynamically configurable, then use + this flag to declare the property as a dynamic property by specifying its + type. When a property specifies its dynamic property type, then the + framework ensures that its value can be accessed using 'tryGetValue' + anytime in the life cycle of the web part. If a property is marked as + DynamicProperty in the IWebPartProperties interface, but does not appear + in the IWebPartPropertiesMetadata with a dynamicPropertyType, then the web + part developer will need to manually create the DynamicProperty themselves + and assign it to the property. + + + A web part can configure a default value for the property by specifying it + in the properties section of the web part's manifest. This value will be + used when a dynamic property is constructed for the property. + + + Note: Web parts should be able to type cast the resultant value from the + `tryGetValue` to suit their needs. + isPreview: false + isDeprecated: false syntax: - content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' + content: >- + dynamicPropertyType?: 'boolean' | 'number' | 'string' | 'array' | + 'object'; return: - type: - - '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member' + type: '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' + - name: isHtmlString + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member' + package: '@microsoft/sp-webpart-base!' + fullName: isHtmlString summary: Indicates whether the property should be serialized as HTML. remarks: >- - This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on - it: + This flag instructs framework to store the value as HTML, so that + SharePoint can perform the following services on it: - normalizing HTML encodings @@ -60,87 +66,96 @@ items: - SharePoint link fix-up - Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, - SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply - needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. - name: isHtmlString - fullName: isHtmlString - langs: - - typeScript - type: property + Only enable this flag for HTML content where these modifications are + acceptable. If non-HTML content is provided, SharePoint framework might + make modifications to convert it to HTML valid. For plain text content + that simply needs to be exposed to the search index (without any + rewriting), use the `isSearchablePlainText` flag instead. + isPreview: false + isDeprecated: false syntax: content: 'isHtmlString?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member' - summary: >- - Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform - services like link fix-up, search indexing, loading from CDN, etc. - name: isImageSource + type: boolean + - name: isImageSource + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member' + package: '@microsoft/sp-webpart-base!' fullName: isImageSource - langs: - - typeScript - type: property + summary: >- + Indicates if the property contains a link. This allows SharePoint server + to treat the value as such and perform services like link fix-up, search + indexing, loading from CDN, etc. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'isImageSource?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member' - summary: >- - Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform - services like search indexing, link fix-up, loading from CDN, etc. - name: isLink + type: boolean + - name: isLink + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member' + package: '@microsoft/sp-webpart-base!' fullName: isLink - langs: - - typeScript - type: property + summary: >- + Indicates if the property contains a link. This allows SharePoint server + to treat the value as such and perform services like search indexing, link + fix-up, loading from CDN, etc. + remarks: '' + isPreview: false + isDeprecated: false syntax: content: 'isLink?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member' - summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. - remarks: >- - This flag instructs the framework to store the property in a representation that supports search indexing. The - content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML - characters may be stored encoded and appear in search results. If your string contains HTML markup, use the - isHtmlString setting instead. - - - Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. - name: isSearchablePlainText + type: boolean + - name: isSearchablePlainText + uid: >- + @microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member + package: '@microsoft/sp-webpart-base!' fullName: isSearchablePlainText - langs: - - typeScript - type: property + summary: >- + Indicates if the property contains plain text that should be + search-indexed by SharePoint. + remarks: >- + This flag instructs the framework to store the property in a + representation that supports search indexing. The content will be treated + as plain text; SharePoint will not modify the string in any way, and + special HTML characters may be stored encoded and appear in search + results. If your string contains HTML markup, use the isHtmlString setting + instead. + + + Security note: For security reasons, never assign a plain text string to + `Element.innerHTML`. + isPreview: false + isDeprecated: false syntax: content: 'isSearchablePlainText?: boolean;' return: - type: - - boolean - - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member' + type: boolean + - name: shouldNotPersist + uid: >- + @microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member + package: '@microsoft/sp-webpart-base!' + fullName: shouldNotPersist summary: Indicates if the framework should persist the property on the server. remarks: >- - Use this for properties that are only important in run-time, and do not need to persist on the server. This can - reduce the size of the serialized data of the web part and optimize the web part load time. The property value - will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. - The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared - from the run-time property bag. The initial render of your web part should not depend on the value of the - property. Setting a default value for the property can be done in `onInit()` method. - - - Note that if the property path refers to a property that has a complex object as the value, the whole object will - be removed from the persisted data. - name: shouldNotPersist - fullName: shouldNotPersist - langs: - - typeScript - type: property + Use this for properties that are only important in run-time, and do not + need to persist on the server. This can reduce the size of the serialized + data of the web part and optimize the web part load time. The property + value will be removed from the serialized data sent to the server, but + this has no effect on the run-time property bag. The property value will + still be available in the `onBeforeSerialize()` method, and the value will + not be cleared from the run-time property bag. The initial render of your + web part should not depend on the value of the property. Setting a default + value for the property can be done in `onInit()` method. + + + Note that if the property path refers to a property that has a complex + object as the value, the whole object will be removed from the persisted + data. + isPreview: false + isDeprecated: false syntax: content: 'shouldNotPersist?: boolean;' return: - type: - - boolean + type: boolean diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index aeda8e30..8c7cc9c0 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -1,88 +1,45 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - summary: Enum for all the supported button types. - deprecated: - content: >- - This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. - name: PropertyPaneButtonType - fullName: PropertyPaneButtonType - langs: - - typeScript - type: enum - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' - summary: Optional actions. - remarks: >- - Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command - bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts. - name: Command - fullName: Command - langs: - - typeScript - type: field - numericValue: '4' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' - summary: Always used as a set with both Standard and Primary compound buttons. - remarks: >- - Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with - a possible significant time investment such as an email or a complex form - name: Compound - fullName: Compound - langs: - - typeScript - type: field - numericValue: '3' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' - summary: Hero button. - name: Hero - fullName: Hero - langs: - - typeScript - type: field - numericValue: '2' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' - summary: >- - Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within - the command bar. - remarks: >- - Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: - OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In - SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In - SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the - bottom of an event creation Callout when clicking inside an empty time range. - name: Icon - fullName: Icon - langs: - - typeScript - type: field - numericValue: '5' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' - summary: Optional completion action. - remarks: >- - Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo - an action. Examples: "Done" button which closes a container but doesn't make a server call or an "Undo" button - when a user is uploading a file in OneDrive. - name: Normal - fullName: Normal - langs: - - typeScript - type: field - numericValue: '0' - - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' - summary: Preferred completion action when paired with a Standard button. - remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' - name: Primary - fullName: Primary - langs: - - typeScript - type: field - numericValue: '1' +### YamlMime:TSEnum +name: PropertyPaneButtonType +uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' +package: '@microsoft/sp-webpart-base!' +fullName: PropertyPaneButtonType +summary: Enum for all the supported button types. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This enum has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: Command + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' + package: '@microsoft/sp-webpart-base!' + summary: Optional actions. + numericValue: '4' + - name: Compound + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' + package: '@microsoft/sp-webpart-base!' + summary: Always used as a set with both Standard and Primary compound buttons. + numericValue: '3' + - name: Hero + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' + package: '@microsoft/sp-webpart-base!' + summary: Hero button. + numericValue: '2' + - name: Icon + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' + package: '@microsoft/sp-webpart-base!' + summary: >- + Same usage as Command button, when real estate does not allow for icons + + labels or as secondary actions within the command bar. + numericValue: '5' + - name: Normal + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' + package: '@microsoft/sp-webpart-base!' + summary: Optional completion action. + numericValue: '0' + - name: Primary + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' + package: '@microsoft/sp-webpart-base!' + summary: Preferred completion action when paired with a Standard button. + numericValue: '1' diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 5c32748a..8fb7bcaa 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -1,44 +1,32 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - summary: >- - Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). - deprecated: - content: >- - This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. - name: PropertyPaneDropdownOptionType - fullName: PropertyPaneDropdownOptionType - langs: - - typeScript - type: enum - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' - - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' - - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' - summary: Render a divider. - name: Divider - fullName: Divider - langs: - - typeScript - type: field - numericValue: '1' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' - summary: Render menu item as a header. - name: Header - fullName: Header - langs: - - typeScript - type: field - numericValue: '2' - - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' - summary: Render normal menu item. - name: Normal - fullName: Normal - langs: - - typeScript - type: field - numericValue: '0' +### YamlMime:TSEnum +name: PropertyPaneDropdownOptionType +uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' +package: '@microsoft/sp-webpart-base!' +fullName: PropertyPaneDropdownOptionType +summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:))<!-- + -->. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This enum has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: Divider + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' + package: '@microsoft/sp-webpart-base!' + summary: Render a divider. + numericValue: '1' + - name: Header + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' + package: '@microsoft/sp-webpart-base!' + summary: Render menu item as a header. + numericValue: '2' + - name: Normal + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' + package: '@microsoft/sp-webpart-base!' + summary: Render normal menu item. + numericValue: '0' diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index cca1d134..5054e94f 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -1,156 +1,93 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - summary: |- - Enum for all the supported PropertyPane field types. - - Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. - deprecated: - content: >- - This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. - name: PropertyPaneFieldType - fullName: PropertyPaneFieldType - langs: - - typeScript - type: enum - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' - summary: Button field. - name: Button - fullName: Button - langs: - - typeScript - type: field - numericValue: '11' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' - summary: Checkbox field. - name: CheckBox - fullName: CheckBox - langs: - - typeScript - type: field - numericValue: '2' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' - summary: Choice Group field. - name: ChoiceGroup - fullName: ChoiceGroup - langs: - - typeScript - type: field - numericValue: '10' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' - summary: Custom field. - name: Custom - fullName: Custom - langs: - - typeScript - type: field - numericValue: '1' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' - summary: Dropdown field. - name: Dropdown - fullName: Dropdown - langs: - - typeScript - type: field - numericValue: '6' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' - summary: Dynamic data field. - name: DynamicField - fullName: DynamicField - langs: - - typeScript - type: field - numericValue: '14' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' - summary: A set of dynamic fields. - name: DynamicFieldSet - fullName: DynamicFieldSet - langs: - - typeScript - type: field - numericValue: '16' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' - summary: Dynamic Text Field - deprecated: - content: '- Please use DynamicField' - isPreview: true - name: DynamicTextField - fullName: DynamicTextField - langs: - - typeScript - type: field - numericValue: '15' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' - summary: Heading field. - name: Heading - fullName: Heading - langs: - - typeScript - type: field - numericValue: '9' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' - summary: Horizontal Rule field. - name: HorizontalRule - fullName: HorizontalRule - langs: - - typeScript - type: field - numericValue: '12' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' - summary: Label field. - name: Label - fullName: Label - langs: - - typeScript - type: field - numericValue: '7' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' - summary: Link field. - name: Link - fullName: Link - langs: - - typeScript - type: field - numericValue: '13' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' - summary: Slider field. - name: Slider - fullName: Slider - langs: - - typeScript - type: field - numericValue: '8' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' - summary: TextField field. - name: TextField - fullName: TextField - langs: - - typeScript - type: field - numericValue: '3' - - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' - summary: Toggle field. - name: Toggle - fullName: Toggle - langs: - - typeScript - type: field - numericValue: '5' +### YamlMime:TSEnum +name: PropertyPaneFieldType +uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' +package: '@microsoft/sp-webpart-base!' +fullName: PropertyPaneFieldType +summary: >- + Enum for all the supported PropertyPane field types. + + + Names should be consistent with those in office-ui-fabric-react, be careful to + get letter casing correct. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This enum has been moved to + `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: Button + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' + package: '@microsoft/sp-webpart-base!' + summary: Button field. + numericValue: '11' + - name: CheckBox + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' + package: '@microsoft/sp-webpart-base!' + summary: Checkbox field. + numericValue: '2' + - name: ChoiceGroup + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' + package: '@microsoft/sp-webpart-base!' + summary: Choice Group field. + numericValue: '10' + - name: Custom + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' + package: '@microsoft/sp-webpart-base!' + summary: Custom field. + numericValue: '1' + - name: Dropdown + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' + package: '@microsoft/sp-webpart-base!' + summary: Dropdown field. + numericValue: '6' + - name: DynamicField + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' + package: '@microsoft/sp-webpart-base!' + summary: Dynamic data field. + numericValue: '14' + - name: DynamicFieldSet + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' + package: '@microsoft/sp-webpart-base!' + summary: A set of dynamic fields. + numericValue: '16' + - name: DynamicTextField + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' + package: '@microsoft/sp-webpart-base!' + summary: Dynamic Text Field + numericValue: '15' + - name: Heading + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' + package: '@microsoft/sp-webpart-base!' + summary: Heading field. + numericValue: '9' + - name: HorizontalRule + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' + package: '@microsoft/sp-webpart-base!' + summary: Horizontal Rule field. + numericValue: '12' + - name: Label + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' + package: '@microsoft/sp-webpart-base!' + summary: Label field. + numericValue: '7' + - name: Link + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' + package: '@microsoft/sp-webpart-base!' + summary: Link field. + numericValue: '13' + - name: Slider + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' + package: '@microsoft/sp-webpart-base!' + summary: Slider field. + numericValue: '8' + - name: TextField + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' + package: '@microsoft/sp-webpart-base!' + summary: TextField field. + numericValue: '3' + - name: Toggle + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' + package: '@microsoft/sp-webpart-base!' + summary: Toggle field. + numericValue: '5' diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index d01b7610..60c89ff1 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -1,88 +1,70 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!WebPartContext:class' - summary: >- - Web part context object. This object contains the contextual services available to a web part. e.g. a contextual - instance to the http client. - remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `WebPartContext` class. - name: WebPartContext - fullName: WebPartContext - langs: - - typeScript - type: class - extends: - - '@microsoft/sp-webpart-base!default:class' - inheritance: - - type: '@microsoft/sp-webpart-base!default:class' - package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!WebPartContext#domElement:member' - - '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' - - '@microsoft/sp-webpart-base!WebPartContext#sdks:member' - - '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' - - uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' - summary: Reference to the DOM element that hosts this client-side component. - name: domElement - fullName: domElement - langs: - - typeScript - type: property - syntax: - content: 'readonly domElement: HTMLElement;' - return: - type: - - '!HTMLElement:interface' - - uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' - summary: >- - Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is - being hosted in Microsoft Teams. - remarks: >- - For more information, please see: - [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - deprecated: - content: '- This function has been deprecated' - name: microsoftTeams - fullName: microsoftTeams - langs: - - typeScript - type: property - syntax: - content: 'readonly microsoftTeams: typeof microsoftTeams | undefined;' - return: - type: - - typeof microsoftTeams | undefined - - uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' - summary: Conditional set of SDKs provided by SPFx dependent on the environment. - name: sdks - fullName: sdks - langs: - - typeScript - type: property - syntax: - content: 'readonly sdks: ISDKs;' - return: - type: - - '@microsoft/sp-webpart-base!ISDKs:interface' - - uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' - summary: Web part status renderer. - name: statusRenderer - fullName: statusRenderer - langs: - - typeScript - type: property - syntax: - content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' - return: - type: - - '@microsoft/sp-webpart-base!default:interface' -references: - - uid: '@microsoft/sp-webpart-base!default:class' - name: BaseWebPartContext - - uid: '!HTMLElement:interface' - name: HTMLElement - - uid: '@microsoft/sp-webpart-base!ISDKs:interface' - name: ISDKs - - uid: '@microsoft/sp-webpart-base!default:interface' - name: IClientSideWebPartStatusRenderer +### YamlMime:TSType +name: WebPartContext +uid: '@microsoft/sp-webpart-base!WebPartContext:class' +package: '@microsoft/sp-webpart-base!' +fullName: WebPartContext +summary: >- + Web part context object. This object contains the contextual services + available to a web part. e.g. a contextual instance to the http client. +remarks: >- + The constructor for this class is marked as internal. Third-party code should + not call the constructor directly or create subclasses that extend the + `WebPartContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: domElement + uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' + package: '@microsoft/sp-webpart-base!' + fullName: domElement + summary: Reference to the DOM element that hosts this client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLElement;' + return: + type: '' + - name: microsoftTeams + uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' + package: '@microsoft/sp-webpart-base!' + fullName: microsoftTeams + summary: >- + Contextual information about the current Microsoft Teams tab. This object + will only be defined if a component is being hosted in Microsoft Teams. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- This function has been deprecated' + syntax: + content: 'readonly microsoftTeams: typeof microsoftTeams | undefined;' + return: + type: typeof microsoftTeams | undefined + - name: sdks + uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' + package: '@microsoft/sp-webpart-base!' + fullName: sdks + summary: Conditional set of SDKs provided by SPFx dependent on the environment. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sdks: ISDKs;' + return: + type: '' + - name: statusRenderer + uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' + package: '@microsoft/sp-webpart-base!' + fullName: statusRenderer + summary: Web part status renderer. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' + return: + type: '' +extends: '' diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index 9002fa19..28e8db98 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -1,39 +1,29 @@ -### YamlMime:UniversalReference -items: - - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' - summary: Form factor of the web part. - remarks: >- - This will change based on how the web part is used, not by the web part itself. In cases like web parts used in - Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web - parts, it will have a canvas web part form factor. - isPreview: true - name: WebPartFormFactor - fullName: WebPartFormFactor - langs: - - typeScript - type: enum +### YamlMime:TSEnum +name: WebPartFormFactor +uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' +package: '@microsoft/sp-webpart-base!' +fullName: WebPartFormFactor +summary: Form factor of the web part. +remarks: >- + This will change based on how the web part is used, not by the web part + itself. In cases like web parts used in Teams tab or as App pages, it will + have full size form factor. If a web part is render in a canvas, with other + web parts, it will have a canvas web part form factor. +isPreview: true +isDeprecated: false +fields: + - name: FullSize + uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' package: '@microsoft/sp-webpart-base!' - children: - - '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' - - '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' - - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' - summary: 'Full size form factor. This means the web part is rendered in full size, taking all space available in the page.' - remarks: This is the case for Teams tabs or single web part App pages. - isPreview: true - name: FullSize - fullName: FullSize - langs: - - typeScript - type: field + summary: >- + Full size form factor. This means the web part is rendered in full size, + taking all space available in the page. numericValue: '1' - - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' + - name: Standard + uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' + package: '@microsoft/sp-webpart-base!' summary: >- - Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this - case, the width is determined by the container, and web part self-adjust for height. - isPreview: true - name: Standard - fullName: Standard - langs: - - typeScript - type: field + Standard form factor. This means the web part is rendered in a canvas, + potentially with other web parts. In this case, the width is determined by + the container, and web part self-adjust for height. numericValue: '0' From b053c55bb3eea97406daed30eeabce579a590cd8 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:11:29 +0800 Subject: [PATCH 35/55] change ur to sdp --- SP-Framework/decorators.yml | 2 +- SP-Framework/sp-application-base.yml | 2 +- .../sp-application-base/placeholdername.yml | 4 +-- SP-Framework/sp-component-base.yml | 2 +- SP-Framework/sp-core-library.yml | 2 +- SP-Framework/sp-core-library/displaymode.yml | 4 +-- .../sp-core-library/environmenttype.yml | 8 ++--- SP-Framework/sp-diagnostics.yml | 2 +- SP-Framework/sp-dialog.yml | 2 +- SP-Framework/sp-dynamic-data.yml | 2 +- SP-Framework/sp-extension-base.yml | 2 +- SP-Framework/sp-http.yml | 2 +- SP-Framework/sp-http/sphttpheader.yml | 2 +- SP-Framework/sp-list-subscription.yml | 2 +- SP-Framework/sp-listview-extensibility.yml | 2 +- SP-Framework/sp-loader.yml | 2 +- SP-Framework/sp-lodash-subset.yml | 2 +- SP-Framework/sp-module-interfaces.yml | 2 +- .../sp-module-interfaces/predefinedgroup.yml | 14 ++++----- SP-Framework/sp-odata-types.yml | 2 +- SP-Framework/sp-page-context.yml | 2 +- SP-Framework/sp-page-context/spdayofweek.yml | 14 ++++----- SP-Framework/sp-property-pane.yml | 2 +- .../dynamicdatashareddepth.yml | 6 ++-- .../sp-property-pane/popupwindowposition.yml | 10 +++---- .../propertypanebuttontype.yml | 12 ++++---- .../propertypanedropdownoptiontype.yml | 6 ++-- .../propertypanefieldtype.yml | 30 +++++++++---------- SP-Framework/sp-search-extensibility.yml | 2 +- .../searchqueryscenario.yml | 4 +-- SP-Framework/sp-webpart-base.yml | 2 +- .../dynamicdatashareddepth.yml | 6 ++-- .../propertypanebuttontype.yml | 12 ++++---- .../propertypanedropdownoptiontype.yml | 6 ++-- .../sp-webpart-base/propertypanefieldtype.yml | 30 +++++++++---------- .../sp-webpart-base/webpartformfactor.yml | 4 +-- 36 files changed, 105 insertions(+), 105 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 63e00650..a1500de3 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/decorators!' name: '@microsoft/decorators' type: package diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index 54f58e06..1036db6e 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-application-base!' name: '@microsoft/sp-application-base' type: package diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index 8bd05116..c057691d 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -17,9 +17,9 @@ fields: uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' package: '@microsoft/sp-application-base!' summary: A region at the bottom of the page. - numericValue: '2' + numericValue: 2 - name: Top uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' package: '@microsoft/sp-application-base!' summary: A region at the top of the page. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 45323f90..177d265a 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-component-base!' name: '@microsoft/sp-component-base' type: package diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index 251b208a..6b33a460 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-core-library!' name: '@microsoft/sp-core-library' type: package diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index b557a188..f6cf6b61 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -17,7 +17,7 @@ fields: The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience. - numericValue: '2' + numericValue: 2 - name: Read uid: '@microsoft/sp-core-library!DisplayMode.Read:member' package: '@microsoft/sp-core-library!' @@ -25,4 +25,4 @@ fields: The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 77445de7..31993afe 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -21,7 +21,7 @@ fields: Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported. - numericValue: '3' + numericValue: 3 - name: Local uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' package: '@microsoft/sp-core-library!' @@ -31,7 +31,7 @@ fields: via "gulp serve". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing. - numericValue: '1' + numericValue: 1 - name: SharePoint uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' package: '@microsoft/sp-core-library!' @@ -39,7 +39,7 @@ fields: Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario. - numericValue: '2' + numericValue: 2 - name: Test uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' package: '@microsoft/sp-core-library!' @@ -47,4 +47,4 @@ fields: Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled. - numericValue: '0' + numericValue: 0 diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index 2e318354..85f582d8 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-diagnostics!' name: '@microsoft/sp-diagnostics' type: package diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index dd638b6a..c6caf5a5 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-dialog!' name: '@microsoft/sp-dialog' type: package diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index 3f2694a2..ed6e885a 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-dynamic-data!' name: '@microsoft/sp-dynamic-data' type: package diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index 67746770..72499721 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-extension-base!' name: '@microsoft/sp-extension-base' type: package diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 7f890040..8b925002 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-http!' name: '@microsoft/sp-http' type: package diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 0f960351..c0116704 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -19,4 +19,4 @@ fields: Example value: "9417279e-40e1-0000-2465-306ba786bfd7" - numericValue: '"SPRequestGuid"' + numericValue: .nan diff --git a/SP-Framework/sp-list-subscription.yml b/SP-Framework/sp-list-subscription.yml index 346b6d88..9e4e4d6e 100644 --- a/SP-Framework/sp-list-subscription.yml +++ b/SP-Framework/sp-list-subscription.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-list-subscription!' name: '@microsoft/sp-list-subscription' type: package diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index 8a1b8855..d1b9ef84 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-listview-extensibility!' name: '@microsoft/sp-listview-extensibility' type: package diff --git a/SP-Framework/sp-loader.yml b/SP-Framework/sp-loader.yml index ee1006ba..651a7ef8 100644 --- a/SP-Framework/sp-loader.yml +++ b/SP-Framework/sp-loader.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-loader!' name: '@microsoft/sp-loader' type: package diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml index 28fcac39..9d90986a 100644 --- a/SP-Framework/sp-lodash-subset.yml +++ b/SP-Framework/sp-lodash-subset.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-lodash-subset!' name: '@microsoft/sp-lodash-subset' type: package diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index b534c13f..1e923271 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-module-interfaces!' name: '@microsoft/sp-module-interfaces' type: package diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index cb6ac347..1fc84232 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -18,7 +18,7 @@ fields: This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. - numericValue: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' + numericValue: .nan - name: CommunicationAndCollaboration uid: >- @microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member @@ -29,7 +29,7 @@ fields: This group includes web parts that facilitate information sharing, team work, and social interactions. - numericValue: '"75e22ed5-fa14-4829-850a-c890608aca2d"' + numericValue: .nan - name: Discovery uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' package: '@microsoft/sp-module-interfaces!' @@ -39,7 +39,7 @@ fields: This group includes web parts that organize, group, and filter content to help users discover information. - numericValue: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' + numericValue: .nan - name: Other uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' package: '@microsoft/sp-module-interfaces!' @@ -47,7 +47,7 @@ fields: Other. This group includes web parts not in other groups. - numericValue: '"5c03119e-3074-46fd-976b-c60198311f70"' + numericValue: .nan - name: PlanningAndProcess uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' package: '@microsoft/sp-module-interfaces!' @@ -57,7 +57,7 @@ fields: This group includes web parts that empower team productivity with the use of planning and process tools. - numericValue: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' + numericValue: .nan - name: SiteTools uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' package: '@microsoft/sp-module-interfaces!' @@ -65,7 +65,7 @@ fields: Site tools. This group includes web parts for site information and management. - numericValue: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' + numericValue: .nan - name: TextMediaAndContent uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' package: '@microsoft/sp-module-interfaces!' @@ -75,4 +75,4 @@ fields: This group includes web parts that display text, multi-media, documents, information from the web, and other rich content. - numericValue: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' + numericValue: .nan diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index 1c46a875..9f5ec50e 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-odata-types!' name: '@microsoft/sp-odata-types' type: package diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index 00d036bd..7f69d8b3 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-page-context!' name: '@microsoft/sp-page-context' type: package diff --git a/SP-Framework/sp-page-context/spdayofweek.yml b/SP-Framework/sp-page-context/spdayofweek.yml index 141ff7f1..3f31e238 100644 --- a/SP-Framework/sp-page-context/spdayofweek.yml +++ b/SP-Framework/sp-page-context/spdayofweek.yml @@ -12,34 +12,34 @@ fields: uid: '@microsoft/sp-page-context!SPDayOfWeek.Friday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '5' + numericValue: 5 - name: Monday uid: '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '1' + numericValue: 1 - name: Saturday uid: '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '6' + numericValue: 6 - name: Sunday uid: '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '0' + numericValue: 0 - name: Thursday uid: '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '4' + numericValue: 4 - name: Tuesday uid: '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '2' + numericValue: 2 - name: Wednesday uid: '@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member' package: '@microsoft/sp-page-context!' summary: '' - numericValue: '3' + numericValue: 3 diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index ab95d560..de3a8f24 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-property-pane!' name: '@microsoft/sp-property-pane' type: package diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 53c7d2d5..fda2be86 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -12,14 +12,14 @@ fields: uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' package: '@microsoft/sp-property-pane!' summary: Indicates that nothing is shared. - numericValue: '0' + numericValue: 0 - name: Property uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' package: '@microsoft/sp-property-pane!' summary: Indicates that both the dynamic data source and the property are shared. - numericValue: '2' + numericValue: 2 - name: Source uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' package: '@microsoft/sp-property-pane!' summary: Indicates that the dynamic data source is shared. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index 743b5280..d2e6dc8f 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -12,24 +12,24 @@ fields: uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in center of screen. - numericValue: '0' + numericValue: 0 - name: leftBottom uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in left bottom of screen. - numericValue: '4' + numericValue: 4 - name: leftTop uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in left top of screen. - numericValue: '2' + numericValue: 2 - name: rightBottom uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in right bottom of screen. - numericValue: '3' + numericValue: 3 - name: rightTop uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in right top of screen. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index f29d32e0..2ce8d7e8 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -12,31 +12,31 @@ fields: uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' package: '@microsoft/sp-property-pane!' summary: Optional actions. - numericValue: '4' + numericValue: 4 - name: Compound uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' package: '@microsoft/sp-property-pane!' summary: Always used as a set with both Standard and Primary compound buttons. - numericValue: '3' + numericValue: 3 - name: Hero uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' package: '@microsoft/sp-property-pane!' summary: Hero button. - numericValue: '2' + numericValue: 2 - name: Icon uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' package: '@microsoft/sp-property-pane!' summary: >- Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar. - numericValue: '5' + numericValue: 5 - name: Normal uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' package: '@microsoft/sp-property-pane!' summary: Optional completion action. - numericValue: '0' + numericValue: 0 - name: Primary uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' package: '@microsoft/sp-property-pane!' summary: Preferred completion action when paired with a Standard button. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 26c8ad84..e961d899 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -16,14 +16,14 @@ fields: uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' package: '@microsoft/sp-property-pane!' summary: Render a divider. - numericValue: '1' + numericValue: 1 - name: Header uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' package: '@microsoft/sp-property-pane!' summary: Render menu item as a header. - numericValue: '2' + numericValue: 2 - name: Normal uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' package: '@microsoft/sp-property-pane!' summary: Render normal menu item. - numericValue: '0' + numericValue: 0 diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 9295fe3b..f0f9d759 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -17,74 +17,74 @@ fields: uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' package: '@microsoft/sp-property-pane!' summary: Button field. - numericValue: '11' + numericValue: 11 - name: CheckBox uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' package: '@microsoft/sp-property-pane!' summary: Checkbox field. - numericValue: '2' + numericValue: 2 - name: ChoiceGroup uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' package: '@microsoft/sp-property-pane!' summary: Choice Group field. - numericValue: '10' + numericValue: 10 - name: Custom uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' package: '@microsoft/sp-property-pane!' summary: Custom field. - numericValue: '1' + numericValue: 1 - name: Dropdown uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' package: '@microsoft/sp-property-pane!' summary: Dropdown field. - numericValue: '6' + numericValue: 6 - name: DynamicField uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' package: '@microsoft/sp-property-pane!' summary: Dynamic data field. - numericValue: '14' + numericValue: 14 - name: DynamicFieldSet uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' package: '@microsoft/sp-property-pane!' summary: A set of dynamic fields. - numericValue: '16' + numericValue: 16 - name: DynamicTextField uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' package: '@microsoft/sp-property-pane!' summary: Dynamic Text Field - numericValue: '15' + numericValue: 15 - name: Heading uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' package: '@microsoft/sp-property-pane!' summary: Heading field. - numericValue: '9' + numericValue: 9 - name: HorizontalRule uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' package: '@microsoft/sp-property-pane!' summary: Horizontal Rule field. - numericValue: '12' + numericValue: 12 - name: Label uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' package: '@microsoft/sp-property-pane!' summary: Label field. - numericValue: '7' + numericValue: 7 - name: Link uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' package: '@microsoft/sp-property-pane!' summary: Link field. - numericValue: '13' + numericValue: 13 - name: Slider uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' package: '@microsoft/sp-property-pane!' summary: Slider field. - numericValue: '8' + numericValue: 8 - name: TextField uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' package: '@microsoft/sp-property-pane!' summary: TextField field. - numericValue: '3' + numericValue: 3 - name: Toggle uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' package: '@microsoft/sp-property-pane!' summary: Toggle field. - numericValue: '5' + numericValue: 5 diff --git a/SP-Framework/sp-search-extensibility.yml b/SP-Framework/sp-search-extensibility.yml index e63b2803..373ff5ce 100644 --- a/SP-Framework/sp-search-extensibility.yml +++ b/SP-Framework/sp-search-extensibility.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-search-extensibility!' name: '@microsoft/sp-search-extensibility' type: package diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index 4488291f..e6042887 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -13,10 +13,10 @@ fields: @microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member package: '@microsoft/sp-search-extensibility!' summary: Search results scenario. - numericValue: '1' + numericValue: 1 - name: SearchSuggestions uid: >- @microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member package: '@microsoft/sp-search-extensibility!' summary: Search suggestions scenario. - numericValue: '2' + numericValue: 2 diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 276692fe..6d6a4dc1 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -1,4 +1,4 @@ -### YamlMime:TSPacakge +### YamlMime:TSPackage uid: '@microsoft/sp-webpart-base!' name: '@microsoft/sp-webpart-base' type: package diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 5275715a..c078bed1 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -15,14 +15,14 @@ fields: uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' package: '@microsoft/sp-webpart-base!' summary: Indicates that nothing is shared. - numericValue: '0' + numericValue: 0 - name: Property uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' package: '@microsoft/sp-webpart-base!' summary: Indicates that both the dynamic data source and the property are shared. - numericValue: '2' + numericValue: 2 - name: Source uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' package: '@microsoft/sp-webpart-base!' summary: Indicates that the dynamic data source is shared. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 8c7cc9c0..9f05bfe3 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -15,31 +15,31 @@ fields: uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' package: '@microsoft/sp-webpart-base!' summary: Optional actions. - numericValue: '4' + numericValue: 4 - name: Compound uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' package: '@microsoft/sp-webpart-base!' summary: Always used as a set with both Standard and Primary compound buttons. - numericValue: '3' + numericValue: 3 - name: Hero uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' package: '@microsoft/sp-webpart-base!' summary: Hero button. - numericValue: '2' + numericValue: 2 - name: Icon uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' package: '@microsoft/sp-webpart-base!' summary: >- Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar. - numericValue: '5' + numericValue: 5 - name: Normal uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' package: '@microsoft/sp-webpart-base!' summary: Optional completion action. - numericValue: '0' + numericValue: 0 - name: Primary uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' package: '@microsoft/sp-webpart-base!' summary: Preferred completion action when paired with a Standard button. - numericValue: '1' + numericValue: 1 diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 8fb7bcaa..1b8ea5fd 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -19,14 +19,14 @@ fields: uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' package: '@microsoft/sp-webpart-base!' summary: Render a divider. - numericValue: '1' + numericValue: 1 - name: Header uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' package: '@microsoft/sp-webpart-base!' summary: Render menu item as a header. - numericValue: '2' + numericValue: 2 - name: Normal uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' package: '@microsoft/sp-webpart-base!' summary: Render normal menu item. - numericValue: '0' + numericValue: 0 diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 5054e94f..084a3e0d 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -20,74 +20,74 @@ fields: uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' package: '@microsoft/sp-webpart-base!' summary: Button field. - numericValue: '11' + numericValue: 11 - name: CheckBox uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' package: '@microsoft/sp-webpart-base!' summary: Checkbox field. - numericValue: '2' + numericValue: 2 - name: ChoiceGroup uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' package: '@microsoft/sp-webpart-base!' summary: Choice Group field. - numericValue: '10' + numericValue: 10 - name: Custom uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' package: '@microsoft/sp-webpart-base!' summary: Custom field. - numericValue: '1' + numericValue: 1 - name: Dropdown uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' package: '@microsoft/sp-webpart-base!' summary: Dropdown field. - numericValue: '6' + numericValue: 6 - name: DynamicField uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' package: '@microsoft/sp-webpart-base!' summary: Dynamic data field. - numericValue: '14' + numericValue: 14 - name: DynamicFieldSet uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' package: '@microsoft/sp-webpart-base!' summary: A set of dynamic fields. - numericValue: '16' + numericValue: 16 - name: DynamicTextField uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' package: '@microsoft/sp-webpart-base!' summary: Dynamic Text Field - numericValue: '15' + numericValue: 15 - name: Heading uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' package: '@microsoft/sp-webpart-base!' summary: Heading field. - numericValue: '9' + numericValue: 9 - name: HorizontalRule uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' package: '@microsoft/sp-webpart-base!' summary: Horizontal Rule field. - numericValue: '12' + numericValue: 12 - name: Label uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' package: '@microsoft/sp-webpart-base!' summary: Label field. - numericValue: '7' + numericValue: 7 - name: Link uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' package: '@microsoft/sp-webpart-base!' summary: Link field. - numericValue: '13' + numericValue: 13 - name: Slider uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' package: '@microsoft/sp-webpart-base!' summary: Slider field. - numericValue: '8' + numericValue: 8 - name: TextField uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' package: '@microsoft/sp-webpart-base!' summary: TextField field. - numericValue: '3' + numericValue: 3 - name: Toggle uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' package: '@microsoft/sp-webpart-base!' summary: Toggle field. - numericValue: '5' + numericValue: 5 diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index 28e8db98..efca261d 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -18,7 +18,7 @@ fields: summary: >- Full size form factor. This means the web part is rendered in full size, taking all space available in the page. - numericValue: '1' + numericValue: 1 - name: Standard uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' package: '@microsoft/sp-webpart-base!' @@ -26,4 +26,4 @@ fields: Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height. - numericValue: '0' + numericValue: 0 From cb52215f5f650b19b4daa3b8a3bb3b8000b6962f Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:19:31 +0800 Subject: [PATCH 36/55] change ur to sdp --- SP-Framework/sp-http/sphttpheader.yml | 1 - SP-Framework/sp-module-interfaces/predefinedgroup.yml | 7 ------- 2 files changed, 8 deletions(-) diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index c0116704..b485b235 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -19,4 +19,3 @@ fields: Example value: "9417279e-40e1-0000-2465-306ba786bfd7" - numericValue: .nan diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index 1fc84232..48c3f651 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -18,7 +18,6 @@ fields: This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. - numericValue: .nan - name: CommunicationAndCollaboration uid: >- @microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member @@ -29,7 +28,6 @@ fields: This group includes web parts that facilitate information sharing, team work, and social interactions. - numericValue: .nan - name: Discovery uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' package: '@microsoft/sp-module-interfaces!' @@ -39,7 +37,6 @@ fields: This group includes web parts that organize, group, and filter content to help users discover information. - numericValue: .nan - name: Other uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' package: '@microsoft/sp-module-interfaces!' @@ -47,7 +44,6 @@ fields: Other. This group includes web parts not in other groups. - numericValue: .nan - name: PlanningAndProcess uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' package: '@microsoft/sp-module-interfaces!' @@ -57,7 +53,6 @@ fields: This group includes web parts that empower team productivity with the use of planning and process tools. - numericValue: .nan - name: SiteTools uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' package: '@microsoft/sp-module-interfaces!' @@ -65,7 +60,6 @@ fields: Site tools. This group includes web parts for site information and management. - numericValue: .nan - name: TextMediaAndContent uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' package: '@microsoft/sp-module-interfaces!' @@ -75,4 +69,3 @@ fields: This group includes web parts that display text, multi-media, documents, information from the web, and other rich content. - numericValue: .nan From 9a629db3c955b3efc9890e35fb8cddfc2a7ce939 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:26:11 +0800 Subject: [PATCH 37/55] change ur to sdp --- .../applicationaccessor.yml | 5 +-- .../iplaceholdercreatecontentoptions.yml | 11 ++++--- .../placeholderprovider.yml | 15 +++++---- .../sp-component-base/dynamicdataprovider.yml | 10 +++--- .../dynamicdatasourcemanager.yml | 5 +-- .../sp-component-base/dynamicproperty.yml | 5 +-- SP-Framework/sp-component-base/irawstyle.yml | 2 +- .../sp-component-base/ireadonlytheme.yml | 13 ++++---- .../themechangedeventargs.yml | 5 +-- .../sp-component-base/themeprovider.yml | 10 +++--- SP-Framework/sp-core-library/servicekey.yml | 10 +++--- SP-Framework/sp-core-library/servicescope.yml | 33 ++++++++++--------- SP-Framework/sp-dialog/basedialog.yml | 11 ++++--- .../sp-dialog/isecondarydialogprovider.yml | 22 +++++++------ .../sp-dynamic-data/idynamicdatacallables.yml | 15 +++++---- .../sp-dynamic-data/idynamicdatasource.yml | 25 ++++++++------ .../sp-extension-base/baseextension.yml | 4 +-- SP-Framework/sp-http/aadhttpclient.yml | 6 ++-- SP-Framework/sp-http/aadhttpclientfactory.yml | 4 +-- SP-Framework/sp-http/aadtokenprovider.yml | 7 ++-- .../sp-http/aadtokenproviderfactory.yml | 5 +-- SP-Framework/sp-http/digestcache.yml | 2 +- SP-Framework/sp-http/graphrequest.yml | 16 ++++----- SP-Framework/sp-http/httpclient.yml | 6 ++-- SP-Framework/sp-http/httpclientresponse.yml | 12 +++---- SP-Framework/sp-http/iaadtokenprovider.yml | 7 ++-- SP-Framework/sp-http/idigestcache.yml | 2 +- SP-Framework/sp-http/msgraphclientfactory.yml | 4 +-- SP-Framework/sp-http/sphttpclient.yml | 6 ++-- SP-Framework/sp-http/sphttpclientbatch.yml | 8 ++--- SP-Framework/sp-http/sphttpclientresponse.yml | 5 +-- .../listsubscriptionfactory.yml | 5 +-- .../fieldcustomizercontext.yml | 5 +-- ...stviewcommandsetexecuteeventparameters.yml | 11 ++++--- ...iewcommandsetlistviewupdatedparameters.yml | 11 ++++--- .../listitemaccessor.yml | 5 +-- .../listviewaccessor.yml | 15 +++++---- .../selectedrowschangedeventargs.yml | 5 +-- ...clientsidecomponentloaderconfiguration.yml | 5 +-- .../iclientsidewebpartmanifest.yml | 10 +++--- .../iclientsidewebpartmanifestentry.yml | 10 +++--- .../icommandsetextensionmanifest.yml | 5 +-- .../icomponentmoduleconfiguration.yml | 5 +-- .../ilocalizedpathmoduleconfiguration.yml | 10 +++--- .../ipathmoduleconfiguration.yml | 5 +-- .../sp-odata-types/iodatanavigationnode.yml | 5 +-- .../iodatanavigationnodecollection.yml | 10 +++--- SP-Framework/sp-page-context/pagecontext.yml | 6 ++-- SP-Framework/sp-page-context/spfield.yml | 5 +-- SP-Framework/sp-page-context/sppermission.yml | 10 +++--- SP-Framework/sp-page-context/spsite.yml | 2 +- SP-Framework/sp-page-context/spuser.yml | 4 +-- SP-Framework/sp-page-context/spweb.yml | 4 +-- .../ipropertypanechoicegroupprops.yml | 5 +-- .../ipropertypaneconfiguration.yml | 10 +++--- .../ipropertypanecustomfieldprops.yml | 10 +++--- .../ipropertypanedropdownprops.yml | 5 +-- .../ipropertypanedynamicfieldsetprops.yml | 10 +++--- .../ipropertypanedynamictextfieldprops.yml | 5 +-- .../sp-property-pane/ipropertypanegroup.yml | 5 +-- .../sp-property-pane/ipropertypanepage.yml | 5 +-- .../ipropertypanetextfieldprops.yml | 5 +-- .../ipropertypanetoggleprops.yml | 5 +-- .../basesearchquerymodifier.yml | 5 +-- SP-Framework/sp-webpart-base/basewebpart.yml | 7 ++-- .../sp-webpart-base/basewebpartcontext.yml | 5 +-- .../iclientsidewebpartstatusrenderer.yml | 5 +-- .../sp-webpart-base/imicrosoftteams.yml | 4 +-- .../sp-webpart-base/iwebpartcontext.yml | 4 +-- 69 files changed, 307 insertions(+), 232 deletions(-) diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 314e11f7..764bf6e6 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -61,5 +61,6 @@ properties: content: 'readonly navigatedEvent: SPEvent;' return: type: >- - @microsoft/sp-application-base!ApplicationAccessor# + diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index babb9317..bb1971ad 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -4,9 +4,9 @@ uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' package: '@microsoft/sp-application-base!' fullName: IPlaceholderCreateContentOptions summary: >- - Options for the - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#)) method. + Options for the [PlaceholderProvider.tryCreateContent()](xref:)) method. remarks: '' isPreview: false isDeprecated: false @@ -31,5 +31,6 @@ properties: content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' return: type: >- - @microsoft/sp-application-base!IPlaceholderCreateContentOptions# + diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index c9fe6eda..1954ad21 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -49,8 +49,9 @@ properties: content: 'readonly changedEvent: SPEvent;' return: type: >- - @microsoft/sp-application-base!PlaceholderProvider# + - name: isDisposed uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' package: '@microsoft/sp-application-base!' @@ -75,8 +76,9 @@ properties: content: 'readonly placeholderNames: ReadonlyArray;' return: type: >- - @microsoft/sp-application-base!PlaceholderProvider# + methods: - name: dispose() uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' @@ -125,8 +127,9 @@ methods: /> return: type: >- - @microsoft/sp-application-base!PlaceholderProvider# + description: >- A new PlaceholderContent object, or undefined if the requested placeholder does not exist. diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 353cb2bb..bb9b013a 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -50,8 +50,9 @@ methods: content: 'getAvailableSources(): ReadonlyArray;' return: type: >- - @microsoft/sp-component-base!DynamicDataProvider# + description: Read-only array with all available sources. - name: registerAvailableSourcesChanged(callback) uid: >- @@ -142,8 +143,9 @@ methods: type: string return: type: >- - @microsoft/sp-component-base!DynamicDataProvider# + description: '' - name: unregisterAvailableSourcesChanged(callback) uid: >- diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index dd07f2ca..7cc9e1e4 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -133,8 +133,9 @@ methods: - id: metadata description: Partial of the metadata. type: >- - @microsoft/sp-component-base!DynamicDataSourceManager# + return: type: void description: '' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 5a469aaf..7e7fa662 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -179,8 +179,9 @@ methods: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: type: >- - @microsoft/sp-component-base!DynamicProperty# + description: '' - name: tryGetValue() uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' diff --git a/SP-Framework/sp-component-base/irawstyle.yml b/SP-Framework/sp-component-base/irawstyle.yml index d000b65d..7321ed28 100644 --- a/SP-Framework/sp-component-base/irawstyle.yml +++ b/SP-Framework/sp-component-base/irawstyle.yml @@ -38,6 +38,6 @@ properties: }; return: type: >- - @microsoft/sp-component-base!IRawStyle# extends: '' diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index c20c2943..0f80e74f 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -21,8 +21,8 @@ properties: content: 'readonly fonts: Readonly;' return: type: >- - @microsoft/sp-component-base!IReadonlyTheme# + - name: palette uid: '@microsoft/sp-component-base!IReadonlyTheme#palette:member' package: '@microsoft/sp-component-base!' @@ -35,8 +35,8 @@ properties: content: 'readonly palette: Readonly;' return: type: >- - @microsoft/sp-component-base!IReadonlyTheme# + - name: semanticColors uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' package: '@microsoft/sp-component-base!' @@ -49,6 +49,7 @@ properties: content: 'readonly semanticColors: Readonly;' return: type: >- - @microsoft/sp-component-base!IReadonlyTheme# + extends: '' diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index 2ac729f3..b5039f58 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -21,6 +21,7 @@ properties: content: 'readonly theme: ITheme | undefined;' return: type: >- - @microsoft/sp-component-base!ThemeChangedEventArgs# + extends: '' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index 72b25a66..28077112 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -56,8 +56,9 @@ properties: content: 'readonly themeChangedEvent: SPEvent;' return: type: >- - @microsoft/sp-component-base!ThemeProvider# + methods: - name: tryGetTheme() uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' @@ -71,6 +72,7 @@ methods: content: 'tryGetTheme(): IReadonlyTheme | undefined;' return: type: >- - @microsoft/sp-component-base!ThemeProvider# + description: '' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index dd035efb..bc372d48 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -5,8 +5,9 @@ package: '@microsoft/sp-core-library!' fullName: ServiceKey summary: >- The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope#)) to fetch a dependency. + [ServiceScope.consume()](xref:)) to fetch a + dependency. remarks: >- Every service key also provides a default implementation of the dependency, which will be automatically created in the root scope if the dependency is not @@ -29,8 +30,9 @@ properties: content: 'readonly defaultCreator: ServiceCreator;' return: type: >- - @microsoft/sp-core-library!ServiceKey# + - name: id uid: '@microsoft/sp-core-library!ServiceKey#id:member' package: '@microsoft/sp-core-library!' diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 9d3203d9..9fde7053 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -100,8 +100,8 @@ methods: the key that was used when provide() was called to register the service type: >- - @microsoft/sp-core-library!ServiceScope# + return: type: T description: the service instance @@ -125,13 +125,15 @@ methods: - id: serviceKey description: the key that can be used later to consume the service type: >- - @microsoft/sp-core-library!ServiceScope# + - id: simpleServiceClass description: the TypeScript class to be constructed type: >- - @microsoft/sp-core-library!ServiceScope# + return: type: T description: a newly constructed instance of simpleServiceClass @@ -152,8 +154,9 @@ methods: - id: serviceKey description: the key that can be used later to consume the service type: >- - @microsoft/sp-core-library!ServiceScope# + return: type: T description: >- @@ -198,8 +201,8 @@ methods: content: 'getParent(): ServiceScope | undefined;' return: type: >- - @microsoft/sp-core-library!ServiceScope# + description: the parent service scope - name: 'provide(serviceKey, service)' uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' @@ -219,8 +222,8 @@ methods: - id: serviceKey description: the key that will later be used to consume the service type: >- - @microsoft/sp-core-library!ServiceScope# + - id: service description: the service instance that is being registered type: T @@ -263,9 +266,9 @@ methods: package: '@microsoft/sp-core-library!' fullName: whenFinished(callback) summary: >- - Defer an operation until after - [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope#)) has completed. + Defer an operation until after [ServiceScope.finish()](xref:)) has + completed. remarks: >- It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect your component against this error diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 2790bfaf..4ed0caff 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -146,8 +146,9 @@ properties: content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' return: type: >- - @microsoft/sp-dialog!BaseDialog# + methods: - name: close() uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' @@ -163,7 +164,7 @@ methods: syntax: content: 'close(): Promise;' return: - type: '@microsoft/sp-dialog!BaseDialog#' + type: '' description: >- A promise that resolves when the dialog is visually closed, or if it was already closed @@ -205,7 +206,7 @@ methods: syntax: content: 'protected onBeforeOpen(): Promise;' return: - type: '@microsoft/sp-dialog!BaseDialog#' + type: '' description: >- A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be @@ -256,7 +257,7 @@ methods: for more information. type: '' return: - type: '@microsoft/sp-dialog!BaseDialog#' + type: '' description: >- A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index e0ead467..69999e3c 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -47,8 +47,8 @@ methods: type: '' return: type: >- - @microsoft/sp-dialog!ISecondaryDialogProvider# + description: '' - name: 'prompt(message, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' @@ -76,18 +76,20 @@ methods: type: '' return: type: >- - @microsoft/sp-dialog!ISecondaryDialogProvider# + description: '' - name: 'show(dialog, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' package: '@microsoft/sp-dialog!' fullName: 'show(dialog, options)' summary: >- - Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog#))<!-- -->. The dialog to show is passed in as - parameter and the dialog is immediately shown if there are no other - secondary dialogs. Otherwise, the promise rejects. + Similar to [BaseDialog.show()](xref:))<!-- -->. + The dialog to show is passed in as parameter and the dialog is immediately + shown if there are no other secondary dialogs. Otherwise, the promise + rejects. remarks: '' isPreview: false isDeprecated: false @@ -105,6 +107,6 @@ methods: type: '' return: type: >- - @microsoft/sp-dialog!ISecondaryDialogProvider# + description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 4855a6bf..39abd499 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -33,8 +33,9 @@ methods: content: 'allowedEvents?(): ReadonlyArray;' return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataCallables# + description: '' - name: getAnnotatedPropertyValue(propertyId) uid: >- @@ -59,8 +60,9 @@ methods: type: string return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataCallables# + description: '' - name: getPropertyDefinitions() uid: >- @@ -75,8 +77,9 @@ methods: content: 'getPropertyDefinitions(): ReadonlyArray;' return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataCallables# + description: '' - name: getPropertyValue(propertyId) uid: >- diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 6c90b904..3a72855e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -59,8 +59,9 @@ methods: Promise>; return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' - name: getAnnotatedPropertyValue(propertyId) uid: >- @@ -113,8 +114,9 @@ methods: type: string return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' - name: getPropertyDefinitions() uid: >- @@ -134,8 +136,9 @@ methods: content: 'getPropertyDefinitions(): ReadonlyArray;' return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' - name: getPropertyDefinitionsAsync() uid: >- @@ -154,8 +157,9 @@ methods: Promise>; return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' - name: getPropertyValue(propertyId) uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' @@ -198,8 +202,9 @@ methods: type: string return: type: >- - @microsoft/sp-dynamic-data!IDynamicDataSource# + description: '' - name: 'sendEvent(eventName, data)' uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 518e8461..f8e5dc82 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -65,7 +65,7 @@ methods: content: 'protected onInit(): Promise;' return: type: >- - @microsoft/sp-extension-base!BaseExtension# + description: '' extends: '' diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index ec1bde7a..6775ab0e 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -87,7 +87,7 @@ methods: description: Additional options that affect the request. type: '' return: - type: '@microsoft/sp-http!AadHttpClient#' + type: '' description: A promise that will return the result. - name: 'get(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' @@ -114,7 +114,7 @@ methods: description: Additional options that affect the request. type: '' return: - type: '@microsoft/sp-http!AadHttpClient#' + type: '' description: A promise that will return the result. - name: 'post(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' @@ -141,5 +141,5 @@ methods: description: Additional options that affect the request. type: '' return: - type: '@microsoft/sp-http!AadHttpClient#' + type: '' description: A promise that will return the result. diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 618e854d..b689328f 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -50,6 +50,6 @@ methods: type: string return: type: >- - @microsoft/sp-http!AadHttpClientFactory# + description: '' diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 6f83fe8d..f744aa3a 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -32,8 +32,9 @@ properties: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: type: >- - @microsoft/sp-http!AadTokenProvider# + methods: - name: 'getToken(resourceEndpoint, useCachedToken)' uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' @@ -64,7 +65,7 @@ methods: https://graph.microsoft.com type: boolean return: - type: '@microsoft/sp-http!AadTokenProvider#' + type: '' description: >- A promise that will be fullfiled with the token or that will reject with an error message diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 8a518f86..379ade6b 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -38,6 +38,7 @@ methods: content: 'getTokenProvider(): Promise;' return: type: >- - @microsoft/sp-http!AadTokenProviderFactory# + description: '' diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index f2087996..5ff11e7a 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -143,5 +143,5 @@ methods: be a server-relative or absolute URL. type: string return: - type: '@microsoft/sp-http!DigestCache#' + type: '' description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 93b7e92b..392f593f 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -140,7 +140,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: del(callback) uid: '@microsoft/sp-http!GraphRequest#del:member(1)' @@ -160,7 +160,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: delete(callback) uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' @@ -180,7 +180,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: expand(properties) uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' @@ -234,7 +234,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: getStream(callback) uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' @@ -354,7 +354,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: 'post(content, callback)' uid: '@microsoft/sp-http!GraphRequest#post:member(1)' @@ -377,7 +377,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: 'put(content, callback)' uid: '@microsoft/sp-http!GraphRequest#put:member(1)' @@ -400,7 +400,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: 'putStream(stream, callback)' uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' @@ -554,7 +554,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '@microsoft/sp-http!GraphRequest#' + type: '' description: '' - name: version(v) uid: '@microsoft/sp-http!GraphRequest#version:member(1)' diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 81773058..38a8bc84 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -84,7 +84,7 @@ methods: description: additional options that affect the request type: '' return: - type: '@microsoft/sp-http!HttpClient#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -117,7 +117,7 @@ methods: description: additional options that affect the request type: '' return: - type: '@microsoft/sp-http!HttpClient#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -150,7 +150,7 @@ methods: description: additional options that affect the request type: '' return: - type: '@microsoft/sp-http!HttpClient#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 8b46b7b3..0e026ebc 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -141,8 +141,8 @@ methods: content: 'arrayBuffer(): Promise;' return: type: >- - @microsoft/sp-http!HttpClientResponse# + description: '' - name: blob() uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' @@ -157,7 +157,7 @@ methods: syntax: content: 'blob(): Promise;' return: - type: '@microsoft/sp-http!HttpClientResponse#' + type: '' description: '' - name: clone() uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' @@ -188,7 +188,7 @@ methods: content: 'formData(): Promise;' return: type: >- - @microsoft/sp-http!HttpClientResponse# description: '' - name: json() @@ -204,7 +204,7 @@ methods: syntax: content: 'json(): Promise;' return: - type: '@microsoft/sp-http!HttpClientResponse#' + type: '' description: '' - name: text() uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' @@ -219,5 +219,5 @@ methods: syntax: content: 'text(): Promise;' return: - type: '@microsoft/sp-http!HttpClientResponse#' + type: '' description: '' diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 1f12d9e8..2bd6b744 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -30,8 +30,9 @@ properties: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: type: >- - @microsoft/sp-http!IAadTokenProvider# + methods: - name: 'getToken(resourceEndpoint, useCachedToken)' uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' @@ -63,7 +64,7 @@ methods: description: Allows the developer to specify if cached tokens should be returned. type: boolean return: - type: '@microsoft/sp-http!IAadTokenProvider#' + type: '' description: >- A promise that will be fullfiled with the token or that will reject with an error message diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 42a1a340..4eea6860 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -115,5 +115,5 @@ methods: be a server-relative or absolute URL. type: string return: - type: '@microsoft/sp-http!IDigestCache#' + type: '' description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 5509db72..5c6ba29c 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -45,6 +45,6 @@ methods: content: 'getClient(): Promise;' return: type: >- - @microsoft/sp-http!MSGraphClientFactory# + description: '' diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 05e1d98f..6d58a7ca 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -141,7 +141,7 @@ methods: description: additional options that affect the request type: '' return: - type: '@microsoft/sp-http!SPHttpClient#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -174,7 +174,7 @@ methods: description: additional options that affect the request type: '' return: - type: '@microsoft/sp-http!SPHttpClient#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -238,7 +238,7 @@ methods: description: additional options that affect the request type: '' return: - type: '@microsoft/sp-http!SPHttpClient#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 72694cfc..c3d3a3a8 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -53,7 +53,7 @@ methods: syntax: content: 'execute(): Promise;' return: - type: '@microsoft/sp-http!SPHttpClientBatch#' + type: '' description: '' - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' @@ -102,7 +102,7 @@ methods: return: - type: '@microsoft/sp-http!SPHttpClientBatch#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -138,7 +138,7 @@ methods: return: - type: '@microsoft/sp-http!SPHttpClientBatch#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -174,7 +174,7 @@ methods: return: - type: '@microsoft/sp-http!SPHttpClientBatch#' + type: '' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index d0661487..c268bd23 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -45,8 +45,9 @@ properties: content: 'readonly correlationId: Guid | undefined;' return: type: >- - @microsoft/sp-http!SPHttpClientResponse# + methods: - name: clone() uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index aae20977..0db93cca 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -48,8 +48,9 @@ methods: /> return: type: >- - @microsoft/sp-list-subscription!ListSubscriptionFactory# + description: Promise of the subscription to the list. - name: deleteSubscription(subscription) uid: >- diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 3fdc3dda..19cbac9e 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -47,7 +47,8 @@ methods: content: 'tryGetListView(): ListViewAccessor | undefined;' return: type: >- - @microsoft/sp-listview-extensibility!FieldCustomizerContext# + description: 'the SharePoint list view, or undefined if there is none.' extends: '' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index 86ead6a5..fc9a30d2 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -5,9 +5,9 @@ uid: >- package: '@microsoft/sp-listview-extensibility!' fullName: IListViewCommandSetExecuteEventParameters summary: >- - Parameters for - [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#)) + Parameters for [BaseListViewCommandSet.onExecute()](xref:)) remarks: '' isPreview: false isDeprecated: false @@ -41,5 +41,6 @@ properties: content: 'readonly selectedRows: ReadonlyArray;' return: type: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters# + diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index cea3a1bc..9b2d770c 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -5,9 +5,9 @@ uid: >- package: '@microsoft/sp-listview-extensibility!' fullName: IListViewCommandSetListViewUpdatedParameters summary: >- - Parameters for - [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#)) + Parameters for [BaseListViewCommandSet.onListViewUpdated()](xref:)) remarks: '' isPreview: false isDeprecated: false @@ -26,5 +26,6 @@ properties: content: 'readonly selectedRows: ReadonlyArray;' return: type: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters# + diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 587c9305..2e408246 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -43,8 +43,9 @@ properties: content: 'abstract readonly fields: ReadonlyArray;' return: type: >- - @microsoft/sp-listview-extensibility!ListItemAccessor# + methods: - name: getValue(field) uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 34d79186..5a3057a3 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -24,8 +24,9 @@ properties: content: 'abstract readonly columns: ReadonlyArray;' return: type: >- - @microsoft/sp-listview-extensibility!ListViewAccessor# + - name: selectedRowsChangedEvent uid: >- @microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member @@ -43,8 +44,9 @@ properties: SPEvent; return: type: >- - @microsoft/sp-listview-extensibility!ListViewAccessor# + methods: - name: tryGetColumnByName(internalName) uid: >- @@ -67,6 +69,7 @@ methods: type: string return: type: >- - @microsoft/sp-listview-extensibility!ListViewAccessor# + description: '' diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index e1c7b152..2da098b6 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -24,6 +24,7 @@ properties: content: 'selectedRows: ReadonlyArray;' return: type: >- - @microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs# + extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 9e1a5913..149ca579 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -177,5 +177,6 @@ properties: }; return: type: >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration# + diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 6b7787de..e053514b 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -137,8 +137,9 @@ properties: content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' return: type: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest# + - name: supportedHosts uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member @@ -160,8 +161,9 @@ properties: 'TeamsTab' | 'TeamsPersonalApp'>; return: type: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest# + - name: supportsFullBleed uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 09c91ade..a7e98137 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -129,8 +129,9 @@ properties: content: 'groupId: PredefinedGroup | string;' return: type: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry# + - name: iconImageUrl uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member @@ -236,8 +237,9 @@ properties: content: 'tags?: ILocalizedString[];' return: type: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry# + - name: title uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index cabca070..d90d8890 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -46,8 +46,9 @@ properties: }; return: type: >- - @microsoft/sp-module-interfaces!ICommandSetExtensionManifest# + extends: >- - - @microsoft/sp-module-interfaces!IComponentModuleConfiguration# + - name: id uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 39b3567b..2dbe0885 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -41,8 +41,9 @@ properties: content: 'defaultPath: string | IPath;' return: type: >- - @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration# + - name: paths uid: >- @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member @@ -91,6 +92,7 @@ properties: }; return: type: >- - @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration# + extends: '' diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 6baff21a..92b97282 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -105,6 +105,7 @@ properties: content: 'path: string | IPath;' return: type: >- - @microsoft/sp-module-interfaces!IPathModuleConfiguration# + extends: '' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index ee29c28f..7bced7b6 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -26,8 +26,9 @@ properties: content: 'Children?: IODataNavigationNode[];' return: type: >- - @microsoft/sp-odata-types!IODataNavigationNode# + - name: Id uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' package: '@microsoft/sp-odata-types!' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index d7b29d74..f61d5e91 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -28,8 +28,9 @@ properties: content: 'quickLaunch: IODataNavigationNode[];' return: type: >- - @microsoft/sp-odata-types!IODataNavigationNodeCollection# + - name: topNav uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' package: '@microsoft/sp-odata-types!' @@ -44,5 +45,6 @@ properties: content: 'topNav: IODataNavigationNode[];' return: type: >- - @microsoft/sp-odata-types!IODataNavigationNodeCollection# + diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 31c9ca51..8d17d506 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -44,7 +44,7 @@ properties: content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' return: type: >- - @microsoft/sp-page-context!PageContext# - name: cultureInfo uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' @@ -113,7 +113,7 @@ properties: syntax: content: 'readonly list: SPList | undefined;' return: - type: '@microsoft/sp-page-context!PageContext#' + type: '' - name: listItem uid: '@microsoft/sp-page-context!PageContext#listItem:member' package: '@microsoft/sp-page-context!' @@ -129,7 +129,7 @@ properties: content: 'readonly listItem: SPListItem | undefined;' return: type: >- - @microsoft/sp-page-context!PageContext# - name: serviceKey uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index fab135f0..63d7a401 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -30,8 +30,9 @@ properties: content: 'readonly clientSideComponentId: Guid | undefined;' return: type: >- - @microsoft/sp-page-context!SPField# + - name: clientSideComponentProperties uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 581732e0..21a2964a 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -540,8 +540,9 @@ methods: Any number of SPPermission objects to be compared against the original type: >- - @microsoft/sp-page-context!SPPermission# + return: type: boolean description: '' @@ -563,8 +564,9 @@ methods: Any number of SPPermission objects to be compared against the original type: >- - @microsoft/sp-page-context!SPPermission# + return: type: boolean description: '' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index af97bb5e..82606492 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -79,7 +79,7 @@ properties: syntax: content: 'readonly group: O365GroupAssociation | undefined;' return: - type: '@microsoft/sp-page-context!SPSite#' + type: '' - name: id uid: '@microsoft/sp-page-context!SPSite#id:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 3bdcc82b..eaed5430 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -52,7 +52,7 @@ properties: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: type: >- - @microsoft/sp-page-context!SPUser# - name: isAnonymousGuestUser uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' @@ -120,5 +120,5 @@ properties: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: type: >- - @microsoft/sp-page-context!SPUser# diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 8625281f..bafc9a8e 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -54,7 +54,7 @@ properties: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: type: >- - @microsoft/sp-page-context!SPWeb# - name: id uid: '@microsoft/sp-page-context!SPWeb#id:member' @@ -175,7 +175,7 @@ properties: syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: '@microsoft/sp-page-context!SPWeb#' + type: '' - name: title uid: '@microsoft/sp-page-context!SPWeb#title:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index d15f4ad2..41c69c68 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -33,5 +33,6 @@ properties: content: 'options: IPropertyPaneChoiceGroupOption[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps# + diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 1765874c..5ad3e6b2 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -39,8 +39,9 @@ properties: content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneConfiguration# + - name: loadingIndicatorDelayTime uid: >- @microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member @@ -68,8 +69,9 @@ properties: content: 'pages: IPropertyPanePage[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneConfiguration# + - name: showLoadingIndicator uid: >- @microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index b4975380..4c3362bc 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -60,8 +60,9 @@ properties: content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneCustomFieldProps# + - name: onRender uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' package: '@microsoft/sp-property-pane!' @@ -78,5 +79,6 @@ properties: (targetProperty?: string, newValue?: any) => void) => void; return: type: >- - @microsoft/sp-property-pane!IPropertyPaneCustomFieldProps# + diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index a4e673b3..aef81332 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -113,8 +113,9 @@ properties: content: 'options?: IPropertyPaneDropdownOption[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneDropdownProps# + - name: selectedKey uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 208c74b6..ce6ec814 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -24,8 +24,9 @@ properties: content: 'fields: IPropertyPaneField[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps# + - name: label uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' package: '@microsoft/sp-property-pane!' @@ -56,5 +57,6 @@ properties: }; return: type: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps# + diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index b0b36abd..96035316 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -113,8 +113,9 @@ properties: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps# + - name: placeholder uid: >- @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 1c226576..267d772f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -21,8 +21,9 @@ properties: content: 'groupFields: IPropertyPaneField[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneGroup# + - name: groupName uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 250024ca..5c1c036a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -36,8 +36,9 @@ properties: content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' return: type: >- - @microsoft/sp-property-pane!IPropertyPanePage# + - name: header uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index 875b350b..36cd2fe8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -193,8 +193,9 @@ properties: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneTextFieldProps# + - name: placeholder uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index e7f46157..52d9fcb5 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -57,8 +57,9 @@ properties: content: 'label: string | JSX.Element;' return: type: >- - @microsoft/sp-property-pane!IPropertyPaneToggleProps# + - name: offAriaLabel uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 055b602f..9001c166 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -78,8 +78,9 @@ methods: uid="@microsoft/sp-search-extensibility!SearchQueryScenario:enum" /> return: type: >- - @microsoft/sp-search-extensibility!BaseSearchQueryModifier# + description: Modified query. extends: >- - - @microsoft/sp-webpart-base!BaseWebPart# + - name: title uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' package: '@microsoft/sp-webpart-base!' @@ -361,7 +362,7 @@ methods: syntax: content: 'protected onInit(): Promise;' return: - type: '@microsoft/sp-webpart-base!BaseWebPart#' + type: '' description: '' - name: onPropertyPaneConfigurationComplete() uid: >- diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index e29cf15f..e6e2c502 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -44,8 +44,9 @@ properties: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: type: >- - @microsoft/sp-webpart-base!BaseWebPartContext# + - name: propertyPane uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 71361900..09a516cc 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -91,8 +91,9 @@ methods: - id: error description: the error message. type: >- - @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer# + return: type: void description: '' diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index b71273c2..d9dd3921 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -25,8 +25,8 @@ properties: content: 'context: microsoftTeams.Context;' return: type: >- - @microsoft/sp-webpart-base!IMicrosoftTeams# + - name: teamsJs uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 4f9c7772..ba694224 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -66,8 +66,8 @@ properties: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: type: >- - @microsoft/sp-webpart-base!IWebPartContext# + - name: pageContext uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' package: '@microsoft/sp-webpart-base!' From 8de2a4b89c0093f8788eaa95bf0d6d67bb047d71 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:53:52 +0800 Subject: [PATCH 38/55] change ur to sdp --- .openpublishing.publish.config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 0c74bb8a..f5d89b22 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -43,7 +43,7 @@ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "master", + "branch": "develop", "branch_mapping": {} } ], From 6ee1fa47364d631c5d5da9964cc25cee5c4110e5 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 11:57:26 +0800 Subject: [PATCH 39/55] change ur to sdp --- SP-Framework/decorators.yml | 6 +-- .../applicationaccessor.yml | 5 +- .../applicationcustomizercontext.yml | 6 +-- .../iplaceholdercreatecontentoptions.yml | 6 +-- SP-Framework/sp-component-base.yml | 2 - .../basecomponentcontext.yml | 6 +-- .../sp-component-base/dynamicproperty.yml | 5 +- .../sp-component-base/isemanticcolors.yml | 2 +- SP-Framework/sp-core-library.yml | 2 - SP-Framework/sp-core-library/guid.yml | 2 +- .../irandomnumbergenerator.yml | 5 +- .../sp-core-library/ispeventobserver.yml | 5 +- .../sp-core-library/itimeprovider.yml | 5 +- .../sp-core-library/randomnumbergenerator.yml | 6 +-- SP-Framework/sp-core-library/servicekey.yml | 5 +- SP-Framework/sp-core-library/servicescope.yml | 6 +-- SP-Framework/sp-core-library/speventargs.yml | 4 +- SP-Framework/sp-core-library/text.yml | 2 +- SP-Framework/sp-core-library/timeprovider.yml | 6 +-- .../sp-dialog/isecondarydialogprovider.yml | 26 +++++----- SP-Framework/sp-http/aadhttpclientfactory.yml | 6 +-- SP-Framework/sp-http/digestcache.yml | 4 +- SP-Framework/sp-http/graphhttpclient.yml | 7 ++- .../sp-http/graphhttpclientconfiguration.yml | 4 +- .../sp-http/graphhttpclientresponse.yml | 4 +- SP-Framework/sp-http/graphrequest.yml | 5 +- SP-Framework/sp-http/httpclientresponse.yml | 48 +++++++++---------- .../sp-http/iaadhttpclientconfigurations.yml | 2 +- SP-Framework/sp-http/iaadtokenprovider.yml | 3 +- SP-Framework/sp-http/idigestcache.yml | 4 +- .../igraphhttpclientconfigurations.yml | 2 +- .../sp-http/ihttpclientconfigurations.yml | 2 +- .../isphttpclientbatchcreationoptions.yml | 10 ++-- .../sp-http/isphttpclientbatchoptions.yml | 2 +- SP-Framework/sp-http/isphttpclientoptions.yml | 2 +- SP-Framework/sp-http/msgraphclientfactory.yml | 4 +- SP-Framework/sp-http/sphttpclientbatch.yml | 3 +- .../sp-http/sphttpclientconfiguration.yml | 4 +- SP-Framework/sp-http/sphttpheader.yml | 4 +- ...stviewcommandsetexecuteeventparameters.yml | 5 +- ...iewcommandsetlistviewupdatedparameters.yml | 5 +- SP-Framework/sp-loader/spcomponentloader.yml | 4 +- SP-Framework/sp-lodash-subset.yml | 3 -- SP-Framework/sp-module-interfaces.yml | 3 -- .../icomponentmoduleconfiguration.yml | 6 +-- .../imoduleconfiguration.yml | 4 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 7 ++- .../sp-odata-types/iodatachangetoken.yml | 5 +- .../iodatacontextwebinformation.yml | 5 +- SP-Framework/sp-odata-types/iodatalist.yml | 5 +- .../sp-odata-types/iodatalistitem.yml | 5 +- .../sp-odata-types/iodatanavigationnode.yml | 5 +- .../iodatanavigationnodecollection.yml | 4 +- SP-Framework/sp-odata-types/iodatauser.yml | 7 ++- .../sp-odata-types/iodatausercustomaction.yml | 6 +-- SP-Framework/sp-odata-types/iodataweb.yml | 7 ++- SP-Framework/sp-page-context/splist.yml | 4 +- SP-Framework/sp-page-context/spweb.yml | 8 ++-- SP-Framework/sp-property-pane.yml | 2 - .../ipropertypanecustomfieldprops.yml | 6 +-- .../ipropertypanesliderprops.yml | 2 +- .../propertypanedropdownoptiontype.yml | 5 +- .../propertypanedropdownoptiontype.yml | 5 +- 63 files changed, 153 insertions(+), 197 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index a1500de3..115d7c8c 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -13,7 +13,7 @@ functions: This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as - @<!-- -->virtual. This decorator is currently used for documentation + @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' isPreview: false @@ -61,8 +61,8 @@ functions: summary: >- This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child - class. Conversely, if the @<!-- -->virtual decorator is NOT applied - to a definition, then child classes may NOT override it. This decorator is + class. Conversely, if the @virtual decorator is NOT applied to a + definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 764bf6e6..a4719f05 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -28,8 +28,9 @@ constructors: package: '@microsoft/sp-application-base!' fullName: (constructor)(serviceScope) summary: >- - Constructs a new instance of the [ApplicationAccessor](xref:) class. + Constructs a new instance of the + [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) + class. remarks: >- Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 237e6fda..5012be56 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -4,9 +4,9 @@ uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' package: '@microsoft/sp-application-base!' fullName: ApplicationCustomizerContext summary: >- - The component context for [BaseApplicationCustomizer](xref:)<!-- -->. + The component context for + [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index bb1971ad..ccdcb031 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -4,9 +4,9 @@ uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' package: '@microsoft/sp-application-base!' fullName: IPlaceholderCreateContentOptions summary: >- - Options for the [PlaceholderProvider.tryCreateContent()](xref:)) method. + Options for the + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) + method. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 177d265a..2e9b0f0d 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -20,5 +20,3 @@ interfaces: - '@microsoft/sp-component-base!ISemanticColors:interface' - '@microsoft/sp-component-base!ISemanticTextColors:interface' - '@microsoft/sp-component-base!ITheme:interface' -typeAliases: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 8392c6d6..2780b27e 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -165,9 +165,9 @@ properties: package: '@microsoft/sp-component-base!' fullName: serviceScope summary: >- - The associated [ServiceScope](xref:) for this - component. + The associated + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for + this component. remarks: A child service scope is created for each client-side component. isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 7e7fa662..670c43d6 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -55,8 +55,7 @@ properties: fullName: reference summary: >- DynamicDataReference string that the DynamicProperty object points to. The - reference is of the form - `<source>:<property>:<path>`<!-- -->. + reference is of the form `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' isPreview: false isDeprecated: false @@ -135,7 +134,7 @@ methods: summary: >- Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form - `<source>:<property>:<path>`<!-- -->. + `::`. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-component-base/isemanticcolors.yml b/SP-Framework/sp-component-base/isemanticcolors.yml index 484d87de..7f8453ec 100644 --- a/SP-Framework/sp-component-base/isemanticcolors.yml +++ b/SP-Framework/sp-component-base/isemanticcolors.yml @@ -123,7 +123,7 @@ properties: package: '@microsoft/sp-component-base!' fullName: bodyDivider summary: >- - Divider lines; e.g. lines that separate sections in a menu, an <HR> + Divider lines; e.g. lines that separate sections in a menu, an
element. remarks: '' isPreview: false diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index 6b33a460..5342ee51 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -27,5 +27,3 @@ interfaces: - '@microsoft/sp-core-library!IServiceCollection:interface' - '@microsoft/sp-core-library!ISPEventObserver:interface' - '@microsoft/sp-core-library!ITimeProvider:interface' -typeAliases: - - '@microsoft/sp-core-library!ServiceCreator:type' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 25fe7def..f818e67b 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -57,7 +57,7 @@ methods: fullName: isValid(guid) summary: >- Indicates whether a GUID is valid, i.e. whether it would be successfully - parsed by `Guid.tryParse()`<!-- -->. This function is cheaper than + parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. remarks: '' isPreview: false diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 3ec3de4d..ec8652c1 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' package: '@microsoft/sp-core-library!' fullName: IRandomNumberGenerator summary: >- - This is a [ServiceScope](xref:) contract for - generating pseudorandom random numbers. + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) + contract for generating pseudorandom random numbers. remarks: >- This interface abstracts the functionality of the system Math.random() API for usage with a diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 69481302..c4ceec8d 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-core-library!ISPEventObserver:interface' package: '@microsoft/sp-core-library!' fullName: ISPEventObserver summary: >- - Used with the [SPEvent](xref:) system, this interface is - implemented by components that can subscribe to events. + Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, + this interface is implemented by components that can subscribe to events. remarks: >- ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 4eedc152..376f8a98 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-core-library!ITimeProvider:interface' package: '@microsoft/sp-core-library!' fullName: ITimeProvider summary: >- - This is a [ServiceScope](xref:) contract for reading - the system clock. + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) + contract for reading the system clock. remarks: >- This interface abstracts the functionality of the system time APIs for usage with a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). remarks: >- Note that JavaScript's `string.replace()` only replaces the first match, unless a global RegExp is provided. diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index e92e95ba..12d37083 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -4,9 +4,9 @@ uid: '@microsoft/sp-core-library!TimeProvider:class' package: '@microsoft/sp-core-library!' fullName: TimeProvider summary: >- - This is the default implementation of [ITimeProvider](xref:) that simply calls - the real browser APIs. + This is the default implementation of + [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that + simply calls the real browser APIs. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 69999e3c..df72f785 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -26,10 +26,10 @@ methods: package: '@microsoft/sp-dialog!' fullName: 'alert(message, options)' summary: >- - Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.))<!-- -->. The only difference is that the - dialog is immediately shown if there are no other secondary dialogs. - Otherwise, the promise rejects. + Similar to + [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there + are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' isPreview: false isDeprecated: false @@ -55,10 +55,10 @@ methods: package: '@microsoft/sp-dialog!' fullName: 'prompt(message, options)' summary: >- - Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.))<!-- -->. The only difference is that the - dialog is immediately shown if there are no other secondary dialogs. - Otherwise, the promise rejects. + Similar to + [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there + are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' isPreview: false isDeprecated: false @@ -85,11 +85,11 @@ methods: package: '@microsoft/sp-dialog!' fullName: 'show(dialog, options)' summary: >- - Similar to [BaseDialog.show()](xref:))<!-- -->. - The dialog to show is passed in as parameter and the dialog is immediately - shown if there are no other secondary dialogs. Otherwise, the promise - rejects. + Similar to + [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog#show:member(1)). The dialog to show is passed in as parameter and the dialog is + immediately shown if there are no other secondary dialogs. Otherwise, the + promise rejects. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index b689328f..7cb75904 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -5,10 +5,8 @@ package: '@microsoft/sp-http!' fullName: AadHttpClientFactory summary: >- Returns a preinitialized version of the AadHttpClient for a given resource - url. For more information: [.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) + url. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 5ff11e7a..4a7a1495 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -13,8 +13,8 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using - SharePoint 2013 REST endpoints"](.microsoft.com/en-us/library/office/jj164022.aspx) + SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml index e9856b9d..81035938 100644 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ b/SP-Framework/sp-http/graphhttpclient.yml @@ -6,8 +6,7 @@ fullName: GraphHttpClient summary: >- GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds default headers and collects telemetry that helps the service to monitor the - performance of an application. .microsoft.com/en-us/graph/ + performance of an application. https://developer.microsoft.com/en-us/graph/ remarks: >- This class is marked as `@sealed`. Subclasses should not extend it. @@ -26,8 +25,8 @@ constructors: package: sp-http fullName: constructor summary: >- - Constructs a new instance of the [GraphHttpClient](.GraphHttpClient) class + Constructs a new instance of the + [GraphHttpClient](xref:sp-http.GraphHttpClient) class remarks: '' isPreview: false isDeprecated: true diff --git a/SP-Framework/sp-http/graphhttpclientconfiguration.yml b/SP-Framework/sp-http/graphhttpclientconfiguration.yml index 8283d695..56aa538e 100644 --- a/SP-Framework/sp-http/graphhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/graphhttpclientconfiguration.yml @@ -3,9 +3,7 @@ name: GraphHttpClientConfiguration uid: sp-http.GraphHttpClientConfiguration package: sp-http fullName: GraphHttpClientConfiguration -summary: >- - Configuration for [GraphHttpClient](.GraphHttpClient)<!-- -->. +summary: 'Configuration for [GraphHttpClient](xref:sp-http.GraphHttpClient).' remarks: >- The GraphHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the GraphHttpClient class. Normally diff --git a/SP-Framework/sp-http/graphhttpclientresponse.yml b/SP-Framework/sp-http/graphhttpclientresponse.yml index 5cfc74db..cd8fd3b8 100644 --- a/SP-Framework/sp-http/graphhttpclientresponse.yml +++ b/SP-Framework/sp-http/graphhttpclientresponse.yml @@ -20,8 +20,8 @@ constructors: package: sp-http fullName: constructor summary: >- - Constructs a new instance of the [GraphHttpClientResponse](.GraphHttpClientResponse) class + Constructs a new instance of the + [GraphHttpClientResponse](xref:sp-http.GraphHttpClientResponse) class remarks: '' isPreview: false isDeprecated: true diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 392f593f..836166b1 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-http!GraphRequest:interface' package: '@microsoft/sp-http!' fullName: GraphRequest summary: >- - Typings for the GraphRequest Object For more information: [.com/microsoftgraph/msgraph-sdk-javascript](.com/microsoftgraph/msgraph-sdk-javascript) + Typings for the GraphRequest Object For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 0e026ebc..79f4be34 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -21,8 +21,8 @@ properties: package: '@microsoft/sp-http!' fullName: bodyUsed summary: >- - See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + See documentation for the browser's + [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -35,8 +35,8 @@ properties: package: '@microsoft/sp-http!' fullName: headers summary: >- - See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + See documentation for the browser's + [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -61,8 +61,8 @@ properties: package: '@microsoft/sp-http!' fullName: ok summary: >- - See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + See documentation for the browser's + [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -75,8 +75,8 @@ properties: package: '@microsoft/sp-http!' fullName: status summary: >- - See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + See documentation for the browser's + [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -89,8 +89,8 @@ properties: package: '@microsoft/sp-http!' fullName: statusText summary: >- - See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + See documentation for the browser's + [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -103,8 +103,8 @@ properties: package: '@microsoft/sp-http!' fullName: type summary: >- - See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + See documentation for the browser's + [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -117,8 +117,8 @@ properties: package: '@microsoft/sp-http!' fullName: url summary: >- - See documentation for the browser's [Response](.mozilla.org/en-US/docs/Web/API/Response) API + See documentation for the browser's + [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -132,8 +132,8 @@ methods: package: '@microsoft/sp-http!' fullName: arrayBuffer() summary: >- - See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + See documentation for the browser's + [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -149,8 +149,8 @@ methods: package: '@microsoft/sp-http!' fullName: blob() summary: >- - See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + See documentation for the browser's + [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -179,8 +179,8 @@ methods: package: '@microsoft/sp-http!' fullName: formData() summary: >- - See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + See documentation for the browser's + [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -196,8 +196,8 @@ methods: package: '@microsoft/sp-http!' fullName: json() summary: >- - See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + See documentation for the browser's + [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -211,8 +211,8 @@ methods: package: '@microsoft/sp-http!' fullName: text() summary: >- - See documentation for the browser's [Body](.mozilla.org/en-US/docs/Web/API/Body) API + See documentation for the browser's + [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 875e758e..d2fa1cd7 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -22,7 +22,7 @@ properties: summary: >- This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API - that is documented here: .spec.whatwg.org/ + that is documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 2bd6b744..d1f0fcbd 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -47,8 +47,7 @@ methods: cached by the method itself. - An example of a resourceEndpoint would be .outlook.com + An example of a resourceEndpoint would be https://sdfpilot.outlook.com remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 4eea6860..b2b466a4 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -13,8 +13,8 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using - SharePoint 2013 REST endpoints"](.microsoft.com/en-us/library/office/jj164022.aspx) + SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml index 692150af..f309f811 100644 --- a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml @@ -24,7 +24,7 @@ properties: summary: >- This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API - that is documented here: .spec.whatwg.org/ + that is documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: true isDeprecated: true diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 1cdcad57..2c1c3317 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -22,7 +22,7 @@ properties: summary: >- This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API - that is documented here: .spec.whatwg.org/ + that is documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index b81937e5..4b22984e 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -17,11 +17,11 @@ properties: fullName: webUrl summary: >- SPHttpClientBatch will need to perform its POST to an endpoint such as - ".com/sites/sample/\_api/$batch". Typically - the SPWeb URL (".com/sites/sample" in this - example) can be guessed by looking for a reserved URL segment such as - "\_api" in the first URL passed to fetch(), but if not, the webUrl can be - explicitly specified using this option. + "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL + ("https://example.com/sites/sample" in this example) can be guessed by + looking for a reserved URL segment such as "\_api" in the first URL passed + to fetch(), but if not, the webUrl can be explicitly specified using this + option. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index d185979e..87488d13 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -6,7 +6,7 @@ fullName: ISPHttpClientBatchOptions summary: >- This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters - that are documented here: .spec.whatwg.org/ + that are documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index ad735ad9..6cc85462 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -6,7 +6,7 @@ fullName: ISPHttpClientOptions summary: >- This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters - that are documented here: .spec.whatwg.org/ + that are documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 5c6ba29c..e461febc 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -5,9 +5,7 @@ package: '@microsoft/sp-http!' fullName: MSGraphClientFactory summary: >- Returns a preinitialized version of the MSGraphClient. For more information: - [.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index c3d3a3a8..0954d9d8 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -6,8 +6,7 @@ fullName: SPHttpClientBatch summary: >- The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. This protocol is documented here: - .oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html + http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html The usage is to call SPHttpClientBatch.fetch() to queue each individual diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 79db0ffb..829182ce 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' package: '@microsoft/sp-http!' fullName: SPHttpClientConfiguration summary: >- - Configuration for [SPHttpClient](xref:)<!-- -->. + Configuration for + [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class). remarks: >- The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index b485b235..7ceadaca 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-http!SPHttpHeader:enum' package: '@microsoft/sp-http!' fullName: SPHttpHeader summary: >- - Standard HTTP headers used with [SPHttpClient](xref:) + Standard HTTP headers used with + [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index fc9a30d2..356b8471 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -5,9 +5,8 @@ uid: >- package: '@microsoft/sp-listview-extensibility!' fullName: IListViewCommandSetExecuteEventParameters summary: >- - Parameters for [BaseListViewCommandSet.onExecute()](xref:)) + Parameters for + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 9b2d770c..3236b9fe 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -5,9 +5,8 @@ uid: >- package: '@microsoft/sp-listview-extensibility!' fullName: IListViewCommandSetListViewUpdatedParameters summary: >- - Parameters for [BaseListViewCommandSet.onListViewUpdated()](xref:)) + Parameters for + [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index 7bb783bf..9d08da1a 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: SPComponentLoader summary: >- Component loader. Needs to be initialized with an implemented - `ISPComponentLoader`<!-- -->. + `ISPComponentLoader`. remarks: '' isPreview: false isDeprecated: false @@ -80,7 +80,7 @@ methods: uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' package: '@microsoft/sp-loader!' fullName: loadCss(url) - summary: Inserts a `<link ... />` tag for a stylesheet. + summary: Inserts a `` tag for a stylesheet. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml index 9d90986a..004c0961 100644 --- a/SP-Framework/sp-lodash-subset.yml +++ b/SP-Framework/sp-lodash-subset.yml @@ -3,6 +3,3 @@ uid: '@microsoft/sp-lodash-subset!' name: '@microsoft/sp-lodash-subset' type: package summary: '' -typeAliases: - - '@microsoft/sp-lodash-subset!Cancelable:type' - - '@microsoft/sp-lodash-subset!ThrottleSettings:type' diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index 1e923271..7508da50 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -3,9 +3,6 @@ uid: '@microsoft/sp-module-interfaces!' name: '@microsoft/sp-module-interfaces' type: package summary: '' -typeAliases: - - '@microsoft/sp-module-interfaces!ComponentType:type' - - '@microsoft/sp-module-interfaces!ExtensionType:type' interfaces: - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - >- diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 9e888c66..3f78e653 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -64,9 +64,9 @@ properties: fullName: version summary: >- The version of the framework-supplied component to be loaded. For - framework runtime component such as `@microsoft/sp-client-base`<!-- - -->, it is recommended the version of the framework component the - component was developed against be specified. + framework runtime component such as `@microsoft/sp-client-base`, + it is recommended the version of the framework component the component was + developed against be specified. remarks: >- Supported values: string representing a [semantic version](http://semver.org), or "latest". diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index 3eb20db0..e81ba9ee 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -15,8 +15,8 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: shouldNotPreload summary: >- - If set to `true`<!-- -->, this module should not be preloaded when - loading the component. + If set to `true`, this module should not be preloaded when loading + the component. remarks: >- The most common case for setting this property to "true" is when a module is defined in a manifest, but is not required for the module referenced in diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index c0518b2d..76de6d2a 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: _IODataUserId summary: >- Represents an OData SP.UserId object. For more information about this object - see the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false @@ -29,7 +28,7 @@ properties: uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' package: '@microsoft/sp-odata-types!' fullName: NameIdIssuer - summary: 'Example: `":"`' + summary: 'Example: `"urn:office:idp:activedirectory"`' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index 353aaea7..3694de34 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataChangeToken summary: >- Represents an OData SP.ChangeToken object. For more information about this - object, see [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + object, see + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index b2498ee3..f95cb69f 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataContextWebInformation summary: >- Represents an OData SP.ContextWebInformation object. For more information - about this object, see [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + about this object, see + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 3a7a0f03..291d5423 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataList summary: >- Represents an OData SP.List object. For more information about this object see - the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index d01087a0..d6fc2b96 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataListItem summary: >- Represents an OData SP.ListItem object. For more information about this object - see the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 7bced7b6..285b883d 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' package: '@microsoft/sp-odata-types!' fullName: IODataNavigationNode summary: >- - Represents an OData SP.NavigationNode object. [.microsoft.com/en-us/library/office/jj246311.aspx](.microsoft.com/en-us/library/office/jj246311.aspx) + Represents an OData SP.NavigationNode object. + [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index f61d5e91..6d2a4713 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -5,9 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataNavigationNodeCollection summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. - [.microsoft.com/en-us/library/office/ee557907.aspx](.microsoft.com/en-us/library/office/ee557907.aspx) + [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index c3b4aa0f..7f39290f 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataUser summary: >- Represents an OData SP.User object. For more information about this object see - the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false @@ -55,7 +54,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' package: '@microsoft/sp-odata-types!' fullName: LoginName - summary: 'Example: `"#.w|domain\user"`' + summary: 'Example: `"i:0#.w|domain\user"`' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index ad5a9aff..91a74182 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -5,10 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataUserCustomAction summary: >- Represents an OData SP.UserCustomAction object. For more information about - this object see the MSDN documentation here: [.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) + this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 8cea1ef2..74e23628 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-odata-types!' fullName: IODataWeb summary: >- Represents an OData SP.Web object. For more information about this object see - the MSDN documentation here: [.microsoft.com/en-us/library/office/jj860569.aspx](.microsoft.com/en-us/library/office/jj860569.aspx) + the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false isDeprecated: false @@ -246,7 +245,7 @@ properties: summary: |- Gets the absolute URL for the website. - Example: `".com/sites/PubSite"` + Example: `"http://example.com/sites/PubSite"` remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 2d8928fa..465a31ae 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -46,7 +46,7 @@ properties: uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' package: '@microsoft/sp-page-context!' fullName: serverRelativeUrl - summary: Returns the server-relative URL for this `SPList`<!-- -->. + summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' isPreview: false isDeprecated: false @@ -58,7 +58,7 @@ properties: uid: '@microsoft/sp-page-context!SPList#title:member' package: '@microsoft/sp-page-context!' fullName: title - summary: Returns the title for this `SPList`<!-- -->. + summary: Returns the title for this `SPList`. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index bafc9a8e..18750b52 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -19,8 +19,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: absoluteUrl summary: >- - Returns the absolute URL for this SPWeb. Example: `".com/sites/PubSite/SubWeb"` + Returns the absolute URL for this SPWeb. Example: + `"https://example.com/sites/PubSite/SubWeb"` remarks: '' isPreview: false isDeprecated: false @@ -72,9 +72,7 @@ properties: uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' package: '@microsoft/sp-page-context!' fullName: isAppWeb - summary: >- - Returns true if this `SPWeb` the container web for an `SPApp`<!-- - -->. + summary: Returns true if this `SPWeb` the container web for an `SPApp`. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index de3a8f24..498a481a 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -41,8 +41,6 @@ interfaces: - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' -typeAliases: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' functions: - name: 'PropertyPaneButton(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index 4c3362bc..b96dbd9f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -38,9 +38,9 @@ properties: understand how to pick the value of the key. - For more information, see the [React documentation](.github.io/react/docs/lists-and-keys.html#keys)<!-- -->. + For more information, see the [React + documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index 9c48e2c3..c0d0ccce 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -122,7 +122,7 @@ properties: Callback to format the Slider value. For example, if ```typescript - (value) => `${value}%` + (value) => `${value}%` ``` is specified, the value of the Slider has % after it. diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index e961d899..527b9695 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-property-pane!' fullName: PropertyPaneDropdownOptionType summary: >- Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:))<!-- - -->. + [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 1b8ea5fd..d821ea25 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneDropdownOptionType summary: >- Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:))<!-- - -->. + [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). remarks: '' isPreview: false isDeprecated: true From b3a662bb288c737ca01247bdbdba037ef8118643 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 13:49:02 +0800 Subject: [PATCH 40/55] revert --- .openpublishing.publish.config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index f5d89b22..0c74bb8a 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -43,7 +43,7 @@ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "develop", + "branch": "master", "branch_mapping": {} } ], From da4523c4bcebf2e09df9dd47ca60e08477eda5d0 Mon Sep 17 00:00:00 2001 From: yunair Date: Fri, 6 Nov 2020 13:55:33 +0800 Subject: [PATCH 41/55] change ur to sdp --- SP-Framework/decorators.yml | 4 +- .../applicationaccessor.yml | 5 +- .../baseapplicationcustomizer.yml | 4 +- .../iplaceholdercreatecontentoptions.yml | 5 +- .../placeholderprovider.yml | 15 ++-- .../sp-component-base/dynamicdataprovider.yml | 10 +-- .../dynamicdatasourcemanager.yml | 6 +- .../sp-component-base/dynamicproperty.yml | 5 +- SP-Framework/sp-component-base/irawstyle.yml | 7 +- .../sp-component-base/ireadonlytheme.yml | 18 ++-- .../themechangedeventargs.yml | 5 +- .../sp-component-base/themeprovider.yml | 14 ++- SP-Framework/sp-core-library/guid.yml | 2 +- .../sp-core-library/randomnumbergenerator.yml | 5 +- SP-Framework/sp-core-library/servicekey.yml | 22 ++--- SP-Framework/sp-core-library/servicescope.yml | 32 +++---- SP-Framework/sp-core-library/timeprovider.yml | 4 +- SP-Framework/sp-core-library/version.yml | 2 +- SP-Framework/sp-dialog/basedialog.yml | 11 ++- SP-Framework/sp-dialog/dialog.yml | 4 +- .../sp-dialog/isecondarydialogprovider.yml | 13 +-- .../sp-dynamic-data/idynamicdatacallables.yml | 16 ++-- .../sp-dynamic-data/idynamicdatasource.yml | 31 ++++--- .../sp-extension-base/baseextension.yml | 4 +- SP-Framework/sp-http/aadhttpclient.yml | 12 ++- SP-Framework/sp-http/aadhttpclientfactory.yml | 8 +- SP-Framework/sp-http/aadtokenprovider.yml | 7 +- .../sp-http/aadtokenproviderfactory.yml | 9 +- SP-Framework/sp-http/digestcache.yml | 6 +- SP-Framework/sp-http/graphrequest.yml | 16 ++-- SP-Framework/sp-http/httpclient.yml | 16 +++- SP-Framework/sp-http/httpclientresponse.yml | 14 +-- SP-Framework/sp-http/iaadtokenprovider.yml | 7 +- SP-Framework/sp-http/idigestcache.yml | 2 +- SP-Framework/sp-http/msgraphclientfactory.yml | 8 +- SP-Framework/sp-http/odataversion.yml | 4 +- SP-Framework/sp-http/sphttpclient.yml | 16 +++- SP-Framework/sp-http/sphttpclientbatch.yml | 16 +++- SP-Framework/sp-http/sphttpclientresponse.yml | 5 +- .../listsubscriptionfactory.yml | 6 +- .../basefieldcustomizer.yml | 4 +- .../baselistviewcommandset.yml | 4 +- .../fieldcustomizercontext.yml | 4 +- ...stviewcommandsetexecuteeventparameters.yml | 5 +- ...iewcommandsetlistviewupdatedparameters.yml | 5 +- .../listitemaccessor.yml | 5 +- .../listviewaccessor.yml | 16 ++-- .../selectedrowschangedeventargs.yml | 5 +- SP-Framework/sp-loader/spcomponentloader.yml | 17 ++-- ...clientsidecomponentloaderconfiguration.yml | 8 +- .../iclientsidewebpartmanifest.yml | 9 +- .../iclientsidewebpartmanifestentry.yml | 10 +-- .../icommandsetextensionmanifest.yml | 8 +- .../icomponentmoduleconfiguration.yml | 3 +- .../ilocalizedpathmoduleconfiguration.yml | 11 ++- .../ipathmoduleconfiguration.yml | 3 +- .../sp-odata-types/iodatanavigationnode.yml | 5 +- .../iodatanavigationnodecollection.yml | 10 +-- SP-Framework/sp-page-context/pagecontext.yml | 14 ++- SP-Framework/sp-page-context/spfield.yml | 5 +- SP-Framework/sp-page-context/sppermission.yml | 10 +-- SP-Framework/sp-page-context/spsite.yml | 2 +- SP-Framework/sp-page-context/spuser.yml | 8 +- SP-Framework/sp-page-context/spweb.yml | 6 +- SP-Framework/sp-property-pane.yml | 86 ++++++++++++------- .../ipropertypanechoicegroupprops.yml | 4 +- .../ipropertypaneconfiguration.yml | 9 +- .../ipropertypanecustomfieldprops.yml | 11 ++- .../ipropertypanedropdownprops.yml | 4 +- .../ipropertypanedynamicfieldsetprops.yml | 17 ++-- .../ipropertypanedynamictextfieldprops.yml | 5 +- .../sp-property-pane/ipropertypanegroup.yml | 5 +- .../sp-property-pane/ipropertypanepage.yml | 7 +- .../ipropertypanetextfieldprops.yml | 5 +- .../ipropertypanetoggleprops.yml | 5 +- .../basesearchquerymodifier.yml | 9 +- SP-Framework/sp-webpart-base.yml | 85 ++++++++++++------ .../sp-webpart-base/baseclientsidewebpart.yml | 2 +- SP-Framework/sp-webpart-base/basewebpart.yml | 6 +- .../sp-webpart-base/basewebpartcontext.yml | 4 +- .../iclientsidewebpartstatusrenderer.yml | 5 +- ...dynamicdatasharedpropertyconfiguration.yml | 4 +- .../idynamicdatasharedpropertyfilters.yml | 4 +- .../idynamicdatasharedsourceconfiguration.yml | 4 +- .../idynamicdatasharedsourcefilters.yml | 4 +- .../sp-webpart-base/imicrosoftteams.yml | 4 +- .../ipropertypanebuttonprops.yml | 4 +- .../ipropertypanecheckboxprops.yml | 4 +- .../ipropertypanechoicegroupoption.yml | 4 +- ...propertypanechoicegroupoptioniconprops.yml | 4 +- .../ipropertypanechoicegroupprops.yml | 4 +- .../ipropertypaneconditionalgroup.yml | 4 +- .../ipropertypaneconfiguration.yml | 4 +- .../ipropertypanecustomfieldprops.yml | 4 +- .../ipropertypanedropdowncalloutprops.yml | 4 +- .../ipropertypanedropdownoption.yml | 4 +- .../ipropertypanedropdownprops.yml | 4 +- .../ipropertypanedynamicfieldfilters.yml | 4 +- .../ipropertypanedynamicfieldprops.yml | 4 +- .../ipropertypanedynamicfieldsetprops.yml | 4 +- .../ipropertypanedynamictextfieldprops.yml | 4 +- .../sp-webpart-base/ipropertypanefield.yml | 5 +- .../sp-webpart-base/ipropertypanegroup.yml | 4 +- .../ipropertypanelabelprops.yml | 4 +- .../ipropertypanelinkprops.yml | 4 +- .../sp-webpart-base/ipropertypanepage.yml | 4 +- .../ipropertypanepageheader.yml | 4 +- .../ipropertypanesliderprops.yml | 4 +- .../ipropertypanetextfieldprops.yml | 4 +- .../ipropertypanetoggleprops.yml | 4 +- .../sp-webpart-base/iwebpartcontext.yml | 3 +- 111 files changed, 494 insertions(+), 468 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 115d7c8c..74219049 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -31,7 +31,7 @@ functions: type: string | symbol - id: descriptor description: '' - type: '' + type: '<any>' return: type: void description: '' @@ -81,7 +81,7 @@ functions: type: string | symbol - id: descriptor description: '' - type: '' + type: '<any>' return: type: void description: '' diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index a4719f05..ce00cac9 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -62,6 +62,5 @@ properties: content: 'readonly navigatedEvent: SPEvent;' return: type: >- - + <> diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index 1d0337f9..cc01eb91 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -71,5 +71,5 @@ methods: type: void description: '' extends: >- - + <TProperties> diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index ccdcb031..a487b9a1 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -31,6 +31,5 @@ properties: content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' return: type: >- - + (placeholderContent: ) => void diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 1954ad21..3193fe1a 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -49,9 +49,8 @@ properties: content: 'readonly changedEvent: SPEvent;' return: type: >- - + <> - name: isDisposed uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' package: '@microsoft/sp-application-base!' @@ -76,9 +75,8 @@ properties: content: 'readonly placeholderNames: ReadonlyArray;' return: type: >- - + <> methods: - name: dispose() uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' @@ -127,9 +125,8 @@ methods: /> return: type: >- - + | + undefined description: >- A new PlaceholderContent object, or undefined if the requested placeholder does not exist. diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index bb9b013a..f6501ed9 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -50,9 +50,8 @@ methods: content: 'getAvailableSources(): ReadonlyArray;' return: type: >- - + <> description: Read-only array with all available sources. - name: registerAvailableSourcesChanged(callback) uid: >- @@ -143,9 +142,8 @@ methods: type: string return: type: >- - + + | undefined description: '' - name: unregisterAvailableSourcesChanged(callback) uid: >- diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 7cc9e1e4..9cf1a85b 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -133,9 +133,9 @@ methods: - id: metadata description: Partial of the metadata. type: >- - + <> return: type: void description: '' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 670c43d6..36840116 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -178,9 +178,8 @@ methods: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: type: >- - + + | undefined description: '' - name: tryGetValue() uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' diff --git a/SP-Framework/sp-component-base/irawstyle.yml b/SP-Framework/sp-component-base/irawstyle.yml index 7321ed28..3f5b0698 100644 --- a/SP-Framework/sp-component-base/irawstyle.yml +++ b/SP-Framework/sp-component-base/irawstyle.yml @@ -37,7 +37,8 @@ properties: [key: string]: IStyle; }; return: - type: >- - + type: |- + { + [key: string]: ; + } extends: '' diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 0f80e74f..77aae7af 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -21,8 +21,9 @@ properties: content: 'readonly fonts: Readonly;' return: type: >- - + <> - name: palette uid: '@microsoft/sp-component-base!IReadonlyTheme#palette:member' package: '@microsoft/sp-component-base!' @@ -35,8 +36,8 @@ properties: content: 'readonly palette: Readonly;' return: type: >- - + <> - name: semanticColors uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' package: '@microsoft/sp-component-base!' @@ -49,7 +50,8 @@ properties: content: 'readonly semanticColors: Readonly;' return: type: >- - -extends: '' + <> +extends: >- + <> diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index b5039f58..7bdf6288 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -21,7 +21,6 @@ properties: content: 'readonly theme: ITheme | undefined;' return: type: >- - + | + undefined extends: '' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index 28077112..c03d1b08 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -42,8 +42,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-component-base!ThemeProvider. + <> - name: themeChangedEvent uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' package: '@microsoft/sp-component-base!' @@ -56,9 +56,8 @@ properties: content: 'readonly themeChangedEvent: SPEvent;' return: type: >- - + <> methods: - name: tryGetTheme() uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' @@ -72,7 +71,6 @@ methods: content: 'tryGetTheme(): IReadonlyTheme | undefined;' return: type: >- - + | + undefined description: '' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index f818e67b..5c3489a1 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -162,5 +162,5 @@ methods: description: The input string. type: string | undefined | null return: - type: '@microsoft/sp-core-library!Guid.' + type: ' | undefined' description: 'The Guid object, or undefined if the string could not be parsed.' diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index c9860ae2..1c590f97 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -39,8 +39,9 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-core-library!RandomNumberGenerator. + <> methods: - name: generate() uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 4840e043..c42f204e 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -28,10 +28,7 @@ properties: syntax: content: 'readonly defaultCreator: ServiceCreator;' return: - type: >- - + type: '<T>' - name: id uid: '@microsoft/sp-core-library!ServiceKey#id:member' package: '@microsoft/sp-core-library!' @@ -106,11 +103,12 @@ methods: type: string - id: serviceClass description: the TypeScript class that implements the service. - type: >- - @microsoft/sp-core-library!ServiceKey. + type: |- + { + new (serviceScope: ): TKey; + } return: - type: '@microsoft/sp-core-library!ServiceKey.' + type: '<TKey>' description: the newly created ServiceKey - name: 'createCustom(name, defaultCreator)' uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' @@ -135,10 +133,8 @@ methods: - id: defaultCreator description: a callback that returns an object that implements the T interface type: >- - @microsoft/sp-core-library!ServiceKey. + <TKey> return: - type: >- - @microsoft/sp-core-library!ServiceKey. + type: '<TKey>' description: the newly created service key diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 40f71485..2dda5b6e 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -78,7 +78,7 @@ constructors: parameters: - id: parent description: '' - type: '' + type: ' | undefined' methods: - name: consume(serviceKey) uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' @@ -99,9 +99,7 @@ methods: description: >- the key that was used when provide() was called to register the service - type: >- - + type: '<T>' return: type: T description: the service instance @@ -124,16 +122,13 @@ methods: parameters: - id: serviceKey description: the key that can be used later to consume the service - type: >- - + type: '<T>' - id: simpleServiceClass description: the TypeScript class to be constructed - type: >- - + type: |- + { + new (serviceScope: ): T; + } return: type: T description: a newly constructed instance of simpleServiceClass @@ -153,10 +148,7 @@ methods: parameters: - id: serviceKey description: the key that can be used later to consume the service - type: >- - + type: '<T>' return: type: T description: >- @@ -200,9 +192,7 @@ methods: syntax: content: 'getParent(): ServiceScope | undefined;' return: - type: >- - + type: ' | undefined' description: the parent service scope - name: 'provide(serviceKey, service)' uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' @@ -221,9 +211,7 @@ methods: parameters: - id: serviceKey description: the key that will later be used to consume the service - type: >- - + type: '<T>' - id: service description: the service instance that is being registered type: T diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 12d37083..28ec03eb 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -39,8 +39,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-core-library!TimeProvider. + <> methods: - name: getDate() uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index d0e288dd..aea69aab 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -294,5 +294,5 @@ methods: description: A version string type: string | undefined | null return: - type: '@microsoft/sp-core-library!Version.' + type: ' | undefined' description: 'The Version object, or undefined if the string could not be parsed.' diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 4ed0caff..7a18c2c0 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -146,9 +146,8 @@ properties: content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' return: type: >- - + + | undefined methods: - name: close() uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' @@ -164,7 +163,7 @@ methods: syntax: content: 'close(): Promise;' return: - type: '' + type: '<void>' description: >- A promise that resolves when the dialog is visually closed, or if it was already closed @@ -206,7 +205,7 @@ methods: syntax: content: 'protected onBeforeOpen(): Promise;' return: - type: '' + type: '<void>' description: >- A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be @@ -257,7 +256,7 @@ methods: for more information. type: '' return: - type: '' + type: '<void>' description: >- A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the request is rejected or diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 2bacd43a..a3b4ac23 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -34,7 +34,7 @@ methods: description: '' type: '' return: - type: '@microsoft/sp-dialog!Dialog.' + type: '<void>' description: '' - name: 'prompt(message, options)' uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' @@ -63,5 +63,5 @@ methods: description: '' type: '' return: - type: '@microsoft/sp-dialog!Dialog.' + type: '<string | undefined>' description: The input string or undefined if the dialog was canceled diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index df72f785..76e0ab4a 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -46,9 +46,7 @@ methods: for more information. type: '' return: - type: >- - + type: '<void>' description: '' - name: 'prompt(message, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' @@ -75,10 +73,7 @@ methods: for more information. type: '' return: - type: >- - + type: '<string>' description: '' - name: 'show(dialog, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' @@ -106,7 +101,5 @@ methods: for more information. type: '' return: - type: >- - + type: '<void>' description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 39abd499..4d03e077 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -33,9 +33,9 @@ methods: content: 'allowedEvents?(): ReadonlyArray;' return: type: >- - + <> description: '' - name: getAnnotatedPropertyValue(propertyId) uid: >- @@ -61,8 +61,8 @@ methods: return: type: >- + uid="@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" + /> | undefined description: '' - name: getPropertyDefinitions() uid: >- @@ -77,9 +77,9 @@ methods: content: 'getPropertyDefinitions(): ReadonlyArray;' return: type: >- - + <> description: '' - name: getPropertyValue(propertyId) uid: >- diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 3a72855e..0b60abcd 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -59,9 +59,10 @@ methods: Promise>; return: type: >- - + <<>> description: '' - name: getAnnotatedPropertyValue(propertyId) uid: >- @@ -114,9 +115,9 @@ methods: type: string return: type: >- - + <> description: '' - name: getPropertyDefinitions() uid: >- @@ -136,9 +137,9 @@ methods: content: 'getPropertyDefinitions(): ReadonlyArray;' return: type: >- - + <> description: '' - name: getPropertyDefinitionsAsync() uid: >- @@ -157,9 +158,10 @@ methods: Promise>; return: type: >- - + <<>> description: '' - name: getPropertyValue(propertyId) uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' @@ -201,10 +203,7 @@ methods: description: Property id for which the value is requested. type: string return: - type: >- - + type: '<any>' description: '' - name: 'sendEvent(eventName, data)' uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index f8e5dc82..ee574133 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -64,8 +64,6 @@ methods: syntax: content: 'protected onInit(): Promise;' return: - type: >- - + type: '<void>' description: '' extends: '' diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 6775ab0e..468e3118 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -87,7 +87,9 @@ methods: description: Additional options that affect the request. type: '' return: - type: '' + type: >- + <> description: A promise that will return the result. - name: 'get(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' @@ -114,7 +116,9 @@ methods: description: Additional options that affect the request. type: '' return: - type: '' + type: >- + <> description: A promise that will return the result. - name: 'post(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' @@ -141,5 +145,7 @@ methods: description: Additional options that affect the request. type: '' return: - type: '' + type: >- + <> description: A promise that will return the result. diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 7cb75904..dbde757e 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -27,8 +27,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-http!AadHttpClientFactory. + <> methods: - name: getClient(resourceEndpoint) uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' @@ -48,6 +48,6 @@ methods: type: string return: type: >- - + <> description: '' diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index f744aa3a..97f39605 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -32,9 +32,8 @@ properties: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: type: >- - + <> methods: - name: 'getToken(resourceEndpoint, useCachedToken)' uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' @@ -65,7 +64,7 @@ methods: https://graph.microsoft.com type: boolean return: - type: '' + type: '<string>' description: >- A promise that will be fullfiled with the token or that will reject with an error message diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 379ade6b..f351e8ed 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -21,8 +21,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-http!AadTokenProviderFactory. + <> methods: - name: getTokenProvider() uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' @@ -38,7 +38,6 @@ methods: content: 'getTokenProvider(): Promise;' return: type: >- - + <> description: '' diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 4a7a1495..239f3fe8 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -46,7 +46,9 @@ properties: syntax: content: 'static readonly serviceKey: ServiceKey;' return: - type: '@microsoft/sp-http!DigestCache.' + type: >- + <> methods: - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' @@ -143,5 +145,5 @@ methods: be a server-relative or absolute URL. type: string return: - type: '' + type: '<string>' description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 836166b1..e42c3329 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -139,7 +139,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: del(callback) uid: '@microsoft/sp-http!GraphRequest#del:member(1)' @@ -159,7 +159,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: delete(callback) uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' @@ -179,7 +179,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: expand(properties) uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' @@ -233,7 +233,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: getStream(callback) uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' @@ -353,7 +353,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: 'post(content, callback)' uid: '@microsoft/sp-http!GraphRequest#post:member(1)' @@ -376,7 +376,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: 'put(content, callback)' uid: '@microsoft/sp-http!GraphRequest#put:member(1)' @@ -399,7 +399,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: 'putStream(stream, callback)' uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' @@ -553,7 +553,7 @@ methods: uid="@microsoft/microsoft-graph-client!GraphRequestCallback:interface" /> return: - type: '' + type: '<any>' description: '' - name: version(v) uid: '@microsoft/sp-http!GraphRequest#version:member(1)' diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 38a8bc84..0e78cf13 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -53,7 +53,9 @@ properties: syntax: content: 'static readonly serviceKey: ServiceKey;' return: - type: '@microsoft/sp-http!HttpClient.' + type: >- + <> methods: - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' @@ -84,7 +86,9 @@ methods: description: additional options that affect the request type: '' return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -117,7 +121,9 @@ methods: description: additional options that affect the request type: '' return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -150,7 +156,9 @@ methods: description: additional options that affect the request type: '' return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 79f4be34..bdf2989a 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -141,8 +141,8 @@ methods: content: 'arrayBuffer(): Promise;' return: type: >- - + <> description: '' - name: blob() uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' @@ -157,7 +157,7 @@ methods: syntax: content: 'blob(): Promise;' return: - type: '' + type: '<>' description: '' - name: clone() uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' @@ -188,8 +188,8 @@ methods: content: 'formData(): Promise;' return: type: >- - + <> description: '' - name: json() uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' @@ -204,7 +204,7 @@ methods: syntax: content: 'json(): Promise;' return: - type: '' + type: '<any>' description: '' - name: text() uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' @@ -219,5 +219,5 @@ methods: syntax: content: 'text(): Promise;' return: - type: '' + type: '<string>' description: '' diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index d1f0fcbd..91c1d4a7 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -30,9 +30,8 @@ properties: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: type: >- - + <> methods: - name: 'getToken(resourceEndpoint, useCachedToken)' uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' @@ -63,7 +62,7 @@ methods: description: Allows the developer to specify if cached tokens should be returned. type: boolean return: - type: '' + type: '<string>' description: >- A promise that will be fullfiled with the token or that will reject with an error message diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index b2b466a4..9503e6ac 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -115,5 +115,5 @@ methods: be a server-relative or absolute URL. type: string return: - type: '' + type: '<string>' description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index e461febc..554abc94 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -26,8 +26,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-http!MSGraphClientFactory. + <> methods: - name: getClient() uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' @@ -43,6 +43,6 @@ methods: content: 'getClient(): Promise;' return: type: >- - + <> description: '' diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 8a74a359..4c76f1f3 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -67,7 +67,5 @@ methods: description: '' type: '' return: - type: >- - @microsoft/sp-http!ODataVersion. + type: ' | undefined' description: '' diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 6d58a7ca..c7103ed3 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -59,7 +59,9 @@ properties: syntax: content: 'static readonly serviceKey: ServiceKey;' return: - type: '@microsoft/sp-http!SPHttpClient.' + type: >- + <> methods: - name: beginBatch(batchCreationOptions) uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' @@ -141,7 +143,9 @@ methods: description: additional options that affect the request type: '' return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -174,7 +178,9 @@ methods: description: additional options that affect the request type: '' return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -238,7 +244,9 @@ methods: description: additional options that affect the request type: '' return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 0954d9d8..003f2ccf 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -52,7 +52,9 @@ methods: syntax: content: 'execute(): Promise;' return: - type: '' + type: >- + <> description: '' - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' @@ -101,7 +103,9 @@ methods: return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -137,7 +141,9 @@ methods: return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with @@ -173,7 +179,9 @@ methods: return: - type: '' + type: >- + <> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index c268bd23..a4ec1af3 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -44,10 +44,7 @@ properties: syntax: content: 'readonly correlationId: Guid | undefined;' return: - type: >- - + type: ' | undefined' methods: - name: clone() uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index 0db93cca..d1b718eb 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -48,9 +48,9 @@ methods: /> return: type: >- - + <> description: Promise of the subscription to the list. - name: deleteSubscription(subscription) uid: >- diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 965c7c20..e98e0ce5 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -79,5 +79,5 @@ methods: type: void description: '' extends: >- - + <TProperties> diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index a5617e19..68e05842 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -108,5 +108,5 @@ methods: type: '' description: '' extends: >- - + <TProperties> diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 19cbac9e..3372d581 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -48,7 +48,7 @@ methods: return: type: >- + uid="@microsoft/sp-listview-extensibility!~ListViewAccessor:class" /> + | undefined description: 'the SharePoint list view, or undefined if there is none.' extends: '' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index 356b8471..220bdef3 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -40,6 +40,5 @@ properties: content: 'readonly selectedRows: ReadonlyArray;' return: type: >- - + <> diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 3236b9fe..6864da23 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -25,6 +25,5 @@ properties: content: 'readonly selectedRows: ReadonlyArray;' return: type: >- - + <> diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 2e408246..5525c130 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -43,9 +43,8 @@ properties: content: 'abstract readonly fields: ReadonlyArray;' return: type: >- - + <> methods: - name: getValue(field) uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 5a3057a3..b7fb0be6 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -24,9 +24,8 @@ properties: content: 'abstract readonly columns: ReadonlyArray;' return: type: >- - + <> - name: selectedRowsChangedEvent uid: >- @microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member @@ -44,9 +43,9 @@ properties: SPEvent; return: type: >- - + <> methods: - name: tryGetColumnByName(internalName) uid: >- @@ -69,7 +68,6 @@ methods: type: string return: type: >- - + | undefined description: '' diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 2da098b6..61cf92e3 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -24,7 +24,6 @@ properties: content: 'selectedRows: ReadonlyArray;' return: type: >- - + <> extends: '' diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index 9d08da1a..2afb6e19 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -23,8 +23,9 @@ methods: content: 'static getManifests(): IClientSideComponentManifest[];' return: type: >- - @microsoft/sp-loader!SPComponentLoader. + [] description: '' - name: loadComponent(manifest) uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' @@ -46,9 +47,7 @@ methods: uid="@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" /> return: - type: >- - @microsoft/sp-loader!SPComponentLoader. + type: '<TComponent>' description: A promise containing the loaded module. - name: 'loadComponentById(id, version)' uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' @@ -72,9 +71,7 @@ methods: method will load any version of the component. type: string return: - type: >- - @microsoft/sp-loader!SPComponentLoader. + type: '<TComponent>' description: A promise containing the loaded module. - name: loadCss(url) uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' @@ -119,7 +116,5 @@ methods: global member on the page, specify the global member's name. type: '' return: - type: >- - @microsoft/sp-loader!SPComponentLoader. + type: '<TModule>' description: A promise containing the loaded module. diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 149ca579..1be1f6a4 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -176,7 +176,7 @@ properties: [name: string]: IModuleConfiguration; }; return: - type: >- - + type: |- + { + [name: string]: ; + } diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index e053514b..3e32c1d1 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -138,8 +138,8 @@ properties: return: type: >- + uid="@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface" + /><TProperties>[] - name: supportedHosts uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member @@ -161,9 +161,8 @@ properties: 'TeamsTab' | 'TeamsPersonalApp'>; return: type: >- - + <'SharePointFullPage' | + 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> - name: supportsFullBleed uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index a7e98137..55042f7a 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -129,9 +129,8 @@ properties: content: 'groupId: PredefinedGroup | string;' return: type: >- - + | + string - name: iconImageUrl uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member @@ -237,9 +236,8 @@ properties: content: 'tags?: ILocalizedString[];' return: type: >- - + [] - name: title uid: >- @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index d90d8890..2a87dcb1 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -45,10 +45,10 @@ properties: [itemId: string]: ICommandDefinition; }; return: - type: >- - + type: |- + { + [itemId: string]: ; + } extends: >- - - - name: id uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 2dbe0885..26441fdd 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -41,8 +41,7 @@ properties: content: 'defaultPath: string | IPath;' return: type: >- - - name: paths uid: >- @@ -91,8 +90,8 @@ properties: [locale: string]: string | IPath; }; return: - type: >- - + type: |- + { + [locale: string]: string | ; + } extends: '' diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 92b97282..e265d506 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -105,7 +105,6 @@ properties: content: 'path: string | IPath;' return: type: >- - extends: '' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 285b883d..4b514423 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -25,9 +25,8 @@ properties: content: 'Children?: IODataNavigationNode[];' return: type: >- - + [] - name: Id uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' package: '@microsoft/sp-odata-types!' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 6d2a4713..e4149491 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -26,9 +26,8 @@ properties: content: 'quickLaunch: IODataNavigationNode[];' return: type: >- - + [] - name: topNav uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' package: '@microsoft/sp-odata-types!' @@ -43,6 +42,5 @@ properties: content: 'topNav: IODataNavigationNode[];' return: type: >- - + [] diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 8d17d506..1b498b96 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -43,9 +43,7 @@ properties: syntax: content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' return: - type: >- - + type: ' | undefined' - name: cultureInfo uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' package: '@microsoft/sp-page-context!' @@ -113,7 +111,7 @@ properties: syntax: content: 'readonly list: SPList | undefined;' return: - type: '' + type: ' | undefined' - name: listItem uid: '@microsoft/sp-page-context!PageContext#listItem:member' package: '@microsoft/sp-page-context!' @@ -128,9 +126,7 @@ properties: syntax: content: 'readonly listItem: SPListItem | undefined;' return: - type: >- - + type: ' | undefined' - name: serviceKey uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' package: '@microsoft/sp-page-context!' @@ -143,8 +139,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - @microsoft/sp-page-context!PageContext. + <> - name: site uid: '@microsoft/sp-page-context!PageContext#site:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 63d7a401..d5fc88e5 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -29,10 +29,7 @@ properties: syntax: content: 'readonly clientSideComponentId: Guid | undefined;' return: - type: >- - + type: ' | undefined' - name: clientSideComponentProperties uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 21a2964a..a1271d4f 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -539,10 +539,7 @@ methods: description: >- Any number of SPPermission objects to be compared against the original - type: >- - + type: '[]' return: type: boolean description: '' @@ -563,10 +560,7 @@ methods: description: >- Any number of SPPermission objects to be compared against the original - type: >- - + type: '[]' return: type: boolean description: '' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index 82606492..bf446de2 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -79,7 +79,7 @@ properties: syntax: content: 'readonly group: O365GroupAssociation | undefined;' return: - type: '' + type: ' | undefined' - name: id uid: '@microsoft/sp-page-context!SPSite#id:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index eaed5430..ee772fc9 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -51,9 +51,7 @@ properties: syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: >- - + type: ' | undefined' - name: isAnonymousGuestUser uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' package: '@microsoft/sp-page-context!' @@ -119,6 +117,4 @@ properties: syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: >- - + type: ' | undefined' diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 18750b52..a9160e38 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -53,9 +53,7 @@ properties: syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: >- - + type: ' | undefined' - name: id uid: '@microsoft/sp-page-context!SPWeb#id:member' package: '@microsoft/sp-page-context!' @@ -173,7 +171,7 @@ properties: syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: '' + type: ' | undefined' - name: title uid: '@microsoft/sp-page-context!SPWeb#title:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 498a481a..4246da6b 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -66,8 +66,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneCheckbox(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' @@ -93,8 +95,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' @@ -120,8 +124,10 @@ functions: /> return: type: >- - + <> description: '' - name: PropertyPaneCustomField(properties) uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' @@ -149,8 +155,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneDropdown(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' @@ -176,8 +184,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneDynamicField(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' @@ -205,9 +215,10 @@ functions: /> return: type: >- - + <> description: '' - name: PropertyPaneDynamicFieldSet(properties) uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' @@ -241,9 +252,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' @@ -270,9 +282,10 @@ functions: /> return: type: >- - + <> description: '' - name: PropertyPaneHorizontalRule() uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' @@ -287,9 +300,8 @@ functions: IPropertyPaneField; return: type: >- - + <void> description: '' - name: 'PropertyPaneLabel(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' @@ -314,7 +326,11 @@ functions: uid="@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface" /> return: - type: '' + type: >- + <> description: '' - name: 'PropertyPaneLink(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' @@ -339,7 +355,11 @@ functions: uid="@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface" /> return: - type: '' + type: >- + <> description: '' - name: 'PropertyPaneSlider(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' @@ -365,8 +385,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneTextField(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' @@ -392,8 +414,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneToggle(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' @@ -419,6 +443,8 @@ functions: /> return: type: >- - + <> description: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 41c69c68..baf76147 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -34,5 +34,5 @@ properties: return: type: >- + uid="@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface" + />[] diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 5ad3e6b2..4e9ecde6 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -40,8 +40,8 @@ properties: return: type: >- + uid="@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface" + />[] - name: loadingIndicatorDelayTime uid: >- @microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member @@ -69,9 +69,8 @@ properties: content: 'pages: IPropertyPanePage[];' return: type: >- - + [] - name: showLoadingIndicator uid: >- @microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index b96dbd9f..f227d391 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -60,9 +60,8 @@ properties: content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' return: type: >- - + (domElement: , context?: any) + => void - name: onRender uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' package: '@microsoft/sp-property-pane!' @@ -79,6 +78,6 @@ properties: (targetProperty?: string, newValue?: any) => void) => void; return: type: >- - + (domElement: , context?: any, + changeCallback?: (targetProperty?: string, newValue?: any) => void) + => void diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index aef81332..7d76d497 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -114,8 +114,8 @@ properties: return: type: >- + uid="@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface" + />[] - name: selectedKey uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index ce6ec814..ed7861c2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -24,9 +24,10 @@ properties: content: 'fields: IPropertyPaneField[];' return: type: >- - + <>[] - name: label uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' package: '@microsoft/sp-property-pane!' @@ -56,7 +57,9 @@ properties: property?: IDynamicDataSharedPropertyConfiguration; }; return: - type: >- - + type: |- + { + depth: ; + source?: ; + property?: ; + } diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 96035316..f98c6367 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -113,9 +113,8 @@ properties: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: type: >- - + (value: string) => string | <string> - name: placeholder uid: >- @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 267d772f..f3619ea3 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -21,9 +21,8 @@ properties: content: 'groupFields: IPropertyPaneField[];' return: type: >- - + <any>[] - name: groupName uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 5c1c036a..156b2ad0 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -36,9 +36,10 @@ properties: content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' return: type: >- - + ( | )[] - name: header uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index 36cd2fe8..e064cb2b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -193,9 +193,8 @@ properties: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: type: >- - + (value: string) => string | <string> - name: placeholder uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index 52d9fcb5..b96a529e 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -56,10 +56,7 @@ properties: syntax: content: 'label: string | JSX.Element;' return: - type: >- - + type: 'string | @types/react!~__global.JSX.' - name: offAriaLabel uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 9001c166..772d8a15 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -78,10 +78,9 @@ methods: uid="@microsoft/sp-search-extensibility!SearchQueryScenario:enum" /> return: type: >- - + <> description: Modified query. extends: >- - + <TProperties> diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 6d6a4dc1..9f6786b2 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -81,7 +81,11 @@ functions: uid="@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface" /> return: - type: '' + type: >- + <> description: '' - name: 'PropertyPaneCheckbox(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' @@ -110,8 +114,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' @@ -140,8 +146,10 @@ functions: /> return: type: >- - + <> description: '' - name: PropertyPaneCustomField(properties) uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' @@ -172,8 +180,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneDropdown(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' @@ -202,8 +212,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneDynamicField(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' @@ -234,8 +246,10 @@ functions: /> return: type: >- - + <> description: '' - name: PropertyPaneDynamicFieldSet(properties) uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' @@ -272,9 +286,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' @@ -303,9 +318,10 @@ functions: /> return: type: >- - + <> description: '' - name: PropertyPaneHorizontalRule() uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' @@ -323,9 +339,8 @@ functions: IPropertyPaneField; return: type: >- - + <void> description: '' - name: 'PropertyPaneLabel(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' @@ -353,7 +368,11 @@ functions: uid="@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface" /> return: - type: '' + type: >- + <> description: '' - name: 'PropertyPaneLink(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' @@ -380,7 +399,11 @@ functions: return: - type: '' + type: >- + <> description: '' - name: 'PropertyPaneSlider(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' @@ -408,7 +431,11 @@ functions: uid="@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface" /> return: - type: '' + type: >- + <> description: '' - name: 'PropertyPaneTextField(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' @@ -437,8 +464,10 @@ functions: /> return: type: >- - + <> description: '' - name: 'PropertyPaneToggle(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' @@ -466,5 +495,9 @@ functions: uid="@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface" /> return: - type: '' + type: >- + <> description: '' diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 03221585..08659849 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -269,4 +269,4 @@ methods: return: type: void description: '' -extends: '' +extends: '<TProperties> ' diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 8b8b3a39..4bb0ba5d 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -177,8 +177,8 @@ properties: return: type: >- + uid="@microsoft/sp-webpart-base!~IWebPartPropertiesMetadata:interface" + /> | undefined - name: title uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' package: '@microsoft/sp-webpart-base!' @@ -362,7 +362,7 @@ methods: syntax: content: 'protected onInit(): Promise;' return: - type: '' + type: '<void>' description: '' - name: onPropertyPaneConfigurationComplete() uid: >- diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index e6e2c502..213d8d9a 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -45,8 +45,8 @@ properties: return: type: >- + uid="@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface" + /><any> - name: propertyPane uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 09a516cc..d27ff68d 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -90,10 +90,7 @@ methods: type: '' - id: error description: the error message. - type: >- - + type: ' | string' return: type: void description: '' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index 57dc3154..2c2c9e73 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -12,6 +12,6 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index 9201036a..d83c8bb9 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -12,6 +12,6 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 7053a543..3121d67a 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -12,6 +12,6 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index b99f3ad7..34c2b338 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index d9dd3921..1b35a99a 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -24,9 +24,7 @@ properties: syntax: content: 'context: microsoftTeams.Context;' return: - type: >- - + type: 'microsoftTeams.' - name: teamsJs uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index a4d3e109..c7737bd3 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index b138991b..4b48fc78 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index d2630d48..2f97c928 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 07e02702..e02abad2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -12,6 +12,6 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index aacc1648..5bddbc95 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 3648170a..7c3ab8d2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 1c85ccdf..fd7e3324 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index ccfbc995..b88ab675 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 44cdd169..8544ffe2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -12,6 +12,6 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index dd9ec41c..87661f2b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 49329048..6146c446 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index a44c59bd..131e3702 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -14,5 +14,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 2a36b8c5..c1219575 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index f6d107ba..49bc6720 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -12,6 +12,6 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 949af5f4..f301bfcc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -10,6 +10,6 @@ isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' type: interface extends: >- - diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 4eae167c..fc714e54 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -11,4 +11,7 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane.<TProperties> diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index bf2955dc..d8b8655a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index 9c0cf506..2e71886e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 25eab8db..c82cbd36 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index e4a4f806..c1d86064 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index 9c39d8c8..e742b2d7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index 0d93a267..e84e4b5f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 050c6dae..79b26510 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -12,5 +12,5 @@ customDeprecatedMessage: >- `@microsoft/sp-property-pane`. Please consume it from there. type: interface extends: >- - + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 71ba55e7..0a4eb471 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -11,4 +11,6 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: >- + SPPropertyPane. diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index ba694224..b2c08138 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -67,7 +67,8 @@ properties: return: type: >- + uid="@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface" + /><any> - name: pageContext uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' package: '@microsoft/sp-webpart-base!' From ef3da008029cdd24efd6a00d884bb9a67e9e1709 Mon Sep 17 00:00:00 2001 From: v-pegao Date: Fri, 11 Dec 2020 16:36:29 +0800 Subject: [PATCH 42/55] add versions for docfx v3 migration --- SP-Framework/docfx.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/SP-Framework/docfx.json b/SP-Framework/docfx.json index c6a67693..a9373dc8 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -33,6 +33,11 @@ "dest": "api" } ], + "versions": { + "sp-typescript-latest": { + "dest": "sp-typescript-latest" + } + }, "overwrite": [], "externalReference": [], "globalMetadata": { From e61e7dbe3b20712c70949f0547ef3fabd2f825bf Mon Sep 17 00:00:00 2001 From: v-pegao Date: Fri, 11 Dec 2020 17:20:50 +0800 Subject: [PATCH 43/55] change TopLevelTOC to ReferenceToc --- .openpublishing.publish.config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 0c74bb8a..36e99366 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -31,7 +31,7 @@ ], "JoinTOCPlugin": [ { - "TopLevelTOC": "SP-Framework/spfx-toc/toc.yml", + "ReferenceTOC": "SP-Framework/spfx-toc/toc.yml", "ConceptualTOCUrl": "/sharepoint/dev/toc.json" } ], @@ -65,4 +65,4 @@ ], "branch_target_mapping": {}, "need_generate_pdf_url_template": false -} \ No newline at end of file +} From 416314b64b001964de7c431b1a04001a897a7f93 Mon Sep 17 00:00:00 2001 From: Xiangwei Cai Date: Mon, 14 Dec 2020 16:23:12 +0800 Subject: [PATCH 44/55] Update config to enable docfx v3 (#24) Update config to enable docfx v3 --- .openpublishing.publish.config.json | 135 ++++++++++++++-------------- 1 file changed, 69 insertions(+), 66 deletions(-) diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 36e99366..d2f551fa 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -1,68 +1,71 @@ { - "need_generate_pdf": false, - "need_generate_intellisense": false, - "docsets_to_publish": [ - { - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/CommonPlugins/tools/JoinTOC.ps1" - ] - }, - "docset_name": "SP-Framework", - "build_source_folder": "SP-Framework", - "build_output_subfolder": "SP-Framework", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "TSType": "Content", - "TSPackage": "Content", - "TSEnum": "Content", - "TSTypeAlias": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "customized_template_paths": [ - "_dependentPackages/uref/content" - ] - } - ], - "JoinTOCPlugin": [ - { - "ReferenceTOC": "SP-Framework/spfx-toc/toc.yml", - "ConceptualTOCUrl": "/sharepoint/dev/toc.json" - } - ], - "notification_subscribers": [], - "branches_to_filter": [], - "skip_source_output_uploading": false, - "need_preview_pull_request": false, - "dependent_repositories": [ - { - "path_to_root": "_themes", - "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "master", - "branch_mapping": {} - } - ], - "dependent_packages": [ - { - "id": "opbuild.templates.uref", - "nuget_feed": "https://www.myget.org/F/op/api/v2", - "path_to_root": "_dependentPackages/uref", - "target_framework": "net45", - "version": "latest" - }, - { - "path_to_root": "_dependentPackages/CommonPlugins", - "target_framework": "net45", - "version": "latest", - "id": "Microsoft.OpenPublishing.CommonPlugins", - "nuget_feed": "https://www.myget.org/F/op/api/v2" - } - ], - "branch_target_mapping": {}, - "need_generate_pdf_url_template": false + "need_generate_pdf": false, + "need_generate_intellisense": false, + "docsets_to_publish": [ + { + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/CommonPlugins/tools/JoinTOC.ps1" + ] + }, + "docset_name": "SP-Framework", + "build_source_folder": "SP-Framework", + "build_output_subfolder": "SP-Framework", + "locale": "en-us", + "monikers": [], + "moniker_ranges": [], + "open_to_public_contributors": true, + "type_mapping": { + "Conceptual": "Content", + "TSType": "Content", + "TSPackage": "Content", + "TSEnum": "Content", + "TSTypeAlias": "Content" + }, + "build_entry_point": "docs", + "template_folder": "_themes", + "customized_template_paths": [ + "_dependentPackages/uref/content" + ] + } + ], + "JoinTOCPlugin": [ + { + "ReferenceTOC": "SP-Framework/spfx-toc/toc.yml", + "ConceptualTOCUrl": "/sharepoint/dev/toc.json" + } + ], + "notification_subscribers": [], + "branches_to_filter": [], + "skip_source_output_uploading": false, + "need_preview_pull_request": false, + "dependent_repositories": [ + { + "path_to_root": "_themes", + "url": "https://github.com/Microsoft/templates.docs.msft", + "branch": "master", + "branch_mapping": {} + } + ], + "dependent_packages": [ + { + "id": "opbuild.templates.uref", + "nuget_feed": "https://www.myget.org/F/op/api/v2", + "path_to_root": "_dependentPackages/uref", + "target_framework": "net45", + "version": "latest" + }, + { + "path_to_root": "_dependentPackages/CommonPlugins", + "target_framework": "net45", + "version": "latest", + "id": "Microsoft.OpenPublishing.CommonPlugins", + "nuget_feed": "https://www.myget.org/F/op/api/v2" + } + ], + "branch_target_mapping": {}, + "need_generate_pdf_url_template": false, + "docs_build_engine": { + "name": "docfx_v3" + } } From ccc18fdb0256bd97be697a9d81b1a2e357af7f1a Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Wed, 10 Nov 2021 20:31:59 +0200 Subject: [PATCH 45/55] Updating API docs to 1.13 level --- .vscode/settings.json | 8 + SP-Framework/decorators.yml | 54 +- .../office-ui-fabric-react-bundle.yml | 18 + .../sp-adaptive-card-extension-base.yml | 50 ++ .../adaptivecardextensioncontext.yml | 50 ++ .../baseadaptivecardextension.yml | 522 ++++++++++++++++++ .../baseadaptivecardview.yml | 70 +++ .../basebasiccardview.yml | 32 ++ .../basecardview.yml | 78 +++ .../baseimagecardview.yml | 32 ++ .../baseprimarytextcardview.yml | 32 ++ .../baseview.yml | 192 +++++++ ...daptivecardextensionpropertiesmetadata.yml | 12 + ...iadaptivecardextensionpropertymetadata.yml | 11 + .../ibaseactionarguments.yml | 40 ++ .../ibasecardparameters.yml | 47 ++ .../ibasiccardparameters.yml | 26 + .../icardbutton.yml | 59 ++ .../iconfirmationdialog.yml | 35 ++ .../iexternallinkcardaction.yml | 35 ++ .../iexternallinkparameters.yml | 35 ++ .../igetlocationaction.yml | 36 ++ .../igetlocationactionarguments.yml | 39 ++ .../igetlocationactionparameters.yml | 23 + .../igetlocationcardaction.yml | 35 ++ .../iimagecardparameters.yml | 38 ++ .../ilocation.yml | 59 ++ .../iprimarytextcardparameters.yml | 38 ++ .../iquickviewcardaction.yml | 35 ++ .../iquickviewparameters.yml | 23 + .../iselectmediaaction.yml | 36 ++ .../iselectmediaactionarguments.yml | 39 ++ .../iselectmediaactionparameters.yml | 59 ++ .../iselectmediaattachment.yml | 35 ++ .../iselectmediacardaction.yml | 35 ++ .../ishowcardactionarguments.yml | 27 + .../ishowlocationaction.yml | 36 ++ .../ishowlocationactionparameters.yml | 23 + .../ishowlocationcardaction.yml | 35 ++ .../ispfxadaptivecard.yml | 11 + .../isubmitactionarguments.yml | 39 ++ .../isubmitcardaction.yml | 47 ++ .../isubmitcardparameters.yml | 10 + .../mediatype.yml | 20 + .../quickviewnavigator.yml | 30 + .../viewnavigator.yml | 148 +++++ SP-Framework/sp-application-base.yml | 4 +- .../applicationaccessor.yml | 39 +- .../applicationcustomizercontext.yml | 21 +- .../baseapplicationcustomizer.yml | 33 +- .../iplaceholdercreatecontentoptions.yml | 20 +- .../placeholdercontent.yml | 51 +- .../sp-application-base/placeholdername.yml | 11 +- .../placeholderprovider.yml | 104 ++-- SP-Framework/sp-component-base.yml | 7 +- .../sp-component-base/basecomponent.yml | 71 +-- .../basecomponentcontext.yml | 84 ++- .../sp-component-base/dynamicdataprovider.yml | 79 +-- .../dynamicdatasourcemanager.yml | 49 +- .../sp-component-base/dynamicproperty.yml | 90 ++- .../icomponentpropertymetadata.yml | 111 ++++ .../sp-component-base/ireadonlyfontstyles.yml | 136 +---- .../sp-component-base/ireadonlytheme.yml | 48 +- .../iserializedserverprocesseddata.yml | 133 +++++ SP-Framework/sp-component-base/itheme.yml | 69 +-- .../themechangedeventargs.yml | 4 +- .../sp-component-base/themeprovider.yml | 36 +- SP-Framework/sp-core-library.yml | 2 +- SP-Framework/sp-core-library/displaymode.yml | 18 +- SP-Framework/sp-core-library/environment.yml | 10 +- .../sp-core-library/environmenttype.yml | 42 +- SP-Framework/sp-core-library/guid.yml | 37 +- SP-Framework/sp-core-library/idisposable.yml | 16 +- .../irandomnumbergenerator.yml | 20 +- .../sp-core-library/iservicecollection.yml | 4 +- .../sp-core-library/ispeventobserver.yml | 22 +- .../sp-core-library/itimeprovider.yml | 20 +- SP-Framework/sp-core-library/log.yml | 82 +-- .../sp-core-library/randomnumbergenerator.yml | 11 +- SP-Framework/sp-core-library/servicekey.yml | 68 +-- SP-Framework/sp-core-library/servicescope.yml | 161 +++--- SP-Framework/sp-core-library/session.yml | 57 +- SP-Framework/sp-core-library/spevent.yml | 69 +-- SP-Framework/sp-core-library/speventargs.yml | 8 +- SP-Framework/sp-core-library/text_2.yml | 63 +++ SP-Framework/sp-core-library/timeprovider.yml | 9 +- .../urlqueryparametercollection.yml | 27 +- SP-Framework/sp-core-library/validate.yml | 32 +- SP-Framework/sp-core-library/version.yml | 87 ++- SP-Framework/sp-diagnostics.yml | 5 +- SP-Framework/sp-dialog/basedialog.yml | 172 +++--- SP-Framework/sp-dialog/dialog.yml | 32 +- .../sp-dialog/idialogconfiguration.yml | 4 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 12 +- .../sp-dialog/isecondarydialogprovider.yml | 55 +- SP-Framework/sp-dynamic-data.yml | 3 +- .../sp-dynamic-data/dynamicdatareference.yml | 25 +- .../idynamicdataannotatedpropertyvalue.yml | 15 +- .../sp-dynamic-data/idynamicdatacallables.yml | 56 +- .../idynamicdataeventdefinition.yml | 6 +- .../idynamicdatapropertydefinition.yml | 13 +- .../idynamicdatapropertymetadata.yml | 8 +- .../idynamicdatapropertyvaluemetadata.yml | 12 +- ...micdatapropertyvaluemetadatacollection.yml | 13 +- .../sp-dynamic-data/idynamicdatasource.yml | 117 ++-- .../idynamicdatasourcemetadata.yml | 24 +- .../sp-extension-base/baseextension.yml | 37 +- .../sp-extension-base/extensioncontext.yml | 5 +- SP-Framework/sp-http.yml | 3 + SP-Framework/sp-http/aadhttpclient.yml | 63 +-- .../sp-http/aadhttpclientconfiguration.yml | 40 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 20 +- .../sp-http/aadhttpclientresponse.yml | 31 ++ SP-Framework/sp-http/aadtokenprovider.yml | 77 +-- .../sp-http/aadtokenproviderfactory.yml | 12 +- .../sp-http/beforeredirecteventargs.yml | 54 ++ SP-Framework/sp-http/digestcache.yml | 59 +- SP-Framework/sp-http/graphrequest.yml | 70 +-- SP-Framework/sp-http/httpclient.yml | 87 ++- .../sp-http/httpclientconfiguration.yml | 28 +- SP-Framework/sp-http/httpclientresponse.yml | 90 +-- .../sp-http/iaadhttpclientconfigurations.yml | 15 +- .../sp-http/iaadhttpclientoptions.yml | 8 +- SP-Framework/sp-http/iaadtokenprovider.yml | 73 +-- .../iaadtokenproviderconfiguration.yml | 38 +- .../sp-http/ibeforeredirecteventargs.yml | 36 ++ SP-Framework/sp-http/idigestcache.yml | 59 +- .../sp-http/ihttpclientconfigurations.yml | 15 +- SP-Framework/sp-http/ihttpclientoptions.yml | 7 +- .../isphttpclientbatchconfigurations.yml | 15 +- .../isphttpclientbatchcreationoptions.yml | 12 +- .../sp-http/isphttpclientbatchoptions.yml | 5 +- .../isphttpclientcommonconfiguration.yml | 16 +- .../sp-http/isphttpclientconfiguration.yml | 28 +- .../sp-http/isphttpclientconfigurations.yml | 15 +- SP-Framework/sp-http/isphttpclientoptions.yml | 18 +- SP-Framework/sp-http/msgraphclient.yml | 28 +- SP-Framework/sp-http/msgraphclientfactory.yml | 17 +- SP-Framework/sp-http/odataversion.yml | 11 +- SP-Framework/sp-http/sphttpclient.yml | 174 +++--- SP-Framework/sp-http/sphttpclientbatch.yml | 131 ++--- .../sphttpclientbatchconfiguration.yml | 46 +- .../sphttpclientcommonconfiguration.yml | 64 +-- .../sp-http/sphttpclientconfiguration.yml | 74 +-- SP-Framework/sp-http/sphttpclientresponse.yml | 15 +- SP-Framework/sp-http/sphttpheader.yml | 11 +- .../sp-http/tokenacquisitioneventargs.yml | 4 +- SP-Framework/sp-image-helper.yml | 9 + .../sp-image-helper/iimagehelperrequest.yml | 50 ++ SP-Framework/sp-image-helper/imagehelper.yml | 34 ++ SP-Framework/sp-list-subscription.yml | 4 +- .../icreatesubscriptionsettings.yml | 36 +- .../ilistsubscription.yml | 4 +- .../isubscriptioncallbacks.yml | 4 +- .../listsubscriptionfactory.yml | 28 +- SP-Framework/sp-listview-extensibility.yml | 9 +- .../basefieldcustomizer.yml | 40 +- .../baselistviewcommandset.yml | 66 +-- .../columnaccessor.yml | 21 +- .../sp-listview-extensibility/command.yml | 32 +- .../fieldcustomizercontext.yml | 30 +- .../ifieldcustomizercelleventparameters.yml | 29 +- ...stviewcommandsetexecuteeventparameters.yml | 19 +- ...iewcommandsetlistviewupdatedparameters.yml | 12 +- .../listitemaccessor.yml | 48 +- .../listviewaccessor.yml | 61 +- .../listviewcommandsetcontext.yml | 26 +- .../sp-listview-extensibility/rowaccessor.yml | 17 +- .../selectedrowschangedeventargs.yml | 11 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 4 +- SP-Framework/sp-loader/spcomponentloader.yml | 47 +- SP-Framework/sp-module-interfaces.yml | 5 +- .../iadaptivecardextensionmanifest.yml | 171 ++++++ .../iadaptivecardextensionmanifestentry.yml | 237 ++++++++ .../iclientsideassemblymanifest.yml | 12 +- ...clientsidecomponentloaderconfiguration.yml | 107 ++-- .../iclientsidecomponentmanifest.yml | 138 ++--- .../iclientsideextensionmanifest.yml | 12 +- .../iclientsidelibrarymanifest.yml | 9 +- .../iclientsidemanifestbase.yml | 25 +- .../iclientsidewebpartmanifest.yml | 144 ++--- .../iclientsidewebpartmanifestentry.yml | 196 +++---- .../iclientsidewebpartmanifestinstance.yml | 5 +- .../icommanddefinition.yml | 39 +- .../icommandsetextensionmanifest.yml | 25 +- .../icomponentmoduleconfiguration.yml | 42 +- .../ilocalizedpathmoduleconfiguration.yml | 61 +- .../sp-module-interfaces/ilocalizedstring.yml | 17 +- .../imoduleconfiguration.yml | 32 +- SP-Framework/sp-module-interfaces/ipath.yml | 29 +- .../ipathmoduleconfiguration.yml | 80 ++- .../sp-module-interfaces/predefinedgroup.yml | 41 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 3 +- .../sp-odata-types/iodatachangetoken.yml | 7 +- .../iodatacontextwebinformation.yml | 9 +- SP-Framework/sp-odata-types/iodatalist.yml | 8 +- .../sp-odata-types/iodatalistitem.yml | 3 +- .../sp-odata-types/iodatanavigationnode.yml | 25 +- .../iodatanavigationnodecollection.yml | 19 +- SP-Framework/sp-odata-types/iodatauser.yml | 15 +- .../sp-odata-types/iodatausercustomaction.yml | 72 +-- SP-Framework/sp-odata-types/iodataweb.yml | 33 +- SP-Framework/sp-page-context.yml | 2 - SP-Framework/sp-page-context/cultureinfo.yml | 31 +- SP-Framework/sp-page-context/pagecontext.yml | 81 ++- SP-Framework/sp-page-context/spfield.yml | 26 +- SP-Framework/sp-page-context/splist.yml | 17 +- SP-Framework/sp-page-context/splistitem.yml | 9 +- SP-Framework/sp-page-context/sppermission.yml | 115 ++-- SP-Framework/sp-page-context/spsite.yml | 19 +- SP-Framework/sp-page-context/sptimezone.yml | 28 +- SP-Framework/sp-page-context/spuser.yml | 27 +- SP-Framework/sp-page-context/spweb.yml | 39 +- SP-Framework/sp-property-pane.yml | 258 +++------ .../dynamicdatashareddepth.yml | 6 +- ...dynamicdatasharedpropertyconfiguration.yml | 8 +- .../idynamicdatasharedpropertyfilters.yml | 21 +- .../idynamicdatasharedsourceconfiguration.yml | 11 +- .../idynamicdatasharedsourcefilters.yml | 47 +- .../sp-property-pane/ipopupwindowprops.yml | 3 +- .../ipropertypanebuttonprops.yml | 18 +- .../ipropertypanechoicegroupoption.yml | 21 +- ...propertypanechoicegroupoptioniconprops.yml | 3 +- .../ipropertypanechoicegroupprops.yml | 5 +- .../ipropertypaneconditionalgroup.yml | 27 +- .../ipropertypaneconfiguration.yml | 60 +- .../ipropertypanecustomfieldprops.yml | 32 +- .../ipropertypanedebounceproperty.yml | 14 +- .../ipropertypanedropdowncalloutprops.yml | 7 +- .../ipropertypanedropdownoption.yml | 9 +- .../ipropertypanedropdownprops.yml | 21 +- .../ipropertypanedynamicfieldprops.yml | 29 +- .../ipropertypanedynamicfieldsetprops.yml | 16 +- .../ipropertypanedynamictextfieldprops.yml | 64 +-- .../sp-property-pane/ipropertypanegroup.yml | 8 +- .../ipropertypanelabelprops.yml | 4 +- .../ipropertypanelinkprops.yml | 4 +- .../sp-property-pane/ipropertypanepage.yml | 17 +- .../ipropertypanepageheader.yml | 3 +- .../ipropertypanesliderprops.yml | 15 +- .../ipropertypanetextfieldprops.yml | 73 +-- .../ipropertypanetoggleprops.yml | 12 +- .../sp-property-pane/popupwindowposition.yml | 10 +- .../propertypanebuttontype.yml | 16 +- .../propertypanedropdownoptiontype.yml | 9 +- .../propertypanefieldtype.yml | 36 +- .../basesearchquerymodifier.yml | 47 +- .../sp-search-extensibility/iquery.yml | 8 +- .../searchqueryscenario.yml | 10 +- SP-Framework/sp-webpart-base.yml | 309 ++++------- .../sp-webpart-base/baseclientsidewebpart.yml | 198 +++---- SP-Framework/sp-webpart-base/basewebpart.yml | 301 +++++----- .../sp-webpart-base/basewebpartcontext.yml | 31 +- .../dynamicdatashareddepth.yml | 10 +- .../iclientsidewebpartstatusrenderer.yml | 30 +- ...dynamicdatasharedpropertyconfiguration.yml | 9 +- .../idynamicdatasharedpropertyfilters.yml | 9 +- .../idynamicdatasharedsourceconfiguration.yml | 9 +- .../idynamicdatasharedsourcefilters.yml | 8 +- .../sp-webpart-base/imicrosoftteams.yml | 6 +- SP-Framework/sp-webpart-base/ioffice.yml | 6 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 40 +- .../ipropertypanebuttonprops.yml | 8 +- .../ipropertypanecheckboxprops.yml | 8 +- .../ipropertypanechoicegroupoption.yml | 8 +- ...propertypanechoicegroupoptioniconprops.yml | 9 +- .../ipropertypanechoicegroupprops.yml | 8 +- .../ipropertypaneconditionalgroup.yml | 8 +- .../ipropertypaneconfiguration.yml | 8 +- .../ipropertypanecustomfieldprops.yml | 8 +- .../ipropertypanedropdowncalloutprops.yml | 9 +- .../ipropertypanedropdownoption.yml | 8 +- .../ipropertypanedropdownprops.yml | 8 +- .../ipropertypanedynamicfieldfilters.yml | 12 +- .../ipropertypanedynamicfieldprops.yml | 8 +- .../ipropertypanedynamicfieldsetprops.yml | 9 +- .../ipropertypanedynamictextfieldprops.yml | 5 +- .../sp-webpart-base/ipropertypanefield.yml | 9 +- .../sp-webpart-base/ipropertypanegroup.yml | 8 +- .../ipropertypanelabelprops.yml | 8 +- .../ipropertypanelinkprops.yml | 8 +- .../sp-webpart-base/ipropertypanepage.yml | 8 +- .../ipropertypanepageheader.yml | 8 +- .../ipropertypanesliderprops.yml | 8 +- .../ipropertypanetextfieldprops.yml | 8 +- .../ipropertypanetoggleprops.yml | 8 +- SP-Framework/sp-webpart-base/isdks.yml | 8 +- .../iserializedwebpartdata.yml | 61 +- .../sp-webpart-base/iwebpartcontext.yml | 22 +- SP-Framework/sp-webpart-base/iwebpartdata.yml | 71 +-- .../iwebpartpropertiesmetadata.yml | 23 +- .../iwebpartpropertymetadata.yml | 150 +---- .../propertypanebuttontype.yml | 20 +- .../propertypanedropdownoptiontype.yml | 13 +- .../sp-webpart-base/propertypanefieldtype.yml | 40 +- .../sp-webpart-base/webpartcontext.yml | 37 +- SP-Framework/spfx-toc/toc.yml | 130 ++++- 297 files changed, 6479 insertions(+), 5509 deletions(-) create mode 100644 .vscode/settings.json create mode 100644 SP-Framework/office-ui-fabric-react-bundle.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/basecardview.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/baseview.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ilocation.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/mediatype.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml create mode 100644 SP-Framework/sp-component-base/icomponentpropertymetadata.yml create mode 100644 SP-Framework/sp-component-base/iserializedserverprocesseddata.yml create mode 100644 SP-Framework/sp-core-library/text_2.yml create mode 100644 SP-Framework/sp-http/aadhttpclientresponse.yml create mode 100644 SP-Framework/sp-http/beforeredirecteventargs.yml create mode 100644 SP-Framework/sp-http/ibeforeredirecteventargs.yml create mode 100644 SP-Framework/sp-image-helper.yml create mode 100644 SP-Framework/sp-image-helper/iimagehelperrequest.yml create mode 100644 SP-Framework/sp-image-helper/imagehelper.yml create mode 100644 SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml create mode 100644 SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..ed9462b7 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "markdownlint.config": { + "MD028": false, + "MD025": { + "front_matter_title": "" + } + } +} \ No newline at end of file diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 74219049..1ccf516b 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -2,47 +2,43 @@ uid: '@microsoft/decorators!' name: '@microsoft/decorators' type: package -summary: >- - A conservative set of decorators intended for use in both NodeJS and web - browser projects. +summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. functions: - name: 'override(target, propertyKey, descriptor)' uid: '@microsoft/decorators!override:function(1)' - package: '@microsoft/decorators' + package: '@microsoft/decorators!' summary: >- - This decorator is applied to a class's member function or property. It - indicates that the definition overrides another defintion (of the same - name) from the base class. The base class definition must be marked as - @virtual. This decorator is currently used for documentation - purposes only. In the future, it may be enforced at runtime. + This decorator is applied to a class's member function or property. It indicates that the definition overrides + another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at + runtime. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function override(target: Object, propertyKey: string | - symbol, descriptor: TypedPropertyDescriptor): void; + export declare function override(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; parameters: - id: target description: '' - type: '' + type: Object - id: propertyKey description: '' type: string | symbol - id: descriptor description: '' - type: '<any>' + type: TypedPropertyDescriptor<any> return: type: void description: '' - name: sealed(target) uid: '@microsoft/decorators!sealed:function(1)' - package: '@microsoft/decorators' + package: '@microsoft/decorators!' summary: >- - This decorator is applied to a class (but NOT member function or - property). It indicates that subclasses must not inherit from this class. - This decorator is currently used for documentation purposes only. In the - future, it may be enforced at runtime. + This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not + inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may + be enforced at runtime. remarks: '' isPreview: false isDeprecated: false @@ -51,37 +47,35 @@ functions: parameters: - id: target description: '' - type: '' + type: Function return: type: void description: '' - name: 'virtual(target, propertyKey, descriptor)' uid: '@microsoft/decorators!virtual:function(1)' - package: '@microsoft/decorators' + package: '@microsoft/decorators!' summary: >- - This decorator is applied to a class's member function or property. It - indicates that the definition may optionally be overridden in a child - class. Conversely, if the @virtual decorator is NOT applied to a - definition, then child classes may NOT override it. This decorator is - currently used for documentation purposes only. In the future, it may be - enforced at runtime. + This decorator is applied to a class's member function or property. It indicates that the definition may + optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a + definition, then child classes may NOT override it. This decorator is currently used for documentation purposes + only. In the future, it may be enforced at runtime. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function virtual(target: Object, propertyKey: string | - symbol, descriptor: TypedPropertyDescriptor): void; + export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; parameters: - id: target description: '' - type: '' + type: Object - id: propertyKey description: '' type: string | symbol - id: descriptor description: '' - type: '<any>' + type: TypedPropertyDescriptor<any> return: type: void description: '' diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml new file mode 100644 index 00000000..3e551787 --- /dev/null +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -0,0 +1,18 @@ +### YamlMime:TSPackage +uid: '@microsoft/office-ui-fabric-react-bundle!' +name: '@microsoft/office-ui-fabric-react-bundle' +type: package +summary: '' +functions: + - name: initializeIcons() + uid: '@microsoft/office-ui-fabric-react-bundle!initializeIcons:function(1)' + package: '@microsoft/office-ui-fabric-react-bundle!' + summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'export declare function initializeIcons(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml new file mode 100644 index 00000000..87869efb --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -0,0 +1,50 @@ +### YamlMime:TSPackage +uid: '@microsoft/sp-adaptive-card-extension-base!' +name: '@microsoft/sp-adaptive-card-extension-base' +type: package +summary: SharePoint Framwork Adaptive Card Extensions +classes: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' +interfaces: + - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' +enums: + - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml new file mode 100644 index 00000000..94f83153 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: AdaptiveCardExtensionContext +uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: AdaptiveCardExtensionContext +summary: Adaptive Card Extension context object. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AdaptiveCardExtensionContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: deviceContext + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#deviceContext:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: deviceContext + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get deviceContext(): DeviceContext;' + return: + type: '' + - name: manifest + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: manifest + summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IAdaptiveCardExtensionManifest;' + return: + type: '<unknown>' + - name: propertyPane + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: propertyPane + summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get propertyPane(): IPropertyPaneAccessor | undefined;' + return: + type: ' | undefined' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml new file mode 100644 index 00000000..46b013f3 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -0,0 +1,522 @@ +### YamlMime:TSType +name: BaseAdaptiveCardExtension +uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseAdaptiveCardExtension +summary: Base class for Adaptive Card Extensions. +remarks: Adaptive Card Extensions must inherit from this class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: (constructor)() + summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: constructor(); +properties: + - name: _iconProperty + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: _iconProperty + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected _iconProperty: string;' + return: + type: string + - name: _title + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: _title + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected _title: string;' + return: + type: string + - name: cardNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardNavigator + summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cardNavigator(): ViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: cardSize + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardSize + summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get cardSize(): CardSize;' + return: + type: '' + - name: context + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: context + summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected context: AdaptiveCardExtensionContext;' + return: + type: '' + - name: dataVersion + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: dataVersion + summary: >- + The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to + manage versioning of the Adaptive Card Extension. + remarks: The default version is 1.0. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get dataVersion(): Version;' + return: + type: '' + - name: description + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: description + summary: The description of the Adaptive Card Extension defined in the manifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get description(): string;' + return: + type: string + - name: displayMode + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: displayMode + summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get displayMode(): DisplayMode;' + return: + type: '' + - name: iconProperty + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: iconProperty + summary: The icon url used to render an icon on the Card view. + remarks: 'By default, this will return the iconImageUrl defined in the manifest.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected get iconProperty(): string; + return: + type: string + - name: isVisible + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isVisible + summary: Sets the visibility of the Adaptive Card Extension and re-render + remarks: >- + This method should be called after a card view has been registered. Otherwise visibility change will not be + applied to the Adaptive Card. + isPreview: false + isDeprecated: false + syntax: + content: |- + get isVisible(): boolean; + + set isVisible(value: boolean); + return: + type: boolean + - name: properties + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: properties + summary: 'The custom, persisted properties of the Adaptive Card Extension.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get properties(): TProperties;' + return: + type: TProperties + - name: propertiesMetadata + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: propertiesMetadata + summary: >- + This property defines metadata for the Adaptive Card Extension property bag. The metadata can help SharePoint + understand the content of the properties better and perform relevant services on the data. + remarks: >- + See + [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) + for more information about how to define metadata. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined; + return: + type: >- + | + undefined + - name: quickViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: quickViewNavigator + summary: >- + [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a + [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get quickViewNavigator(): QuickViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: renderedFromPersistedData + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderedFromPersistedData + summary: >- + Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default + state. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get renderedFromPersistedData(): boolean;' + return: + type: boolean + - name: renderedOnce + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderedOnce + summary: Indicates whether the Adaptive Card Extension has initially rendered. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get renderedOnce(): boolean;' + return: + type: boolean + - name: renderType + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderType + summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get renderType(): RenderType;' + return: + type: '' + - name: state + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: state + summary: Gets the custom state of the Adaptive Card Extension. + remarks: >- + If this property is not initialized, + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) + cannot be called. + isPreview: false + isDeprecated: false + syntax: + content: |- + protected get state(): Readonly; + + protected set state(initialState: Readonly); + return: + type: Readonly<TState> + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: >- + This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also + displayed as the Property Pane title. + remarks: 'By default, this will return the title defined in the manifest.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get title(): string; + return: + type: string +methods: + - name: getPropertyPaneConfiguration() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: getPropertyPaneConfiguration() + summary: >- + Get the Property Pane configuration for this Adaptive Card Extension. If an Adaptive Card Extension wants to use + the Property Pane, then this method must be overriden. + remarks: >- + Property Pane resources can be defer loaded to reduce bundle size. See + [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration; + return: + type: '' + description: '' + - name: loadPropertyPaneResources() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: loadPropertyPaneResources() + summary: API to enable asynchronous loading of Property Pane related resources of the Adaptive Card Extension. + remarks: >- + No Property Pane events will be raised until this method resolves except for + `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected loadPropertyPaneResources(): Promise; + return: + type: Promise<void> + description: '' + - name: 'onAfterDeserialize(deserializedProperties, dataVersion)' + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)' + summary: Lifecycle method called before the property bag is populated with the deserialized property object. + remarks: >- + The default implementation is a no-op. An Adaptive Card Extension developer can override this API if the + deserialized object does not fully reflect the initial state of the property bag. This gives the Adaptive Card + Extension developer a chance to populate the property bag right after the data is deserialized to an object. + + + An important scenario to use deserialize is upgrading. An upgraded Adaptive Card Extension may load the data that + was serialized by an older version of the Adaptive Card Extension that supported a different schema of the + property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The + developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onAfterDeserialize(deserializedProperties: any, dataVersion: Version): TProperties; + parameters: + - id: deserializedProperties + description: >- + The object deserialized from the stored data. Note that the schema of this object is not necessarily + consistent with the current property bag, because the serialization could have been done by an older version + of the Adaptive Card Extension + type: any + - id: dataVersion + description: >- + The data version of the stored data being deserialized. You can use this value to determine if the data was + serialized by an older Adaptive Card Extension. Adaptive Card Extensions can define their data version by + overriding the dataVersion property. + type: '' + return: + type: TProperties + description: The property bag of the Adaptive Card Extension + - name: onAfterPropertiesUpdatedExternally(prevProperties) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onAfterPropertiesUpdatedExternally(prevProperties) + summary: >- + Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than + the property pane (except for isolated Adaptive Card Extensions). + remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onAfterPropertiesUpdatedExternally(prevProperties: TProperties): void; + parameters: + - id: prevProperties + description: The Adaptive Card Extension properties before the update. + type: TProperties + return: + type: void + description: '' + - name: onBeforeSerialize() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onBeforeSerialize() + summary: Lifecycle method called before serialization. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onBeforeSerialize(): void; + return: + type: void + description: '' + - name: onDisplayModeChanged(oldDisplayMode) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onDisplayModeChanged(oldDisplayMode) + summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; + parameters: + - id: oldDisplayMode + description: The old display mode. + type: '' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onDispose() + summary: Lifecycle method called before disposing the Adaptive Card Extension. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onDispose(): void; + return: + type: void + description: '' + - name: onInit() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onInit() + summary: Lifecycle method called during initialization. + remarks: >- + Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result + or, if resolved immediately, a fetching data state can be rendered. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onInit(): Promise; + return: + type: Promise<void> + description: '' + - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + summary: Lifecycle method called when a Property Pane field is changed. + remarks: This is invoked for reactive Property Panes. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void; + parameters: + - id: propertyPath + description: >- + JSON path of the property in the property bag. In the case of custom field, if no target property is + provided then a custom value is assigned, which will be in the form of `__CustomField_`. + type: string + - id: oldValue + description: Old value of the property. This value could be undefined/empty in the case of custom field. + type: any + - id: newValue + description: New value of the property. This value could be undefined/empty in the case of custom field. + type: any + return: + type: void + description: '' + - name: onRenderTypeChanged(oldRenderType) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onRenderTypeChanged(oldRenderType) + summary: >- + Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) + changes. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onRenderTypeChanged(oldRenderType: RenderType): void; + parameters: + - id: oldRenderType + description: 'The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' + type: '' + return: + type: void + description: '' + - name: renderCard() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderCard() + summary: The id of the initial Card view. + remarks: 'By default, this returns undefined and will render a default Card view.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected renderCard(): string | undefined; + return: + type: string | undefined + description: '' + - name: setState(newState) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: setState(newState) + summary: Update the state of the Adaptive Card Extension and re-render. + remarks: >- + [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member) + must have been initialized before calling + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). + isPreview: false + isDeprecated: false + syntax: + content: 'setState(newState?: Partial): void;' + parameters: + - id: newState + description: '' + type: Partial<TState> + return: + type: void + description: '' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml new file mode 100644 index 00000000..dc90b971 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: BaseAdaptiveCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseAdaptiveCardView +summary: Base class for an Adaptive Card view. +remarks: Views used to render the Quick view must inherit from this class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data used to render the Adaptive Card. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get data(): TData; + return: + type: TData + - name: externalLink + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: externalLink + summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. + remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get externalLink(): IExternalLinkParameters | undefined; + return: + type: ' | undefined' + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: The Adaptive Card template rendered by the view. + remarks: The format of the template must be valid Adaptive Card JSON. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + abstract get template(): ISPFxAdaptiveCard; + return: + type: '' + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: An optional title to be displayed in the navigation bar above the Adaptive Card. + remarks: >- + If not overriden, the title displayed will be + [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get title(): string; + return: + type: string +extends: '<TProperties, TState, TData> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml new file mode 100644 index 00000000..a927cc19 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: BaseBasicCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseBasicCardView +summary: Base class for a Basic Card view. +remarks: >- + The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the + `Medium` Card size, two buttons in the `Large` Card size +isPreview: false +isDeprecated: false +type: class +properties: + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: >- + Returns the Adaptive Card template for the + [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + type: '' +extends: >- + <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml new file mode 100644 index 00000000..0a8d68c9 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: BaseCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseCardView +summary: Primitive base class for Card views. +remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + No third-party Card views should inherit from this class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: cardButtons + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#cardButtons:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardButtons + summary: The buttons displayed on the Card. + remarks: >- + Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the + documentation for the respective base Card View class for specific details. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get cardButtons(): [ICardButton] | [ICardButton, ICardButton] | undefined; + return: + type: >- + [] | [, ] | undefined + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data used to render the Card view. + remarks: >- + The available data to display is dependent on the Card view template and its respective base Card view class. See + the documentation for the Card View class for specific details. + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get data(): TData;' + return: + type: TData + - name: isCacheEnabled + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#isCacheEnabled:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isCacheEnabled + summary: 'If true, this Card view will be cached and rendered at next load.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get isCacheEnabled(): boolean; + return: + type: boolean + - name: onCardSelection + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onCardSelection + summary: Action to invoke when the card is selected. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | undefined; + return: + type: >- + | | undefined +extends: '<TProperties, TState, TData> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml new file mode 100644 index 00000000..a3e872c1 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: BaseImageCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseImageCardView +summary: Base class for an Image Card view. +remarks: >- + The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero + buttons in the `Medium` Card size, up to two buttons in `Large` Card size +isPreview: false +isDeprecated: false +type: class +properties: + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: >- + Returns the Adaptive Card template for the + [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + type: '' +extends: >- + <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml new file mode 100644 index 00000000..0153ee5b --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: BasePrimaryTextCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BasePrimaryTextCardView +summary: Base class for a Primary Text Card view. +remarks: >- + The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description + text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size +isPreview: false +isDeprecated: false +type: class +properties: + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: >- + Returns the Adaptive Card template for the + [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + type: '' +extends: >- + <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml new file mode 100644 index 00000000..984a58df --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -0,0 +1,192 @@ +### YamlMime:TSType +name: BaseView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseView +summary: Base class for all views. +remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + No third-party views should inherit from this class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: cardNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardNavigator + summary: >- + See + [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cardNavigator(): ViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: cardSize + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardSize:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardSize + summary: >- + See + [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cardSize(): CardSize;' + return: + type: '' + - name: context + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#context:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: context + summary: >- + See + [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get context(): AdaptiveCardExtensionContext;' + return: + type: '' + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data used to render the View. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get data(): TData | undefined;' + return: + type: TData | undefined + - name: properties + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#properties:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: properties + summary: >- + See + [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get properties(): TProperties;' + return: + type: TProperties + - name: quickViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: quickViewNavigator + summary: >- + See + [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get quickViewNavigator(): QuickViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: state + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#state:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: state + summary: >- + See + [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get state(): Readonly;' + return: + type: Readonly<TState> + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: The Adaptive Card template used to render the view. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get template(): ISPFxAdaptiveCard;' + return: + type: '' +methods: + - name: onAction(action) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onAction:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onAction(action) + summary: Action handler for Adaptive Card Actions. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onAction(action: IActionArguments): void;' + parameters: + - id: action + description: >- + The [IActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionArguments:type) for the + current event. + type: '' + return: + type: void + description: '' + - name: setState(newState) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: setState(newState) + summary: >- + See + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'setState(newState?: Partial): void;' + parameters: + - id: newState + description: '' + type: Partial<TState> + return: + type: void + description: '' + - name: setVisibility(isVisible) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setVisibility:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: setVisibility(isVisible) + summary: >- + Sets visibility to false and rerenders the card. See + [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'setVisibility(isVisible: boolean): void;' + parameters: + - id: isVisible + description: '' + type: boolean + return: + type: void + description: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml new file mode 100644 index 00000000..aaf8dd00 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -0,0 +1,12 @@ +### YamlMime:TSType +name: IAdaptiveCardExtensionPropertiesMetadata +uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IAdaptiveCardExtensionPropertiesMetadata +summary: >- + This structure is used to define metadata for Adaptive Card Extension properties as a map of string to + `IAdaptiveCardExtensionPropertiesMetadata` +remarks: '' +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml new file mode 100644 index 00000000..ebc8f262 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -0,0 +1,11 @@ +### YamlMime:TSType +name: IAdaptiveCardExtensionPropertyMetadata +uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IAdaptiveCardExtensionPropertyMetadata +summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml new file mode 100644 index 00000000..08c1ba59 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -0,0 +1,40 @@ +### YamlMime:TSType +name: IBaseActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBaseActionArguments +summary: >- + Base object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an Adaptive + Card Action is executed. +remarks: >- + Only `Submit` and `ShowCard` actions are routed to the + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#id:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: id + summary: The id specified in the Adaptive Card template + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''Submit'' | ''ShowCard'';' + return: + type: '''Submit'' | ''ShowCard''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml new file mode 100644 index 00000000..3b70fd94 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: IBaseCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBaseCardParameters +summary: The primitive data parameters for every Card view. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: iconAltText + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconAltText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: iconAltText + summary: The icon alt text. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'iconAltText?: string;' + return: + type: string + - name: iconProperty + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconProperty:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: iconProperty + summary: The icon to display. + remarks: The value is a URL to an icon. + isPreview: false + isDeprecated: false + syntax: + content: 'iconProperty?: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: The title to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml new file mode 100644 index 00000000..1af9b25b --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: IBasicCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBasicCardParameters +summary: >- + The data parameters for + [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: primaryText + uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters#primaryText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: primaryText + summary: The primary text to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryText: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml new file mode 100644 index 00000000..4e7e77aa --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: ICardButton +uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ICardButton +summary: A button to display on a Card View. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: action + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#action:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: action + summary: The type of the button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'action: ICardAction;' + return: + type: '' + - name: id + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: id + summary: Unique Id of the button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: style + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#style:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: style + summary: Controls the style of the button. + remarks: The destructive Action style is not supported in Card views + isPreview: false + isDeprecated: false + syntax: + content: 'style?: ActionStyle;' + return: + type: '' + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: Text displayed on the button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml new file mode 100644 index 00000000..1f987a7a --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: IConfirmationDialog +uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IConfirmationDialog +summary: Confirmation Dialog option that is passed through `Submit` Action is executed. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: message + uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#message:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: message + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'message: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml new file mode 100644 index 00000000..6b5b3454 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: IExternalLinkCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IExternalLinkCardAction +summary: Open an external link. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters for the external link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parameters: IExternalLinkParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is an external link button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''ExternalLink'';' + return: + type: '''ExternalLink''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml new file mode 100644 index 00000000..71754ad9 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: IExternalLinkParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IExternalLinkParameters +summary: Parameters for opening an external link. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isTeamsDeepLink + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#isTeamsDeepLink:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isTeamsDeepLink + summary: Indicates whether this is a Teams Deep Link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isTeamsDeepLink?: boolean;' + return: + type: boolean + - name: target + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: target + summary: The URL of the link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'target: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml new file mode 100644 index 00000000..e289e1fa --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: IGetLocationAction +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationAction +summary: Interface for Viva Get Location action +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Get Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IGetLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml new file mode 100644 index 00000000..42054004 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: IGetLocationActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get + location Action is executed. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: location + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: location + summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'location?: ILocation;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' +extends: 'Omit<, ''type''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml new file mode 100644 index 00000000..93c981c4 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: IGetLocationActionParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationActionParameters +summary: Parameters that can be supplied with the Viva Get Location Action. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: chooseLocationOnMap + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters#chooseLocationOnMap:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: chooseLocationOnMap + summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'chooseLocationOnMap?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml new file mode 100644 index 00000000..baa4aa1a --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: IGetLocationCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationCardAction +summary: Invoke an `VivaAction.GetLocation` event. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Get Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IGetLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml new file mode 100644 index 00000000..988e886e --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: IImageCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IImageCardParameters +summary: >- + The data parameters for + [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: imageUrl + uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#imageUrl:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: imageUrl + summary: The image URL to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'imageUrl: string;' + return: + type: string + - name: primaryText + uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: primaryText + summary: The primary text to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryText: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml new file mode 100644 index 00000000..b212dd60 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: ILocation +uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ILocation +summary: Interface for location coordinates +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: accuracy + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#accuracy:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: accuracy + summary: Accuracy of the location. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'accuracy?: number;' + return: + type: number + - name: latitude + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: latitude + summary: Latitude of the location. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'latitude: number;' + return: + type: number + - name: longitude + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: longitude + summary: Longitude of the location. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'longitude: number;' + return: + type: number + - name: timestamp + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: timestamp + summary: Timestamp + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'timestamp?: number;' + return: + type: number diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml new file mode 100644 index 00000000..8b272f47 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: IPrimaryTextCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IPrimaryTextCardParameters +summary: >- + The data parameters for + [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#description:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: description + summary: The description to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description: string;' + return: + type: string + - name: primaryText + uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: primaryText + summary: The primary text to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryText: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml new file mode 100644 index 00000000..b12fddd9 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: IQuickViewCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IQuickViewCardAction +summary: Open the quick view. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters for the quick view opened by this action + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parameters: IQuickViewParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this action opens the quick view. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''QuickView'';' + return: + type: '''QuickView''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml new file mode 100644 index 00000000..a49c4fe8 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: IQuickViewParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IQuickViewParameters +summary: Parameters for opening a Quick view. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: view + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters#view:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: view + summary: The view of the Quick view to open. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'view: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml new file mode 100644 index 00000000..08115001 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: ISelectMediaAction +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaAction +summary: Interface for new Viva Select Media action +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters: ISelectMediaActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml new file mode 100644 index 00000000..61d857af --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: ISelectMediaActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a + `SelectMedia` Action is executed. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: media + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: media + summary: media object returned media picker API + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'media: ISelectMediaAttachment[];' + return: + type: '[]' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' +extends: 'Omit<, ''type''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml new file mode 100644 index 00000000..019f9eea --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: ISelectMediaActionParameters +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaActionParameters +summary: Parameters that can be supplied with the Viva Select Media Action. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: allowMultipleCapture + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#allowMultipleCapture:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: allowMultipleCapture + summary: Allow multiple images to be selected. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'allowMultipleCapture?: boolean;' + return: + type: boolean + - name: maxSizePerFile + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#maxSizePerFile:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: maxSizePerFile + summary: Max file size that can be uploaded. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'maxSizePerFile?: number;' + return: + type: number + - name: mediaType + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#mediaType:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: mediaType + summary: Specify the specific media type that should be selected + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'mediaType: MediaType;' + return: + type: '' + - name: supportedFileFormats + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#supportedFileFormats:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: supportedFileFormats + summary: File formats supported for upload. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'supportedFileFormats?: string[];' + return: + type: 'string[]' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml new file mode 100644 index 00000000..e6d179dd --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: ISelectMediaAttachment +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaAttachment +summary: This object represents the data returned by the native media picker API. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: content + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#content:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: content + summary: Content of the file represented as base64Strings + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'content: string;' + return: + type: string + - name: fileName + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: fileName + summary: The names of the selected files. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'fileName: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml new file mode 100644 index 00000000..292aedda --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: ISelectMediaCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaCardAction +summary: Invoke an `VivaAction.SelectMedia` event. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters for the external link. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters: ISelectMediaActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Media button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml new file mode 100644 index 00000000..00278237 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: IShowCardActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowCardActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` + Action is executed. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''ShowCard'';' + return: + type: '''ShowCard''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml new file mode 100644 index 00000000..74e122a9 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: IShowLocationAction +uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowLocationAction +summary: Interface for Viva Show Location action +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Show Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IShowLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva show Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.ShowLocation'';' + return: + type: '''VivaAction.ShowLocation''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml new file mode 100644 index 00000000..e6bbcd4f --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: IShowLocationActionParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowLocationActionParameters +summary: Parameters that can be supplied with the Viva Show Location Action. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: locationCoordinates + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: locationCoordinates + summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'locationCoordinates?: ILocation;' + return: + type: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml new file mode 100644 index 00000000..8e7fe84b --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: IShowLocationCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowLocationCardAction +summary: Invoke an `VivaAction.ShowLocation` event. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Show Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IShowLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva show Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.ShowLocation'';' + return: + type: '''VivaAction.ShowLocation''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml new file mode 100644 index 00000000..e6514122 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -0,0 +1,11 @@ +### YamlMime:TSType +name: ISPFxAdaptiveCard +uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISPFxAdaptiveCard +summary: SPFx Adaptive Card Extension schema for Adaptive Cards. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml new file mode 100644 index 00000000..063fe44a --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: ISubmitActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISubmitActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` + Action is executed. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data object defined in the Adaptive Card template + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'data: any;' + return: + type: any + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''Submit'';' + return: + type: '''Submit''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml new file mode 100644 index 00000000..c388a053 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: ISubmitCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISubmitCardAction +summary: Invoke an `Action.Submit` event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: confirmationDialog + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#confirmationDialog:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: confirmationDialog + summary: Confirmation dialog option passed to the submit handler. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'confirmationDialog?: IConfirmationDialog;' + return: + type: '' + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters passed to the Submit event handler. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parameters: ISubmitCardParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Submit button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''Submit'';' + return: + type: '''Submit''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml new file mode 100644 index 00000000..153e276f --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -0,0 +1,10 @@ +### YamlMime:TSType +name: ISubmitCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISubmitCardParameters +summary: Parameters for submit card action. +remarks: '' +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml new file mode 100644 index 00000000..3959ee1d --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -0,0 +1,20 @@ +### YamlMime:TSEnum +name: MediaType +uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: MediaType +summary: Enum value to specify the type of media. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +fields: + - name: Audio + uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Audio:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + summary: '' + value: '4' + - name: Image + uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Image:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + summary: '' + value: '1' diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml new file mode 100644 index 00000000..107f1b42 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: QuickViewNavigator +uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: QuickViewNavigator +summary: Manages a stack of Adaptive Card views for the Quick view. +remarks: >- + The top of the stack is the currently rendered view. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `QuickViewNavigator` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: close() + uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator#close:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: close() + summary: Closes the View. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'close(): void;' + return: + type: void + description: '' +extends: '<TView> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml new file mode 100644 index 00000000..ba5af8cc --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -0,0 +1,148 @@ +### YamlMime:TSType +name: ViewNavigator +uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ViewNavigator +summary: Manages a stack of views. +remarks: The top of the stack represents the currently rendered view. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + summary: Constructs a new instance of the `ViewNavigator` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + constructor(_handleStackChangedCallback: (skipUpdate: boolean) => void, _handleInitializeCallback: (view: + BaseView) => void); + parameters: + - id: _handleStackChangedCallback + description: '' + type: '(skipUpdate: boolean) => void' + - id: _handleInitializeCallback + description: '' + type: '(view: ) => void' +properties: + - name: currentId + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#currentId:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: currentId + summary: Get the id of the currently rendered View from the top of the View stack + remarks: 'If the stack is empty, this will return undefined' + isPreview: false + isDeprecated: false + syntax: + content: 'get currentId(): string | undefined;' + return: + type: string | undefined + - name: size + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#size:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: size + summary: Current size of the View stack. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get size(): number;' + return: + type: number +methods: + - name: pop(skipUpdate) + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#pop:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: pop(skipUpdate) + summary: >- + If there is more than one View, pops the top View from the View stack. + + + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'pop(skipUpdate?: boolean): void;' + parameters: + - id: skipUpdate + description: Whether to skip the update (and re-render) after popping the current View. + type: boolean + return: + type: void + description: '' + - name: 'push(id, skipUpdate)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'push(id, skipUpdate)' + summary: >- + Pushes a new view to the top of the view stack. + + + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'push(id: string, skipUpdate?: boolean): void;' + parameters: + - id: id + description: Unique identifier for the view. + type: string + - id: skipUpdate + description: Whether to skip the update (and re-render) after pushing the new view. + type: boolean + return: + type: void + description: '' + - name: 'register(id, initializer)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'register(id, initializer)' + summary: Registers a new view. + remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' + isPreview: false + isDeprecated: false + syntax: + content: 'register(id: string, initializer: () => TView): void;' + parameters: + - id: id + description: Unique identifier for the view. + type: string + - id: initializer + description: 'Function that returns a new view, which is only called if no view with the `id` already exists.' + type: () => TView + return: + type: void + description: '' + - name: 'replace(id, skipUpdate)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'replace(id, skipUpdate)' + summary: >- + Replaces the top view with a new view. + + + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'replace(id: string, skipUpdate?: boolean): void;' + parameters: + - id: id + description: Unique identifier for the view. + type: string + - id: skipUpdate + description: Whether to skip the update (and re-render) after replacing the current view. + type: boolean + return: + type: void + description: '' diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index 1036db6e..cf424bbc 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -2,9 +2,7 @@ uid: '@microsoft/sp-application-base!' name: '@microsoft/sp-application-base' type: package -summary: >- - SharePoint Framework support for building and extending client-side - applications. +summary: SharePoint Framework support for building and extending client-side applications. classes: - '@microsoft/sp-application-base!ApplicationAccessor:class' - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index ce00cac9..e78c47a8 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -5,20 +5,15 @@ package: '@microsoft/sp-application-base!' fullName: ApplicationAccessor summary: Provides access to the client-side application that is currently running. remarks: >- - The client-side application determines the user experience for an entire web - page. (It is a client-side component with a manifest; however, the SharePoint - Framework does not enable third parties to create their own client-side - applications at this time.) Within a web page, at most one client-side - application will be running at a time. Certain in-place navigation transitions - can cause the application to be unloaded and replaced by a different - application. + The client-side application determines the user experience for an entire web page. (It is a client-side component with + a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side + applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain + in-place navigation transitions can cause the application to be unloaded and replaced by a different application. - The ApplicationAccessor class enables extensibility components such as - extensions and web parts to interact with the currently running application. - It acts as a proxy for the real application object (the BaseApplication - subclass), to ensure that extensibility components only rely on interactions - that would be portable across all applications. + The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the + currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to + ensure that extensibility components only rely on interactions that would be portable across all applications. isPreview: false isDeprecated: false type: class @@ -29,12 +24,11 @@ constructors: fullName: (constructor)(serviceScope) summary: >- Constructs a new instance of the - [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) - class. + [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) class. remarks: >- - Third parties should not call this constructor. Instead, use the - ApplicationAccessor instance from the component context, for example - [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer#context:member). isPreview: false isDeprecated: false @@ -44,22 +38,19 @@ constructors: - id: serviceScope description: '' type: '' -properties: +events: - name: navigatedEvent uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' package: '@microsoft/sp-application-base!' fullName: navigatedEvent - summary: >- - An event that is fired when the application's top-level page context - navigates to a new page. + summary: An event that is fired when the application's top-level page context navigates to a new page. remarks: >- - This event fires after the top-level - [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has + This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has navigated to a new page. isPreview: false isDeprecated: false syntax: - content: 'readonly navigatedEvent: SPEvent;' + content: 'get navigatedEvent(): SPEvent;' return: type: >- <- The component context for - [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). + [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `ApplicationCustomizerContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ApplicationCustomizerContext` class. isPreview: false isDeprecated: false type: class properties: - name: application - uid: >- - @microsoft/sp-application-base!ApplicationCustomizerContext#application:member + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' package: '@microsoft/sp-application-base!' fullName: application summary: Provides access to the client-side application that is currently running. @@ -25,12 +22,11 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly application: ApplicationAccessor;' + content: 'get application(): ApplicationAccessor;' return: type: '' - name: placeholderProvider - uid: >- - @microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' package: '@microsoft/sp-application-base!' fullName: placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. @@ -38,13 +34,12 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly placeholderProvider: PlaceholderProvider;' + content: 'get placeholderProvider(): PlaceholderProvider;' return: type: '' methods: - name: dispose() - uid: >- - @microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1) + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' package: '@microsoft/sp-application-base!' fullName: dispose() summary: '' diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index cc01eb91..dbe00dac 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -4,16 +4,14 @@ uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' package: '@microsoft/sp-application-base!' fullName: BaseApplicationCustomizer summary: >- - This is the base class that third parties should extend when implementing a - client-side extension that runs when an application is first starting. + This is the base class that third parties should extend when implementing a client-side extension that runs when an + application is first starting. remarks: >- - In the component manifest, the "extensionType" should be set to - "ApplicationCustomizer". + In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - Example usage scenarios for an application customizer might include: rendering - custom UI elements inside a SharePoint content placeholder, tracking page load - statistics, or automatically logging the user out after a certain time period. + Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint + content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. isPreview: false isDeprecated: false type: class @@ -37,10 +35,8 @@ methods: fullName: dispose() summary: Disposes the component. remarks: >- - Third-party code generally does not need to call this method; it's invoked - automatically when the lifecycle ends for a web part or extension. To - perform custom cleanup when your component is disposed, override the - method. + Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends + for a web part or extension. To perform custom cleanup when your component is disposed, override the method. isPreview: false isDeprecated: false syntax: @@ -49,20 +45,17 @@ methods: type: void description: '' - name: onPlaceholdersChanged(placeholderProvider) - uid: >- - @microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1) + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' package: '@microsoft/sp-application-base!' fullName: onPlaceholdersChanged(placeholderProvider) summary: >- - This event method is called when the placeholders of the host application - change, come into existence, or disappear. + This event method is called when the placeholders of the host application change, come into existence, or + disappear. virtual remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - protected onPlaceholdersChanged(placeholderProvider: - PlaceholderProvider): void; + content: 'protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;' parameters: - id: placeholderProvider description: '' @@ -70,6 +63,4 @@ methods: return: type: void description: '' -extends: >- - <TProperties> +extends: '<TProperties> ' diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index a487b9a1..3006b0a6 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-application-base!' fullName: IPlaceholderCreateContentOptions summary: >- Options for the - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) method. remarks: '' isPreview: false @@ -13,23 +13,17 @@ isDeprecated: false type: interface properties: - name: onDispose - uid: >- - @microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member + uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' package: '@microsoft/sp-application-base!' fullName: onDispose - summary: >- - An optional callback that will be invoked when the PlaceholderContent - object is disposed. + summary: An optional callback that will be invoked when the PlaceholderContent object is disposed. remarks: >- - To avoid a resource leak, use this callback to free any resources that - were allocated when the placeholder content was rendered. For example, if - ReactDOM.render() was used to mount a React component, then the onDispose - handler might call ReactDOM.unmountComponentAtNode() to unmount it. + To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content + was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler + might call ReactDOM.unmountComponentAtNode() to unmount it. isPreview: false isDeprecated: false syntax: content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' return: - type: >- - (placeholderContent: ) => void + type: '(placeholderContent: ) => void' diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 22425fb0..cecf4574 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -3,19 +3,15 @@ name: PlaceholderContent uid: '@microsoft/sp-application-base!PlaceholderContent:class' package: '@microsoft/sp-application-base!' fullName: PlaceholderContent -summary: >- - Represents custom content that is rendered inside a placeholder on a - SharePoint page. +summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. remarks: >- This object is returned by - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the - owner can render its custom content. + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `PlaceholderContent` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderContent` class. isPreview: false isDeprecated: false type: class @@ -24,20 +20,17 @@ properties: uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' package: '@microsoft/sp-application-base!' fullName: domElement - summary: >- - The Document Object Model (DOM) element where the owner should render its - custom content. + summary: The Document Object Model (DOM) element where the owner should render its custom content. remarks: >- - If the caller needs to be notified when the DOM element is disposed, use - the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) + If the caller needs to be notified when the DOM element is disposed, use the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback. isPreview: false isDeprecated: false syntax: - content: 'readonly domElement: HTMLDivElement;' + content: 'get domElement(): HTMLDivElement;' return: - type: '' + type: HTMLDivElement - name: isDisposed uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' package: '@microsoft/sp-application-base!' @@ -47,7 +40,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean - name: isVisible @@ -55,13 +48,13 @@ properties: package: '@microsoft/sp-application-base!' fullName: isVisible summary: >- - Return true if this PlacholderContent object is visible. If you create a - placeholder and the host page isn't displaying it, this will return false. + Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't + displaying it, this will return false. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly isVisible: boolean;' + content: 'get isVisible(): boolean;' return: type: boolean - name: name @@ -73,7 +66,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly name: PlaceholderName;' + content: 'get name(): PlaceholderName;' return: type: '' methods: @@ -81,16 +74,12 @@ methods: uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' package: '@microsoft/sp-application-base!' fullName: dispose() - summary: >- - Disposes the PlaceholderContent object and removes its attached DOM - element from the page. + summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. remarks: >- - This method can be called to immediately dispose the attached DOM element. - Otherwise, it will be disposed by the application when the containing - placeholder is disposed. Calling dispose() invokes the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member) - callback, removes the associated DOM element from the page, and disposes - the PlaceholderContent object. + This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the + application when the containing placeholder is disposed. Calling dispose() invokes the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) + callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index c057691d..8466d08c 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-application-base!PlaceholderName:enum' package: '@microsoft/sp-application-base!' fullName: PlaceholderName summary: >- - The identifier for a content placeholder, which is a region on the page where - third-party extensibility components can render custom content. + The identifier for a content placeholder, which is a region on the page where third-party extensibility components can + render custom content. remarks: >- For more information about placeholders, see - [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). + [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). isPreview: false isDeprecated: false fields: @@ -17,9 +16,9 @@ fields: uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' package: '@microsoft/sp-application-base!' summary: A region at the bottom of the page. - numericValue: 2 + value: '2' - name: Top uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' package: '@microsoft/sp-application-base!' summary: A region at the top of the page. - numericValue: 1 + value: '1' diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 3193fe1a..d241b436 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -4,53 +4,29 @@ uid: '@microsoft/sp-application-base!PlaceholderProvider:class' package: '@microsoft/sp-application-base!' fullName: PlaceholderProvider summary: >- - Allows third-party components to discover and use SharePoint placeholders. - Placeholders enable third-party components to render custom content into - designated regions on the page. + Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components + to render custom content into designated regions on the page. remarks: >- - Placeholders are designated regions on the page, identified by one of the - predefined - [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) - constants. Different applications and pages might support different - placeholder names. Placeholders can appear and disappear as the user interacts - with the page, for example via in-place navigation. Third-party components - should not assume that a given placeholder will always be available. + Placeholders are designated regions on the page, identified by one of the predefined + [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and + pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the + page, for example via in-place navigation. Third-party components should not assume that a given placeholder will + always be available. Use - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)) + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) to test whether a placeholder is available and add content to it. Use the - [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member) + [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider%23changedEvent:member) event to discover when new placeholders appear. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `PlaceholderProvider` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderProvider` class. isPreview: false isDeprecated: false type: class properties: - - name: changedEvent - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' - package: '@microsoft/sp-application-base!' - fullName: changedEvent - summary: >- - This event is raised when the list of currently available placeholders is - changed. - remarks: >- - The application can change its list of available placeholders at any time. - This means that the existing placeholders may get disposed or new - placeholders may be added. Use this event to discover new placeholders - when they appear. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly changedEvent: SPEvent;' - return: - type: >- - <> - name: isDisposed uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' package: '@microsoft/sp-application-base!' @@ -60,7 +36,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean - name: placeholderNames @@ -72,11 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly placeholderNames: ReadonlyArray;' + content: 'get placeholderNames(): ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' methods: - name: dispose() uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' @@ -92,41 +66,47 @@ methods: type: void description: '' - name: 'tryCreateContent(name, options)' - uid: >- - @microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1) + uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' package: '@microsoft/sp-application-base!' fullName: 'tryCreateContent(name, options)' summary: >- - Tests whether the page contains the specified placeholder. If so, a new - PlaceholderContent object is created, which allows the caller to render - custom content inside the placeholder. + Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, + which allows the caller to render custom content inside the placeholder. remarks: >- - The host application makes no guarantees about the availability of a given - placeholder. In situations where an expected placeholder is not available, - the third-party extension must handle it gracefully, e.g. by not rendering + The host application makes no guarantees about the availability of a given placeholder. In situations where an + expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. isPreview: false isDeprecated: false syntax: content: >- - tryCreateContent(name: PlaceholderName, options?: - IPlaceholderCreateContentOptions): PlaceholderContent | undefined; + tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | + undefined; parameters: - id: name description: The requested placeholder type: '' - id: options - description: >- - Additional options, for example to detect when the placeholder is - disposed. - type: >- - + description: 'Additional options, for example to detect when the placeholder is disposed.' + type: '' + return: + type: ' | undefined' + description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' +events: + - name: changedEvent + uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' + package: '@microsoft/sp-application-base!' + fullName: changedEvent + summary: This event is raised when the list of currently available placeholders is changed. + remarks: >- + The application can change its list of available placeholders at any time. This means that the existing + placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when + they appear. + isPreview: false + isDeprecated: false + syntax: + content: 'get changedEvent(): SPEvent;' return: type: >- - | - undefined - description: >- - A new PlaceholderContent object, or undefined if the requested - placeholder does not exist. + <> diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 2e9b0f0d..961901e9 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -12,11 +12,8 @@ classes: - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - '@microsoft/sp-component-base!ThemeProvider:class' interfaces: - - '@microsoft/sp-component-base!IFontStyles:interface' - - '@microsoft/sp-component-base!IPalette:interface' - - '@microsoft/sp-component-base!IRawStyle:interface' + - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - '@microsoft/sp-component-base!IReadonlyTheme:interface' - - '@microsoft/sp-component-base!ISemanticColors:interface' - - '@microsoft/sp-component-base!ISemanticTextColors:interface' + - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' - '@microsoft/sp-component-base!ITheme:interface' diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 9ba57911..100423f9 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -3,13 +3,10 @@ name: BaseComponent uid: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-component-base!' fullName: BaseComponent -summary: >- - The base class for client-side components such as BaseClientSideWebPart or - BaseExtension. +summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `BaseComponent` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponent` class. isPreview: false isDeprecated: false type: class @@ -18,55 +15,45 @@ properties: uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' package: '@microsoft/sp-component-base!' fullName: componentId - summary: >- - Returns the component identifier as defined in the component’s associated - manifest. + summary: Returns the component identifier as defined in the component’s associated manifest. remarks: >- - Each client-side component has an associated manifest that is used by the - sp-loader to load its scripts, and which may include additional metadata - about the component. The manifest is uniquely identified using a text - string containing a lower case GUID value. + Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which + may include additional metadata about the component. The manifest is uniquely identified using a text string + containing a lower case GUID value. isPreview: false isDeprecated: false syntax: - content: 'readonly componentId: string;' + content: 'get componentId(): string;' return: type: string - name: context uid: '@microsoft/sp-component-base!BaseComponent#context:member' package: '@microsoft/sp-component-base!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: false isDeprecated: false syntax: content: 'protected context: BaseComponentContext;' return: - type: >- - + type: '' - name: instanceId uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' package: '@microsoft/sp-component-base!' fullName: instanceId summary: A unique identifier for the instance of the component. remarks: >- - A component implementation can be loaded multiple times on the page. For - example, if the component is a charting web part, multiple instances of - this web part could be added to the SharePoint canvas. The instanceId - uniquely identifies each of these instances. + A component implementation can be loaded multiple times on the page. For example, if the component is a charting + web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely + identifies each of these instances. isPreview: false isDeprecated: false syntax: - content: 'readonly instanceId: string;' + content: 'get instanceId(): string;' return: type: string - name: isDisposed @@ -78,24 +65,21 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean - name: manifest uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' package: '@microsoft/sp-component-base!' fullName: manifest - summary: Provides access to the manifest for the client-side component. + summary: Provides access to the manifest for the client-side component. virtual remarks: Child classes can override this with more specialized manifest types. isPreview: false isDeprecated: false syntax: - content: 'readonly manifest: IClientSideComponentManifest;' + content: 'get manifest(): IClientSideComponentManifest;' return: - type: >- - + type: '' methods: - name: dispose() uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' @@ -103,11 +87,9 @@ methods: fullName: dispose() summary: Disposes the component. remarks: >- - Third-party code generally does not need to call this method; it's invoked - automatically when the lifecycle ends for a web part or extension. To - perform custom cleanup when your component is disposed, override the - [onDispose()](xref:@microsoft/sp-component-base!BaseComponent#onDispose:member(1)) - method. + Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends + for a web part or extension. To perform custom cleanup when your component is disposed, override the + [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. isPreview: false isDeprecated: false syntax: @@ -120,9 +102,8 @@ methods: package: '@microsoft/sp-component-base!' fullName: onDispose() summary: >- - This event method is called at the end of the component's lifecycle. It - provides an opportunity to release any associated resources, cancel any - outstanding requests, etc. + This event method is called at the end of the component's lifecycle. It provides an opportunity to release any + associated resources, cancel any outstanding requests, etc. virtual remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 2780b27e..7d1c69cb 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -5,53 +5,43 @@ package: '@microsoft/sp-component-base!' fullName: BaseComponentContext summary: The base class for context objects for client-side components. remarks: >- - A "context" object is a collection of well-known services and other objects - that are likely to be needed by business logic that interacts with a - associated component. Each component type has its own specialized subclass of - BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for - client-side extensions, and so on. + A "context" object is a collection of well-known services and other objects that are likely to be needed by business + logic that interacts with a associated component. Each component type has its own specialized subclass of + BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `BaseComponentContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponentContext` class. isPreview: false isDeprecated: false type: class properties: - name: aadHttpClientFactory - uid: >- - @microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member + uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' package: '@microsoft/sp-component-base!' fullName: aadHttpClientFactory - summary: >- - The instance of AadHttpClientFactory created for this instance of - component + summary: The instance of AadHttpClientFactory created for this instance of component remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly aadHttpClientFactory: AadHttpClientFactory;' + content: 'get aadHttpClientFactory(): AadHttpClientFactory;' return: type: '' - name: aadTokenProviderFactory - uid: >- - @microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member + uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' package: '@microsoft/sp-component-base!' fullName: aadTokenProviderFactory - summary: >- - The instance of AadTokenProviderFactory created for this instance of - component + summary: The instance of AadTokenProviderFactory created for this instance of component remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly aadTokenProviderFactory: AadTokenProviderFactory;' + content: 'get aadTokenProviderFactory(): AadTokenProviderFactory;' return: type: '' - name: dynamicDataProvider - uid: >- - @microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member + uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' package: '@microsoft/sp-component-base!' fullName: dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. @@ -59,12 +49,11 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly dynamicDataProvider: DynamicDataProvider;' + content: 'get dynamicDataProvider(): DynamicDataProvider;' return: type: '' - name: dynamicDataSourceManager - uid: >- - @microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member + uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' package: '@microsoft/sp-component-base!' fullName: dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. @@ -72,7 +61,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly dynamicDataSourceManager: DynamicDataSourceManager;' + content: 'get dynamicDataSourceManager(): DynamicDataSourceManager;' return: type: '' - name: httpClient @@ -84,7 +73,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly httpClient: HttpClient;' + content: 'get httpClient(): HttpClient;' return: type: '' - name: instanceId @@ -93,14 +82,13 @@ properties: fullName: instanceId summary: A unique identifier for the instance of the component. remarks: >- - A component implementation can be loaded multiple times on the page. For - example, if the component is a charting web part, multiple instances of - this web part could be added to the SharePoint canvas. The instanceId - uniquely identifies each of these instances. + A component implementation can be loaded multiple times on the page. For example, if the component is a charting + web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely + identifies each of these instances. isPreview: false isDeprecated: false syntax: - content: 'readonly instanceId: string;' + content: 'get instanceId(): string;' return: type: string - name: isDisposed @@ -112,7 +100,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean - name: manifest @@ -126,23 +114,17 @@ properties: syntax: content: 'readonly manifest: IClientSideComponentManifest;' return: - type: >- - + type: '' - name: msGraphClientFactory - uid: >- - @microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member + uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' package: '@microsoft/sp-component-base!' fullName: msGraphClientFactory - summary: >- - The instance of MSGraphClientFactory created for this instance of - component + summary: The instance of MSGraphClientFactory created for this instance of component remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly msGraphClientFactory: MSGraphClientFactory;' + content: 'get msGraphClientFactory(): MSGraphClientFactory;' return: type: '' - name: pageContext @@ -150,29 +132,25 @@ properties: package: '@microsoft/sp-component-base!' fullName: pageContext summary: >- - The page context provides standard definitions for common SharePoint - objects that need to be shared between the client-side application, web - parts, and other components. + The page context provides standard definitions for common SharePoint objects that need to be shared between the + client-side application, web parts, and other components. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly pageContext: PageContext;' + content: 'get pageContext(): PageContext;' return: type: '' - name: serviceScope uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' package: '@microsoft/sp-component-base!' fullName: serviceScope - summary: >- - The associated - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for - this component. + summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. isPreview: false isDeprecated: false syntax: - content: 'readonly serviceScope: ServiceScope;' + content: 'get serviceScope(): ServiceScope;' return: type: '' - name: spHttpClient @@ -184,7 +162,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly spHttpClient: SPHttpClient;' + content: 'get spHttpClient(): SPHttpClient;' return: type: '' methods: diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index f6501ed9..58b01f86 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-component-base!DynamicDataProvider:class' package: '@microsoft/sp-component-base!' fullName: DynamicDataProvider summary: >- - The Dynamic Data Provider allows components to consume Dynamic Data. It allows - components to request Dynamic Data sources and register/unregister to those. + The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data + sources and register/unregister to those. remarks: '' isPreview: false isDeprecated: false @@ -20,7 +20,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean methods: @@ -38,8 +38,7 @@ methods: type: void description: '' - name: getAvailableSources() - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' package: '@microsoft/sp-component-base!' fullName: getAvailableSources() summary: Returns a list with all available Dynamic Data Sources. @@ -49,18 +48,13 @@ methods: syntax: content: 'getAvailableSources(): ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' description: Read-only array with all available sources. - name: registerAvailableSourcesChanged(callback) - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: registerAvailableSourcesChanged(callback) - summary: >- - Registers a callback to an event that raises when the list of available - Dynamic Data Sources is updated. + summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' isPreview: false isDeprecated: false @@ -74,20 +68,15 @@ methods: type: void description: '' - name: 'registerPropertyChanged(sourceId, propertyId, callback)' - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' - summary: >- - Registers a callback for updates when a property is changed in a Dynamic - Data source. + summary: Registers a callback for updates when a property is changed in a Dynamic Data source. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - registerPropertyChanged(sourceId: string, propertyId: string, callback: - () => void): void; + content: 'registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' parameters: - id: sourceId description: Id of the Dynamic Data Source. @@ -102,13 +91,12 @@ methods: type: void description: '' - name: 'registerSourceChanged(sourceId, callback)' - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: 'registerSourceChanged(sourceId, callback)' summary: >- - Registers a callback for updates when a Dynamic Data source is changed. - This happens when any property is updated within the source. + Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated + within the source. remarks: '' isPreview: false isDeprecated: false @@ -128,9 +116,7 @@ methods: uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' package: '@microsoft/sp-component-base!' fullName: tryGetSource(id) - summary: >- - Returns a Dynamic Data Source, by its id. If the source is not present, it - returns undefined. + summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' remarks: '' isPreview: false isDeprecated: false @@ -141,18 +127,13 @@ methods: description: Id of the Dynamic Data Source. type: string return: - type: >- - - | undefined + type: ' | undefined' description: '' - name: unregisterAvailableSourcesChanged(callback) - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: unregisterAvailableSourcesChanged(callback) - summary: >- - Unregisters a callback to an event that raises when the list of available - Dynamic Data Sources is updated. + summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' isPreview: false isDeprecated: false @@ -160,28 +141,21 @@ methods: content: 'unregisterAvailableSourcesChanged(callback: () => void): void;' parameters: - id: callback - description: >- - Function to remove from the registration. Must be the same it was - registered with. + description: Function to remove from the registration. Must be the same it was registered with. type: () => void return: type: void description: '' - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - summary: >- - Unregisters a callback for updates when a property is changed in a Dynamic - Data source. + summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - unregisterPropertyChanged(sourceId: string, propertyId: string, - callback: () => void): void; + content: 'unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' parameters: - id: sourceId description: Id of the Dynamic Data Source. @@ -190,16 +164,13 @@ methods: description: Id of the property of the source. type: string - id: callback - description: >- - Function to remove from the registration. Must be the same it was - registered with. + description: Function to remove from the registration. Must be the same it was registered with. type: () => void return: type: void description: '' - name: 'unregisterSourceChanged(sourceId, callback)' - uid: >- - @microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: 'unregisterSourceChanged(sourceId, callback)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. @@ -213,9 +184,7 @@ methods: description: Id of the Dynamic Data Source. type: string - id: callback - description: >- - Function to remove from the registration. Must be the same it was - registered with. + description: Function to remove from the registration. Must be the same it was registered with. type: () => void return: type: void diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 9cf1a85b..eed48b9e 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -4,10 +4,9 @@ uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' package: '@microsoft/sp-component-base!' fullName: DynamicDataSourceManager summary: >- - The Dynamic Data Source Manager is responsible for: - Constructing the dynamic - data source - Allowing initialization of the dynamic data source by a - component - Allowing data source to update its metadata and notify when data - has been updated. + The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization + of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been + updated. remarks: '' isPreview: false isDeprecated: false @@ -22,7 +21,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean - name: sourceId @@ -30,13 +29,13 @@ properties: package: '@microsoft/sp-component-base!' fullName: sourceId summary: >- - Returns the Id of the current DataSource. If the component did not - initialize as a dynamic data source, then it returns an empty string. + Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it + returns an empty string. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly sourceId: string;' + content: 'get sourceId(): string;' return: type: string methods: @@ -54,8 +53,7 @@ methods: type: void description: '' - name: initializeSource(callableFunctions) - uid: >- - @microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' package: '@microsoft/sp-component-base!' fullName: initializeSource(callableFunctions) summary: Initializes the Dynamic Data Source for the component. @@ -67,23 +65,20 @@ methods: parameters: - id: callableFunctions description: Set of methods that are exposed through the Dynamic Data Source - type: >- - + type: '' return: type: void description: '' - name: notifyPropertyChanged(propertyId) - uid: >- - @microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: notifyPropertyChanged(propertyId) summary: >- Notifies that this source has updated a specific property. - When invoked, it enables to broadcast the notification to all the - consumers who have registered to this notification from this source. + When invoked, it enables to broadcast the notification to all the consumers who have registered to this + notification from this source. remarks: '' isPreview: false isDeprecated: false @@ -97,16 +92,15 @@ methods: type: void description: '' - name: notifySourceChanged() - uid: >- - @microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' package: '@microsoft/sp-component-base!' fullName: notifySourceChanged() summary: >- Notifies that this source has updated its properties. - When invoked, it enables to broadcast the notification to all the - consumers who have registered to this notification from this source. + When invoked, it enables to broadcast the notification to all the consumers who have registered to this + notification from this source. remarks: '' isPreview: false isDeprecated: false @@ -116,14 +110,12 @@ methods: type: void description: '' - name: updateMetadata(metadata) - uid: >- - @microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' package: '@microsoft/sp-component-base!' fullName: updateMetadata(metadata) summary: >- - Updates the metadata of the Dynamic Data Source. It allows to update - fields like title or description. Auto-generated fields like alias, - componentId or instanceId cannot be updated. + Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. + Auto-generated fields like alias, componentId or instanceId cannot be updated. remarks: '' isPreview: false isDeprecated: false @@ -132,10 +124,7 @@ methods: parameters: - id: metadata description: Partial of the metadata. - type: >- - <> + type: 'Partial<>' return: type: void description: '' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 36840116..0090cbd6 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -5,10 +5,9 @@ package: '@microsoft/sp-component-base!' fullName: DynamicProperty summary: Serializable object that simplifies usage of a DynamicProperty. remarks: >- - This is built for usage in web part properties, and modified through the - property pane. Can be initialized with a default callback. Web parts - initialize with the render method so if the 3rd party developer does nothing, - a change in the DynamicProperty will re-render the web part automatically. + This is built for usage in web part properties, and modified through the property pane. Can be initialized with a + default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in + the DynamicProperty will re-render the web part automatically. isPreview: false isDeprecated: false type: class @@ -28,9 +27,7 @@ constructors: description: DynamicDataProvider. type: '' - id: callback - description: >- - Optional. Default callback to be registered for updates in the - DynamicDataSource. + description: Optional. Default callback to be registered for updates in the DynamicDataSource. type: () => void properties: - name: isDisposed @@ -38,15 +35,13 @@ properties: package: '@microsoft/sp-component-base!' fullName: isDisposed summary: >- - Returns true if the dispose() method has been called. Once an object is - disposed, it remains in this state permanently. - remarks: >- - After the object has been disposed, do not call its methods or access its - properties. + Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state + permanently. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' isPreview: false isDeprecated: false syntax: - content: 'readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: boolean - name: reference @@ -54,13 +49,13 @@ properties: package: '@microsoft/sp-component-base!' fullName: reference summary: >- - DynamicDataReference string that the DynamicProperty object points to. The - reference is of the form `::`. + DynamicDataReference string that the DynamicProperty object points to. The reference is of the form + `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' isPreview: false isDeprecated: false syntax: - content: 'readonly reference: string | undefined;' + content: 'get reference(): string | undefined;' return: type: string | undefined methods: @@ -69,9 +64,7 @@ methods: package: '@microsoft/sp-component-base!' fullName: dispose() summary: This method is called to permanently dispose the object. - remarks: >- - After the object has been disposed, do not call its methods or access its - properties. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' isPreview: false isDeprecated: false syntax: @@ -96,9 +89,7 @@ methods: uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' package: '@microsoft/sp-component-base!' fullName: register(callback) - summary: >- - Registers a callback function for updates on the associated - DynamicDataSource. + summary: Registers a callback function for updates on the associated DynamicDataSource. remarks: '' isPreview: false isDeprecated: false @@ -112,14 +103,11 @@ methods: type: void description: '' - name: removeDefaultCallback() - uid: >- - @microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1) + uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' package: '@microsoft/sp-component-base!' fullName: removeDefaultCallback() summary: Removes the registration for the default callback. - remarks: >- - This can be useful for advanced users who only want their custom - callbacks. + remarks: This can be useful for advanced users who only want their custom callbacks. isPreview: false isDeprecated: false syntax: @@ -132,9 +120,8 @@ methods: package: '@microsoft/sp-component-base!' fullName: setReference(reference) summary: >- - Sets the value of the DynamicProperty to be a reference to a - DynamicDynamicSource and property. The reference is of the form - `::`. + Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is + of the form `::`. remarks: '' isPreview: false isDeprecated: false @@ -169,17 +156,15 @@ methods: package: '@microsoft/sp-component-base!' fullName: tryGetSource() summary: >- - Returns the DynamicDataSource that the DynamicProperty object refers to. - Returns undefined if the source doesn't exist. + Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't + exist. remarks: '' isPreview: false isDeprecated: false syntax: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: - type: >- - - | undefined + type: ' | undefined' description: '' - name: tryGetValue() uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' @@ -187,55 +172,46 @@ methods: fullName: tryGetValue() summary: Returns the value of the object. remarks: >- - If the value is an array, then the first element of the array is returned; - otherwise, the value itself is returned. + If the value is an array, then the first element of the array is returned; otherwise, the value itself is + returned. - NOTE: This api will never return an array. To retrieve an array value, use - the - [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)) - API. + NOTE: This api will never return an array. To retrieve an array value, use the + [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. isPreview: false isDeprecated: false syntax: content: 'tryGetValue(): TValue | undefined;' return: type: TValue | undefined - description: >- - the value associated with the dynamic property or undefined if the - source or the data doesn't exist. + description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. - name: tryGetValues() uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' package: '@microsoft/sp-component-base!' fullName: tryGetValues() summary: Returns the value of the object. remarks: >- - If the value is NOT an array, then an array is returned with the value - being the single entry; otherwise, the value itself is returned. If the - property is undefined or cannot be found, an empty array will be returned. + If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the + value itself is returned. If the property is undefined or cannot be found, an empty array will be returned. - NOTE: This api will always return an array and it assumes that the array - is homogeneous. To retrieve a non-array value, use the - [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)) - API. + NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array + value, use the + [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. isPreview: false isDeprecated: false syntax: content: 'tryGetValues(): TValue[];' return: type: 'TValue[]' - description: >- - the value associated with the dynamic property or an empty array if - the source or the data doesn't exist. + description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - name: unregister(callback) uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' package: '@microsoft/sp-component-base!' fullName: unregister(callback) summary: >- - Unregisters a callback function for updates on the associated - DynamicDataSource. The callback function must be the same it was - registered with. + Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the + same it was registered with. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml new file mode 100644 index 00000000..456ec3ed --- /dev/null +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: IComponentPropertyMetadata +uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' +package: '@microsoft/sp-component-base!' +fullName: IComponentPropertyMetadata +summary: This is the structure used for map values for component properties metadata. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isHtmlString + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isHtmlString:member' + package: '@microsoft/sp-component-base!' + fullName: isHtmlString + summary: Indicates whether the property should be serialized as HTML. + remarks: >- + This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on + it: + + + - normalizing HTML encodings + + + - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) + + + - search indexing + + + - SharePoint link fix-up + + + Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, + SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply + needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. + isPreview: false + isDeprecated: false + syntax: + content: 'isHtmlString?: boolean;' + return: + type: boolean + - name: isImageSource + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isImageSource:member' + package: '@microsoft/sp-component-base!' + fullName: isImageSource + summary: >- + Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform + services like link fix-up, search indexing, loading from CDN, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isImageSource?: boolean;' + return: + type: boolean + - name: isLink + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isLink:member' + package: '@microsoft/sp-component-base!' + fullName: isLink + summary: >- + Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform + services like search indexing, link fix-up, loading from CDN, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isLink?: boolean;' + return: + type: boolean + - name: isSearchablePlainText + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isSearchablePlainText:member' + package: '@microsoft/sp-component-base!' + fullName: isSearchablePlainText + summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. + remarks: >- + This flag instructs the framework to store the property in a representation that supports search indexing. The + content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML + characters may be stored encoded and appear in search results. If your string contains HTML markup, use the + isHtmlString setting instead. + + + Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. + isPreview: false + isDeprecated: false + syntax: + content: 'isSearchablePlainText?: boolean;' + return: + type: boolean + - name: shouldNotPersist + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#shouldNotPersist:member' + package: '@microsoft/sp-component-base!' + fullName: shouldNotPersist + summary: Indicates if the framework should persist the property on the server. + remarks: >- + Use this for properties that are only important in run-time, and do not need to persist on the server. This can + reduce the size of the serialized data of the component and optimize the component load time. The property value + will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. + The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared + from the run-time property bag. The initial render of your component should not depend on the value of the + property. Setting a default value for the property can be done in `onInit()` method. + + + Note that if the property path refers to a property that has a complex object as the value, the whole object will + be removed from the persisted data. + isPreview: false + isDeprecated: false + syntax: + content: 'shouldNotPersist?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 66c306f8..0ab1c860 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -3,141 +3,9 @@ name: IReadonlyFontStyles uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' package: '@microsoft/sp-component-base!' fullName: IReadonlyFontStyles -summary: Font styles for different sizes. +summary: '' remarks: '' isPreview: false isDeprecated: false type: interface -properties: - - name: large - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#large:member' - package: '@microsoft/sp-component-base!' - fullName: large - summary: Large font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'large: IReadonlyRawStyle;' - return: - type: '' - - name: medium - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#medium:member' - package: '@microsoft/sp-component-base!' - fullName: medium - summary: Medium font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'medium: IReadonlyRawStyle;' - return: - type: '' - - name: mediumPlus - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member' - package: '@microsoft/sp-component-base!' - fullName: mediumPlus - summary: Larger than medium but smaller than large font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'mediumPlus: IReadonlyRawStyle;' - return: - type: '' - - name: mega - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#mega:member' - package: '@microsoft/sp-component-base!' - fullName: mega - summary: Mega sized font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'mega: IReadonlyRawStyle;' - return: - type: '' - - name: small - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#small:member' - package: '@microsoft/sp-component-base!' - fullName: small - summary: Small font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'small: IReadonlyRawStyle;' - return: - type: '' - - name: smallPlus - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member' - package: '@microsoft/sp-component-base!' - fullName: smallPlus - summary: Larger than small but smaller than medium font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'smallPlus: IReadonlyRawStyle;' - return: - type: '' - - name: superLarge - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member' - package: '@microsoft/sp-component-base!' - fullName: superLarge - summary: Super large font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'superLarge: IReadonlyRawStyle;' - return: - type: '' - - name: tiny - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member' - package: '@microsoft/sp-component-base!' - fullName: tiny - summary: Tiny font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tiny: IReadonlyRawStyle;' - return: - type: '' - - name: xLarge - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member' - package: '@microsoft/sp-component-base!' - fullName: xLarge - summary: Extra large font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'xLarge: IReadonlyRawStyle;' - return: - type: '' - - name: xSmall - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member' - package: '@microsoft/sp-component-base!' - fullName: xSmall - summary: Extra small font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'xSmall: IReadonlyRawStyle;' - return: - type: '' - - name: xxLarge - uid: '@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member' - package: '@microsoft/sp-component-base!' - fullName: xxLarge - summary: Extra extra large font style. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'xxLarge: IReadonlyRawStyle;' - return: - type: '' +extends: 'Readonly<> ' diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 77aae7af..a3245568 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -8,50 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -properties: - - name: fonts - uid: '@microsoft/sp-component-base!IReadonlyTheme#fonts:member' - package: '@microsoft/sp-component-base!' - fullName: fonts - summary: Font styles for different sizes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly fonts: Readonly;' - return: - type: >- - <> - - name: palette - uid: '@microsoft/sp-component-base!IReadonlyTheme#palette:member' - package: '@microsoft/sp-component-base!' - fullName: palette - summary: Color palette. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly palette: Readonly;' - return: - type: >- - <> - - name: semanticColors - uid: '@microsoft/sp-component-base!IReadonlyTheme#semanticColors:member' - package: '@microsoft/sp-component-base!' - fullName: semanticColors - summary: The collection of all semantic slots for colors used in themes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly semanticColors: Readonly;' - return: - type: >- - <> -extends: >- - <> +extends: 'Readonly<> ' diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml new file mode 100644 index 00000000..ff3e9585 --- /dev/null +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -0,0 +1,133 @@ +### YamlMime:TSType +name: ISerializedServerProcessedData +uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' +package: '@microsoft/sp-component-base!' +fullName: ISerializedServerProcessedData +summary: Contains collections of data that can be processed by server side services like search index and link fixup +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: htmlStrings + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#htmlStrings:member' + package: '@microsoft/sp-component-base!' + fullName: htmlStrings + summary: A key-value map where keys are string identifiers and values are rich text with HTML format. + remarks: >- + SharePoint servers treat the values as HTML content and run services like safety checks, search index and link + fixup on them. + + + Example: + + + ``` + + { + 'myRichDescription': '
Some standard HTML contentA Link
' + 'anotherRichText':
Some red text
+ } + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + htmlStrings?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: imageSources + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#imageSources:member' + package: '@microsoft/sp-component-base!' + fullName: imageSources + summary: A key-value map where keys are string identifiers and values are image sources. + remarks: |- + SharePoint servers treat the values as image sources and run services like search index and link fixup on them. + + Example: + + ``` + { + 'myImage1': 'http://res.contoso.com/path/to/file' + 'myImage2': 'https://res.contoso.com/someName.jpg' + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + imageSources?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: links + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#links:member' + package: '@microsoft/sp-component-base!' + fullName: links + summary: A key-value map where keys are string identifiers and values are links. + remarks: |- + SharePoint servers treat the values as links and run services like link fixup on them. + + Example: + + ``` + { + 'myWebURL': 'http://contoso.com' + 'myFileLink': 'https://res.contoso.com/file.docx' + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + links?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: searchablePlainTexts + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#searchablePlainTexts:member' + package: '@microsoft/sp-component-base!' + fullName: searchablePlainTexts + summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. + remarks: >- + The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, + but are not treated as valid HTML. So, other services such as link fixup will not run on them. + + + Example: + + + ``` + + { + 'justSomeText': 'This is some plain text', + 'anotherText': 'Can have characters here: "<>&\'' + } + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + searchablePlainTexts?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index d2f3e7de..ca938cfb 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -3,74 +3,9 @@ name: ITheme uid: '@microsoft/sp-component-base!ITheme:interface' package: '@microsoft/sp-component-base!' fullName: ITheme -summary: >- - Collection of theme values, which can be used to programatically style - components. +summary: 'Collection of theme values, which can be used to programatically style components.' remarks: '' isPreview: false isDeprecated: false type: interface -properties: - - name: disableGlobalClassNames - uid: '@microsoft/sp-component-base!ITheme#disableGlobalClassNames:member' - package: '@microsoft/sp-component-base!' - fullName: disableGlobalClassNames - summary: >- - Disables global styles on Fabric components. This will prevent global - overrides that might have been set by other Fabric users from applying to - your components. - remarks: This has a vary narrow use case and most likely should be avoided. - isPreview: false - isDeprecated: false - syntax: - content: 'disableGlobalClassNames: boolean;' - return: - type: boolean - - name: fonts - uid: '@microsoft/sp-component-base!ITheme#fonts:member' - package: '@microsoft/sp-component-base!' - fullName: fonts - summary: Font styles for different sizes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'fonts: IFontStyles;' - return: - type: '' - - name: isInverted - uid: '@microsoft/sp-component-base!ITheme#isInverted:member' - package: '@microsoft/sp-component-base!' - fullName: isInverted - summary: Indicates whether the theme is inverted. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isInverted: boolean;' - return: - type: boolean - - name: palette - uid: '@microsoft/sp-component-base!ITheme#palette:member' - package: '@microsoft/sp-component-base!' - fullName: palette - summary: Color palette. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'palette: IPalette;' - return: - type: '' - - name: semanticColors - uid: '@microsoft/sp-component-base!ITheme#semanticColors:member' - package: '@microsoft/sp-component-base!' - fullName: semanticColors - summary: The collection of all semantic slots for colors used in themes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'semanticColors: ISemanticColors;' - return: - type: '' +extends: '' diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index 7bdf6288..7e4bd9ce 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -20,7 +20,5 @@ properties: syntax: content: 'readonly theme: ITheme | undefined;' return: - type: >- - | - undefined + type: ' | undefined' extends: '' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index c03d1b08..45e6cefc 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-component-base!ThemeProvider:class' package: '@microsoft/sp-component-base!' fullName: ThemeProvider summary: >- - The ThemeProvider class provides the capability to get different themes from - the Framework. Themes can be provided in different contexts, e.g. Canvas - sections may provide a variant of the global theme in some contexts. + The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in + different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. remarks: '' isPreview: false isDeprecated: false @@ -44,6 +43,21 @@ properties: type: >- <> +methods: + - name: tryGetTheme() + uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetTheme() + summary: 'If set, get the current scoped theme.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetTheme(): IReadonlyTheme | undefined;' + return: + type: ' | undefined' + description: '' +events: - name: themeChangedEvent uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' package: '@microsoft/sp-component-base!' @@ -58,19 +72,3 @@ properties: type: >- <> -methods: - - name: tryGetTheme() - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetTheme() - summary: 'If set, get the current scoped theme.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetTheme(): IReadonlyTheme | undefined;' - return: - type: >- - | - undefined - description: '' diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index 5342ee51..1a5d9b92 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -16,7 +16,7 @@ classes: - '@microsoft/sp-core-library!Session:class' - '@microsoft/sp-core-library!SPEvent:class' - '@microsoft/sp-core-library!SPEventArgs:class' - - '@microsoft/sp-core-library!Text:class' + - '@microsoft/sp-core-library!Text_2:class' - '@microsoft/sp-core-library!TimeProvider:class' - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - '@microsoft/sp-core-library!Validate:class' diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index f6cf6b61..c60d40c6 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -3,9 +3,7 @@ name: DisplayMode uid: '@microsoft/sp-core-library!DisplayMode:enum' package: '@microsoft/sp-core-library!' fullName: DisplayMode -summary: >- - Indicates whether a visual control should display itself for reading or for - editing. +summary: Indicates whether a visual control should display itself for reading or for editing. remarks: '' isPreview: false isDeprecated: false @@ -14,15 +12,13 @@ fields: uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' package: '@microsoft/sp-core-library!' summary: >- - The page, control, or editing surface is in a mode intended for authoring - new content. It may display editing panels or other controls that are not - part of the normal reading experience. - numericValue: 2 + The page, control, or editing surface is in a mode intended for authoring new content. It may display editing + panels or other controls that are not part of the normal reading experience. + value: '2' - name: Read uid: '@microsoft/sp-core-library!DisplayMode.Read:member' package: '@microsoft/sp-core-library!' summary: >- - The page, control, or editing surface is in a mode intended for reading. - It may have some interactive features, but the authoring controls are not - enabled. - numericValue: 1 + The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, + but the authoring controls are not enabled. + value: '1' diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index b9e16e31..e757e9a2 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -3,9 +3,7 @@ name: Environment uid: '@microsoft/sp-core-library!Environment:class' package: '@microsoft/sp-core-library!' fullName: Environment -summary: >- - Information about the system environment where the SharePoint Framework is - running. +summary: Information about the system environment where the SharePoint Framework is running. remarks: '' isPreview: false isDeprecated: false @@ -15,13 +13,11 @@ properties: uid: '@microsoft/sp-core-library!Environment.type:member' package: '@microsoft/sp-core-library!' fullName: type - summary: >- - Indicates the general type of environment where the SharePoint Framework - is running. + summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'static readonly type: EnvironmentType;' + content: 'static get type(): EnvironmentType;' return: type: '' diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 31993afe..e938cddd 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -3,14 +3,10 @@ name: EnvironmentType uid: '@microsoft/sp-core-library!EnvironmentType:enum' package: '@microsoft/sp-core-library!' fullName: EnvironmentType -summary: >- - Indicates the general type of environment where the SharePoint Framework is - running. +summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: >- - This enum is used by the - [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) - property. It provides a way to distinguish environments where certain - functionality may be limited or disabled. + This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It + provides a way to distinguish environments where certain functionality may be limited or disabled. isPreview: false isDeprecated: false fields: @@ -18,33 +14,29 @@ fields: uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' package: '@microsoft/sp-core-library!' summary: >- - Indicates that the framework was hosted by a classic server-rendered - SharePoint page. Some functionality may be limited, e.g. various - extensibility APIs may not be supported. - numericValue: 3 + Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be + limited, e.g. various extensibility APIs may not be supported. + value: '3' - name: Local uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' package: '@microsoft/sp-core-library!' summary: >- - Indicates that the SharePoint Framework is running on a page from a - "localhost" web server, for example the SharePoint Workbench when hosted - via "gulp serve". SharePoint REST API calls will not be available, and in - general network access may not authenticate properly. Certain page context - information may be using mock values for testing. - numericValue: 1 + Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the + SharePoint Workbench when hosted via "gulp serve". SharePoint REST API calls will not be available, and in general + network access may not authenticate properly. Certain page context information may be using mock values for + testing. + value: '1' - name: SharePoint uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' package: '@microsoft/sp-core-library!' summary: >- - Indicates that the SharePoint Framework is running on a modern SharePoint - web page, with full framework functionality. This is the normal usage - scenario. - numericValue: 2 + Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework + functionality. This is the normal usage scenario. + value: '2' - name: Test uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' package: '@microsoft/sp-core-library!' summary: >- - Indicates that the SharePoint Framework is running inside a test harness, - e.g. a unit test. There may be no user interaction at all, and network - access in general may be disabled. - numericValue: 0 + Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user + interaction at all, and network access in general may be disabled. + value: '0' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 5c3489a1..9d56417a 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -3,15 +3,11 @@ name: Guid uid: '@microsoft/sp-core-library!Guid:class' package: '@microsoft/sp-core-library!' fullName: Guid -summary: >- - This class represents a globally unique identifier, as described by IETF RFC - 4122. +summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' remarks: >- - The input string is normalized and validated, which provides important - guarantees that simplify other code that works with the GUID. This class also - provides basic support for generating a pseudo-random GUID; however, be aware - that the uniqueness depends on the browser's `Math.random()` function and may - be not be suitable for some applications. + The input string is normalized and validated, which provides important guarantees that simplify other code that works + with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the + uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications. See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. @@ -48,17 +44,14 @@ methods: type: '' return: type: boolean - description: >- - True if this instance and the specified Guid object represent the same - value. + description: True if this instance and the specified Guid object represent the same value. - name: isValid(guid) uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' package: '@microsoft/sp-core-library!' fullName: isValid(guid) summary: >- - Indicates whether a GUID is valid, i.e. whether it would be successfully - parsed by `Guid.tryParse()`. This function is cheaper than - `Guid.tryParse()` because it does not construct a Guid object. + Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This + function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. remarks: '' isPreview: false isDeprecated: false @@ -76,8 +69,8 @@ methods: package: '@microsoft/sp-core-library!' fullName: newGuid(randomNumberGenerator) summary: >- - Returns a new Guid instance with a pseudo-randomly generated GUID, - according to the version 4 UUID algorithm from RFC 4122. + Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from + RFC 4122. remarks: '' isPreview: false isDeprecated: false @@ -86,9 +79,7 @@ methods: parameters: - id: randomNumberGenerator description: '' - type: >- - + type: '' return: type: '' description: A new unique Guid object @@ -96,9 +87,7 @@ methods: uid: '@microsoft/sp-core-library!Guid.parse:member(1)' package: '@microsoft/sp-core-library!' fullName: parse(guidString) - summary: >- - Parses the input string to construct a new Guid object. If the string - cannot be parsed, then an error is thrown. + summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' remarks: |- Example syntaxes accepted by this function: @@ -141,8 +130,8 @@ methods: package: '@microsoft/sp-core-library!' fullName: tryParse(guid) summary: >- - Attempts to parse the input string to construct a new Guid object. If the - string cannot be parsed, then undefined is returned. + Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined + is returned. remarks: |- Example syntaxes accepted by this function: diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 33dbb983..7081768a 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -4,9 +4,7 @@ uid: '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-core-library!' fullName: IDisposable summary: Implemented by an object that supports a disposal lifecycle. -remarks: >- - The dispose event allows an object to free any resources that it allocated - before its lifecycle ends. +remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. isPreview: false isDeprecated: false type: interface @@ -16,11 +14,9 @@ properties: package: '@microsoft/sp-core-library!' fullName: isDisposed summary: >- - Returns true if the dispose() method has been called. Once an object is - disposed, it remains in this state permanently. - remarks: >- - After the object has been disposed, do not call its methods or access its - properties. + Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state + permanently. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' isPreview: false isDeprecated: false syntax: @@ -33,9 +29,7 @@ methods: package: '@microsoft/sp-core-library!' fullName: dispose() summary: This method is called to permanently dispose the object. - remarks: >- - After the object has been disposed, do not call its methods or access its - properties. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index ec8652c1..2ea40fba 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -4,16 +4,14 @@ uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' package: '@microsoft/sp-core-library!' fullName: IRandomNumberGenerator summary: >- - This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) - contract for generating pseudorandom random numbers. + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom + random numbers. remarks: >- - This interface abstracts the functionality of the system Math.random() API for - usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). - For example, a unit test might replace the default - [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) - service with a mock implementation that always returns the same sequence of - random numbers, in order to ensure that test failures are always repeatable. + This interface abstracts the functionality of the system Math.random() API for usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the + default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock + implementation that always returns the same sequence of random numbers, in order to ensure that test failures are + always repeatable. isPreview: false isDeprecated: false type: interface @@ -22,9 +20,7 @@ methods: uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' package: '@microsoft/sp-core-library!' fullName: generate() - summary: >- - Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), - following the contract of Math.random(). + summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index 9dec7676..eaa443f7 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -8,8 +8,8 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This pattern has been superceded by the BaseComponentContext pattern. This - interface will be removed in a future release. + This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future + release. type: interface properties: - name: serviceScope diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index c4ceec8d..5ee221e0 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -4,15 +4,13 @@ uid: '@microsoft/sp-core-library!ISPEventObserver:interface' package: '@microsoft/sp-core-library!' fullName: ISPEventObserver summary: >- - Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, - this interface is implemented by components that can subscribe to events. + Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by + components that can subscribe to events. remarks: >- - ISPEventObserver is an abstraction of the key features that a component must - have in order to subscribe to a SharePoint Framework event: It must have - instanceId and componentId information for diagnostics reporting, and it must - have a way to notify the event system when the component is disposed, so that - its handlers can be automatically removed. Other objects may implement this - contract, as long as they meet these requirements. + ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a + SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must + have a way to notify the event system when the component is disposed, so that its handlers can be automatically + removed. Other objects may implement this contract, as long as they meet these requirements. isPreview: false isDeprecated: false type: interface @@ -22,9 +20,7 @@ properties: package: '@microsoft/sp-core-library!' fullName: componentId summary: 'The component identifier, from the component''s manifest.' - remarks: >- - This will be used for diagnostic reporting, e.g. if the callback function - has an uncaught exception + remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' isPreview: false isDeprecated: false syntax: @@ -36,9 +32,7 @@ properties: package: '@microsoft/sp-core-library!' fullName: instanceId summary: The instance identifier for the component. - remarks: >- - This will be used for diagnostic reporting, e.g. if the callback function - has an uncaught exception + remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 376f8a98..89e6a424 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -3,16 +3,12 @@ name: ITimeProvider uid: '@microsoft/sp-core-library!ITimeProvider:interface' package: '@microsoft/sp-core-library!' fullName: ITimeProvider -summary: >- - This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) - contract for reading the system clock. +summary: 'This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system clock.' remarks: >- - This interface abstracts the functionality of the system time APIs for usage - with a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the default - [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service - with a mock implementation that follows a manually incremented timeline, in - order to ensure that test failures are always repeatable. + This interface abstracts the functionality of the system time APIs for usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the + default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that + follows a manually incremented timeline, in order to ensure that test failures are always repeatable. isPreview: false isDeprecated: false type: interface @@ -28,15 +24,13 @@ methods: syntax: content: 'getDate(): Date;' return: - type: '' + type: Date description: '' - name: getTimestamp() uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' package: '@microsoft/sp-core-library!' fullName: getTimestamp() - summary: >- - Returns a DOMHighResTimeStamp timing measurement, as defined by the - standard performance.now() API. + summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index f0a0c4f0..68641d66 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -5,11 +5,9 @@ package: '@microsoft/sp-core-library!' fullName: Log summary: A basic redirectable logging system. remarks: >- - The Log class provides static methods for logging messages at different levels - (verbose, info, warning, error) and with context information. Context - information helps identify which component generated the messages and allows - for filtering of log events. In a SharePoint Framework application, these - messages will appear on the developer dashboard. + The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and + with context information. Context information helps identify which component generated the messages and allows for + filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. isPreview: false isDeprecated: false type: class @@ -27,19 +25,16 @@ methods: parameters: - id: source description: >- - the source from where the error is logged, e.g., the class name. The - source provides context information for the logged error. If the - source's length is more than 20, only the first 20 characters are - kept. + the source from where the error is logged, e.g., the class name. The source provides context information for + the logged error. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: error description: the error to be logged - type: '' + type: Error - id: scope description: >- - the service scope that the source uses. A service scope can provide - more context information (e.g., web part information) to the logged - error. + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged error. type: '' return: type: void @@ -53,27 +48,20 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - static info(source: string, message: string, scope?: ServiceScope): - void; + content: 'static info(source: string, message: string, scope?: ServiceScope): void;' parameters: - id: source description: >- - the source from where the message is logged, e.g., the class name. - The source provides context information for the logged message. If - the source's length is more than 20, only the first 20 characters - are kept. + the source from where the message is logged, e.g., the class name. The source provides context information + for the logged message. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: message - description: >- - the message to be logged If the message's length is more than 100, - only the first 100 characters are kept. + description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' type: string - id: scope description: >- - the service scope that the source uses. A service scope can provide - more context information (e.g., web part information) to the logged - message. + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged message. type: '' return: type: void @@ -82,34 +70,25 @@ methods: uid: '@microsoft/sp-core-library!Log.verbose:member(1)' package: '@microsoft/sp-core-library!' fullName: 'verbose(source, message, scope)' - summary: >- - Logs a message which contains detailed information that is generally only - needed for troubleshooting. + summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - static verbose(source: string, message: string, scope?: ServiceScope): - void; + content: 'static verbose(source: string, message: string, scope?: ServiceScope): void;' parameters: - id: source description: >- - the source from where the message is logged, e.g., the class name. - The source provides context information for the logged message. If - the source's length is more than 20, only the first 20 characters - are kept. + the source from where the message is logged, e.g., the class name. The source provides context information + for the logged message. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: message - description: >- - the message to be logged If the message's length is more than 100, - only the first 100 characters are kept. + description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' type: string - id: scope description: >- - the service scope that the source uses. A service scope can provide - more context information (e.g., web part information) to the logged - message. + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged message. type: '' return: type: void @@ -123,27 +102,20 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - static warn(source: string, message: string, scope?: ServiceScope): - void; + content: 'static warn(source: string, message: string, scope?: ServiceScope): void;' parameters: - id: source description: >- - the source from where the message is logged, e.g., the class name. - The source provides context information for the logged message. If - the source's length is more than 20, only the first 20 characters - are kept. + the source from where the message is logged, e.g., the class name. The source provides context information + for the logged message. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: message - description: >- - the message to be logged If the message's length is more than 100, - only the first 100 characters are kept. + description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' type: string - id: scope description: >- - the service scope that the source uses. A service scope can provide - more context information (e.g., web part information) to the logged - message. + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged message. type: '' return: type: void diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 1c590f97..ccf6b9a2 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -5,8 +5,8 @@ package: '@microsoft/sp-core-library!' fullName: RandomNumberGenerator summary: >- This is the default implementation of - [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) - that simply calls Math.random(). + [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls + Math.random(). remarks: '' isPreview: false isDeprecated: false @@ -40,16 +40,13 @@ properties: return: type: >- <> + uid="@microsoft/sp-core-library!IRandomNumberGenerator:interface" />> methods: - name: generate() uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' package: '@microsoft/sp-core-library!' fullName: generate() - summary: >- - Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), - following the contract of Math.random(). + summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index c42f204e..af90efde 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -5,14 +5,12 @@ package: '@microsoft/sp-core-library!' fullName: ServiceKey summary: >- The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope#consume:member(1)) - to fetch a dependency. + [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope%23consume:member(1)) to fetch a dependency. remarks: >- - Every service key also provides a default implementation of the dependency, - which will be automatically created in the root scope if the dependency is not - found. Providing a default implementation ensures that new dependencies can be - safely introduced without inadvertently breaking components that are loaded by - an older host that does not provide the new dependency. + Every service key also provides a default implementation of the dependency, which will be automatically created in the + root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be + safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the + new dependency. isPreview: false isDeprecated: false type: class @@ -35,20 +33,16 @@ properties: fullName: id summary: A unique identifier for this service key. remarks: >- - This identifier is an automatically generated string that will be unique - for the lifetime of the page. Callers should not make assumptions about - the formatting of this string. It is currently based on a global counter, - but this may change in the future. + This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers + should not make assumptions about the formatting of this string. It is currently based on a global counter, but + this may change in the future. - The ServiceScope uses this identifier internally as a dictionary key for - finding services. The ServiceKey is meant to be unique, even if multiple - instances of the same library are loaded on the same page, even if the - same name was passed to ServiceKey.create(). This is because each call to - ServiceKey.create() could potentially provide a different defaultCreator - implementation, whereas one of the design goals of ServiceScope is that - the order in which libraries are loaded should never affect the resulting - tree of scopes. + The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant + to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name + was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a + different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in + which libraries are loaded should never affect the resulting tree of scopes. isPreview: false isDeprecated: false syntax: @@ -61,14 +55,12 @@ properties: fullName: name summary: The name of the service. remarks: >- - This name is used for logging and diagnostic purposes only. To make it - unique, the recommended convention is the package name, followed by a - period, followed by the class or interface name. + This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the + package name, followed by a period, followed by the class or interface name. The system does not assume that this string is unique. Instead, the - [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey#id:member) is - used wherever a lookup key is needed. + [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. isPreview: false isDeprecated: false syntax: @@ -81,13 +73,11 @@ methods: package: '@microsoft/sp-core-library!' fullName: 'create(name, serviceClass)' summary: >- - Constructs a new ServiceKey whose default implementation will be a new - instance of a TypeScript class that accepts the standard constructor - parameter. + Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts + the standard constructor parameter. remarks: >- If you want to specify custom constructor parameters, use - [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) - instead. + [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. isPreview: false isDeprecated: false syntax: @@ -97,9 +87,7 @@ methods: }): ServiceKey; parameters: - id: name - description: >- - A name such as "my-package.IMyService" which should be unique across - packages. + description: A name such as "my-package.IMyService" which should be unique across packages. type: string - id: serviceClass description: the TypeScript class that implements the service. @@ -114,27 +102,19 @@ methods: uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' package: '@microsoft/sp-core-library!' fullName: 'createCustom(name, defaultCreator)' - summary: >- - Constructs a new ServiceKey whose default implementation will be obtained - by invoking the specified callback. + summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - static createCustom(name: string, defaultCreator: - ServiceCreator): ServiceKey; + content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' parameters: - id: name - description: >- - A name such as "my-package.IMyService" which should be unique across - packages. + description: A name such as "my-package.IMyService" which should be unique across packages. type: string - id: defaultCreator description: a callback that returns an object that implements the T interface - type: >- - <TKey> + type: '<TKey>' return: type: '<TKey>' description: the newly created service key diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 2dda5b6e..333f5ceb 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -5,62 +5,44 @@ package: '@microsoft/sp-core-library!' fullName: ServiceScope summary: The service locator pattern used by the SharePoint Framework. remarks: >- - ServiceScope provides a formalized way for components to register and consume - dependencies ("services"), and to enable different implementations to be - registered in different scopes. This improves modularity by decoupling - components from their dependencies in an extensible way. + ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to enable + different implementations to be registered in different scopes. This improves modularity by decoupling components from + their dependencies in an extensible way. - For example, suppose that various components need access to an IPageManager - instance. We could simply make the PageManager a singleton (i.e. global - variable), but this will not work e.g. if we need to create a pop-up dialog - that requires a second PageManager instance. A better solution would be to add - the PageManager as a constructor parameter for each component that requires - it, however then we immediately face the problem that any code that calls - these constructors also needs a PageManager parameter. In an application with - many such dependencies, business logic that ties together many subsystems - would eventually pick up a constructor parameter for every possible - dependency, which is awkward. A natural solution would be to move all the - dependencies into a class with name like "ApplicationContext", and then pass - this around as our constructor parameter. This enables the PageManager to be - passed to classes that need it without cluttering the intermediary classes - that don't. However, it still has a design problem that "ApplicationContext" - has hard-coded dependencies on many unrelated things. A more flexible approach - is to make it a dictionary that can look up items for consumers/providers who - know the right lookup key (i.e. ServiceKey). This is the popular "service - locator" design pattern, familiar from the SPContext API in classic - SharePoint. + For example, suppose that various components need access to an IPageManager instance. We could simply make the + PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that + requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter + for each component that requires it, however then we immediately face the problem that any code that calls these + constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that + ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is + awkward. A natural solution would be to move all the dependencies into a class with name like "ApplicationContext", + and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need + it without cluttering the intermediary classes that don't. However, it still has a design problem that + "ApplicationContext" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a + dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the + popular "service locator" design pattern, familiar from the SPContext API in classic SharePoint. - ServiceScope takes this idea a step further in two important ways: First, it - provides a scoping mechanism so that e.g. if we have two different pages, they - can each provide a unique PageManager instance while still sharing other - common dependencies. Secondly, it allows for a ServiceKey to provide a default - implementation of the dependency. This is important for API stability in our - modular client-side environment: For example, suppose that version 2.0 of our - application introduced a new IDiagnosticTracing interface that a version 2.0 - component will expect to consume. If the version 2.0 component gets loaded by - an older 1.0 application, it would fail. We could fix this by requiring each - consumer to check for any missing dependencies and handle that case, but it - would require a lot of checks. A better solution is to ensure that a default - implementation always exists, perhaps just a trivial behavior, so that - components can assume that consume() will always return some object that - implements the contract. + ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. + if we have two different pages, they can each provide a unique PageManager instance while still sharing other common + dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is + important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our + application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the + version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each + consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better + solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components + can assume that consume() will always return some object that implements the contract. - Usage: ServiceScope instances are created by calling either - ServiceScope.startNewRoot() or ServiceScope.startNewChild(). They are - initially in an "unfinished" state, during which provide() can be called to - register service keys, but consume() is disallowed. After - ServiceScope.finish() is called, consume() is allowed and provide() is now - disallowed. These semantics ensure that ServiceScope.consume() always returns - the same result for the same key, and does not depend on order of - initialization. It also allows us to support circular dependencies without - worrying about infinite loops. (Circular dependencies are best avoided, - however this is difficult to guarantee when working with components that were - contributed by various third parties without any coordination.) To avoid - mistakes, it's best to always call consume() inside a callback from - serviceScope.whenFinished(). + Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or + ServiceScope.startNewChild(). They are initially in an "unfinished" state, during which provide() can be called to + register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and + provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the + same key, and does not depend on order of initialization. It also allows us to support circular dependencies without + worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when + working with components that were contributed by various third parties without any coordination.) To avoid mistakes, + it's best to always call consume() inside a callback from serviceScope.whenFinished(). isPreview: false isDeprecated: false type: class @@ -86,9 +68,8 @@ methods: fullName: consume(serviceKey) summary: Consumes a service from the service scope. remarks: >- - Components should call this function to "consume" a dependency, i.e. look - up the serviceKey and return the registered service instance. If the - instance cannot be found, then a default instance will be automatically + Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the + registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. isPreview: false isDeprecated: false @@ -96,9 +77,7 @@ methods: content: 'consume(serviceKey: ServiceKey): T;' parameters: - id: serviceKey - description: >- - the key that was used when provide() was called to register the - service + description: the key that was used when provide() was called to register the service type: '<T>' return: type: T @@ -108,9 +87,8 @@ methods: package: '@microsoft/sp-core-library!' fullName: 'createAndProvide(serviceKey, simpleServiceClass)' summary: >- - This is a shorthand function that is equivalent to constructing a new - instance of the simpleServiceClass, then registering it by calling - ServiceScope.provide(). + This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then + registering it by calling ServiceScope.provide(). remarks: '' isPreview: false isDeprecated: false @@ -137,9 +115,8 @@ methods: package: '@microsoft/sp-core-library!' fullName: createDefaultAndProvide(serviceKey) summary: >- - This is a shorthand function that constructs the default implementation of - the specified serviceKey, and then registers it by calling - ServiceScope.provide(). + This is a shorthand function that constructs the default implementation of the specified serviceKey, and then + registers it by calling ServiceScope.provide(). remarks: '' isPreview: false isDeprecated: false @@ -151,27 +128,22 @@ methods: type: '<T>' return: type: T - description: >- - a service instance that was constructed using - ServiceKey.defaultCreator + description: a service instance that was constructed using ServiceKey.defaultCreator - name: finish() uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' package: '@microsoft/sp-core-library!' fullName: finish() summary: Completes the initialization sequence for a service scope. remarks: >- - When a ServiceScope is first started, it is in an "unfinished" state where - provide() is allowed but consume() is disallowed. After calling finish(), - then consume() is allowed but provide() is disallowed. + When a ServiceScope is first started, it is in an "unfinished" state where provide() is allowed but consume() is + disallowed. After calling finish(), then consume() is allowed but provide() is disallowed. - This formalism prevents a number of complex situations that could lead to - bugs. For example, supposed that Scope2 is a child of Scope1, and Scope1 - provides instance A1 of interface A. If someone consumes A1 from Scope2 - (via inheritance) before Scope2.provide() is called with A2, then a - subsequent call to Scope2.consume() might return a different result than - the previous call. This nondeterminism could cause unpredictable results - that are difficult to diagnose. + This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 + is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via + inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a + different result than the previous call. This nondeterminism could cause unpredictable results that are difficult + to diagnose. isPreview: false isDeprecated: false syntax: @@ -183,9 +155,7 @@ methods: uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' package: '@microsoft/sp-core-library!' fullName: getParent() - summary: >- - Returns the parent of the current ServiceScope, or undefined if this is a - root scope. + summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' remarks: '' isPreview: false isDeprecated: false @@ -200,10 +170,8 @@ methods: fullName: 'provide(serviceKey, service)' summary: Add a new service to a service scope. remarks: >- - ServiceScope.provide() is used to register an implementation of the given - serviceKey for the current scope. It may only be used when the - ServiceScope is in an "unfinished" state, i.e. before finish() has been - called. + ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may + only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. isPreview: false isDeprecated: false syntax: @@ -224,9 +192,8 @@ methods: fullName: startNewChild() summary: Constructs a new ServiceScope that is a child of the current scope. remarks: >- - The service scopes form a tree structure, such that when consuming a - service, if the key is not explicitly provided by a child scope, the - parent hierarchy will be consulted. + The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly + provided by a child scope, the parent hierarchy will be consulted. isPreview: false isDeprecated: false syntax: @@ -239,8 +206,8 @@ methods: package: '@microsoft/sp-core-library!' fullName: startNewRoot() summary: >- - Create a new root-level ServiceScope. Only root-level scopes have the - ability to autocreate default implementations of ServiceKeys. + Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default + implementations of ServiceKeys. remarks: '' isPreview: false isDeprecated: false @@ -255,21 +222,17 @@ methods: fullName: whenFinished(callback) summary: >- Defer an operation until after - [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope#finish:member(1)) - has completed. + [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope%23finish:member(1)) has completed. remarks: >- - It is an error to call ServiceScope.consume() before finish() has been - called. The most reliable way to protect your component against this error - is to perform the consume() calls inside a whenFinished() callback. If the - service scope is already finished, then the callback will be executed - immediately; otherwise, it will be executed later when the scope is - finished. + It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect + your component against this error is to perform the consume() calls inside a whenFinished() callback. If the + service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed + later when the scope is finished. - NOTE: This is not an asynchronous callback. ServiceScope initialization is - typically inexpensive and short lived. However, the control flow often - threads through numerous constructors and base classes, which can be - simplified using whenFinished(). + NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. + However, the control flow often threads through numerous constructors and base classes, which can be simplified + using whenFinished(). isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 66c8f995..c1c63790 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -13,52 +13,53 @@ properties: uid: '@microsoft/sp-core-library!Session.applicationId:member' package: '@microsoft/sp-core-library!' fullName: applicationId - summary: >- - A unique identifier for the current instance of the client-side - application. + summary: A unique identifier for the current instance of the client-side application. remarks: >- - A unique identifier used to correlate logging and other diagnostic - information. Its lifetime persists for the duration of the client-side - application instance, i.e. it begins with the server request that renders - the page, and ends e.g. when the browser tab is closed or F5 is pressed to - reload the page. Note that if the application's router supports in-place - navigation (via the history.pushState() API), the application session - persists across these transitions. + A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the + duration of the client-side application instance, i.e. it begins with the server request that renders the page, + and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's + router supports in-place navigation (via the history.pushState() API), the application session persists across + these transitions. isPreview: false isDeprecated: false syntax: - content: 'static readonly applicationId: Guid;' + content: 'static get applicationId(): Guid;' return: type: '' + - name: clientSideApplicationId + uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' + package: '@microsoft/sp-core-library!' + fullName: clientSideApplicationId + summary: The id of the currently running application + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static get clientSideApplicationId(): string;' + return: + type: string - name: pageId uid: '@microsoft/sp-core-library!Session.pageId:member' package: '@microsoft/sp-core-library!' fullName: pageId - summary: >- - A unique identifier for the current page within the client-side - application. + summary: A unique identifier for the current page within the client-side application. remarks: >- - A unique identifier used to correlate logging and other diagnostic - information. Whereas the - [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) - tracks the entire lifetime of the client-side application instance, the - pageId tracks an individual "page" that is rendered. + A unique identifier used to correlate logging and other diagnostic information. Whereas the + [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) tracks the entire lifetime + of the client-side application instance, the pageId tracks an individual "page" that is rendered. - For example, suppose that the application initially loads PageA, then the - user does in-place navigation (via the history.pushState() API) to PageB, - then navigates back to PageA, and finally they close the browser tab. - During this sequence, the applicationId will remain the same, however the - pageId will change on each navigation. The 3 different pageId values are - used by the diagnostics e.g. to track success/failure statistics for PageA + For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the + history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During + this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 + different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA independently of PageB. - The concept of a page is subjective and defined by the router for a - particular application. + The concept of a page is subjective and defined by the router for a particular application. isPreview: false isDeprecated: false syntax: - content: 'static readonly pageId: Guid;' + content: 'static get pageId(): Guid;' return: type: '' diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index a429a490..3f322aa8 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -5,31 +5,23 @@ package: '@microsoft/sp-core-library!' fullName: SPEvent summary: Represents a framework event that components can subscribe to. remarks: >- - Examples of events in a web application might include: the user clicking a - button, the system navigating to another page, or an item being added/removed - from an abstract collection. The SharePoint Framework represents events using - instances of the SPEvent object, one for each kind of event. The SPEvent - object is typically exposed as a property of an associated class (e.g. the - button that can be clicked). When a component is interested in an event, it - calls add() to register an event handler callback that will be invoked each - time the event occurs. The handler receives an SPEventArgs parameter that may - provide additional details about what happened. This is analogous to the - browser's Document Object Model (DOM) events. The main difference is the - ISPEventObserver feature, which tracks which component subscribed to each - event, and automatically unsubscribes the handler when the component is - disposed. + Examples of events in a web application might include: the user clicking a button, the system navigating to another + page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using + instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of + an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() + to register an event handler callback that will be invoked each time the event occurs. The handler receives an + SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's + Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component + subscribed to each event, and automatically unsubscribes the handler when the component is disposed. - When an event is raised, all handlers are invoked synchronously. The order in - which event handlers are called is unspecified. The event handler callback - must catch any exceptions that occur during processing; an uncaught exception - will not prevent other handlers from executing, but it will be reported as a - problem with the associated component. + When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is + unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception + will not prevent other handlers from executing, but it will be reported as a problem with the associated component. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPEvent` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPEvent` class. isPreview: false isDeprecated: false type: class @@ -40,24 +32,19 @@ methods: fullName: 'add(observer, eventHandler)' summary: Registers a callback that will be invoked whenever the event occurs. remarks: >- - The same object can add multiple event handlers to the same event. Since - BaseComponent implements the ISPEventObserver interface, a web part or - extension can pass itself as the observer. This will cause the event - handler to be automatically unsubscribed when the web part or extension is - disposed. + The same object can add multiple event handlers to the same event. Since BaseComponent implements the + ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event + handler to be automatically unsubscribed when the web part or extension is disposed. isPreview: false isDeprecated: false syntax: - content: >- - add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => - void): void; + content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' parameters: - id: observer description: >- - Indicates the object that is subscribing to the event: When the - object is disposed, the event handler will be automatically removed. - This object is also used for diagnostic purposes, e.g. detecting if - the event handler failed to catch an exception. + Indicates the object that is subscribing to the event: When the object is disposed, the event handler will + be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event + handler failed to catch an exception. type: '' - id: eventHandler description: A callback function that will be invoked whenever the event occurs @@ -70,25 +57,17 @@ methods: package: '@microsoft/sp-core-library!' fullName: 'remove(observer, eventHandler)' summary: Unregisters a callback that was registered using add(). - remarks: >- - If the event handler has already been removed, or if it was never added, - then this method has no effect. + remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' isPreview: false isDeprecated: false syntax: - content: >- - remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) - => void): void; + content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' parameters: - id: observer - description: >- - This must be the same observer that was passed to the add() - function. + description: This must be the same observer that was passed to the add() function. type: '' - id: eventHandler - description: >- - The event handler to remove; this must be the same object instance - that was passed to the add() function. + description: The event handler to remove; this must be the same object instance that was passed to the add() function. type: '(eventArgs: TEventArgs) => void' return: type: void diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 11a2d5fd..94bde34b 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -3,12 +3,8 @@ name: SPEventArgs uid: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-core-library!' fullName: SPEventArgs -summary: >- - The base class for event arguments used with the - [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class. -remarks: >- - If certain event types need to provide additional details, they will define a - subclass of SPEventArgs. +summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' +remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml new file mode 100644 index 00000000..6c642456 --- /dev/null +++ b/SP-Framework/sp-core-library/text_2.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Text_2 +uid: '@microsoft/sp-core-library!Text_2:class' +package: '@microsoft/sp-core-library!' +fullName: Text_2 +summary: Operations for working with strings that contain text. +remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'format(s, values)' + uid: '@microsoft/sp-core-library!Text_2.format:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'format(s, values)' + summary: Format a string by substituting parameters. + remarks: >- + This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the + value is null or undefined, it will be replaced by the word `"null"` or `"undefined"`. The format string s + must not be null or undefined. + + + Usage example: + + + `Text.format("hello {0}!", "world")` will return `"hello world!"` + isPreview: false + isDeprecated: false + syntax: + content: 'static format(s: string, ...values: unknown[]): string;' + parameters: + - id: s + description: '' + type: string + - id: values + description: '' + type: 'unknown[]' + return: + type: string + description: '' + - name: 'replaceAll(input, searchValue, replaceValue)' + uid: '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'replaceAll(input, searchValue, replaceValue)' + summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' + remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' + isPreview: false + isDeprecated: false + syntax: + content: 'static replaceAll(input: string, searchValue: string, replaceValue: string): string;' + parameters: + - id: input + description: The string to be modified + type: string + - id: searchValue + description: The value to search for + type: string + - id: replaceValue + description: The replacement text + type: string + return: + type: string + description: '' diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 28ec03eb..6e2b7e73 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-core-library!TimeProvider:class' package: '@microsoft/sp-core-library!' fullName: TimeProvider summary: >- - This is the default implementation of - [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that + This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that simply calls the real browser APIs. remarks: '' isPreview: false @@ -53,15 +52,13 @@ methods: syntax: content: 'getDate(): Date;' return: - type: '' + type: Date description: '' - name: getTimestamp() uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' package: '@microsoft/sp-core-library!' fullName: getTimestamp() - summary: >- - Returns a DOMHighResTimeStamp timing measurement, as defined by the - standard performance.now() API. + summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 0ece8ba3..2a5dcbd6 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -5,25 +5,20 @@ package: '@microsoft/sp-core-library!' fullName: UrlQueryParameterCollection summary: Provides features for storing and retrieving URL query parameters. remarks: >- - The URL can be server-relative, and it can also be an empty or null string. - The query parameters must start with "?" to indicate the first query parameter - and use "&" for all subsequent parameters. The class also supports + The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with "?" + to indicate the first query parameter and use "&" for all subsequent parameters. The class also supports fragments. Edge case behavior: - Empty value (www.example.com/?test=) stores key and empty value No equals in - queryParam (www.example.com/?test) stores key and undefined value Empty - queryParam (www.example.com/?&debug=on) stores undefined key and value - Query param with only equals (www.example.com/?=&debug=on stores empty - string key and value + Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores + key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param + with only equals (www.example.com/?=&debug=on stores empty string key and value isPreview: false isDeprecated: true -customDeprecatedMessage: >- - Use the URLSearchParams browser API instead. The SharePoint Framework includes - a polyfill for older browsers. +customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. type: class constructors: - name: (constructor)(url) @@ -45,9 +40,7 @@ methods: uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' package: '@microsoft/sp-core-library!' fullName: getValue(param) - summary: >- - Returns the value of the first matching query parameter or undefined if - the key doesn't exist. + summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. remarks: |- Examples: @@ -59,7 +52,6 @@ methods: getValue('TEST') ---> 'done' getValue('debug') ---> 'false' getValue('lost') ---> undefined - ``` isPreview: false isDeprecated: false @@ -76,9 +68,7 @@ methods: uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' package: '@microsoft/sp-core-library!' fullName: getValues(param) - summary: >- - Returns the values of all of the matching query parameters or undefined if - the key doesn't exist. + summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. remarks: |- Examples: @@ -90,7 +80,6 @@ methods: getValues('TEST') ---> ['done', 'notdone'] getValues('debug') ---> ['false'] getValues('lost') ---> undefined - ``` isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index c10e7005..21bb61a5 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -5,11 +5,9 @@ package: '@microsoft/sp-core-library!' fullName: Validate summary: Performs common validation tests for properties and function parameters. remarks: >- - This class implements provides a standard way to validate properties and - function parameters. Unlike debug assertions, Validate checks are always - performed and will always throw an error, even in a production release. As - such, be careful not to overuse these checks in a way that might impact - performance. + This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, + Validate checks are always performed and will always throw an error, even in a production release. As such, be careful + not to overuse these checks in a way that might impact performance. isPreview: false isDeprecated: false type: class @@ -18,24 +16,18 @@ methods: uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' package: '@microsoft/sp-core-library!' fullName: 'isNonemptyString(value, variableName)' - summary: >- - Throws an exception if the specified string is null, undefined, or an - empty string. + summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - static isNonemptyString(value: string | undefined | null, variableName: - string): void; + content: 'static isNonemptyString(value: string | undefined | null, variableName: string): void;' parameters: - id: value description: the value to check type: string | undefined | null - id: variableName - description: >- - the program variable name, which will be mentioned in the error - message + description: 'the program variable name, which will be mentioned in the error message' type: string return: type: void @@ -75,9 +67,7 @@ methods: description: the value to check type: any - id: variableName - description: >- - the program variable name, which will be mentioned in the error - message + description: 'the program variable name, which will be mentioned in the error message' type: string return: type: void @@ -91,17 +81,13 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - static isTrue(value: boolean | undefined | null, variableName: string): - void; + content: 'static isTrue(value: boolean | undefined | null, variableName: string): void;' parameters: - id: value description: the value to check type: boolean | undefined | null - id: variableName - description: >- - the program variable name, which will be mentioned in the error - message + description: 'the program variable name, which will be mentioned in the error message' type: string return: type: void diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index aea69aab..9c72e84a 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -5,15 +5,12 @@ package: '@microsoft/sp-core-library!' fullName: Version summary: 'Represents a version number with two, three, or four parts.' remarks: >- - This class represents versions that follow the string format of - `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, MINOR, PATCH and REVISION - parts are integers. PATCH and REVISION are optional. Leading zero digits are - allowed, but they are discarded. Missing parts are treated as zeroes for - comparisons. + This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, + MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but + they are discarded. Missing parts are treated as zeroes for comparisons. - Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, - `01.02.03`, `001.002.003.004` + Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` isPreview: false isDeprecated: false type: class @@ -23,13 +20,11 @@ properties: package: '@microsoft/sp-core-library!' fullName: major summary: Returns the first component of the version string. - remarks: >- - Typically a change in the major version number indicates a compatibility - break with previous versions. + remarks: Typically a change in the major version number indicates a compatibility break with previous versions. isPreview: false isDeprecated: false syntax: - content: 'readonly major: number;' + content: 'get major(): number;' return: type: number - name: minor @@ -38,12 +33,12 @@ properties: fullName: minor summary: Returns the second component of the version string. remarks: >- - Typically a change in the minor version number indicates that new features - were added, while remaining backwards compatible with previous releases. + Typically a change in the minor version number indicates that new features were added, while remaining backwards + compatible with previous releases. isPreview: false isDeprecated: false syntax: - content: 'readonly minor: number;' + content: 'get minor(): number;' return: type: number - name: patch @@ -52,13 +47,12 @@ properties: fullName: patch summary: 'The third number in the version string, or undefined if unspecified.' remarks: >- - Typically a change in the patch version number indicates a small fix that - does not affect the compatibility contract for the library. For a .NET - System.Version object, this is referred to as the "build" number. + Typically a change in the patch version number indicates a small fix that does not affect the compatibility + contract for the library. For a .NET System.Version object, this is referred to as the "build" number. isPreview: false isDeprecated: false syntax: - content: 'readonly patch: number | undefined;' + content: 'get patch(): number | undefined;' return: type: number | undefined - name: revision @@ -67,12 +61,12 @@ properties: fullName: revision summary: 'The fourth number in the version string, or undefined if unspecified.' remarks: >- - This number is not part of the Semantic Versioning (SemVer) standard used - in JavaScript, but it is used by .NET version numbers. + This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET + version numbers. isPreview: false isDeprecated: false syntax: - content: 'readonly revision: number | undefined;' + content: 'get revision(): number | undefined;' return: type: number | undefined methods: @@ -96,9 +90,8 @@ methods: return: type: number description: >- - -1 if the first input is less than the second input; 0 if the first - input is equal to the second input; 1 if the first input is greater - than the second input. + -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if + the first input is greater than the second input. - name: equals(compareWith) uid: '@microsoft/sp-core-library!Version#equals:member(1)' package: '@microsoft/sp-core-library!' @@ -112,7 +105,6 @@ methods: 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true - ``` isPreview: false isDeprecated: false @@ -129,9 +121,7 @@ methods: uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' package: '@microsoft/sp-core-library!' fullName: greaterThan(compareWith) - summary: >- - Tests whether this version is greater than (i.e. newer than) the input - parameter. + summary: Tests whether this version is greater than (i.e. newer than) the input parameter. remarks: |- Examples: @@ -139,7 +129,6 @@ methods: 1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true - ``` isPreview: false isDeprecated: false @@ -151,9 +140,7 @@ methods: type: '' return: type: boolean - description: >- - A boolean indicating if this version is greater than the input - parameter + description: A boolean indicating if this version is greater than the input parameter - name: isValid(versionString) uid: '@microsoft/sp-core-library!Version.isValid:member(1)' package: '@microsoft/sp-core-library!' @@ -175,9 +162,7 @@ methods: uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' package: '@microsoft/sp-core-library!' fullName: lessThan(compareWith) - summary: >- - Tests whether this version is less than (i.e. older than) the input - parameter. + summary: Tests whether this version is less than (i.e. older than) the input parameter. remarks: |- Examples: @@ -186,7 +171,6 @@ methods: 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false - ``` isPreview: false isDeprecated: false @@ -203,9 +187,7 @@ methods: uid: '@microsoft/sp-core-library!Version.parse:member(1)' package: '@microsoft/sp-core-library!' fullName: parse(versionString) - summary: >- - Constructs a new Version instance using the version string. An exception - is thrown if the string cannot be parsed. + summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. remarks: '' isPreview: false isDeprecated: false @@ -223,12 +205,11 @@ methods: package: '@microsoft/sp-core-library!' fullName: satisfies(compareWith) summary: >- - Tests whether this version satisfies the compatibility requirements of the - input version, i.e. is backwards compatible. + Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards + compatible. remarks: >- - In order to satisfy the compatibility requirements, this object must have - the same major version number as the input parameter, and it must NOT be - older than the input parameter. + In order to satisfy the compatibility requirements, this object must have the same major version number as the + input parameter, and it must NOT be older than the input parameter. Examples: @@ -244,7 +225,6 @@ methods: 1.0.0 satisfies 1.1.0 -> false - ``` isPreview: false isDeprecated: false @@ -256,18 +236,15 @@ methods: type: '' return: type: boolean - description: >- - A boolean indicating if this version is compatible with the input - parameter + description: A boolean indicating if this version is compatible with the input parameter - name: toString() uid: '@microsoft/sp-core-library!Version#toString:member(1)' package: '@microsoft/sp-core-library!' fullName: toString() summary: Returns a string representation of the version. remarks: >- - The value is normalized and may be different from the original string - (e.g. leading zeroes may be removed). However, the number of version parts - will be unchanged. + The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). + However, the number of version parts will be unchanged. isPreview: false isDeprecated: false syntax: @@ -280,15 +257,13 @@ methods: package: '@microsoft/sp-core-library!' fullName: tryParse(versionString) summary: >- - Attempts to parse the input string to construct a new Version object. If - the string cannot be parsed, then undefined is returned. + Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then + undefined is returned. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - static tryParse(versionString: string | undefined | null): Version | - undefined; + content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' parameters: - id: versionString description: A version string diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index 85f582d8..914e3cac 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -3,6 +3,5 @@ uid: '@microsoft/sp-diagnostics!' name: '@microsoft/sp-diagnostics' type: package summary: >- - This package defines the internal diagnostics tools for the SharePoint - Framework, including monitoring, trace, user engagement and performance - logging. + This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user + engagement and performance logging. diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 7a18c2c0..e8533e88 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -4,18 +4,14 @@ uid: '@microsoft/sp-dialog!BaseDialog:class' package: '@microsoft/sp-dialog!' fullName: BaseDialog summary: >- - The base class for implementing dialogs in SharePoint Framework. This provides - a supported way for showing dialogs to the user inside SharePoint Framework - components. + The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to + the user inside SharePoint Framework components. remarks: >- - Extend this class to create dialogs for SharePoint Framework. By following the - guidelines in implementation, the framework can ensure that the dialogs are - shown in a user-friendly manner. While the content of the dialog is controlled - by this class by implementing the render method, the framework can decide when - to show the dialog and how to render the overlay and modal. The application on - the page can also have control on allowing dialogs to show. Refer to the - documentation of the individual methods and properties to learn more about how - to extend and use this class. + Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the + framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is + controlled by this class by implementing the render method, the framework can decide when to show the dialog and how + to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer + to the documentation of the individual methods and properties to learn more about how to extend and use this class. isPreview: false isDeprecated: false type: class @@ -26,21 +22,16 @@ constructors: fullName: (constructor)(config) summary: Constructor for the `BaseDialog` class. remarks: >- - It is important to keep the constructor lightweight. Use `onBeforeOpen()` - for doing heavy-weight initialization that is needed for rendering the - dialog such as resource allocations and asynchronous calls to fetch data. - You can use the constructor to set initial parameters of your dialog such - as references to resources in your application. The reason for this is - that dialogs are usually constructed upon a UI event e.g. a button click, - but the dialog may not always be shown right after construction. Keeping - the constructor lightweight ensures smooth user experience and avoids - doing throw-away work in case the dialog is not shown later e.g. if the - framework rejects it. Another benefit of doing this is avoiding memory - leaks by doing all the allocations and disposals in symmetric - `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in - the constructor, you have a memory leak because there is no guarantee - onAfterClose() will get called, and onAfterClose() is your only - opportunity to dispose. + It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization + that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can + use the constructor to set initial parameters of your dialog such as references to resources in your application. + The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog + may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user + experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects + it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric + `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak + because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to + dispose. Example: @@ -54,7 +45,6 @@ constructors: this._cache.refresh(); // This is bad practice. // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() } - ``` isPreview: false isDeprecated: false @@ -69,33 +59,28 @@ properties: uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' package: '@microsoft/sp-dialog!' fullName: domElement - summary: >- - Use this property to access the container element provided by the - framework for rendering. + summary: Use this property to access the container element provided by the framework for rendering. remarks: >- - See - [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog#render:member(1)) - for more information on rendering. + See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on + rendering. isPreview: false isDeprecated: false syntax: - content: 'protected readonly domElement: HTMLElement;' + content: 'protected get domElement(): HTMLElement;' return: - type: '' + type: HTMLElement - name: isHidden uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' package: '@microsoft/sp-dialog!' fullName: isHidden summary: If the dialog is visually hidden. remarks: >- - This happens when the dialog goes behind a secondary dialog. Note that - this is different from closed, because the dialog still has the permission - to show and will eventually unhide. This returns false if the dialog is - closed. + This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the + dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. isPreview: false isDeprecated: false syntax: - content: 'readonly isHidden: boolean;' + content: 'get isHidden(): boolean;' return: type: boolean - name: isOpen @@ -103,28 +88,25 @@ properties: package: '@microsoft/sp-dialog!' fullName: isOpen summary: >- - If the dialog is visually open. This returns true during onBeforeOpen() - because there is a visual component. It returns false when the dialog is - hidden. + If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It + returns false when the dialog is hidden. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly isOpen: boolean;' + content: 'get isOpen(): boolean;' return: type: boolean - name: isSecondary uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' package: '@microsoft/sp-dialog!' fullName: isSecondary - summary: >- - If the dialog is a secondary dialog. This means that there is another - dialog hidden behind this dialog. + summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly isSecondary: boolean;' + content: 'get isSecondary(): boolean;' return: type: boolean - name: secondaryDialogProvider @@ -132,22 +114,18 @@ properties: package: '@microsoft/sp-dialog!' fullName: secondaryDialogProvider summary: >- - An active dialog is permitted to show a secondary dialog on top of itself. - By design, only two layers of dialogs are permitted. + An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs + are permitted. remarks: >- - Secondary dialogs do not have to wait for permission and will immediately - be shown or rejected. All calls to show a secondary dialog reject while - there is already a secondary dialog showing. This property may be - undefined if a secondary dialog is not available i.e. the current dialog - is secondary itself or the dialog is not active. + Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show + a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a + secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. isPreview: false isDeprecated: false syntax: - content: 'readonly secondaryDialogProvider: ISecondaryDialogProvider | undefined;' + content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' return: - type: >- - - | undefined + type: ' | undefined' methods: - name: close() uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' @@ -155,33 +133,25 @@ methods: fullName: close() summary: Close the dialog. remarks: >- - This will void the permission to show for this dialog. Every dialog should - have a mechanism to eventually close to avoid blocking the user interface. - If called on an inactive dialog it will abort the request to show. + This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to + avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. isPreview: false isDeprecated: false syntax: content: 'close(): Promise;' return: - type: '<void>' - description: >- - A promise that resolves when the dialog is visually closed, or if it - was already closed + type: Promise<void> + description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - name: onAfterClose() uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' package: '@microsoft/sp-dialog!' fullName: onAfterClose() - summary: >- - This method is called after the dialog is visually closed and gives an - opportunity for doing clean up. + summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. remarks: >- - The dialog lifecycle completes after closing and there should be no - resources left inside the object. Even though the dialog may be revived - again for a new lifecycle using show() method, this is considered a whole - new lifecycle that should reallocate its own resources. If there are any - resources that you would like to keep for multiple lifecycles, consider - allocating it outside the dialog object and passing its reference to the - dialog constructor. + The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though + the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle + that should reallocate its own resources. If there are any resources that you would like to keep for multiple + lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. isPreview: false isDeprecated: false syntax: @@ -194,43 +164,35 @@ methods: package: '@microsoft/sp-dialog!' fullName: onBeforeOpen() summary: >- - This method is called before the render method and can be overridden to - make preparations for rendering. The loading indicator is displayed during - the lifetime of this method. - remarks: >- - All resource allocations in onBeforeOpen() should be properly disposed in - `onAfterClose()` to a avoid memory leak. + This method is called before the render method and can be overridden to make preparations for rendering. The + loading indicator is displayed during the lifetime of this method. virtual + remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. isPreview: false isDeprecated: false syntax: content: 'protected onBeforeOpen(): Promise;' return: - type: '<void>' + type: Promise<void> description: >- - A promise that resolves when the operations are done and the dialog is - ready to render. If the promise is rejected, the dialog will not be - rendered and `onAfterClose()` will not be called. + A promise that resolves when the operations are done and the dialog is ready to render. If the promise is + rejected, the dialog will not be rendered and `onAfterClose()` will not be called. - name: render() uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' package: '@microsoft/sp-dialog!' fullName: render() summary: Renders the contents of the dialog. remarks: >- - The `render` method must be implemented to render the content of the - dialog in the container element provided by the framework. Use - `this.domElement` to access this container. The container is inside a - modal rendered in the center of the page on top of a dark overlay. + The `render` method must be implemented to render the content of the dialog in the container element provided by + the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the + center of the page on top of a dark overlay. - The render method is called once after the modal element is created and - opened. It is recommended to use `onBeforeOpen()` for doing non-UI - operations for your rendering that might take a long time. This will - ensure that the framework can show a friendly UI such as a spinner to let - the user know that the dialog is being prepared. If you choose to do your - initialization or other costly operations inside render method, make sure - to have a friendly UI so the user is informed about the state of your - dialog. Otherwise, an empty element is shown to the user which is a bad - user experience practice. + The render method is called once after the modal element is created and opened. It is recommended to use + `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that + the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If + you choose to do your initialization or other costly operations inside render method, make sure to have a friendly + UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which + is a bad user experience practice. isPreview: false isDeprecated: false syntax: @@ -251,13 +213,11 @@ methods: parameters: - id: options description: >- - Dialog showing options. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) - for more information. + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. type: '' return: - type: '<void>' + type: Promise<void> description: >- - A promise that resolves once the dialog is successfully closed (after - being shown). The promise rejects if the request is rejected or - aborted. + A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the + request is rejected or aborted. diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index a3b4ac23..43a7543d 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -14,14 +14,12 @@ methods: package: '@microsoft/sp-dialog!' fullName: 'alert(message, options)' summary: >- - Alerts a message to the user with a user-friendly interface. Calling this - method sends a request to application to show the alert dialog. + Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to + show the alert dialog. remarks: >- - There might be a delay until the dialog is approved and shown by the - application, for example, if there is another dialog currently being - shown. The returned promise resolves when the dialog is successfully shown - and closed. The promise rejects if the application rejects the request for - any reason. + There might be a delay until the dialog is approved and shown by the application, for example, if there is another + dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The + promise rejects if the application rejects the request for any reason. isPreview: false isDeprecated: false syntax: @@ -34,27 +32,23 @@ methods: description: '' type: '' return: - type: '<void>' + type: Promise<void> description: '' - name: 'prompt(message, options)' uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' package: '@microsoft/sp-dialog!' fullName: 'prompt(message, options)' summary: >- - Prompts the user for a string value with a user-friendly interface. - Calling this method sends a request to application to show the dialog. + Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to + application to show the dialog. remarks: >- - There might be a delay until the dialog is approved and shown by the - application, for example, if there is another dialog currently being - shown. The returned promise resolves when the dialog is successfully shown - and closed. The promise rejects if the application rejects the request for - any reason. + There might be a delay until the dialog is approved and shown by the application, for example, if there is another + dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The + promise rejects if the application rejects the request for any reason. isPreview: false isDeprecated: false syntax: - content: >- - static prompt(message: string, options?: IPromptOptions): Promise; + content: 'static prompt(message: string, options?: IPromptOptions): Promise;' parameters: - id: message description: The message for prompt dialog @@ -63,5 +57,5 @@ methods: description: '' type: '' return: - type: '<string | undefined>' + type: Promise<string | undefined> description: The input string or undefined if the dialog was canceled diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 662bc5cb..edf5e34b 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -13,9 +13,7 @@ properties: uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' package: '@microsoft/sp-dialog!' fullName: isBlocking - summary: >- - Whether the dialog can be closed by clicking outside the dialog (on the - overlay). + summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 81ee54bd..33cec05c 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -15,13 +15,11 @@ properties: fullName: confirmOpen summary: A callback that is invoked immediately before the dialog receives focus. remarks: >- - Provide this callback if there is a case when you want to abort showing - the dialog before it's approved by the framework. For example, you can - check if a long time has passed since the request was made or the the - component requesting the dialog is disposed and you don't want to show the - dialog anymore. It is important to keep this callback lightweight so the - framework can resolve it quickly and the user interface does not have to - wait a long time for it. + Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the + framework. For example, you can check if a long time has passed since the request was made or the the component + requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this + callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long + time for it. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 76e0ab4a..f8d6d1a5 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -4,19 +4,17 @@ uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' package: '@microsoft/sp-dialog!' fullName: ISecondaryDialogProvider summary: >- - This interface handles calls to show a secondary dialog. It's only available - by calling this.secondaryManagerProvider inside a dialog. + This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider + inside a dialog. remarks: >- - Secondary dialogs do not need to request permission from dialog manager, - because the primary dialog already has permission. Therefore, the secondary - dialog will be immediately shown. This causes the primary dialog to hide until - the secondary dialog is closed. There can be only one secondary dialog at a - time. Additional requests to show more secondary dialogs are rejected. + Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has + permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until + the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more + secondary dialogs are rejected. - See - [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member) - for how to use this. + See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for + how to use this. isPreview: false isDeprecated: false type: interface @@ -26,10 +24,8 @@ methods: package: '@microsoft/sp-dialog!' fullName: 'alert(message, options)' summary: >- - Similar to - [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there - are no other secondary dialogs. Otherwise, the promise rejects. + Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that + the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' isPreview: false isDeprecated: false @@ -41,22 +37,19 @@ methods: type: string - id: options description: >- - Dialog showing options. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) - for more information. + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. type: '' return: - type: '<void>' + type: Promise<void> description: '' - name: 'prompt(message, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' package: '@microsoft/sp-dialog!' fullName: 'prompt(message, options)' summary: >- - Similar to - [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there - are no other secondary dialogs. Otherwise, the promise rejects. + Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is + that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' isPreview: false isDeprecated: false @@ -69,22 +62,19 @@ methods: - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) - for more information. + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. type: '' return: - type: '<string>' + type: Promise<string> description: '' - name: 'show(dialog, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' package: '@microsoft/sp-dialog!' fullName: 'show(dialog, options)' summary: >- - Similar to - [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog#show:member(1)). The dialog to show is passed in as parameter and the dialog is - immediately shown if there are no other secondary dialogs. Otherwise, the - promise rejects. + Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog%23show:member(1)). The dialog to show + is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, + the promise rejects. remarks: '' isPreview: false isDeprecated: false @@ -97,9 +87,8 @@ methods: - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) - for more information. + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. type: '' return: - type: '<void>' + type: Promise<void> description: '' diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index ed6e885a..f71f06f7 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -12,7 +12,6 @@ interfaces: - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - - >- - @microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 6aec09b5..4d9f92ff 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -4,15 +4,12 @@ uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' package: '@microsoft/sp-dynamic-data!' fullName: DynamicDataReference summary: >- - Class that contains the Dynamic Data reference. This includes the source, - property, and property path (if applicable) of Dynamic Data -remarks: >- - The reference string is of the form `:` or - `::` + Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) + of Dynamic Data +remarks: |- + The reference string is of the form `:` or `::` - - Examples of references are: - `WebPart..:myComplexProperty:myArray[0].lastName` + Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` isPreview: false isDeprecated: false type: class @@ -41,21 +38,19 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly property: string;' + content: 'get property(): string;' return: type: string - name: propertyPath uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' package: '@microsoft/sp-dynamic-data!' fullName: propertyPath - summary: >- - Returns the referred property path of the Dynamic Data. Returns undefined - if there is no property path. + summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly propertyPath: string | undefined;' + content: 'get propertyPath(): string | undefined;' return: type: string | undefined - name: reference @@ -67,7 +62,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly reference: string;' + content: 'get reference(): string;' return: type: string - name: sourceId @@ -79,6 +74,6 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly sourceId: string;' + content: 'get sourceId(): string;' return: type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index 9f8cedb1..a7e9eb24 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -4,16 +4,15 @@ uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataAnnotatedPropertyValue summary: >- - Describes the value and the structure of a property value. It contains sample - value of the property and the metadata describing the structure of that value. + Describes the value and the structure of a property value. It contains sample value of the property and the metadata + describing the structure of that value. remarks: '' isPreview: false isDeprecated: false type: interface properties: - name: metadata - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' package: '@microsoft/sp-dynamic-data!' fullName: metadata summary: Metadata describing the sample value of the property. @@ -23,13 +22,9 @@ properties: syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: >- - + type: '' - name: sampleValue - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' package: '@microsoft/sp-dynamic-data!' fullName: sampleValue summary: Sample value of a property diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 4d03e077..7fb597f0 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataCallables summary: >- - Interface for components to implement in order to be dynamic data sources. - This can be implemented as an object with state, or a set of loose functions - that returns the data. + Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with + state, or a set of loose functions that returns the data. remarks: '' isPreview: false isDeprecated: false @@ -16,57 +15,41 @@ methods: uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: allowedEvents() - summary: >- + summary: |- Returns list of allowed events on the dynamic data source. + When this function returns a non-empty result, then source must define 'sendEvent' api. - When this function returns a non-empty result, then source must define - 'sendEvent' api. - - - If this api is not defined or returns an empty array, then no consumer - will be able to talk to this source. + If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. remarks: '' isPreview: true isDeprecated: false syntax: content: 'allowedEvents?(): ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' description: '' - name: getAnnotatedPropertyValue(propertyId) - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getAnnotatedPropertyValue(propertyId) summary: >- - Given a property id, returns its annotated value. If the source doesn't - supply the annotated value, then it falls back to whatever - 'getPropertyValue' returns as the sample value and metadata would be - undefined. + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - getAnnotatedPropertyValue?(propertyId: string): - IDynamicDataAnnotatedPropertyValue | undefined; + content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. type: string return: - type: >- - | undefined + type: ' | undefined' description: '' - name: getPropertyDefinitions() - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getPropertyDefinitions() summary: Returns all the property definitions that the DataSource will provide. @@ -76,14 +59,10 @@ methods: syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' description: '' - name: getPropertyValue(propertyId) - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getPropertyValue(propertyId) summary: 'Given a property id, returns the value of the property.' @@ -104,12 +83,11 @@ methods: package: '@microsoft/sp-dynamic-data!' fullName: 'sendEvent(eventName, data)' summary: >- - If defined, enables the consumer to send data to the associated dynamic - data source. Then source can act accordingly. + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. - Invoking this api throws an error when the passed in 'eventName' is not - one of the allowed events on the source. + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 959f321b..3ad515b0 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -3,12 +3,10 @@ name: IDynamicDataEventDefinition uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataEventDefinition -summary: >- +summary: |- Definition of an event which a dynamic data source accepts. - - It includes the name of the event and description to be seen and used by end - users. + It includes the name of the event and description to be seen and used by end users. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 75fca41a..3edabe15 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyDefinition summary: >- - Definition of a property. It includes the id of the property to be used with - the APIs, along with a user-friendly, localized title and description to be - seen and used by end users. + Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, + localized title and description to be seen and used by end users. remarks: '' isPreview: false isDeprecated: false @@ -17,8 +16,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: id summary: >- - Id of the property. This can only contains letters, numbers, dashes and - underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" + Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or + "time\_in\_24-hour\_clock" remarks: '' isPreview: false isDeprecated: false @@ -26,6 +25,4 @@ properties: content: 'id: string;' return: type: string -extends: >- - +extends: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index e374ca84..ad278993 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -14,8 +14,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: description summary: >- - User-friendly, localized description of the property. Example: "Contains a - list of ids with the files of the current user" + User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the + current user" remarks: '' isPreview: false isDeprecated: false @@ -28,8 +28,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: title summary: >- - User-friendly, localized title of the property. Example: "My files" / "Mis - archivos" (depending of current language) + User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current + language) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 0a881408..55d262ce 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -10,8 +10,7 @@ isDeprecated: false type: interface properties: - name: metadata - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' package: '@microsoft/sp-dynamic-data!' fullName: metadata summary: Metadata describing the sample value of the property. @@ -21,10 +20,5 @@ properties: syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: >- - -extends: >- - + type: '' +extends: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index 4746b4ed..5a0717b8 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -1,13 +1,11 @@ ### YamlMime:TSType name: IDynamicDataPropertyValueMetadataCollection -uid: >- - @microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyValueMetadataCollection summary: >- - A collection of key value pairs, where 'key' is one of the keys from the - property value object and 'value' is the metadata describing the 'key' and its - value. + A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the + metadata describing the 'key' and its value. remarks: >- Important note: @@ -15,8 +13,8 @@ remarks: >- 1. Key in the metadata should match the key in the sample value object. - 2. For arrays, metadataCollection would be same as describing the element of - the array, only once. See below example for more details. + 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example + for more details. For example: @@ -75,7 +73,6 @@ remarks: >- } } } - ``` isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 0b60abcd..a2c93fde 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataSource summary: >- - Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to - identify the data sources and API to get the data. + Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to + get the data. remarks: '' isPreview: false isDeprecated: false @@ -34,133 +34,98 @@ properties: syntax: content: 'metadata: IDynamicDataSourceMetadata;' return: - type: >- - + type: '' methods: - name: allowedEventsAsync() uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: allowedEventsAsync() summary: >- - Returns list of allowed events on the dynamic data source. When this api - returns a non-empty result, then source must define 'sendData' api. + Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source + must define 'sendData' api. - If this api is not defined or returns an empty map, then no consumer will - be able to talk to this source. + If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. remarks: '' isPreview: true isDeprecated: false syntax: - content: >- - allowedEventsAsync?(): - Promise>; + content: 'allowedEventsAsync?(): Promise>;' return: type: >- - <<>> description: '' - name: getAnnotatedPropertyValue(propertyId) - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getAnnotatedPropertyValue(propertyId) summary: >- - Given a property id, returns its annotated value. If the source doesn't - supply the annotated value, then it falls back to whatever - 'getPropertyValue' as the sample value and metadata would be undefined. + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' isPreview: false isDeprecated: true - customDeprecatedMessage: >- - - This API is deprecated. Please use the asynchronous version - `getAsyncAnnotatedPropertyValue` + customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' syntax: - content: >- - getAnnotatedPropertyValue(propertyId: string): - IDynamicDataAnnotatedPropertyValue; + content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. type: string return: - type: >- - + type: '' description: '' - name: getAnnotatedPropertyValueAsync(propertyId) - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getAnnotatedPropertyValueAsync(propertyId) summary: >- - Given a property id, returns its annotated value. If the source doesn't - supply the annotated value, then it falls back to whatever - 'getPropertyValue' as the sample value and metadata would be undefined. + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - getAnnotatedPropertyValueAsync(propertyId: string): - Promise; + content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise;' parameters: - id: propertyId description: Property id for which the value is requested. type: string return: - type: >- - <> + type: 'Promise<>' description: '' - name: getPropertyDefinitions() - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getPropertyDefinitions() summary: >- - Returns all the property definitions for dynamic data. This needs to be - overriden by the implementation of the component. + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. remarks: '' isPreview: false isDeprecated: true - customDeprecatedMessage: >- - - This API is deprecated. Please use the asynchronous version - `getPropertyDefinitionsAsync` + customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' description: '' - name: getPropertyDefinitionsAsync() - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getPropertyDefinitionsAsync() summary: >- - Returns all the property definitions for dynamic data. This needs to be - overriden by the implementation of the component. + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - getPropertyDefinitionsAsync(): - Promise>; + content: 'getPropertyDefinitionsAsync(): Promise>;' return: type: >- - <<>> description: '' - name: getPropertyValue(propertyId) @@ -168,14 +133,12 @@ methods: package: '@microsoft/sp-dynamic-data!' fullName: getPropertyValue(propertyId) summary: >- - Given a property id, returns the value of the property. This needs to be - overriden by the implementation of the component. + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. remarks: '' isPreview: false isDeprecated: true - customDeprecatedMessage: >- - - This API is deprecated. Please use the asynchronous version - `getAsyncPropertyValue` + customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' syntax: content: 'getPropertyValue(propertyId: string): any;' parameters: @@ -186,13 +149,12 @@ methods: type: any description: '' - name: getPropertyValueAsync(propertyId) - uid: >- - @microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getPropertyValueAsync(propertyId) summary: >- - Given a property id, returns the value of the property. This needs to be - overriden by the implementation of the component. + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. remarks: '' isPreview: false isDeprecated: false @@ -203,19 +165,18 @@ methods: description: Property id for which the value is requested. type: string return: - type: '<any>' + type: Promise<any> description: '' - name: 'sendEvent(eventName, data)' uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: 'sendEvent(eventName, data)' summary: >- - If defined, enables the consumer to send data to the associated dynamic - data source. Then source can act accordingly. + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. - Invoking this api throws an error when the passed in 'eventName' is not - one of the allowed events on the source. + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 6badb0b0..7c8845fa 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -3,9 +3,7 @@ name: IDynamicDataSourceMetadata uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataSourceMetadata -summary: >- - Metadata of the Dynamic Data Source. It allows consumers to easily distinguish - Dynamic Data Sources. +summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. remarks: '' isPreview: false isDeprecated: false @@ -16,9 +14,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: alias summary: >- - Alias of the component that the Dynamic Data Source refers to. It can be - undefined when the sources doesn't come from a component, for example - framework level data sources. + Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come + from a component, for example framework level data sources. remarks: '' isPreview: false isDeprecated: false @@ -31,9 +28,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: componentId summary: >- - Id of the component that the Dynamic Data Source refers to. It can be - undefined when the sources doesn't come from a component, for example - framework level data sources. + Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from + a component, for example framework level data sources. remarks: '' isPreview: false isDeprecated: false @@ -58,9 +54,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: instanceId summary: >- - Id of the instance of the component that the Dynamic Data Source refers - to. This allows to distinguish, for example, between two web parts with - the same type. It can be undefined when the sources doesn't come from a + Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for + example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' isPreview: false @@ -74,9 +69,8 @@ properties: package: '@microsoft/sp-dynamic-data!' fullName: title summary: >- - User-friendly, localized title of the Dynamic Data Source. This can be - customized by the component it refers to. By default it's the alias of the - component. + User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. + By default it's the alias of the component. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index ee574133..3a9b777f 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-extension-base!' fullName: BaseExtension summary: The base class for all client-side extensions. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `BaseExtension` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseExtension` class. isPreview: false isDeprecated: false type: class @@ -16,15 +15,11 @@ properties: uid: '@microsoft/sp-extension-base!BaseExtension#context:member' package: '@microsoft/sp-extension-base!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: false isDeprecated: false syntax: @@ -35,19 +30,15 @@ properties: uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' package: '@microsoft/sp-extension-base!' fullName: properties - summary: >- - Extension properties is a JavaScript object that are passed in by the - application that initializes the extension. + summary: Extension properties is a JavaScript object that are passed in by the application that initializes the extension. remarks: >- - Properties can be used in the extension code to define configurable - behaviors. The application has control over what properties to provide to - an instance of the extension, however the most common way would be to have - it stored on the server as JSON and pass it as is to the extension on - initialization. + Properties can be used in the extension code to define configurable behaviors. The application has control over + what properties to provide to an instance of the extension, however the most common way would be to have it stored + on the server as JSON and pass it as is to the extension on initialization. isPreview: false isDeprecated: false syntax: - content: 'protected readonly properties: TProperties;' + content: 'protected get properties(): TProperties;' return: type: TProperties methods: @@ -55,15 +46,13 @@ methods: uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' package: '@microsoft/sp-extension-base!' fullName: onInit() - summary: >- - This event method is called when the client-side extension is first - activated on the page. + summary: This event method is called when the client-side extension is first activated on the page. virtual remarks: '' isPreview: false isDeprecated: false syntax: content: 'protected onInit(): Promise;' return: - type: '<void>' + type: Promise<void> description: '' extends: '' diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 8ebac63f..665f0ed4 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-extension-base!' fullName: ExtensionContext summary: The base class for context objects for client-side extensions. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `ExtensionContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ExtensionContext` class. isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 8b925002..25c68bb6 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -7,8 +7,10 @@ classes: - '@microsoft/sp-http!AadHttpClient:class' - '@microsoft/sp-http!AadHttpClientConfiguration:class' - '@microsoft/sp-http!AadHttpClientFactory:class' + - '@microsoft/sp-http!AadHttpClientResponse:class' - '@microsoft/sp-http!AadTokenProvider:class' - '@microsoft/sp-http!AadTokenProviderFactory:class' + - '@microsoft/sp-http!BeforeRedirectEventArgs:class' - '@microsoft/sp-http!DigestCache:class' - '@microsoft/sp-http!HttpClient:class' - '@microsoft/sp-http!HttpClientConfiguration:class' @@ -30,6 +32,7 @@ interfaces: - '@microsoft/sp-http!IAadHttpClientOptions:interface' - '@microsoft/sp-http!IAadTokenProvider:interface' - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' - '@microsoft/sp-http!IDigestCache:interface' - '@microsoft/sp-http!IHttpClientConfiguration:interface' - '@microsoft/sp-http!IHttpClientConfigurations:interface' diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 468e3118..a0ddf9d4 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -8,10 +8,8 @@ remarks: >- This class is marked as `@sealed`. Subclasses should not extend it. - For communicating with SharePoint, use the - [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. For - communicating with Microsoft Graph, use the - [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. + For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. + For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. isPreview: false isDeprecated: false type: class @@ -25,14 +23,10 @@ constructors: isPreview: false isDeprecated: false syntax: - content: >- - constructor(serviceScope: ServiceScope, resourceEndpoint: string, - options?: IAadHttpClientOptions); + content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);' parameters: - id: serviceScope - description: >- - The service scope is needed to retrieve some of the class's internal - components. + description: The service scope is needed to retrieve some of the class's internal components. type: '' - id: resourceEndpoint description: '' @@ -45,18 +39,14 @@ properties: uid: '@microsoft/sp-http!AadHttpClient.configurations:member' package: '@microsoft/sp-http!' fullName: configurations - summary: >- - The standard predefined AadHttpClientConfiguration objects for use with - the AadHttpClient class. + summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly configurations: IAadHttpClientConfigurations;' return: - type: >- - + type: '' methods: - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' @@ -64,32 +54,29 @@ methods: fullName: 'fetch(url, configuration, options)' summary: Performs a REST service call. remarks: >- - Although the AadHttpClient subclass adds additional enhancements, the - parameters and semantics for HttpClient.fetch() are essentially the same - as the WHATWG API standard that is documented here: + Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for + HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ isPreview: false isDeprecated: false syntax: content: >- - fetch(url: string, configuration: AadHttpClientConfiguration, options: - IHttpClientOptions): Promise; + fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): + Promise; parameters: - id: url description: The endpoint URL that fetch will be called on. type: string - id: configuration description: >- - Determines the default behavior of HttpClient; normally this should - be the latest version number from HttpClientConfigurations. + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. type: '' - id: options description: Additional options that affect the request. type: '' return: - type: >- - <> + type: 'Promise<>' description: A promise that will return the result. - name: 'get(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' @@ -101,24 +88,22 @@ methods: isDeprecated: false syntax: content: >- - get(url: string, configuration: AadHttpClientConfiguration, options?: - IHttpClientOptions): Promise; + get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): + Promise; parameters: - id: url description: The endpoint URL that fetch will be called on. type: string - id: configuration description: >- - Determines the default behavior of HttpClient; normally this should - be the latest version number from HttpClientConfigurations. + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. type: '' - id: options description: Additional options that affect the request. type: '' return: - type: >- - <> + type: 'Promise<>' description: A promise that will return the result. - name: 'post(url, configuration, options)' uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' @@ -130,22 +115,20 @@ methods: isDeprecated: false syntax: content: >- - post(url: string, configuration: AadHttpClientConfiguration, options: - IHttpClientOptions): Promise; + post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): + Promise; parameters: - id: url description: The endpoint URL that fetch will be called on. type: string - id: configuration description: >- - Determines the default behavior of HttpClient; normally this should - be the latest version number from HttpClientConfigurations. + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. type: '' - id: options description: Additional options that affect the request. type: '' return: - type: >- - <> + type: 'Promise<>' description: A promise that will return the result. diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index db528a30..58fdcd15 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -5,11 +5,10 @@ package: '@microsoft/sp-http!' fullName: AadHttpClientConfiguration summary: Configuration for HttpClient. remarks: >- - The HttpClientConfiguration object provides a set of switches for - enabling/disabling various features of the HttpClient class. Normally these - switches are set (e.g. when calling HttpClient.fetch()) by providing one of - the predefined defaults from HttpClientConfigurations, however switches can - also be changed via the HttpClientConfiguration.overrideWith() method. + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. isPreview: false isDeprecated: false type: class @@ -19,27 +18,20 @@ constructors: package: '@microsoft/sp-http!' fullName: '(constructor)(flags, overrideFlags)' summary: >- - Constructs a new instance of HttpClientConfiguration with the specified - flags. The default values will be used for any flags that are missing or - undefined. If overrideFlags is specified, it takes precedence over flags. + Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for + any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - constructor(flags: IAadHttpClientConfiguration, overrideFlags?: - IAadHttpClientConfiguration); + content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' parameters: - id: flags description: '' - type: >- - + type: '' - id: overrideFlags description: '' - type: >- - + type: '' properties: - name: flags uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' @@ -52,9 +44,7 @@ properties: syntax: content: 'protected flags: IAadHttpClientConfiguration;' return: - type: >- - + type: '' methods: - name: overrideWith(sourceFlags) uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' @@ -65,17 +55,13 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- + content: |- /** @override */ - - overrideWith(sourceFlags: IAadHttpClientConfiguration): - AadHttpClientConfiguration; + overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; parameters: - id: sourceFlags description: '' - type: >- - + type: '' return: type: '' description: '' diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index dbde757e..b61f8c62 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -4,13 +4,11 @@ uid: '@microsoft/sp-http!AadHttpClientFactory:class' package: '@microsoft/sp-http!' fullName: AadHttpClientFactory summary: >- - Returns a preinitialized version of the AadHttpClient for a given resource - url. For more information: + Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `AadHttpClientFactory` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AadHttpClientFactory` class. isPreview: false isDeprecated: false type: class @@ -27,16 +25,16 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - <> + <> methods: - name: getClient(resourceEndpoint) uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' package: '@microsoft/sp-http!' fullName: getClient(resourceEndpoint) summary: >- - Returns an instance of the AadHttpClient that communicates with the - current tenant's configurable Service Principal. + Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service + Principal. remarks: '' isPreview: false isDeprecated: false @@ -47,7 +45,5 @@ methods: description: The target AAD application's resource endpoint. type: string return: - type: >- - <> + type: 'Promise<>' description: '' diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml new file mode 100644 index 00000000..4f925716 --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: AadHttpClientResponse +uid: '@microsoft/sp-http!AadHttpClientResponse:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClientResponse +summary: >- + The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends + HttpClientResponse adding additional functionality specific to the AadHttpClient. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(response, tokenFetchRequestTime)' + uid: '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(response, tokenFetchRequestTime)' + summary: Constructs a new instance of the `AadHttpClientResponse` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(response: Response, tokenFetchRequestTime: number);' + parameters: + - id: response + description: '' + type: Response + - id: tokenFetchRequestTime + description: '' + type: number +extends: '' diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 97f39605..cdf48e47 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -7,64 +7,69 @@ summary: >- This class allows a developer to obtain OAuth2 tokens from Azure AD. - OAuth2 tokens are used to authenticate the user from the SharePoint page to - other services such as PowerBI, Sway, Exchange, Yammer, etc. + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. remarks: >- This class is marked as `@sealed`. Subclasses should not extend it. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `AadTokenProvider` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AadTokenProvider` class. isPreview: false isDeprecated: false type: class -properties: - - name: tokenAcquisitionEvent - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' - package: '@microsoft/sp-http!' - fullName: tokenAcquisitionEvent - summary: Notifies the developer when Token Acquisition requires user action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly tokenAcquisitionEvent: SPEvent;' - return: - type: >- - <> methods: - name: 'getToken(resourceEndpoint, useCachedToken)' uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' package: '@microsoft/sp-http!' fullName: 'getToken(resourceEndpoint, useCachedToken)' - summary: >- - Fetches the AAD OAuth2 token for a resource if the user that's currently - logged in has access to that resource. - + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. - The OAuth2 token should not be cached by the caller since it is already - cached by the method itself. + The OAuth2 token should not be cached by the caller since it is already cached by the method itself. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - getToken(resourceEndpoint: string, useCachedToken?: boolean): - Promise; + content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' parameters: - id: resourceEndpoint description: the resource for which the token should be obtained type: string - id: useCachedToken description: >- - Allows the developer to specify if cached tokens should be returned. - An example of a resourceEndpoint would be - https://graph.microsoft.com + Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would + be https://graph.microsoft.com type: boolean return: - type: '<string>' - description: >- - A promise that will be fullfiled with the token or that will reject - with an error message + type: Promise<string> + description: A promise that will be fullfiled with the token or that will reject with an error message +events: + - name: onBeforeRedirectEvent + uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' + package: '@microsoft/sp-http!' + fullName: onBeforeRedirectEvent + summary: Notifies the developer before a full page redirect occurs. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + type: >- + <> + - name: tokenAcquisitionEvent + uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' + package: '@microsoft/sp-http!' + fullName: tokenAcquisitionEvent + summary: Notifies the developer when Token Acquisition requires user action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get tokenAcquisitionEvent(): SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index f351e8ed..27c7c3be 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -21,23 +21,21 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - <> + <> methods: - name: getTokenProvider() uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' package: '@microsoft/sp-http!' fullName: getTokenProvider() summary: >- - Returns an instance of the AadTokenProvider that communicates with the - current tenant's configurable Service Principal. + Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service + Principal. remarks: '' isPreview: false isDeprecated: false syntax: content: 'getTokenProvider(): Promise;' return: - type: >- - <> + type: 'Promise<>' description: '' diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml new file mode 100644 index 00000000..9beb6acb --- /dev/null +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: BeforeRedirectEventArgs +uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' +package: '@microsoft/sp-http!' +fullName: BeforeRedirectEventArgs +summary: Arguments for before redirecting for a full page authentication +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(redirectUrl, cancel)' + uid: '@microsoft/sp-http!BeforeRedirectEventArgs:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(redirectUrl, cancel)' + summary: Constructs a new instance of the `BeforeRedirectEventArgs` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(redirectUrl: string, cancel: () => void);' + parameters: + - id: redirectUrl + description: '' + type: string + - id: cancel + description: '' + type: () => void +properties: + - name: cancel + uid: '@microsoft/sp-http!BeforeRedirectEventArgs#cancel:member' + package: '@microsoft/sp-http!' + fullName: cancel + summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'cancel: () => void;' + return: + type: () => void + - name: redirectUrl + uid: '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' + fullName: redirectUrl + summary: The url of the page to redirect to if automatic redirect is cancelled + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 239f3fe8..ecba9db7 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -4,16 +4,13 @@ uid: '@microsoft/sp-http!DigestCache:class' package: '@microsoft/sp-http!' fullName: DigestCache summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache - of request digests for each SPWeb URL. A request digest is a security token - that the SharePoint server requires for for any REST write operation, - specified via the "X-RequestDigest" HTTP header. It is obtained by calling the - "/\_api/contextinfo" REST endpoint, and expires after a server configurable - amount of time. + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A + request digest is a security token that the SharePoint server requires for for any REST write operation, specified via + the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after + a server configurable amount of time. - For more information, see the MSDN article ["Complete basic operations using - SharePoint 2013 REST + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' isPreview: false @@ -55,36 +52,28 @@ methods: package: '@microsoft/sp-http!' fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' summary: >- - Inserts a specific request digest value into the cache. Normally this is - unnecessary because the framework will automatically issue a REST request - to fetch the digest when necessary; however, in advanced scenarios + Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will + automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - addDigestToCache(webUrl: string, digestValue: string, - expirationTimestamp: number): void; + content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' parameters: - id: webUrl - description: >- - The URL of the SPWeb that the API call will be issued to. This may - be a server-relative or absolute URL. + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. type: string - id: digestValue description: >- - The digest value, which is an opaque that must be generated by the - SharePoint server. The syntax will look something like this: - "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look + something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" type: string - id: expirationTimestamp description: >- - A future point in time, as measured by performance.now(), after - which the digest value will no longer be valid. NOTE: The - expirationTime is a DOMHighResTimeStamp value whose units are - fractional milliseconds; for example, to specify an expiration "5 - seconds from right now", use performance.now()+5000. + A future point in time, as measured by performance.now(), after which the digest value will no longer be + valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for + example, to specify an expiration "5 seconds from right now", use performance.now()+5000. type: number return: type: void @@ -107,9 +96,8 @@ methods: package: '@microsoft/sp-http!' fullName: clearDigest(webUrl) summary: >- - Clears the cached digest for the specified SPWeb URL. This operation is - useful e.g. if an error indicates that a digest was invalidated prior to - its expiration time. + Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a + digest was invalidated prior to its expiration time. remarks: '' isPreview: false isDeprecated: false @@ -117,9 +105,7 @@ methods: content: 'clearDigest(webUrl: string): boolean;' parameters: - id: webUrl - description: >- - The URL of the SPWeb whose digest should be cleared. This may be a - server-relative or absolute URL. + description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. type: string return: type: boolean @@ -129,9 +115,8 @@ methods: package: '@microsoft/sp-http!' fullName: fetchDigest(webUrl) summary: >- - Returns a digest string for the specified SPWeb URL. If the cache already - contains a usable value, the promise is fulfilled immediately. Otherwise, - the promise will be pending and resolve after an HTTP request obtains the + Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is + fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' isPreview: false @@ -140,10 +125,8 @@ methods: content: 'fetchDigest(webUrl: string): Promise;' parameters: - id: webUrl - description: >- - The URL of the SPWeb that the API call will be issued to. This may - be a server-relative or absolute URL. + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. type: string return: - type: '<string>' + type: Promise<string> description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index e42c3329..3186c248 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -64,9 +64,7 @@ properties: syntax: content: 'urlComponents: URLComponents;' return: - type: >- - + type: '' methods: - name: buildFullUrl() uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' @@ -134,12 +132,9 @@ methods: type: any - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: del(callback) uid: '@microsoft/sp-http!GraphRequest#del:member(1)' @@ -154,12 +149,9 @@ methods: parameters: - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: delete(callback) uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' @@ -174,12 +166,9 @@ methods: parameters: - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: expand(properties) uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' @@ -228,12 +217,9 @@ methods: parameters: - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: getStream(callback) uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' @@ -248,10 +234,7 @@ methods: parameters: - id: callback description: '' - type: >- - + type: '' return: type: void description: '' @@ -348,12 +331,9 @@ methods: type: any - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: 'post(content, callback)' uid: '@microsoft/sp-http!GraphRequest#post:member(1)' @@ -371,12 +351,9 @@ methods: type: any - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: 'put(content, callback)' uid: '@microsoft/sp-http!GraphRequest#put:member(1)' @@ -394,12 +371,9 @@ methods: type: any - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: 'putStream(stream, callback)' uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' @@ -417,10 +391,7 @@ methods: type: any - id: callback description: '' - type: >- - + type: '' return: type: void description: '' @@ -548,12 +519,9 @@ methods: type: any - id: callback description: '' - type: >- - + type: '' return: - type: '<any>' + type: Promise<any> description: '' - name: version(v) uid: '@microsoft/sp-http!GraphRequest#version:member(1)' diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 0e78cf13..2ee450e5 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -3,12 +3,8 @@ name: HttpClient uid: '@microsoft/sp-http!HttpClient:class' package: '@microsoft/sp-http!' fullName: HttpClient -summary: >- - HttpClient implements a basic set of features for performing REST operations - against a generic service. -remarks: >- - For communicating with SharePoint, use the - [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. +summary: HttpClient implements a basic set of features for performing REST operations against a generic service. +remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' isPreview: false isDeprecated: false type: class @@ -32,9 +28,7 @@ properties: uid: '@microsoft/sp-http!HttpClient.configurations:member' package: '@microsoft/sp-http!' fullName: configurations - summary: >- - The standard predefined HttpClientConfiguration objects for use with the - HttpClient class. + summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. remarks: '' isPreview: false isDeprecated: false @@ -54,8 +48,8 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - <> + <> methods: - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' @@ -63,39 +57,34 @@ methods: fullName: 'fetch(url, configuration, options)' summary: Performs a REST service call. remarks: >- - Although the SPHttpClient subclass adds additional enhancements, the - parameters and semantics for HttpClient.fetch() are essentially the same - as the WHATWG API standard that is documented here: + Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for + HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ isPreview: false isDeprecated: false syntax: content: >- - fetch(url: string, configuration: HttpClientConfiguration, options: - IHttpClientOptions): Promise; + fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of HttpClient; normally this should - be the latest version number from HttpClientConfigurations + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations type: '' - id: options description: additional options that affect the request type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. - name: 'get(url, configuration, options)' uid: '@microsoft/sp-http!HttpClient#get:member(1)' package: '@microsoft/sp-http!' @@ -106,31 +95,27 @@ methods: isDeprecated: false syntax: content: >- - get(url: string, configuration: HttpClientConfiguration, options?: - IHttpClientOptions): Promise; + get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of HttpClient; normally this should - be the latest version number from HttpClientConfigurations + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations type: '' - id: options description: additional options that affect the request type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. - name: 'post(url, configuration, options)' uid: '@microsoft/sp-http!HttpClient#post:member(1)' package: '@microsoft/sp-http!' @@ -141,28 +126,24 @@ methods: isDeprecated: false syntax: content: >- - post(url: string, configuration: HttpClientConfiguration, options: - IHttpClientOptions): Promise; + post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of HttpClient; normally this should - be the latest version number from HttpClientConfigurations + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations type: '' - id: options description: additional options that affect the request type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index ad06305e..68207a10 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -5,11 +5,10 @@ package: '@microsoft/sp-http!' fullName: HttpClientConfiguration summary: Configuration for HttpClient. remarks: >- - The HttpClientConfiguration object provides a set of switches for - enabling/disabling various features of the HttpClient class. Normally these - switches are set (e.g. when calling HttpClient.fetch()) by providing one of - the predefined defaults from HttpClientConfigurations, however switches can - also be changed via the HttpClientConfiguration.overrideWith() method. + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. isPreview: false isDeprecated: false type: class @@ -19,16 +18,13 @@ constructors: package: '@microsoft/sp-http!' fullName: '(constructor)(flags, overrideFlags)' summary: >- - Constructs a new instance of HttpClientConfiguration with the specified - flags. The default values will be used for any flags that are missing or - undefined. If overrideFlags is specified, it takes precedence over flags. + Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for + any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - constructor(flags: IHttpClientConfiguration, overrideFlags?: - IHttpClientConfiguration); + content: 'constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);' parameters: - id: flags description: '' @@ -69,18 +65,14 @@ methods: uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' package: '@microsoft/sp-http!' fullName: overrideWith(sourceFlags) - summary: >- - Child classes should override this method to construct the child class - type, rather than the base class type. + summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' remarks: '' isPreview: false isDeprecated: false syntax: - content: >- + content: |- /** @virtual */ - - overrideWith(sourceFlags: IHttpClientConfiguration): - HttpClientConfiguration; + overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; parameters: - id: sourceFlags description: '' diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index bdf2989a..95613159 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -5,13 +5,11 @@ package: '@microsoft/sp-http!' fullName: HttpClientResponse summary: The Response subclass returned by methods such as HttpClient.fetch(). remarks: >- - This is a placeholder. In the future, additional HttpClient-specific - functionality may be added to this class. + This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `HttpClientResponse` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `HttpClientResponse` class. isPreview: false isDeprecated: false type: class @@ -20,30 +18,26 @@ properties: uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' package: '@microsoft/sp-http!' fullName: bodyUsed - summary: >- - See documentation for the browser's - [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly bodyUsed: boolean;' + content: 'get bodyUsed(): boolean;' return: type: boolean - name: headers uid: '@microsoft/sp-http!HttpClientResponse#headers:member' package: '@microsoft/sp-http!' fullName: headers - summary: >- - See documentation for the browser's - [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly headers: Headers;' + content: 'get headers(): Headers;' return: - type: '' + type: Headers - name: nativeResponse uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' package: '@microsoft/sp-http!' @@ -55,75 +49,65 @@ properties: syntax: content: 'protected nativeResponse: Response;' return: - type: '' + type: Response - name: ok uid: '@microsoft/sp-http!HttpClientResponse#ok:member' package: '@microsoft/sp-http!' fullName: ok - summary: >- - See documentation for the browser's - [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly ok: boolean;' + content: 'get ok(): boolean;' return: type: boolean - name: status uid: '@microsoft/sp-http!HttpClientResponse#status:member' package: '@microsoft/sp-http!' fullName: status - summary: >- - See documentation for the browser's - [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly status: number;' + content: 'get status(): number;' return: type: number - name: statusText uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' package: '@microsoft/sp-http!' fullName: statusText - summary: >- - See documentation for the browser's - [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly statusText: string;' + content: 'get statusText(): string;' return: type: string - name: type uid: '@microsoft/sp-http!HttpClientResponse#type:member' package: '@microsoft/sp-http!' fullName: type - summary: >- - See documentation for the browser's - [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly type: ResponseType;' + content: 'get type(): ResponseType;' return: - type: '' + type: ResponseType - name: url uid: '@microsoft/sp-http!HttpClientResponse#url:member' package: '@microsoft/sp-http!' fullName: url - summary: >- - See documentation for the browser's - [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly url: string;' + content: 'get url(): string;' return: type: string methods: @@ -131,33 +115,27 @@ methods: uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' package: '@microsoft/sp-http!' fullName: arrayBuffer() - summary: >- - See documentation for the browser's - [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' isPreview: false isDeprecated: false syntax: content: 'arrayBuffer(): Promise;' return: - type: >- - <> + type: Promise<ArrayBuffer> description: '' - name: blob() uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' package: '@microsoft/sp-http!' fullName: blob() - summary: >- - See documentation for the browser's - [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' isPreview: false isDeprecated: false syntax: content: 'blob(): Promise;' return: - type: '<>' + type: Promise<Blob> description: '' - name: clone() uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' @@ -178,46 +156,38 @@ methods: uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' package: '@microsoft/sp-http!' fullName: formData() - summary: >- - See documentation for the browser's - [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' isPreview: false isDeprecated: false syntax: content: 'formData(): Promise;' return: - type: >- - <> + type: Promise<FormData> description: '' - name: json() uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' package: '@microsoft/sp-http!' fullName: json() - summary: >- - See documentation for the browser's - [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' isPreview: false isDeprecated: false syntax: content: 'json(): Promise;' return: - type: '<any>' + type: Promise<any> description: '' - name: text() uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' package: '@microsoft/sp-http!' fullName: text() - summary: >- - See documentation for the browser's - [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' isPreview: false isDeprecated: false syntax: content: 'text(): Promise;' return: - type: '<string>' + type: Promise<string> description: '' diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index d2fa1cd7..d7240840 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -5,12 +5,10 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientConfigurations summary: Standard configurations for AadHttpClient. remarks: >- - This interface provides standard predefined AadHttpClientConfiguration objects - for use with the AadHttpClient class. In general, clients should choose the - latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the - future, a new version number will be introduced, which ensures that existing - code will continue to function the way it did at the time when it was tested.) + This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. + In general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) isPreview: false isDeprecated: false type: interface @@ -20,9 +18,8 @@ properties: package: '@microsoft/sp-http!' fullName: v1 summary: >- - This configuration turns off every feature switch for AadHttpClient. The - fetch() behavior will be essentially identical to the WHATWG standard API - that is documented here: https://fetch.spec.whatwg.org/ + This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially + identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index a8a89fe2..031fa096 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -21,9 +21,7 @@ properties: syntax: content: 'configuration?: IAadTokenProviderConfiguration;' return: - type: >- - + type: '' - name: tokenProvider uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' package: '@microsoft/sp-http!' @@ -41,9 +39,7 @@ properties: uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' package: '@microsoft/sp-http!' fullName: useCachedToken - summary: >- - Allows the developer to specify if cached tokens should be use for the - current request. + summary: Allows the developer to specify if cached tokens should be use for the current request. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 91c1d4a7..4da118d9 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -7,53 +7,31 @@ summary: >- This class allows a developer to obtain OAuth2 tokens from Azure AD. - OAuth2 tokens are used to authenticate the user from the SharePoint page to - other services such as PowerBI, Sway, Exchange, Yammer, etc. + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. remarks: >- - AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for - authentication with ADAL.js. At some point in the near future, when Azure AD - v2.0 can support the same scenarios as the original version, we will switch to + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some + point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL. isPreview: false isDeprecated: false type: interface -properties: - - name: tokenAcquisitionEvent - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' - package: '@microsoft/sp-http!' - fullName: tokenAcquisitionEvent - summary: Notifies the developer when Token Acquistion requires user action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly tokenAcquisitionEvent: SPEvent;' - return: - type: >- - <> methods: - name: 'getToken(resourceEndpoint, useCachedToken)' uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' package: '@microsoft/sp-http!' fullName: 'getToken(resourceEndpoint, useCachedToken)' - summary: >- - Fetches the AAD OAuth2 token for a resource if the user that's currently - logged in has access to that resource. - - - The OAuth2 token SHOULD NOT be cached by the caller since it is already - cached by the method itself. + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. An example of a resourceEndpoint would be https://sdfpilot.outlook.com remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - getToken(resourceEndpoint: string, useCachedToken?: boolean): - Promise; + content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' parameters: - id: resourceEndpoint description: the resource for which the token should be obtained @@ -62,7 +40,34 @@ methods: description: Allows the developer to specify if cached tokens should be returned. type: boolean return: - type: '<string>' - description: >- - A promise that will be fullfiled with the token or that will reject - with an error message + type: Promise<string> + description: A promise that will be fullfiled with the token or that will reject with an error message +events: + - name: onBeforeRedirectEvent + uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' + package: '@microsoft/sp-http!' + fullName: onBeforeRedirectEvent + summary: Notifies the developer before a full page redirect occurs. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + type: >- + <> + - name: tokenAcquisitionEvent + uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' + package: '@microsoft/sp-http!' + fullName: tokenAcquisitionEvent + summary: Notifies the developer when Token Acquistion requires user action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tokenAcquisitionEvent: SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index a8c9f085..a563468c 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -13,9 +13,7 @@ properties: uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' package: '@microsoft/sp-http!' fullName: aadInstanceUrl - summary: >- - The sign in page used to authenticate with Azure Active Directory. - Trailing slashes are forbidden. + summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. remarks: '' isPreview: false isDeprecated: false @@ -23,6 +21,18 @@ properties: content: 'aadInstanceUrl: string;' return: type: string + - name: aadSessionId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' + package: '@microsoft/sp-http!' + fullName: aadSessionId + summary: The current Azure Active Directory's session id. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'aadSessionId: string;' + return: + type: string - name: aadTenantId uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' package: '@microsoft/sp-http!' @@ -40,8 +50,8 @@ properties: package: '@microsoft/sp-http!' fullName: aadUserId summary: >- - The user's Azure Active Directory id. This will be used to ensure that a - valid cached token is for the current user. + The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current + user. remarks: '' isPreview: false isDeprecated: false @@ -54,8 +64,8 @@ properties: package: '@microsoft/sp-http!' fullName: redirectUri summary: >- - The page used to retrieve tokens from Azure Active Directory. This url - must be listed in the developer's application redirect uris. + The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's + application redirect uris. remarks: '' isPreview: false isDeprecated: false @@ -64,8 +74,7 @@ properties: return: type: string - name: servicePrincipalId - uid: >- - @microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' package: '@microsoft/sp-http!' fullName: servicePrincipalId summary: The client ID of the developer's Azure Active Directory application. @@ -81,8 +90,8 @@ properties: package: '@microsoft/sp-http!' fullName: userEmail summary: >- - The user's email address. This will be used to ensure that the current - user's identity is used for fetching auth tokens. + The user's email address. This will be used to ensure that the current user's identity is used for fetching auth + tokens. remarks: '' isPreview: false isDeprecated: true @@ -96,10 +105,9 @@ properties: package: '@microsoft/sp-http!' fullName: userPrincipalName summary: >- - The user's principal name. This will be used to ensure that the current - user's identity is used for fetching auth tokens. This parameter will - avoid the "Request is ambiguous: multiple user identities are avaliable - for the current request" error. + The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth + tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the + current request" error. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml new file mode 100644 index 00000000..cbf4c480 --- /dev/null +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: IBeforeRedirectEventArgs +uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' +package: '@microsoft/sp-http!' +fullName: IBeforeRedirectEventArgs +summary: Represents arguments used before redirecting event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: cancel + uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#cancel:member' + package: '@microsoft/sp-http!' + fullName: cancel + summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'cancel: () => void;' + return: + type: () => void + - name: redirectUrl + uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' + fullName: redirectUrl + summary: The url of the page to redirect to if automatic redirect is cancelled + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 9503e6ac..bdc99345 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -4,16 +4,13 @@ uid: '@microsoft/sp-http!IDigestCache:interface' package: '@microsoft/sp-http!' fullName: IDigestCache summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache - of request digests for each SPWeb URL. A request digest is a security token - that the SharePoint server requires for for any REST write operation, - specified via the "X-RequestDigest" HTTP header. It is obtained by calling the - "/\_api/contextinfo" REST endpoint, and expires after a server configurable - amount of time. + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A + request digest is a security token that the SharePoint server requires for for any REST write operation, specified via + the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after + a server configurable amount of time. - For more information, see the MSDN article ["Complete basic operations using - SharePoint 2013 REST + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' isPreview: false @@ -25,36 +22,28 @@ methods: package: '@microsoft/sp-http!' fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' summary: >- - Inserts a specific request digest value into the cache. Normally this is - unnecessary because the framework will automatically issue a REST request - to fetch the digest when necessary; however, in advanced scenarios + Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will + automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - addDigestToCache(webUrl: string, digestValue: string, - expirationTimestamp: number): void; + content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' parameters: - id: webUrl - description: >- - The URL of the SPWeb that the API call will be issued to. This may - be a server-relative or absolute URL. + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. type: string - id: digestValue description: >- - The digest value, which is an opaque that must be generated by the - SharePoint server. The syntax will look something like this: - "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look + something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" type: string - id: expirationTimestamp description: >- - A future point in time, as measured by performance.now(), after - which the digest value will no longer be valid. NOTE: The - expirationTime is a DOMHighResTimeStamp value whose units are - fractional milliseconds; for example, to specify an expiration "5 - seconds from right now", use performance.now()+5000. + A future point in time, as measured by performance.now(), after which the digest value will no longer be + valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for + example, to specify an expiration "5 seconds from right now", use performance.now()+5000. type: number return: type: void @@ -77,9 +66,8 @@ methods: package: '@microsoft/sp-http!' fullName: clearDigest(webUrl) summary: >- - Clears the cached digest for the specified SPWeb URL. This operation is - useful e.g. if an error indicates that a digest was invalidated prior to - its expiration time. + Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a + digest was invalidated prior to its expiration time. remarks: '' isPreview: false isDeprecated: false @@ -87,9 +75,7 @@ methods: content: 'clearDigest(webUrl: string): boolean;' parameters: - id: webUrl - description: >- - The URL of the SPWeb whose digest should be cleared. This may be a - server-relative or absolute URL. + description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. type: string return: type: boolean @@ -99,9 +85,8 @@ methods: package: '@microsoft/sp-http!' fullName: fetchDigest(webUrl) summary: >- - Returns a digest string for the specified SPWeb URL. If the cache already - contains a usable value, the promise is fulfilled immediately. Otherwise, - the promise will be pending and resolve after an HTTP request obtains the + Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is + fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' isPreview: false @@ -110,10 +95,8 @@ methods: content: 'fetchDigest(webUrl: string): Promise;' parameters: - id: webUrl - description: >- - The URL of the SPWeb that the API call will be issued to. This may - be a server-relative or absolute URL. + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. type: string return: - type: '<string>' + type: Promise<string> description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 2c1c3317..23fad171 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -5,12 +5,10 @@ package: '@microsoft/sp-http!' fullName: IHttpClientConfigurations summary: Standard configurations for HttpClient. remarks: >- - This interface provides standard predefined HttpClientConfiguration objects - for use with the HttpClient class. In general, clients should choose the - latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the - future, a new version number will be introduced, which ensures that existing - code will continue to function the way it did at the time when it was tested.) + This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In + general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) isPreview: false isDeprecated: false type: interface @@ -20,9 +18,8 @@ properties: package: '@microsoft/sp-http!' fullName: v1 summary: >- - This configuration turns off every feature switch for HttpClient. The - fetch() behavior will be essentially identical to the WHATWG standard API - that is documented here: https://fetch.spec.whatwg.org/ + This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially + identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index b74eb3bf..4db2f088 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -5,10 +5,9 @@ package: '@microsoft/sp-http!' fullName: IHttpClientOptions summary: Options for HttpClient remarks: >- - This interface defines the options for the HttpClient operations such as - get(), post(), fetch(), etc. It is based on the whatwg API standard parameters - that are documented here: https://fetch.spec.whatwg.org/ + This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on + the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ isPreview: false isDeprecated: false type: interface -extends: '' +extends: RequestInit diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index fd1262db..71ffece7 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -5,13 +5,10 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchConfigurations summary: Standard configurations for SPHttpClient. remarks: >- - This interface provides standard predefined SPHttpClientBatchConfiguration - objects for use with the SPHttpClientBatch class. In general, clients should - choose the latest available version number, which enables all the switches - that are recommended for typical scenarios. (If new switches are introduced in - the future, a new version number will be introduced, which ensures that - existing code will continue to function the way it did at the time when it was - tested.) + This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch + class. In general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) isPreview: true isDeprecated: false type: interface @@ -20,9 +17,7 @@ properties: uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' package: '@microsoft/sp-http!' fullName: v1 - summary: >- - Version 1 enables these switches: consoleLogging = true; jsonRequest = - true; jsonResponse = true + summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 4b22984e..8b7f94f9 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -3,9 +3,7 @@ name: ISPHttpClientBatchCreationOptions uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchCreationOptions -summary: >- - This interface is passed to the SPHttpClientBatch constructor. It specifies - options that affect the entire batch. +summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. remarks: '' isPreview: true isDeprecated: false @@ -17,11 +15,9 @@ properties: fullName: webUrl summary: >- SPHttpClientBatch will need to perform its POST to an endpoint such as - "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL - ("https://example.com/sites/sample" in this example) can be guessed by - looking for a reserved URL segment such as "\_api" in the first URL passed - to fetch(), but if not, the webUrl can be explicitly specified using this - option. + "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in + this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to + fetch(), but if not, the webUrl can be explicitly specified using this option. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 87488d13..70eb681a 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchOptions summary: >- - This interface defines the options for an individual REST request that is part - of an SPHttpClientBatch. It is based on the WHATWG API standard parameters - that are documented here: https://fetch.spec.whatwg.org/ + This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on + the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index 9a8b7338..0c3a659f 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -18,13 +18,11 @@ properties: When this switch is true: - If the "Content-Type" header was not explicitly added for the request, - then SPHttpClient will add it if the request is a write operation (i.e. an - HTTP method other than "GET", "HEAD", or "OPTIONS"). + If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). - For OData 3.0, the value is - 'application/json;odata=verbose;charset=utf-8'. + For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. For OData 4.0, the value is 'application/json;charset=utf-8'. @@ -39,17 +37,13 @@ properties: package: '@microsoft/sp-http!' fullName: jsonResponse summary: Automatically configure the "Accept" header for a JSON payload. - remarks: >- + remarks: |- When this switch is true: - - If the "Accept" header was not explicitly added for the request, then - SPHttpClient will add it. - + If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. For OData 3.0, the value is 'application/json'. - For OData 4.0, the value is 'application/json;odata.metadata=minimal'. isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 8baf0251..7e4b8727 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -15,13 +15,12 @@ properties: fullName: defaultODataVersion summary: Automatically configure the "OData-Version" header. remarks: >- - When this switch is specified (i.e. not undefined): If the "OData-Version" - header was not explicitly added for the request, then SPHttpClient will - add the header to specify the version indicated by defaultODataVersion. + When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the + request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. - NOTE: Without an 'OData-Version' header, the SharePoint server currently - defaults to Version 3.0 in most cases. The recommended version is 4.0. + NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. + The recommended version is 4.0. isPreview: false isDeprecated: false syntax: @@ -29,8 +28,7 @@ properties: return: type: '' - name: defaultSameOriginCredentials - uid: >- - @microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member + uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' package: '@microsoft/sp-http!' fullName: defaultSameOriginCredentials summary: Automatically configure the RequestInit.credentials. @@ -38,13 +36,11 @@ properties: When this switch is true: - If RequestInit.credentials is not explicitly specified for the request, - then SPHttpClient will assign it to be "same-origin". Without this switch, - different web browsers may apply different defaults. + If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be + "same-origin". Without this switch, different web browsers may apply different defaults. - For more information, see the spec: - https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials isPreview: false isDeprecated: false syntax: @@ -60,11 +56,9 @@ properties: When this switch is true: - If the "X-RequestDigest" header was not explicitly added for the request, - then SPHttpClient will add it if the request is a write operation (i.e. an - HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an - additional network request may be performed. + If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index db70bb9b..af67baf8 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -5,12 +5,10 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientConfigurations summary: Standard configurations for SPHttpClient. remarks: >- - This interface provides standard predefined SPHttpClientConfiguration objects - for use with the SPHttpClient class. In general, clients should choose the - latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the - future, a new version number will be introduced, which ensures that existing - code will continue to function the way it did at the time when it was tested.) + This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In + general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) isPreview: false isDeprecated: false type: interface @@ -23,9 +21,8 @@ properties: Version 1 enables these switches: - consoleLogging = true; jsonRequest = true; jsonResponse = true; - defaultSameOriginCredentials = true; defaultODataVersion = - ODataVersion.v4; requestDigest = true + consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; + defaultODataVersion = ODataVersion.v4; requestDigest = true remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 6cc85462..f85a09fe 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' package: '@microsoft/sp-http!' fullName: ISPHttpClientOptions summary: >- - This interface defines the options for the SPHttpClient operations such as - get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters - that are documented here: https://fetch.spec.whatwg.org/ + This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on + the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' isPreview: false isDeprecated: false @@ -18,14 +17,11 @@ properties: fullName: webUrl summary: Configure the SPWeb URL for authentication. remarks: >- - For a write operation, SPHttpClient will automatically add the - "X-RequestDigest" header, which may need to be fetched using a seperate - request such as "https://example.com/sites/sample/\_api/contextinfo". - Typically the SPWeb URL ("https://example.com/sites/sample" in this - example) can be guessed by looking for a reserved URL segment such as - "\_api" in the original REST query, however certain REST endpoints do not - contain a reserved URL segment; in this case, the webUrl can be explicitly - specified using this option. + For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be + fetched using a seperate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the SPWeb + URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such + as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in + this case, the webUrl can be explicitly specified using this option. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 2e224bf8..e64e15a3 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -5,20 +5,18 @@ package: '@microsoft/sp-http!' fullName: MSGraphClient summary: MSGraphClient is used to perform REST calls against Microsoft Graph. remarks: >- - The Microsoft Graph JavaScript client library is a lightweight wrapper around - the Microsoft Graph API. This class allows developers to start making REST - calls to MSGraph without needing to initialize the the MSGraph client library. - If a custom configuration is desired, the MSGraphClient api function needs to - be provided with that custom configuration for every request. + The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class + allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. + If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom + configuration for every request. For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `MSGraphClient` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClient` class. isPreview: false isDeprecated: false type: class @@ -27,18 +25,14 @@ methods: uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' package: '@microsoft/sp-http!' fullName: 'api(path, config)' - summary: >- - All calls to Microsoft Graph are chained together starting with the api - function. + summary: All calls to Microsoft Graph are chained together starting with the api function. remarks: >- - Path supports the following formats: \* me \* /me \* - https://graph.microsoft.com/v1.0/me \* https://graph.microsoft.com/beta/me - \* me/events?$filter=startswith(subject, 'ship') + Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* + https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship') - The authProvider and baseUrl option should not be used, as they have - already been provided by the framework. See the official documentation - here: https://github.com/microsoftgraph/msgraph-sdk-javascript + The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See + the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 554abc94..555d8d00 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -7,9 +7,8 @@ summary: >- Returns a preinitialized version of the MSGraphClient. For more information: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `MSGraphClientFactory` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClientFactory` class. isPreview: false isDeprecated: false type: class @@ -26,23 +25,21 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - <> + <> methods: - name: getClient() uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' package: '@microsoft/sp-http!' fullName: getClient() summary: >- - Returns an instance of the MSGraphClient that communicates with the - current tenant's configurable Service Principal. + Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service + Principal. remarks: '' isPreview: false isDeprecated: false syntax: content: 'getClient(): Promise;' return: - type: >- - <> + type: 'Promise<>' description: '' diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 4c76f1f3..d212fcdc 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -3,9 +3,7 @@ name: ODataVersion uid: '@microsoft/sp-http!ODataVersion:class' package: '@microsoft/sp-http!' fullName: ODataVersion -summary: >- - Represents supported version of the "OData-Version" header, which is part of - the Open Data Protocol standard. +summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' remarks: '' isPreview: false isDeprecated: false @@ -55,9 +53,8 @@ methods: fullName: tryParseFromHeaders(headers) summary: Attempt to parse the "OData-Version" header. remarks: >- - If the "OData-Version" header is present, this returns the corresponding - ODataVersion constant. An error is thrown if the version number is not - supported. If the header is missing, then undefined is returned. + If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown + if the version number is not supported. If the header is missing, then undefined is returned. isPreview: false isDeprecated: false syntax: @@ -65,7 +62,7 @@ methods: parameters: - id: headers description: '' - type: '' + type: Headers return: type: ' | undefined' description: '' diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index c7103ed3..58860cee 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -4,15 +4,12 @@ uid: '@microsoft/sp-http!SPHttpClient:class' package: '@microsoft/sp-http!' fullName: SPHttpClient summary: >- - SPHttpClient is used to perform REST calls against SharePoint. It adds default - headers, manages the digest needed for writes, and collects telemetry that - helps the service to monitor the performance of an application. -remarks: >- + SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for + writes, and collects telemetry that helps the service to monitor the performance of an application. +remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. - - For communicating with other internet services, use the - [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. + For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. isPreview: false isDeprecated: false type: class @@ -36,18 +33,14 @@ properties: uid: '@microsoft/sp-http!SPHttpClient.configurations:member' package: '@microsoft/sp-http!' fullName: configurations - summary: >- - The standard predefined SPHttpClientConfiguration objects for use with the - SPHttpClient class. + summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly configurations: ISPHttpClientConfigurations;' return: - type: >- - + type: '' - name: serviceKey uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' package: '@microsoft/sp-http!' @@ -60,99 +53,105 @@ properties: content: 'static readonly serviceKey: ServiceKey;' return: type: >- - <> + <> methods: + - name: '_fetch(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#_fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: '_fetch(url, configuration, options)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; + parameters: + - id: url + description: '' + type: string + - id: configuration + description: '' + type: '' + - id: options + description: '' + type: '' + return: + type: 'Promise<>' + description: '' - name: beginBatch(batchCreationOptions) uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' package: '@microsoft/sp-http!' fullName: beginBatch(batchCreationOptions) - summary: >- - Begins an ODATA batch, which allows multiple REST queries to be bundled - into a single web request. + summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' remarks: '' isPreview: true isDeprecated: false syntax: - content: >- - beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): - SPHttpClientBatch; + content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' parameters: - id: batchCreationOptions description: '' - type: >- - + type: '' return: type: '' description: >- - An - [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) - object used to manage the batch operation. + An [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) object used to manage the batch + operation. - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' package: '@microsoft/sp-http!' fullName: 'fetch(url, configuration, options)' summary: Perform a REST service call. remarks: >- - Generally, the parameters and semantics for SPHttpClient.fetch() are - essentially the same as the WHATWG API standard that is documented here: - https://fetch.spec.whatwg.org/ + Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API + standard that is documented here: https://fetch.spec.whatwg.org/ - The SPHttpClient subclass adds some additional behaviors that are - convenient when working with SharePoint ODATA API's (which can be avoided - by using HttpClient instead): + The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA + API's (which can be avoided by using HttpClient instead): - - Default "Accept" and "Content-Type" headers are added if not explicitly - specified. + - Default "Accept" and "Content-Type" headers are added if not explicitly specified. - For write operations, an "X-RequestDigest" header is automatically added - - The request digest token is automatically fetched and stored in a cache, - with support for preloading + - The request digest token is automatically fetched and stored in a cache, with support for preloading - For a write operation, SPHttpClient will automatically add the - "X-RequestDigest" header, which may need to be obtained by issuing a - separate request such as - "https://example.com/sites/sample/\_api/contextinfo". Typically the - appropriate SPWeb URL can be guessed by looking for a reserved URL segment - such as "\_api" in the original URL passed to fetch(); if not, use - ISPHttpClientOptions.webUrl to specify it explicitly. + For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be + obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the + appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL + passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. isPreview: false isDeprecated: false syntax: content: >- - fetch(url: string, configuration: SPHttpClientConfiguration, options: - ISPHttpClientOptions): Promise; + fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of SPHttpClient; normally this - should be the latest version number from SPHttpClientConfigurations + determines the default behavior of SPHttpClient; normally this should be the latest version number from + SPHttpClientConfigurations type: '' - id: options description: additional options that affect the request type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. - name: 'get(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' package: '@microsoft/sp-http!' @@ -163,48 +162,41 @@ methods: isDeprecated: false syntax: content: >- - get(url: string, configuration: SPHttpClientConfiguration, options?: - ISPHttpClientOptions): Promise; + get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of SPHttpClient; normally this - should be the latest version number from SPHttpClientConfigurations + determines the default behavior of SPHttpClient; normally this should be the latest version number from + SPHttpClientConfigurations type: '' - id: options description: additional options that affect the request type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. - name: getWebUrlFromRequestUrl(requestUrl) uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' package: '@microsoft/sp-http!' fullName: getWebUrlFromRequestUrl(requestUrl) summary: Use a heuristic to infer the base URL for authentication. remarks: >- - Attempts to infer the SPWeb URL associated with the provided REST URL, by - looking for common SharePoint path components such as "\_api", - "\_layouts", or "\_vit\_bin". This is necessary for operations such as the - X-RequestDigest and ODATA batching, which require POSTing to a separate - REST endpoint in order to complete a request. + Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path + components such as "\_api", "\_layouts", or "\_vit\_bin". This is necessary for operations such as the + X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a + request. - For example, if the requestUrl is "/sites/site/web/\_api/service", the - returned URL would be "/sites/site/web". Or if the requestUrl is - "http://example.com/\_layouts/service", the returned URL would be - "http://example.com". + For example, if the requestUrl is "/sites/site/web/\_api/service", the returned URL would be "/sites/site/web". Or + if the requestUrl is "http://example.com/\_layouts/service", the returned URL would be "http://example.com". If the URL cannot be determined, an exception is thrown. @@ -229,28 +221,24 @@ methods: isDeprecated: false syntax: content: >- - post(url: string, configuration: SPHttpClientConfiguration, options: - ISPHttpClientOptions): Promise; + post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of SPHttpClient; normally this - should be the latest version number from SPHttpClientConfigurations + determines the default behavior of SPHttpClient; normally this should be the latest version number from + SPHttpClientConfigurations type: '' - id: options description: additional options that affect the request type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 003f2ccf..9a3b248f 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -4,20 +4,17 @@ uid: '@microsoft/sp-http!SPHttpClientBatch:class' package: '@microsoft/sp-http!' fullName: SPHttpClientBatch summary: >- - The SPHttpClientBatch class accumulates a number of REST service calls and - transmits them as a single ODATA batch. This protocol is documented here: - http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html + The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. + This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html - The usage is to call SPHttpClientBatch.fetch() to queue each individual - request, and then call SPHttpClientBatch.execute() to execute the batch - operation. The execute() method returns a promise that resolves when the real - REST call has completed. Each call to fetch() also returns a promise that will - resolve with an SPHttpClientResponse object for that particular request. + The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call + SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when + the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an + SPHttpClientResponse object for that particular request. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPHttpClientBatch` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPHttpClientBatch` class. isPreview: true isDeprecated: false type: class @@ -26,93 +23,75 @@ properties: uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' package: '@microsoft/sp-http!' fullName: configurations - summary: >- - The standard predefined SPHttpClientBatchConfigurations objects for use - with the SPHttpClientBatch class. + summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. remarks: '' isPreview: true isDeprecated: false syntax: content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: - type: >- - + type: '' methods: - name: execute() uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' package: '@microsoft/sp-http!' fullName: execute() - summary: >- - Executes the batched queries that were queued using - SPHttpClientBatch.fetch(). + summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). remarks: '' isPreview: true isDeprecated: false syntax: content: 'execute(): Promise;' return: - type: >- - <> + type: 'Promise<>' description: '' - name: 'fetch(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' package: '@microsoft/sp-http!' fullName: 'fetch(url, configuration, options)' summary: >- - Queues a new request, and returns a promise that can be used to access the - server response (after execute() has completed). + Queues a new request, and returns a promise that can be used to access the server response (after execute() has + completed). remarks: >- - The parameters for this function are basically the same as the WHATWG API - standard documented here: + The parameters for this function are basically the same as the WHATWG API standard documented here: [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/) - However, be aware that certain REST headers are ignored or not allowed - inside a batch. See the ODATA documentation for details. + However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation + for details. - When execute() is called, it will POST to a URL such as - "http://example.com/sites/sample/\_api/$batch". Typically - SPHttpClientBatch can successfully guess the appropriate SPWeb URL by - looking for a reserved URL segment such as "\_api" in the first URL passed - to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to - specify it explicitly. + When execute() is called, it will POST to a URL such as "http://example.com/sites/sample/\_api/$batch". Typically + SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as + "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it + explicitly. isPreview: true isDeprecated: false syntax: content: >- - fetch(url: string, configuration: SPHttpClientBatchConfiguration, - options?: ISPHttpClientBatchOptions): Promise; + fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of this request; normally this - should be the latest version number from + determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: '' - id: options description: additional options that affect the request - type: >- - + type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. - name: 'get(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' package: '@microsoft/sp-http!' @@ -123,34 +102,27 @@ methods: isDeprecated: false syntax: content: >- - get(url: string, configuration: SPHttpClientBatchConfiguration, - options?: ISPHttpClientBatchOptions): Promise; + get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of this request; normally this - should be the latest version number from + determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: '' - id: options description: additional options that affect the request - type: >- - + type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. - name: 'post(url, configuration, options)' uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' package: '@microsoft/sp-http!' @@ -161,31 +133,24 @@ methods: isDeprecated: false syntax: content: >- - post(url: string, configuration: SPHttpClientBatchConfiguration, - options: ISPHttpClientBatchOptions): Promise; + post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): + Promise; parameters: - id: url description: the URL to fetch type: string - id: configuration description: >- - determines the default behavior of this request; normally this - should be the latest version number from + determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: '' - id: options description: additional options that affect the request - type: >- - + type: '' return: - type: >- - <> + type: 'Promise<>' description: >- - A promise with behavior similar to WHATWG fetch(). This promise will - resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse#ok:member) - being false) for error status codes such as HTTP 404 or 500. The - promise will only reject for network failures or other errors that - prevent communication with the server. + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 629579d1..f8574460 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -5,11 +5,9 @@ package: '@microsoft/sp-http!' fullName: SPHttpClientBatchConfiguration summary: Configuration for SPHttpClientBatch. remarks: >- - The SPHttpClientBatchConfiguration object provides a set of switches for - enabling/disabling various features of the SPHttpClientBatch class. Normally - these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by - providing one of the predefined defaults from SPHttpClientBatchConfigurations, - however switches can also be changed via the + The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the + SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing + one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method. isPreview: true isDeprecated: false @@ -20,30 +18,20 @@ constructors: package: '@microsoft/sp-http!' fullName: '(constructor)(flags, overrideFlags)' summary: >- - Constructs a new instance of SPHttpClientBatchConfiguration with the - specified flags. The default values will be used for any flags that are - missing or undefined. If overrideFlags is specified, it takes precedence - over flags. + Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be + used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' isPreview: true isDeprecated: false syntax: - content: >- - constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: - ISPHttpClientBatchConfiguration); + content: 'constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);' parameters: - id: flags description: '' - type: >- - + type: '' - id: overrideFlags description: '' - type: >- - + type: '' properties: - name: flags uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' @@ -56,13 +44,10 @@ properties: syntax: content: 'protected flags: ISPHttpClientBatchConfiguration;' return: - type: >- - + type: '' methods: - name: initializeFlags() - uid: >- - @microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1) + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' package: '@microsoft/sp-http!' fullName: initializeFlags() summary: '' @@ -85,18 +70,13 @@ methods: isPreview: true isDeprecated: false syntax: - content: >- + content: |- /** @override */ - - overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): - SPHttpClientBatchConfiguration; + overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; parameters: - id: sourceFlags description: '' - type: >- - + type: '' return: type: '' description: '' diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index ac5fbb35..c510137d 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -3,9 +3,7 @@ name: SPHttpClientCommonConfiguration uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' package: '@microsoft/sp-http!' fullName: SPHttpClientCommonConfiguration -summary: >- - Common base class for SPHttpClientConfiguration and - SPHttpClientBatchConfiguration. +summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. remarks: '' isPreview: false isDeprecated: false @@ -15,31 +13,21 @@ constructors: uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' package: '@microsoft/sp-http!' fullName: '(constructor)(flags, overrideFlags)' - summary: >- - Constructs a new instance of SPHttpClientCommonConfiguration with the - specified flags. + summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. remarks: >- - The default values will be used for any flags that are missing or - undefined. If overrideFlags is specified, it takes precedence over flags. + The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it + takes precedence over flags. isPreview: false isDeprecated: false syntax: - content: >- - constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: - ISPHttpClientCommonConfiguration); + content: 'constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);' parameters: - id: flags description: '' - type: >- - + type: '' - id: overrideFlags description: '' - type: >- - + type: '' properties: - name: flags uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' @@ -52,9 +40,7 @@ properties: syntax: content: 'protected flags: ISPHttpClientCommonConfiguration;' return: - type: >- - + type: '' - name: jsonRequest uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' package: '@microsoft/sp-http!' @@ -64,20 +50,18 @@ properties: When this switch is true: - If the "Content-Type" header was not explicitly added for the request, - then SPHttpClient will add it if the request is a write operation (i.e. an - HTTP method other than "GET", "HEAD", or "OPTIONS"). + If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). - For OData 3.0, the value is - 'application/json;odata=verbose;charset=utf-8'. + For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. For OData 4.0, the value is 'application/json;charset=utf-8'. isPreview: false isDeprecated: false syntax: - content: 'readonly jsonRequest: boolean;' + content: 'get jsonRequest(): boolean;' return: type: boolean - name: jsonResponse @@ -85,28 +69,23 @@ properties: package: '@microsoft/sp-http!' fullName: jsonResponse summary: Automatically configure the "Accept" header for a JSON payload. - remarks: >- + remarks: |- When this switch is true: - - If the "Accept" header was not explicitly added for the request, then - SPHttpClient will add it. - + If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. For OData 3.0, the value is 'application/json'. - For OData 4.0, the value is 'application/json;odata.metadata=minimal'. isPreview: false isDeprecated: false syntax: - content: 'readonly jsonResponse: boolean;' + content: 'get jsonResponse(): boolean;' return: type: boolean methods: - name: initializeFlags() - uid: >- - @microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1) + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' package: '@microsoft/sp-http!' fullName: initializeFlags() summary: '' @@ -129,18 +108,13 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- + content: |- /** @override */ - - overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): - SPHttpClientCommonConfiguration; + overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; parameters: - id: sourceFlags description: '' - type: >- - + type: '' return: type: '' description: '' diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 829182ce..63c95b77 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -3,15 +3,12 @@ name: SPHttpClientConfiguration uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' package: '@microsoft/sp-http!' fullName: SPHttpClientConfiguration -summary: >- - Configuration for - [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class). +summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' remarks: >- - The SPHttpClientConfiguration object provides a set of switches for - enabling/disabling various features of the SPHttpClient class. Normally these - switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of - the predefined defaults from SPHttpClientConfigurations, however switches can - also be changed via the SPHttpClientConfiguration.overrideWith() method. + The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the + predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the + SPHttpClientConfiguration.overrideWith() method. isPreview: false isDeprecated: false type: class @@ -21,27 +18,20 @@ constructors: package: '@microsoft/sp-http!' fullName: '(constructor)(flags, overrideFlags)' summary: >- - Constructs a new instance of SPHttpClientConfiguration with the specified - flags. The default values will be used for any flags that are missing or - undefined. If overrideFlags is specified, it takes precedence over flags. + Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used + for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - constructor(flags: ISPHttpClientConfiguration, overrideFlags?: - ISPHttpClientConfiguration); + content: 'constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);' parameters: - id: flags description: '' - type: >- - + type: '' - id: overrideFlags description: '' - type: >- - + type: '' properties: - name: defaultODataVersion uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' @@ -49,22 +39,20 @@ properties: fullName: defaultODataVersion summary: Automatically configure the "OData-Version" header. remarks: >- - When this switch is specified (i.e. not undefined): If the "OData-Version" - header was not explicitly added for the request, then SPHttpClient will - add the header to specify the version indicated by defaultODataVersion. + When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the + request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. - NOTE: Without an 'OData-Version' header, the SharePoint server currently - defaults to Version 3.0 in most cases. The recommended version is 4.0. + NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. + The recommended version is 4.0. isPreview: false isDeprecated: false syntax: - content: 'readonly defaultODataVersion: ODataVersion;' + content: 'get defaultODataVersion(): ODataVersion;' return: type: '' - name: defaultSameOriginCredentials - uid: >- - @microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member + uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' package: '@microsoft/sp-http!' fullName: defaultSameOriginCredentials summary: Automatically configure the RequestInit.credentials. @@ -72,17 +60,15 @@ properties: When this switch is true: - If RequestInit.credentials is not explicitly specified for the request, - then SPHttpClient will assign it to be "same-origin". Without this switch, - different web browsers may apply different defaults. + If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be + "same-origin". Without this switch, different web browsers may apply different defaults. - For more information, see the spec: - https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials isPreview: false isDeprecated: false syntax: - content: 'readonly defaultSameOriginCredentials: boolean;' + content: 'get defaultSameOriginCredentials(): boolean;' return: type: boolean - name: flags @@ -106,15 +92,13 @@ properties: When this switch is true: - If the "X-RequestDigest" header was not explicitly added for the request, - then SPHttpClient will add it if the request is a write operation (i.e. an - HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an - additional network request may be performed. + If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. isPreview: false isDeprecated: false syntax: - content: 'readonly requestDigest: boolean;' + content: 'get requestDigest(): boolean;' return: type: boolean methods: @@ -142,17 +126,13 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- + content: |- /** @override */ - - overrideWith(sourceFlags: ISPHttpClientConfiguration): - SPHttpClientConfiguration; + overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; parameters: - id: sourceFlags description: '' - type: >- - + type: '' return: type: '' description: '' diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index a4ec1af3..52da2a90 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -4,12 +4,10 @@ uid: '@microsoft/sp-http!SPHttpClientResponse:class' package: '@microsoft/sp-http!' fullName: SPHttpClientResponse summary: The Response subclass returned by methods such as SPHttpClient.fetch(). -remarks: >- +remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. - - This is a placeholder. In the future, additional SPHttpClient-specific - functionality may be added to this class. + This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. isPreview: false isDeprecated: false type: class @@ -27,7 +25,7 @@ constructors: parameters: - id: response description: '' - type: '' + type: Response properties: - name: correlationId uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' @@ -35,14 +33,13 @@ properties: fullName: correlationId summary: Returns the SharePoint correlation ID. remarks: >- - The correlation ID is a Guid that can be used to associate log events that - are part of the same overall operation, but may originate from different - services or components. SharePoint REST operations return the server's + The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, + but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header. isPreview: true isDeprecated: false syntax: - content: 'readonly correlationId: Guid | undefined;' + content: 'get correlationId(): Guid | undefined;' return: type: ' | undefined' methods: diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 7ceadaca..4e4a7347 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -3,9 +3,7 @@ name: SPHttpHeader uid: '@microsoft/sp-http!SPHttpHeader:enum' package: '@microsoft/sp-http!' fullName: SPHttpHeader -summary: >- - Standard HTTP headers used with - [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) +summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' remarks: '' isPreview: true isDeprecated: false @@ -13,9 +11,8 @@ fields: - name: SPRequestGuid uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' package: '@microsoft/sp-http!' - summary: >- - SharePoint uses the 'SPRequestGuid' header to return the server's - correlation ID for a request. - + summary: |- + SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request. Example value: "9417279e-40e1-0000-2465-306ba786bfd7" + value: '"SPRequestGuid"' diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 18593f96..fc9c829e 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -43,9 +43,7 @@ properties: uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' package: '@microsoft/sp-http!' fullName: redirectUrl - summary: >- - The url of the page for the end user to perform Multi Factor - Authentication + summary: The url of the page for the end user to perform Multi Factor Authentication remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-image-helper.yml b/SP-Framework/sp-image-helper.yml new file mode 100644 index 00000000..24e685cd --- /dev/null +++ b/SP-Framework/sp-image-helper.yml @@ -0,0 +1,9 @@ +### YamlMime:TSPackage +uid: '@microsoft/sp-image-helper!' +name: '@microsoft/sp-image-helper' +type: package +summary: SharePoint Framework helper library to generate image urls optimized for delivery. +interfaces: + - '@microsoft/sp-image-helper!IImageHelperRequest:interface' +classes: + - '@microsoft/sp-image-helper!ImageHelper:class' diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml new file mode 100644 index 00000000..ca8688ce --- /dev/null +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: IImageHelperRequest +uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' +package: '@microsoft/sp-image-helper!' +fullName: IImageHelperRequest +summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: height + uid: '@microsoft/sp-image-helper!IImageHelperRequest#height:member' + package: '@microsoft/sp-image-helper!' + fullName: height + summary: Optional height of the image requested + remarks: >- + By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This + provides the image with the quickest response.) When the height is specified, the width is not adjusted to the + nearest larger resolution breakpoint. + isPreview: true + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: sourceUrl + uid: '@microsoft/sp-image-helper!IImageHelperRequest#sourceUrl:member' + package: '@microsoft/sp-image-helper!' + fullName: sourceUrl + summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'sourceUrl: string;' + return: + type: string + - name: width + uid: '@microsoft/sp-image-helper!IImageHelperRequest#width:member' + package: '@microsoft/sp-image-helper!' + fullName: width + summary: Width of the image requested. + remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' + isPreview: true + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml new file mode 100644 index 00000000..192f4668 --- /dev/null +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ImageHelper +uid: '@microsoft/sp-image-helper!ImageHelper:class' +package: '@microsoft/sp-image-helper!' +fullName: ImageHelper +summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. +remarks: '' +isPreview: true +isDeprecated: false +type: class +methods: + - name: convertToImageUrl(request) + uid: '@microsoft/sp-image-helper!ImageHelper.convertToImageUrl:member(1)' + package: '@microsoft/sp-image-helper!' + fullName: convertToImageUrl(request) + summary: Convert a url to a file or page on SharePoint into an optimized image url. + remarks: >- + - If width and height are provided, then the resulting image will be scaled to the minimum of the width or height. + - The url will be most performant if only a width is provided. If a height is provided, the image will take longer + to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. + Continue to use the original file's url for serialization. + isPreview: true + isDeprecated: false + syntax: + content: 'static convertToImageUrl(request: IImageHelperRequest): string;' + parameters: + - id: request + description: IImageHelperRequest for the bundled parameters. + type: '' + return: + type: string + description: >- + A full url string for the image of the file. If no optimized url can be created (i.e. an external url or an + unsupported file type), the original sourceUrl is returned. diff --git a/SP-Framework/sp-list-subscription.yml b/SP-Framework/sp-list-subscription.yml index 9e4e4d6e..a3919e95 100644 --- a/SP-Framework/sp-list-subscription.yml +++ b/SP-Framework/sp-list-subscription.yml @@ -2,9 +2,7 @@ uid: '@microsoft/sp-list-subscription!' name: '@microsoft/sp-list-subscription' type: package -summary: >- - This package provides developer support for subscribing to changes in a - SharePoint document library. +summary: This package provides developer support for subscribing to changes in a SharePoint document library. interfaces: - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - '@microsoft/sp-list-subscription!IListSubscription:interface' diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 8f68bb93..4f7b1bed 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -4,23 +4,20 @@ uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' package: '@microsoft/sp-list-subscription!' fullName: ICreateSubscriptionSettings summary: >- - A list subscription requires at least a site ID and list ID. If the list is - not contained in the root site of a web, you need to pass in the subweb id. If - the domain you are accessing is different than the current domain, you will - need to provide it as well. + A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a web, + you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you will need + to provide it as well. - In the simple case (say a teamsite document library) in the current site, you - can simply provide the library ID, and the current domain, site and web will - be used. + In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and + the current domain, site and web will be used. remarks: '' isPreview: false isDeprecated: false type: interface properties: - name: callbacks - uid: >- - @microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' package: '@microsoft/sp-list-subscription!' fullName: callbacks summary: the list of callbacks @@ -30,17 +27,12 @@ properties: syntax: content: 'callbacks: ISubscriptionCallbacks;' return: - type: >- - + type: '' - name: domain uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' package: '@microsoft/sp-list-subscription!' fullName: domain - summary: >- - In the case of a multi-geography tenancy, you need to provide the domain - that the site collection lives in. + summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' remarks: '' isPreview: false isDeprecated: false @@ -52,9 +44,7 @@ properties: uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' package: '@microsoft/sp-list-subscription!' fullName: listId - summary: >- - The Guid of the Sharepoint List. At this point, it needs to be a document - library, and not just a list. + summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' remarks: '' isPreview: false isDeprecated: false @@ -67,8 +57,8 @@ properties: package: '@microsoft/sp-list-subscription!' fullName: siteId summary: >- - The SharePoint Site Id (assuming it is not the current site) If the siteId - parameter is not provided, the current site will be used. + The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current + site will be used. remarks: '' isPreview: false isDeprecated: false @@ -81,8 +71,8 @@ properties: package: '@microsoft/sp-list-subscription!' fullName: webId summary: >- - The SharePoint Web Id (assuming it is not the current web) If the webId - parameter is not provided, the current web will be used. + The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web + will be used. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index cc5a9a7d..0d18dc0a 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -3,9 +3,7 @@ name: IListSubscription uid: '@microsoft/sp-list-subscription!IListSubscription:interface' package: '@microsoft/sp-list-subscription!' fullName: IListSubscription -summary: >- - A subscription to a SharePoint list resource. Contains the id of the - subscription. +summary: A subscription to a SharePoint list resource. Contains the id of the subscription. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index 0fda4eff..c2502315 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -25,9 +25,7 @@ properties: uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' package: '@microsoft/sp-list-subscription!' fullName: disconnect - summary: >- - The callback to invoke when the subscription is disconnected from the - list. + summary: The callback to invoke when the subscription is disconnected from the list. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index d1b718eb..178ca96a 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' package: '@microsoft/sp-list-subscription!' fullName: ListSubscriptionFactory summary: >- - Creates and manages subscriptions to list resources. Registers callbacks - provided by the developer with the subscription to handle subscription events. + Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the + subscription to handle subscription events. remarks: '' isPreview: false isDeprecated: false @@ -27,8 +27,7 @@ constructors: type: '' methods: - name: createSubscription(settings) - uid: >- - @microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1) + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' package: '@microsoft/sp-list-subscription!' fullName: createSubscription(settings) summary: Creates a connection to the list specified by the site id and list id. @@ -36,25 +35,16 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - createSubscription(settings: ICreateSubscriptionSettings): - Promise; + content: 'createSubscription(settings: ICreateSubscriptionSettings): Promise;' parameters: - id: settings description: The various parameters - type: >- - + type: '' return: - type: >- - <> + type: 'Promise<>' description: Promise of the subscription to the list. - name: deleteSubscription(subscription) - uid: >- - @microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1) + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' package: '@microsoft/sp-list-subscription!' fullName: deleteSubscription(subscription) summary: Deletes the subscription's connection to the resource. @@ -66,9 +56,7 @@ methods: parameters: - id: subscription description: The subscription to delete. - type: >- - + type: '' return: type: void description: '' diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index d1b9ef84..cb399011 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -15,9 +15,6 @@ classes: - '@microsoft/sp-listview-extensibility!RowAccessor:class' - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' interfaces: - - >- - @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface - - >- - @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface - - >- - @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index e98e0ce5..a14e3f11 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -4,13 +4,11 @@ uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' package: '@microsoft/sp-listview-extensibility!' fullName: BaseFieldCustomizer summary: >- - This is the base class that third parties should extend when implementing a - client-side extension that customizes the appearance of fields in a SharePoint - ListView. + This is the base class that third parties should extend when implementing a client-side extension that customizes the + appearance of fields in a SharePoint ListView. - In the component manifest, the "extensionType" should be set to - "FieldCustomizer". + In the component manifest, the "extensionType" should be set to "FieldCustomizer". remarks: '' isPreview: false isDeprecated: false @@ -20,15 +18,11 @@ properties: uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' package: '@microsoft/sp-listview-extensibility!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: false isDeprecated: false syntax: @@ -37,8 +31,7 @@ properties: type: '' methods: - name: onDisposeCell(event) - uid: >- - @microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1) + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: onDisposeCell(event) summary: '' @@ -50,16 +43,12 @@ methods: parameters: - id: event description: '' - type: >- - + type: '' return: type: void description: '' - name: onRenderCell(event) - uid: >- - @microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1) + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: onRenderCell(event) summary: '' @@ -71,13 +60,8 @@ methods: parameters: - id: event description: '' - type: >- - + type: '' return: type: void description: '' -extends: >- - <TProperties> +extends: '<TProperties> ' diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 68e05842..90bbceca 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -4,16 +4,14 @@ uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' package: '@microsoft/sp-listview-extensibility!' fullName: BaseListViewCommandSet summary: >- - This is the base class that third parties should extend when implementing a - client-side extension that provides a command set for a SharePoint list view. + This is the base class that third parties should extend when implementing a client-side extension that provides a + command set for a SharePoint list view. remarks: >- - In the component manifest, the "extensionType" should be set to - "ListViewCommandSet". + In the component manifest, the "extensionType" should be set to "ListViewCommandSet". - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `BaseListViewCommandSet` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseListViewCommandSet` class. isPreview: false isDeprecated: false type: class @@ -22,15 +20,11 @@ properties: uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' package: '@microsoft/sp-listview-extensibility!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: false isDeprecated: false syntax: @@ -39,13 +33,12 @@ properties: type: '' methods: - name: onExecute(event) - uid: >- - @microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1) + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: onExecute(event) summary: >- - This event occurs when the command is invoked, e.g. because the user - clicked on the toolbar button or menu item. + This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. + virtual remarks: '' isPreview: false isDeprecated: false @@ -54,47 +47,34 @@ methods: parameters: - id: event description: '' - type: >- - + type: '' return: type: void description: '' - name: onListViewUpdated(event) - uid: >- - @microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1) + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: onListViewUpdated(event) - summary: This event occurs whenever the ListView state changes. + summary: This event occurs whenever the ListView state changes. virtual remarks: >- - This event allows the implementor to tailor the appearance of the command. - For example, to hide the command, assign its property visible = false. To - customize the title, modify the command property title. + This event allows the implementor to tailor the appearance of the command. For example, to hide the command, + assign its property visible = false. To customize the title, modify the command property title. isPreview: false isDeprecated: false syntax: - content: >- - onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): - void; + content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' parameters: - id: event description: '' - type: >- - + type: '' return: type: void description: '' - name: tryGetCommand(id) - uid: >- - @microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1) + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: tryGetCommand(id) - summary: >- - Returns the command with the given id. Returns undefined if there is not - command with the given id. + summary: Returns the command with the given id. Returns undefined if there is not command with the given id. remarks: '' isPreview: false isDeprecated: false @@ -107,6 +87,4 @@ methods: return: type: '' description: '' -extends: >- - <TProperties> +extends: '<TProperties> ' diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 8404cd02..a86759d1 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -3,22 +3,17 @@ name: ColumnAccessor uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' package: '@microsoft/sp-listview-extensibility!' fullName: ColumnAccessor -summary: >- - Provides access to a ListView column, which is the visual presentation of a - field. +summary: 'Provides access to a ListView column, which is the visual presentation of a field.' remarks: >- - A SharePoint "field" (SPField) defines the data storage for a property of a - list item. (If the list item represents a document, then the field is - sometimes called a "property".) + A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item represents a + document, then the field is sometimes called a "property".) - A "column" is the visual presentation of a field, when displayed by the - ListView. + A "column" is the visual presentation of a field, when displayed by the ListView. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `ColumnAccessor` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ColumnAccessor` class. isPreview: false isDeprecated: false type: class @@ -32,7 +27,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'abstract readonly field: SPField;' + content: 'abstract get field(): SPField;' return: type: '' - name: visible @@ -44,6 +39,6 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'abstract readonly visible: boolean;' + content: 'abstract get visible(): boolean;' return: type: boolean diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 01485294..6dc83137 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -5,14 +5,12 @@ package: '@microsoft/sp-listview-extensibility!' fullName: Command summary: Represents a command belonging to a command set. remarks: >- - The BaseListViewCommandSet extension type exposes generalized commands that - may be displayed as tool bar buttons, context menu items, etc. These commands - are initially defined in the extension’s manifest file. At runtime, the + The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, + context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the corresponding Command object can be obtained by calling - [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, - for example to hide a command that is not contextually relevant, or to - pluralize the title based on the number of selected items. + [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not + contextually relevant, or to pluralize the title based on the number of selected items. isPreview: false isDeprecated: false type: class @@ -22,9 +20,8 @@ properties: package: '@microsoft/sp-listview-extensibility!' fullName: ariaLabel summary: >- - Custom accessibility text for the browser's "aria-label" attribute. If - omitted, the title property will be used by default. Example: "Show - information. Press ENTER to select." + Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by + default. Example: "Show information. Press ENTER to select." remarks: '' isPreview: false isDeprecated: false @@ -37,9 +34,8 @@ properties: package: '@microsoft/sp-listview-extensibility!' fullName: iconImageUrl summary: >- - An optional URL for an image to be displayed next to the command. The - requirements for this image are defined by the type of extension; some - extension types may not display the image at all. + An optional URL for an image to be displayed next to the command. The requirements for this image are defined by + the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. isPreview: false isDeprecated: false @@ -68,12 +64,10 @@ properties: Example: "Show information" - Altering the title property is intended to allow minor changes to the - title, e.g. “Submit these 3 items” or toggling between “Schedule” and - “Unschedule”. Developers are discouraged from assigning a title that - radically alters the meaning of the command, because administrators should - be able to examine the extension manifest to understand which commands are - being implemented by a given extension. + Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or + toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically + alters the meaning of the command, because administrators should be able to examine the extension manifest to + understand which commands are being implemented by a given extension. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 3372d581..af3a9c58 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-listview-extensibility!' fullName: FieldCustomizerContext summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `FieldCustomizerContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `FieldCustomizerContext` class. isPreview: false isDeprecated: false type: class @@ -16,39 +15,30 @@ properties: uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' package: '@microsoft/sp-listview-extensibility!' fullName: field - summary: >- - Provides access to the SharePoint field that the customizer will operate - on. + summary: Provides access to the SharePoint field that the customizer will operate on. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly field: SPField;' + content: 'get field(): SPField;' return: type: '' methods: - name: tryGetListView() - uid: >- - @microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1) + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: tryGetListView() summary: >- - If the field customizer is bounded to the SharePoint list view, this - provides access to the list view specific functionality; otherwise the - value is undefined. + If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific + functionality; otherwise the value is undefined. remarks: >- - Although the SharePoint list view is the main usage scenario, field - customizers can be used by other user interface surfaces. For example, in - the future SharePoint may support field customizers on a display/edit - form. + Although the SharePoint list view is the main usage scenario, field customizers can be used by other user + interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. isPreview: false isDeprecated: false syntax: content: 'tryGetListView(): ListViewAccessor | undefined;' return: - type: >- - - | undefined + type: ' | undefined' description: 'the SharePoint list view, or undefined if there is none.' extends: '' diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index a56b6908..ee42db86 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -1,7 +1,6 @@ ### YamlMime:TSType name: IFieldCustomizerCellEventParameters -uid: >- - @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface +uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' package: '@microsoft/sp-listview-extensibility!' fullName: IFieldCustomizerCellEventParameters summary: Event parameters for BaseFieldCustomizer.onRenderCell() @@ -11,23 +10,21 @@ isDeprecated: false type: interface properties: - name: domElement - uid: >- - @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' package: '@microsoft/sp-listview-extensibility!' fullName: domElement summary: >- - The HTML "div" element that the extension will take ownership of. This - ownership will end when onDisposeCell() is called. + The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is + called. remarks: '' isPreview: false isDeprecated: false syntax: content: 'readonly domElement: HTMLDivElement;' return: - type: '' + type: HTMLDivElement - name: fieldValue - uid: >- - @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' package: '@microsoft/sp-listview-extensibility!' fullName: fieldValue summary: The value of the field being rendered. @@ -39,8 +36,7 @@ properties: return: type: any - name: listItem - uid: >- - @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' package: '@microsoft/sp-listview-extensibility!' fullName: listItem summary: The list item being edited. @@ -52,17 +48,14 @@ properties: return: type: '' - name: userData - uid: >- - @microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' package: '@microsoft/sp-listview-extensibility!' fullName: userData summary: An implementation defined storage property. remarks: >- - For example, suppose that resources need to be allocated during rendering - (e.g. a renderer object, an HTTP request to be canceled, a cache slot, - etc). The onRenderCell() implementation could store a key or handle in - this property, and then onDisposeCell() can use this key to find the - resource to be freed. + For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request + to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this + property, and then onDisposeCell() can use this key to find the resource to be freed. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index 220bdef3..d3e11a29 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,25 +1,23 @@ ### YamlMime:TSType name: IListViewCommandSetExecuteEventParameters -uid: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface +uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' package: '@microsoft/sp-listview-extensibility!' fullName: IListViewCommandSetExecuteEventParameters summary: >- Parameters for - [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)) + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) remarks: '' isPreview: false isDeprecated: false type: interface properties: - name: itemId - uid: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' package: '@microsoft/sp-listview-extensibility!' fullName: itemId summary: >- - The unique identifier for the command. This is specified as - ICommandDefinition.commandId in the component manifest. + The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component + manifest. remarks: '' isPreview: false isDeprecated: false @@ -28,8 +26,7 @@ properties: return: type: string - name: selectedRows - uid: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' @@ -39,6 +36,4 @@ properties: syntax: content: 'readonly selectedRows: ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 6864da23..b343e25a 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -1,20 +1,18 @@ ### YamlMime:TSType name: IListViewCommandSetListViewUpdatedParameters -uid: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface +uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' package: '@microsoft/sp-listview-extensibility!' fullName: IListViewCommandSetListViewUpdatedParameters summary: >- Parameters for - [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)) + [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) remarks: '' isPreview: false isDeprecated: false type: interface properties: - name: selectedRows - uid: >- - @microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' @@ -24,6 +22,4 @@ properties: syntax: content: 'readonly selectedRows: ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 5525c130..544f28b5 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -4,23 +4,20 @@ uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' package: '@microsoft/sp-listview-extensibility!' fullName: ListItemAccessor summary: >- - When a field customizer extension is rendering a field, the ListItemAccessor - provides access to the associated SharePoint list item. + When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated + SharePoint list item. remarks: >- - ListItemAccessor allows a field customizer extension to determine which fields - are available in the editor and retrieve the current values for those fields. - In the future, it may also support validation and editing operations. + ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and + retrieve the current values for those fields. In the future, it may also support validation and editing operations. - When the editor is the SharePoint list view, the ListViewAccessor uses the - RowAccessor subclass instead of the ListItemAccessor base class. This allows - additional functionality to be exposed, for example determining whether the + When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the + ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the associated table row is selected or not. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `ListItemAccessor` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListItemAccessor` class. isPreview: false isDeprecated: false type: class @@ -29,30 +26,25 @@ properties: uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' package: '@microsoft/sp-listview-extensibility!' fullName: fields - summary: >- - The SharePoint fields that are currently available in the editor for this - list item. + summary: The SharePoint fields that are currently available in the editor for this list item. remarks: >- - The set of available fields depends on the editing context. For example, - if a list view column is hidden, the corresponding field definition may - not be loaded. Field customizers should not assume that a given field will - be available, even if it is defined in the content type. + The set of available fields depends on the editing context. For example, if a list view column is hidden, the + corresponding field definition may not be loaded. Field customizers should not assume that a given field will be + available, even if it is defined in the content type. isPreview: false isDeprecated: false syntax: - content: 'abstract readonly fields: ReadonlyArray;' + content: 'abstract get fields(): ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' methods: - name: getValue(field) uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: getValue(field) summary: >- - Retrieves the current data value for the specified field. The value will - be a primitive JavaScript object such as a string, number, etc. + Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as + a string, number, etc. remarks: '' isPreview: false isDeprecated: false @@ -66,14 +58,12 @@ methods: type: any description: '' - name: getValueByName(internalName) - uid: >- - @microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1) + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: getValueByName(internalName) summary: >- - Retrieves the current data value for the field with the specified internal - name. The value will be a primitive JavaScript object such as a string, - number, etc. + Retrieves the current data value for the field with the specified internal name. The value will be a primitive + JavaScript object such as a string, number, etc. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index b7fb0be6..0be26a82 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewAccessor summary: Provides access to a SharePoint ListView control. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `ListViewAccessor` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListViewAccessor` class. isPreview: false isDeprecated: false type: class @@ -21,53 +20,41 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'abstract readonly columns: ReadonlyArray;' + content: 'abstract get columns(): ReadonlyArray;' return: - type: >- - <> - - name: selectedRowsChangedEvent - uid: >- - @microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRowsChangedEvent - summary: >- - Event that gets raised every time the selected items in the list view - change. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - readonly selectedRowsChangedEvent: - SPEvent; - return: - type: >- - <> + type: 'ReadonlyArray<>' methods: - name: tryGetColumnByName(internalName) - uid: >- - @microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1) + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: tryGetColumnByName(internalName) summary: >- - Returns the list view column corresponding to the field with the specified - internal name, or undefined if none is found. + Returns the list view column corresponding to the field with the specified internal name, or undefined if none is + found. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - abstract tryGetColumnByName(internalName: string): ColumnAccessor | - undefined; + content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' parameters: - id: internalName description: '' type: string return: - type: >- - | undefined + type: ' | undefined' description: '' +events: + - name: selectedRowsChangedEvent + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRowsChangedEvent + summary: Event that gets raised every time the selected items in the list view change. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get selectedRowsChangedEvent(): SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index c283af70..9f0fddb1 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -5,33 +5,26 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewCommandSetContext summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `ListViewCommandSetContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListViewCommandSetContext` class. isPreview: false isDeprecated: false type: class properties: - name: listView - uid: >- - @microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' package: '@microsoft/sp-listview-extensibility!' fullName: listView - summary: >- - Provides access to the ListView control that the customizer will operate - on. + summary: Provides access to the ListView control that the customizer will operate on. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly listView: ListViewAccessor;' + content: 'get listView(): ListViewAccessor;' return: - type: >- - + type: '' - name: manifest - uid: >- - @microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' package: '@microsoft/sp-listview-extensibility!' fullName: manifest summary: Manifest for the client-side component. @@ -41,8 +34,5 @@ properties: syntax: content: 'readonly manifest: ICommandSetExtensionManifest;' return: - type: >- - + type: '' extends: '' diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index e5e754ff..74b7b7dc 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -3,21 +3,18 @@ name: RowAccessor uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' package: '@microsoft/sp-listview-extensibility!' fullName: RowAccessor -summary: >- - Provides access to a ListView row, which is the visual presentation of a - SharePoint list item. +summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' remarks: >- - A SharePoint "list item" (SPListItem) is a data storage record in the content - management system; it stores an array of values for the associated fields. + A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an array of + values for the associated fields. - A "row" is the visual presentation of a list item, when displayed by the - ListView; it stores an array of cell values for the associated columns. + A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values + for the associated columns. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `RowAccessor` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `RowAccessor` class. isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 61cf92e3..69af1e3d 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -10,20 +10,15 @@ isDeprecated: false type: class properties: - name: selectedRows - uid: >- - @microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member + uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' fullName: selectedRows - summary: >- - The list of rows that were selected in the list view at the time when the - event was fired. + summary: The list of rows that were selected in the list view at the time when the event was fired. remarks: '' isPreview: false isDeprecated: false syntax: content: 'selectedRows: ReadonlyArray;' return: - type: >- - <> + type: 'ReadonlyArray<>' extends: '' diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index 141faf18..6a8ac03d 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -13,9 +13,7 @@ properties: uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' package: '@microsoft/sp-loader!' fullName: globalExportsName - summary: >- - If set, the loaded script will be stored in a global variable under this - name. + summary: 'If set, the loaded script will be stored in a global variable under this name.' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index 2afb6e19..f72db3dc 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -3,9 +3,7 @@ name: SPComponentLoader uid: '@microsoft/sp-loader!SPComponentLoader:class' package: '@microsoft/sp-loader!' fullName: SPComponentLoader -summary: >- - Component loader. Needs to be initialized with an implemented - `ISPComponentLoader`. +summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. remarks: '' isPreview: false isDeprecated: false @@ -22,10 +20,7 @@ methods: syntax: content: 'static getManifests(): IClientSideComponentManifest[];' return: - type: >- - [] + type: '[]' description: '' - name: loadComponent(manifest) uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' @@ -36,18 +31,13 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - static loadComponent(manifest: - IClientSideComponentManifest): Promise; + content: 'static loadComponent(manifest: IClientSideComponentManifest): Promise;' parameters: - id: manifest description: Manifest of the module to load. - type: >- - + type: '' return: - type: '<TComponent>' + type: Promise<TComponent> description: A promise containing the loaded module. - name: 'loadComponentById(id, version)' uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' @@ -58,20 +48,18 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - static loadComponentById(id: string, version?: string): - Promise; + content: 'static loadComponentById(id: string, version?: string): Promise;' parameters: - id: id description: The id of the component to load. type: string - id: version description: >- - The version of the component to load. If version is not defined, the - method will load any version of the component. + The version of the component to load. If version is not defined, the method will load any version of the + component. type: string return: - type: '<TComponent>' + type: Promise<TComponent> description: A promise containing the loaded module. - name: loadCss(url) uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' @@ -96,25 +84,22 @@ methods: fullName: 'loadScript(url, options)' summary: 'Given a URL, load a script.' remarks: >- - If a script with a global variable is being loaded, the global variable - already exists, and the script fails to load (because of a syntax error, - for example), the original global variable may be returned and an error - may not be propagated. + If a script with a global variable is being loaded, the global variable already exists, and the script fails to + load (because of a syntax error, for example), the original global variable may be returned and an error may not + be propagated. isPreview: false isDeprecated: false syntax: - content: >- - static loadScript(url: string, options?: ILoadScriptOptions): - Promise; + content: 'static loadScript(url: string, options?: ILoadScriptOptions): Promise;' parameters: - id: url description: The script URL. type: string - id: options description: >- - globalExportsName: If the script isn't an AMD module and loads a - global member on the page, specify the global member's name. + globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the + global member's name. type: '' return: - type: '<TModule>' + type: Promise<TModule> description: A promise containing the loaded module. diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index 7508da50..22e8e66d 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -4,9 +4,10 @@ name: '@microsoft/sp-module-interfaces' type: package summary: '' interfaces: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - - >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml new file mode 100644 index 00000000..0758aefb --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -0,0 +1,171 @@ +### YamlMime:TSType +name: IAdaptiveCardExtensionManifest +uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IAdaptiveCardExtensionManifest +summary: '' +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: connectedSPFXAppId + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: connectedSPFXAppId + summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'connectedSPFXAppId?: string;' + return: + type: string + - name: connectedTeamsAppId + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: connectedTeamsAppId + summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'connectedTeamsAppId?: string;' + return: + type: string + - name: experimentalData + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' + package: '@microsoft/sp-module-interfaces!' + fullName: experimentalData + summary: An untyped property bag for experimental flags not ready for production. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + experimentalData?: { + [key: string]: any; + }; + return: + type: |- + { + [key: string]: any; + } + - name: hiddenFromToolbox + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' + package: '@microsoft/sp-module-interfaces!' + fullName: hiddenFromToolbox + summary: 'If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.' + remarks: >- + Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By + default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains + 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in + a pre configured way. + isPreview: true + isDeprecated: false + syntax: + content: 'hiddenFromToolbox?: boolean;' + return: + type: boolean + - name: preconfiguredEntries + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries:member' + package: '@microsoft/sp-module-interfaces!' + fullName: preconfiguredEntries + summary: >- + A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, + officeFabricIconFontName, toolbox group name and AdaptiveCardExtension specific custom properties. And there can + be multiple instances of these pre-configured properties. + remarks: >- + This helps support scenarios where an organization may want to present multiple pre-configured entries for a + AdaptiveCardExtension in the Toolbox. Each entry is expected to configure the AdaptiveCardExtension with a + different set of pre-configured properties. A developer may decide to seed some initial values for these + properties but an organization admin can go ahead and customize these properties per the needs of his/her + organization. The properties can also be modified by the author of the page. + + + Usage: help display a AdaptiveCardExtension in the Toolbox, PropertyPane and the initial rendering of the + AdaptiveCardExtension. + + + Type: JSON object + + + Supported values: Array of `IClientSideWebPartManifestEntry` objects. + + + Example: + + + ``` + [{ + "groupId": "5c03119e-3074-46fd-976b-c60198311f70", + "group": { "default": "Other" }, + "title": { "id": "$./ManifestStrings.resx:PrimaryTextL1Template;" }, + "description": { "id": "$./ManifestStrings.resx:PrimaryTextL1TemplateDescription;" }, + "officeFabricIconFontName": "Balloons", + "properties": { + "templateType": "primaryText", + "title": "Primary Text", + "primaryText": "Basic card", + "description": "This is an example.", + "cardSize": "Medium" + } + }] + ``` + isPreview: true + isDeprecated: false + syntax: + content: 'preconfiguredEntries: IAdaptiveCardExtensionManifestEntry[];' + return: + type: >- + <TProperties>[] + - name: supportedHosts + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportedHosts + summary: 'Definition: An array defining what host types are supported' + remarks: 'Usage: Use this array to define all hosts that are supported.' + isPreview: true + isDeprecated: false + syntax: + content: 'supportedHosts?: ReadonlyArray<''Dashboard''>;' + return: + type: ReadonlyArray<'Dashboard'> + - name: supportsThemeVariants + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportsThemeVariants:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportsThemeVariants + summary: 'Definition: If true, this ACE supports and has been tested for theme variants experience.' + remarks: >- + Usage: Use this flag if a ACE supports theme variants and has been tested as such. In order to support theme + variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may + not need to be updated to support theme variants, but should always be tested before enabling this flag. By + default no ACEs support theme variants. + isPreview: true + isDeprecated: false + syntax: + content: 'supportsThemeVariants?: boolean;' + return: + type: boolean + - name: useFallbackWhenPropertiesUpdatedExternally + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#useFallbackWhenPropertiesUpdatedExternally:member' + package: '@microsoft/sp-module-interfaces!' + fullName: useFallbackWhenPropertiesUpdatedExternally + summary: >- + Definition: - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data + is updated by an external source. - If false, the AdaptiveCardExtension data will be deserialized and the + properties of the AdaptiveCardExtension will be updated, onAfterPropertiesUpdatedExternally will be executed. - If + undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and + AdaptiveCardExtensions developed with a SPFx version 1.9 or greater will default to false. + remarks: >- + By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your + AdaptiveCardExtension requires specialized logic, then it is recommended to override + onAfterPropertiesUpdatedExternally. + isPreview: true + isDeprecated: false + syntax: + content: 'useFallbackWhenPropertiesUpdatedExternally?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml new file mode 100644 index 00000000..ece55765 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -0,0 +1,237 @@ +### YamlMime:TSType +name: IAdaptiveCardExtensionManifestEntry +uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IAdaptiveCardExtensionManifestEntry +summary: >- + This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each + pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and + content authors can modify these properties on a need basis. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: cardSize + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member' + package: '@microsoft/sp-module-interfaces!' + fullName: cardSize + summary: >- + Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes + \["Medium", "Large"\] defined in the sp-adaptive-card-base project. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'cardSize: string;' + return: + type: string + - name: dataVersion + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member' + package: '@microsoft/sp-module-interfaces!' + fullName: dataVersion + summary: >- + Definition: Use this field to specify the data version of the pre-configured data provided to the + AdaptiveCardExtension. Note that data version is different from the version field in the manifest. + remarks: >- + The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is + used to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of + your AdaptiveCardExtension for more information. + + + Usage: versioning and evolving the serialized data of the AdaptiveCardExtension + + + Type: string representing a [semantic version](http://semver.org) with only two parts + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: true + isDeprecated: false + syntax: + content: 'dataVersion?: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member' + package: '@microsoft/sp-module-interfaces!' + fullName: description + summary: >- + Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This + value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and + other display areas. + remarks: >- + The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization + admin and page author will have the ability to change this description as per need. + + + Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"A tool for displaying neat information."` + + + ``` + { + "default": "A tool for displaying neat information.", + "en-us": "A tool for displaying neat information.", + "fr-fr": "Un outil d’affichage des informations soignées.", + "zh": "用於顯示整潔資訊的工具。" + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: 'description: ILocalizedString;' + return: + type: '' + - name: groupId + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: groupId + summary: >- + The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The + SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If + the developer fills an id not in the predefined groups, it falls back to Other group. + remarks: |- + Supported values: the GUID from PredefinedGroup list + + Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` + isPreview: true + isDeprecated: false + syntax: + content: 'groupId: PredefinedGroup | string;' + return: + type: ' | string' + - name: iconImageUrl + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: iconImageUrl + summary: >- + The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the + URL must be exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). + remarks: >- + If the + [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member) + field does not have a value, this field must have a value. This value can be an absolute URL (e.g. + `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). + In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file + will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). + + + Supported values: Any absolute URL. + + + Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + isPreview: true + isDeprecated: false + syntax: + content: 'iconImageUrl?: string;' + return: + type: string + - name: officeFabricIconFontName + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member' + package: '@microsoft/sp-module-interfaces!' + fullName: officeFabricIconFontName + summary: >- + The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the + Office 365 icon font file. + remarks: >- + The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has + a value, the + [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member) + field will be ignored. + + + Supported values: Any character name in the Office 365 Icon Font. + + + Example: "graph" + isPreview: true + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string;' + return: + type: string + - name: properties + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member' + package: '@microsoft/sp-module-interfaces!' + fullName: properties + summary: >- + Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension + might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and + list title as its properties, and so on. + remarks: >- + The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The + AdaptiveCardExtension developer fully controls the schema for these properties. The AdaptiveCardExtension + developer should follow versioning rules when updating the properties. + + + Usage: rendering of the AdaptiveCardExtension + + + Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` + isPreview: true + isDeprecated: false + syntax: + content: 'properties: TProperties;' + return: + type: TProperties + - name: tags + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member' + package: '@microsoft/sp-module-interfaces!' + fullName: tags + summary: >- + This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension + group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the + toolbox. + remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + isPreview: true + isDeprecated: false + syntax: + content: 'tags?: ILocalizedString[];' + return: + type: '[]' + - name: title + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' + package: '@microsoft/sp-module-interfaces!' + fullName: title + summary: >- + Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value + will be displayed to the user in the toolbox. + remarks: >- + This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give an + initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to change + this title as per need. + + + Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"My Webpart"` + + + ``` + { + "default": "My WebPart" + "en-us": "My WebPart", + "fr-fr": "Ma WebPart", + "zh": "我的 web 部件" + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: 'title: ILocalizedString;' + return: + type: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index e16ecea8..1a6f7f69 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -3,17 +3,14 @@ name: IClientSideAssemblyManifest uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideAssemblyManifest -summary: >- - A library is defined by this manifest. Libraries currently do not have any - additional properties. +summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' isPreview: false isDeprecated: false type: interface properties: - name: rootComponentId - uid: >- - @microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member + uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' package: '@microsoft/sp-module-interfaces!' fullName: rootComponentId summary: The ID of the component from which the assembly is built. @@ -27,7 +24,4 @@ properties: content: 'rootComponentId: string;' return: type: string -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 1be1f6a4..15d3f089 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -1,34 +1,29 @@ ### YamlMime:TSType name: IClientSideComponentLoaderConfiguration -uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface +uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideComponentLoaderConfiguration summary: >- - This interface describes how a client-side component is to be loaded and - initialized by a SharePoint client framework. It contains all data for loading - an entrypoint script and its dependency scripts. + This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. + It contains all data for loading an entrypoint script and its dependency scripts. remarks: '' isPreview: true isDeprecated: false type: interface properties: - name: entryModuleId - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' package: '@microsoft/sp-module-interfaces!' fullName: entryModuleId summary: This is the ID of one of the entries in the "scriptResources" dictionary. remarks: >- - The loader will download and evaluate the script resource referenced in - this field, resolve all dependencies against the keys in the - "scriptResources", and return the exported object to the loader's calling - function. The entry referenced in the "scriptResources" dictionary must be - of the "internal" or the "localized" type. + The loader will download and evaluate the script resource referenced in this field, resolve all dependencies + against the keys in the "scriptResources", and return the exported object to the loader's calling function. The + entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type. - Supported values: An entry in the "scriptResources" dictionary that - defines the base exported module of the component. + Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the + component. Example: `"myApplication.bundle"` @@ -39,33 +34,26 @@ properties: return: type: string - name: exportName - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' package: '@microsoft/sp-module-interfaces!' fullName: exportName - summary: >- - The module referenced by the "entryModuleId" field may export an object - with several fields. + summary: The module referenced by the "entryModuleId" field may export an object with several fields. remarks: >- - This value optionally references the name of a field on the object - exported by the module referenced by the `entryModuleId` field. When this - field has a value, the value of the referenced field on the object - exported by the module referenced by the `entryModuleId` field is returned - when this manifest is loaded instead of the base exported object. For - example, if entryModuleId refers to a module with with a top-level export - of `{ foo: 'bar', baz: 123 }` and: + This value optionally references the name of a field on the object exported by the module referenced by the + `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported by + the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of the base + exported object. For example, if entryModuleId refers to a module with with a top-level export of `{ foo: 'bar', + baz: 123 }` and: - - if this field is unset, the value returned by the module loader is `{ - foo: 'bar', baz: 123 }` + - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }` - - if this field is set to `foo`, the value returned by the module - loader is `bar` + - if this field is set to `foo`, the value returned by the module loader is `bar` - - if this field is set to `bar`, the value returned by the module - loader is undefined (as `bar` is not a key in the top-level export). + - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a + key in the top-level export). Example: `mySpWebpart` @@ -76,44 +64,34 @@ properties: return: type: string - name: internalModuleBaseUrls - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' package: '@microsoft/sp-module-interfaces!' fullName: internalModuleBaseUrls summary: >- - This is an array of fully-qualified paths to be prepended to each of the - script resource paths with the "internal" or "localized" type. If one - fails to load, the loader will attempt to load from the next until there - are no base paths remaining. + This is an array of fully-qualified paths to be prepended to each of the script resource paths with the "internal" + or "localized" type. If one fails to load, the loader will attempt to load from the next until there are no base + paths remaining. remarks: >- - All "internal" and "localized" script resources that do not have - fully-qualified URLs as their "path" field values must be hosted under - each of the paths listed in this property. For example, if an internal - module's "path" field value is - `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's - value is `[ "https://contoso.akamaihd.net/files/", - "https://contoso.msecnd.net/files/" ]`, the loader will first + All "internal" and "localized" script resources that do not have fully-qualified URLs as their "path" field values + must be hosted under each of the paths listed in this property. For example, if an internal module's "path" field + value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's value is `[ + "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from the URL - `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading from that URL fails, the loader will then attempt to load - this script resource from - `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL fails to load, the component will fail to load and an - error will be returned. It is important to note that the support for - multiple base URLs is purely for failover support. This means that all - files must be present on all hosts listed in this field. + `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading + from that URL fails, the loader will then attempt to load this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL + fails to load, the component will fail to load and an error will be returned. It is important to note that the + support for multiple base URLs is purely for failover support. This means that all files must be present on all + hosts listed in this field. - Usage: Base URLs for script resources with the "internal" or "localized" - type. + Usage: Base URLs for script resources with the "internal" or "localized" type. - Supported values: Any URL that contains all internal scripts referenced in - the "scriptResources" dictionary. + Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary. - Example: `[ "https://contoso.akamaihd.net/files/", - "https://contoso.msecnd.net/files/" ]` + Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` isPreview: true isDeprecated: false syntax: @@ -121,15 +99,13 @@ properties: return: type: 'string[]' - name: scriptResources - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' package: '@microsoft/sp-module-interfaces!' fullName: scriptResources summary: >- - This is a dictionary of named script resources. `path` and `localizedPath` - modules may reference each other and `manifest` modules are expected to be - provided by the framework runtime. The resource named in the - `entryModuleId` must contain the component's exported object. + This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and + `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` + must contain the component's exported object. remarks: |- Supported values: A dictionary of named script resources. @@ -166,7 +142,6 @@ properties: } } } - ``` isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index 31430925..c54fbbea 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -4,24 +4,20 @@ uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideComponentManifest summary: >- - All client-side components built on the SharePoint framework need a valid - component manifest. This interface represents properties that are required by - all types of client-side components like Applications and Web Parts. Component - specific manifests will extend this interface to add properties required by - that component type. + All client-side components built on the SharePoint framework need a valid component manifest. This interface + represents properties that are required by all types of client-side components like Applications and Web Parts. + Component specific manifests will extend this interface to add properties required by that component type. remarks: >- - The schema of this manifest is owned and versioned by Microsoft. Following - rules should be followed while changing this schema. This set of rules can - also be called the "manifest upgrade rules". + The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing + this schema. This set of rules can also be called the "manifest upgrade rules". - - For minor changes, new properties can be added to this schema in a - backwards-compatible way. i.e. the code that processes the manifest should be - able to handle the absence of those new properties. + - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that + processes the manifest should be able to handle the absence of those new properties. - - Try to model your changes as minor SemVer increments. Major version changes - should be avoided because they impose a migration cost on developers. + - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they impose a + migration cost on developers. - The `'manifestVersion'` should be bumped for all small or big changes. @@ -34,18 +30,13 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: alias summary: >- - A short name usually given by developer. It does not need to be localized - and is expected to stay the same through the lifetime of the component. If - an application overrides the `ClientSideApplication.alias` property, - `ClientSideApplication.alias` is given precedence over the value provided - in the manifest. - remarks: >- + A short name usually given by developer. It does not need to be localized and is expected to stay the same through + the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, + `ClientSideApplication.alias` is given precedence over the value provided in the manifest. + remarks: |- Usage: A short name to identify a client-side component by developer. - - Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer - than 40 characters. - + Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` isPreview: false @@ -55,23 +46,21 @@ properties: return: type: string - name: componentType - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' package: '@microsoft/sp-module-interfaces!' fullName: componentType summary: >- - Type of client-side component. Components with the "Application" type are - defined by the "IClientSideApplicationManifest" interface. Components with - the "WebPart" type are defined by the "IClientSideWebPartManifest" - interface. Components with the "Library" type are defined by the - "IClientSideLibraryManifest" interface. + Type of client-side component. Components with the "Application" type are defined by the + "IClientSideApplicationManifest" interface. Components with the "WebPart" type are defined by the + "IClientSideWebPartManifest" interface. Components with the "Library" type are defined by the + "IClientSideLibraryManifest" interface. Components with the "AdaptiveCardExtension" type are defined by the + "IAdaptiveCardExtensionManifest" interface. remarks: >- - Usage: To help bundling, loading, enumeration, and initialization of - components based on their contents. + Usage: To help bundling, loading, enumeration, and initialization of components based on their contents. - Supported values: `"Application"`, `"WebPart"`, - `"Library"`, `"Extension"` + Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, + `"AdaptiveCardExtension"` isPreview: false isDeprecated: false syntax: @@ -79,38 +68,29 @@ properties: return: type: '' - name: loaderConfig - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' package: '@microsoft/sp-module-interfaces!' fullName: loaderConfig summary: >- - This portion of the configuration describes how the component is to be - loaded and initialized by a client. It contains an enumeration of scripts - that the component requires along with a single entry point script. - remarks: >- + This portion of the configuration describes how the component is to be loaded and initialized by a client. It + contains an enumeration of scripts that the component requires along with a single entry point script. + remarks: |- Usage: Loading a component. - - See `IClientSideComponentLoaderConfiguration` for more information and - examples. + See `IClientSideComponentLoaderConfiguration` for more information and examples. isPreview: true isDeprecated: false syntax: content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' return: - type: >- - + type: '' - name: loadLegacyFabricCss - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' package: '@microsoft/sp-module-interfaces!' fullName: loadLegacyFabricCss summary: >- - This property is used to keep older components that don't explicitly use - fabric CSS. For the most part, webparts build after using spfx 1.1 don't - need this. + This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts + build after using spfx 1.1 don't need this. remarks: '' isPreview: false isDeprecated: false @@ -119,22 +99,19 @@ properties: return: type: boolean - name: requiresCustomScript - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' package: '@microsoft/sp-module-interfaces!' fullName: requiresCustomScript summary: >- - If true, the component can only be installed on sites where Custom Script - is enabled. This should be set to true if the component allows authors to - execute arbitrary scripts on the page. + If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true + if the component allows authors to execute arbitrary scripts on the page. remarks: >- Defaults to false. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. - Usage: Requires Custom Script to be allowed in order for this component to - be installed and run. + Usage: Requires Custom Script to be allowed in order for this component to be installed and run. isPreview: false isDeprecated: false syntax: @@ -142,13 +119,10 @@ properties: return: type: boolean - name: safeWithCustomScriptDisabled - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' package: '@microsoft/sp-module-interfaces!' fullName: safeWithCustomScriptDisabled - summary: >- - This property is provided for backwards compatibility. It no longer has - any effect. + summary: This property is provided for backwards compatibility. It no longer has any effect. remarks: '' isPreview: false isDeprecated: true @@ -158,35 +132,29 @@ properties: return: type: boolean - name: version - uid: >- - @microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' package: '@microsoft/sp-module-interfaces!' fullName: version summary: >- - Client-side component version. The value of this field is expected to be - controlled by the developer of the client-side component. + Client-side component version. The value of this field is expected to be controlled by the developer of the + client-side component. remarks: >- - The purpose of this field is to help client-side component developers - upgrade their client-side components in a managed way. This helps the - consumers of the client-side component make decisions about when and how - to upgrade the client-side component. As the developer evolves the code - for their client-side component, they can decide to bump the MAJOR, MINOR - or PATCH version of the component. + The purpose of this field is to help client-side component developers upgrade their client-side components in a + managed way. This helps the consumers of the client-side component make decisions about when and how to upgrade + the client-side component. As the developer evolves the code for their client-side component, they can decide to + bump the MAJOR, MINOR or PATCH version of the component. - All incompatible API changes should result in a MAJOR version bump. - Backwards compatible functionality changes should result in a MINOR - version bump, and backwards compatible bug fixes should result in a PATCH - version bump. Please see [http://semver.org](http://semver.org) for more - details on how to manage the version of your components. + All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes + should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. + Please see [http://semver.org](http://semver.org) for more details on how to manage the version of your + components. - Usage: Versioning and evolving a client-side component safely in a - controlled way. + Usage: Versioning and evolving a client-side component safely in a controlled way. - Supported values: string representing a [semantic - version](http://semver.org) i.e. MAJOR.MINOR.PATCH + Supported values: string representing a [semantic version](http://semver.org) i.e. MAJOR.MINOR.PATCH Example: `"1.0.0"` @@ -196,6 +164,4 @@ properties: content: 'version: string;' return: type: string -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index de1cf9cc..461234d2 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -10,13 +10,12 @@ isDeprecated: false type: interface properties: - name: extensionType - uid: >- - @microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member + uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' package: '@microsoft/sp-module-interfaces!' fullName: extensionType summary: >- - Specifies the type of client-side extension. Some extension types support - additional manifest fields beyond SPClientSideExtensionManifest. + Specifies the type of client-side extension. Some extension types support additional manifest fields beyond + SPClientSideExtensionManifest. remarks: '' isPreview: false isDeprecated: false @@ -24,7 +23,4 @@ properties: content: 'extensionType: ExtensionType;' return: type: '' -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index 44fe5321..bac9d402 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -3,14 +3,9 @@ name: IClientSideLibraryManifest uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideLibraryManifest -summary: >- - A library is defined by this manifest. Libraries currently do not have any - additional properties. +summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' isPreview: false isDeprecated: false type: interface -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index bfe23b40..e84cf0ca 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -3,9 +3,7 @@ name: IClientSideManifestBase uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideManifestBase -summary: >- - This interface defines members that are common between all deployable - manifests. +summary: This interface defines members that are common between all deployable manifests. remarks: '' isPreview: false isDeprecated: false @@ -16,9 +14,8 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: id summary: >- - A universally unique component id. Each client-side component is required - to have this id. Once an id has been used for a component, it cannot be - changed. A change in this value is treated same as the creation of a new + A universally unique component id. Each client-side component is required to have this id. Once an id has been + used for a component, it cannot be changed. A change in this value is treated same as the creation of a new component. Two components are never expected to have the same id. @@ -37,20 +34,16 @@ properties: return: type: string - name: manifestVersion - uid: >- - @microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' package: '@microsoft/sp-module-interfaces!' fullName: manifestVersion summary: >- - Version of the component manifest schema. The value of this field is - controlled by Microsoft. The purpose of this field is to help manage - upgrades of the component manifest schema. + Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this + field is to help manage upgrades of the component manifest schema. remarks: >- - A component developer needs to only confirm that they are using the - correct value per the manifest schema. Please read the "manifest upgrade - rules" for more details on when the schema could change. Note, manifest - schema version upgrade will be considered a big API change event and will - be advertised broadly. + A component developer needs to only confirm that they are using the correct value per the manifest schema. Please + read the "manifest upgrade rules" for more details on when the schema could change. Note, manifest schema version + upgrade will be considered a big API change event and will be advertised broadly. Usage: To help support multiple manifest schema versions. diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 3e32c1d1..8286f396 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -4,28 +4,23 @@ uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideWebPartManifest summary: >- - The client-side SharePoint framework identifies a Web Part by its manifest. - All Web Parts are expected to have a manifest. + The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a + manifest. remarks: >- - The manifest is a schematized JSON blob that is used in multiple parts of the - SharePoint infrastructure to identify, load and process a Web Part. The schema - for this manifest is completely owned and versioned by Microsoft. There are - some required properties in the manifest and some optional properties. - Optional properties need to be provided only if the Web Part needs the - specific functionality. An invalid manifest could lead to issues with Web Part - loading and functionality problems. + The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to identify, + load and process a Web Part. The schema for this manifest is completely owned and versioned by Microsoft. There are + some required properties in the manifest and some optional properties. Optional properties need to be provided only if + the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and + functionality problems. isPreview: false isDeprecated: false type: interface properties: - name: canUpdateConfiguration - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' package: '@microsoft/sp-module-interfaces!' fullName: canUpdateConfiguration - summary: >- - Indicates whether the web part uses the property pane to update the - configuration of the web part. + summary: Indicates whether the web part uses the property pane to update the configuration of the web part. remarks: Default value is `true` if the property is not explicitly defined. isPreview: false isDeprecated: false @@ -34,15 +29,13 @@ properties: return: type: boolean - name: disabledOnClassicSharepoint - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' package: '@microsoft/sp-module-interfaces!' fullName: disabledOnClassicSharepoint summary: 'If true, this web part is disabled on SharePoint classic pages' remarks: >- - Certain web parts may not be required on or apply to SharePoint classic - pages. This flag helps control that. If this flag is true, the web part - will not appear in the classic page web part gallery. + Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If + this flag is true, the web part will not appear in the classic page web part gallery. isPreview: false isDeprecated: false syntax: @@ -50,19 +43,14 @@ properties: return: type: boolean - name: hiddenFromToolbox - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' package: '@microsoft/sp-module-interfaces!' fullName: hiddenFromToolbox - summary: >- - If true, this web part should not be displayed in the modern SharePoint - toolbox. + summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' remarks: >- - Usage: Use this flag if it is not appropriate to display a web part in the - modern toolbox. This property is not used in Classic SharePoint. By - default, all web parts are enabled to be displayed in the toolbox. Such - web parts can be provisioned on pages though API or be added to the page - in a pre configured way. + Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not + used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts + can be provisioned on pages though API or be added to the page in a pre configured way. isPreview: false isDeprecated: false syntax: @@ -70,16 +58,14 @@ properties: return: type: boolean - name: imagePreviewUrl - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' package: '@microsoft/sp-module-interfaces!' fullName: imagePreviewUrl summary: 'Definition: Url of the image image used for preview' remarks: >- - Usage: Use this string to specify that a preview image should be used - instead of a preview rendering of the web part. This can either be a - absolute url or a relative URL which will be resolved based on the - internal base module url + Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web + part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module + url isPreview: false isDeprecated: false syntax: @@ -87,26 +73,21 @@ properties: return: type: string - name: preconfiguredEntries - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' package: '@microsoft/sp-module-interfaces!' fullName: preconfiguredEntries summary: >- - A Web Part can have pre-configured properties like the title, description, - toolbox group name and Web Part specific custom properties. And there can - be multiple instances of these pre-configured properties. + A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part + specific custom properties. And there can be multiple instances of these pre-configured properties. remarks: >- - This helps support scenarios where an organization may want to present - multiple pre-configured entries for a Web Part in the Toolbox. Each entry - is expected to configure the Web Part with a different set of - pre-configured properties. A developer may decide to seed some initial - values for these properties but an organization admin can go ahead and - customize these properties per the needs of his/her organization. The - properties can also be modified by the author of the page. + This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web + Part in the Toolbox. Each entry is expected to configure the Web Part with a different set of pre-configured + properties. A developer may decide to seed some initial values for these properties but an organization admin can + go ahead and customize these properties per the needs of his/her organization. The properties can also be modified + by the author of the page. - Usage: help display a Web Part in the Toolbox, PropertyPane and the - initial rendering of the Web Part. + Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. Type: JSON object @@ -129,54 +110,41 @@ properties: captionText: "Mount Rainier" } }] - ``` isPreview: false isDeprecated: false syntax: content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' return: - type: >- - <TProperties>[] + type: '<TProperties>[]' - name: supportedHosts - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' package: '@microsoft/sp-module-interfaces!' fullName: supportedHosts summary: 'Definition: An array defining what host types are supported' remarks: >- - Usage: Use this array to define all hosts that are supported. The default - value is SharePointWebPart if nothing is provided. If SharePointFullPage - is added the solution will be available when adding full page apps. If - SharePointWebPart is added the solution will be available when adding - webparts to a page. If TeamsTab or TeamsPersonalApp is added the solution - will be available when using teams. + Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is + provided. If SharePointFullPage is added the solution will be available when adding full page apps. If + SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, + TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp + cannot be used with TeamsTab or TeamsPersonalTab. isPreview: false isDeprecated: false syntax: content: >- - supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | - 'TeamsTab' | 'TeamsPersonalApp'>; + supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | + 'TeamsMeetingApp'>; return: - type: >- - <'SharePointFullPage' | - 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp'> + type: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> - name: supportsFullBleed - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' package: '@microsoft/sp-module-interfaces!' fullName: supportsFullBleed - summary: >- - Definition: If true, this web part supports and has been tested for full - bleed experience. + summary: 'Definition: If true, this web part supports and has been tested for full bleed experience.' remarks: >- - Usage: Use this flag if a web part supports full bleed experience and has - been tested as such. In this context, full bleed is a term used to denote - that the web part takes the whole width of the containing page. Full bleed - experiences require special treatment and testing. By default no web parts - support full bleed experiences. + Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, + full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed + experiences require special treatment and testing. By default no web parts support full bleed experiences. isPreview: false isDeprecated: false syntax: @@ -184,27 +152,19 @@ properties: return: type: boolean - name: supportsThemeVariants - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' package: '@microsoft/sp-module-interfaces!' fullName: supportsThemeVariants - summary: >- - Definition: If true, this web part supports and has been tested for theme - variants experience. + summary: 'Definition: If true, this web part supports and has been tested for theme variants experience.' remarks: >- - Usage: Use this flag if a web part supports theme variants and has been - tested as such. In order to support theme variants, web parts must have - the capability to render correctly in the context of a theme variant. A - web part may or may not need to be updated to support theme variants, but - should always be tested before enabling this flag. By default no web parts - support theme variants. + Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme + variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may + or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By + default no web parts support theme variants. isPreview: false isDeprecated: false syntax: content: 'supportsThemeVariants?: boolean;' return: type: boolean -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 55042f7a..7f18665a 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' package: '@microsoft/sp-module-interfaces!' fullName: IClientSideWebPartManifestEntry summary: >- - This interface specifies the set of properties that can be pre-configured by a - Web Part developer. Each pre-configured instance of the Web Part will need a - copy of these properties. Organization admins and content authors can modify + This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured + instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' isPreview: false @@ -14,26 +13,22 @@ isDeprecated: false type: interface properties: - name: dataVersion - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' package: '@microsoft/sp-module-interfaces!' fullName: dataVersion summary: >- - Definition: Use this field to specify the data version of the - pre-configured data provided to the web part. Note that data version is - different from the version field in the manifest. + Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note + that data version is different from the version field in the manifest. remarks: >- - The manifest version is used to control the versioning of the web part - code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web - part for more information. + The manifest version is used to control the versioning of the web part code, while data version is used to control + the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more + information. Usage: versioning and evolving the serialized data of the web part - Type: string representing a [semantic version](http://semver.org) with - only two parts + Type: string representing a [semantic version](http://semver.org) with only two parts Supported values: MAJOR.MINOR @@ -47,27 +42,22 @@ properties: return: type: string - name: description - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' package: '@microsoft/sp-module-interfaces!' fullName: description summary: >- - Description of the web part represented as a dictionary of locale keys to - description values. This value will be displayed to the user in the - toolbox. This description should be used in the Toolbox tooltip and other - display areas. + Description of the web part represented as a dictionary of locale keys to description values. This value will be + displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display + areas. remarks: >- - The Web Part developer may give an initial description to the web part. - The organization admin and page author will have the ability to change - this description as per need. + The Web Part developer may give an initial description to the web part. The organization admin and page author + will have the ability to change this description as per need. - Usage: display the description of the web part in the toolbox tooltip, web - part gallery and the page. + Usage: display the description of the web part in the toolbox tooltip, web part gallery and the page. - Supported values: a dictionary of locale keys to strings. Should always - have a `'default'` key. + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. Example: `"A tool for displaying neat information."` @@ -80,45 +70,57 @@ properties: "fr-fr": "Un outil d’affichage des informations soignées.", "zh": "用於顯示整潔資訊的工具。" } - ``` isPreview: false isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: >- - + type: '' + - name: fullPageAppIconImageUrl + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: fullPageAppIconImageUrl + summary: The icon for the Application pages. + remarks: >- + If this field is not defined, then the iconimageurl is used instead as the icon for Full Page apps. This value can + be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. + `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to the folder containing + the input manifest. + + + Supported values: Any absolute URL. + + + Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + isPreview: false + isDeprecated: false + syntax: + content: 'fullPageAppIconImageUrl?: string;' + return: + type: string - name: group - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' package: '@microsoft/sp-module-interfaces!' fullName: group summary: >- - The group name in web part picker to contain the web part in the classic - page. If no value is provided, then the web part will be displayed in the - Miscellaneous group. + The group name in web part picker to contain the web part in the classic page. If no value is provided, then the + web part will be displayed in the Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' isPreview: true isDeprecated: false syntax: content: 'group?: ILocalizedString;' return: - type: >- - + type: '' - name: groupId - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' package: '@microsoft/sp-module-interfaces!' fullName: groupId summary: >- - The group id to determine which modern group contains the web part in - modern site page. The SharePoint Framework reserves group ids for - predefined groups. The developer can pick one from those groups. If the - developer fills an id not in the predefined groups, it falls back to Other - group. + The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework + reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an + id not in the predefined groups, it falls back to Other group. remarks: |- Supported values: the GUID from PredefinedGroup list @@ -128,29 +130,22 @@ properties: syntax: content: 'groupId: PredefinedGroup | string;' return: - type: >- - | - string + type: ' | string' - name: iconImageUrl - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' package: '@microsoft/sp-module-interfaces!' fullName: iconImageUrl summary: >- - The icon for the web part, to be displayed in the toolbox, represented an - image URL. The image at the URL must be exactly 40x28 px (SPPPLAT - VSO\#218660 to fix the size of the icon image). + The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be + exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). remarks: >- If the - [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member) - field does not have a value, this field must have a value. This value can - be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) - or a relative file path (e.g. `"./icons/my-icon.png"`). In the - latter case, the path will be resolved relative to the folder containing - the input manifest. The icon file will be copied to the deployment folder - like an asset, and the output manifest’s iconImageUrl will be replaced - with a URL relative to the URL used to load all other assets (the - loaderConfig.internalModuleBaseUrls property). + [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member) + field does not have a value, this field must have a value. This value can be an absolute URL (e.g. + `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). + In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file + will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). Supported values: Any absolute URL. @@ -164,18 +159,16 @@ properties: return: type: string - name: officeFabricIconFontName - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' package: '@microsoft/sp-module-interfaces!' fullName: officeFabricIconFontName summary: >- - The icon for the Web Part, to be displayed in the toolbox, represented as - a character name in the Office 365 icon font file. + The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon + font file. remarks: >- - The icon font is specified here: - [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this - field has a value, the - [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member) + The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has + a value, the + [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member) field will be ignored. @@ -190,28 +183,23 @@ properties: return: type: string - name: properties - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' package: '@microsoft/sp-module-interfaces!' fullName: properties summary: >- - Every web part is expected to have some custom properties. For example, an - image web part might define properties for the image URL and caption text. - A list web part may have the list ID and list title as its properties, and - so on. + Every web part is expected to have some custom properties. For example, an image web part might define properties + for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so + on. remarks: >- - The SharePoint Framework passes these properties to the web parts when - they are loaded. The web part developer fully controls the schema for - these properties. The web part developer should follow versioning rules - when updating the properties. + The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer + fully controls the schema for these properties. The web part developer should follow versioning rules when + updating the properties. Usage: rendering of the web part - Example: `{"imageSource": - "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": - "Contoso logo"}"` + Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` isPreview: false isDeprecated: false syntax: @@ -219,46 +207,35 @@ properties: return: type: TProperties - name: tags - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' package: '@microsoft/sp-module-interfaces!' fullName: tags summary: >- - This field is used to tag a web part with keywords that are different from - the web part group name. Tags can be used for categorization and searching - of web parts. For example, in the web part toolbox. - remarks: >- - Example `[{ "default": "image" }, { "default": "media" }, { "default": - "picture" }, ...]` + This field is used to tag a web part with keywords that are different from the web part group name. Tags can be + used for categorization and searching of web parts. For example, in the web part toolbox. + remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' isPreview: true isDeprecated: false syntax: content: 'tags?: ILocalizedString[];' return: - type: >- - [] + type: '[]' - name: title - uid: >- - @microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' package: '@microsoft/sp-module-interfaces!' fullName: title summary: >- - Title of the web part represented as a single a dictionary of locale keys - to title values. This value will be displayed to the user in the toolbox. + Title of the web part represented as a single a dictionary of locale keys to title values. This value will be + displayed to the user in the toolbox. remarks: >- - This title should be used in the Toolbox and other display areas. The Web - Part developer may give an initial title to the web part. The organization - admin and page author will have the ability to change this title as per - need. + This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title + to the web part. The organization admin and page author will have the ability to change this title as per need. - Usage: display the name of the web part in the toolbox, web part gallery - and the page. + Usage: display the name of the web part in the toolbox, web part gallery and the page. - Supported values: a dictionary of locale keys to strings. Should always - have a `'default'` key. + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. Example: `"My Webpart"` @@ -271,13 +248,10 @@ properties: "fr-fr": "Ma WebPart", "zh": "我的 web 部件" } - ``` isPreview: false isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: >- - + type: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 12856c5f..b88fd877 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -8,7 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index e8dbdd86..06a03705 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' package: '@microsoft/sp-module-interfaces!' fullName: ICommandDefinition summary: >- - Used by ICommandSetExtensionManifest, this defines a command to be displayed - by a UI surface such as a menu, tool bar, etc. + Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, + etc. remarks: '' isPreview: false isDeprecated: false @@ -16,35 +16,28 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: ariaLabel summary: >- - Custom accessibility text for the browser's "aria-label" attribute. If - omitted, the title property will be used by default. Example: "Show - information. Press ENTER to select." + Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by + default. Example: "Show information. Press ENTER to select." remarks: '' isPreview: false isDeprecated: false syntax: content: 'ariaLabel?: ILocalizedString;' return: - type: >- - + type: '' - name: iconImageUrl uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' package: '@microsoft/sp-module-interfaces!' fullName: iconImageUrl summary: >- - An optional URL for an image to be displayed next to the command. The - requirements for this image are defined by the type of extension; some - extension types may not display the image at all. + An optional URL for an image to be displayed next to the command. The requirements for this image are defined by + the type of extension; some extension types may not display the image at all. remarks: >- - This value can be an absolute URL (e.g. - "http://example.com/icons/my-icon.png") or a relative file path (e.g. - "./icons/my-icon.png"). In the latter case, the path will be resolved - relative to the folder containing the input manifest. The icon file will - be copied to the deployment folder like an asset, and the output - manifest’s iconImageUrl will be replaced with a URL relative to the URL - used to load all other assets (the loaderConfig.internalModuleBaseUrls - property). + This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. + "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input + manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s + iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the + loaderConfig.internalModuleBaseUrls property). isPreview: false isDeprecated: false syntax: @@ -55,18 +48,14 @@ properties: uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' package: '@microsoft/sp-module-interfaces!' fullName: title - summary: >- - A short label to be displayed by the associated button, menu item, etc. - Example: "Show information" + summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' remarks: '' isPreview: false isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: >- - + type: '' - name: type uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index 2a87dcb1..1ae87848 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -4,21 +4,20 @@ uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' package: '@microsoft/sp-module-interfaces!' fullName: ICommandSetExtensionManifest summary: >- - This is the manifest for a client-side extension that defines a set of custom - commands that can be shown in a menu, tool bar, etc. + This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, + tool bar, etc. remarks: '' isPreview: false isDeprecated: false type: interface properties: - name: extensionType - uid: >- - @microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' package: '@microsoft/sp-module-interfaces!' fullName: extensionType summary: >- - Specifies the type of client-side extension. Some extension types support - additional manifest fields beyond SPClientSideExtensionManifest. + Specifies the type of client-side extension. Some extension types support additional manifest fields beyond + SPClientSideExtensionManifest. remarks: '' isPreview: false isDeprecated: false @@ -30,13 +29,10 @@ properties: uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' package: '@microsoft/sp-module-interfaces!' fullName: items - summary: >- - A table of items defined by this command set. The object key is the Item - ID. + summary: A table of items defined by this command set. The object key is the Item ID. remarks: >- - The Item ID is a unique identifier that event handlers use to recognize - the command The identifier must consist of upper-case letters, numbers, - and underscores. Example: "SHOW\_INFO" + The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of + upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" isPreview: false isDeprecated: false syntax: @@ -49,7 +45,4 @@ properties: { [itemId: string]: ; } -extends: >- - +extends: '' diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 631caa1c..04938a19 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -4,32 +4,26 @@ uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' package: '@microsoft/sp-module-interfaces!' fullName: IComponentModuleConfiguration summary: >- - This is the interface for a script module with the "component" type. Modules - of this type will be provided via manifests. In order for the dependency to be - loaded, the manifest must be available on the site. + This is the interface for a script module with the "component" type. Modules of this type will be provided via + manifests. In order for the dependency to be loaded, the manifest must be available on the site. remarks: '' isPreview: true isDeprecated: false type: interface properties: - name: failoverPath - uid: >- - @microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' package: '@microsoft/sp-module-interfaces!' fullName: failoverPath - summary: >- - A path to the framework-supplied component in case the framework fails to - load the requested version. + summary: A path to the framework-supplied component in case the framework fails to load the requested version. remarks: >- - This must be either a fully-qualified URL, or a path under the paths - specified in the `internalModuleBaseUrls` field. If this field is not - specified and the version is not available in the framework runtime, the - closest matching version of the component will be provided instead. + This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` + field. If this field is not specified and the version is not available in the framework runtime, the closest + matching version of the component will be provided instead. - Supported values: The path to the component either as a fully-qualified - URL or as a path under the paths provided in the "internalModuleBaseUrls" - field. + Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided + in the "internalModuleBaseUrls" field. Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` @@ -38,9 +32,7 @@ properties: syntax: content: 'failoverPath?: string | IPath;' return: - type: >- - string | + type: 'string | ' - name: id uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' package: '@microsoft/sp-module-interfaces!' @@ -57,19 +49,15 @@ properties: return: type: string - name: version - uid: >- - @microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' package: '@microsoft/sp-module-interfaces!' fullName: version summary: >- - The version of the framework-supplied component to be loaded. For - framework runtime component such as `@microsoft/sp-client-base`, - it is recommended the version of the framework component the component was + The version of the framework-supplied component to be loaded. For framework runtime component such as + `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was developed against be specified. - remarks: >- - Supported values: string representing a [semantic - version](http://semver.org), or "latest". - + remarks: |- + Supported values: string representing a [semantic version](http://semver.org), or "latest". Example: `"2.2.4"` isPreview: true diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 26441fdd..4a71d92c 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -5,33 +5,28 @@ package: '@microsoft/sp-module-interfaces!' fullName: ILocalizedPathModuleConfiguration summary: This is the interface for a script module with the "localizedPath" type. remarks: >- - Modules of this type must be provided by the component developer. These script - resources are similar to those of the "path" type, but they may be present at - a number of different paths, to be selected by the user's locale. Paths in + Modules of this type must be provided by the component developer. These script resources are similar to those of the + "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as "internal" modules are. isPreview: true isDeprecated: false type: interface properties: - name: defaultPath - uid: >- - @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' package: '@microsoft/sp-module-interfaces!' fullName: defaultPath summary: >- - A path to this module's default locale javascript resource either as a - fully-qualified URL or as a path under the paths provided in the - "internalModuleBaseUrls" field. + A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the + paths provided in the "internalModuleBaseUrls" field. remarks: >- - If the user's locale does not resolve to one of the paths specified in the - "paths" field, the path in this field is used. Paths in this module type - are treated exactly the same way paths in modules of the "internal" type - are treated. + If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this field + is used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are + treated. - Supported values: The path to the default locale version of the module - either as a fully-qualified URL or as a path under the paths provided in - the "internalModuleBaseUrls" field. + Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a + path under the paths provided in the "internalModuleBaseUrls" field. Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` @@ -40,33 +35,24 @@ properties: syntax: content: 'defaultPath: string | IPath;' return: - type: >- - string | + type: 'string | ' - name: paths - uid: >- - @microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' package: '@microsoft/sp-module-interfaces!' fullName: paths summary: >- - This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to - this module's locale javascript resource either as a fully-qualified URL - or as a path under the paths provided in the `"internalModuleBaseUrls"` - field. + This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale javascript resource + either as a fully-qualified URL or as a path under the paths provided in the `"internalModuleBaseUrls"` field. remarks: >- - The loader will attempt to resolve the user's locale to one of the paths - provided by this field, and will load the script resource under that path. - If the user's locale does not resolve to one of the paths specified in - this field, the path in `"defaultPath"` field is used. For example, if the - user's locale is `"en-gb"`, and this field's value contains the - keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the - `"en-gb"` key will be used. If the user's locale is "en-gb", and this - field's value contains the keys `[ "en-us", "fr-fr" ]`, the path - specified by the `"en-us"` key will be used. If the user's locale is - `"en-gb"`, and this field's value contains the keys `[ "es-es", - "fr-fr" ]`, the path specified by the "defaultPath" field will be - used. Paths in this module type are treated exactly the same way paths in - modules of the "internal" type are treated. + The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the + script resource under that path. If the user's locale does not resolve to one of the paths specified in this + field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this + field's value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key + will be used. If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this + field's value contains the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will + be used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are + treated. Supported values: A dictionary of locale-to-path mappings. @@ -80,7 +66,6 @@ properties: "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" } - ``` isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index 1811cd34..d2d19315 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -8,12 +8,10 @@ remarks: >- Supported values: - - An Id referring to a localized resource. In this case it requires an 'id' - key. + - An Id referring to a localized resource. In this case it requires an 'id' key. - - A dictionary of locale keys to strings. In this case it requires a 'default' - key. + - A dictionary of locale keys to strings. In this case it requires a 'default' key. ``` @@ -29,7 +27,6 @@ remarks: >- "fr-fr": "Ma demande", "zh": "我的應用程式" } - ``` Notes on string ids: @@ -41,16 +38,14 @@ remarks: >- - `resourceName` needs to be a `localizedResource` in the config.json. - - `expression` is an expression that will be evaluated to access the string - from the resource module. + - `expression` is an expression that will be evaluated to access the string from the resource module. - If your resource is a dictionary, access it through - `"$resource:resource.MyString;"` or `"$resource:resource[\"MyString\"];"` + If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or + `"$resource:resource[\"MyString\"];"` - For more complex cases, run an appropriate expression to access your resource - and return the string. + For more complex cases, run an appropriate expression to access your resource and return the string. isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index e81ba9ee..af86cba3 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -10,19 +10,14 @@ isDeprecated: false type: interface properties: - name: shouldNotPreload - uid: >- - @microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' package: '@microsoft/sp-module-interfaces!' fullName: shouldNotPreload - summary: >- - If set to `true`, this module should not be preloaded when loading - the component. + summary: 'If set to `true`, this module should not be preloaded when loading the component.' remarks: >- - The most common case for setting this property to "true" is when a module - is defined in a manifest, but is not required for the module referenced in - "entryModuleId" to load. Modules may be defined that are loaded - asynchronously, and these modules do not need to be preloaded. This field - implicitly defaults to `false`. + The most common case for setting this property to "true" is when a module is defined in a manifest, but is not + required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded + asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. Usage: Instructs the module loader to not preload this module. @@ -37,22 +32,17 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: type summary: >- - The type of the script block. `"component"` modules come from a component, - `"path"` and `"localizedPath"` modules must be available on the paths - provided in the `"internalModuleBaseUrls"` field. + The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules + must be available on the paths provided in the `"internalModuleBaseUrls"` field. remarks: >- - Modules with the `"path"` type use the `IPathModuleConfiguration` - interface. + Modules with the `"path"` type use the `IPathModuleConfiguration` interface. - Modules with the `"component"` type use the - `IComponentModuleConfiguration` interface. Modules with the - "localizedPath" type use the `ILocalizedPathModuleConfiguration` - interface. + Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the + "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. - Supported values: `"component"`, `"path"`, - `"localizedPath"` + Supported values: `"component"`, `"path"`, `"localizedPath"` Example: `"localized"` diff --git a/SP-Framework/sp-module-interfaces/ipath.yml b/SP-Framework/sp-module-interfaces/ipath.yml index 689e54f2..47345d64 100644 --- a/SP-Framework/sp-module-interfaces/ipath.yml +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-module-interfaces!IPath:interface' package: '@microsoft/sp-module-interfaces!' fullName: IPath summary: >- - This is the base interface for a set of debug and non-debug/minimized paths. - The paths in this object are loaded in exactly the same way as any other - internal path. + This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded in + exactly the same way as any other internal path. remarks: '' isPreview: true isDeprecated: false @@ -17,14 +16,12 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: debug summary: >- - A path to this module's debug javascript resource either as a - fully-qualified URL or as a path under the paths provided in the - "internalModuleBaseUrls" field. The script referenced by this field is - only loaded if it is present and debug scripts are explicitly requested. + A path to this module's debug javascript resource either as a fully-qualified URL or as a path under the paths + provided in the "internalModuleBaseUrls" field. The script referenced by this field is only loaded if it is + present and debug scripts are explicitly requested. remarks: >- - Supported values: The path to the debug script either as a fully-qualified - URL or as a path under the paths provided in the - `"internalModuleBaseUrls"` field. + Supported values: The path to the debug script either as a fully-qualified URL or as a path under the paths + provided in the `"internalModuleBaseUrls"` field. Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` @@ -39,14 +36,12 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: default summary: >- - A path to this module's javascript resource either as a fully-qualified - URL or as a path under the paths provided in the "internalModuleBaseUrls" - field. The script referenced by this field is loaded by default unless a - debug version of the script is provided and explicitly requested. + A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided + in the "internalModuleBaseUrls" field. The script referenced by this field is loaded by default unless a debug + version of the script is provided and explicitly requested. remarks: >- - Supported values: The path to the default/non-debug script either as a - fully-qualified URL or as a path under the paths provided in the - "internalModuleBaseUrls" field. + Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the + paths provided in the "internalModuleBaseUrls" field. Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index e265d506..6d3413e2 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -4,32 +4,28 @@ uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' package: '@microsoft/sp-module-interfaces!' fullName: IPathModuleConfiguration summary: >- - This is the interface for a script module with the "path" type. Modules of - this type must be provided by the component developer. + This is the interface for a script module with the "path" type. Modules of this type must be provided by the component + developer. remarks: '' isPreview: true isDeprecated: false type: interface properties: - name: globalDependencies - uid: >- - @microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' package: '@microsoft/sp-module-interfaces!' fullName: globalDependencies summary: >- - For non-AMD/module-pattern scripts that have dependencies (for example, - jQuery plugins), the module loader will ensure that those dependencies are - already loaded. + For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will + ensure that those dependencies are already loaded. remarks: >- - Entries in the array specified in this field must refer to other non-AMD - modules in this component. This field is not required to have a value for - non-AMD modules. If any values are specified that do not refer to other - modules in the same component manifest that this module is specified, the - module loader will throw an exception and the component will fail to load. + Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is + not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules + in the same component manifest that this module is specified, the module loader will throw an exception and the + component will fail to load. - Supported values: Names of other non-AMD-pattern modules in this loader - configuration, as specified by the key + Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key `IClientSideComponentLoaderConfiguration.scriptResources[]` @@ -45,22 +41,19 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: globalName summary: >- - If this property is specified, this module is considered non-AMD and the - module loader will not expect "define" or "require" to be called. + If this property is specified, this module is considered non-AMD and the module loader will not expect "define" or + "require" to be called. remarks: >- - In order to load scripts that don't follow the AMD/module-pattern where - "define" or "require" is called and dependencies are explicitly listed and - exports are explicitly returned, the module loader needs to know which - global variable must be examined. If this property is specified, this - module is considered non-AMD and the module loader will not expect - "define" or "require" to be called. Instead, it will wait for the script - to finish loading and examine the global variable specified in this field. + In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is called and + dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which + global variable must be examined. If this property is specified, this module is considered non-AMD and the module + loader will not expect "define" or "require" to be called. Instead, it will wait for the script to finish loading + and examine the global variable specified in this field. - Supported values: Variable names that are expected to be populated after - this module is loaded. For example, if this module is describing jQuery, - this value should probably be "$". If an empty string is specified, the - module loader will throw an exception and the component will fail to load. + Supported values: Variable names that are expected to be populated after this module is loaded. For example, if + this module is describing jQuery, this value should probably be "$". If an empty string is specified, the module + loader will throw an exception and the component will fail to load. Example: `"$"` @@ -75,27 +68,20 @@ properties: package: '@microsoft/sp-module-interfaces!' fullName: path summary: >- - A path to this module's javascript resource either as a fully-qualified - URL or as a path under the paths provided in the `internalModuleBaseUrls` - field. + A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided + in the `internalModuleBaseUrls` field. remarks: >- - For example, if this field's value is - `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the - `"internalModuleBaseUrls"` field's value is `[ - "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" - ]`, the loader will first attempt to load this script resource - from the URL - `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading from that URL fails, the loader will then attempt to load - this script resource from - `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL fails to load, the component will fail to load and an - error will be returned. + For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the + `"internalModuleBaseUrls"` field's value is `[ "https://contoso.akamaihd.net/files/", + "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from + the URL `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If + loading from that URL fails, the loader will then attempt to load this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL + fails to load, the component will fail to load and an error will be returned. - Supported values: The path to the module either as a fully-qualified URL - or as a path under the paths provided in the "internalModuleBaseUrls" - field. + Supported values: The path to the module either as a fully-qualified URL or as a path under the paths provided in + the "internalModuleBaseUrls" field. Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` @@ -104,7 +90,5 @@ properties: syntax: content: 'path: string | IPath;' return: - type: >- - string | + type: 'string | ' extends: '' diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index 48c3f651..aa38f38d 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -9,34 +9,29 @@ isPreview: true isDeprecated: false fields: - name: BusinessAndIntelligence - uid: >- - @microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' package: '@microsoft/sp-module-interfaces!' - summary: >- + summary: |- Business and intelligence. - - This group includes web parts for tracking and analyzing data, and for - integrating business flow with pages. + This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. + value: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' - name: CommunicationAndCollaboration - uid: >- - @microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' package: '@microsoft/sp-module-interfaces!' - summary: >- + summary: |- Communication and collaboration. - - This group includes web parts that facilitate information sharing, team - work, and social interactions. + This group includes web parts that facilitate information sharing, team work, and social interactions. + value: '"75e22ed5-fa14-4829-850a-c890608aca2d"' - name: Discovery uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' package: '@microsoft/sp-module-interfaces!' - summary: >- + summary: |- Discovery. - - This group includes web parts that organize, group, and filter content to - help users discover information. + This group includes web parts that organize, group, and filter content to help users discover information. + value: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' - name: Other uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' package: '@microsoft/sp-module-interfaces!' @@ -44,15 +39,15 @@ fields: Other. This group includes web parts not in other groups. + value: '"5c03119e-3074-46fd-976b-c60198311f70"' - name: PlanningAndProcess uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' package: '@microsoft/sp-module-interfaces!' - summary: >- + summary: |- Planning and process. - - This group includes web parts that empower team productivity with the use - of planning and process tools. + This group includes web parts that empower team productivity with the use of planning and process tools. + value: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' - name: SiteTools uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' package: '@microsoft/sp-module-interfaces!' @@ -60,6 +55,7 @@ fields: Site tools. This group includes web parts for site information and management. + value: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' - name: TextMediaAndContent uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' package: '@microsoft/sp-module-interfaces!' @@ -67,5 +63,6 @@ fields: Text, media and content. - This group includes web parts that display text, multi-media, documents, - information from the web, and other rich content. + This group includes web parts that display text, multi-media, documents, information from the web, and other rich + content. + value: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 76de6d2a..9302846a 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!_IODataUserId:interface' package: '@microsoft/sp-odata-types!' fullName: _IODataUserId summary: >- - Represents an OData SP.UserId object. For more information about this object - see the MSDN documentation here: + Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index 3694de34..d38dfc06 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' package: '@microsoft/sp-odata-types!' fullName: IODataChangeToken summary: >- - Represents an OData SP.ChangeToken object. For more information about this - object, see + Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false @@ -16,9 +15,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' package: '@microsoft/sp-odata-types!' fullName: StringValue - summary: >- - Example: `{ StringValue: - "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }` + summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index f95cb69f..7c07f4a9 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' package: '@microsoft/sp-odata-types!' fullName: IODataContextWebInformation summary: >- - Represents an OData SP.ContextWebInformation object. For more information - about this object, see + Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false @@ -13,8 +12,7 @@ isDeprecated: false type: interface properties: - name: LibraryVersion - uid: >- - @microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' package: '@microsoft/sp-odata-types!' fullName: LibraryVersion summary: 'Example: `"16.0.4919.3000"`' @@ -38,8 +36,7 @@ properties: return: type: string - name: SupportedSchemaVersions - uid: >- - @microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' package: '@microsoft/sp-odata-types!' fullName: SupportedSchemaVersions summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 291d5423..0a0d8f20 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!IODataList:interface' package: '@microsoft/sp-odata-types!' fullName: IODataList summary: >- - Represents an OData SP.List object. For more information about this object see - the MSDN documentation here: + Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false @@ -77,9 +76,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: Hidden summary: >- - A hidden list does not appear on the Documents and Lists page, Quick - Launch bar, the Modify Site Content page, or the Add Column page as an - option for lookup fields. + A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or + the Add Column page as an option for lookup fields. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index d6fc2b96..91777f5f 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!IODataListItem:interface' package: '@microsoft/sp-odata-types!' fullName: IODataListItem summary: >- - Represents an OData SP.ListItem object. For more information about this object - see the MSDN documentation here: + Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 4b514423..a89c8b9d 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -15,18 +15,14 @@ properties: uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' package: '@microsoft/sp-odata-types!' fullName: Children - summary: >- - Gets or sets an array of Navigation Nodes that are children to the current - node. + summary: Gets or sets an array of Navigation Nodes that are children to the current node. remarks: '' isPreview: false isDeprecated: false syntax: content: 'Children?: IODataNavigationNode[];' return: - type: >- - [] + type: '[]' - name: Id uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' package: '@microsoft/sp-odata-types!' @@ -56,8 +52,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: IsExternal summary: >- - Gets or sets a value that specifies whether the navigation node URL - potentially corresponds to pages outside of the site collection. + Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of + the site collection. remarks: '' isPreview: false isDeprecated: false @@ -69,9 +65,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' package: '@microsoft/sp-odata-types!' fullName: IsVisible - summary: >- - Gets or sets a value that specifies if the node navigation link should be - visible. + summary: Gets or sets a value that specifies if the node navigation link should be visible. remarks: '' isPreview: false isDeprecated: false @@ -83,9 +77,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' package: '@microsoft/sp-odata-types!' fullName: Title - summary: >- - Gets or sets a value that specifies the anchor text for the node - navigation link. + summary: Gets or sets a value that specifies the anchor text for the node navigation link. remarks: '' isPreview: false isDeprecated: false @@ -98,9 +90,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: Url summary: >- - Gets or sets a value that specifies the URL to be stored with the - navigation node. It must be a URL of relative form if IsExternal is false. - It must be a URL of relative or absolute form. + Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative + form if IsExternal is false. It must be a URL of relative or absolute form. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index e4149491..97df29e3 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -12,35 +12,26 @@ isDeprecated: false type: interface properties: - name: quickLaunch - uid: >- - @microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' package: '@microsoft/sp-odata-types!' fullName: quickLaunch - summary: >- - Gets an SPNavigationNode object that contains the nodes in the Quick - Launch area of the site. + summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. remarks: '' isPreview: false isDeprecated: false syntax: content: 'quickLaunch: IODataNavigationNode[];' return: - type: >- - [] + type: '[]' - name: topNav uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' package: '@microsoft/sp-odata-types!' fullName: topNav - summary: >- - Gets an SPNavigationNode object that contains the nodes in the top link - bar for the website. + summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. remarks: '' isPreview: false isDeprecated: false syntax: content: 'topNav: IODataNavigationNode[];' return: - type: >- - [] + type: '[]' diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index 7f39290f..4053347b 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!IODataUser:interface' package: '@microsoft/sp-odata-types!' fullName: IODataUser summary: >- - Represents an OData SP.User object. For more information about this object see - the MSDN documentation here: + Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false @@ -40,9 +39,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' package: '@microsoft/sp-odata-types!' fullName: IsSiteAdmin - summary: >- - Boolean value that specifies whether the user is a site collection - administrator. + summary: Boolean value that specifies whether the user is a site collection administrator. remarks: '' isPreview: false isDeprecated: false @@ -66,9 +63,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' package: '@microsoft/sp-odata-types!' fullName: PrincipalType - summary: >- - This enumeration has a FlagsAttribute attribute that allows a bitwise - combination of its member values. + summary: This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. remarks: |- Values: @@ -106,8 +101,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: UserId summary: >- - Gets the information of the user that contains the user's name identifier - and the issuer of the user's name identifier. + Gets the information of the user that contains the user's name identifier and the issuer of the user's name + identifier. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index 91a74182..8fd2a96c 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' package: '@microsoft/sp-odata-types!' fullName: IODataUserCustomAction summary: >- - Represents an OData SP.UserCustomAction object. For more information about - this object see the MSDN documentation here: + Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation + here: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) remarks: '' isPreview: false @@ -13,13 +13,10 @@ isDeprecated: false type: interface properties: - name: ClientSideComponentId - uid: >- - @microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' package: '@microsoft/sp-odata-types!' fullName: ClientSideComponentId - summary: >- - The unique identifier of the client-side component defined with SharePoint - Framework + summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' isPreview: false isDeprecated: false @@ -28,16 +25,14 @@ properties: return: type: string - name: ClientSideComponentProperties - uid: >- - @microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' package: '@microsoft/sp-odata-types!' fullName: ClientSideComponentProperties summary: Custom initialization properties for the client-side component. remarks: >- - This property is only used when a ClientSideComponentId is specified. It - is optional. If non-empty, the string must contain a JSON object with - custom initialization properties whose format and meaning are defined by - the client-side component. + This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string + must contain a JSON object with custom initialization properties whose format and meaning are defined by the + client-side component. Example: `"{ \"maxItemsToShow\": 123 }"` @@ -52,8 +47,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: CommandUIExtension summary: >- - Gets or sets a value that specifies an implementation specific XML - fragment that determines user interface properties of the custom action. + Gets or sets a value that specifies an implementation specific XML fragment that determines user interface + properties of the custom action. remarks: '' isPreview: false isDeprecated: false @@ -78,8 +73,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: Group summary: >- - Gets or sets a value that specifies an implementation-specific value that - determines the position of the custom action in the page. + Gets or sets a value that specifies an implementation-specific value that determines the position of the custom + action in the page. remarks: '' isPreview: false isDeprecated: false @@ -92,8 +87,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: Id summary: >- - Gets a value that specifies the identifier (GUID) of the custom action. - Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` + Gets a value that specifies the identifier (GUID) of the custom action. Example: + `"48309f28-53aa-43ed-b113-625120e5af6f"` remarks: '' isPreview: false isDeprecated: false @@ -129,9 +124,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' package: '@microsoft/sp-odata-types!' fullName: RegistrationId - summary: >- - Gets or sets the value that specifies the identifier of the object - associated with the custom action. + summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. remarks: '' isPreview: false isDeprecated: false @@ -143,12 +136,10 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' package: '@microsoft/sp-odata-types!' fullName: RegistrationType - summary: >- - Gets or sets the value that specifies the type of object associated with - the custom action. + summary: Gets or sets the value that specifies the type of object associated with the custom action. remarks: >- - Represents an SP.UserCustomActionRegistrationType value: None = 0; List = - 1; ContentType = 2; ProgId = 3; FileType = 4. + Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType + = 4. isPreview: false isDeprecated: false syntax: @@ -159,18 +150,14 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' package: '@microsoft/sp-odata-types!' fullName: Rights - summary: >- - Gets or sets the value that specifies the permissions needed for the - custom action. + summary: Gets or sets the value that specifies the permissions needed for the custom action. remarks: '' isPreview: false isDeprecated: false syntax: content: 'Rights: IODataBasePermission;' return: - type: >- - + type: '' - name: Scope uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' package: '@microsoft/sp-odata-types!' @@ -187,9 +174,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' package: '@microsoft/sp-odata-types!' fullName: ScriptBlock - summary: >- - Gets or sets the value that specifies the ECMAScript to be executed when - the custom action is performed. + summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. remarks: '' isPreview: false isDeprecated: false @@ -201,9 +186,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' package: '@microsoft/sp-odata-types!' fullName: ScriptSrc - summary: >- - Gets or sets a value that specifies the URI of a file which contains the - ECMAScript to execute on the page. + summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. remarks: '' isPreview: false isDeprecated: false @@ -216,8 +199,8 @@ properties: package: '@microsoft/sp-odata-types!' fullName: Sequence summary: >- - Gets or sets the value that specifies an implementation-specific value - that determines the order of the custom action that appears on the page. + Gets or sets the value that specifies an implementation-specific value that determines the order of the custom + action that appears on the page. remarks: '' isPreview: false isDeprecated: false @@ -241,9 +224,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' package: '@microsoft/sp-odata-types!' fullName: Url - summary: >- - Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function - associated with the action. + summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' remarks: '' isPreview: false isDeprecated: false @@ -252,8 +233,7 @@ properties: return: type: string - name: VersionOfUserCustomAction - uid: >- - @microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' package: '@microsoft/sp-odata-types!' fullName: VersionOfUserCustomAction summary: Gets a value that specifies an implementation specific version identifier. diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 74e23628..b7088b83 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -4,8 +4,7 @@ uid: '@microsoft/sp-odata-types!IODataWeb:interface' package: '@microsoft/sp-odata-types!' fullName: IODataWeb summary: >- - Represents an OData SP.Web object. For more information about this object see - the MSDN documentation here: + Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' isPreview: false @@ -31,9 +30,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' package: '@microsoft/sp-odata-types!' fullName: CurrentChangeToken - summary: >- - Represents the unique sequential location of a change within the change - log. + summary: Represents the unique sequential location of a change within the change log. remarks: '' isPreview: false isDeprecated: false @@ -45,10 +42,8 @@ properties: uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' package: '@microsoft/sp-odata-types!' fullName: CustomMasterUrl - summary: >- - Gets or sets the URL for a custom master page file to apply to the - website. - + summary: |- + Gets or sets the URL for a custom master page file to apply to the website. Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' @@ -101,10 +96,8 @@ properties: uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' package: '@microsoft/sp-odata-types!' fullName: Language - summary: >- - Gets a value that specifies the LCID for the language that is used on the - site. - + summary: |- + Gets a value that specifies the LCID for the language that is used on the site. Example: `1033` remarks: '' @@ -160,9 +153,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' package: '@microsoft/sp-odata-types!' fullName: QuickLaunchEnabled - summary: >- - Gets or sets a value that specifies whether the Quick Launch area is - enabled on the site. + summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. remarks: '' isPreview: false isDeprecated: false @@ -174,9 +165,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' package: '@microsoft/sp-odata-types!' fullName: RecycleBinEnabled - summary: >- - Gets or sets a value that determines whether the recycle bin is enabled - for the website. + summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. remarks: '' isPreview: false isDeprecated: false @@ -257,10 +246,8 @@ properties: uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' package: '@microsoft/sp-odata-types!' fullName: WebTemplate - summary: >- - Gets the name of the site definition or site template that was used to - create the site. - + summary: |- + Gets the name of the site definition or site template that was used to create the site. Example: `"BLANKINTERNET"` remarks: '' diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index 7f69d8b3..e2122ba4 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -17,5 +17,3 @@ classes: interfaces: - '@microsoft/sp-page-context!ISPSystemTime:interface' - '@microsoft/sp-page-context!ISPTimeZoneData:interface' -enums: - - '@microsoft/sp-page-context!SPDayOfWeek:enum' diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 2d553c98..1a6fdf7d 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-page-context!CultureInfo:class' package: '@microsoft/sp-page-context!' fullName: CultureInfo summary: >- - This class is primarily used with the `PageContext` class. It provides culture - info for the current user of the application. + This class is primarily used with the `PageContext` class. It provides culture info for the current user of the + application. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `CultureInfo` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `CultureInfo` class. isPreview: false isDeprecated: false type: class @@ -19,15 +18,14 @@ properties: package: '@microsoft/sp-page-context!' fullName: currentCultureName summary: >- - This string determines the language default format for dates, times, - numbers, currency values, the sorting order of text, casing conventions, - and string comparisons. + This string determines the language default format for dates, times, numbers, currency values, the sorting order + of text, casing conventions, and string comparisons. remarks: >- This property may be an empty string, but it will never be undefined. - Example: If the currentCultureName is `"en-AU"` then the application could - use this information to display the date as 1/8 instead of 8/1. + Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the + date as 1/8 instead of 8/1. isPreview: false isDeprecated: false syntax: @@ -38,16 +36,13 @@ properties: uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' package: '@microsoft/sp-page-context!' fullName: currentUICultureName - summary: >- - This string determines the default user interface language. This used for - localization and translation of text. + summary: This string determines the default user interface language. This used for localization and translation of text. remarks: >- This property may have an empty string, but will never be undefined. - Example: If the currentUICultureName is `"es-MX"`, then the - application could use this information to translate the word "hello" to - "hola". + Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to + translate the word "hello" to "hola". isPreview: false isDeprecated: false syntax: @@ -58,9 +53,7 @@ properties: uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' package: '@microsoft/sp-page-context!' fullName: isRightToLeft - summary: >- - This boolean represents the dominant direction of written text for the - default user interface language. + summary: This boolean represents the dominant direction of written text for the default user interface language. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 1b498b96..04034975 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -5,11 +5,9 @@ package: '@microsoft/sp-page-context!' fullName: PageContext summary: The SharePoint page context object. remarks: >- - The page context provides standard definitions for common SharePoint objects - that need to be shared between the client-side application, web parts, and - other components. Typically the data is fetched via REST queries when - navigating to a new page, but it can also be preloaded by the web server, or - filled from a custom application cache. + The page context provides standard definitions for common SharePoint objects that need to be shared between the + client-side application, web parts, and other components. Typically the data is fetched via REST queries when + navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. isPreview: false isDeprecated: false type: class @@ -34,14 +32,13 @@ properties: package: '@microsoft/sp-page-context!' fullName: aadInfo summary: >- - Contextual information for communicating with Azure Active Directory. If - the current page doesn't have an associated Azure Active Directory tenant, - this property will be undefined. + Contextual information for communicating with Azure Active Directory. If the current page doesn't have an + associated Azure Active Directory tenant, this property will be undefined. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly aadInfo: AzureActiveDirectoryInfo | undefined;' + content: 'get aadInfo(): AzureActiveDirectoryInfo | undefined;' return: type: ' | undefined' - name: cultureInfo @@ -49,13 +46,13 @@ properties: package: '@microsoft/sp-page-context!' fullName: cultureInfo summary: >- - It provides culture info for the current user of the application. This - class is primarily used with the `PageContext` class. + It provides culture info for the current user of the application. This class is primarily used with the + `PageContext` class. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly cultureInfo: CultureInfo;' + content: 'get cultureInfo(): CultureInfo;' return: type: '' - name: isInitialized @@ -67,34 +64,29 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly isInitialized: boolean;' + content: 'get isInitialized(): boolean;' return: type: boolean - name: legacyPageContext uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' package: '@microsoft/sp-page-context!' fullName: legacyPageContext - summary: >- - An object providing classic SharePoint properties that may be required by - certain legacy scripts. + summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. remarks: >- - This property is provided to facilitate migration of legacy code. It - returns a JavaScript object whose contents are similar to the - `_spPageContextInfo` window variable from classic pages. The contents of - this variable may change in future releases of SharePoint. For this - reason, new projects are encouraged to use the SharePoint Framework - TypeScript APIs instead, since they are fully documented and provide - reliable backwards compatibility guarantees. + This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents + are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may + change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint + Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility + guarantees. - NOTE: If certain functionality is exposed in the `legacyPageContext` but - does not seem to have a proper TypeScript API, please file an issue on - GitHub. The intention is that no modern application should need to rely on - the `legacyPageContext` object. + NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript + API, please file an issue on GitHub. The intention is that no modern application should need to rely on the + `legacyPageContext` object. isPreview: false isDeprecated: false syntax: - content: 'readonly legacyPageContext: any;' + content: 'get legacyPageContext(): any;' return: type: any - name: list @@ -102,14 +94,13 @@ properties: package: '@microsoft/sp-page-context!' fullName: list summary: >- - Contextual information for the SharePoint list that is hosting the page. - If there is no list associated to the current page, this property will be - undefined. + Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the + current page, this property will be undefined. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly list: SPList | undefined;' + content: 'get list(): SPList | undefined;' return: type: ' | undefined' - name: listItem @@ -117,14 +108,13 @@ properties: package: '@microsoft/sp-page-context!' fullName: listItem summary: >- - Contextual information for the SharePoint list item that is hosting the - page. If there is no list item associated to the current page, this - property will be undefined. + Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated + to the current page, this property will be undefined. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly listItem: SPListItem | undefined;' + content: 'get listItem(): SPListItem | undefined;' return: type: ' | undefined' - name: serviceKey @@ -145,14 +135,12 @@ properties: uid: '@microsoft/sp-page-context!PageContext#site:member' package: '@microsoft/sp-page-context!' fullName: site - summary: >- - Contextual information for the SharePoint site collection ("SPSite") that - is hosting the page. + summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly site: SPSite;' + content: 'get site(): SPSite;' return: type: '' - name: user @@ -160,27 +148,24 @@ properties: package: '@microsoft/sp-page-context!' fullName: user summary: >- - It provides contextual information for the SharePoint user that is - accessing the page. This class is primarily used with the `PageContext` - class. + It provides contextual information for the SharePoint user that is accessing the page. This class is primarily + used with the `PageContext` class. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly user: SPUser;' + content: 'get user(): SPUser;' return: type: '' - name: web uid: '@microsoft/sp-page-context!PageContext#web:member' package: '@microsoft/sp-page-context!' fullName: web - summary: >- - Contextual information for the SharePoint site ("SPWeb") that is hosting - the page. + summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly web: SPWeb;' + content: 'get web(): SPWeb;' return: type: '' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index d5fc88e5..9fbaa07e 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -5,13 +5,12 @@ package: '@microsoft/sp-page-context!' fullName: SPField summary: A field represents the data model for a column in SharePoint list view. remarks: >- - This is the client-side equivalent for SharePoint `SPField` class. It is used - with the `@microsoft/sp-listview-extensibility` package. + This is the client-side equivalent for SharePoint `SPField` class. It is used with the + `@microsoft/sp-listview-extensibility` package. - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPField` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPField` class. isPreview: false isDeprecated: false type: class @@ -20,9 +19,7 @@ properties: uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' package: '@microsoft/sp-page-context!' fullName: clientSideComponentId - summary: >- - The unique identifier of the client-side component associated with the - field. + summary: The unique identifier of the client-side component associated with the field. remarks: '' isPreview: false isDeprecated: false @@ -34,13 +31,10 @@ properties: uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' package: '@microsoft/sp-page-context!' fullName: clientSideComponentProperties - summary: >- - This property is only used when a `ClientSideComponentId` is specified. It - is optional. + summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. remarks: >- - If non-empty, the string must contain a JSON object with custom - initialization properties whose format and meaning are defined by the - client-side component. + If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning + are defined by the client-side component. isPreview: false isDeprecated: false syntax: @@ -87,9 +81,7 @@ properties: uid: '@microsoft/sp-page-context!SPField#internalName:member' package: '@microsoft/sp-page-context!' fullName: internalName - summary: >- - The internal name of the field. This name is usually used to find the - field. + summary: The internal name of the field. This name is usually used to find the field. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 465a31ae..b6978acc 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-page-context!SPList:class' package: '@microsoft/sp-page-context!' fullName: SPList summary: >- - This class is primarily used with the `PageContext` class. It provides - contextual information for the SharePoint list that hosts the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list + that hosts the page. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPList` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPList` class. isPreview: false isDeprecated: false type: class @@ -19,8 +18,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: id summary: >- - The GUID that identifies the SPList on the server. This property could be - undefined if the information isn't available. + The GUID that identifies the SPList on the server. This property could be undefined if the information isn't + available. remarks: '' isPreview: false isDeprecated: false @@ -33,8 +32,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: permissions summary: >- - Return the SPPermission object that represents the set of permissions that - the current user has for interacting with the list. + Return the SPPermission object that represents the set of permissions that the current user has for interacting + with the list. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 58c494b0..91dfb2b9 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-page-context!SPListItem:class' package: '@microsoft/sp-page-context!' fullName: SPListItem summary: >- - This class is primarily used with the `PageContext` class. It provides - contextual information for the SharePoint list item that hosts the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list + item that hosts the page. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPListItem` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPListItem` class. isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index a1271d4f..14045f95 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -27,17 +27,15 @@ constructors: parameters: - id: value description: '' - type: >- - + type: '' properties: - name: addAndCustomizePages uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' package: '@microsoft/sp-page-context!' fullName: addAndCustomizePages summary: >- - Add, change, or delete HTML pages or web part Pages, and edit the Web site - using a SharePoint Foundation–compatible editor. + Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint + Foundation–compatible editor. remarks: '' isPreview: false isDeprecated: false @@ -61,9 +59,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' package: '@microsoft/sp-page-context!' fullName: addListItems - summary: >- - Add items to lists, add documents to document libraries, and add Web - discussion comments. + summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' remarks: '' isPreview: false isDeprecated: false @@ -111,9 +107,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' package: '@microsoft/sp-page-context!' fullName: browseDirectories - summary: >- - Enumerate files and folders in a Web site using Microsoft Office - SharePoint Designer 2007 and WebDAV interfaces. + summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. remarks: '' isPreview: false isDeprecated: false @@ -161,9 +155,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' package: '@microsoft/sp-page-context!' fullName: createGroups - summary: >- - Create a group of users that can be used anywhere within the site - collection. + summary: Create a group of users that can be used anywhere within the site collection. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +179,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' package: '@microsoft/sp-page-context!' fullName: deleteListItems - summary: >- - Delete items from a list, documents from a document library, and Web - discussion comments in documents. + summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' remarks: '' isPreview: false isDeprecated: false @@ -214,9 +204,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: editListItems summary: >- - Edit items in lists, edit documents in document libraries, edit Web - discussion comments in documents, and customize web part Pages in document - libraries. + Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and + customize web part Pages in document libraries. remarks: '' isPreview: false isDeprecated: false @@ -228,9 +217,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' package: '@microsoft/sp-page-context!' fullName: editMyUserInfo - summary: >- - Allows a user to change his or her user information, such as adding a - picture. + summary: 'Allows a user to change his or her user information, such as adding a picture.' remarks: '' isPreview: false isDeprecated: false @@ -242,9 +229,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' package: '@microsoft/sp-page-context!' fullName: emptyMask - summary: >- - Has no permissions on the Web site. Not available through the user - interface. + summary: Has no permissions on the Web site. Not available through the user interface. remarks: '' isPreview: false isDeprecated: false @@ -256,9 +241,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' package: '@microsoft/sp-page-context!' fullName: enumeratePermissions - summary: >- - Enumerate permissions on the Web site, list, folder, document, or list - item. + summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' remarks: '' isPreview: false isDeprecated: false @@ -270,9 +253,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' package: '@microsoft/sp-page-context!' fullName: fullMask - summary: >- - Has all permissions on the Web site. Not available through the user - interface. + summary: Has all permissions on the Web site. Not available through the user interface. remarks: '' isPreview: false isDeprecated: false @@ -308,9 +289,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' package: '@microsoft/sp-page-context!' fullName: manageLists - summary: >- - Create and delete lists, add or remove columns in a list, and add or - remove public views of a list. + summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' remarks: '' isPreview: false isDeprecated: false @@ -322,9 +301,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' package: '@microsoft/sp-page-context!' fullName: managePermissions - summary: >- - Create and change permission levels on the Web site and assign permissions - to users and groups. + summary: Create and change permission levels on the Web site and assign permissions to users and groups. remarks: '' isPreview: false isDeprecated: false @@ -348,9 +325,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' package: '@microsoft/sp-page-context!' fullName: manageSubwebs - summary: >- - Create subsites such as team sites, Meeting Workspace sites, and Document - Workspace sites. + summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' remarks: '' isPreview: false isDeprecated: false @@ -362,17 +337,13 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' package: '@microsoft/sp-page-context!' fullName: manageWeb - summary: >- - Grant the ability to perform all administration tasks for the Web site as - well as manage content. + summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. remarks: >- - Activate, deactivate, or edit properties of Web site scoped Features - through the object model or through the user interface (UI). When granted - on the root Web site of a site collection, activate, deactivate, or edit - properties of site collection scoped Features through the object model. To - browse to the Site Collection Features page and activate or deactivate - site collection scoped Features through the UI, you must be a site - collection administrator. + Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user + interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties + of site collection scoped Features through the object model. To browse to the Site Collection Features page and + activate or deactivate site collection scoped Features through the UI, you must be a site collection + administrator. isPreview: false isDeprecated: false syntax: @@ -383,9 +354,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.open:member' package: '@microsoft/sp-page-context!' fullName: open - summary: >- - Allow users to open a Web site, list, or folder to access items inside - that container. + summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' remarks: '' isPreview: false isDeprecated: false @@ -421,9 +390,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' package: '@microsoft/sp-page-context!' fullName: useClientIntegration - summary: >- - Use features that launch client applications; otherwise, users must work - on documents locally and upload changes. + summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' remarks: '' isPreview: false isDeprecated: false @@ -435,9 +402,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' package: '@microsoft/sp-page-context!' fullName: useRemoteAPIs - summary: >- - Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces - to access the Web site. + summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' remarks: '' isPreview: false isDeprecated: false @@ -454,11 +419,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly value: IODataBasePermission;' + content: 'get value(): IODataBasePermission;' return: - type: >- - + type: '' - name: viewFormPages uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' package: '@microsoft/sp-page-context!' @@ -475,9 +438,7 @@ properties: uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' package: '@microsoft/sp-page-context!' fullName: viewListItems - summary: >- - View items in lists, documents in document libraries, and view Web - discussion comments. + summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' remarks: '' isPreview: false isDeprecated: false @@ -526,9 +487,7 @@ methods: uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' package: '@microsoft/sp-page-context!' fullName: hasAllPermissions(requestedPerms) - summary: >- - Function for testing whether a given permission mask has all of the - requested permissions. + summary: Function for testing whether a given permission mask has all of the requested permissions. remarks: '' isPreview: false isDeprecated: false @@ -536,9 +495,7 @@ methods: content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' parameters: - id: requestedPerms - description: >- - Any number of SPPermission objects to be compared against the - original + description: Any number of SPPermission objects to be compared against the original type: '[]' return: type: boolean @@ -547,9 +504,7 @@ methods: uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' package: '@microsoft/sp-page-context!' fullName: hasAnyPermissions(requestedPerms) - summary: >- - Function for testing whether a given permission mask has any of the - requested permissions. + summary: Function for testing whether a given permission mask has any of the requested permissions. remarks: '' isPreview: false isDeprecated: false @@ -557,9 +512,7 @@ methods: content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' parameters: - id: requestedPerms - description: >- - Any number of SPPermission objects to be compared against the - original + description: Any number of SPPermission objects to be compared against the original type: '[]' return: type: boolean @@ -568,9 +521,7 @@ methods: uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' package: '@microsoft/sp-page-context!' fullName: hasPermission(requestedPerm) - summary: >- - Function for testing whether a given permission mask has the requested - permission. + summary: Function for testing whether a given permission mask has the requested permission. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index bf446de2..6ed6c8e0 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -4,13 +4,11 @@ uid: '@microsoft/sp-page-context!SPSite:class' package: '@microsoft/sp-page-context!' fullName: SPSite summary: >- - This class is primarily used with the `PageContext` class. It provides - contextual information for the SharePoint site collection ("SPSite") that - hosts the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site + collection ("SPSite") that hosts the page. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPSite` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPSite` class. isPreview: false isDeprecated: false type: class @@ -31,9 +29,7 @@ properties: uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' package: '@microsoft/sp-page-context!' fullName: cdnPrefix - summary: >- - Returns the prefix of the application's specified cdn or an empty string - if there isn't one. + summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. remarks: '' isPreview: false isDeprecated: false @@ -70,9 +66,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: group summary: >- - Contextual information about the O365 Group associated with this site. If - there is no O365Group associated with the current site, this property will - be undefined. + Contextual information about the O365 Group associated with this site. If there is no O365Group associated with + the current site, this property will be undefined. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 29d6ae5e..9f1c320b 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -4,25 +4,21 @@ uid: '@microsoft/sp-page-context!SPTimeZone:class' package: '@microsoft/sp-page-context!' fullName: SPTimeZone summary: >- - It provides timezone information from SharePoint. A conversion from UTC to - local time can be calculated by using the following formula. + It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the + following formula. remarks: >- ``` - isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the - StandardDate + isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate - LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : - standardOffset) + LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) - ``` - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPTimeZone` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPTimeZone` class. isPreview: true isDeprecated: false type: class @@ -44,8 +40,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: daylightOffset summary: >- - Gets the offset in the number of minutes that daylight time for the time - zone differs from Coordinated Universal Time (UTC). + Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal + Time (UTC). remarks: '' isPreview: true isDeprecated: false @@ -81,9 +77,7 @@ properties: uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' package: '@microsoft/sp-page-context!' fullName: offset - summary: >- - Gets the offset in the number of minutes that the time zone differs from - Coordinated Universal Time (UTC). + summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). remarks: '' isPreview: true isDeprecated: false @@ -108,8 +102,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: standardOffset summary: >- - Gets the offset in the number of minutes that standard time for the time - zone differs from coordinated universal time (UTC). + Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal + time (UTC). remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index ee772fc9..f2479aa2 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-page-context!SPUser:class' package: '@microsoft/sp-page-context!' fullName: SPUser summary: >- - This class is primarily used with the `PageContext` class. It provides - contextual information for the SharePoint user that is accessing the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user + that is accessing the page. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `SPUser` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPUser` class. isPreview: false isDeprecated: false type: class @@ -42,16 +41,14 @@ properties: uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' package: '@microsoft/sp-page-context!' fullName: firstDayOfWeek - summary: >- - Returns the user's regional first day of week setting or undefined if it - hasn't been set. + summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. remarks: '' isPreview: true isDeprecated: false syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: ' | undefined' + type: ' | undefined' - name: isAnonymousGuestUser uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' package: '@microsoft/sp-page-context!' @@ -81,9 +78,7 @@ properties: package: '@microsoft/sp-page-context!' fullName: loginName summary: The login name for current user. - remarks: >- - Example: on-premise user: `"domain\user"`, online user: - `"user@domain.com"` + remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' isPreview: false isDeprecated: false syntax: @@ -94,9 +89,7 @@ properties: uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' package: '@microsoft/sp-page-context!' fullName: preferUserTimeZone - summary: >- - This boolean represents if a the user or web's time zone settings should - be used to display the current time. + summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. remarks: '' isPreview: false isDeprecated: false @@ -108,9 +101,7 @@ properties: uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' package: '@microsoft/sp-page-context!' fullName: timeZoneInfo - summary: >- - Returns the user's regional timezone settings or undefined if they haven't - been set. + summary: Returns the user's regional timezone settings or undefined if they haven't been set. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index a9160e38..b554b723 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-page-context!SPWeb:class' package: '@microsoft/sp-page-context!' fullName: SPWeb summary: >- - This class is primarily used with the `PageContext` class. It provides - contextual information for the SharePoint site ("SPWeb") that hosts the page. + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site + ("SPWeb") that hosts the page. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the `SPWeb` - class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPWeb` class. isPreview: false isDeprecated: false type: class @@ -18,9 +17,7 @@ properties: uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' package: '@microsoft/sp-page-context!' fullName: absoluteUrl - summary: >- - Returns the absolute URL for this SPWeb. Example: - `"https://example.com/sites/PubSite/SubWeb"` + summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' remarks: '' isPreview: false isDeprecated: false @@ -44,16 +41,14 @@ properties: uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' package: '@microsoft/sp-page-context!' fullName: firstDayOfWeek - summary: >- - Returns the web's regional first day of week setting or undefined if it - hasn't been set. + summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. remarks: '' isPreview: true isDeprecated: false syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: ' | undefined' + type: ' | undefined' - name: id uid: '@microsoft/sp-page-context!SPWeb#id:member' package: '@microsoft/sp-page-context!' @@ -82,9 +77,7 @@ properties: uid: '@microsoft/sp-page-context!SPWeb#language:member' package: '@microsoft/sp-page-context!' fullName: language - summary: >- - Returns the locale identifier (LCID) for the default language of the - website. + summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' isPreview: false isDeprecated: false @@ -121,8 +114,8 @@ properties: package: '@microsoft/sp-page-context!' fullName: permissions summary: >- - Return the SPPermission object that represents the set of permissions that - the current user has for interacting with the web. + Return the SPPermission object that represents the set of permissions that the current user has for interacting + with the web. remarks: '' isPreview: false isDeprecated: false @@ -147,11 +140,9 @@ properties: package: '@microsoft/sp-page-context!' fullName: templateName summary: >- - Returns the string representing the numeric identifier for the site - definition or site template that was used to create the site. - remarks: >- - Example: `"1"` represents the team site template when creating a new site - on SharePoint. + Returns the string representing the numeric identifier for the site definition or site template that was used to + create the site. + remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' isPreview: false isDeprecated: false syntax: @@ -162,9 +153,7 @@ properties: uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' package: '@microsoft/sp-page-context!' fullName: timeZoneInfo - summary: >- - Returns the web's regional timezone settings or undefined if they haven't - been set. + summary: Returns the web's regional timezone settings or undefined if they haven't been set. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 4246da6b..f57b0678 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -10,8 +10,7 @@ enums: - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' interfaces: - - >- - @microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' @@ -19,8 +18,7 @@ interfaces: - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - - >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' @@ -44,15 +42,14 @@ interfaces: functions: - name: 'PropertyPaneButton(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Button on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneButton(targetProperty: string, - properties: IPropertyPaneButtonProps): + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField; parameters: - id: targetProperty @@ -60,28 +57,22 @@ functions: type: string - id: properties description: Strongly typed Button properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneCheckbox(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneCheckbox(targetProperty: string, - properties: IPropertyPaneCheckboxProps): + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField; parameters: - id: targetProperty @@ -89,88 +80,69 @@ functions: type: string - id: properties description: Strongly typed Checkbox properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneChoiceGroup(targetProperty: string, - properties: IPropertyPaneChoiceGroupProps): - IPropertyPaneField; + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; parameters: - id: targetProperty description: Target property the choice group is associated to. type: string - id: properties description: Strongly typed Choice Group properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: PropertyPaneCustomField(properties) uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a custom field on the PropertyPane. remarks: >- - The purpose of the custom field is to help the web part developer to add a - custom control to the PropertyPane. The PropertyPane supports a host of - inbuilt field types. While this list meets the demands of most web parts, - but there are exceptional cases when web parts have special needs and need - a special control. The custom field helps fill that gap. + The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The + PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but + there are exceptional cases when web parts have special needs and need a special control. The custom field helps + fill that gap. isPreview: true isDeprecated: false syntax: content: >- - export declare function PropertyPaneCustomField(properties: - IPropertyPaneCustomFieldProps): + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField; parameters: - id: properties description: Strongly typed Custom field properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneDropdown(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneDropdown(targetProperty: string, - properties: IPropertyPaneDropdownProps): + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField; parameters: - id: targetProperty @@ -178,88 +150,66 @@ functions: type: string - id: properties description: Strongly typed Dropdown properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneDynamicField(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' - package: '@microsoft/sp-property-pane' - summary: >- - Helper method to create a Dynamic Data widget on the PropertyPane for a - dynamic field. + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneDynamicField(targetProperty: string, - properties: IPropertyPaneDynamicFieldProps): - IPropertyPaneField; + export declare function PropertyPaneDynamicField(targetProperty: string, properties: + IPropertyPaneDynamicFieldProps): IPropertyPaneField; parameters: - id: targetProperty description: Target property the Dynamic Data widget is associated to. type: string - id: properties description: '' - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: PropertyPaneDynamicFieldSet(properties) uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: >- - Helper method to create a Dynamic Data widget on the Property Pane for a - set of dynamic fields with a common data source. + Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data + source. - These fields can possibly share the same property based on the associated - filters. + These fields can possibly share the same property based on the associated filters. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneDynamicFieldSet(properties: - IPropertyPaneDynamicFieldSetProps): + export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField; parameters: - id: properties description: >- - Contains entries and options, described as below: entries - A set of - entries to be configured by the widget. Each entry includes the - target property and, optionally, the label to show. options - - Options enabling customized values for callback, filters etc., for - the given set of dynamic fields. - type: >- - + Contains entries and options, described as below: entries - A set of entries to be configured by the widget. + Each entry includes the target property and, optionally, the label to show. options - Options enabling + customized values for callback, filters etc., for the given set of dynamic fields. + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' isPreview: true @@ -267,53 +217,42 @@ functions: customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' syntax: content: >- - export declare function PropertyPaneDynamicTextField(targetProperty: - string, properties: IPropertyPaneDynamicTextFieldProps): - IPropertyPaneField; + export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: + IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; parameters: - id: targetProperty description: Target property the dynamic textfield is associated to. type: string - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: PropertyPaneHorizontalRule() uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - export declare function PropertyPaneHorizontalRule(): - IPropertyPaneField; + content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' return: - type: >- - <void> + type: '<void>' description: '' - name: 'PropertyPaneLabel(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Label on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneLabel(targetProperty: string, - properties: IPropertyPaneLabelProps): + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField; parameters: - id: targetProperty @@ -321,28 +260,22 @@ functions: type: string - id: properties description: Strongly typed Label properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneLink(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Link on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneLink(targetProperty: string, - properties: IPropertyPaneLinkProps): + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField; parameters: - id: targetProperty @@ -350,28 +283,22 @@ functions: type: string - id: properties description: Strongly typed Link properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneSlider(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneSlider(targetProperty: string, - properties: IPropertyPaneSliderProps): + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField; parameters: - id: targetProperty @@ -379,28 +306,22 @@ functions: type: string - id: properties description: Strongly typed Slider properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneTextField(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneTextField(targetProperty: string, - properties: IPropertyPaneTextFieldProps): + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField; parameters: - id: targetProperty @@ -408,28 +329,22 @@ functions: type: string - id: properties description: Strongly typed TextField properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneToggle(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' - package: '@microsoft/sp-property-pane' + package: '@microsoft/sp-property-pane!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - export declare function PropertyPaneToggle(targetProperty: string, - properties: IPropertyPaneToggleProps): + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField; parameters: - id: targetProperty @@ -437,14 +352,9 @@ functions: type: string - id: properties description: Strongly typed Toggle properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index fda2be86..3c4c427c 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -12,14 +12,14 @@ fields: uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' package: '@microsoft/sp-property-pane!' summary: Indicates that nothing is shared. - numericValue: 0 + value: '0' - name: Property uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' package: '@microsoft/sp-property-pane!' summary: Indicates that both the dynamic data source and the property are shared. - numericValue: 2 + value: '2' - name: Source uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' package: '@microsoft/sp-property-pane!' summary: Indicates that the dynamic data source is shared. - numericValue: 1 + value: '1' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 73b1d2d2..4ed16cea 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -10,8 +10,7 @@ isDeprecated: false type: interface properties: - name: filters - uid: >- - @microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' package: '@microsoft/sp-property-pane!' fullName: filters summary: Filters for the shared property. @@ -21,7 +20,4 @@ properties: syntax: content: 'filters?: IDynamicDataSharedPropertyFilters;' return: - type: >- - + type: '' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index 2a1e9e98..26ba8c3e 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -10,26 +10,21 @@ isDeprecated: false type: interface properties: - name: propertyId - uid: >- - @microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' package: '@microsoft/sp-property-pane!' fullName: propertyId - summary: >- + summary: |- Property Id - - Usage: Use this filter when the author can only to connect to a specific - property from the selected source. + Usage: Use this filter when the author can only to connect to a specific property from the selected source. remarks: >- - This is to filter which specific property is to be pre-selected in the - properties dropdown(second level) on the dynamic data widget. + This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the + dynamic data widget. - When provided, the dynamic data properties dropdown is pre-selected to - show the specific property, if avaialble. Otherwise the dropdown will fall - back to show all the exposed properties from the source. If a property is - pre-selected, the control will be disabled to ensure that authors can not - change it. + When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. + Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is + pre-selected, the control will be disabled to ensure that authors can not change it. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index ab0d3e19..0f46301c 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -10,8 +10,7 @@ isDeprecated: false type: interface properties: - name: filters - uid: >- - @microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' package: '@microsoft/sp-property-pane!' fullName: filters summary: Filters for the shared source. @@ -21,13 +20,9 @@ properties: syntax: content: 'filters?: IDynamicDataSharedSourceFilters;' return: - type: >- - + type: '' - name: sourcesLabel - uid: >- - @microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' package: '@microsoft/sp-property-pane!' fullName: sourcesLabel summary: |- diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index 0981e281..5c692144 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -10,29 +10,24 @@ isDeprecated: false type: interface properties: - name: componentId - uid: >- - @microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' package: '@microsoft/sp-property-pane!' fullName: componentId - summary: >- + summary: |- Component Id. - - Usage: Use this filter when the author should only be able to connect to a - specific type of source. + Usage: Use this filter when the author should only be able to connect to a specific type of source. remarks: >- - This is to filter what type of source needs to be shown in the data - sources dropdown (first level) on the dynamic data widget. + This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic + data widget. - When provided, the dynamic data sources dropdown in the dynamic data - widget is filtered to only show the sources matching the given component - id. + When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources + matching the given component id. - Example - If the document library web part component id is supplied, then - the dynamic data sources dropdown only shows document library web parts on - the page which are registered dynamic sources. + Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only + shows document library web parts on the page which are registered dynamic sources. isPreview: false isDeprecated: false syntax: @@ -40,30 +35,24 @@ properties: return: type: '' - name: sourceId - uid: >- - @microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' package: '@microsoft/sp-property-pane!' fullName: sourceId - summary: >- + summary: |- Source Id - - Usage: Use this filter, when the author can only to connect to a specific - data source. + Usage: Use this filter, when the author can only to connect to a specific data source. remarks: >- - This is to filter which specific source is to be pre-selected in the data - sources dropdown (first level) on the dynamic data widget. + This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the + dynamic data widget. - When provided, the dynamic data sources dropdown is pre-selected to show - the source with the provided id, if available. Otherwise the dropdown will - fall back to show all the existing data sources on the page. If a source - is pre-selected, the control will be disabled to ensure that authors can - not change it. + When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if + available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is + pre-selected, the control will be disabled to ensure that authors can not change it. - The source id for a web part will be of the form - WebPart.. + The source id for a web part will be of the form WebPart.. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index 9a75174d..af3ca9ba 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -22,8 +22,7 @@ properties: return: type: number - name: positionWindowPosition - uid: >- - @microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member + uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' package: '@microsoft/sp-property-pane!' fullName: positionWindowPosition summary: The position of pop up window. diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index 3a72c38a..d1d3f07d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -10,16 +10,13 @@ isDeprecated: false type: interface properties: - name: ariaDescription - uid: >- - @microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' package: '@microsoft/sp-property-pane!' fullName: ariaDescription - summary: >- + summary: |- Detailed description of the button for the benefit of screen readers. - - Besides the compound button, other button types will need more information - provided to screen reader. + Besides the compound button, other button types will need more information provided to screen reader. remarks: '' isPreview: false isDeprecated: false @@ -55,9 +52,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' package: '@microsoft/sp-property-pane!' fullName: description - summary: >- - Description of the action this button takes. Only used for compound - buttons. + summary: Description of the action this button takes. Only used for compound buttons. remarks: '' isPreview: false isDeprecated: false @@ -94,9 +89,8 @@ properties: package: '@microsoft/sp-property-pane!' fullName: onClick summary: >- - A callback which is invoked on the button click, which takes in the - existing value for the bound property and returns the new value and which - is then used to update the properties bag. This update will result in the + A callback which is invoked on the button click, which takes in the existing value for the bound property and + returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. remarks: '' isPreview: false diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index bc5cdfca..e08595d2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -10,13 +10,10 @@ isDeprecated: false type: interface properties: - name: ariaLabel - uid: >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' package: '@microsoft/sp-property-pane!' fullName: ariaLabel - summary: >- - The aria label of the property pane choice group option for the benefit of - screen readers. + summary: The aria label of the property pane choice group option for the benefit of screen readers. remarks: '' isPreview: false isDeprecated: false @@ -52,8 +49,7 @@ properties: return: type: boolean - name: iconProps - uid: >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' package: '@microsoft/sp-property-pane!' fullName: iconProps summary: The Icon component props for choice field. @@ -63,13 +59,9 @@ properties: syntax: content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' return: - type: >- - + type: '' - name: imageSize - uid: >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' package: '@microsoft/sp-property-pane!' fullName: imageSize summary: The width and height of the image in px for choice field. @@ -113,8 +105,7 @@ properties: return: type: string | number - name: selectedImageSrc - uid: >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' package: '@microsoft/sp-property-pane!' fullName: selectedImageSrc summary: The src of image for choice field which is selected. diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index 1fd4c91a..df9a6753 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -10,8 +10,7 @@ isDeprecated: false type: interface properties: - name: officeFabricIconFontName - uid: >- - @microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' package: '@microsoft/sp-property-pane!' fullName: officeFabricIconFontName summary: The name of the icon to use from the Office Fabric icon set. diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index baf76147..30f5520d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -32,7 +32,4 @@ properties: syntax: content: 'options: IPropertyPaneChoiceGroupOption[];' return: - type: >- - [] + type: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index 5938652d..78557fbb 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -10,8 +10,7 @@ isDeprecated: false type: interface properties: - name: onShowPrimaryGroup - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' package: '@microsoft/sp-property-pane!' fullName: onShowPrimaryGroup summary: Callback when user clicks to show primary group. @@ -23,8 +22,7 @@ properties: return: type: () => void - name: onShowSecondaryGroup - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' package: '@microsoft/sp-property-pane!' fullName: onShowSecondaryGroup summary: Callback when user clicks to show secondary group. @@ -36,8 +34,7 @@ properties: return: type: () => void - name: primaryGroup - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' package: '@microsoft/sp-property-pane!' fullName: primaryGroup summary: Primary group to show @@ -47,12 +44,9 @@ properties: syntax: content: 'primaryGroup: IPropertyPaneGroup;' return: - type: >- - + type: '' - name: secondaryGroup - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' package: '@microsoft/sp-property-pane!' fullName: secondaryGroup summary: Secondary group to show @@ -62,17 +56,12 @@ properties: syntax: content: 'secondaryGroup: IPropertyPaneGroup;' return: - type: >- - + type: '' - name: showSecondaryGroup - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' package: '@microsoft/sp-property-pane!' fullName: showSecondaryGroup - summary: >- - Indicating whether the property pane should show primary group or the - secondary group. + summary: Indicating whether the property pane should show primary group or the secondary group. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 4e9ecde6..93a7ceb3 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -22,34 +22,38 @@ properties: return: type: number - name: debounceProperties - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' package: '@microsoft/sp-property-pane!' fullName: debounceProperties summary: List of properties to debounce the `onPropertyPaneFieldChanged` event. remarks: >- - If your property pane is reactive, the `onPropertyPaneFieldChanged` event - will fire with any change to the web part properties. This may lead to - jank for some property pane controls or web parts. You can use this - configuration property to debounce the `onPropertyPaneFieldChanged` event - for the properties listed; other properties will be unaffected. + If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web + part properties. This may lead to jank for some property pane controls or web parts. You can use this + configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other + properties will be unaffected. isPreview: true isDeprecated: false syntax: content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' return: - type: >- - [] + type: '[]' + - name: disableFocusTrap + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableFocusTrap:member' + package: '@microsoft/sp-property-pane!' + fullName: disableFocusTrap + summary: Whether to disable trapping focus inside property pane. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'disableFocusTrap?: boolean;' + return: + type: boolean - name: loadingIndicatorDelayTime - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' package: '@microsoft/sp-property-pane!' fullName: loadingIndicatorDelayTime - summary: >- - Number of milliseconds to be delayed before the loading indicator is shown - on the property pane. + summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. isPreview: false isDeprecated: false @@ -68,28 +72,20 @@ properties: syntax: content: 'pages: IPropertyPanePage[];' return: - type: >- - [] + type: '[]' - name: showLoadingIndicator - uid: >- - @microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' package: '@microsoft/sp-property-pane!' fullName: showLoadingIndicator - summary: >- - Indicates whether the loading indicator should be displayed on top of the - property pane or not. + summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. remarks: >- - This feature is intended to be used when the user is waiting on a promise - to resolve. If set to true, overlay loading indicator appears after 500ms - (web part author can override this behavior by using - overlayLoadingIndicator property). + This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay + loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator + property). - The reason why we are not showing it immediately is that our intent is to - never show the loading indicator. But in real life async requests could - take long and it becomes necessary to display a loading indicator to the - end user. + The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in + real life async requests could take long and it becomes necessary to display a loading indicator to the end user. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index f227d391..ebac223f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -14,9 +14,8 @@ properties: package: '@microsoft/sp-property-pane!' fullName: context summary: >- - Instance specific context. This context is passed back to the web part in - the onRender and onDispose APIs. The web part can use this context to - manage state information. + Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web + part can use this context to manage state information. remarks: '' isPreview: false isDeprecated: false @@ -32,15 +31,13 @@ properties: An UNIQUE key indicates the identity of this contorl. - The PropertyPane uses ReactJS to render its components. ReactJS uses keys - to identify a component and if it should be re-rendered or not. This is a - performance feature in ReactJS. Please read the following link to - understand how to pick the value of the key. + The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should + be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how + to pick the value of the key. For more information, see the [React - documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). + documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). remarks: '' isPreview: false isDeprecated: false @@ -59,25 +56,20 @@ properties: syntax: content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' return: - type: >- - (domElement: , context?: any) - => void + type: '(domElement: HTMLElement, context?: any) => void' - name: onRender uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' package: '@microsoft/sp-property-pane!' fullName: onRender - summary: >- - This API will be called once the custom field is mounted on the host - element. + summary: This API will be called once the custom field is mounted on the host element. remarks: '' isPreview: false isDeprecated: false syntax: content: >- - onRender: (domElement: HTMLElement, context?: any, changeCallback?: - (targetProperty?: string, newValue?: any) => void) => void; + onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => + void) => void; return: type: >- - (domElement: , context?: any, - changeCallback?: (targetProperty?: string, newValue?: any) => void) - => void + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => + void) => void diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index 0621253f..14930d14 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -3,22 +3,19 @@ name: IPropertyPaneDebounceProperty uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDebounceProperty -summary: >- - Definition of a Property Pane property, which should have the - `onPropertyPaneFieldChanged` event be debounced. +summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' remarks: '' isPreview: true isDeprecated: false type: interface properties: - name: debouncePeriod - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' package: '@microsoft/sp-property-pane!' fullName: debouncePeriod summary: >- - Number of milliseconds to delay the next `onPropertyPaneFieldChanged` - event since the last time the event fired for this property. + Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired + for this property. remarks: The default value is 500. isPreview: true isDeprecated: false @@ -27,8 +24,7 @@ properties: return: type: number - name: propertyName - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' package: '@microsoft/sp-property-pane!' fullName: propertyName summary: Property to debounce. diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index 37222b9a..8e4b08ba 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -10,13 +10,10 @@ isDeprecated: false type: interface properties: - name: calloutMaxHeight - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' package: '@microsoft/sp-property-pane!' fullName: calloutMaxHeight - summary: >- - Set max height of callout When not set the callout will expand with - contents up to the bottom of the screen + summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index 33e20434..816d870a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -49,16 +49,11 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' package: '@microsoft/sp-property-pane!' fullName: type - summary: >- - The type of option. If omitted, the default is - PropertyPaneDropdownMenuItemType.Normal + summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' remarks: '' isPreview: false isDeprecated: false syntax: content: 'type?: PropertyPaneDropdownOptionType;' return: - type: >- - + type: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index 7d76d497..adbd012b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -22,13 +22,12 @@ properties: return: type: string - name: ariaPositionInSet - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' package: '@microsoft/sp-property-pane!' fullName: ariaPositionInSet summary: >- - Defines an element's number or position in the current set of controls. - Maps to native aria-posinset attribute. It starts from 1. + Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It + starts from 1. remarks: '' isPreview: false isDeprecated: false @@ -40,9 +39,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' package: '@microsoft/sp-property-pane!' fullName: ariaSetSize - summary: >- - Defines the number of items in the current set of controls. Maps to native - aria-setsize attribute. + summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. remarks: '' isPreview: false isDeprecated: false @@ -61,10 +58,7 @@ properties: syntax: content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' return: - type: >- - + type: '' - name: disabled uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' package: '@microsoft/sp-property-pane!' @@ -112,10 +106,7 @@ properties: syntax: content: 'options?: IPropertyPaneDropdownOption[];' return: - type: >- - [] + type: '[]' - name: selectedKey uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index 690f926d..d9571129 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -20,10 +20,7 @@ properties: syntax: content: 'filters?: IPropertyPaneDynamicFieldFilters;' return: - type: >- - + type: '' - name: label uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' package: '@microsoft/sp-property-pane!' @@ -37,24 +34,19 @@ properties: return: type: string - name: propertyValueDepth - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' package: '@microsoft/sp-property-pane!' fullName: propertyValueDepth - summary: >- - Indicates to what depth of property values are shown on the property pane - dynamic data widget. - + summary: |- + Indicates to what depth of property values are shown on the property pane dynamic data widget. If not specified, then max of 2 levels of property value will be shown. remarks: >- - It takes following values - - 0: Indicates that no property value will be - shown i.e., the widget will display only source and property for this - field. - 1: Indicates that a depth of one level of property value will be - shown i.e., the widget will display one level after the source and - property for this field. - 2: Indicates that a depth of two levels of - property value will be shown i.e., the widget will display two levels - after the source and property for this field. + It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only + source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., + the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two + levels of property value will be shown i.e., the widget will display two levels after the source and property for + this field. isPreview: false isDeprecated: false syntax: @@ -62,8 +54,7 @@ properties: return: type: number - name: sourcesLabel - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' package: '@microsoft/sp-property-pane!' fullName: sourcesLabel summary: |- diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index ed7861c2..fb2f2e29 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -10,13 +10,10 @@ isDeprecated: false type: interface properties: - name: fields - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' package: '@microsoft/sp-property-pane!' fullName: fields - summary: >- - List of property pane dynamic fields to be configured on the Dynamic Data - Widget. + summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. remarks: '' isPreview: false isDeprecated: false @@ -24,10 +21,8 @@ properties: content: 'fields: IPropertyPaneField[];' return: type: >- - <>[] + <>[] - name: label uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' package: '@microsoft/sp-property-pane!' @@ -41,8 +36,7 @@ properties: return: type: string - name: sharedConfiguration - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' package: '@microsoft/sp-property-pane!' fullName: sharedConfiguration summary: Configuration shared between all the entries of the set. diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index f98c6367..7235fe31 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -11,8 +11,7 @@ customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldP type: interface properties: - name: ariaLabel - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' package: '@microsoft/sp-property-pane!' fullName: ariaLabel summary: 'ARIA Label for text field, if any.' @@ -24,8 +23,7 @@ properties: return: type: string - name: description - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' package: '@microsoft/sp-property-pane!' fullName: description summary: The text field input description. @@ -37,8 +35,7 @@ properties: return: type: string - name: disabled - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' package: '@microsoft/sp-property-pane!' fullName: disabled summary: Whether the property pane text field is enabled or not. @@ -50,18 +47,16 @@ properties: return: type: boolean - name: errorMessage - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' package: '@microsoft/sp-property-pane!' fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: >- - When `onGetErrorMessage` returns empty string, if this property has a - value set then this will be displayed as the error message. + When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the + error message. - Make sure to set this only if you want to see an error message displayed - for the text field. + Make sure to set this only if you want to see an error message displayed for the text field. isPreview: true isDeprecated: false syntax: @@ -69,8 +64,7 @@ properties: return: type: string - name: label - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' package: '@microsoft/sp-property-pane!' fullName: label summary: Label for the text field. @@ -82,42 +76,30 @@ properties: return: type: string - name: onGetErrorMessage - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' package: '@microsoft/sp-property-pane!' fullName: onGetErrorMessage - summary: >- - This method is used to get the validation error message and determine - whether the input value is valid or not. - remarks: >- + summary: This method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- When it returns string: - - If valid, it returns empty string. - - - If invalid, it returns the error message string and an error message is - displayed below the text field. - + - If invalid, it returns the error message string and an error message is displayed below the text field. When it returns `Promise`: - - The resolved value is display as error message. - - The rejected, the value is thrown away. isPreview: true isDeprecated: false syntax: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: - type: >- - (value: string) => string | <string> + type: '(value: string) => string | Promise<string>' - name: placeholder - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' package: '@microsoft/sp-property-pane!' fullName: placeholder summary: Placeholder text to be displayed in the text field. @@ -129,8 +111,7 @@ properties: return: type: string - name: validateOnFocusIn - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' package: '@microsoft/sp-property-pane!' fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. @@ -142,13 +123,10 @@ properties: return: type: boolean - name: validateOnFocusOut - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' package: '@microsoft/sp-property-pane!' fullName: validateOnFocusOut - summary: >- - Run validation when the `PropertyPaneTextField` is out of focus or on - blur. + summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. isPreview: true isDeprecated: false @@ -157,14 +135,12 @@ properties: return: type: boolean - name: value - uid: >- - @microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' package: '@microsoft/sp-property-pane!' fullName: value summary: >- - Value to be displayed in the text field when the value of the - targetProperty in the manifest's property bag is empty or contains null - value. + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index f3619ea3..e09fada7 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -20,17 +20,15 @@ properties: syntax: content: 'groupFields: IPropertyPaneField[];' return: - type: >- - <any>[] + type: '<any>[]' - name: groupName uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' package: '@microsoft/sp-property-pane!' fullName: groupName summary: Display name for the group. remarks: >- - For performance reasons, it's highly recommended to keep this name unique - within the property pane page. + For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left + empty, the group header will not render (not recommended for accordions). isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index f2975965..ca098df3 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -14,9 +14,7 @@ properties: package: '@microsoft/sp-property-pane!' fullName: required summary: Whether the associated form field is required or not. - remarks: >- - If true, a red asterisk is displayed to the right of the label. Default - value is false. + remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 230206c2..d680532a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -60,8 +60,8 @@ properties: \_blank - Load the response into a new unnamed tab. - \_parent - Load the response in the parent of the current page. If no - parent exists, then this option behaves same as "\_self" + \_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same + as "\_self" \_top - Load the response into the original window. diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 156b2ad0..c3b5aff2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -10,13 +10,10 @@ isDeprecated: false type: interface properties: - name: displayGroupsAsAccordion - uid: >- - @microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member + uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' package: '@microsoft/sp-property-pane!' fullName: displayGroupsAsAccordion - summary: >- - Indicates whether the groups on the PropertyPanePage are displayed as - accordion or not. + summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. remarks: '' isPreview: false isDeprecated: false @@ -36,10 +33,8 @@ properties: content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' return: type: >- - ( | )[] + ( | )[] - name: header uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' package: '@microsoft/sp-property-pane!' @@ -51,6 +46,4 @@ properties: syntax: content: 'header?: IPropertyPanePageHeader;' return: - type: >- - + type: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index cdde7863..cc667341 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -28,7 +28,8 @@ properties: summary: Image url for the background image. remarks: '' isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: This property is not used. syntax: content: 'image?: string;' return: diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index c0d0ccce..deb06adb 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -74,9 +74,7 @@ properties: package: '@microsoft/sp-property-pane!' fullName: showValue summary: Whether to show the value on the right of the Slider. - remarks: >- - If you want to show the value by yourself, you may want to set this value - to false. + remarks: 'If you want to show the value by yourself, you may want to set this value to false.' isPreview: false isDeprecated: false syntax: @@ -87,9 +85,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' package: '@microsoft/sp-property-pane!' fullName: step - summary: >- - The difference between the two adjacent values of the Slider. Defaults to - 1. + summary: The difference between the two adjacent values of the Slider. Defaults to 1. remarks: '' isPreview: false isDeprecated: false @@ -101,10 +97,8 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' package: '@microsoft/sp-property-pane!' fullName: value - summary: >- - The initial value of the Slider. Use this if you intend to pass in a new - value as a result of onChange events. - + summary: |- + The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. Defaults to min. remarks: '' @@ -123,7 +117,6 @@ properties: ```typescript (value) => `${value}%` - ``` is specified, the value of the Slider has % after it. remarks: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index e064cb2b..c180984d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -22,13 +22,10 @@ properties: return: type: string - name: deferredValidationTime - uid: >- - @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' package: '@microsoft/sp-property-pane!' fullName: deferredValidationTime - summary: >- - Text field will start to validate after users stop typing for - `deferredValidationTime` milliseconds. + summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. isPreview: false isDeprecated: false @@ -61,18 +58,16 @@ properties: return: type: boolean - name: errorMessage - uid: >- - @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' package: '@microsoft/sp-property-pane!' fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: >- - When onGetErrorMessage returns empty string, if this property has a value - set then this will be displayed as the error message. + When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the + error message. - So, make sure to set this only if you want to see an error message - displayed for the text field. + So, make sure to set this only if you want to see an error message displayed for the text field. isPreview: false isDeprecated: false syntax: @@ -95,31 +90,25 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' package: '@microsoft/sp-property-pane!' fullName: logName - summary: >- - Name used to log `PropertyPaneTextField` value changes for engagement - tracking. + summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. remarks: >- - The messages will be logged with a format such as - `.`. + The messages will be logged with a format such as `.`. - For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` - is specified, the engagement log might contain: + For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might + contain: 1. The action type: - `Add`: change from initial/unset state to customized content. - (first edit) + `Add`: change from initial/unset state to customized content. (first edit) - `Clear`: reset the content of caption element to initial/unset - state. + `Clear`: reset the content of caption element to initial/unset state. - `Edit`: any edition that changes the content apart from add and - clear + `Edit`: any edition that changes the content apart from add and clear 2. The text length after each edit @@ -162,39 +151,28 @@ properties: return: type: boolean - name: onGetErrorMessage - uid: >- - @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' package: '@microsoft/sp-property-pane!' fullName: onGetErrorMessage - summary: >- - The method is used to get the validation error message and determine - whether the input value is valid or not. - remarks: >- + summary: The method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- When it returns string: - - If valid, it returns empty string. - - - If invalid, it returns the error message string and an error message is - displayed below the text field. - + - If invalid, it returns the error message string and an error message is displayed below the text field. When it returns `Promise`: - - The resolved value is display as error message. - - The rejected, the value is thrown away. isPreview: false isDeprecated: false syntax: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: - type: >- - (value: string) => string | <string> + type: '(value: string) => string | Promise<string>' - name: placeholder uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' package: '@microsoft/sp-property-pane!' @@ -223,9 +201,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' package: '@microsoft/sp-property-pane!' fullName: rows - summary: >- - Specifies the visible height of a text area(multiline text TextField), in - lines. + summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. isPreview: false isDeprecated: false @@ -246,8 +222,7 @@ properties: return: type: boolean - name: validateOnFocusIn - uid: >- - @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' package: '@microsoft/sp-property-pane!' fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. @@ -259,8 +234,7 @@ properties: return: type: boolean - name: validateOnFocusOut - uid: >- - @microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' package: '@microsoft/sp-property-pane!' fullName: validateOnFocusOut summary: Run validation when the PropertyPaneTextField is out of focus or on blur. @@ -276,9 +250,8 @@ properties: package: '@microsoft/sp-property-pane!' fullName: value summary: >- - Value to be displayed in the text field when the value of the - targetProperty in the manifest's property bag is empty or contains null - value. + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index b96a529e..15a7e76a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -54,16 +54,14 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'label: string | JSX.Element;' + content: 'label: string | React.ReactElement;' return: - type: 'string | @types/react!~__global.JSX.' + type: 'string | ' - name: offAriaLabel uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' package: '@microsoft/sp-property-pane!' fullName: offAriaLabel - summary: >- - Optional offAriaLabel flag. Text for screen-reader to announce when toggle - is OFF. + summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. remarks: '' isPreview: false isDeprecated: false @@ -87,9 +85,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' package: '@microsoft/sp-property-pane!' fullName: onAriaLabel - summary: >- - Optional onAriaLabel flag. Text for screen-reader to announce when toggle - is ON. + summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index d2e6dc8f..1c7ebe94 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -12,24 +12,24 @@ fields: uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in center of screen. - numericValue: 0 + value: '0' - name: leftBottom uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in left bottom of screen. - numericValue: 4 + value: '4' - name: leftTop uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in left top of screen. - numericValue: 2 + value: '2' - name: rightBottom uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in right bottom of screen. - numericValue: 3 + value: '3' - name: rightTop uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' package: '@microsoft/sp-property-pane!' summary: PopupWindowPosition would be located in right top of screen. - numericValue: 1 + value: '1' diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index 2ce8d7e8..4215c282 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -12,31 +12,31 @@ fields: uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' package: '@microsoft/sp-property-pane!' summary: Optional actions. - numericValue: 4 + value: '4' - name: Compound uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' package: '@microsoft/sp-property-pane!' summary: Always used as a set with both Standard and Primary compound buttons. - numericValue: 3 + value: '3' - name: Hero uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' package: '@microsoft/sp-property-pane!' summary: Hero button. - numericValue: 2 + value: '2' - name: Icon uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' package: '@microsoft/sp-property-pane!' summary: >- - Same usage as Command button, when real estate does not allow for icons + - labels or as secondary actions within the command bar. - numericValue: 5 + Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within + the command bar. + value: '5' - name: Normal uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' package: '@microsoft/sp-property-pane!' summary: Optional completion action. - numericValue: 0 + value: '0' - name: Primary uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' package: '@microsoft/sp-property-pane!' summary: Preferred completion action when paired with a Standard button. - numericValue: 1 + value: '1' diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 527b9695..ec59c37b 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -5,8 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PropertyPaneDropdownOptionType summary: >- Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). + [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). remarks: '' isPreview: false isDeprecated: false @@ -15,14 +14,14 @@ fields: uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' package: '@microsoft/sp-property-pane!' summary: Render a divider. - numericValue: 1 + value: '1' - name: Header uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' package: '@microsoft/sp-property-pane!' summary: Render menu item as a header. - numericValue: 2 + value: '2' - name: Normal uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' package: '@microsoft/sp-property-pane!' summary: Render normal menu item. - numericValue: 0 + value: '0' diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index f0f9d759..04c93910 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -3,12 +3,10 @@ name: PropertyPaneFieldType uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' package: '@microsoft/sp-property-pane!' fullName: PropertyPaneFieldType -summary: >- +summary: |- Enum for all the supported PropertyPane field types. - - Names should be consistent with those in office-ui-fabric-react, be careful to - get letter casing correct. + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' isPreview: false isDeprecated: false @@ -17,74 +15,74 @@ fields: uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' package: '@microsoft/sp-property-pane!' summary: Button field. - numericValue: 11 + value: '11' - name: CheckBox uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' package: '@microsoft/sp-property-pane!' summary: Checkbox field. - numericValue: 2 + value: '2' - name: ChoiceGroup uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' package: '@microsoft/sp-property-pane!' summary: Choice Group field. - numericValue: 10 + value: '10' - name: Custom uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' package: '@microsoft/sp-property-pane!' summary: Custom field. - numericValue: 1 + value: '1' - name: Dropdown uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' package: '@microsoft/sp-property-pane!' summary: Dropdown field. - numericValue: 6 + value: '6' - name: DynamicField uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' package: '@microsoft/sp-property-pane!' summary: Dynamic data field. - numericValue: 14 + value: '14' - name: DynamicFieldSet uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' package: '@microsoft/sp-property-pane!' summary: A set of dynamic fields. - numericValue: 16 + value: '16' - name: DynamicTextField uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' package: '@microsoft/sp-property-pane!' summary: Dynamic Text Field - numericValue: 15 + value: '15' - name: Heading uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' package: '@microsoft/sp-property-pane!' summary: Heading field. - numericValue: 9 + value: '9' - name: HorizontalRule uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' package: '@microsoft/sp-property-pane!' summary: Horizontal Rule field. - numericValue: 12 + value: '12' - name: Label uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' package: '@microsoft/sp-property-pane!' summary: Label field. - numericValue: 7 + value: '7' - name: Link uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' package: '@microsoft/sp-property-pane!' summary: Link field. - numericValue: 13 + value: '13' - name: Slider uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' package: '@microsoft/sp-property-pane!' summary: Slider field. - numericValue: 8 + value: '8' - name: TextField uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' package: '@microsoft/sp-property-pane!' summary: TextField field. - numericValue: 3 + value: '3' - name: Toggle uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' package: '@microsoft/sp-property-pane!' summary: Toggle field. - numericValue: 5 + value: '5' diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 772d8a15..92cedf82 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' package: '@microsoft/sp-search-extensibility!' fullName: BaseSearchQueryModifier summary: >- - This is the base class that third parties should extend when implementing a - client-side extension that can modify the search query. + This is the base class that third parties should extend when implementing a client-side extension that can modify the + search query. - In the component manifest, the "extensionType" should be set to - "SearchQueryModifier". + In the component manifest, the "extensionType" should be set to "SearchQueryModifier". remarks: '' isPreview: true isDeprecated: false @@ -19,15 +18,11 @@ properties: uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' package: '@microsoft/sp-search-extensibility!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: true isDeprecated: false syntax: @@ -39,22 +34,20 @@ properties: package: '@microsoft/sp-search-extensibility!' fullName: timeout summary: >- - Timeout for the search query modifier in milliseconds. If the execution - takes longer than the timeout, the original query will be used instead of - the modified one. + Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the + original query will be used instead of the modified one. remarks: '' isPreview: true isDeprecated: false syntax: content: |- /** @virtual */ - readonly timeout: number; + get timeout(): number; return: type: number methods: - name: 'modifySearchQuery(query, scenario)' - uid: >- - @microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1) + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' package: '@microsoft/sp-search-extensibility!' fullName: 'modifySearchQuery(query, scenario)' summary: Returns a modified search query. @@ -62,25 +55,17 @@ methods: isPreview: true isDeprecated: false syntax: - content: >- + content: |- /** @virtual */ - - modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): - Promise; + modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise; parameters: - id: query description: Query to modify. type: '' - id: scenario description: Search scenario. - type: >- - + type: '' return: - type: >- - <> + type: 'Promise<>' description: Modified query. -extends: >- - <TProperties> +extends: '<TProperties> ' diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index 4cdb0676..ab2f88fd 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -3,12 +3,8 @@ name: IQuery uid: '@microsoft/sp-search-extensibility!IQuery:interface' package: '@microsoft/sp-search-extensibility!' fullName: IQuery -summary: >- - Query object. Includes the query text that will be used for search and exposed - through dynamic data. -remarks: >- - Additional properties can be added to the object to pass data between - extensions. +summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. +remarks: Additional properties can be added to the object to pass data between extensions. isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index e6042887..b93661eb 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -9,14 +9,12 @@ isPreview: true isDeprecated: false fields: - name: SearchResults - uid: >- - @microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' package: '@microsoft/sp-search-extensibility!' summary: Search results scenario. - numericValue: 1 + value: '1' - name: SearchSuggestions - uid: >- - @microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' package: '@microsoft/sp-search-extensibility!' summary: Search suggestions scenario. - numericValue: 2 + value: '2' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 9f6786b2..4cced970 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -13,7 +13,6 @@ enums: - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' interfaces: - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' @@ -48,7 +47,6 @@ interfaces: - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - '@microsoft/sp-webpart-base!ISDKs:interface' - - '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - '@microsoft/sp-webpart-base!IWebPartContext:interface' - '@microsoft/sp-webpart-base!IWebPartData:interface' @@ -57,18 +55,17 @@ interfaces: functions: - name: 'PropertyPaneButton(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Button on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneButton(targetProperty: string, - properties: IPropertyPaneButtonProps): + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField; parameters: - id: targetProperty @@ -76,31 +73,25 @@ functions: type: string - id: properties description: Strongly typed Button properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneCheckbox(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneCheckbox(targetProperty: string, - properties: IPropertyPaneCheckboxProps): + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField; parameters: - id: targetProperty @@ -108,97 +99,78 @@ functions: type: string - id: properties description: Strongly typed Checkbox properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneChoiceGroup(targetProperty: string, - properties: IPropertyPaneChoiceGroupProps): - IPropertyPaneField; + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; parameters: - id: targetProperty description: Target property the choice group is associated to. type: string - id: properties description: Strongly typed Choice Group properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: PropertyPaneCustomField(properties) uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a custom field on the PropertyPane. remarks: >- - The purpose of the custom field is to help the web part developer to add a - custom control to the PropertyPane. The PropertyPane supports a host of - inbuilt field types. While this list meets the demands of most web parts, - but there are exceptional cases when web parts have special needs and need - a special control. The custom field helps fill that gap. + The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The + PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but + there are exceptional cases when web parts have special needs and need a special control. The custom field helps + fill that gap. isPreview: true isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneCustomField(properties: - IPropertyPaneCustomFieldProps): + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField; parameters: - id: properties description: Strongly typed Custom field properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneDropdown(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneDropdown(targetProperty: string, - properties: IPropertyPaneDropdownProps): + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField; parameters: - id: targetProperty @@ -206,156 +178,123 @@ functions: type: string - id: properties description: Strongly typed Dropdown properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneDynamicField(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' - package: '@microsoft/sp-webpart-base' - summary: >- - Helper method to create a Dynamic Data widget on the PropertyPane for a - dynamic field. + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneDynamicField(targetProperty: string, - properties: IPropertyPaneDynamicFieldProps): - IPropertyPaneField; + export declare function PropertyPaneDynamicField(targetProperty: string, properties: + IPropertyPaneDynamicFieldProps): IPropertyPaneField; parameters: - id: targetProperty description: Target property the Dynamic Data widget is associated to. type: string - id: properties description: '' - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: PropertyPaneDynamicFieldSet(properties) uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: >- - Helper method to create a Dynamic Data widget on the Property Pane for a - set of dynamic fields with a common data source. + Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data + source. - These fields can possibly share the same property based on the associated - filters. + These fields can possibly share the same property based on the associated filters. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneDynamicFieldSet(properties: - IPropertyPaneDynamicFieldSetProps): + export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField; parameters: - id: properties description: >- - Contains entries and options, described as below: entries - A set of - entries to be configured by the widget. Each entry includes the - target property and, optionally, the label to show. options - - Options enabling customized values for callback, filters etc., for - the given set of dynamic fields. - type: >- - + Contains entries and options, described as below: entries - A set of entries to be configured by the widget. + Each entry includes the target property and, optionally, the label to show. options - Options enabling + customized values for callback, filters etc., for the given set of dynamic fields. + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' isPreview: true isDeprecated: true customDeprecatedMessage: >- - This has been replaced by PropertyPaneDynamicField and moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please + consume it from there. syntax: content: >- - export declare function PropertyPaneDynamicTextField(targetProperty: - string, properties: IPropertyPaneDynamicTextFieldProps): - IPropertyPaneField; + export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: + IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; parameters: - id: targetProperty description: Target property the dynamic textfield is associated to. type: string - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: PropertyPaneHorizontalRule() uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: - content: >- - export declare function PropertyPaneHorizontalRule(): - IPropertyPaneField; + content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' return: - type: >- - <void> + type: '<void>' description: '' - name: 'PropertyPaneLabel(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Label on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneLabel(targetProperty: string, - properties: IPropertyPaneLabelProps): + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField; parameters: - id: targetProperty @@ -363,31 +302,25 @@ functions: type: string - id: properties description: Strongly typed Label properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneLink(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Link on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneLink(targetProperty: string, - properties: IPropertyPaneLinkProps): + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField; parameters: - id: targetProperty @@ -395,30 +328,25 @@ functions: type: string - id: properties description: Strongly typed Link properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneSlider(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneSlider(targetProperty: string, - properties: IPropertyPaneSliderProps): + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField; parameters: - id: targetProperty @@ -426,31 +354,25 @@ functions: type: string - id: properties description: Strongly typed Slider properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneTextField(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneTextField(targetProperty: string, - properties: IPropertyPaneTextFieldProps): + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField; parameters: - id: targetProperty @@ -458,31 +380,25 @@ functions: type: string - id: properties description: Strongly typed TextField properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' - name: 'PropertyPaneToggle(targetProperty, properties)' uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' - package: '@microsoft/sp-webpart-base' + package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This function has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. syntax: content: >- - export declare function PropertyPaneToggle(targetProperty: string, - properties: IPropertyPaneToggleProps): + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField; parameters: - id: targetProperty @@ -490,14 +406,9 @@ functions: type: string - id: properties description: Strongly typed Toggle properties. - type: >- - + type: '' return: type: >- - <> + <> description: '' diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 08659849..535a8a6f 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -4,24 +4,21 @@ uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' package: '@microsoft/sp-webpart-base!' fullName: BaseClientSideWebPart summary: >- - This abstract class implements the the base functionality for a client-side - web part. Every client-side web part needs to inherit from this class. + This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs + to inherit from this class. remarks: >- - Along with the base functionality, this class provides some APIs that can be - used by the web part. These APIs fall in two catagories. + Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in + two catagories. - The first category of APIs provide data and functionality. Example, the web - part context (i.e. this.context). This API should be used to access contextual - data relevant to this web part instance. + The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API + should be used to access contextual data relevant to this web part instance. - The second category of APIs provide a base implementation for the web part - lifecycle and can be overridden for an updated implementation. The render() - API is the only API that is mandatory to be implemented/overridden by a web - part. All other life cycle APIs have a base implementation and can be - overridden based on the needs of the web part. Please refer to the - documentation of the individual APIs to make the right decision. + The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an + updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. + All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please + refer to the documentation of the individual APIs to make the right decision. isPreview: false isDeprecated: false type: class @@ -32,56 +29,44 @@ constructors: fullName: (constructor)() summary: Constructor for the BaseClientSideWebPart class. remarks: >- - It is highly recommended that the web part use the `onInit()` API to - perform any web part specific initialization. Most of the web part - features like this.context and `this.properties` are not available to be - used before the the `onInit()` part of the web part loading lifecycle. + It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. + Most of the web part features like this.context and `this.properties` are not available to be used before the the + `onInit()` part of the web part loading lifecycle. isPreview: false isDeprecated: false syntax: content: constructor(); properties: - name: canOpenPopupOnRender - uid: >- - @microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' package: '@microsoft/sp-webpart-base!' fullName: canOpenPopupOnRender - summary: >- - This property indicates whether a web part can open a popup on initial - render. + summary: This property indicates whether a web part can open a popup on initial render. remarks: >- - In some environments the host re-renders the web parts frequently, and - therefore opening popups during render will cause popups to open - repeatedly, which is a poor user experience. As an example, the classic - SharePoint pages perform postbacks causing the page to re-render on all - button clicks. + In some environments the host re-renders the web parts frequently, and therefore opening popups during render will + cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages + perform postbacks causing the page to re-render on all button clicks. - If a web part needs to open a popup on render, it should use this API - before opening the popup. If this API returns false, the web part should - not open popup on initial render. Some web parts that open popups during - render are the document embed web part that pops up the file picker on - initial render, embedded video web part that pops up the PropertyPane on - initial render. + If a web part needs to open a popup on render, it should use this API before opening the popup. If this API + returns false, the web part should not open popup on initial render. Some web parts that open popups during render + are the document embed web part that pops up the file picker on initial render, embedded video web part that pops + up the PropertyPane on initial render. isPreview: false isDeprecated: false syntax: - content: 'protected readonly canOpenPopupOnRender: boolean;' + content: 'protected get canOpenPopupOnRender(): boolean;' return: type: boolean - name: context uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' package: '@microsoft/sp-webpart-base!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: false isDeprecated: false syntax: @@ -93,23 +78,23 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: domElement summary: >- - This property is a pointer to the root DOM element of the web part. This - is a DIV element and contains the whole DOM subtree of the web part. + This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole + DOM subtree of the web part. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'protected readonly domElement: HTMLElement;' + content: 'protected get domElement(): HTMLElement;' return: - type: '' + type: HTMLElement - name: isRenderAsync uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' package: '@microsoft/sp-webpart-base!' fullName: isRenderAsync summary: Indicates whether the web part is rendering in Async mode. remarks: >- - If the web part overrides this field to return true, then it needs to call - renderCompleted API after the web part rendering is complete. + If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part + rendering is complete. The default value is false. @@ -118,25 +103,21 @@ properties: syntax: content: |- /** @virtual */ - protected readonly isRenderAsync: boolean; + protected get isRenderAsync(): boolean; return: type: boolean - name: renderedFromPersistedData - uid: >- - @microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' package: '@microsoft/sp-webpart-base!' fullName: renderedFromPersistedData summary: >- - This property indicates whether the web part was rendered from the - persisted data (serialized state from the last time that the web part was - saved) or not. - remarks: >- - Example: When web part is added for the first time using toolbox then the - value is false. + This property indicates whether the web part was rendered from the persisted data (serialized state from the last + time that the web part was saved) or not. + remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' isPreview: false isDeprecated: false syntax: - content: 'protected readonly renderedFromPersistedData: boolean;' + content: 'protected get renderedFromPersistedData(): boolean;' return: type: boolean - name: renderedOnce @@ -144,24 +125,35 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: renderedOnce summary: >- - This property indicates whether the web part has been rendered once or - not. After the first time rendering, the value of this property is always - true until a full re-render of the web part happens. + This property indicates whether the web part has been rendered once or not. After the first time rendering, the + value of this property is always true until a full re-render of the web part happens. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'protected readonly renderedOnce: boolean;' + content: 'protected get renderedOnce(): boolean;' return: type: boolean + - name: width + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#width:member' + package: '@microsoft/sp-webpart-base!' + fullName: width + summary: This propery returns the width of the container for the web part. + remarks: >- + Web parts should utilize this property to perform operations such as any conditional styling of components based + on the initial available width for the web part. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get width(): number;' + return: + type: number methods: - name: clearError() uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' package: '@microsoft/sp-webpart-base!' fullName: clearError() - summary: >- - This API should be used to clear the error message from the web part - display area. + summary: This API should be used to clear the error message from the web part display area. remarks: '' isPreview: false isDeprecated: false @@ -170,20 +162,38 @@ methods: return: type: void description: '' + - name: onAfterResize(newWidth) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onAfterResize(newWidth) + summary: >- + This API is invoked when the web part container dom element width is changed, e.g. when the browser browser window + is resized and when the property pane is toggled open/closed. + remarks: >- + Web parts should utilize this method to perform operations such as potentially re-rendering components based on + the new available width for the web part. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onAfterResize(newWidth: number): void; + parameters: + - id: newWidth + description: Width (in pixels) of the container for the web part after the resize event. + type: number + return: + type: void + description: '' - name: onDisplayModeChanged(oldDisplayMode) - uid: >- - @microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onDisplayModeChanged(oldDisplayMode) - summary: >- - This event method is called when the display mode of a web part is - changed. + summary: This event method is called when the display mode of a web part is changed. remarks: >- - The default implementation of this API calls the web part render method to - re-render the web part with the new display mode. If a web part developer - does not want a full re-render to happen on display mode change, they can - override this API and perform specific updates to the web part DOM to - switch its display mode. + The default implementation of this API calls the web part render method to re-render the web part with the new + display mode. If a web part developer does not want a full re-render to happen on display mode change, they can + override this API and perform specific updates to the web part DOM to switch its display mode. isPreview: false isDeprecated: false syntax: @@ -203,11 +213,10 @@ methods: fullName: onDispose() summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- - This API is called at the end of the web part lifecycle on a page. It - should be used to dispose any local resources (i.e. DOM elements) that the - web part is holding onto. This API is expected to be called in scenarios - like page navigation i.e. the host is transitioning from one page to - another and disposes the page that is being transitioned out. + This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local + resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being + transitioned out. isPreview: false isDeprecated: false syntax: @@ -222,8 +231,8 @@ methods: package: '@microsoft/sp-webpart-base!' fullName: render() summary: >- - This API is called to render the web part. There is no base implementation - of this API and the web part is required to override this API. + This API is called to render the web part. There is no base implementation of this API and the web part is + required to override this API. remarks: '' isPreview: false isDeprecated: false @@ -232,21 +241,24 @@ methods: return: type: void description: '' - - name: renderCompleted() + - name: renderCompleted(error) uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: renderCompleted() + fullName: renderCompleted(error) summary: >- - This API should be called by web parts that perform Async rendering. Those - web part are required to override the isRenderAsync API and return true. - One such example is web parts that render content in an IFrame. The web - part initiates the IFrame rendering in the `render()` API but the actual - rendering is complete only after the iframe loading completes. + This API should be called by web parts that perform Async rendering. Those web part are required to override the + isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part + initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe + loading completes. remarks: '' isPreview: false isDeprecated: false syntax: - content: 'protected renderCompleted(): void;' + content: 'protected renderCompleted(error?: Error): void;' + parameters: + - id: error + description: '' + type: Error return: type: void description: '' @@ -255,8 +267,8 @@ methods: package: '@microsoft/sp-webpart-base!' fullName: renderError(error) summary: >- - This API should be used to render an error message in the web part display - area. Also logs the error message using the trace logger. + This API should be used to render an error message in the web part display area. Also logs the error message using + the trace logger. remarks: '' isPreview: false isDeprecated: false @@ -265,7 +277,7 @@ methods: parameters: - id: error description: An error object containing the error message to render. - type: '' + type: Error return: type: void description: '' diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 4bb0ba5d..16a2e96c 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-webpart-base!BaseWebPart:class' package: '@microsoft/sp-webpart-base!' fullName: BaseWebPart summary: >- - This abstract class implements the UI-agnostic base functionality for a - client-side web part. The purpose is to allow a common core between 2D and MR - WebParts. + This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow + a common core between 2D and MR WebParts. remarks: '' isPreview: false isDeprecated: false @@ -18,10 +17,9 @@ constructors: fullName: (constructor)() summary: Constructor for the `BaseWebPart` class. remarks: >- - It is highly recommended that the web part use the OnInit API to perform - any web part specific initialization. Most of the web part features like - this.context and this.properties are not available to be used before the - the onInit part of the web part loading lifecycle. + It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. + Most of the web part features like this.context and this.properties are not available to be used before the the + onInit part of the web part loading lifecycle. isPreview: false isDeprecated: false syntax: @@ -32,30 +30,25 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: accessibleTitle summary: >- - This property points to the accessible title of web part made available to - screen readers. The base implementation returns that default title in the - manifest. Web parts that want to provide more descriptive title containing - contextual information need to override this API. + This property points to the accessible title of web part made available to screen readers. The base implementation + returns that default title in the manifest. Web parts that want to provide more descriptive title containing + contextual information need to override this API. virtual remarks: '' isPreview: false isDeprecated: false syntax: - content: 'protected readonly accessibleTitle: string;' + content: 'protected get accessibleTitle(): string;' return: type: string - name: context uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' package: '@microsoft/sp-webpart-base!' fullName: context - summary: >- - Use the context object to access common services and state associated with - the component. + summary: Use the context object to access common services and state associated with the component. remarks: >- - Child classes are expected to override this field by redeclaring it with a - specialized type. It is meant to be a read-only property; the type cannot - be declared as read-only in the base class (because it is initialized - outside the constructor), but child classes should redeclare it as - readonly. + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. isPreview: false isDeprecated: false syntax: @@ -67,14 +60,13 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: dataVersion summary: >- - The value of this property is stored in the serialized data of the web - part to allow developers to manage versioning of their web part. The - default version is 1.0 + The value of this property is stored in the serialized data of the web part to allow developers to manage + versioning of their web part. The default version is 1.0 remarks: '' isPreview: false isDeprecated: false syntax: - content: 'protected readonly dataVersion: Version;' + content: 'protected get dataVersion(): Version;' return: type: '' - name: description @@ -86,33 +78,29 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'protected readonly description: string;' + content: 'protected get description(): string;' return: type: string - name: disableReactivePropertyChanges - uid: >- - @microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member + uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' package: '@microsoft/sp-webpart-base!' fullName: disableReactivePropertyChanges - summary: >- - This property is used to change the web part's property pane interaction - from Reactive to NonReactive. + summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. virtual remarks: >- The default behavior is Reactive. - Reactive implies that changes made in the PropertyPane are transmitted to - the web part instantly and the user can see instant updates. This helps - the page creator get instant feedback and decide if they should keep the - new configuration changes or not. + Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can + see instant updates. This helps the page creator get instant feedback and decide if they should keep the new + configuration changes or not. - NonReactive implies that the configuration changes are transmitted to the - web part only after "Apply" PropertyPane button is clicked. + NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane + button is clicked. isPreview: false isDeprecated: false syntax: - content: 'protected readonly disableReactivePropertyChanges: boolean;' + content: 'protected get disableReactivePropertyChanges(): boolean;' return: type: boolean - name: displayMode @@ -124,7 +112,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'protected readonly displayMode: DisplayMode;' + content: 'get displayMode(): DisplayMode;' return: type: '' - name: previewImageUrl @@ -132,16 +120,14 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: previewImageUrl summary: >- - This property points to the preview image for the web part. The base - implementation returns undefined. Web parts that want to provide a valid - preview image url need to override this API. The preview image url can be - used to create a preview of the web part or of the page on which the web - part is present. + This property points to the preview image for the web part. The base implementation returns undefined. Web parts + that want to provide a valid preview image url need to override this API. The preview image url can be used to + create a preview of the web part or of the page on which the web part is present. virtual remarks: '' isPreview: false isDeprecated: false syntax: - content: 'readonly previewImageUrl: string | undefined;' + content: 'get previewImageUrl(): string | undefined;' return: type: string | undefined - name: properties @@ -153,7 +139,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'protected readonly properties: TProperties;' + content: 'protected get properties(): TProperties;' return: type: TProperties - name: propertiesMetadata @@ -161,24 +147,17 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: propertiesMetadata summary: >- - This property defines metadata for the web part property bag. The metadata - can help SharePoint understand the content of the properties better and - perform relevant services on the data. + This property defines metadata for the web part property bag. The metadata can help SharePoint understand the + content of the properties better and perform relevant services on the data. virtual remarks: >- - See - [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) - for more information about how to define metadata + See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more + information about how to define metadata isPreview: false isDeprecated: false syntax: - content: >- - protected readonly propertiesMetadata: IWebPartPropertiesMetadata | - undefined; + content: 'protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;' return: - type: >- - | undefined + type: ' | undefined' - name: title uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' package: '@microsoft/sp-webpart-base!' @@ -188,93 +167,101 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'protected readonly title: string;' + content: 'protected get title(): string;' return: type: string methods: - name: getPropertyPaneConfiguration() - uid: >- - @microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1) + uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' package: '@microsoft/sp-webpart-base!' fullName: getPropertyPaneConfiguration() summary: >- - This API is used to ger the configuration to build the property pane for - the web part. If the web part wants to use the PropertyPane for - configuration, this API needs to be overridden and the web part needs to - return the configuration for the PropertyPane. + This API is used to ger the configuration to build the property pane for the web part. If the web part wants to + use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the + configuration for the PropertyPane. - This API is not invoked until the 'loadPropertyPaneResources' promise is - resolved. + This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. - See IPropertyPane and other PropertyPane integration wiki documentation - for more details. + See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual remarks: '' isPreview: false isDeprecated: false syntax: content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: - type: >- - + type: '' + description: '' + - name: loadPropertyPaneResources() + uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: loadPropertyPaneResources() + summary: This API enables asynchronous loading of property pane related resources of the web part. + remarks: >- + If not overridden by the web part, base web part resolves the promise immediately. + + + This method is called before any property pane APIs are called. Other property pane APIs cannot be called until + this promise is resolved. No other property pane related events are raised except + 'PropertyPaneConfigurationComplete'. + + + 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including + 'loadPropertyPaneResources' promise. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected loadPropertyPaneResources(): Promise; + return: + type: Promise<void> description: '' - name: 'onAfterDeserialize(deserializedObject, dataVersion)' uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' package: '@microsoft/sp-webpart-base!' fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' summary: >- - This API is called after the web part is deserialized to an object, right - before the property bag is populated. + This API is called after the web part is deserialized to an object, right before the property bag is populated. + virtual remarks: >- - The default implementation is a no-op. A web part developer can override - this API if the deserialized object does not fully reflect the initial - state of the property bag. This gives the web part developer a chance to - populate the property bag right after the data is deserialized to an - object. + The default implementation is a no-op. A web part developer can override this API if the deserialized object does + not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate + the property bag right after the data is deserialized to an object. - An important scenario to use deserialize is upgrading. An upgraded web - part may load the data that was serialized by an older version of the web - part that supported a different schema of the property bag, resulting the - deserialized object to be incosistent with the current schema of the - property bag. The developer can use `onAfterDeserialize` to check the - dataVersion and fix the property bag. + An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized + by an older version of the web part that supported a different schema of the property bag, resulting the + deserialized object to be incosistent with the current schema of the property bag. The developer can use + `onAfterDeserialize` to check the dataVersion and fix the property bag. isPreview: false isDeprecated: false syntax: - content: >- - protected onAfterDeserialize(deserializedObject: any, dataVersion: - Version): TProperties; + content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' parameters: - id: deserializedObject description: >- - The object deserialized from the stored data. Note that the schema - of this object is not necessarily consistent with the current - property bag, because the serialization could have been done by an - older version of the web part + The object deserialized from the stored data. Note that the schema of this object is not necessarily + consistent with the current property bag, because the serialization could have been done by an older version + of the web part type: any - id: dataVersion description: >- - The data version of the stored data being deserialized. You can use - this value to determine if the data was serialized by an older web - part. Web parts can define their data version by overriding the - dataVersion property. + The data version of the stored data being deserialized. You can use this value to determine if the data was + serialized by an older web part. Web parts can define their data version by overriding the dataVersion + property. type: '' return: type: TProperties description: The property bag of the web part - name: onAfterPropertyPaneChangesApplied() - uid: >- - @microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1) + uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onAfterPropertyPaneChangesApplied() summary: >- - This API is invoked after the changes made on the PropertyPane are applied - when the PropertyPane is used in Non-Reactive mode. This API is not - invoked when the PropertyPane is used in Reactive mode. + This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in + Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual remarks: '' isPreview: false isDeprecated: false @@ -287,17 +274,14 @@ methods: uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onBeforeSerialize() - summary: This event method is called before the web part is serialized. + summary: This event method is called before the web part is serialized. virtual remarks: >- - The default implementation is a no-op. The serialization process - serializes the web part property bag i.e. this.properties. This API gives - the web part a chance to update it's property bag before the serialization - happens. Some web part's may keep their state other objects or even in the - DOM. If a web part needs to persist some of that state, it needs to - override this API and update the web part property bag to the latest - state. If a web part updates the property bag with invalid property - values, those will get persisted. So that should be avoided. The web part - property bag should always contain valid property values. + The default implementation is a no-op. The serialization process serializes the web part property bag i.e. + this.properties. This API gives the web part a chance to update it's property bag before the serialization + happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist + some of that state, it needs to override this API and update the web part property bag to the latest state. If a + web part updates the property bag with invalid property values, those will get persisted. So that should be + avoided. The web part property bag should always contain valid property values. isPreview: false isDeprecated: false syntax: @@ -309,15 +293,10 @@ methods: uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onDisplayModeChanged(oldDisplayMode) - summary: >- - This event method is called when the display mode of a web part is - changed. + summary: This event method is called when the display mode of a web part is changed. virtual remarks: >- - The default implementation of this API calls the web part render method to - re-render the web part with the new display mode. If a web part developer - does not want a full re-render to happen on display mode change, they can - override this API and perform specific updates to the web part DOM to - switch its display mode. + If the web part is initialized or re-initialized in a different display mode then this lifecycle method is not + called. isPreview: false isDeprecated: false syntax: @@ -333,13 +312,12 @@ methods: uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onDispose() - summary: This API should be used to refresh the contents of the PropertyPane. + summary: This API should be used to refresh the contents of the PropertyPane. virtual remarks: >- - This API is called at the end of the web part lifecycle on a page. It - should be used to dispose any local resources (i.e. DOM elements) that the - web part is holding onto. This API is expected to be called in scenarios - like page navigation i.e. the host is transitioning from one page to - another and disposes the page that is being transitioned out. + This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local + resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being + transitioned out. isPreview: false isDeprecated: false syntax: @@ -351,45 +329,33 @@ methods: uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onInit() - summary: This event method is called when the web part is initialized. + summary: This event method is called when the web part is initialized. virtual remarks: >- - This API should be overridden to perform long running operations e.g. data - fetching from a remote service before the initial rendering of the web - part. The loading indicator is displayed during the lifetime of this - method. This API is called only once during the lifecycle of a web part. + This API should be overridden to perform long running operations e.g. data fetching from a remote service before + the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This + API is called only once during the lifecycle of a web part. isPreview: false isDeprecated: false syntax: content: 'protected onInit(): Promise;' return: - type: '<void>' + type: Promise<void> description: '' - name: onPropertyPaneConfigurationComplete() - uid: >- - @microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1) + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onPropertyPaneConfigurationComplete() - summary: >- - This API is invoked when the configuration is completed on the - PropertyPane. - remarks: >- + summary: This API is invoked when the configuration is completed on the PropertyPane. virtual + remarks: |- This event method is invoked in the following cases: + - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. - - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 - secs) elapses after the last change. - + - When user clicks the "X" (close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - When user clicks the "X" (close) button before the - CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - - When user clicks the 'Apply' button before the - CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - - - When the user switches web parts then the current web part gets this - event. + - When the user switches web parts then the current web part gets this event. isPreview: false isDeprecated: false syntax: @@ -398,13 +364,10 @@ methods: type: void description: '' - name: onPropertyPaneConfigurationStart() - uid: >- - @microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1) + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onPropertyPaneConfigurationStart() - summary: >- - This event method is invoked when the configuration starts on the - PropertyPane. + summary: This event method is invoked when the configuration starts on the PropertyPane. virtual remarks: |- This event method is invoked in the following cases: @@ -419,37 +382,29 @@ methods: type: void description: '' - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - uid: >- - @microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1) + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' package: '@microsoft/sp-webpart-base!' fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' summary: >- - This API is invoked after updating the new value of the property in the - property bag when the PropertyPane is being used in Reactive mode. + This API is invoked after updating the new value of the property in the property bag when the PropertyPane is + being used in Reactive mode. virtual remarks: '' isPreview: false isDeprecated: false syntax: - content: >- - protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: - any, newValue: any): void; + content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' parameters: - id: propertyPath description: >- - JSON path of the property in the property bag. In the case of custom - field, if no target property is provided then a custom value is - assigned, which will be in the form of `__CustomField_`. + JSON path of the property in the property bag. In the case of custom field, if no target property is + provided then a custom value is assigned, which will be in the form of `__CustomField_`. type: string - id: oldValue - description: >- - Old value of the property. This value could be undefined/empty in - the case of custom field. + description: Old value of the property. This value could be undefined/empty in the case of custom field. type: any - id: newValue - description: >- - New value of the property. This value could be undefined/empty in - the case of custom field. + description: New value of the property. This value could be undefined/empty in the case of custom field. type: any return: type: void @@ -458,7 +413,7 @@ methods: uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' package: '@microsoft/sp-webpart-base!' fullName: onPropertyPaneRendered() - summary: This API is invoked when the PropertyPane is rendered. + summary: This API is invoked when the PropertyPane is rendered. virtual remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 213d8d9a..2b02b625 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -4,15 +4,14 @@ uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' package: '@microsoft/sp-webpart-base!' fullName: BaseWebPartContext summary: >- - Web part context object. This object contains the contextual services - available to a web part. e.g. a contextual instance to the http client. + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. This base is to be extended by UI-specific WebPart's base. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `BaseWebPartContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseWebPartContext` class. isPreview: false isDeprecated: false type: class @@ -23,15 +22,14 @@ properties: fullName: formFactor summary: Form factor of the web part. remarks: >- - Web parts may behave differently based on its form factor. E.g. a web part - rendering as full size may want to set up different margins that when - rendering in a canvas. + Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set + up different margins that when rendering in a canvas. isPreview: true isDeprecated: false syntax: - content: 'readonly formFactor: WebPartFormFactor;' + content: 'get formFactor(): WebPartFormFactor;' return: - type: '' + type: '' - name: manifest uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' package: '@microsoft/sp-webpart-base!' @@ -43,10 +41,7 @@ properties: syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: >- - <any> + type: '<any>' - name: propertyPane uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' package: '@microsoft/sp-webpart-base!' @@ -56,11 +51,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly propertyPane: IPropertyPaneAccessor;' + content: 'get propertyPane(): IPropertyPaneAccessor;' return: - type: >- - + type: '' - name: webPartTag uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' package: '@microsoft/sp-webpart-base!' @@ -70,7 +63,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly webPartTag: string;' + content: 'get webPartTag(): string;' return: type: string extends: '' diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index c078bed1..114df558 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -7,22 +7,20 @@ summary: Enum for the possible values of shared depth of the dynamic data refere remarks: '' isPreview: false isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This enum has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. fields: - name: None uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' package: '@microsoft/sp-webpart-base!' summary: Indicates that nothing is shared. - numericValue: 0 + value: '0' - name: Property uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' package: '@microsoft/sp-webpart-base!' summary: Indicates that both the dynamic data source and the property are shared. - numericValue: 2 + value: '2' - name: Source uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' package: '@microsoft/sp-webpart-base!' summary: Indicates that the dynamic data source is shared. - numericValue: 1 + value: '1' diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index d27ff68d..f63d9402 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -4,16 +4,15 @@ uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' package: '@microsoft/sp-webpart-base!' fullName: IClientSideWebPartStatusRenderer summary: >- - Interface to be implemented by a component that should display the loading - indicator and error messages for a web part. + Interface to be implemented by a component that should display the loading indicator and error messages for a web + part. remarks: '' isPreview: false isDeprecated: false type: interface methods: - name: clearError(domElement) - uid: >- - @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1) + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' package: '@microsoft/sp-webpart-base!' fullName: clearError(domElement) summary: Clear the webpart error message. @@ -25,13 +24,12 @@ methods: parameters: - id: domElement description: the web part container div. - type: '' + type: HTMLElement return: type: void description: '' - name: clearLoadingIndicator(domElement) - uid: >- - @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1) + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' package: '@microsoft/sp-webpart-base!' fullName: clearLoadingIndicator(domElement) summary: Clear the loading indicator. @@ -43,13 +41,12 @@ methods: parameters: - id: domElement description: the web part container div. - type: '' + type: Element return: type: void description: '' - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - uid: >- - @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1) + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' package: '@microsoft/sp-webpart-base!' fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' summary: Display a loading spinner. @@ -57,13 +54,11 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - displayLoadingIndicator(domElement: Element, loadingMessage: string, - timeout?: number): void; + content: 'displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;' parameters: - id: domElement description: the web part container div. - type: '' + type: Element - id: loadingMessage description: the message to be displayed when the loading spinner id displayed. type: string @@ -74,8 +69,7 @@ methods: type: void description: '' - name: 'renderError(domElement, error)' - uid: >- - @microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1) + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' package: '@microsoft/sp-webpart-base!' fullName: 'renderError(domElement, error)' summary: Render the provided error message in the webpart container div. @@ -87,10 +81,10 @@ methods: parameters: - id: domElement description: the web part container div. - type: '' + type: HTMLElement - id: error description: the error message. - type: ' | string' + type: Error | string return: type: void description: '' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index 2c2c9e73..329cb804 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index d83c8bb9..7038ffc9 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 3121d67a..9d120d69 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index 34c2b338..0f5a6c3a 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index 1b35a99a..5f712358 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -3,9 +3,7 @@ name: IMicrosoftTeams uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' package: '@microsoft/sp-webpart-base!' fullName: IMicrosoftTeams -summary: >- - Provides access to the Teams SDK and Teams context. Only provided when the web - part is loaded in Teams. +summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. remarks: '' isPreview: false isDeprecated: false @@ -24,7 +22,7 @@ properties: syntax: content: 'context: microsoftTeams.Context;' return: - type: 'microsoftTeams.' + type: microsoftTeams.Context - name: teamsJs uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/ioffice.yml b/SP-Framework/sp-webpart-base/ioffice.yml index c0cfe174..9a6e6254 100644 --- a/SP-Framework/sp-webpart-base/ioffice.yml +++ b/SP-Framework/sp-webpart-base/ioffice.yml @@ -3,9 +3,7 @@ name: IOffice uid: '@microsoft/sp-webpart-base!IOffice:interface' package: '@microsoft/sp-webpart-base!' fullName: IOffice -summary: >- - Provides access to the Office context. Only provided when the web part is - loaded in Office. +summary: Provides access to the Office context. Only provided when the web part is loaded in Office. remarks: '' isPreview: true isDeprecated: false @@ -22,4 +20,4 @@ properties: syntax: content: 'context: Office.Context;' return: - type: '!Office.' + type: Office.Context diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 1124d56d..57247297 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -4,8 +4,8 @@ uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneAccessor summary: >- - Web part context property pane accessor interface. Provides some most commonly - used operations to access the property pane. + Web part context property pane accessor interface. Provides some most commonly used operations to access the property + pane. remarks: '' isPreview: false isDeprecated: false @@ -15,9 +15,7 @@ methods: uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' package: '@microsoft/sp-webpart-base!' fullName: close() - summary: >- - This API should be used to close the PropertyPane to help configure the - web part. + summary: This API should be used to close the PropertyPane to help configure the web part. remarks: '' isPreview: false isDeprecated: false @@ -27,8 +25,7 @@ methods: type: void description: '' - name: isPropertyPaneOpen() - uid: >- - @microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1) + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' package: '@microsoft/sp-webpart-base!' fullName: isPropertyPaneOpen() summary: Returns true if the PropertyPane is open. @@ -41,15 +38,13 @@ methods: type: boolean description: '' - name: isRenderedByWebPart() - uid: >- - @microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1) + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' package: '@microsoft/sp-webpart-base!' fullName: isRenderedByWebPart() summary: Indicates whether the PropertyPane was initially opened by the web part. remarks: >- - For example, if the web part calls this.context.propertyPane.open() then - the property would be true, whereas if the property pane was opened by the - host, then the value will be false. + For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if + the property pane was opened by the host, then the value will be false. isPreview: false isDeprecated: false syntax: @@ -61,9 +56,7 @@ methods: uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' package: '@microsoft/sp-webpart-base!' fullName: open() - summary: >- - This API should be used to open the PropertyPane to help configure the web - part. + summary: This API should be used to open the PropertyPane to help configure the web part. remarks: '' isPreview: false isDeprecated: false @@ -76,12 +69,8 @@ methods: uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' package: '@microsoft/sp-webpart-base!' fullName: openDetails(context) - summary: >- - This API should be used to open the Details PropertyPane to help configure - the items in the web part. - remarks: >- - This API is mainly used for configuring Details, which is different from - configuring the web part itself. + summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. + remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' isPreview: false isDeprecated: false syntax: @@ -97,13 +86,10 @@ methods: uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' package: '@microsoft/sp-webpart-base!' fullName: refresh() - summary: >- - This API should be used to invoke the PropertyPane to help configure the - web part. + summary: This API should be used to invoke the PropertyPane to help configure the web part. remarks: >- - This operation only works when the PropertyPane is already open for the - currently active web part. If the PropertyPane is opened for another web - part, calling the refresh API will have no impact. + This operation only works when the PropertyPane is already open for the currently active web part. If the + PropertyPane is opened for another web part, calling the refresh API will have no impact. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index c7737bd3..637c61b6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 4b48fc78..15f4f1c9 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 2f97c928..901e0d0d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index e02abad2..9c46073a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 5bddbc95..eb6e2630 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 7c3ab8d2..aa87620c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index fd7e3324..50e68764 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index b88ab675..8a4e6795 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 8544ffe2..1698c25b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 87661f2b..55b55a0c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 6146c446..e498e9bf 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 131e3702..801a0d6d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -3,16 +3,12 @@ name: IPropertyPaneDynamicFieldFilters uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldFilters -summary: >- - Property pane dynamic field filters which is an intersection of both source - and property filters. +summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index c1219575..8ef6657a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 49bc6720..0f4f5a27 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index f301bfcc..604db734 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -9,7 +9,4 @@ isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index fc714e54..2d12f503 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -8,10 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane.<TProperties> +extends: 'SPPropertyPane.<TProperties> ' diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index d8b8655a..3580a4d7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index 2e71886e..56fcf599 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index c82cbd36..3586c564 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index c1d86064..99075ef0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index e742b2d7..8744490a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index e84e4b5f..b186a02b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 79b26510..b3e88693 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 0a4eb471..59af9720 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -8,9 +8,7 @@ remarks: '' isPreview: false isDeprecated: true customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. type: interface -extends: >- - SPPropertyPane. +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index 72a9c1ec..e46b4775 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -14,8 +14,8 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: microsoftTeams summary: >- - Contextual information about the current Microsoft Teams tab. This object - will only be defined if a component is being hosted in Microsoft Teams. + Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is + being hosted in Microsoft Teams. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) @@ -30,8 +30,8 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: office summary: >- - Contextual information about the current Office app. This object will only - be defined if a component is being hosted in an Office app. + Contextual information about the current Office app. This object will only be defined if a component is being + hosted in an Office app. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office](https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office) diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index d4f47ee2..2172e665 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -4,9 +4,8 @@ uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' package: '@microsoft/sp-webpart-base!' fullName: ISerializedWebPartData summary: >- - This structure represents the part of the serialized state of a web part which - is controlled by the web part. It is extended by IWebPartData which contains - additional data added by the framework to the serialized data. + This structure represents the part of the serialized state of a web part which is controlled by the web part. It is + extended by IWebPartData which contains additional data added by the framework to the serialized data. remarks: '' isPreview: false isDeprecated: false @@ -18,11 +17,9 @@ properties: fullName: dataVersion summary: Web part data version. remarks: >- - Note that data version is different from the version field in the - manifest. The manifest version is used to control the versioning of the - web part code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web - part for more information. + Note that data version is different from the version field in the manifest. The manifest version is used to + control the versioning of the web part code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web part for more information. Supported values: MAJOR.MINOR @@ -39,27 +36,19 @@ properties: uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' package: '@microsoft/sp-webpart-base!' fullName: dynamicDataPaths - summary: >- - Paths for the dynamic data. This is used to reconstruct the dynamic data - objects when deserializing the web part. - remarks: >- - The key is the path within the web part properties, and the value is the - dynamic data internal id. - + summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data internal id. Example: - ``` - { 'pageContextUser': 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } - - ``` isPreview: true isDeprecated: false @@ -78,24 +67,18 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: dynamicDataValues summary: >- - Static values for the dynamic data. This is used to reconstruct the - dynamic data objects when deserializing the web part. - remarks: >- - The key is the path within the web part properties, and the value is the - dynamic data static value. - + Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the + web part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data static value. Example: - ``` - { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true } - - ``` isPreview: true isDeprecated: false @@ -113,12 +96,10 @@ properties: uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' package: '@microsoft/sp-webpart-base!' fullName: properties - summary: >- - Web part specific properties. The individual web part owns the definition - of these properties. + summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- - Used by the web part to manage its internal metadata and config data. The - framework code never touches these properties. + Used by the web part to manage its internal metadata and config data. The framework code never touches these + properties. Supported values: any JSON stringifiable object hierarchy. @@ -132,20 +113,14 @@ properties: return: type: any - name: serverProcessedContent - uid: >- - @microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' package: '@microsoft/sp-webpart-base!' fullName: serverProcessedContent - summary: >- - The collections of data that can be processed by server side services like - search index and link fixup. + summary: The collections of data that can be processed by server side services like search index and link fixup. remarks: '' isPreview: false isDeprecated: false syntax: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: - type: >- - + type: '' diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index b2c08138..74f61587 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -5,17 +5,14 @@ package: '@microsoft/sp-webpart-base!' fullName: IWebPartContext summary: The base context interface for client-side web parts. remarks: >- - A "context" object is a collection of well-known services and other objects - that are likely to be needed by any business logic working with a component. - Each component type has its own specialized extension of this interface, e.g. - IWebPartContext for web parts, IExtensionContext for client-side extensions, - etc. + A "context" object is a collection of well-known services and other objects that are likely to be needed by any + business logic working with a component. Each component type has its own specialized extension of this interface, e.g. + IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. isPreview: false isDeprecated: true customDeprecatedMessage: >- - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class - instead. + [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. type: interface properties: - name: domElement @@ -29,7 +26,7 @@ properties: syntax: content: 'readonly domElement: HTMLElement;' return: - type: '' + type: HTMLElement - name: httpClient uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' package: '@microsoft/sp-webpart-base!' @@ -65,10 +62,7 @@ properties: syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: >- - <any> + type: '<any>' - name: pageContext uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' package: '@microsoft/sp-webpart-base!' @@ -92,9 +86,7 @@ properties: syntax: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: - type: >- - + type: '' - name: spHttpClient uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 187c84d5..9f92f211 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -5,9 +5,8 @@ package: '@microsoft/sp-webpart-base!' fullName: IWebPartData summary: This structure represents the serialized state of a web part. remarks: >- - When the `serialize()` API is called on a web part, the output should be this - structure. The structure of the 'properties' field is owned by the web part - and is specific to the web part. Each web part can decide the set of + When the `serialize()` API is called on a web part, the output should be this structure. The structure of the + 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize. isPreview: false isDeprecated: false @@ -19,11 +18,9 @@ properties: fullName: dataVersion summary: Web part data version remarks: >- - Note that data version is different from the version field in the - manifest. The manifest version is used to control the versioning of the - web part code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web - part for more information. + Note that data version is different from the version field in the manifest. The manifest version is used to + control the versioning of the web part code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web part for more information. Supported values: MAJOR.MINOR @@ -59,9 +56,8 @@ properties: fullName: dynamicDataPaths summary: Paths for the dynamic data. remarks: >- - This is used to reconstruct the dynamic data objects when deserializing - the web part. The key is the path within the web part properties, and the - value is the dynamic data internal id. + This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within + the web part properties, and the value is the dynamic data internal id. Example: @@ -76,7 +72,6 @@ properties: 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } - ``` isPreview: true isDeprecated: false @@ -95,24 +90,18 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: dynamicDataValues summary: >- - Static values for the dynamic data.This is used to reconstruct the dynamic - data objects when deserializing the web part. - remarks: >- - The key is the path within the web part properties, and the value is the - dynamic data static value. - + Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web + part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data static value. Example: - ``` - { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true } - - ``` isPreview: true isDeprecated: false @@ -143,13 +132,10 @@ properties: package: '@microsoft/sp-webpart-base!' fullName: instanceId summary: >- - Universally unique instance id of the web part. A web part can have - multiple instances on a page. This id is expected to be universally unique - across time and page boundaries. - remarks: >- - supported values: a unique string. Could be GUID or other uniquely - identifiable formats. - + Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is + expected to be universally unique across time and page boundaries. + remarks: |- + supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` isPreview: false @@ -162,16 +148,13 @@ properties: uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' package: '@microsoft/sp-webpart-base!' fullName: properties - summary: >- - Web part specific properties. The individual web part owns the definition - of these properties. + summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- - Used by the web part to manage its internal metadata and config data. The - framework code never touches these properties. + Used by the web part to manage its internal metadata and config data. The framework code never touches these + properties. - Supported values: any object hierarchy that can be serialized using - `JSON.stringify()`. + Supported values: any object hierarchy that can be serialized using `JSON.stringify()`. Example: `{ 'value': 'text value' }` @@ -185,32 +168,24 @@ properties: uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' package: '@microsoft/sp-webpart-base!' fullName: serverProcessedContent - summary: >- - The collections of data that can be processed by server side services like - search index and link fixup + summary: The collections of data that can be processed by server side services like search index and link fixup remarks: '' isPreview: false isDeprecated: false syntax: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: - type: >- - + type: '' - name: title uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' package: '@microsoft/sp-webpart-base!' fullName: title summary: Web part title - remarks: >- - Used to display the name of the web part in the toolbox, web part gallery - and the page. - + remarks: |- + Used to display the name of the web part in the toolbox, web part gallery and the page. Supported values: string less than 100 characters - Example: `"Text"` isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 363d133e..def7cef8 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -3,12 +3,9 @@ name: IWebPartPropertiesMetadata uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' package: '@microsoft/sp-webpart-base!' fullName: IWebPartPropertiesMetadata -summary: >- - This structure is used to define metadata for web part properties as a map of - string to `IWebPartPropertyMetadata` +summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` remarks: >- - The key should be a JSON path to the property in web part properties. The JSON - path supports the following operators: + The key should be a JSON path to the property in web part properties. The JSON path supports the following operators: - Dot `.` for selecting object members, for example `person.name` @@ -17,19 +14,16 @@ remarks: >- - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` - - Bracketed asterisk `[*]` for array elements wildcard, for example - `person.websites[*]`. + - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. - You can make combinations of these operators, for example - `person.websites[*].url` + You can make combinations of these operators, for example `person.websites[*].url` Important Note: Only one wildcard per path is supported. - Example: Let's assume we have a web part with properties that have the - following schema: + Example: Let's assume we have a web part with properties that have the following schema: ``` @@ -44,7 +38,6 @@ remarks: >- } } - ``` We can define the metadata for the desired properties as following: @@ -58,12 +51,10 @@ remarks: >- 'person.websites[*].url': { isLink: true } } - ``` - This will make SharePoint servers aware of the content of your properties and - run services such as search indexing, link fix-up, etc on the data. In case - any of the values needs to update by these services, e.g link fix-up, the web + This will make SharePoint servers aware of the content of your properties and run services such as search indexing, + link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated. isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index b7a4f5d4..2e4804b3 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -10,152 +10,28 @@ isDeprecated: false type: interface properties: - name: dynamicPropertyType - uid: >- - @microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' package: '@microsoft/sp-webpart-base!' fullName: dynamicPropertyType - summary: >- - If specified, indicates that the property is a dynamic property and the - type of the dynamic property. + summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' remarks: >- - If a web part has properties that are dynamically configurable, then use - this flag to declare the property as a dynamic property by specifying its - type. When a property specifies its dynamic property type, then the - framework ensures that its value can be accessed using 'tryGetValue' - anytime in the life cycle of the web part. If a property is marked as - DynamicProperty in the IWebPartProperties interface, but does not appear - in the IWebPartPropertiesMetadata with a dynamicPropertyType, then the web - part developer will need to manually create the DynamicProperty themselves - and assign it to the property. + If a web part has properties that are dynamically configurable, then use this flag to declare the property as a + dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework + ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a + property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the + IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create + the DynamicProperty themselves and assign it to the property. - A web part can configure a default value for the property by specifying it - in the properties section of the web part's manifest. This value will be - used when a dynamic property is constructed for the property. + A web part can configure a default value for the property by specifying it in the properties section of the web + part's manifest. This value will be used when a dynamic property is constructed for the property. - Note: Web parts should be able to type cast the resultant value from the - `tryGetValue` to suit their needs. + Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. isPreview: false isDeprecated: false syntax: - content: >- - dynamicPropertyType?: 'boolean' | 'number' | 'string' | 'array' | - 'object'; + content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' return: type: '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' - - name: isHtmlString - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isHtmlString:member' - package: '@microsoft/sp-webpart-base!' - fullName: isHtmlString - summary: Indicates whether the property should be serialized as HTML. - remarks: >- - This flag instructs framework to store the value as HTML, so that - SharePoint can perform the following services on it: - - - - normalizing HTML encodings - - - - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) - - - - search indexing - - - - SharePoint link fix-up - - - Only enable this flag for HTML content where these modifications are - acceptable. If non-HTML content is provided, SharePoint framework might - make modifications to convert it to HTML valid. For plain text content - that simply needs to be exposed to the search index (without any - rewriting), use the `isSearchablePlainText` flag instead. - isPreview: false - isDeprecated: false - syntax: - content: 'isHtmlString?: boolean;' - return: - type: boolean - - name: isImageSource - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isImageSource:member' - package: '@microsoft/sp-webpart-base!' - fullName: isImageSource - summary: >- - Indicates if the property contains a link. This allows SharePoint server - to treat the value as such and perform services like link fix-up, search - indexing, loading from CDN, etc. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isImageSource?: boolean;' - return: - type: boolean - - name: isLink - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#isLink:member' - package: '@microsoft/sp-webpart-base!' - fullName: isLink - summary: >- - Indicates if the property contains a link. This allows SharePoint server - to treat the value as such and perform services like search indexing, link - fix-up, loading from CDN, etc. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isLink?: boolean;' - return: - type: boolean - - name: isSearchablePlainText - uid: >- - @microsoft/sp-webpart-base!IWebPartPropertyMetadata#isSearchablePlainText:member - package: '@microsoft/sp-webpart-base!' - fullName: isSearchablePlainText - summary: >- - Indicates if the property contains plain text that should be - search-indexed by SharePoint. - remarks: >- - This flag instructs the framework to store the property in a - representation that supports search indexing. The content will be treated - as plain text; SharePoint will not modify the string in any way, and - special HTML characters may be stored encoded and appear in search - results. If your string contains HTML markup, use the isHtmlString setting - instead. - - - Security note: For security reasons, never assign a plain text string to - `Element.innerHTML`. - isPreview: false - isDeprecated: false - syntax: - content: 'isSearchablePlainText?: boolean;' - return: - type: boolean - - name: shouldNotPersist - uid: >- - @microsoft/sp-webpart-base!IWebPartPropertyMetadata#shouldNotPersist:member - package: '@microsoft/sp-webpart-base!' - fullName: shouldNotPersist - summary: Indicates if the framework should persist the property on the server. - remarks: >- - Use this for properties that are only important in run-time, and do not - need to persist on the server. This can reduce the size of the serialized - data of the web part and optimize the web part load time. The property - value will be removed from the serialized data sent to the server, but - this has no effect on the run-time property bag. The property value will - still be available in the `onBeforeSerialize()` method, and the value will - not be cleared from the run-time property bag. The initial render of your - web part should not depend on the value of the property. Setting a default - value for the property can be done in `onInit()` method. - - - Note that if the property path refers to a property that has a complex - object as the value, the whole object will be removed from the persisted - data. - isPreview: false - isDeprecated: false - syntax: - content: 'shouldNotPersist?: boolean;' - return: - type: boolean +extends: '' diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 9f05bfe3..eee5d3d8 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -7,39 +7,37 @@ summary: Enum for all the supported button types. remarks: '' isPreview: false isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This enum has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. fields: - name: Command uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' package: '@microsoft/sp-webpart-base!' summary: Optional actions. - numericValue: 4 + value: '4' - name: Compound uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' package: '@microsoft/sp-webpart-base!' summary: Always used as a set with both Standard and Primary compound buttons. - numericValue: 3 + value: '3' - name: Hero uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' package: '@microsoft/sp-webpart-base!' summary: Hero button. - numericValue: 2 + value: '2' - name: Icon uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' package: '@microsoft/sp-webpart-base!' summary: >- - Same usage as Command button, when real estate does not allow for icons + - labels or as secondary actions within the command bar. - numericValue: 5 + Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within + the command bar. + value: '5' - name: Normal uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' package: '@microsoft/sp-webpart-base!' summary: Optional completion action. - numericValue: 0 + value: '0' - name: Primary uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' package: '@microsoft/sp-webpart-base!' summary: Preferred completion action when paired with a Standard button. - numericValue: 1 + value: '1' diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index d821ea25..40aaeaa6 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -5,27 +5,24 @@ package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneDropdownOptionType summary: >- Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). + [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). remarks: '' isPreview: false isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This enum has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. fields: - name: Divider uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' package: '@microsoft/sp-webpart-base!' summary: Render a divider. - numericValue: 1 + value: '1' - name: Header uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' package: '@microsoft/sp-webpart-base!' summary: Render menu item as a header. - numericValue: 2 + value: '2' - name: Normal uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' package: '@microsoft/sp-webpart-base!' summary: Render normal menu item. - numericValue: 0 + value: '0' diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 084a3e0d..0182cebe 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -3,91 +3,87 @@ name: PropertyPaneFieldType uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneFieldType -summary: >- +summary: |- Enum for all the supported PropertyPane field types. - - Names should be consistent with those in office-ui-fabric-react, be careful to - get letter casing correct. + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' isPreview: false isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This enum has been moved to - `@microsoft/sp-property-pane`. Please consume it from there. +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. fields: - name: Button uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' package: '@microsoft/sp-webpart-base!' summary: Button field. - numericValue: 11 + value: '11' - name: CheckBox uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' package: '@microsoft/sp-webpart-base!' summary: Checkbox field. - numericValue: 2 + value: '2' - name: ChoiceGroup uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' package: '@microsoft/sp-webpart-base!' summary: Choice Group field. - numericValue: 10 + value: '10' - name: Custom uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' package: '@microsoft/sp-webpart-base!' summary: Custom field. - numericValue: 1 + value: '1' - name: Dropdown uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' package: '@microsoft/sp-webpart-base!' summary: Dropdown field. - numericValue: 6 + value: '6' - name: DynamicField uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' package: '@microsoft/sp-webpart-base!' summary: Dynamic data field. - numericValue: 14 + value: '14' - name: DynamicFieldSet uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' package: '@microsoft/sp-webpart-base!' summary: A set of dynamic fields. - numericValue: 16 + value: '16' - name: DynamicTextField uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' package: '@microsoft/sp-webpart-base!' summary: Dynamic Text Field - numericValue: 15 + value: '15' - name: Heading uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' package: '@microsoft/sp-webpart-base!' summary: Heading field. - numericValue: 9 + value: '9' - name: HorizontalRule uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' package: '@microsoft/sp-webpart-base!' summary: Horizontal Rule field. - numericValue: 12 + value: '12' - name: Label uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' package: '@microsoft/sp-webpart-base!' summary: Label field. - numericValue: 7 + value: '7' - name: Link uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' package: '@microsoft/sp-webpart-base!' summary: Link field. - numericValue: 13 + value: '13' - name: Slider uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' package: '@microsoft/sp-webpart-base!' summary: Slider field. - numericValue: 8 + value: '8' - name: TextField uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' package: '@microsoft/sp-webpart-base!' summary: TextField field. - numericValue: 3 + value: '3' - name: Toggle uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' package: '@microsoft/sp-webpart-base!' summary: Toggle field. - numericValue: 5 + value: '5' diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 60c89ff1..950eeb2f 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -4,12 +4,11 @@ uid: '@microsoft/sp-webpart-base!WebPartContext:class' package: '@microsoft/sp-webpart-base!' fullName: WebPartContext summary: >- - Web part context object. This object contains the contextual services - available to a web part. e.g. a contextual instance to the http client. + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. remarks: >- - The constructor for this class is marked as internal. Third-party code should - not call the constructor directly or create subclasses that extend the - `WebPartContext` class. + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `WebPartContext` class. isPreview: false isDeprecated: false type: class @@ -23,16 +22,16 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly domElement: HTMLElement;' + content: 'get domElement(): HTMLElement;' return: - type: '' + type: HTMLElement - name: microsoftTeams uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' package: '@microsoft/sp-webpart-base!' fullName: microsoftTeams summary: >- - Contextual information about the current Microsoft Teams tab. This object - will only be defined if a component is being hosted in Microsoft Teams. + Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is + being hosted in Microsoft Teams. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) @@ -40,7 +39,7 @@ properties: isDeprecated: true customDeprecatedMessage: '- This function has been deprecated' syntax: - content: 'readonly microsoftTeams: typeof microsoftTeams | undefined;' + content: 'get microsoftTeams(): typeof microsoftTeams | undefined;' return: type: typeof microsoftTeams | undefined - name: sdks @@ -52,7 +51,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly sdks: ISDKs;' + content: 'get sdks(): ISDKs;' return: type: '' - name: statusRenderer @@ -64,7 +63,21 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' + content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;' return: type: '' + - name: widthCacheKey + uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' + package: '@microsoft/sp-webpart-base!' + fullName: widthCacheKey + summary: >- + This functions returns a key generated by web parts display mode, layout index, and section factor. It will return + undefined if sectionFactor or display mode is undefined, else return the cache key. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get widthCacheKey(): string | undefined;' + return: + type: string | undefined extends: '' diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index 5565cf60..07cdb15b 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -4,6 +4,95 @@ items: items: - name: decorators uid: '@microsoft/decorators!' + - name: office-ui-fabric-react-bundle + uid: '@microsoft/office-ui-fabric-react-bundle!' + - name: sp-adaptive-card-extension-base + uid: '@microsoft/sp-adaptive-card-extension-base!' + items: + - name: AdaptiveCardExtensionContext + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - name: BaseAdaptiveCardExtension + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + - name: BaseAdaptiveCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + - name: BaseBasicCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + - name: BaseCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + - name: BaseImageCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + - name: BasePrimaryTextCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + - name: BaseView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + - name: IAdaptiveCardExtensionPropertiesMetadata + uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + - name: IAdaptiveCardExtensionPropertyMetadata + uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + - name: IBaseActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + - name: IBaseCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + - name: IBasicCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + - name: ICardButton + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + - name: IConfirmationDialog + uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + - name: IExternalLinkCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + - name: IExternalLinkParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + - name: IGetLocationAction + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + - name: IGetLocationActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + - name: IGetLocationActionParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - name: IGetLocationCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + - name: IImageCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + - name: ILocation + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - name: IPrimaryTextCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + - name: IQuickViewCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + - name: IQuickViewParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + - name: ISelectMediaAction + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + - name: ISelectMediaActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + - name: ISelectMediaActionParameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - name: ISelectMediaAttachment + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + - name: ISelectMediaCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + - name: IShowCardActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + - name: IShowLocationAction + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + - name: IShowLocationActionParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - name: IShowLocationCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + - name: ISPFxAdaptiveCard + uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + - name: ISubmitActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + - name: ISubmitCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + - name: ISubmitCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + - name: MediaType + uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + - name: QuickViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + - name: ViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' - name: sp-application-base uid: '@microsoft/sp-application-base!' items: @@ -34,20 +123,14 @@ items: uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' - name: DynamicProperty uid: '@microsoft/sp-component-base!DynamicProperty:class' - - name: IFontStyles - uid: '@microsoft/sp-component-base!IFontStyles:interface' - - name: IPalette - uid: '@microsoft/sp-component-base!IPalette:interface' - - name: IRawStyle - uid: '@microsoft/sp-component-base!IRawStyle:interface' + - name: IComponentPropertyMetadata + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' - name: IReadonlyFontStyles uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - name: IReadonlyTheme uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - - name: ISemanticColors - uid: '@microsoft/sp-component-base!ISemanticColors:interface' - - name: ISemanticTextColors - uid: '@microsoft/sp-component-base!ISemanticTextColors:interface' + - name: ISerializedServerProcessedData + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' - name: ITheme uid: '@microsoft/sp-component-base!ITheme:interface' - name: ThemeChangedEventArgs @@ -89,8 +172,8 @@ items: uid: '@microsoft/sp-core-library!SPEvent:class' - name: SPEventArgs uid: '@microsoft/sp-core-library!SPEventArgs:class' - - name: Text - uid: '@microsoft/sp-core-library!Text:class' + - name: Text_2 + uid: '@microsoft/sp-core-library!Text_2:class' - name: TimeProvider uid: '@microsoft/sp-core-library!TimeProvider:class' - name: UrlQueryParameterCollection @@ -157,10 +240,14 @@ items: uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' - name: AadHttpClientFactory uid: '@microsoft/sp-http!AadHttpClientFactory:class' + - name: AadHttpClientResponse + uid: '@microsoft/sp-http!AadHttpClientResponse:class' - name: AadTokenProvider uid: '@microsoft/sp-http!AadTokenProvider:class' - name: AadTokenProviderFactory uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + - name: BeforeRedirectEventArgs + uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' - name: DigestCache uid: '@microsoft/sp-http!DigestCache:class' - name: GraphRequest @@ -181,6 +268,8 @@ items: uid: '@microsoft/sp-http!IAadTokenProvider:interface' - name: IAadTokenProviderConfiguration uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - name: IBeforeRedirectEventArgs + uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' - name: IDigestCache uid: '@microsoft/sp-http!IDigestCache:interface' - name: IHttpClientConfiguration @@ -229,6 +318,13 @@ items: uid: '@microsoft/sp-http!SPHttpHeader:enum' - name: TokenAcquisitionEventArgs uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + - name: sp-image-helper + uid: '@microsoft/sp-image-helper!' + items: + - name: IImageHelperRequest + uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' + - name: ImageHelper + uid: '@microsoft/sp-image-helper!ImageHelper:class' - name: sp-list-subscription uid: '@microsoft/sp-list-subscription!' items: @@ -281,6 +377,10 @@ items: - name: sp-module-interfaces uid: '@microsoft/sp-module-interfaces!' items: + - name: IAdaptiveCardExtensionManifest + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + - name: IAdaptiveCardExtensionManifestEntry + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' - name: IClientSideAssemblyManifest uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - name: IClientSideComponentLoaderConfiguration @@ -353,8 +453,6 @@ items: uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' - name: PageContext uid: '@microsoft/sp-page-context!PageContext:class' - - name: SPDayOfWeek - uid: '@microsoft/sp-page-context!SPDayOfWeek:enum' - name: SPField uid: '@microsoft/sp-page-context!SPField:class' - name: SPList @@ -530,8 +628,6 @@ items: uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - name: ISDKs uid: '@microsoft/sp-webpart-base!ISDKs:interface' - - name: ISerializedServerProcessedData - uid: '@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface' - name: ISerializedWebPartData uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - name: IWebPartContext @@ -550,5 +646,3 @@ items: uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - name: WebPartContext uid: '@microsoft/sp-webpart-base!WebPartContext:class' - - name: WebPartFormFactor - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' From 54010a94c9818a3e097cb489c237bba1d8b17b9b Mon Sep 17 00:00:00 2001 From: VesaJuvonen Date: Wed, 10 Nov 2021 20:39:06 +0200 Subject: [PATCH 46/55] Updating API overview file --- SP-Framework/overview/sharepoint.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/SP-Framework/overview/sharepoint.md b/SP-Framework/overview/sharepoint.md index f21b44a9..20451f07 100644 --- a/SP-Framework/overview/sharepoint.md +++ b/SP-Framework/overview/sharepoint.md @@ -1,16 +1,20 @@ --- title: SharePoint Framework TypeScript Reference description: The SharePoint Framework object model is built in TypeScript. -ms.date: 01/17/2020 +ms.date: 11/9/2021 ms.prod: sharepoint --- # SharePoint Framework Reference +SharePoint Framework is extensibility model for Microsoft Teams, Microsoft Viva and SharePoint. See more details from the [SharePoint Framework overview documentation](https://aka.ms/spfx). + The SharePoint Framework object model is built in TypeScript. Use this section to learn more about the classes, methods, and other types available for building your SharePoint Framework solutions. ## See also - [Overview of SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) - [Getting started with SharePoint Framework web parts](https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) -- [Getting started with SharePoint Framework Extensions](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/build-a-hello-world-extension) \ No newline at end of file +- [Getting started with SharePoint Framework Extensions](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/build-a-hello-world-extension) +- [Overview of Viva Connections Extensibility](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/viva/overview-viva-connections) +- [Build for Microsoft Teams using SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview) \ No newline at end of file From 91422342e80c5ddcd4c7fd387b8535a38909dc4a Mon Sep 17 00:00:00 2001 From: John Nguyen Date: Fri, 10 Dec 2021 15:37:22 -0800 Subject: [PATCH 47/55] Update for 1.14.0-beta.4 --- SP-Framework/decorators.yml | 162 +-- .../office-ui-fabric-react-bundle.yml | 36 +- .../sp-adaptive-card-extension-base.yml | 102 +- .../adaptivecardextensioncontext.yml | 100 +- .../baseadaptivecardextension.yml | 1103 +++++++++-------- .../baseadaptivecardview.yml | 140 +-- .../basebasiccardview.yml | 64 +- .../basecardview.yml | 156 +-- .../baseimagecardview.yml | 64 +- .../baseprimarytextcardview.yml | 64 +- .../baseview.yml | 384 +++--- ...daptivecardextensionpropertiesmetadata.yml | 24 +- ...iadaptivecardextensionpropertymetadata.yml | 22 +- .../ibaseactionarguments.yml | 80 +- .../ibasecardparameters.yml | 94 +- .../ibasiccardparameters.yml | 52 +- .../icachedloadparameters.yml | 35 + .../icachesettings.yml | 49 + .../icardbutton.yml | 118 +- .../iconfirmationdialog.yml | 70 +- .../iexternallinkcardaction.yml | 70 +- .../iexternallinkparameters.yml | 70 +- .../igetlocationaction.yml | 72 +- .../igetlocationactionarguments.yml | 78 +- .../igetlocationactionparameters.yml | 46 +- .../igetlocationcardaction.yml | 70 +- .../iimagecardparameters.yml | 76 +- .../ilocation.yml | 118 +- .../iprimarytextcardparameters.yml | 76 +- .../iquickviewcardaction.yml | 70 +- .../iquickviewparameters.yml | 46 +- .../iselectmediaaction.yml | 72 +- .../iselectmediaactionarguments.yml | 78 +- .../iselectmediaactionparameters.yml | 118 +- .../iselectmediaattachment.yml | 70 +- .../iselectmediacardaction.yml | 70 +- .../ishowcardactionarguments.yml | 54 +- .../ishowlocationaction.yml | 72 +- .../ishowlocationactionparameters.yml | 46 +- .../ishowlocationcardaction.yml | 70 +- .../ispfxadaptivecard.yml | 22 +- .../isubmitactionarguments.yml | 78 +- .../isubmitcardaction.yml | 94 +- .../isubmitcardparameters.yml | 20 +- .../mediatype.yml | 40 +- .../quickviewnavigator.yml | 60 +- .../viewnavigator.yml | 296 ++--- SP-Framework/sp-application-base.yml | 30 +- .../applicationaccessor.yml | 114 +- .../applicationcustomizercontext.yml | 112 +- .../baseapplicationcustomizer.yml | 132 +- .../iplaceholdercreatecontentoptions.yml | 58 +- .../placeholdercontent.yml | 178 +-- .../sp-application-base/placeholdername.yml | 48 +- .../placeholderprovider.yml | 224 ++-- SP-Framework/sp-component-base.yml | 38 +- .../sp-component-base/basecomponent.yml | 228 ++-- .../basecomponentcontext.yml | 374 +++--- .../sp-component-base/dynamicdataprovider.yml | 382 +++--- .../dynamicdatasourcemanager.yml | 260 ++-- .../sp-component-base/dynamicproperty.yml | 452 +++---- .../icomponentpropertymetadata.yml | 222 ++-- .../sp-component-base/ireadonlyfontstyles.yml | 22 +- .../sp-component-base/ireadonlytheme.yml | 22 +- .../iserializedserverprocesseddata.yml | 266 ++-- SP-Framework/sp-component-base/itheme.yml | 22 +- .../themechangedeventargs.yml | 48 +- .../sp-component-base/themeprovider.yml | 148 +-- SP-Framework/sp-core-library.yml | 58 +- SP-Framework/sp-core-library/displaymode.yml | 48 +- SP-Framework/sp-core-library/environment.yml | 46 +- .../sp-core-library/environmenttype.yml | 84 +- SP-Framework/sp-core-library/guid.yml | 310 ++--- SP-Framework/sp-core-library/idisposable.yml | 78 +- .../irandomnumbergenerator.yml | 62 +- .../sp-core-library/iservicecollection.yml | 52 +- .../sp-core-library/ispeventobserver.yml | 84 +- .../sp-core-library/itimeprovider.yml | 82 +- SP-Framework/sp-core-library/log.yml | 244 ++-- .../sp-core-library/randomnumbergenerator.yml | 114 +- SP-Framework/sp-core-library/servicekey.yml | 240 ++-- SP-Framework/sp-core-library/servicescope.yml | 492 ++++---- SP-Framework/sp-core-library/session.yml | 130 +- SP-Framework/sp-core-library/spevent.yml | 148 +-- SP-Framework/sp-core-library/speventargs.yml | 20 +- SP-Framework/sp-core-library/text_2.yml | 126 +- SP-Framework/sp-core-library/timeprovider.yml | 138 +-- .../urlqueryparametercollection.yml | 188 +-- SP-Framework/sp-core-library/validate.yml | 188 +-- SP-Framework/sp-core-library/version.yml | 546 ++++---- SP-Framework/sp-diagnostics.yml | 14 +- SP-Framework/sp-dialog.yml | 28 +- SP-Framework/sp-dialog/basedialog.yml | 446 +++---- SP-Framework/sp-dialog/dialog.yml | 122 +- SP-Framework/sp-dialog/ialertoptions.yml | 22 +- .../sp-dialog/idialogconfiguration.yml | 46 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 56 +- SP-Framework/sp-dialog/ipromptoptions.yml | 48 +- .../sp-dialog/isecondarydialogprovider.yml | 188 +-- SP-Framework/sp-dynamic-data.yml | 34 +- .../sp-dynamic-data/dynamicdatareference.yml | 158 +-- .../idynamicdataannotatedpropertyvalue.yml | 74 +- .../sp-dynamic-data/idynamicdatacallables.yml | 210 ++-- .../idynamicdataeventdefinition.yml | 76 +- .../idynamicdatapropertydefinition.yml | 56 +- .../idynamicdatapropertymetadata.yml | 78 +- .../idynamicdatapropertyvaluemetadata.yml | 48 +- ...micdatapropertyvaluemetadatacollection.yml | 158 +-- .../sp-dynamic-data/idynamicdatasource.yml | 388 +++--- .../idynamicdatasourcemetadata.yml | 160 +-- SP-Framework/sp-extension-base.yml | 16 +- .../sp-extension-base/baseextension.yml | 116 +- .../sp-extension-base/extensioncontext.yml | 26 +- SP-Framework/sp-http.yml | 100 +- SP-Framework/sp-http/aadhttpclient.yml | 268 ++-- .../sp-http/aadhttpclientconfiguration.yml | 136 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 98 +- .../sp-http/aadhttpclientresponse.yml | 62 +- SP-Framework/sp-http/aadtokenprovider.yml | 150 +-- .../sp-http/aadtokenproviderfactory.yml | 82 +- .../sp-http/beforeredirecteventargs.yml | 108 +- SP-Framework/sp-http/digestcache.yml | 264 ++-- SP-Framework/sp-http/graphrequest.yml | 1084 ++++++++-------- SP-Framework/sp-http/httpclient.yml | 298 ++--- .../sp-http/httpclientconfiguration.yml | 164 +-- SP-Framework/sp-http/httpclientresponse.yml | 386 +++--- .../sp-http/iaadhttpclientconfiguration.yml | 22 +- .../sp-http/iaadhttpclientconfigurations.yml | 58 +- .../sp-http/iaadhttpclientoptions.yml | 98 +- SP-Framework/sp-http/iaadtokenprovider.yml | 146 +-- .../iaadtokenproviderconfiguration.yml | 234 ++-- .../sp-http/ibeforeredirecteventargs.yml | 72 +- SP-Framework/sp-http/idigestcache.yml | 204 +-- .../sp-http/ihttpclientconfiguration.yml | 20 +- .../sp-http/ihttpclientconfigurations.yml | 58 +- SP-Framework/sp-http/ihttpclientoptions.yml | 26 +- .../isphttpclientbatchconfiguration.yml | 22 +- .../isphttpclientbatchconfigurations.yml | 54 +- .../isphttpclientbatchcreationoptions.yml | 54 +- .../sp-http/isphttpclientbatchoptions.yml | 26 +- .../isphttpclientcommonconfiguration.yml | 108 +- .../sp-http/isphttpclientconfiguration.yml | 136 +- .../sp-http/isphttpclientconfigurations.yml | 64 +- SP-Framework/sp-http/isphttpclientoptions.yml | 62 +- .../sp-http/itokenacquisitioneventargs.yml | 72 +- SP-Framework/sp-http/msgraphclient.yml | 98 +- SP-Framework/sp-http/msgraphclientfactory.yml | 90 +- SP-Framework/sp-http/odataversion.yml | 136 +- SP-Framework/sp-http/sphttpclient.yml | 488 ++++---- SP-Framework/sp-http/sphttpclientbatch.yml | 312 ++--- .../sphttpclientbatchconfiguration.yml | 166 +-- .../sphttpclientcommonconfiguration.yml | 242 ++-- .../sp-http/sphttpclientconfiguration.yml | 278 ++--- SP-Framework/sp-http/sphttpclientresponse.yml | 122 +- SP-Framework/sp-http/sphttpheader.yml | 36 +- .../sp-http/tokenacquisitioneventargs.yml | 108 +- SP-Framework/sp-image-helper.yml | 18 +- .../sp-image-helper/iimagehelperrequest.yml | 100 +- SP-Framework/sp-image-helper/imagehelper.yml | 68 +- SP-Framework/sp-list-subscription.yml | 22 +- .../icreatesubscriptionsettings.yml | 164 +-- .../ilistsubscription.yml | 46 +- .../isubscriptioncallbacks.yml | 94 +- .../listsubscriptionfactory.yml | 124 +- SP-Framework/sp-listview-extensibility.yml | 40 +- .../basefieldcustomizer.yml | 134 +- .../baselistviewcommandset.yml | 178 ++- .../columnaccessor.yml | 88 +- .../sp-listview-extensibility/command.yml | 176 +-- .../fieldcustomizercontext.yml | 88 +- .../ifieldcustomizercelleventparameters.yml | 128 +- ...stviewcommandsetexecuteeventparameters.yml | 78 +- ...iewcommandsetlistviewupdatedparameters.yml | 50 +- .../listitemaccessor.yml | 156 +-- .../listviewaccessor.yml | 120 +- .../listviewcommandsetcontext.yml | 76 +- .../sp-listview-extensibility/rowaccessor.yml | 42 +- .../selectedrowschangedeventargs.yml | 48 +- SP-Framework/sp-loader.yml | 18 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 46 +- SP-Framework/sp-loader/spcomponentloader.yml | 210 ++-- SP-Framework/sp-lodash-subset.yml | 10 +- SP-Framework/sp-module-interfaces.yml | 54 +- .../iadaptivecardextensionmanifest.yml | 342 ++--- .../iadaptivecardextensionmanifestentry.yml | 474 +++---- .../iclientsideassemblymanifest.yml | 54 +- ...clientsidecomponentloaderconfiguration.yml | 314 ++--- .../iclientsidecomponentmanifest.yml | 334 ++--- .../iclientsideextensionmanifest.yml | 52 +- .../iclientsidelibrarymanifest.yml | 22 +- .../iclientsidemanifestbase.yml | 122 +- .../iclientsidewebpartmanifest.yml | 340 ++--- .../iclientsidewebpartmanifestentry.yml | 514 ++++---- .../iclientsidewebpartmanifestinstance.yml | 22 +- .../icommanddefinition.yml | 140 +-- .../icommandsetextensionmanifest.yml | 96 +- .../icomponentmoduleconfiguration.yml | 138 +-- .../ilocalizedpathmoduleconfiguration.yml | 164 +-- .../sp-module-interfaces/ilocalizedstring.yml | 152 +-- .../imoduleconfiguration.yml | 108 +- SP-Framework/sp-module-interfaces/ipath.yml | 106 +- .../ipathmoduleconfiguration.yml | 188 +-- .../sp-module-interfaces/predefinedgroup.yml | 136 +- SP-Framework/sp-odata-types.yml | 34 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 74 +- .../sp-odata-types/iodatabasepermission.yml | 70 +- .../sp-odata-types/iodatachangetoken.yml | 50 +- .../iodatacontextwebinformation.yml | 122 +- SP-Framework/sp-odata-types/iodatalist.yml | 342 ++--- .../sp-odata-types/iodatalistitem.yml | 134 +- .../sp-odata-types/iodatanavigationnode.yml | 202 +-- .../iodatanavigationnodecollection.yml | 74 +- SP-Framework/sp-odata-types/iodatauser.yml | 224 ++-- .../sp-odata-types/iodatausercustomaction.yml | 492 ++++---- SP-Framework/sp-odata-types/iodataweb.yml | 518 ++++---- SP-Framework/sp-page-context.yml | 38 +- SP-Framework/sp-page-context/cultureinfo.yml | 126 +- .../sp-page-context/ispsystemtime.yml | 214 ++-- .../sp-page-context/isptimezonedata.yml | 190 +-- SP-Framework/sp-page-context/pagecontext.yml | 342 ++--- SP-Framework/sp-page-context/spfield.yml | 206 +-- SP-Framework/sp-page-context/splist.yml | 134 +- SP-Framework/sp-page-context/splistitem.yml | 54 +- SP-Framework/sp-page-context/sppermission.yml | 1072 ++++++++-------- SP-Framework/sp-page-context/spsite.yml | 298 ++--- SP-Framework/sp-page-context/sptimezone.yml | 226 ++-- SP-Framework/sp-page-context/spuser.yml | 222 ++-- SP-Framework/sp-page-context/spweb.yml | 350 +++--- SP-Framework/sp-property-pane.yml | 720 +++++------ .../dynamicdatashareddepth.yml | 50 +- ...dynamicdatasharedpropertyconfiguration.yml | 46 +- .../idynamicdatasharedpropertyfilters.yml | 66 +- .../idynamicdatasharedsourceconfiguration.yml | 76 +- .../idynamicdatasharedsourcefilters.yml | 122 +- .../sp-property-pane/ipopupwindowprops.yml | 118 +- .../ipropertypanebuttonprops.yml | 226 ++-- .../ipropertypanecheckboxprops.yml | 94 +- .../ipropertypanechoicegroupoption.yml | 260 ++-- ...propertypanechoicegroupoptioniconprops.yml | 46 +- .../ipropertypanechoicegroupprops.yml | 70 +- .../ipropertypaneconditionalgroup.yml | 142 +-- .../ipropertypaneconfiguration.yml | 188 +-- .../ipropertypanecustomfieldprops.yml | 150 +-- .../ipropertypanedebounceproperty.yml | 74 +- .../ipropertypanedropdowncalloutprops.yml | 46 +- .../ipropertypanedropdownoption.yml | 118 +- .../ipropertypanedropdownprops.yml | 242 ++-- .../ipropertypanedynamicfieldprops.yml | 140 +-- .../ipropertypanedynamicfieldsetprops.yml | 118 +- .../ipropertypanedynamictextfieldprops.yml | 300 ++--- .../sp-property-pane/ipropertypanefield.yml | 118 +- .../sp-property-pane/ipropertypanegroup.yml | 112 +- .../ipropertypanelabelprops.yml | 70 +- .../ipropertypanelinkprops.yml | 170 +-- .../sp-property-pane/ipropertypanepage.yml | 98 +- .../ipropertypanepageheader.yml | 72 +- .../ipropertypanesliderprops.yml | 256 ++-- .../ipropertypanetextfieldprops.yml | 522 ++++---- .../ipropertypanetoggleprops.yml | 214 ++-- .../sp-property-pane/popupwindowposition.yml | 70 +- .../propertypanebuttontype.yml | 84 +- .../propertypanedropdownoptiontype.yml | 54 +- .../propertypanefieldtype.yml | 176 +-- SP-Framework/sp-search-extensibility.yml | 24 +- .../basesearchquerymodifier.yml | 142 +-- .../sp-search-extensibility/iquery.yml | 70 +- .../searchquerymodifiercontext.yml | 22 +- .../searchqueryscenario.yml | 40 +- SP-Framework/sp-webpart-base.yml | 827 ++++++------ .../sp-webpart-base/baseclientsidewebpart.yml | 589 ++++----- SP-Framework/sp-webpart-base/basewebpart.yml | 850 ++++++------- .../sp-webpart-base/basewebpartcontext.yml | 138 +-- .../dynamicdatashareddepth.yml | 52 +- .../iclientsidewebpartstatusrenderer.yml | 180 +-- ...dynamicdatasharedpropertyconfiguration.yml | 28 +- .../idynamicdatasharedpropertyfilters.yml | 28 +- .../idynamicdatasharedsourceconfiguration.yml | 28 +- .../idynamicdatasharedsourcefilters.yml | 28 +- .../sp-webpart-base/imicrosoftteams.yml | 74 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 198 +-- .../ipropertypanebuttonprops.yml | 28 +- .../ipropertypanecheckboxprops.yml | 28 +- .../ipropertypanechoicegroupoption.yml | 28 +- ...propertypanechoicegroupoptioniconprops.yml | 28 +- .../ipropertypanechoicegroupprops.yml | 28 +- .../ipropertypaneconditionalgroup.yml | 28 +- .../ipropertypaneconfiguration.yml | 28 +- .../ipropertypanecustomfieldprops.yml | 28 +- .../ipropertypanedropdowncalloutprops.yml | 28 +- .../ipropertypanedropdownoption.yml | 28 +- .../ipropertypanedropdownprops.yml | 28 +- .../ipropertypanedynamicfieldfilters.yml | 28 +- .../ipropertypanedynamicfieldprops.yml | 28 +- .../ipropertypanedynamicfieldsetprops.yml | 28 +- .../ipropertypanedynamictextfieldprops.yml | 24 +- .../sp-webpart-base/ipropertypanefield.yml | 28 +- .../sp-webpart-base/ipropertypanegroup.yml | 28 +- .../ipropertypanelabelprops.yml | 28 +- .../ipropertypanelinkprops.yml | 28 +- .../sp-webpart-base/ipropertypanepage.yml | 28 +- .../ipropertypanepageheader.yml | 28 +- .../ipropertypanesliderprops.yml | 28 +- .../ipropertypanetextfieldprops.yml | 28 +- .../ipropertypanetoggleprops.yml | 28 +- SP-Framework/sp-webpart-base/isdks.yml | 70 +- .../iserializedwebpartdata.yml | 252 ++-- .../sp-webpart-base/iwebpartcontext.yml | 250 ++-- SP-Framework/sp-webpart-base/iwebpartdata.yml | 390 +++--- .../iwebpartpropertiesmetadata.yml | 122 +- .../iwebpartpropertymetadata.yml | 74 +- .../propertypanebuttontype.yml | 86 +- .../propertypanedropdownoptiontype.yml | 56 +- .../sp-webpart-base/propertypanefieldtype.yml | 178 +-- .../sp-webpart-base/webpartcontext.yml | 166 +-- 314 files changed, 22221 insertions(+), 22048 deletions(-) create mode 100644 SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 1ccf516b..0cf44050 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -1,81 +1,81 @@ -### YamlMime:TSPackage -uid: '@microsoft/decorators!' -name: '@microsoft/decorators' -type: package -summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. -functions: - - name: 'override(target, propertyKey, descriptor)' - uid: '@microsoft/decorators!override:function(1)' - package: '@microsoft/decorators!' - summary: >- - This decorator is applied to a class's member function or property. It indicates that the definition overrides - another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at - runtime. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function override(target: Object, propertyKey: string | symbol, descriptor: - TypedPropertyDescriptor): void; - parameters: - - id: target - description: '' - type: Object - - id: propertyKey - description: '' - type: string | symbol - - id: descriptor - description: '' - type: TypedPropertyDescriptor<any> - return: - type: void - description: '' - - name: sealed(target) - uid: '@microsoft/decorators!sealed:function(1)' - package: '@microsoft/decorators!' - summary: >- - This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not - inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may - be enforced at runtime. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'export declare function sealed(target: Function): void;' - parameters: - - id: target - description: '' - type: Function - return: - type: void - description: '' - - name: 'virtual(target, propertyKey, descriptor)' - uid: '@microsoft/decorators!virtual:function(1)' - package: '@microsoft/decorators!' - summary: >- - This decorator is applied to a class's member function or property. It indicates that the definition may - optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a - definition, then child classes may NOT override it. This decorator is currently used for documentation purposes - only. In the future, it may be enforced at runtime. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: - TypedPropertyDescriptor): void; - parameters: - - id: target - description: '' - type: Object - - id: propertyKey - description: '' - type: string | symbol - - id: descriptor - description: '' - type: TypedPropertyDescriptor<any> - return: - type: void - description: '' +### YamlMime:TSPackage +uid: '@microsoft/decorators!' +name: '@microsoft/decorators' +type: package +summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. +functions: + - name: 'override(target, propertyKey, descriptor)' + uid: '@microsoft/decorators!override:function(1)' + package: '@microsoft/decorators!' + summary: >- + This decorator is applied to a class's member function or property. It indicates that the definition overrides + another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at + runtime. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function override(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; + parameters: + - id: target + description: '' + type: Object + - id: propertyKey + description: '' + type: string | symbol + - id: descriptor + description: '' + type: TypedPropertyDescriptor<any> + return: + type: void + description: '' + - name: sealed(target) + uid: '@microsoft/decorators!sealed:function(1)' + package: '@microsoft/decorators!' + summary: >- + This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not + inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may + be enforced at runtime. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'export declare function sealed(target: Function): void;' + parameters: + - id: target + description: '' + type: Function + return: + type: void + description: '' + - name: 'virtual(target, propertyKey, descriptor)' + uid: '@microsoft/decorators!virtual:function(1)' + package: '@microsoft/decorators!' + summary: >- + This decorator is applied to a class's member function or property. It indicates that the definition may + optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a + definition, then child classes may NOT override it. This decorator is currently used for documentation purposes + only. In the future, it may be enforced at runtime. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; + parameters: + - id: target + description: '' + type: Object + - id: propertyKey + description: '' + type: string | symbol + - id: descriptor + description: '' + type: TypedPropertyDescriptor<any> + return: + type: void + description: '' diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml index 3e551787..e7524b1b 100644 --- a/SP-Framework/office-ui-fabric-react-bundle.yml +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -1,18 +1,18 @@ -### YamlMime:TSPackage -uid: '@microsoft/office-ui-fabric-react-bundle!' -name: '@microsoft/office-ui-fabric-react-bundle' -type: package -summary: '' -functions: - - name: initializeIcons() - uid: '@microsoft/office-ui-fabric-react-bundle!initializeIcons:function(1)' - package: '@microsoft/office-ui-fabric-react-bundle!' - summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'export declare function initializeIcons(): void;' - return: - type: void - description: '' +### YamlMime:TSPackage +uid: '@microsoft/office-ui-fabric-react-bundle!' +name: '@microsoft/office-ui-fabric-react-bundle' +type: package +summary: '' +functions: + - name: initializeIcons() + uid: '@microsoft/office-ui-fabric-react-bundle!initializeIcons:function(1)' + package: '@microsoft/office-ui-fabric-react-bundle!' + summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'export declare function initializeIcons(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml index 87869efb..af73e8aa 100644 --- a/SP-Framework/sp-adaptive-card-extension-base.yml +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -1,50 +1,52 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-adaptive-card-extension-base!' -name: '@microsoft/sp-adaptive-card-extension-base' -type: package -summary: SharePoint Framwork Adaptive Card Extensions -classes: - - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' - - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' - - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' -interfaces: - - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' - - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' - - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' - - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' - - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' -enums: - - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' +### YamlMime:TSPackage +uid: '@microsoft/sp-adaptive-card-extension-base!' +name: '@microsoft/sp-adaptive-card-extension-base' +type: package +summary: SharePoint Framwork Adaptive Card Extensions +classes: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' +interfaces: + - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' +enums: + - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index 94f83153..d45a86fe 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -1,50 +1,50 @@ -### YamlMime:TSType -name: AdaptiveCardExtensionContext -uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: AdaptiveCardExtensionContext -summary: Adaptive Card Extension context object. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AdaptiveCardExtensionContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: deviceContext - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#deviceContext:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: deviceContext - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get deviceContext(): DeviceContext;' - return: - type: '' - - name: manifest - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: manifest - summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly manifest: IAdaptiveCardExtensionManifest;' - return: - type: '<unknown>' - - name: propertyPane - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: propertyPane - summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get propertyPane(): IPropertyPaneAccessor | undefined;' - return: - type: ' | undefined' -extends: '' +### YamlMime:TSType +name: AdaptiveCardExtensionContext +uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: AdaptiveCardExtensionContext +summary: Adaptive Card Extension context object. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AdaptiveCardExtensionContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: deviceContext + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#deviceContext:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: deviceContext + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get deviceContext(): DeviceContext;' + return: + type: '' + - name: manifest + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: manifest + summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IAdaptiveCardExtensionManifest;' + return: + type: '<unknown>' + - name: propertyPane + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: propertyPane + summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get propertyPane(): IPropertyPaneAccessor | undefined;' + return: + type: ' | undefined' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index 46b013f3..bf9ec28f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -1,522 +1,581 @@ -### YamlMime:TSType -name: BaseAdaptiveCardExtension -uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseAdaptiveCardExtension -summary: Base class for Adaptive Card Extensions. -remarks: Adaptive Card Extensions must inherit from this class. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: (constructor)() - summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: constructor(); -properties: - - name: _iconProperty - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: _iconProperty - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected _iconProperty: string;' - return: - type: string - - name: _title - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: _title - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected _title: string;' - return: - type: string - - name: cardNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardNavigator - summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get cardNavigator(): ViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: cardSize - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardSize - summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get cardSize(): CardSize;' - return: - type: '' - - name: context - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: context - summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected context: AdaptiveCardExtensionContext;' - return: - type: '' - - name: dataVersion - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: dataVersion - summary: >- - The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to - manage versioning of the Adaptive Card Extension. - remarks: The default version is 1.0. - isPreview: false - isDeprecated: false - syntax: - content: 'protected get dataVersion(): Version;' - return: - type: '' - - name: description - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: description - summary: The description of the Adaptive Card Extension defined in the manifest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get description(): string;' - return: - type: string - - name: displayMode - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: displayMode - summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get displayMode(): DisplayMode;' - return: - type: '' - - name: iconProperty - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: iconProperty - summary: The icon url used to render an icon on the Card view. - remarks: 'By default, this will return the iconImageUrl defined in the manifest.' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected get iconProperty(): string; - return: - type: string - - name: isVisible - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isVisible - summary: Sets the visibility of the Adaptive Card Extension and re-render - remarks: >- - This method should be called after a card view has been registered. Otherwise visibility change will not be - applied to the Adaptive Card. - isPreview: false - isDeprecated: false - syntax: - content: |- - get isVisible(): boolean; - - set isVisible(value: boolean); - return: - type: boolean - - name: properties - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: properties - summary: 'The custom, persisted properties of the Adaptive Card Extension.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get properties(): TProperties;' - return: - type: TProperties - - name: propertiesMetadata - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: propertiesMetadata - summary: >- - This property defines metadata for the Adaptive Card Extension property bag. The metadata can help SharePoint - understand the content of the properties better and perform relevant services on the data. - remarks: >- - See - [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) - for more information about how to define metadata. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined; - return: - type: >- - | - undefined - - name: quickViewNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: quickViewNavigator - summary: >- - [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a - [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get quickViewNavigator(): QuickViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: renderedFromPersistedData - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderedFromPersistedData - summary: >- - Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default - state. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get renderedFromPersistedData(): boolean;' - return: - type: boolean - - name: renderedOnce - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderedOnce - summary: Indicates whether the Adaptive Card Extension has initially rendered. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get renderedOnce(): boolean;' - return: - type: boolean - - name: renderType - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderType - summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get renderType(): RenderType;' - return: - type: '' - - name: state - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: state - summary: Gets the custom state of the Adaptive Card Extension. - remarks: >- - If this property is not initialized, - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) - cannot be called. - isPreview: false - isDeprecated: false - syntax: - content: |- - protected get state(): Readonly; - - protected set state(initialState: Readonly); - return: - type: Readonly<TState> - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title - summary: >- - This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also - displayed as the Property Pane title. - remarks: 'By default, this will return the title defined in the manifest.' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get title(): string; - return: - type: string -methods: - - name: getPropertyPaneConfiguration() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: getPropertyPaneConfiguration() - summary: >- - Get the Property Pane configuration for this Adaptive Card Extension. If an Adaptive Card Extension wants to use - the Property Pane, then this method must be overriden. - remarks: >- - Property Pane resources can be defer loaded to reduce bundle size. See - [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration; - return: - type: '' - description: '' - - name: loadPropertyPaneResources() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: loadPropertyPaneResources() - summary: API to enable asynchronous loading of Property Pane related resources of the Adaptive Card Extension. - remarks: >- - No Property Pane events will be raised until this method resolves except for - `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected loadPropertyPaneResources(): Promise; - return: - type: Promise<void> - description: '' - - name: 'onAfterDeserialize(deserializedProperties, dataVersion)' - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)' - summary: Lifecycle method called before the property bag is populated with the deserialized property object. - remarks: >- - The default implementation is a no-op. An Adaptive Card Extension developer can override this API if the - deserialized object does not fully reflect the initial state of the property bag. This gives the Adaptive Card - Extension developer a chance to populate the property bag right after the data is deserialized to an object. - - - An important scenario to use deserialize is upgrading. An upgraded Adaptive Card Extension may load the data that - was serialized by an older version of the Adaptive Card Extension that supported a different schema of the - property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The - developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onAfterDeserialize(deserializedProperties: any, dataVersion: Version): TProperties; - parameters: - - id: deserializedProperties - description: >- - The object deserialized from the stored data. Note that the schema of this object is not necessarily - consistent with the current property bag, because the serialization could have been done by an older version - of the Adaptive Card Extension - type: any - - id: dataVersion - description: >- - The data version of the stored data being deserialized. You can use this value to determine if the data was - serialized by an older Adaptive Card Extension. Adaptive Card Extensions can define their data version by - overriding the dataVersion property. - type: '' - return: - type: TProperties - description: The property bag of the Adaptive Card Extension - - name: onAfterPropertiesUpdatedExternally(prevProperties) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onAfterPropertiesUpdatedExternally(prevProperties) - summary: >- - Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than - the property pane (except for isolated Adaptive Card Extensions). - remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - onAfterPropertiesUpdatedExternally(prevProperties: TProperties): void; - parameters: - - id: prevProperties - description: The Adaptive Card Extension properties before the update. - type: TProperties - return: - type: void - description: '' - - name: onBeforeSerialize() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onBeforeSerialize() - summary: Lifecycle method called before serialization. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - onBeforeSerialize(): void; - return: - type: void - description: '' - - name: onDisplayModeChanged(oldDisplayMode) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onDisplayModeChanged(oldDisplayMode) - summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; - parameters: - - id: oldDisplayMode - description: The old display mode. - type: '' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onDispose() - summary: Lifecycle method called before disposing the Adaptive Card Extension. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - onDispose(): void; - return: - type: void - description: '' - - name: onInit() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onInit() - summary: Lifecycle method called during initialization. - remarks: >- - Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result - or, if resolved immediately, a fetching data state can be rendered. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - onInit(): Promise; - return: - type: Promise<void> - description: '' - - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - summary: Lifecycle method called when a Property Pane field is changed. - remarks: This is invoked for reactive Property Panes. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void; - parameters: - - id: propertyPath - description: >- - JSON path of the property in the property bag. In the case of custom field, if no target property is - provided then a custom value is assigned, which will be in the form of `__CustomField_`. - type: string - - id: oldValue - description: Old value of the property. This value could be undefined/empty in the case of custom field. - type: any - - id: newValue - description: New value of the property. This value could be undefined/empty in the case of custom field. - type: any - return: - type: void - description: '' - - name: onRenderTypeChanged(oldRenderType) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onRenderTypeChanged(oldRenderType) - summary: >- - Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) - changes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onRenderTypeChanged(oldRenderType: RenderType): void; - parameters: - - id: oldRenderType - description: 'The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' - type: '' - return: - type: void - description: '' - - name: renderCard() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderCard() - summary: The id of the initial Card view. - remarks: 'By default, this returns undefined and will render a default Card view.' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected renderCard(): string | undefined; - return: - type: string | undefined - description: '' - - name: setState(newState) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: setState(newState) - summary: Update the state of the Adaptive Card Extension and re-render. - remarks: >- - [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member) - must have been initialized before calling - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - isPreview: false - isDeprecated: false - syntax: - content: 'setState(newState?: Partial): void;' - parameters: - - id: newState - description: '' - type: Partial<TState> - return: - type: void - description: '' -extends: '' +### YamlMime:TSType +name: BaseAdaptiveCardExtension +uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseAdaptiveCardExtension +summary: Base class for Adaptive Card Extensions. +remarks: Adaptive Card Extensions must inherit from this class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: (constructor)() + summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: constructor(); +properties: + - name: _iconProperty + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: _iconProperty + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected _iconProperty: string;' + return: + type: string + - name: _title + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: _title + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected _title: string;' + return: + type: string + - name: cardNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardNavigator + summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cardNavigator(): ViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: cardSize + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardSize + summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get cardSize(): CardSize;' + return: + type: '' + - name: context + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: context + summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected context: AdaptiveCardExtensionContext;' + return: + type: '' + - name: dataVersion + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: dataVersion + summary: >- + The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to + manage versioning of the Adaptive Card Extension. + remarks: The default version is 1.0. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get dataVersion(): Version;' + return: + type: '' + - name: description + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: description + summary: The description of the Adaptive Card Extension defined in the manifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get description(): string;' + return: + type: string + - name: displayMode + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: displayMode + summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get displayMode(): DisplayMode;' + return: + type: '' + - name: iconProperty + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: iconProperty + summary: The icon url used to render an icon on the Card view. + remarks: 'By default, this will return the iconImageUrl defined in the manifest.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected get iconProperty(): string; + return: + type: string + - name: isVisible + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isVisible + summary: Sets the visibility of the Adaptive Card Extension and re-render + remarks: >- + This method should be called after a card view has been registered. Otherwise visibility change will not be + applied to the Adaptive Card. + isPreview: false + isDeprecated: false + syntax: + content: |- + get isVisible(): boolean; + + set isVisible(value: boolean); + return: + type: boolean + - name: properties + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: properties + summary: 'The custom, persisted properties of the Adaptive Card Extension.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get properties(): TProperties;' + return: + type: TProperties + - name: propertiesMetadata + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: propertiesMetadata + summary: >- + This property defines metadata for the Adaptive Card Extension property bag. The metadata can help SharePoint + understand the content of the properties better and perform relevant services on the data. + remarks: >- + See + [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) + for more information about how to define metadata. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined; + return: + type: >- + | + undefined + - name: quickViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: quickViewNavigator + summary: >- + [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a + [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get quickViewNavigator(): QuickViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: renderedFromPersistedData + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderedFromPersistedData + summary: >- + Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default + state. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get renderedFromPersistedData(): boolean;' + return: + type: boolean + - name: renderedOnce + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderedOnce + summary: Indicates whether the Adaptive Card Extension has initially rendered. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get renderedOnce(): boolean;' + return: + type: boolean + - name: renderType + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderType + summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get renderType(): RenderType;' + return: + type: '' + - name: state + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: state + summary: Gets the custom state of the Adaptive Card Extension. + remarks: >- + If this property is not initialized, + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) + cannot be called. + isPreview: false + isDeprecated: false + syntax: + content: |- + protected get state(): Readonly; + + protected set state(initialState: Readonly); + return: + type: Readonly<TState> + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: >- + This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also + displayed as the Property Pane title. + remarks: 'By default, this will return the title defined in the manifest.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get title(): string; + return: + type: string +methods: + - name: getCachedState(state) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: getCachedState(state) + summary: This virtual method returns a subset of the state object that will be cached by the client. + remarks: 'If not overriden, this will return an empty object.' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected getCachedState(state: TState): Partial; + parameters: + - id: state + description: A shallow clone of the AdaptiveCardExtension state object. + type: TState + return: + type: Partial<TState> + description: '' + - name: getCacheSettings() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: getCacheSettings() + summary: Override the default cache settings. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected getCacheSettings(): Partial; + return: + type: 'Partial<>' + description: '' + - name: getPropertyPaneConfiguration() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: getPropertyPaneConfiguration() + summary: >- + Get the Property Pane configuration for this Adaptive Card Extension. If an Adaptive Card Extension wants to use + the Property Pane, then this method must be overriden. + remarks: >- + Property Pane resources can be defer loaded to reduce bundle size. See + [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration; + return: + type: '' + description: '' + - name: loadPropertyPaneResources() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: loadPropertyPaneResources() + summary: API to enable asynchronous loading of Property Pane related resources of the Adaptive Card Extension. + remarks: >- + No Property Pane events will be raised until this method resolves except for + `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected loadPropertyPaneResources(): Promise; + return: + type: Promise<void> + description: '' + - name: 'onAfterDeserialize(deserializedProperties, dataVersion)' + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)' + summary: Lifecycle method called before the property bag is populated with the deserialized property object. + remarks: >- + The default implementation is a no-op. An Adaptive Card Extension developer can override this API if the + deserialized object does not fully reflect the initial state of the property bag. This gives the Adaptive Card + Extension developer a chance to populate the property bag right after the data is deserialized to an object. + + + An important scenario to use deserialize is upgrading. An upgraded Adaptive Card Extension may load the data that + was serialized by an older version of the Adaptive Card Extension that supported a different schema of the + property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The + developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onAfterDeserialize(deserializedProperties: any, dataVersion: Version): TProperties; + parameters: + - id: deserializedProperties + description: >- + The object deserialized from the stored data. Note that the schema of this object is not necessarily + consistent with the current property bag, because the serialization could have been done by an older version + of the Adaptive Card Extension + type: any + - id: dataVersion + description: >- + The data version of the stored data being deserialized. You can use this value to determine if the data was + serialized by an older Adaptive Card Extension. Adaptive Card Extensions can define their data version by + overriding the dataVersion property. + type: '' + return: + type: TProperties + description: The property bag of the Adaptive Card Extension + - name: onAfterPropertiesUpdatedExternally(prevProperties) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onAfterPropertiesUpdatedExternally(prevProperties) + summary: >- + Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than + the property pane (except for isolated Adaptive Card Extensions). + remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onAfterPropertiesUpdatedExternally(prevProperties: TProperties): void; + parameters: + - id: prevProperties + description: The Adaptive Card Extension properties before the update. + type: TProperties + return: + type: void + description: '' + - name: onBeforeSerialize() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onBeforeSerialize() + summary: Lifecycle method called before serialization. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onBeforeSerialize(): void; + return: + type: void + description: '' + - name: onDisplayModeChanged(oldDisplayMode) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onDisplayModeChanged(oldDisplayMode) + summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; + parameters: + - id: oldDisplayMode + description: The old display mode. + type: '' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onDispose() + summary: Lifecycle method called before disposing the Adaptive Card Extension. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onDispose(): void; + return: + type: void + description: '' + - name: onInit() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onInit() + summary: Lifecycle method called during initialization. + remarks: >- + Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result + or, if resolved immediately, a fetching data state can be rendered. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onInit(): Promise; + return: + type: Promise<void> + description: '' + - name: onInit(cachedLoadParameters) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(2)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onInit(cachedLoadParameters) + summary: Lifecycle method called during initialization. + remarks: >- + Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result + or, if resolved immediately, a fetching data state can be rendered. + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @virtual */ + onInit(cachedLoadParameters?: ICachedLoadParameters): Promise; + parameters: + - id: cachedLoadParameters + description: >- + Parameters containing the cached state object (see + [BaseAdaptiveCardExtension.getCachedState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23getCachedState:member(1))), which can be used to rehydrate the AdaptiveCardExtension. If undefined, the AdaptiveCardExtension was + not cached or the cache expired. + type: '' + return: + type: Promise<void> + description: '' + - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + summary: Lifecycle method called when a Property Pane field is changed. + remarks: This is invoked for reactive Property Panes. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void; + parameters: + - id: propertyPath + description: >- + JSON path of the property in the property bag. In the case of custom field, if no target property is + provided then a custom value is assigned, which will be in the form of `__CustomField_`. + type: string + - id: oldValue + description: Old value of the property. This value could be undefined/empty in the case of custom field. + type: any + - id: newValue + description: New value of the property. This value could be undefined/empty in the case of custom field. + type: any + return: + type: void + description: '' + - name: onRenderTypeChanged(oldRenderType) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onRenderTypeChanged(oldRenderType) + summary: >- + Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) + changes. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onRenderTypeChanged(oldRenderType: RenderType): void; + parameters: + - id: oldRenderType + description: 'The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' + type: '' + return: + type: void + description: '' + - name: renderCard() + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: renderCard() + summary: The id of the initial Card view. + remarks: 'By default, this returns undefined and will render a default Card view.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected renderCard(): string | undefined; + return: + type: string | undefined + description: '' + - name: setState(newState) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: setState(newState) + summary: Update the state of the Adaptive Card Extension and re-render. + remarks: >- + [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member) + must have been initialized before calling + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). + isPreview: false + isDeprecated: false + syntax: + content: 'setState(newState?: Partial): void;' + parameters: + - id: newState + description: '' + type: Partial<TState> + return: + type: void + description: '' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml index dc90b971..7b9cc052 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -1,70 +1,70 @@ -### YamlMime:TSType -name: BaseAdaptiveCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseAdaptiveCardView -summary: Base class for an Adaptive Card view. -remarks: Views used to render the Quick view must inherit from this class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#data:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data - summary: The data used to render the Adaptive Card. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get data(): TData; - return: - type: TData - - name: externalLink - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: externalLink - summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. - remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get externalLink(): IExternalLinkParameters | undefined; - return: - type: ' | undefined' - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template - summary: The Adaptive Card template rendered by the view. - remarks: The format of the template must be valid Adaptive Card JSON. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - abstract get template(): ISPFxAdaptiveCard; - return: - type: '' - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title - summary: An optional title to be displayed in the navigation bar above the Adaptive Card. - remarks: >- - If not overriden, the title displayed will be - [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get title(): string; - return: - type: string -extends: '<TProperties, TState, TData> ' +### YamlMime:TSType +name: BaseAdaptiveCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseAdaptiveCardView +summary: Base class for an Adaptive Card view. +remarks: Views used to render the Quick view must inherit from this class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data used to render the Adaptive Card. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get data(): TData; + return: + type: TData + - name: externalLink + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: externalLink + summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. + remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get externalLink(): IExternalLinkParameters | undefined; + return: + type: ' | undefined' + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: The Adaptive Card template rendered by the view. + remarks: The format of the template must be valid Adaptive Card JSON. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + abstract get template(): ISPFxAdaptiveCard; + return: + type: '' + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: An optional title to be displayed in the navigation bar above the Adaptive Card. + remarks: >- + If not overriden, the title displayed will be + [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get title(): string; + return: + type: string +extends: '<TProperties, TState, TData> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index a927cc19..a1b7a570 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -1,32 +1,32 @@ -### YamlMime:TSType -name: BaseBasicCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseBasicCardView -summary: Base class for a Basic Card view. -remarks: >- - The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the - `Medium` Card size, two buttons in the `Large` Card size -isPreview: false -isDeprecated: false -type: class -properties: - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template - summary: >- - Returns the Adaptive Card template for the - [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @sealed */ - get template(): ISPFxAdaptiveCard; - return: - type: '' -extends: >- - <TProperties, TState, > +### YamlMime:TSType +name: BaseBasicCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseBasicCardView +summary: Base class for a Basic Card view. +remarks: >- + The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the + `Medium` Card size, two buttons in the `Large` Card size +isPreview: false +isDeprecated: false +type: class +properties: + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: >- + Returns the Adaptive Card template for the + [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + type: '' +extends: >- + <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index 0a8d68c9..81c7a6b2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -1,78 +1,78 @@ -### YamlMime:TSType -name: BaseCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseCardView -summary: Primitive base class for Card views. -remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. - - No third-party Card views should inherit from this class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: cardButtons - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#cardButtons:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardButtons - summary: The buttons displayed on the Card. - remarks: >- - Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the - documentation for the respective base Card View class for specific details. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get cardButtons(): [ICardButton] | [ICardButton, ICardButton] | undefined; - return: - type: >- - [] | [, ] | undefined - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#data:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data - summary: The data used to render the Card view. - remarks: >- - The available data to display is dependent on the Card view template and its respective base Card view class. See - the documentation for the Card View class for specific details. - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get data(): TData;' - return: - type: TData - - name: isCacheEnabled - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#isCacheEnabled:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isCacheEnabled - summary: 'If true, this Card view will be cached and rendered at next load.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get isCacheEnabled(): boolean; - return: - type: boolean - - name: onCardSelection - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onCardSelection - summary: Action to invoke when the card is selected. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | undefined; - return: - type: >- - | | undefined -extends: '<TProperties, TState, TData> ' +### YamlMime:TSType +name: BaseCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseCardView +summary: Primitive base class for Card views. +remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + No third-party Card views should inherit from this class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: cardButtons + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#cardButtons:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardButtons + summary: The buttons displayed on the Card. + remarks: >- + Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the + documentation for the respective base Card View class for specific details. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get cardButtons(): [ICardButton] | [ICardButton, ICardButton] | undefined; + return: + type: >- + [] | [, ] | undefined + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data used to render the Card view. + remarks: >- + The available data to display is dependent on the Card view template and its respective base Card view class. See + the documentation for the Card View class for specific details. + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get data(): TData;' + return: + type: TData + - name: isCacheEnabled + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#isCacheEnabled:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isCacheEnabled + summary: 'If true, this Card view will be cached and rendered at next load.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get isCacheEnabled(): boolean; + return: + type: boolean + - name: onCardSelection + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onCardSelection + summary: Action to invoke when the card is selected. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | undefined; + return: + type: >- + | | undefined +extends: '<TProperties, TState, TData> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index a3e872c1..c9318dd8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -1,32 +1,32 @@ -### YamlMime:TSType -name: BaseImageCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseImageCardView -summary: Base class for an Image Card view. -remarks: >- - The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero - buttons in the `Medium` Card size, up to two buttons in `Large` Card size -isPreview: false -isDeprecated: false -type: class -properties: - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template - summary: >- - Returns the Adaptive Card template for the - [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @sealed */ - get template(): ISPFxAdaptiveCard; - return: - type: '' -extends: >- - <TProperties, TState, > +### YamlMime:TSType +name: BaseImageCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseImageCardView +summary: Base class for an Image Card view. +remarks: >- + The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero + buttons in the `Medium` Card size, up to two buttons in `Large` Card size +isPreview: false +isDeprecated: false +type: class +properties: + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: >- + Returns the Adaptive Card template for the + [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + type: '' +extends: >- + <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml index 0153ee5b..7c226713 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -1,32 +1,32 @@ -### YamlMime:TSType -name: BasePrimaryTextCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BasePrimaryTextCardView -summary: Base class for a Primary Text Card view. -remarks: >- - The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description - text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size -isPreview: false -isDeprecated: false -type: class -properties: - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template - summary: >- - Returns the Adaptive Card template for the - [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @sealed */ - get template(): ISPFxAdaptiveCard; - return: - type: '' -extends: >- - <TProperties, TState, > +### YamlMime:TSType +name: BasePrimaryTextCardView +uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BasePrimaryTextCardView +summary: Base class for a Primary Text Card view. +remarks: >- + The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description + text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size +isPreview: false +isDeprecated: false +type: class +properties: + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: >- + Returns the Adaptive Card template for the + [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + type: '' +extends: >- + <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml index 984a58df..6ce8de39 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -1,192 +1,192 @@ -### YamlMime:TSType -name: BaseView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseView -summary: Base class for all views. -remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. - - No third-party views should inherit from this class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: cardNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardNavigator - summary: >- - See - [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get cardNavigator(): ViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: cardSize - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardSize:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardSize - summary: >- - See - [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get cardSize(): CardSize;' - return: - type: '' - - name: context - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#context:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: context - summary: >- - See - [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get context(): AdaptiveCardExtensionContext;' - return: - type: '' - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#data:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data - summary: The data used to render the View. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get data(): TData | undefined;' - return: - type: TData | undefined - - name: properties - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#properties:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: properties - summary: >- - See - [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get properties(): TProperties;' - return: - type: TProperties - - name: quickViewNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: quickViewNavigator - summary: >- - See - [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get quickViewNavigator(): QuickViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: state - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#state:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: state - summary: >- - See - [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get state(): Readonly;' - return: - type: Readonly<TState> - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template - summary: The Adaptive Card template used to render the view. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get template(): ISPFxAdaptiveCard;' - return: - type: '' -methods: - - name: onAction(action) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onAction:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onAction(action) - summary: Action handler for Adaptive Card Actions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onAction(action: IActionArguments): void;' - parameters: - - id: action - description: >- - The [IActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionArguments:type) for the - current event. - type: '' - return: - type: void - description: '' - - name: setState(newState) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: setState(newState) - summary: >- - See - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setState(newState?: Partial): void;' - parameters: - - id: newState - description: '' - type: Partial<TState> - return: - type: void - description: '' - - name: setVisibility(isVisible) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setVisibility:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: setVisibility(isVisible) - summary: >- - Sets visibility to false and rerenders the card. See - [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setVisibility(isVisible: boolean): void;' - parameters: - - id: isVisible - description: '' - type: boolean - return: - type: void - description: '' +### YamlMime:TSType +name: BaseView +uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: BaseView +summary: Base class for all views. +remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + No third-party views should inherit from this class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: cardNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardNavigator + summary: >- + See + [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cardNavigator(): ViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: cardSize + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardSize:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardSize + summary: >- + See + [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cardSize(): CardSize;' + return: + type: '' + - name: context + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#context:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: context + summary: >- + See + [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get context(): AdaptiveCardExtensionContext;' + return: + type: '' + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data used to render the View. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get data(): TData | undefined;' + return: + type: TData | undefined + - name: properties + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#properties:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: properties + summary: >- + See + [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get properties(): TProperties;' + return: + type: TProperties + - name: quickViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: quickViewNavigator + summary: >- + See + [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get quickViewNavigator(): QuickViewNavigator>;' + return: + type: >- + <<TProperties, TState>> + - name: state + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#state:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: state + summary: >- + See + [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get state(): Readonly;' + return: + type: Readonly<TState> + - name: template + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#template:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: template + summary: The Adaptive Card template used to render the view. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get template(): ISPFxAdaptiveCard;' + return: + type: '' +methods: + - name: onAction(action) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onAction:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onAction(action) + summary: Action handler for Adaptive Card Actions. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onAction(action: IActionArguments): void;' + parameters: + - id: action + description: >- + The [IActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionArguments:type) for the + current event. + type: '' + return: + type: void + description: '' + - name: setState(newState) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: setState(newState) + summary: >- + See + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'setState(newState?: Partial): void;' + parameters: + - id: newState + description: '' + type: Partial<TState> + return: + type: void + description: '' + - name: setVisibility(isVisible) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setVisibility:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: setVisibility(isVisible) + summary: >- + Sets visibility to false and rerenders the card. See + [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'setVisibility(isVisible: boolean): void;' + parameters: + - id: isVisible + description: '' + type: boolean + return: + type: void + description: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml index aaf8dd00..fb719bce 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -1,12 +1,12 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionPropertiesMetadata -uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IAdaptiveCardExtensionPropertiesMetadata -summary: >- - This structure is used to define metadata for Adaptive Card Extension properties as a map of string to - `IAdaptiveCardExtensionPropertiesMetadata` -remarks: '' -isPreview: false -isDeprecated: false -type: interface +### YamlMime:TSType +name: IAdaptiveCardExtensionPropertiesMetadata +uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IAdaptiveCardExtensionPropertiesMetadata +summary: >- + This structure is used to define metadata for Adaptive Card Extension properties as a map of string to + `IAdaptiveCardExtensionPropertiesMetadata` +remarks: '' +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index ebc8f262..23ad28a1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionPropertyMetadata -uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IAdaptiveCardExtensionPropertyMetadata -summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: IAdaptiveCardExtensionPropertyMetadata +uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IAdaptiveCardExtensionPropertyMetadata +summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml index 08c1ba59..7ae0dd3a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -1,40 +1,40 @@ -### YamlMime:TSType -name: IBaseActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBaseActionArguments -summary: >- - Base object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an Adaptive - Card Action is executed. -remarks: >- - Only `Submit` and `ShowCard` actions are routed to the - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#id:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: id - summary: The id specified in the Adaptive Card template - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id?: string;' - return: - type: string - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: The type of Adaptive Card Action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''Submit'' | ''ShowCard'';' - return: - type: '''Submit'' | ''ShowCard''' +### YamlMime:TSType +name: IBaseActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBaseActionArguments +summary: >- + Base object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an Adaptive + Card Action is executed. +remarks: >- + Only `Submit` and `ShowCard` actions are routed to the + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#id:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: id + summary: The id specified in the Adaptive Card template + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''Submit'' | ''ShowCard'';' + return: + type: '''Submit'' | ''ShowCard''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml index 3b70fd94..a8303c4b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -1,47 +1,47 @@ -### YamlMime:TSType -name: IBaseCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBaseCardParameters -summary: The primitive data parameters for every Card view. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: iconAltText - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconAltText:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: iconAltText - summary: The icon alt text. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'iconAltText?: string;' - return: - type: string - - name: iconProperty - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconProperty:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: iconProperty - summary: The icon to display. - remarks: The value is a URL to an icon. - isPreview: false - isDeprecated: false - syntax: - content: 'iconProperty?: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title - summary: The title to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title?: string;' - return: - type: string +### YamlMime:TSType +name: IBaseCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBaseCardParameters +summary: The primitive data parameters for every Card view. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: iconAltText + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconAltText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: iconAltText + summary: The icon alt text. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'iconAltText?: string;' + return: + type: string + - name: iconProperty + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconProperty:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: iconProperty + summary: The icon to display. + remarks: The value is a URL to an icon. + isPreview: false + isDeprecated: false + syntax: + content: 'iconProperty?: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: The title to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index 1af9b25b..f8ad9c06 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -1,26 +1,26 @@ -### YamlMime:TSType -name: IBasicCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBasicCardParameters -summary: >- - The data parameters for - [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: primaryText - uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters#primaryText:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: primaryText - summary: The primary text to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'primaryText: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IBasicCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBasicCardParameters +summary: >- + The data parameters for + [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: primaryText + uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters#primaryText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: primaryText + summary: The primary text to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryText: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml new file mode 100644 index 00000000..1157614a --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: ICachedLoadParameters +uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ICachedLoadParameters +summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: cardNavigatorState + uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#cardNavigatorState:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cardNavigatorState + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'cardNavigatorState: string[];' + return: + type: 'string[]' + - name: state + uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#state:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: state + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'state: any;' + return: + type: any diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml new file mode 100644 index 00000000..15aa62e7 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: ICacheSettings +uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ICacheSettings +summary: '' +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: cachedCardView + uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#cachedCardView:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: cachedCardView + summary: >- + Returns the Card View used to generate the cached card. By default, the currently rendered Card View will be used + to cache the card. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'cachedCardView?: () => BaseCardView;' + return: + type: '() => ' + - name: expiryTimeInSeconds + uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#expiryTimeInSeconds:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: expiryTimeInSeconds + summary: 'Expiry time in seconds. Default: 86400 seconds (24 hours)' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'expiryTimeInSeconds: number;' + return: + type: number + - name: isEnabled + uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#isEnabled:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isEnabled + summary: 'Whether cache is enabled. Default: true' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'isEnabled: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 4e7e77aa..5596f0b0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: ICardButton -uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ICardButton -summary: A button to display on a Card View. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: action - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#action:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: action - summary: The type of the button. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'action: ICardAction;' - return: - type: '' - - name: id - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: id - summary: Unique Id of the button. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id?: string;' - return: - type: string - - name: style - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#style:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: style - summary: Controls the style of the button. - remarks: The destructive Action style is not supported in Card views - isPreview: false - isDeprecated: false - syntax: - content: 'style?: ActionStyle;' - return: - type: '' - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title - summary: Text displayed on the button. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string +### YamlMime:TSType +name: ICardButton +uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ICardButton +summary: A button to display on a Card View. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: action + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#action:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: action + summary: The type of the button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'action: ICardAction;' + return: + type: '' + - name: id + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: id + summary: Unique Id of the button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: style + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#style:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: style + summary: Controls the style of the button. + remarks: The destructive Action style is not supported in Card views + isPreview: false + isDeprecated: false + syntax: + content: 'style?: ActionStyle;' + return: + type: '' + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: Text displayed on the button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml index 1f987a7a..cf9b9090 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IConfirmationDialog -uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IConfirmationDialog -summary: Confirmation Dialog option that is passed through `Submit` Action is executed. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: message - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#message:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: message - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'message: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string +### YamlMime:TSType +name: IConfirmationDialog +uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IConfirmationDialog +summary: Confirmation Dialog option that is passed through `Submit` Action is executed. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: message + uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#message:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: message + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'message: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: title + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index 6b5b3454..0f1f201d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IExternalLinkCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IExternalLinkCardAction -summary: Open an external link. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters for the external link. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'parameters: IExternalLinkParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is an external link button. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''ExternalLink'';' - return: - type: '''ExternalLink''' +### YamlMime:TSType +name: IExternalLinkCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IExternalLinkCardAction +summary: Open an external link. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters for the external link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parameters: IExternalLinkParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is an external link button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''ExternalLink'';' + return: + type: '''ExternalLink''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml index 71754ad9..04d96bbd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IExternalLinkParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IExternalLinkParameters -summary: Parameters for opening an external link. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isTeamsDeepLink - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#isTeamsDeepLink:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isTeamsDeepLink - summary: Indicates whether this is a Teams Deep Link. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isTeamsDeepLink?: boolean;' - return: - type: boolean - - name: target - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: target - summary: The URL of the link. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'target: string;' - return: - type: string +### YamlMime:TSType +name: IExternalLinkParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IExternalLinkParameters +summary: Parameters for opening an external link. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isTeamsDeepLink + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#isTeamsDeepLink:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: isTeamsDeepLink + summary: Indicates whether this is a Teams Deep Link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isTeamsDeepLink?: boolean;' + return: + type: boolean + - name: target + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: target + summary: The URL of the link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'target: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index e289e1fa..42d12b2e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -1,36 +1,36 @@ -### YamlMime:TSType -name: IGetLocationAction -uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IGetLocationAction -summary: Interface for Viva Get Location action -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters that can be supplied with the Viva Get Location Action. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'parameters?: IGetLocationActionParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is a Viva Select Location button. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.GetLocation'';' - return: - type: '''VivaAction.GetLocation''' -extends: '' +### YamlMime:TSType +name: IGetLocationAction +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationAction +summary: Interface for Viva Get Location action +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Get Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IGetLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 42054004..4bc7f9a9 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: IGetLocationActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IGetLocationActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get - location Action is executed. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: location - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: location - summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'location?: ILocation;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: The type of Adaptive Card Action. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.GetLocation'';' - return: - type: '''VivaAction.GetLocation''' -extends: 'Omit<, ''type''> ' +### YamlMime:TSType +name: IGetLocationActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get + location Action is executed. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: location + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: location + summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'location?: ILocation;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' +extends: 'Omit<, ''type''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index 93c981c4..05bf3cff 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IGetLocationActionParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IGetLocationActionParameters -summary: Parameters that can be supplied with the Viva Get Location Action. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: chooseLocationOnMap - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters#chooseLocationOnMap:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: chooseLocationOnMap - summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'chooseLocationOnMap?: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IGetLocationActionParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationActionParameters +summary: Parameters that can be supplied with the Viva Get Location Action. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: chooseLocationOnMap + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters#chooseLocationOnMap:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: chooseLocationOnMap + summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'chooseLocationOnMap?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index baa4aa1a..268dc783 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IGetLocationCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IGetLocationCardAction -summary: Invoke an `VivaAction.GetLocation` event. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters that can be supplied with the Viva Get Location Action. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'parameters?: IGetLocationActionParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is a Viva Select Location button. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.GetLocation'';' - return: - type: '''VivaAction.GetLocation''' +### YamlMime:TSType +name: IGetLocationCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IGetLocationCardAction +summary: Invoke an `VivaAction.GetLocation` event. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Get Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IGetLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index 988e886e..35e892a9 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -1,38 +1,38 @@ -### YamlMime:TSType -name: IImageCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IImageCardParameters -summary: >- - The data parameters for - [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: imageUrl - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#imageUrl:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: imageUrl - summary: The image URL to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'imageUrl: string;' - return: - type: string - - name: primaryText - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: primaryText - summary: The primary text to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'primaryText: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IImageCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IImageCardParameters +summary: >- + The data parameters for + [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: imageUrl + uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#imageUrl:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: imageUrl + summary: The image URL to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'imageUrl: string;' + return: + type: string + - name: primaryText + uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: primaryText + summary: The primary text to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryText: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index b212dd60..642f99f1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: ILocation -uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ILocation -summary: Interface for location coordinates -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: accuracy - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#accuracy:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: accuracy - summary: Accuracy of the location. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'accuracy?: number;' - return: - type: number - - name: latitude - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: latitude - summary: Latitude of the location. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'latitude: number;' - return: - type: number - - name: longitude - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: longitude - summary: Longitude of the location. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'longitude: number;' - return: - type: number - - name: timestamp - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: timestamp - summary: Timestamp - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'timestamp?: number;' - return: - type: number +### YamlMime:TSType +name: ILocation +uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ILocation +summary: Interface for location coordinates +remarks: API under active development and is not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: accuracy + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#accuracy:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: accuracy + summary: Accuracy of the location. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'accuracy?: number;' + return: + type: number + - name: latitude + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: latitude + summary: Latitude of the location. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'latitude: number;' + return: + type: number + - name: longitude + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: longitude + summary: Longitude of the location. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'longitude: number;' + return: + type: number + - name: timestamp + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: timestamp + summary: Timestamp + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'timestamp?: number;' + return: + type: number diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml index 8b272f47..4a2622ac 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -1,38 +1,38 @@ -### YamlMime:TSType -name: IPrimaryTextCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IPrimaryTextCardParameters -summary: >- - The data parameters for - [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#description:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: description - summary: The description to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description: string;' - return: - type: string - - name: primaryText - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: primaryText - summary: The primary text to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'primaryText: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IPrimaryTextCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IPrimaryTextCardParameters +summary: >- + The data parameters for + [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#description:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: description + summary: The description to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description: string;' + return: + type: string + - name: primaryText + uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: primaryText + summary: The primary text to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryText: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index b12fddd9..2fd4f260 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IQuickViewCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IQuickViewCardAction -summary: Open the quick view. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters for the quick view opened by this action - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'parameters: IQuickViewParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this action opens the quick view. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''QuickView'';' - return: - type: '''QuickView''' +### YamlMime:TSType +name: IQuickViewCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IQuickViewCardAction +summary: Open the quick view. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters for the quick view opened by this action + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parameters: IQuickViewParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this action opens the quick view. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''QuickView'';' + return: + type: '''QuickView''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml index a49c4fe8..a29f4714 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IQuickViewParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IQuickViewParameters -summary: Parameters for opening a Quick view. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: view - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters#view:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: view - summary: The view of the Quick view to open. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'view: string;' - return: - type: string +### YamlMime:TSType +name: IQuickViewParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IQuickViewParameters +summary: Parameters for opening a Quick view. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: view + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters#view:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: view + summary: The view of the Quick view to open. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'view: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index 08115001..eba92be6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -1,36 +1,36 @@ -### YamlMime:TSType -name: ISelectMediaAction -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaAction -summary: Interface for new Viva Select Media action -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'parameters: ISelectMediaActionParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.SelectMedia'';' - return: - type: '''VivaAction.SelectMedia''' -extends: '' +### YamlMime:TSType +name: ISelectMediaAction +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaAction +summary: Interface for new Viva Select Media action +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters: ISelectMediaActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index 61d857af..470a58d2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: ISelectMediaActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a - `SelectMedia` Action is executed. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: media - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: media - summary: media object returned media picker API - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'media: ISelectMediaAttachment[];' - return: - type: '[]' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: The type of Adaptive Card Action. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.SelectMedia'';' - return: - type: '''VivaAction.SelectMedia''' -extends: 'Omit<, ''type''> ' +### YamlMime:TSType +name: ISelectMediaActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a + `SelectMedia` Action is executed. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: media + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: media + summary: media object returned media picker API + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'media: ISelectMediaAttachment[];' + return: + type: '[]' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' +extends: 'Omit<, ''type''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml index 019f9eea..8e9e3425 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: ISelectMediaActionParameters -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaActionParameters -summary: Parameters that can be supplied with the Viva Select Media Action. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: allowMultipleCapture - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#allowMultipleCapture:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: allowMultipleCapture - summary: Allow multiple images to be selected. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'allowMultipleCapture?: boolean;' - return: - type: boolean - - name: maxSizePerFile - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#maxSizePerFile:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: maxSizePerFile - summary: Max file size that can be uploaded. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'maxSizePerFile?: number;' - return: - type: number - - name: mediaType - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#mediaType:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: mediaType - summary: Specify the specific media type that should be selected - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'mediaType: MediaType;' - return: - type: '' - - name: supportedFileFormats - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#supportedFileFormats:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: supportedFileFormats - summary: File formats supported for upload. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'supportedFileFormats?: string[];' - return: - type: 'string[]' +### YamlMime:TSType +name: ISelectMediaActionParameters +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaActionParameters +summary: Parameters that can be supplied with the Viva Select Media Action. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: allowMultipleCapture + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#allowMultipleCapture:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: allowMultipleCapture + summary: Allow multiple images to be selected. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'allowMultipleCapture?: boolean;' + return: + type: boolean + - name: maxSizePerFile + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#maxSizePerFile:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: maxSizePerFile + summary: Max file size that can be uploaded. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'maxSizePerFile?: number;' + return: + type: number + - name: mediaType + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#mediaType:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: mediaType + summary: Specify the specific media type that should be selected + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'mediaType: MediaType;' + return: + type: '' + - name: supportedFileFormats + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#supportedFileFormats:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: supportedFileFormats + summary: File formats supported for upload. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'supportedFileFormats?: string[];' + return: + type: 'string[]' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index e6d179dd..b3b08ca4 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: ISelectMediaAttachment -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaAttachment -summary: This object represents the data returned by the native media picker API. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: content - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#content:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: content - summary: Content of the file represented as base64Strings - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'content: string;' - return: - type: string - - name: fileName - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: fileName - summary: The names of the selected files. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'fileName: string;' - return: - type: string +### YamlMime:TSType +name: ISelectMediaAttachment +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaAttachment +summary: This object represents the data returned by the native media picker API. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: content + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#content:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: content + summary: Content of the file represented as base64Strings + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'content: string;' + return: + type: string + - name: fileName + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: fileName + summary: The names of the selected files. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'fileName: string;' + return: + type: string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 292aedda..993e8c19 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: ISelectMediaCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaCardAction -summary: Invoke an `VivaAction.SelectMedia` event. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters for the external link. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'parameters: ISelectMediaActionParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is a Viva Select Media button. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.SelectMedia'';' - return: - type: '''VivaAction.SelectMedia''' +### YamlMime:TSType +name: ISelectMediaCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaCardAction +summary: Invoke an `VivaAction.SelectMedia` event. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters for the Select Media Action + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters: ISelectMediaActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Media button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index 00278237..c48d8a7e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -1,27 +1,27 @@ -### YamlMime:TSType -name: IShowCardActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowCardActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` - Action is executed. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: The type of Adaptive Card Action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''ShowCard'';' - return: - type: '''ShowCard''' -extends: '' +### YamlMime:TSType +name: IShowCardActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowCardActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` + Action is executed. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''ShowCard'';' + return: + type: '''ShowCard''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index 74e122a9..da0babab 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -1,36 +1,36 @@ -### YamlMime:TSType -name: IShowLocationAction -uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowLocationAction -summary: Interface for Viva Show Location action -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters that can be supplied with the Viva Show Location Action. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'parameters?: IShowLocationActionParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is a Viva show Location button. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.ShowLocation'';' - return: - type: '''VivaAction.ShowLocation''' -extends: '' +### YamlMime:TSType +name: IShowLocationAction +uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowLocationAction +summary: Interface for Viva Show Location action +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Show Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IShowLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva show Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.ShowLocation'';' + return: + type: '''VivaAction.ShowLocation''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index e6bbcd4f..b3143ebf 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IShowLocationActionParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowLocationActionParameters -summary: Parameters that can be supplied with the Viva Show Location Action. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: locationCoordinates - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: locationCoordinates - summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'locationCoordinates?: ILocation;' - return: - type: '' +### YamlMime:TSType +name: IShowLocationActionParameters +uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowLocationActionParameters +summary: Parameters that can be supplied with the Viva Show Location Action. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: locationCoordinates + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: locationCoordinates + summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'locationCoordinates?: ILocation;' + return: + type: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 8e7fe84b..7e8037ee 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IShowLocationCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowLocationCardAction -summary: Invoke an `VivaAction.ShowLocation` event. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters that can be supplied with the Viva Show Location Action. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'parameters?: IShowLocationActionParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is a Viva show Location button. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''VivaAction.ShowLocation'';' - return: - type: '''VivaAction.ShowLocation''' +### YamlMime:TSType +name: IShowLocationCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IShowLocationCardAction +summary: Invoke an `VivaAction.ShowLocation` event. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters that can be supplied with the Viva Show Location Action. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'parameters?: IShowLocationActionParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva show Location button. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.ShowLocation'';' + return: + type: '''VivaAction.ShowLocation''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index e6514122..1d00bfab 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: ISPFxAdaptiveCard -uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISPFxAdaptiveCard -summary: SPFx Adaptive Card Extension schema for Adaptive Cards. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: ISPFxAdaptiveCard +uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISPFxAdaptiveCard +summary: SPFx Adaptive Card Extension schema for Adaptive Cards. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index 063fe44a..6e612e74 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: ISubmitActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISubmitActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` - Action is executed. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#data:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data - summary: The data object defined in the Adaptive Card template - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'data: any;' - return: - type: any - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: The type of Adaptive Card Action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''Submit'';' - return: - type: '''Submit''' -extends: '' +### YamlMime:TSType +name: ISubmitActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISubmitActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` + Action is executed. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: The data object defined in the Adaptive Card template + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'data: any;' + return: + type: any + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''Submit'';' + return: + type: '''Submit''' +extends: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index c388a053..23b53f58 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -1,47 +1,47 @@ -### YamlMime:TSType -name: ISubmitCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISubmitCardAction -summary: Invoke an `Action.Submit` event. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: confirmationDialog - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#confirmationDialog:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: confirmationDialog - summary: Confirmation dialog option passed to the submit handler. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'confirmationDialog?: IConfirmationDialog;' - return: - type: '' - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters - summary: Parameters passed to the Submit event handler. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'parameters: ISubmitCardParameters;' - return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type - summary: Indicates this is a Submit button. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''Submit'';' - return: - type: '''Submit''' +### YamlMime:TSType +name: ISubmitCardAction +uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISubmitCardAction +summary: Invoke an `Action.Submit` event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: confirmationDialog + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#confirmationDialog:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: confirmationDialog + summary: Confirmation dialog option passed to the submit handler. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'confirmationDialog?: IConfirmationDialog;' + return: + type: '' + - name: parameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: parameters + summary: Parameters passed to the Submit event handler. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parameters: ISubmitCardParameters;' + return: + type: '' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Submit button. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''Submit'';' + return: + type: '''Submit''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml index 153e276f..4e4fa3fd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -1,10 +1,10 @@ -### YamlMime:TSType -name: ISubmitCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISubmitCardParameters -summary: Parameters for submit card action. -remarks: '' -isPreview: false -isDeprecated: false -type: interface +### YamlMime:TSType +name: ISubmitCardParameters +uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISubmitCardParameters +summary: Parameters for submit card action. +remarks: '' +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml index 3959ee1d..e74899c5 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -1,20 +1,20 @@ -### YamlMime:TSEnum -name: MediaType -uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: MediaType -summary: Enum value to specify the type of media. -remarks: API under active development and not ready for use. -isPreview: true -isDeprecated: false -fields: - - name: Audio - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Audio:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - summary: '' - value: '4' - - name: Image - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Image:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - summary: '' - value: '1' +### YamlMime:TSEnum +name: MediaType +uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: MediaType +summary: Enum value to specify the type of media. +remarks: API under active development and not ready for use. +isPreview: true +isDeprecated: false +fields: + - name: Audio + uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Audio:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + summary: '' + value: '4' + - name: Image + uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Image:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + summary: '' + value: '1' diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index 107f1b42..67561c3e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -1,30 +1,30 @@ -### YamlMime:TSType -name: QuickViewNavigator -uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: QuickViewNavigator -summary: Manages a stack of Adaptive Card views for the Quick view. -remarks: >- - The top of the stack is the currently rendered view. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `QuickViewNavigator` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: close() - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator#close:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: close() - summary: Closes the View. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'close(): void;' - return: - type: void - description: '' -extends: '<TView> ' +### YamlMime:TSType +name: QuickViewNavigator +uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: QuickViewNavigator +summary: Manages a stack of Adaptive Card views for the Quick view. +remarks: >- + The top of the stack is the currently rendered view. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `QuickViewNavigator` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: close() + uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator#close:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: close() + summary: Closes the View. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'close(): void;' + return: + type: void + description: '' +extends: '<TView> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index ba5af8cc..5ff4b9e1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -1,148 +1,148 @@ -### YamlMime:TSType -name: ViewNavigator -uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ViewNavigator -summary: Manages a stack of views. -remarks: The top of the stack represents the currently rendered view. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' - summary: Constructs a new instance of the `ViewNavigator` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - constructor(_handleStackChangedCallback: (skipUpdate: boolean) => void, _handleInitializeCallback: (view: - BaseView) => void); - parameters: - - id: _handleStackChangedCallback - description: '' - type: '(skipUpdate: boolean) => void' - - id: _handleInitializeCallback - description: '' - type: '(view: ) => void' -properties: - - name: currentId - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#currentId:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: currentId - summary: Get the id of the currently rendered View from the top of the View stack - remarks: 'If the stack is empty, this will return undefined' - isPreview: false - isDeprecated: false - syntax: - content: 'get currentId(): string | undefined;' - return: - type: string | undefined - - name: size - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#size:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: size - summary: Current size of the View stack. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get size(): number;' - return: - type: number -methods: - - name: pop(skipUpdate) - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#pop:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: pop(skipUpdate) - summary: >- - If there is more than one View, pops the top View from the View stack. - - - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'pop(skipUpdate?: boolean): void;' - parameters: - - id: skipUpdate - description: Whether to skip the update (and re-render) after popping the current View. - type: boolean - return: - type: void - description: '' - - name: 'push(id, skipUpdate)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'push(id, skipUpdate)' - summary: >- - Pushes a new view to the top of the view stack. - - - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'push(id: string, skipUpdate?: boolean): void;' - parameters: - - id: id - description: Unique identifier for the view. - type: string - - id: skipUpdate - description: Whether to skip the update (and re-render) after pushing the new view. - type: boolean - return: - type: void - description: '' - - name: 'register(id, initializer)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'register(id, initializer)' - summary: Registers a new view. - remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' - isPreview: false - isDeprecated: false - syntax: - content: 'register(id: string, initializer: () => TView): void;' - parameters: - - id: id - description: Unique identifier for the view. - type: string - - id: initializer - description: 'Function that returns a new view, which is only called if no view with the `id` already exists.' - type: () => TView - return: - type: void - description: '' - - name: 'replace(id, skipUpdate)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'replace(id, skipUpdate)' - summary: >- - Replaces the top view with a new view. - - - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'replace(id: string, skipUpdate?: boolean): void;' - parameters: - - id: id - description: Unique identifier for the view. - type: string - - id: skipUpdate - description: Whether to skip the update (and re-render) after replacing the current view. - type: boolean - return: - type: void - description: '' +### YamlMime:TSType +name: ViewNavigator +uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ViewNavigator +summary: Manages a stack of views. +remarks: The top of the stack represents the currently rendered view. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + summary: Constructs a new instance of the `ViewNavigator` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + constructor(_handleStackChangedCallback: (skipUpdate: boolean) => void, _handleInitializeCallback: (view: + BaseView) => void); + parameters: + - id: _handleStackChangedCallback + description: '' + type: '(skipUpdate: boolean) => void' + - id: _handleInitializeCallback + description: '' + type: '(view: ) => void' +properties: + - name: currentId + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#currentId:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: currentId + summary: Get the id of the currently rendered View from the top of the View stack + remarks: 'If the stack is empty, this will return undefined' + isPreview: false + isDeprecated: false + syntax: + content: 'get currentId(): string | undefined;' + return: + type: string | undefined + - name: size + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#size:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: size + summary: Current size of the View stack. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get size(): number;' + return: + type: number +methods: + - name: pop(skipUpdate) + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#pop:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: pop(skipUpdate) + summary: >- + If there is more than one View, pops the top View from the View stack. + + + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'pop(skipUpdate?: boolean): void;' + parameters: + - id: skipUpdate + description: Whether to skip the update (and re-render) after popping the current View. + type: boolean + return: + type: void + description: '' + - name: 'push(id, skipUpdate)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'push(id, skipUpdate)' + summary: >- + Pushes a new view to the top of the view stack. + + + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'push(id: string, skipUpdate?: boolean): void;' + parameters: + - id: id + description: Unique identifier for the view. + type: string + - id: skipUpdate + description: Whether to skip the update (and re-render) after pushing the new view. + type: boolean + return: + type: void + description: '' + - name: 'register(id, initializer)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'register(id, initializer)' + summary: Registers a new view. + remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' + isPreview: false + isDeprecated: false + syntax: + content: 'register(id: string, initializer: () => TView): void;' + parameters: + - id: id + description: Unique identifier for the view. + type: string + - id: initializer + description: 'Function that returns a new view, which is only called if no view with the `id` already exists.' + type: () => TView + return: + type: void + description: '' + - name: 'replace(id, skipUpdate)' + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: 'replace(id, skipUpdate)' + summary: >- + Replaces the top view with a new view. + + + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'replace(id: string, skipUpdate?: boolean): void;' + parameters: + - id: id + description: Unique identifier for the view. + type: string + - id: skipUpdate + description: Whether to skip the update (and re-render) after replacing the current view. + type: boolean + return: + type: void + description: '' diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index cf424bbc..7cc99cd3 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -1,15 +1,15 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-application-base!' -name: '@microsoft/sp-application-base' -type: package -summary: SharePoint Framework support for building and extending client-side applications. -classes: - - '@microsoft/sp-application-base!ApplicationAccessor:class' - - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - - '@microsoft/sp-application-base!PlaceholderContent:class' - - '@microsoft/sp-application-base!PlaceholderProvider:class' -interfaces: - - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' -enums: - - '@microsoft/sp-application-base!PlaceholderName:enum' +### YamlMime:TSPackage +uid: '@microsoft/sp-application-base!' +name: '@microsoft/sp-application-base' +type: package +summary: SharePoint Framework support for building and extending client-side applications. +classes: + - '@microsoft/sp-application-base!ApplicationAccessor:class' + - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + - '@microsoft/sp-application-base!PlaceholderContent:class' + - '@microsoft/sp-application-base!PlaceholderProvider:class' +interfaces: + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' +enums: + - '@microsoft/sp-application-base!PlaceholderName:enum' diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index e78c47a8..9e791818 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -1,57 +1,57 @@ -### YamlMime:TSType -name: ApplicationAccessor -uid: '@microsoft/sp-application-base!ApplicationAccessor:class' -package: '@microsoft/sp-application-base!' -fullName: ApplicationAccessor -summary: Provides access to the client-side application that is currently running. -remarks: >- - The client-side application determines the user experience for an entire web page. (It is a client-side component with - a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side - applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain - in-place navigation transitions can cause the application to be unloaded and replaced by a different application. - - - The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the - currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to - ensure that extensibility components only rely on interactions that would be portable across all applications. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' - package: '@microsoft/sp-application-base!' - fullName: (constructor)(serviceScope) - summary: >- - Constructs a new instance of the - [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) class. - remarks: >- - Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component - context, for example - [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -events: - - name: navigatedEvent - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' - package: '@microsoft/sp-application-base!' - fullName: navigatedEvent - summary: An event that is fired when the application's top-level page context navigates to a new page. - remarks: >- - This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has - navigated to a new page. - isPreview: false - isDeprecated: false - syntax: - content: 'get navigatedEvent(): SPEvent;' - return: - type: >- - <> +### YamlMime:TSType +name: ApplicationAccessor +uid: '@microsoft/sp-application-base!ApplicationAccessor:class' +package: '@microsoft/sp-application-base!' +fullName: ApplicationAccessor +summary: Provides access to the client-side application that is currently running. +remarks: >- + The client-side application determines the user experience for an entire web page. (It is a client-side component with + a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side + applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain + in-place navigation transitions can cause the application to be unloaded and replaced by a different application. + + + The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the + currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to + ensure that extensibility components only rely on interactions that would be portable across all applications. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' + package: '@microsoft/sp-application-base!' + fullName: (constructor)(serviceScope) + summary: >- + Constructs a new instance of the + [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) class. + remarks: >- + Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component + context, for example + [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +events: + - name: navigatedEvent + uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' + package: '@microsoft/sp-application-base!' + fullName: navigatedEvent + summary: An event that is fired when the application's top-level page context navigates to a new page. + remarks: >- + This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has + navigated to a new page. + isPreview: false + isDeprecated: false + syntax: + content: 'get navigatedEvent(): SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 14f1132a..1ff85dd9 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -1,56 +1,56 @@ -### YamlMime:TSType -name: ApplicationCustomizerContext -uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' -package: '@microsoft/sp-application-base!' -fullName: ApplicationCustomizerContext -summary: >- - The component context for - [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ApplicationCustomizerContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: application - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' - package: '@microsoft/sp-application-base!' - fullName: application - summary: Provides access to the client-side application that is currently running. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get application(): ApplicationAccessor;' - return: - type: '' - - name: placeholderProvider - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' - package: '@microsoft/sp-application-base!' - fullName: placeholderProvider - summary: Exposes a collection of content placeholders for use by third parties. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get placeholderProvider(): PlaceholderProvider;' - return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - dispose(): void; - return: - type: void - description: '' -extends: '' +### YamlMime:TSType +name: ApplicationCustomizerContext +uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' +package: '@microsoft/sp-application-base!' +fullName: ApplicationCustomizerContext +summary: >- + The component context for + [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ApplicationCustomizerContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: application + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' + package: '@microsoft/sp-application-base!' + fullName: application + summary: Provides access to the client-side application that is currently running. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get application(): ApplicationAccessor;' + return: + type: '' + - name: placeholderProvider + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' + package: '@microsoft/sp-application-base!' + fullName: placeholderProvider + summary: Exposes a collection of content placeholders for use by third parties. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get placeholderProvider(): PlaceholderProvider;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + dispose(): void; + return: + type: void + description: '' +extends: '' diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index dbe00dac..ca4833ba 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -1,66 +1,66 @@ -### YamlMime:TSType -name: BaseApplicationCustomizer -uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' -package: '@microsoft/sp-application-base!' -fullName: BaseApplicationCustomizer -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that runs when an - application is first starting. -remarks: >- - In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - - - Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint - content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' - package: '@microsoft/sp-application-base!' - fullName: context - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected readonly context: ApplicationCustomizerContext;' - return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() - summary: Disposes the component. - remarks: >- - Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends - for a web part or extension. To perform custom cleanup when your component is disposed, override the method. - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: onPlaceholdersChanged(placeholderProvider) - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' - package: '@microsoft/sp-application-base!' - fullName: onPlaceholdersChanged(placeholderProvider) - summary: >- - This event method is called when the placeholders of the host application change, come into existence, or - disappear. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;' - parameters: - - id: placeholderProvider - description: '' - type: '' - return: - type: void - description: '' -extends: '<TProperties> ' +### YamlMime:TSType +name: BaseApplicationCustomizer +uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' +package: '@microsoft/sp-application-base!' +fullName: BaseApplicationCustomizer +summary: >- + This is the base class that third parties should extend when implementing a client-side extension that runs when an + application is first starting. +remarks: >- + In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". + + + Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint + content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' + package: '@microsoft/sp-application-base!' + fullName: context + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly context: ApplicationCustomizerContext;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: Disposes the component. + remarks: >- + Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends + for a web part or extension. To perform custom cleanup when your component is disposed, override the method. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: onPlaceholdersChanged(placeholderProvider) + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' + package: '@microsoft/sp-application-base!' + fullName: onPlaceholdersChanged(placeholderProvider) + summary: >- + This event method is called when the placeholders of the host application change, come into existence, or + disappear. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;' + parameters: + - id: placeholderProvider + description: '' + type: '' + return: + type: void + description: '' +extends: '<TProperties> ' diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index 3006b0a6..d88f6295 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -1,29 +1,29 @@ -### YamlMime:TSType -name: IPlaceholderCreateContentOptions -uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' -package: '@microsoft/sp-application-base!' -fullName: IPlaceholderCreateContentOptions -summary: >- - Options for the - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) - method. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: onDispose - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' - package: '@microsoft/sp-application-base!' - fullName: onDispose - summary: An optional callback that will be invoked when the PlaceholderContent object is disposed. - remarks: >- - To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content - was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler - might call ReactDOM.unmountComponentAtNode() to unmount it. - isPreview: false - isDeprecated: false - syntax: - content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' - return: - type: '(placeholderContent: ) => void' +### YamlMime:TSType +name: IPlaceholderCreateContentOptions +uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' +package: '@microsoft/sp-application-base!' +fullName: IPlaceholderCreateContentOptions +summary: >- + Options for the + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) + method. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: onDispose + uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' + package: '@microsoft/sp-application-base!' + fullName: onDispose + summary: An optional callback that will be invoked when the PlaceholderContent object is disposed. + remarks: >- + To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content + was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler + might call ReactDOM.unmountComponentAtNode() to unmount it. + isPreview: false + isDeprecated: false + syntax: + content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' + return: + type: '(placeholderContent: ) => void' diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index cecf4574..6025529a 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -1,89 +1,89 @@ -### YamlMime:TSType -name: PlaceholderContent -uid: '@microsoft/sp-application-base!PlaceholderContent:class' -package: '@microsoft/sp-application-base!' -fullName: PlaceholderContent -summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. -remarks: >- - This object is returned by - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `PlaceholderContent` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: domElement - uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' - package: '@microsoft/sp-application-base!' - fullName: domElement - summary: The Document Object Model (DOM) element where the owner should render its custom content. - remarks: >- - If the caller needs to be notified when the DOM element is disposed, use the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) - callback. - isPreview: false - isDeprecated: false - syntax: - content: 'get domElement(): HTMLDivElement;' - return: - type: HTMLDivElement - - name: isDisposed - uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' - package: '@microsoft/sp-application-base!' - fullName: isDisposed - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: isVisible - uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' - package: '@microsoft/sp-application-base!' - fullName: isVisible - summary: >- - Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't - displaying it, this will return false. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isVisible(): boolean;' - return: - type: boolean - - name: name - uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' - package: '@microsoft/sp-application-base!' - fullName: name - summary: Identifies the placeholder that this content was added to. - remarks: 'Example: PlaceholderName.Top' - isPreview: false - isDeprecated: false - syntax: - content: 'get name(): PlaceholderName;' - return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() - summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. - remarks: >- - This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the - application when the containing placeholder is disposed. Calling dispose() invokes the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) - callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' +### YamlMime:TSType +name: PlaceholderContent +uid: '@microsoft/sp-application-base!PlaceholderContent:class' +package: '@microsoft/sp-application-base!' +fullName: PlaceholderContent +summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. +remarks: >- + This object is returned by + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderContent` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: domElement + uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' + package: '@microsoft/sp-application-base!' + fullName: domElement + summary: The Document Object Model (DOM) element where the owner should render its custom content. + remarks: >- + If the caller needs to be notified when the DOM element is disposed, use the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) + callback. + isPreview: false + isDeprecated: false + syntax: + content: 'get domElement(): HTMLDivElement;' + return: + type: HTMLDivElement + - name: isDisposed + uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' + package: '@microsoft/sp-application-base!' + fullName: isDisposed + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean + - name: isVisible + uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' + package: '@microsoft/sp-application-base!' + fullName: isVisible + summary: >- + Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't + displaying it, this will return false. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isVisible(): boolean;' + return: + type: boolean + - name: name + uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' + package: '@microsoft/sp-application-base!' + fullName: name + summary: Identifies the placeholder that this content was added to. + remarks: 'Example: PlaceholderName.Top' + isPreview: false + isDeprecated: false + syntax: + content: 'get name(): PlaceholderName;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. + remarks: >- + This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the + application when the containing placeholder is disposed. Calling dispose() invokes the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) + callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index 8466d08c..ee717eea 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -1,24 +1,24 @@ -### YamlMime:TSEnum -name: PlaceholderName -uid: '@microsoft/sp-application-base!PlaceholderName:enum' -package: '@microsoft/sp-application-base!' -fullName: PlaceholderName -summary: >- - The identifier for a content placeholder, which is a region on the page where third-party extensibility components can - render custom content. -remarks: >- - For more information about placeholders, see - [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). -isPreview: false -isDeprecated: false -fields: - - name: Bottom - uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' - package: '@microsoft/sp-application-base!' - summary: A region at the bottom of the page. - value: '2' - - name: Top - uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' - package: '@microsoft/sp-application-base!' - summary: A region at the top of the page. - value: '1' +### YamlMime:TSEnum +name: PlaceholderName +uid: '@microsoft/sp-application-base!PlaceholderName:enum' +package: '@microsoft/sp-application-base!' +fullName: PlaceholderName +summary: >- + The identifier for a content placeholder, which is a region on the page where third-party extensibility components can + render custom content. +remarks: >- + For more information about placeholders, see + [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). +isPreview: false +isDeprecated: false +fields: + - name: Bottom + uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' + package: '@microsoft/sp-application-base!' + summary: A region at the bottom of the page. + value: '2' + - name: Top + uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' + package: '@microsoft/sp-application-base!' + summary: A region at the top of the page. + value: '1' diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index d241b436..5a1fdcdc 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -1,112 +1,112 @@ -### YamlMime:TSType -name: PlaceholderProvider -uid: '@microsoft/sp-application-base!PlaceholderProvider:class' -package: '@microsoft/sp-application-base!' -fullName: PlaceholderProvider -summary: >- - Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components - to render custom content into designated regions on the page. -remarks: >- - Placeholders are designated regions on the page, identified by one of the predefined - [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and - pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the - page, for example via in-place navigation. Third-party components should not assume that a given placeholder will - always be available. - - - Use - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) - to test whether a placeholder is available and add content to it. Use the - [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider%23changedEvent:member) - event to discover when new placeholders appear. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `PlaceholderProvider` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: isDisposed - uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' - package: '@microsoft/sp-application-base!' - fullName: isDisposed - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: placeholderNames - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' - package: '@microsoft/sp-application-base!' - fullName: placeholderNames - summary: Returns the names of the currently available placeholders. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get placeholderNames(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: 'tryCreateContent(name, options)' - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' - package: '@microsoft/sp-application-base!' - fullName: 'tryCreateContent(name, options)' - summary: >- - Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, - which allows the caller to render custom content inside the placeholder. - remarks: >- - The host application makes no guarantees about the availability of a given placeholder. In situations where an - expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering - anything, or by choosing an alternative placeholder. - isPreview: false - isDeprecated: false - syntax: - content: >- - tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | - undefined; - parameters: - - id: name - description: The requested placeholder - type: '' - - id: options - description: 'Additional options, for example to detect when the placeholder is disposed.' - type: '' - return: - type: ' | undefined' - description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' -events: - - name: changedEvent - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' - package: '@microsoft/sp-application-base!' - fullName: changedEvent - summary: This event is raised when the list of currently available placeholders is changed. - remarks: >- - The application can change its list of available placeholders at any time. This means that the existing - placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when - they appear. - isPreview: false - isDeprecated: false - syntax: - content: 'get changedEvent(): SPEvent;' - return: - type: >- - <> +### YamlMime:TSType +name: PlaceholderProvider +uid: '@microsoft/sp-application-base!PlaceholderProvider:class' +package: '@microsoft/sp-application-base!' +fullName: PlaceholderProvider +summary: >- + Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components + to render custom content into designated regions on the page. +remarks: >- + Placeholders are designated regions on the page, identified by one of the predefined + [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and + pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the + page, for example via in-place navigation. Third-party components should not assume that a given placeholder will + always be available. + + + Use + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) + to test whether a placeholder is available and add content to it. Use the + [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider%23changedEvent:member) + event to discover when new placeholders appear. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderProvider` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: isDisposed + uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' + package: '@microsoft/sp-application-base!' + fullName: isDisposed + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean + - name: placeholderNames + uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' + package: '@microsoft/sp-application-base!' + fullName: placeholderNames + summary: Returns the names of the currently available placeholders. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get placeholderNames(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' +methods: + - name: dispose() + uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' + package: '@microsoft/sp-application-base!' + fullName: dispose() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: 'tryCreateContent(name, options)' + uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' + package: '@microsoft/sp-application-base!' + fullName: 'tryCreateContent(name, options)' + summary: >- + Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, + which allows the caller to render custom content inside the placeholder. + remarks: >- + The host application makes no guarantees about the availability of a given placeholder. In situations where an + expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering + anything, or by choosing an alternative placeholder. + isPreview: false + isDeprecated: false + syntax: + content: >- + tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | + undefined; + parameters: + - id: name + description: The requested placeholder + type: '' + - id: options + description: 'Additional options, for example to detect when the placeholder is disposed.' + type: '' + return: + type: ' | undefined' + description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' +events: + - name: changedEvent + uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' + package: '@microsoft/sp-application-base!' + fullName: changedEvent + summary: This event is raised when the list of currently available placeholders is changed. + remarks: >- + The application can change its list of available placeholders at any time. This means that the existing + placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when + they appear. + isPreview: false + isDeprecated: false + syntax: + content: 'get changedEvent(): SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 961901e9..6d3eb5b9 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -1,19 +1,19 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-component-base!' -name: '@microsoft/sp-component-base' -type: package -summary: SharePoint Framework support for building client-side components -classes: - - '@microsoft/sp-component-base!BaseComponent:class' - - '@microsoft/sp-component-base!BaseComponentContext:class' - - '@microsoft/sp-component-base!DynamicDataProvider:class' - - '@microsoft/sp-component-base!DynamicDataSourceManager:class' - - '@microsoft/sp-component-base!DynamicProperty:class' - - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - - '@microsoft/sp-component-base!ThemeProvider:class' -interfaces: - - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' - - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - - '@microsoft/sp-component-base!IReadonlyTheme:interface' - - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' - - '@microsoft/sp-component-base!ITheme:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-component-base!' +name: '@microsoft/sp-component-base' +type: package +summary: SharePoint Framework support for building client-side components +classes: + - '@microsoft/sp-component-base!BaseComponent:class' + - '@microsoft/sp-component-base!BaseComponentContext:class' + - '@microsoft/sp-component-base!DynamicDataProvider:class' + - '@microsoft/sp-component-base!DynamicDataSourceManager:class' + - '@microsoft/sp-component-base!DynamicProperty:class' + - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + - '@microsoft/sp-component-base!ThemeProvider:class' +interfaces: + - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - '@microsoft/sp-component-base!IReadonlyTheme:interface' + - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + - '@microsoft/sp-component-base!ITheme:interface' diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 100423f9..931169b1 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -1,114 +1,114 @@ -### YamlMime:TSType -name: BaseComponent -uid: '@microsoft/sp-component-base!BaseComponent:class' -package: '@microsoft/sp-component-base!' -fullName: BaseComponent -summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseComponent` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: componentId - uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' - package: '@microsoft/sp-component-base!' - fullName: componentId - summary: Returns the component identifier as defined in the component’s associated manifest. - remarks: >- - Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which - may include additional metadata about the component. The manifest is uniquely identified using a text string - containing a lower case GUID value. - isPreview: false - isDeprecated: false - syntax: - content: 'get componentId(): string;' - return: - type: string - - name: context - uid: '@microsoft/sp-component-base!BaseComponent#context:member' - package: '@microsoft/sp-component-base!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: false - isDeprecated: false - syntax: - content: 'protected context: BaseComponentContext;' - return: - type: '' - - name: instanceId - uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' - package: '@microsoft/sp-component-base!' - fullName: instanceId - summary: A unique identifier for the instance of the component. - remarks: >- - A component implementation can be loaded multiple times on the page. For example, if the component is a charting - web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely - identifies each of these instances. - isPreview: false - isDeprecated: false - syntax: - content: 'get instanceId(): string;' - return: - type: string - - name: isDisposed - uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: Returns true if the component has been already disposed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: manifest - uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' - package: '@microsoft/sp-component-base!' - fullName: manifest - summary: Provides access to the manifest for the client-side component. virtual - remarks: Child classes can override this with more specialized manifest types. - isPreview: false - isDeprecated: false - syntax: - content: 'get manifest(): IClientSideComponentManifest;' - return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: Disposes the component. - remarks: >- - Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends - for a web part or extension. To perform custom cleanup when your component is disposed, override the - [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: onDispose() - summary: >- - This event method is called at the end of the component's lifecycle. It provides an opportunity to release any - associated resources, cancel any outstanding requests, etc. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected onDispose(): void;' - return: - type: void - description: '' +### YamlMime:TSType +name: BaseComponent +uid: '@microsoft/sp-component-base!BaseComponent:class' +package: '@microsoft/sp-component-base!' +fullName: BaseComponent +summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponent` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: componentId + uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' + package: '@microsoft/sp-component-base!' + fullName: componentId + summary: Returns the component identifier as defined in the component’s associated manifest. + remarks: >- + Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which + may include additional metadata about the component. The manifest is uniquely identified using a text string + containing a lower case GUID value. + isPreview: false + isDeprecated: false + syntax: + content: 'get componentId(): string;' + return: + type: string + - name: context + uid: '@microsoft/sp-component-base!BaseComponent#context:member' + package: '@microsoft/sp-component-base!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'protected context: BaseComponentContext;' + return: + type: '' + - name: instanceId + uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' + package: '@microsoft/sp-component-base!' + fullName: instanceId + summary: A unique identifier for the instance of the component. + remarks: >- + A component implementation can be loaded multiple times on the page. For example, if the component is a charting + web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely + identifies each of these instances. + isPreview: false + isDeprecated: false + syntax: + content: 'get instanceId(): string;' + return: + type: string + - name: isDisposed + uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the component has been already disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean + - name: manifest + uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' + package: '@microsoft/sp-component-base!' + fullName: manifest + summary: Provides access to the manifest for the client-side component. virtual + remarks: Child classes can override this with more specialized manifest types. + isPreview: false + isDeprecated: false + syntax: + content: 'get manifest(): IClientSideComponentManifest;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: Disposes the component. + remarks: >- + Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends + for a web part or extension. To perform custom cleanup when your component is disposed, override the + [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: onDispose() + summary: >- + This event method is called at the end of the component's lifecycle. It provides an opportunity to release any + associated resources, cancel any outstanding requests, etc. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onDispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 7d1c69cb..3be978b2 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -1,181 +1,193 @@ -### YamlMime:TSType -name: BaseComponentContext -uid: '@microsoft/sp-component-base!BaseComponentContext:class' -package: '@microsoft/sp-component-base!' -fullName: BaseComponentContext -summary: The base class for context objects for client-side components. -remarks: >- - A "context" object is a collection of well-known services and other objects that are likely to be needed by business - logic that interacts with a associated component. Each component type has its own specialized subclass of - BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseComponentContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: aadHttpClientFactory - uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' - package: '@microsoft/sp-component-base!' - fullName: aadHttpClientFactory - summary: The instance of AadHttpClientFactory created for this instance of component - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get aadHttpClientFactory(): AadHttpClientFactory;' - return: - type: '' - - name: aadTokenProviderFactory - uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' - package: '@microsoft/sp-component-base!' - fullName: aadTokenProviderFactory - summary: The instance of AadTokenProviderFactory created for this instance of component - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get aadTokenProviderFactory(): AadTokenProviderFactory;' - return: - type: '' - - name: dynamicDataProvider - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' - package: '@microsoft/sp-component-base!' - fullName: dynamicDataProvider - summary: Returns the Dynamic Data Provider associated with the component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get dynamicDataProvider(): DynamicDataProvider;' - return: - type: '' - - name: dynamicDataSourceManager - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' - package: '@microsoft/sp-component-base!' - fullName: dynamicDataSourceManager - summary: Returns the Dynamic Data Source Manager associated with the component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get dynamicDataSourceManager(): DynamicDataSourceManager;' - return: - type: '' - - name: httpClient - uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' - package: '@microsoft/sp-component-base!' - fullName: httpClient - summary: The instance of HttpClient created for this instance of component - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get httpClient(): HttpClient;' - return: - type: '' - - name: instanceId - uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' - package: '@microsoft/sp-component-base!' - fullName: instanceId - summary: A unique identifier for the instance of the component. - remarks: >- - A component implementation can be loaded multiple times on the page. For example, if the component is a charting - web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely - identifies each of these instances. - isPreview: false - isDeprecated: false - syntax: - content: 'get instanceId(): string;' - return: - type: string - - name: isDisposed - uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: Returns true if the context is disposed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: manifest - uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' - package: '@microsoft/sp-component-base!' - fullName: manifest - summary: Manifest for the client-side component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly manifest: IClientSideComponentManifest;' - return: - type: '' - - name: msGraphClientFactory - uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' - package: '@microsoft/sp-component-base!' - fullName: msGraphClientFactory - summary: The instance of MSGraphClientFactory created for this instance of component - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get msGraphClientFactory(): MSGraphClientFactory;' - return: - type: '' - - name: pageContext - uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' - package: '@microsoft/sp-component-base!' - fullName: pageContext - summary: >- - The page context provides standard definitions for common SharePoint objects that need to be shared between the - client-side application, web parts, and other components. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get pageContext(): PageContext;' - return: - type: '' - - name: serviceScope - uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' - package: '@microsoft/sp-component-base!' - fullName: serviceScope - summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' - remarks: A child service scope is created for each client-side component. - isPreview: false - isDeprecated: false - syntax: - content: 'get serviceScope(): ServiceScope;' - return: - type: '' - - name: spHttpClient - uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' - package: '@microsoft/sp-component-base!' - fullName: spHttpClient - summary: The instance of SpHttpClient created for this instance of component - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get spHttpClient(): SPHttpClient;' - return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: Disposes the base component context. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' +### YamlMime:TSType +name: BaseComponentContext +uid: '@microsoft/sp-component-base!BaseComponentContext:class' +package: '@microsoft/sp-component-base!' +fullName: BaseComponentContext +summary: The base class for context objects for client-side components. +remarks: >- + A "context" object is a collection of well-known services and other objects that are likely to be needed by business + logic that interacts with a associated component. Each component type has its own specialized subclass of + BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponentContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: aadHttpClientFactory + uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' + package: '@microsoft/sp-component-base!' + fullName: aadHttpClientFactory + summary: The instance of AadHttpClientFactory created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get aadHttpClientFactory(): AadHttpClientFactory;' + return: + type: '' + - name: aadTokenProviderFactory + uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' + package: '@microsoft/sp-component-base!' + fullName: aadTokenProviderFactory + summary: The instance of AadTokenProviderFactory created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get aadTokenProviderFactory(): AadTokenProviderFactory;' + return: + type: '' + - name: dynamicDataProvider + uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' + package: '@microsoft/sp-component-base!' + fullName: dynamicDataProvider + summary: Returns the Dynamic Data Provider associated with the component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get dynamicDataProvider(): DynamicDataProvider;' + return: + type: '' + - name: dynamicDataSourceManager + uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' + package: '@microsoft/sp-component-base!' + fullName: dynamicDataSourceManager + summary: Returns the Dynamic Data Source Manager associated with the component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get dynamicDataSourceManager(): DynamicDataSourceManager;' + return: + type: '' + - name: httpClient + uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' + package: '@microsoft/sp-component-base!' + fullName: httpClient + summary: The instance of HttpClient created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get httpClient(): HttpClient;' + return: + type: '' + - name: instanceId + uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' + package: '@microsoft/sp-component-base!' + fullName: instanceId + summary: A unique identifier for the instance of the component. + remarks: >- + A component implementation can be loaded multiple times on the page. For example, if the component is a charting + web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely + identifies each of these instances. + isPreview: false + isDeprecated: false + syntax: + content: 'get instanceId(): string;' + return: + type: string + - name: isDisposed + uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the context is disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean + - name: isServedFromLocalhost + uid: '@microsoft/sp-component-base!BaseComponentContext#isServedFromLocalhost:member' + package: '@microsoft/sp-component-base!' + fullName: isServedFromLocalhost + summary: Returns true if the solution is being served from localhost + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isServedFromLocalhost(): boolean;' + return: + type: boolean + - name: manifest + uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' + package: '@microsoft/sp-component-base!' + fullName: manifest + summary: Manifest for the client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IClientSideComponentManifest;' + return: + type: '' + - name: msGraphClientFactory + uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' + package: '@microsoft/sp-component-base!' + fullName: msGraphClientFactory + summary: The instance of MSGraphClientFactory created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get msGraphClientFactory(): MSGraphClientFactory;' + return: + type: '' + - name: pageContext + uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' + package: '@microsoft/sp-component-base!' + fullName: pageContext + summary: >- + The page context provides standard definitions for common SharePoint objects that need to be shared between the + client-side application, web parts, and other components. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get pageContext(): PageContext;' + return: + type: '' + - name: serviceScope + uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' + package: '@microsoft/sp-component-base!' + fullName: serviceScope + summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' + remarks: A child service scope is created for each client-side component. + isPreview: false + isDeprecated: false + syntax: + content: 'get serviceScope(): ServiceScope;' + return: + type: '' + - name: spHttpClient + uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' + package: '@microsoft/sp-component-base!' + fullName: spHttpClient + summary: The instance of SpHttpClient created for this instance of component + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get spHttpClient(): SPHttpClient;' + return: + type: '' +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: Disposes the base component context. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 58b01f86..e71293e0 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -1,191 +1,191 @@ -### YamlMime:TSType -name: DynamicDataProvider -uid: '@microsoft/sp-component-base!DynamicDataProvider:class' -package: '@microsoft/sp-component-base!' -fullName: DynamicDataProvider -summary: >- - The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data - sources and register/unregister to those. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: isDisposed - uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: Returns true if the Dynamic Data Provider is disposed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: Disposes the Dynamic Data Provider. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: getAvailableSources() - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' - package: '@microsoft/sp-component-base!' - fullName: getAvailableSources() - summary: Returns a list with all available Dynamic Data Sources. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getAvailableSources(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' - description: Read-only array with all available sources. - - name: registerAvailableSourcesChanged(callback) - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: registerAvailableSourcesChanged(callback) - summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'registerAvailableSourcesChanged(callback: () => void): void;' - parameters: - - id: callback - description: Function to execute when the sources are updated. - type: () => void - return: - type: void - description: '' - - name: 'registerPropertyChanged(sourceId, propertyId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' - summary: Registers a callback for updates when a property is changed in a Dynamic Data source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' - parameters: - - id: sourceId - description: Id of the Dynamic Data Source. - type: string - - id: propertyId - description: Id of the property of the source. - type: string - - id: callback - description: Function to execute when the source updates its data. - type: () => void - return: - type: void - description: '' - - name: 'registerSourceChanged(sourceId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'registerSourceChanged(sourceId, callback)' - summary: >- - Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated - within the source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'registerSourceChanged(sourceId: string, callback: () => void): void;' - parameters: - - id: sourceId - description: Id of the Dynamic Data Source. - type: string - - id: callback - description: Function to execute when the source updates its data. - type: () => void - return: - type: void - description: '' - - name: tryGetSource(id) - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetSource(id) - summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetSource(id: string): IDynamicDataSource | undefined;' - parameters: - - id: id - description: Id of the Dynamic Data Source. - type: string - return: - type: ' | undefined' - description: '' - - name: unregisterAvailableSourcesChanged(callback) - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: unregisterAvailableSourcesChanged(callback) - summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'unregisterAvailableSourcesChanged(callback: () => void): void;' - parameters: - - id: callback - description: Function to remove from the registration. Must be the same it was registered with. - type: () => void - return: - type: void - description: '' - - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' - parameters: - - id: sourceId - description: Id of the Dynamic Data Source. - type: string - - id: propertyId - description: Id of the property of the source. - type: string - - id: callback - description: Function to remove from the registration. Must be the same it was registered with. - type: () => void - return: - type: void - description: '' - - name: 'unregisterSourceChanged(sourceId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'unregisterSourceChanged(sourceId, callback)' - summary: Unregisters a callback for updates when a Dynamic Data source is changed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'unregisterSourceChanged(sourceId: string, callback: () => void): void;' - parameters: - - id: sourceId - description: Id of the Dynamic Data Source. - type: string - - id: callback - description: Function to remove from the registration. Must be the same it was registered with. - type: () => void - return: - type: void - description: '' +### YamlMime:TSType +name: DynamicDataProvider +uid: '@microsoft/sp-component-base!DynamicDataProvider:class' +package: '@microsoft/sp-component-base!' +fullName: DynamicDataProvider +summary: >- + The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data + sources and register/unregister to those. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: isDisposed + uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the Dynamic Data Provider is disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: Disposes the Dynamic Data Provider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: getAvailableSources() + uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' + package: '@microsoft/sp-component-base!' + fullName: getAvailableSources() + summary: Returns a list with all available Dynamic Data Sources. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getAvailableSources(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + description: Read-only array with all available sources. + - name: registerAvailableSourcesChanged(callback) + uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: registerAvailableSourcesChanged(callback) + summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'registerAvailableSourcesChanged(callback: () => void): void;' + parameters: + - id: callback + description: Function to execute when the sources are updated. + type: () => void + return: + type: void + description: '' + - name: 'registerPropertyChanged(sourceId, propertyId, callback)' + uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' + summary: Registers a callback for updates when a property is changed in a Dynamic Data source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: string + - id: propertyId + description: Id of the property of the source. + type: string + - id: callback + description: Function to execute when the source updates its data. + type: () => void + return: + type: void + description: '' + - name: 'registerSourceChanged(sourceId, callback)' + uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: 'registerSourceChanged(sourceId, callback)' + summary: >- + Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated + within the source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'registerSourceChanged(sourceId: string, callback: () => void): void;' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: string + - id: callback + description: Function to execute when the source updates its data. + type: () => void + return: + type: void + description: '' + - name: tryGetSource(id) + uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetSource(id) + summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetSource(id: string): IDynamicDataSource | undefined;' + parameters: + - id: id + description: Id of the Dynamic Data Source. + type: string + return: + type: ' | undefined' + description: '' + - name: unregisterAvailableSourcesChanged(callback) + uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: unregisterAvailableSourcesChanged(callback) + summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'unregisterAvailableSourcesChanged(callback: () => void): void;' + parameters: + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + type: () => void + return: + type: void + description: '' + - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: string + - id: propertyId + description: Id of the property of the source. + type: string + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + type: () => void + return: + type: void + description: '' + - name: 'unregisterSourceChanged(sourceId, callback)' + uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: 'unregisterSourceChanged(sourceId, callback)' + summary: Unregisters a callback for updates when a Dynamic Data source is changed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'unregisterSourceChanged(sourceId: string, callback: () => void): void;' + parameters: + - id: sourceId + description: Id of the Dynamic Data Source. + type: string + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + type: () => void + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index eed48b9e..24f4b636 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -1,130 +1,130 @@ -### YamlMime:TSType -name: DynamicDataSourceManager -uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' -package: '@microsoft/sp-component-base!' -fullName: DynamicDataSourceManager -summary: >- - The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization - of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been - updated. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: isDisposed - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: Returns true if the DynamicDataSourceManager is disposed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: sourceId - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' - package: '@microsoft/sp-component-base!' - fullName: sourceId - summary: >- - Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it - returns an empty string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get sourceId(): string;' - return: - type: string -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: Disposes the resources held by the Dynamic Data source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: initializeSource(callableFunctions) - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' - package: '@microsoft/sp-component-base!' - fullName: initializeSource(callableFunctions) - summary: Initializes the Dynamic Data Source for the component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'initializeSource(callableFunctions: IDynamicDataCallables): void;' - parameters: - - id: callableFunctions - description: Set of methods that are exposed through the Dynamic Data Source - type: '' - return: - type: void - description: '' - - name: notifyPropertyChanged(propertyId) - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: notifyPropertyChanged(propertyId) - summary: >- - Notifies that this source has updated a specific property. - - - When invoked, it enables to broadcast the notification to all the consumers who have registered to this - notification from this source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'notifyPropertyChanged(propertyId: string): void;' - parameters: - - id: propertyId - description: Id of the updated property in the source. - type: string - return: - type: void - description: '' - - name: notifySourceChanged() - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: notifySourceChanged() - summary: >- - Notifies that this source has updated its properties. - - - When invoked, it enables to broadcast the notification to all the consumers who have registered to this - notification from this source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'notifySourceChanged(): void;' - return: - type: void - description: '' - - name: updateMetadata(metadata) - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' - package: '@microsoft/sp-component-base!' - fullName: updateMetadata(metadata) - summary: >- - Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. - Auto-generated fields like alias, componentId or instanceId cannot be updated. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'updateMetadata(metadata: Partial): void;' - parameters: - - id: metadata - description: Partial of the metadata. - type: 'Partial<>' - return: - type: void - description: '' +### YamlMime:TSType +name: DynamicDataSourceManager +uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' +package: '@microsoft/sp-component-base!' +fullName: DynamicDataSourceManager +summary: >- + The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization + of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been + updated. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: isDisposed + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: Returns true if the DynamicDataSourceManager is disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean + - name: sourceId + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' + package: '@microsoft/sp-component-base!' + fullName: sourceId + summary: >- + Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it + returns an empty string. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get sourceId(): string;' + return: + type: string +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: Disposes the resources held by the Dynamic Data source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: initializeSource(callableFunctions) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' + package: '@microsoft/sp-component-base!' + fullName: initializeSource(callableFunctions) + summary: Initializes the Dynamic Data Source for the component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'initializeSource(callableFunctions: IDynamicDataCallables): void;' + parameters: + - id: callableFunctions + description: Set of methods that are exposed through the Dynamic Data Source + type: '' + return: + type: void + description: '' + - name: notifyPropertyChanged(propertyId) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: notifyPropertyChanged(propertyId) + summary: >- + Notifies that this source has updated a specific property. + + + When invoked, it enables to broadcast the notification to all the consumers who have registered to this + notification from this source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'notifyPropertyChanged(propertyId: string): void;' + parameters: + - id: propertyId + description: Id of the updated property in the source. + type: string + return: + type: void + description: '' + - name: notifySourceChanged() + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' + package: '@microsoft/sp-component-base!' + fullName: notifySourceChanged() + summary: >- + Notifies that this source has updated its properties. + + + When invoked, it enables to broadcast the notification to all the consumers who have registered to this + notification from this source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'notifySourceChanged(): void;' + return: + type: void + description: '' + - name: updateMetadata(metadata) + uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' + package: '@microsoft/sp-component-base!' + fullName: updateMetadata(metadata) + summary: >- + Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. + Auto-generated fields like alias, componentId or instanceId cannot be updated. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'updateMetadata(metadata: Partial): void;' + parameters: + - id: metadata + description: Partial of the metadata. + type: 'Partial<>' + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 0090cbd6..06a12a5e 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -1,226 +1,226 @@ -### YamlMime:TSType -name: DynamicProperty -uid: '@microsoft/sp-component-base!DynamicProperty:class' -package: '@microsoft/sp-component-base!' -fullName: DynamicProperty -summary: Serializable object that simplifies usage of a DynamicProperty. -remarks: >- - This is built for usage in web part properties, and modified through the property pane. Can be initialized with a - default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in - the DynamicProperty will re-render the web part automatically. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(provider, callback)' - uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' - package: '@microsoft/sp-component-base!' - fullName: '(constructor)(provider, callback)' - summary: Create a new DynamicProperty object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' - parameters: - - id: provider - description: DynamicDataProvider. - type: '' - - id: callback - description: Optional. Default callback to be registered for updates in the DynamicDataSource. - type: () => void -properties: - - name: isDisposed - uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: >- - Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state - permanently. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: reference - uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' - package: '@microsoft/sp-component-base!' - fullName: reference - summary: >- - DynamicDataReference string that the DynamicProperty object points to. The reference is of the form - `::`. - remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' - isPreview: false - isDeprecated: false - syntax: - content: 'get reference(): string | undefined;' - return: - type: string | undefined -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: hasDefaultCallback() - uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' - package: '@microsoft/sp-component-base!' - fullName: hasDefaultCallback() - summary: Returns true if the object has a default callback. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'hasDefaultCallback(): boolean;' - return: - type: boolean - description: '' - - name: register(callback) - uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' - package: '@microsoft/sp-component-base!' - fullName: register(callback) - summary: Registers a callback function for updates on the associated DynamicDataSource. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'register(callback: () => void): void;' - parameters: - - id: callback - description: Callback function to register. - type: () => void - return: - type: void - description: '' - - name: removeDefaultCallback() - uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' - package: '@microsoft/sp-component-base!' - fullName: removeDefaultCallback() - summary: Removes the registration for the default callback. - remarks: This can be useful for advanced users who only want their custom callbacks. - isPreview: false - isDeprecated: false - syntax: - content: 'removeDefaultCallback(): void;' - return: - type: void - description: '' - - name: setReference(reference) - uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' - package: '@microsoft/sp-component-base!' - fullName: setReference(reference) - summary: >- - Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is - of the form `::`. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setReference(reference: string): void;' - parameters: - - id: reference - description: Id of the DynamicDataSource and property. - type: string - return: - type: void - description: '' - - name: setValue(value) - uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' - package: '@microsoft/sp-component-base!' - fullName: setValue(value) - summary: Sets a static value in the DynamicProperty. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setValue(value: TValue): void;' - parameters: - - id: value - description: Value for the DynamicProperty. - type: TValue - return: - type: void - description: '' - - name: tryGetSource() - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetSource() - summary: >- - Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't - exist. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetSource(): IDynamicDataSource | undefined;' - return: - type: ' | undefined' - description: '' - - name: tryGetValue() - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetValue() - summary: Returns the value of the object. - remarks: >- - If the value is an array, then the first element of the array is returned; otherwise, the value itself is - returned. - - - NOTE: This api will never return an array. To retrieve an array value, use the - [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetValue(): TValue | undefined;' - return: - type: TValue | undefined - description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. - - name: tryGetValues() - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetValues() - summary: Returns the value of the object. - remarks: >- - If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the - value itself is returned. If the property is undefined or cannot be found, an empty array will be returned. - - - NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array - value, use the - [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetValues(): TValue[];' - return: - type: 'TValue[]' - description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - - name: unregister(callback) - uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' - package: '@microsoft/sp-component-base!' - fullName: unregister(callback) - summary: >- - Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the - same it was registered with. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'unregister(callback: () => void): void;' - parameters: - - id: callback - description: Callback function to unregister. - type: () => void - return: - type: void - description: '' +### YamlMime:TSType +name: DynamicProperty +uid: '@microsoft/sp-component-base!DynamicProperty:class' +package: '@microsoft/sp-component-base!' +fullName: DynamicProperty +summary: Serializable object that simplifies usage of a DynamicProperty. +remarks: >- + This is built for usage in web part properties, and modified through the property pane. Can be initialized with a + default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in + the DynamicProperty will re-render the web part automatically. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(provider, callback)' + uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' + package: '@microsoft/sp-component-base!' + fullName: '(constructor)(provider, callback)' + summary: Create a new DynamicProperty object. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' + parameters: + - id: provider + description: DynamicDataProvider. + type: '' + - id: callback + description: Optional. Default callback to be registered for updates in the DynamicDataSource. + type: () => void +properties: + - name: isDisposed + uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' + package: '@microsoft/sp-component-base!' + fullName: isDisposed + summary: >- + Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state + permanently. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + isPreview: false + isDeprecated: false + syntax: + content: 'get isDisposed(): boolean;' + return: + type: boolean + - name: reference + uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' + package: '@microsoft/sp-component-base!' + fullName: reference + summary: >- + DynamicDataReference string that the DynamicProperty object points to. The reference is of the form + `::`. + remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' + isPreview: false + isDeprecated: false + syntax: + content: 'get reference(): string | undefined;' + return: + type: string | undefined +methods: + - name: dispose() + uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' + package: '@microsoft/sp-component-base!' + fullName: dispose() + summary: This method is called to permanently dispose the object. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: hasDefaultCallback() + uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' + package: '@microsoft/sp-component-base!' + fullName: hasDefaultCallback() + summary: Returns true if the object has a default callback. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasDefaultCallback(): boolean;' + return: + type: boolean + description: '' + - name: register(callback) + uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' + package: '@microsoft/sp-component-base!' + fullName: register(callback) + summary: Registers a callback function for updates on the associated DynamicDataSource. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'register(callback: () => void): void;' + parameters: + - id: callback + description: Callback function to register. + type: () => void + return: + type: void + description: '' + - name: removeDefaultCallback() + uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' + package: '@microsoft/sp-component-base!' + fullName: removeDefaultCallback() + summary: Removes the registration for the default callback. + remarks: This can be useful for advanced users who only want their custom callbacks. + isPreview: false + isDeprecated: false + syntax: + content: 'removeDefaultCallback(): void;' + return: + type: void + description: '' + - name: setReference(reference) + uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' + package: '@microsoft/sp-component-base!' + fullName: setReference(reference) + summary: >- + Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is + of the form `::`. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'setReference(reference: string): void;' + parameters: + - id: reference + description: Id of the DynamicDataSource and property. + type: string + return: + type: void + description: '' + - name: setValue(value) + uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' + package: '@microsoft/sp-component-base!' + fullName: setValue(value) + summary: Sets a static value in the DynamicProperty. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'setValue(value: TValue): void;' + parameters: + - id: value + description: Value for the DynamicProperty. + type: TValue + return: + type: void + description: '' + - name: tryGetSource() + uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetSource() + summary: >- + Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't + exist. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetSource(): IDynamicDataSource | undefined;' + return: + type: ' | undefined' + description: '' + - name: tryGetValue() + uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetValue() + summary: Returns the value of the object. + remarks: >- + If the value is an array, then the first element of the array is returned; otherwise, the value itself is + returned. + + + NOTE: This api will never return an array. To retrieve an array value, use the + [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetValue(): TValue | undefined;' + return: + type: TValue | undefined + description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. + - name: tryGetValues() + uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetValues() + summary: Returns the value of the object. + remarks: >- + If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the + value itself is returned. If the property is undefined or cannot be found, an empty array will be returned. + + + NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array + value, use the + [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetValues(): TValue[];' + return: + type: 'TValue[]' + description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. + - name: unregister(callback) + uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' + package: '@microsoft/sp-component-base!' + fullName: unregister(callback) + summary: >- + Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the + same it was registered with. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'unregister(callback: () => void): void;' + parameters: + - id: callback + description: Callback function to unregister. + type: () => void + return: + type: void + description: '' diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml index 456ec3ed..5b401199 100644 --- a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -1,111 +1,111 @@ -### YamlMime:TSType -name: IComponentPropertyMetadata -uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' -package: '@microsoft/sp-component-base!' -fullName: IComponentPropertyMetadata -summary: This is the structure used for map values for component properties metadata. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isHtmlString - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isHtmlString:member' - package: '@microsoft/sp-component-base!' - fullName: isHtmlString - summary: Indicates whether the property should be serialized as HTML. - remarks: >- - This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on - it: - - - - normalizing HTML encodings - - - - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) - - - - search indexing - - - - SharePoint link fix-up - - - Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, - SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply - needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. - isPreview: false - isDeprecated: false - syntax: - content: 'isHtmlString?: boolean;' - return: - type: boolean - - name: isImageSource - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isImageSource:member' - package: '@microsoft/sp-component-base!' - fullName: isImageSource - summary: >- - Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform - services like link fix-up, search indexing, loading from CDN, etc. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isImageSource?: boolean;' - return: - type: boolean - - name: isLink - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isLink:member' - package: '@microsoft/sp-component-base!' - fullName: isLink - summary: >- - Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform - services like search indexing, link fix-up, loading from CDN, etc. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isLink?: boolean;' - return: - type: boolean - - name: isSearchablePlainText - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isSearchablePlainText:member' - package: '@microsoft/sp-component-base!' - fullName: isSearchablePlainText - summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. - remarks: >- - This flag instructs the framework to store the property in a representation that supports search indexing. The - content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML - characters may be stored encoded and appear in search results. If your string contains HTML markup, use the - isHtmlString setting instead. - - - Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. - isPreview: false - isDeprecated: false - syntax: - content: 'isSearchablePlainText?: boolean;' - return: - type: boolean - - name: shouldNotPersist - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#shouldNotPersist:member' - package: '@microsoft/sp-component-base!' - fullName: shouldNotPersist - summary: Indicates if the framework should persist the property on the server. - remarks: >- - Use this for properties that are only important in run-time, and do not need to persist on the server. This can - reduce the size of the serialized data of the component and optimize the component load time. The property value - will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. - The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared - from the run-time property bag. The initial render of your component should not depend on the value of the - property. Setting a default value for the property can be done in `onInit()` method. - - - Note that if the property path refers to a property that has a complex object as the value, the whole object will - be removed from the persisted data. - isPreview: false - isDeprecated: false - syntax: - content: 'shouldNotPersist?: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IComponentPropertyMetadata +uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' +package: '@microsoft/sp-component-base!' +fullName: IComponentPropertyMetadata +summary: This is the structure used for map values for component properties metadata. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isHtmlString + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isHtmlString:member' + package: '@microsoft/sp-component-base!' + fullName: isHtmlString + summary: Indicates whether the property should be serialized as HTML. + remarks: >- + This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on + it: + + + - normalizing HTML encodings + + + - stripping unsafe HTML tags (i.e. for usage with Element.innerHTML) + + + - search indexing + + + - SharePoint link fix-up + + + Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, + SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply + needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. + isPreview: false + isDeprecated: false + syntax: + content: 'isHtmlString?: boolean;' + return: + type: boolean + - name: isImageSource + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isImageSource:member' + package: '@microsoft/sp-component-base!' + fullName: isImageSource + summary: >- + Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform + services like link fix-up, search indexing, loading from CDN, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isImageSource?: boolean;' + return: + type: boolean + - name: isLink + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isLink:member' + package: '@microsoft/sp-component-base!' + fullName: isLink + summary: >- + Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform + services like search indexing, link fix-up, loading from CDN, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isLink?: boolean;' + return: + type: boolean + - name: isSearchablePlainText + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isSearchablePlainText:member' + package: '@microsoft/sp-component-base!' + fullName: isSearchablePlainText + summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. + remarks: >- + This flag instructs the framework to store the property in a representation that supports search indexing. The + content will be treated as plain text; SharePoint will not modify the string in any way, and special HTML + characters may be stored encoded and appear in search results. If your string contains HTML markup, use the + isHtmlString setting instead. + + + Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. + isPreview: false + isDeprecated: false + syntax: + content: 'isSearchablePlainText?: boolean;' + return: + type: boolean + - name: shouldNotPersist + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#shouldNotPersist:member' + package: '@microsoft/sp-component-base!' + fullName: shouldNotPersist + summary: Indicates if the framework should persist the property on the server. + remarks: >- + Use this for properties that are only important in run-time, and do not need to persist on the server. This can + reduce the size of the serialized data of the component and optimize the component load time. The property value + will be removed from the serialized data sent to the server, but this has no effect on the run-time property bag. + The property value will still be available in the `onBeforeSerialize()` method, and the value will not be cleared + from the run-time property bag. The initial render of your component should not depend on the value of the + property. Setting a default value for the property can be done in `onInit()` method. + + + Note that if the property path refers to a property that has a complex object as the value, the whole object will + be removed from the persisted data. + isPreview: false + isDeprecated: false + syntax: + content: 'shouldNotPersist?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 0ab1c860..54f8b747 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IReadonlyFontStyles -uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' -package: '@microsoft/sp-component-base!' -fullName: IReadonlyFontStyles -summary: '' -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: 'Readonly<> ' +### YamlMime:TSType +name: IReadonlyFontStyles +uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' +package: '@microsoft/sp-component-base!' +fullName: IReadonlyFontStyles +summary: '' +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: 'Readonly<> ' diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index a3245568..8bb99cbd 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IReadonlyTheme -uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' -package: '@microsoft/sp-component-base!' -fullName: IReadonlyTheme -summary: Immutable ITheme. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: 'Readonly<> ' +### YamlMime:TSType +name: IReadonlyTheme +uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' +package: '@microsoft/sp-component-base!' +fullName: IReadonlyTheme +summary: Immutable ITheme. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: 'Readonly<> ' diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml index ff3e9585..357da434 100644 --- a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -1,133 +1,133 @@ -### YamlMime:TSType -name: ISerializedServerProcessedData -uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' -package: '@microsoft/sp-component-base!' -fullName: ISerializedServerProcessedData -summary: Contains collections of data that can be processed by server side services like search index and link fixup -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: htmlStrings - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#htmlStrings:member' - package: '@microsoft/sp-component-base!' - fullName: htmlStrings - summary: A key-value map where keys are string identifiers and values are rich text with HTML format. - remarks: >- - SharePoint servers treat the values as HTML content and run services like safety checks, search index and link - fixup on them. - - - Example: - - - ``` - - { - 'myRichDescription': '
Some standard HTML contentA Link
' - 'anotherRichText':
Some red text
- } - - ``` - isPreview: false - isDeprecated: false - syntax: - content: |- - htmlStrings?: { - [key: string]: string; - }; - return: - type: |- - { - [key: string]: string; - } - - name: imageSources - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#imageSources:member' - package: '@microsoft/sp-component-base!' - fullName: imageSources - summary: A key-value map where keys are string identifiers and values are image sources. - remarks: |- - SharePoint servers treat the values as image sources and run services like search index and link fixup on them. - - Example: - - ``` - { - 'myImage1': 'http://res.contoso.com/path/to/file' - 'myImage2': 'https://res.contoso.com/someName.jpg' - } - ``` - isPreview: false - isDeprecated: false - syntax: - content: |- - imageSources?: { - [key: string]: string; - }; - return: - type: |- - { - [key: string]: string; - } - - name: links - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#links:member' - package: '@microsoft/sp-component-base!' - fullName: links - summary: A key-value map where keys are string identifiers and values are links. - remarks: |- - SharePoint servers treat the values as links and run services like link fixup on them. - - Example: - - ``` - { - 'myWebURL': 'http://contoso.com' - 'myFileLink': 'https://res.contoso.com/file.docx' - } - ``` - isPreview: false - isDeprecated: false - syntax: - content: |- - links?: { - [key: string]: string; - }; - return: - type: |- - { - [key: string]: string; - } - - name: searchablePlainTexts - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#searchablePlainTexts:member' - package: '@microsoft/sp-component-base!' - fullName: searchablePlainTexts - summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. - remarks: >- - The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, - but are not treated as valid HTML. So, other services such as link fixup will not run on them. - - - Example: - - - ``` - - { - 'justSomeText': 'This is some plain text', - 'anotherText': 'Can have characters here: "<>&\'' - } - - ``` - isPreview: false - isDeprecated: false - syntax: - content: |- - searchablePlainTexts?: { - [key: string]: string; - }; - return: - type: |- - { - [key: string]: string; - } +### YamlMime:TSType +name: ISerializedServerProcessedData +uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' +package: '@microsoft/sp-component-base!' +fullName: ISerializedServerProcessedData +summary: Contains collections of data that can be processed by server side services like search index and link fixup +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: htmlStrings + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#htmlStrings:member' + package: '@microsoft/sp-component-base!' + fullName: htmlStrings + summary: A key-value map where keys are string identifiers and values are rich text with HTML format. + remarks: >- + SharePoint servers treat the values as HTML content and run services like safety checks, search index and link + fixup on them. + + + Example: + + + ``` + + { + 'myRichDescription': '
Some standard HTML contentA Link
' + 'anotherRichText':
Some red text
+ } + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + htmlStrings?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: imageSources + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#imageSources:member' + package: '@microsoft/sp-component-base!' + fullName: imageSources + summary: A key-value map where keys are string identifiers and values are image sources. + remarks: |- + SharePoint servers treat the values as image sources and run services like search index and link fixup on them. + + Example: + + ``` + { + 'myImage1': 'http://res.contoso.com/path/to/file' + 'myImage2': 'https://res.contoso.com/someName.jpg' + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + imageSources?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: links + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#links:member' + package: '@microsoft/sp-component-base!' + fullName: links + summary: A key-value map where keys are string identifiers and values are links. + remarks: |- + SharePoint servers treat the values as links and run services like link fixup on them. + + Example: + + ``` + { + 'myWebURL': 'http://contoso.com' + 'myFileLink': 'https://res.contoso.com/file.docx' + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + links?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + - name: searchablePlainTexts + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#searchablePlainTexts:member' + package: '@microsoft/sp-component-base!' + fullName: searchablePlainTexts + summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. + remarks: >- + The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, + but are not treated as valid HTML. So, other services such as link fixup will not run on them. + + + Example: + + + ``` + + { + 'justSomeText': 'This is some plain text', + 'anotherText': 'Can have characters here: "<>&\'' + } + + ``` + isPreview: false + isDeprecated: false + syntax: + content: |- + searchablePlainTexts?: { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index ca938cfb..d425f70d 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: ITheme -uid: '@microsoft/sp-component-base!ITheme:interface' -package: '@microsoft/sp-component-base!' -fullName: ITheme -summary: 'Collection of theme values, which can be used to programatically style components.' -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: ITheme +uid: '@microsoft/sp-component-base!ITheme:interface' +package: '@microsoft/sp-component-base!' +fullName: ITheme +summary: 'Collection of theme values, which can be used to programatically style components.' +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index 7e4bd9ce..d8f2a030 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -1,24 +1,24 @@ -### YamlMime:TSType -name: ThemeChangedEventArgs -uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' -package: '@microsoft/sp-component-base!' -fullName: ThemeChangedEventArgs -summary: The object passed when the IThemeProvider.themeChangedEvent is raised. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: theme - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' - package: '@microsoft/sp-component-base!' - fullName: theme - summary: 'The new theme. If the value is undefined, then the theme was cleared.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly theme: ITheme | undefined;' - return: - type: ' | undefined' -extends: '' +### YamlMime:TSType +name: ThemeChangedEventArgs +uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' +package: '@microsoft/sp-component-base!' +fullName: ThemeChangedEventArgs +summary: The object passed when the IThemeProvider.themeChangedEvent is raised. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: theme + uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' + package: '@microsoft/sp-component-base!' + fullName: theme + summary: 'The new theme. If the value is undefined, then the theme was cleared.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly theme: ITheme | undefined;' + return: + type: ' | undefined' +extends: '' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index 45e6cefc..225f13bd 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -1,74 +1,74 @@ -### YamlMime:TSType -name: ThemeProvider -uid: '@microsoft/sp-component-base!ThemeProvider:class' -package: '@microsoft/sp-component-base!' -fullName: ThemeProvider -summary: >- - The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in - different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(serviceScope, theme)' - uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' - package: '@microsoft/sp-component-base!' - fullName: '(constructor)(serviceScope, theme)' - summary: Construct a new instance of the ThemeProvider class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' - parameters: - - id: serviceScope - description: The current service scope. - type: '' - - id: theme - description: Theme to provide. - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' - package: '@microsoft/sp-component-base!' - fullName: serviceKey - summary: The service key for ThemeProvider. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: tryGetTheme() - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetTheme() - summary: 'If set, get the current scoped theme.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetTheme(): IReadonlyTheme | undefined;' - return: - type: ' | undefined' - description: '' -events: - - name: themeChangedEvent - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' - package: '@microsoft/sp-component-base!' - fullName: themeChangedEvent - summary: Raised when the theme changes with the new theme as an argument. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly themeChangedEvent: SPEvent;' - return: - type: >- - <> +### YamlMime:TSType +name: ThemeProvider +uid: '@microsoft/sp-component-base!ThemeProvider:class' +package: '@microsoft/sp-component-base!' +fullName: ThemeProvider +summary: >- + The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in + different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(serviceScope, theme)' + uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' + package: '@microsoft/sp-component-base!' + fullName: '(constructor)(serviceScope, theme)' + summary: Construct a new instance of the ThemeProvider class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' + parameters: + - id: serviceScope + description: The current service scope. + type: '' + - id: theme + description: Theme to provide. + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' + package: '@microsoft/sp-component-base!' + fullName: serviceKey + summary: The service key for ThemeProvider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: tryGetTheme() + uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' + package: '@microsoft/sp-component-base!' + fullName: tryGetTheme() + summary: 'If set, get the current scoped theme.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetTheme(): IReadonlyTheme | undefined;' + return: + type: ' | undefined' + description: '' +events: + - name: themeChangedEvent + uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' + package: '@microsoft/sp-component-base!' + fullName: themeChangedEvent + summary: Raised when the theme changes with the new theme as an argument. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly themeChangedEvent: SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index 1a5d9b92..f8d2e87d 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -1,29 +1,29 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-core-library!' -name: '@microsoft/sp-core-library' -type: package -summary: SharePoint Framework core libraries. -enums: - - '@microsoft/sp-core-library!DisplayMode:enum' - - '@microsoft/sp-core-library!EnvironmentType:enum' -classes: - - '@microsoft/sp-core-library!Environment:class' - - '@microsoft/sp-core-library!Guid:class' - - '@microsoft/sp-core-library!Log:class' - - '@microsoft/sp-core-library!RandomNumberGenerator:class' - - '@microsoft/sp-core-library!ServiceKey:class' - - '@microsoft/sp-core-library!ServiceScope:class' - - '@microsoft/sp-core-library!Session:class' - - '@microsoft/sp-core-library!SPEvent:class' - - '@microsoft/sp-core-library!SPEventArgs:class' - - '@microsoft/sp-core-library!Text_2:class' - - '@microsoft/sp-core-library!TimeProvider:class' - - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - - '@microsoft/sp-core-library!Validate:class' - - '@microsoft/sp-core-library!Version:class' -interfaces: - - '@microsoft/sp-core-library!IDisposable:interface' - - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - - '@microsoft/sp-core-library!IServiceCollection:interface' - - '@microsoft/sp-core-library!ISPEventObserver:interface' - - '@microsoft/sp-core-library!ITimeProvider:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-core-library!' +name: '@microsoft/sp-core-library' +type: package +summary: SharePoint Framework core libraries. +enums: + - '@microsoft/sp-core-library!DisplayMode:enum' + - '@microsoft/sp-core-library!EnvironmentType:enum' +classes: + - '@microsoft/sp-core-library!Environment:class' + - '@microsoft/sp-core-library!Guid:class' + - '@microsoft/sp-core-library!Log:class' + - '@microsoft/sp-core-library!RandomNumberGenerator:class' + - '@microsoft/sp-core-library!ServiceKey:class' + - '@microsoft/sp-core-library!ServiceScope:class' + - '@microsoft/sp-core-library!Session:class' + - '@microsoft/sp-core-library!SPEvent:class' + - '@microsoft/sp-core-library!SPEventArgs:class' + - '@microsoft/sp-core-library!Text_2:class' + - '@microsoft/sp-core-library!TimeProvider:class' + - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + - '@microsoft/sp-core-library!Validate:class' + - '@microsoft/sp-core-library!Version:class' +interfaces: + - '@microsoft/sp-core-library!IDisposable:interface' + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - '@microsoft/sp-core-library!IServiceCollection:interface' + - '@microsoft/sp-core-library!ISPEventObserver:interface' + - '@microsoft/sp-core-library!ITimeProvider:interface' diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index c60d40c6..40dbb5cd 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -1,24 +1,24 @@ -### YamlMime:TSEnum -name: DisplayMode -uid: '@microsoft/sp-core-library!DisplayMode:enum' -package: '@microsoft/sp-core-library!' -fullName: DisplayMode -summary: Indicates whether a visual control should display itself for reading or for editing. -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Edit - uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' - package: '@microsoft/sp-core-library!' - summary: >- - The page, control, or editing surface is in a mode intended for authoring new content. It may display editing - panels or other controls that are not part of the normal reading experience. - value: '2' - - name: Read - uid: '@microsoft/sp-core-library!DisplayMode.Read:member' - package: '@microsoft/sp-core-library!' - summary: >- - The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, - but the authoring controls are not enabled. - value: '1' +### YamlMime:TSEnum +name: DisplayMode +uid: '@microsoft/sp-core-library!DisplayMode:enum' +package: '@microsoft/sp-core-library!' +fullName: DisplayMode +summary: Indicates whether a visual control should display itself for reading or for editing. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Edit + uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' + package: '@microsoft/sp-core-library!' + summary: >- + The page, control, or editing surface is in a mode intended for authoring new content. It may display editing + panels or other controls that are not part of the normal reading experience. + value: '2' + - name: Read + uid: '@microsoft/sp-core-library!DisplayMode.Read:member' + package: '@microsoft/sp-core-library!' + summary: >- + The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, + but the authoring controls are not enabled. + value: '1' diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index e757e9a2..63f3feaf 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: Environment -uid: '@microsoft/sp-core-library!Environment:class' -package: '@microsoft/sp-core-library!' -fullName: Environment -summary: Information about the system environment where the SharePoint Framework is running. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: type - uid: '@microsoft/sp-core-library!Environment.type:member' - package: '@microsoft/sp-core-library!' - fullName: type - summary: Indicates the general type of environment where the SharePoint Framework is running. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static get type(): EnvironmentType;' - return: - type: '' +### YamlMime:TSType +name: Environment +uid: '@microsoft/sp-core-library!Environment:class' +package: '@microsoft/sp-core-library!' +fullName: Environment +summary: Information about the system environment where the SharePoint Framework is running. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: type + uid: '@microsoft/sp-core-library!Environment.type:member' + package: '@microsoft/sp-core-library!' + fullName: type + summary: Indicates the general type of environment where the SharePoint Framework is running. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static get type(): EnvironmentType;' + return: + type: '' diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index e938cddd..080248b9 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -1,42 +1,42 @@ -### YamlMime:TSEnum -name: EnvironmentType -uid: '@microsoft/sp-core-library!EnvironmentType:enum' -package: '@microsoft/sp-core-library!' -fullName: EnvironmentType -summary: Indicates the general type of environment where the SharePoint Framework is running. -remarks: >- - This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It - provides a way to distinguish environments where certain functionality may be limited or disabled. -isPreview: false -isDeprecated: false -fields: - - name: ClassicSharePoint - uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' - package: '@microsoft/sp-core-library!' - summary: >- - Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be - limited, e.g. various extensibility APIs may not be supported. - value: '3' - - name: Local - uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' - package: '@microsoft/sp-core-library!' - summary: >- - Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the - SharePoint Workbench when hosted via "gulp serve". SharePoint REST API calls will not be available, and in general - network access may not authenticate properly. Certain page context information may be using mock values for - testing. - value: '1' - - name: SharePoint - uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' - package: '@microsoft/sp-core-library!' - summary: >- - Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework - functionality. This is the normal usage scenario. - value: '2' - - name: Test - uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' - package: '@microsoft/sp-core-library!' - summary: >- - Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user - interaction at all, and network access in general may be disabled. - value: '0' +### YamlMime:TSEnum +name: EnvironmentType +uid: '@microsoft/sp-core-library!EnvironmentType:enum' +package: '@microsoft/sp-core-library!' +fullName: EnvironmentType +summary: Indicates the general type of environment where the SharePoint Framework is running. +remarks: >- + This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It + provides a way to distinguish environments where certain functionality may be limited or disabled. +isPreview: false +isDeprecated: false +fields: + - name: ClassicSharePoint + uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be + limited, e.g. various extensibility APIs may not be supported. + value: '3' + - name: Local + uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the + SharePoint Workbench when hosted via "gulp serve". SharePoint REST API calls will not be available, and in general + network access may not authenticate properly. Certain page context information may be using mock values for + testing. + value: '1' + - name: SharePoint + uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework + functionality. This is the normal usage scenario. + value: '2' + - name: Test + uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' + package: '@microsoft/sp-core-library!' + summary: >- + Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user + interaction at all, and network access in general may be disabled. + value: '0' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 9d56417a..1186619d 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -1,155 +1,155 @@ -### YamlMime:TSType -name: Guid -uid: '@microsoft/sp-core-library!Guid:class' -package: '@microsoft/sp-core-library!' -fullName: Guid -summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' -remarks: >- - The input string is normalized and validated, which provides important guarantees that simplify other code that works - with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the - uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications. - - - See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. -isPreview: false -isDeprecated: false -type: class -properties: - - name: empty - uid: '@microsoft/sp-core-library!Guid.empty:member' - package: '@microsoft/sp-core-library!' - fullName: empty - summary: Returns a new empty Guid instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly empty: Guid;' - return: - type: '' -methods: - - name: equals(guid) - uid: '@microsoft/sp-core-library!Guid#equals:member(1)' - package: '@microsoft/sp-core-library!' - fullName: equals(guid) - summary: Compare this instance to another Guid instance - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'equals(guid: Guid): boolean;' - parameters: - - id: guid - description: '' - type: '' - return: - type: boolean - description: True if this instance and the specified Guid object represent the same value. - - name: isValid(guid) - uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' - package: '@microsoft/sp-core-library!' - fullName: isValid(guid) - summary: >- - Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This - function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static isValid(guid: string | undefined | null): boolean;' - parameters: - - id: guid - description: The input string. - type: string | undefined | null - return: - type: boolean - description: 'true, if the Guid is valid.' - - name: newGuid(randomNumberGenerator) - uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' - package: '@microsoft/sp-core-library!' - fullName: newGuid(randomNumberGenerator) - summary: >- - Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from - RFC 4122. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' - parameters: - - id: randomNumberGenerator - description: '' - type: '' - return: - type: '' - description: A new unique Guid object - - name: parse(guidString) - uid: '@microsoft/sp-core-library!Guid.parse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: parse(guidString) - summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' - remarks: |- - Example syntaxes accepted by this function: - - - `"d5369f3bbd7a412a9c0f7f0650bb5489"` - - - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` - - - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - - - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - isPreview: false - isDeprecated: false - syntax: - content: 'static parse(guidString: string | undefined | null): Guid;' - parameters: - - id: guidString - description: '' - type: string | undefined | null - return: - type: '' - description: A valid Guid object - - name: toString() - uid: '@microsoft/sp-core-library!Guid#toString:member(1)' - package: '@microsoft/sp-core-library!' - fullName: toString() - summary: Returns a string representation of the GUID - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'toString(): string;' - return: - type: string - description: |- - The GUID value in lowercase hexadecimal without braces. - - Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` - - name: tryParse(guid) - uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: tryParse(guid) - summary: >- - Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined - is returned. - remarks: |- - Example syntaxes accepted by this function: - - - `"d5369f3bbd7a412a9c0f7f0650bb5489"` - - - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` - - - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - - - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - isPreview: false - isDeprecated: false - syntax: - content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' - parameters: - - id: guid - description: The input string. - type: string | undefined | null - return: - type: ' | undefined' - description: 'The Guid object, or undefined if the string could not be parsed.' +### YamlMime:TSType +name: Guid +uid: '@microsoft/sp-core-library!Guid:class' +package: '@microsoft/sp-core-library!' +fullName: Guid +summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' +remarks: >- + The input string is normalized and validated, which provides important guarantees that simplify other code that works + with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the + uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications. + + + See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. +isPreview: false +isDeprecated: false +type: class +properties: + - name: empty + uid: '@microsoft/sp-core-library!Guid.empty:member' + package: '@microsoft/sp-core-library!' + fullName: empty + summary: Returns a new empty Guid instance. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly empty: Guid;' + return: + type: '' +methods: + - name: equals(guid) + uid: '@microsoft/sp-core-library!Guid#equals:member(1)' + package: '@microsoft/sp-core-library!' + fullName: equals(guid) + summary: Compare this instance to another Guid instance + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'equals(guid: Guid): boolean;' + parameters: + - id: guid + description: '' + type: '' + return: + type: boolean + description: True if this instance and the specified Guid object represent the same value. + - name: isValid(guid) + uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' + package: '@microsoft/sp-core-library!' + fullName: isValid(guid) + summary: >- + Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This + function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isValid(guid: string | undefined | null): boolean;' + parameters: + - id: guid + description: The input string. + type: string | undefined | null + return: + type: boolean + description: 'true, if the Guid is valid.' + - name: newGuid(randomNumberGenerator) + uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' + package: '@microsoft/sp-core-library!' + fullName: newGuid(randomNumberGenerator) + summary: >- + Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from + RFC 4122. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' + parameters: + - id: randomNumberGenerator + description: '' + type: '' + return: + type: '' + description: A new unique Guid object + - name: parse(guidString) + uid: '@microsoft/sp-core-library!Guid.parse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: parse(guidString) + summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' + remarks: |- + Example syntaxes accepted by this function: + + - `"d5369f3bbd7a412a9c0f7f0650bb5489"` + + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` + + - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` + + - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` + isPreview: false + isDeprecated: false + syntax: + content: 'static parse(guidString: string | undefined | null): Guid;' + parameters: + - id: guidString + description: '' + type: string | undefined | null + return: + type: '' + description: A valid Guid object + - name: toString() + uid: '@microsoft/sp-core-library!Guid#toString:member(1)' + package: '@microsoft/sp-core-library!' + fullName: toString() + summary: Returns a string representation of the GUID + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'toString(): string;' + return: + type: string + description: |- + The GUID value in lowercase hexadecimal without braces. + + Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` + - name: tryParse(guid) + uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: tryParse(guid) + summary: >- + Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined + is returned. + remarks: |- + Example syntaxes accepted by this function: + + - `"d5369f3bbd7a412a9c0f7f0650bb5489"` + + - `"d5369f3b-bd7a-412a-9c0f-7f0650bb5489"` + + - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` + + - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` + isPreview: false + isDeprecated: false + syntax: + content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' + parameters: + - id: guid + description: The input string. + type: string | undefined | null + return: + type: ' | undefined' + description: 'The Guid object, or undefined if the string could not be parsed.' diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 7081768a..2fd58909 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: IDisposable -uid: '@microsoft/sp-core-library!IDisposable:interface' -package: '@microsoft/sp-core-library!' -fullName: IDisposable -summary: Implemented by an object that supports a disposal lifecycle. -remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isDisposed - uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' - package: '@microsoft/sp-core-library!' - fullName: isDisposed - summary: >- - Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state - permanently. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - isPreview: false - isDeprecated: false - syntax: - content: 'isDisposed: boolean;' - return: - type: boolean -methods: - - name: dispose() - uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' - package: '@microsoft/sp-core-library!' - fullName: dispose() - summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' +### YamlMime:TSType +name: IDisposable +uid: '@microsoft/sp-core-library!IDisposable:interface' +package: '@microsoft/sp-core-library!' +fullName: IDisposable +summary: Implemented by an object that supports a disposal lifecycle. +remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isDisposed + uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' + package: '@microsoft/sp-core-library!' + fullName: isDisposed + summary: >- + Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state + permanently. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + isPreview: false + isDeprecated: false + syntax: + content: 'isDisposed: boolean;' + return: + type: boolean +methods: + - name: dispose() + uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' + package: '@microsoft/sp-core-library!' + fullName: dispose() + summary: This method is called to permanently dispose the object. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 2ea40fba..efc147ed 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -1,31 +1,31 @@ -### YamlMime:TSType -name: IRandomNumberGenerator -uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' -package: '@microsoft/sp-core-library!' -fullName: IRandomNumberGenerator -summary: >- - This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom - random numbers. -remarks: >- - This interface abstracts the functionality of the system Math.random() API for usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the - default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock - implementation that always returns the same sequence of random numbers, in order to ensure that test failures are - always repeatable. -isPreview: false -isDeprecated: false -type: interface -methods: - - name: generate() - uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' - package: '@microsoft/sp-core-library!' - fullName: generate() - summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'generate(): number;' - return: - type: number - description: '' +### YamlMime:TSType +name: IRandomNumberGenerator +uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' +package: '@microsoft/sp-core-library!' +fullName: IRandomNumberGenerator +summary: >- + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom + random numbers. +remarks: >- + This interface abstracts the functionality of the system Math.random() API for usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the + default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock + implementation that always returns the same sequence of random numbers, in order to ensure that test failures are + always repeatable. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: generate() + uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: generate() + summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'generate(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index eaa443f7..dd5a803e 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -1,26 +1,26 @@ -### YamlMime:TSType -name: IServiceCollection -uid: '@microsoft/sp-core-library!IServiceCollection:interface' -package: '@microsoft/sp-core-library!' -fullName: IServiceCollection -summary: A shorthand pattern for extracting well-known services from a ServiceScope. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future - release. -type: interface -properties: - - name: serviceScope - uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' - package: '@microsoft/sp-core-library!' - fullName: serviceScope - summary: Returns the underlying ServiceScope that the members belong to. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly serviceScope: ServiceScope;' - return: - type: '' +### YamlMime:TSType +name: IServiceCollection +uid: '@microsoft/sp-core-library!IServiceCollection:interface' +package: '@microsoft/sp-core-library!' +fullName: IServiceCollection +summary: A shorthand pattern for extracting well-known services from a ServiceScope. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future + release. +type: interface +properties: + - name: serviceScope + uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' + package: '@microsoft/sp-core-library!' + fullName: serviceScope + summary: Returns the underlying ServiceScope that the members belong to. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serviceScope: ServiceScope;' + return: + type: '' diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 5ee221e0..a6b3b32e 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -1,42 +1,42 @@ -### YamlMime:TSType -name: ISPEventObserver -uid: '@microsoft/sp-core-library!ISPEventObserver:interface' -package: '@microsoft/sp-core-library!' -fullName: ISPEventObserver -summary: >- - Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by - components that can subscribe to events. -remarks: >- - ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a - SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must - have a way to notify the event system when the component is disposed, so that its handlers can be automatically - removed. Other objects may implement this contract, as long as they meet these requirements. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: componentId - uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' - package: '@microsoft/sp-core-library!' - fullName: componentId - summary: 'The component identifier, from the component''s manifest.' - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly componentId: string;' - return: - type: string - - name: instanceId - uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' - package: '@microsoft/sp-core-library!' - fullName: instanceId - summary: The instance identifier for the component. - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly instanceId: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: ISPEventObserver +uid: '@microsoft/sp-core-library!ISPEventObserver:interface' +package: '@microsoft/sp-core-library!' +fullName: ISPEventObserver +summary: >- + Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by + components that can subscribe to events. +remarks: >- + ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a + SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must + have a way to notify the event system when the component is disposed, so that its handlers can be automatically + removed. Other objects may implement this contract, as long as they meet these requirements. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: componentId + uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' + package: '@microsoft/sp-core-library!' + fullName: componentId + summary: 'The component identifier, from the component''s manifest.' + remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly componentId: string;' + return: + type: string + - name: instanceId + uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' + package: '@microsoft/sp-core-library!' + fullName: instanceId + summary: The instance identifier for the component. + remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly instanceId: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 89e6a424..993757e7 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -1,41 +1,41 @@ -### YamlMime:TSType -name: ITimeProvider -uid: '@microsoft/sp-core-library!ITimeProvider:interface' -package: '@microsoft/sp-core-library!' -fullName: ITimeProvider -summary: 'This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system clock.' -remarks: >- - This interface abstracts the functionality of the system time APIs for usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the - default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that - follows a manually incremented timeline, in order to ensure that test failures are always repeatable. -isPreview: false -isDeprecated: false -type: interface -methods: - - name: getDate() - uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getDate() - summary: 'Returns the current date/time, similar to the Date class constructor.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getDate(): Date;' - return: - type: Date - description: '' - - name: getTimestamp() - uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getTimestamp() - summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getTimestamp(): number;' - return: - type: number - description: '' +### YamlMime:TSType +name: ITimeProvider +uid: '@microsoft/sp-core-library!ITimeProvider:interface' +package: '@microsoft/sp-core-library!' +fullName: ITimeProvider +summary: 'This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system clock.' +remarks: >- + This interface abstracts the functionality of the system time APIs for usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the + default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that + follows a manually incremented timeline, in order to ensure that test failures are always repeatable. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: getDate() + uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getDate() + summary: 'Returns the current date/time, similar to the Date class constructor.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getDate(): Date;' + return: + type: Date + description: '' + - name: getTimestamp() + uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getTimestamp() + summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getTimestamp(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index 68641d66..b0306811 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -1,122 +1,122 @@ -### YamlMime:TSType -name: Log -uid: '@microsoft/sp-core-library!Log:class' -package: '@microsoft/sp-core-library!' -fullName: Log -summary: A basic redirectable logging system. -remarks: >- - The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and - with context information. Context information helps identify which component generated the messages and allows for - filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'error(source, error, scope)' - uid: '@microsoft/sp-core-library!Log.error:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'error(source, error, scope)' - summary: Logs an error. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static error(source: string, error: Error, scope?: ServiceScope): void;' - parameters: - - id: source - description: >- - the source from where the error is logged, e.g., the class name. The source provides context information for - the logged error. If the source's length is more than 20, only the first 20 characters are kept. - type: string - - id: error - description: the error to be logged - type: Error - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged error. - type: '' - return: - type: void - description: '' - - name: 'info(source, message, scope)' - uid: '@microsoft/sp-core-library!Log.info:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'info(source, message, scope)' - summary: Logs a general informational message. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static info(source: string, message: string, scope?: ServiceScope): void;' - parameters: - - id: source - description: >- - the source from where the message is logged, e.g., the class name. The source provides context information - for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: string - - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: string - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged message. - type: '' - return: - type: void - description: '' - - name: 'verbose(source, message, scope)' - uid: '@microsoft/sp-core-library!Log.verbose:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'verbose(source, message, scope)' - summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static verbose(source: string, message: string, scope?: ServiceScope): void;' - parameters: - - id: source - description: >- - the source from where the message is logged, e.g., the class name. The source provides context information - for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: string - - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: string - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged message. - type: '' - return: - type: void - description: '' - - name: 'warn(source, message, scope)' - uid: '@microsoft/sp-core-library!Log.warn:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'warn(source, message, scope)' - summary: Logs a warning. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static warn(source: string, message: string, scope?: ServiceScope): void;' - parameters: - - id: source - description: >- - the source from where the message is logged, e.g., the class name. The source provides context information - for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: string - - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: string - - id: scope - description: >- - the service scope that the source uses. A service scope can provide more context information (e.g., web part - information) to the logged message. - type: '' - return: - type: void - description: '' +### YamlMime:TSType +name: Log +uid: '@microsoft/sp-core-library!Log:class' +package: '@microsoft/sp-core-library!' +fullName: Log +summary: A basic redirectable logging system. +remarks: >- + The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and + with context information. Context information helps identify which component generated the messages and allows for + filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'error(source, error, scope)' + uid: '@microsoft/sp-core-library!Log.error:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'error(source, error, scope)' + summary: Logs an error. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static error(source: string, error: Error, scope?: ServiceScope): void;' + parameters: + - id: source + description: >- + the source from where the error is logged, e.g., the class name. The source provides context information for + the logged error. If the source's length is more than 20, only the first 20 characters are kept. + type: string + - id: error + description: the error to be logged + type: Error + - id: scope + description: >- + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged error. + type: '' + return: + type: void + description: '' + - name: 'info(source, message, scope)' + uid: '@microsoft/sp-core-library!Log.info:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'info(source, message, scope)' + summary: Logs a general informational message. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static info(source: string, message: string, scope?: ServiceScope): void;' + parameters: + - id: source + description: >- + the source from where the message is logged, e.g., the class name. The source provides context information + for the logged message. If the source's length is more than 20, only the first 20 characters are kept. + type: string + - id: message + description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' + type: string + - id: scope + description: >- + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged message. + type: '' + return: + type: void + description: '' + - name: 'verbose(source, message, scope)' + uid: '@microsoft/sp-core-library!Log.verbose:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'verbose(source, message, scope)' + summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static verbose(source: string, message: string, scope?: ServiceScope): void;' + parameters: + - id: source + description: >- + the source from where the message is logged, e.g., the class name. The source provides context information + for the logged message. If the source's length is more than 20, only the first 20 characters are kept. + type: string + - id: message + description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' + type: string + - id: scope + description: >- + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged message. + type: '' + return: + type: void + description: '' + - name: 'warn(source, message, scope)' + uid: '@microsoft/sp-core-library!Log.warn:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'warn(source, message, scope)' + summary: Logs a warning. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static warn(source: string, message: string, scope?: ServiceScope): void;' + parameters: + - id: source + description: >- + the source from where the message is logged, e.g., the class name. The source provides context information + for the logged message. If the source's length is more than 20, only the first 20 characters are kept. + type: string + - id: message + description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' + type: string + - id: scope + description: >- + the service scope that the source uses. A service scope can provide more context information (e.g., web part + information) to the logged message. + type: '' + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index ccf6b9a2..5ca03bb7 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -1,57 +1,57 @@ -### YamlMime:TSType -name: RandomNumberGenerator -uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' -package: '@microsoft/sp-core-library!' -fullName: RandomNumberGenerator -summary: >- - This is the default implementation of - [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls - Math.random(). -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' - package: '@microsoft/sp-core-library!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `RandomNumberGenerator` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' - package: '@microsoft/sp-core-library!' - fullName: serviceKey - summary: The service key for IRandomNumberGenerator. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: generate() - uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' - package: '@microsoft/sp-core-library!' - fullName: generate() - summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'generate(): number;' - return: - type: number - description: '' +### YamlMime:TSType +name: RandomNumberGenerator +uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' +package: '@microsoft/sp-core-library!' +fullName: RandomNumberGenerator +summary: >- + This is the default implementation of + [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls + Math.random(). +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `RandomNumberGenerator` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' + package: '@microsoft/sp-core-library!' + fullName: serviceKey + summary: The service key for IRandomNumberGenerator. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: generate() + uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: generate() + summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'generate(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index af90efde..97a082eb 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -1,120 +1,120 @@ -### YamlMime:TSType -name: ServiceKey -uid: '@microsoft/sp-core-library!ServiceKey:class' -package: '@microsoft/sp-core-library!' -fullName: ServiceKey -summary: >- - The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope%23consume:member(1)) to fetch a dependency. -remarks: >- - Every service key also provides a default implementation of the dependency, which will be automatically created in the - root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be - safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the - new dependency. -isPreview: false -isDeprecated: false -type: class -properties: - - name: defaultCreator - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' - package: '@microsoft/sp-core-library!' - fullName: defaultCreator - summary: A callback function that constructs the default instance of this service. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly defaultCreator: ServiceCreator;' - return: - type: '<T>' - - name: id - uid: '@microsoft/sp-core-library!ServiceKey#id:member' - package: '@microsoft/sp-core-library!' - fullName: id - summary: A unique identifier for this service key. - remarks: >- - This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers - should not make assumptions about the formatting of this string. It is currently based on a global counter, but - this may change in the future. - - - The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant - to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name - was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a - different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in - which libraries are loaded should never affect the resulting tree of scopes. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly id: string;' - return: - type: string - - name: name - uid: '@microsoft/sp-core-library!ServiceKey#name:member' - package: '@microsoft/sp-core-library!' - fullName: name - summary: The name of the service. - remarks: >- - This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the - package name, followed by a period, followed by the class or interface name. - - - The system does not assume that this string is unique. Instead, the - [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly name: string;' - return: - type: string -methods: - - name: 'create(name, serviceClass)' - uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'create(name, serviceClass)' - summary: >- - Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts - the standard constructor parameter. - remarks: >- - If you want to specify custom constructor parameters, use - [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. - isPreview: false - isDeprecated: false - syntax: - content: |- - static create(name: string, serviceClass: { - new (serviceScope: ServiceScope): TKey; - }): ServiceKey; - parameters: - - id: name - description: A name such as "my-package.IMyService" which should be unique across packages. - type: string - - id: serviceClass - description: the TypeScript class that implements the service. - type: |- - { - new (serviceScope: ): TKey; - } - return: - type: '<TKey>' - description: the newly created ServiceKey - - name: 'createCustom(name, defaultCreator)' - uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'createCustom(name, defaultCreator)' - summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' - parameters: - - id: name - description: A name such as "my-package.IMyService" which should be unique across packages. - type: string - - id: defaultCreator - description: a callback that returns an object that implements the T interface - type: '<TKey>' - return: - type: '<TKey>' - description: the newly created service key +### YamlMime:TSType +name: ServiceKey +uid: '@microsoft/sp-core-library!ServiceKey:class' +package: '@microsoft/sp-core-library!' +fullName: ServiceKey +summary: >- + The ServiceKey is a lookup key that is used when calling + [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope%23consume:member(1)) to fetch a dependency. +remarks: >- + Every service key also provides a default implementation of the dependency, which will be automatically created in the + root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be + safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the + new dependency. +isPreview: false +isDeprecated: false +type: class +properties: + - name: defaultCreator + uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' + package: '@microsoft/sp-core-library!' + fullName: defaultCreator + summary: A callback function that constructs the default instance of this service. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly defaultCreator: ServiceCreator;' + return: + type: '<T>' + - name: id + uid: '@microsoft/sp-core-library!ServiceKey#id:member' + package: '@microsoft/sp-core-library!' + fullName: id + summary: A unique identifier for this service key. + remarks: >- + This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers + should not make assumptions about the formatting of this string. It is currently based on a global counter, but + this may change in the future. + + + The ServiceScope uses this identifier internally as a dictionary key for finding services. The ServiceKey is meant + to be unique, even if multiple instances of the same library are loaded on the same page, even if the same name + was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a + different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in + which libraries are loaded should never affect the resulting tree of scopes. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: '@microsoft/sp-core-library!ServiceKey#name:member' + package: '@microsoft/sp-core-library!' + fullName: name + summary: The name of the service. + remarks: >- + This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the + package name, followed by a period, followed by the class or interface name. + + + The system does not assume that this string is unique. Instead, the + [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string +methods: + - name: 'create(name, serviceClass)' + uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'create(name, serviceClass)' + summary: >- + Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts + the standard constructor parameter. + remarks: >- + If you want to specify custom constructor parameters, use + [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. + isPreview: false + isDeprecated: false + syntax: + content: |- + static create(name: string, serviceClass: { + new (serviceScope: ServiceScope): TKey; + }): ServiceKey; + parameters: + - id: name + description: A name such as "my-package.IMyService" which should be unique across packages. + type: string + - id: serviceClass + description: the TypeScript class that implements the service. + type: |- + { + new (serviceScope: ): TKey; + } + return: + type: '<TKey>' + description: the newly created ServiceKey + - name: 'createCustom(name, defaultCreator)' + uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'createCustom(name, defaultCreator)' + summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' + parameters: + - id: name + description: A name such as "my-package.IMyService" which should be unique across packages. + type: string + - id: defaultCreator + description: a callback that returns an object that implements the T interface + type: '<TKey>' + return: + type: '<TKey>' + description: the newly created service key diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 333f5ceb..726a7761 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -1,246 +1,246 @@ -### YamlMime:TSType -name: ServiceScope -uid: '@microsoft/sp-core-library!ServiceScope:class' -package: '@microsoft/sp-core-library!' -fullName: ServiceScope -summary: The service locator pattern used by the SharePoint Framework. -remarks: >- - ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to enable - different implementations to be registered in different scopes. This improves modularity by decoupling components from - their dependencies in an extensible way. - - - For example, suppose that various components need access to an IPageManager instance. We could simply make the - PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that - requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter - for each component that requires it, however then we immediately face the problem that any code that calls these - constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that - ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is - awkward. A natural solution would be to move all the dependencies into a class with name like "ApplicationContext", - and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need - it without cluttering the intermediary classes that don't. However, it still has a design problem that - "ApplicationContext" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a - dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the - popular "service locator" design pattern, familiar from the SPContext API in classic SharePoint. - - - ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. - if we have two different pages, they can each provide a unique PageManager instance while still sharing other common - dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is - important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our - application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the - version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each - consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better - solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components - can assume that consume() will always return some object that implements the contract. - - - Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or - ServiceScope.startNewChild(). They are initially in an "unfinished" state, during which provide() can be called to - register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and - provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the - same key, and does not depend on order of initialization. It also allows us to support circular dependencies without - worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when - working with components that were contributed by various third parties without any coordination.) To avoid mistakes, - it's best to always call consume() inside a callback from serviceScope.whenFinished(). -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(parent) - uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' - package: '@microsoft/sp-core-library!' - fullName: (constructor)(parent) - summary: Constructs a new instance of the `ServiceScope` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected constructor(parent: ServiceScope | undefined);' - parameters: - - id: parent - description: '' - type: ' | undefined' -methods: - - name: consume(serviceKey) - uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' - package: '@microsoft/sp-core-library!' - fullName: consume(serviceKey) - summary: Consumes a service from the service scope. - remarks: >- - Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the - registered service instance. If the instance cannot be found, then a default instance will be automatically - created and registered with the root ServiceScope. - isPreview: false - isDeprecated: false - syntax: - content: 'consume(serviceKey: ServiceKey): T;' - parameters: - - id: serviceKey - description: the key that was used when provide() was called to register the service - type: '<T>' - return: - type: T - description: the service instance - - name: 'createAndProvide(serviceKey, simpleServiceClass)' - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'createAndProvide(serviceKey, simpleServiceClass)' - summary: >- - This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then - registering it by calling ServiceScope.provide(). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { - new (serviceScope: ServiceScope): T; - }): T; - parameters: - - id: serviceKey - description: the key that can be used later to consume the service - type: '<T>' - - id: simpleServiceClass - description: the TypeScript class to be constructed - type: |- - { - new (serviceScope: ): T; - } - return: - type: T - description: a newly constructed instance of simpleServiceClass - - name: createDefaultAndProvide(serviceKey) - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' - package: '@microsoft/sp-core-library!' - fullName: createDefaultAndProvide(serviceKey) - summary: >- - This is a shorthand function that constructs the default implementation of the specified serviceKey, and then - registers it by calling ServiceScope.provide(). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' - parameters: - - id: serviceKey - description: the key that can be used later to consume the service - type: '<T>' - return: - type: T - description: a service instance that was constructed using ServiceKey.defaultCreator - - name: finish() - uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' - package: '@microsoft/sp-core-library!' - fullName: finish() - summary: Completes the initialization sequence for a service scope. - remarks: >- - When a ServiceScope is first started, it is in an "unfinished" state where provide() is allowed but consume() is - disallowed. After calling finish(), then consume() is allowed but provide() is disallowed. - - - This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 - is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via - inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a - different result than the previous call. This nondeterminism could cause unpredictable results that are difficult - to diagnose. - isPreview: false - isDeprecated: false - syntax: - content: 'finish(): void;' - return: - type: void - description: '' - - name: getParent() - uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getParent() - summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getParent(): ServiceScope | undefined;' - return: - type: ' | undefined' - description: the parent service scope - - name: 'provide(serviceKey, service)' - uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'provide(serviceKey, service)' - summary: Add a new service to a service scope. - remarks: >- - ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may - only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. - isPreview: false - isDeprecated: false - syntax: - content: 'provide(serviceKey: ServiceKey, service: T): T;' - parameters: - - id: serviceKey - description: the key that will later be used to consume the service - type: '<T>' - - id: service - description: the service instance that is being registered - type: T - return: - type: T - description: the same object that was passed as the "service" parameter - - name: startNewChild() - uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' - package: '@microsoft/sp-core-library!' - fullName: startNewChild() - summary: Constructs a new ServiceScope that is a child of the current scope. - remarks: >- - The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly - provided by a child scope, the parent hierarchy will be consulted. - isPreview: false - isDeprecated: false - syntax: - content: 'startNewChild(): ServiceScope;' - return: - type: '' - description: the newly created root ServiceScope - - name: startNewRoot() - uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' - package: '@microsoft/sp-core-library!' - fullName: startNewRoot() - summary: >- - Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default - implementations of ServiceKeys. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static startNewRoot(): ServiceScope;' - return: - type: '' - description: the newly created root ServiceScope - - name: whenFinished(callback) - uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' - package: '@microsoft/sp-core-library!' - fullName: whenFinished(callback) - summary: >- - Defer an operation until after - [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope%23finish:member(1)) has completed. - remarks: >- - It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect - your component against this error is to perform the consume() calls inside a whenFinished() callback. If the - service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed - later when the scope is finished. - - - NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. - However, the control flow often threads through numerous constructors and base classes, which can be simplified - using whenFinished(). - isPreview: false - isDeprecated: false - syntax: - content: 'whenFinished(callback: () => void): void;' - parameters: - - id: callback - description: A block of code that needs to call ServiceScope.consume() - type: () => void - return: - type: void - description: '' +### YamlMime:TSType +name: ServiceScope +uid: '@microsoft/sp-core-library!ServiceScope:class' +package: '@microsoft/sp-core-library!' +fullName: ServiceScope +summary: The service locator pattern used by the SharePoint Framework. +remarks: >- + ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to enable + different implementations to be registered in different scopes. This improves modularity by decoupling components from + their dependencies in an extensible way. + + + For example, suppose that various components need access to an IPageManager instance. We could simply make the + PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that + requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter + for each component that requires it, however then we immediately face the problem that any code that calls these + constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that + ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is + awkward. A natural solution would be to move all the dependencies into a class with name like "ApplicationContext", + and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need + it without cluttering the intermediary classes that don't. However, it still has a design problem that + "ApplicationContext" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a + dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the + popular "service locator" design pattern, familiar from the SPContext API in classic SharePoint. + + + ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. + if we have two different pages, they can each provide a unique PageManager instance while still sharing other common + dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is + important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our + application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the + version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each + consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better + solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components + can assume that consume() will always return some object that implements the contract. + + + Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or + ServiceScope.startNewChild(). They are initially in an "unfinished" state, during which provide() can be called to + register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and + provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the + same key, and does not depend on order of initialization. It also allows us to support circular dependencies without + worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when + working with components that were contributed by various third parties without any coordination.) To avoid mistakes, + it's best to always call consume() inside a callback from serviceScope.whenFinished(). +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(parent) + uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(parent) + summary: Constructs a new instance of the `ServiceScope` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected constructor(parent: ServiceScope | undefined);' + parameters: + - id: parent + description: '' + type: ' | undefined' +methods: + - name: consume(serviceKey) + uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' + package: '@microsoft/sp-core-library!' + fullName: consume(serviceKey) + summary: Consumes a service from the service scope. + remarks: >- + Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the + registered service instance. If the instance cannot be found, then a default instance will be automatically + created and registered with the root ServiceScope. + isPreview: false + isDeprecated: false + syntax: + content: 'consume(serviceKey: ServiceKey): T;' + parameters: + - id: serviceKey + description: the key that was used when provide() was called to register the service + type: '<T>' + return: + type: T + description: the service instance + - name: 'createAndProvide(serviceKey, simpleServiceClass)' + uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'createAndProvide(serviceKey, simpleServiceClass)' + summary: >- + This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then + registering it by calling ServiceScope.provide(). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { + new (serviceScope: ServiceScope): T; + }): T; + parameters: + - id: serviceKey + description: the key that can be used later to consume the service + type: '<T>' + - id: simpleServiceClass + description: the TypeScript class to be constructed + type: |- + { + new (serviceScope: ): T; + } + return: + type: T + description: a newly constructed instance of simpleServiceClass + - name: createDefaultAndProvide(serviceKey) + uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' + package: '@microsoft/sp-core-library!' + fullName: createDefaultAndProvide(serviceKey) + summary: >- + This is a shorthand function that constructs the default implementation of the specified serviceKey, and then + registers it by calling ServiceScope.provide(). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' + parameters: + - id: serviceKey + description: the key that can be used later to consume the service + type: '<T>' + return: + type: T + description: a service instance that was constructed using ServiceKey.defaultCreator + - name: finish() + uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' + package: '@microsoft/sp-core-library!' + fullName: finish() + summary: Completes the initialization sequence for a service scope. + remarks: >- + When a ServiceScope is first started, it is in an "unfinished" state where provide() is allowed but consume() is + disallowed. After calling finish(), then consume() is allowed but provide() is disallowed. + + + This formalism prevents a number of complex situations that could lead to bugs. For example, supposed that Scope2 + is a child of Scope1, and Scope1 provides instance A1 of interface A. If someone consumes A1 from Scope2 (via + inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a + different result than the previous call. This nondeterminism could cause unpredictable results that are difficult + to diagnose. + isPreview: false + isDeprecated: false + syntax: + content: 'finish(): void;' + return: + type: void + description: '' + - name: getParent() + uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getParent() + summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getParent(): ServiceScope | undefined;' + return: + type: ' | undefined' + description: the parent service scope + - name: 'provide(serviceKey, service)' + uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'provide(serviceKey, service)' + summary: Add a new service to a service scope. + remarks: >- + ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may + only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. + isPreview: false + isDeprecated: false + syntax: + content: 'provide(serviceKey: ServiceKey, service: T): T;' + parameters: + - id: serviceKey + description: the key that will later be used to consume the service + type: '<T>' + - id: service + description: the service instance that is being registered + type: T + return: + type: T + description: the same object that was passed as the "service" parameter + - name: startNewChild() + uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' + package: '@microsoft/sp-core-library!' + fullName: startNewChild() + summary: Constructs a new ServiceScope that is a child of the current scope. + remarks: >- + The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly + provided by a child scope, the parent hierarchy will be consulted. + isPreview: false + isDeprecated: false + syntax: + content: 'startNewChild(): ServiceScope;' + return: + type: '' + description: the newly created root ServiceScope + - name: startNewRoot() + uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' + package: '@microsoft/sp-core-library!' + fullName: startNewRoot() + summary: >- + Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default + implementations of ServiceKeys. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static startNewRoot(): ServiceScope;' + return: + type: '' + description: the newly created root ServiceScope + - name: whenFinished(callback) + uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' + package: '@microsoft/sp-core-library!' + fullName: whenFinished(callback) + summary: >- + Defer an operation until after + [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope%23finish:member(1)) has completed. + remarks: >- + It is an error to call ServiceScope.consume() before finish() has been called. The most reliable way to protect + your component against this error is to perform the consume() calls inside a whenFinished() callback. If the + service scope is already finished, then the callback will be executed immediately; otherwise, it will be executed + later when the scope is finished. + + + NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. + However, the control flow often threads through numerous constructors and base classes, which can be simplified + using whenFinished(). + isPreview: false + isDeprecated: false + syntax: + content: 'whenFinished(callback: () => void): void;' + parameters: + - id: callback + description: A block of code that needs to call ServiceScope.consume() + type: () => void + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index c1c63790..b5a426e2 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -1,65 +1,65 @@ -### YamlMime:TSType -name: Session -uid: '@microsoft/sp-core-library!Session:class' -package: '@microsoft/sp-core-library!' -fullName: Session -summary: Provides access to the application's browser session and active page. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: applicationId - uid: '@microsoft/sp-core-library!Session.applicationId:member' - package: '@microsoft/sp-core-library!' - fullName: applicationId - summary: A unique identifier for the current instance of the client-side application. - remarks: >- - A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the - duration of the client-side application instance, i.e. it begins with the server request that renders the page, - and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's - router supports in-place navigation (via the history.pushState() API), the application session persists across - these transitions. - isPreview: false - isDeprecated: false - syntax: - content: 'static get applicationId(): Guid;' - return: - type: '' - - name: clientSideApplicationId - uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' - package: '@microsoft/sp-core-library!' - fullName: clientSideApplicationId - summary: The id of the currently running application - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static get clientSideApplicationId(): string;' - return: - type: string - - name: pageId - uid: '@microsoft/sp-core-library!Session.pageId:member' - package: '@microsoft/sp-core-library!' - fullName: pageId - summary: A unique identifier for the current page within the client-side application. - remarks: >- - A unique identifier used to correlate logging and other diagnostic information. Whereas the - [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) tracks the entire lifetime - of the client-side application instance, the pageId tracks an individual "page" that is rendered. - - - For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the - history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During - this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 - different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA - independently of PageB. - - - The concept of a page is subjective and defined by the router for a particular application. - isPreview: false - isDeprecated: false - syntax: - content: 'static get pageId(): Guid;' - return: - type: '' +### YamlMime:TSType +name: Session +uid: '@microsoft/sp-core-library!Session:class' +package: '@microsoft/sp-core-library!' +fullName: Session +summary: Provides access to the application's browser session and active page. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: applicationId + uid: '@microsoft/sp-core-library!Session.applicationId:member' + package: '@microsoft/sp-core-library!' + fullName: applicationId + summary: A unique identifier for the current instance of the client-side application. + remarks: >- + A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the + duration of the client-side application instance, i.e. it begins with the server request that renders the page, + and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's + router supports in-place navigation (via the history.pushState() API), the application session persists across + these transitions. + isPreview: false + isDeprecated: false + syntax: + content: 'static get applicationId(): Guid;' + return: + type: '' + - name: clientSideApplicationId + uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' + package: '@microsoft/sp-core-library!' + fullName: clientSideApplicationId + summary: The id of the currently running application + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static get clientSideApplicationId(): string;' + return: + type: string + - name: pageId + uid: '@microsoft/sp-core-library!Session.pageId:member' + package: '@microsoft/sp-core-library!' + fullName: pageId + summary: A unique identifier for the current page within the client-side application. + remarks: >- + A unique identifier used to correlate logging and other diagnostic information. Whereas the + [Session.applicationId](xref:@microsoft/sp-core-library!Session.applicationId:member) tracks the entire lifetime + of the client-side application instance, the pageId tracks an individual "page" that is rendered. + + + For example, suppose that the application initially loads PageA, then the user does in-place navigation (via the + history.pushState() API) to PageB, then navigates back to PageA, and finally they close the browser tab. During + this sequence, the applicationId will remain the same, however the pageId will change on each navigation. The 3 + different pageId values are used by the diagnostics e.g. to track success/failure statistics for PageA + independently of PageB. + + + The concept of a page is subjective and defined by the router for a particular application. + isPreview: false + isDeprecated: false + syntax: + content: 'static get pageId(): Guid;' + return: + type: '' diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index 3f322aa8..bfadd94c 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -1,74 +1,74 @@ -### YamlMime:TSType -name: SPEvent -uid: '@microsoft/sp-core-library!SPEvent:class' -package: '@microsoft/sp-core-library!' -fullName: SPEvent -summary: Represents a framework event that components can subscribe to. -remarks: >- - Examples of events in a web application might include: the user clicking a button, the system navigating to another - page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using - instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of - an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() - to register an event handler callback that will be invoked each time the event occurs. The handler receives an - SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's - Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component - subscribed to each event, and automatically unsubscribes the handler when the component is disposed. - - - When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is - unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception - will not prevent other handlers from executing, but it will be reported as a problem with the associated component. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPEvent` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'add(observer, eventHandler)' - uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'add(observer, eventHandler)' - summary: Registers a callback that will be invoked whenever the event occurs. - remarks: >- - The same object can add multiple event handlers to the same event. Since BaseComponent implements the - ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event - handler to be automatically unsubscribed when the web part or extension is disposed. - isPreview: false - isDeprecated: false - syntax: - content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' - parameters: - - id: observer - description: >- - Indicates the object that is subscribing to the event: When the object is disposed, the event handler will - be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event - handler failed to catch an exception. - type: '' - - id: eventHandler - description: A callback function that will be invoked whenever the event occurs - type: '(eventArgs: TEventArgs) => void' - return: - type: void - description: '' - - name: 'remove(observer, eventHandler)' - uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'remove(observer, eventHandler)' - summary: Unregisters a callback that was registered using add(). - remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - isPreview: false - isDeprecated: false - syntax: - content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' - parameters: - - id: observer - description: This must be the same observer that was passed to the add() function. - type: '' - - id: eventHandler - description: The event handler to remove; this must be the same object instance that was passed to the add() function. - type: '(eventArgs: TEventArgs) => void' - return: - type: void - description: '' +### YamlMime:TSType +name: SPEvent +uid: '@microsoft/sp-core-library!SPEvent:class' +package: '@microsoft/sp-core-library!' +fullName: SPEvent +summary: Represents a framework event that components can subscribe to. +remarks: >- + Examples of events in a web application might include: the user clicking a button, the system navigating to another + page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using + instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of + an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() + to register an event handler callback that will be invoked each time the event occurs. The handler receives an + SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's + Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component + subscribed to each event, and automatically unsubscribes the handler when the component is disposed. + + + When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is + unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception + will not prevent other handlers from executing, but it will be reported as a problem with the associated component. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPEvent` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'add(observer, eventHandler)' + uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'add(observer, eventHandler)' + summary: Registers a callback that will be invoked whenever the event occurs. + remarks: >- + The same object can add multiple event handlers to the same event. Since BaseComponent implements the + ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event + handler to be automatically unsubscribed when the web part or extension is disposed. + isPreview: false + isDeprecated: false + syntax: + content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + parameters: + - id: observer + description: >- + Indicates the object that is subscribing to the event: When the object is disposed, the event handler will + be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event + handler failed to catch an exception. + type: '' + - id: eventHandler + description: A callback function that will be invoked whenever the event occurs + type: '(eventArgs: TEventArgs) => void' + return: + type: void + description: '' + - name: 'remove(observer, eventHandler)' + uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'remove(observer, eventHandler)' + summary: Unregisters a callback that was registered using add(). + remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' + isPreview: false + isDeprecated: false + syntax: + content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + parameters: + - id: observer + description: This must be the same observer that was passed to the add() function. + type: '' + - id: eventHandler + description: The event handler to remove; this must be the same object instance that was passed to the add() function. + type: '(eventArgs: TEventArgs) => void' + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 94bde34b..e131601d 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -1,10 +1,10 @@ -### YamlMime:TSType -name: SPEventArgs -uid: '@microsoft/sp-core-library!SPEventArgs:class' -package: '@microsoft/sp-core-library!' -fullName: SPEventArgs -summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' -remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' -isPreview: false -isDeprecated: false -type: class +### YamlMime:TSType +name: SPEventArgs +uid: '@microsoft/sp-core-library!SPEventArgs:class' +package: '@microsoft/sp-core-library!' +fullName: SPEventArgs +summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' +remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' +isPreview: false +isDeprecated: false +type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 6c642456..5e658b1b 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -1,63 +1,63 @@ -### YamlMime:TSType -name: Text_2 -uid: '@microsoft/sp-core-library!Text_2:class' -package: '@microsoft/sp-core-library!' -fullName: Text_2 -summary: Operations for working with strings that contain text. -remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'format(s, values)' - uid: '@microsoft/sp-core-library!Text_2.format:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'format(s, values)' - summary: Format a string by substituting parameters. - remarks: >- - This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the - value is null or undefined, it will be replaced by the word `"null"` or `"undefined"`. The format string s - must not be null or undefined. - - - Usage example: - - - `Text.format("hello {0}!", "world")` will return `"hello world!"` - isPreview: false - isDeprecated: false - syntax: - content: 'static format(s: string, ...values: unknown[]): string;' - parameters: - - id: s - description: '' - type: string - - id: values - description: '' - type: 'unknown[]' - return: - type: string - description: '' - - name: 'replaceAll(input, searchValue, replaceValue)' - uid: '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'replaceAll(input, searchValue, replaceValue)' - summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' - remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' - isPreview: false - isDeprecated: false - syntax: - content: 'static replaceAll(input: string, searchValue: string, replaceValue: string): string;' - parameters: - - id: input - description: The string to be modified - type: string - - id: searchValue - description: The value to search for - type: string - - id: replaceValue - description: The replacement text - type: string - return: - type: string - description: '' +### YamlMime:TSType +name: Text_2 +uid: '@microsoft/sp-core-library!Text_2:class' +package: '@microsoft/sp-core-library!' +fullName: Text_2 +summary: Operations for working with strings that contain text. +remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'format(s, values)' + uid: '@microsoft/sp-core-library!Text_2.format:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'format(s, values)' + summary: Format a string by substituting parameters. + remarks: >- + This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the + value is null or undefined, it will be replaced by the word `"null"` or `"undefined"`. The format string s + must not be null or undefined. + + + Usage example: + + + `Text.format("hello {0}!", "world")` will return `"hello world!"` + isPreview: false + isDeprecated: false + syntax: + content: 'static format(s: string, ...values: unknown[]): string;' + parameters: + - id: s + description: '' + type: string + - id: values + description: '' + type: 'unknown[]' + return: + type: string + description: '' + - name: 'replaceAll(input, searchValue, replaceValue)' + uid: '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'replaceAll(input, searchValue, replaceValue)' + summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' + remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' + isPreview: false + isDeprecated: false + syntax: + content: 'static replaceAll(input: string, searchValue: string, replaceValue: string): string;' + parameters: + - id: input + description: The string to be modified + type: string + - id: searchValue + description: The value to search for + type: string + - id: replaceValue + description: The replacement text + type: string + return: + type: string + description: '' diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 6e2b7e73..0148511b 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -1,69 +1,69 @@ -### YamlMime:TSType -name: TimeProvider -uid: '@microsoft/sp-core-library!TimeProvider:class' -package: '@microsoft/sp-core-library!' -fullName: TimeProvider -summary: >- - This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that - simply calls the real browser APIs. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' - package: '@microsoft/sp-core-library!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `TimeProvider` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' - package: '@microsoft/sp-core-library!' - fullName: serviceKey - summary: The service key for ITimeProvider. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getDate() - uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getDate() - summary: 'Returns the current date/time, similar to the Date class constructor.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getDate(): Date;' - return: - type: Date - description: '' - - name: getTimestamp() - uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getTimestamp() - summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getTimestamp(): number;' - return: - type: number - description: '' +### YamlMime:TSType +name: TimeProvider +uid: '@microsoft/sp-core-library!TimeProvider:class' +package: '@microsoft/sp-core-library!' +fullName: TimeProvider +summary: >- + This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that + simply calls the real browser APIs. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `TimeProvider` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' + package: '@microsoft/sp-core-library!' + fullName: serviceKey + summary: The service key for ITimeProvider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: getDate() + uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getDate() + summary: 'Returns the current date/time, similar to the Date class constructor.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getDate(): Date;' + return: + type: Date + description: '' + - name: getTimestamp() + uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getTimestamp() + summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getTimestamp(): number;' + return: + type: number + description: '' diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 2a5dcbd6..7800652a 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -1,94 +1,94 @@ -### YamlMime:TSType -name: UrlQueryParameterCollection -uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' -package: '@microsoft/sp-core-library!' -fullName: UrlQueryParameterCollection -summary: Provides features for storing and retrieving URL query parameters. -remarks: >- - The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with "?" - to indicate the first query parameter and use "&" for all subsequent parameters. The class also supports - fragments. - - - Edge case behavior: - - - Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores - key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param - with only equals (www.example.com/?=&debug=on stores empty string key and value -isPreview: false -isDeprecated: true -customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. -type: class -constructors: - - name: (constructor)(url) - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' - package: '@microsoft/sp-core-library!' - fullName: (constructor)(url) - summary: Constructs a new instance of the `UrlQueryParameterCollection` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(url: string);' - parameters: - - id: url - description: '' - type: string -methods: - - name: getValue(param) - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getValue(param) - summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. - remarks: |- - Examples: - - ``` - this._queryParameterList = [ - {key: TEST, value: done}, - {key: DEBUG, value: false}, - {key: TEST, value: notdone}] - getValue('TEST') ---> 'done' - getValue('debug') ---> 'false' - getValue('lost') ---> undefined - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'getValue(param: string): string | undefined;' - parameters: - - id: param - description: the case insensitive key for the desired query parameter value. - type: string - return: - type: string | undefined - description: '' - - name: getValues(param) - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getValues(param) - summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. - remarks: |- - Examples: - - ``` - this._queryParameterList = [ - {key: TEST, value: done}, - {key: DEBUG, value: false}, - {key: TEST, value: notdone}] - getValues('TEST') ---> ['done', 'notdone'] - getValues('debug') ---> ['false'] - getValues('lost') ---> undefined - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'getValues(param: string): (string | undefined)[] | undefined;' - parameters: - - id: param - description: the case insensitive key for the desired query parameter value. - type: string - return: - type: '(string | undefined)[] | undefined' - description: '' +### YamlMime:TSType +name: UrlQueryParameterCollection +uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' +package: '@microsoft/sp-core-library!' +fullName: UrlQueryParameterCollection +summary: Provides features for storing and retrieving URL query parameters. +remarks: >- + The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with "?" + to indicate the first query parameter and use "&" for all subsequent parameters. The class also supports + fragments. + + + Edge case behavior: + + + Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores + key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param + with only equals (www.example.com/?=&debug=on stores empty string key and value +isPreview: false +isDeprecated: true +customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. +type: class +constructors: + - name: (constructor)(url) + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' + package: '@microsoft/sp-core-library!' + fullName: (constructor)(url) + summary: Constructs a new instance of the `UrlQueryParameterCollection` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(url: string);' + parameters: + - id: url + description: '' + type: string +methods: + - name: getValue(param) + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getValue(param) + summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. + remarks: |- + Examples: + + ``` + this._queryParameterList = [ + {key: TEST, value: done}, + {key: DEBUG, value: false}, + {key: TEST, value: notdone}] + getValue('TEST') ---> 'done' + getValue('debug') ---> 'false' + getValue('lost') ---> undefined + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'getValue(param: string): string | undefined;' + parameters: + - id: param + description: the case insensitive key for the desired query parameter value. + type: string + return: + type: string | undefined + description: '' + - name: getValues(param) + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' + package: '@microsoft/sp-core-library!' + fullName: getValues(param) + summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. + remarks: |- + Examples: + + ``` + this._queryParameterList = [ + {key: TEST, value: done}, + {key: DEBUG, value: false}, + {key: TEST, value: notdone}] + getValues('TEST') ---> ['done', 'notdone'] + getValues('debug') ---> ['false'] + getValues('lost') ---> undefined + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'getValues(param: string): (string | undefined)[] | undefined;' + parameters: + - id: param + description: the case insensitive key for the desired query parameter value. + type: string + return: + type: '(string | undefined)[] | undefined' + description: '' diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 21bb61a5..73257d11 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -1,94 +1,94 @@ -### YamlMime:TSType -name: Validate -uid: '@microsoft/sp-core-library!Validate:class' -package: '@microsoft/sp-core-library!' -fullName: Validate -summary: Performs common validation tests for properties and function parameters. -remarks: >- - This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, - Validate checks are always performed and will always throw an error, even in a production release. As such, be careful - not to overuse these checks in a way that might impact performance. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'isNonemptyString(value, variableName)' - uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isNonemptyString(value, variableName)' - summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static isNonemptyString(value: string | undefined | null, variableName: string): void;' - parameters: - - id: value - description: the value to check - type: string | undefined | null - - id: variableName - description: 'the program variable name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' - - name: 'isNotDisposed(value, className)' - uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isNotDisposed(value, className)' - summary: Throws an exception if the specified object has been disposed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static isNotDisposed(value: IDisposable, className: string): void;' - parameters: - - id: value - description: the value to check - type: '' - - id: className - description: 'the class name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' - - name: 'isNotNullOrUndefined(value, variableName)' - uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isNotNullOrUndefined(value, variableName)' - summary: Throws an exception if the specified value is null or undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' - parameters: - - id: value - description: the value to check - type: any - - id: variableName - description: 'the program variable name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' - - name: 'isTrue(value, variableName)' - uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isTrue(value, variableName)' - summary: Throws an exception if the specified value is not true. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static isTrue(value: boolean | undefined | null, variableName: string): void;' - parameters: - - id: value - description: the value to check - type: boolean | undefined | null - - id: variableName - description: 'the program variable name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' +### YamlMime:TSType +name: Validate +uid: '@microsoft/sp-core-library!Validate:class' +package: '@microsoft/sp-core-library!' +fullName: Validate +summary: Performs common validation tests for properties and function parameters. +remarks: >- + This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, + Validate checks are always performed and will always throw an error, even in a production release. As such, be careful + not to overuse these checks in a way that might impact performance. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'isNonemptyString(value, variableName)' + uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isNonemptyString(value, variableName)' + summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isNonemptyString(value: string | undefined | null, variableName: string): void;' + parameters: + - id: value + description: the value to check + type: string | undefined | null + - id: variableName + description: 'the program variable name, which will be mentioned in the error message' + type: string + return: + type: void + description: '' + - name: 'isNotDisposed(value, className)' + uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isNotDisposed(value, className)' + summary: Throws an exception if the specified object has been disposed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isNotDisposed(value: IDisposable, className: string): void;' + parameters: + - id: value + description: the value to check + type: '' + - id: className + description: 'the class name, which will be mentioned in the error message' + type: string + return: + type: void + description: '' + - name: 'isNotNullOrUndefined(value, variableName)' + uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isNotNullOrUndefined(value, variableName)' + summary: Throws an exception if the specified value is null or undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' + parameters: + - id: value + description: the value to check + type: any + - id: variableName + description: 'the program variable name, which will be mentioned in the error message' + type: string + return: + type: void + description: '' + - name: 'isTrue(value, variableName)' + uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'isTrue(value, variableName)' + summary: Throws an exception if the specified value is not true. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isTrue(value: boolean | undefined | null, variableName: string): void;' + parameters: + - id: value + description: the value to check + type: boolean | undefined | null + - id: variableName + description: 'the program variable name, which will be mentioned in the error message' + type: string + return: + type: void + description: '' diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 9c72e84a..5767b32d 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -1,273 +1,273 @@ -### YamlMime:TSType -name: Version -uid: '@microsoft/sp-core-library!Version:class' -package: '@microsoft/sp-core-library!' -fullName: Version -summary: 'Represents a version number with two, three, or four parts.' -remarks: >- - This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, - MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but - they are discarded. Missing parts are treated as zeroes for comparisons. - - - Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` -isPreview: false -isDeprecated: false -type: class -properties: - - name: major - uid: '@microsoft/sp-core-library!Version#major:member' - package: '@microsoft/sp-core-library!' - fullName: major - summary: Returns the first component of the version string. - remarks: Typically a change in the major version number indicates a compatibility break with previous versions. - isPreview: false - isDeprecated: false - syntax: - content: 'get major(): number;' - return: - type: number - - name: minor - uid: '@microsoft/sp-core-library!Version#minor:member' - package: '@microsoft/sp-core-library!' - fullName: minor - summary: Returns the second component of the version string. - remarks: >- - Typically a change in the minor version number indicates that new features were added, while remaining backwards - compatible with previous releases. - isPreview: false - isDeprecated: false - syntax: - content: 'get minor(): number;' - return: - type: number - - name: patch - uid: '@microsoft/sp-core-library!Version#patch:member' - package: '@microsoft/sp-core-library!' - fullName: patch - summary: 'The third number in the version string, or undefined if unspecified.' - remarks: >- - Typically a change in the patch version number indicates a small fix that does not affect the compatibility - contract for the library. For a .NET System.Version object, this is referred to as the "build" number. - isPreview: false - isDeprecated: false - syntax: - content: 'get patch(): number | undefined;' - return: - type: number | undefined - - name: revision - uid: '@microsoft/sp-core-library!Version#revision:member' - package: '@microsoft/sp-core-library!' - fullName: revision - summary: 'The fourth number in the version string, or undefined if unspecified.' - remarks: >- - This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET - version numbers. - isPreview: false - isDeprecated: false - syntax: - content: 'get revision(): number | undefined;' - return: - type: number | undefined -methods: - - name: 'compare(v1, v2)' - uid: '@microsoft/sp-core-library!Version.compare:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'compare(v1, v2)' - summary: Compares two Version objects to determine which version is newer. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static compare(v1: Version, v2: Version): number;' - parameters: - - id: v1 - description: The first version class for comparison - type: '' - - id: v2 - description: The second version class for comparison - type: '' - return: - type: number - description: >- - -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if - the first input is greater than the second input. - - name: equals(compareWith) - uid: '@microsoft/sp-core-library!Version#equals:member(1)' - package: '@microsoft/sp-core-library!' - fullName: equals(compareWith) - summary: Tests whether this version is equal to the input parameter. - remarks: |- - Examples: - - ``` - 1.0.0 equals 1.0.0 -> true; - 2.0.1 equals 2.0.0 -> false; - 3.0 equals 3.0.0 -> true; - 04.01 equals 4.1 -> true - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'equals(compareWith: Version): boolean;' - parameters: - - id: compareWith - description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is equal to the input parameter - - name: greaterThan(compareWith) - uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' - package: '@microsoft/sp-core-library!' - fullName: greaterThan(compareWith) - summary: Tests whether this version is greater than (i.e. newer than) the input parameter. - remarks: |- - Examples: - - ``` - 1.0.0 greaterThan 0.0.9 -> true; - 2.0 greaterThan 2.0.0 -> false; - 3.0.1 greaterThan 3.0 -> true - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'greaterThan(compareWith: Version): boolean;' - parameters: - - id: compareWith - description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is greater than the input parameter - - name: isValid(versionString) - uid: '@microsoft/sp-core-library!Version.isValid:member(1)' - package: '@microsoft/sp-core-library!' - fullName: isValid(versionString) - summary: Test whether a string is a valid version specifier. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static isValid(versionString: string | undefined | null): boolean;' - parameters: - - id: versionString - description: The version string - type: string | undefined | null - return: - type: boolean - description: true if the versionString is a valid version specifier - - name: lessThan(compareWith) - uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' - package: '@microsoft/sp-core-library!' - fullName: lessThan(compareWith) - summary: Tests whether this version is less than (i.e. older than) the input parameter. - remarks: |- - Examples: - - ``` - 0.9.9 lessThan 1.0.0 -> true; - 2.0 lessThan 2.0.0 -> false; - 3.0 lessThan 3.0.1 -> true; - 04.01 lessThan 4.1 -> false - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'lessThan(compareWith: Version): boolean;' - parameters: - - id: compareWith - description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is less than the input parameter - - name: parse(versionString) - uid: '@microsoft/sp-core-library!Version.parse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: parse(versionString) - summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static parse(versionString: string | undefined | null): Version;' - parameters: - - id: versionString - description: A version string - type: string | undefined | null - return: - type: '' - description: a new Version object - - name: satisfies(compareWith) - uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' - package: '@microsoft/sp-core-library!' - fullName: satisfies(compareWith) - summary: >- - Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards - compatible. - remarks: >- - In order to satisfy the compatibility requirements, this object must have the same major version number as the - input parameter, and it must NOT be older than the input parameter. - - - Examples: - - - ``` - - 1.0.0 satisfies 1.0.0 -> true; - - 1.1.0 satisfies 1.0.0 -> true; - - 2.0.0 satisfies 1.0.0 -> false; - - 1.0.0 satisfies 1.1.0 -> false - - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'satisfies(compareWith: Version): boolean;' - parameters: - - id: compareWith - description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is compatible with the input parameter - - name: toString() - uid: '@microsoft/sp-core-library!Version#toString:member(1)' - package: '@microsoft/sp-core-library!' - fullName: toString() - summary: Returns a string representation of the version. - remarks: >- - The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). - However, the number of version parts will be unchanged. - isPreview: false - isDeprecated: false - syntax: - content: 'toString(): string;' - return: - type: string - description: '' - - name: tryParse(versionString) - uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: tryParse(versionString) - summary: >- - Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then - undefined is returned. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' - parameters: - - id: versionString - description: A version string - type: string | undefined | null - return: - type: ' | undefined' - description: 'The Version object, or undefined if the string could not be parsed.' +### YamlMime:TSType +name: Version +uid: '@microsoft/sp-core-library!Version:class' +package: '@microsoft/sp-core-library!' +fullName: Version +summary: 'Represents a version number with two, three, or four parts.' +remarks: >- + This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, + MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but + they are discarded. Missing parts are treated as zeroes for comparisons. + + + Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` +isPreview: false +isDeprecated: false +type: class +properties: + - name: major + uid: '@microsoft/sp-core-library!Version#major:member' + package: '@microsoft/sp-core-library!' + fullName: major + summary: Returns the first component of the version string. + remarks: Typically a change in the major version number indicates a compatibility break with previous versions. + isPreview: false + isDeprecated: false + syntax: + content: 'get major(): number;' + return: + type: number + - name: minor + uid: '@microsoft/sp-core-library!Version#minor:member' + package: '@microsoft/sp-core-library!' + fullName: minor + summary: Returns the second component of the version string. + remarks: >- + Typically a change in the minor version number indicates that new features were added, while remaining backwards + compatible with previous releases. + isPreview: false + isDeprecated: false + syntax: + content: 'get minor(): number;' + return: + type: number + - name: patch + uid: '@microsoft/sp-core-library!Version#patch:member' + package: '@microsoft/sp-core-library!' + fullName: patch + summary: 'The third number in the version string, or undefined if unspecified.' + remarks: >- + Typically a change in the patch version number indicates a small fix that does not affect the compatibility + contract for the library. For a .NET System.Version object, this is referred to as the "build" number. + isPreview: false + isDeprecated: false + syntax: + content: 'get patch(): number | undefined;' + return: + type: number | undefined + - name: revision + uid: '@microsoft/sp-core-library!Version#revision:member' + package: '@microsoft/sp-core-library!' + fullName: revision + summary: 'The fourth number in the version string, or undefined if unspecified.' + remarks: >- + This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET + version numbers. + isPreview: false + isDeprecated: false + syntax: + content: 'get revision(): number | undefined;' + return: + type: number | undefined +methods: + - name: 'compare(v1, v2)' + uid: '@microsoft/sp-core-library!Version.compare:member(1)' + package: '@microsoft/sp-core-library!' + fullName: 'compare(v1, v2)' + summary: Compares two Version objects to determine which version is newer. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static compare(v1: Version, v2: Version): number;' + parameters: + - id: v1 + description: The first version class for comparison + type: '' + - id: v2 + description: The second version class for comparison + type: '' + return: + type: number + description: >- + -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if + the first input is greater than the second input. + - name: equals(compareWith) + uid: '@microsoft/sp-core-library!Version#equals:member(1)' + package: '@microsoft/sp-core-library!' + fullName: equals(compareWith) + summary: Tests whether this version is equal to the input parameter. + remarks: |- + Examples: + + ``` + 1.0.0 equals 1.0.0 -> true; + 2.0.1 equals 2.0.0 -> false; + 3.0 equals 3.0.0 -> true; + 04.01 equals 4.1 -> true + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'equals(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: A boolean indicating if this version is equal to the input parameter + - name: greaterThan(compareWith) + uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' + package: '@microsoft/sp-core-library!' + fullName: greaterThan(compareWith) + summary: Tests whether this version is greater than (i.e. newer than) the input parameter. + remarks: |- + Examples: + + ``` + 1.0.0 greaterThan 0.0.9 -> true; + 2.0 greaterThan 2.0.0 -> false; + 3.0.1 greaterThan 3.0 -> true + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'greaterThan(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: A boolean indicating if this version is greater than the input parameter + - name: isValid(versionString) + uid: '@microsoft/sp-core-library!Version.isValid:member(1)' + package: '@microsoft/sp-core-library!' + fullName: isValid(versionString) + summary: Test whether a string is a valid version specifier. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static isValid(versionString: string | undefined | null): boolean;' + parameters: + - id: versionString + description: The version string + type: string | undefined | null + return: + type: boolean + description: true if the versionString is a valid version specifier + - name: lessThan(compareWith) + uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' + package: '@microsoft/sp-core-library!' + fullName: lessThan(compareWith) + summary: Tests whether this version is less than (i.e. older than) the input parameter. + remarks: |- + Examples: + + ``` + 0.9.9 lessThan 1.0.0 -> true; + 2.0 lessThan 2.0.0 -> false; + 3.0 lessThan 3.0.1 -> true; + 04.01 lessThan 4.1 -> false + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'lessThan(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: A boolean indicating if this version is less than the input parameter + - name: parse(versionString) + uid: '@microsoft/sp-core-library!Version.parse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: parse(versionString) + summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static parse(versionString: string | undefined | null): Version;' + parameters: + - id: versionString + description: A version string + type: string | undefined | null + return: + type: '' + description: a new Version object + - name: satisfies(compareWith) + uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' + package: '@microsoft/sp-core-library!' + fullName: satisfies(compareWith) + summary: >- + Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards + compatible. + remarks: >- + In order to satisfy the compatibility requirements, this object must have the same major version number as the + input parameter, and it must NOT be older than the input parameter. + + + Examples: + + + ``` + + 1.0.0 satisfies 1.0.0 -> true; + + 1.1.0 satisfies 1.0.0 -> true; + + 2.0.0 satisfies 1.0.0 -> false; + + 1.0.0 satisfies 1.1.0 -> false + + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'satisfies(compareWith: Version): boolean;' + parameters: + - id: compareWith + description: The version to compare with + type: '' + return: + type: boolean + description: A boolean indicating if this version is compatible with the input parameter + - name: toString() + uid: '@microsoft/sp-core-library!Version#toString:member(1)' + package: '@microsoft/sp-core-library!' + fullName: toString() + summary: Returns a string representation of the version. + remarks: >- + The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). + However, the number of version parts will be unchanged. + isPreview: false + isDeprecated: false + syntax: + content: 'toString(): string;' + return: + type: string + description: '' + - name: tryParse(versionString) + uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' + package: '@microsoft/sp-core-library!' + fullName: tryParse(versionString) + summary: >- + Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then + undefined is returned. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' + parameters: + - id: versionString + description: A version string + type: string | undefined | null + return: + type: ' | undefined' + description: 'The Version object, or undefined if the string could not be parsed.' diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index 914e3cac..f668b495 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -1,7 +1,7 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-diagnostics!' -name: '@microsoft/sp-diagnostics' -type: package -summary: >- - This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user - engagement and performance logging. +### YamlMime:TSPackage +uid: '@microsoft/sp-diagnostics!' +name: '@microsoft/sp-diagnostics' +type: package +summary: >- + This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user + engagement and performance logging. diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index c6caf5a5..e3af49b4 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -1,14 +1,14 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-dialog!' -name: '@microsoft/sp-dialog' -type: package -summary: SharePoint Framework support for displaying pop-up dialog boxes. -classes: - - '@microsoft/sp-dialog!BaseDialog:class' - - '@microsoft/sp-dialog!Dialog:class' -interfaces: - - '@microsoft/sp-dialog!IAlertOptions:interface' - - '@microsoft/sp-dialog!IDialogConfiguration:interface' - - '@microsoft/sp-dialog!IDialogShowOptions:interface' - - '@microsoft/sp-dialog!IPromptOptions:interface' - - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-dialog!' +name: '@microsoft/sp-dialog' +type: package +summary: SharePoint Framework support for displaying pop-up dialog boxes. +classes: + - '@microsoft/sp-dialog!BaseDialog:class' + - '@microsoft/sp-dialog!Dialog:class' +interfaces: + - '@microsoft/sp-dialog!IAlertOptions:interface' + - '@microsoft/sp-dialog!IDialogConfiguration:interface' + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + - '@microsoft/sp-dialog!IPromptOptions:interface' + - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index e8533e88..072ea4fc 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -1,223 +1,223 @@ -### YamlMime:TSType -name: BaseDialog -uid: '@microsoft/sp-dialog!BaseDialog:class' -package: '@microsoft/sp-dialog!' -fullName: BaseDialog -summary: >- - The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to - the user inside SharePoint Framework components. -remarks: >- - Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the - framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is - controlled by this class by implementing the render method, the framework can decide when to show the dialog and how - to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer - to the documentation of the individual methods and properties to learn more about how to extend and use this class. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(config) - uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' - package: '@microsoft/sp-dialog!' - fullName: (constructor)(config) - summary: Constructor for the `BaseDialog` class. - remarks: >- - It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization - that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can - use the constructor to set initial parameters of your dialog such as references to resources in your application. - The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog - may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user - experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects - it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric - `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak - because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to - dispose. - - - Example: - - - ``` - constructor(cacheReference: any) { - super(); - - this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. - this._cache.refresh(); // This is bad practice. - // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() - } - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(config?: IDialogConfiguration);' - parameters: - - id: config - description: the dialog configuration that affects how the dialog is displayed \* - type: '' -properties: - - name: domElement - uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' - package: '@microsoft/sp-dialog!' - fullName: domElement - summary: Use this property to access the container element provided by the framework for rendering. - remarks: >- - See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on - rendering. - isPreview: false - isDeprecated: false - syntax: - content: 'protected get domElement(): HTMLElement;' - return: - type: HTMLElement - - name: isHidden - uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' - package: '@microsoft/sp-dialog!' - fullName: isHidden - summary: If the dialog is visually hidden. - remarks: >- - This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the - dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - isPreview: false - isDeprecated: false - syntax: - content: 'get isHidden(): boolean;' - return: - type: boolean - - name: isOpen - uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' - package: '@microsoft/sp-dialog!' - fullName: isOpen - summary: >- - If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It - returns false when the dialog is hidden. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isOpen(): boolean;' - return: - type: boolean - - name: isSecondary - uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' - package: '@microsoft/sp-dialog!' - fullName: isSecondary - summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isSecondary(): boolean;' - return: - type: boolean - - name: secondaryDialogProvider - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' - package: '@microsoft/sp-dialog!' - fullName: secondaryDialogProvider - summary: >- - An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs - are permitted. - remarks: >- - Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show - a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a - secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - isPreview: false - isDeprecated: false - syntax: - content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' - return: - type: ' | undefined' -methods: - - name: close() - uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' - package: '@microsoft/sp-dialog!' - fullName: close() - summary: Close the dialog. - remarks: >- - This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to - avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - isPreview: false - isDeprecated: false - syntax: - content: 'close(): Promise;' - return: - type: Promise<void> - description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - - name: onAfterClose() - uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' - package: '@microsoft/sp-dialog!' - fullName: onAfterClose() - summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. - remarks: >- - The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though - the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle - that should reallocate its own resources. If there are any resources that you would like to keep for multiple - lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onAfterClose(): void;' - return: - type: void - description: '' - - name: onBeforeOpen() - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' - package: '@microsoft/sp-dialog!' - fullName: onBeforeOpen() - summary: >- - This method is called before the render method and can be overridden to make preparations for rendering. The - loading indicator is displayed during the lifetime of this method. virtual - remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onBeforeOpen(): Promise;' - return: - type: Promise<void> - description: >- - A promise that resolves when the operations are done and the dialog is ready to render. If the promise is - rejected, the dialog will not be rendered and `onAfterClose()` will not be called. - - name: render() - uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' - package: '@microsoft/sp-dialog!' - fullName: render() - summary: Renders the contents of the dialog. - remarks: >- - The `render` method must be implemented to render the content of the dialog in the container element provided by - the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the - center of the page on top of a dark overlay. - - - The render method is called once after the modal element is created and opened. It is recommended to use - `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that - the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If - you choose to do your initialization or other costly operations inside render method, make sure to have a friendly - UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which - is a bad user experience practice. - isPreview: false - isDeprecated: false - syntax: - content: 'protected abstract render(): void;' - return: - type: void - description: '' - - name: show(options) - uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' - package: '@microsoft/sp-dialog!' - fullName: show(options) - summary: Request the framework to show this dialog. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'show(options?: IDialogShowOptions): Promise;' - parameters: - - id: options - description: >- - Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for - more information. - type: '' - return: - type: Promise<void> - description: >- - A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the - request is rejected or aborted. +### YamlMime:TSType +name: BaseDialog +uid: '@microsoft/sp-dialog!BaseDialog:class' +package: '@microsoft/sp-dialog!' +fullName: BaseDialog +summary: >- + The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to + the user inside SharePoint Framework components. +remarks: >- + Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the + framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is + controlled by this class by implementing the render method, the framework can decide when to show the dialog and how + to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer + to the documentation of the individual methods and properties to learn more about how to extend and use this class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(config) + uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' + package: '@microsoft/sp-dialog!' + fullName: (constructor)(config) + summary: Constructor for the `BaseDialog` class. + remarks: >- + It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization + that is needed for rendering the dialog such as resource allocations and asynchronous calls to fetch data. You can + use the constructor to set initial parameters of your dialog such as references to resources in your application. + The reason for this is that dialogs are usually constructed upon a UI event e.g. a button click, but the dialog + may not always be shown right after construction. Keeping the constructor lightweight ensures smooth user + experience and avoids doing throw-away work in case the dialog is not shown later e.g. if the framework rejects + it. Another benefit of doing this is avoiding memory leaks by doing all the allocations and disposals in symmetric + `onBeforeOpen()` and `onAfterClose()` events. If you allocate resources in the constructor, you have a memory leak + because there is no guarantee onAfterClose() will get called, and onAfterClose() is your only opportunity to + dispose. + + + Example: + + + ``` + constructor(cacheReference: any) { + super(); + + this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. + this._cache.refresh(); // This is bad practice. + // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(config?: IDialogConfiguration);' + parameters: + - id: config + description: the dialog configuration that affects how the dialog is displayed \* + type: '' +properties: + - name: domElement + uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' + package: '@microsoft/sp-dialog!' + fullName: domElement + summary: Use this property to access the container element provided by the framework for rendering. + remarks: >- + See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on + rendering. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get domElement(): HTMLElement;' + return: + type: HTMLElement + - name: isHidden + uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' + package: '@microsoft/sp-dialog!' + fullName: isHidden + summary: If the dialog is visually hidden. + remarks: >- + This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the + dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. + isPreview: false + isDeprecated: false + syntax: + content: 'get isHidden(): boolean;' + return: + type: boolean + - name: isOpen + uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' + package: '@microsoft/sp-dialog!' + fullName: isOpen + summary: >- + If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It + returns false when the dialog is hidden. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isOpen(): boolean;' + return: + type: boolean + - name: isSecondary + uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' + package: '@microsoft/sp-dialog!' + fullName: isSecondary + summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isSecondary(): boolean;' + return: + type: boolean + - name: secondaryDialogProvider + uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' + package: '@microsoft/sp-dialog!' + fullName: secondaryDialogProvider + summary: >- + An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs + are permitted. + remarks: >- + Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show + a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a + secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. + isPreview: false + isDeprecated: false + syntax: + content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' + return: + type: ' | undefined' +methods: + - name: close() + uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' + package: '@microsoft/sp-dialog!' + fullName: close() + summary: Close the dialog. + remarks: >- + This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to + avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. + isPreview: false + isDeprecated: false + syntax: + content: 'close(): Promise;' + return: + type: Promise<void> + description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' + - name: onAfterClose() + uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' + package: '@microsoft/sp-dialog!' + fullName: onAfterClose() + summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. + remarks: >- + The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though + the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle + that should reallocate its own resources. If there are any resources that you would like to keep for multiple + lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onAfterClose(): void;' + return: + type: void + description: '' + - name: onBeforeOpen() + uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' + package: '@microsoft/sp-dialog!' + fullName: onBeforeOpen() + summary: >- + This method is called before the render method and can be overridden to make preparations for rendering. The + loading indicator is displayed during the lifetime of this method. virtual + remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onBeforeOpen(): Promise;' + return: + type: Promise<void> + description: >- + A promise that resolves when the operations are done and the dialog is ready to render. If the promise is + rejected, the dialog will not be rendered and `onAfterClose()` will not be called. + - name: render() + uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' + package: '@microsoft/sp-dialog!' + fullName: render() + summary: Renders the contents of the dialog. + remarks: >- + The `render` method must be implemented to render the content of the dialog in the container element provided by + the framework. Use `this.domElement` to access this container. The container is inside a modal rendered in the + center of the page on top of a dark overlay. + + + The render method is called once after the modal element is created and opened. It is recommended to use + `onBeforeOpen()` for doing non-UI operations for your rendering that might take a long time. This will ensure that + the framework can show a friendly UI such as a spinner to let the user know that the dialog is being prepared. If + you choose to do your initialization or other costly operations inside render method, make sure to have a friendly + UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which + is a bad user experience practice. + isPreview: false + isDeprecated: false + syntax: + content: 'protected abstract render(): void;' + return: + type: void + description: '' + - name: show(options) + uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' + package: '@microsoft/sp-dialog!' + fullName: show(options) + summary: Request the framework to show this dialog. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'show(options?: IDialogShowOptions): Promise;' + parameters: + - id: options + description: >- + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. + type: '' + return: + type: Promise<void> + description: >- + A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the + request is rejected or aborted. diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 43a7543d..d632447d 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -1,61 +1,61 @@ -### YamlMime:TSType -name: Dialog -uid: '@microsoft/sp-dialog!Dialog:class' -package: '@microsoft/sp-dialog!' -fullName: Dialog -summary: A static class for showing stock dialogs such as an alert or prompt. -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'alert(message, options)' - uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'alert(message, options)' - summary: >- - Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to - show the alert dialog. - remarks: >- - There might be a delay until the dialog is approved and shown by the application, for example, if there is another - dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The - promise rejects if the application rejects the request for any reason. - isPreview: false - isDeprecated: false - syntax: - content: 'static alert(message: string, options?: IAlertOptions): Promise;' - parameters: - - id: message - description: The message to alert - type: string - - id: options - description: '' - type: '' - return: - type: Promise<void> - description: '' - - name: 'prompt(message, options)' - uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'prompt(message, options)' - summary: >- - Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to - application to show the dialog. - remarks: >- - There might be a delay until the dialog is approved and shown by the application, for example, if there is another - dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The - promise rejects if the application rejects the request for any reason. - isPreview: false - isDeprecated: false - syntax: - content: 'static prompt(message: string, options?: IPromptOptions): Promise;' - parameters: - - id: message - description: The message for prompt dialog - type: string - - id: options - description: '' - type: '' - return: - type: Promise<string | undefined> - description: The input string or undefined if the dialog was canceled +### YamlMime:TSType +name: Dialog +uid: '@microsoft/sp-dialog!Dialog:class' +package: '@microsoft/sp-dialog!' +fullName: Dialog +summary: A static class for showing stock dialogs such as an alert or prompt. +remarks: '' +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'alert(message, options)' + uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'alert(message, options)' + summary: >- + Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to + show the alert dialog. + remarks: >- + There might be a delay until the dialog is approved and shown by the application, for example, if there is another + dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The + promise rejects if the application rejects the request for any reason. + isPreview: false + isDeprecated: false + syntax: + content: 'static alert(message: string, options?: IAlertOptions): Promise;' + parameters: + - id: message + description: The message to alert + type: string + - id: options + description: '' + type: '' + return: + type: Promise<void> + description: '' + - name: 'prompt(message, options)' + uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'prompt(message, options)' + summary: >- + Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to + application to show the dialog. + remarks: >- + There might be a delay until the dialog is approved and shown by the application, for example, if there is another + dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The + promise rejects if the application rejects the request for any reason. + isPreview: false + isDeprecated: false + syntax: + content: 'static prompt(message: string, options?: IPromptOptions): Promise;' + parameters: + - id: message + description: The message for prompt dialog + type: string + - id: options + description: '' + type: '' + return: + type: Promise<string | undefined> + description: The input string or undefined if the dialog was canceled diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index c3320646..2b172728 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IAlertOptions -uid: '@microsoft/sp-dialog!IAlertOptions:interface' -package: '@microsoft/sp-dialog!' -fullName: IAlertOptions -summary: Options for showing an alert dialog -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: IAlertOptions +uid: '@microsoft/sp-dialog!IAlertOptions:interface' +package: '@microsoft/sp-dialog!' +fullName: IAlertOptions +summary: Options for showing an alert dialog +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index edf5e34b..06c362f8 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IDialogConfiguration -uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' -package: '@microsoft/sp-dialog!' -fullName: IDialogConfiguration -summary: The interface for dialog configuration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isBlocking - uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' - package: '@microsoft/sp-dialog!' - fullName: isBlocking - summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isBlocking?: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IDialogConfiguration +uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' +package: '@microsoft/sp-dialog!' +fullName: IDialogConfiguration +summary: The interface for dialog configuration +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isBlocking + uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' + package: '@microsoft/sp-dialog!' + fullName: isBlocking + summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isBlocking?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 33cec05c..572bff4a 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -1,28 +1,28 @@ -### YamlMime:TSType -name: IDialogShowOptions -uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' -package: '@microsoft/sp-dialog!' -fullName: IDialogShowOptions -summary: Options for showing a dialog -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: confirmOpen - uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' - package: '@microsoft/sp-dialog!' - fullName: confirmOpen - summary: A callback that is invoked immediately before the dialog receives focus. - remarks: >- - Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the - framework. For example, you can check if a long time has passed since the request was made or the the component - requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this - callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long - time for it. - isPreview: false - isDeprecated: false - syntax: - content: 'confirmOpen?: () => boolean;' - return: - type: () => boolean +### YamlMime:TSType +name: IDialogShowOptions +uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' +package: '@microsoft/sp-dialog!' +fullName: IDialogShowOptions +summary: Options for showing a dialog +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: confirmOpen + uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' + package: '@microsoft/sp-dialog!' + fullName: confirmOpen + summary: A callback that is invoked immediately before the dialog receives focus. + remarks: >- + Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the + framework. For example, you can check if a long time has passed since the request was made or the the component + requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this + callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long + time for it. + isPreview: false + isDeprecated: false + syntax: + content: 'confirmOpen?: () => boolean;' + return: + type: () => boolean diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index f9971bce..f8c1dcae 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -1,24 +1,24 @@ -### YamlMime:TSType -name: IPromptOptions -uid: '@microsoft/sp-dialog!IPromptOptions:interface' -package: '@microsoft/sp-dialog!' -fullName: IPromptOptions -summary: Options for showing a prompt dialog -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: defaultValue - uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' - package: '@microsoft/sp-dialog!' - fullName: defaultValue - summary: The default value for the input text field of prompt dialog - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'defaultValue?: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IPromptOptions +uid: '@microsoft/sp-dialog!IPromptOptions:interface' +package: '@microsoft/sp-dialog!' +fullName: IPromptOptions +summary: Options for showing a prompt dialog +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: defaultValue + uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' + package: '@microsoft/sp-dialog!' + fullName: defaultValue + summary: The default value for the input text field of prompt dialog + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'defaultValue?: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index f8d6d1a5..a2258f65 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -1,94 +1,94 @@ -### YamlMime:TSType -name: ISecondaryDialogProvider -uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' -package: '@microsoft/sp-dialog!' -fullName: ISecondaryDialogProvider -summary: >- - This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider - inside a dialog. -remarks: >- - Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has - permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until - the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more - secondary dialogs are rejected. - - - See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for - how to use this. -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'alert(message, options)' - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'alert(message, options)' - summary: >- - Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that - the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'alert(message: string, options?: IAlertOptions): Promise;' - parameters: - - id: message - description: '' - type: string - - id: options - description: >- - Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for - more information. - type: '' - return: - type: Promise<void> - description: '' - - name: 'prompt(message, options)' - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'prompt(message, options)' - summary: >- - Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is - that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'prompt(message: string, options?: IPromptOptions): Promise;' - parameters: - - id: message - description: '' - type: string - - id: options - description: >- - Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' - return: - type: Promise<string> - description: '' - - name: 'show(dialog, options)' - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'show(dialog, options)' - summary: >- - Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog%23show:member(1)). The dialog to show - is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, - the promise rejects. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' - parameters: - - id: dialog - description: '' - type: '' - - id: options - description: >- - Dialog showing options. The confirmOpen option will be ignored. See - [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' - return: - type: Promise<void> - description: '' +### YamlMime:TSType +name: ISecondaryDialogProvider +uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' +package: '@microsoft/sp-dialog!' +fullName: ISecondaryDialogProvider +summary: >- + This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider + inside a dialog. +remarks: >- + Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has + permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until + the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more + secondary dialogs are rejected. + + + See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for + how to use this. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: 'alert(message, options)' + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'alert(message, options)' + summary: >- + Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that + the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'alert(message: string, options?: IAlertOptions): Promise;' + parameters: + - id: message + description: '' + type: string + - id: options + description: >- + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. + type: '' + return: + type: Promise<void> + description: '' + - name: 'prompt(message, options)' + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'prompt(message, options)' + summary: >- + Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is + that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'prompt(message: string, options?: IPromptOptions): Promise;' + parameters: + - id: message + description: '' + type: string + - id: options + description: >- + Dialog showing options. The confirmOpen option will be ignored. See + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. + type: '' + return: + type: Promise<string> + description: '' + - name: 'show(dialog, options)' + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' + package: '@microsoft/sp-dialog!' + fullName: 'show(dialog, options)' + summary: >- + Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog%23show:member(1)). The dialog to show + is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, + the promise rejects. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' + parameters: + - id: dialog + description: '' + type: '' + - id: options + description: >- + Dialog showing options. The confirmOpen option will be ignored. See + [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. + type: '' + return: + type: Promise<void> + description: '' diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index f71f06f7..1721daaa 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -1,17 +1,17 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-dynamic-data!' -name: '@microsoft/sp-dynamic-data' -type: package -summary: SharePoint Framework support for dynamic data bindings. -classes: - - '@microsoft/sp-dynamic-data!DynamicDataReference:class' -interfaces: - - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-dynamic-data!' +name: '@microsoft/sp-dynamic-data' +type: package +summary: SharePoint Framework support for dynamic data bindings. +classes: + - '@microsoft/sp-dynamic-data!DynamicDataReference:class' +interfaces: + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 4d9f92ff..8486625f 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -1,79 +1,79 @@ -### YamlMime:TSType -name: DynamicDataReference -uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' -package: '@microsoft/sp-dynamic-data!' -fullName: DynamicDataReference -summary: >- - Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) - of Dynamic Data -remarks: |- - The reference string is of the form `:` or `::` - - Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(reference) - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: (constructor)(reference) - summary: Constructs a new instance of the `DynamicDataReference` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(reference: string);' - parameters: - - id: reference - description: '' - type: string -properties: - - name: property - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' - package: '@microsoft/sp-dynamic-data!' - fullName: property - summary: Returns the referred property of the Dynamic Data. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get property(): string;' - return: - type: string - - name: propertyPath - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' - package: '@microsoft/sp-dynamic-data!' - fullName: propertyPath - summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get propertyPath(): string | undefined;' - return: - type: string | undefined - - name: reference - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' - package: '@microsoft/sp-dynamic-data!' - fullName: reference - summary: Returns the full reference of the Dynamic Data object as a string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get reference(): string;' - return: - type: string - - name: sourceId - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' - package: '@microsoft/sp-dynamic-data!' - fullName: sourceId - summary: Returns the referred id of the Dynamic Data Source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get sourceId(): string;' - return: - type: string +### YamlMime:TSType +name: DynamicDataReference +uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' +package: '@microsoft/sp-dynamic-data!' +fullName: DynamicDataReference +summary: >- + Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) + of Dynamic Data +remarks: |- + The reference string is of the form `:` or `::` + + Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(reference) + uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: (constructor)(reference) + summary: Constructs a new instance of the `DynamicDataReference` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(reference: string);' + parameters: + - id: reference + description: '' + type: string +properties: + - name: property + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' + package: '@microsoft/sp-dynamic-data!' + fullName: property + summary: Returns the referred property of the Dynamic Data. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get property(): string;' + return: + type: string + - name: propertyPath + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' + package: '@microsoft/sp-dynamic-data!' + fullName: propertyPath + summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get propertyPath(): string | undefined;' + return: + type: string | undefined + - name: reference + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' + package: '@microsoft/sp-dynamic-data!' + fullName: reference + summary: Returns the full reference of the Dynamic Data object as a string. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get reference(): string;' + return: + type: string + - name: sourceId + uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' + package: '@microsoft/sp-dynamic-data!' + fullName: sourceId + summary: Returns the referred id of the Dynamic Data Source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get sourceId(): string;' + return: + type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index a7e9eb24..b0e70cbb 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -1,37 +1,37 @@ -### YamlMime:TSType -name: IDynamicDataAnnotatedPropertyValue -uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataAnnotatedPropertyValue -summary: >- - Describes the value and the structure of a property value. It contains sample value of the property and the metadata - describing the structure of that value. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: metadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' - package: '@microsoft/sp-dynamic-data!' - fullName: metadata - summary: Metadata describing the sample value of the property. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' - return: - type: '' - - name: sampleValue - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' - package: '@microsoft/sp-dynamic-data!' - fullName: sampleValue - summary: Sample value of a property - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sampleValue: any;' - return: - type: any +### YamlMime:TSType +name: IDynamicDataAnnotatedPropertyValue +uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataAnnotatedPropertyValue +summary: >- + Describes the value and the structure of a property value. It contains sample value of the property and the metadata + describing the structure of that value. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: metadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' + package: '@microsoft/sp-dynamic-data!' + fullName: metadata + summary: Metadata describing the sample value of the property. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' + return: + type: '' + - name: sampleValue + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' + package: '@microsoft/sp-dynamic-data!' + fullName: sampleValue + summary: Sample value of a property + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'sampleValue: any;' + return: + type: any diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 7fb597f0..39adbf0b 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -1,105 +1,105 @@ -### YamlMime:TSType -name: IDynamicDataCallables -uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataCallables -summary: >- - Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with - state, or a set of loose functions that returns the data. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: allowedEvents() - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: allowedEvents() - summary: |- - Returns list of allowed events on the dynamic data source. - - When this function returns a non-empty result, then source must define 'sendEvent' api. - - If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'allowedEvents?(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' - description: '' - - name: getAnnotatedPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getAnnotatedPropertyValue(propertyId) - summary: >- - Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls - back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' - parameters: - - id: propertyId - description: One of the property ids exposed from the dynamic data source. - type: string - return: - type: ' | undefined' - description: '' - - name: getPropertyDefinitions() - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyDefinitions() - summary: Returns all the property definitions that the DataSource will provide. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getPropertyDefinitions(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' - description: '' - - name: getPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyValue(propertyId) - summary: 'Given a property id, returns the value of the property.' - remarks: 'It is assumed that when this function returns an array, it is homogeneous.' - isPreview: false - isDeprecated: false - syntax: - content: 'getPropertyValue(propertyId: string): any;' - parameters: - - id: propertyId - description: '' - type: string - return: - type: any - description: '' - - name: 'sendEvent(eventName, data)' - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: 'sendEvent(eventName, data)' - summary: >- - If defined, enables the consumer to send data to the associated dynamic data source. Then source can act - accordingly. - - - Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'sendEvent?(eventName: string, data: any): void;' - parameters: - - id: eventName - description: A case-sensitive string representing the name of the event. - type: string - - id: data - description: Data to be sent to the dynamic data source. - type: any - return: - type: void - description: '' +### YamlMime:TSType +name: IDynamicDataCallables +uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataCallables +summary: >- + Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with + state, or a set of loose functions that returns the data. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: allowedEvents() + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: allowedEvents() + summary: |- + Returns list of allowed events on the dynamic data source. + + When this function returns a non-empty result, then source must define 'sendEvent' api. + + If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'allowedEvents?(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + description: '' + - name: getAnnotatedPropertyValue(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getAnnotatedPropertyValue(propertyId) + summary: >- + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' + parameters: + - id: propertyId + description: One of the property ids exposed from the dynamic data source. + type: string + return: + type: ' | undefined' + description: '' + - name: getPropertyDefinitions() + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyDefinitions() + summary: Returns all the property definitions that the DataSource will provide. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getPropertyDefinitions(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + description: '' + - name: getPropertyValue(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyValue(propertyId) + summary: 'Given a property id, returns the value of the property.' + remarks: 'It is assumed that when this function returns an array, it is homogeneous.' + isPreview: false + isDeprecated: false + syntax: + content: 'getPropertyValue(propertyId: string): any;' + parameters: + - id: propertyId + description: '' + type: string + return: + type: any + description: '' + - name: 'sendEvent(eventName, data)' + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: 'sendEvent(eventName, data)' + summary: >- + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. + + + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'sendEvent?(eventName: string, data: any): void;' + parameters: + - id: eventName + description: A case-sensitive string representing the name of the event. + type: string + - id: data + description: Data to be sent to the dynamic data source. + type: any + return: + type: void + description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 3ad515b0..7208490d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -1,38 +1,38 @@ -### YamlMime:TSType -name: IDynamicDataEventDefinition -uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataEventDefinition -summary: |- - Definition of an event which a dynamic data source accepts. - - It includes the name of the event and description to be seen and used by end users. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' - package: '@microsoft/sp-dynamic-data!' - fullName: description - summary: 'User-friendly, localized description of the event.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: name - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' - package: '@microsoft/sp-dynamic-data!' - fullName: name - summary: Event name - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'name: string;' - return: - type: string +### YamlMime:TSType +name: IDynamicDataEventDefinition +uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataEventDefinition +summary: |- + Definition of an event which a dynamic data source accepts. + + It includes the name of the event and description to be seen and used by end users. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' + package: '@microsoft/sp-dynamic-data!' + fullName: description + summary: 'User-friendly, localized description of the event.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: name + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' + package: '@microsoft/sp-dynamic-data!' + fullName: name + summary: Event name + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 3edabe15..3c7a374b 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -1,28 +1,28 @@ -### YamlMime:TSType -name: IDynamicDataPropertyDefinition -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyDefinition -summary: >- - Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, - localized title and description to be seen and used by end users. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' - package: '@microsoft/sp-dynamic-data!' - fullName: id - summary: >- - Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or - "time\_in\_24-hour\_clock" - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IDynamicDataPropertyDefinition +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyDefinition +summary: >- + Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, + localized title and description to be seen and used by end users. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' + package: '@microsoft/sp-dynamic-data!' + fullName: id + summary: >- + Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or + "time\_in\_24-hour\_clock" + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index ad278993..0566203f 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: IDynamicDataPropertyMetadata -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyMetadata -summary: Metadata of a property -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' - package: '@microsoft/sp-dynamic-data!' - fullName: description - summary: >- - User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the - current user" - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' - package: '@microsoft/sp-dynamic-data!' - fullName: title - summary: >- - User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current - language) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string +### YamlMime:TSType +name: IDynamicDataPropertyMetadata +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyMetadata +summary: Metadata of a property +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' + package: '@microsoft/sp-dynamic-data!' + fullName: description + summary: >- + User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the + current user" + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' + package: '@microsoft/sp-dynamic-data!' + fullName: title + summary: >- + User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current + language) + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 55d262ce..df35e22f 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -1,24 +1,24 @@ -### YamlMime:TSType -name: IDynamicDataPropertyValueMetadata -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyValueMetadata -summary: Metadata describing the sample value of the property. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: metadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' - package: '@microsoft/sp-dynamic-data!' - fullName: metadata - summary: Metadata describing the sample value of the property. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' - return: - type: '' -extends: '' +### YamlMime:TSType +name: IDynamicDataPropertyValueMetadata +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyValueMetadata +summary: Metadata describing the sample value of the property. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: metadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' + package: '@microsoft/sp-dynamic-data!' + fullName: metadata + summary: Metadata describing the sample value of the property. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' + return: + type: '' +extends: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index 5a0717b8..ef701e5f 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -1,79 +1,79 @@ -### YamlMime:TSType -name: IDynamicDataPropertyValueMetadataCollection -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyValueMetadataCollection -summary: >- - A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the - metadata describing the 'key' and its value. -remarks: >- - Important note: - - - 1. Key in the metadata should match the key in the sample value object. - - - 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example - for more details. - - - For example: - - - ``` - - case 1: With simple values - Sample Property Id value - { - firstName: 'Bob', - lastName: 'Smith', - age: 30 - } - - MetadataCollection for the above object would be - - metadataCollection: { - 'firstName': { title: 'First Name' }, - 'lastName': { title: 'Last Name' }, - 'age': { title: 'Age' } - } - - Case 2: With complex values - Sample Property Id value - { - person: { - firstName: 'Bob', - lastName: 'Smith', - age: 30 - }, - visitedLocations: [ - { - city: 'Redmond', - state: 'WA' - }, - { - city: 'New York City', - state: 'NY' - } - ] - } - - MetadataCollection for the above object would be - - metadataCollection: { - 'person': { - title: 'Person', - metadataCollection: { - 'firstName': { title: 'First Name' }, - 'lastName': { title: 'Last Name' }, - 'age': { title: 'Age' } - } - }, - 'vistedLocations': { - title: 'Visted Locations', - metadataCollection: { - 'city': { title: 'City' }, - 'state': { title: 'State' } - } - } - } - ``` -isPreview: false -isDeprecated: false -type: interface +### YamlMime:TSType +name: IDynamicDataPropertyValueMetadataCollection +uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataPropertyValueMetadataCollection +summary: >- + A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the + metadata describing the 'key' and its value. +remarks: >- + Important note: + + + 1. Key in the metadata should match the key in the sample value object. + + + 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example + for more details. + + + For example: + + + ``` + + case 1: With simple values + Sample Property Id value - { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + } + + MetadataCollection for the above object would be - + metadataCollection: { + 'firstName': { title: 'First Name' }, + 'lastName': { title: 'Last Name' }, + 'age': { title: 'Age' } + } + + Case 2: With complex values + Sample Property Id value - { + person: { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + }, + visitedLocations: [ + { + city: 'Redmond', + state: 'WA' + }, + { + city: 'New York City', + state: 'NY' + } + ] + } + + MetadataCollection for the above object would be - + metadataCollection: { + 'person': { + title: 'Person', + metadataCollection: { + 'firstName': { title: 'First Name' }, + 'lastName': { title: 'Last Name' }, + 'age': { title: 'Age' } + } + }, + 'vistedLocations': { + title: 'Visted Locations', + metadataCollection: { + 'city': { title: 'City' }, + 'state': { title: 'State' } + } + } + } + ``` +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index a2c93fde..d4146af1 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -1,194 +1,194 @@ -### YamlMime:TSType -name: IDynamicDataSource -uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataSource -summary: >- - Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to - get the data. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' - package: '@microsoft/sp-dynamic-data!' - fullName: id - summary: Id of the Dynamic Data Source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string - - name: metadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' - package: '@microsoft/sp-dynamic-data!' - fullName: metadata - summary: Metadata of the Dynamic Data Source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'metadata: IDynamicDataSourceMetadata;' - return: - type: '' -methods: - - name: allowedEventsAsync() - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: allowedEventsAsync() - summary: >- - Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source - must define 'sendData' api. - - - If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'allowedEventsAsync?(): Promise>;' - return: - type: >- - Promise<ReadonlyArray<>> - description: '' - - name: getAnnotatedPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getAnnotatedPropertyValue(propertyId) - summary: >- - Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls - back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' - syntax: - content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' - parameters: - - id: propertyId - description: One of the property ids exposed from the dynamic data source. - type: string - return: - type: '' - description: '' - - name: getAnnotatedPropertyValueAsync(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getAnnotatedPropertyValueAsync(propertyId) - summary: >- - Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls - back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise;' - parameters: - - id: propertyId - description: Property id for which the value is requested. - type: string - return: - type: 'Promise<>' - description: '' - - name: getPropertyDefinitions() - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyDefinitions() - summary: >- - Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the - component. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' - syntax: - content: 'getPropertyDefinitions(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' - description: '' - - name: getPropertyDefinitionsAsync() - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyDefinitionsAsync() - summary: >- - Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the - component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getPropertyDefinitionsAsync(): Promise>;' - return: - type: >- - Promise<ReadonlyArray<>> - description: '' - - name: getPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyValue(propertyId) - summary: >- - Given a property id, returns the value of the property. This needs to be overriden by the implementation of the - component. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' - syntax: - content: 'getPropertyValue(propertyId: string): any;' - parameters: - - id: propertyId - description: Property id for which the value is requested. - type: string - return: - type: any - description: '' - - name: getPropertyValueAsync(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyValueAsync(propertyId) - summary: >- - Given a property id, returns the value of the property. This needs to be overriden by the implementation of the - component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getPropertyValueAsync(propertyId: string): Promise;' - parameters: - - id: propertyId - description: Property id for which the value is requested. - type: string - return: - type: Promise<any> - description: '' - - name: 'sendEvent(eventName, data)' - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: 'sendEvent(eventName, data)' - summary: >- - If defined, enables the consumer to send data to the associated dynamic data source. Then source can act - accordingly. - - - Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'sendEvent?(eventName: string, data: any): void;' - parameters: - - id: eventName - description: A case-sensitive string representing the name of the event. - type: string - - id: data - description: Data to be sent to the dynamic data source. - type: any - return: - type: void - description: '' +### YamlMime:TSType +name: IDynamicDataSource +uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataSource +summary: >- + Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to + get the data. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' + package: '@microsoft/sp-dynamic-data!' + fullName: id + summary: Id of the Dynamic Data Source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: metadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' + package: '@microsoft/sp-dynamic-data!' + fullName: metadata + summary: Metadata of the Dynamic Data Source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'metadata: IDynamicDataSourceMetadata;' + return: + type: '' +methods: + - name: allowedEventsAsync() + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: allowedEventsAsync() + summary: >- + Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source + must define 'sendData' api. + + + If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'allowedEventsAsync?(): Promise>;' + return: + type: >- + Promise<ReadonlyArray<>> + description: '' + - name: getAnnotatedPropertyValue(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getAnnotatedPropertyValue(propertyId) + summary: >- + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' + syntax: + content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' + parameters: + - id: propertyId + description: One of the property ids exposed from the dynamic data source. + type: string + return: + type: '' + description: '' + - name: getAnnotatedPropertyValueAsync(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getAnnotatedPropertyValueAsync(propertyId) + summary: >- + Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls + back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise;' + parameters: + - id: propertyId + description: Property id for which the value is requested. + type: string + return: + type: 'Promise<>' + description: '' + - name: getPropertyDefinitions() + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyDefinitions() + summary: >- + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' + syntax: + content: 'getPropertyDefinitions(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + description: '' + - name: getPropertyDefinitionsAsync() + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyDefinitionsAsync() + summary: >- + Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the + component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getPropertyDefinitionsAsync(): Promise>;' + return: + type: >- + Promise<ReadonlyArray<>> + description: '' + - name: getPropertyValue(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyValue(propertyId) + summary: >- + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' + syntax: + content: 'getPropertyValue(propertyId: string): any;' + parameters: + - id: propertyId + description: Property id for which the value is requested. + type: string + return: + type: any + description: '' + - name: getPropertyValueAsync(propertyId) + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: getPropertyValueAsync(propertyId) + summary: >- + Given a property id, returns the value of the property. This needs to be overriden by the implementation of the + component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getPropertyValueAsync(propertyId: string): Promise;' + parameters: + - id: propertyId + description: Property id for which the value is requested. + type: string + return: + type: Promise<any> + description: '' + - name: 'sendEvent(eventName, data)' + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' + package: '@microsoft/sp-dynamic-data!' + fullName: 'sendEvent(eventName, data)' + summary: >- + If defined, enables the consumer to send data to the associated dynamic data source. Then source can act + accordingly. + + + Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'sendEvent?(eventName: string, data: any): void;' + parameters: + - id: eventName + description: A case-sensitive string representing the name of the event. + type: string + - id: data + description: Data to be sent to the dynamic data source. + type: any + return: + type: void + description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 7c8845fa..2ec749b1 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -1,80 +1,80 @@ -### YamlMime:TSType -name: IDynamicDataSourceMetadata -uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataSourceMetadata -summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: alias - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' - package: '@microsoft/sp-dynamic-data!' - fullName: alias - summary: >- - Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come - from a component, for example framework level data sources. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'alias?: string;' - return: - type: string - - name: componentId - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' - package: '@microsoft/sp-dynamic-data!' - fullName: componentId - summary: >- - Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from - a component, for example framework level data sources. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'componentId?: string;' - return: - type: string - - name: description - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' - package: '@microsoft/sp-dynamic-data!' - fullName: description - summary: 'User-friendly, localized description of the Dynamic Data Source.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: instanceId - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' - package: '@microsoft/sp-dynamic-data!' - fullName: instanceId - summary: >- - Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for - example, between two web parts with the same type. It can be undefined when the sources doesn't come from a - component, for example framework level data sources. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'instanceId?: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' - package: '@microsoft/sp-dynamic-data!' - fullName: title - summary: >- - User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. - By default it's the alias of the component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string +### YamlMime:TSType +name: IDynamicDataSourceMetadata +uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' +package: '@microsoft/sp-dynamic-data!' +fullName: IDynamicDataSourceMetadata +summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: alias + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' + package: '@microsoft/sp-dynamic-data!' + fullName: alias + summary: >- + Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come + from a component, for example framework level data sources. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'alias?: string;' + return: + type: string + - name: componentId + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' + package: '@microsoft/sp-dynamic-data!' + fullName: componentId + summary: >- + Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from + a component, for example framework level data sources. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'componentId?: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' + package: '@microsoft/sp-dynamic-data!' + fullName: description + summary: 'User-friendly, localized description of the Dynamic Data Source.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: instanceId + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' + package: '@microsoft/sp-dynamic-data!' + fullName: instanceId + summary: >- + Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for + example, between two web parts with the same type. It can be undefined when the sources doesn't come from a + component, for example framework level data sources. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'instanceId?: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' + package: '@microsoft/sp-dynamic-data!' + fullName: title + summary: >- + User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. + By default it's the alias of the component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index 72499721..e151167a 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -1,8 +1,8 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-extension-base!' -name: '@microsoft/sp-extension-base' -type: package -summary: SharePoint Framework support for building client-side extensions. -classes: - - '@microsoft/sp-extension-base!BaseExtension:class' - - '@microsoft/sp-extension-base!ExtensionContext:class' +### YamlMime:TSPackage +uid: '@microsoft/sp-extension-base!' +name: '@microsoft/sp-extension-base' +type: package +summary: SharePoint Framework support for building client-side extensions. +classes: + - '@microsoft/sp-extension-base!BaseExtension:class' + - '@microsoft/sp-extension-base!ExtensionContext:class' diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 3a9b777f..ac1a3264 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -1,58 +1,58 @@ -### YamlMime:TSType -name: BaseExtension -uid: '@microsoft/sp-extension-base!BaseExtension:class' -package: '@microsoft/sp-extension-base!' -fullName: BaseExtension -summary: The base class for all client-side extensions. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseExtension` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-extension-base!BaseExtension#context:member' - package: '@microsoft/sp-extension-base!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: false - isDeprecated: false - syntax: - content: 'protected readonly context: ExtensionContext;' - return: - type: '' - - name: properties - uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' - package: '@microsoft/sp-extension-base!' - fullName: properties - summary: Extension properties is a JavaScript object that are passed in by the application that initializes the extension. - remarks: >- - Properties can be used in the extension code to define configurable behaviors. The application has control over - what properties to provide to an instance of the extension, however the most common way would be to have it stored - on the server as JSON and pass it as is to the extension on initialization. - isPreview: false - isDeprecated: false - syntax: - content: 'protected get properties(): TProperties;' - return: - type: TProperties -methods: - - name: onInit() - uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' - package: '@microsoft/sp-extension-base!' - fullName: onInit() - summary: This event method is called when the client-side extension is first activated on the page. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected onInit(): Promise;' - return: - type: Promise<void> - description: '' -extends: '' +### YamlMime:TSType +name: BaseExtension +uid: '@microsoft/sp-extension-base!BaseExtension:class' +package: '@microsoft/sp-extension-base!' +fullName: BaseExtension +summary: The base class for all client-side extensions. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseExtension` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-extension-base!BaseExtension#context:member' + package: '@microsoft/sp-extension-base!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly context: ExtensionContext;' + return: + type: '' + - name: properties + uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' + package: '@microsoft/sp-extension-base!' + fullName: properties + summary: Extension properties is a JavaScript object that are passed in by the application that initializes the extension. + remarks: >- + Properties can be used in the extension code to define configurable behaviors. The application has control over + what properties to provide to an instance of the extension, however the most common way would be to have it stored + on the server as JSON and pass it as is to the extension on initialization. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get properties(): TProperties;' + return: + type: TProperties +methods: + - name: onInit() + uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' + package: '@microsoft/sp-extension-base!' + fullName: onInit() + summary: This event method is called when the client-side extension is first activated on the page. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onInit(): Promise;' + return: + type: Promise<void> + description: '' +extends: '' diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 665f0ed4..9af3d712 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -1,13 +1,13 @@ -### YamlMime:TSType -name: ExtensionContext -uid: '@microsoft/sp-extension-base!ExtensionContext:class' -package: '@microsoft/sp-extension-base!' -fullName: ExtensionContext -summary: The base class for context objects for client-side extensions. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ExtensionContext` class. -isPreview: false -isDeprecated: false -type: class -extends: '' +### YamlMime:TSType +name: ExtensionContext +uid: '@microsoft/sp-extension-base!ExtensionContext:class' +package: '@microsoft/sp-extension-base!' +fullName: ExtensionContext +summary: The base class for context objects for client-side extensions. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ExtensionContext` class. +isPreview: false +isDeprecated: false +type: class +extends: '' diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 25c68bb6..d119d250 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -1,50 +1,50 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-http!' -name: '@microsoft/sp-http' -type: package -summary: Base communication layer for the SharePoint Framework -classes: - - '@microsoft/sp-http!AadHttpClient:class' - - '@microsoft/sp-http!AadHttpClientConfiguration:class' - - '@microsoft/sp-http!AadHttpClientFactory:class' - - '@microsoft/sp-http!AadHttpClientResponse:class' - - '@microsoft/sp-http!AadTokenProvider:class' - - '@microsoft/sp-http!AadTokenProviderFactory:class' - - '@microsoft/sp-http!BeforeRedirectEventArgs:class' - - '@microsoft/sp-http!DigestCache:class' - - '@microsoft/sp-http!HttpClient:class' - - '@microsoft/sp-http!HttpClientConfiguration:class' - - '@microsoft/sp-http!HttpClientResponse:class' - - '@microsoft/sp-http!MSGraphClient:class' - - '@microsoft/sp-http!MSGraphClientFactory:class' - - '@microsoft/sp-http!ODataVersion:class' - - '@microsoft/sp-http!SPHttpClient:class' - - '@microsoft/sp-http!SPHttpClientBatch:class' - - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - - '@microsoft/sp-http!SPHttpClientConfiguration:class' - - '@microsoft/sp-http!SPHttpClientResponse:class' - - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' -interfaces: - - '@microsoft/sp-http!GraphRequest:interface' - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - - '@microsoft/sp-http!IAadHttpClientOptions:interface' - - '@microsoft/sp-http!IAadTokenProvider:interface' - - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - - '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' - - '@microsoft/sp-http!IDigestCache:interface' - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - - '@microsoft/sp-http!IHttpClientConfigurations:interface' - - '@microsoft/sp-http!IHttpClientOptions:interface' - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - - '@microsoft/sp-http!ISPHttpClientOptions:interface' - - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' -enums: - - '@microsoft/sp-http!SPHttpHeader:enum' +### YamlMime:TSPackage +uid: '@microsoft/sp-http!' +name: '@microsoft/sp-http' +type: package +summary: Base communication layer for the SharePoint Framework +classes: + - '@microsoft/sp-http!AadHttpClient:class' + - '@microsoft/sp-http!AadHttpClientConfiguration:class' + - '@microsoft/sp-http!AadHttpClientFactory:class' + - '@microsoft/sp-http!AadHttpClientResponse:class' + - '@microsoft/sp-http!AadTokenProvider:class' + - '@microsoft/sp-http!AadTokenProviderFactory:class' + - '@microsoft/sp-http!BeforeRedirectEventArgs:class' + - '@microsoft/sp-http!DigestCache:class' + - '@microsoft/sp-http!HttpClient:class' + - '@microsoft/sp-http!HttpClientConfiguration:class' + - '@microsoft/sp-http!HttpClientResponse:class' + - '@microsoft/sp-http!MSGraphClient:class' + - '@microsoft/sp-http!MSGraphClientFactory:class' + - '@microsoft/sp-http!ODataVersion:class' + - '@microsoft/sp-http!SPHttpClient:class' + - '@microsoft/sp-http!SPHttpClientBatch:class' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + - '@microsoft/sp-http!SPHttpClientConfiguration:class' + - '@microsoft/sp-http!SPHttpClientResponse:class' + - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' +interfaces: + - '@microsoft/sp-http!GraphRequest:interface' + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - '@microsoft/sp-http!IAadHttpClientOptions:interface' + - '@microsoft/sp-http!IAadTokenProvider:interface' + - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' + - '@microsoft/sp-http!IDigestCache:interface' + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - '@microsoft/sp-http!IHttpClientConfigurations:interface' + - '@microsoft/sp-http!IHttpClientOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' +enums: + - '@microsoft/sp-http!SPHttpHeader:enum' diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index a0ddf9d4..5c799ded 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -1,134 +1,134 @@ -### YamlMime:TSType -name: AadHttpClient -uid: '@microsoft/sp-http!AadHttpClient:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClient -summary: AadHttpClient is used to perform REST calls against an Azure AD Application. -remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. - For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(serviceScope, resourceEndpoint, options)' - uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(serviceScope, resourceEndpoint, options)' - summary: Constructs a new instance of the `AadHttpClient` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);' - parameters: - - id: serviceScope - description: The service scope is needed to retrieve some of the class's internal components. - type: '' - - id: resourceEndpoint - description: '' - type: string - - id: options - description: Configuration options for the request to get an access token. - type: '' -properties: - - name: configurations - uid: '@microsoft/sp-http!AadHttpClient.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations - summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly configurations: IAadHttpClientConfigurations;' - return: - type: '' -methods: - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' - summary: Performs a REST service call. - remarks: >- - Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for - HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: - https://fetch.spec.whatwg.org/ - isPreview: false - isDeprecated: false - syntax: - content: >- - fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): - Promise; - parameters: - - id: url - description: The endpoint URL that fetch will be called on. - type: string - - id: configuration - description: >- - Determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations. - type: '' - - id: options - description: Additional options that affect the request. - type: '' - return: - type: 'Promise<>' - description: A promise that will return the result. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): - Promise; - parameters: - - id: url - description: The endpoint URL that fetch will be called on. - type: string - - id: configuration - description: >- - Determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations. - type: '' - - id: options - description: Additional options that affect the request. - type: '' - return: - type: 'Promise<>' - description: A promise that will return the result. - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): - Promise; - parameters: - - id: url - description: The endpoint URL that fetch will be called on. - type: string - - id: configuration - description: >- - Determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations. - type: '' - - id: options - description: Additional options that affect the request. - type: '' - return: - type: 'Promise<>' - description: A promise that will return the result. +### YamlMime:TSType +name: AadHttpClient +uid: '@microsoft/sp-http!AadHttpClient:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClient +summary: AadHttpClient is used to perform REST calls against an Azure AD Application. +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. + For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(serviceScope, resourceEndpoint, options)' + uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(serviceScope, resourceEndpoint, options)' + summary: Constructs a new instance of the `AadHttpClient` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);' + parameters: + - id: serviceScope + description: The service scope is needed to retrieve some of the class's internal components. + type: '' + - id: resourceEndpoint + description: '' + type: string + - id: options + description: Configuration options for the request to get an access token. + type: '' +properties: + - name: configurations + uid: '@microsoft/sp-http!AadHttpClient.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly configurations: IAadHttpClientConfigurations;' + return: + type: '' +methods: + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: Performs a REST service call. + remarks: >- + Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for + HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: + https://fetch.spec.whatwg.org/ + isPreview: false + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): + Promise; + parameters: + - id: url + description: The endpoint URL that fetch will be called on. + type: string + - id: configuration + description: >- + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. + type: '' + - id: options + description: Additional options that affect the request. + type: '' + return: + type: 'Promise<>' + description: A promise that will return the result. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): + Promise; + parameters: + - id: url + description: The endpoint URL that fetch will be called on. + type: string + - id: configuration + description: >- + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. + type: '' + - id: options + description: Additional options that affect the request. + type: '' + return: + type: 'Promise<>' + description: A promise that will return the result. + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): + Promise; + parameters: + - id: url + description: The endpoint URL that fetch will be called on. + type: string + - id: configuration + description: >- + Determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations. + type: '' + - id: options + description: Additional options that affect the request. + type: '' + return: + type: 'Promise<>' + description: A promise that will return the result. diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 58fdcd15..265809d6 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -1,68 +1,68 @@ -### YamlMime:TSType -name: AadHttpClientConfiguration -uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClientConfiguration -summary: Configuration for HttpClient. -remarks: >- - The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the - predefined defaults from HttpClientConfigurations, however switches can also be changed via the - HttpClientConfiguration.overrideWith() method. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' - summary: >- - Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for - any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' - parameters: - - id: flags - description: '' - type: '' - - id: overrideFlags - description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' - package: '@microsoft/sp-http!' - fullName: flags - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected flags: IAadHttpClientConfiguration;' - return: - type: '' -methods: - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; - parameters: - - id: sourceFlags - description: '' - type: '' - return: - type: '' - description: '' -extends: '' +### YamlMime:TSType +name: AadHttpClientConfiguration +uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClientConfiguration +summary: Configuration for HttpClient. +remarks: >- + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for + any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' + parameters: + - id: flags + description: '' + type: '' + - id: overrideFlags + description: '' + type: '' +properties: + - name: flags + uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: IAadHttpClientConfiguration;' + return: + type: '' +methods: + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; + parameters: + - id: sourceFlags + description: '' + type: '' + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index b61f8c62..0e16d0fe 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -1,49 +1,49 @@ -### YamlMime:TSType -name: AadHttpClientFactory -uid: '@microsoft/sp-http!AadHttpClientFactory:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClientFactory -summary: >- - Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: - [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AadHttpClientFactory` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: serviceKey - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for AadHttpClientFactory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getClient(resourceEndpoint) - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' - package: '@microsoft/sp-http!' - fullName: getClient(resourceEndpoint) - summary: >- - Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service - Principal. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getClient(resourceEndpoint: string): Promise;' - parameters: - - id: resourceEndpoint - description: The target AAD application's resource endpoint. - type: string - return: - type: 'Promise<>' - description: '' +### YamlMime:TSType +name: AadHttpClientFactory +uid: '@microsoft/sp-http!AadHttpClientFactory:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClientFactory +summary: >- + Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AadHttpClientFactory` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: serviceKey + uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for AadHttpClientFactory. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: getClient(resourceEndpoint) + uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' + package: '@microsoft/sp-http!' + fullName: getClient(resourceEndpoint) + summary: >- + Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service + Principal. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getClient(resourceEndpoint: string): Promise;' + parameters: + - id: resourceEndpoint + description: The target AAD application's resource endpoint. + type: string + return: + type: 'Promise<>' + description: '' diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml index 4f925716..9d66560e 100644 --- a/SP-Framework/sp-http/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -1,31 +1,31 @@ -### YamlMime:TSType -name: AadHttpClientResponse -uid: '@microsoft/sp-http!AadHttpClientResponse:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClientResponse -summary: >- - The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends - HttpClientResponse adding additional functionality specific to the AadHttpClient. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(response, tokenFetchRequestTime)' - uid: '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(response, tokenFetchRequestTime)' - summary: Constructs a new instance of the `AadHttpClientResponse` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(response: Response, tokenFetchRequestTime: number);' - parameters: - - id: response - description: '' - type: Response - - id: tokenFetchRequestTime - description: '' - type: number -extends: '' +### YamlMime:TSType +name: AadHttpClientResponse +uid: '@microsoft/sp-http!AadHttpClientResponse:class' +package: '@microsoft/sp-http!' +fullName: AadHttpClientResponse +summary: >- + The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends + HttpClientResponse adding additional functionality specific to the AadHttpClient. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(response, tokenFetchRequestTime)' + uid: '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(response, tokenFetchRequestTime)' + summary: Constructs a new instance of the `AadHttpClientResponse` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(response: Response, tokenFetchRequestTime: number);' + parameters: + - id: response + description: '' + type: Response + - id: tokenFetchRequestTime + description: '' + type: number +extends: '' diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index cdf48e47..47694a84 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -1,75 +1,75 @@ -### YamlMime:TSType -name: AadTokenProvider -uid: '@microsoft/sp-http!AadTokenProvider:class' -package: '@microsoft/sp-http!' -fullName: AadTokenProvider -summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. - - - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. -remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AadTokenProvider` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'getToken(resourceEndpoint, useCachedToken)' - uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' - package: '@microsoft/sp-http!' - fullName: 'getToken(resourceEndpoint, useCachedToken)' - summary: |- - Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. - - The OAuth2 token should not be cached by the caller since it is already cached by the method itself. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' - parameters: - - id: resourceEndpoint - description: the resource for which the token should be obtained - type: string - - id: useCachedToken - description: >- - Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would - be https://graph.microsoft.com - type: boolean - return: - type: Promise<string> - description: A promise that will be fullfiled with the token or that will reject with an error message -events: - - name: onBeforeRedirectEvent - uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' - package: '@microsoft/sp-http!' - fullName: onBeforeRedirectEvent - summary: Notifies the developer before a full page redirect occurs. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly onBeforeRedirectEvent: SPEvent;' - return: - type: >- - <> - - name: tokenAcquisitionEvent - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' - package: '@microsoft/sp-http!' - fullName: tokenAcquisitionEvent - summary: Notifies the developer when Token Acquisition requires user action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get tokenAcquisitionEvent(): SPEvent;' - return: - type: >- - <> +### YamlMime:TSType +name: AadTokenProvider +uid: '@microsoft/sp-http!AadTokenProvider:class' +package: '@microsoft/sp-http!' +fullName: AadTokenProvider +summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. + + + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. +remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AadTokenProvider` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'getToken(resourceEndpoint, useCachedToken)' + uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' + package: '@microsoft/sp-http!' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + + The OAuth2 token should not be cached by the caller since it is already cached by the method itself. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' + parameters: + - id: resourceEndpoint + description: the resource for which the token should be obtained + type: string + - id: useCachedToken + description: >- + Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would + be https://graph.microsoft.com + type: boolean + return: + type: Promise<string> + description: A promise that will be fullfiled with the token or that will reject with an error message +events: + - name: onBeforeRedirectEvent + uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' + package: '@microsoft/sp-http!' + fullName: onBeforeRedirectEvent + summary: Notifies the developer before a full page redirect occurs. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + type: >- + <> + - name: tokenAcquisitionEvent + uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' + package: '@microsoft/sp-http!' + fullName: tokenAcquisitionEvent + summary: Notifies the developer when Token Acquisition requires user action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get tokenAcquisitionEvent(): SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 27c7c3be..7f686f5b 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -1,41 +1,41 @@ -### YamlMime:TSType -name: AadTokenProviderFactory -uid: '@microsoft/sp-http!AadTokenProviderFactory:class' -package: '@microsoft/sp-http!' -fullName: AadTokenProviderFactory -summary: Returns a preinitialized version of the AadTokenProviderFactory. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: serviceKey - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for AadTokenProviderFactory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getTokenProvider() - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' - package: '@microsoft/sp-http!' - fullName: getTokenProvider() - summary: >- - Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service - Principal. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getTokenProvider(): Promise;' - return: - type: 'Promise<>' - description: '' +### YamlMime:TSType +name: AadTokenProviderFactory +uid: '@microsoft/sp-http!AadTokenProviderFactory:class' +package: '@microsoft/sp-http!' +fullName: AadTokenProviderFactory +summary: Returns a preinitialized version of the AadTokenProviderFactory. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: serviceKey + uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for AadTokenProviderFactory. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: getTokenProvider() + uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' + package: '@microsoft/sp-http!' + fullName: getTokenProvider() + summary: >- + Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service + Principal. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getTokenProvider(): Promise;' + return: + type: 'Promise<>' + description: '' diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml index 9beb6acb..553dda5c 100644 --- a/SP-Framework/sp-http/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -1,54 +1,54 @@ -### YamlMime:TSType -name: BeforeRedirectEventArgs -uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' -package: '@microsoft/sp-http!' -fullName: BeforeRedirectEventArgs -summary: Arguments for before redirecting for a full page authentication -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(redirectUrl, cancel)' - uid: '@microsoft/sp-http!BeforeRedirectEventArgs:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(redirectUrl, cancel)' - summary: Constructs a new instance of the `BeforeRedirectEventArgs` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(redirectUrl: string, cancel: () => void);' - parameters: - - id: redirectUrl - description: '' - type: string - - id: cancel - description: '' - type: () => void -properties: - - name: cancel - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#cancel:member' - package: '@microsoft/sp-http!' - fullName: cancel - summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'cancel: () => void;' - return: - type: () => void - - name: redirectUrl - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl - summary: The url of the page to redirect to if automatic redirect is cancelled - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectUrl: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: BeforeRedirectEventArgs +uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' +package: '@microsoft/sp-http!' +fullName: BeforeRedirectEventArgs +summary: Arguments for before redirecting for a full page authentication +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(redirectUrl, cancel)' + uid: '@microsoft/sp-http!BeforeRedirectEventArgs:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(redirectUrl, cancel)' + summary: Constructs a new instance of the `BeforeRedirectEventArgs` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(redirectUrl: string, cancel: () => void);' + parameters: + - id: redirectUrl + description: '' + type: string + - id: cancel + description: '' + type: () => void +properties: + - name: cancel + uid: '@microsoft/sp-http!BeforeRedirectEventArgs#cancel:member' + package: '@microsoft/sp-http!' + fullName: cancel + summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'cancel: () => void;' + return: + type: () => void + - name: redirectUrl + uid: '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' + fullName: redirectUrl + summary: The url of the page to redirect to if automatic redirect is cancelled + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index ecba9db7..9dba83ba 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -1,132 +1,132 @@ -### YamlMime:TSType -name: DigestCache -uid: '@microsoft/sp-http!DigestCache:class' -package: '@microsoft/sp-http!' -fullName: DigestCache -summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A - request digest is a security token that the SharePoint server requires for for any REST write operation, specified via - the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after - a server configurable amount of time. - - - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-http!DigestCache:constructor(1)' - package: '@microsoft/sp-http!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `DigestCache` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-http!DigestCache.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for IDigestCache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' - package: '@microsoft/sp-http!' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - summary: >- - Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will - automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios - addDigestToCache() can be used to avoid the overhead of the REST call. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' - parameters: - - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string - - id: digestValue - description: >- - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look - something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" - type: string - - id: expirationTimestamp - description: >- - A future point in time, as measured by performance.now(), after which the digest value will no longer be - valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for - example, to specify an expiration "5 seconds from right now", use performance.now()+5000. - type: number - return: - type: void - description: '' - - name: clearAllDigests() - uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' - package: '@microsoft/sp-http!' - fullName: clearAllDigests() - summary: Clears all values from the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clearAllDigests(): void;' - return: - type: void - description: '' - - name: clearDigest(webUrl) - uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: clearDigest(webUrl) - summary: >- - Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a - digest was invalidated prior to its expiration time. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clearDigest(webUrl: string): boolean;' - parameters: - - id: webUrl - description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. - type: string - return: - type: boolean - description: Returns true if a cache entry was found and deleted; false otherwise. - - name: fetchDigest(webUrl) - uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: fetchDigest(webUrl) - summary: >- - Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is - fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the - digest, which will be added to the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'fetchDigest(webUrl: string): Promise;' - parameters: - - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string - return: - type: Promise<string> - description: A promise that is fulfilled with the digest value. +### YamlMime:TSType +name: DigestCache +uid: '@microsoft/sp-http!DigestCache:class' +package: '@microsoft/sp-http!' +fullName: DigestCache +summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A + request digest is a security token that the SharePoint server requires for for any REST write operation, specified via + the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after + a server configurable amount of time. + + + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-http!DigestCache:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `DigestCache` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: serviceKey + uid: '@microsoft/sp-http!DigestCache.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for IDigestCache. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' + package: '@microsoft/sp-http!' + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + summary: >- + Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will + automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios + addDigestToCache() can be used to avoid the overhead of the REST call. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: string + - id: digestValue + description: >- + The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look + something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + type: string + - id: expirationTimestamp + description: >- + A future point in time, as measured by performance.now(), after which the digest value will no longer be + valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for + example, to specify an expiration "5 seconds from right now", use performance.now()+5000. + type: number + return: + type: void + description: '' + - name: clearAllDigests() + uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' + package: '@microsoft/sp-http!' + fullName: clearAllDigests() + summary: Clears all values from the cache. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearAllDigests(): void;' + return: + type: void + description: '' + - name: clearDigest(webUrl) + uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' + package: '@microsoft/sp-http!' + fullName: clearDigest(webUrl) + summary: >- + Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a + digest was invalidated prior to its expiration time. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearDigest(webUrl: string): boolean;' + parameters: + - id: webUrl + description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. + type: string + return: + type: boolean + description: Returns true if a cache entry was found and deleted; false otherwise. + - name: fetchDigest(webUrl) + uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' + package: '@microsoft/sp-http!' + fullName: fetchDigest(webUrl) + summary: >- + Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is + fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the + digest, which will be added to the cache. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'fetchDigest(webUrl: string): Promise;' + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: string + return: + type: Promise<string> + description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 3186c248..ee00b267 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -1,542 +1,542 @@ -### YamlMime:TSType -name: GraphRequest -uid: '@microsoft/sp-http!GraphRequest:interface' -package: '@microsoft/sp-http!' -fullName: GraphRequest -summary: >- - Typings for the GraphRequest Object For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: _headers - uid: '@microsoft/sp-http!GraphRequest#_headers:member' - package: '@microsoft/sp-http!' - fullName: _headers - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - _headers: { - [key: string]: string | number; - }; - return: - type: |- - { - [key: string]: string | number; - } - - name: _responseType - uid: '@microsoft/sp-http!GraphRequest#_responseType:member' - package: '@microsoft/sp-http!' - fullName: _responseType - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: '_responseType: string;' - return: - type: string - - name: config - uid: '@microsoft/sp-http!GraphRequest#config:member' - package: '@microsoft/sp-http!' - fullName: config - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'config: Options;' - return: - type: '' - - name: urlComponents - uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' - package: '@microsoft/sp-http!' - fullName: urlComponents - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'urlComponents: URLComponents;' - return: - type: '' -methods: - - name: buildFullUrl() - uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' - package: '@microsoft/sp-http!' - fullName: buildFullUrl() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'buildFullUrl(): string;' - return: - type: string - description: '' - - name: 'constructor(config, path)' - uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' - package: '@microsoft/sp-http!' - fullName: 'constructor(config, path)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(config: Options, path: string): IGraphRequest;' - parameters: - - id: config - description: '' - type: '' - - id: path - description: '' - type: string - return: - type: '' - description: '' - - name: count(count) - uid: '@microsoft/sp-http!GraphRequest#count:member(1)' - package: '@microsoft/sp-http!' - fullName: count(count) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'count(count: boolean): IGraphRequest;' - parameters: - - id: count - description: '' - type: boolean - return: - type: '' - description: '' - - name: 'create(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#create:member(1)' - package: '@microsoft/sp-http!' - fullName: 'create(content, callback)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'create(content: any, callback?: GraphRequestCallback): Promise;' - parameters: - - id: content - description: '' - type: any - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: del(callback) - uid: '@microsoft/sp-http!GraphRequest#del:member(1)' - package: '@microsoft/sp-http!' - fullName: del(callback) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'del(callback?: GraphRequestCallback): Promise;' - parameters: - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: delete(callback) - uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' - package: '@microsoft/sp-http!' - fullName: delete(callback) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'delete(callback?: GraphRequestCallback): Promise;' - parameters: - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: expand(properties) - uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' - package: '@microsoft/sp-http!' - fullName: expand(properties) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'expand(properties: string | string[]): IGraphRequest;' - parameters: - - id: properties - description: '' - type: 'string | string[]' - return: - type: '' - description: '' - - name: filter(filterStr) - uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' - package: '@microsoft/sp-http!' - fullName: filter(filterStr) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'filter(filterStr: string): IGraphRequest;' - parameters: - - id: filterStr - description: '' - type: string - return: - type: '' - description: '' - - name: get(callback) - uid: '@microsoft/sp-http!GraphRequest#get:member(1)' - package: '@microsoft/sp-http!' - fullName: get(callback) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get(callback?: GraphRequestCallback): Promise;' - parameters: - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: getStream(callback) - uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' - package: '@microsoft/sp-http!' - fullName: getStream(callback) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getStream(callback: GraphRequestCallback): void;' - parameters: - - id: callback - description: '' - type: '' - return: - type: void - description: '' - - name: 'header(headerKey, headerValue)' - uid: '@microsoft/sp-http!GraphRequest#header:member(1)' - package: '@microsoft/sp-http!' - fullName: 'header(headerKey, headerValue)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'header(headerKey: string, headerValue: string): this;' - parameters: - - id: headerKey - description: '' - type: string - - id: headerValue - description: '' - type: string - return: - type: this - description: '' - - name: headers(headers) - uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' - package: '@microsoft/sp-http!' - fullName: headers(headers) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - headers(headers: { - [key: string]: string | number; - }): this; - parameters: - - id: headers - description: '' - type: |- - { - [key: string]: string | number; - } - return: - type: this - description: '' - - name: orderby(properties) - uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' - package: '@microsoft/sp-http!' - fullName: orderby(properties) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'orderby(properties: string | string[]): IGraphRequest;' - parameters: - - id: properties - description: '' - type: 'string | string[]' - return: - type: '' - description: '' - - name: parsePath(rawPath) - uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' - package: '@microsoft/sp-http!' - fullName: parsePath(rawPath) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'parsePath(rawPath: string): void;' - parameters: - - id: rawPath - description: '' - type: string - return: - type: void - description: '' - - name: 'patch(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'patch(content, callback)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'patch(content: any, callback?: GraphRequestCallback): Promise;' - parameters: - - id: content - description: '' - type: any - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: 'post(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(content, callback)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'post(content: any, callback?: GraphRequestCallback): Promise;' - parameters: - - id: content - description: '' - type: any - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: 'put(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#put:member(1)' - package: '@microsoft/sp-http!' - fullName: 'put(content, callback)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'put(content: any, callback?: GraphRequestCallback): Promise;' - parameters: - - id: content - description: '' - type: any - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: 'putStream(stream, callback)' - uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' - package: '@microsoft/sp-http!' - fullName: 'putStream(stream, callback)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'putStream(stream: any, callback: GraphRequestCallback): void;' - parameters: - - id: stream - description: '' - type: any - - id: callback - description: '' - type: '' - return: - type: void - description: '' - - name: query(queryDictionaryOrString) - uid: '@microsoft/sp-http!GraphRequest#query:member(1)' - package: '@microsoft/sp-http!' - fullName: query(queryDictionaryOrString) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - query(queryDictionaryOrString: string | { - [key: string]: string | number; - }): IGraphRequest; - parameters: - - id: queryDictionaryOrString - description: '' - type: |- - string | { - [key: string]: string | number; - } - return: - type: '' - description: '' - - name: responseType(responseType) - uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' - package: '@microsoft/sp-http!' - fullName: responseType(responseType) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'responseType(responseType: string): IGraphRequest;' - parameters: - - id: responseType - description: '' - type: string - return: - type: '' - description: '' - - name: select(properties) - uid: '@microsoft/sp-http!GraphRequest#select:member(1)' - package: '@microsoft/sp-http!' - fullName: select(properties) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'select(properties: string | string[]): IGraphRequest;' - parameters: - - id: properties - description: '' - type: 'string | string[]' - return: - type: '' - description: '' - - name: skip(n) - uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' - package: '@microsoft/sp-http!' - fullName: skip(n) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'skip(n: number): IGraphRequest;' - parameters: - - id: 'n' - description: '' - type: number - return: - type: '' - description: '' - - name: skipToken(token) - uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' - package: '@microsoft/sp-http!' - fullName: skipToken(token) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'skipToken(token: string): IGraphRequest;' - parameters: - - id: token - description: '' - type: string - return: - type: '' - description: '' - - name: top(n) - uid: '@microsoft/sp-http!GraphRequest#top:member(1)' - package: '@microsoft/sp-http!' - fullName: top(n) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'top(n: number): IGraphRequest;' - parameters: - - id: 'n' - description: '' - type: number - return: - type: '' - description: '' - - name: 'update(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#update:member(1)' - package: '@microsoft/sp-http!' - fullName: 'update(content, callback)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'update(content: any, callback?: GraphRequestCallback): Promise;' - parameters: - - id: content - description: '' - type: any - - id: callback - description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: version(v) - uid: '@microsoft/sp-http!GraphRequest#version:member(1)' - package: '@microsoft/sp-http!' - fullName: version(v) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'version(v: string): IGraphRequest;' - parameters: - - id: v - description: '' - type: string - return: - type: '' - description: '' +### YamlMime:TSType +name: GraphRequest +uid: '@microsoft/sp-http!GraphRequest:interface' +package: '@microsoft/sp-http!' +fullName: GraphRequest +summary: >- + Typings for the GraphRequest Object For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: _headers + uid: '@microsoft/sp-http!GraphRequest#_headers:member' + package: '@microsoft/sp-http!' + fullName: _headers + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + _headers: { + [key: string]: string | number; + }; + return: + type: |- + { + [key: string]: string | number; + } + - name: _responseType + uid: '@microsoft/sp-http!GraphRequest#_responseType:member' + package: '@microsoft/sp-http!' + fullName: _responseType + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: '_responseType: string;' + return: + type: string + - name: config + uid: '@microsoft/sp-http!GraphRequest#config:member' + package: '@microsoft/sp-http!' + fullName: config + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'config: Options;' + return: + type: '' + - name: urlComponents + uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' + package: '@microsoft/sp-http!' + fullName: urlComponents + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'urlComponents: URLComponents;' + return: + type: '' +methods: + - name: buildFullUrl() + uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' + package: '@microsoft/sp-http!' + fullName: buildFullUrl() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buildFullUrl(): string;' + return: + type: string + description: '' + - name: 'constructor(config, path)' + uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' + package: '@microsoft/sp-http!' + fullName: 'constructor(config, path)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(config: Options, path: string): IGraphRequest;' + parameters: + - id: config + description: '' + type: '' + - id: path + description: '' + type: string + return: + type: '' + description: '' + - name: count(count) + uid: '@microsoft/sp-http!GraphRequest#count:member(1)' + package: '@microsoft/sp-http!' + fullName: count(count) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'count(count: boolean): IGraphRequest;' + parameters: + - id: count + description: '' + type: boolean + return: + type: '' + description: '' + - name: 'create(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#create:member(1)' + package: '@microsoft/sp-http!' + fullName: 'create(content, callback)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'create(content: any, callback?: GraphRequestCallback): Promise;' + parameters: + - id: content + description: '' + type: any + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: del(callback) + uid: '@microsoft/sp-http!GraphRequest#del:member(1)' + package: '@microsoft/sp-http!' + fullName: del(callback) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'del(callback?: GraphRequestCallback): Promise;' + parameters: + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: delete(callback) + uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' + package: '@microsoft/sp-http!' + fullName: delete(callback) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'delete(callback?: GraphRequestCallback): Promise;' + parameters: + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: expand(properties) + uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' + package: '@microsoft/sp-http!' + fullName: expand(properties) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'expand(properties: string | string[]): IGraphRequest;' + parameters: + - id: properties + description: '' + type: 'string | string[]' + return: + type: '' + description: '' + - name: filter(filterStr) + uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' + package: '@microsoft/sp-http!' + fullName: filter(filterStr) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'filter(filterStr: string): IGraphRequest;' + parameters: + - id: filterStr + description: '' + type: string + return: + type: '' + description: '' + - name: get(callback) + uid: '@microsoft/sp-http!GraphRequest#get:member(1)' + package: '@microsoft/sp-http!' + fullName: get(callback) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get(callback?: GraphRequestCallback): Promise;' + parameters: + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: getStream(callback) + uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' + package: '@microsoft/sp-http!' + fullName: getStream(callback) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getStream(callback: GraphRequestCallback): void;' + parameters: + - id: callback + description: '' + type: '' + return: + type: void + description: '' + - name: 'header(headerKey, headerValue)' + uid: '@microsoft/sp-http!GraphRequest#header:member(1)' + package: '@microsoft/sp-http!' + fullName: 'header(headerKey, headerValue)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'header(headerKey: string, headerValue: string): this;' + parameters: + - id: headerKey + description: '' + type: string + - id: headerValue + description: '' + type: string + return: + type: this + description: '' + - name: headers(headers) + uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' + package: '@microsoft/sp-http!' + fullName: headers(headers) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + headers(headers: { + [key: string]: string | number; + }): this; + parameters: + - id: headers + description: '' + type: |- + { + [key: string]: string | number; + } + return: + type: this + description: '' + - name: orderby(properties) + uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' + package: '@microsoft/sp-http!' + fullName: orderby(properties) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'orderby(properties: string | string[]): IGraphRequest;' + parameters: + - id: properties + description: '' + type: 'string | string[]' + return: + type: '' + description: '' + - name: parsePath(rawPath) + uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' + package: '@microsoft/sp-http!' + fullName: parsePath(rawPath) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'parsePath(rawPath: string): void;' + parameters: + - id: rawPath + description: '' + type: string + return: + type: void + description: '' + - name: 'patch(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'patch(content, callback)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'patch(content: any, callback?: GraphRequestCallback): Promise;' + parameters: + - id: content + description: '' + type: any + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: 'post(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(content, callback)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'post(content: any, callback?: GraphRequestCallback): Promise;' + parameters: + - id: content + description: '' + type: any + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: 'put(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#put:member(1)' + package: '@microsoft/sp-http!' + fullName: 'put(content, callback)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'put(content: any, callback?: GraphRequestCallback): Promise;' + parameters: + - id: content + description: '' + type: any + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: 'putStream(stream, callback)' + uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' + package: '@microsoft/sp-http!' + fullName: 'putStream(stream, callback)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'putStream(stream: any, callback: GraphRequestCallback): void;' + parameters: + - id: stream + description: '' + type: any + - id: callback + description: '' + type: '' + return: + type: void + description: '' + - name: query(queryDictionaryOrString) + uid: '@microsoft/sp-http!GraphRequest#query:member(1)' + package: '@microsoft/sp-http!' + fullName: query(queryDictionaryOrString) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + query(queryDictionaryOrString: string | { + [key: string]: string | number; + }): IGraphRequest; + parameters: + - id: queryDictionaryOrString + description: '' + type: |- + string | { + [key: string]: string | number; + } + return: + type: '' + description: '' + - name: responseType(responseType) + uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' + package: '@microsoft/sp-http!' + fullName: responseType(responseType) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'responseType(responseType: string): IGraphRequest;' + parameters: + - id: responseType + description: '' + type: string + return: + type: '' + description: '' + - name: select(properties) + uid: '@microsoft/sp-http!GraphRequest#select:member(1)' + package: '@microsoft/sp-http!' + fullName: select(properties) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'select(properties: string | string[]): IGraphRequest;' + parameters: + - id: properties + description: '' + type: 'string | string[]' + return: + type: '' + description: '' + - name: skip(n) + uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' + package: '@microsoft/sp-http!' + fullName: skip(n) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'skip(n: number): IGraphRequest;' + parameters: + - id: 'n' + description: '' + type: number + return: + type: '' + description: '' + - name: skipToken(token) + uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' + package: '@microsoft/sp-http!' + fullName: skipToken(token) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'skipToken(token: string): IGraphRequest;' + parameters: + - id: token + description: '' + type: string + return: + type: '' + description: '' + - name: top(n) + uid: '@microsoft/sp-http!GraphRequest#top:member(1)' + package: '@microsoft/sp-http!' + fullName: top(n) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'top(n: number): IGraphRequest;' + parameters: + - id: 'n' + description: '' + type: number + return: + type: '' + description: '' + - name: 'update(content, callback)' + uid: '@microsoft/sp-http!GraphRequest#update:member(1)' + package: '@microsoft/sp-http!' + fullName: 'update(content, callback)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'update(content: any, callback?: GraphRequestCallback): Promise;' + parameters: + - id: content + description: '' + type: any + - id: callback + description: '' + type: '' + return: + type: Promise<any> + description: '' + - name: version(v) + uid: '@microsoft/sp-http!GraphRequest#version:member(1)' + package: '@microsoft/sp-http!' + fullName: version(v) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'version(v: string): IGraphRequest;' + parameters: + - id: v + description: '' + type: string + return: + type: '' + description: '' diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 2ee450e5..5e79f83c 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -1,149 +1,149 @@ -### YamlMime:TSType -name: HttpClient -uid: '@microsoft/sp-http!HttpClient:class' -package: '@microsoft/sp-http!' -fullName: HttpClient -summary: HttpClient implements a basic set of features for performing REST operations against a generic service. -remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-http!HttpClient:constructor(1)' - package: '@microsoft/sp-http!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `HttpClient` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: configurations - uid: '@microsoft/sp-http!HttpClient.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations - summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly configurations: IHttpClientConfigurations;' - return: - type: '' - - name: serviceKey - uid: '@microsoft/sp-http!HttpClient.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for HttpClient. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' - summary: Performs a REST service call. - remarks: >- - Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for - HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: - https://fetch.spec.whatwg.org/ - isPreview: false - isDeprecated: false - syntax: - content: >- - fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!HttpClient#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!HttpClient#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of HttpClient; normally this should be the latest version number from - HttpClientConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. +### YamlMime:TSType +name: HttpClient +uid: '@microsoft/sp-http!HttpClient:class' +package: '@microsoft/sp-http!' +fullName: HttpClient +summary: HttpClient implements a basic set of features for performing REST operations against a generic service. +remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-http!HttpClient:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `HttpClient` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: configurations + uid: '@microsoft/sp-http!HttpClient.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly configurations: IHttpClientConfigurations;' + return: + type: '' + - name: serviceKey + uid: '@microsoft/sp-http!HttpClient.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for HttpClient. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: Performs a REST service call. + remarks: >- + Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for + HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: + https://fetch.spec.whatwg.org/ + isPreview: false + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!HttpClient#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!HttpClient#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of HttpClient; normally this should be the latest version number from + HttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index 68207a10..a87538c6 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -1,82 +1,82 @@ -### YamlMime:TSType -name: HttpClientConfiguration -uid: '@microsoft/sp-http!HttpClientConfiguration:class' -package: '@microsoft/sp-http!' -fullName: HttpClientConfiguration -summary: Configuration for HttpClient. -remarks: >- - The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the - predefined defaults from HttpClientConfigurations, however switches can also be changed via the - HttpClientConfiguration.overrideWith() method. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' - summary: >- - Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for - any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);' - parameters: - - id: flags - description: '' - type: '' - - id: overrideFlags - description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' - package: '@microsoft/sp-http!' - fullName: flags - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected flags: IHttpClientConfiguration;' - return: - type: '' -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() - summary: Child classes should override this method to initialize the flags object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected initializeFlags(): void; - return: - type: void - description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) - summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; - parameters: - - id: sourceFlags - description: '' - type: '' - return: - type: '' - description: '' +### YamlMime:TSType +name: HttpClientConfiguration +uid: '@microsoft/sp-http!HttpClientConfiguration:class' +package: '@microsoft/sp-http!' +fullName: HttpClientConfiguration +summary: Configuration for HttpClient. +remarks: >- + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for + any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);' + parameters: + - id: flags + description: '' + type: '' + - id: overrideFlags + description: '' + type: '' +properties: + - name: flags + uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: IHttpClientConfiguration;' + return: + type: '' +methods: + - name: initializeFlags() + uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: Child classes should override this method to initialize the flags object. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; + parameters: + - id: sourceFlags + description: '' + type: '' + return: + type: '' + description: '' diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 95613159..63328c60 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -1,193 +1,193 @@ -### YamlMime:TSType -name: HttpClientResponse -uid: '@microsoft/sp-http!HttpClientResponse:class' -package: '@microsoft/sp-http!' -fullName: HttpClientResponse -summary: The Response subclass returned by methods such as HttpClient.fetch(). -remarks: >- - This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `HttpClientResponse` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: bodyUsed - uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' - package: '@microsoft/sp-http!' - fullName: bodyUsed - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get bodyUsed(): boolean;' - return: - type: boolean - - name: headers - uid: '@microsoft/sp-http!HttpClientResponse#headers:member' - package: '@microsoft/sp-http!' - fullName: headers - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get headers(): Headers;' - return: - type: Headers - - name: nativeResponse - uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' - package: '@microsoft/sp-http!' - fullName: nativeResponse - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected nativeResponse: Response;' - return: - type: Response - - name: ok - uid: '@microsoft/sp-http!HttpClientResponse#ok:member' - package: '@microsoft/sp-http!' - fullName: ok - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get ok(): boolean;' - return: - type: boolean - - name: status - uid: '@microsoft/sp-http!HttpClientResponse#status:member' - package: '@microsoft/sp-http!' - fullName: status - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get status(): number;' - return: - type: number - - name: statusText - uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' - package: '@microsoft/sp-http!' - fullName: statusText - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get statusText(): string;' - return: - type: string - - name: type - uid: '@microsoft/sp-http!HttpClientResponse#type:member' - package: '@microsoft/sp-http!' - fullName: type - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get type(): ResponseType;' - return: - type: ResponseType - - name: url - uid: '@microsoft/sp-http!HttpClientResponse#url:member' - package: '@microsoft/sp-http!' - fullName: url - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get url(): string;' - return: - type: string -methods: - - name: arrayBuffer() - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' - package: '@microsoft/sp-http!' - fullName: arrayBuffer() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'arrayBuffer(): Promise;' - return: - type: Promise<ArrayBuffer> - description: '' - - name: blob() - uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' - package: '@microsoft/sp-http!' - fullName: blob() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'blob(): Promise;' - return: - type: Promise<Blob> - description: '' - - name: clone() - uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' - package: '@microsoft/sp-http!' - fullName: clone() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - clone(): HttpClientResponse; - return: - type: '' - description: '' - - name: formData() - uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' - package: '@microsoft/sp-http!' - fullName: formData() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'formData(): Promise;' - return: - type: Promise<FormData> - description: '' - - name: json() - uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' - package: '@microsoft/sp-http!' - fullName: json() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'json(): Promise;' - return: - type: Promise<any> - description: '' - - name: text() - uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' - package: '@microsoft/sp-http!' - fullName: text() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text(): Promise;' - return: - type: Promise<string> - description: '' +### YamlMime:TSType +name: HttpClientResponse +uid: '@microsoft/sp-http!HttpClientResponse:class' +package: '@microsoft/sp-http!' +fullName: HttpClientResponse +summary: The Response subclass returned by methods such as HttpClient.fetch(). +remarks: >- + This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `HttpClientResponse` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: bodyUsed + uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' + package: '@microsoft/sp-http!' + fullName: bodyUsed + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get bodyUsed(): boolean;' + return: + type: boolean + - name: headers + uid: '@microsoft/sp-http!HttpClientResponse#headers:member' + package: '@microsoft/sp-http!' + fullName: headers + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get headers(): Headers;' + return: + type: Headers + - name: nativeResponse + uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' + package: '@microsoft/sp-http!' + fullName: nativeResponse + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected nativeResponse: Response;' + return: + type: Response + - name: ok + uid: '@microsoft/sp-http!HttpClientResponse#ok:member' + package: '@microsoft/sp-http!' + fullName: ok + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get ok(): boolean;' + return: + type: boolean + - name: status + uid: '@microsoft/sp-http!HttpClientResponse#status:member' + package: '@microsoft/sp-http!' + fullName: status + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get status(): number;' + return: + type: number + - name: statusText + uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' + package: '@microsoft/sp-http!' + fullName: statusText + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get statusText(): string;' + return: + type: string + - name: type + uid: '@microsoft/sp-http!HttpClientResponse#type:member' + package: '@microsoft/sp-http!' + fullName: type + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get type(): ResponseType;' + return: + type: ResponseType + - name: url + uid: '@microsoft/sp-http!HttpClientResponse#url:member' + package: '@microsoft/sp-http!' + fullName: url + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get url(): string;' + return: + type: string +methods: + - name: arrayBuffer() + uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' + package: '@microsoft/sp-http!' + fullName: arrayBuffer() + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'arrayBuffer(): Promise;' + return: + type: Promise<ArrayBuffer> + description: '' + - name: blob() + uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' + package: '@microsoft/sp-http!' + fullName: blob() + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blob(): Promise;' + return: + type: Promise<Blob> + description: '' + - name: clone() + uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' + package: '@microsoft/sp-http!' + fullName: clone() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + clone(): HttpClientResponse; + return: + type: '' + description: '' + - name: formData() + uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' + package: '@microsoft/sp-http!' + fullName: formData() + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'formData(): Promise;' + return: + type: Promise<FormData> + description: '' + - name: json() + uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' + package: '@microsoft/sp-http!' + fullName: json() + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'json(): Promise;' + return: + type: Promise<any> + description: '' + - name: text() + uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' + package: '@microsoft/sp-http!' + fullName: text() + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text(): Promise;' + return: + type: Promise<string> + description: '' diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index bf7709f7..80cd286d 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IAadHttpClientConfiguration -uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: IAadHttpClientConfiguration -summary: Flags interface for HttpClientConfiguration. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: IAadHttpClientConfiguration +uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: IAadHttpClientConfiguration +summary: Flags interface for HttpClientConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index d7240840..46468a04 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -1,29 +1,29 @@ -### YamlMime:TSType -name: IAadHttpClientConfigurations -uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: IAadHttpClientConfigurations -summary: Standard configurations for AadHttpClient. -remarks: >- - This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. - In general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -isPreview: false -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' - package: '@microsoft/sp-http!' - fullName: v1 - summary: >- - This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially - identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly v1: AadHttpClientConfiguration;' - return: - type: '' +### YamlMime:TSType +name: IAadHttpClientConfigurations +uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: IAadHttpClientConfigurations +summary: Standard configurations for AadHttpClient. +remarks: >- + This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. + In general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +isPreview: false +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: >- + This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially + identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly v1: AadHttpClientConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index 031fa096..49f33114 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -1,49 +1,49 @@ -### YamlMime:TSType -name: IAadHttpClientOptions -uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' -package: '@microsoft/sp-http!' -fullName: IAadHttpClientOptions -summary: Interface for overriding the default behavior of AadHttpClient. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: configuration - uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' - package: '@microsoft/sp-http!' - fullName: configuration - summary: '' - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' - syntax: - content: 'configuration?: IAadTokenProviderConfiguration;' - return: - type: '' - - name: tokenProvider - uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' - package: '@microsoft/sp-http!' - fullName: tokenProvider - summary: '' - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' - syntax: - content: 'tokenProvider?: IAadTokenProvider;' - return: - type: '' - - name: useCachedToken - uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' - package: '@microsoft/sp-http!' - fullName: useCachedToken - summary: Allows the developer to specify if cached tokens should be use for the current request. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'useCachedToken?: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IAadHttpClientOptions +uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' +package: '@microsoft/sp-http!' +fullName: IAadHttpClientOptions +summary: Interface for overriding the default behavior of AadHttpClient. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: configuration + uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' + package: '@microsoft/sp-http!' + fullName: configuration + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' + syntax: + content: 'configuration?: IAadTokenProviderConfiguration;' + return: + type: '' + - name: tokenProvider + uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' + package: '@microsoft/sp-http!' + fullName: tokenProvider + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' + syntax: + content: 'tokenProvider?: IAadTokenProvider;' + return: + type: '' + - name: useCachedToken + uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' + package: '@microsoft/sp-http!' + fullName: useCachedToken + summary: Allows the developer to specify if cached tokens should be use for the current request. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'useCachedToken?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 4da118d9..22c5162a 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -1,73 +1,73 @@ -### YamlMime:TSType -name: IAadTokenProvider -uid: '@microsoft/sp-http!IAadTokenProvider:interface' -package: '@microsoft/sp-http!' -fullName: IAadTokenProvider -summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. - - - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. -remarks: >- - AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some - point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to - MSAL. -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'getToken(resourceEndpoint, useCachedToken)' - uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' - package: '@microsoft/sp-http!' - fullName: 'getToken(resourceEndpoint, useCachedToken)' - summary: |- - Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. - - The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. - - An example of a resourceEndpoint would be https://sdfpilot.outlook.com - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' - parameters: - - id: resourceEndpoint - description: the resource for which the token should be obtained - type: string - - id: useCachedToken - description: Allows the developer to specify if cached tokens should be returned. - type: boolean - return: - type: Promise<string> - description: A promise that will be fullfiled with the token or that will reject with an error message -events: - - name: onBeforeRedirectEvent - uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' - package: '@microsoft/sp-http!' - fullName: onBeforeRedirectEvent - summary: Notifies the developer before a full page redirect occurs. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly onBeforeRedirectEvent: SPEvent;' - return: - type: >- - <> - - name: tokenAcquisitionEvent - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' - package: '@microsoft/sp-http!' - fullName: tokenAcquisitionEvent - summary: Notifies the developer when Token Acquistion requires user action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly tokenAcquisitionEvent: SPEvent;' - return: - type: >- - <> +### YamlMime:TSType +name: IAadTokenProvider +uid: '@microsoft/sp-http!IAadTokenProvider:interface' +package: '@microsoft/sp-http!' +fullName: IAadTokenProvider +summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. + + + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. +remarks: >- + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some + point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to + MSAL. +isPreview: false +isDeprecated: false +type: interface +methods: + - name: 'getToken(resourceEndpoint, useCachedToken)' + uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' + package: '@microsoft/sp-http!' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + summary: |- + Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. + + The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. + + An example of a resourceEndpoint would be https://sdfpilot.outlook.com + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' + parameters: + - id: resourceEndpoint + description: the resource for which the token should be obtained + type: string + - id: useCachedToken + description: Allows the developer to specify if cached tokens should be returned. + type: boolean + return: + type: Promise<string> + description: A promise that will be fullfiled with the token or that will reject with an error message +events: + - name: onBeforeRedirectEvent + uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' + package: '@microsoft/sp-http!' + fullName: onBeforeRedirectEvent + summary: Notifies the developer before a full page redirect occurs. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + type: >- + <> + - name: tokenAcquisitionEvent + uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' + package: '@microsoft/sp-http!' + fullName: tokenAcquisitionEvent + summary: Notifies the developer when Token Acquistion requires user action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tokenAcquisitionEvent: SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index a563468c..d82f4c30 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -1,117 +1,117 @@ -### YamlMime:TSType -name: IAadTokenProviderConfiguration -uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: IAadTokenProviderConfiguration -summary: Required strings for constructing an AadTokenProvider. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: aadInstanceUrl - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' - package: '@microsoft/sp-http!' - fullName: aadInstanceUrl - summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'aadInstanceUrl: string;' - return: - type: string - - name: aadSessionId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' - package: '@microsoft/sp-http!' - fullName: aadSessionId - summary: The current Azure Active Directory's session id. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'aadSessionId: string;' - return: - type: string - - name: aadTenantId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' - package: '@microsoft/sp-http!' - fullName: aadTenantId - summary: The Azure Active Directory's tenant id. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'aadTenantId: string;' - return: - type: string - - name: aadUserId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' - package: '@microsoft/sp-http!' - fullName: aadUserId - summary: >- - The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current - user. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'aadUserId?: string;' - return: - type: string - - name: redirectUri - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' - package: '@microsoft/sp-http!' - fullName: redirectUri - summary: >- - The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's - application redirect uris. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectUri: string;' - return: - type: string - - name: servicePrincipalId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' - package: '@microsoft/sp-http!' - fullName: servicePrincipalId - summary: The client ID of the developer's Azure Active Directory application. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'servicePrincipalId: string;' - return: - type: string - - name: userEmail - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' - package: '@microsoft/sp-http!' - fullName: userEmail - summary: >- - The user's email address. This will be used to ensure that the current user's identity is used for fetching auth - tokens. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead - syntax: - content: 'userEmail?: string;' - return: - type: string - - name: userPrincipalName - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' - package: '@microsoft/sp-http!' - fullName: userPrincipalName - summary: >- - The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth - tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the - current request" error. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userPrincipalName?: string;' - return: - type: string +### YamlMime:TSType +name: IAadTokenProviderConfiguration +uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: IAadTokenProviderConfiguration +summary: Required strings for constructing an AadTokenProvider. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: aadInstanceUrl + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' + package: '@microsoft/sp-http!' + fullName: aadInstanceUrl + summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'aadInstanceUrl: string;' + return: + type: string + - name: aadSessionId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' + package: '@microsoft/sp-http!' + fullName: aadSessionId + summary: The current Azure Active Directory's session id. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'aadSessionId: string;' + return: + type: string + - name: aadTenantId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' + package: '@microsoft/sp-http!' + fullName: aadTenantId + summary: The Azure Active Directory's tenant id. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'aadTenantId: string;' + return: + type: string + - name: aadUserId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' + package: '@microsoft/sp-http!' + fullName: aadUserId + summary: >- + The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current + user. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'aadUserId?: string;' + return: + type: string + - name: redirectUri + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' + package: '@microsoft/sp-http!' + fullName: redirectUri + summary: >- + The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's + application redirect uris. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUri: string;' + return: + type: string + - name: servicePrincipalId + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' + package: '@microsoft/sp-http!' + fullName: servicePrincipalId + summary: The client ID of the developer's Azure Active Directory application. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'servicePrincipalId: string;' + return: + type: string + - name: userEmail + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' + package: '@microsoft/sp-http!' + fullName: userEmail + summary: >- + The user's email address. This will be used to ensure that the current user's identity is used for fetching auth + tokens. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead + syntax: + content: 'userEmail?: string;' + return: + type: string + - name: userPrincipalName + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' + package: '@microsoft/sp-http!' + fullName: userPrincipalName + summary: >- + The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth + tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the + current request" error. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'userPrincipalName?: string;' + return: + type: string diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml index cbf4c480..a98c74d8 100644 --- a/SP-Framework/sp-http/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -1,36 +1,36 @@ -### YamlMime:TSType -name: IBeforeRedirectEventArgs -uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' -package: '@microsoft/sp-http!' -fullName: IBeforeRedirectEventArgs -summary: Represents arguments used before redirecting event. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: cancel - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#cancel:member' - package: '@microsoft/sp-http!' - fullName: cancel - summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'cancel: () => void;' - return: - type: () => void - - name: redirectUrl - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl - summary: The url of the page to redirect to if automatic redirect is cancelled - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectUrl: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IBeforeRedirectEventArgs +uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' +package: '@microsoft/sp-http!' +fullName: IBeforeRedirectEventArgs +summary: Represents arguments used before redirecting event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: cancel + uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#cancel:member' + package: '@microsoft/sp-http!' + fullName: cancel + summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'cancel: () => void;' + return: + type: () => void + - name: redirectUrl + uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' + fullName: redirectUrl + summary: The url of the page to redirect to if automatic redirect is cancelled + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index bdc99345..f286197a 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -1,102 +1,102 @@ -### YamlMime:TSType -name: IDigestCache -uid: '@microsoft/sp-http!IDigestCache:interface' -package: '@microsoft/sp-http!' -fullName: IDigestCache -summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A - request digest is a security token that the SharePoint server requires for for any REST write operation, specified via - the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after - a server configurable amount of time. - - - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' - package: '@microsoft/sp-http!' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - summary: >- - Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will - automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios - addDigestToCache() can be used to avoid the overhead of the REST call. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' - parameters: - - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string - - id: digestValue - description: >- - The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look - something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" - type: string - - id: expirationTimestamp - description: >- - A future point in time, as measured by performance.now(), after which the digest value will no longer be - valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for - example, to specify an expiration "5 seconds from right now", use performance.now()+5000. - type: number - return: - type: void - description: '' - - name: clearAllDigests() - uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' - package: '@microsoft/sp-http!' - fullName: clearAllDigests() - summary: Clears all values from the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clearAllDigests(): void;' - return: - type: void - description: '' - - name: clearDigest(webUrl) - uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: clearDigest(webUrl) - summary: >- - Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a - digest was invalidated prior to its expiration time. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clearDigest(webUrl: string): boolean;' - parameters: - - id: webUrl - description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. - type: string - return: - type: boolean - description: Returns true if a cache entry was found and deleted; false otherwise. - - name: fetchDigest(webUrl) - uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: fetchDigest(webUrl) - summary: >- - Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is - fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the - digest, which will be added to the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'fetchDigest(webUrl: string): Promise;' - parameters: - - id: webUrl - description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string - return: - type: Promise<string> - description: A promise that is fulfilled with the digest value. +### YamlMime:TSType +name: IDigestCache +uid: '@microsoft/sp-http!IDigestCache:interface' +package: '@microsoft/sp-http!' +fullName: IDigestCache +summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A + request digest is a security token that the SharePoint server requires for for any REST write operation, specified via + the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after + a server configurable amount of time. + + + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' + package: '@microsoft/sp-http!' + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + summary: >- + Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will + automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios + addDigestToCache() can be used to avoid the overhead of the REST call. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: string + - id: digestValue + description: >- + The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look + something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" + type: string + - id: expirationTimestamp + description: >- + A future point in time, as measured by performance.now(), after which the digest value will no longer be + valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for + example, to specify an expiration "5 seconds from right now", use performance.now()+5000. + type: number + return: + type: void + description: '' + - name: clearAllDigests() + uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' + package: '@microsoft/sp-http!' + fullName: clearAllDigests() + summary: Clears all values from the cache. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearAllDigests(): void;' + return: + type: void + description: '' + - name: clearDigest(webUrl) + uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' + package: '@microsoft/sp-http!' + fullName: clearDigest(webUrl) + summary: >- + Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a + digest was invalidated prior to its expiration time. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearDigest(webUrl: string): boolean;' + parameters: + - id: webUrl + description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. + type: string + return: + type: boolean + description: Returns true if a cache entry was found and deleted; false otherwise. + - name: fetchDigest(webUrl) + uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' + package: '@microsoft/sp-http!' + fullName: fetchDigest(webUrl) + summary: >- + Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is + fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the + digest, which will be added to the cache. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'fetchDigest(webUrl: string): Promise;' + parameters: + - id: webUrl + description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. + type: string + return: + type: Promise<string> + description: A promise that is fulfilled with the digest value. diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index df0a8fce..8949bae1 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -1,10 +1,10 @@ -### YamlMime:TSType -name: IHttpClientConfiguration -uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: IHttpClientConfiguration -summary: Flags interface for HttpClientConfiguration. -remarks: '' -isPreview: false -isDeprecated: false -type: interface +### YamlMime:TSType +name: IHttpClientConfiguration +uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: IHttpClientConfiguration +summary: Flags interface for HttpClientConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 23fad171..c5606949 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -1,29 +1,29 @@ -### YamlMime:TSType -name: IHttpClientConfigurations -uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: IHttpClientConfigurations -summary: Standard configurations for HttpClient. -remarks: >- - This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In - general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -isPreview: false -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' - package: '@microsoft/sp-http!' - fullName: v1 - summary: >- - This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially - identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly v1: HttpClientConfiguration;' - return: - type: '' +### YamlMime:TSType +name: IHttpClientConfigurations +uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: IHttpClientConfigurations +summary: Standard configurations for HttpClient. +remarks: >- + This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In + general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +isPreview: false +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: >- + This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially + identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly v1: HttpClientConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index 4db2f088..b447cd81 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -1,13 +1,13 @@ -### YamlMime:TSType -name: IHttpClientOptions -uid: '@microsoft/sp-http!IHttpClientOptions:interface' -package: '@microsoft/sp-http!' -fullName: IHttpClientOptions -summary: Options for HttpClient -remarks: >- - This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on - the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -isPreview: false -isDeprecated: false -type: interface -extends: RequestInit +### YamlMime:TSType +name: IHttpClientOptions +uid: '@microsoft/sp-http!IHttpClientOptions:interface' +package: '@microsoft/sp-http!' +fullName: IHttpClientOptions +summary: Options for HttpClient +remarks: >- + This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on + the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ +isPreview: false +isDeprecated: false +type: interface +extends: RequestInit diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 030db3fd..fbed7db9 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: ISPHttpClientBatchConfiguration -uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchConfiguration -summary: Flags interface for SPHttpClientBatchConfiguration. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: ISPHttpClientBatchConfiguration +uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchConfiguration +summary: Flags interface for SPHttpClientBatchConfiguration. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 71ffece7..72045b57 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -1,27 +1,27 @@ -### YamlMime:TSType -name: ISPHttpClientBatchConfigurations -uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchConfigurations -summary: Standard configurations for SPHttpClient. -remarks: >- - This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch - class. In general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -isPreview: true -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' - package: '@microsoft/sp-http!' - fullName: v1 - summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly v1: SPHttpClientBatchConfiguration;' - return: - type: '' +### YamlMime:TSType +name: ISPHttpClientBatchConfigurations +uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchConfigurations +summary: Standard configurations for SPHttpClient. +remarks: >- + This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch + class. In general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +isPreview: true +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly v1: SPHttpClientBatchConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 8b7f94f9..54f9061c 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -1,27 +1,27 @@ -### YamlMime:TSType -name: ISPHttpClientBatchCreationOptions -uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchCreationOptions -summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: webUrl - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' - package: '@microsoft/sp-http!' - fullName: webUrl - summary: >- - SPHttpClientBatch will need to perform its POST to an endpoint such as - "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in - this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to - fetch(), but if not, the webUrl can be explicitly specified using this option. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'webUrl?: string;' - return: - type: string +### YamlMime:TSType +name: ISPHttpClientBatchCreationOptions +uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchCreationOptions +summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: webUrl + uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' + package: '@microsoft/sp-http!' + fullName: webUrl + summary: >- + SPHttpClientBatch will need to perform its POST to an endpoint such as + "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in + this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to + fetch(), but if not, the webUrl can be explicitly specified using this option. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'webUrl?: string;' + return: + type: string diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 70eb681a..4a77681d 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -1,13 +1,13 @@ -### YamlMime:TSType -name: ISPHttpClientBatchOptions -uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchOptions -summary: >- - This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on - the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -remarks: '' -isPreview: true -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: ISPHttpClientBatchOptions +uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientBatchOptions +summary: >- + This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on + the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index 0c3a659f..1512e15a 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -1,54 +1,54 @@ -### YamlMime:TSType -name: ISPHttpClientCommonConfiguration -uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientCommonConfiguration -summary: Flags interface for SPHttpClientCommonConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: jsonRequest - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' - package: '@microsoft/sp-http!' - fullName: jsonRequest - summary: Automatically configure the "Content-Type" header for a JSON payload. - remarks: >- - When this switch is true: - - - If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). - - - For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. - - - For OData 4.0, the value is 'application/json;charset=utf-8'. - isPreview: false - isDeprecated: false - syntax: - content: 'jsonRequest?: boolean;' - return: - type: boolean - - name: jsonResponse - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' - package: '@microsoft/sp-http!' - fullName: jsonResponse - summary: Automatically configure the "Accept" header for a JSON payload. - remarks: |- - When this switch is true: - - If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. - - For OData 3.0, the value is 'application/json'. - - For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - isPreview: false - isDeprecated: false - syntax: - content: 'jsonResponse?: boolean;' - return: - type: boolean -extends: '' +### YamlMime:TSType +name: ISPHttpClientCommonConfiguration +uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientCommonConfiguration +summary: Flags interface for SPHttpClientCommonConfiguration +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: jsonRequest + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' + package: '@microsoft/sp-http!' + fullName: jsonRequest + summary: Automatically configure the "Content-Type" header for a JSON payload. + remarks: >- + When this switch is true: + + + If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). + + + For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. + + + For OData 4.0, the value is 'application/json;charset=utf-8'. + isPreview: false + isDeprecated: false + syntax: + content: 'jsonRequest?: boolean;' + return: + type: boolean + - name: jsonResponse + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' + package: '@microsoft/sp-http!' + fullName: jsonResponse + summary: Automatically configure the "Accept" header for a JSON payload. + remarks: |- + When this switch is true: + + If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. + + For OData 3.0, the value is 'application/json'. + + For OData 4.0, the value is 'application/json;odata.metadata=minimal'. + isPreview: false + isDeprecated: false + syntax: + content: 'jsonResponse?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 7e4b8727..efff553f 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -1,68 +1,68 @@ -### YamlMime:TSType -name: ISPHttpClientConfiguration -uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientConfiguration -summary: Flags interface for SPHttpClientConfiguration. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: defaultODataVersion - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' - package: '@microsoft/sp-http!' - fullName: defaultODataVersion - summary: Automatically configure the "OData-Version" header. - remarks: >- - When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the - request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. - - - NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. - The recommended version is 4.0. - isPreview: false - isDeprecated: false - syntax: - content: 'defaultODataVersion?: ODataVersion;' - return: - type: '' - - name: defaultSameOriginCredentials - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' - package: '@microsoft/sp-http!' - fullName: defaultSameOriginCredentials - summary: Automatically configure the RequestInit.credentials. - remarks: >- - When this switch is true: - - - If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be - "same-origin". Without this switch, different web browsers may apply different defaults. - - - For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - isPreview: false - isDeprecated: false - syntax: - content: 'defaultSameOriginCredentials?: boolean;' - return: - type: boolean - - name: requestDigest - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' - package: '@microsoft/sp-http!' - fullName: requestDigest - summary: Automatically provide an "X-RequestDigest" header for authentication. - remarks: >- - When this switch is true: - - - If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - isPreview: false - isDeprecated: false - syntax: - content: 'requestDigest?: boolean;' - return: - type: boolean -extends: '' +### YamlMime:TSType +name: ISPHttpClientConfiguration +uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientConfiguration +summary: Flags interface for SPHttpClientConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: defaultODataVersion + uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' + package: '@microsoft/sp-http!' + fullName: defaultODataVersion + summary: Automatically configure the "OData-Version" header. + remarks: >- + When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the + request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. + + + NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. + The recommended version is 4.0. + isPreview: false + isDeprecated: false + syntax: + content: 'defaultODataVersion?: ODataVersion;' + return: + type: '' + - name: defaultSameOriginCredentials + uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' + package: '@microsoft/sp-http!' + fullName: defaultSameOriginCredentials + summary: Automatically configure the RequestInit.credentials. + remarks: >- + When this switch is true: + + + If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be + "same-origin". Without this switch, different web browsers may apply different defaults. + + + For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + isPreview: false + isDeprecated: false + syntax: + content: 'defaultSameOriginCredentials?: boolean;' + return: + type: boolean + - name: requestDigest + uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' + package: '@microsoft/sp-http!' + fullName: requestDigest + summary: Automatically provide an "X-RequestDigest" header for authentication. + remarks: >- + When this switch is true: + + + If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. + isPreview: false + isDeprecated: false + syntax: + content: 'requestDigest?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index af67baf8..5911cf8f 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -1,32 +1,32 @@ -### YamlMime:TSType -name: ISPHttpClientConfigurations -uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientConfigurations -summary: Standard configurations for SPHttpClient. -remarks: >- - This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In - general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -isPreview: false -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' - package: '@microsoft/sp-http!' - fullName: v1 - summary: >- - Version 1 enables these switches: - - - consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; - defaultODataVersion = ODataVersion.v4; requestDigest = true - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly v1: SPHttpClientConfiguration;' - return: - type: '' +### YamlMime:TSType +name: ISPHttpClientConfigurations +uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientConfigurations +summary: Standard configurations for SPHttpClient. +remarks: >- + This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In + general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +isPreview: false +isDeprecated: false +type: interface +properties: + - name: v1 + uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' + package: '@microsoft/sp-http!' + fullName: v1 + summary: >- + Version 1 enables these switches: + + + consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; + defaultODataVersion = ODataVersion.v4; requestDigest = true + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly v1: SPHttpClientConfiguration;' + return: + type: '' diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index f85a09fe..68c63a68 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -1,31 +1,31 @@ -### YamlMime:TSType -name: ISPHttpClientOptions -uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientOptions -summary: >- - This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on - the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: webUrl - uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' - package: '@microsoft/sp-http!' - fullName: webUrl - summary: Configure the SPWeb URL for authentication. - remarks: >- - For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be - fetched using a seperate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the SPWeb - URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such - as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in - this case, the webUrl can be explicitly specified using this option. - isPreview: false - isDeprecated: false - syntax: - content: 'webUrl?: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: ISPHttpClientOptions +uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' +package: '@microsoft/sp-http!' +fullName: ISPHttpClientOptions +summary: >- + This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on + the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: webUrl + uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' + package: '@microsoft/sp-http!' + fullName: webUrl + summary: Configure the SPWeb URL for authentication. + remarks: >- + For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be + fetched using a seperate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the SPWeb + URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such + as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in + this case, the webUrl can be explicitly specified using this option. + isPreview: false + isDeprecated: false + syntax: + content: 'webUrl?: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index dc3d4742..90a1d4ce 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -1,36 +1,36 @@ -### YamlMime:TSType -name: ITokenAcquisitionEventArgs -uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' -package: '@microsoft/sp-http!' -fullName: ITokenAcquisitionEventArgs -summary: Represents arguments used for raising a token acquisiton failure event. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: message - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' - package: '@microsoft/sp-http!' - fullName: message - summary: The message returned from ADAL fails to retrieve a token from Azure AD. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'message: string;' - return: - type: string - - name: redirectUrl - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl - summary: The url of the page for the end user to interact with Azure AD. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectUrl?: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: ITokenAcquisitionEventArgs +uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' +package: '@microsoft/sp-http!' +fullName: ITokenAcquisitionEventArgs +summary: Represents arguments used for raising a token acquisiton failure event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: message + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' + package: '@microsoft/sp-http!' + fullName: message + summary: The message returned from ADAL fails to retrieve a token from Azure AD. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'message: string;' + return: + type: string + - name: redirectUrl + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' + fullName: redirectUrl + summary: The url of the page for the end user to interact with Azure AD. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl?: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index e64e15a3..403e4a01 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -1,49 +1,49 @@ -### YamlMime:TSType -name: MSGraphClient -uid: '@microsoft/sp-http!MSGraphClient:class' -package: '@microsoft/sp-http!' -fullName: MSGraphClient -summary: MSGraphClient is used to perform REST calls against Microsoft Graph. -remarks: >- - The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class - allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. - If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom - configuration for every request. - - - For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClient` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'api(path, config)' - uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' - package: '@microsoft/sp-http!' - fullName: 'api(path, config)' - summary: All calls to Microsoft Graph are chained together starting with the api function. - remarks: >- - Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* - https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship') - - - The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See - the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - isPreview: false - isDeprecated: false - syntax: - content: 'api(path: string, config?: Options): IGraphRequest;' - parameters: - - id: path - description: The path for the request to MSGraph. - type: string - - id: config - description: Sets the configuration for this request. - type: '' - return: - type: '' - description: '' +### YamlMime:TSType +name: MSGraphClient +uid: '@microsoft/sp-http!MSGraphClient:class' +package: '@microsoft/sp-http!' +fullName: MSGraphClient +summary: MSGraphClient is used to perform REST calls against Microsoft Graph. +remarks: >- + The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class + allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. + If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom + configuration for every request. + + + For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClient` class. +isPreview: false +isDeprecated: false +type: class +methods: + - name: 'api(path, config)' + uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' + package: '@microsoft/sp-http!' + fullName: 'api(path, config)' + summary: All calls to Microsoft Graph are chained together starting with the api function. + remarks: >- + Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* + https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship') + + + The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See + the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript + isPreview: false + isDeprecated: false + syntax: + content: 'api(path: string, config?: Options): IGraphRequest;' + parameters: + - id: path + description: The path for the request to MSGraph. + type: string + - id: config + description: Sets the configuration for this request. + type: '' + return: + type: '' + description: '' diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 555d8d00..a4eeb08d 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -1,45 +1,45 @@ -### YamlMime:TSType -name: MSGraphClientFactory -uid: '@microsoft/sp-http!MSGraphClientFactory:class' -package: '@microsoft/sp-http!' -fullName: MSGraphClientFactory -summary: >- - Returns a preinitialized version of the MSGraphClient. For more information: - [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClientFactory` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: serviceKey - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for MSGraphClientFactory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getClient() - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' - package: '@microsoft/sp-http!' - fullName: getClient() - summary: >- - Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service - Principal. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'getClient(): Promise;' - return: - type: 'Promise<>' - description: '' +### YamlMime:TSType +name: MSGraphClientFactory +uid: '@microsoft/sp-http!MSGraphClientFactory:class' +package: '@microsoft/sp-http!' +fullName: MSGraphClientFactory +summary: >- + Returns a preinitialized version of the MSGraphClient. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClientFactory` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: serviceKey + uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for MSGraphClientFactory. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: getClient() + uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' + package: '@microsoft/sp-http!' + fullName: getClient() + summary: >- + Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service + Principal. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getClient(): Promise;' + return: + type: 'Promise<>' + description: '' diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index d212fcdc..357706a9 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -1,68 +1,68 @@ -### YamlMime:TSType -name: ODataVersion -uid: '@microsoft/sp-http!ODataVersion:class' -package: '@microsoft/sp-http!' -fullName: ODataVersion -summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: v3 - uid: '@microsoft/sp-http!ODataVersion.v3:member' - package: '@microsoft/sp-http!' - fullName: v3 - summary: Represents version 3.0 for the "OData-Version" header - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static v3: ODataVersion;' - return: - type: '' - - name: v4 - uid: '@microsoft/sp-http!ODataVersion.v4:member' - package: '@microsoft/sp-http!' - fullName: v4 - summary: Represents version 4.0 for the "OData-Version" header - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static v4: ODataVersion;' - return: - type: '' -methods: - - name: toString() - uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' - package: '@microsoft/sp-http!' - fullName: toString() - summary: 'Returns the "OData-Version" value, for example "4.0".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'toString(): string;' - return: - type: string - description: '' - - name: tryParseFromHeaders(headers) - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' - package: '@microsoft/sp-http!' - fullName: tryParseFromHeaders(headers) - summary: Attempt to parse the "OData-Version" header. - remarks: >- - If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown - if the version number is not supported. If the header is missing, then undefined is returned. - isPreview: false - isDeprecated: false - syntax: - content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' - parameters: - - id: headers - description: '' - type: Headers - return: - type: ' | undefined' - description: '' +### YamlMime:TSType +name: ODataVersion +uid: '@microsoft/sp-http!ODataVersion:class' +package: '@microsoft/sp-http!' +fullName: ODataVersion +summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: v3 + uid: '@microsoft/sp-http!ODataVersion.v3:member' + package: '@microsoft/sp-http!' + fullName: v3 + summary: Represents version 3.0 for the "OData-Version" header + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static v3: ODataVersion;' + return: + type: '' + - name: v4 + uid: '@microsoft/sp-http!ODataVersion.v4:member' + package: '@microsoft/sp-http!' + fullName: v4 + summary: Represents version 4.0 for the "OData-Version" header + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static v4: ODataVersion;' + return: + type: '' +methods: + - name: toString() + uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' + package: '@microsoft/sp-http!' + fullName: toString() + summary: 'Returns the "OData-Version" value, for example "4.0".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'toString(): string;' + return: + type: string + description: '' + - name: tryParseFromHeaders(headers) + uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' + package: '@microsoft/sp-http!' + fullName: tryParseFromHeaders(headers) + summary: Attempt to parse the "OData-Version" header. + remarks: >- + If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown + if the version number is not supported. If the header is missing, then undefined is returned. + isPreview: false + isDeprecated: false + syntax: + content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' + parameters: + - id: headers + description: '' + type: Headers + return: + type: ' | undefined' + description: '' diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 58860cee..0bde4bd1 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -1,244 +1,244 @@ -### YamlMime:TSType -name: SPHttpClient -uid: '@microsoft/sp-http!SPHttpClient:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClient -summary: >- - SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for - writes, and collects telemetry that helps the service to monitor the performance of an application. -remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. - - For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' - package: '@microsoft/sp-http!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `SPHttpClient` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: configurations - uid: '@microsoft/sp-http!SPHttpClient.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations - summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly configurations: ISPHttpClientConfigurations;' - return: - type: '' - - name: serviceKey - uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for SPHttpClient. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: '_fetch(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#_fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: '_fetch(url, configuration, options)' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): - Promise; - parameters: - - id: url - description: '' - type: string - - id: configuration - description: '' - type: '' - - id: options - description: '' - type: '' - return: - type: 'Promise<>' - description: '' - - name: beginBatch(batchCreationOptions) - uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' - package: '@microsoft/sp-http!' - fullName: beginBatch(batchCreationOptions) - summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' - parameters: - - id: batchCreationOptions - description: '' - type: '' - return: - type: '' - description: >- - An [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) object used to manage the batch - operation. - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' - summary: Perform a REST service call. - remarks: >- - Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API - standard that is documented here: https://fetch.spec.whatwg.org/ - - - The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA - API's (which can be avoided by using HttpClient instead): - - - - Default "Accept" and "Content-Type" headers are added if not explicitly specified. - - - - For write operations, an "X-RequestDigest" header is automatically added - - - - The request digest token is automatically fetched and stored in a cache, with support for preloading - - - For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be - obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the - appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL - passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. - isPreview: false - isDeprecated: false - syntax: - content: >- - fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of SPHttpClient; normally this should be the latest version number from - SPHttpClientConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of SPHttpClient; normally this should be the latest version number from - SPHttpClientConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: getWebUrlFromRequestUrl(requestUrl) - uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' - package: '@microsoft/sp-http!' - fullName: getWebUrlFromRequestUrl(requestUrl) - summary: Use a heuristic to infer the base URL for authentication. - remarks: >- - Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path - components such as "\_api", "\_layouts", or "\_vit\_bin". This is necessary for operations such as the - X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a - request. - - - For example, if the requestUrl is "/sites/site/web/\_api/service", the returned URL would be "/sites/site/web". Or - if the requestUrl is "http://example.com/\_layouts/service", the returned URL would be "http://example.com". - - - If the URL cannot be determined, an exception is thrown. - isPreview: false - isDeprecated: false - syntax: - content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' - parameters: - - id: requestUrl - description: The URL for a SharePoint REST service - type: string - return: - type: string - description: the inferred SPWeb URL - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of SPHttpClient; normally this should be the latest version number from - SPHttpClientConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. +### YamlMime:TSType +name: SPHttpClient +uid: '@microsoft/sp-http!SPHttpClient:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClient +summary: >- + SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for + writes, and collects telemetry that helps the service to monitor the performance of an application. +remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `SPHttpClient` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: configurations + uid: '@microsoft/sp-http!SPHttpClient.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly configurations: ISPHttpClientConfigurations;' + return: + type: '' + - name: serviceKey + uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' + package: '@microsoft/sp-http!' + fullName: serviceKey + summary: The service key for SPHttpClient. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> +methods: + - name: '_fetch(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#_fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: '_fetch(url, configuration, options)' + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; + parameters: + - id: url + description: '' + type: string + - id: configuration + description: '' + type: '' + - id: options + description: '' + type: '' + return: + type: 'Promise<>' + description: '' + - name: beginBatch(batchCreationOptions) + uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' + package: '@microsoft/sp-http!' + fullName: beginBatch(batchCreationOptions) + summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' + parameters: + - id: batchCreationOptions + description: '' + type: '' + return: + type: '' + description: >- + An [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) object used to manage the batch + operation. + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: Perform a REST service call. + remarks: >- + Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API + standard that is documented here: https://fetch.spec.whatwg.org/ + + + The SPHttpClient subclass adds some additional behaviors that are convenient when working with SharePoint ODATA + API's (which can be avoided by using HttpClient instead): + + + - Default "Accept" and "Content-Type" headers are added if not explicitly specified. + + + - For write operations, an "X-RequestDigest" header is automatically added + + + - The request digest token is automatically fetched and stored in a cache, with support for preloading + + + For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be + obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the + appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL + passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. + isPreview: false + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of SPHttpClient; normally this should be the latest version number from + SPHttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "GET".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of SPHttpClient; normally this should be the latest version number from + SPHttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. + - name: getWebUrlFromRequestUrl(requestUrl) + uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' + package: '@microsoft/sp-http!' + fullName: getWebUrlFromRequestUrl(requestUrl) + summary: Use a heuristic to infer the base URL for authentication. + remarks: >- + Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path + components such as "\_api", "\_layouts", or "\_vit\_bin". This is necessary for operations such as the + X-RequestDigest and ODATA batching, which require POSTing to a separate REST endpoint in order to complete a + request. + + + For example, if the requestUrl is "/sites/site/web/\_api/service", the returned URL would be "/sites/site/web". Or + if the requestUrl is "http://example.com/\_layouts/service", the returned URL would be "http://example.com". + + + If the URL cannot be determined, an exception is thrown. + isPreview: false + isDeprecated: false + syntax: + content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' + parameters: + - id: requestUrl + description: The URL for a SharePoint REST service + type: string + return: + type: string + description: the inferred SPWeb URL + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to "POST".' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of SPHttpClient; normally this should be the latest version number from + SPHttpClientConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 9a3b248f..dd1ae9ad 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -1,156 +1,156 @@ -### YamlMime:TSType -name: SPHttpClientBatch -uid: '@microsoft/sp-http!SPHttpClientBatch:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientBatch -summary: >- - The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. - This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html - - - The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call - SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when - the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an - SPHttpClientResponse object for that particular request. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPHttpClientBatch` class. -isPreview: true -isDeprecated: false -type: class -properties: - - name: configurations - uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations - summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' - return: - type: '' -methods: - - name: execute() - uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' - package: '@microsoft/sp-http!' - fullName: execute() - summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'execute(): Promise;' - return: - type: 'Promise<>' - description: '' - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' - summary: >- - Queues a new request, and returns a promise that can be used to access the server response (after execute() has - completed). - remarks: >- - The parameters for this function are basically the same as the WHATWG API standard documented here: - - - [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/) - - - However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation - for details. - - - When execute() is called, it will POST to a URL such as "http://example.com/sites/sample/\_api/$batch". Typically - SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as - "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it - explicitly. - isPreview: true - isDeprecated: false - syntax: - content: >- - fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of this request; normally this should be the latest version number from - SPHttpClientBatchConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to ''GET''.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: >- - get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of this request; normally this should be the latest version number from - SPHttpClientBatchConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to ''POST''.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: >- - post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): - Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of this request; normally this should be the latest version number from - SPHttpClientBatchConfigurations - type: '' - - id: options - description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. +### YamlMime:TSType +name: SPHttpClientBatch +uid: '@microsoft/sp-http!SPHttpClientBatch:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientBatch +summary: >- + The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. + This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html + + + The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call + SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when + the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an + SPHttpClientResponse object for that particular request. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPHttpClientBatch` class. +isPreview: true +isDeprecated: false +type: class +properties: + - name: configurations + uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' + package: '@microsoft/sp-http!' + fullName: configurations + summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' + return: + type: '' +methods: + - name: execute() + uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' + package: '@microsoft/sp-http!' + fullName: execute() + summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'execute(): Promise;' + return: + type: 'Promise<>' + description: '' + - name: 'fetch(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' + package: '@microsoft/sp-http!' + fullName: 'fetch(url, configuration, options)' + summary: >- + Queues a new request, and returns a promise that can be used to access the server response (after execute() has + completed). + remarks: >- + The parameters for this function are basically the same as the WHATWG API standard documented here: + + + [https://fetch.spec.whatwg.org/](https://fetch.spec.whatwg.org/) + + + However, be aware that certain REST headers are ignored or not allowed inside a batch. See the ODATA documentation + for details. + + + When execute() is called, it will POST to a URL such as "http://example.com/sites/sample/\_api/$batch". Typically + SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as + "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it + explicitly. + isPreview: true + isDeprecated: false + syntax: + content: >- + fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of this request; normally this should be the latest version number from + SPHttpClientBatchConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. + - name: 'get(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' + package: '@microsoft/sp-http!' + fullName: 'get(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to ''GET''.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of this request; normally this should be the latest version number from + SPHttpClientBatchConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. + - name: 'post(url, configuration, options)' + uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' + package: '@microsoft/sp-http!' + fullName: 'post(url, configuration, options)' + summary: 'Calls fetch(), but sets the method to ''POST''.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: >- + post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): + Promise; + parameters: + - id: url + description: the URL to fetch + type: string + - id: configuration + description: >- + determines the default behavior of this request; normally this should be the latest version number from + SPHttpClientBatchConfigurations + type: '' + - id: options + description: additional options that affect the request + type: '' + return: + type: 'Promise<>' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index f8574460..d89b6929 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -1,83 +1,83 @@ -### YamlMime:TSType -name: SPHttpClientBatchConfiguration -uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientBatchConfiguration -summary: Configuration for SPHttpClientBatch. -remarks: >- - The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the - SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing - one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the - SPHttpClientBatchConfiguration.overrideWith() method. -isPreview: true -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' - summary: >- - Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be - used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);' - parameters: - - id: flags - description: '' - type: '' - - id: overrideFlags - description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' - package: '@microsoft/sp-http!' - fullName: flags - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'protected flags: ISPHttpClientBatchConfiguration;' - return: - type: '' -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: void - description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; - parameters: - - id: sourceFlags - description: '' - type: '' - return: - type: '' - description: '' -extends: '' +### YamlMime:TSType +name: SPHttpClientBatchConfiguration +uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientBatchConfiguration +summary: Configuration for SPHttpClientBatch. +remarks: >- + The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the + SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing + one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the + SPHttpClientBatchConfiguration.overrideWith() method. +isPreview: true +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be + used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);' + parameters: + - id: flags + description: '' + type: '' + - id: overrideFlags + description: '' + type: '' +properties: + - name: flags + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'protected flags: ISPHttpClientBatchConfiguration;' + return: + type: '' +methods: + - name: initializeFlags() + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; + parameters: + - id: sourceFlags + description: '' + type: '' + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index c510137d..9976779c 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -1,121 +1,121 @@ -### YamlMime:TSType -name: SPHttpClientCommonConfiguration -uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientCommonConfiguration -summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' - summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. - remarks: >- - The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it - takes precedence over flags. - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);' - parameters: - - id: flags - description: '' - type: '' - - id: overrideFlags - description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' - package: '@microsoft/sp-http!' - fullName: flags - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected flags: ISPHttpClientCommonConfiguration;' - return: - type: '' - - name: jsonRequest - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' - package: '@microsoft/sp-http!' - fullName: jsonRequest - summary: Automatically configure the "Content-Type" header for a JSON payload. - remarks: >- - When this switch is true: - - - If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). - - - For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. - - - For OData 4.0, the value is 'application/json;charset=utf-8'. - isPreview: false - isDeprecated: false - syntax: - content: 'get jsonRequest(): boolean;' - return: - type: boolean - - name: jsonResponse - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' - package: '@microsoft/sp-http!' - fullName: jsonResponse - summary: Automatically configure the "Accept" header for a JSON payload. - remarks: |- - When this switch is true: - - If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. - - For OData 3.0, the value is 'application/json'. - - For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - isPreview: false - isDeprecated: false - syntax: - content: 'get jsonResponse(): boolean;' - return: - type: boolean -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: void - description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; - parameters: - - id: sourceFlags - description: '' - type: '' - return: - type: '' - description: '' -extends: '' +### YamlMime:TSType +name: SPHttpClientCommonConfiguration +uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientCommonConfiguration +summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. + remarks: >- + The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it + takes precedence over flags. + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);' + parameters: + - id: flags + description: '' + type: '' + - id: overrideFlags + description: '' + type: '' +properties: + - name: flags + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: ISPHttpClientCommonConfiguration;' + return: + type: '' + - name: jsonRequest + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' + package: '@microsoft/sp-http!' + fullName: jsonRequest + summary: Automatically configure the "Content-Type" header for a JSON payload. + remarks: >- + When this switch is true: + + + If the "Content-Type" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). + + + For OData 3.0, the value is 'application/json;odata=verbose;charset=utf-8'. + + + For OData 4.0, the value is 'application/json;charset=utf-8'. + isPreview: false + isDeprecated: false + syntax: + content: 'get jsonRequest(): boolean;' + return: + type: boolean + - name: jsonResponse + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' + package: '@microsoft/sp-http!' + fullName: jsonResponse + summary: Automatically configure the "Accept" header for a JSON payload. + remarks: |- + When this switch is true: + + If the "Accept" header was not explicitly added for the request, then SPHttpClient will add it. + + For OData 3.0, the value is 'application/json'. + + For OData 4.0, the value is 'application/json;odata.metadata=minimal'. + isPreview: false + isDeprecated: false + syntax: + content: 'get jsonResponse(): boolean;' + return: + type: boolean +methods: + - name: initializeFlags() + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; + parameters: + - id: sourceFlags + description: '' + type: '' + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 63c95b77..5f1ccbdc 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -1,139 +1,139 @@ -### YamlMime:TSType -name: SPHttpClientConfiguration -uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientConfiguration -summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' -remarks: >- - The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the - predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the - SPHttpClientConfiguration.overrideWith() method. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' - summary: >- - Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used - for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);' - parameters: - - id: flags - description: '' - type: '' - - id: overrideFlags - description: '' - type: '' -properties: - - name: defaultODataVersion - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' - package: '@microsoft/sp-http!' - fullName: defaultODataVersion - summary: Automatically configure the "OData-Version" header. - remarks: >- - When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the - request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. - - - NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. - The recommended version is 4.0. - isPreview: false - isDeprecated: false - syntax: - content: 'get defaultODataVersion(): ODataVersion;' - return: - type: '' - - name: defaultSameOriginCredentials - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' - package: '@microsoft/sp-http!' - fullName: defaultSameOriginCredentials - summary: Automatically configure the RequestInit.credentials. - remarks: >- - When this switch is true: - - - If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be - "same-origin". Without this switch, different web browsers may apply different defaults. - - - For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - isPreview: false - isDeprecated: false - syntax: - content: 'get defaultSameOriginCredentials(): boolean;' - return: - type: boolean - - name: flags - uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' - package: '@microsoft/sp-http!' - fullName: flags - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected flags: ISPHttpClientConfiguration;' - return: - type: '' - - name: requestDigest - uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' - package: '@microsoft/sp-http!' - fullName: requestDigest - summary: Automatically provide an "X-RequestDigest" header for authentication. - remarks: >- - When this switch is true: - - - If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - isPreview: false - isDeprecated: false - syntax: - content: 'get requestDigest(): boolean;' - return: - type: boolean -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: void - description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; - parameters: - - id: sourceFlags - description: '' - type: '' - return: - type: '' - description: '' -extends: '' +### YamlMime:TSType +name: SPHttpClientConfiguration +uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientConfiguration +summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' +remarks: >- + The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the + predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the + SPHttpClientConfiguration.overrideWith() method. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(flags, overrideFlags)' + uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(flags, overrideFlags)' + summary: >- + Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used + for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);' + parameters: + - id: flags + description: '' + type: '' + - id: overrideFlags + description: '' + type: '' +properties: + - name: defaultODataVersion + uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' + package: '@microsoft/sp-http!' + fullName: defaultODataVersion + summary: Automatically configure the "OData-Version" header. + remarks: >- + When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the + request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion. + + + NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. + The recommended version is 4.0. + isPreview: false + isDeprecated: false + syntax: + content: 'get defaultODataVersion(): ODataVersion;' + return: + type: '' + - name: defaultSameOriginCredentials + uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' + package: '@microsoft/sp-http!' + fullName: defaultSameOriginCredentials + summary: Automatically configure the RequestInit.credentials. + remarks: >- + When this switch is true: + + + If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be + "same-origin". Without this switch, different web browsers may apply different defaults. + + + For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + isPreview: false + isDeprecated: false + syntax: + content: 'get defaultSameOriginCredentials(): boolean;' + return: + type: boolean + - name: flags + uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' + package: '@microsoft/sp-http!' + fullName: flags + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected flags: ISPHttpClientConfiguration;' + return: + type: '' + - name: requestDigest + uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' + package: '@microsoft/sp-http!' + fullName: requestDigest + summary: Automatically provide an "X-RequestDigest" header for authentication. + remarks: >- + When this switch is true: + + + If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. + isPreview: false + isDeprecated: false + syntax: + content: 'get requestDigest(): boolean;' + return: + type: boolean +methods: + - name: initializeFlags() + uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' + package: '@microsoft/sp-http!' + fullName: initializeFlags() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: void + description: '' + - name: overrideWith(sourceFlags) + uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' + package: '@microsoft/sp-http!' + fullName: overrideWith(sourceFlags) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; + parameters: + - id: sourceFlags + description: '' + type: '' + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index 52da2a90..fcfb6923 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -1,61 +1,61 @@ -### YamlMime:TSType -name: SPHttpClientResponse -uid: '@microsoft/sp-http!SPHttpClientResponse:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientResponse -summary: The Response subclass returned by methods such as SPHttpClient.fetch(). -remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. - - This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(response) - uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' - package: '@microsoft/sp-http!' - fullName: (constructor)(response) - summary: Constructs a new instance of the `SPHttpClientResponse` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(response: Response);' - parameters: - - id: response - description: '' - type: Response -properties: - - name: correlationId - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' - package: '@microsoft/sp-http!' - fullName: correlationId - summary: Returns the SharePoint correlation ID. - remarks: >- - The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, - but may originate from different services or components. SharePoint REST operations return the server's - correlation ID as the "sprequestguid" header. - isPreview: true - isDeprecated: false - syntax: - content: 'get correlationId(): Guid | undefined;' - return: - type: ' | undefined' -methods: - - name: clone() - uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' - package: '@microsoft/sp-http!' - fullName: clone() - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - clone(): SPHttpClientResponse; - return: - type: '' - description: '' -extends: '' +### YamlMime:TSType +name: SPHttpClientResponse +uid: '@microsoft/sp-http!SPHttpClientResponse:class' +package: '@microsoft/sp-http!' +fullName: SPHttpClientResponse +summary: The Response subclass returned by methods such as SPHttpClient.fetch(). +remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. + + This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(response) + uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' + package: '@microsoft/sp-http!' + fullName: (constructor)(response) + summary: Constructs a new instance of the `SPHttpClientResponse` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(response: Response);' + parameters: + - id: response + description: '' + type: Response +properties: + - name: correlationId + uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' + package: '@microsoft/sp-http!' + fullName: correlationId + summary: Returns the SharePoint correlation ID. + remarks: >- + The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, + but may originate from different services or components. SharePoint REST operations return the server's + correlation ID as the "sprequestguid" header. + isPreview: true + isDeprecated: false + syntax: + content: 'get correlationId(): Guid | undefined;' + return: + type: ' | undefined' +methods: + - name: clone() + uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' + package: '@microsoft/sp-http!' + fullName: clone() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @override */ + clone(): SPHttpClientResponse; + return: + type: '' + description: '' +extends: '' diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 4e4a7347..58947dc5 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -1,18 +1,18 @@ -### YamlMime:TSEnum -name: SPHttpHeader -uid: '@microsoft/sp-http!SPHttpHeader:enum' -package: '@microsoft/sp-http!' -fullName: SPHttpHeader -summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' -remarks: '' -isPreview: true -isDeprecated: false -fields: - - name: SPRequestGuid - uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' - package: '@microsoft/sp-http!' - summary: |- - SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request. - - Example value: "9417279e-40e1-0000-2465-306ba786bfd7" - value: '"SPRequestGuid"' +### YamlMime:TSEnum +name: SPHttpHeader +uid: '@microsoft/sp-http!SPHttpHeader:enum' +package: '@microsoft/sp-http!' +fullName: SPHttpHeader +summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: SPRequestGuid + uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' + package: '@microsoft/sp-http!' + summary: |- + SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request. + + Example value: "9417279e-40e1-0000-2465-306ba786bfd7" + value: '"SPRequestGuid"' diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index fc9c829e..12b922b3 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -1,54 +1,54 @@ -### YamlMime:TSType -name: TokenAcquisitionEventArgs -uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' -package: '@microsoft/sp-http!' -fullName: TokenAcquisitionEventArgs -summary: Arguments for a token acquisition failure event. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(message, redirectUrl)' - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' - package: '@microsoft/sp-http!' - fullName: '(constructor)(message, redirectUrl)' - summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(message: string, redirectUrl?: string);' - parameters: - - id: message - description: '' - type: string - - id: redirectUrl - description: '' - type: string -properties: - - name: message - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' - package: '@microsoft/sp-http!' - fullName: message - summary: The message returned from ADAL fails to retrieve a token from Azure AD. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'message: string;' - return: - type: string - - name: redirectUrl - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl - summary: The url of the page for the end user to perform Multi Factor Authentication - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectUrl?: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: TokenAcquisitionEventArgs +uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' +package: '@microsoft/sp-http!' +fullName: TokenAcquisitionEventArgs +summary: Arguments for a token acquisition failure event. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(message, redirectUrl)' + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' + package: '@microsoft/sp-http!' + fullName: '(constructor)(message, redirectUrl)' + summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(message: string, redirectUrl?: string);' + parameters: + - id: message + description: '' + type: string + - id: redirectUrl + description: '' + type: string +properties: + - name: message + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' + package: '@microsoft/sp-http!' + fullName: message + summary: The message returned from ADAL fails to retrieve a token from Azure AD. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'message: string;' + return: + type: string + - name: redirectUrl + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' + package: '@microsoft/sp-http!' + fullName: redirectUrl + summary: The url of the page for the end user to perform Multi Factor Authentication + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl?: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-image-helper.yml b/SP-Framework/sp-image-helper.yml index 24e685cd..6c5b2219 100644 --- a/SP-Framework/sp-image-helper.yml +++ b/SP-Framework/sp-image-helper.yml @@ -1,9 +1,9 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-image-helper!' -name: '@microsoft/sp-image-helper' -type: package -summary: SharePoint Framework helper library to generate image urls optimized for delivery. -interfaces: - - '@microsoft/sp-image-helper!IImageHelperRequest:interface' -classes: - - '@microsoft/sp-image-helper!ImageHelper:class' +### YamlMime:TSPackage +uid: '@microsoft/sp-image-helper!' +name: '@microsoft/sp-image-helper' +type: package +summary: SharePoint Framework helper library to generate image urls optimized for delivery. +interfaces: + - '@microsoft/sp-image-helper!IImageHelperRequest:interface' +classes: + - '@microsoft/sp-image-helper!ImageHelper:class' diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index ca8688ce..282f6941 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -1,50 +1,50 @@ -### YamlMime:TSType -name: IImageHelperRequest -uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' -package: '@microsoft/sp-image-helper!' -fullName: IImageHelperRequest -summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: height - uid: '@microsoft/sp-image-helper!IImageHelperRequest#height:member' - package: '@microsoft/sp-image-helper!' - fullName: height - summary: Optional height of the image requested - remarks: >- - By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This - provides the image with the quickest response.) When the height is specified, the width is not adjusted to the - nearest larger resolution breakpoint. - isPreview: true - isDeprecated: false - syntax: - content: 'height?: number;' - return: - type: number - - name: sourceUrl - uid: '@microsoft/sp-image-helper!IImageHelperRequest#sourceUrl:member' - package: '@microsoft/sp-image-helper!' - fullName: sourceUrl - summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'sourceUrl: string;' - return: - type: string - - name: width - uid: '@microsoft/sp-image-helper!IImageHelperRequest#width:member' - package: '@microsoft/sp-image-helper!' - fullName: width - summary: Width of the image requested. - remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' - isPreview: true - isDeprecated: false - syntax: - content: 'width: number;' - return: - type: number +### YamlMime:TSType +name: IImageHelperRequest +uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' +package: '@microsoft/sp-image-helper!' +fullName: IImageHelperRequest +summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: height + uid: '@microsoft/sp-image-helper!IImageHelperRequest#height:member' + package: '@microsoft/sp-image-helper!' + fullName: height + summary: Optional height of the image requested + remarks: >- + By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This + provides the image with the quickest response.) When the height is specified, the width is not adjusted to the + nearest larger resolution breakpoint. + isPreview: true + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: sourceUrl + uid: '@microsoft/sp-image-helper!IImageHelperRequest#sourceUrl:member' + package: '@microsoft/sp-image-helper!' + fullName: sourceUrl + summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'sourceUrl: string;' + return: + type: string + - name: width + uid: '@microsoft/sp-image-helper!IImageHelperRequest#width:member' + package: '@microsoft/sp-image-helper!' + fullName: width + summary: Width of the image requested. + remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' + isPreview: true + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 192f4668..bbcc094e 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -1,34 +1,34 @@ -### YamlMime:TSType -name: ImageHelper -uid: '@microsoft/sp-image-helper!ImageHelper:class' -package: '@microsoft/sp-image-helper!' -fullName: ImageHelper -summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. -remarks: '' -isPreview: true -isDeprecated: false -type: class -methods: - - name: convertToImageUrl(request) - uid: '@microsoft/sp-image-helper!ImageHelper.convertToImageUrl:member(1)' - package: '@microsoft/sp-image-helper!' - fullName: convertToImageUrl(request) - summary: Convert a url to a file or page on SharePoint into an optimized image url. - remarks: >- - - If width and height are provided, then the resulting image will be scaled to the minimum of the width or height. - - The url will be most performant if only a width is provided. If a height is provided, the image will take longer - to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. - Continue to use the original file's url for serialization. - isPreview: true - isDeprecated: false - syntax: - content: 'static convertToImageUrl(request: IImageHelperRequest): string;' - parameters: - - id: request - description: IImageHelperRequest for the bundled parameters. - type: '' - return: - type: string - description: >- - A full url string for the image of the file. If no optimized url can be created (i.e. an external url or an - unsupported file type), the original sourceUrl is returned. +### YamlMime:TSType +name: ImageHelper +uid: '@microsoft/sp-image-helper!ImageHelper:class' +package: '@microsoft/sp-image-helper!' +fullName: ImageHelper +summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. +remarks: '' +isPreview: true +isDeprecated: false +type: class +methods: + - name: convertToImageUrl(request) + uid: '@microsoft/sp-image-helper!ImageHelper.convertToImageUrl:member(1)' + package: '@microsoft/sp-image-helper!' + fullName: convertToImageUrl(request) + summary: Convert a url to a file or page on SharePoint into an optimized image url. + remarks: >- + - If width and height are provided, then the resulting image will be scaled to the minimum of the width or height. + - The url will be most performant if only a width is provided. If a height is provided, the image will take longer + to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. + Continue to use the original file's url for serialization. + isPreview: true + isDeprecated: false + syntax: + content: 'static convertToImageUrl(request: IImageHelperRequest): string;' + parameters: + - id: request + description: IImageHelperRequest for the bundled parameters. + type: '' + return: + type: string + description: >- + A full url string for the image of the file. If no optimized url can be created (i.e. an external url or an + unsupported file type), the original sourceUrl is returned. diff --git a/SP-Framework/sp-list-subscription.yml b/SP-Framework/sp-list-subscription.yml index a3919e95..8fd3ea01 100644 --- a/SP-Framework/sp-list-subscription.yml +++ b/SP-Framework/sp-list-subscription.yml @@ -1,11 +1,11 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-list-subscription!' -name: '@microsoft/sp-list-subscription' -type: package -summary: This package provides developer support for subscribing to changes in a SharePoint document library. -interfaces: - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - - '@microsoft/sp-list-subscription!IListSubscription:interface' - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' -classes: - - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' +### YamlMime:TSPackage +uid: '@microsoft/sp-list-subscription!' +name: '@microsoft/sp-list-subscription' +type: package +summary: This package provides developer support for subscribing to changes in a SharePoint document library. +interfaces: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - '@microsoft/sp-list-subscription!IListSubscription:interface' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' +classes: + - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 4f7b1bed..afaff990 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -1,82 +1,82 @@ -### YamlMime:TSType -name: ICreateSubscriptionSettings -uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' -package: '@microsoft/sp-list-subscription!' -fullName: ICreateSubscriptionSettings -summary: >- - A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a web, - you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you will need - to provide it as well. - - - In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and - the current domain, site and web will be used. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: callbacks - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' - package: '@microsoft/sp-list-subscription!' - fullName: callbacks - summary: the list of callbacks - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'callbacks: ISubscriptionCallbacks;' - return: - type: '' - - name: domain - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' - package: '@microsoft/sp-list-subscription!' - fullName: domain - summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'domain?: string;' - return: - type: string - - name: listId - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' - package: '@microsoft/sp-list-subscription!' - fullName: listId - summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'listId?: Guid;' - return: - type: '' - - name: siteId - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' - package: '@microsoft/sp-list-subscription!' - fullName: siteId - summary: >- - The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current - site will be used. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'siteId?: Guid;' - return: - type: '' - - name: webId - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' - package: '@microsoft/sp-list-subscription!' - fullName: webId - summary: >- - The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web - will be used. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'webId?: Guid;' - return: - type: '' +### YamlMime:TSType +name: ICreateSubscriptionSettings +uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' +package: '@microsoft/sp-list-subscription!' +fullName: ICreateSubscriptionSettings +summary: >- + A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a web, + you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you will need + to provide it as well. + + + In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and + the current domain, site and web will be used. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: callbacks + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' + package: '@microsoft/sp-list-subscription!' + fullName: callbacks + summary: the list of callbacks + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'callbacks: ISubscriptionCallbacks;' + return: + type: '' + - name: domain + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' + package: '@microsoft/sp-list-subscription!' + fullName: domain + summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'domain?: string;' + return: + type: string + - name: listId + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' + package: '@microsoft/sp-list-subscription!' + fullName: listId + summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listId?: Guid;' + return: + type: '' + - name: siteId + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' + package: '@microsoft/sp-list-subscription!' + fullName: siteId + summary: >- + The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current + site will be used. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'siteId?: Guid;' + return: + type: '' + - name: webId + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' + package: '@microsoft/sp-list-subscription!' + fullName: webId + summary: >- + The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web + will be used. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'webId?: Guid;' + return: + type: '' diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index 0d18dc0a..8d7a766d 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IListSubscription -uid: '@microsoft/sp-list-subscription!IListSubscription:interface' -package: '@microsoft/sp-list-subscription!' -fullName: IListSubscription -summary: A subscription to a SharePoint list resource. Contains the id of the subscription. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' - package: '@microsoft/sp-list-subscription!' - fullName: id - summary: The id of the subscription. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: Guid;' - return: - type: '' +### YamlMime:TSType +name: IListSubscription +uid: '@microsoft/sp-list-subscription!IListSubscription:interface' +package: '@microsoft/sp-list-subscription!' +fullName: IListSubscription +summary: A subscription to a SharePoint list resource. Contains the id of the subscription. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' + package: '@microsoft/sp-list-subscription!' + fullName: id + summary: The id of the subscription. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: Guid;' + return: + type: '' diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index c2502315..e3bc71d8 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -1,47 +1,47 @@ -### YamlMime:TSType -name: ISubscriptionCallbacks -uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' -package: '@microsoft/sp-list-subscription!' -fullName: ISubscriptionCallbacks -summary: The callbacks that can be triggered by a subscription event. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: connect - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' - package: '@microsoft/sp-list-subscription!' - fullName: connect - summary: The callback to invoke when a connection has been made to the list. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'connect?: () => void;' - return: - type: () => void - - name: disconnect - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' - package: '@microsoft/sp-list-subscription!' - fullName: disconnect - summary: The callback to invoke when the subscription is disconnected from the list. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disconnect?: (reason: string) => void;' - return: - type: '(reason: string) => void' - - name: notification - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' - package: '@microsoft/sp-list-subscription!' - fullName: notification - summary: The callback to invoke when a change occurs in the list. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'notification: () => void;' - return: - type: () => void +### YamlMime:TSType +name: ISubscriptionCallbacks +uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' +package: '@microsoft/sp-list-subscription!' +fullName: ISubscriptionCallbacks +summary: The callbacks that can be triggered by a subscription event. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: connect + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' + package: '@microsoft/sp-list-subscription!' + fullName: connect + summary: The callback to invoke when a connection has been made to the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'connect?: () => void;' + return: + type: () => void + - name: disconnect + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' + package: '@microsoft/sp-list-subscription!' + fullName: disconnect + summary: The callback to invoke when the subscription is disconnected from the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disconnect?: (reason: string) => void;' + return: + type: '(reason: string) => void' + - name: notification + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' + package: '@microsoft/sp-list-subscription!' + fullName: notification + summary: The callback to invoke when a change occurs in the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'notification: () => void;' + return: + type: () => void diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index 178ca96a..0c147391 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -1,62 +1,62 @@ -### YamlMime:TSType -name: ListSubscriptionFactory -uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' -package: '@microsoft/sp-list-subscription!' -fullName: ListSubscriptionFactory -summary: >- - Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the - subscription to handle subscription events. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(component) - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' - package: '@microsoft/sp-list-subscription!' - fullName: (constructor)(component) - summary: Constructs a new instance of the `ListSubscriptionFactory` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(component: BaseComponent);' - parameters: - - id: component - description: '' - type: '' -methods: - - name: createSubscription(settings) - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' - package: '@microsoft/sp-list-subscription!' - fullName: createSubscription(settings) - summary: Creates a connection to the list specified by the site id and list id. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'createSubscription(settings: ICreateSubscriptionSettings): Promise;' - parameters: - - id: settings - description: The various parameters - type: '' - return: - type: 'Promise<>' - description: Promise of the subscription to the list. - - name: deleteSubscription(subscription) - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' - package: '@microsoft/sp-list-subscription!' - fullName: deleteSubscription(subscription) - summary: Deletes the subscription's connection to the resource. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'deleteSubscription(subscription: IListSubscription): void;' - parameters: - - id: subscription - description: The subscription to delete. - type: '' - return: - type: void - description: '' +### YamlMime:TSType +name: ListSubscriptionFactory +uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' +package: '@microsoft/sp-list-subscription!' +fullName: ListSubscriptionFactory +summary: >- + Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the + subscription to handle subscription events. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(component) + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' + package: '@microsoft/sp-list-subscription!' + fullName: (constructor)(component) + summary: Constructs a new instance of the `ListSubscriptionFactory` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(component: BaseComponent);' + parameters: + - id: component + description: '' + type: '' +methods: + - name: createSubscription(settings) + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' + package: '@microsoft/sp-list-subscription!' + fullName: createSubscription(settings) + summary: Creates a connection to the list specified by the site id and list id. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'createSubscription(settings: ICreateSubscriptionSettings): Promise;' + parameters: + - id: settings + description: The various parameters + type: '' + return: + type: 'Promise<>' + description: Promise of the subscription to the list. + - name: deleteSubscription(subscription) + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' + package: '@microsoft/sp-list-subscription!' + fullName: deleteSubscription(subscription) + summary: Deletes the subscription's connection to the resource. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'deleteSubscription(subscription: IListSubscription): void;' + parameters: + - id: subscription + description: The subscription to delete. + type: '' + return: + type: void + description: '' diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index cb399011..8bdfd93f 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -1,20 +1,20 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-listview-extensibility!' -name: '@microsoft/sp-listview-extensibility' -type: package -summary: SharePoint Framework support for customizing the list view. -classes: - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - - '@microsoft/sp-listview-extensibility!Command:class' - - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - - '@microsoft/sp-listview-extensibility!RowAccessor:class' - - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' -interfaces: - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-listview-extensibility!' +name: '@microsoft/sp-listview-extensibility' +type: package +summary: SharePoint Framework support for customizing the list view. +classes: + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + - '@microsoft/sp-listview-extensibility!Command:class' + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - '@microsoft/sp-listview-extensibility!RowAccessor:class' + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' +interfaces: + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index a14e3f11..1b157fff 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -1,67 +1,67 @@ -### YamlMime:TSType -name: BaseFieldCustomizer -uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: BaseFieldCustomizer -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that customizes the - appearance of fields in a SharePoint ListView. - - - In the component manifest, the "extensionType" should be set to "FieldCustomizer". -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: false - isDeprecated: false - syntax: - content: 'protected readonly context: FieldCustomizerContext;' - return: - type: '' -methods: - - name: onDisposeCell(event) - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: onDisposeCell(event) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' - parameters: - - id: event - description: '' - type: '' - return: - type: void - description: '' - - name: onRenderCell(event) - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: onRenderCell(event) - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' - parameters: - - id: event - description: '' - type: '' - return: - type: void - description: '' -extends: '<TProperties> ' +### YamlMime:TSType +name: BaseFieldCustomizer +uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: BaseFieldCustomizer +summary: >- + This is the base class that third parties should extend when implementing a client-side extension that customizes the + appearance of fields in a SharePoint ListView. + + + In the component manifest, the "extensionType" should be set to "FieldCustomizer". +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'protected readonly context: FieldCustomizerContext;' + return: + type: '' +methods: + - name: onDisposeCell(event) + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: onDisposeCell(event) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' + parameters: + - id: event + description: '' + type: '' + return: + type: void + description: '' + - name: onRenderCell(event) + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: onRenderCell(event) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' + parameters: + - id: event + description: '' + type: '' + return: + type: void + description: '' +extends: '<TProperties> ' diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 90bbceca..81ed0d8b 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -1,90 +1,88 @@ -### YamlMime:TSType -name: BaseListViewCommandSet -uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: BaseListViewCommandSet -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that provides a - command set for a SharePoint list view. -remarks: >- - In the component manifest, the "extensionType" should be set to "ListViewCommandSet". - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseListViewCommandSet` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly context: ListViewCommandSetContext;' - return: - type: '' -methods: - - name: onExecute(event) - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: onExecute(event) - summary: >- - This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. - virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' - parameters: - - id: event - description: '' - type: '' - return: - type: void - description: '' - - name: onListViewUpdated(event) - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: onListViewUpdated(event) - summary: This event occurs whenever the ListView state changes. virtual - remarks: >- - This event allows the implementor to tailor the appearance of the command. For example, to hide the command, - assign its property visible = false. To customize the title, modify the command property title. - isPreview: false - isDeprecated: false - syntax: - content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' - parameters: - - id: event - description: '' - type: '' - return: - type: void - description: '' - - name: tryGetCommand(id) - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: tryGetCommand(id) - summary: Returns the command with the given id. Returns undefined if there is not command with the given id. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetCommand(id: string): Command;' - parameters: - - id: id - description: Id of the command - type: string - return: - type: '' - description: '' -extends: '<TProperties> ' +### YamlMime:TSType +name: BaseListViewCommandSet +uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: BaseListViewCommandSet +summary: >- + This is the base class that third parties should extend when implementing a client-side extension that provides a + command set for a SharePoint list view. +remarks: >- + In the component manifest, the "extensionType" should be set to "ListViewCommandSet". + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseListViewCommandSet` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly context: ListViewCommandSetContext;' + return: + type: '' +methods: + - name: onExecute(event) + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: onExecute(event) + summary: >- + This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. + virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' + parameters: + - id: event + description: '' + type: '' + return: + type: void + description: '' + - name: onListViewUpdated(event) + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: onListViewUpdated(event) + summary: This event occurs whenever the ListView state changes. virtual + remarks: This event allows the implementor to tailor the visibility of the command. + isPreview: false + isDeprecated: false + syntax: + content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' + parameters: + - id: event + description: '' + type: '' + return: + type: void + description: '' + - name: tryGetCommand(id) + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: tryGetCommand(id) + summary: Returns the command with the given id. Returns undefined if there is not command with the given id. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetCommand(id: string): Command;' + parameters: + - id: id + description: Id of the command + type: string + return: + type: '' + description: '' +extends: '<TProperties> ' diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index a86759d1..8d62ec6f 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -1,44 +1,44 @@ -### YamlMime:TSType -name: ColumnAccessor -uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ColumnAccessor -summary: 'Provides access to a ListView column, which is the visual presentation of a field.' -remarks: >- - A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item represents a - document, then the field is sometimes called a "property".) - - - A "column" is the visual presentation of a field, when displayed by the ListView. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ColumnAccessor` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: field - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: field - summary: The server-side definition of the field. This property is read-only. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get field(): SPField;' - return: - type: '' - - name: visible - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: visible - summary: Whether to show this column in the list view. This property is read-only. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get visible(): boolean;' - return: - type: boolean +### YamlMime:TSType +name: ColumnAccessor +uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ColumnAccessor +summary: 'Provides access to a ListView column, which is the visual presentation of a field.' +remarks: >- + A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item represents a + document, then the field is sometimes called a "property".) + + + A "column" is the visual presentation of a field, when displayed by the ListView. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ColumnAccessor` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: field + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: field + summary: The server-side definition of the field. This property is read-only. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get field(): SPField;' + return: + type: '' + - name: visible + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: visible + summary: Whether to show this column in the list view. This property is read-only. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get visible(): boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 6dc83137..2b498d34 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -1,88 +1,88 @@ -### YamlMime:TSType -name: Command -uid: '@microsoft/sp-listview-extensibility!Command:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: Command -summary: Represents a command belonging to a command set. -remarks: >- - The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, - context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the - corresponding Command object can be obtained by calling - [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not - contextually relevant, or to pluralize the title based on the number of selected items. -isPreview: false -isDeprecated: false -type: class -properties: - - name: ariaLabel - uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: ariaLabel - summary: >- - Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by - default. Example: "Show information. Press ENTER to select." - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel: string | undefined;' - return: - type: string | undefined - - name: iconImageUrl - uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: iconImageUrl - summary: >- - An optional URL for an image to be displayed next to the command. The requirements for this image are defined by - the type of extension; some extension types may not display the image at all. - remarks: This must be a absolute URL. - isPreview: false - isDeprecated: false - syntax: - content: 'iconImageUrl: string | undefined;' - return: - type: string | undefined - - name: id - uid: '@microsoft/sp-listview-extensibility!Command#id:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: id - summary: Id of the command. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-listview-extensibility!Command#title:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: title - summary: 'A short label to be displayed by the associated button, menu item, etc.' - remarks: >- - Example: "Show information" - - - Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or - toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically - alters the meaning of the command, because administrators should be able to examine the extension manifest to - understand which commands are being implemented by a given extension. - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string - - name: visible - uid: '@microsoft/sp-listview-extensibility!Command#visible:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: visible - summary: True if the command is visible. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'visible: boolean;' - return: - type: boolean +### YamlMime:TSType +name: Command +uid: '@microsoft/sp-listview-extensibility!Command:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: Command +summary: Represents a command belonging to a command set. +remarks: >- + The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, + context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the + corresponding Command object can be obtained by calling + [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not + contextually relevant, or to pluralize the title based on the number of selected items. +isPreview: false +isDeprecated: false +type: class +properties: + - name: ariaLabel + uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: ariaLabel + summary: >- + Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by + default. Example: "Show information. Press ENTER to select." + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel: string | undefined;' + return: + type: string | undefined + - name: iconImageUrl + uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: iconImageUrl + summary: >- + An optional URL for an image to be displayed next to the command. The requirements for this image are defined by + the type of extension; some extension types may not display the image at all. + remarks: This must be a absolute URL. + isPreview: false + isDeprecated: false + syntax: + content: 'iconImageUrl: string | undefined;' + return: + type: string | undefined + - name: id + uid: '@microsoft/sp-listview-extensibility!Command#id:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: id + summary: Id of the command. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-listview-extensibility!Command#title:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: title + summary: 'A short label to be displayed by the associated button, menu item, etc.' + remarks: >- + Example: "Show information" + + + Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or + toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically + alters the meaning of the command, because administrators should be able to examine the extension manifest to + understand which commands are being implemented by a given extension. + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string + - name: visible + uid: '@microsoft/sp-listview-extensibility!Command#visible:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: visible + summary: True if the command is visible. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index af3a9c58..d75ca01b 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -1,44 +1,44 @@ -### YamlMime:TSType -name: FieldCustomizerContext -uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: FieldCustomizerContext -summary: This object provides contextual information for BaseFieldCustomizer. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `FieldCustomizerContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: field - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: field - summary: Provides access to the SharePoint field that the customizer will operate on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get field(): SPField;' - return: - type: '' -methods: - - name: tryGetListView() - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: tryGetListView() - summary: >- - If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific - functionality; otherwise the value is undefined. - remarks: >- - Although the SharePoint list view is the main usage scenario, field customizers can be used by other user - interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. - isPreview: false - isDeprecated: false - syntax: - content: 'tryGetListView(): ListViewAccessor | undefined;' - return: - type: ' | undefined' - description: 'the SharePoint list view, or undefined if there is none.' -extends: '' +### YamlMime:TSType +name: FieldCustomizerContext +uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: FieldCustomizerContext +summary: This object provides contextual information for BaseFieldCustomizer. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `FieldCustomizerContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: field + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: field + summary: Provides access to the SharePoint field that the customizer will operate on. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get field(): SPField;' + return: + type: '' +methods: + - name: tryGetListView() + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: tryGetListView() + summary: >- + If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific + functionality; otherwise the value is undefined. + remarks: >- + Although the SharePoint list view is the main usage scenario, field customizers can be used by other user + interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. + isPreview: false + isDeprecated: false + syntax: + content: 'tryGetListView(): ListViewAccessor | undefined;' + return: + type: ' | undefined' + description: 'the SharePoint list view, or undefined if there is none.' +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index ee42db86..d81701e5 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -1,64 +1,64 @@ -### YamlMime:TSType -name: IFieldCustomizerCellEventParameters -uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IFieldCustomizerCellEventParameters -summary: Event parameters for BaseFieldCustomizer.onRenderCell() -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: domElement - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: domElement - summary: >- - The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is - called. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly domElement: HTMLDivElement;' - return: - type: HTMLDivElement - - name: fieldValue - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: fieldValue - summary: The value of the field being rendered. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly fieldValue: any;' - return: - type: any - - name: listItem - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: listItem - summary: The list item being edited. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly listItem: ListItemAccessor;' - return: - type: '' - - name: userData - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: userData - summary: An implementation defined storage property. - remarks: >- - For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request - to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this - property, and then onDisposeCell() can use this key to find the resource to be freed. - isPreview: false - isDeprecated: false - syntax: - content: 'userData: any;' - return: - type: any +### YamlMime:TSType +name: IFieldCustomizerCellEventParameters +uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IFieldCustomizerCellEventParameters +summary: Event parameters for BaseFieldCustomizer.onRenderCell() +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: domElement + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: domElement + summary: >- + The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is + called. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLDivElement;' + return: + type: HTMLDivElement + - name: fieldValue + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: fieldValue + summary: The value of the field being rendered. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fieldValue: any;' + return: + type: any + - name: listItem + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: listItem + summary: The list item being edited. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly listItem: ListItemAccessor;' + return: + type: '' + - name: userData + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: userData + summary: An implementation defined storage property. + remarks: >- + For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request + to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this + property, and then onDisposeCell() can use this key to find the resource to be freed. + isPreview: false + isDeprecated: false + syntax: + content: 'userData: any;' + return: + type: any diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index d3e11a29..badadd67 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: IListViewCommandSetExecuteEventParameters -uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IListViewCommandSetExecuteEventParameters -summary: >- - Parameters for - [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: itemId - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: itemId - summary: >- - The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component - manifest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly itemId: string;' - return: - type: string - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows - summary: 'The currently selected ListView rows, at the time when the event occurred.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly selectedRows: ReadonlyArray;' - return: - type: 'ReadonlyArray<>' +### YamlMime:TSType +name: IListViewCommandSetExecuteEventParameters +uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IListViewCommandSetExecuteEventParameters +summary: >- + Parameters for + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: itemId + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: itemId + summary: >- + The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component + manifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly itemId: string;' + return: + type: string + - name: selectedRows + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: 'The currently selected ListView rows, at the time when the event occurred.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly selectedRows: ReadonlyArray;' + return: + type: 'ReadonlyArray<>' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index b343e25a..c95c3b25 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -1,25 +1,25 @@ -### YamlMime:TSType -name: IListViewCommandSetListViewUpdatedParameters -uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IListViewCommandSetListViewUpdatedParameters -summary: >- - Parameters for - [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows - summary: 'The currently selected ListView rows, at the time when the event occurred.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly selectedRows: ReadonlyArray;' - return: - type: 'ReadonlyArray<>' +### YamlMime:TSType +name: IListViewCommandSetListViewUpdatedParameters +uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IListViewCommandSetListViewUpdatedParameters +summary: >- + Parameters for + [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: selectedRows + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: 'The currently selected ListView rows, at the time when the event occurred.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly selectedRows: ReadonlyArray;' + return: + type: 'ReadonlyArray<>' diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 544f28b5..9074d0ee 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -1,78 +1,78 @@ -### YamlMime:TSType -name: ListItemAccessor -uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListItemAccessor -summary: >- - When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated - SharePoint list item. -remarks: >- - ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and - retrieve the current values for those fields. In the future, it may also support validation and editing operations. - - - When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the - ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the - associated table row is selected or not. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListItemAccessor` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: fields - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: fields - summary: The SharePoint fields that are currently available in the editor for this list item. - remarks: >- - The set of available fields depends on the editing context. For example, if a list view column is hidden, the - corresponding field definition may not be loaded. Field customizers should not assume that a given field will be - available, even if it is defined in the content type. - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get fields(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' -methods: - - name: getValue(field) - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: getValue(field) - summary: >- - Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as - a string, number, etc. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract getValue(field: SPField): any;' - parameters: - - id: field - description: '' - type: '' - return: - type: any - description: '' - - name: getValueByName(internalName) - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: getValueByName(internalName) - summary: >- - Retrieves the current data value for the field with the specified internal name. The value will be a primitive - JavaScript object such as a string, number, etc. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract getValueByName(internalName: string): any;' - parameters: - - id: internalName - description: '' - type: string - return: - type: any - description: '' +### YamlMime:TSType +name: ListItemAccessor +uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListItemAccessor +summary: >- + When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated + SharePoint list item. +remarks: >- + ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and + retrieve the current values for those fields. In the future, it may also support validation and editing operations. + + + When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the + ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the + associated table row is selected or not. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListItemAccessor` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: fields + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: fields + summary: The SharePoint fields that are currently available in the editor for this list item. + remarks: >- + The set of available fields depends on the editing context. For example, if a list view column is hidden, the + corresponding field definition may not be loaded. Field customizers should not assume that a given field will be + available, even if it is defined in the content type. + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get fields(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' +methods: + - name: getValue(field) + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: getValue(field) + summary: >- + Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as + a string, number, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract getValue(field: SPField): any;' + parameters: + - id: field + description: '' + type: '' + return: + type: any + description: '' + - name: getValueByName(internalName) + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: getValueByName(internalName) + summary: >- + Retrieves the current data value for the field with the specified internal name. The value will be a primitive + JavaScript object such as a string, number, etc. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract getValueByName(internalName: string): any;' + parameters: + - id: internalName + description: '' + type: string + return: + type: any + description: '' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 0be26a82..8a12e559 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -1,60 +1,60 @@ -### YamlMime:TSType -name: ListViewAccessor -uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListViewAccessor -summary: Provides access to a SharePoint ListView control. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListViewAccessor` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: columns - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: columns - summary: 'The columns in associated with this view, including hidden columns.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get columns(): ReadonlyArray;' - return: - type: 'ReadonlyArray<>' -methods: - - name: tryGetColumnByName(internalName) - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: tryGetColumnByName(internalName) - summary: >- - Returns the list view column corresponding to the field with the specified internal name, or undefined if none is - found. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' - parameters: - - id: internalName - description: '' - type: string - return: - type: ' | undefined' - description: '' -events: - - name: selectedRowsChangedEvent - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRowsChangedEvent - summary: Event that gets raised every time the selected items in the list view change. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get selectedRowsChangedEvent(): SPEvent;' - return: - type: >- - <> +### YamlMime:TSType +name: ListViewAccessor +uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListViewAccessor +summary: Provides access to a SharePoint ListView control. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListViewAccessor` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: columns + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: columns + summary: 'The columns in associated with this view, including hidden columns.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract get columns(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' +methods: + - name: tryGetColumnByName(internalName) + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: tryGetColumnByName(internalName) + summary: >- + Returns the list view column corresponding to the field with the specified internal name, or undefined if none is + found. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' + parameters: + - id: internalName + description: '' + type: string + return: + type: ' | undefined' + description: '' +events: + - name: selectedRowsChangedEvent + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRowsChangedEvent + summary: Event that gets raised every time the selected items in the list view change. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get selectedRowsChangedEvent(): SPEvent;' + return: + type: >- + <> diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index 9f0fddb1..66de710a 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -1,38 +1,38 @@ -### YamlMime:TSType -name: ListViewCommandSetContext -uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListViewCommandSetContext -summary: This object provides contextual information for BaseListViewCommandSet. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListViewCommandSetContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: listView - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: listView - summary: Provides access to the ListView control that the customizer will operate on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get listView(): ListViewAccessor;' - return: - type: '' - - name: manifest - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: manifest - summary: Manifest for the client-side component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly manifest: ICommandSetExtensionManifest;' - return: - type: '' -extends: '' +### YamlMime:TSType +name: ListViewCommandSetContext +uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListViewCommandSetContext +summary: This object provides contextual information for BaseListViewCommandSet. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListViewCommandSetContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: listView + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: listView + summary: Provides access to the ListView control that the customizer will operate on. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get listView(): ListViewAccessor;' + return: + type: '' + - name: manifest + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: manifest + summary: Manifest for the client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: ICommandSetExtensionManifest;' + return: + type: '' +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 74b7b7dc..a1792f06 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -1,21 +1,21 @@ -### YamlMime:TSType -name: RowAccessor -uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: RowAccessor -summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' -remarks: >- - A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an array of - values for the associated fields. - - - A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values - for the associated columns. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `RowAccessor` class. -isPreview: false -isDeprecated: false -type: class -extends: '' +### YamlMime:TSType +name: RowAccessor +uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: RowAccessor +summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' +remarks: >- + A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an array of + values for the associated fields. + + + A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values + for the associated columns. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `RowAccessor` class. +isPreview: false +isDeprecated: false +type: class +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 69af1e3d..44757881 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -1,24 +1,24 @@ -### YamlMime:TSType -name: SelectedRowsChangedEventArgs -uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: SelectedRowsChangedEventArgs -summary: Arguments for the selected rows changed event. -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows - summary: The list of rows that were selected in the list view at the time when the event was fired. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'selectedRows: ReadonlyArray;' - return: - type: 'ReadonlyArray<>' -extends: '' +### YamlMime:TSType +name: SelectedRowsChangedEventArgs +uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: SelectedRowsChangedEventArgs +summary: Arguments for the selected rows changed event. +remarks: '' +isPreview: false +isDeprecated: false +type: class +properties: + - name: selectedRows + uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: The list of rows that were selected in the list view at the time when the event was fired. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'selectedRows: ReadonlyArray;' + return: + type: 'ReadonlyArray<>' +extends: '' diff --git a/SP-Framework/sp-loader.yml b/SP-Framework/sp-loader.yml index 651a7ef8..95d6a09c 100644 --- a/SP-Framework/sp-loader.yml +++ b/SP-Framework/sp-loader.yml @@ -1,9 +1,9 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-loader!' -name: '@microsoft/sp-loader' -type: package -summary: The SharePoint Framework loader -interfaces: - - '@microsoft/sp-loader!ILoadScriptOptions:interface' -classes: - - '@microsoft/sp-loader!SPComponentLoader:class' +### YamlMime:TSPackage +uid: '@microsoft/sp-loader!' +name: '@microsoft/sp-loader' +type: package +summary: The SharePoint Framework loader +interfaces: + - '@microsoft/sp-loader!ILoadScriptOptions:interface' +classes: + - '@microsoft/sp-loader!SPComponentLoader:class' diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index 6a8ac03d..8033ab61 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: ILoadScriptOptions -uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' -package: '@microsoft/sp-loader!' -fullName: ILoadScriptOptions -summary: Options for the loadScript() method in ISPComponentLoader -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: globalExportsName - uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' - package: '@microsoft/sp-loader!' - fullName: globalExportsName - summary: 'If set, the loaded script will be stored in a global variable under this name.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'globalExportsName?: string;' - return: - type: string +### YamlMime:TSType +name: ILoadScriptOptions +uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' +package: '@microsoft/sp-loader!' +fullName: ILoadScriptOptions +summary: Options for the loadScript() method in ISPComponentLoader +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: globalExportsName + uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' + package: '@microsoft/sp-loader!' + fullName: globalExportsName + summary: 'If set, the loaded script will be stored in a global variable under this name.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'globalExportsName?: string;' + return: + type: string diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index f72db3dc..a228d6d1 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -1,105 +1,105 @@ -### YamlMime:TSType -name: SPComponentLoader -uid: '@microsoft/sp-loader!SPComponentLoader:class' -package: '@microsoft/sp-loader!' -fullName: SPComponentLoader -summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: getManifests() - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' - package: '@microsoft/sp-loader!' - fullName: getManifests() - summary: Returns static copies of all the manifests. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static getManifests(): IClientSideComponentManifest[];' - return: - type: '[]' - description: '' - - name: loadComponent(manifest) - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' - package: '@microsoft/sp-loader!' - fullName: loadComponent(manifest) - summary: Loads a component from a manifest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static loadComponent(manifest: IClientSideComponentManifest): Promise;' - parameters: - - id: manifest - description: Manifest of the module to load. - type: '' - return: - type: Promise<TComponent> - description: A promise containing the loaded module. - - name: 'loadComponentById(id, version)' - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' - package: '@microsoft/sp-loader!' - fullName: 'loadComponentById(id, version)' - summary: 'Resolve a component id and version, and load it.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static loadComponentById(id: string, version?: string): Promise;' - parameters: - - id: id - description: The id of the component to load. - type: string - - id: version - description: >- - The version of the component to load. If version is not defined, the method will load any version of the - component. - type: string - return: - type: Promise<TComponent> - description: A promise containing the loaded module. - - name: loadCss(url) - uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' - package: '@microsoft/sp-loader!' - fullName: loadCss(url) - summary: Inserts a `` tag for a stylesheet. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static loadCss(url: string): void;' - parameters: - - id: url - description: The CSS file URL. - type: string - return: - type: void - description: '' - - name: 'loadScript(url, options)' - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' - package: '@microsoft/sp-loader!' - fullName: 'loadScript(url, options)' - summary: 'Given a URL, load a script.' - remarks: >- - If a script with a global variable is being loaded, the global variable already exists, and the script fails to - load (because of a syntax error, for example), the original global variable may be returned and an error may not - be propagated. - isPreview: false - isDeprecated: false - syntax: - content: 'static loadScript(url: string, options?: ILoadScriptOptions): Promise;' - parameters: - - id: url - description: The script URL. - type: string - - id: options - description: >- - globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the - global member's name. - type: '' - return: - type: Promise<TModule> - description: A promise containing the loaded module. +### YamlMime:TSType +name: SPComponentLoader +uid: '@microsoft/sp-loader!SPComponentLoader:class' +package: '@microsoft/sp-loader!' +fullName: SPComponentLoader +summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. +remarks: '' +isPreview: false +isDeprecated: false +type: class +methods: + - name: getManifests() + uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' + package: '@microsoft/sp-loader!' + fullName: getManifests() + summary: Returns static copies of all the manifests. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static getManifests(): IClientSideComponentManifest[];' + return: + type: '[]' + description: '' + - name: loadComponent(manifest) + uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' + package: '@microsoft/sp-loader!' + fullName: loadComponent(manifest) + summary: Loads a component from a manifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static loadComponent(manifest: IClientSideComponentManifest): Promise;' + parameters: + - id: manifest + description: Manifest of the module to load. + type: '' + return: + type: Promise<TComponent> + description: A promise containing the loaded module. + - name: 'loadComponentById(id, version)' + uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' + package: '@microsoft/sp-loader!' + fullName: 'loadComponentById(id, version)' + summary: 'Resolve a component id and version, and load it.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static loadComponentById(id: string, version?: string): Promise;' + parameters: + - id: id + description: The id of the component to load. + type: string + - id: version + description: >- + The version of the component to load. If version is not defined, the method will load any version of the + component. + type: string + return: + type: Promise<TComponent> + description: A promise containing the loaded module. + - name: loadCss(url) + uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' + package: '@microsoft/sp-loader!' + fullName: loadCss(url) + summary: Inserts a `` tag for a stylesheet. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static loadCss(url: string): void;' + parameters: + - id: url + description: The CSS file URL. + type: string + return: + type: void + description: '' + - name: 'loadScript(url, options)' + uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' + package: '@microsoft/sp-loader!' + fullName: 'loadScript(url, options)' + summary: 'Given a URL, load a script.' + remarks: >- + If a script with a global variable is being loaded, the global variable already exists, and the script fails to + load (because of a syntax error, for example), the original global variable may be returned and an error may not + be propagated. + isPreview: false + isDeprecated: false + syntax: + content: 'static loadScript(url: string, options?: ILoadScriptOptions): Promise;' + parameters: + - id: url + description: The script URL. + type: string + - id: options + description: >- + globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the + global member's name. + type: '' + return: + type: Promise<TModule> + description: A promise containing the loaded module. diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml index 004c0961..313a6dfa 100644 --- a/SP-Framework/sp-lodash-subset.yml +++ b/SP-Framework/sp-lodash-subset.yml @@ -1,5 +1,5 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-lodash-subset!' -name: '@microsoft/sp-lodash-subset' -type: package -summary: '' +### YamlMime:TSPackage +uid: '@microsoft/sp-lodash-subset!' +name: '@microsoft/sp-lodash-subset' +type: package +summary: '' diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index 22e8e66d..43e6f38c 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -1,27 +1,27 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-module-interfaces!' -name: '@microsoft/sp-module-interfaces' -type: package -summary: '' -interfaces: - - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' - - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!IPath:interface' - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' -enums: - - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' +### YamlMime:TSPackage +uid: '@microsoft/sp-module-interfaces!' +name: '@microsoft/sp-module-interfaces' +type: package +summary: '' +interfaces: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!IPath:interface' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' +enums: + - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index 0758aefb..cba5055e 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -1,171 +1,171 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionManifest -uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IAdaptiveCardExtensionManifest -summary: '' -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: connectedSPFXAppId - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: connectedSPFXAppId - summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'connectedSPFXAppId?: string;' - return: - type: string - - name: connectedTeamsAppId - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: connectedTeamsAppId - summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'connectedTeamsAppId?: string;' - return: - type: string - - name: experimentalData - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' - package: '@microsoft/sp-module-interfaces!' - fullName: experimentalData - summary: An untyped property bag for experimental flags not ready for production. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: |- - experimentalData?: { - [key: string]: any; - }; - return: - type: |- - { - [key: string]: any; - } - - name: hiddenFromToolbox - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' - package: '@microsoft/sp-module-interfaces!' - fullName: hiddenFromToolbox - summary: 'If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.' - remarks: >- - Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By - default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains - 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in - a pre configured way. - isPreview: true - isDeprecated: false - syntax: - content: 'hiddenFromToolbox?: boolean;' - return: - type: boolean - - name: preconfiguredEntries - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries:member' - package: '@microsoft/sp-module-interfaces!' - fullName: preconfiguredEntries - summary: >- - A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, - officeFabricIconFontName, toolbox group name and AdaptiveCardExtension specific custom properties. And there can - be multiple instances of these pre-configured properties. - remarks: >- - This helps support scenarios where an organization may want to present multiple pre-configured entries for a - AdaptiveCardExtension in the Toolbox. Each entry is expected to configure the AdaptiveCardExtension with a - different set of pre-configured properties. A developer may decide to seed some initial values for these - properties but an organization admin can go ahead and customize these properties per the needs of his/her - organization. The properties can also be modified by the author of the page. - - - Usage: help display a AdaptiveCardExtension in the Toolbox, PropertyPane and the initial rendering of the - AdaptiveCardExtension. - - - Type: JSON object - - - Supported values: Array of `IClientSideWebPartManifestEntry` objects. - - - Example: - - - ``` - [{ - "groupId": "5c03119e-3074-46fd-976b-c60198311f70", - "group": { "default": "Other" }, - "title": { "id": "$./ManifestStrings.resx:PrimaryTextL1Template;" }, - "description": { "id": "$./ManifestStrings.resx:PrimaryTextL1TemplateDescription;" }, - "officeFabricIconFontName": "Balloons", - "properties": { - "templateType": "primaryText", - "title": "Primary Text", - "primaryText": "Basic card", - "description": "This is an example.", - "cardSize": "Medium" - } - }] - ``` - isPreview: true - isDeprecated: false - syntax: - content: 'preconfiguredEntries: IAdaptiveCardExtensionManifestEntry[];' - return: - type: >- - <TProperties>[] - - name: supportedHosts - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportedHosts - summary: 'Definition: An array defining what host types are supported' - remarks: 'Usage: Use this array to define all hosts that are supported.' - isPreview: true - isDeprecated: false - syntax: - content: 'supportedHosts?: ReadonlyArray<''Dashboard''>;' - return: - type: ReadonlyArray<'Dashboard'> - - name: supportsThemeVariants - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportsThemeVariants:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportsThemeVariants - summary: 'Definition: If true, this ACE supports and has been tested for theme variants experience.' - remarks: >- - Usage: Use this flag if a ACE supports theme variants and has been tested as such. In order to support theme - variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may - not need to be updated to support theme variants, but should always be tested before enabling this flag. By - default no ACEs support theme variants. - isPreview: true - isDeprecated: false - syntax: - content: 'supportsThemeVariants?: boolean;' - return: - type: boolean - - name: useFallbackWhenPropertiesUpdatedExternally - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#useFallbackWhenPropertiesUpdatedExternally:member' - package: '@microsoft/sp-module-interfaces!' - fullName: useFallbackWhenPropertiesUpdatedExternally - summary: >- - Definition: - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data - is updated by an external source. - If false, the AdaptiveCardExtension data will be deserialized and the - properties of the AdaptiveCardExtension will be updated, onAfterPropertiesUpdatedExternally will be executed. - If - undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and - AdaptiveCardExtensions developed with a SPFx version 1.9 or greater will default to false. - remarks: >- - By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your - AdaptiveCardExtension requires specialized logic, then it is recommended to override - onAfterPropertiesUpdatedExternally. - isPreview: true - isDeprecated: false - syntax: - content: 'useFallbackWhenPropertiesUpdatedExternally?: boolean;' - return: - type: boolean -extends: '' +### YamlMime:TSType +name: IAdaptiveCardExtensionManifest +uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IAdaptiveCardExtensionManifest +summary: '' +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: connectedSPFXAppId + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: connectedSPFXAppId + summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'connectedSPFXAppId?: string;' + return: + type: string + - name: connectedTeamsAppId + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: connectedTeamsAppId + summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'connectedTeamsAppId?: string;' + return: + type: string + - name: experimentalData + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' + package: '@microsoft/sp-module-interfaces!' + fullName: experimentalData + summary: An untyped property bag for experimental flags not ready for production. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + experimentalData?: { + [key: string]: any; + }; + return: + type: |- + { + [key: string]: any; + } + - name: hiddenFromToolbox + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' + package: '@microsoft/sp-module-interfaces!' + fullName: hiddenFromToolbox + summary: 'If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.' + remarks: >- + Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By + default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains + 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in + a pre configured way. + isPreview: true + isDeprecated: false + syntax: + content: 'hiddenFromToolbox?: boolean;' + return: + type: boolean + - name: preconfiguredEntries + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries:member' + package: '@microsoft/sp-module-interfaces!' + fullName: preconfiguredEntries + summary: >- + A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, + officeFabricIconFontName, toolbox group name and AdaptiveCardExtension specific custom properties. And there can + be multiple instances of these pre-configured properties. + remarks: >- + This helps support scenarios where an organization may want to present multiple pre-configured entries for a + AdaptiveCardExtension in the Toolbox. Each entry is expected to configure the AdaptiveCardExtension with a + different set of pre-configured properties. A developer may decide to seed some initial values for these + properties but an organization admin can go ahead and customize these properties per the needs of his/her + organization. The properties can also be modified by the author of the page. + + + Usage: help display a AdaptiveCardExtension in the Toolbox, PropertyPane and the initial rendering of the + AdaptiveCardExtension. + + + Type: JSON object + + + Supported values: Array of `IClientSideWebPartManifestEntry` objects. + + + Example: + + + ``` + [{ + "groupId": "5c03119e-3074-46fd-976b-c60198311f70", + "group": { "default": "Other" }, + "title": { "id": "$./ManifestStrings.resx:PrimaryTextL1Template;" }, + "description": { "id": "$./ManifestStrings.resx:PrimaryTextL1TemplateDescription;" }, + "officeFabricIconFontName": "Balloons", + "properties": { + "templateType": "primaryText", + "title": "Primary Text", + "primaryText": "Basic card", + "description": "This is an example.", + "cardSize": "Medium" + } + }] + ``` + isPreview: true + isDeprecated: false + syntax: + content: 'preconfiguredEntries: IAdaptiveCardExtensionManifestEntry[];' + return: + type: >- + <TProperties>[] + - name: supportedHosts + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportedHosts + summary: 'Definition: An array defining what host types are supported' + remarks: 'Usage: Use this array to define all hosts that are supported.' + isPreview: true + isDeprecated: false + syntax: + content: 'supportedHosts?: ReadonlyArray<''Dashboard''>;' + return: + type: ReadonlyArray<'Dashboard'> + - name: supportsThemeVariants + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportsThemeVariants:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportsThemeVariants + summary: 'Definition: If true, this ACE supports and has been tested for theme variants experience.' + remarks: >- + Usage: Use this flag if a ACE supports theme variants and has been tested as such. In order to support theme + variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may + not need to be updated to support theme variants, but should always be tested before enabling this flag. By + default no ACEs support theme variants. + isPreview: true + isDeprecated: false + syntax: + content: 'supportsThemeVariants?: boolean;' + return: + type: boolean + - name: useFallbackWhenPropertiesUpdatedExternally + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#useFallbackWhenPropertiesUpdatedExternally:member' + package: '@microsoft/sp-module-interfaces!' + fullName: useFallbackWhenPropertiesUpdatedExternally + summary: >- + Definition: - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data + is updated by an external source. - If false, the AdaptiveCardExtension data will be deserialized and the + properties of the AdaptiveCardExtension will be updated, onAfterPropertiesUpdatedExternally will be executed. - If + undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and + AdaptiveCardExtensions developed with a SPFx version 1.9 or greater will default to false. + remarks: >- + By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your + AdaptiveCardExtension requires specialized logic, then it is recommended to override + onAfterPropertiesUpdatedExternally. + isPreview: true + isDeprecated: false + syntax: + content: 'useFallbackWhenPropertiesUpdatedExternally?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index ece55765..21503b75 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -1,237 +1,237 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionManifestEntry -uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IAdaptiveCardExtensionManifestEntry -summary: >- - This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each - pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and - content authors can modify these properties on a need basis. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: cardSize - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member' - package: '@microsoft/sp-module-interfaces!' - fullName: cardSize - summary: >- - Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes - \["Medium", "Large"\] defined in the sp-adaptive-card-base project. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'cardSize: string;' - return: - type: string - - name: dataVersion - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member' - package: '@microsoft/sp-module-interfaces!' - fullName: dataVersion - summary: >- - Definition: Use this field to specify the data version of the pre-configured data provided to the - AdaptiveCardExtension. Note that data version is different from the version field in the manifest. - remarks: >- - The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is - used to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of - your AdaptiveCardExtension for more information. - - - Usage: versioning and evolving the serialized data of the AdaptiveCardExtension - - - Type: string representing a [semantic version](http://semver.org) with only two parts - - - Supported values: MAJOR.MINOR - - - Example: `"1.0"` - isPreview: true - isDeprecated: false - syntax: - content: 'dataVersion?: string;' - return: - type: string - - name: description - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member' - package: '@microsoft/sp-module-interfaces!' - fullName: description - summary: >- - Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This - value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and - other display areas. - remarks: >- - The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization - admin and page author will have the ability to change this description as per need. - - - Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page. - - - Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. - - - Example: `"A tool for displaying neat information."` - - - ``` - { - "default": "A tool for displaying neat information.", - "en-us": "A tool for displaying neat information.", - "fr-fr": "Un outil d’affichage des informations soignées.", - "zh": "用於顯示整潔資訊的工具。" - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: 'description: ILocalizedString;' - return: - type: '' - - name: groupId - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: groupId - summary: >- - The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The - SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If - the developer fills an id not in the predefined groups, it falls back to Other group. - remarks: |- - Supported values: the GUID from PredefinedGroup list - - Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - isPreview: true - isDeprecated: false - syntax: - content: 'groupId: PredefinedGroup | string;' - return: - type: ' | string' - - name: iconImageUrl - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: iconImageUrl - summary: >- - The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the - URL must be exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). - remarks: >- - If the - [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member) - field does not have a value, this field must have a value. This value can be an absolute URL (e.g. - `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). - In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file - will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced - with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). - - - Supported values: Any absolute URL. - - - Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - isPreview: true - isDeprecated: false - syntax: - content: 'iconImageUrl?: string;' - return: - type: string - - name: officeFabricIconFontName - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: officeFabricIconFontName - summary: >- - The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the - Office 365 icon font file. - remarks: >- - The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has - a value, the - [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member) - field will be ignored. - - - Supported values: Any character name in the Office 365 Icon Font. - - - Example: "graph" - isPreview: true - isDeprecated: false - syntax: - content: 'officeFabricIconFontName?: string;' - return: - type: string - - name: properties - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member' - package: '@microsoft/sp-module-interfaces!' - fullName: properties - summary: >- - Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension - might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and - list title as its properties, and so on. - remarks: >- - The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The - AdaptiveCardExtension developer fully controls the schema for these properties. The AdaptiveCardExtension - developer should follow versioning rules when updating the properties. - - - Usage: rendering of the AdaptiveCardExtension - - - Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - isPreview: true - isDeprecated: false - syntax: - content: 'properties: TProperties;' - return: - type: TProperties - - name: tags - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member' - package: '@microsoft/sp-module-interfaces!' - fullName: tags - summary: >- - This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension - group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the - toolbox. - remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - isPreview: true - isDeprecated: false - syntax: - content: 'tags?: ILocalizedString[];' - return: - type: '[]' - - name: title - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' - package: '@microsoft/sp-module-interfaces!' - fullName: title - summary: >- - Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value - will be displayed to the user in the toolbox. - remarks: >- - This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give an - initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to change - this title as per need. - - - Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page. - - - Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. - - - Example: `"My Webpart"` - - - ``` - { - "default": "My WebPart" - "en-us": "My WebPart", - "fr-fr": "Ma WebPart", - "zh": "我的 web 部件" - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: 'title: ILocalizedString;' - return: - type: '' +### YamlMime:TSType +name: IAdaptiveCardExtensionManifestEntry +uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IAdaptiveCardExtensionManifestEntry +summary: >- + This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each + pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and + content authors can modify these properties on a need basis. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: cardSize + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member' + package: '@microsoft/sp-module-interfaces!' + fullName: cardSize + summary: >- + Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes + \["Medium", "Large"\] defined in the sp-adaptive-card-base project. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'cardSize: string;' + return: + type: string + - name: dataVersion + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member' + package: '@microsoft/sp-module-interfaces!' + fullName: dataVersion + summary: >- + Definition: Use this field to specify the data version of the pre-configured data provided to the + AdaptiveCardExtension. Note that data version is different from the version field in the manifest. + remarks: >- + The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is + used to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of + your AdaptiveCardExtension for more information. + + + Usage: versioning and evolving the serialized data of the AdaptiveCardExtension + + + Type: string representing a [semantic version](http://semver.org) with only two parts + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: true + isDeprecated: false + syntax: + content: 'dataVersion?: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member' + package: '@microsoft/sp-module-interfaces!' + fullName: description + summary: >- + Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This + value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and + other display areas. + remarks: >- + The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization + admin and page author will have the ability to change this description as per need. + + + Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"A tool for displaying neat information."` + + + ``` + { + "default": "A tool for displaying neat information.", + "en-us": "A tool for displaying neat information.", + "fr-fr": "Un outil d’affichage des informations soignées.", + "zh": "用於顯示整潔資訊的工具。" + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: 'description: ILocalizedString;' + return: + type: '' + - name: groupId + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: groupId + summary: >- + The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The + SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If + the developer fills an id not in the predefined groups, it falls back to Other group. + remarks: |- + Supported values: the GUID from PredefinedGroup list + + Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` + isPreview: true + isDeprecated: false + syntax: + content: 'groupId: PredefinedGroup | string;' + return: + type: ' | string' + - name: iconImageUrl + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: iconImageUrl + summary: >- + The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the + URL must be exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). + remarks: >- + If the + [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member) + field does not have a value, this field must have a value. This value can be an absolute URL (e.g. + `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). + In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file + will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). + + + Supported values: Any absolute URL. + + + Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + isPreview: true + isDeprecated: false + syntax: + content: 'iconImageUrl?: string;' + return: + type: string + - name: officeFabricIconFontName + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member' + package: '@microsoft/sp-module-interfaces!' + fullName: officeFabricIconFontName + summary: >- + The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the + Office 365 icon font file. + remarks: >- + The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has + a value, the + [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member) + field will be ignored. + + + Supported values: Any character name in the Office 365 Icon Font. + + + Example: "graph" + isPreview: true + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string;' + return: + type: string + - name: properties + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member' + package: '@microsoft/sp-module-interfaces!' + fullName: properties + summary: >- + Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension + might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and + list title as its properties, and so on. + remarks: >- + The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The + AdaptiveCardExtension developer fully controls the schema for these properties. The AdaptiveCardExtension + developer should follow versioning rules when updating the properties. + + + Usage: rendering of the AdaptiveCardExtension + + + Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` + isPreview: true + isDeprecated: false + syntax: + content: 'properties: TProperties;' + return: + type: TProperties + - name: tags + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member' + package: '@microsoft/sp-module-interfaces!' + fullName: tags + summary: >- + This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension + group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the + toolbox. + remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + isPreview: true + isDeprecated: false + syntax: + content: 'tags?: ILocalizedString[];' + return: + type: '[]' + - name: title + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' + package: '@microsoft/sp-module-interfaces!' + fullName: title + summary: >- + Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value + will be displayed to the user in the toolbox. + remarks: >- + This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give an + initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to change + this title as per need. + + + Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"My Webpart"` + + + ``` + { + "default": "My WebPart" + "en-us": "My WebPart", + "fr-fr": "Ma WebPart", + "zh": "我的 web 部件" + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: 'title: ILocalizedString;' + return: + type: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 1a6f7f69..9ac3e6ed 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -1,27 +1,27 @@ -### YamlMime:TSType -name: IClientSideAssemblyManifest -uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideAssemblyManifest -summary: A library is defined by this manifest. Libraries currently do not have any additional properties. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: rootComponentId - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: rootComponentId - summary: The ID of the component from which the assembly is built. - remarks: |- - Supported values: any GUID - - Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" - isPreview: false - isDeprecated: false - syntax: - content: 'rootComponentId: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IClientSideAssemblyManifest +uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideAssemblyManifest +summary: A library is defined by this manifest. Libraries currently do not have any additional properties. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: rootComponentId + uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: rootComponentId + summary: The ID of the component from which the assembly is built. + remarks: |- + Supported values: any GUID + + Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" + isPreview: false + isDeprecated: false + syntax: + content: 'rootComponentId: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 15d3f089..4c4573ce 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -1,157 +1,157 @@ -### YamlMime:TSType -name: IClientSideComponentLoaderConfiguration -uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideComponentLoaderConfiguration -summary: >- - This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. - It contains all data for loading an entrypoint script and its dependency scripts. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: entryModuleId - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: entryModuleId - summary: This is the ID of one of the entries in the "scriptResources" dictionary. - remarks: >- - The loader will download and evaluate the script resource referenced in this field, resolve all dependencies - against the keys in the "scriptResources", and return the exported object to the loader's calling function. The - entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type. - - - Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the - component. - - - Example: `"myApplication.bundle"` - isPreview: true - isDeprecated: false - syntax: - content: 'entryModuleId: string;' - return: - type: string - - name: exportName - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: exportName - summary: The module referenced by the "entryModuleId" field may export an object with several fields. - remarks: >- - This value optionally references the name of a field on the object exported by the module referenced by the - `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported by - the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of the base - exported object. For example, if entryModuleId refers to a module with with a top-level export of `{ foo: 'bar', - baz: 123 }` and: - - - - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }` - - - - if this field is set to `foo`, the value returned by the module loader is `bar` - - - - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a - key in the top-level export). - - - Example: `mySpWebpart` - isPreview: true - isDeprecated: false - syntax: - content: 'exportName?: string;' - return: - type: string - - name: internalModuleBaseUrls - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' - package: '@microsoft/sp-module-interfaces!' - fullName: internalModuleBaseUrls - summary: >- - This is an array of fully-qualified paths to be prepended to each of the script resource paths with the "internal" - or "localized" type. If one fails to load, the loader will attempt to load from the next until there are no base - paths remaining. - remarks: >- - All "internal" and "localized" script resources that do not have fully-qualified URLs as their "path" field values - must be hosted under each of the paths listed in this property. For example, if an internal module's "path" field - value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's value is `[ - "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first - attempt to load this script resource from the URL - `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading - from that URL fails, the loader will then attempt to load this script resource from - `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL - fails to load, the component will fail to load and an error will be returned. It is important to note that the - support for multiple base URLs is purely for failover support. This means that all files must be present on all - hosts listed in this field. - - - Usage: Base URLs for script resources with the "internal" or "localized" type. - - - Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary. - - - Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` - isPreview: true - isDeprecated: false - syntax: - content: 'internalModuleBaseUrls: string[];' - return: - type: 'string[]' - - name: scriptResources - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' - package: '@microsoft/sp-module-interfaces!' - fullName: scriptResources - summary: >- - This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and - `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` - must contain the component's exported object. - remarks: |- - Supported values: A dictionary of named script resources. - - Example: - - ``` - { - "myApplication.bundle": { - "type": "path", - "path": "master_2015-04-20/my-application.bundle_1928f8a0.js" - }, - "@microsoft/sp-client-base": { - "type": "component", - "id": "af59c2b3-2da7-41fd-8b72-3939817960af", - "version": "latest" - }, - "@microsoft/sp-client-preview": { - "type": "component", - "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e", - "version": "latest" - }, - "jQuery": { - "type": "component", - "id": "00000000-0000-0000-0000-000000000000", - "version": "2.2.4", - "path": "https://code.jquery.com/jquery-2.2.4.min.js" - }, - "myApplication_strings": { - "type": "localizedPath", - "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js", - "paths": { - "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", - "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" - } - } - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: |- - scriptResources: { - [name: string]: IModuleConfiguration; - }; - return: - type: |- - { - [name: string]: ; - } +### YamlMime:TSType +name: IClientSideComponentLoaderConfiguration +uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideComponentLoaderConfiguration +summary: >- + This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. + It contains all data for loading an entrypoint script and its dependency scripts. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: entryModuleId + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: entryModuleId + summary: This is the ID of one of the entries in the "scriptResources" dictionary. + remarks: >- + The loader will download and evaluate the script resource referenced in this field, resolve all dependencies + against the keys in the "scriptResources", and return the exported object to the loader's calling function. The + entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type. + + + Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the + component. + + + Example: `"myApplication.bundle"` + isPreview: true + isDeprecated: false + syntax: + content: 'entryModuleId: string;' + return: + type: string + - name: exportName + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' + package: '@microsoft/sp-module-interfaces!' + fullName: exportName + summary: The module referenced by the "entryModuleId" field may export an object with several fields. + remarks: >- + This value optionally references the name of a field on the object exported by the module referenced by the + `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported by + the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of the base + exported object. For example, if entryModuleId refers to a module with with a top-level export of `{ foo: 'bar', + baz: 123 }` and: + + + - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }` + + + - if this field is set to `foo`, the value returned by the module loader is `bar` + + + - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a + key in the top-level export). + + + Example: `mySpWebpart` + isPreview: true + isDeprecated: false + syntax: + content: 'exportName?: string;' + return: + type: string + - name: internalModuleBaseUrls + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' + package: '@microsoft/sp-module-interfaces!' + fullName: internalModuleBaseUrls + summary: >- + This is an array of fully-qualified paths to be prepended to each of the script resource paths with the "internal" + or "localized" type. If one fails to load, the loader will attempt to load from the next until there are no base + paths remaining. + remarks: >- + All "internal" and "localized" script resources that do not have fully-qualified URLs as their "path" field values + must be hosted under each of the paths listed in this property. For example, if an internal module's "path" field + value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's value is `[ + "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first + attempt to load this script resource from the URL + `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading + from that URL fails, the loader will then attempt to load this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL + fails to load, the component will fail to load and an error will be returned. It is important to note that the + support for multiple base URLs is purely for failover support. This means that all files must be present on all + hosts listed in this field. + + + Usage: Base URLs for script resources with the "internal" or "localized" type. + + + Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary. + + + Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` + isPreview: true + isDeprecated: false + syntax: + content: 'internalModuleBaseUrls: string[];' + return: + type: 'string[]' + - name: scriptResources + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' + package: '@microsoft/sp-module-interfaces!' + fullName: scriptResources + summary: >- + This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and + `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` + must contain the component's exported object. + remarks: |- + Supported values: A dictionary of named script resources. + + Example: + + ``` + { + "myApplication.bundle": { + "type": "path", + "path": "master_2015-04-20/my-application.bundle_1928f8a0.js" + }, + "@microsoft/sp-client-base": { + "type": "component", + "id": "af59c2b3-2da7-41fd-8b72-3939817960af", + "version": "latest" + }, + "@microsoft/sp-client-preview": { + "type": "component", + "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e", + "version": "latest" + }, + "jQuery": { + "type": "component", + "id": "00000000-0000-0000-0000-000000000000", + "version": "2.2.4", + "path": "https://code.jquery.com/jquery-2.2.4.min.js" + }, + "myApplication_strings": { + "type": "localizedPath", + "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js", + "paths": { + "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", + "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" + } + } + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + scriptResources: { + [name: string]: IModuleConfiguration; + }; + return: + type: |- + { + [name: string]: ; + } diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index c54fbbea..97e12c09 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -1,167 +1,167 @@ -### YamlMime:TSType -name: IClientSideComponentManifest -uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideComponentManifest -summary: >- - All client-side components built on the SharePoint framework need a valid component manifest. This interface - represents properties that are required by all types of client-side components like Applications and Web Parts. - Component specific manifests will extend this interface to add properties required by that component type. -remarks: >- - The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing - this schema. This set of rules can also be called the "manifest upgrade rules". - - - - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that - processes the manifest should be able to handle the absence of those new properties. - - - - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they impose a - migration cost on developers. - - - - The `'manifestVersion'` should be bumped for all small or big changes. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: alias - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' - package: '@microsoft/sp-module-interfaces!' - fullName: alias - summary: >- - A short name usually given by developer. It does not need to be localized and is expected to stay the same through - the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, - `ClientSideApplication.alias` is given precedence over the value provided in the manifest. - remarks: |- - Usage: A short name to identify a client-side component by developer. - - Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. - - Example: `"NewFeed"` - isPreview: false - isDeprecated: false - syntax: - content: 'alias: string;' - return: - type: string - - name: componentType - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' - package: '@microsoft/sp-module-interfaces!' - fullName: componentType - summary: >- - Type of client-side component. Components with the "Application" type are defined by the - "IClientSideApplicationManifest" interface. Components with the "WebPart" type are defined by the - "IClientSideWebPartManifest" interface. Components with the "Library" type are defined by the - "IClientSideLibraryManifest" interface. Components with the "AdaptiveCardExtension" type are defined by the - "IAdaptiveCardExtensionManifest" interface. - remarks: >- - Usage: To help bundling, loading, enumeration, and initialization of components based on their contents. - - - Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, - `"AdaptiveCardExtension"` - isPreview: false - isDeprecated: false - syntax: - content: 'componentType: ComponentType;' - return: - type: '' - - name: loaderConfig - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' - package: '@microsoft/sp-module-interfaces!' - fullName: loaderConfig - summary: >- - This portion of the configuration describes how the component is to be loaded and initialized by a client. It - contains an enumeration of scripts that the component requires along with a single entry point script. - remarks: |- - Usage: Loading a component. - - See `IClientSideComponentLoaderConfiguration` for more information and examples. - isPreview: true - isDeprecated: false - syntax: - content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' - return: - type: '' - - name: loadLegacyFabricCss - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' - package: '@microsoft/sp-module-interfaces!' - fullName: loadLegacyFabricCss - summary: >- - This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts - build after using spfx 1.1 don't need this. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'loadLegacyFabricCss?: boolean;' - return: - type: boolean - - name: requiresCustomScript - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' - package: '@microsoft/sp-module-interfaces!' - fullName: requiresCustomScript - summary: >- - If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true - if the component allows authors to execute arbitrary scripts on the page. - remarks: >- - Defaults to false. See - https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f - for more information. - - - Usage: Requires Custom Script to be allowed in order for this component to be installed and run. - isPreview: false - isDeprecated: false - syntax: - content: 'requiresCustomScript?: boolean;' - return: - type: boolean - - name: safeWithCustomScriptDisabled - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' - package: '@microsoft/sp-module-interfaces!' - fullName: safeWithCustomScriptDisabled - summary: This property is provided for backwards compatibility. It no longer has any effect. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. - syntax: - content: 'safeWithCustomScriptDisabled?: boolean;' - return: - type: boolean - - name: version - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' - package: '@microsoft/sp-module-interfaces!' - fullName: version - summary: >- - Client-side component version. The value of this field is expected to be controlled by the developer of the - client-side component. - remarks: >- - The purpose of this field is to help client-side component developers upgrade their client-side components in a - managed way. This helps the consumers of the client-side component make decisions about when and how to upgrade - the client-side component. As the developer evolves the code for their client-side component, they can decide to - bump the MAJOR, MINOR or PATCH version of the component. - - - All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes - should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. - Please see [http://semver.org](http://semver.org) for more details on how to manage the version of your - components. - - - Usage: Versioning and evolving a client-side component safely in a controlled way. - - - Supported values: string representing a [semantic version](http://semver.org) i.e. MAJOR.MINOR.PATCH - - - Example: `"1.0.0"` - isPreview: false - isDeprecated: false - syntax: - content: 'version: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IClientSideComponentManifest +uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideComponentManifest +summary: >- + All client-side components built on the SharePoint framework need a valid component manifest. This interface + represents properties that are required by all types of client-side components like Applications and Web Parts. + Component specific manifests will extend this interface to add properties required by that component type. +remarks: >- + The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing + this schema. This set of rules can also be called the "manifest upgrade rules". + + + - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that + processes the manifest should be able to handle the absence of those new properties. + + + - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they impose a + migration cost on developers. + + + - The `'manifestVersion'` should be bumped for all small or big changes. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: alias + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' + package: '@microsoft/sp-module-interfaces!' + fullName: alias + summary: >- + A short name usually given by developer. It does not need to be localized and is expected to stay the same through + the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, + `ClientSideApplication.alias` is given precedence over the value provided in the manifest. + remarks: |- + Usage: A short name to identify a client-side component by developer. + + Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. + + Example: `"NewFeed"` + isPreview: false + isDeprecated: false + syntax: + content: 'alias: string;' + return: + type: string + - name: componentType + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' + package: '@microsoft/sp-module-interfaces!' + fullName: componentType + summary: >- + Type of client-side component. Components with the "Application" type are defined by the + "IClientSideApplicationManifest" interface. Components with the "WebPart" type are defined by the + "IClientSideWebPartManifest" interface. Components with the "Library" type are defined by the + "IClientSideLibraryManifest" interface. Components with the "AdaptiveCardExtension" type are defined by the + "IAdaptiveCardExtensionManifest" interface. + remarks: >- + Usage: To help bundling, loading, enumeration, and initialization of components based on their contents. + + + Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, + `"AdaptiveCardExtension"` + isPreview: false + isDeprecated: false + syntax: + content: 'componentType: ComponentType;' + return: + type: '' + - name: loaderConfig + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' + package: '@microsoft/sp-module-interfaces!' + fullName: loaderConfig + summary: >- + This portion of the configuration describes how the component is to be loaded and initialized by a client. It + contains an enumeration of scripts that the component requires along with a single entry point script. + remarks: |- + Usage: Loading a component. + + See `IClientSideComponentLoaderConfiguration` for more information and examples. + isPreview: true + isDeprecated: false + syntax: + content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' + return: + type: '' + - name: loadLegacyFabricCss + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' + package: '@microsoft/sp-module-interfaces!' + fullName: loadLegacyFabricCss + summary: >- + This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts + build after using spfx 1.1 don't need this. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'loadLegacyFabricCss?: boolean;' + return: + type: boolean + - name: requiresCustomScript + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' + package: '@microsoft/sp-module-interfaces!' + fullName: requiresCustomScript + summary: >- + If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true + if the component allows authors to execute arbitrary scripts on the page. + remarks: >- + Defaults to false. See + https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f + for more information. + + + Usage: Requires Custom Script to be allowed in order for this component to be installed and run. + isPreview: false + isDeprecated: false + syntax: + content: 'requiresCustomScript?: boolean;' + return: + type: boolean + - name: safeWithCustomScriptDisabled + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' + package: '@microsoft/sp-module-interfaces!' + fullName: safeWithCustomScriptDisabled + summary: This property is provided for backwards compatibility. It no longer has any effect. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. + syntax: + content: 'safeWithCustomScriptDisabled?: boolean;' + return: + type: boolean + - name: version + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' + package: '@microsoft/sp-module-interfaces!' + fullName: version + summary: >- + Client-side component version. The value of this field is expected to be controlled by the developer of the + client-side component. + remarks: >- + The purpose of this field is to help client-side component developers upgrade their client-side components in a + managed way. This helps the consumers of the client-side component make decisions about when and how to upgrade + the client-side component. As the developer evolves the code for their client-side component, they can decide to + bump the MAJOR, MINOR or PATCH version of the component. + + + All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes + should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. + Please see [http://semver.org](http://semver.org) for more details on how to manage the version of your + components. + + + Usage: Versioning and evolving a client-side component safely in a controlled way. + + + Supported values: string representing a [semantic version](http://semver.org) i.e. MAJOR.MINOR.PATCH + + + Example: `"1.0.0"` + isPreview: false + isDeprecated: false + syntax: + content: 'version: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index 461234d2..c755266f 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -1,26 +1,26 @@ -### YamlMime:TSType -name: IClientSideExtensionManifest -uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideExtensionManifest -summary: This is the manifest for a client-side extension. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: extensionType - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' - package: '@microsoft/sp-module-interfaces!' - fullName: extensionType - summary: >- - Specifies the type of client-side extension. Some extension types support additional manifest fields beyond - SPClientSideExtensionManifest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'extensionType: ExtensionType;' - return: - type: '' -extends: '' +### YamlMime:TSType +name: IClientSideExtensionManifest +uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideExtensionManifest +summary: This is the manifest for a client-side extension. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: extensionType + uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' + package: '@microsoft/sp-module-interfaces!' + fullName: extensionType + summary: >- + Specifies the type of client-side extension. Some extension types support additional manifest fields beyond + SPClientSideExtensionManifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'extensionType: ExtensionType;' + return: + type: '' +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index bac9d402..91c3bfe8 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IClientSideLibraryManifest -uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideLibraryManifest -summary: A library is defined by this manifest. Libraries currently do not have any additional properties. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: IClientSideLibraryManifest +uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideLibraryManifest +summary: A library is defined by this manifest. Libraries currently do not have any additional properties. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index e84cf0ca..87467a27 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -1,61 +1,61 @@ -### YamlMime:TSType -name: IClientSideManifestBase -uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideManifestBase -summary: This interface defines members that are common between all deployable manifests. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' - package: '@microsoft/sp-module-interfaces!' - fullName: id - summary: >- - A universally unique component id. Each client-side component is required to have this id. Once an id has been - used for a component, it cannot be changed. A change in this value is treated same as the creation of a new - component. Two components are never expected to have the same id. - - - Usage: Uniquely identify a client-side component. - - - Supported values: a GUID string - - - Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string - - name: manifestVersion - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' - package: '@microsoft/sp-module-interfaces!' - fullName: manifestVersion - summary: >- - Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this - field is to help manage upgrades of the component manifest schema. - remarks: >- - A component developer needs to only confirm that they are using the correct value per the manifest schema. Please - read the "manifest upgrade rules" for more details on when the schema could change. Note, manifest schema version - upgrade will be considered a big API change event and will be advertised broadly. - - - Usage: To help support multiple manifest schema versions. - - - Supported values: A positive integer. - - - Example: `1` - isPreview: false - isDeprecated: false - syntax: - content: 'manifestVersion: number;' - return: - type: number +### YamlMime:TSType +name: IClientSideManifestBase +uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideManifestBase +summary: This interface defines members that are common between all deployable manifests. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' + package: '@microsoft/sp-module-interfaces!' + fullName: id + summary: >- + A universally unique component id. Each client-side component is required to have this id. Once an id has been + used for a component, it cannot be changed. A change in this value is treated same as the creation of a new + component. Two components are never expected to have the same id. + + + Usage: Uniquely identify a client-side component. + + + Supported values: a GUID string + + + Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: manifestVersion + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' + package: '@microsoft/sp-module-interfaces!' + fullName: manifestVersion + summary: >- + Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this + field is to help manage upgrades of the component manifest schema. + remarks: >- + A component developer needs to only confirm that they are using the correct value per the manifest schema. Please + read the "manifest upgrade rules" for more details on when the schema could change. Note, manifest schema version + upgrade will be considered a big API change event and will be advertised broadly. + + + Usage: To help support multiple manifest schema versions. + + + Supported values: A positive integer. + + + Example: `1` + isPreview: false + isDeprecated: false + syntax: + content: 'manifestVersion: number;' + return: + type: number diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 8286f396..0dec5d01 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -1,170 +1,170 @@ -### YamlMime:TSType -name: IClientSideWebPartManifest -uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideWebPartManifest -summary: >- - The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a - manifest. -remarks: >- - The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to identify, - load and process a Web Part. The schema for this manifest is completely owned and versioned by Microsoft. There are - some required properties in the manifest and some optional properties. Optional properties need to be provided only if - the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and - functionality problems. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: canUpdateConfiguration - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' - package: '@microsoft/sp-module-interfaces!' - fullName: canUpdateConfiguration - summary: Indicates whether the web part uses the property pane to update the configuration of the web part. - remarks: Default value is `true` if the property is not explicitly defined. - isPreview: false - isDeprecated: false - syntax: - content: 'canUpdateConfiguration?: boolean;' - return: - type: boolean - - name: disabledOnClassicSharepoint - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' - package: '@microsoft/sp-module-interfaces!' - fullName: disabledOnClassicSharepoint - summary: 'If true, this web part is disabled on SharePoint classic pages' - remarks: >- - Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If - this flag is true, the web part will not appear in the classic page web part gallery. - isPreview: false - isDeprecated: false - syntax: - content: 'disabledOnClassicSharepoint?: boolean;' - return: - type: boolean - - name: hiddenFromToolbox - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' - package: '@microsoft/sp-module-interfaces!' - fullName: hiddenFromToolbox - summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' - remarks: >- - Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not - used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts - can be provisioned on pages though API or be added to the page in a pre configured way. - isPreview: false - isDeprecated: false - syntax: - content: 'hiddenFromToolbox?: boolean;' - return: - type: boolean - - name: imagePreviewUrl - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: imagePreviewUrl - summary: 'Definition: Url of the image image used for preview' - remarks: >- - Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web - part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module - url - isPreview: false - isDeprecated: false - syntax: - content: 'imagePreviewUrl?: string;' - return: - type: string - - name: preconfiguredEntries - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' - package: '@microsoft/sp-module-interfaces!' - fullName: preconfiguredEntries - summary: >- - A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part - specific custom properties. And there can be multiple instances of these pre-configured properties. - remarks: >- - This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web - Part in the Toolbox. Each entry is expected to configure the Web Part with a different set of pre-configured - properties. A developer may decide to seed some initial values for these properties but an organization admin can - go ahead and customize these properties per the needs of his/her organization. The properties can also be modified - by the author of the page. - - - Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. - - - Type: JSON object - - - Supported values: Array of `IClientSideWebPartManifestEntry` objects. - - - Example: - - - ``` - [{ - title:"Image Web Part", - description: "This Web Part displays an image", - group: "Media", - iconFontName: "image", - properties: { - imageSource: "https://contoso.akamaihd.net/files/mountRainier.jpg", - captionText: "Mount Rainier" - } - }] - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' - return: - type: '<TProperties>[]' - - name: supportedHosts - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportedHosts - summary: 'Definition: An array defining what host types are supported' - remarks: >- - Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is - provided. If SharePointFullPage is added the solution will be available when adding full page apps. If - SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, - TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp - cannot be used with TeamsTab or TeamsPersonalTab. - isPreview: false - isDeprecated: false - syntax: - content: >- - supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | - 'TeamsMeetingApp'>; - return: - type: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> - - name: supportsFullBleed - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportsFullBleed - summary: 'Definition: If true, this web part supports and has been tested for full bleed experience.' - remarks: >- - Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, - full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed - experiences require special treatment and testing. By default no web parts support full bleed experiences. - isPreview: false - isDeprecated: false - syntax: - content: 'supportsFullBleed?: boolean;' - return: - type: boolean - - name: supportsThemeVariants - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportsThemeVariants - summary: 'Definition: If true, this web part supports and has been tested for theme variants experience.' - remarks: >- - Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme - variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may - or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By - default no web parts support theme variants. - isPreview: false - isDeprecated: false - syntax: - content: 'supportsThemeVariants?: boolean;' - return: - type: boolean -extends: '' +### YamlMime:TSType +name: IClientSideWebPartManifest +uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideWebPartManifest +summary: >- + The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a + manifest. +remarks: >- + The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to identify, + load and process a Web Part. The schema for this manifest is completely owned and versioned by Microsoft. There are + some required properties in the manifest and some optional properties. Optional properties need to be provided only if + the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and + functionality problems. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: canUpdateConfiguration + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' + package: '@microsoft/sp-module-interfaces!' + fullName: canUpdateConfiguration + summary: Indicates whether the web part uses the property pane to update the configuration of the web part. + remarks: Default value is `true` if the property is not explicitly defined. + isPreview: false + isDeprecated: false + syntax: + content: 'canUpdateConfiguration?: boolean;' + return: + type: boolean + - name: disabledOnClassicSharepoint + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' + package: '@microsoft/sp-module-interfaces!' + fullName: disabledOnClassicSharepoint + summary: 'If true, this web part is disabled on SharePoint classic pages' + remarks: >- + Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If + this flag is true, the web part will not appear in the classic page web part gallery. + isPreview: false + isDeprecated: false + syntax: + content: 'disabledOnClassicSharepoint?: boolean;' + return: + type: boolean + - name: hiddenFromToolbox + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' + package: '@microsoft/sp-module-interfaces!' + fullName: hiddenFromToolbox + summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' + remarks: >- + Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not + used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts + can be provisioned on pages though API or be added to the page in a pre configured way. + isPreview: false + isDeprecated: false + syntax: + content: 'hiddenFromToolbox?: boolean;' + return: + type: boolean + - name: imagePreviewUrl + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: imagePreviewUrl + summary: 'Definition: Url of the image image used for preview' + remarks: >- + Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web + part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module + url + isPreview: false + isDeprecated: false + syntax: + content: 'imagePreviewUrl?: string;' + return: + type: string + - name: preconfiguredEntries + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' + package: '@microsoft/sp-module-interfaces!' + fullName: preconfiguredEntries + summary: >- + A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part + specific custom properties. And there can be multiple instances of these pre-configured properties. + remarks: >- + This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web + Part in the Toolbox. Each entry is expected to configure the Web Part with a different set of pre-configured + properties. A developer may decide to seed some initial values for these properties but an organization admin can + go ahead and customize these properties per the needs of his/her organization. The properties can also be modified + by the author of the page. + + + Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. + + + Type: JSON object + + + Supported values: Array of `IClientSideWebPartManifestEntry` objects. + + + Example: + + + ``` + [{ + title:"Image Web Part", + description: "This Web Part displays an image", + group: "Media", + iconFontName: "image", + properties: { + imageSource: "https://contoso.akamaihd.net/files/mountRainier.jpg", + captionText: "Mount Rainier" + } + }] + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' + return: + type: '<TProperties>[]' + - name: supportedHosts + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportedHosts + summary: 'Definition: An array defining what host types are supported' + remarks: >- + Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is + provided. If SharePointFullPage is added the solution will be available when adding full page apps. If + SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, + TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp + cannot be used with TeamsTab or TeamsPersonalTab. + isPreview: false + isDeprecated: false + syntax: + content: >- + supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | + 'TeamsMeetingApp'>; + return: + type: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> + - name: supportsFullBleed + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportsFullBleed + summary: 'Definition: If true, this web part supports and has been tested for full bleed experience.' + remarks: >- + Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, + full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed + experiences require special treatment and testing. By default no web parts support full bleed experiences. + isPreview: false + isDeprecated: false + syntax: + content: 'supportsFullBleed?: boolean;' + return: + type: boolean + - name: supportsThemeVariants + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' + package: '@microsoft/sp-module-interfaces!' + fullName: supportsThemeVariants + summary: 'Definition: If true, this web part supports and has been tested for theme variants experience.' + remarks: >- + Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme + variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may + or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By + default no web parts support theme variants. + isPreview: false + isDeprecated: false + syntax: + content: 'supportsThemeVariants?: boolean;' + return: + type: boolean +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 7f18665a..2a58647d 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -1,257 +1,257 @@ -### YamlMime:TSType -name: IClientSideWebPartManifestEntry -uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideWebPartManifestEntry -summary: >- - This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured - instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify - these properties on a need basis. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dataVersion - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' - package: '@microsoft/sp-module-interfaces!' - fullName: dataVersion - summary: >- - Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note - that data version is different from the version field in the manifest. - remarks: >- - The manifest version is used to control the versioning of the web part code, while data version is used to control - the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more - information. - - - Usage: versioning and evolving the serialized data of the web part - - - Type: string representing a [semantic version](http://semver.org) with only two parts - - - Supported values: MAJOR.MINOR - - - Example: `"1.0"` - isPreview: false - isDeprecated: false - syntax: - content: 'dataVersion?: string;' - return: - type: string - - name: description - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' - package: '@microsoft/sp-module-interfaces!' - fullName: description - summary: >- - Description of the web part represented as a dictionary of locale keys to description values. This value will be - displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display - areas. - remarks: >- - The Web Part developer may give an initial description to the web part. The organization admin and page author - will have the ability to change this description as per need. - - - Usage: display the description of the web part in the toolbox tooltip, web part gallery and the page. - - - Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. - - - Example: `"A tool for displaying neat information."` - - - ``` - { - "default": "A tool for displaying neat information.", - "en-us": "A tool for displaying neat information.", - "fr-fr": "Un outil d’affichage des informations soignées.", - "zh": "用於顯示整潔資訊的工具。" - } - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'description: ILocalizedString;' - return: - type: '' - - name: fullPageAppIconImageUrl - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: fullPageAppIconImageUrl - summary: The icon for the Application pages. - remarks: >- - If this field is not defined, then the iconimageurl is used instead as the icon for Full Page apps. This value can - be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. - `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to the folder containing - the input manifest. - - - Supported values: Any absolute URL. - - - Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - isPreview: false - isDeprecated: false - syntax: - content: 'fullPageAppIconImageUrl?: string;' - return: - type: string - - name: group - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' - package: '@microsoft/sp-module-interfaces!' - fullName: group - summary: >- - The group name in web part picker to contain the web part in the classic page. If no value is provided, then the - web part will be displayed in the Miscellaneous group. - remarks: 'Example: `{ "default": "Media and Content" }`' - isPreview: true - isDeprecated: false - syntax: - content: 'group?: ILocalizedString;' - return: - type: '' - - name: groupId - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: groupId - summary: >- - The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework - reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an - id not in the predefined groups, it falls back to Other group. - remarks: |- - Supported values: the GUID from PredefinedGroup list - - Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - isPreview: true - isDeprecated: false - syntax: - content: 'groupId: PredefinedGroup | string;' - return: - type: ' | string' - - name: iconImageUrl - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: iconImageUrl - summary: >- - The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be - exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). - remarks: >- - If the - [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member) - field does not have a value, this field must have a value. This value can be an absolute URL (e.g. - `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). - In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file - will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced - with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). - - - Supported values: Any absolute URL. - - - Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - isPreview: false - isDeprecated: false - syntax: - content: 'iconImageUrl?: string;' - return: - type: string - - name: officeFabricIconFontName - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: officeFabricIconFontName - summary: >- - The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon - font file. - remarks: >- - The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has - a value, the - [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member) - field will be ignored. - - - Supported values: Any character name in the Office 365 Icon Font. - - - Example: "graph" - isPreview: false - isDeprecated: false - syntax: - content: 'officeFabricIconFontName?: string;' - return: - type: string - - name: properties - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' - package: '@microsoft/sp-module-interfaces!' - fullName: properties - summary: >- - Every web part is expected to have some custom properties. For example, an image web part might define properties - for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so - on. - remarks: >- - The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer - fully controls the schema for these properties. The web part developer should follow versioning rules when - updating the properties. - - - Usage: rendering of the web part - - - Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - isPreview: false - isDeprecated: false - syntax: - content: 'properties: TProperties;' - return: - type: TProperties - - name: tags - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' - package: '@microsoft/sp-module-interfaces!' - fullName: tags - summary: >- - This field is used to tag a web part with keywords that are different from the web part group name. Tags can be - used for categorization and searching of web parts. For example, in the web part toolbox. - remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - isPreview: true - isDeprecated: false - syntax: - content: 'tags?: ILocalizedString[];' - return: - type: '[]' - - name: title - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' - package: '@microsoft/sp-module-interfaces!' - fullName: title - summary: >- - Title of the web part represented as a single a dictionary of locale keys to title values. This value will be - displayed to the user in the toolbox. - remarks: >- - This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title - to the web part. The organization admin and page author will have the ability to change this title as per need. - - - Usage: display the name of the web part in the toolbox, web part gallery and the page. - - - Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. - - - Example: `"My Webpart"` - - - ``` - { - "default": "My WebPart" - "en-us": "My WebPart", - "fr-fr": "Ma WebPart", - "zh": "我的 web 部件" - } - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'title: ILocalizedString;' - return: - type: '' +### YamlMime:TSType +name: IClientSideWebPartManifestEntry +uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideWebPartManifestEntry +summary: >- + This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured + instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify + these properties on a need basis. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataVersion + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' + package: '@microsoft/sp-module-interfaces!' + fullName: dataVersion + summary: >- + Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note + that data version is different from the version field in the manifest. + remarks: >- + The manifest version is used to control the versioning of the web part code, while data version is used to control + the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more + information. + + + Usage: versioning and evolving the serialized data of the web part + + + Type: string representing a [semantic version](http://semver.org) with only two parts + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: false + isDeprecated: false + syntax: + content: 'dataVersion?: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' + package: '@microsoft/sp-module-interfaces!' + fullName: description + summary: >- + Description of the web part represented as a dictionary of locale keys to description values. This value will be + displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display + areas. + remarks: >- + The Web Part developer may give an initial description to the web part. The organization admin and page author + will have the ability to change this description as per need. + + + Usage: display the description of the web part in the toolbox tooltip, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"A tool for displaying neat information."` + + + ``` + { + "default": "A tool for displaying neat information.", + "en-us": "A tool for displaying neat information.", + "fr-fr": "Un outil d’affichage des informations soignées.", + "zh": "用於顯示整潔資訊的工具。" + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'description: ILocalizedString;' + return: + type: '' + - name: fullPageAppIconImageUrl + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: fullPageAppIconImageUrl + summary: The icon for the Application pages. + remarks: >- + If this field is not defined, then the iconimageurl is used instead as the icon for Full Page apps. This value can + be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. + `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to the folder containing + the input manifest. + + + Supported values: Any absolute URL. + + + Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + isPreview: false + isDeprecated: false + syntax: + content: 'fullPageAppIconImageUrl?: string;' + return: + type: string + - name: group + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' + package: '@microsoft/sp-module-interfaces!' + fullName: group + summary: >- + The group name in web part picker to contain the web part in the classic page. If no value is provided, then the + web part will be displayed in the Miscellaneous group. + remarks: 'Example: `{ "default": "Media and Content" }`' + isPreview: true + isDeprecated: false + syntax: + content: 'group?: ILocalizedString;' + return: + type: '' + - name: groupId + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' + package: '@microsoft/sp-module-interfaces!' + fullName: groupId + summary: >- + The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework + reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an + id not in the predefined groups, it falls back to Other group. + remarks: |- + Supported values: the GUID from PredefinedGroup list + + Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` + isPreview: true + isDeprecated: false + syntax: + content: 'groupId: PredefinedGroup | string;' + return: + type: ' | string' + - name: iconImageUrl + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: iconImageUrl + summary: >- + The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be + exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). + remarks: >- + If the + [IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member) + field does not have a value, this field must have a value. This value can be an absolute URL (e.g. + `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). + In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file + will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). + + + Supported values: Any absolute URL. + + + Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + isPreview: false + isDeprecated: false + syntax: + content: 'iconImageUrl?: string;' + return: + type: string + - name: officeFabricIconFontName + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' + package: '@microsoft/sp-module-interfaces!' + fullName: officeFabricIconFontName + summary: >- + The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon + font file. + remarks: >- + The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has + a value, the + [IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member) + field will be ignored. + + + Supported values: Any character name in the Office 365 Icon Font. + + + Example: "graph" + isPreview: false + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string;' + return: + type: string + - name: properties + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' + package: '@microsoft/sp-module-interfaces!' + fullName: properties + summary: >- + Every web part is expected to have some custom properties. For example, an image web part might define properties + for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so + on. + remarks: >- + The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer + fully controls the schema for these properties. The web part developer should follow versioning rules when + updating the properties. + + + Usage: rendering of the web part + + + Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` + isPreview: false + isDeprecated: false + syntax: + content: 'properties: TProperties;' + return: + type: TProperties + - name: tags + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' + package: '@microsoft/sp-module-interfaces!' + fullName: tags + summary: >- + This field is used to tag a web part with keywords that are different from the web part group name. Tags can be + used for categorization and searching of web parts. For example, in the web part toolbox. + remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + isPreview: true + isDeprecated: false + syntax: + content: 'tags?: ILocalizedString[];' + return: + type: '[]' + - name: title + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' + package: '@microsoft/sp-module-interfaces!' + fullName: title + summary: >- + Title of the web part represented as a single a dictionary of locale keys to title values. This value will be + displayed to the user in the toolbox. + remarks: >- + This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title + to the web part. The organization admin and page author will have the ability to change this title as per need. + + + Usage: display the name of the web part in the toolbox, web part gallery and the page. + + + Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key. + + + Example: `"My Webpart"` + + + ``` + { + "default": "My WebPart" + "en-us": "My WebPart", + "fr-fr": "Ma WebPart", + "zh": "我的 web 部件" + } + ``` + isPreview: false + isDeprecated: false + syntax: + content: 'title: ILocalizedString;' + return: + type: '' diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index b88fd877..6ad4afcf 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: IClientSideWebPartManifestInstance -uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideWebPartManifestInstance -summary: Manifest that is relevant to a Web Part instance. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:TSType +name: IClientSideWebPartManifestInstance +uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IClientSideWebPartManifestInstance +summary: Manifest that is relevant to a Web Part instance. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +extends: '' diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index 06a03705..66f04a6c 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -1,70 +1,70 @@ -### YamlMime:TSType -name: ICommandDefinition -uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ICommandDefinition -summary: >- - Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, - etc. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' - package: '@microsoft/sp-module-interfaces!' - fullName: ariaLabel - summary: >- - Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by - default. Example: "Show information. Press ENTER to select." - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel?: ILocalizedString;' - return: - type: '' - - name: iconImageUrl - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: iconImageUrl - summary: >- - An optional URL for an image to be displayed next to the command. The requirements for this image are defined by - the type of extension; some extension types may not display the image at all. - remarks: >- - This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. - "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input - manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s - iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the - loaderConfig.internalModuleBaseUrls property). - isPreview: false - isDeprecated: false - syntax: - content: 'iconImageUrl?: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' - package: '@microsoft/sp-module-interfaces!' - fullName: title - summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: ILocalizedString;' - return: - type: '' - - name: type - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type - summary: Type of the item. Currently only "command" is allowed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: ''command'';' - return: - type: '''command''' +### YamlMime:TSType +name: ICommandDefinition +uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ICommandDefinition +summary: >- + Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, + etc. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' + package: '@microsoft/sp-module-interfaces!' + fullName: ariaLabel + summary: >- + Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by + default. Example: "Show information. Press ENTER to select." + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel?: ILocalizedString;' + return: + type: '' + - name: iconImageUrl + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' + package: '@microsoft/sp-module-interfaces!' + fullName: iconImageUrl + summary: >- + An optional URL for an image to be displayed next to the command. The requirements for this image are defined by + the type of extension; some extension types may not display the image at all. + remarks: >- + This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. + "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input + manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s + iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the + loaderConfig.internalModuleBaseUrls property). + isPreview: false + isDeprecated: false + syntax: + content: 'iconImageUrl?: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' + package: '@microsoft/sp-module-interfaces!' + fullName: title + summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: ILocalizedString;' + return: + type: '' + - name: type + uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type + summary: Type of the item. Currently only "command" is allowed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: ''command'';' + return: + type: '''command''' diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index 1ae87848..37079bca 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -1,48 +1,48 @@ -### YamlMime:TSType -name: ICommandSetExtensionManifest -uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ICommandSetExtensionManifest -summary: >- - This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, - tool bar, etc. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: extensionType - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' - package: '@microsoft/sp-module-interfaces!' - fullName: extensionType - summary: >- - Specifies the type of client-side extension. Some extension types support additional manifest fields beyond - SPClientSideExtensionManifest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'extensionType: ''ListViewCommandSet'';' - return: - type: '''ListViewCommandSet''' - - name: items - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' - package: '@microsoft/sp-module-interfaces!' - fullName: items - summary: A table of items defined by this command set. The object key is the Item ID. - remarks: >- - The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of - upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" - isPreview: false - isDeprecated: false - syntax: - content: |- - items: { - [itemId: string]: ICommandDefinition; - }; - return: - type: |- - { - [itemId: string]: ; - } -extends: '' +### YamlMime:TSType +name: ICommandSetExtensionManifest +uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ICommandSetExtensionManifest +summary: >- + This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, + tool bar, etc. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: extensionType + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' + package: '@microsoft/sp-module-interfaces!' + fullName: extensionType + summary: >- + Specifies the type of client-side extension. Some extension types support additional manifest fields beyond + SPClientSideExtensionManifest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'extensionType: ''ListViewCommandSet'';' + return: + type: '''ListViewCommandSet''' + - name: items + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' + package: '@microsoft/sp-module-interfaces!' + fullName: items + summary: A table of items defined by this command set. The object key is the Item ID. + remarks: >- + The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of + upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" + isPreview: false + isDeprecated: false + syntax: + content: |- + items: { + [itemId: string]: ICommandDefinition; + }; + return: + type: |- + { + [itemId: string]: ; + } +extends: '' diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 04938a19..7cdd4349 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -1,69 +1,69 @@ -### YamlMime:TSType -name: IComponentModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IComponentModuleConfiguration -summary: >- - This is the interface for a script module with the "component" type. Modules of this type will be provided via - manifests. In order for the dependency to be loaded, the manifest must be available on the site. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: failoverPath - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' - package: '@microsoft/sp-module-interfaces!' - fullName: failoverPath - summary: A path to the framework-supplied component in case the framework fails to load the requested version. - remarks: >- - This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` - field. If this field is not specified and the version is not available in the framework runtime, the closest - matching version of the component will be provided instead. - - - Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided - in the "internalModuleBaseUrls" field. - - - Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` - isPreview: true - isDeprecated: false - syntax: - content: 'failoverPath?: string | IPath;' - return: - type: 'string | ' - - name: id - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' - package: '@microsoft/sp-module-interfaces!' - fullName: id - summary: The ID of the framework-supplied component to be loaded. - remarks: |- - Supported values: string representing a component's ID. - - Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` - isPreview: true - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string - - name: version - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' - package: '@microsoft/sp-module-interfaces!' - fullName: version - summary: >- - The version of the framework-supplied component to be loaded. For framework runtime component such as - `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was - developed against be specified. - remarks: |- - Supported values: string representing a [semantic version](http://semver.org), or "latest". - - Example: `"2.2.4"` - isPreview: true - isDeprecated: false - syntax: - content: 'version: string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: IComponentModuleConfiguration +uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IComponentModuleConfiguration +summary: >- + This is the interface for a script module with the "component" type. Modules of this type will be provided via + manifests. In order for the dependency to be loaded, the manifest must be available on the site. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: failoverPath + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' + package: '@microsoft/sp-module-interfaces!' + fullName: failoverPath + summary: A path to the framework-supplied component in case the framework fails to load the requested version. + remarks: >- + This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` + field. If this field is not specified and the version is not available in the framework runtime, the closest + matching version of the component will be provided instead. + + + Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided + in the "internalModuleBaseUrls" field. + + + Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` + isPreview: true + isDeprecated: false + syntax: + content: 'failoverPath?: string | IPath;' + return: + type: 'string | ' + - name: id + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' + package: '@microsoft/sp-module-interfaces!' + fullName: id + summary: The ID of the framework-supplied component to be loaded. + remarks: |- + Supported values: string representing a component's ID. + + Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` + isPreview: true + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: version + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' + package: '@microsoft/sp-module-interfaces!' + fullName: version + summary: >- + The version of the framework-supplied component to be loaded. For framework runtime component such as + `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was + developed against be specified. + remarks: |- + Supported values: string representing a [semantic version](http://semver.org), or "latest". + + Example: `"2.2.4"` + isPreview: true + isDeprecated: false + syntax: + content: 'version: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 4a71d92c..141e12be 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -1,82 +1,82 @@ -### YamlMime:TSType -name: ILocalizedPathModuleConfiguration -uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ILocalizedPathModuleConfiguration -summary: This is the interface for a script module with the "localizedPath" type. -remarks: >- - Modules of this type must be provided by the component developer. These script resources are similar to those of the - "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in - this module type are loaded exactly the same way as "internal" modules are. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: defaultPath - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' - package: '@microsoft/sp-module-interfaces!' - fullName: defaultPath - summary: >- - A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the - paths provided in the "internalModuleBaseUrls" field. - remarks: >- - If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this field - is used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are - treated. - - - Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a - path under the paths provided in the "internalModuleBaseUrls" field. - - - Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` - isPreview: true - isDeprecated: false - syntax: - content: 'defaultPath: string | IPath;' - return: - type: 'string | ' - - name: paths - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' - package: '@microsoft/sp-module-interfaces!' - fullName: paths - summary: >- - This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale javascript resource - either as a fully-qualified URL or as a path under the paths provided in the `"internalModuleBaseUrls"` field. - remarks: >- - The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the - script resource under that path. If the user's locale does not resolve to one of the paths specified in this - field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this - field's value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key - will be used. If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this - field's value contains the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will - be used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are - treated. - - - Supported values: A dictionary of locale-to-path mappings. - - - Example: - - - ``` - { - "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", - "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: |- - paths?: { - [locale: string]: string | IPath; - }; - return: - type: |- - { - [locale: string]: string | ; - } -extends: '' +### YamlMime:TSType +name: ILocalizedPathModuleConfiguration +uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ILocalizedPathModuleConfiguration +summary: This is the interface for a script module with the "localizedPath" type. +remarks: >- + Modules of this type must be provided by the component developer. These script resources are similar to those of the + "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in + this module type are loaded exactly the same way as "internal" modules are. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: defaultPath + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' + package: '@microsoft/sp-module-interfaces!' + fullName: defaultPath + summary: >- + A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the + paths provided in the "internalModuleBaseUrls" field. + remarks: >- + If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this field + is used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are + treated. + + + Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a + path under the paths provided in the "internalModuleBaseUrls" field. + + + Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` + isPreview: true + isDeprecated: false + syntax: + content: 'defaultPath: string | IPath;' + return: + type: 'string | ' + - name: paths + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' + package: '@microsoft/sp-module-interfaces!' + fullName: paths + summary: >- + This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale javascript resource + either as a fully-qualified URL or as a path under the paths provided in the `"internalModuleBaseUrls"` field. + remarks: >- + The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the + script resource under that path. If the user's locale does not resolve to one of the paths specified in this + field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this + field's value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key + will be used. If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this + field's value contains the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will + be used. Paths in this module type are treated exactly the same way paths in modules of the "internal" type are + treated. + + + Supported values: A dictionary of locale-to-path mappings. + + + Example: + + + ``` + { + "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", + "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + paths?: { + [locale: string]: string | IPath; + }; + return: + type: |- + { + [locale: string]: string | ; + } +extends: '' diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index d2d19315..730fe2fc 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -1,76 +1,76 @@ -### YamlMime:TSType -name: ILocalizedString -uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ILocalizedString -summary: A set of localized strings. -remarks: >- - Supported values: - - - - An Id referring to a localized resource. In this case it requires an 'id' key. - - - - A dictionary of locale keys to strings. In this case it requires a 'default' key. - - - ``` - - Example 1: "My Application" - { - "id": "$myStrings:myStrings.MyApplication;" - } - Example 2: "My Application" - { - "default": "My Application" - "en-us": "My Application", - "fr-fr": "Ma demande", - "zh": "我的應用程式" - } - ``` - - Notes on string ids: - - - - Ids have the following structure: `$:;` - - - - `resourceName` needs to be a `localizedResource` in the config.json. - - - - `expression` is an expression that will be evaluated to access the string from the resource module. - - - If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or - `"$resource:resource[\"MyString\"];"` - - - For more complex cases, run an appropriate expression to access your resource and return the string. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: default - uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' - package: '@microsoft/sp-module-interfaces!' - fullName: default - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'default?: string;' - return: - type: string - - name: id - uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' - package: '@microsoft/sp-module-interfaces!' - fullName: id - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id?: string;' - return: - type: string +### YamlMime:TSType +name: ILocalizedString +uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: ILocalizedString +summary: A set of localized strings. +remarks: >- + Supported values: + + + - An Id referring to a localized resource. In this case it requires an 'id' key. + + + - A dictionary of locale keys to strings. In this case it requires a 'default' key. + + + ``` + + Example 1: "My Application" + { + "id": "$myStrings:myStrings.MyApplication;" + } + Example 2: "My Application" + { + "default": "My Application" + "en-us": "My Application", + "fr-fr": "Ma demande", + "zh": "我的應用程式" + } + ``` + + Notes on string ids: + + + - Ids have the following structure: `$:;` + + + - `resourceName` needs to be a `localizedResource` in the config.json. + + + - `expression` is an expression that will be evaluated to access the string from the resource module. + + + If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or + `"$resource:resource[\"MyString\"];"` + + + For more complex cases, run an appropriate expression to access your resource and return the string. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: default + uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' + package: '@microsoft/sp-module-interfaces!' + fullName: default + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'default?: string;' + return: + type: string + - name: id + uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' + package: '@microsoft/sp-module-interfaces!' + fullName: id + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index af86cba3..5f85afd8 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -1,54 +1,54 @@ -### YamlMime:TSType -name: IModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IModuleConfiguration -summary: This is the base interface for a script module's definition. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: shouldNotPreload - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' - package: '@microsoft/sp-module-interfaces!' - fullName: shouldNotPreload - summary: 'If set to `true`, this module should not be preloaded when loading the component.' - remarks: >- - The most common case for setting this property to "true" is when a module is defined in a manifest, but is not - required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded - asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. - - - Usage: Instructs the module loader to not preload this module. - isPreview: true - isDeprecated: false - syntax: - content: 'shouldNotPreload?: boolean;' - return: - type: boolean - - name: type - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type - summary: >- - The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules - must be available on the paths provided in the `"internalModuleBaseUrls"` field. - remarks: >- - Modules with the `"path"` type use the `IPathModuleConfiguration` interface. - - - Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the - "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. - - - Supported values: `"component"`, `"path"`, `"localizedPath"` - - - Example: `"localized"` - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''component'' | ''path'' | ''localizedPath'';' - return: - type: '''component'' | ''path'' | ''localizedPath''' +### YamlMime:TSType +name: IModuleConfiguration +uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IModuleConfiguration +summary: This is the base interface for a script module's definition. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: shouldNotPreload + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' + package: '@microsoft/sp-module-interfaces!' + fullName: shouldNotPreload + summary: 'If set to `true`, this module should not be preloaded when loading the component.' + remarks: >- + The most common case for setting this property to "true" is when a module is defined in a manifest, but is not + required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded + asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. + + + Usage: Instructs the module loader to not preload this module. + isPreview: true + isDeprecated: false + syntax: + content: 'shouldNotPreload?: boolean;' + return: + type: boolean + - name: type + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type + summary: >- + The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules + must be available on the paths provided in the `"internalModuleBaseUrls"` field. + remarks: >- + Modules with the `"path"` type use the `IPathModuleConfiguration` interface. + + + Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the + "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. + + + Supported values: `"component"`, `"path"`, `"localizedPath"` + + + Example: `"localized"` + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''component'' | ''path'' | ''localizedPath'';' + return: + type: '''component'' | ''path'' | ''localizedPath''' diff --git a/SP-Framework/sp-module-interfaces/ipath.yml b/SP-Framework/sp-module-interfaces/ipath.yml index 47345d64..267e5056 100644 --- a/SP-Framework/sp-module-interfaces/ipath.yml +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -1,53 +1,53 @@ -### YamlMime:TSType -name: IPath -uid: '@microsoft/sp-module-interfaces!IPath:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IPath -summary: >- - This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded in - exactly the same way as any other internal path. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: debug - uid: '@microsoft/sp-module-interfaces!IPath#debug:member' - package: '@microsoft/sp-module-interfaces!' - fullName: debug - summary: >- - A path to this module's debug javascript resource either as a fully-qualified URL or as a path under the paths - provided in the "internalModuleBaseUrls" field. The script referenced by this field is only loaded if it is - present and debug scripts are explicitly requested. - remarks: >- - Supported values: The path to the debug script either as a fully-qualified URL or as a path under the paths - provided in the `"internalModuleBaseUrls"` field. - - - Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` - isPreview: true - isDeprecated: false - syntax: - content: 'debug?: string;' - return: - type: string - - name: default - uid: '@microsoft/sp-module-interfaces!IPath#default:member' - package: '@microsoft/sp-module-interfaces!' - fullName: default - summary: >- - A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided - in the "internalModuleBaseUrls" field. The script referenced by this field is loaded by default unless a debug - version of the script is provided and explicitly requested. - remarks: >- - Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the - paths provided in the "internalModuleBaseUrls" field. - - - Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - isPreview: true - isDeprecated: false - syntax: - content: 'default: string;' - return: - type: string +### YamlMime:TSType +name: IPath +uid: '@microsoft/sp-module-interfaces!IPath:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IPath +summary: >- + This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded in + exactly the same way as any other internal path. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: debug + uid: '@microsoft/sp-module-interfaces!IPath#debug:member' + package: '@microsoft/sp-module-interfaces!' + fullName: debug + summary: >- + A path to this module's debug javascript resource either as a fully-qualified URL or as a path under the paths + provided in the "internalModuleBaseUrls" field. The script referenced by this field is only loaded if it is + present and debug scripts are explicitly requested. + remarks: >- + Supported values: The path to the debug script either as a fully-qualified URL or as a path under the paths + provided in the `"internalModuleBaseUrls"` field. + + + Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` + isPreview: true + isDeprecated: false + syntax: + content: 'debug?: string;' + return: + type: string + - name: default + uid: '@microsoft/sp-module-interfaces!IPath#default:member' + package: '@microsoft/sp-module-interfaces!' + fullName: default + summary: >- + A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided + in the "internalModuleBaseUrls" field. The script referenced by this field is loaded by default unless a debug + version of the script is provided and explicitly requested. + remarks: >- + Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the + paths provided in the "internalModuleBaseUrls" field. + + + Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` + isPreview: true + isDeprecated: false + syntax: + content: 'default: string;' + return: + type: string diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 6d3413e2..d1130505 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -1,94 +1,94 @@ -### YamlMime:TSType -name: IPathModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IPathModuleConfiguration -summary: >- - This is the interface for a script module with the "path" type. Modules of this type must be provided by the component - developer. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: globalDependencies - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' - package: '@microsoft/sp-module-interfaces!' - fullName: globalDependencies - summary: >- - For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will - ensure that those dependencies are already loaded. - remarks: >- - Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is - not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules - in the same component manifest that this module is specified, the module loader will throw an exception and the - component will fail to load. - - - Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key - `IClientSideComponentLoaderConfiguration.scriptResources[]` - - - Example: `["jquery"]` - isPreview: true - isDeprecated: false - syntax: - content: 'globalDependencies?: string[];' - return: - type: 'string[]' - - name: globalName - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: globalName - summary: >- - If this property is specified, this module is considered non-AMD and the module loader will not expect "define" or - "require" to be called. - remarks: >- - In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is called and - dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which - global variable must be examined. If this property is specified, this module is considered non-AMD and the module - loader will not expect "define" or "require" to be called. Instead, it will wait for the script to finish loading - and examine the global variable specified in this field. - - - Supported values: Variable names that are expected to be populated after this module is loaded. For example, if - this module is describing jQuery, this value should probably be "$". If an empty string is specified, the module - loader will throw an exception and the component will fail to load. - - - Example: `"$"` - isPreview: true - isDeprecated: false - syntax: - content: 'globalName?: string;' - return: - type: string - - name: path - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' - package: '@microsoft/sp-module-interfaces!' - fullName: path - summary: >- - A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided - in the `internalModuleBaseUrls` field. - remarks: >- - For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the - `"internalModuleBaseUrls"` field's value is `[ "https://contoso.akamaihd.net/files/", - "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from - the URL `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If - loading from that URL fails, the loader will then attempt to load this script resource from - `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL - fails to load, the component will fail to load and an error will be returned. - - - Supported values: The path to the module either as a fully-qualified URL or as a path under the paths provided in - the "internalModuleBaseUrls" field. - - - Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - isPreview: true - isDeprecated: false - syntax: - content: 'path: string | IPath;' - return: - type: 'string | ' -extends: '' +### YamlMime:TSType +name: IPathModuleConfiguration +uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IPathModuleConfiguration +summary: >- + This is the interface for a script module with the "path" type. Modules of this type must be provided by the component + developer. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: globalDependencies + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' + package: '@microsoft/sp-module-interfaces!' + fullName: globalDependencies + summary: >- + For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will + ensure that those dependencies are already loaded. + remarks: >- + Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is + not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules + in the same component manifest that this module is specified, the module loader will throw an exception and the + component will fail to load. + + + Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key + `IClientSideComponentLoaderConfiguration.scriptResources[]` + + + Example: `["jquery"]` + isPreview: true + isDeprecated: false + syntax: + content: 'globalDependencies?: string[];' + return: + type: 'string[]' + - name: globalName + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' + package: '@microsoft/sp-module-interfaces!' + fullName: globalName + summary: >- + If this property is specified, this module is considered non-AMD and the module loader will not expect "define" or + "require" to be called. + remarks: >- + In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is called and + dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which + global variable must be examined. If this property is specified, this module is considered non-AMD and the module + loader will not expect "define" or "require" to be called. Instead, it will wait for the script to finish loading + and examine the global variable specified in this field. + + + Supported values: Variable names that are expected to be populated after this module is loaded. For example, if + this module is describing jQuery, this value should probably be "$". If an empty string is specified, the module + loader will throw an exception and the component will fail to load. + + + Example: `"$"` + isPreview: true + isDeprecated: false + syntax: + content: 'globalName?: string;' + return: + type: string + - name: path + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' + package: '@microsoft/sp-module-interfaces!' + fullName: path + summary: >- + A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided + in the `internalModuleBaseUrls` field. + remarks: >- + For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and the + `"internalModuleBaseUrls"` field's value is `[ "https://contoso.akamaihd.net/files/", + "https://contoso.msecnd.net/files/" ]`, the loader will first attempt to load this script resource from + the URL `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If + loading from that URL fails, the loader will then attempt to load this script resource from + `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL + fails to load, the component will fail to load and an error will be returned. + + + Supported values: The path to the module either as a fully-qualified URL or as a path under the paths provided in + the "internalModuleBaseUrls" field. + + + Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` + isPreview: true + isDeprecated: false + syntax: + content: 'path: string | IPath;' + return: + type: 'string | ' +extends: '' diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index aa38f38d..6625d178 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -1,68 +1,68 @@ -### YamlMime:TSEnum -name: PredefinedGroup -uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' -package: '@microsoft/sp-module-interfaces!' -fullName: PredefinedGroup -summary: Predefined web part group. -remarks: '' -isPreview: true -isDeprecated: false -fields: - - name: BusinessAndIntelligence - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' - package: '@microsoft/sp-module-interfaces!' - summary: |- - Business and intelligence. - - This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. - value: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' - - name: CommunicationAndCollaboration - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' - package: '@microsoft/sp-module-interfaces!' - summary: |- - Communication and collaboration. - - This group includes web parts that facilitate information sharing, team work, and social interactions. - value: '"75e22ed5-fa14-4829-850a-c890608aca2d"' - - name: Discovery - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' - package: '@microsoft/sp-module-interfaces!' - summary: |- - Discovery. - - This group includes web parts that organize, group, and filter content to help users discover information. - value: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' - - name: Other - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' - package: '@microsoft/sp-module-interfaces!' - summary: |- - Other. - - This group includes web parts not in other groups. - value: '"5c03119e-3074-46fd-976b-c60198311f70"' - - name: PlanningAndProcess - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' - package: '@microsoft/sp-module-interfaces!' - summary: |- - Planning and process. - - This group includes web parts that empower team productivity with the use of planning and process tools. - value: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' - - name: SiteTools - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' - package: '@microsoft/sp-module-interfaces!' - summary: |- - Site tools. - - This group includes web parts for site information and management. - value: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' - - name: TextMediaAndContent - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' - package: '@microsoft/sp-module-interfaces!' - summary: >- - Text, media and content. - - - This group includes web parts that display text, multi-media, documents, information from the web, and other rich - content. - value: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' +### YamlMime:TSEnum +name: PredefinedGroup +uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' +package: '@microsoft/sp-module-interfaces!' +fullName: PredefinedGroup +summary: Predefined web part group. +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: BusinessAndIntelligence + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Business and intelligence. + + This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. + value: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' + - name: CommunicationAndCollaboration + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Communication and collaboration. + + This group includes web parts that facilitate information sharing, team work, and social interactions. + value: '"75e22ed5-fa14-4829-850a-c890608aca2d"' + - name: Discovery + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Discovery. + + This group includes web parts that organize, group, and filter content to help users discover information. + value: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' + - name: Other + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Other. + + This group includes web parts not in other groups. + value: '"5c03119e-3074-46fd-976b-c60198311f70"' + - name: PlanningAndProcess + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Planning and process. + + This group includes web parts that empower team productivity with the use of planning and process tools. + value: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' + - name: SiteTools + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Site tools. + + This group includes web parts for site information and management. + value: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' + - name: TextMediaAndContent + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' + package: '@microsoft/sp-module-interfaces!' + summary: >- + Text, media and content. + + + This group includes web parts that display text, multi-media, documents, information from the web, and other rich + content. + value: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index 9f5ec50e..03cb92e3 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -1,17 +1,17 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-odata-types!' -name: '@microsoft/sp-odata-types' -type: package -summary: TypeScript interfaces for working with SharePoint REST APIs. -interfaces: - - '@microsoft/sp-odata-types!_IODataUserId:interface' - - '@microsoft/sp-odata-types!IODataBasePermission:interface' - - '@microsoft/sp-odata-types!IODataChangeToken:interface' - - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - - '@microsoft/sp-odata-types!IODataList:interface' - - '@microsoft/sp-odata-types!IODataListItem:interface' - - '@microsoft/sp-odata-types!IODataNavigationNode:interface' - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - - '@microsoft/sp-odata-types!IODataUser:interface' - - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - - '@microsoft/sp-odata-types!IODataWeb:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-odata-types!' +name: '@microsoft/sp-odata-types' +type: package +summary: TypeScript interfaces for working with SharePoint REST APIs. +interfaces: + - '@microsoft/sp-odata-types!_IODataUserId:interface' + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - '@microsoft/sp-odata-types!IODataList:interface' + - '@microsoft/sp-odata-types!IODataListItem:interface' + - '@microsoft/sp-odata-types!IODataNavigationNode:interface' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + - '@microsoft/sp-odata-types!IODataUser:interface' + - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + - '@microsoft/sp-odata-types!IODataWeb:interface' diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 9302846a..dd06fd8d 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -1,37 +1,37 @@ -### YamlMime:TSType -name: _IODataUserId -uid: '@microsoft/sp-odata-types!_IODataUserId:interface' -package: '@microsoft/sp-odata-types!' -fullName: _IODataUserId -summary: >- - Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: NameId - uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' - package: '@microsoft/sp-odata-types!' - fullName: NameId - summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'NameId: string;' - return: - type: string - - name: NameIdIssuer - uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' - package: '@microsoft/sp-odata-types!' - fullName: NameIdIssuer - summary: 'Example: `"urn:office:idp:activedirectory"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'NameIdIssuer: string;' - return: - type: string +### YamlMime:TSType +name: _IODataUserId +uid: '@microsoft/sp-odata-types!_IODataUserId:interface' +package: '@microsoft/sp-odata-types!' +fullName: _IODataUserId +summary: >- + Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: NameId + uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' + package: '@microsoft/sp-odata-types!' + fullName: NameId + summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'NameId: string;' + return: + type: string + - name: NameIdIssuer + uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' + package: '@microsoft/sp-odata-types!' + fullName: NameIdIssuer + summary: 'Example: `"urn:office:idp:activedirectory"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'NameIdIssuer: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 4f66a557..18a5e692 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IODataBasePermission -uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataBasePermission -summary: Data used for creating a SPPermission object. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: High - uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' - package: '@microsoft/sp-odata-types!' - fullName: High - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'High: number;' - return: - type: number - - name: Low - uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' - package: '@microsoft/sp-odata-types!' - fullName: Low - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Low: number;' - return: - type: number +### YamlMime:TSType +name: IODataBasePermission +uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataBasePermission +summary: Data used for creating a SPPermission object. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: High + uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' + package: '@microsoft/sp-odata-types!' + fullName: High + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'High: number;' + return: + type: number + - name: Low + uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' + package: '@microsoft/sp-odata-types!' + fullName: Low + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Low: number;' + return: + type: number diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index d38dfc06..b7bcf678 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -1,25 +1,25 @@ -### YamlMime:TSType -name: IODataChangeToken -uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataChangeToken -summary: >- - Represents an OData SP.ChangeToken object. For more information about this object, see - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: StringValue - uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' - package: '@microsoft/sp-odata-types!' - fullName: StringValue - summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'StringValue: string;' - return: - type: string +### YamlMime:TSType +name: IODataChangeToken +uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataChangeToken +summary: >- + Represents an OData SP.ChangeToken object. For more information about this object, see + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: StringValue + uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' + package: '@microsoft/sp-odata-types!' + fullName: StringValue + summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'StringValue: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 7c07f4a9..cec543b4 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -1,61 +1,61 @@ -### YamlMime:TSType -name: IODataContextWebInformation -uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataContextWebInformation -summary: >- - Represents an OData SP.ContextWebInformation object. For more information about this object, see - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: LibraryVersion - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' - package: '@microsoft/sp-odata-types!' - fullName: LibraryVersion - summary: 'Example: `"16.0.4919.3000"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'LibraryVersion: string;' - return: - type: string - - name: SiteFullUrl - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: SiteFullUrl - summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'SiteFullUrl: string;' - return: - type: string - - name: SupportedSchemaVersions - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' - package: '@microsoft/sp-odata-types!' - fullName: SupportedSchemaVersions - summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'SupportedSchemaVersions: string[];' - return: - type: 'string[]' - - name: WebFullUrl - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: WebFullUrl - summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'WebFullUrl: string;' - return: - type: string +### YamlMime:TSType +name: IODataContextWebInformation +uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataContextWebInformation +summary: >- + Represents an OData SP.ContextWebInformation object. For more information about this object, see + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: LibraryVersion + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' + package: '@microsoft/sp-odata-types!' + fullName: LibraryVersion + summary: 'Example: `"16.0.4919.3000"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LibraryVersion: string;' + return: + type: string + - name: SiteFullUrl + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: SiteFullUrl + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'SiteFullUrl: string;' + return: + type: string + - name: SupportedSchemaVersions + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' + package: '@microsoft/sp-odata-types!' + fullName: SupportedSchemaVersions + summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'SupportedSchemaVersions: string[];' + return: + type: 'string[]' + - name: WebFullUrl + uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: WebFullUrl + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'WebFullUrl: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 0a0d8f20..20a23cac 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -1,171 +1,171 @@ -### YamlMime:TSType -name: IODataList -uid: '@microsoft/sp-odata-types!IODataList:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataList -summary: >- - Represents an OData SP.List object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: BaseTemplate - uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' - package: '@microsoft/sp-odata-types!' - fullName: BaseTemplate - summary: The list definition type on which the list is based. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'BaseTemplate: number;' - return: - type: number - - name: Created - uid: '@microsoft/sp-odata-types!IODataList#Created:member' - package: '@microsoft/sp-odata-types!' - fullName: Created - summary: 'Example: `"/Date(1453294804000)/"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Created: string;' - return: - type: string - - name: CurrentChangeToken - uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' - package: '@microsoft/sp-odata-types!' - fullName: CurrentChangeToken - summary: The change token that will be used in logging the next change to the list. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'CurrentChangeToken: IODataChangeToken;' - return: - type: '' - - name: Description - uid: '@microsoft/sp-odata-types!IODataList#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description - summary: A description of the List. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Description: string;' - return: - type: string - - name: EntityTypeName - uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' - package: '@microsoft/sp-odata-types!' - fullName: EntityTypeName - summary: 'Example: `"MyListTitleList"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'EntityTypeName: string;' - return: - type: string - - name: Hidden - uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' - package: '@microsoft/sp-odata-types!' - fullName: Hidden - summary: >- - A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or - the Add Column page as an option for lookup fields. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Hidden: boolean;' - return: - type: boolean - - name: Id - uid: '@microsoft/sp-odata-types!IODataList#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id - summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Id: string;' - return: - type: string - - name: LastItemDeletedDate - uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' - package: '@microsoft/sp-odata-types!' - fullName: LastItemDeletedDate - summary: 'Example: `"/Date(1453294809000)/"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'LastItemDeletedDate: string;' - return: - type: string - - name: LastItemModifiedDate - uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' - package: '@microsoft/sp-odata-types!' - fullName: LastItemModifiedDate - summary: 'Example: `"/Date(1453294809000)/"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'LastItemModifiedDate: string;' - return: - type: string - - name: ListItemEntityTypeFullName - uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' - package: '@microsoft/sp-odata-types!' - fullName: ListItemEntityTypeFullName - summary: 'Example: `"SP.Data.MyListTitleListItem"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ListItemEntityTypeFullName: string;' - return: - type: string - - name: ParentWebUrl - uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: ParentWebUrl - summary: 'Example: `"/sites/PubSite"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ParentWebUrl: string;' - return: - type: string - - name: TemplateFeatureId - uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' - package: '@microsoft/sp-odata-types!' - fullName: TemplateFeatureId - summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'TemplateFeatureId: string;' - return: - type: string - - name: Title - uid: '@microsoft/sp-odata-types!IODataList#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title - summary: 'Example: `"Pages"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Title: string;' - return: - type: string +### YamlMime:TSType +name: IODataList +uid: '@microsoft/sp-odata-types!IODataList:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataList +summary: >- + Represents an OData SP.List object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: BaseTemplate + uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' + package: '@microsoft/sp-odata-types!' + fullName: BaseTemplate + summary: The list definition type on which the list is based. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'BaseTemplate: number;' + return: + type: number + - name: Created + uid: '@microsoft/sp-odata-types!IODataList#Created:member' + package: '@microsoft/sp-odata-types!' + fullName: Created + summary: 'Example: `"/Date(1453294804000)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Created: string;' + return: + type: string + - name: CurrentChangeToken + uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' + package: '@microsoft/sp-odata-types!' + fullName: CurrentChangeToken + summary: The change token that will be used in logging the next change to the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CurrentChangeToken: IODataChangeToken;' + return: + type: '' + - name: Description + uid: '@microsoft/sp-odata-types!IODataList#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: A description of the List. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Description: string;' + return: + type: string + - name: EntityTypeName + uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' + package: '@microsoft/sp-odata-types!' + fullName: EntityTypeName + summary: 'Example: `"MyListTitleList"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'EntityTypeName: string;' + return: + type: string + - name: Hidden + uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' + package: '@microsoft/sp-odata-types!' + fullName: Hidden + summary: >- + A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or + the Add Column page as an option for lookup fields. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Hidden: boolean;' + return: + type: boolean + - name: Id + uid: '@microsoft/sp-odata-types!IODataList#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id: string;' + return: + type: string + - name: LastItemDeletedDate + uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' + package: '@microsoft/sp-odata-types!' + fullName: LastItemDeletedDate + summary: 'Example: `"/Date(1453294809000)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LastItemDeletedDate: string;' + return: + type: string + - name: LastItemModifiedDate + uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' + package: '@microsoft/sp-odata-types!' + fullName: LastItemModifiedDate + summary: 'Example: `"/Date(1453294809000)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LastItemModifiedDate: string;' + return: + type: string + - name: ListItemEntityTypeFullName + uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' + package: '@microsoft/sp-odata-types!' + fullName: ListItemEntityTypeFullName + summary: 'Example: `"SP.Data.MyListTitleListItem"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ListItemEntityTypeFullName: string;' + return: + type: string + - name: ParentWebUrl + uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: ParentWebUrl + summary: 'Example: `"/sites/PubSite"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ParentWebUrl: string;' + return: + type: string + - name: TemplateFeatureId + uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' + package: '@microsoft/sp-odata-types!' + fullName: TemplateFeatureId + summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'TemplateFeatureId: string;' + return: + type: string + - name: Title + uid: '@microsoft/sp-odata-types!IODataList#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: 'Example: `"Pages"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 91777f5f..32f6a0c3 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -1,67 +1,67 @@ -### YamlMime:TSType -name: IODataListItem -uid: '@microsoft/sp-odata-types!IODataListItem:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataListItem -summary: >- - Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ContentTypeId - uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' - package: '@microsoft/sp-odata-types!' - fullName: ContentTypeId - summary: 'Example: `{ StringValue: "0x010100C5..." }`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - ContentTypeId: { - StringValue: string; - }; - return: - type: |- - { - StringValue: string; - } - - name: ID - uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' - package: '@microsoft/sp-odata-types!' - fullName: ID - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ID: number;' - return: - type: number - - name: Title - uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title - summary: Title of the List Item - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Title: string;' - return: - type: string - - name: UniqueId - uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' - package: '@microsoft/sp-odata-types!' - fullName: UniqueId - summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'UniqueId: string;' - return: - type: string +### YamlMime:TSType +name: IODataListItem +uid: '@microsoft/sp-odata-types!IODataListItem:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataListItem +summary: >- + Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ContentTypeId + uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' + package: '@microsoft/sp-odata-types!' + fullName: ContentTypeId + summary: 'Example: `{ StringValue: "0x010100C5..." }`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + ContentTypeId: { + StringValue: string; + }; + return: + type: |- + { + StringValue: string; + } + - name: ID + uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' + package: '@microsoft/sp-odata-types!' + fullName: ID + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ID: number;' + return: + type: number + - name: Title + uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: Title of the List Item + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string + - name: UniqueId + uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' + package: '@microsoft/sp-odata-types!' + fullName: UniqueId + summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'UniqueId: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index a89c8b9d..32bc1a50 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -1,101 +1,101 @@ -### YamlMime:TSType -name: IODataNavigationNode -uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataNavigationNode -summary: >- - Represents an OData SP.NavigationNode object. - [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: Children - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' - package: '@microsoft/sp-odata-types!' - fullName: Children - summary: Gets or sets an array of Navigation Nodes that are children to the current node. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Children?: IODataNavigationNode[];' - return: - type: '[]' - - name: Id - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id - summary: Gets a value that specifies the identifier for the navigation node. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Id?: number;' - return: - type: number - - name: IsDocLib - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' - package: '@microsoft/sp-odata-types!' - fullName: IsDocLib - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'IsDocLib?: boolean;' - return: - type: boolean - - name: IsExternal - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' - package: '@microsoft/sp-odata-types!' - fullName: IsExternal - summary: >- - Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of - the site collection. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'IsExternal?: boolean;' - return: - type: boolean - - name: IsVisible - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' - package: '@microsoft/sp-odata-types!' - fullName: IsVisible - summary: Gets or sets a value that specifies if the node navigation link should be visible. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'IsVisible?: boolean;' - return: - type: boolean - - name: Title - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title - summary: Gets or sets a value that specifies the anchor text for the node navigation link. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Title?: string;' - return: - type: string - - name: Url - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' - package: '@microsoft/sp-odata-types!' - fullName: Url - summary: >- - Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative - form if IsExternal is false. It must be a URL of relative or absolute form. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Url?: string;' - return: - type: string +### YamlMime:TSType +name: IODataNavigationNode +uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataNavigationNode +summary: >- + Represents an OData SP.NavigationNode object. + [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: Children + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' + package: '@microsoft/sp-odata-types!' + fullName: Children + summary: Gets or sets an array of Navigation Nodes that are children to the current node. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Children?: IODataNavigationNode[];' + return: + type: '[]' + - name: Id + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: Gets a value that specifies the identifier for the navigation node. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id?: number;' + return: + type: number + - name: IsDocLib + uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' + package: '@microsoft/sp-odata-types!' + fullName: IsDocLib + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsDocLib?: boolean;' + return: + type: boolean + - name: IsExternal + uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' + package: '@microsoft/sp-odata-types!' + fullName: IsExternal + summary: >- + Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of + the site collection. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsExternal?: boolean;' + return: + type: boolean + - name: IsVisible + uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' + package: '@microsoft/sp-odata-types!' + fullName: IsVisible + summary: Gets or sets a value that specifies if the node navigation link should be visible. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsVisible?: boolean;' + return: + type: boolean + - name: Title + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: Gets or sets a value that specifies the anchor text for the node navigation link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title?: string;' + return: + type: string + - name: Url + uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' + package: '@microsoft/sp-odata-types!' + fullName: Url + summary: >- + Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative + form if IsExternal is false. It must be a URL of relative or absolute form. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Url?: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 97df29e3..30026142 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -1,37 +1,37 @@ -### YamlMime:TSType -name: IODataNavigationNodeCollection -uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataNavigationNodeCollection -summary: >- - Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. - [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: quickLaunch - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' - package: '@microsoft/sp-odata-types!' - fullName: quickLaunch - summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'quickLaunch: IODataNavigationNode[];' - return: - type: '[]' - - name: topNav - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' - package: '@microsoft/sp-odata-types!' - fullName: topNav - summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'topNav: IODataNavigationNode[];' - return: - type: '[]' +### YamlMime:TSType +name: IODataNavigationNodeCollection +uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataNavigationNodeCollection +summary: >- + Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. + [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: quickLaunch + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' + package: '@microsoft/sp-odata-types!' + fullName: quickLaunch + summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'quickLaunch: IODataNavigationNode[];' + return: + type: '[]' + - name: topNav + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' + package: '@microsoft/sp-odata-types!' + fullName: topNav + summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'topNav: IODataNavigationNode[];' + return: + type: '[]' diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index 4053347b..a78453ec 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -1,112 +1,112 @@ -### YamlMime:TSType -name: IODataUser -uid: '@microsoft/sp-odata-types!IODataUser:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataUser -summary: >- - Represents an OData SP.User object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: Email - uid: '@microsoft/sp-odata-types!IODataUser#Email:member' - package: '@microsoft/sp-odata-types!' - fullName: Email - summary: 'Example: `"someone@example.com"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Email: string;' - return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataUser#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Id: number;' - return: - type: number - - name: IsSiteAdmin - uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' - package: '@microsoft/sp-odata-types!' - fullName: IsSiteAdmin - summary: Boolean value that specifies whether the user is a site collection administrator. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'IsSiteAdmin: boolean;' - return: - type: boolean - - name: LoginName - uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' - package: '@microsoft/sp-odata-types!' - fullName: LoginName - summary: 'Example: `"i:0#.w|domain\user"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'LoginName: string;' - return: - type: string - - name: PrincipalType - uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' - package: '@microsoft/sp-odata-types!' - fullName: PrincipalType - summary: This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. - remarks: |- - Values: - - None: 0 - - User: 1 - - DistributionList: 2 - - SecurityGroup: 4 - - SharePointGroup: 8 - - All: 15 - isPreview: false - isDeprecated: false - syntax: - content: 'PrincipalType: number;' - return: - type: number - - name: Title - uid: '@microsoft/sp-odata-types!IODataUser#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title - summary: 'Example: `"DOMAIN\user"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Title: string;' - return: - type: string - - name: UserId - uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' - package: '@microsoft/sp-odata-types!' - fullName: UserId - summary: >- - Gets the information of the user that contains the user's name identifier and the issuer of the user's name - identifier. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'UserId: IODataUserId;' - return: - type: '' +### YamlMime:TSType +name: IODataUser +uid: '@microsoft/sp-odata-types!IODataUser:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataUser +summary: >- + Represents an OData SP.User object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: Email + uid: '@microsoft/sp-odata-types!IODataUser#Email:member' + package: '@microsoft/sp-odata-types!' + fullName: Email + summary: 'Example: `"someone@example.com"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Email: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataUser#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id: number;' + return: + type: number + - name: IsSiteAdmin + uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' + package: '@microsoft/sp-odata-types!' + fullName: IsSiteAdmin + summary: Boolean value that specifies whether the user is a site collection administrator. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsSiteAdmin: boolean;' + return: + type: boolean + - name: LoginName + uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' + package: '@microsoft/sp-odata-types!' + fullName: LoginName + summary: 'Example: `"i:0#.w|domain\user"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LoginName: string;' + return: + type: string + - name: PrincipalType + uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' + package: '@microsoft/sp-odata-types!' + fullName: PrincipalType + summary: This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. + remarks: |- + Values: + + None: 0 + + User: 1 + + DistributionList: 2 + + SecurityGroup: 4 + + SharePointGroup: 8 + + All: 15 + isPreview: false + isDeprecated: false + syntax: + content: 'PrincipalType: number;' + return: + type: number + - name: Title + uid: '@microsoft/sp-odata-types!IODataUser#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: 'Example: `"DOMAIN\user"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string + - name: UserId + uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' + package: '@microsoft/sp-odata-types!' + fullName: UserId + summary: >- + Gets the information of the user that contains the user's name identifier and the issuer of the user's name + identifier. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'UserId: IODataUserId;' + return: + type: '' diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index 8fd2a96c..f83c9584 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -1,246 +1,246 @@ -### YamlMime:TSType -name: IODataUserCustomAction -uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataUserCustomAction -summary: >- - Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation - here: - [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ClientSideComponentId - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' - package: '@microsoft/sp-odata-types!' - fullName: ClientSideComponentId - summary: The unique identifier of the client-side component defined with SharePoint Framework - remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' - isPreview: false - isDeprecated: false - syntax: - content: 'ClientSideComponentId: string;' - return: - type: string - - name: ClientSideComponentProperties - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' - package: '@microsoft/sp-odata-types!' - fullName: ClientSideComponentProperties - summary: Custom initialization properties for the client-side component. - remarks: >- - This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string - must contain a JSON object with custom initialization properties whose format and meaning are defined by the - client-side component. - - - Example: `"{ \"maxItemsToShow\": 123 }"` - isPreview: false - isDeprecated: false - syntax: - content: 'ClientSideComponentProperties: string;' - return: - type: string - - name: CommandUIExtension - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' - package: '@microsoft/sp-odata-types!' - fullName: CommandUIExtension - summary: >- - Gets or sets a value that specifies an implementation specific XML fragment that determines user interface - properties of the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'CommandUIExtension: string;' - return: - type: string - - name: Description - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description - summary: Gets or sets the description of the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Description: string;' - return: - type: string - - name: Group - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' - package: '@microsoft/sp-odata-types!' - fullName: Group - summary: >- - Gets or sets a value that specifies an implementation-specific value that determines the position of the custom - action in the page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Group: string;' - return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id - summary: >- - Gets a value that specifies the identifier (GUID) of the custom action. Example: - `"48309f28-53aa-43ed-b113-625120e5af6f"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Id: string;' - return: - type: string - - name: ImageUrl - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: ImageUrl - summary: Gets or sets the URL of the image associated with the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ImageUrl: string;' - return: - type: string - - name: Location - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' - package: '@microsoft/sp-odata-types!' - fullName: Location - summary: Gets or sets the location of the custom action. - remarks: 'Example: `"ClientSide.Application"`' - isPreview: false - isDeprecated: false - syntax: - content: 'Location: string;' - return: - type: string - - name: RegistrationId - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' - package: '@microsoft/sp-odata-types!' - fullName: RegistrationId - summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'RegistrationId: string;' - return: - type: string - - name: RegistrationType - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' - package: '@microsoft/sp-odata-types!' - fullName: RegistrationType - summary: Gets or sets the value that specifies the type of object associated with the custom action. - remarks: >- - Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType - = 4. - isPreview: false - isDeprecated: false - syntax: - content: 'RegistrationType: number;' - return: - type: number - - name: Rights - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' - package: '@microsoft/sp-odata-types!' - fullName: Rights - summary: Gets or sets the value that specifies the permissions needed for the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Rights: IODataBasePermission;' - return: - type: '' - - name: Scope - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' - package: '@microsoft/sp-odata-types!' - fullName: Scope - summary: Gets a value that specifies the scope of the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Scope: number;' - return: - type: number - - name: ScriptBlock - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' - package: '@microsoft/sp-odata-types!' - fullName: ScriptBlock - summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ScriptBlock: string;' - return: - type: string - - name: ScriptSrc - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' - package: '@microsoft/sp-odata-types!' - fullName: ScriptSrc - summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ScriptSrc: string;' - return: - type: string - - name: Sequence - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' - package: '@microsoft/sp-odata-types!' - fullName: Sequence - summary: >- - Gets or sets the value that specifies an implementation-specific value that determines the order of the custom - action that appears on the page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Sequence: number;' - return: - type: number - - name: Title - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title - summary: Gets or sets the display title of the custom action. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Title: string;' - return: - type: string - - name: Url - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' - package: '@microsoft/sp-odata-types!' - fullName: Url - summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Url: string;' - return: - type: string - - name: VersionOfUserCustomAction - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' - package: '@microsoft/sp-odata-types!' - fullName: VersionOfUserCustomAction - summary: Gets a value that specifies an implementation specific version identifier. - remarks: 'Example: `"16.0.1.0"`' - isPreview: false - isDeprecated: false - syntax: - content: 'VersionOfUserCustomAction: string;' - return: - type: string +### YamlMime:TSType +name: IODataUserCustomAction +uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataUserCustomAction +summary: >- + Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation + here: + [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ClientSideComponentId + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' + package: '@microsoft/sp-odata-types!' + fullName: ClientSideComponentId + summary: The unique identifier of the client-side component defined with SharePoint Framework + remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' + isPreview: false + isDeprecated: false + syntax: + content: 'ClientSideComponentId: string;' + return: + type: string + - name: ClientSideComponentProperties + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' + package: '@microsoft/sp-odata-types!' + fullName: ClientSideComponentProperties + summary: Custom initialization properties for the client-side component. + remarks: >- + This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string + must contain a JSON object with custom initialization properties whose format and meaning are defined by the + client-side component. + + + Example: `"{ \"maxItemsToShow\": 123 }"` + isPreview: false + isDeprecated: false + syntax: + content: 'ClientSideComponentProperties: string;' + return: + type: string + - name: CommandUIExtension + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' + package: '@microsoft/sp-odata-types!' + fullName: CommandUIExtension + summary: >- + Gets or sets a value that specifies an implementation specific XML fragment that determines user interface + properties of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CommandUIExtension: string;' + return: + type: string + - name: Description + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: Gets or sets the description of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Description: string;' + return: + type: string + - name: Group + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' + package: '@microsoft/sp-odata-types!' + fullName: Group + summary: >- + Gets or sets a value that specifies an implementation-specific value that determines the position of the custom + action in the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Group: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: >- + Gets a value that specifies the identifier (GUID) of the custom action. Example: + `"48309f28-53aa-43ed-b113-625120e5af6f"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id: string;' + return: + type: string + - name: ImageUrl + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: ImageUrl + summary: Gets or sets the URL of the image associated with the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ImageUrl: string;' + return: + type: string + - name: Location + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' + package: '@microsoft/sp-odata-types!' + fullName: Location + summary: Gets or sets the location of the custom action. + remarks: 'Example: `"ClientSide.Application"`' + isPreview: false + isDeprecated: false + syntax: + content: 'Location: string;' + return: + type: string + - name: RegistrationId + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' + package: '@microsoft/sp-odata-types!' + fullName: RegistrationId + summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'RegistrationId: string;' + return: + type: string + - name: RegistrationType + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' + package: '@microsoft/sp-odata-types!' + fullName: RegistrationType + summary: Gets or sets the value that specifies the type of object associated with the custom action. + remarks: >- + Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType + = 4. + isPreview: false + isDeprecated: false + syntax: + content: 'RegistrationType: number;' + return: + type: number + - name: Rights + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' + package: '@microsoft/sp-odata-types!' + fullName: Rights + summary: Gets or sets the value that specifies the permissions needed for the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Rights: IODataBasePermission;' + return: + type: '' + - name: Scope + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' + package: '@microsoft/sp-odata-types!' + fullName: Scope + summary: Gets a value that specifies the scope of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Scope: number;' + return: + type: number + - name: ScriptBlock + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' + package: '@microsoft/sp-odata-types!' + fullName: ScriptBlock + summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ScriptBlock: string;' + return: + type: string + - name: ScriptSrc + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' + package: '@microsoft/sp-odata-types!' + fullName: ScriptSrc + summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ScriptSrc: string;' + return: + type: string + - name: Sequence + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' + package: '@microsoft/sp-odata-types!' + fullName: Sequence + summary: >- + Gets or sets the value that specifies an implementation-specific value that determines the order of the custom + action that appears on the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Sequence: number;' + return: + type: number + - name: Title + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: Gets or sets the display title of the custom action. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title: string;' + return: + type: string + - name: Url + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' + package: '@microsoft/sp-odata-types!' + fullName: Url + summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Url: string;' + return: + type: string + - name: VersionOfUserCustomAction + uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' + package: '@microsoft/sp-odata-types!' + fullName: VersionOfUserCustomAction + summary: Gets a value that specifies an implementation specific version identifier. + remarks: 'Example: `"16.0.1.0"`' + isPreview: false + isDeprecated: false + syntax: + content: 'VersionOfUserCustomAction: string;' + return: + type: string diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index b7088b83..9c878644 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -1,259 +1,259 @@ -### YamlMime:TSType -name: IODataWeb -uid: '@microsoft/sp-odata-types!IODataWeb:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataWeb -summary: >- - Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: Created - uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' - package: '@microsoft/sp-odata-types!' - fullName: Created - summary: |- - Gets a value that specifies when the site was created. - - Example: `"/Date(2016,0,20,12,58,7,0)/"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Created?: string;' - return: - type: string - - name: CurrentChangeToken - uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' - package: '@microsoft/sp-odata-types!' - fullName: CurrentChangeToken - summary: Represents the unique sequential location of a change within the change log. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'CurrentChangeToken?: IODataChangeToken;' - return: - type: '' - - name: CustomMasterUrl - uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: CustomMasterUrl - summary: |- - Gets or sets the URL for a custom master page file to apply to the website. - - Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'CustomMasterUrl?: string;' - return: - type: string - - name: Description - uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description - summary: Gets or sets the description for the site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Description?: string;' - return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id - summary: |- - Gets a value that specifies the site identifier for the site. - - Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Id?: string;' - return: - type: string - - name: IsMultilingual - uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' - package: '@microsoft/sp-odata-types!' - fullName: IsMultilingual - summary: Value that represents if the web was - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'IsMultilingual?: boolean;' - return: - type: boolean - - name: Language - uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' - package: '@microsoft/sp-odata-types!' - fullName: Language - summary: |- - Gets a value that specifies the LCID for the language that is used on the site. - - Example: `1033` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Language?: number;' - return: - type: number - - name: LastItemModifiedDate - uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' - package: '@microsoft/sp-odata-types!' - fullName: LastItemModifiedDate - summary: |- - Gets a value that specifies when an item was last modified in the site. - - Example: `"/Date(1453618828000)/"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'LastItemModifiedDate?: string;' - return: - type: string - - name: MasterUrl - uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: MasterUrl - summary: |- - Gets or sets the URL of the master page that is used for the website. - - Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'MasterUrl?: string;' - return: - type: string - - name: NoCrawl - uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' - package: '@microsoft/sp-odata-types!' - fullName: NoCrawl - summary: Determines if a particular web will be crawled by search or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'NoCrawl?: boolean;' - return: - type: boolean - - name: QuickLaunchEnabled - uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' - package: '@microsoft/sp-odata-types!' - fullName: QuickLaunchEnabled - summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'QuickLaunchEnabled?: boolean;' - return: - type: boolean - - name: RecycleBinEnabled - uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' - package: '@microsoft/sp-odata-types!' - fullName: RecycleBinEnabled - summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'RecycleBinEnabled?: boolean;' - return: - type: boolean - - name: ServerRelativeUrl - uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: ServerRelativeUrl - summary: |- - Gets or sets the server-relative URL for the Web site. - - Example: `"/sites/PubSite"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ServerRelativeUrl?: string;' - return: - type: string - - name: SiteLogoUrl - uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: SiteLogoUrl - summary: Gets the url for the logo of this particular site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'SiteLogoUrl?: string;' - return: - type: string - - name: Title - uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title - summary: The title of the web. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Title?: string;' - return: - type: string - - name: UIVersion - uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' - package: '@microsoft/sp-odata-types!' - fullName: UIVersion - summary: |- - Gets or sets the user interface (UI) version of the Web site. - - Example: `15` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'UIVersion?: number;' - return: - type: number - - name: Url - uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' - package: '@microsoft/sp-odata-types!' - fullName: Url - summary: |- - Gets the absolute URL for the website. - - Example: `"http://example.com/sites/PubSite"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Url?: string;' - return: - type: string - - name: WebTemplate - uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' - package: '@microsoft/sp-odata-types!' - fullName: WebTemplate - summary: |- - Gets the name of the site definition or site template that was used to create the site. - - Example: `"BLANKINTERNET"` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'WebTemplate?: string;' - return: - type: string +### YamlMime:TSType +name: IODataWeb +uid: '@microsoft/sp-odata-types!IODataWeb:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataWeb +summary: >- + Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: Created + uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' + package: '@microsoft/sp-odata-types!' + fullName: Created + summary: |- + Gets a value that specifies when the site was created. + + Example: `"/Date(2016,0,20,12,58,7,0)/"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Created?: string;' + return: + type: string + - name: CurrentChangeToken + uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' + package: '@microsoft/sp-odata-types!' + fullName: CurrentChangeToken + summary: Represents the unique sequential location of a change within the change log. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CurrentChangeToken?: IODataChangeToken;' + return: + type: '' + - name: CustomMasterUrl + uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: CustomMasterUrl + summary: |- + Gets or sets the URL for a custom master page file to apply to the website. + + Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'CustomMasterUrl?: string;' + return: + type: string + - name: Description + uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: Gets or sets the description for the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Description?: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: |- + Gets a value that specifies the site identifier for the site. + + Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Id?: string;' + return: + type: string + - name: IsMultilingual + uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' + package: '@microsoft/sp-odata-types!' + fullName: IsMultilingual + summary: Value that represents if the web was + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'IsMultilingual?: boolean;' + return: + type: boolean + - name: Language + uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' + package: '@microsoft/sp-odata-types!' + fullName: Language + summary: |- + Gets a value that specifies the LCID for the language that is used on the site. + + Example: `1033` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Language?: number;' + return: + type: number + - name: LastItemModifiedDate + uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' + package: '@microsoft/sp-odata-types!' + fullName: LastItemModifiedDate + summary: |- + Gets a value that specifies when an item was last modified in the site. + + Example: `"/Date(1453618828000)/"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'LastItemModifiedDate?: string;' + return: + type: string + - name: MasterUrl + uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: MasterUrl + summary: |- + Gets or sets the URL of the master page that is used for the website. + + Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'MasterUrl?: string;' + return: + type: string + - name: NoCrawl + uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' + package: '@microsoft/sp-odata-types!' + fullName: NoCrawl + summary: Determines if a particular web will be crawled by search or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'NoCrawl?: boolean;' + return: + type: boolean + - name: QuickLaunchEnabled + uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' + package: '@microsoft/sp-odata-types!' + fullName: QuickLaunchEnabled + summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'QuickLaunchEnabled?: boolean;' + return: + type: boolean + - name: RecycleBinEnabled + uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' + package: '@microsoft/sp-odata-types!' + fullName: RecycleBinEnabled + summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'RecycleBinEnabled?: boolean;' + return: + type: boolean + - name: ServerRelativeUrl + uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: ServerRelativeUrl + summary: |- + Gets or sets the server-relative URL for the Web site. + + Example: `"/sites/PubSite"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ServerRelativeUrl?: string;' + return: + type: string + - name: SiteLogoUrl + uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: SiteLogoUrl + summary: Gets the url for the logo of this particular site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'SiteLogoUrl?: string;' + return: + type: string + - name: Title + uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' + package: '@microsoft/sp-odata-types!' + fullName: Title + summary: The title of the web. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Title?: string;' + return: + type: string + - name: UIVersion + uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' + package: '@microsoft/sp-odata-types!' + fullName: UIVersion + summary: |- + Gets or sets the user interface (UI) version of the Web site. + + Example: `15` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'UIVersion?: number;' + return: + type: number + - name: Url + uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' + package: '@microsoft/sp-odata-types!' + fullName: Url + summary: |- + Gets the absolute URL for the website. + + Example: `"http://example.com/sites/PubSite"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'Url?: string;' + return: + type: string + - name: WebTemplate + uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' + package: '@microsoft/sp-odata-types!' + fullName: WebTemplate + summary: |- + Gets the name of the site definition or site template that was used to create the site. + + Example: `"BLANKINTERNET"` + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'WebTemplate?: string;' + return: + type: string diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index e2122ba4..97eb8e6c 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -1,19 +1,19 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-page-context!' -name: '@microsoft/sp-page-context' -type: package -summary: Page context services for the SharePoint Framework -classes: - - '@microsoft/sp-page-context!CultureInfo:class' - - '@microsoft/sp-page-context!PageContext:class' - - '@microsoft/sp-page-context!SPField:class' - - '@microsoft/sp-page-context!SPList:class' - - '@microsoft/sp-page-context!SPListItem:class' - - '@microsoft/sp-page-context!SPPermission:class' - - '@microsoft/sp-page-context!SPSite:class' - - '@microsoft/sp-page-context!SPTimeZone:class' - - '@microsoft/sp-page-context!SPUser:class' - - '@microsoft/sp-page-context!SPWeb:class' -interfaces: - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - '@microsoft/sp-page-context!ISPTimeZoneData:interface' +### YamlMime:TSPackage +uid: '@microsoft/sp-page-context!' +name: '@microsoft/sp-page-context' +type: package +summary: Page context services for the SharePoint Framework +classes: + - '@microsoft/sp-page-context!CultureInfo:class' + - '@microsoft/sp-page-context!PageContext:class' + - '@microsoft/sp-page-context!SPField:class' + - '@microsoft/sp-page-context!SPList:class' + - '@microsoft/sp-page-context!SPListItem:class' + - '@microsoft/sp-page-context!SPPermission:class' + - '@microsoft/sp-page-context!SPSite:class' + - '@microsoft/sp-page-context!SPTimeZone:class' + - '@microsoft/sp-page-context!SPUser:class' + - '@microsoft/sp-page-context!SPWeb:class' +interfaces: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - '@microsoft/sp-page-context!ISPTimeZoneData:interface' diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 1a6fdf7d..9734254c 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -1,63 +1,63 @@ -### YamlMime:TSType -name: CultureInfo -uid: '@microsoft/sp-page-context!CultureInfo:class' -package: '@microsoft/sp-page-context!' -fullName: CultureInfo -summary: >- - This class is primarily used with the `PageContext` class. It provides culture info for the current user of the - application. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `CultureInfo` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: currentCultureName - uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' - package: '@microsoft/sp-page-context!' - fullName: currentCultureName - summary: >- - This string determines the language default format for dates, times, numbers, currency values, the sorting order - of text, casing conventions, and string comparisons. - remarks: >- - This property may be an empty string, but it will never be undefined. - - - Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the - date as 1/8 instead of 8/1. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly currentCultureName: string;' - return: - type: string - - name: currentUICultureName - uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' - package: '@microsoft/sp-page-context!' - fullName: currentUICultureName - summary: This string determines the default user interface language. This used for localization and translation of text. - remarks: >- - This property may have an empty string, but will never be undefined. - - - Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to - translate the word "hello" to "hola". - isPreview: false - isDeprecated: false - syntax: - content: 'readonly currentUICultureName: string;' - return: - type: string - - name: isRightToLeft - uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' - package: '@microsoft/sp-page-context!' - fullName: isRightToLeft - summary: This boolean represents the dominant direction of written text for the default user interface language. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly isRightToLeft: boolean;' - return: - type: boolean +### YamlMime:TSType +name: CultureInfo +uid: '@microsoft/sp-page-context!CultureInfo:class' +package: '@microsoft/sp-page-context!' +fullName: CultureInfo +summary: >- + This class is primarily used with the `PageContext` class. It provides culture info for the current user of the + application. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `CultureInfo` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: currentCultureName + uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' + package: '@microsoft/sp-page-context!' + fullName: currentCultureName + summary: >- + This string determines the language default format for dates, times, numbers, currency values, the sorting order + of text, casing conventions, and string comparisons. + remarks: >- + This property may be an empty string, but it will never be undefined. + + + Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the + date as 1/8 instead of 8/1. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly currentCultureName: string;' + return: + type: string + - name: currentUICultureName + uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' + package: '@microsoft/sp-page-context!' + fullName: currentUICultureName + summary: This string determines the default user interface language. This used for localization and translation of text. + remarks: >- + This property may have an empty string, but will never be undefined. + + + Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to + translate the word "hello" to "hola". + isPreview: false + isDeprecated: false + syntax: + content: 'readonly currentUICultureName: string;' + return: + type: string + - name: isRightToLeft + uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' + package: '@microsoft/sp-page-context!' + fullName: isRightToLeft + summary: This boolean represents the dominant direction of written text for the default user interface language. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isRightToLeft: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index 2c5d8f3d..56fcbdb8 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -1,107 +1,107 @@ -### YamlMime:TSType -name: ISPSystemTime -uid: '@microsoft/sp-page-context!ISPSystemTime:interface' -package: '@microsoft/sp-page-context!' -fullName: ISPSystemTime -summary: Interface that represents a `SPSystemTime` structure. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: Day - uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' - package: '@microsoft/sp-page-context!' - fullName: Day - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Day: number;' - return: - type: number - - name: DayOfWeek - uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' - package: '@microsoft/sp-page-context!' - fullName: DayOfWeek - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'DayOfWeek: number;' - return: - type: number - - name: Hour - uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' - package: '@microsoft/sp-page-context!' - fullName: Hour - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Hour: number;' - return: - type: number - - name: Milliseconds - uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' - package: '@microsoft/sp-page-context!' - fullName: Milliseconds - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Milliseconds: number;' - return: - type: number - - name: Minute - uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' - package: '@microsoft/sp-page-context!' - fullName: Minute - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Minute: number;' - return: - type: number - - name: Month - uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' - package: '@microsoft/sp-page-context!' - fullName: Month - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Month: number;' - return: - type: number - - name: Second - uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' - package: '@microsoft/sp-page-context!' - fullName: Second - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Second: number;' - return: - type: number - - name: Year - uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' - package: '@microsoft/sp-page-context!' - fullName: Year - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'Year: number;' - return: - type: number +### YamlMime:TSType +name: ISPSystemTime +uid: '@microsoft/sp-page-context!ISPSystemTime:interface' +package: '@microsoft/sp-page-context!' +fullName: ISPSystemTime +summary: Interface that represents a `SPSystemTime` structure. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: Day + uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' + package: '@microsoft/sp-page-context!' + fullName: Day + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Day: number;' + return: + type: number + - name: DayOfWeek + uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' + package: '@microsoft/sp-page-context!' + fullName: DayOfWeek + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'DayOfWeek: number;' + return: + type: number + - name: Hour + uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' + package: '@microsoft/sp-page-context!' + fullName: Hour + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Hour: number;' + return: + type: number + - name: Milliseconds + uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' + package: '@microsoft/sp-page-context!' + fullName: Milliseconds + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Milliseconds: number;' + return: + type: number + - name: Minute + uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' + package: '@microsoft/sp-page-context!' + fullName: Minute + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Minute: number;' + return: + type: number + - name: Month + uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' + package: '@microsoft/sp-page-context!' + fullName: Month + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Month: number;' + return: + type: number + - name: Second + uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' + package: '@microsoft/sp-page-context!' + fullName: Second + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Second: number;' + return: + type: number + - name: Year + uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' + package: '@microsoft/sp-page-context!' + fullName: Year + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'Year: number;' + return: + type: number diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 64feba8b..af727df3 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -1,95 +1,95 @@ -### YamlMime:TSType -name: ISPTimeZoneData -uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' -package: '@microsoft/sp-page-context!' -fullName: ISPTimeZoneData -summary: Interface that represents the data necessary to build an `TimeZone` object. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: daylightDate - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' - package: '@microsoft/sp-page-context!' - fullName: daylightDate - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'daylightDate: ISPSystemTime;' - return: - type: '' - - name: daylightOffset - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' - package: '@microsoft/sp-page-context!' - fullName: daylightOffset - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'daylightOffset: number;' - return: - type: number - - name: description - uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' - package: '@microsoft/sp-page-context!' - fullName: description - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'description: string;' - return: - type: string - - name: id - uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'id: number;' - return: - type: number - - name: offset - uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' - package: '@microsoft/sp-page-context!' - fullName: offset - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'offset: number;' - return: - type: number - - name: standardDate - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' - package: '@microsoft/sp-page-context!' - fullName: standardDate - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'standardDate: ISPSystemTime;' - return: - type: '' - - name: standardOffset - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' - package: '@microsoft/sp-page-context!' - fullName: standardOffset - summary: '' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'standardOffset: number;' - return: - type: number +### YamlMime:TSType +name: ISPTimeZoneData +uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' +package: '@microsoft/sp-page-context!' +fullName: ISPTimeZoneData +summary: Interface that represents the data necessary to build an `TimeZone` object. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: daylightDate + uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' + package: '@microsoft/sp-page-context!' + fullName: daylightDate + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'daylightDate: ISPSystemTime;' + return: + type: '' + - name: daylightOffset + uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' + package: '@microsoft/sp-page-context!' + fullName: daylightOffset + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'daylightOffset: number;' + return: + type: number + - name: description + uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' + package: '@microsoft/sp-page-context!' + fullName: description + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'description: string;' + return: + type: string + - name: id + uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'id: number;' + return: + type: number + - name: offset + uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' + package: '@microsoft/sp-page-context!' + fullName: offset + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'offset: number;' + return: + type: number + - name: standardDate + uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' + package: '@microsoft/sp-page-context!' + fullName: standardDate + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'standardDate: ISPSystemTime;' + return: + type: '' + - name: standardOffset + uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' + package: '@microsoft/sp-page-context!' + fullName: standardOffset + summary: '' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'standardOffset: number;' + return: + type: number diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 04034975..0d23aa1e 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -1,171 +1,171 @@ -### YamlMime:TSType -name: PageContext -uid: '@microsoft/sp-page-context!PageContext:class' -package: '@microsoft/sp-page-context!' -fullName: PageContext -summary: The SharePoint page context object. -remarks: >- - The page context provides standard definitions for common SharePoint objects that need to be shared between the - client-side application, web parts, and other components. Typically the data is fetched via REST queries when - navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-page-context!PageContext:constructor(1)' - package: '@microsoft/sp-page-context!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `PageContext` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: aadInfo - uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' - package: '@microsoft/sp-page-context!' - fullName: aadInfo - summary: >- - Contextual information for communicating with Azure Active Directory. If the current page doesn't have an - associated Azure Active Directory tenant, this property will be undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get aadInfo(): AzureActiveDirectoryInfo | undefined;' - return: - type: ' | undefined' - - name: cultureInfo - uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' - package: '@microsoft/sp-page-context!' - fullName: cultureInfo - summary: >- - It provides culture info for the current user of the application. This class is primarily used with the - `PageContext` class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get cultureInfo(): CultureInfo;' - return: - type: '' - - name: isInitialized - uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' - package: '@microsoft/sp-page-context!' - fullName: isInitialized - summary: Returns whether the `PageContext` has been initialized. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get isInitialized(): boolean;' - return: - type: boolean - - name: legacyPageContext - uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' - package: '@microsoft/sp-page-context!' - fullName: legacyPageContext - summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. - remarks: >- - This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents - are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may - change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint - Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility - guarantees. - - - NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript - API, please file an issue on GitHub. The intention is that no modern application should need to rely on the - `legacyPageContext` object. - isPreview: false - isDeprecated: false - syntax: - content: 'get legacyPageContext(): any;' - return: - type: any - - name: list - uid: '@microsoft/sp-page-context!PageContext#list:member' - package: '@microsoft/sp-page-context!' - fullName: list - summary: >- - Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the - current page, this property will be undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get list(): SPList | undefined;' - return: - type: ' | undefined' - - name: listItem - uid: '@microsoft/sp-page-context!PageContext#listItem:member' - package: '@microsoft/sp-page-context!' - fullName: listItem - summary: >- - Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated - to the current page, this property will be undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get listItem(): SPListItem | undefined;' - return: - type: ' | undefined' - - name: serviceKey - uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' - package: '@microsoft/sp-page-context!' - fullName: serviceKey - summary: The service key for PageContext. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> - - name: site - uid: '@microsoft/sp-page-context!PageContext#site:member' - package: '@microsoft/sp-page-context!' - fullName: site - summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get site(): SPSite;' - return: - type: '' - - name: user - uid: '@microsoft/sp-page-context!PageContext#user:member' - package: '@microsoft/sp-page-context!' - fullName: user - summary: >- - It provides contextual information for the SharePoint user that is accessing the page. This class is primarily - used with the `PageContext` class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get user(): SPUser;' - return: - type: '' - - name: web - uid: '@microsoft/sp-page-context!PageContext#web:member' - package: '@microsoft/sp-page-context!' - fullName: web - summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get web(): SPWeb;' - return: - type: '' +### YamlMime:TSType +name: PageContext +uid: '@microsoft/sp-page-context!PageContext:class' +package: '@microsoft/sp-page-context!' +fullName: PageContext +summary: The SharePoint page context object. +remarks: >- + The page context provides standard definitions for common SharePoint objects that need to be shared between the + client-side application, web parts, and other components. Typically the data is fetched via REST queries when + navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(serviceScope) + uid: '@microsoft/sp-page-context!PageContext:constructor(1)' + package: '@microsoft/sp-page-context!' + fullName: (constructor)(serviceScope) + summary: Constructs a new instance of the `PageContext` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: '' +properties: + - name: aadInfo + uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' + package: '@microsoft/sp-page-context!' + fullName: aadInfo + summary: >- + Contextual information for communicating with Azure Active Directory. If the current page doesn't have an + associated Azure Active Directory tenant, this property will be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get aadInfo(): AzureActiveDirectoryInfo | undefined;' + return: + type: ' | undefined' + - name: cultureInfo + uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' + package: '@microsoft/sp-page-context!' + fullName: cultureInfo + summary: >- + It provides culture info for the current user of the application. This class is primarily used with the + `PageContext` class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get cultureInfo(): CultureInfo;' + return: + type: '' + - name: isInitialized + uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' + package: '@microsoft/sp-page-context!' + fullName: isInitialized + summary: Returns whether the `PageContext` has been initialized. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get isInitialized(): boolean;' + return: + type: boolean + - name: legacyPageContext + uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' + package: '@microsoft/sp-page-context!' + fullName: legacyPageContext + summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. + remarks: >- + This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents + are similar to the `_spPageContextInfo` window variable from classic pages. The contents of this variable may + change in future releases of SharePoint. For this reason, new projects are encouraged to use the SharePoint + Framework TypeScript APIs instead, since they are fully documented and provide reliable backwards compatibility + guarantees. + + + NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript + API, please file an issue on GitHub. The intention is that no modern application should need to rely on the + `legacyPageContext` object. + isPreview: false + isDeprecated: false + syntax: + content: 'get legacyPageContext(): any;' + return: + type: any + - name: list + uid: '@microsoft/sp-page-context!PageContext#list:member' + package: '@microsoft/sp-page-context!' + fullName: list + summary: >- + Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the + current page, this property will be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get list(): SPList | undefined;' + return: + type: ' | undefined' + - name: listItem + uid: '@microsoft/sp-page-context!PageContext#listItem:member' + package: '@microsoft/sp-page-context!' + fullName: listItem + summary: >- + Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated + to the current page, this property will be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get listItem(): SPListItem | undefined;' + return: + type: ' | undefined' + - name: serviceKey + uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' + package: '@microsoft/sp-page-context!' + fullName: serviceKey + summary: The service key for PageContext. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: >- + <> + - name: site + uid: '@microsoft/sp-page-context!PageContext#site:member' + package: '@microsoft/sp-page-context!' + fullName: site + summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get site(): SPSite;' + return: + type: '' + - name: user + uid: '@microsoft/sp-page-context!PageContext#user:member' + package: '@microsoft/sp-page-context!' + fullName: user + summary: >- + It provides contextual information for the SharePoint user that is accessing the page. This class is primarily + used with the `PageContext` class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get user(): SPUser;' + return: + type: '' + - name: web + uid: '@microsoft/sp-page-context!PageContext#web:member' + package: '@microsoft/sp-page-context!' + fullName: web + summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get web(): SPWeb;' + return: + type: '' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 9fbaa07e..3bd78259 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -1,103 +1,103 @@ -### YamlMime:TSType -name: SPField -uid: '@microsoft/sp-page-context!SPField:class' -package: '@microsoft/sp-page-context!' -fullName: SPField -summary: A field represents the data model for a column in SharePoint list view. -remarks: >- - This is the client-side equivalent for SharePoint `SPField` class. It is used with the - `@microsoft/sp-listview-extensibility` package. - - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPField` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: clientSideComponentId - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' - package: '@microsoft/sp-page-context!' - fullName: clientSideComponentId - summary: The unique identifier of the client-side component associated with the field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly clientSideComponentId: Guid | undefined;' - return: - type: ' | undefined' - - name: clientSideComponentProperties - uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' - package: '@microsoft/sp-page-context!' - fullName: clientSideComponentProperties - summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. - remarks: >- - If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning - are defined by the client-side component. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly clientSideComponentProperties: string;' - return: - type: string - - name: displayName - uid: '@microsoft/sp-page-context!SPField#displayName:member' - package: '@microsoft/sp-page-context!' - fullName: displayName - summary: The display name of the field. This name is shown as column name in UI. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly displayName: string;' - return: - type: string - - name: fieldType - uid: '@microsoft/sp-page-context!SPField#fieldType:member' - package: '@microsoft/sp-page-context!' - fullName: fieldType - summary: The type of the field represented as a string - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly fieldType: string;' - return: - type: string - - name: id - uid: '@microsoft/sp-page-context!SPField#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: The GUID identifier for this field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly id: Guid;' - return: - type: '' - - name: internalName - uid: '@microsoft/sp-page-context!SPField#internalName:member' - package: '@microsoft/sp-page-context!' - fullName: internalName - summary: The internal name of the field. This name is usually used to find the field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly internalName: string;' - return: - type: string - - name: isRequired - uid: '@microsoft/sp-page-context!SPField#isRequired:member' - package: '@microsoft/sp-page-context!' - fullName: isRequired - summary: Whether the field is required for each list item in the list - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly isRequired: boolean;' - return: - type: boolean +### YamlMime:TSType +name: SPField +uid: '@microsoft/sp-page-context!SPField:class' +package: '@microsoft/sp-page-context!' +fullName: SPField +summary: A field represents the data model for a column in SharePoint list view. +remarks: >- + This is the client-side equivalent for SharePoint `SPField` class. It is used with the + `@microsoft/sp-listview-extensibility` package. + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPField` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: clientSideComponentId + uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' + package: '@microsoft/sp-page-context!' + fullName: clientSideComponentId + summary: The unique identifier of the client-side component associated with the field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly clientSideComponentId: Guid | undefined;' + return: + type: ' | undefined' + - name: clientSideComponentProperties + uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' + package: '@microsoft/sp-page-context!' + fullName: clientSideComponentProperties + summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. + remarks: >- + If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning + are defined by the client-side component. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly clientSideComponentProperties: string;' + return: + type: string + - name: displayName + uid: '@microsoft/sp-page-context!SPField#displayName:member' + package: '@microsoft/sp-page-context!' + fullName: displayName + summary: The display name of the field. This name is shown as column name in UI. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly displayName: string;' + return: + type: string + - name: fieldType + uid: '@microsoft/sp-page-context!SPField#fieldType:member' + package: '@microsoft/sp-page-context!' + fullName: fieldType + summary: The type of the field represented as a string + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fieldType: string;' + return: + type: string + - name: id + uid: '@microsoft/sp-page-context!SPField#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The GUID identifier for this field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: internalName + uid: '@microsoft/sp-page-context!SPField#internalName:member' + package: '@microsoft/sp-page-context!' + fullName: internalName + summary: The internal name of the field. This name is usually used to find the field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly internalName: string;' + return: + type: string + - name: isRequired + uid: '@microsoft/sp-page-context!SPField#isRequired:member' + package: '@microsoft/sp-page-context!' + fullName: isRequired + summary: Whether the field is required for each list item in the list + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isRequired: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index b6978acc..b84bd9f7 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -1,67 +1,67 @@ -### YamlMime:TSType -name: SPList -uid: '@microsoft/sp-page-context!SPList:class' -package: '@microsoft/sp-page-context!' -fullName: SPList -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list - that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPList` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: id - uid: '@microsoft/sp-page-context!SPList#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: >- - The GUID that identifies the SPList on the server. This property could be undefined if the information isn't - available. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly id: Guid;' - return: - type: '' - - name: permissions - uid: '@microsoft/sp-page-context!SPList#permissions:member' - package: '@microsoft/sp-page-context!' - fullName: permissions - summary: >- - Return the SPPermission object that represents the set of permissions that the current user has for interacting - with the list. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly permissions: SPPermission;' - return: - type: '' - - name: serverRelativeUrl - uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' - package: '@microsoft/sp-page-context!' - fullName: serverRelativeUrl - summary: Returns the server-relative URL for this `SPList`. - remarks: 'Example: "/sites/PubSite"' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly serverRelativeUrl: string;' - return: - type: string - - name: title - uid: '@microsoft/sp-page-context!SPList#title:member' - package: '@microsoft/sp-page-context!' - fullName: title - summary: Returns the title for this `SPList`. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly title: string;' - return: - type: string +### YamlMime:TSType +name: SPList +uid: '@microsoft/sp-page-context!SPList:class' +package: '@microsoft/sp-page-context!' +fullName: SPList +summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list + that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPList` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: id + uid: '@microsoft/sp-page-context!SPList#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: >- + The GUID that identifies the SPList on the server. This property could be undefined if the information isn't + available. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: permissions + uid: '@microsoft/sp-page-context!SPList#permissions:member' + package: '@microsoft/sp-page-context!' + fullName: permissions + summary: >- + Return the SPPermission object that represents the set of permissions that the current user has for interacting + with the list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly permissions: SPPermission;' + return: + type: '' + - name: serverRelativeUrl + uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' + package: '@microsoft/sp-page-context!' + fullName: serverRelativeUrl + summary: Returns the server-relative URL for this `SPList`. + remarks: 'Example: "/sites/PubSite"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-page-context!SPList#title:member' + package: '@microsoft/sp-page-context!' + fullName: title + summary: Returns the title for this `SPList`. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly title: string;' + return: + type: string diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 91dfb2b9..01613062 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -1,27 +1,27 @@ -### YamlMime:TSType -name: SPListItem -uid: '@microsoft/sp-page-context!SPListItem:class' -package: '@microsoft/sp-page-context!' -fullName: SPListItem -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list - item that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPListItem` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: id - uid: '@microsoft/sp-page-context!SPListItem#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: The number that identifies the `SPListItem` on the server. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly id: number;' - return: - type: number +### YamlMime:TSType +name: SPListItem +uid: '@microsoft/sp-page-context!SPListItem:class' +package: '@microsoft/sp-page-context!' +fullName: SPListItem +summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list + item that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPListItem` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: id + uid: '@microsoft/sp-page-context!SPListItem#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The number that identifies the `SPListItem` on the server. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: number;' + return: + type: number diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 14045f95..4bc23a46 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -1,536 +1,536 @@ -### YamlMime:TSType -name: SPPermission -uid: '@microsoft/sp-page-context!SPPermission:class' -package: '@microsoft/sp-page-context!' -fullName: SPPermission -summary: Used to test whether the current user has a requested set of permissions. -remarks: >- - Specifies the built-in permissions available in SharePoint Foundation - - - For more information, see: - [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(value) - uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' - package: '@microsoft/sp-page-context!' - fullName: (constructor)(value) - summary: Constructs a new instance of the `SPPermission` class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(value: IODataBasePermission);' - parameters: - - id: value - description: '' - type: '' -properties: - - name: addAndCustomizePages - uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' - package: '@microsoft/sp-page-context!' - fullName: addAndCustomizePages - summary: >- - Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint - Foundation–compatible editor. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly addAndCustomizePages: SPPermission;' - return: - type: '' - - name: addDelPrivateWebParts - uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' - package: '@microsoft/sp-page-context!' - fullName: addDelPrivateWebParts - summary: Add or remove personal web parts on a web part Page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly addDelPrivateWebParts: SPPermission;' - return: - type: '' - - name: addListItems - uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' - package: '@microsoft/sp-page-context!' - fullName: addListItems - summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly addListItems: SPPermission;' - return: - type: '' - - name: applyStyleSheets - uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' - package: '@microsoft/sp-page-context!' - fullName: applyStyleSheets - summary: Apply a style sheet (.css file) to the Web site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly applyStyleSheets: SPPermission;' - return: - type: '' - - name: applyThemeAndBorder - uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' - package: '@microsoft/sp-page-context!' - fullName: applyThemeAndBorder - summary: Apply a theme or borders to the entire Web site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly applyThemeAndBorder: SPPermission;' - return: - type: '' - - name: approveItems - uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' - package: '@microsoft/sp-page-context!' - fullName: approveItems - summary: Approve a minor version of a list item or document. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly approveItems: SPPermission;' - return: - type: '' - - name: browseDirectories - uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' - package: '@microsoft/sp-page-context!' - fullName: browseDirectories - summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly browseDirectories: SPPermission;' - return: - type: '' - - name: browserUserInfo - uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' - package: '@microsoft/sp-page-context!' - fullName: browserUserInfo - summary: View information about users of the Web site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly browserUserInfo: SPPermission;' - return: - type: '' - - name: cancelCheckout - uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' - package: '@microsoft/sp-page-context!' - fullName: cancelCheckout - summary: Discard or check in a document which is checked out to another user. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly cancelCheckout: SPPermission;' - return: - type: '' - - name: createAlerts - uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' - package: '@microsoft/sp-page-context!' - fullName: createAlerts - summary: Create e-mail alerts. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly createAlerts: SPPermission;' - return: - type: '' - - name: createGroups - uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' - package: '@microsoft/sp-page-context!' - fullName: createGroups - summary: Create a group of users that can be used anywhere within the site collection. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly createGroups: SPPermission;' - return: - type: '' - - name: createSSCSite - uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' - package: '@microsoft/sp-page-context!' - fullName: createSSCSite - summary: Create a Web site using Self-Service Site Creation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly createSSCSite: SPPermission;' - return: - type: '' - - name: deleteListItems - uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' - package: '@microsoft/sp-page-context!' - fullName: deleteListItems - summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly deleteListItems: SPPermission;' - return: - type: '' - - name: deleteVersions - uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' - package: '@microsoft/sp-page-context!' - fullName: deleteVersions - summary: Delete past versions of a list item or document. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly deleteVersions: SPPermission;' - return: - type: '' - - name: editListItems - uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' - package: '@microsoft/sp-page-context!' - fullName: editListItems - summary: >- - Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and - customize web part Pages in document libraries. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly editListItems: SPPermission;' - return: - type: '' - - name: editMyUserInfo - uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' - package: '@microsoft/sp-page-context!' - fullName: editMyUserInfo - summary: 'Allows a user to change his or her user information, such as adding a picture.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly editMyUserInfo: SPPermission;' - return: - type: '' - - name: emptyMask - uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' - package: '@microsoft/sp-page-context!' - fullName: emptyMask - summary: Has no permissions on the Web site. Not available through the user interface. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly emptyMask: SPPermission;' - return: - type: '' - - name: enumeratePermissions - uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' - package: '@microsoft/sp-page-context!' - fullName: enumeratePermissions - summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly enumeratePermissions: SPPermission;' - return: - type: '' - - name: fullMask - uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' - package: '@microsoft/sp-page-context!' - fullName: fullMask - summary: Has all permissions on the Web site. Not available through the user interface. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly fullMask: SPPermission;' - return: - type: '' - - name: layoutsPage - uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' - package: '@microsoft/sp-page-context!' - fullName: layoutsPage - summary: View the layouts page? - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly layoutsPage: SPPermission;' - return: - type: '' - - name: manageAlerts - uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' - package: '@microsoft/sp-page-context!' - fullName: manageAlerts - summary: Manage alerts for all users of the Web site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly manageAlerts: SPPermission;' - return: - type: '' - - name: manageLists - uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' - package: '@microsoft/sp-page-context!' - fullName: manageLists - summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly manageLists: SPPermission;' - return: - type: '' - - name: managePermissions - uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' - package: '@microsoft/sp-page-context!' - fullName: managePermissions - summary: Create and change permission levels on the Web site and assign permissions to users and groups. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly managePermissions: SPPermission;' - return: - type: '' - - name: managePersonalViews - uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' - package: '@microsoft/sp-page-context!' - fullName: managePersonalViews - summary: 'Create, change, and delete personal views of lists.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly managePersonalViews: SPPermission;' - return: - type: '' - - name: manageSubwebs - uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' - package: '@microsoft/sp-page-context!' - fullName: manageSubwebs - summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly manageSubwebs: SPPermission;' - return: - type: '' - - name: manageWeb - uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' - package: '@microsoft/sp-page-context!' - fullName: manageWeb - summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. - remarks: >- - Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user - interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties - of site collection scoped Features through the object model. To browse to the Site Collection Features page and - activate or deactivate site collection scoped Features through the UI, you must be a site collection - administrator. - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly manageWeb: SPPermission;' - return: - type: '' - - name: open - uid: '@microsoft/sp-page-context!SPPermission.open:member' - package: '@microsoft/sp-page-context!' - fullName: open - summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly open: SPPermission;' - return: - type: '' - - name: openItems - uid: '@microsoft/sp-page-context!SPPermission.openItems:member' - package: '@microsoft/sp-page-context!' - fullName: openItems - summary: View the source of documents with server-side file handlers. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly openItems: SPPermission;' - return: - type: '' - - name: updatePersonalWebParts - uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' - package: '@microsoft/sp-page-context!' - fullName: updatePersonalWebParts - summary: Update web parts to display personalized information. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly updatePersonalWebParts: SPPermission;' - return: - type: '' - - name: useClientIntegration - uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' - package: '@microsoft/sp-page-context!' - fullName: useClientIntegration - summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly useClientIntegration: SPPermission;' - return: - type: '' - - name: useRemoteAPIs - uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' - package: '@microsoft/sp-page-context!' - fullName: useRemoteAPIs - summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly useRemoteAPIs: SPPermission;' - return: - type: '' - - name: value - uid: '@microsoft/sp-page-context!SPPermission#value:member' - package: '@microsoft/sp-page-context!' - fullName: value - summary: Returns the value of this SPPermission object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get value(): IODataBasePermission;' - return: - type: '' - - name: viewFormPages - uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' - package: '@microsoft/sp-page-context!' - fullName: viewFormPages - summary: 'View forms, views, and application pages, and enumerate lists.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly viewFormPages: SPPermission;' - return: - type: '' - - name: viewListItems - uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' - package: '@microsoft/sp-page-context!' - fullName: viewListItems - summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly viewListItems: SPPermission;' - return: - type: '' - - name: viewPages - uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' - package: '@microsoft/sp-page-context!' - fullName: viewPages - summary: View pages in a Web site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly viewPages: SPPermission;' - return: - type: '' - - name: viewUsageData - uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' - package: '@microsoft/sp-page-context!' - fullName: viewUsageData - summary: View reports on Web site usage. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly viewUsageData: SPPermission;' - return: - type: '' - - name: viewVersions - uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' - package: '@microsoft/sp-page-context!' - fullName: viewVersions - summary: View past versions of a list item or document. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly viewVersions: SPPermission;' - return: - type: '' -methods: - - name: hasAllPermissions(requestedPerms) - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' - package: '@microsoft/sp-page-context!' - fullName: hasAllPermissions(requestedPerms) - summary: Function for testing whether a given permission mask has all of the requested permissions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' - parameters: - - id: requestedPerms - description: Any number of SPPermission objects to be compared against the original - type: '[]' - return: - type: boolean - description: '' - - name: hasAnyPermissions(requestedPerms) - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' - package: '@microsoft/sp-page-context!' - fullName: hasAnyPermissions(requestedPerms) - summary: Function for testing whether a given permission mask has any of the requested permissions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' - parameters: - - id: requestedPerms - description: Any number of SPPermission objects to be compared against the original - type: '[]' - return: - type: boolean - description: '' - - name: hasPermission(requestedPerm) - uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' - package: '@microsoft/sp-page-context!' - fullName: hasPermission(requestedPerm) - summary: Function for testing whether a given permission mask has the requested permission. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'hasPermission(requestedPerm: SPPermission): boolean;' - parameters: - - id: requestedPerm - description: The SPPermission object to be compared against the original - type: '' - return: - type: boolean - description: '' +### YamlMime:TSType +name: SPPermission +uid: '@microsoft/sp-page-context!SPPermission:class' +package: '@microsoft/sp-page-context!' +fullName: SPPermission +summary: Used to test whether the current user has a requested set of permissions. +remarks: >- + Specifies the built-in permissions available in SharePoint Foundation + + + For more information, see: + [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(value) + uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' + package: '@microsoft/sp-page-context!' + fullName: (constructor)(value) + summary: Constructs a new instance of the `SPPermission` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(value: IODataBasePermission);' + parameters: + - id: value + description: '' + type: '' +properties: + - name: addAndCustomizePages + uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' + package: '@microsoft/sp-page-context!' + fullName: addAndCustomizePages + summary: >- + Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint + Foundation–compatible editor. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly addAndCustomizePages: SPPermission;' + return: + type: '' + - name: addDelPrivateWebParts + uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' + package: '@microsoft/sp-page-context!' + fullName: addDelPrivateWebParts + summary: Add or remove personal web parts on a web part Page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly addDelPrivateWebParts: SPPermission;' + return: + type: '' + - name: addListItems + uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' + package: '@microsoft/sp-page-context!' + fullName: addListItems + summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly addListItems: SPPermission;' + return: + type: '' + - name: applyStyleSheets + uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' + package: '@microsoft/sp-page-context!' + fullName: applyStyleSheets + summary: Apply a style sheet (.css file) to the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly applyStyleSheets: SPPermission;' + return: + type: '' + - name: applyThemeAndBorder + uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' + package: '@microsoft/sp-page-context!' + fullName: applyThemeAndBorder + summary: Apply a theme or borders to the entire Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly applyThemeAndBorder: SPPermission;' + return: + type: '' + - name: approveItems + uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' + package: '@microsoft/sp-page-context!' + fullName: approveItems + summary: Approve a minor version of a list item or document. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly approveItems: SPPermission;' + return: + type: '' + - name: browseDirectories + uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' + package: '@microsoft/sp-page-context!' + fullName: browseDirectories + summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly browseDirectories: SPPermission;' + return: + type: '' + - name: browserUserInfo + uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' + package: '@microsoft/sp-page-context!' + fullName: browserUserInfo + summary: View information about users of the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly browserUserInfo: SPPermission;' + return: + type: '' + - name: cancelCheckout + uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' + package: '@microsoft/sp-page-context!' + fullName: cancelCheckout + summary: Discard or check in a document which is checked out to another user. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly cancelCheckout: SPPermission;' + return: + type: '' + - name: createAlerts + uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' + package: '@microsoft/sp-page-context!' + fullName: createAlerts + summary: Create e-mail alerts. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly createAlerts: SPPermission;' + return: + type: '' + - name: createGroups + uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' + package: '@microsoft/sp-page-context!' + fullName: createGroups + summary: Create a group of users that can be used anywhere within the site collection. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly createGroups: SPPermission;' + return: + type: '' + - name: createSSCSite + uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' + package: '@microsoft/sp-page-context!' + fullName: createSSCSite + summary: Create a Web site using Self-Service Site Creation. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly createSSCSite: SPPermission;' + return: + type: '' + - name: deleteListItems + uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' + package: '@microsoft/sp-page-context!' + fullName: deleteListItems + summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly deleteListItems: SPPermission;' + return: + type: '' + - name: deleteVersions + uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' + package: '@microsoft/sp-page-context!' + fullName: deleteVersions + summary: Delete past versions of a list item or document. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly deleteVersions: SPPermission;' + return: + type: '' + - name: editListItems + uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' + package: '@microsoft/sp-page-context!' + fullName: editListItems + summary: >- + Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and + customize web part Pages in document libraries. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly editListItems: SPPermission;' + return: + type: '' + - name: editMyUserInfo + uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' + package: '@microsoft/sp-page-context!' + fullName: editMyUserInfo + summary: 'Allows a user to change his or her user information, such as adding a picture.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly editMyUserInfo: SPPermission;' + return: + type: '' + - name: emptyMask + uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' + package: '@microsoft/sp-page-context!' + fullName: emptyMask + summary: Has no permissions on the Web site. Not available through the user interface. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly emptyMask: SPPermission;' + return: + type: '' + - name: enumeratePermissions + uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' + package: '@microsoft/sp-page-context!' + fullName: enumeratePermissions + summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly enumeratePermissions: SPPermission;' + return: + type: '' + - name: fullMask + uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' + package: '@microsoft/sp-page-context!' + fullName: fullMask + summary: Has all permissions on the Web site. Not available through the user interface. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly fullMask: SPPermission;' + return: + type: '' + - name: layoutsPage + uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' + package: '@microsoft/sp-page-context!' + fullName: layoutsPage + summary: View the layouts page? + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly layoutsPage: SPPermission;' + return: + type: '' + - name: manageAlerts + uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' + package: '@microsoft/sp-page-context!' + fullName: manageAlerts + summary: Manage alerts for all users of the Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageAlerts: SPPermission;' + return: + type: '' + - name: manageLists + uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' + package: '@microsoft/sp-page-context!' + fullName: manageLists + summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageLists: SPPermission;' + return: + type: '' + - name: managePermissions + uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' + package: '@microsoft/sp-page-context!' + fullName: managePermissions + summary: Create and change permission levels on the Web site and assign permissions to users and groups. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly managePermissions: SPPermission;' + return: + type: '' + - name: managePersonalViews + uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' + package: '@microsoft/sp-page-context!' + fullName: managePersonalViews + summary: 'Create, change, and delete personal views of lists.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly managePersonalViews: SPPermission;' + return: + type: '' + - name: manageSubwebs + uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' + package: '@microsoft/sp-page-context!' + fullName: manageSubwebs + summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageSubwebs: SPPermission;' + return: + type: '' + - name: manageWeb + uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' + package: '@microsoft/sp-page-context!' + fullName: manageWeb + summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. + remarks: >- + Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user + interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties + of site collection scoped Features through the object model. To browse to the Site Collection Features page and + activate or deactivate site collection scoped Features through the UI, you must be a site collection + administrator. + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly manageWeb: SPPermission;' + return: + type: '' + - name: open + uid: '@microsoft/sp-page-context!SPPermission.open:member' + package: '@microsoft/sp-page-context!' + fullName: open + summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly open: SPPermission;' + return: + type: '' + - name: openItems + uid: '@microsoft/sp-page-context!SPPermission.openItems:member' + package: '@microsoft/sp-page-context!' + fullName: openItems + summary: View the source of documents with server-side file handlers. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly openItems: SPPermission;' + return: + type: '' + - name: updatePersonalWebParts + uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' + package: '@microsoft/sp-page-context!' + fullName: updatePersonalWebParts + summary: Update web parts to display personalized information. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly updatePersonalWebParts: SPPermission;' + return: + type: '' + - name: useClientIntegration + uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' + package: '@microsoft/sp-page-context!' + fullName: useClientIntegration + summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly useClientIntegration: SPPermission;' + return: + type: '' + - name: useRemoteAPIs + uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' + package: '@microsoft/sp-page-context!' + fullName: useRemoteAPIs + summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly useRemoteAPIs: SPPermission;' + return: + type: '' + - name: value + uid: '@microsoft/sp-page-context!SPPermission#value:member' + package: '@microsoft/sp-page-context!' + fullName: value + summary: Returns the value of this SPPermission object + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get value(): IODataBasePermission;' + return: + type: '' + - name: viewFormPages + uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' + package: '@microsoft/sp-page-context!' + fullName: viewFormPages + summary: 'View forms, views, and application pages, and enumerate lists.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewFormPages: SPPermission;' + return: + type: '' + - name: viewListItems + uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' + package: '@microsoft/sp-page-context!' + fullName: viewListItems + summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewListItems: SPPermission;' + return: + type: '' + - name: viewPages + uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' + package: '@microsoft/sp-page-context!' + fullName: viewPages + summary: View pages in a Web site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewPages: SPPermission;' + return: + type: '' + - name: viewUsageData + uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' + package: '@microsoft/sp-page-context!' + fullName: viewUsageData + summary: View reports on Web site usage. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewUsageData: SPPermission;' + return: + type: '' + - name: viewVersions + uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' + package: '@microsoft/sp-page-context!' + fullName: viewVersions + summary: View past versions of a list item or document. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'static readonly viewVersions: SPPermission;' + return: + type: '' +methods: + - name: hasAllPermissions(requestedPerms) + uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' + package: '@microsoft/sp-page-context!' + fullName: hasAllPermissions(requestedPerms) + summary: Function for testing whether a given permission mask has all of the requested permissions. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' + parameters: + - id: requestedPerms + description: Any number of SPPermission objects to be compared against the original + type: '[]' + return: + type: boolean + description: '' + - name: hasAnyPermissions(requestedPerms) + uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' + package: '@microsoft/sp-page-context!' + fullName: hasAnyPermissions(requestedPerms) + summary: Function for testing whether a given permission mask has any of the requested permissions. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' + parameters: + - id: requestedPerms + description: Any number of SPPermission objects to be compared against the original + type: '[]' + return: + type: boolean + description: '' + - name: hasPermission(requestedPerm) + uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' + package: '@microsoft/sp-page-context!' + fullName: hasPermission(requestedPerm) + summary: Function for testing whether a given permission mask has the requested permission. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'hasPermission(requestedPerm: SPPermission): boolean;' + parameters: + - id: requestedPerm + description: The SPPermission object to be compared against the original + type: '' + return: + type: boolean + description: '' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index 6ed6c8e0..def2d2eb 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -1,149 +1,149 @@ -### YamlMime:TSType -name: SPSite -uid: '@microsoft/sp-page-context!SPSite:class' -package: '@microsoft/sp-page-context!' -fullName: SPSite -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site - collection ("SPSite") that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPSite` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: absoluteUrl - uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' - package: '@microsoft/sp-page-context!' - fullName: absoluteUrl - summary: Returns the absolute URL for this SPSite. - remarks: 'Example: "https://example.com/sites/PubSite"' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly absoluteUrl: string;' - return: - type: string - - name: cdnPrefix - uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' - package: '@microsoft/sp-page-context!' - fullName: cdnPrefix - summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly cdnPrefix: string;' - return: - type: string - - name: classification - uid: '@microsoft/sp-page-context!SPSite#classification:member' - package: '@microsoft/sp-page-context!' - fullName: classification - summary: Returns the classification of the site. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly classification: string;' - return: - type: string - - name: correlationId - uid: '@microsoft/sp-page-context!SPSite#correlationId:member' - package: '@microsoft/sp-page-context!' - fullName: correlationId - summary: Returns the correlation id to the current server request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly correlationId: Guid;' - return: - type: '' - - name: group - uid: '@microsoft/sp-page-context!SPSite#group:member' - package: '@microsoft/sp-page-context!' - fullName: group - summary: >- - Contextual information about the O365 Group associated with this site. If there is no O365Group associated with - the current site, this property will be undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly group: O365GroupAssociation | undefined;' - return: - type: ' | undefined' - - name: id - uid: '@microsoft/sp-page-context!SPSite#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: The GUID that identifies the SPSite on the server. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly id: Guid;' - return: - type: '' - - name: isNoScriptEnabled - uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' - package: '@microsoft/sp-page-context!' - fullName: isNoScriptEnabled - summary: Returns true if isNoScript has been enabled on the SPSite. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly isNoScriptEnabled: boolean;' - return: - type: boolean - - name: recycleBinItemCount - uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' - package: '@microsoft/sp-page-context!' - fullName: recycleBinItemCount - summary: The amount of items in the recycle bin. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly recycleBinItemCount: number;' - return: - type: number - - name: serverRelativeUrl - uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' - package: '@microsoft/sp-page-context!' - fullName: serverRelativeUrl - summary: Returns the server-relative URL for this SPSite. - remarks: 'Example: "/sites/PubSite"' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly serverRelativeUrl: string;' - return: - type: string - - name: serverRequestPath - uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' - package: '@microsoft/sp-page-context!' - fullName: serverRequestPath - summary: Returns serverRelativeUrl of the original request. - remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly serverRequestPath: string;' - return: - type: string - - name: sitePagesEnabled - uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' - package: '@microsoft/sp-page-context!' - fullName: sitePagesEnabled - summary: Returns true if SitePages are enabled on this SPSite. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly sitePagesEnabled: boolean;' - return: - type: boolean +### YamlMime:TSType +name: SPSite +uid: '@microsoft/sp-page-context!SPSite:class' +package: '@microsoft/sp-page-context!' +fullName: SPSite +summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site + collection ("SPSite") that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPSite` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: absoluteUrl + uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' + package: '@microsoft/sp-page-context!' + fullName: absoluteUrl + summary: Returns the absolute URL for this SPSite. + remarks: 'Example: "https://example.com/sites/PubSite"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly absoluteUrl: string;' + return: + type: string + - name: cdnPrefix + uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' + package: '@microsoft/sp-page-context!' + fullName: cdnPrefix + summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cdnPrefix: string;' + return: + type: string + - name: classification + uid: '@microsoft/sp-page-context!SPSite#classification:member' + package: '@microsoft/sp-page-context!' + fullName: classification + summary: Returns the classification of the site. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly classification: string;' + return: + type: string + - name: correlationId + uid: '@microsoft/sp-page-context!SPSite#correlationId:member' + package: '@microsoft/sp-page-context!' + fullName: correlationId + summary: Returns the correlation id to the current server request. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly correlationId: Guid;' + return: + type: '' + - name: group + uid: '@microsoft/sp-page-context!SPSite#group:member' + package: '@microsoft/sp-page-context!' + fullName: group + summary: >- + Contextual information about the O365 Group associated with this site. If there is no O365Group associated with + the current site, this property will be undefined. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly group: O365GroupAssociation | undefined;' + return: + type: ' | undefined' + - name: id + uid: '@microsoft/sp-page-context!SPSite#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The GUID that identifies the SPSite on the server. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: isNoScriptEnabled + uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' + package: '@microsoft/sp-page-context!' + fullName: isNoScriptEnabled + summary: Returns true if isNoScript has been enabled on the SPSite. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isNoScriptEnabled: boolean;' + return: + type: boolean + - name: recycleBinItemCount + uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' + package: '@microsoft/sp-page-context!' + fullName: recycleBinItemCount + summary: The amount of items in the recycle bin. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly recycleBinItemCount: number;' + return: + type: number + - name: serverRelativeUrl + uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' + package: '@microsoft/sp-page-context!' + fullName: serverRelativeUrl + summary: Returns the server-relative URL for this SPSite. + remarks: 'Example: "/sites/PubSite"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: serverRequestPath + uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' + package: '@microsoft/sp-page-context!' + fullName: serverRequestPath + summary: Returns serverRelativeUrl of the original request. + remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRequestPath: string;' + return: + type: string + - name: sitePagesEnabled + uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' + package: '@microsoft/sp-page-context!' + fullName: sitePagesEnabled + summary: Returns true if SitePages are enabled on this SPSite. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sitePagesEnabled: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 9f1c320b..374e968c 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -1,113 +1,113 @@ -### YamlMime:TSType -name: SPTimeZone -uid: '@microsoft/sp-page-context!SPTimeZone:class' -package: '@microsoft/sp-page-context!' -fullName: SPTimeZone -summary: >- - It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the - following formula. -remarks: >- - ``` - - isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate - - LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) - - June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) - - ``` - - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPTimeZone` class. -isPreview: true -isDeprecated: false -type: class -properties: - - name: daylightDate - uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' - package: '@microsoft/sp-page-context!' - fullName: daylightDate - summary: Gets the date on which daylight time begins for the time zone. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly daylightDate: ISPSystemTime;' - return: - type: '' - - name: daylightOffset - uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' - package: '@microsoft/sp-page-context!' - fullName: daylightOffset - summary: >- - Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal - Time (UTC). - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly daylightOffset: number;' - return: - type: number - - name: description - uid: '@microsoft/sp-page-context!SPTimeZone#description:member' - package: '@microsoft/sp-page-context!' - fullName: description - summary: Gets the description for the time zone. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly description: string;' - return: - type: string - - name: id - uid: '@microsoft/sp-page-context!SPTimeZone#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: Gets the ID of the time zone. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly id: number;' - return: - type: number - - name: offset - uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' - package: '@microsoft/sp-page-context!' - fullName: offset - summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly offset: number;' - return: - type: number - - name: standardDate - uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' - package: '@microsoft/sp-page-context!' - fullName: standardDate - summary: Gets the date on which standard time begins for the time zone. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly standardDate: ISPSystemTime;' - return: - type: '' - - name: standardOffset - uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' - package: '@microsoft/sp-page-context!' - fullName: standardOffset - summary: >- - Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal - time (UTC). - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly standardOffset: number;' - return: - type: number +### YamlMime:TSType +name: SPTimeZone +uid: '@microsoft/sp-page-context!SPTimeZone:class' +package: '@microsoft/sp-page-context!' +fullName: SPTimeZone +summary: >- + It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the + following formula. +remarks: >- + ``` + + isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate + + LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) + + June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) + + ``` + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPTimeZone` class. +isPreview: true +isDeprecated: false +type: class +properties: + - name: daylightDate + uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' + package: '@microsoft/sp-page-context!' + fullName: daylightDate + summary: Gets the date on which daylight time begins for the time zone. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly daylightDate: ISPSystemTime;' + return: + type: '' + - name: daylightOffset + uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' + package: '@microsoft/sp-page-context!' + fullName: daylightOffset + summary: >- + Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal + Time (UTC). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly daylightOffset: number;' + return: + type: number + - name: description + uid: '@microsoft/sp-page-context!SPTimeZone#description:member' + package: '@microsoft/sp-page-context!' + fullName: description + summary: Gets the description for the time zone. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly description: string;' + return: + type: string + - name: id + uid: '@microsoft/sp-page-context!SPTimeZone#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: Gets the ID of the time zone. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: number;' + return: + type: number + - name: offset + uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' + package: '@microsoft/sp-page-context!' + fullName: offset + summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly offset: number;' + return: + type: number + - name: standardDate + uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' + package: '@microsoft/sp-page-context!' + fullName: standardDate + summary: Gets the date on which standard time begins for the time zone. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly standardDate: ISPSystemTime;' + return: + type: '' + - name: standardOffset + uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' + package: '@microsoft/sp-page-context!' + fullName: standardOffset + summary: >- + Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal + time (UTC). + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly standardOffset: number;' + return: + type: number diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index f2479aa2..009c0cae 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -1,111 +1,111 @@ -### YamlMime:TSType -name: SPUser -uid: '@microsoft/sp-page-context!SPUser:class' -package: '@microsoft/sp-page-context!' -fullName: SPUser -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user - that is accessing the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPUser` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: displayName - uid: '@microsoft/sp-page-context!SPUser#displayName:member' - package: '@microsoft/sp-page-context!' - fullName: displayName - summary: The display name for the current user. - remarks: 'Example: `"John Doe"`' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly displayName: string;' - return: - type: string - - name: email - uid: '@microsoft/sp-page-context!SPUser#email:member' - package: '@microsoft/sp-page-context!' - fullName: email - summary: The email address for the current user. - remarks: 'Example: `"example@contoso.com"`' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly email: string;' - return: - type: string - - name: firstDayOfWeek - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' - package: '@microsoft/sp-page-context!' - fullName: firstDayOfWeek - summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' - return: - type: ' | undefined' - - name: isAnonymousGuestUser - uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' - package: '@microsoft/sp-page-context!' - fullName: isAnonymousGuestUser - summary: Returns if the current user is an anonymous guest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly isAnonymousGuestUser: boolean;' - return: - type: boolean - - name: isExternalGuestUser - uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' - package: '@microsoft/sp-page-context!' - fullName: isExternalGuestUser - summary: Returns true if the current user is an external guest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly isExternalGuestUser: boolean;' - return: - type: boolean - - name: loginName - uid: '@microsoft/sp-page-context!SPUser#loginName:member' - package: '@microsoft/sp-page-context!' - fullName: loginName - summary: The login name for current user. - remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly loginName: string;' - return: - type: string - - name: preferUserTimeZone - uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' - package: '@microsoft/sp-page-context!' - fullName: preferUserTimeZone - summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly preferUserTimeZone: boolean;' - return: - type: boolean - - name: timeZoneInfo - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' - package: '@microsoft/sp-page-context!' - fullName: timeZoneInfo - summary: Returns the user's regional timezone settings or undefined if they haven't been set. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly timeZoneInfo: SPTimeZone | undefined;' - return: - type: ' | undefined' +### YamlMime:TSType +name: SPUser +uid: '@microsoft/sp-page-context!SPUser:class' +package: '@microsoft/sp-page-context!' +fullName: SPUser +summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user + that is accessing the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPUser` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: displayName + uid: '@microsoft/sp-page-context!SPUser#displayName:member' + package: '@microsoft/sp-page-context!' + fullName: displayName + summary: The display name for the current user. + remarks: 'Example: `"John Doe"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly displayName: string;' + return: + type: string + - name: email + uid: '@microsoft/sp-page-context!SPUser#email:member' + package: '@microsoft/sp-page-context!' + fullName: email + summary: The email address for the current user. + remarks: 'Example: `"example@contoso.com"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly email: string;' + return: + type: string + - name: firstDayOfWeek + uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' + package: '@microsoft/sp-page-context!' + fullName: firstDayOfWeek + summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' + return: + type: ' | undefined' + - name: isAnonymousGuestUser + uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' + package: '@microsoft/sp-page-context!' + fullName: isAnonymousGuestUser + summary: Returns if the current user is an anonymous guest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isAnonymousGuestUser: boolean;' + return: + type: boolean + - name: isExternalGuestUser + uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' + package: '@microsoft/sp-page-context!' + fullName: isExternalGuestUser + summary: Returns true if the current user is an external guest. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isExternalGuestUser: boolean;' + return: + type: boolean + - name: loginName + uid: '@microsoft/sp-page-context!SPUser#loginName:member' + package: '@microsoft/sp-page-context!' + fullName: loginName + summary: The login name for current user. + remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly loginName: string;' + return: + type: string + - name: preferUserTimeZone + uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' + package: '@microsoft/sp-page-context!' + fullName: preferUserTimeZone + summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly preferUserTimeZone: boolean;' + return: + type: boolean + - name: timeZoneInfo + uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' + package: '@microsoft/sp-page-context!' + fullName: timeZoneInfo + summary: Returns the user's regional timezone settings or undefined if they haven't been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly timeZoneInfo: SPTimeZone | undefined;' + return: + type: ' | undefined' diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index b554b723..6a78b95e 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -1,175 +1,175 @@ -### YamlMime:TSType -name: SPWeb -uid: '@microsoft/sp-page-context!SPWeb:class' -package: '@microsoft/sp-page-context!' -fullName: SPWeb -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site - ("SPWeb") that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPWeb` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: absoluteUrl - uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' - package: '@microsoft/sp-page-context!' - fullName: absoluteUrl - summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly absoluteUrl: string;' - return: - type: string - - name: description - uid: '@microsoft/sp-page-context!SPWeb#description:member' - package: '@microsoft/sp-page-context!' - fullName: description - summary: Returns the description of the current SPWeb. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly description: string;' - return: - type: string - - name: firstDayOfWeek - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' - package: '@microsoft/sp-page-context!' - fullName: firstDayOfWeek - summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' - return: - type: ' | undefined' - - name: id - uid: '@microsoft/sp-page-context!SPWeb#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: The GUID that identifies the SPWeb on the server. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly id: Guid;' - return: - type: '' - - name: isAppWeb - uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' - package: '@microsoft/sp-page-context!' - fullName: isAppWeb - summary: Returns true if this `SPWeb` the container web for an `SPApp`. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly isAppWeb: boolean;' - return: - type: boolean - - name: language - uid: '@microsoft/sp-page-context!SPWeb#language:member' - package: '@microsoft/sp-page-context!' - fullName: language - summary: Returns the locale identifier (LCID) for the default language of the website. - remarks: 'Example: 1033 represents the locale identifier for en-US.' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly language: number;' - return: - type: number - - name: languageName - uid: '@microsoft/sp-page-context!SPWeb#languageName:member' - package: '@microsoft/sp-page-context!' - fullName: languageName - summary: Returns the language name for the default language of the website. - remarks: 'Example: en-US represents the English language in the US locale.' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly languageName: string;' - return: - type: string - - name: logoUrl - uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' - package: '@microsoft/sp-page-context!' - fullName: logoUrl - summary: Returns the absolute URL of the website logo. - remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly logoUrl: string;' - return: - type: string - - name: permissions - uid: '@microsoft/sp-page-context!SPWeb#permissions:member' - package: '@microsoft/sp-page-context!' - fullName: permissions - summary: >- - Return the SPPermission object that represents the set of permissions that the current user has for interacting - with the web. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly permissions: SPPermission;' - return: - type: '' - - name: serverRelativeUrl - uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' - package: '@microsoft/sp-page-context!' - fullName: serverRelativeUrl - summary: Returns the server-relative URL for this SPWeb. - remarks: 'Example: `"/sites/PubSite/SubWeb"`' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly serverRelativeUrl: string;' - return: - type: string - - name: templateName - uid: '@microsoft/sp-page-context!SPWeb#templateName:member' - package: '@microsoft/sp-page-context!' - fullName: templateName - summary: >- - Returns the string representing the numeric identifier for the site definition or site template that was used to - create the site. - remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly templateName: string;' - return: - type: string - - name: timeZoneInfo - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' - package: '@microsoft/sp-page-context!' - fullName: timeZoneInfo - summary: Returns the web's regional timezone settings or undefined if they haven't been set. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'readonly timeZoneInfo: SPTimeZone | undefined;' - return: - type: ' | undefined' - - name: title - uid: '@microsoft/sp-page-context!SPWeb#title:member' - package: '@microsoft/sp-page-context!' - fullName: title - summary: Returns the title of the current SPWeb. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly title: string;' - return: - type: string +### YamlMime:TSType +name: SPWeb +uid: '@microsoft/sp-page-context!SPWeb:class' +package: '@microsoft/sp-page-context!' +fullName: SPWeb +summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site + ("SPWeb") that hosts the page. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPWeb` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: absoluteUrl + uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' + package: '@microsoft/sp-page-context!' + fullName: absoluteUrl + summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly absoluteUrl: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-page-context!SPWeb#description:member' + package: '@microsoft/sp-page-context!' + fullName: description + summary: Returns the description of the current SPWeb. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly description: string;' + return: + type: string + - name: firstDayOfWeek + uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' + package: '@microsoft/sp-page-context!' + fullName: firstDayOfWeek + summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' + return: + type: ' | undefined' + - name: id + uid: '@microsoft/sp-page-context!SPWeb#id:member' + package: '@microsoft/sp-page-context!' + fullName: id + summary: The GUID that identifies the SPWeb on the server. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: isAppWeb + uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' + package: '@microsoft/sp-page-context!' + fullName: isAppWeb + summary: Returns true if this `SPWeb` the container web for an `SPApp`. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isAppWeb: boolean;' + return: + type: boolean + - name: language + uid: '@microsoft/sp-page-context!SPWeb#language:member' + package: '@microsoft/sp-page-context!' + fullName: language + summary: Returns the locale identifier (LCID) for the default language of the website. + remarks: 'Example: 1033 represents the locale identifier for en-US.' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly language: number;' + return: + type: number + - name: languageName + uid: '@microsoft/sp-page-context!SPWeb#languageName:member' + package: '@microsoft/sp-page-context!' + fullName: languageName + summary: Returns the language name for the default language of the website. + remarks: 'Example: en-US represents the English language in the US locale.' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly languageName: string;' + return: + type: string + - name: logoUrl + uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' + package: '@microsoft/sp-page-context!' + fullName: logoUrl + summary: Returns the absolute URL of the website logo. + remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly logoUrl: string;' + return: + type: string + - name: permissions + uid: '@microsoft/sp-page-context!SPWeb#permissions:member' + package: '@microsoft/sp-page-context!' + fullName: permissions + summary: >- + Return the SPPermission object that represents the set of permissions that the current user has for interacting + with the web. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly permissions: SPPermission;' + return: + type: '' + - name: serverRelativeUrl + uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' + package: '@microsoft/sp-page-context!' + fullName: serverRelativeUrl + summary: Returns the server-relative URL for this SPWeb. + remarks: 'Example: `"/sites/PubSite/SubWeb"`' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: templateName + uid: '@microsoft/sp-page-context!SPWeb#templateName:member' + package: '@microsoft/sp-page-context!' + fullName: templateName + summary: >- + Returns the string representing the numeric identifier for the site definition or site template that was used to + create the site. + remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly templateName: string;' + return: + type: string + - name: timeZoneInfo + uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' + package: '@microsoft/sp-page-context!' + fullName: timeZoneInfo + summary: Returns the web's regional timezone settings or undefined if they haven't been set. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'readonly timeZoneInfo: SPTimeZone | undefined;' + return: + type: ' | undefined' + - name: title + uid: '@microsoft/sp-page-context!SPWeb#title:member' + package: '@microsoft/sp-page-context!' + fullName: title + summary: Returns the title of the current SPWeb. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly title: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index f57b0678..10530363 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -1,360 +1,360 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-property-pane!' -name: '@microsoft/sp-property-pane' -type: package -summary: SharePoint Framework property pane. -enums: - - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - - '@microsoft/sp-property-pane!PopupWindowPosition:enum' - - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' -interfaces: - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - - '@microsoft/sp-property-pane!IPopupWindowProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneField:interface' - - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - - '@microsoft/sp-property-pane!IPropertyPanePage:interface' - - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' -functions: - - name: 'PropertyPaneButton(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Button on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the Button is associated to. - type: string - - id: properties - description: Strongly typed Button properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneCheckbox(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Checkbox on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the checkbox is associated to. - type: string - - id: properties - description: Strongly typed Checkbox properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Choice Group on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: - IPropertyPaneChoiceGroupProps): IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the choice group is associated to. - type: string - - id: properties - description: Strongly typed Choice Group properties. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneCustomField(properties) - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a custom field on the PropertyPane. - remarks: >- - The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The - PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but - there are exceptional cases when web parts have special needs and need a special control. The custom field helps - fill that gap. - isPreview: true - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): - IPropertyPaneField; - parameters: - - id: properties - description: Strongly typed Custom field properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDropdown(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Dropdown on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the dropdown is associated to. - type: string - - id: properties - description: Strongly typed Dropdown properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicField(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneDynamicField(targetProperty: string, properties: - IPropertyPaneDynamicFieldProps): IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the Dynamic Data widget is associated to. - type: string - - id: properties - description: '' - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneDynamicFieldSet(properties) - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' - package: '@microsoft/sp-property-pane!' - summary: >- - Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data - source. - - - These fields can possibly share the same property based on the associated filters. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): - IPropertyPaneField; - parameters: - - id: properties - description: >- - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. - Each entry includes the target property and, optionally, the label to show. options - Options enabling - customized values for callback, filters etc., for the given set of dynamic fields. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Dynamic TextField on the PropertyPane. - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' - syntax: - content: >- - export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: - IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the dynamic textfield is associated to. - type: string - - id: properties - description: Properties of the PropertyPaneDynamicTextField. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneHorizontalRule() - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Horizontal Rule on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' - return: - type: '<void>' - description: '' - - name: 'PropertyPaneLabel(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Label on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the label is associated to. - type: string - - id: properties - description: Strongly typed Label properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneLink(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Link on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the Link is associated to. - type: string - - id: properties - description: Strongly typed Link properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneSlider(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Slider on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the slider is associated to. - type: string - - id: properties - description: Strongly typed Slider properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneTextField(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a TextField on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the textfield is associated to. - type: string - - id: properties - description: Strongly typed TextField properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneToggle(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' - package: '@microsoft/sp-property-pane!' - summary: Helper method to create a Toggle on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the toggle is associated to. - type: string - - id: properties - description: Strongly typed Toggle properties. - type: '' - return: - type: >- - <> - description: '' +### YamlMime:TSPackage +uid: '@microsoft/sp-property-pane!' +name: '@microsoft/sp-property-pane' +type: package +summary: SharePoint Framework property pane. +enums: + - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' +interfaces: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' +functions: + - name: 'PropertyPaneButton(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Button on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Button is associated to. + type: string + - id: properties + description: Strongly typed Button properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneCheckbox(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Checkbox on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the checkbox is associated to. + type: string + - id: properties + description: Strongly typed Checkbox properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Choice Group on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the choice group is associated to. + type: string + - id: properties + description: Strongly typed Choice Group properties. + type: '' + return: + type: >- + <> + description: '' + - name: PropertyPaneCustomField(properties) + uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a custom field on the PropertyPane. + remarks: >- + The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The + PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but + there are exceptional cases when web parts have special needs and need a special control. The custom field helps + fill that gap. + isPreview: true + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): + IPropertyPaneField; + parameters: + - id: properties + description: Strongly typed Custom field properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneDropdown(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Dropdown on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the dropdown is associated to. + type: string + - id: properties + description: Strongly typed Dropdown properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneDynamicField(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneDynamicField(targetProperty: string, properties: + IPropertyPaneDynamicFieldProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Dynamic Data widget is associated to. + type: string + - id: properties + description: '' + type: '' + return: + type: >- + <> + description: '' + - name: PropertyPaneDynamicFieldSet(properties) + uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' + package: '@microsoft/sp-property-pane!' + summary: >- + Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data + source. + + + These fields can possibly share the same property based on the associated filters. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): + IPropertyPaneField; + parameters: + - id: properties + description: >- + Contains entries and options, described as below: entries - A set of entries to be configured by the widget. + Each entry includes the target property and, optionally, the label to show. options - Options enabling + customized values for callback, filters etc., for the given set of dynamic fields. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Dynamic TextField on the PropertyPane. + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' + syntax: + content: >- + export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: + IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the dynamic textfield is associated to. + type: string + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + type: '' + return: + type: >- + <> + description: '' + - name: PropertyPaneHorizontalRule() + uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Horizontal Rule on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' + return: + type: '<void>' + description: '' + - name: 'PropertyPaneLabel(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Label on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the label is associated to. + type: string + - id: properties + description: Strongly typed Label properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneLink(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Link on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Link is associated to. + type: string + - id: properties + description: Strongly typed Link properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneSlider(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Slider on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the slider is associated to. + type: string + - id: properties + description: Strongly typed Slider properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneTextField(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a TextField on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the textfield is associated to. + type: string + - id: properties + description: Strongly typed TextField properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneToggle(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a Toggle on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the toggle is associated to. + type: string + - id: properties + description: Strongly typed Toggle properties. + type: '' + return: + type: >- + <> + description: '' diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 3c4c427c..21b0ff56 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -1,25 +1,25 @@ -### YamlMime:TSEnum -name: DynamicDataSharedDepth -uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' -package: '@microsoft/sp-property-pane!' -fullName: DynamicDataSharedDepth -summary: Enum for the possible values of shared depth of the dynamic data reference. -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: None - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' - package: '@microsoft/sp-property-pane!' - summary: Indicates that nothing is shared. - value: '0' - - name: Property - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' - package: '@microsoft/sp-property-pane!' - summary: Indicates that both the dynamic data source and the property are shared. - value: '2' - - name: Source - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' - package: '@microsoft/sp-property-pane!' - summary: Indicates that the dynamic data source is shared. - value: '1' +### YamlMime:TSEnum +name: DynamicDataSharedDepth +uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' +package: '@microsoft/sp-property-pane!' +fullName: DynamicDataSharedDepth +summary: Enum for the possible values of shared depth of the dynamic data reference. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: None + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' + package: '@microsoft/sp-property-pane!' + summary: Indicates that nothing is shared. + value: '0' + - name: Property + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' + package: '@microsoft/sp-property-pane!' + summary: Indicates that both the dynamic data source and the property are shared. + value: '2' + - name: Source + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' + package: '@microsoft/sp-property-pane!' + summary: Indicates that the dynamic data source is shared. + value: '1' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 4ed16cea..36677cef 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyConfiguration -uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedPropertyConfiguration -summary: Configuration related to a shared property. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: filters - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' - package: '@microsoft/sp-property-pane!' - fullName: filters - summary: Filters for the shared property. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'filters?: IDynamicDataSharedPropertyFilters;' - return: - type: '' +### YamlMime:TSType +name: IDynamicDataSharedPropertyConfiguration +uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedPropertyConfiguration +summary: Configuration related to a shared property. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' + package: '@microsoft/sp-property-pane!' + fullName: filters + summary: Filters for the shared property. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'filters?: IDynamicDataSharedPropertyFilters;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index 26ba8c3e..a568e853 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -1,33 +1,33 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyFilters -uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedPropertyFilters -summary: Property pane dynamic data property filters. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: propertyId - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' - package: '@microsoft/sp-property-pane!' - fullName: propertyId - summary: |- - Property Id - - Usage: Use this filter when the author can only to connect to a specific property from the selected source. - remarks: >- - This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the - dynamic data widget. - - - When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. - Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is - pre-selected, the control will be disabled to ensure that authors can not change it. - isPreview: false - isDeprecated: false - syntax: - content: 'propertyId?: string;' - return: - type: string +### YamlMime:TSType +name: IDynamicDataSharedPropertyFilters +uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedPropertyFilters +summary: Property pane dynamic data property filters. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: propertyId + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' + package: '@microsoft/sp-property-pane!' + fullName: propertyId + summary: |- + Property Id + + Usage: Use this filter when the author can only to connect to a specific property from the selected source. + remarks: >- + This is to filter which specific property is to be pre-selected in the properties dropdown(second level) on the + dynamic data widget. + + + When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. + Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is + pre-selected, the control will be disabled to ensure that authors can not change it. + isPreview: false + isDeprecated: false + syntax: + content: 'propertyId?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index 0f46301c..84c97986 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -1,38 +1,38 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceConfiguration -uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedSourceConfiguration -summary: Configuration related to a shared source. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: filters - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' - package: '@microsoft/sp-property-pane!' - fullName: filters - summary: Filters for the shared source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'filters?: IDynamicDataSharedSourceFilters;' - return: - type: '' - - name: sourcesLabel - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: sourcesLabel - summary: |- - User-friendly, localized label for the sources dropdown. - - default value - 'Connect to source' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sourcesLabel?: string;' - return: - type: string +### YamlMime:TSType +name: IDynamicDataSharedSourceConfiguration +uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedSourceConfiguration +summary: Configuration related to a shared source. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' + package: '@microsoft/sp-property-pane!' + fullName: filters + summary: Filters for the shared source. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'filters?: IDynamicDataSharedSourceFilters;' + return: + type: '' + - name: sourcesLabel + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: sourcesLabel + summary: |- + User-friendly, localized label for the sources dropdown. + + default value - 'Connect to source' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'sourcesLabel?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index 5c692144..221599b2 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -1,61 +1,61 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceFilters -uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedSourceFilters -summary: Property pane dynamic data source filters. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: componentId - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' - package: '@microsoft/sp-property-pane!' - fullName: componentId - summary: |- - Component Id. - - Usage: Use this filter when the author should only be able to connect to a specific type of source. - remarks: >- - This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic - data widget. - - - When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources - matching the given component id. - - - Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only - shows document library web parts on the page which are registered dynamic sources. - isPreview: false - isDeprecated: false - syntax: - content: 'componentId?: Guid;' - return: - type: '' - - name: sourceId - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' - package: '@microsoft/sp-property-pane!' - fullName: sourceId - summary: |- - Source Id - - Usage: Use this filter, when the author can only to connect to a specific data source. - remarks: >- - This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the - dynamic data widget. - - - When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if - available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is - pre-selected, the control will be disabled to ensure that authors can not change it. - - - The source id for a web part will be of the form WebPart.. - isPreview: false - isDeprecated: false - syntax: - content: 'sourceId?: string;' - return: - type: string +### YamlMime:TSType +name: IDynamicDataSharedSourceFilters +uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' +package: '@microsoft/sp-property-pane!' +fullName: IDynamicDataSharedSourceFilters +summary: Property pane dynamic data source filters. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: componentId + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' + package: '@microsoft/sp-property-pane!' + fullName: componentId + summary: |- + Component Id. + + Usage: Use this filter when the author should only be able to connect to a specific type of source. + remarks: >- + This is to filter what type of source needs to be shown in the data sources dropdown (first level) on the dynamic + data widget. + + + When provided, the dynamic data sources dropdown in the dynamic data widget is filtered to only show the sources + matching the given component id. + + + Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only + shows document library web parts on the page which are registered dynamic sources. + isPreview: false + isDeprecated: false + syntax: + content: 'componentId?: Guid;' + return: + type: '' + - name: sourceId + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' + package: '@microsoft/sp-property-pane!' + fullName: sourceId + summary: |- + Source Id + + Usage: Use this filter, when the author can only to connect to a specific data source. + remarks: >- + This is to filter which specific source is to be pre-selected in the data sources dropdown (first level) on the + dynamic data widget. + + + When provided, the dynamic data sources dropdown is pre-selected to show the source with the provided id, if + available. Otherwise the dropdown will fall back to show all the existing data sources on the page. If a source is + pre-selected, the control will be disabled to ensure that authors can not change it. + + + The source id for a web part will be of the form WebPart.. + isPreview: false + isDeprecated: false + syntax: + content: 'sourceId?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index af3ca9ba..1467aac8 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: IPopupWindowProps -uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPopupWindowProps -summary: Popup window props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: height - uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' - package: '@microsoft/sp-property-pane!' - fullName: height - summary: Height of pop up window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'height: number;' - return: - type: number - - name: positionWindowPosition - uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' - package: '@microsoft/sp-property-pane!' - fullName: positionWindowPosition - summary: The position of pop up window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'positionWindowPosition: PopupWindowPosition;' - return: - type: '' - - name: title - uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' - package: '@microsoft/sp-property-pane!' - fullName: title - summary: Title of pop up window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string - - name: width - uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' - package: '@microsoft/sp-property-pane!' - fullName: width - summary: Width of pop up window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'width: number;' - return: - type: number +### YamlMime:TSType +name: IPopupWindowProps +uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPopupWindowProps +summary: Popup window props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: height + uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' + package: '@microsoft/sp-property-pane!' + fullName: height + summary: Height of pop up window. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: positionWindowPosition + uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' + package: '@microsoft/sp-property-pane!' + fullName: positionWindowPosition + summary: The position of pop up window. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'positionWindowPosition: PopupWindowPosition;' + return: + type: '' + - name: title + uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' + package: '@microsoft/sp-property-pane!' + fullName: title + summary: Title of pop up window. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string + - name: width + uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' + package: '@microsoft/sp-property-pane!' + fullName: width + summary: Width of pop up window. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index d1d3f07d..eb8971e7 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -1,113 +1,113 @@ -### YamlMime:TSType -name: IPropertyPaneButtonProps -uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneButtonProps -summary: PropertyPane button props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaDescription - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaDescription - summary: |- - Detailed description of the button for the benefit of screen readers. - - Besides the compound button, other button types will need more information provided to screen reader. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaDescription?: string;' - return: - type: string - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel - summary: The aria label of the button for the benefit of screen readers. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel?: string;' - return: - type: string - - name: buttonType - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' - package: '@microsoft/sp-property-pane!' - fullName: buttonType - summary: The type of button to render. Default value is ButtonType.normal. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'buttonType?: PropertyPaneButtonType;' - return: - type: '' - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description - summary: Description of the action this button takes. Only used for compound buttons. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the button is disabled. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: icon - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' - package: '@microsoft/sp-property-pane!' - fullName: icon - summary: The button icon shown in command or hero type. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'icon?: string;' - return: - type: string - - name: onClick - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' - package: '@microsoft/sp-property-pane!' - fullName: onClick - summary: >- - A callback which is invoked on the button click, which takes in the existing value for the bound property and - returns the new value and which is then used to update the properties bag. This update will result in the - re-render of the PropertyPane with the new props. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onClick: (value: any) => any;' - return: - type: '(value: any) => any' - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text - summary: Display text of the element. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneButtonProps +uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneButtonProps +summary: PropertyPane button props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaDescription + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaDescription + summary: |- + Detailed description of the button for the benefit of screen readers. + + Besides the compound button, other button types will need more information provided to screen reader. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaDescription?: string;' + return: + type: string + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaLabel + summary: The aria label of the button for the benefit of screen readers. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel?: string;' + return: + type: string + - name: buttonType + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' + package: '@microsoft/sp-property-pane!' + fullName: buttonType + summary: The type of button to render. Default value is ButtonType.normal. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonType?: PropertyPaneButtonType;' + return: + type: '' + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' + package: '@microsoft/sp-property-pane!' + fullName: description + summary: Description of the action this button takes. Only used for compound buttons. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the button is disabled. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: icon + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' + package: '@microsoft/sp-property-pane!' + fullName: icon + summary: The button icon shown in command or hero type. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'icon?: string;' + return: + type: string + - name: onClick + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' + package: '@microsoft/sp-property-pane!' + fullName: onClick + summary: >- + A callback which is invoked on the button click, which takes in the existing value for the bound property and + returns the new value and which is then used to update the properties bag. This update will result in the + re-render of the PropertyPane with the new props. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onClick: (value: any) => any;' + return: + type: '(value: any) => any' + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' + package: '@microsoft/sp-property-pane!' + fullName: text + summary: Display text of the element. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index 73e11b1b..8b6e0f68 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -1,47 +1,47 @@ -### YamlMime:TSType -name: IPropertyPaneCheckboxProps -uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneCheckboxProps -summary: PropertyPane CheckBox component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: checked - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' - package: '@microsoft/sp-property-pane!' - fullName: checked - summary: Whether the property pane checkbox is checked or not. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'checked?: boolean;' - return: - type: boolean - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the property pane checkbox is disabled or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text - summary: Label to display next to the checkbox. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text?: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneCheckboxProps +uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneCheckboxProps +summary: PropertyPane CheckBox component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: checked + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' + package: '@microsoft/sp-property-pane!' + fullName: checked + summary: Whether the property pane checkbox is checked or not. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'checked?: boolean;' + return: + type: boolean + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the property pane checkbox is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' + package: '@microsoft/sp-property-pane!' + fullName: text + summary: Label to display next to the checkbox. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index e08595d2..8c53fbbb 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -1,130 +1,130 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOption -uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneChoiceGroupOption -summary: PropertyPane ChoiceGroup option props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel - summary: The aria label of the property pane choice group option for the benefit of screen readers. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel?: string;' - return: - type: string - - name: checked - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' - package: '@microsoft/sp-property-pane!' - fullName: checked - summary: |- - Whether the property pane choice group option is checked or not. - - Default value is false. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'checked?: boolean;' - return: - type: boolean - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the property pane choice group option is disabled or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: iconProps - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' - package: '@microsoft/sp-property-pane!' - fullName: iconProps - summary: The Icon component props for choice field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' - return: - type: '' - - name: imageSize - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' - package: '@microsoft/sp-property-pane!' - fullName: imageSize - summary: The width and height of the image in px for choice field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - imageSize?: { - width: number; - height: number; - }; - return: - type: |- - { - width: number; - height: number; - } - - name: imageSrc - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' - package: '@microsoft/sp-property-pane!' - fullName: imageSrc - summary: The src of image for choice field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'imageSrc?: string;' - return: - type: string - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key - summary: A required key to uniquely identify the option. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key: string | number;' - return: - type: string | number - - name: selectedImageSrc - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' - package: '@microsoft/sp-property-pane!' - fullName: selectedImageSrc - summary: The src of image for choice field which is selected. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'selectedImageSrc?: string;' - return: - type: string - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text - summary: The text string for the option. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOption +uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneChoiceGroupOption +summary: PropertyPane ChoiceGroup option props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaLabel + summary: The aria label of the property pane choice group option for the benefit of screen readers. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel?: string;' + return: + type: string + - name: checked + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' + package: '@microsoft/sp-property-pane!' + fullName: checked + summary: |- + Whether the property pane choice group option is checked or not. + + Default value is false. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'checked?: boolean;' + return: + type: boolean + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the property pane choice group option is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: iconProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' + package: '@microsoft/sp-property-pane!' + fullName: iconProps + summary: The Icon component props for choice field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' + return: + type: '' + - name: imageSize + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' + package: '@microsoft/sp-property-pane!' + fullName: imageSize + summary: The width and height of the image in px for choice field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + imageSize?: { + width: number; + height: number; + }; + return: + type: |- + { + width: number; + height: number; + } + - name: imageSrc + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' + package: '@microsoft/sp-property-pane!' + fullName: imageSrc + summary: The src of image for choice field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'imageSrc?: string;' + return: + type: string + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' + package: '@microsoft/sp-property-pane!' + fullName: key + summary: A required key to uniquely identify the option. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'key: string | number;' + return: + type: string | number + - name: selectedImageSrc + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' + package: '@microsoft/sp-property-pane!' + fullName: selectedImageSrc + summary: The src of image for choice field which is selected. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'selectedImageSrc?: string;' + return: + type: string + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' + package: '@microsoft/sp-property-pane!' + fullName: text + summary: The text string for the option. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index df9a6753..4f7bd524 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOptionIconProps -uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneChoiceGroupOptionIconProps -summary: PropertyPane ChoiceGroup icon props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: officeFabricIconFontName - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' - package: '@microsoft/sp-property-pane!' - fullName: officeFabricIconFontName - summary: The name of the icon to use from the Office Fabric icon set. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'officeFabricIconFontName?: string | null;' - return: - type: string | null +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOptionIconProps +uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneChoiceGroupOptionIconProps +summary: PropertyPane ChoiceGroup icon props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: officeFabricIconFontName + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' + package: '@microsoft/sp-property-pane!' + fullName: officeFabricIconFontName + summary: The name of the icon to use from the Office Fabric icon set. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string | null;' + return: + type: string | null diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 30f5520d..d93a8ad9 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupProps -uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneChoiceGroupProps -summary: PropertyPane ChoiceGroup props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: Descriptive label for the choice group. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label?: string;' - return: - type: string - - name: options - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' - package: '@microsoft/sp-property-pane!' - fullName: options - summary: The options for the choice group. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'options: IPropertyPaneChoiceGroupOption[];' - return: - type: '[]' +### YamlMime:TSType +name: IPropertyPaneChoiceGroupProps +uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneChoiceGroupProps +summary: PropertyPane ChoiceGroup props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: Descriptive label for the choice group. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label?: string;' + return: + type: string + - name: options + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' + package: '@microsoft/sp-property-pane!' + fullName: options + summary: The options for the choice group. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'options: IPropertyPaneChoiceGroupOption[];' + return: + type: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index 78557fbb..af4fcd70 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -1,71 +1,71 @@ -### YamlMime:TSType -name: IPropertyPaneConditionalGroup -uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneConditionalGroup -summary: Property pane conditional group. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: onShowPrimaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: onShowPrimaryGroup - summary: Callback when user clicks to show primary group. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onShowPrimaryGroup?: () => void;' - return: - type: () => void - - name: onShowSecondaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: onShowSecondaryGroup - summary: Callback when user clicks to show secondary group. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onShowSecondaryGroup?: () => void;' - return: - type: () => void - - name: primaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: primaryGroup - summary: Primary group to show - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'primaryGroup: IPropertyPaneGroup;' - return: - type: '' - - name: secondaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: secondaryGroup - summary: Secondary group to show - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'secondaryGroup: IPropertyPaneGroup;' - return: - type: '' - - name: showSecondaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: showSecondaryGroup - summary: Indicating whether the property pane should show primary group or the secondary group. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'showSecondaryGroup: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IPropertyPaneConditionalGroup +uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneConditionalGroup +summary: Property pane conditional group. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: onShowPrimaryGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' + package: '@microsoft/sp-property-pane!' + fullName: onShowPrimaryGroup + summary: Callback when user clicks to show primary group. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onShowPrimaryGroup?: () => void;' + return: + type: () => void + - name: onShowSecondaryGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' + package: '@microsoft/sp-property-pane!' + fullName: onShowSecondaryGroup + summary: Callback when user clicks to show secondary group. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onShowSecondaryGroup?: () => void;' + return: + type: () => void + - name: primaryGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' + package: '@microsoft/sp-property-pane!' + fullName: primaryGroup + summary: Primary group to show + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryGroup: IPropertyPaneGroup;' + return: + type: '' + - name: secondaryGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' + package: '@microsoft/sp-property-pane!' + fullName: secondaryGroup + summary: Secondary group to show + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'secondaryGroup: IPropertyPaneGroup;' + return: + type: '' + - name: showSecondaryGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' + package: '@microsoft/sp-property-pane!' + fullName: showSecondaryGroup + summary: Indicating whether the property pane should show primary group or the secondary group. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'showSecondaryGroup: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 93a7ceb3..a6ecfe2d 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -1,94 +1,94 @@ -### YamlMime:TSType -name: IPropertyPaneConfiguration -uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneConfiguration -summary: Web part configuration settings -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: currentPage - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' - package: '@microsoft/sp-property-pane!' - fullName: currentPage - summary: Page to be displayed on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'currentPage?: number;' - return: - type: number - - name: debounceProperties - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' - package: '@microsoft/sp-property-pane!' - fullName: debounceProperties - summary: List of properties to debounce the `onPropertyPaneFieldChanged` event. - remarks: >- - If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web - part properties. This may lead to jank for some property pane controls or web parts. You can use this - configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other - properties will be unaffected. - isPreview: true - isDeprecated: false - syntax: - content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' - return: - type: '[]' - - name: disableFocusTrap - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableFocusTrap:member' - package: '@microsoft/sp-property-pane!' - fullName: disableFocusTrap - summary: Whether to disable trapping focus inside property pane. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'disableFocusTrap?: boolean;' - return: - type: boolean - - name: loadingIndicatorDelayTime - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' - package: '@microsoft/sp-property-pane!' - fullName: loadingIndicatorDelayTime - summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. - remarks: The default value is 500. - isPreview: false - isDeprecated: false - syntax: - content: 'loadingIndicatorDelayTime?: number;' - return: - type: number - - name: pages - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' - package: '@microsoft/sp-property-pane!' - fullName: pages - summary: Total number of pages on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'pages: IPropertyPanePage[];' - return: - type: '[]' - - name: showLoadingIndicator - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' - package: '@microsoft/sp-property-pane!' - fullName: showLoadingIndicator - summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. - remarks: >- - This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay - loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator - property). - - - The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in - real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - isPreview: false - isDeprecated: false - syntax: - content: 'showLoadingIndicator?: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IPropertyPaneConfiguration +uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneConfiguration +summary: Web part configuration settings +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: currentPage + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' + package: '@microsoft/sp-property-pane!' + fullName: currentPage + summary: Page to be displayed on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'currentPage?: number;' + return: + type: number + - name: debounceProperties + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' + package: '@microsoft/sp-property-pane!' + fullName: debounceProperties + summary: List of properties to debounce the `onPropertyPaneFieldChanged` event. + remarks: >- + If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web + part properties. This may lead to jank for some property pane controls or web parts. You can use this + configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other + properties will be unaffected. + isPreview: true + isDeprecated: false + syntax: + content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' + return: + type: '[]' + - name: disableFocusTrap + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableFocusTrap:member' + package: '@microsoft/sp-property-pane!' + fullName: disableFocusTrap + summary: Whether to disable trapping focus inside property pane. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'disableFocusTrap?: boolean;' + return: + type: boolean + - name: loadingIndicatorDelayTime + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' + package: '@microsoft/sp-property-pane!' + fullName: loadingIndicatorDelayTime + summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. + remarks: The default value is 500. + isPreview: false + isDeprecated: false + syntax: + content: 'loadingIndicatorDelayTime?: number;' + return: + type: number + - name: pages + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' + package: '@microsoft/sp-property-pane!' + fullName: pages + summary: Total number of pages on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'pages: IPropertyPanePage[];' + return: + type: '[]' + - name: showLoadingIndicator + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' + package: '@microsoft/sp-property-pane!' + fullName: showLoadingIndicator + summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. + remarks: >- + This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay + loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator + property). + + + The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in + real life async requests could take long and it becomes necessary to display a loading indicator to the end user. + isPreview: false + isDeprecated: false + syntax: + content: 'showLoadingIndicator?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index ebac223f..7ad1d67f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -1,75 +1,75 @@ -### YamlMime:TSType -name: IPropertyPaneCustomFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneCustomFieldProps -summary: PropertyPane CustomPropertyField props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: context - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' - package: '@microsoft/sp-property-pane!' - fullName: context - summary: >- - Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web - part can use this context to manage state information. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'context?: any;' - return: - type: any - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key - summary: >- - An UNIQUE key indicates the identity of this contorl. - - - The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should - be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how - to pick the value of the key. - - - For more information, see the [React - documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key: string;' - return: - type: string - - name: onDispose - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' - package: '@microsoft/sp-property-pane!' - fullName: onDispose - summary: This API is called when the component is unmounted from the host element. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' - return: - type: '(domElement: HTMLElement, context?: any) => void' - - name: onRender - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' - package: '@microsoft/sp-property-pane!' - fullName: onRender - summary: This API will be called once the custom field is mounted on the host element. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => - void) => void; - return: - type: >- - (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => - void) => void +### YamlMime:TSType +name: IPropertyPaneCustomFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneCustomFieldProps +summary: PropertyPane CustomPropertyField props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: context + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' + package: '@microsoft/sp-property-pane!' + fullName: context + summary: >- + Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web + part can use this context to manage state information. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'context?: any;' + return: + type: any + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' + package: '@microsoft/sp-property-pane!' + fullName: key + summary: >- + An UNIQUE key indicates the identity of this contorl. + + + The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should + be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how + to pick the value of the key. + + + For more information, see the [React + documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'key: string;' + return: + type: string + - name: onDispose + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' + package: '@microsoft/sp-property-pane!' + fullName: onDispose + summary: This API is called when the component is unmounted from the host element. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' + return: + type: '(domElement: HTMLElement, context?: any) => void' + - name: onRender + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' + package: '@microsoft/sp-property-pane!' + fullName: onRender + summary: This API will be called once the custom field is mounted on the host element. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: >- + onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => + void) => void; + return: + type: >- + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => + void) => void diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index 14930d14..1cd10929 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -1,37 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDebounceProperty -uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDebounceProperty -summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: debouncePeriod - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' - package: '@microsoft/sp-property-pane!' - fullName: debouncePeriod - summary: >- - Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired - for this property. - remarks: The default value is 500. - isPreview: true - isDeprecated: false - syntax: - content: 'debouncePeriod?: number;' - return: - type: number - - name: propertyName - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' - package: '@microsoft/sp-property-pane!' - fullName: propertyName - summary: Property to debounce. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'propertyName: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneDebounceProperty +uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDebounceProperty +summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: debouncePeriod + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' + package: '@microsoft/sp-property-pane!' + fullName: debouncePeriod + summary: >- + Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired + for this property. + remarks: The default value is 500. + isPreview: true + isDeprecated: false + syntax: + content: 'debouncePeriod?: number;' + return: + type: number + - name: propertyName + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' + package: '@microsoft/sp-property-pane!' + fullName: propertyName + summary: Property to debounce. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'propertyName: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index 8e4b08ba..c38ba12b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownCalloutProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDropdownCalloutProps -summary: PropertyPane dropdown callout properties. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: calloutMaxHeight - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' - package: '@microsoft/sp-property-pane!' - fullName: calloutMaxHeight - summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'calloutMaxHeight?: number;' - return: - type: number +### YamlMime:TSType +name: IPropertyPaneDropdownCalloutProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDropdownCalloutProps +summary: PropertyPane dropdown callout properties. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: calloutMaxHeight + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' + package: '@microsoft/sp-property-pane!' + fullName: calloutMaxHeight + summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'calloutMaxHeight?: number;' + return: + type: number diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index 816d870a..79657fe2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownOption -uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDropdownOption -summary: PropertyPane drop down options. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: index - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' - package: '@microsoft/sp-property-pane!' - fullName: index - summary: Index for this option. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'index?: number;' - return: - type: number - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key - summary: A key to uniquely identify this option. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key: string | number;' - return: - type: string | number - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text - summary: Text to render for this option. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text: string;' - return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type - summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type?: PropertyPaneDropdownOptionType;' - return: - type: '' +### YamlMime:TSType +name: IPropertyPaneDropdownOption +uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDropdownOption +summary: PropertyPane drop down options. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: index + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' + package: '@microsoft/sp-property-pane!' + fullName: index + summary: Index for this option. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' + package: '@microsoft/sp-property-pane!' + fullName: key + summary: A key to uniquely identify this option. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'key: string | number;' + return: + type: string | number + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' + package: '@microsoft/sp-property-pane!' + fullName: text + summary: Text to render for this option. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' + package: '@microsoft/sp-property-pane!' + fullName: type + summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type?: PropertyPaneDropdownOptionType;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index adbd012b..b5e8bcfe 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -1,121 +1,121 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDropdownProps -summary: PropertyPane drop down component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel - summary: A description of the dropdown for the benefit of screen reader users. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel?: string;' - return: - type: string - - name: ariaPositionInSet - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaPositionInSet - summary: >- - Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It - starts from 1. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaPositionInSet?: number;' - return: - type: number - - name: ariaSetSize - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaSetSize - summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaSetSize?: number;' - return: - type: number - - name: calloutProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' - package: '@microsoft/sp-property-pane!' - fullName: calloutProps - summary: Custom properties for Dropdown's Callout used to render options. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' - return: - type: '' - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the property pane dropdown option is disabled or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: errorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: errorMessage - summary: 'If set, this will be displayed as an error message.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'errorMessage?: string;' - return: - type: string - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: Descriptive label for the Dropdown. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label: string;' - return: - type: string - - name: options - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' - package: '@microsoft/sp-property-pane!' - fullName: options - summary: Collection of options for this Dropdown. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'options?: IPropertyPaneDropdownOption[];' - return: - type: '[]' - - name: selectedKey - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' - package: '@microsoft/sp-property-pane!' - fullName: selectedKey - summary: The key of the initially selected option. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'selectedKey?: string | number;' - return: - type: string | number +### YamlMime:TSType +name: IPropertyPaneDropdownProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDropdownProps +summary: PropertyPane drop down component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaLabel + summary: A description of the dropdown for the benefit of screen reader users. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel?: string;' + return: + type: string + - name: ariaPositionInSet + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaPositionInSet + summary: >- + Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It + starts from 1. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaPositionInSet?: number;' + return: + type: number + - name: ariaSetSize + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaSetSize + summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaSetSize?: number;' + return: + type: number + - name: calloutProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' + package: '@microsoft/sp-property-pane!' + fullName: calloutProps + summary: Custom properties for Dropdown's Callout used to render options. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' + return: + type: '' + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the property pane dropdown option is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: errorMessage + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' + package: '@microsoft/sp-property-pane!' + fullName: errorMessage + summary: 'If set, this will be displayed as an error message.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'errorMessage?: string;' + return: + type: string + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: Descriptive label for the Dropdown. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label: string;' + return: + type: string + - name: options + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' + package: '@microsoft/sp-property-pane!' + fullName: options + summary: Collection of options for this Dropdown. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'options?: IPropertyPaneDropdownOption[];' + return: + type: '[]' + - name: selectedKey + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' + package: '@microsoft/sp-property-pane!' + fullName: selectedKey + summary: The key of the initially selected option. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'selectedKey?: string | number;' + return: + type: string | number diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index d9571129..6c575d36 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -1,70 +1,70 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicFieldProps -summary: PropertyPaneDynamicField props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: filters - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' - package: '@microsoft/sp-property-pane!' - fullName: filters - summary: Filters for the property pane dynamic field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'filters?: IPropertyPaneDynamicFieldFilters;' - return: - type: '' - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: 'User-friendly, localized label to identify the field.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label: string;' - return: - type: string - - name: propertyValueDepth - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' - package: '@microsoft/sp-property-pane!' - fullName: propertyValueDepth - summary: |- - Indicates to what depth of property values are shown on the property pane dynamic data widget. - - If not specified, then max of 2 levels of property value will be shown. - remarks: >- - It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only - source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., - the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two - levels of property value will be shown i.e., the widget will display two levels after the source and property for - this field. - isPreview: false - isDeprecated: false - syntax: - content: 'propertyValueDepth?: number;' - return: - type: number - - name: sourcesLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: sourcesLabel - summary: |- - User-friendly, localized label for the sources dropdown. - - default value - 'Connect to source' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sourcesLabel?: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneDynamicFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicFieldProps +summary: PropertyPaneDynamicField props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filters + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' + package: '@microsoft/sp-property-pane!' + fullName: filters + summary: Filters for the property pane dynamic field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'filters?: IPropertyPaneDynamicFieldFilters;' + return: + type: '' + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: 'User-friendly, localized label to identify the field.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label: string;' + return: + type: string + - name: propertyValueDepth + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' + package: '@microsoft/sp-property-pane!' + fullName: propertyValueDepth + summary: |- + Indicates to what depth of property values are shown on the property pane dynamic data widget. + + If not specified, then max of 2 levels of property value will be shown. + remarks: >- + It takes following values - - 0: Indicates that no property value will be shown i.e., the widget will display only + source and property for this field. - 1: Indicates that a depth of one level of property value will be shown i.e., + the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two + levels of property value will be shown i.e., the widget will display two levels after the source and property for + this field. + isPreview: false + isDeprecated: false + syntax: + content: 'propertyValueDepth?: number;' + return: + type: number + - name: sourcesLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: sourcesLabel + summary: |- + User-friendly, localized label for the sources dropdown. + + default value - 'Connect to source' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'sourcesLabel?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index fb2f2e29..2f3eb31e 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldSetProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicFieldSetProps -summary: PropertyPane DynamicFieldSet props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: fields - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' - package: '@microsoft/sp-property-pane!' - fullName: fields - summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'fields: IPropertyPaneField[];' - return: - type: >- - <>[] - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: 'User-friendly, localized label to identify the property.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label: string;' - return: - type: string - - name: sharedConfiguration - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' - package: '@microsoft/sp-property-pane!' - fullName: sharedConfiguration - summary: Configuration shared between all the entries of the set. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - sharedConfiguration?: { - depth: DynamicDataSharedDepth; - source?: IDynamicDataSharedSourceConfiguration; - property?: IDynamicDataSharedPropertyConfiguration; - }; - return: - type: |- - { - depth: ; - source?: ; - property?: ; - } +### YamlMime:TSType +name: IPropertyPaneDynamicFieldSetProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicFieldSetProps +summary: PropertyPane DynamicFieldSet props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fields + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' + package: '@microsoft/sp-property-pane!' + fullName: fields + summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'fields: IPropertyPaneField[];' + return: + type: >- + <>[] + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: 'User-friendly, localized label to identify the property.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label: string;' + return: + type: string + - name: sharedConfiguration + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' + package: '@microsoft/sp-property-pane!' + fullName: sharedConfiguration + summary: Configuration shared between all the entries of the set. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + sharedConfiguration?: { + depth: DynamicDataSharedDepth; + source?: IDynamicDataSharedSourceConfiguration; + property?: IDynamicDataSharedPropertyConfiguration; + }; + return: + type: |- + { + depth: ; + source?: ; + property?: ; + } diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 7235fe31..33ad157f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -1,150 +1,150 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicTextFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicTextFieldProps -summary: '`PropertyPaneDynamicData` component props.' -remarks: '' -isPreview: true -isDeprecated: true -customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel - summary: 'ARIA Label for text field, if any.' - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'ariaLabel?: string;' - return: - type: string - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description - summary: The text field input description. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the property pane text field is enabled or not. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: errorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: errorMessage - summary: 'If set, this will be displayed as an error message.' - remarks: >- - When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the - error message. - - - Make sure to set this only if you want to see an error message displayed for the text field. - isPreview: true - isDeprecated: false - syntax: - content: 'errorMessage?: string;' - return: - type: string - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: Label for the text field. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'label?: string;' - return: - type: string - - name: onGetErrorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: onGetErrorMessage - summary: This method is used to get the validation error message and determine whether the input value is valid or not. - remarks: |- - When it returns string: - - - If valid, it returns empty string. - - - If invalid, it returns the error message string and an error message is displayed below the text field. - - When it returns `Promise`: - - - The resolved value is display as error message. - - - The rejected, the value is thrown away. - isPreview: true - isDeprecated: false - syntax: - content: 'onGetErrorMessage?: (value: string) => string | Promise;' - return: - type: '(value: string) => string | Promise<string>' - - name: placeholder - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' - package: '@microsoft/sp-property-pane!' - fullName: placeholder - summary: Placeholder text to be displayed in the text field. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'placeholder?: string;' - return: - type: string - - name: validateOnFocusIn - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusIn - summary: Run validation when the PropertyPaneTextField is focused. - remarks: The default value is false. - isPreview: true - isDeprecated: false - syntax: - content: 'validateOnFocusIn?: boolean;' - return: - type: boolean - - name: validateOnFocusOut - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusOut - summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. - remarks: The default value is false. - isPreview: true - isDeprecated: false - syntax: - content: 'validateOnFocusOut?: boolean;' - return: - type: boolean - - name: value - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' - package: '@microsoft/sp-property-pane!' - fullName: value - summary: >- - Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is - empty or contains null value. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'value?: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneDynamicTextFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicTextFieldProps +summary: '`PropertyPaneDynamicData` component props.' +remarks: '' +isPreview: true +isDeprecated: true +customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaLabel + summary: 'ARIA Label for text field, if any.' + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'ariaLabel?: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' + package: '@microsoft/sp-property-pane!' + fullName: description + summary: The text field input description. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the property pane text field is enabled or not. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: errorMessage + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' + package: '@microsoft/sp-property-pane!' + fullName: errorMessage + summary: 'If set, this will be displayed as an error message.' + remarks: >- + When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the + error message. + + + Make sure to set this only if you want to see an error message displayed for the text field. + isPreview: true + isDeprecated: false + syntax: + content: 'errorMessage?: string;' + return: + type: string + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: Label for the text field. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'label?: string;' + return: + type: string + - name: onGetErrorMessage + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' + package: '@microsoft/sp-property-pane!' + fullName: onGetErrorMessage + summary: This method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- + When it returns string: + + - If valid, it returns empty string. + + - If invalid, it returns the error message string and an error message is displayed below the text field. + + When it returns `Promise`: + + - The resolved value is display as error message. + + - The rejected, the value is thrown away. + isPreview: true + isDeprecated: false + syntax: + content: 'onGetErrorMessage?: (value: string) => string | Promise;' + return: + type: '(value: string) => string | Promise<string>' + - name: placeholder + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' + package: '@microsoft/sp-property-pane!' + fullName: placeholder + summary: Placeholder text to be displayed in the text field. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'placeholder?: string;' + return: + type: string + - name: validateOnFocusIn + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusIn + summary: Run validation when the PropertyPaneTextField is focused. + remarks: The default value is false. + isPreview: true + isDeprecated: false + syntax: + content: 'validateOnFocusIn?: boolean;' + return: + type: boolean + - name: validateOnFocusOut + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusOut + summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. + remarks: The default value is false. + isPreview: true + isDeprecated: false + syntax: + content: 'validateOnFocusOut?: boolean;' + return: + type: boolean + - name: value + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' + package: '@microsoft/sp-property-pane!' + fullName: value + summary: >- + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'value?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index e0b9674a..193fe82f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -1,59 +1,59 @@ -### YamlMime:TSType -name: IPropertyPaneField -uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneField -summary: PropertyPane field. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: properties - uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' - package: '@microsoft/sp-property-pane!' - fullName: properties - summary: Strongly typed properties object. Specific to each field type. - remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - isPreview: false - isDeprecated: false - syntax: - content: 'properties: TProperties;' - return: - type: TProperties - - name: shouldFocus - uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' - package: '@microsoft/sp-property-pane!' - fullName: shouldFocus - summary: Whether this control should be focused. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'shouldFocus?: boolean;' - return: - type: boolean - - name: targetProperty - uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' - package: '@microsoft/sp-property-pane!' - fullName: targetProperty - summary: Target property from the web part's property bag. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'targetProperty: string;' - return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type - summary: Type of the PropertyPane field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: PropertyPaneFieldType;' - return: - type: '' +### YamlMime:TSType +name: IPropertyPaneField +uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneField +summary: PropertyPane field. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: properties + uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' + package: '@microsoft/sp-property-pane!' + fullName: properties + summary: Strongly typed properties object. Specific to each field type. + remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' + isPreview: false + isDeprecated: false + syntax: + content: 'properties: TProperties;' + return: + type: TProperties + - name: shouldFocus + uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' + package: '@microsoft/sp-property-pane!' + fullName: shouldFocus + summary: Whether this control should be focused. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'shouldFocus?: boolean;' + return: + type: boolean + - name: targetProperty + uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' + package: '@microsoft/sp-property-pane!' + fullName: targetProperty + summary: Target property from the web part's property bag. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'targetProperty: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' + package: '@microsoft/sp-property-pane!' + fullName: type + summary: Type of the PropertyPane field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'type: PropertyPaneFieldType;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index e09fada7..34db3cfd 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -1,49 +1,63 @@ -### YamlMime:TSType -name: IPropertyPaneGroup -uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneGroup -summary: PropertyPane group. Group is part of the PropertyPanePage. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: groupFields - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' - package: '@microsoft/sp-property-pane!' - fullName: groupFields - summary: List of PropertyPane fields. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'groupFields: IPropertyPaneField[];' - return: - type: '<any>[]' - - name: groupName - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' - package: '@microsoft/sp-property-pane!' - fullName: groupName - summary: Display name for the group. - remarks: >- - For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left - empty, the group header will not render (not recommended for accordions). - isPreview: false - isDeprecated: false - syntax: - content: 'groupName?: string;' - return: - type: string - - name: isCollapsed - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' - package: '@microsoft/sp-property-pane!' - fullName: isCollapsed - summary: Indicates whether the PropertyPane group is collapsed or not. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'isCollapsed?: boolean;' - return: - type: boolean +### YamlMime:TSType +name: IPropertyPaneGroup +uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneGroup +summary: PropertyPane group. Group is part of the PropertyPanePage. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: groupFields + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' + package: '@microsoft/sp-property-pane!' + fullName: groupFields + summary: List of PropertyPane fields. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'groupFields: IPropertyPaneField[];' + return: + type: '<any>[]' + - name: groupName + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' + package: '@microsoft/sp-property-pane!' + fullName: groupName + summary: Display name for the group. + remarks: >- + For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left + empty, the group header will not render (not recommended for accordions). + isPreview: false + isDeprecated: false + syntax: + content: 'groupName?: string;' + return: + type: string + - name: isCollapsed + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' + package: '@microsoft/sp-property-pane!' + fullName: isCollapsed + summary: Indicates whether the PropertyPane group is collapsed or not. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'isCollapsed?: boolean;' + return: + type: boolean + - name: isGroupNameHidden + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isGroupNameHidden:member' + package: '@microsoft/sp-property-pane!' + fullName: isGroupNameHidden + summary: Indicates whether group name should be hidden. + remarks: >- + The default value is false. Use this option to skip the rendering of group name to avoid empty group header being + displayed. + isPreview: false + isDeprecated: false + syntax: + content: 'isGroupNameHidden?: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index ca098df3..c365ee84 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IPropertyPaneLabelProps -uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneLabelProps -summary: PropertyPaneLabel component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: required - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' - package: '@microsoft/sp-property-pane!' - fullName: required - summary: Whether the associated form field is required or not. - remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - isPreview: false - isDeprecated: false - syntax: - content: 'required?: boolean;' - return: - type: boolean - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text - summary: Display text fot the label. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneLabelProps +uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneLabelProps +summary: PropertyPaneLabel component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: required + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' + package: '@microsoft/sp-property-pane!' + fullName: required + summary: Whether the associated form field is required or not. + remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' + isPreview: false + isDeprecated: false + syntax: + content: 'required?: boolean;' + return: + type: boolean + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' + package: '@microsoft/sp-property-pane!' + fullName: text + summary: Display text fot the label. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index d680532a..4421db5b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -1,85 +1,85 @@ -### YamlMime:TSType -name: IPropertyPaneLinkProps -uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneLinkProps -summary: PropertyPaneLink component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the property pane link is disabled or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: href - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' - package: '@microsoft/sp-property-pane!' - fullName: href - summary: Location to which the link is targeted to. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'href: string;' - return: - type: string - - name: popupWindowProps - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' - package: '@microsoft/sp-property-pane!' - fullName: popupWindowProps - summary: The props of pop up window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'popupWindowProps?: IPopupWindowProps;' - return: - type: '' - - name: target - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' - package: '@microsoft/sp-property-pane!' - fullName: target - summary: This attribute specifies where to display the linked resource. - remarks: >- - Following values can be used: - - - \_self - (default) Load the response in the current page. - - - \_blank - Load the response into a new unnamed tab. - - - \_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same - as "\_self" - - - \_top - Load the response into the original window. - isPreview: false - isDeprecated: false - syntax: - content: 'target?: string;' - return: - type: string - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text - summary: Display text for the link. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneLinkProps +uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneLinkProps +summary: PropertyPaneLink component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the property pane link is disabled or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: href + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' + package: '@microsoft/sp-property-pane!' + fullName: href + summary: Location to which the link is targeted to. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'href: string;' + return: + type: string + - name: popupWindowProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' + package: '@microsoft/sp-property-pane!' + fullName: popupWindowProps + summary: The props of pop up window. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'popupWindowProps?: IPopupWindowProps;' + return: + type: '' + - name: target + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' + package: '@microsoft/sp-property-pane!' + fullName: target + summary: This attribute specifies where to display the linked resource. + remarks: >- + Following values can be used: + + + \_self - (default) Load the response in the current page. + + + \_blank - Load the response into a new unnamed tab. + + + \_parent - Load the response in the parent of the current page. If no parent exists, then this option behaves same + as "\_self" + + + \_top - Load the response into the original window. + isPreview: false + isDeprecated: false + syntax: + content: 'target?: string;' + return: + type: string + - name: text + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' + package: '@microsoft/sp-property-pane!' + fullName: text + summary: Display text for the link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index c3b5aff2..7a2cbac6 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -1,49 +1,49 @@ -### YamlMime:TSType -name: IPropertyPanePage -uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPanePage -summary: PropertyPanePage interface. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: displayGroupsAsAccordion - uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' - package: '@microsoft/sp-property-pane!' - fullName: displayGroupsAsAccordion - summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'displayGroupsAsAccordion?: boolean;' - return: - type: boolean - - name: groups - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' - package: '@microsoft/sp-property-pane!' - fullName: groups - summary: List of groups to be displayed on the PropertyPane page. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' - return: - type: >- - ( | )[] - - name: header - uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' - package: '@microsoft/sp-property-pane!' - fullName: header - summary: PropertyPane page header. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'header?: IPropertyPanePageHeader;' - return: - type: '' +### YamlMime:TSType +name: IPropertyPanePage +uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPanePage +summary: PropertyPanePage interface. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: displayGroupsAsAccordion + uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' + package: '@microsoft/sp-property-pane!' + fullName: displayGroupsAsAccordion + summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'displayGroupsAsAccordion?: boolean;' + return: + type: boolean + - name: groups + uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' + package: '@microsoft/sp-property-pane!' + fullName: groups + summary: List of groups to be displayed on the PropertyPane page. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' + return: + type: >- + ( | )[] + - name: header + uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' + package: '@microsoft/sp-property-pane!' + fullName: header + summary: PropertyPane page header. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'header?: IPropertyPanePageHeader;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index cc667341..73eac723 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -1,36 +1,36 @@ -### YamlMime:TSType -name: IPropertyPanePageHeader -uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPanePageHeader -summary: PropertyPane header. This header remains same for all the pages. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description - summary: Header to display. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description: string;' - return: - type: string - - name: image - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' - package: '@microsoft/sp-property-pane!' - fullName: image - summary: Image url for the background image. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: This property is not used. - syntax: - content: 'image?: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPanePageHeader +uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPanePageHeader +summary: PropertyPane header. This header remains same for all the pages. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' + package: '@microsoft/sp-property-pane!' + fullName: description + summary: Header to display. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description: string;' + return: + type: string + - name: image + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' + package: '@microsoft/sp-property-pane!' + fullName: image + summary: Image url for the background image. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: This property is not used. + syntax: + content: 'image?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index deb06adb..03e61168 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -1,128 +1,128 @@ -### YamlMime:TSType -name: IPropertyPaneSliderProps -uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneSliderProps -summary: PropertyPaneSliderProps component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel - summary: A description of the Slider for the benefit of screen readers. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel?: string;' - return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether or not the Slider is disabled. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: Description label of the Slider. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label?: string;' - return: - type: string - - name: max - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' - package: '@microsoft/sp-property-pane!' - fullName: max - summary: The max value of the Slider. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'max: number;' - return: - type: number - - name: min - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' - package: '@microsoft/sp-property-pane!' - fullName: min - summary: The min value of the Slider. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'min: number;' - return: - type: number - - name: showValue - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' - package: '@microsoft/sp-property-pane!' - fullName: showValue - summary: Whether to show the value on the right of the Slider. - remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - isPreview: false - isDeprecated: false - syntax: - content: 'showValue?: boolean;' - return: - type: boolean - - name: step - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' - package: '@microsoft/sp-property-pane!' - fullName: step - summary: The difference between the two adjacent values of the Slider. Defaults to 1. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'step?: number;' - return: - type: number - - name: value - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' - package: '@microsoft/sp-property-pane!' - fullName: value - summary: |- - The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. - - Defaults to min. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'value?: number;' - return: - type: number - - name: valueFormat - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' - package: '@microsoft/sp-property-pane!' - fullName: valueFormat - summary: |- - Callback to format the Slider value. For example, if - - ```typescript - (value) => `${value}%` - ``` - is specified, the value of the Slider has % after it. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'valueFormat?: (value: number) => string;' - return: - type: '(value: number) => string' +### YamlMime:TSType +name: IPropertyPaneSliderProps +uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneSliderProps +summary: PropertyPaneSliderProps component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaLabel + summary: A description of the Slider for the benefit of screen readers. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel?: string;' + return: + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether or not the Slider is disabled. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: Description label of the Slider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label?: string;' + return: + type: string + - name: max + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' + package: '@microsoft/sp-property-pane!' + fullName: max + summary: The max value of the Slider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'max: number;' + return: + type: number + - name: min + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' + package: '@microsoft/sp-property-pane!' + fullName: min + summary: The min value of the Slider. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'min: number;' + return: + type: number + - name: showValue + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' + package: '@microsoft/sp-property-pane!' + fullName: showValue + summary: Whether to show the value on the right of the Slider. + remarks: 'If you want to show the value by yourself, you may want to set this value to false.' + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: step + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' + package: '@microsoft/sp-property-pane!' + fullName: step + summary: The difference between the two adjacent values of the Slider. Defaults to 1. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'step?: number;' + return: + type: number + - name: value + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' + package: '@microsoft/sp-property-pane!' + fullName: value + summary: |- + The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. + + Defaults to min. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'value?: number;' + return: + type: number + - name: valueFormat + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' + package: '@microsoft/sp-property-pane!' + fullName: valueFormat + summary: |- + Callback to format the Slider value. For example, if + + ```typescript + (value) => `${value}%` + ``` + is specified, the value of the Slider has % after it. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'valueFormat?: (value: number) => string;' + return: + type: '(value: number) => string' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index c180984d..ef59e71b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -1,261 +1,261 @@ -### YamlMime:TSType -name: IPropertyPaneTextFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneTextFieldProps -summary: PropertyPaneTextField component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel - summary: 'Aria Label for text field, if any.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ariaLabel?: string;' - return: - type: string - - name: deferredValidationTime - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' - package: '@microsoft/sp-property-pane!' - fullName: deferredValidationTime - summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. - remarks: The default value is 200. - isPreview: false - isDeprecated: false - syntax: - content: 'deferredValidationTime?: number;' - return: - type: number - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description - summary: The text field input description. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Whether the property pane text field is enabled or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: errorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: errorMessage - summary: 'If set, this will be displayed as an error message.' - remarks: >- - When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the - error message. - - - So, make sure to set this only if you want to see an error message displayed for the text field. - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage?: string;' - return: - type: string - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: Label for the text field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label?: string;' - return: - type: string - - name: logName - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' - package: '@microsoft/sp-property-pane!' - fullName: logName - summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. - remarks: >- - The messages will be logged with a format such as `.`. - - - For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might - contain: - - - 1. The action type: - - - `Add`: change from initial/unset state to customized content. (first edit) - - - `Clear`: reset the content of caption element to initial/unset state. - - - `Edit`: any edition that changes the content apart from add and clear - - - 2. The text length after each edit - isPreview: false - isDeprecated: false - syntax: - content: |- - logName?: { - moduleName: string; - controlName: string; - }; - return: - type: |- - { - moduleName: string; - controlName: string; - } - - name: maxLength - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' - package: '@microsoft/sp-property-pane!' - fullName: maxLength - summary: Maximum number of characters that the PropertyPaneTextField can have. - remarks: 'If the value is set to a negative number, an exception will be thrown.' - isPreview: false - isDeprecated: false - syntax: - content: 'maxLength?: number;' - return: - type: number - - name: multiline - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' - package: '@microsoft/sp-property-pane!' - fullName: multiline - summary: Whether or not the text field is a multiline text field. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'multiline?: boolean;' - return: - type: boolean - - name: onGetErrorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: onGetErrorMessage - summary: The method is used to get the validation error message and determine whether the input value is valid or not. - remarks: |- - When it returns string: - - - If valid, it returns empty string. - - - If invalid, it returns the error message string and an error message is displayed below the text field. - - When it returns `Promise`: - - - The resolved value is display as error message. - - - The rejected, the value is thrown away. - isPreview: false - isDeprecated: false - syntax: - content: 'onGetErrorMessage?: (value: string) => string | Promise;' - return: - type: '(value: string) => string | Promise<string>' - - name: placeholder - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' - package: '@microsoft/sp-property-pane!' - fullName: placeholder - summary: placeholder text to be displayed in the text field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'placeholder?: string;' - return: - type: string - - name: resizable - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' - package: '@microsoft/sp-property-pane!' - fullName: resizable - summary: Whether or not the multiline text field is resizable. - remarks: The default value is true. - isPreview: false - isDeprecated: false - syntax: - content: 'resizable?: boolean;' - return: - type: boolean - - name: rows - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' - package: '@microsoft/sp-property-pane!' - fullName: rows - summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' - remarks: This prop is used only when the multiline prop is set to true. - isPreview: false - isDeprecated: false - syntax: - content: 'rows?: number;' - return: - type: number - - name: underlined - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' - package: '@microsoft/sp-property-pane!' - fullName: underlined - summary: Whether or not the text field is underlined. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'underlined?: boolean;' - return: - type: boolean - - name: validateOnFocusIn - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusIn - summary: Run validation when the PropertyPaneTextField is focused. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'validateOnFocusIn?: boolean;' - return: - type: boolean - - name: validateOnFocusOut - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusOut - summary: Run validation when the PropertyPaneTextField is out of focus or on blur. - remarks: The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: 'validateOnFocusOut?: boolean;' - return: - type: boolean - - name: value - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' - package: '@microsoft/sp-property-pane!' - fullName: value - summary: >- - Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is - empty or contains null value. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'value?: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneTextFieldProps +uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneTextFieldProps +summary: PropertyPaneTextField component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: ariaLabel + summary: 'Aria Label for text field, if any.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'ariaLabel?: string;' + return: + type: string + - name: deferredValidationTime + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' + package: '@microsoft/sp-property-pane!' + fullName: deferredValidationTime + summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. + remarks: The default value is 200. + isPreview: false + isDeprecated: false + syntax: + content: 'deferredValidationTime?: number;' + return: + type: number + - name: description + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' + package: '@microsoft/sp-property-pane!' + fullName: description + summary: The text field input description. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Whether the property pane text field is enabled or not. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: errorMessage + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' + package: '@microsoft/sp-property-pane!' + fullName: errorMessage + summary: 'If set, this will be displayed as an error message.' + remarks: >- + When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the + error message. + + + So, make sure to set this only if you want to see an error message displayed for the text field. + isPreview: false + isDeprecated: false + syntax: + content: 'errorMessage?: string;' + return: + type: string + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: Label for the text field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label?: string;' + return: + type: string + - name: logName + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' + package: '@microsoft/sp-property-pane!' + fullName: logName + summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. + remarks: >- + The messages will be logged with a format such as `.`. + + + For example, if `{moduleName: 'ImageWebPart', controlName: 'OverlayText'}` is specified, the engagement log might + contain: + + + 1. The action type: + + + `Add`: change from initial/unset state to customized content. (first edit) + + + `Clear`: reset the content of caption element to initial/unset state. + + + `Edit`: any edition that changes the content apart from add and clear + + + 2. The text length after each edit + isPreview: false + isDeprecated: false + syntax: + content: |- + logName?: { + moduleName: string; + controlName: string; + }; + return: + type: |- + { + moduleName: string; + controlName: string; + } + - name: maxLength + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' + package: '@microsoft/sp-property-pane!' + fullName: maxLength + summary: Maximum number of characters that the PropertyPaneTextField can have. + remarks: 'If the value is set to a negative number, an exception will be thrown.' + isPreview: false + isDeprecated: false + syntax: + content: 'maxLength?: number;' + return: + type: number + - name: multiline + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' + package: '@microsoft/sp-property-pane!' + fullName: multiline + summary: Whether or not the text field is a multiline text field. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'multiline?: boolean;' + return: + type: boolean + - name: onGetErrorMessage + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' + package: '@microsoft/sp-property-pane!' + fullName: onGetErrorMessage + summary: The method is used to get the validation error message and determine whether the input value is valid or not. + remarks: |- + When it returns string: + + - If valid, it returns empty string. + + - If invalid, it returns the error message string and an error message is displayed below the text field. + + When it returns `Promise`: + + - The resolved value is display as error message. + + - The rejected, the value is thrown away. + isPreview: false + isDeprecated: false + syntax: + content: 'onGetErrorMessage?: (value: string) => string | Promise;' + return: + type: '(value: string) => string | Promise<string>' + - name: placeholder + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' + package: '@microsoft/sp-property-pane!' + fullName: placeholder + summary: placeholder text to be displayed in the text field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'placeholder?: string;' + return: + type: string + - name: resizable + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' + package: '@microsoft/sp-property-pane!' + fullName: resizable + summary: Whether or not the multiline text field is resizable. + remarks: The default value is true. + isPreview: false + isDeprecated: false + syntax: + content: 'resizable?: boolean;' + return: + type: boolean + - name: rows + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' + package: '@microsoft/sp-property-pane!' + fullName: rows + summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' + remarks: This prop is used only when the multiline prop is set to true. + isPreview: false + isDeprecated: false + syntax: + content: 'rows?: number;' + return: + type: number + - name: underlined + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' + package: '@microsoft/sp-property-pane!' + fullName: underlined + summary: Whether or not the text field is underlined. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'underlined?: boolean;' + return: + type: boolean + - name: validateOnFocusIn + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusIn + summary: Run validation when the PropertyPaneTextField is focused. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'validateOnFocusIn?: boolean;' + return: + type: boolean + - name: validateOnFocusOut + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' + package: '@microsoft/sp-property-pane!' + fullName: validateOnFocusOut + summary: Run validation when the PropertyPaneTextField is out of focus or on blur. + remarks: The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: 'validateOnFocusOut?: boolean;' + return: + type: boolean + - name: value + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' + package: '@microsoft/sp-property-pane!' + fullName: value + summary: >- + Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is + empty or contains null value. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'value?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index 15a7e76a..dd4c3c93 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -1,107 +1,107 @@ -### YamlMime:TSType -name: IPropertyPaneToggleProps -uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneToggleProps -summary: PropertyPaneToggle component props. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: checked - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' - package: '@microsoft/sp-property-pane!' - fullName: checked - summary: Checked state of the toggle. - remarks: 'If you are maintaining state yourself, use this property.' - isPreview: false - isDeprecated: false - syntax: - content: 'checked?: boolean;' - return: - type: boolean - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled - summary: Optional disabled flag. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disabled?: boolean;' - return: - type: boolean - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key - summary: A key to uniquely identify the field. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key?: string | number;' - return: - type: string | number - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label - summary: A label for the toggle. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label: string | React.ReactElement;' - return: - type: 'string | ' - - name: offAriaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: offAriaLabel - summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'offAriaLabel?: string;' - return: - type: string - - name: offText - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' - package: '@microsoft/sp-property-pane!' - fullName: offText - summary: Test display when toggle is OFF. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'offText?: string;' - return: - type: string - - name: onAriaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: onAriaLabel - summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onAriaLabel?: string;' - return: - type: string - - name: onText - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' - package: '@microsoft/sp-property-pane!' - fullName: onText - summary: Text to display when toggle is ON. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onText?: string;' - return: - type: string +### YamlMime:TSType +name: IPropertyPaneToggleProps +uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneToggleProps +summary: PropertyPaneToggle component props. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: checked + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' + package: '@microsoft/sp-property-pane!' + fullName: checked + summary: Checked state of the toggle. + remarks: 'If you are maintaining state yourself, use this property.' + isPreview: false + isDeprecated: false + syntax: + content: 'checked?: boolean;' + return: + type: boolean + - name: disabled + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' + package: '@microsoft/sp-property-pane!' + fullName: disabled + summary: Optional disabled flag. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabled?: boolean;' + return: + type: boolean + - name: key + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' + package: '@microsoft/sp-property-pane!' + fullName: key + summary: A key to uniquely identify the field. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'key?: string | number;' + return: + type: string | number + - name: label + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' + package: '@microsoft/sp-property-pane!' + fullName: label + summary: A label for the toggle. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'label: string | React.ReactElement;' + return: + type: 'string | ' + - name: offAriaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: offAriaLabel + summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'offAriaLabel?: string;' + return: + type: string + - name: offText + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' + package: '@microsoft/sp-property-pane!' + fullName: offText + summary: Test display when toggle is OFF. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'offText?: string;' + return: + type: string + - name: onAriaLabel + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' + package: '@microsoft/sp-property-pane!' + fullName: onAriaLabel + summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onAriaLabel?: string;' + return: + type: string + - name: onText + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' + package: '@microsoft/sp-property-pane!' + fullName: onText + summary: Text to display when toggle is ON. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'onText?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index 1c7ebe94..fa6c0ef0 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -1,35 +1,35 @@ -### YamlMime:TSEnum -name: PopupWindowPosition -uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' -package: '@microsoft/sp-property-pane!' -fullName: PopupWindowPosition -summary: The position of pop up window. -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: center - uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' - package: '@microsoft/sp-property-pane!' - summary: PopupWindowPosition would be located in center of screen. - value: '0' - - name: leftBottom - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' - package: '@microsoft/sp-property-pane!' - summary: PopupWindowPosition would be located in left bottom of screen. - value: '4' - - name: leftTop - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' - package: '@microsoft/sp-property-pane!' - summary: PopupWindowPosition would be located in left top of screen. - value: '2' - - name: rightBottom - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' - package: '@microsoft/sp-property-pane!' - summary: PopupWindowPosition would be located in right bottom of screen. - value: '3' - - name: rightTop - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' - package: '@microsoft/sp-property-pane!' - summary: PopupWindowPosition would be located in right top of screen. - value: '1' +### YamlMime:TSEnum +name: PopupWindowPosition +uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' +package: '@microsoft/sp-property-pane!' +fullName: PopupWindowPosition +summary: The position of pop up window. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: center + uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' + package: '@microsoft/sp-property-pane!' + summary: PopupWindowPosition would be located in center of screen. + value: '0' + - name: leftBottom + uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' + package: '@microsoft/sp-property-pane!' + summary: PopupWindowPosition would be located in left bottom of screen. + value: '4' + - name: leftTop + uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' + package: '@microsoft/sp-property-pane!' + summary: PopupWindowPosition would be located in left top of screen. + value: '2' + - name: rightBottom + uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' + package: '@microsoft/sp-property-pane!' + summary: PopupWindowPosition would be located in right bottom of screen. + value: '3' + - name: rightTop + uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' + package: '@microsoft/sp-property-pane!' + summary: PopupWindowPosition would be located in right top of screen. + value: '1' diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index 4215c282..945c8d11 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -1,42 +1,42 @@ -### YamlMime:TSEnum -name: PropertyPaneButtonType -uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' -package: '@microsoft/sp-property-pane!' -fullName: PropertyPaneButtonType -summary: Enum for all the supported button types. -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Command - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' - package: '@microsoft/sp-property-pane!' - summary: Optional actions. - value: '4' - - name: Compound - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' - package: '@microsoft/sp-property-pane!' - summary: Always used as a set with both Standard and Primary compound buttons. - value: '3' - - name: Hero - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' - package: '@microsoft/sp-property-pane!' - summary: Hero button. - value: '2' - - name: Icon - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' - package: '@microsoft/sp-property-pane!' - summary: >- - Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within - the command bar. - value: '5' - - name: Normal - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' - package: '@microsoft/sp-property-pane!' - summary: Optional completion action. - value: '0' - - name: Primary - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' - package: '@microsoft/sp-property-pane!' - summary: Preferred completion action when paired with a Standard button. - value: '1' +### YamlMime:TSEnum +name: PropertyPaneButtonType +uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' +package: '@microsoft/sp-property-pane!' +fullName: PropertyPaneButtonType +summary: Enum for all the supported button types. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Command + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' + package: '@microsoft/sp-property-pane!' + summary: Optional actions. + value: '4' + - name: Compound + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' + package: '@microsoft/sp-property-pane!' + summary: Always used as a set with both Standard and Primary compound buttons. + value: '3' + - name: Hero + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' + package: '@microsoft/sp-property-pane!' + summary: Hero button. + value: '2' + - name: Icon + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' + package: '@microsoft/sp-property-pane!' + summary: >- + Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within + the command bar. + value: '5' + - name: Normal + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' + package: '@microsoft/sp-property-pane!' + summary: Optional completion action. + value: '0' + - name: Primary + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' + package: '@microsoft/sp-property-pane!' + summary: Preferred completion action when paired with a Standard button. + value: '1' diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index ec59c37b..e7d1ce3a 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -1,27 +1,27 @@ -### YamlMime:TSEnum -name: PropertyPaneDropdownOptionType -uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' -package: '@microsoft/sp-property-pane!' -fullName: PropertyPaneDropdownOptionType -summary: >- - Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Divider - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' - package: '@microsoft/sp-property-pane!' - summary: Render a divider. - value: '1' - - name: Header - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' - package: '@microsoft/sp-property-pane!' - summary: Render menu item as a header. - value: '2' - - name: Normal - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' - package: '@microsoft/sp-property-pane!' - summary: Render normal menu item. - value: '0' +### YamlMime:TSEnum +name: PropertyPaneDropdownOptionType +uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' +package: '@microsoft/sp-property-pane!' +fullName: PropertyPaneDropdownOptionType +summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Divider + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' + package: '@microsoft/sp-property-pane!' + summary: Render a divider. + value: '1' + - name: Header + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' + package: '@microsoft/sp-property-pane!' + summary: Render menu item as a header. + value: '2' + - name: Normal + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' + package: '@microsoft/sp-property-pane!' + summary: Render normal menu item. + value: '0' diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 04c93910..fb871153 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -1,88 +1,88 @@ -### YamlMime:TSEnum -name: PropertyPaneFieldType -uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' -package: '@microsoft/sp-property-pane!' -fullName: PropertyPaneFieldType -summary: |- - Enum for all the supported PropertyPane field types. - - Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Button - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' - package: '@microsoft/sp-property-pane!' - summary: Button field. - value: '11' - - name: CheckBox - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' - package: '@microsoft/sp-property-pane!' - summary: Checkbox field. - value: '2' - - name: ChoiceGroup - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' - package: '@microsoft/sp-property-pane!' - summary: Choice Group field. - value: '10' - - name: Custom - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' - package: '@microsoft/sp-property-pane!' - summary: Custom field. - value: '1' - - name: Dropdown - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' - package: '@microsoft/sp-property-pane!' - summary: Dropdown field. - value: '6' - - name: DynamicField - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' - package: '@microsoft/sp-property-pane!' - summary: Dynamic data field. - value: '14' - - name: DynamicFieldSet - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' - package: '@microsoft/sp-property-pane!' - summary: A set of dynamic fields. - value: '16' - - name: DynamicTextField - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' - package: '@microsoft/sp-property-pane!' - summary: Dynamic Text Field - value: '15' - - name: Heading - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' - package: '@microsoft/sp-property-pane!' - summary: Heading field. - value: '9' - - name: HorizontalRule - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' - package: '@microsoft/sp-property-pane!' - summary: Horizontal Rule field. - value: '12' - - name: Label - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' - package: '@microsoft/sp-property-pane!' - summary: Label field. - value: '7' - - name: Link - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' - package: '@microsoft/sp-property-pane!' - summary: Link field. - value: '13' - - name: Slider - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' - package: '@microsoft/sp-property-pane!' - summary: Slider field. - value: '8' - - name: TextField - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' - package: '@microsoft/sp-property-pane!' - summary: TextField field. - value: '3' - - name: Toggle - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' - package: '@microsoft/sp-property-pane!' - summary: Toggle field. - value: '5' +### YamlMime:TSEnum +name: PropertyPaneFieldType +uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' +package: '@microsoft/sp-property-pane!' +fullName: PropertyPaneFieldType +summary: |- + Enum for all the supported PropertyPane field types. + + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. +remarks: '' +isPreview: false +isDeprecated: false +fields: + - name: Button + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' + package: '@microsoft/sp-property-pane!' + summary: Button field. + value: '11' + - name: CheckBox + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' + package: '@microsoft/sp-property-pane!' + summary: Checkbox field. + value: '2' + - name: ChoiceGroup + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' + package: '@microsoft/sp-property-pane!' + summary: Choice Group field. + value: '10' + - name: Custom + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' + package: '@microsoft/sp-property-pane!' + summary: Custom field. + value: '1' + - name: Dropdown + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' + package: '@microsoft/sp-property-pane!' + summary: Dropdown field. + value: '6' + - name: DynamicField + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' + package: '@microsoft/sp-property-pane!' + summary: Dynamic data field. + value: '14' + - name: DynamicFieldSet + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' + package: '@microsoft/sp-property-pane!' + summary: A set of dynamic fields. + value: '16' + - name: DynamicTextField + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' + package: '@microsoft/sp-property-pane!' + summary: Dynamic Text Field + value: '15' + - name: Heading + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' + package: '@microsoft/sp-property-pane!' + summary: Heading field. + value: '9' + - name: HorizontalRule + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' + package: '@microsoft/sp-property-pane!' + summary: Horizontal Rule field. + value: '12' + - name: Label + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' + package: '@microsoft/sp-property-pane!' + summary: Label field. + value: '7' + - name: Link + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' + package: '@microsoft/sp-property-pane!' + summary: Link field. + value: '13' + - name: Slider + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' + package: '@microsoft/sp-property-pane!' + summary: Slider field. + value: '8' + - name: TextField + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' + package: '@microsoft/sp-property-pane!' + summary: TextField field. + value: '3' + - name: Toggle + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' + package: '@microsoft/sp-property-pane!' + summary: Toggle field. + value: '5' diff --git a/SP-Framework/sp-search-extensibility.yml b/SP-Framework/sp-search-extensibility.yml index 373ff5ce..df221c4c 100644 --- a/SP-Framework/sp-search-extensibility.yml +++ b/SP-Framework/sp-search-extensibility.yml @@ -1,12 +1,12 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-search-extensibility!' -name: '@microsoft/sp-search-extensibility' -type: package -summary: SharePoint Framework developer support for customizing search. -classes: - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' - - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' -interfaces: - - '@microsoft/sp-search-extensibility!IQuery:interface' -enums: - - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' +### YamlMime:TSPackage +uid: '@microsoft/sp-search-extensibility!' +name: '@microsoft/sp-search-extensibility' +type: package +summary: SharePoint Framework developer support for customizing search. +classes: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' +interfaces: + - '@microsoft/sp-search-extensibility!IQuery:interface' +enums: + - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 92cedf82..3e750439 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -1,71 +1,71 @@ -### YamlMime:TSType -name: BaseSearchQueryModifier -uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' -package: '@microsoft/sp-search-extensibility!' -fullName: BaseSearchQueryModifier -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that can modify the - search query. - - - In the component manifest, the "extensionType" should be set to "SearchQueryModifier". -remarks: '' -isPreview: true -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' - package: '@microsoft/sp-search-extensibility!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: true - isDeprecated: false - syntax: - content: 'protected readonly context: SearchQueryModifierContext;' - return: - type: '' - - name: timeout - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' - package: '@microsoft/sp-search-extensibility!' - fullName: timeout - summary: >- - Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the - original query will be used instead of the modified one. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get timeout(): number; - return: - type: number -methods: - - name: 'modifySearchQuery(query, scenario)' - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' - package: '@microsoft/sp-search-extensibility!' - fullName: 'modifySearchQuery(query, scenario)' - summary: Returns a modified search query. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: |- - /** @virtual */ - modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise; - parameters: - - id: query - description: Query to modify. - type: '' - - id: scenario - description: Search scenario. - type: '' - return: - type: 'Promise<>' - description: Modified query. -extends: '<TProperties> ' +### YamlMime:TSType +name: BaseSearchQueryModifier +uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' +package: '@microsoft/sp-search-extensibility!' +fullName: BaseSearchQueryModifier +summary: >- + This is the base class that third parties should extend when implementing a client-side extension that can modify the + search query. + + + In the component manifest, the "extensionType" should be set to "SearchQueryModifier". +remarks: '' +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' + package: '@microsoft/sp-search-extensibility!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: true + isDeprecated: false + syntax: + content: 'protected readonly context: SearchQueryModifierContext;' + return: + type: '' + - name: timeout + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' + package: '@microsoft/sp-search-extensibility!' + fullName: timeout + summary: >- + Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the + original query will be used instead of the modified one. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @virtual */ + get timeout(): number; + return: + type: number +methods: + - name: 'modifySearchQuery(query, scenario)' + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' + package: '@microsoft/sp-search-extensibility!' + fullName: 'modifySearchQuery(query, scenario)' + summary: Returns a modified search query. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + /** @virtual */ + modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise; + parameters: + - id: query + description: Query to modify. + type: '' + - id: scenario + description: Search scenario. + type: '' + return: + type: 'Promise<>' + description: Modified query. +extends: '<TProperties> ' diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index ab2f88fd..f7bc45b7 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -1,35 +1,35 @@ -### YamlMime:TSType -name: IQuery -uid: '@microsoft/sp-search-extensibility!IQuery:interface' -package: '@microsoft/sp-search-extensibility!' -fullName: IQuery -summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. -remarks: Additional properties can be added to the object to pass data between extensions. -isPreview: true -isDeprecated: false -type: interface -properties: - - name: originalQueryText - uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' - package: '@microsoft/sp-search-extensibility!' - fullName: originalQueryText - summary: Query text that the user provided. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'originalQueryText: string;' - return: - type: string - - name: queryText - uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' - package: '@microsoft/sp-search-extensibility!' - fullName: queryText - summary: Text of the query. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'queryText: string;' - return: - type: string +### YamlMime:TSType +name: IQuery +uid: '@microsoft/sp-search-extensibility!IQuery:interface' +package: '@microsoft/sp-search-extensibility!' +fullName: IQuery +summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. +remarks: Additional properties can be added to the object to pass data between extensions. +isPreview: true +isDeprecated: false +type: interface +properties: + - name: originalQueryText + uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' + package: '@microsoft/sp-search-extensibility!' + fullName: originalQueryText + summary: Query text that the user provided. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'originalQueryText: string;' + return: + type: string + - name: queryText + uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' + package: '@microsoft/sp-search-extensibility!' + fullName: queryText + summary: Text of the query. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'queryText: string;' + return: + type: string diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index f46dfd15..8fbe58b8 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: SearchQueryModifierContext -uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' -package: '@microsoft/sp-search-extensibility!' -fullName: SearchQueryModifierContext -summary: Context for the search query modifier extensions. -remarks: '' -isPreview: true -isDeprecated: false -type: class -extends: '' +### YamlMime:TSType +name: SearchQueryModifierContext +uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' +package: '@microsoft/sp-search-extensibility!' +fullName: SearchQueryModifierContext +summary: Context for the search query modifier extensions. +remarks: '' +isPreview: true +isDeprecated: false +type: class +extends: '' diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index b93661eb..7c12b98e 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -1,20 +1,20 @@ -### YamlMime:TSEnum -name: SearchQueryScenario -uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' -package: '@microsoft/sp-search-extensibility!' -fullName: SearchQueryScenario -summary: Scenario for the search query modifier. -remarks: '' -isPreview: true -isDeprecated: false -fields: - - name: SearchResults - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' - package: '@microsoft/sp-search-extensibility!' - summary: Search results scenario. - value: '1' - - name: SearchSuggestions - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' - package: '@microsoft/sp-search-extensibility!' - summary: Search suggestions scenario. - value: '2' +### YamlMime:TSEnum +name: SearchQueryScenario +uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' +package: '@microsoft/sp-search-extensibility!' +fullName: SearchQueryScenario +summary: Scenario for the search query modifier. +remarks: '' +isPreview: true +isDeprecated: false +fields: + - name: SearchResults + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' + package: '@microsoft/sp-search-extensibility!' + summary: Search results scenario. + value: '1' + - name: SearchSuggestions + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' + package: '@microsoft/sp-search-extensibility!' + summary: Search suggestions scenario. + value: '2' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 4cced970..cacbc988 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -1,414 +1,413 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-webpart-base!' -name: '@microsoft/sp-webpart-base' -type: package -summary: SharePoint Framework support for building web parts. -classes: - - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - - '@microsoft/sp-webpart-base!BaseWebPart:class' - - '@microsoft/sp-webpart-base!BaseWebPartContext:class' - - '@microsoft/sp-webpart-base!WebPartContext:class' -enums: - - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' -interfaces: - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - - '@microsoft/sp-webpart-base!IOffice:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - - '@microsoft/sp-webpart-base!ISDKs:interface' - - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - - '@microsoft/sp-webpart-base!IWebPartContext:interface' - - '@microsoft/sp-webpart-base!IWebPartData:interface' - - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' -functions: - - name: 'PropertyPaneButton(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Button on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the Button is associated to. - type: string - - id: properties - description: Strongly typed Button properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneCheckbox(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Checkbox on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the checkbox is associated to. - type: string - - id: properties - description: Strongly typed Checkbox properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Choice Group on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: - IPropertyPaneChoiceGroupProps): IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the choice group is associated to. - type: string - - id: properties - description: Strongly typed Choice Group properties. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneCustomField(properties) - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a custom field on the PropertyPane. - remarks: >- - The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The - PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but - there are exceptional cases when web parts have special needs and need a special control. The custom field helps - fill that gap. - isPreview: true - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): - IPropertyPaneField; - parameters: - - id: properties - description: Strongly typed Custom field properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDropdown(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Dropdown on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the dropdown is associated to. - type: string - - id: properties - description: Strongly typed Dropdown properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicField(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneDynamicField(targetProperty: string, properties: - IPropertyPaneDynamicFieldProps): IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the Dynamic Data widget is associated to. - type: string - - id: properties - description: '' - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneDynamicFieldSet(properties) - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: >- - Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data - source. - - - These fields can possibly share the same property based on the associated filters. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): - IPropertyPaneField; - parameters: - - id: properties - description: >- - Contains entries and options, described as below: entries - A set of entries to be configured by the widget. - Each entry includes the target property and, optionally, the label to show. options - Options enabling - customized values for callback, filters etc., for the given set of dynamic fields. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Dynamic TextField on the PropertyPane. - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: >- - This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please - consume it from there. - syntax: - content: >- - export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: - IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the dynamic textfield is associated to. - type: string - - id: properties - description: Properties of the PropertyPaneDynamicTextField. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneHorizontalRule() - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Horizontal Rule on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' - return: - type: '<void>' - description: '' - - name: 'PropertyPaneLabel(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Label on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the label is associated to. - type: string - - id: properties - description: Strongly typed Label properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneLink(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Link on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the Link is associated to. - type: string - - id: properties - description: Strongly typed Link properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneSlider(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Slider on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the slider is associated to. - type: string - - id: properties - description: Strongly typed Slider properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneTextField(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a TextField on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the textfield is associated to. - type: string - - id: properties - description: Strongly typed TextField properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneToggle(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' - package: '@microsoft/sp-webpart-base!' - summary: Helper method to create a Toggle on the PropertyPane. - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. - syntax: - content: >- - export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): - IPropertyPaneField; - parameters: - - id: targetProperty - description: Target property the toggle is associated to. - type: string - - id: properties - description: Strongly typed Toggle properties. - type: '' - return: - type: >- - <> - description: '' +### YamlMime:TSPackage +uid: '@microsoft/sp-webpart-base!' +name: '@microsoft/sp-webpart-base' +type: package +summary: SharePoint Framework support for building web parts. +classes: + - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPartContext:class' + - '@microsoft/sp-webpart-base!WebPartContext:class' +enums: + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' +interfaces: + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-webpart-base!ISDKs:interface' + - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartContext:interface' + - '@microsoft/sp-webpart-base!IWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' +functions: + - name: 'PropertyPaneButton(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Button on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Button is associated to. + type: string + - id: properties + description: Strongly typed Button properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneCheckbox(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Checkbox on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the checkbox is associated to. + type: string + - id: properties + description: Strongly typed Checkbox properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Choice Group on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the choice group is associated to. + type: string + - id: properties + description: Strongly typed Choice Group properties. + type: '' + return: + type: >- + <> + description: '' + - name: PropertyPaneCustomField(properties) + uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a custom field on the PropertyPane. + remarks: >- + The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The + PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but + there are exceptional cases when web parts have special needs and need a special control. The custom field helps + fill that gap. + isPreview: true + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): + IPropertyPaneField; + parameters: + - id: properties + description: Strongly typed Custom field properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneDropdown(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Dropdown on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the dropdown is associated to. + type: string + - id: properties + description: Strongly typed Dropdown properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneDynamicField(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneDynamicField(targetProperty: string, properties: + IPropertyPaneDynamicFieldProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Dynamic Data widget is associated to. + type: string + - id: properties + description: '' + type: '' + return: + type: >- + <> + description: '' + - name: PropertyPaneDynamicFieldSet(properties) + uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: >- + Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data + source. + + + These fields can possibly share the same property based on the associated filters. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): + IPropertyPaneField; + parameters: + - id: properties + description: >- + Contains entries and options, described as below: entries - A set of entries to be configured by the widget. + Each entry includes the target property and, optionally, the label to show. options - Options enabling + customized values for callback, filters etc., for the given set of dynamic fields. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Dynamic TextField on the PropertyPane. + remarks: '' + isPreview: true + isDeprecated: true + customDeprecatedMessage: >- + This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please + consume it from there. + syntax: + content: >- + export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: + IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the dynamic textfield is associated to. + type: string + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + type: '' + return: + type: >- + <> + description: '' + - name: PropertyPaneHorizontalRule() + uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Horizontal Rule on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' + return: + type: '<void>' + description: '' + - name: 'PropertyPaneLabel(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Label on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the label is associated to. + type: string + - id: properties + description: Strongly typed Label properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneLink(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Link on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the Link is associated to. + type: string + - id: properties + description: Strongly typed Link properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneSlider(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Slider on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the slider is associated to. + type: string + - id: properties + description: Strongly typed Slider properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneTextField(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a TextField on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the textfield is associated to. + type: string + - id: properties + description: Strongly typed TextField properties. + type: '' + return: + type: >- + <> + description: '' + - name: 'PropertyPaneToggle(targetProperty, properties)' + uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' + package: '@microsoft/sp-webpart-base!' + summary: Helper method to create a Toggle on the PropertyPane. + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + syntax: + content: >- + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the toggle is associated to. + type: string + - id: properties + description: Strongly typed Toggle properties. + type: '' + return: + type: >- + <> + description: '' diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 535a8a6f..2923f4a5 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -1,284 +1,305 @@ -### YamlMime:TSType -name: BaseClientSideWebPart -uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' -package: '@microsoft/sp-webpart-base!' -fullName: BaseClientSideWebPart -summary: >- - This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs - to inherit from this class. -remarks: >- - Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in - two catagories. - - - The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API - should be used to access contextual data relevant to this web part instance. - - - The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an - updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. - All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please - refer to the documentation of the individual APIs to make the right decision. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' - package: '@microsoft/sp-webpart-base!' - fullName: (constructor)() - summary: Constructor for the BaseClientSideWebPart class. - remarks: >- - It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. - Most of the web part features like this.context and `this.properties` are not available to be used before the the - `onInit()` part of the web part loading lifecycle. - isPreview: false - isDeprecated: false - syntax: - content: constructor(); -properties: - - name: canOpenPopupOnRender - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' - package: '@microsoft/sp-webpart-base!' - fullName: canOpenPopupOnRender - summary: This property indicates whether a web part can open a popup on initial render. - remarks: >- - In some environments the host re-renders the web parts frequently, and therefore opening popups during render will - cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages - perform postbacks causing the page to re-render on all button clicks. - - - If a web part needs to open a popup on render, it should use this API before opening the popup. If this API - returns false, the web part should not open popup on initial render. Some web parts that open popups during render - are the document embed web part that pops up the file picker on initial render, embedded video web part that pops - up the PropertyPane on initial render. - isPreview: false - isDeprecated: false - syntax: - content: 'protected get canOpenPopupOnRender(): boolean;' - return: - type: boolean - - name: context - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' - package: '@microsoft/sp-webpart-base!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly context: WebPartContext;' - return: - type: '' - - name: domElement - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' - package: '@microsoft/sp-webpart-base!' - fullName: domElement - summary: >- - This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole - DOM subtree of the web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get domElement(): HTMLElement;' - return: - type: HTMLElement - - name: isRenderAsync - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' - package: '@microsoft/sp-webpart-base!' - fullName: isRenderAsync - summary: Indicates whether the web part is rendering in Async mode. - remarks: >- - If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part - rendering is complete. - - - The default value is false. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected get isRenderAsync(): boolean; - return: - type: boolean - - name: renderedFromPersistedData - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' - package: '@microsoft/sp-webpart-base!' - fullName: renderedFromPersistedData - summary: >- - This property indicates whether the web part was rendered from the persisted data (serialized state from the last - time that the web part was saved) or not. - remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get renderedFromPersistedData(): boolean;' - return: - type: boolean - - name: renderedOnce - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' - package: '@microsoft/sp-webpart-base!' - fullName: renderedOnce - summary: >- - This property indicates whether the web part has been rendered once or not. After the first time rendering, the - value of this property is always true until a full re-render of the web part happens. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get renderedOnce(): boolean;' - return: - type: boolean - - name: width - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#width:member' - package: '@microsoft/sp-webpart-base!' - fullName: width - summary: This propery returns the width of the container for the web part. - remarks: >- - Web parts should utilize this property to perform operations such as any conditional styling of components based - on the initial available width for the web part. - isPreview: false - isDeprecated: false - syntax: - content: 'protected get width(): number;' - return: - type: number -methods: - - name: clearError() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: clearError() - summary: This API should be used to clear the error message from the web part display area. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected clearError(): void;' - return: - type: void - description: '' - - name: onAfterResize(newWidth) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onAfterResize(newWidth) - summary: >- - This API is invoked when the web part container dom element width is changed, e.g. when the browser browser window - is resized and when the property pane is toggled open/closed. - remarks: >- - Web parts should utilize this method to perform operations such as potentially re-rendering components based on - the new available width for the web part. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onAfterResize(newWidth: number): void; - parameters: - - id: newWidth - description: Width (in pixels) of the container for the web part after the resize event. - type: number - return: - type: void - description: '' - - name: onDisplayModeChanged(oldDisplayMode) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDisplayModeChanged(oldDisplayMode) - summary: This event method is called when the display mode of a web part is changed. - remarks: >- - The default implementation of this API calls the web part render method to re-render the web part with the new - display mode. If a web part developer does not want a full re-render to happen on display mode change, they can - override this API and perform specific updates to the web part DOM to switch its display mode. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; - parameters: - - id: oldDisplayMode - description: The old display mode. - type: '' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDispose() - summary: This API should be used to refresh the contents of the PropertyPane. - remarks: >- - This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local - resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios - like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being - transitioned out. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected onDispose(): void; - return: - type: void - description: '' - - name: render() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: render() - summary: >- - This API is called to render the web part. There is no base implementation of this API and the web part is - required to override this API. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected abstract render(): void;' - return: - type: void - description: '' - - name: renderCompleted(error) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: renderCompleted(error) - summary: >- - This API should be called by web parts that perform Async rendering. Those web part are required to override the - isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part - initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe - loading completes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected renderCompleted(error?: Error): void;' - parameters: - - id: error - description: '' - type: Error - return: - type: void - description: '' - - name: renderError(error) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: renderError(error) - summary: >- - This API should be used to render an error message in the web part display area. Also logs the error message using - the trace logger. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected renderError(error: Error): void;' - parameters: - - id: error - description: An error object containing the error message to render. - type: Error - return: - type: void - description: '' -extends: '<TProperties> ' +### YamlMime:TSType +name: BaseClientSideWebPart +uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' +package: '@microsoft/sp-webpart-base!' +fullName: BaseClientSideWebPart +summary: >- + This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs + to inherit from this class. +remarks: >- + Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in + two catagories. + + + The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API + should be used to access contextual data relevant to this web part instance. + + + The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an + updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. + All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please + refer to the documentation of the individual APIs to make the right decision. +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' + package: '@microsoft/sp-webpart-base!' + fullName: (constructor)() + summary: Constructor for the BaseClientSideWebPart class. + remarks: >- + It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. + Most of the web part features like this.context and `this.properties` are not available to be used before the the + `onInit()` part of the web part loading lifecycle. + isPreview: false + isDeprecated: false + syntax: + content: constructor(); +properties: + - name: canOpenPopupOnRender + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' + package: '@microsoft/sp-webpart-base!' + fullName: canOpenPopupOnRender + summary: This property indicates whether a web part can open a popup on initial render. + remarks: >- + In some environments the host re-renders the web parts frequently, and therefore opening popups during render will + cause popups to open repeatedly, which is a poor user experience. As an example, the classic SharePoint pages + perform postbacks causing the page to re-render on all button clicks. + + + If a web part needs to open a popup on render, it should use this API before opening the popup. If this API + returns false, the web part should not open popup on initial render. Some web parts that open popups during render + are the document embed web part that pops up the file picker on initial render, embedded video web part that pops + up the PropertyPane on initial render. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get canOpenPopupOnRender(): boolean;' + return: + type: boolean + - name: context + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' + package: '@microsoft/sp-webpart-base!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly context: WebPartContext;' + return: + type: '' + - name: domElement + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' + package: '@microsoft/sp-webpart-base!' + fullName: domElement + summary: >- + This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole + DOM subtree of the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get domElement(): HTMLElement;' + return: + type: HTMLElement + - name: isRenderAsync + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' + package: '@microsoft/sp-webpart-base!' + fullName: isRenderAsync + summary: Indicates whether the web part is rendering in Async mode. + remarks: >- + If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part + rendering is complete. + + + The default value is false. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected get isRenderAsync(): boolean; + return: + type: boolean + - name: renderedFromPersistedData + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' + package: '@microsoft/sp-webpart-base!' + fullName: renderedFromPersistedData + summary: >- + This property indicates whether the web part was rendered from the persisted data (serialized state from the last + time that the web part was saved) or not. + remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get renderedFromPersistedData(): boolean;' + return: + type: boolean + - name: renderedOnce + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' + package: '@microsoft/sp-webpart-base!' + fullName: renderedOnce + summary: >- + This property indicates whether the web part has been rendered once or not. After the first time rendering, the + value of this property is always true until a full re-render of the web part happens. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get renderedOnce(): boolean;' + return: + type: boolean + - name: width + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#width:member' + package: '@microsoft/sp-webpart-base!' + fullName: width + summary: This propery returns the width of the container for the web part. + remarks: >- + Web parts should utilize this property to perform operations such as any conditional styling of components based + on the initial available width for the web part. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get width(): number;' + return: + type: number +methods: + - name: clearError() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: clearError() + summary: This API should be used to clear the error message from the web part display area. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected clearError(): void;' + return: + type: void + description: '' + - name: onAfterResize(newWidth) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onAfterResize(newWidth) + summary: >- + This API is invoked when the web part container dom element width is changed, e.g. when the browser browser window + is resized and when the property pane is toggled open/closed. + remarks: >- + Web parts should utilize this method to perform operations such as potentially re-rendering components based on + the new available width for the web part. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onAfterResize(newWidth: number): void; + parameters: + - id: newWidth + description: Width (in pixels) of the container for the web part after the resize event. + type: number + return: + type: void + description: '' + - name: onDisplayModeChanged(oldDisplayMode) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onDisplayModeChanged(oldDisplayMode) + summary: This event method is called when the display mode of a web part is changed. + remarks: >- + The default implementation of this API calls the web part render method to re-render the web part with the new + display mode. If a web part developer does not want a full re-render to happen on display mode change, they can + override this API and perform specific updates to the web part DOM to switch its display mode. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; + parameters: + - id: oldDisplayMode + description: The old display mode. + type: '' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onDispose() + summary: This API should be used to refresh the contents of the PropertyPane. + remarks: >- + This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local + resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being + transitioned out. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onDispose(): void; + return: + type: void + description: '' + - name: onThemeChanged(theme) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onThemeChanged:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onThemeChanged(theme) + summary: This API is called when a theme is initialized or changed on the page or for the current section. + remarks: >- + Developers sould not call render in overridden method. It can lead to unpredicted re-flow of the web part. render + will be called from the base class when needed. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected onThemeChanged(theme: IReadonlyTheme | undefined): void; + parameters: + - id: theme + description: New theme for the page or section + type: ' | undefined' + return: + type: void + description: '' + - name: render() + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: render() + summary: >- + This API is called to render the web part. There is no base implementation of this API and the web part is + required to override this API. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected abstract render(): void;' + return: + type: void + description: '' + - name: renderCompleted(error) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: renderCompleted(error) + summary: >- + This API should be called by web parts that perform Async rendering. Those web part are required to override the + isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part + initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe + loading completes. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected renderCompleted(error?: Error): void;' + parameters: + - id: error + description: '' + type: Error + return: + type: void + description: '' + - name: renderError(error) + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: renderError(error) + summary: >- + This API should be used to render an error message in the web part display area. Also logs the error message using + the trace logger. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected renderError(error: Error): void;' + parameters: + - id: error + description: An error object containing the error message to render. + type: Error + return: + type: void + description: '' +extends: '<TProperties> ' diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 16a2e96c..d868a252 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -1,425 +1,425 @@ -### YamlMime:TSType -name: BaseWebPart -uid: '@microsoft/sp-webpart-base!BaseWebPart:class' -package: '@microsoft/sp-webpart-base!' -fullName: BaseWebPart -summary: >- - This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow - a common core between 2D and MR WebParts. -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)() - uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' - package: '@microsoft/sp-webpart-base!' - fullName: (constructor)() - summary: Constructor for the `BaseWebPart` class. - remarks: >- - It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. - Most of the web part features like this.context and this.properties are not available to be used before the the - onInit part of the web part loading lifecycle. - isPreview: false - isDeprecated: false - syntax: - content: constructor(); -properties: - - name: accessibleTitle - uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' - package: '@microsoft/sp-webpart-base!' - fullName: accessibleTitle - summary: >- - This property points to the accessible title of web part made available to screen readers. The base implementation - returns that default title in the manifest. Web parts that want to provide more descriptive title containing - contextual information need to override this API. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get accessibleTitle(): string;' - return: - type: string - - name: context - uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' - package: '@microsoft/sp-webpart-base!' - fullName: context - summary: Use the context object to access common services and state associated with the component. - remarks: >- - Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a - read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside - the constructor), but child classes should redeclare it as readonly. - isPreview: false - isDeprecated: false - syntax: - content: 'readonly context: BaseWebPartContext;' - return: - type: '' - - name: dataVersion - uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' - package: '@microsoft/sp-webpart-base!' - fullName: dataVersion - summary: >- - The value of this property is stored in the serialized data of the web part to allow developers to manage - versioning of their web part. The default version is 1.0 - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get dataVersion(): Version;' - return: - type: '' - - name: description - uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' - package: '@microsoft/sp-webpart-base!' - fullName: description - summary: Description of the WebPart - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get description(): string;' - return: - type: string - - name: disableReactivePropertyChanges - uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' - package: '@microsoft/sp-webpart-base!' - fullName: disableReactivePropertyChanges - summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. virtual - remarks: >- - The default behavior is Reactive. - - - Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can - see instant updates. This helps the page creator get instant feedback and decide if they should keep the new - configuration changes or not. - - - NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane - button is clicked. - isPreview: false - isDeprecated: false - syntax: - content: 'protected get disableReactivePropertyChanges(): boolean;' - return: - type: boolean - - name: displayMode - uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' - package: '@microsoft/sp-webpart-base!' - fullName: displayMode - summary: This property is the current display mode of the web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get displayMode(): DisplayMode;' - return: - type: '' - - name: previewImageUrl - uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' - package: '@microsoft/sp-webpart-base!' - fullName: previewImageUrl - summary: >- - This property points to the preview image for the web part. The base implementation returns undefined. Web parts - that want to provide a valid preview image url need to override this API. The preview image url can be used to - create a preview of the web part or of the page on which the web part is present. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get previewImageUrl(): string | undefined;' - return: - type: string | undefined - - name: properties - uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' - package: '@microsoft/sp-webpart-base!' - fullName: properties - summary: This property is the pointer to the custom property bag of the web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get properties(): TProperties;' - return: - type: TProperties - - name: propertiesMetadata - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' - package: '@microsoft/sp-webpart-base!' - fullName: propertiesMetadata - summary: >- - This property defines metadata for the web part property bag. The metadata can help SharePoint understand the - content of the properties better and perform relevant services on the data. virtual - remarks: >- - See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more - information about how to define metadata - isPreview: false - isDeprecated: false - syntax: - content: 'protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;' - return: - type: ' | undefined' - - name: title - uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' - package: '@microsoft/sp-webpart-base!' - fullName: title - summary: Title of the WebPart - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected get title(): string;' - return: - type: string -methods: - - name: getPropertyPaneConfiguration() - uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: getPropertyPaneConfiguration() - summary: >- - This API is used to ger the configuration to build the property pane for the web part. If the web part wants to - use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the - configuration for the PropertyPane. - - - This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. - - - See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' - return: - type: '' - description: '' - - name: loadPropertyPaneResources() - uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: loadPropertyPaneResources() - summary: This API enables asynchronous loading of property pane related resources of the web part. - remarks: >- - If not overridden by the web part, base web part resolves the promise immediately. - - - This method is called before any property pane APIs are called. Other property pane APIs cannot be called until - this promise is resolved. No other property pane related events are raised except - 'PropertyPaneConfigurationComplete'. - - - 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including - 'loadPropertyPaneResources' promise. - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected loadPropertyPaneResources(): Promise; - return: - type: Promise<void> - description: '' - - name: 'onAfterDeserialize(deserializedObject, dataVersion)' - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' - summary: >- - This API is called after the web part is deserialized to an object, right before the property bag is populated. - virtual - remarks: >- - The default implementation is a no-op. A web part developer can override this API if the deserialized object does - not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate - the property bag right after the data is deserialized to an object. - - - An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized - by an older version of the web part that supported a different schema of the property bag, resulting the - deserialized object to be incosistent with the current schema of the property bag. The developer can use - `onAfterDeserialize` to check the dataVersion and fix the property bag. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' - parameters: - - id: deserializedObject - description: >- - The object deserialized from the stored data. Note that the schema of this object is not necessarily - consistent with the current property bag, because the serialization could have been done by an older version - of the web part - type: any - - id: dataVersion - description: >- - The data version of the stored data being deserialized. You can use this value to determine if the data was - serialized by an older web part. Web parts can define their data version by overriding the dataVersion - property. - type: '' - return: - type: TProperties - description: The property bag of the web part - - name: onAfterPropertyPaneChangesApplied() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onAfterPropertyPaneChangesApplied() - summary: >- - This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in - Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected onAfterPropertyPaneChangesApplied(): void;' - return: - type: void - description: '' - - name: onBeforeSerialize() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onBeforeSerialize() - summary: This event method is called before the web part is serialized. virtual - remarks: >- - The default implementation is a no-op. The serialization process serializes the web part property bag i.e. - this.properties. This API gives the web part a chance to update it's property bag before the serialization - happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist - some of that state, it needs to override this API and update the web part property bag to the latest state. If a - web part updates the property bag with invalid property values, those will get persisted. So that should be - avoided. The web part property bag should always contain valid property values. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onBeforeSerialize(): void;' - return: - type: void - description: '' - - name: onDisplayModeChanged(oldDisplayMode) - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDisplayModeChanged(oldDisplayMode) - summary: This event method is called when the display mode of a web part is changed. virtual - remarks: >- - If the web part is initialized or re-initialized in a different display mode then this lifecycle method is not - called. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' - parameters: - - id: oldDisplayMode - description: The old display mode. - type: '' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDispose() - summary: This API should be used to refresh the contents of the PropertyPane. virtual - remarks: >- - This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local - resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios - like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being - transitioned out. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onDispose(): void;' - return: - type: void - description: '' - - name: onInit() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onInit() - summary: This event method is called when the web part is initialized. virtual - remarks: >- - This API should be overridden to perform long running operations e.g. data fetching from a remote service before - the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This - API is called only once during the lifecycle of a web part. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onInit(): Promise;' - return: - type: Promise<void> - description: '' - - name: onPropertyPaneConfigurationComplete() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onPropertyPaneConfigurationComplete() - summary: This API is invoked when the configuration is completed on the PropertyPane. virtual - remarks: |- - This event method is invoked in the following cases: - - - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. - - - When user clicks the "X" (close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - - - When the user switches web parts then the current web part gets this event. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onPropertyPaneConfigurationComplete(): void;' - return: - type: void - description: '' - - name: onPropertyPaneConfigurationStart() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onPropertyPaneConfigurationStart() - summary: This event method is invoked when the configuration starts on the PropertyPane. virtual - remarks: |- - This event method is invoked in the following cases: - - - When the PropertyPane is opened. - - - When the user switches web parts then the new web part gets this event. - isPreview: false - isDeprecated: false - syntax: - content: 'protected onPropertyPaneConfigurationStart(): void;' - return: - type: void - description: '' - - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - summary: >- - This API is invoked after updating the new value of the property in the property bag when the PropertyPane is - being used in Reactive mode. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' - parameters: - - id: propertyPath - description: >- - JSON path of the property in the property bag. In the case of custom field, if no target property is - provided then a custom value is assigned, which will be in the form of `__CustomField_`. - type: string - - id: oldValue - description: Old value of the property. This value could be undefined/empty in the case of custom field. - type: any - - id: newValue - description: New value of the property. This value could be undefined/empty in the case of custom field. - type: any - return: - type: void - description: '' - - name: onPropertyPaneRendered() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onPropertyPaneRendered() - summary: This API is invoked when the PropertyPane is rendered. virtual - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'protected onPropertyPaneRendered(): void;' - return: - type: void - description: '' -extends: '' +### YamlMime:TSType +name: BaseWebPart +uid: '@microsoft/sp-webpart-base!BaseWebPart:class' +package: '@microsoft/sp-webpart-base!' +fullName: BaseWebPart +summary: >- + This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow + a common core between 2D and MR WebParts. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)() + uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' + package: '@microsoft/sp-webpart-base!' + fullName: (constructor)() + summary: Constructor for the `BaseWebPart` class. + remarks: >- + It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. + Most of the web part features like this.context and this.properties are not available to be used before the the + onInit part of the web part loading lifecycle. + isPreview: false + isDeprecated: false + syntax: + content: constructor(); +properties: + - name: accessibleTitle + uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' + package: '@microsoft/sp-webpart-base!' + fullName: accessibleTitle + summary: >- + This property points to the accessible title of web part made available to screen readers. The base implementation + returns that default title in the manifest. Web parts that want to provide more descriptive title containing + contextual information need to override this API. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get accessibleTitle(): string;' + return: + type: string + - name: context + uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' + package: '@microsoft/sp-webpart-base!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + isPreview: false + isDeprecated: false + syntax: + content: 'readonly context: BaseWebPartContext;' + return: + type: '' + - name: dataVersion + uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' + package: '@microsoft/sp-webpart-base!' + fullName: dataVersion + summary: >- + The value of this property is stored in the serialized data of the web part to allow developers to manage + versioning of their web part. The default version is 1.0 + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get dataVersion(): Version;' + return: + type: '' + - name: description + uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' + package: '@microsoft/sp-webpart-base!' + fullName: description + summary: Description of the WebPart + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get description(): string;' + return: + type: string + - name: disableReactivePropertyChanges + uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' + package: '@microsoft/sp-webpart-base!' + fullName: disableReactivePropertyChanges + summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. virtual + remarks: >- + The default behavior is Reactive. + + + Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can + see instant updates. This helps the page creator get instant feedback and decide if they should keep the new + configuration changes or not. + + + NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane + button is clicked. + isPreview: false + isDeprecated: false + syntax: + content: 'protected get disableReactivePropertyChanges(): boolean;' + return: + type: boolean + - name: displayMode + uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' + package: '@microsoft/sp-webpart-base!' + fullName: displayMode + summary: This property is the current display mode of the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get displayMode(): DisplayMode;' + return: + type: '' + - name: previewImageUrl + uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' + package: '@microsoft/sp-webpart-base!' + fullName: previewImageUrl + summary: >- + This property points to the preview image for the web part. The base implementation returns undefined. Web parts + that want to provide a valid preview image url need to override this API. The preview image url can be used to + create a preview of the web part or of the page on which the web part is present. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get previewImageUrl(): string | undefined;' + return: + type: string | undefined + - name: properties + uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' + package: '@microsoft/sp-webpart-base!' + fullName: properties + summary: This property is the pointer to the custom property bag of the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get properties(): TProperties;' + return: + type: TProperties + - name: propertiesMetadata + uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' + package: '@microsoft/sp-webpart-base!' + fullName: propertiesMetadata + summary: >- + This property defines metadata for the web part property bag. The metadata can help SharePoint understand the + content of the properties better and perform relevant services on the data. virtual + remarks: >- + See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more + information about how to define metadata + isPreview: false + isDeprecated: false + syntax: + content: 'protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;' + return: + type: ' | undefined' + - name: title + uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' + package: '@microsoft/sp-webpart-base!' + fullName: title + summary: Title of the WebPart + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected get title(): string;' + return: + type: string +methods: + - name: getPropertyPaneConfiguration() + uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: getPropertyPaneConfiguration() + summary: >- + This API is used to ger the configuration to build the property pane for the web part. If the web part wants to + use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the + configuration for the PropertyPane. + + + This API is not invoked until the 'loadPropertyPaneResources' promise is resolved. + + + See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' + return: + type: '' + description: '' + - name: loadPropertyPaneResources() + uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: loadPropertyPaneResources() + summary: This API enables asynchronous loading of property pane related resources of the web part. + remarks: >- + If not overridden by the web part, base web part resolves the promise immediately. + + + This method is called before any property pane APIs are called. Other property pane APIs cannot be called until + this promise is resolved. No other property pane related events are raised except + 'PropertyPaneConfigurationComplete'. + + + 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including + 'loadPropertyPaneResources' promise. + isPreview: false + isDeprecated: false + syntax: + content: |- + /** @virtual */ + protected loadPropertyPaneResources(): Promise; + return: + type: Promise<void> + description: '' + - name: 'onAfterDeserialize(deserializedObject, dataVersion)' + uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' + summary: >- + This API is called after the web part is deserialized to an object, right before the property bag is populated. + virtual + remarks: >- + The default implementation is a no-op. A web part developer can override this API if the deserialized object does + not fully reflect the initial state of the property bag. This gives the web part developer a chance to populate + the property bag right after the data is deserialized to an object. + + + An important scenario to use deserialize is upgrading. An upgraded web part may load the data that was serialized + by an older version of the web part that supported a different schema of the property bag, resulting the + deserialized object to be incosistent with the current schema of the property bag. The developer can use + `onAfterDeserialize` to check the dataVersion and fix the property bag. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' + parameters: + - id: deserializedObject + description: >- + The object deserialized from the stored data. Note that the schema of this object is not necessarily + consistent with the current property bag, because the serialization could have been done by an older version + of the web part + type: any + - id: dataVersion + description: >- + The data version of the stored data being deserialized. You can use this value to determine if the data was + serialized by an older web part. Web parts can define their data version by overriding the dataVersion + property. + type: '' + return: + type: TProperties + description: The property bag of the web part + - name: onAfterPropertyPaneChangesApplied() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onAfterPropertyPaneChangesApplied() + summary: >- + This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in + Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onAfterPropertyPaneChangesApplied(): void;' + return: + type: void + description: '' + - name: onBeforeSerialize() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onBeforeSerialize() + summary: This event method is called before the web part is serialized. virtual + remarks: >- + The default implementation is a no-op. The serialization process serializes the web part property bag i.e. + this.properties. This API gives the web part a chance to update it's property bag before the serialization + happens. Some web part's may keep their state other objects or even in the DOM. If a web part needs to persist + some of that state, it needs to override this API and update the web part property bag to the latest state. If a + web part updates the property bag with invalid property values, those will get persisted. So that should be + avoided. The web part property bag should always contain valid property values. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onBeforeSerialize(): void;' + return: + type: void + description: '' + - name: onDisplayModeChanged(oldDisplayMode) + uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onDisplayModeChanged(oldDisplayMode) + summary: This event method is called when the display mode of a web part is changed. virtual + remarks: >- + If the web part is initialized or re-initialized in a different display mode then this lifecycle method is not + called. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' + parameters: + - id: oldDisplayMode + description: The old display mode. + type: '' + return: + type: void + description: '' + - name: onDispose() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onDispose() + summary: This API should be used to refresh the contents of the PropertyPane. virtual + remarks: >- + This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local + resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios + like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being + transitioned out. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onDispose(): void;' + return: + type: void + description: '' + - name: onInit() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onInit() + summary: This event method is called when the web part is initialized. virtual + remarks: >- + This API should be overridden to perform long running operations e.g. data fetching from a remote service before + the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This + API is called only once during the lifecycle of a web part. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onInit(): Promise;' + return: + type: Promise<void> + description: '' + - name: onPropertyPaneConfigurationComplete() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onPropertyPaneConfigurationComplete() + summary: This API is invoked when the configuration is completed on the PropertyPane. virtual + remarks: |- + This event method is invoked in the following cases: + + - When the CONFIGURATION\_COMPLETE\_TIMEOUT((currently the value is 5 secs) elapses after the last change. + + - When user clicks the "X" (close) button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + + - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. + + - When the user switches web parts then the current web part gets this event. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onPropertyPaneConfigurationComplete(): void;' + return: + type: void + description: '' + - name: onPropertyPaneConfigurationStart() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onPropertyPaneConfigurationStart() + summary: This event method is invoked when the configuration starts on the PropertyPane. virtual + remarks: |- + This event method is invoked in the following cases: + + - When the PropertyPane is opened. + + - When the user switches web parts then the new web part gets this event. + isPreview: false + isDeprecated: false + syntax: + content: 'protected onPropertyPaneConfigurationStart(): void;' + return: + type: void + description: '' + - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + summary: >- + This API is invoked after updating the new value of the property in the property bag when the PropertyPane is + being used in Reactive mode. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' + parameters: + - id: propertyPath + description: >- + JSON path of the property in the property bag. In the case of custom field, if no target property is + provided then a custom value is assigned, which will be in the form of `__CustomField_`. + type: string + - id: oldValue + description: Old value of the property. This value could be undefined/empty in the case of custom field. + type: any + - id: newValue + description: New value of the property. This value could be undefined/empty in the case of custom field. + type: any + return: + type: void + description: '' + - name: onPropertyPaneRendered() + uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: onPropertyPaneRendered() + summary: This API is invoked when the PropertyPane is rendered. virtual + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'protected onPropertyPaneRendered(): void;' + return: + type: void + description: '' +extends: '' diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 2b02b625..00acc2c4 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -1,69 +1,69 @@ -### YamlMime:TSType -name: BaseWebPartContext -uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' -package: '@microsoft/sp-webpart-base!' -fullName: BaseWebPartContext -summary: >- - Web part context object. This object contains the contextual services available to a web part. e.g. a contextual - instance to the http client. - - - This base is to be extended by UI-specific WebPart's base. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseWebPartContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: formFactor - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' - package: '@microsoft/sp-webpart-base!' - fullName: formFactor - summary: Form factor of the web part. - remarks: >- - Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set - up different margins that when rendering in a canvas. - isPreview: true - isDeprecated: false - syntax: - content: 'get formFactor(): WebPartFormFactor;' - return: - type: '' - - name: manifest - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' - package: '@microsoft/sp-webpart-base!' - fullName: manifest - summary: Manifest for the client-side component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly manifest: IClientSideWebPartManifestInstance;' - return: - type: '<any>' - - name: propertyPane - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' - package: '@microsoft/sp-webpart-base!' - fullName: propertyPane - summary: Accessor for common web part property pane operations. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get propertyPane(): IPropertyPaneAccessor;' - return: - type: '' - - name: webPartTag - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' - package: '@microsoft/sp-webpart-base!' - fullName: webPartTag - summary: Web part tag to be used for logging and telemetry. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get webPartTag(): string;' - return: - type: string -extends: '' +### YamlMime:TSType +name: BaseWebPartContext +uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' +package: '@microsoft/sp-webpart-base!' +fullName: BaseWebPartContext +summary: >- + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. + + + This base is to be extended by UI-specific WebPart's base. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseWebPartContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: formFactor + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' + package: '@microsoft/sp-webpart-base!' + fullName: formFactor + summary: Form factor of the web part. + remarks: >- + Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set + up different margins that when rendering in a canvas. + isPreview: true + isDeprecated: false + syntax: + content: 'get formFactor(): WebPartFormFactor;' + return: + type: '' + - name: manifest + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' + package: '@microsoft/sp-webpart-base!' + fullName: manifest + summary: Manifest for the client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IClientSideWebPartManifestInstance;' + return: + type: '<any>' + - name: propertyPane + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' + package: '@microsoft/sp-webpart-base!' + fullName: propertyPane + summary: Accessor for common web part property pane operations. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get propertyPane(): IPropertyPaneAccessor;' + return: + type: '' + - name: webPartTag + uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' + package: '@microsoft/sp-webpart-base!' + fullName: webPartTag + summary: Web part tag to be used for logging and telemetry. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get webPartTag(): string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 114df558..addc7d13 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -1,26 +1,26 @@ -### YamlMime:TSEnum -name: DynamicDataSharedDepth -uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' -package: '@microsoft/sp-webpart-base!' -fullName: DynamicDataSharedDepth -summary: Enum for the possible values of shared depth of the dynamic data reference. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: None - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' - package: '@microsoft/sp-webpart-base!' - summary: Indicates that nothing is shared. - value: '0' - - name: Property - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' - package: '@microsoft/sp-webpart-base!' - summary: Indicates that both the dynamic data source and the property are shared. - value: '2' - - name: Source - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' - package: '@microsoft/sp-webpart-base!' - summary: Indicates that the dynamic data source is shared. - value: '1' +### YamlMime:TSEnum +name: DynamicDataSharedDepth +uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' +package: '@microsoft/sp-webpart-base!' +fullName: DynamicDataSharedDepth +summary: Enum for the possible values of shared depth of the dynamic data reference. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: None + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' + package: '@microsoft/sp-webpart-base!' + summary: Indicates that nothing is shared. + value: '0' + - name: Property + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' + package: '@microsoft/sp-webpart-base!' + summary: Indicates that both the dynamic data source and the property are shared. + value: '2' + - name: Source + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' + package: '@microsoft/sp-webpart-base!' + summary: Indicates that the dynamic data source is shared. + value: '1' diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index f63d9402..18d97afd 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -1,90 +1,90 @@ -### YamlMime:TSType -name: IClientSideWebPartStatusRenderer -uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IClientSideWebPartStatusRenderer -summary: >- - Interface to be implemented by a component that should display the loading indicator and error messages for a web - part. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: clearError(domElement) - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: clearError(domElement) - summary: Clear the webpart error message. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clearError(domElement: HTMLElement): void;' - parameters: - - id: domElement - description: the web part container div. - type: HTMLElement - return: - type: void - description: '' - - name: clearLoadingIndicator(domElement) - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: clearLoadingIndicator(domElement) - summary: Clear the loading indicator. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clearLoadingIndicator(domElement: Element): void;' - parameters: - - id: domElement - description: the web part container div. - type: Element - return: - type: void - description: '' - - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - summary: Display a loading spinner. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;' - parameters: - - id: domElement - description: the web part container div. - type: Element - - id: loadingMessage - description: the message to be displayed when the loading spinner id displayed. - type: string - - id: timeout - description: timeout to render the loading indicator. Default is 1500ms. - type: number - return: - type: void - description: '' - - name: 'renderError(domElement, error)' - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'renderError(domElement, error)' - summary: Render the provided error message in the webpart container div. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'renderError(domElement: HTMLElement, error: Error | string): void;' - parameters: - - id: domElement - description: the web part container div. - type: HTMLElement - - id: error - description: the error message. - type: Error | string - return: - type: void - description: '' +### YamlMime:TSType +name: IClientSideWebPartStatusRenderer +uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IClientSideWebPartStatusRenderer +summary: >- + Interface to be implemented by a component that should display the loading indicator and error messages for a web + part. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: clearError(domElement) + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: clearError(domElement) + summary: Clear the webpart error message. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearError(domElement: HTMLElement): void;' + parameters: + - id: domElement + description: the web part container div. + type: HTMLElement + return: + type: void + description: '' + - name: clearLoadingIndicator(domElement) + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: clearLoadingIndicator(domElement) + summary: Clear the loading indicator. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'clearLoadingIndicator(domElement: Element): void;' + parameters: + - id: domElement + description: the web part container div. + type: Element + return: + type: void + description: '' + - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' + summary: Display a loading spinner. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;' + parameters: + - id: domElement + description: the web part container div. + type: Element + - id: loadingMessage + description: the message to be displayed when the loading spinner id displayed. + type: string + - id: timeout + description: timeout to render the loading indicator. Default is 1500ms. + type: number + return: + type: void + description: '' + - name: 'renderError(domElement, error)' + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: 'renderError(domElement, error)' + summary: Render the provided error message in the webpart container div. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'renderError(domElement: HTMLElement, error: Error | string): void;' + parameters: + - id: domElement + description: the web part container div. + type: HTMLElement + - id: error + description: the error message. + type: Error | string + return: + type: void + description: '' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index 329cb804..161a032c 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyConfiguration -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedPropertyConfiguration -summary: Configuration related to a shared property. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IDynamicDataSharedPropertyConfiguration +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedPropertyConfiguration +summary: Configuration related to a shared property. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index 7038ffc9..af437a0f 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyFilters -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedPropertyFilters -summary: Property pane dynamic data property filters. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IDynamicDataSharedPropertyFilters +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedPropertyFilters +summary: Property pane dynamic data property filters. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 9d120d69..55dffebc 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceConfiguration -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedSourceConfiguration -summary: Configuration related to a shared source. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IDynamicDataSharedSourceConfiguration +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedSourceConfiguration +summary: Configuration related to a shared source. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index 0f5a6c3a..22b09022 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceFilters -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedSourceFilters -summary: Property pane dynamic data source filters. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IDynamicDataSharedSourceFilters +uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IDynamicDataSharedSourceFilters +summary: Property pane dynamic data source filters. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index 5f712358..e3b5f7a0 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -1,37 +1,37 @@ -### YamlMime:TSType -name: IMicrosoftTeams -uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IMicrosoftTeams -summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: context - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' - package: '@microsoft/sp-webpart-base!' - fullName: context - summary: Microsoft Teams' Context. - remarks: >- - For more information, please see: - [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) - isPreview: false - isDeprecated: false - syntax: - content: 'context: microsoftTeams.Context;' - return: - type: microsoftTeams.Context - - name: teamsJs - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' - package: '@microsoft/sp-webpart-base!' - fullName: teamsJs - summary: Microsoft Teams SDK. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'teamsJs: typeof microsoftTeams;' - return: - type: typeof microsoftTeams +### YamlMime:TSType +name: IMicrosoftTeams +uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IMicrosoftTeams +summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: context + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' + package: '@microsoft/sp-webpart-base!' + fullName: context + summary: Microsoft Teams' Context. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) + isPreview: false + isDeprecated: false + syntax: + content: 'context: microsoftTeams.Context;' + return: + type: microsoftTeams.Context + - name: teamsJs + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' + package: '@microsoft/sp-webpart-base!' + fullName: teamsJs + summary: Microsoft Teams SDK. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'teamsJs: typeof microsoftTeams;' + return: + type: typeof microsoftTeams diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 57247297..dce54583 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -1,99 +1,99 @@ -### YamlMime:TSType -name: IPropertyPaneAccessor -uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneAccessor -summary: >- - Web part context property pane accessor interface. Provides some most commonly used operations to access the property - pane. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: close() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: close() - summary: This API should be used to close the PropertyPane to help configure the web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'close(): void;' - return: - type: void - description: '' - - name: isPropertyPaneOpen() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: isPropertyPaneOpen() - summary: Returns true if the PropertyPane is open. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isPropertyPaneOpen(): boolean;' - return: - type: boolean - description: '' - - name: isRenderedByWebPart() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: isRenderedByWebPart() - summary: Indicates whether the PropertyPane was initially opened by the web part. - remarks: >- - For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if - the property pane was opened by the host, then the value will be false. - isPreview: false - isDeprecated: false - syntax: - content: 'isRenderedByWebPart(): boolean;' - return: - type: boolean - description: '' - - name: open() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: open() - summary: This API should be used to open the PropertyPane to help configure the web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'open(): void;' - return: - type: void - description: '' - - name: openDetails(context) - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: openDetails(context) - summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. - remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' - isPreview: false - isDeprecated: false - syntax: - content: 'openDetails(context?: any): void;' - parameters: - - id: context - description: Add additional context for property pane - type: any - return: - type: void - description: '' - - name: refresh() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: refresh() - summary: This API should be used to invoke the PropertyPane to help configure the web part. - remarks: >- - This operation only works when the PropertyPane is already open for the currently active web part. If the - PropertyPane is opened for another web part, calling the refresh API will have no impact. - isPreview: false - isDeprecated: false - syntax: - content: 'refresh(): void;' - return: - type: void - description: '' +### YamlMime:TSType +name: IPropertyPaneAccessor +uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneAccessor +summary: >- + Web part context property pane accessor interface. Provides some most commonly used operations to access the property + pane. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +methods: + - name: close() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: close() + summary: This API should be used to close the PropertyPane to help configure the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'close(): void;' + return: + type: void + description: '' + - name: isPropertyPaneOpen() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: isPropertyPaneOpen() + summary: Returns true if the PropertyPane is open. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'isPropertyPaneOpen(): boolean;' + return: + type: boolean + description: '' + - name: isRenderedByWebPart() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: isRenderedByWebPart() + summary: Indicates whether the PropertyPane was initially opened by the web part. + remarks: >- + For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if + the property pane was opened by the host, then the value will be false. + isPreview: false + isDeprecated: false + syntax: + content: 'isRenderedByWebPart(): boolean;' + return: + type: boolean + description: '' + - name: open() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: open() + summary: This API should be used to open the PropertyPane to help configure the web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'open(): void;' + return: + type: void + description: '' + - name: openDetails(context) + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: openDetails(context) + summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. + remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' + isPreview: false + isDeprecated: false + syntax: + content: 'openDetails(context?: any): void;' + parameters: + - id: context + description: Add additional context for property pane + type: any + return: + type: void + description: '' + - name: refresh() + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' + package: '@microsoft/sp-webpart-base!' + fullName: refresh() + summary: This API should be used to invoke the PropertyPane to help configure the web part. + remarks: >- + This operation only works when the PropertyPane is already open for the currently active web part. If the + PropertyPane is opened for another web part, calling the refresh API will have no impact. + isPreview: false + isDeprecated: false + syntax: + content: 'refresh(): void;' + return: + type: void + description: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 637c61b6..37584cbb 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneButtonProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneButtonProps -summary: PropertyPane button props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneButtonProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneButtonProps +summary: PropertyPane button props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 15f4f1c9..19a9f4c8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneCheckboxProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneCheckboxProps -summary: PropertyPane CheckBox component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneCheckboxProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneCheckboxProps +summary: PropertyPane CheckBox component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 901e0d0d..424f3c0c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOption -uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneChoiceGroupOption -summary: PropertyPane ChoiceGroup option props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOption +uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneChoiceGroupOption +summary: PropertyPane ChoiceGroup option props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 9c46073a..547ee007 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOptionIconProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneChoiceGroupOptionIconProps -summary: PropertyPane ChoiceGroup icon props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneChoiceGroupOptionIconProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneChoiceGroupOptionIconProps +summary: PropertyPane ChoiceGroup icon props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index eb6e2630..8c04c3f6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneChoiceGroupProps -summary: PropertyPane ChoiceGroup props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneChoiceGroupProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneChoiceGroupProps +summary: PropertyPane ChoiceGroup props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index aa87620c..138c23ac 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneConditionalGroup -uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneConditionalGroup -summary: Property pane conditional group. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneConditionalGroup +uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneConditionalGroup +summary: Property pane conditional group. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 50e68764..3aa8169f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneConfiguration -uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneConfiguration -summary: Web part configuration settings -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneConfiguration +uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneConfiguration +summary: Web part configuration settings +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 8a4e6795..940eaed8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneCustomFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneCustomFieldProps -summary: PropertyPane CustomPropertyField props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneCustomFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneCustomFieldProps +summary: PropertyPane CustomPropertyField props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 1698c25b..0c9f33b7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownCalloutProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDropdownCalloutProps -summary: PropertyPane dropdown callout properties. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDropdownCalloutProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDropdownCalloutProps +summary: PropertyPane dropdown callout properties. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 55b55a0c..da82bb26 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownOption -uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDropdownOption -summary: PropertyPane drop down options. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDropdownOption +uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDropdownOption +summary: PropertyPane drop down options. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index e498e9bf..5b80e09a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDropdownProps -summary: PropertyPane drop down component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDropdownProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDropdownProps +summary: PropertyPane drop down component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 801a0d6d..d04615bc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldFilters -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicFieldFilters -summary: Property pane dynamic field filters which is an intersection of both source and property filters. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDynamicFieldFilters +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicFieldFilters +summary: Property pane dynamic field filters which is an intersection of both source and property filters. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 8ef6657a..09041671 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicFieldProps -summary: PropertyPaneDynamicField props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDynamicFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicFieldProps +summary: PropertyPaneDynamicField props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 0f4f5a27..4a2da7de 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldSetProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicFieldSetProps -summary: PropertyPane DynamicFieldSet props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDynamicFieldSetProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicFieldSetProps +summary: PropertyPane DynamicFieldSet props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 604db734..e134e1c4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -1,12 +1,12 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicTextFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicTextFieldProps -summary: '`PropertyPaneDynamicData` component props.' -remarks: '' -isPreview: true -isDeprecated: true -customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneDynamicTextFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneDynamicTextFieldProps +summary: '`PropertyPaneDynamicData` component props.' +remarks: '' +isPreview: true +isDeprecated: true +customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 2d12f503..869b3839 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneField -uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneField -summary: PropertyPane field. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.<TProperties> ' +### YamlMime:TSType +name: IPropertyPaneField +uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneField +summary: PropertyPane field. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.<TProperties> ' diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index 3580a4d7..3ac0858a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneGroup -uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneGroup -summary: PropertyPane group. Group is part of the PropertyPanePage. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneGroup +uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneGroup +summary: PropertyPane group. Group is part of the PropertyPanePage. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index 56fcf599..bc16d438 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneLabelProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneLabelProps -summary: PropertyPaneLabel component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneLabelProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneLabelProps +summary: PropertyPaneLabel component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 3586c564..da0ff22b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneLinkProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneLinkProps -summary: PropertyPaneLink component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneLinkProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneLinkProps +summary: PropertyPaneLink component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index 99075ef0..98b51f0e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPanePage -uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPanePage -summary: PropertyPanePage interface. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPanePage +uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPanePage +summary: PropertyPanePage interface. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index 8744490a..cd3a9e30 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPanePageHeader -uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPanePageHeader -summary: PropertyPane header. This header remains same for all the pages. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPanePageHeader +uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPanePageHeader +summary: PropertyPane header. This header remains same for all the pages. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index b186a02b..b7f6ffae 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneSliderProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneSliderProps -summary: PropertyPaneSliderProps component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneSliderProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneSliderProps +summary: PropertyPaneSliderProps component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index b3e88693..89f89913 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneTextFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneTextFieldProps -summary: PropertyPaneTextField component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneTextFieldProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneTextFieldProps +summary: PropertyPaneTextField component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 59af9720..05c48a56 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -1,14 +1,14 @@ -### YamlMime:TSType -name: IPropertyPaneToggleProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneToggleProps -summary: PropertyPaneToggle component props. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:TSType +name: IPropertyPaneToggleProps +uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IPropertyPaneToggleProps +summary: PropertyPaneToggle component props. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. +type: interface +extends: 'SPPropertyPane.' diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index e46b4775..10fb2080 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -1,43 +1,27 @@ -### YamlMime:TSType -name: ISDKs -uid: '@microsoft/sp-webpart-base!ISDKs:interface' -package: '@microsoft/sp-webpart-base!' -fullName: ISDKs -summary: Conditional set of SDKs provided by SPFx dependent on the environment. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: microsoftTeams - uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' - package: '@microsoft/sp-webpart-base!' - fullName: microsoftTeams - summary: >- - Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is - being hosted in Microsoft Teams. - remarks: >- - For more information, please see: - [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - isPreview: false - isDeprecated: false - syntax: - content: 'microsoftTeams?: IMicrosoftTeams;' - return: - type: '' - - name: office - uid: '@microsoft/sp-webpart-base!ISDKs#office:member' - package: '@microsoft/sp-webpart-base!' - fullName: office - summary: >- - Contextual information about the current Office app. This object will only be defined if a component is being - hosted in an Office app. - remarks: >- - For more information, please see: - [https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office](https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office) - isPreview: true - isDeprecated: false - syntax: - content: 'office?: IOffice;' - return: - type: '' +### YamlMime:TSType +name: ISDKs +uid: '@microsoft/sp-webpart-base!ISDKs:interface' +package: '@microsoft/sp-webpart-base!' +fullName: ISDKs +summary: Conditional set of SDKs provided by SPFx dependent on the environment. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: microsoftTeams + uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' + package: '@microsoft/sp-webpart-base!' + fullName: microsoftTeams + summary: >- + Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is + being hosted in Microsoft Teams. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + isPreview: false + isDeprecated: false + syntax: + content: 'microsoftTeams?: IMicrosoftTeams;' + return: + type: '' diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index 2172e665..f64fde7d 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -1,126 +1,126 @@ -### YamlMime:TSType -name: ISerializedWebPartData -uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' -package: '@microsoft/sp-webpart-base!' -fullName: ISerializedWebPartData -summary: >- - This structure represents the part of the serialized state of a web part which is controlled by the web part. It is - extended by IWebPartData which contains additional data added by the framework to the serialized data. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dataVersion - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' - package: '@microsoft/sp-webpart-base!' - fullName: dataVersion - summary: Web part data version. - remarks: >- - Note that data version is different from the version field in the manifest. The manifest version is used to - control the versioning of the web part code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web part for more information. - - - Supported values: MAJOR.MINOR - - - Example: `"1.0"` - isPreview: false - isDeprecated: false - syntax: - content: 'dataVersion: Version;' - return: - type: '' - - name: dynamicDataPaths - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataPaths - summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. - remarks: |- - The key is the path within the web part properties, and the value is the dynamic data internal id. - - Example: - - ``` - { - 'pageContextUser': - 'PageContext:user', - 'anotherWebPartProperty': - 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: |- - dynamicDataPaths?: { - [path: string]: string; - }; - return: - type: |- - { - [path: string]: string; - } - - name: dynamicDataValues - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataValues - summary: >- - Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the - web part. - remarks: |- - The key is the path within the web part properties, and the value is the dynamic data static value. - - Example: - - ``` - { - 'aStringProperty': 'thisIsAString', - 'aBooleanProperty': true - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: |- - dynamicDataValues?: { - [path: string]: any; - }; - return: - type: |- - { - [path: string]: any; - } - - name: properties - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' - package: '@microsoft/sp-webpart-base!' - fullName: properties - summary: Web part specific properties. The individual web part owns the definition of these properties. - remarks: >- - Used by the web part to manage its internal metadata and config data. The framework code never touches these - properties. - - - Supported values: any JSON stringifiable object hierarchy. - - - Example: `{ 'value': 'text value' }` - isPreview: false - isDeprecated: false - syntax: - content: 'properties?: any;' - return: - type: any - - name: serverProcessedContent - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' - package: '@microsoft/sp-webpart-base!' - fullName: serverProcessedContent - summary: The collections of data that can be processed by server side services like search index and link fixup. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'serverProcessedContent?: ISerializedServerProcessedData;' - return: - type: '' +### YamlMime:TSType +name: ISerializedWebPartData +uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' +package: '@microsoft/sp-webpart-base!' +fullName: ISerializedWebPartData +summary: >- + This structure represents the part of the serialized state of a web part which is controlled by the web part. It is + extended by IWebPartData which contains additional data added by the framework to the serialized data. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataVersion + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' + package: '@microsoft/sp-webpart-base!' + fullName: dataVersion + summary: Web part data version. + remarks: >- + Note that data version is different from the version field in the manifest. The manifest version is used to + control the versioning of the web part code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web part for more information. + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: false + isDeprecated: false + syntax: + content: 'dataVersion: Version;' + return: + type: '' + - name: dynamicDataPaths + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataPaths + summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data internal id. + + Example: + + ``` + { + 'pageContextUser': + 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataPaths?: { + [path: string]: string; + }; + return: + type: |- + { + [path: string]: string; + } + - name: dynamicDataValues + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataValues + summary: >- + Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the + web part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data static value. + + Example: + + ``` + { + 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataValues?: { + [path: string]: any; + }; + return: + type: |- + { + [path: string]: any; + } + - name: properties + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' + package: '@microsoft/sp-webpart-base!' + fullName: properties + summary: Web part specific properties. The individual web part owns the definition of these properties. + remarks: >- + Used by the web part to manage its internal metadata and config data. The framework code never touches these + properties. + + + Supported values: any JSON stringifiable object hierarchy. + + + Example: `{ 'value': 'text value' }` + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: any;' + return: + type: any + - name: serverProcessedContent + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' + package: '@microsoft/sp-webpart-base!' + fullName: serverProcessedContent + summary: The collections of data that can be processed by server side services like search index and link fixup. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'serverProcessedContent?: ISerializedServerProcessedData;' + return: + type: '' diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 74f61587..0f7d8cfd 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -1,125 +1,125 @@ -### YamlMime:TSType -name: IWebPartContext -uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartContext -summary: The base context interface for client-side web parts. -remarks: >- - A "context" object is a collection of well-known services and other objects that are likely to be needed by any - business logic working with a component. Each component type has its own specialized extension of this interface, e.g. - IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. -type: interface -properties: - - name: domElement - uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' - package: '@microsoft/sp-webpart-base!' - fullName: domElement - summary: Reference to the DOM element that hosts this client-side component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly domElement: HTMLElement;' - return: - type: HTMLElement - - name: httpClient - uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' - package: '@microsoft/sp-webpart-base!' - fullName: httpClient - summary: HttpClient instance scoped to this web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly httpClient: HttpClient;' - return: - type: '' - - name: instanceId - uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' - package: '@microsoft/sp-webpart-base!' - fullName: instanceId - summary: Web part instance id. This is a globally unique value. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly instanceId: string;' - return: - type: string - - name: manifest - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' - package: '@microsoft/sp-webpart-base!' - fullName: manifest - summary: Manifest for the client-side web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly manifest: IClientSideWebPartManifestInstance;' - return: - type: '<any>' - - name: pageContext - uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' - package: '@microsoft/sp-webpart-base!' - fullName: pageContext - summary: SharePoint page context. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly pageContext: PageContext;' - return: - type: '' - - name: propertyPane - uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' - package: '@microsoft/sp-webpart-base!' - fullName: propertyPane - summary: Accessor for common web part property pane operations. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly propertyPane: IPropertyPaneAccessor;' - return: - type: '' - - name: spHttpClient - uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' - package: '@microsoft/sp-webpart-base!' - fullName: spHttpClient - summary: SPHttpClient instance scoped to this web part. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly spHttpClient: SPHttpClient;' - return: - type: '' - - name: statusRenderer - uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' - package: '@microsoft/sp-webpart-base!' - fullName: statusRenderer - summary: Web part status renderer. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' - return: - type: '' - - name: webPartTag - uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' - package: '@microsoft/sp-webpart-base!' - fullName: webPartTag - summary: Web part tag to be used for logging and telemetry. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readonly webPartTag: string;' - return: - type: string +### YamlMime:TSType +name: IWebPartContext +uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartContext +summary: The base context interface for client-side web parts. +remarks: >- + A "context" object is a collection of well-known services and other objects that are likely to be needed by any + business logic working with a component. Each component type has its own specialized extension of this interface, e.g. + IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + - This interface will be removed in an upcoming release. Use the + [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. +type: interface +properties: + - name: domElement + uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' + package: '@microsoft/sp-webpart-base!' + fullName: domElement + summary: Reference to the DOM element that hosts this client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLElement;' + return: + type: HTMLElement + - name: httpClient + uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' + package: '@microsoft/sp-webpart-base!' + fullName: httpClient + summary: HttpClient instance scoped to this web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly httpClient: HttpClient;' + return: + type: '' + - name: instanceId + uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' + package: '@microsoft/sp-webpart-base!' + fullName: instanceId + summary: Web part instance id. This is a globally unique value. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly instanceId: string;' + return: + type: string + - name: manifest + uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' + package: '@microsoft/sp-webpart-base!' + fullName: manifest + summary: Manifest for the client-side web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly manifest: IClientSideWebPartManifestInstance;' + return: + type: '<any>' + - name: pageContext + uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' + package: '@microsoft/sp-webpart-base!' + fullName: pageContext + summary: SharePoint page context. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pageContext: PageContext;' + return: + type: '' + - name: propertyPane + uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' + package: '@microsoft/sp-webpart-base!' + fullName: propertyPane + summary: Accessor for common web part property pane operations. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly propertyPane: IPropertyPaneAccessor;' + return: + type: '' + - name: spHttpClient + uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' + package: '@microsoft/sp-webpart-base!' + fullName: spHttpClient + summary: SPHttpClient instance scoped to this web part. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly spHttpClient: SPHttpClient;' + return: + type: '' + - name: statusRenderer + uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' + package: '@microsoft/sp-webpart-base!' + fullName: statusRenderer + summary: Web part status renderer. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' + return: + type: '' + - name: webPartTag + uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' + package: '@microsoft/sp-webpart-base!' + fullName: webPartTag + summary: Web part tag to be used for logging and telemetry. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly webPartTag: string;' + return: + type: string diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 9f92f211..8ad852eb 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -1,195 +1,195 @@ -### YamlMime:TSType -name: IWebPartData -uid: '@microsoft/sp-webpart-base!IWebPartData:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartData -summary: This structure represents the serialized state of a web part. -remarks: >- - When the `serialize()` API is called on a web part, the output should be this structure. The structure of the - 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of - properties it wants to serialize. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dataVersion - uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' - package: '@microsoft/sp-webpart-base!' - fullName: dataVersion - summary: Web part data version - remarks: >- - Note that data version is different from the version field in the manifest. The manifest version is used to - control the versioning of the web part code, while data version is used to control the versioning of the - serialized data of the web part. Refer to dataVersion field of your web part for more information. - - - Supported values: MAJOR.MINOR - - - Example: `"1.0"` - isPreview: false - isDeprecated: false - syntax: - content: 'dataVersion: string;' - return: - type: string - - name: description - uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' - package: '@microsoft/sp-webpart-base!' - fullName: description - summary: Web part description - remarks: |- - Used to display the description of the web part. - - Supported values: string with the description. - - Example: `"Text"` - isPreview: false - isDeprecated: false - syntax: - content: 'description?: string;' - return: - type: string - - name: dynamicDataPaths - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataPaths - summary: Paths for the dynamic data. - remarks: >- - This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within - the web part properties, and the value is the dynamic data internal id. - - - Example: - - - ``` - - { - 'pageContextUser': - 'PageContext:user', - 'anotherWebPartProperty': - 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' - } - - ``` - isPreview: true - isDeprecated: false - syntax: - content: |- - dynamicDataPaths?: { - [path: string]: string; - }; - return: - type: |- - { - [path: string]: string; - } - - name: dynamicDataValues - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataValues - summary: >- - Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web - part. - remarks: |- - The key is the path within the web part properties, and the value is the dynamic data static value. - - Example: - - ``` - { - 'aStringProperty': 'thisIsAString', - 'aBooleanProperty': true - } - ``` - isPreview: true - isDeprecated: false - syntax: - content: |- - dynamicDataValues?: { - [path: string]: any; - }; - return: - type: |- - { - [path: string]: any; - } - - name: id - uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' - package: '@microsoft/sp-webpart-base!' - fullName: id - summary: Universally unique web part Type id. - remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string - - name: instanceId - uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' - package: '@microsoft/sp-webpart-base!' - fullName: instanceId - summary: >- - Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is - expected to be universally unique across time and page boundaries. - remarks: |- - supported values: a unique string. Could be GUID or other uniquely identifiable formats. - - example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` - isPreview: false - isDeprecated: false - syntax: - content: 'instanceId: string;' - return: - type: string - - name: properties - uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' - package: '@microsoft/sp-webpart-base!' - fullName: properties - summary: Web part specific properties. The individual web part owns the definition of these properties. - remarks: >- - Used by the web part to manage its internal metadata and config data. The framework code never touches these - properties. - - - Supported values: any object hierarchy that can be serialized using `JSON.stringify()`. - - - Example: `{ 'value': 'text value' }` - isPreview: false - isDeprecated: false - syntax: - content: 'properties?: any;' - return: - type: any - - name: serverProcessedContent - uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' - package: '@microsoft/sp-webpart-base!' - fullName: serverProcessedContent - summary: The collections of data that can be processed by server side services like search index and link fixup - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'serverProcessedContent?: ISerializedServerProcessedData;' - return: - type: '' - - name: title - uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' - package: '@microsoft/sp-webpart-base!' - fullName: title - summary: Web part title - remarks: |- - Used to display the name of the web part in the toolbox, web part gallery and the page. - - Supported values: string less than 100 characters - - Example: `"Text"` - isPreview: false - isDeprecated: false - syntax: - content: 'title: string;' - return: - type: string +### YamlMime:TSType +name: IWebPartData +uid: '@microsoft/sp-webpart-base!IWebPartData:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartData +summary: This structure represents the serialized state of a web part. +remarks: >- + When the `serialize()` API is called on a web part, the output should be this structure. The structure of the + 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of + properties it wants to serialize. +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataVersion + uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' + package: '@microsoft/sp-webpart-base!' + fullName: dataVersion + summary: Web part data version + remarks: >- + Note that data version is different from the version field in the manifest. The manifest version is used to + control the versioning of the web part code, while data version is used to control the versioning of the + serialized data of the web part. Refer to dataVersion field of your web part for more information. + + + Supported values: MAJOR.MINOR + + + Example: `"1.0"` + isPreview: false + isDeprecated: false + syntax: + content: 'dataVersion: string;' + return: + type: string + - name: description + uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' + package: '@microsoft/sp-webpart-base!' + fullName: description + summary: Web part description + remarks: |- + Used to display the description of the web part. + + Supported values: string with the description. + + Example: `"Text"` + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: dynamicDataPaths + uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataPaths + summary: Paths for the dynamic data. + remarks: >- + This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within + the web part properties, and the value is the dynamic data internal id. + + + Example: + + + ``` + + { + 'pageContextUser': + 'PageContext:user', + 'anotherWebPartProperty': + 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' + } + + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataPaths?: { + [path: string]: string; + }; + return: + type: |- + { + [path: string]: string; + } + - name: dynamicDataValues + uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicDataValues + summary: >- + Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web + part. + remarks: |- + The key is the path within the web part properties, and the value is the dynamic data static value. + + Example: + + ``` + { + 'aStringProperty': 'thisIsAString', + 'aBooleanProperty': true + } + ``` + isPreview: true + isDeprecated: false + syntax: + content: |- + dynamicDataValues?: { + [path: string]: any; + }; + return: + type: |- + { + [path: string]: any; + } + - name: id + uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' + package: '@microsoft/sp-webpart-base!' + fullName: id + summary: Universally unique web part Type id. + remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: instanceId + uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' + package: '@microsoft/sp-webpart-base!' + fullName: instanceId + summary: >- + Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is + expected to be universally unique across time and page boundaries. + remarks: |- + supported values: a unique string. Could be GUID or other uniquely identifiable formats. + + example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` + isPreview: false + isDeprecated: false + syntax: + content: 'instanceId: string;' + return: + type: string + - name: properties + uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' + package: '@microsoft/sp-webpart-base!' + fullName: properties + summary: Web part specific properties. The individual web part owns the definition of these properties. + remarks: >- + Used by the web part to manage its internal metadata and config data. The framework code never touches these + properties. + + + Supported values: any object hierarchy that can be serialized using `JSON.stringify()`. + + + Example: `{ 'value': 'text value' }` + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: any;' + return: + type: any + - name: serverProcessedContent + uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' + package: '@microsoft/sp-webpart-base!' + fullName: serverProcessedContent + summary: The collections of data that can be processed by server side services like search index and link fixup + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'serverProcessedContent?: ISerializedServerProcessedData;' + return: + type: '' + - name: title + uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' + package: '@microsoft/sp-webpart-base!' + fullName: title + summary: Web part title + remarks: |- + Used to display the name of the web part in the toolbox, web part gallery and the page. + + Supported values: string less than 100 characters + + Example: `"Text"` + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index def7cef8..fb3050af 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -1,61 +1,61 @@ -### YamlMime:TSType -name: IWebPartPropertiesMetadata -uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartPropertiesMetadata -summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` -remarks: >- - The key should be a JSON path to the property in web part properties. The JSON path supports the following operators: - - - - Dot `.` for selecting object members, for example `person.name` - - - - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` - - - - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. - - - You can make combinations of these operators, for example `person.websites[*].url` - - - Important Note: Only one wildcard per path is supported. - - - Example: Let's assume we have a web part with properties that have the following schema: - - - ``` - - { - title: string; - person: { - name: string; - bio: string; - photoURLs: string[]; - websites: { title: string; url: string; }[] - } - } - - ``` - - We can define the metadata for the desired properties as following: - - - ``` - - { - 'person.bio': { isRichContent: true }, - 'person.photoURLs[*]': { isImageSource: true }, - 'person.websites[*].url': { isLink: true } - } - - ``` - - This will make SharePoint servers aware of the content of your properties and run services such as search indexing, - link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web - part property bag is automatically updated. -isPreview: false -isDeprecated: false -type: interface +### YamlMime:TSType +name: IWebPartPropertiesMetadata +uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartPropertiesMetadata +summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` +remarks: >- + The key should be a JSON path to the property in web part properties. The JSON path supports the following operators: + + + - Dot `.` for selecting object members, for example `person.name` + + + - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` + + + - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. + + + You can make combinations of these operators, for example `person.websites[*].url` + + + Important Note: Only one wildcard per path is supported. + + + Example: Let's assume we have a web part with properties that have the following schema: + + + ``` + + { + title: string; + person: { + name: string; + bio: string; + photoURLs: string[]; + websites: { title: string; url: string; }[] + } + } + + ``` + + We can define the metadata for the desired properties as following: + + + ``` + + { + 'person.bio': { isRichContent: true }, + 'person.photoURLs[*]': { isImageSource: true }, + 'person.websites[*].url': { isLink: true } + } + + ``` + + This will make SharePoint servers aware of the content of your properties and run services such as search indexing, + link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web + part property bag is automatically updated. +isPreview: false +isDeprecated: false +type: interface diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 2e4804b3..3bf6ad55 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -1,37 +1,37 @@ -### YamlMime:TSType -name: IWebPartPropertyMetadata -uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartPropertyMetadata -summary: This is the structure used for map values in `IWebPartPropertiesMetadata` -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dynamicPropertyType - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicPropertyType - summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' - remarks: >- - If a web part has properties that are dynamically configurable, then use this flag to declare the property as a - dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework - ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a - property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the - IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create - the DynamicProperty themselves and assign it to the property. - - - A web part can configure a default value for the property by specifying it in the properties section of the web - part's manifest. This value will be used when a dynamic property is constructed for the property. - - - Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. - isPreview: false - isDeprecated: false - syntax: - content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' - return: - type: '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' -extends: '' +### YamlMime:TSType +name: IWebPartPropertyMetadata +uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' +package: '@microsoft/sp-webpart-base!' +fullName: IWebPartPropertyMetadata +summary: This is the structure used for map values in `IWebPartPropertiesMetadata` +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dynamicPropertyType + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' + package: '@microsoft/sp-webpart-base!' + fullName: dynamicPropertyType + summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' + remarks: >- + If a web part has properties that are dynamically configurable, then use this flag to declare the property as a + dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework + ensures that its value can be accessed using 'tryGetValue' anytime in the life cycle of the web part. If a + property is marked as DynamicProperty in the IWebPartProperties interface, but does not appear in the + IWebPartPropertiesMetadata with a dynamicPropertyType, then the web part developer will need to manually create + the DynamicProperty themselves and assign it to the property. + + + A web part can configure a default value for the property by specifying it in the properties section of the web + part's manifest. This value will be used when a dynamic property is constructed for the property. + + + Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. + isPreview: false + isDeprecated: false + syntax: + content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' + return: + type: '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' +extends: '' diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index eee5d3d8..eda5002f 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -1,43 +1,43 @@ -### YamlMime:TSEnum -name: PropertyPaneButtonType -uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' -package: '@microsoft/sp-webpart-base!' -fullName: PropertyPaneButtonType -summary: Enum for all the supported button types. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: Command - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' - package: '@microsoft/sp-webpart-base!' - summary: Optional actions. - value: '4' - - name: Compound - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' - package: '@microsoft/sp-webpart-base!' - summary: Always used as a set with both Standard and Primary compound buttons. - value: '3' - - name: Hero - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' - package: '@microsoft/sp-webpart-base!' - summary: Hero button. - value: '2' - - name: Icon - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' - package: '@microsoft/sp-webpart-base!' - summary: >- - Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within - the command bar. - value: '5' - - name: Normal - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' - package: '@microsoft/sp-webpart-base!' - summary: Optional completion action. - value: '0' - - name: Primary - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' - package: '@microsoft/sp-webpart-base!' - summary: Preferred completion action when paired with a Standard button. - value: '1' +### YamlMime:TSEnum +name: PropertyPaneButtonType +uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' +package: '@microsoft/sp-webpart-base!' +fullName: PropertyPaneButtonType +summary: Enum for all the supported button types. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: Command + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' + package: '@microsoft/sp-webpart-base!' + summary: Optional actions. + value: '4' + - name: Compound + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' + package: '@microsoft/sp-webpart-base!' + summary: Always used as a set with both Standard and Primary compound buttons. + value: '3' + - name: Hero + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' + package: '@microsoft/sp-webpart-base!' + summary: Hero button. + value: '2' + - name: Icon + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' + package: '@microsoft/sp-webpart-base!' + summary: >- + Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within + the command bar. + value: '5' + - name: Normal + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' + package: '@microsoft/sp-webpart-base!' + summary: Optional completion action. + value: '0' + - name: Primary + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' + package: '@microsoft/sp-webpart-base!' + summary: Preferred completion action when paired with a Standard button. + value: '1' diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 40aaeaa6..90f13878 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -1,28 +1,28 @@ -### YamlMime:TSEnum -name: PropertyPaneDropdownOptionType -uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' -package: '@microsoft/sp-webpart-base!' -fullName: PropertyPaneDropdownOptionType -summary: >- - Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: Divider - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' - package: '@microsoft/sp-webpart-base!' - summary: Render a divider. - value: '1' - - name: Header - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' - package: '@microsoft/sp-webpart-base!' - summary: Render menu item as a header. - value: '2' - - name: Normal - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' - package: '@microsoft/sp-webpart-base!' - summary: Render normal menu item. - value: '0' +### YamlMime:TSEnum +name: PropertyPaneDropdownOptionType +uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' +package: '@microsoft/sp-webpart-base!' +fullName: PropertyPaneDropdownOptionType +summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: Divider + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' + package: '@microsoft/sp-webpart-base!' + summary: Render a divider. + value: '1' + - name: Header + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' + package: '@microsoft/sp-webpart-base!' + summary: Render menu item as a header. + value: '2' + - name: Normal + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' + package: '@microsoft/sp-webpart-base!' + summary: Render normal menu item. + value: '0' diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 0182cebe..9bbcb618 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -1,89 +1,89 @@ -### YamlMime:TSEnum -name: PropertyPaneFieldType -uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' -package: '@microsoft/sp-webpart-base!' -fullName: PropertyPaneFieldType -summary: |- - Enum for all the supported PropertyPane field types. - - Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: Button - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' - package: '@microsoft/sp-webpart-base!' - summary: Button field. - value: '11' - - name: CheckBox - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' - package: '@microsoft/sp-webpart-base!' - summary: Checkbox field. - value: '2' - - name: ChoiceGroup - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' - package: '@microsoft/sp-webpart-base!' - summary: Choice Group field. - value: '10' - - name: Custom - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' - package: '@microsoft/sp-webpart-base!' - summary: Custom field. - value: '1' - - name: Dropdown - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' - package: '@microsoft/sp-webpart-base!' - summary: Dropdown field. - value: '6' - - name: DynamicField - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' - package: '@microsoft/sp-webpart-base!' - summary: Dynamic data field. - value: '14' - - name: DynamicFieldSet - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' - package: '@microsoft/sp-webpart-base!' - summary: A set of dynamic fields. - value: '16' - - name: DynamicTextField - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' - package: '@microsoft/sp-webpart-base!' - summary: Dynamic Text Field - value: '15' - - name: Heading - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' - package: '@microsoft/sp-webpart-base!' - summary: Heading field. - value: '9' - - name: HorizontalRule - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' - package: '@microsoft/sp-webpart-base!' - summary: Horizontal Rule field. - value: '12' - - name: Label - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' - package: '@microsoft/sp-webpart-base!' - summary: Label field. - value: '7' - - name: Link - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' - package: '@microsoft/sp-webpart-base!' - summary: Link field. - value: '13' - - name: Slider - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' - package: '@microsoft/sp-webpart-base!' - summary: Slider field. - value: '8' - - name: TextField - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' - package: '@microsoft/sp-webpart-base!' - summary: TextField field. - value: '3' - - name: Toggle - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' - package: '@microsoft/sp-webpart-base!' - summary: Toggle field. - value: '5' +### YamlMime:TSEnum +name: PropertyPaneFieldType +uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' +package: '@microsoft/sp-webpart-base!' +fullName: PropertyPaneFieldType +summary: |- + Enum for all the supported PropertyPane field types. + + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. +remarks: '' +isPreview: false +isDeprecated: true +customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. +fields: + - name: Button + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' + package: '@microsoft/sp-webpart-base!' + summary: Button field. + value: '11' + - name: CheckBox + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' + package: '@microsoft/sp-webpart-base!' + summary: Checkbox field. + value: '2' + - name: ChoiceGroup + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' + package: '@microsoft/sp-webpart-base!' + summary: Choice Group field. + value: '10' + - name: Custom + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' + package: '@microsoft/sp-webpart-base!' + summary: Custom field. + value: '1' + - name: Dropdown + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' + package: '@microsoft/sp-webpart-base!' + summary: Dropdown field. + value: '6' + - name: DynamicField + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' + package: '@microsoft/sp-webpart-base!' + summary: Dynamic data field. + value: '14' + - name: DynamicFieldSet + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' + package: '@microsoft/sp-webpart-base!' + summary: A set of dynamic fields. + value: '16' + - name: DynamicTextField + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' + package: '@microsoft/sp-webpart-base!' + summary: Dynamic Text Field + value: '15' + - name: Heading + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' + package: '@microsoft/sp-webpart-base!' + summary: Heading field. + value: '9' + - name: HorizontalRule + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' + package: '@microsoft/sp-webpart-base!' + summary: Horizontal Rule field. + value: '12' + - name: Label + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' + package: '@microsoft/sp-webpart-base!' + summary: Label field. + value: '7' + - name: Link + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' + package: '@microsoft/sp-webpart-base!' + summary: Link field. + value: '13' + - name: Slider + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' + package: '@microsoft/sp-webpart-base!' + summary: Slider field. + value: '8' + - name: TextField + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' + package: '@microsoft/sp-webpart-base!' + summary: TextField field. + value: '3' + - name: Toggle + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' + package: '@microsoft/sp-webpart-base!' + summary: Toggle field. + value: '5' diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 950eeb2f..d9f2cdf2 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -1,83 +1,83 @@ -### YamlMime:TSType -name: WebPartContext -uid: '@microsoft/sp-webpart-base!WebPartContext:class' -package: '@microsoft/sp-webpart-base!' -fullName: WebPartContext -summary: >- - Web part context object. This object contains the contextual services available to a web part. e.g. a contextual - instance to the http client. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `WebPartContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: domElement - uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' - package: '@microsoft/sp-webpart-base!' - fullName: domElement - summary: Reference to the DOM element that hosts this client-side component. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get domElement(): HTMLElement;' - return: - type: HTMLElement - - name: microsoftTeams - uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' - package: '@microsoft/sp-webpart-base!' - fullName: microsoftTeams - summary: >- - Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is - being hosted in Microsoft Teams. - remarks: >- - For more information, please see: - [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This function has been deprecated' - syntax: - content: 'get microsoftTeams(): typeof microsoftTeams | undefined;' - return: - type: typeof microsoftTeams | undefined - - name: sdks - uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' - package: '@microsoft/sp-webpart-base!' - fullName: sdks - summary: Conditional set of SDKs provided by SPFx dependent on the environment. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get sdks(): ISDKs;' - return: - type: '' - - name: statusRenderer - uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' - package: '@microsoft/sp-webpart-base!' - fullName: statusRenderer - summary: Web part status renderer. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;' - return: - type: '' - - name: widthCacheKey - uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' - package: '@microsoft/sp-webpart-base!' - fullName: widthCacheKey - summary: >- - This functions returns a key generated by web parts display mode, layout index, and section factor. It will return - undefined if sectionFactor or display mode is undefined, else return the cache key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'get widthCacheKey(): string | undefined;' - return: - type: string | undefined -extends: '' +### YamlMime:TSType +name: WebPartContext +uid: '@microsoft/sp-webpart-base!WebPartContext:class' +package: '@microsoft/sp-webpart-base!' +fullName: WebPartContext +summary: >- + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. +remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `WebPartContext` class. +isPreview: false +isDeprecated: false +type: class +properties: + - name: domElement + uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' + package: '@microsoft/sp-webpart-base!' + fullName: domElement + summary: Reference to the DOM element that hosts this client-side component. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get domElement(): HTMLElement;' + return: + type: HTMLElement + - name: microsoftTeams + uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' + package: '@microsoft/sp-webpart-base!' + fullName: microsoftTeams + summary: >- + Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is + being hosted in Microsoft Teams. + remarks: >- + For more information, please see: + [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + isPreview: false + isDeprecated: true + customDeprecatedMessage: '- This function has been deprecated' + syntax: + content: 'get microsoftTeams(): typeof microsoftTeams | undefined;' + return: + type: typeof microsoftTeams | undefined + - name: sdks + uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' + package: '@microsoft/sp-webpart-base!' + fullName: sdks + summary: Conditional set of SDKs provided by SPFx dependent on the environment. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get sdks(): ISDKs;' + return: + type: '' + - name: statusRenderer + uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' + package: '@microsoft/sp-webpart-base!' + fullName: statusRenderer + summary: Web part status renderer. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;' + return: + type: '' + - name: widthCacheKey + uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' + package: '@microsoft/sp-webpart-base!' + fullName: widthCacheKey + summary: >- + This functions returns a key generated by web parts display mode, layout index, and section factor. It will return + undefined if sectionFactor or display mode is undefined, else return the cache key. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'get widthCacheKey(): string | undefined;' + return: + type: string | undefined +extends: '' From e06e3400601feaa8091c4d906de9737ed764d906 Mon Sep 17 00:00:00 2001 From: John Nguyen Date: Fri, 10 Dec 2021 15:38:15 -0800 Subject: [PATCH 48/55] Remove deprecated APIs --- SP-Framework/sp-http/graphhttpclient.yml | 168 ------------------ .../sp-http/graphhttpclientconfiguration.yml | 57 ------ .../sp-http/graphhttpclientresponse.yml | 66 ------- .../sp-http/igraphhttpclientconfiguration.yml | 12 -- .../igraphhttpclientconfigurations.yml | 35 ---- .../sp-http/igraphhttpclientoptions.yml | 14 -- SP-Framework/sp-webpart-base/ioffice.yml | 23 --- 7 files changed, 375 deletions(-) delete mode 100644 SP-Framework/sp-http/graphhttpclient.yml delete mode 100644 SP-Framework/sp-http/graphhttpclientconfiguration.yml delete mode 100644 SP-Framework/sp-http/graphhttpclientresponse.yml delete mode 100644 SP-Framework/sp-http/igraphhttpclientconfiguration.yml delete mode 100644 SP-Framework/sp-http/igraphhttpclientconfigurations.yml delete mode 100644 SP-Framework/sp-http/igraphhttpclientoptions.yml delete mode 100644 SP-Framework/sp-webpart-base/ioffice.yml diff --git a/SP-Framework/sp-http/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml deleted file mode 100644 index 81035938..00000000 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ /dev/null @@ -1,168 +0,0 @@ -### YamlMime:TSType -name: GraphHttpClient -uid: sp-http.GraphHttpClient -package: sp-http -fullName: GraphHttpClient -summary: >- - GraphHttpClient is used to perform REST calls against Microsoft Graph. It adds - default headers and collects telemetry that helps the service to monitor the - performance of an application. https://developer.microsoft.com/en-us/graph/ -remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - For communicating with SharePoint, use the - [SPHttpClient](xref:sp-http.SPHttpClient) class instead. For communicating - with other internet services, use the [HttpClient](xref:sp-http.HttpClient) - class instead. -isPreview: true -isDeprecated: true -customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. -type: class -constructors: - - name: constructor(serviceScope) - uid: sp-http.GraphHttpClient.constructor - package: sp-http - fullName: constructor - summary: >- - Constructs a new instance of the - [GraphHttpClient](xref:sp-http.GraphHttpClient) class - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: ServiceScope -properties: - - name: configurations - uid: sp-http.GraphHttpClient.configurations - package: sp-http - fullName: configurations - summary: >- - The standard predefined GraphHttpClientConfiguration objects for use with - the GraphHttpClient class. - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. - syntax: - content: 'static readonly configurations: IGraphHttpClientConfigurations;' - return: - type: IGraphHttpClientConfigurations - - name: serviceKey - uid: sp-http.GraphHttpClient.serviceKey - package: sp-http - fullName: serviceKey - summary: The service key for GraphHttpClient. - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: ServiceKey<GraphHttpClient> -methods: - - name: 'fetch(url, configuration, options)' - uid: sp-http.GraphHttpClient.fetch - package: sp-http - fullName: fetch - summary: Perform a REST service call. - remarks: >- - Generally, the parameters and semantics for HttpClient.fetch() are - essentially the same as the WHATWG API standard that is documented here: - https://fetch.spec.whatwg.org/ - - - The GraphHttpClient subclass adds some additional behaviors that are - convenient when working with SharePoint ODATA API's (which can be avoided - by using HttpClient instead): - Default "Accept" and "Content-Type" - headers are added if not explicitly specified. - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. - syntax: - content: >- - fetch(url: string, configuration: GraphHttpClientConfiguration, options: - IGraphHttpClientOptions): Promise; - parameters: - - id: url - description: >- - The url string should be relative to the graph server. Good: - 'v1.0/me/events' Bad: '/v1.0/me/events', - 'https://graph.microsoft.com/v1.0/me/events' - type: string - - id: configuration - description: >- - determines the default behavior of GraphHttpClient; normally this - should be the latest version number from - GraphHttpClientConfigurations - type: GraphHttpClientConfiguration - - id: options - description: additional options that affect the request - type: IGraphHttpClientOptions - return: - type: Promise<GraphHttpClientResponse> - description: a promise that will return the result - - name: 'get(url, configuration, options)' - uid: sp-http.GraphHttpClient.get - package: sp-http - fullName: get - summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. - syntax: - content: >- - get(url: string, configuration: GraphHttpClientConfiguration, options?: - IGraphHttpClientOptions): Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of GraphHttpClient; normally this - should be the latest version number from - GraphHttpClientConfigurations - type: GraphHttpClientConfiguration - - id: options - description: additional options that affect the request - type: IGraphHttpClientOptions - return: - type: Promise<GraphHttpClientResponse> - description: a promise that will return the result - - name: 'post(url, configuration, options)' - uid: sp-http.GraphHttpClient.post - package: sp-http - fullName: post - summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superseded by the MSGraphClient class. - syntax: - content: >- - post(url: string, configuration: GraphHttpClientConfiguration, options: - IGraphHttpClientOptions): Promise; - parameters: - - id: url - description: the URL to fetch - type: string - - id: configuration - description: >- - determines the default behavior of GraphHttpClient; normally this - should be the latest version number from - GraphHttpClientConfigurations - type: GraphHttpClientConfiguration - - id: options - description: additional options that affect the request - type: IGraphHttpClientOptions - return: - type: Promise<GraphHttpClientResponse> - description: a promise that will return the result diff --git a/SP-Framework/sp-http/graphhttpclientconfiguration.yml b/SP-Framework/sp-http/graphhttpclientconfiguration.yml deleted file mode 100644 index 56aa538e..00000000 --- a/SP-Framework/sp-http/graphhttpclientconfiguration.yml +++ /dev/null @@ -1,57 +0,0 @@ -### YamlMime:TSType -name: GraphHttpClientConfiguration -uid: sp-http.GraphHttpClientConfiguration -package: sp-http -fullName: GraphHttpClientConfiguration -summary: 'Configuration for [GraphHttpClient](xref:sp-http.GraphHttpClient).' -remarks: >- - The GraphHttpClientConfiguration object provides a set of switches for - enabling/disabling various features of the GraphHttpClient class. Normally - these switches are set (e.g. when calling GraphHttpClient.fetch()) by - providing one of the predefined defaults from GraphHttpClientConfigurations, - however switches can also be changed via the - GraphHttpClientConfiguration.overrideWith() method. -isPreview: true -isDeprecated: true -customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. -type: class -constructors: - - name: 'constructor(flags, overrideFlags)' - uid: sp-http.GraphHttpClientConfiguration.constructor - package: sp-http - fullName: constructor - summary: >- - Constructs a new instance of GraphHttpClientCommonConfiguration with the - specified flags. - remarks: >- - The default values will be used for any flags that are missing or - undefined. If overrideFlags is specified, it takes precedence over flags. - isPreview: false - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. - syntax: - content: >- - constructor(flags: IGraphHttpClientConfiguration, overrideFlags?: - IGraphHttpClientConfiguration); - parameters: - - id: flags - description: '' - type: IGraphHttpClientConfiguration - - id: overrideFlags - description: '' - type: IGraphHttpClientConfiguration -properties: - - name: flags - uid: sp-http.GraphHttpClientConfiguration.flags - package: sp-http - fullName: flags - summary: '' - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. - syntax: - content: 'protected flags: IGraphHttpClientConfiguration;' - return: - type: IGraphHttpClientConfiguration -extends: HttpClientConfiguration diff --git a/SP-Framework/sp-http/graphhttpclientresponse.yml b/SP-Framework/sp-http/graphhttpclientresponse.yml deleted file mode 100644 index cd8fd3b8..00000000 --- a/SP-Framework/sp-http/graphhttpclientresponse.yml +++ /dev/null @@ -1,66 +0,0 @@ -### YamlMime:TSType -name: GraphHttpClientResponse -uid: sp-http.GraphHttpClientResponse -package: sp-http -fullName: GraphHttpClientResponse -summary: The Response subclass returned by methods such as GraphHttpClient.fetch(). -remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - - - This is a placeholder. In the future, additional GraphHttpClient-specific - functionality may be added to this class. -isPreview: true -isDeprecated: true -customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. -type: class -constructors: - - name: constructor(response) - uid: sp-http.GraphHttpClientResponse.constructor - package: sp-http - fullName: constructor - summary: >- - Constructs a new instance of the - [GraphHttpClientResponse](xref:sp-http.GraphHttpClientResponse) class - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. - syntax: - content: 'constructor(response: Response);' - parameters: - - id: response - description: '' - type: Response -properties: - - name: correlationId - uid: sp-http.GraphHttpClientResponse.correlationId - package: sp-http - fullName: correlationId - summary: Returns the Graph API correlation ID. - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. - syntax: - content: 'readonly correlationId: Guid | undefined;' - return: - type: Guid | undefined -methods: - - name: clone() - uid: sp-http.GraphHttpClientResponse.clone - package: sp-http - fullName: clone - summary: '' - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. - syntax: - content: |- - /** @override */ - clone(): GraphHttpClientResponse; - return: - type: GraphHttpClientResponse - description: '' -extends: HttpClientResponse diff --git a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml b/SP-Framework/sp-http/igraphhttpclientconfiguration.yml deleted file mode 100644 index 962d2d30..00000000 --- a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml +++ /dev/null @@ -1,12 +0,0 @@ -### YamlMime:TSType -name: IGraphHttpClientConfiguration -uid: sp-http.IGraphHttpClientConfiguration -package: sp-http -fullName: IGraphHttpClientConfiguration -summary: Flags interface for GraphHttpClientCommonConfiguration -remarks: '' -isPreview: true -isDeprecated: true -customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. -type: interface -extends: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml deleted file mode 100644 index f309f811..00000000 --- a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml +++ /dev/null @@ -1,35 +0,0 @@ -### YamlMime:TSType -name: IGraphHttpClientConfigurations -uid: sp-http.IGraphHttpClientConfigurations -package: sp-http -fullName: IGraphHttpClientConfigurations -summary: Standard configurations for GraphHttpClient. -remarks: >- - This interface provides standard predefined GraphHttpClientConfiguration - objects for use with the GraphHttpClient class. In general, clients should - choose the latest available version number, which enables all the switches - that are recommended for typical scenarios. (If new switches are introduced in - the future, a new version number will be introduced, which ensures that - existing code will continue to function the way it did at the time when it was - tested.) -isPreview: true -isDeprecated: true -customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. -type: interface -properties: - - name: v1 - uid: sp-http.IGraphHttpClientConfigurations.v1 - package: sp-http - fullName: v1 - summary: >- - This configuration turns off every feature switch for HttpClient. The - fetch() behavior will be essentially identical to the WHATWG standard API - that is documented here: https://fetch.spec.whatwg.org/ - remarks: '' - isPreview: true - isDeprecated: true - customDeprecatedMessage: The GraphHttpClient class has been superceded by the MSGraphClient class. - syntax: - content: 'readonly v1: GraphHttpClientConfiguration;' - return: - type: GraphHttpClientConfiguration diff --git a/SP-Framework/sp-http/igraphhttpclientoptions.yml b/SP-Framework/sp-http/igraphhttpclientoptions.yml deleted file mode 100644 index f7aa9687..00000000 --- a/SP-Framework/sp-http/igraphhttpclientoptions.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSType -name: IGraphHttpClientOptions -uid: sp-http.IGraphHttpClientOptions -package: sp-http -fullName: IGraphHttpClientOptions -summary: Options for HttpClient -remarks: >- - This interface defines the options for the GraphHttpClient operations such as - get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters - that are documented here: https://fetch.spec.whatwg.org/ -isPreview: true -isDeprecated: false -type: interface -extends: sp-http.IHttpClientOptions diff --git a/SP-Framework/sp-webpart-base/ioffice.yml b/SP-Framework/sp-webpart-base/ioffice.yml deleted file mode 100644 index 9a6e6254..00000000 --- a/SP-Framework/sp-webpart-base/ioffice.yml +++ /dev/null @@ -1,23 +0,0 @@ -### YamlMime:TSType -name: IOffice -uid: '@microsoft/sp-webpart-base!IOffice:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IOffice -summary: Provides access to the Office context. Only provided when the web part is loaded in Office. -remarks: '' -isPreview: true -isDeprecated: false -type: interface -properties: - - name: context - uid: '@microsoft/sp-webpart-base!IOffice#context:member' - package: '@microsoft/sp-webpart-base!' - fullName: context - summary: Microsoft Office SDK. - remarks: '' - isPreview: true - isDeprecated: false - syntax: - content: 'context: Office.Context;' - return: - type: Office.Context From da376ea62ee2fd132b8154247fe5eeb4e5b22a73 Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Thu, 20 Jan 2022 09:21:22 -0500 Subject: [PATCH 49/55] Update API docs for 1.14.0-beta.5 --- SP-Framework/decorators.yml | 3 + .../office-ui-fabric-react-bundle.yml | 1 + .../sp-adaptive-card-extension-base.yml | 4 + .../adaptivecardextensioncontext.yml | 4 + .../baseadaptivecardextension.yml | 55 ++ .../baseadaptivecardview.yml | 5 + .../basebasiccardview.yml | 2 + .../basecardview.yml | 5 + .../baseimagecardview.yml | 2 + .../baseprimarytextcardview.yml | 2 + .../baseview.yml | 32 + ...daptivecardextensionpropertiesmetadata.yml | 1 + ...iadaptivecardextensionpropertymetadata.yml | 1 + .../iattachmenterror.yml | 25 + .../ibaseactionarguments.yml | 3 + .../ibaseactionerrorarguments.yml | 54 ++ .../ibasecardparameters.yml | 4 + .../ibasiccardparameters.yml | 2 + .../icachedloadparameters.yml | 3 + .../icachesettings.yml | 4 + .../icardbutton.yml | 5 + .../iconfirmationdialog.yml | 3 + .../iexternallinkcardaction.yml | 3 + .../iexternallinkparameters.yml | 3 + .../igetlocationaction.yml | 5 +- .../igetlocationactionarguments.yml | 5 +- .../igetlocationactionparameters.yml | 2 + .../igetlocationcardaction.yml | 3 + .../iimagecardparameters.yml | 3 + .../ilocation.yml | 5 + .../ilocationerrorarguments.yml | 45 ++ .../iprimarytextcardparameters.yml | 3 + .../iquickviewcardaction.yml | 3 + .../iquickviewparameters.yml | 2 + .../iselectmediaaction.yml | 9 +- .../iselectmediaactionarguments.yml | 5 +- .../iselectmediaactionerrorarguments.yml | 58 ++ .../iselectmediaactionparameters.yml | 5 + .../iselectmediaattachment.yml | 16 + .../iselectmediacardaction.yml | 3 + .../ishowcardactionarguments.yml | 2 + .../ishowlocationaction.yml | 5 +- .../ishowlocationactionparameters.yml | 2 + .../ishowlocationcardaction.yml | 3 + .../ispfxadaptivecard.yml | 24 +- .../isubmitactionarguments.yml | 3 + .../isubmitcardaction.yml | 4 + .../isubmitcardparameters.yml | 1 + .../mediatype.yml | 1 + .../quickviewnavigator.yml | 2 + .../viewnavigator.yml | 8 + .../applicationaccessor.yml | 3 + .../applicationcustomizercontext.yml | 4 + .../baseapplicationcustomizer.yml | 4 + .../iplaceholdercreatecontentoptions.yml | 2 + .../placeholdercontent.yml | 6 + .../sp-application-base/placeholdername.yml | 1 + .../placeholderprovider.yml | 6 + .../sp-component-base/basecomponent.yml | 8 + .../basecomponentcontext.yml | 15 + .../sp-component-base/dynamicdataprovider.yml | 11 + .../dynamicdatasourcemanager.yml | 8 + .../sp-component-base/dynamicproperty.yml | 14 + .../icomponentpropertymetadata.yml | 6 + .../sp-component-base/ireadonlyfontstyles.yml | 1 + .../sp-component-base/ireadonlytheme.yml | 1 + .../iserializedserverprocesseddata.yml | 5 + SP-Framework/sp-component-base/itheme.yml | 1 + .../themechangedeventargs.yml | 2 + .../sp-component-base/themeprovider.yml | 5 + SP-Framework/sp-core-library/displaymode.yml | 1 + SP-Framework/sp-core-library/environment.yml | 2 + .../sp-core-library/environmenttype.yml | 1 + SP-Framework/sp-core-library/guid.yml | 8 + SP-Framework/sp-core-library/idisposable.yml | 3 + .../irandomnumbergenerator.yml | 2 + .../sp-core-library/iservicecollection.yml | 2 + .../sp-core-library/ispeventobserver.yml | 3 + .../sp-core-library/itimeprovider.yml | 3 + SP-Framework/sp-core-library/log.yml | 5 + .../sp-core-library/randomnumbergenerator.yml | 4 + SP-Framework/sp-core-library/servicekey.yml | 6 + SP-Framework/sp-core-library/servicescope.yml | 11 + SP-Framework/sp-core-library/session.yml | 4 + SP-Framework/sp-core-library/spevent.yml | 3 + SP-Framework/sp-core-library/speventargs.yml | 1 + SP-Framework/sp-core-library/text_2.yml | 3 + SP-Framework/sp-core-library/timeprovider.yml | 5 + .../urlqueryparametercollection.yml | 4 + SP-Framework/sp-core-library/validate.yml | 5 + SP-Framework/sp-core-library/version.yml | 14 + SP-Framework/sp-dialog/basedialog.yml | 12 + SP-Framework/sp-dialog/dialog.yml | 3 + SP-Framework/sp-dialog/ialertoptions.yml | 1 + .../sp-dialog/idialogconfiguration.yml | 2 + SP-Framework/sp-dialog/idialogshowoptions.yml | 2 + SP-Framework/sp-dialog/ipromptoptions.yml | 2 + .../sp-dialog/isecondarydialogprovider.yml | 4 + .../sp-dynamic-data/dynamicdatareference.yml | 6 + .../idynamicdataannotatedpropertyvalue.yml | 3 + .../sp-dynamic-data/idynamicdatacallables.yml | 6 + .../idynamicdataeventdefinition.yml | 3 + .../idynamicdatapropertydefinition.yml | 2 + .../idynamicdatapropertymetadata.yml | 3 + .../idynamicdatapropertyvaluemetadata.yml | 2 + ...micdatapropertyvaluemetadatacollection.yml | 1 + .../sp-dynamic-data/idynamicdatasource.yml | 11 + .../idynamicdatasourcemetadata.yml | 6 + .../sp-extension-base/baseextension.yml | 4 + .../sp-extension-base/extensioncontext.yml | 1 + SP-Framework/sp-http/aadhttpclient.yml | 6 + .../sp-http/aadhttpclientconfiguration.yml | 4 + SP-Framework/sp-http/aadhttpclientfactory.yml | 3 + .../sp-http/aadhttpclientresponse.yml | 2 + SP-Framework/sp-http/aadtokenprovider.yml | 4 + .../sp-http/aadtokenproviderfactory.yml | 3 + .../sp-http/beforeredirecteventargs.yml | 4 + SP-Framework/sp-http/digestcache.yml | 7 + SP-Framework/sp-http/graphrequest.yml | 31 + SP-Framework/sp-http/httpclient.yml | 7 + .../sp-http/httpclientconfiguration.yml | 5 + SP-Framework/sp-http/httpclientresponse.yml | 15 + .../sp-http/iaadhttpclientconfiguration.yml | 1 + .../sp-http/iaadhttpclientconfigurations.yml | 2 + .../sp-http/iaadhttpclientoptions.yml | 4 + SP-Framework/sp-http/iaadtokenprovider.yml | 4 + .../iaadtokenproviderconfiguration.yml | 9 + .../sp-http/ibeforeredirecteventargs.yml | 3 + SP-Framework/sp-http/idigestcache.yml | 5 + .../sp-http/ihttpclientconfiguration.yml | 1 + .../sp-http/ihttpclientconfigurations.yml | 2 + SP-Framework/sp-http/ihttpclientoptions.yml | 1 + .../isphttpclientbatchconfiguration.yml | 1 + .../isphttpclientbatchconfigurations.yml | 2 + .../isphttpclientbatchcreationoptions.yml | 2 + .../sp-http/isphttpclientbatchoptions.yml | 1 + .../isphttpclientcommonconfiguration.yml | 3 + .../sp-http/isphttpclientconfiguration.yml | 4 + .../sp-http/isphttpclientconfigurations.yml | 2 + SP-Framework/sp-http/isphttpclientoptions.yml | 2 + .../sp-http/itokenacquisitioneventargs.yml | 3 + SP-Framework/sp-http/msgraphclient.yml | 2 + SP-Framework/sp-http/msgraphclientfactory.yml | 3 + SP-Framework/sp-http/odataversion.yml | 5 + SP-Framework/sp-http/sphttpclient.yml | 10 + SP-Framework/sp-http/sphttpclientbatch.yml | 6 + .../sphttpclientbatchconfiguration.yml | 5 + .../sphttpclientcommonconfiguration.yml | 7 + .../sp-http/sphttpclientconfiguration.yml | 8 + SP-Framework/sp-http/sphttpclientresponse.yml | 4 + SP-Framework/sp-http/sphttpheader.yml | 1 + .../sp-http/tokenacquisitioneventargs.yml | 4 + .../sp-image-helper/iimagehelperrequest.yml | 4 + SP-Framework/sp-image-helper/imagehelper.yml | 2 + .../icreatesubscriptionsettings.yml | 6 + .../ilistsubscription.yml | 2 + .../isubscriptioncallbacks.yml | 4 + .../listsubscriptionfactory.yml | 4 + SP-Framework/sp-listview-extensibility.yml | 10 + .../basefieldcustomizer.yml | 4 + .../baselistviewcommandset.yml | 22 +- .../columnaccessor.yml | 3 + .../sp-listview-extensibility/command.yml | 6 + .../fieldcustomizercontext.yml | 3 + .../sp-listview-extensibility/icolumn.yml | 118 +++ .../ifieldcustomizercelleventparameters.yml | 5 + .../sp-listview-extensibility/ifilter.yml | 38 + .../sp-listview-extensibility/ifolderinfo.yml | 25 + .../sp-listview-extensibility/ilist.yml | 51 ++ .../ilistviewaccessorstate.yml | 135 ++++ ...stviewcommandsetexecuteeventparameters.yml | 3 + ...iewcommandsetlistviewupdatedparameters.yml | 2 + .../sp-listview-extensibility/irow.yml | 33 + .../sp-listview-extensibility/iview.yml | 51 ++ .../listitemaccessor.yml | 4 + .../listviewaccessor.yml | 129 ++++ .../listviewaccessorstatechanges.yml | 56 ++ .../listviewcommandsetcontext.yml | 3 + .../listviewstatechangedeventargs.yml | 39 + .../sp-listview-extensibility/rowaccessor.yml | 1 + .../selectedrowschangedeventargs.yml | 2 + SP-Framework/sp-loader/iloadscriptoptions.yml | 2 + SP-Framework/sp-loader/spcomponentloader.yml | 6 + .../iadaptivecardextensionmanifest.yml | 9 + .../iadaptivecardextensionmanifestentry.yml | 10 + .../iclientsideassemblymanifest.yml | 2 + ...clientsidecomponentloaderconfiguration.yml | 5 + .../iclientsidecomponentmanifest.yml | 8 + .../iclientsideextensionmanifest.yml | 2 + .../iclientsidelibrarymanifest.yml | 1 + .../iclientsidemanifestbase.yml | 3 + .../iclientsidewebpartmanifest.yml | 9 + .../iclientsidewebpartmanifestentry.yml | 11 + .../iclientsidewebpartmanifestinstance.yml | 1 + .../icommanddefinition.yml | 5 + .../icommandsetextensionmanifest.yml | 3 + .../icomponentmoduleconfiguration.yml | 4 + .../ilocalizedpathmoduleconfiguration.yml | 3 + .../sp-module-interfaces/ilocalizedstring.yml | 3 + .../imoduleconfiguration.yml | 3 + SP-Framework/sp-module-interfaces/ipath.yml | 3 + .../ipathmoduleconfiguration.yml | 4 + .../sp-module-interfaces/predefinedgroup.yml | 9 + SP-Framework/sp-odata-types/_iodatauserid.yml | 3 + .../sp-odata-types/iodatabasepermission.yml | 3 + .../sp-odata-types/iodatachangetoken.yml | 2 + .../iodatacontextwebinformation.yml | 5 + SP-Framework/sp-odata-types/iodatalist.yml | 14 + .../sp-odata-types/iodatalistitem.yml | 5 + .../sp-odata-types/iodatanavigationnode.yml | 8 + .../iodatanavigationnodecollection.yml | 3 + SP-Framework/sp-odata-types/iodatauser.yml | 8 + .../sp-odata-types/iodatausercustomaction.yml | 19 + SP-Framework/sp-odata-types/iodataweb.yml | 19 + SP-Framework/sp-page-context/cultureinfo.yml | 4 + .../sp-page-context/ispsystemtime.yml | 9 + .../sp-page-context/isptimezonedata.yml | 8 + SP-Framework/sp-page-context/pagecontext.yml | 12 + SP-Framework/sp-page-context/spfield.yml | 8 + SP-Framework/sp-page-context/splist.yml | 5 + SP-Framework/sp-page-context/splistitem.yml | 2 + SP-Framework/sp-page-context/sppermission.yml | 42 ++ SP-Framework/sp-page-context/spsite.yml | 12 + SP-Framework/sp-page-context/sptimezone.yml | 8 + SP-Framework/sp-page-context/spuser.yml | 9 + SP-Framework/sp-page-context/spweb.yml | 14 + SP-Framework/sp-property-pane.yml | 14 + .../dynamicdatashareddepth.yml | 1 + ...dynamicdatasharedpropertyconfiguration.yml | 2 + .../idynamicdatasharedpropertyfilters.yml | 2 + .../idynamicdatasharedsourceconfiguration.yml | 3 + .../idynamicdatasharedsourcefilters.yml | 3 + .../sp-property-pane/ipopupwindowprops.yml | 5 + .../ipropertypanebuttonprops.yml | 9 + .../ipropertypanecheckboxprops.yml | 4 + .../ipropertypanechoicegroupoption.yml | 10 + ...propertypanechoicegroupoptioniconprops.yml | 2 + .../ipropertypanechoicegroupprops.yml | 3 + .../ipropertypaneconditionalgroup.yml | 6 + .../ipropertypaneconfiguration.yml | 7 + .../ipropertypanecustomfieldprops.yml | 5 + .../ipropertypanedebounceproperty.yml | 3 + .../ipropertypanedropdowncalloutprops.yml | 2 + .../ipropertypanedropdownoption.yml | 5 + .../ipropertypanedropdownprops.yml | 10 + .../ipropertypanedynamicfieldprops.yml | 5 + .../ipropertypanedynamicfieldsetprops.yml | 4 + .../ipropertypanedynamictextfieldprops.yml | 11 + .../sp-property-pane/ipropertypanefield.yml | 5 + .../sp-property-pane/ipropertypanegroup.yml | 5 + .../ipropertypanelabelprops.yml | 3 + .../ipropertypanelinkprops.yml | 6 + .../sp-property-pane/ipropertypanepage.yml | 4 + .../ipropertypanepageheader.yml | 3 + .../ipropertypanesliderprops.yml | 10 + .../ipropertypanetextfieldprops.yml | 18 + .../ipropertypanetoggleprops.yml | 9 + .../sp-property-pane/popupwindowposition.yml | 1 + .../propertypanebuttontype.yml | 1 + .../propertypanedropdownoptiontype.yml | 1 + .../propertypanefieldtype.yml | 1 + .../basesearchquerymodifier.yml | 4 + .../sp-search-extensibility/iquery.yml | 3 + .../searchquerymodifiercontext.yml | 1 + .../searchqueryscenario.yml | 1 + SP-Framework/sp-webpart-base.yml | 15 + .../sp-webpart-base/baseclientsidewebpart.yml | 17 + SP-Framework/sp-webpart-base/basewebpart.yml | 24 + .../sp-webpart-base/basewebpartcontext.yml | 7 +- .../dynamicdatashareddepth.yml | 1 + .../iclientsidewebpartstatusrenderer.yml | 31 +- ...dynamicdatasharedpropertyconfiguration.yml | 1 + .../idynamicdatasharedpropertyfilters.yml | 1 + .../idynamicdatasharedsourceconfiguration.yml | 1 + .../idynamicdatasharedsourcefilters.yml | 1 + .../sp-webpart-base/imicrosoftteams.yml | 3 + .../sp-webpart-base/ipropertypaneaccessor.yml | 7 + .../ipropertypanebuttonprops.yml | 1 + .../ipropertypanecheckboxprops.yml | 1 + .../ipropertypanechoicegroupoption.yml | 1 + ...propertypanechoicegroupoptioniconprops.yml | 1 + .../ipropertypanechoicegroupprops.yml | 1 + .../ipropertypaneconditionalgroup.yml | 1 + .../ipropertypaneconfiguration.yml | 1 + .../ipropertypanecustomfieldprops.yml | 1 + .../ipropertypanedropdowncalloutprops.yml | 1 + .../ipropertypanedropdownoption.yml | 1 + .../ipropertypanedropdownprops.yml | 1 + .../ipropertypanedynamicfieldfilters.yml | 1 + .../ipropertypanedynamicfieldprops.yml | 1 + .../ipropertypanedynamicfieldsetprops.yml | 1 + .../ipropertypanedynamictextfieldprops.yml | 1 + .../sp-webpart-base/ipropertypanefield.yml | 1 + .../sp-webpart-base/ipropertypanegroup.yml | 1 + .../ipropertypanelabelprops.yml | 1 + .../ipropertypanelinkprops.yml | 1 + .../sp-webpart-base/ipropertypanepage.yml | 1 + .../ipropertypanepageheader.yml | 1 + .../ipropertypanesliderprops.yml | 1 + .../ipropertypanetextfieldprops.yml | 1 + .../ipropertypanetoggleprops.yml | 1 + SP-Framework/sp-webpart-base/isdks.yml | 2 + .../iserializedwebpartdata.yml | 6 + .../sp-webpart-base/iwebpartcontext.yml | 10 + SP-Framework/sp-webpart-base/iwebpartdata.yml | 10 + .../iwebpartpropertiesmetadata.yml | 1 + .../iwebpartpropertymetadata.yml | 2 + .../propertypanebuttontype.yml | 1 + .../propertypanedropdownoptiontype.yml | 1 + .../sp-webpart-base/propertypanefieldtype.yml | 1 + .../sp-webpart-base/webpartcontext.yml | 6 + .../sp-webpart-base/webpartformfactor.yml | 21 +- SP-Framework/toc.yml | 678 ++++++++++++++++++ 313 files changed, 3047 insertions(+), 28 deletions(-) create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml create mode 100644 SP-Framework/sp-listview-extensibility/icolumn.yml create mode 100644 SP-Framework/sp-listview-extensibility/ifilter.yml create mode 100644 SP-Framework/sp-listview-extensibility/ifolderinfo.yml create mode 100644 SP-Framework/sp-listview-extensibility/ilist.yml create mode 100644 SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml create mode 100644 SP-Framework/sp-listview-extensibility/irow.yml create mode 100644 SP-Framework/sp-listview-extensibility/iview.yml create mode 100644 SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml create mode 100644 SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml create mode 100644 SP-Framework/toc.yml diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 0cf44050..7aa0222c 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -13,6 +13,7 @@ functions: -->virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -40,6 +41,7 @@ functions: inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -60,6 +62,7 @@ functions: definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml index e7524b1b..8d507768 100644 --- a/SP-Framework/office-ui-fabric-react-bundle.yml +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -9,6 +9,7 @@ functions: package: '@microsoft/office-ui-fabric-react-bundle!' summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml index af73e8aa..798dce3e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base.yml +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -17,7 +17,9 @@ classes: interfaces: - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' @@ -32,11 +34,13 @@ interfaces: - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index d45a86fe..05dff4e9 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -7,6 +7,7 @@ summary: Adaptive Card Extension context object. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AdaptiveCardExtensionContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ properties: fullName: deviceContext summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: manifest summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: propertyPane summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index bf9ec28f..abaed17e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardExtension summary: Base class for Adaptive Card Extensions. remarks: Adaptive Card Extensions must inherit from this class. +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ constructors: fullName: (constructor)() summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -26,6 +28,7 @@ properties: fullName: _iconProperty summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -38,6 +41,7 @@ properties: fullName: _title summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -50,6 +54,7 @@ properties: fullName: cardNavigator summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -64,6 +69,7 @@ properties: fullName: cardSize summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -76,6 +82,7 @@ properties: fullName: context summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +97,7 @@ properties: The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to manage versioning of the Adaptive Card Extension. remarks: The default version is 1.0. + example: [] isPreview: false isDeprecated: false syntax: @@ -102,6 +110,7 @@ properties: fullName: description summary: The description of the Adaptive Card Extension defined in the manifest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -114,6 +123,7 @@ properties: fullName: displayMode summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -126,6 +136,7 @@ properties: fullName: iconProperty summary: The icon url used to render an icon on the Card view. remarks: 'By default, this will return the iconImageUrl defined in the manifest.' + example: [] isPreview: false isDeprecated: false syntax: @@ -142,6 +153,7 @@ properties: remarks: >- This method should be called after a card view has been registered. Otherwise visibility change will not be applied to the Adaptive Card. + example: [] isPreview: false isDeprecated: false syntax: @@ -151,12 +163,33 @@ properties: set isVisible(value: boolean); return: type: boolean + - name: navigator + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: navigator + summary: 'The current [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class).' + remarks: >- + If the current + [BaseAdaptiveCardExtension.renderType](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23renderType:member) + is `QuickView` then returns + [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'get navigator(): ViewNavigator>;' + return: + type: >- + <<TProperties, TState>> - name: properties uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: properties summary: 'The custom, persisted properties of the Adaptive Card Extension.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -174,6 +207,7 @@ properties: See [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) for more information about how to define metadata. + example: [] isPreview: false isDeprecated: false syntax: @@ -192,6 +226,7 @@ properties: [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -208,6 +243,7 @@ properties: Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default state. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -220,6 +256,7 @@ properties: fullName: renderedOnce summary: Indicates whether the Adaptive Card Extension has initially rendered. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -232,6 +269,7 @@ properties: fullName: renderType summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -247,6 +285,7 @@ properties: If this property is not initialized, [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) cannot be called. + example: [] isPreview: false isDeprecated: false syntax: @@ -264,6 +303,7 @@ properties: This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also displayed as the Property Pane title. remarks: 'By default, this will return the title defined in the manifest.' + example: [] isPreview: false isDeprecated: false syntax: @@ -279,6 +319,7 @@ methods: fullName: getCachedState(state) summary: This virtual method returns a subset of the state object that will be cached by the client. remarks: 'If not overriden, this will return an empty object.' + example: [] isPreview: true isDeprecated: false syntax: @@ -298,6 +339,7 @@ methods: fullName: getCacheSettings() summary: Override the default cache settings. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -318,6 +360,7 @@ methods: Property Pane resources can be defer loaded to reduce bundle size. See [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). + example: [] isPreview: false isDeprecated: false syntax: @@ -335,6 +378,7 @@ methods: remarks: >- No Property Pane events will be raised until this method resolves except for `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. + example: [] isPreview: false isDeprecated: false syntax: @@ -359,6 +403,7 @@ methods: was serialized by an older version of the Adaptive Card Extension that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. + example: [] isPreview: false isDeprecated: false syntax: @@ -389,6 +434,7 @@ methods: Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than the property pane (except for isolated Adaptive Card Extensions). remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' + example: [] isPreview: false isDeprecated: false syntax: @@ -408,6 +454,7 @@ methods: fullName: onBeforeSerialize() summary: Lifecycle method called before serialization. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -423,6 +470,7 @@ methods: fullName: onDisplayModeChanged(oldDisplayMode) summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -442,6 +490,7 @@ methods: fullName: onDispose() summary: Lifecycle method called before disposing the Adaptive Card Extension. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -459,6 +508,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. + example: [] isPreview: false isDeprecated: false syntax: @@ -476,6 +526,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. + example: [] isPreview: true isDeprecated: false syntax: @@ -499,6 +550,7 @@ methods: fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' summary: Lifecycle method called when a Property Pane field is changed. remarks: This is invoked for reactive Property Panes. + example: [] isPreview: false isDeprecated: false syntax: @@ -529,6 +581,7 @@ methods: Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) changes. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -548,6 +601,7 @@ methods: fullName: renderCard() summary: The id of the initial Card view. remarks: 'By default, this returns undefined and will render a default Card view.' + example: [] isPreview: false isDeprecated: false syntax: @@ -567,6 +621,7 @@ methods: must have been initialized before calling [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml index 7b9cc052..6d23abe3 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardView summary: Base class for an Adaptive Card view. remarks: Views used to render the Quick view must inherit from this class. +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ properties: fullName: data summary: The data used to render the Adaptive Card. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: externalLink summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +46,7 @@ properties: fullName: template summary: The Adaptive Card template rendered by the view. remarks: The format of the template must be valid Adaptive Card JSON. + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: remarks: >- If not overriden, the title displayed will be [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index a1b7a570..c8653ee6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -7,6 +7,7 @@ summary: Base class for a Basic Card view. remarks: >- The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the `Medium` Card size, two buttons in the `Large` Card size +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index 81c7a6b2..cb3ae69d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -8,6 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party Card views should inherit from this class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ properties: remarks: >- Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the documentation for the respective base Card View class for specific details. + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +41,7 @@ properties: remarks: >- The available data to display is dependent on the Card view template and its respective base Card view class. See the documentation for the Card View class for specific details. + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +54,7 @@ properties: fullName: isCacheEnabled summary: 'If true, this Card view will be cached and rendered at next load.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +69,7 @@ properties: fullName: onCardSelection summary: Action to invoke when the card is selected. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index c9318dd8..2d1740b0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -7,6 +7,7 @@ summary: Base class for an Image Card view. remarks: >- The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml index 7c226713..c1781b0f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -7,6 +7,7 @@ summary: Base class for a Primary Text Card view. remarks: >- The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: Returns the Adaptive Card template for the [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml index 6ce8de39..58bd6408 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -8,6 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party views should inherit from this class. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ properties: [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -38,6 +40,7 @@ properties: [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +56,7 @@ properties: [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +69,7 @@ properties: fullName: data summary: The data used to render the View. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -80,6 +85,7 @@ properties: [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -95,6 +101,7 @@ properties: [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -112,6 +119,7 @@ properties: [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -124,6 +132,7 @@ properties: fullName: template summary: The Adaptive Card template used to render the view. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -137,6 +146,7 @@ methods: fullName: onAction(action) summary: Action handler for Adaptive Card Actions. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -150,6 +160,26 @@ methods: return: type: void description: '' + - name: onActionError(error) + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onActionError:member(1)' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: onActionError(error) + summary: Error handler for Adaptive Card Actions. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'onActionError(error: IActionErrorArguments): void;' + parameters: + - id: error + description: >- + The [IActionErrorArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type) for + the current event. + type: '' + return: + type: void + description: '' - name: setState(newState) uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -159,6 +189,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -179,6 +210,7 @@ methods: [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml index fb719bce..67bd2069 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -7,6 +7,7 @@ summary: >- This structure is used to define metadata for Adaptive Card Extension properties as a map of string to `IAdaptiveCardExtensionPropertiesMetadata` remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index 23ad28a1..88bf5c21 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAdaptiveCardExtensionPropertyMetadata summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml new file mode 100644 index 00000000..6be15035 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: IAttachmentError +uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IAttachmentError +summary: This object represents error associated with a single attachment +remarks: API under active development and not ready for use. +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: errorCode + uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError#errorCode:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: errorCode + summary: Error code associated with a particular attachment + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'errorCode: ''FileTooLarge'' | ''IncorrectFileFormat'';' + return: + type: '''FileTooLarge'' | ''IncorrectFileFormat''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml index 7ae0dd3a..143a9b10 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -10,6 +10,7 @@ summary: >- remarks: >- Only `Submit` and `ShowCard` actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. +example: [] isPreview: false isDeprecated: false type: interface @@ -20,6 +21,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml new file mode 100644 index 00000000..b1f8beaa --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: IBaseActionErrorArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IBaseActionErrorArguments +summary: >- + Base object passed to + [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an + Adaptive Card OnActionError is executed. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: error + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#error:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: error + summary: The error thrown by the action + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'error: IActionError;' + return: + type: '' + - name: id + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#id:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: id + summary: The id specified in the Adaptive Card template + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action thsat caused the error. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''Submit'' | ''ShowCard'' | ''VivaAction.SelectMedia'' | ''VivaAction.GetLocation'' | ''VivaAction.ShowLocation'';' + return: + type: '''Submit'' | ''ShowCard'' | ''VivaAction.SelectMedia'' | ''VivaAction.GetLocation'' | ''VivaAction.ShowLocation''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml index a8303c4b..df28b94e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IBaseCardParameters summary: The primitive data parameters for every Card view. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: iconAltText summary: The icon alt text. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: iconProperty summary: The icon to display. remarks: The value is a URL to an icon. + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: title summary: The title to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index f8ad9c06..e1a132c1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -7,6 +7,7 @@ summary: >- The data parameters for [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml index 1157614a..f0c24e98 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICachedLoadParameters summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: cardNavigatorState summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: state summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml index 15aa62e7..4df2f958 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICacheSettings summary: '' remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: Returns the Card View used to generate the cached card. By default, the currently rendered Card View will be used to cache the card. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: expiryTimeInSeconds summary: 'Expiry time in seconds. Default: 86400 seconds (24 hours)' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: isEnabled summary: 'Whether cache is enabled. Default: true' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 5596f0b0..2d8d904a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardButton summary: A button to display on a Card View. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: action summary: The type of the button. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: id summary: Unique Id of the button. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: style summary: Controls the style of the button. remarks: The destructive Action style is not supported in Card views + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: title summary: Text displayed on the button. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml index cf9b9090..7f5a449c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IConfirmationDialog summary: Confirmation Dialog option that is passed through `Submit` Action is executed. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: message summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: title summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index 0f1f201d..ddfb6f81 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkCardAction summary: Open an external link. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters for the external link. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this is an external link button. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml index 04d96bbd..e238f58a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkParameters summary: Parameters for opening an external link. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: isTeamsDeepLink summary: Indicates whether this is a Teams Deep Link. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: target summary: The URL of the link. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index 42d12b2e..d173d02b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -5,7 +5,8 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationAction summary: Interface for Viva Get Location action remarks: API under active development and not ready for use. -isPreview: true +example: [] +isPreview: false isDeprecated: false type: interface properties: @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 4bc7f9a9..d8269fe0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -8,7 +8,8 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get location Action is executed. remarks: API under active development and not ready for use. -isPreview: true +example: [] +isPreview: false isDeprecated: false type: interface properties: @@ -18,6 +19,7 @@ properties: fullName: location summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index 05bf3cff..0902ab85 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationActionParameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: chooseLocationOnMap summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index 268dc783..409dfb0d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationCardAction summary: Invoke an `VivaAction.GetLocation` event. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index 35e892a9..66c89e57 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -7,6 +7,7 @@ summary: >- The data parameters for [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: imageUrl summary: The image URL to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index 642f99f1..297edeb3 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocation summary: Interface for location coordinates remarks: API under active development and is not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: accuracy summary: Accuracy of the location. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: latitude summary: Latitude of the location. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: longitude summary: Longitude of the location. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: timestamp summary: Timestamp remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml new file mode 100644 index 00000000..abe6553c --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -0,0 +1,45 @@ +### YamlMime:TSType +name: ILocationErrorArguments +uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ILocationErrorArguments +summary: This object represents the error data that the Location action can throw. +remarks: API under active development and not ready for use. +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: error + uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#error:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: error + summary: Error codes specific to the Get Location Error + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: |- + error: { + code: 'InternalError' | 'PermissionDenied'; + }; + return: + type: |- + { + code: 'InternalError' | 'PermissionDenied'; + } + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: Indicates this is a Viva Select Location button. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: '''VivaAction.GetLocation''' +extends: 'Omit<, ''type''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml index 4a2622ac..8b1957b2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -7,6 +7,7 @@ summary: >- The data parameters for [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: description summary: The description to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index 2fd4f260..b024b3f8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewCardAction summary: Open the quick view. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters for the quick view opened by this action remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this action opens the quick view. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml index a29f4714..0b4a1ba2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewParameters summary: Parameters for opening a Quick view. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: view summary: The view of the Quick view to open. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index eba92be6..73c146ad 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -5,7 +5,8 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAction summary: Interface for new Viva Select Media action remarks: API under active development and not ready for use. -isPreview: true +example: [] +isPreview: false isDeprecated: false type: interface properties: @@ -13,8 +14,9 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: parameters - summary: '' + summary: Parameters that can be provided to the ISelectMedia Action remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -25,8 +27,9 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: type - summary: '' + summary: Indicates this is a Viva Select Location button. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index 470a58d2..f86fc1eb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -8,7 +8,8 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `SelectMedia` Action is executed. remarks: API under active development and not ready for use. -isPreview: true +example: [] +isPreview: false isDeprecated: false type: interface properties: @@ -18,6 +19,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml new file mode 100644 index 00000000..61f576e1 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: ISelectMediaActionErrorArguments +uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ISelectMediaActionErrorArguments +summary: This object represents the data returned by the native media picker API. +remarks: API under active development and not ready for use. +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: error + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#error:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: error + summary: Error codes specific to the Select Media Action. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: |- + error: { + code: 'FileSelectionFailed' | 'FilesSelectedAreIncompatible'; + }; + return: + type: |- + { + code: 'FileSelectionFailed' | 'FilesSelectedAreIncompatible'; + } + - name: media + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#media:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: media + summary: media object returned media picker API + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'media: ISelectMediaAttachment[] | undefined;' + return: + type: '[] | undefined' + - name: type + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#type:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: type + summary: The type of Adaptive Card Action. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: '''VivaAction.SelectMedia''' +extends: 'Omit<, ''type''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml index 8e9e3425..758f97ce 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionParameters summary: Parameters that can be supplied with the Viva Select Media Action. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: allowMultipleCapture summary: Allow multiple images to be selected. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: maxSizePerFile summary: Max file size that can be uploaded. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: mediaType summary: Specify the specific media type that should be selected remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: supportedFileFormats summary: File formats supported for upload. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index b3b08ca4..a9d3b142 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAttachment summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,18 +16,33 @@ properties: fullName: content summary: Content of the file represented as base64Strings remarks: '' + example: [] isPreview: true isDeprecated: false syntax: content: 'content: string;' return: type: string + - name: error + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#error:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: error + summary: Error associated with attachment + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'error?: IAttachmentError;' + return: + type: '' - name: fileName uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: fileName summary: The names of the selected files. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 993e8c19..017fca6d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaCardAction summary: Invoke an `VivaAction.SelectMedia` event. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters for the Select Media Action remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Media button. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index c48d8a7e..35272400 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -8,6 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` Action is executed. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index da0babab..5151f5cf 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -5,7 +5,8 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationAction summary: Interface for Viva Show Location action remarks: API under active development and not ready for use. -isPreview: true +example: [] +isPreview: false isDeprecated: false type: interface properties: @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index b3143ebf..5ab04acc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationActionParameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: locationCoordinates summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 7e8037ee..8cf3186e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationCardAction summary: Invoke an `VivaAction.ShowLocation` event. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index 1d00bfab..d0096adb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -5,7 +5,29 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISPFxAdaptiveCard summary: SPFx Adaptive Card Extension schema for Adaptive Cards. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface -extends: '' +properties: + - name: actions + uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard#actions:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: actions + summary: Types of actions being exposed + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: >- + actions?: (ISubmitAction | IOpenUrlAction | IShowCardAction | ISelectMediaAction | IGetLocationAction | + IShowLocationAction)[]; + return: + type: >- + ( | + | | | | )[] +extends: 'Omit<, ''actions''> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index 6e612e74..2c6b58f9 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -8,6 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` Action is executed. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: fullName: data summary: The data object defined in the Adaptive Card template remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index 23b53f58..70c67960 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardAction summary: Invoke an `Action.Submit` event. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: confirmationDialog summary: Confirmation dialog option passed to the submit handler. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: parameters summary: Parameters passed to the Submit event handler. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: type summary: Indicates this is a Submit button. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml index 4e4fa3fd..3c9c622a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardParameters summary: Parameters for submit card action. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml index e74899c5..8b1a7ec5 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: MediaType summary: Enum value to specify the type of media. remarks: API under active development and not ready for use. +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index 67561c3e..672f6c29 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -10,6 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `QuickViewNavigator` class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ methods: fullName: close() summary: Closes the View. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index 5ff4b9e1..ff4fd497 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ViewNavigator summary: Manages a stack of views. remarks: The top of the stack represents the currently rendered view. +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ constructors: fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' summary: Constructs a new instance of the `ViewNavigator` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: currentId summary: Get the id of the currently rendered View from the top of the View stack remarks: 'If the stack is empty, this will return undefined' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: size summary: Current size of the View stack. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +69,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -87,6 +92,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -107,6 +113,7 @@ methods: fullName: 'register(id, initializer)' summary: Registers a new view. remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' + example: [] isPreview: false isDeprecated: false syntax: @@ -132,6 +139,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 9e791818..3b12e5c0 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -14,6 +14,7 @@ remarks: >- The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications. +example: [] isPreview: false isDeprecated: false type: class @@ -30,6 +31,7 @@ constructors: context, for example [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +49,7 @@ events: remarks: >- This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has navigated to a new page. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 1ff85dd9..42efb081 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: application summary: Provides access to the client-side application that is currently running. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: fullName: placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -44,6 +47,7 @@ methods: fullName: dispose() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index ca4833ba..da70bb21 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -12,6 +12,7 @@ remarks: >- Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. +example: [] isPreview: false isDeprecated: false type: class @@ -22,6 +23,7 @@ properties: fullName: context summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -37,6 +39,7 @@ methods: remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the method. + example: [] isPreview: false isDeprecated: false syntax: @@ -52,6 +55,7 @@ methods: This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index d88f6295..2222f824 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -8,6 +8,7 @@ summary: >- [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) method. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -21,6 +22,7 @@ properties: To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 6025529a..83af8427 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -12,6 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderContent` class. +example: [] isPreview: false isDeprecated: false type: class @@ -25,6 +26,7 @@ properties: If the caller needs to be notified when the DOM element is disposed, use the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback. + example: [] isPreview: false isDeprecated: false syntax: @@ -37,6 +39,7 @@ properties: fullName: isDisposed summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +54,7 @@ properties: Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +67,7 @@ properties: fullName: name summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' + example: [] isPreview: false isDeprecated: false syntax: @@ -80,6 +85,7 @@ methods: application when the containing placeholder is disposed. Calling dispose() invokes the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index ee717eea..e4bf15c7 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- For more information about placeholders, see [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 5a1fdcdc..cd43c1ad 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -23,6 +23,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderProvider` class. +example: [] isPreview: false isDeprecated: false type: class @@ -33,6 +34,7 @@ properties: fullName: isDisposed summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +47,7 @@ properties: fullName: placeholderNames summary: Returns the names of the currently available placeholders. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +61,7 @@ methods: fullName: dispose() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -76,6 +80,7 @@ methods: The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. + example: [] isPreview: false isDeprecated: false syntax: @@ -102,6 +107,7 @@ events: The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 931169b1..98ddabcf 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -7,6 +7,7 @@ summary: The base class for client-side components such as BaseClientSideWebPart remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponent` class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ properties: Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value. + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: false isDeprecated: false syntax: @@ -50,6 +53,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. + example: [] isPreview: false isDeprecated: false syntax: @@ -62,6 +66,7 @@ properties: fullName: isDisposed summary: Returns true if the component has been already disposed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -74,6 +79,7 @@ properties: fullName: manifest summary: Provides access to the manifest for the client-side component. virtual remarks: Child classes can override this with more specialized manifest types. + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +96,7 @@ methods: Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. + example: [] isPreview: false isDeprecated: false syntax: @@ -105,6 +112,7 @@ methods: This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 3be978b2..70d9865c 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -12,6 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponentContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -22,6 +23,7 @@ properties: fullName: aadHttpClientFactory summary: The instance of AadHttpClientFactory created for this instance of component remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -34,6 +36,7 @@ properties: fullName: aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -46,6 +49,7 @@ properties: fullName: dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +62,7 @@ properties: fullName: dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -70,6 +75,7 @@ properties: fullName: httpClient summary: The instance of HttpClient created for this instance of component remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -85,6 +91,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. + example: [] isPreview: false isDeprecated: false syntax: @@ -97,6 +104,7 @@ properties: fullName: isDisposed summary: Returns true if the context is disposed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -109,6 +117,7 @@ properties: fullName: isServedFromLocalhost summary: Returns true if the solution is being served from localhost remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -121,6 +130,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -133,6 +143,7 @@ properties: fullName: msGraphClientFactory summary: The instance of MSGraphClientFactory created for this instance of component remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -147,6 +158,7 @@ properties: The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -159,6 +171,7 @@ properties: fullName: serviceScope summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. + example: [] isPreview: false isDeprecated: false syntax: @@ -171,6 +184,7 @@ properties: fullName: spHttpClient summary: The instance of SpHttpClient created for this instance of component remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -184,6 +198,7 @@ methods: fullName: dispose() summary: Disposes the base component context. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index e71293e0..d2a74da9 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -7,6 +7,7 @@ summary: >- The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ properties: fullName: isDisposed summary: Returns true if the Dynamic Data Provider is disposed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ methods: fullName: dispose() summary: Disposes the Dynamic Data Provider. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +46,7 @@ methods: fullName: getAvailableSources() summary: Returns a list with all available Dynamic Data Sources. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -56,6 +60,7 @@ methods: fullName: registerAvailableSourcesChanged(callback) summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -73,6 +78,7 @@ methods: fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' summary: Registers a callback for updates when a property is changed in a Dynamic Data source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -98,6 +104,7 @@ methods: Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -118,6 +125,7 @@ methods: fullName: tryGetSource(id) summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -135,6 +143,7 @@ methods: fullName: unregisterAvailableSourcesChanged(callback) summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -152,6 +161,7 @@ methods: fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -175,6 +185,7 @@ methods: fullName: 'unregisterSourceChanged(sourceId, callback)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 24f4b636..fda94fd6 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -8,6 +8,7 @@ summary: >- of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ properties: fullName: isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ properties: Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +48,7 @@ methods: fullName: dispose() summary: Disposes the resources held by the Dynamic Data source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +62,7 @@ methods: fullName: initializeSource(callableFunctions) summary: Initializes the Dynamic Data Source for the component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -80,6 +85,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -102,6 +108,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -117,6 +124,7 @@ methods: Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 06a12a5e..7333568c 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -8,6 +8,7 @@ remarks: >- This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically. +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ constructors: fullName: '(constructor)(provider, callback)' summary: Create a new DynamicProperty object. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -38,6 +40,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' + example: [] isPreview: false isDeprecated: false syntax: @@ -52,6 +55,7 @@ properties: DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +69,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' + example: [] isPreview: false isDeprecated: false syntax: @@ -78,6 +83,7 @@ methods: fullName: hasDefaultCallback() summary: Returns true if the object has a default callback. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +97,7 @@ methods: fullName: register(callback) summary: Registers a callback function for updates on the associated DynamicDataSource. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -108,6 +115,7 @@ methods: fullName: removeDefaultCallback() summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. + example: [] isPreview: false isDeprecated: false syntax: @@ -123,6 +131,7 @@ methods: Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -140,6 +149,7 @@ methods: fullName: setValue(value) summary: Sets a static value in the DynamicProperty. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -159,6 +169,7 @@ methods: Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -178,6 +189,7 @@ methods: NOTE: This api will never return an array. To retrieve an array value, use the [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. + example: [] isPreview: false isDeprecated: false syntax: @@ -198,6 +210,7 @@ methods: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. + example: [] isPreview: false isDeprecated: false syntax: @@ -213,6 +226,7 @@ methods: Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml index 5b401199..cdec3d93 100644 --- a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IComponentPropertyMetadata summary: This is the structure used for map values for component properties metadata. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -34,6 +35,7 @@ properties: Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. + example: [] isPreview: false isDeprecated: false syntax: @@ -48,6 +50,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -62,6 +65,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -81,6 +85,7 @@ properties: Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. + example: [] isPreview: false isDeprecated: false syntax: @@ -103,6 +108,7 @@ properties: Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 54f8b747..42894413 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyFontStyles summary: '' remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 8bb99cbd..82d6865d 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyTheme summary: Immutable ITheme. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml index 357da434..fe67d541 100644 --- a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ISerializedServerProcessedData summary: Contains collections of data that can be processed by server side services like search index and link fixup remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -30,6 +31,7 @@ properties: } ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +60,7 @@ properties: 'myImage2': 'https://res.contoso.com/someName.jpg' } ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -86,6 +89,7 @@ properties: 'myFileLink': 'https://res.contoso.com/file.docx' } ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -119,6 +123,7 @@ properties: } ``` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index d425f70d..e6ebbf1c 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ITheme summary: 'Collection of theme values, which can be used to programatically style components.' remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index d8f2a030..f492c2e0 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ThemeChangedEventArgs summary: The object passed when the IThemeProvider.themeChangedEvent is raised. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ properties: fullName: theme summary: 'The new theme. If the value is undefined, then the theme was cleared.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index 225f13bd..e4b2dccf 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -7,6 +7,7 @@ summary: >- The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ constructors: fullName: '(constructor)(serviceScope, theme)' summary: Construct a new instance of the ThemeProvider class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: serviceKey summary: The service key for ThemeProvider. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -50,6 +53,7 @@ methods: fullName: tryGetTheme() summary: 'If set, get the current scoped theme.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -64,6 +68,7 @@ events: fullName: themeChangedEvent summary: Raised when the theme changes with the new theme as an argument. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 40dbb5cd..4a3bdea5 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: DisplayMode summary: Indicates whether a visual control should display itself for reading or for editing. remarks: '' +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index 63f3feaf..5f63daa7 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Environment summary: Information about the system environment where the SharePoint Framework is running. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ properties: fullName: type summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 080248b9..d0c0f3e9 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -7,6 +7,7 @@ summary: Indicates the general type of environment where the SharePoint Framewor remarks: >- This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It provides a way to distinguish environments where certain functionality may be limited or disabled. +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 1186619d..a6d81f68 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -11,6 +11,7 @@ remarks: >- See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ properties: fullName: empty summary: Returns a new empty Guid instance. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -34,6 +36,7 @@ methods: fullName: equals(guid) summary: Compare this instance to another Guid instance remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +56,7 @@ methods: Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -72,6 +76,7 @@ methods: Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -98,6 +103,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` + example: [] isPreview: false isDeprecated: false syntax: @@ -115,6 +121,7 @@ methods: fullName: toString() summary: Returns a string representation of the GUID remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -142,6 +149,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 2fd58909..d9ccbd42 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IDisposable summary: Implemented by an object that supports a disposal lifecycle. remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index efc147ed..93916995 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -12,6 +12,7 @@ remarks: >- default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable. +example: [] isPreview: false isDeprecated: false type: interface @@ -22,6 +23,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index dd5a803e..d0f81a16 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IServiceCollection summary: A shorthand pattern for extracting well-known services from a ServiceScope. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -18,6 +19,7 @@ properties: fullName: serviceScope summary: Returns the underlying ServiceScope that the members belong to. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index a6b3b32e..465c9b32 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -11,6 +11,7 @@ remarks: >- SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements. +example: [] isPreview: false isDeprecated: false type: interface @@ -21,6 +22,7 @@ properties: fullName: componentId summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + example: [] isPreview: false isDeprecated: false syntax: @@ -33,6 +35,7 @@ properties: fullName: instanceId summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 993757e7..2f0f6c0d 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -9,6 +9,7 @@ remarks: >- [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. +example: [] isPreview: false isDeprecated: false type: interface @@ -19,6 +20,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index b0306811..a08a630d 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -8,6 +8,7 @@ remarks: >- The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ methods: fullName: 'error(source, error, scope)' summary: Logs an error. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +47,7 @@ methods: fullName: 'info(source, message, scope)' summary: Logs a general informational message. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -72,6 +75,7 @@ methods: fullName: 'verbose(source, message, scope)' summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -99,6 +103,7 @@ methods: fullName: 'warn(source, message, scope)' summary: Logs a warning. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 5ca03bb7..f11546a5 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -8,6 +8,7 @@ summary: >- [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls Math.random(). remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `RandomNumberGenerator` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -33,6 +35,7 @@ properties: fullName: serviceKey summary: The service key for IRandomNumberGenerator. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -48,6 +51,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 97a082eb..409b6de2 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -11,6 +11,7 @@ remarks: >- root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ properties: fullName: defaultCreator summary: A callback function that constructs the default instance of this service. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +45,7 @@ properties: was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes. + example: [] isPreview: false isDeprecated: false syntax: @@ -61,6 +64,7 @@ properties: The system does not assume that this string is unique. Instead, the [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. + example: [] isPreview: false isDeprecated: false syntax: @@ -78,6 +82,7 @@ methods: remarks: >- If you want to specify custom constructor parameters, use [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. + example: [] isPreview: false isDeprecated: false syntax: @@ -104,6 +109,7 @@ methods: fullName: 'createCustom(name, defaultCreator)' summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 726a7761..09fa004d 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -43,6 +43,7 @@ remarks: >- worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished(). +example: [] isPreview: false isDeprecated: false type: class @@ -53,6 +54,7 @@ constructors: fullName: (constructor)(parent) summary: Constructs a new instance of the `ServiceScope` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -71,6 +73,7 @@ methods: Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +93,7 @@ methods: This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -118,6 +122,7 @@ methods: This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -144,6 +149,7 @@ methods: inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. + example: [] isPreview: false isDeprecated: false syntax: @@ -157,6 +163,7 @@ methods: fullName: getParent() summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -172,6 +179,7 @@ methods: remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. + example: [] isPreview: false isDeprecated: false syntax: @@ -194,6 +202,7 @@ methods: remarks: >- The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. + example: [] isPreview: false isDeprecated: false syntax: @@ -209,6 +218,7 @@ methods: Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -233,6 +243,7 @@ methods: NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index b5a426e2..284ab208 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Session summary: Provides access to the application's browser session and active page. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ properties: and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions. + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ properties: fullName: clientSideApplicationId summary: The id of the currently running application remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -57,6 +60,7 @@ properties: The concept of a page is subjective and defined by the router for a particular application. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index bfadd94c..d7aa82d2 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -22,6 +22,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPEvent` class. +example: [] isPreview: false isDeprecated: false type: class @@ -35,6 +36,7 @@ methods: The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +60,7 @@ methods: fullName: 'remove(observer, eventHandler)' summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index e131601d..0c0d6c54 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: SPEventArgs summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' +example: [] isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 5e658b1b..2eaf1dee 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Text_2 summary: Operations for working with strings that contain text. remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' +example: [] isPreview: false isDeprecated: false type: class @@ -24,6 +25,7 @@ methods: `Text.format("hello {0}!", "world")` will return `"hello world!"` + example: [] isPreview: false isDeprecated: false syntax: @@ -44,6 +46,7 @@ methods: fullName: 'replaceAll(input, searchValue, replaceValue)' summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 0148511b..6dd98724 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -7,6 +7,7 @@ summary: >- This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that simply calls the real browser APIs. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `TimeProvider` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ properties: fullName: serviceKey summary: The service key for ITimeProvider. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -60,6 +64,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 7800652a..76e091aa 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -16,6 +16,7 @@ remarks: >- Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. @@ -27,6 +28,7 @@ constructors: fullName: (constructor)(url) summary: Constructs a new instance of the `UrlQueryParameterCollection` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +55,7 @@ methods: getValue('debug') ---> 'false' getValue('lost') ---> undefined ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -81,6 +84,7 @@ methods: getValues('debug') ---> ['false'] getValues('lost') ---> undefined ``` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 73257d11..643ac440 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -8,6 +8,7 @@ remarks: >- This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance. +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ methods: fullName: 'isNonemptyString(value, variableName)' summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -38,6 +40,7 @@ methods: fullName: 'isNotDisposed(value, className)' summary: Throws an exception if the specified object has been disposed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +61,7 @@ methods: fullName: 'isNotNullOrUndefined(value, variableName)' summary: Throws an exception if the specified value is null or undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -78,6 +82,7 @@ methods: fullName: 'isTrue(value, variableName)' summary: Throws an exception if the specified value is not true. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 5767b32d..54955dc2 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -11,6 +11,7 @@ remarks: >- Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ properties: fullName: major summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: remarks: >- Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases. + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +52,7 @@ properties: remarks: >- Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the "build" number. + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +67,7 @@ properties: remarks: >- This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers. + example: [] isPreview: false isDeprecated: false syntax: @@ -76,6 +81,7 @@ methods: fullName: 'compare(v1, v2)' summary: Compares two Version objects to determine which version is newer. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -106,6 +112,7 @@ methods: 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -130,6 +137,7 @@ methods: 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -147,6 +155,7 @@ methods: fullName: isValid(versionString) summary: Test whether a string is a valid version specifier. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -172,6 +181,7 @@ methods: 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -189,6 +199,7 @@ methods: fullName: parse(versionString) summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -226,6 +237,7 @@ methods: 1.0.0 satisfies 1.1.0 -> false ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -245,6 +257,7 @@ methods: remarks: >- The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged. + example: [] isPreview: false isDeprecated: false syntax: @@ -260,6 +273,7 @@ methods: Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 072ea4fc..e5897c2c 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -12,6 +12,7 @@ remarks: >- controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class. +example: [] isPreview: false isDeprecated: false type: class @@ -46,6 +47,7 @@ constructors: // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() } ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +65,7 @@ properties: remarks: >- See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on rendering. + example: [] isPreview: false isDeprecated: false syntax: @@ -77,6 +80,7 @@ properties: remarks: >- This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +95,7 @@ properties: If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -103,6 +108,7 @@ properties: fullName: isSecondary summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -120,6 +126,7 @@ properties: Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. + example: [] isPreview: false isDeprecated: false syntax: @@ -135,6 +142,7 @@ methods: remarks: >- This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. + example: [] isPreview: false isDeprecated: false syntax: @@ -152,6 +160,7 @@ methods: the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. + example: [] isPreview: false isDeprecated: false syntax: @@ -167,6 +176,7 @@ methods: This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. virtual remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. + example: [] isPreview: false isDeprecated: false syntax: @@ -193,6 +203,7 @@ methods: you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. + example: [] isPreview: false isDeprecated: false syntax: @@ -206,6 +217,7 @@ methods: fullName: show(options) summary: Request the framework to show this dialog. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index d632447d..a9ca2e75 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: Dialog summary: A static class for showing stock dialogs such as an alert or prompt. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +47,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index 2b172728..a714c2a7 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IAlertOptions summary: Options for showing an alert dialog remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 06c362f8..1a4913ce 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogConfiguration summary: The interface for dialog configuration remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: isBlocking summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 572bff4a..60ebd707 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogShowOptions summary: Options for showing a dialog remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -20,6 +21,7 @@ properties: requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index f8c1dcae..8fad9614 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IPromptOptions summary: Options for showing a prompt dialog remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: defaultValue summary: The default value for the input text field of prompt dialog remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index a2258f65..277c1112 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -15,6 +15,7 @@ remarks: >- See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for how to use this. +example: [] isPreview: false isDeprecated: false type: interface @@ -27,6 +28,7 @@ methods: Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +53,7 @@ methods: Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -76,6 +79,7 @@ methods: is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index 8486625f..aaa803e4 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -10,6 +10,7 @@ remarks: |- The reference string is of the form `:` or `::` Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ constructors: fullName: (constructor)(reference) summary: Constructs a new instance of the `DynamicDataReference` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: property summary: Returns the referred property of the Dynamic Data. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: propertyPath summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: fullName: reference summary: Returns the full reference of the Dynamic Data object as a string. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -71,6 +76,7 @@ properties: fullName: sourceId summary: Returns the referred id of the Dynamic Data Source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index b0e70cbb..00df95c9 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -7,6 +7,7 @@ summary: >- Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: sampleValue summary: Sample value of a property remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 39adbf0b..82c2f04d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -7,6 +7,7 @@ summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -22,6 +23,7 @@ methods: If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -37,6 +39,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -54,6 +57,7 @@ methods: fullName: getPropertyDefinitions() summary: Returns all the property definitions that the DataSource will provide. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +71,7 @@ methods: fullName: getPropertyValue(propertyId) summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' + example: [] isPreview: false isDeprecated: false syntax: @@ -89,6 +94,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 7208490d..cb99692e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -8,6 +8,7 @@ summary: |- It includes the name of the event and description to be seen and used by end users. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the event.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: name summary: Event name remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 3c7a374b..2f979708 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -7,6 +7,7 @@ summary: >- Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index 0566203f..865b79fc 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyMetadata summary: Metadata of a property remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index df35e22f..cec346ee 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyValueMetadata summary: Metadata describing the sample value of the property. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index ef701e5f..ad72cc5e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -74,6 +74,7 @@ remarks: >- } } ``` +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index d4146af1..36f0d714 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -7,6 +7,7 @@ summary: >- Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: id summary: Id of the Dynamic Data Source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: metadata summary: Metadata of the Dynamic Data Source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ methods: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -64,6 +68,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' @@ -84,6 +89,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -103,6 +109,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' @@ -119,6 +126,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -136,6 +144,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' @@ -156,6 +165,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -178,6 +188,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 2ec749b1..046d071c 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataSourceMetadata summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +46,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the Dynamic Data Source.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +62,7 @@ properties: example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -72,6 +77,7 @@ properties: User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index ac1a3264..982619f7 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -7,6 +7,7 @@ summary: The base class for all client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseExtension` class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization. + example: [] isPreview: false isDeprecated: false syntax: @@ -48,6 +51,7 @@ methods: fullName: onInit() summary: This event method is called when the client-side extension is first activated on the page. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 9af3d712..be76c4b0 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -7,6 +7,7 @@ summary: The base class for context objects for client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtensionContext` class. +example: [] isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 5c799ded..642b915d 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -10,6 +10,7 @@ remarks: >- For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ constructors: fullName: '(constructor)(serviceScope, resourceEndpoint, options)' summary: Constructs a new instance of the `AadHttpClient` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +43,7 @@ properties: fullName: configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -57,6 +60,7 @@ methods: Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ + example: [] isPreview: false isDeprecated: false syntax: @@ -84,6 +88,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -111,6 +116,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 265809d6..3a830c3f 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -9,6 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +41,7 @@ properties: fullName: flags summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -52,6 +55,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 0e16d0fe..4e2199ce 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadHttpClientFactory` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: serviceKey summary: The service key for AadHttpClientFactory. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ methods: Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml index 9d66560e..9ec22382 100644 --- a/SP-Framework/sp-http/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -7,6 +7,7 @@ summary: >- The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends HttpClientResponse adding additional functionality specific to the AadHttpClient. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ constructors: fullName: '(constructor)(response, tokenFetchRequestTime)' summary: Constructs a new instance of the `AadHttpClientResponse` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 47694a84..7cb10f04 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -15,6 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadTokenProvider` class. +example: [] isPreview: false isDeprecated: false type: class @@ -28,6 +29,7 @@ methods: The OAuth2 token should not be cached by the caller since it is already cached by the method itself. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +53,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +68,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquisition requires user action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 7f686f5b..17c2b48c 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: AadTokenProviderFactory summary: Returns a preinitialized version of the AadTokenProviderFactory. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ properties: fullName: serviceKey summary: The service key for AadTokenProviderFactory. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ methods: Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml index 553dda5c..e24f3a38 100644 --- a/SP-Framework/sp-http/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: BeforeRedirectEventArgs summary: Arguments for before redirecting for a full page authentication remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ constructors: fullName: '(constructor)(redirectUrl, cancel)' summary: Constructs a new instance of the `BeforeRedirectEventArgs` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -33,6 +35,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 9dba83ba..e164b71a 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -13,6 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -23,6 +24,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `DigestCache` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -38,6 +40,7 @@ properties: fullName: serviceKey summary: The service key for IDigestCache. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -56,6 +59,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -84,6 +88,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -99,6 +104,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -119,6 +125,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index ee00b267..0799d982 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -7,6 +7,7 @@ summary: >- Typings for the GraphRequest Object For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: _headers summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: _responseType summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: config summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: fullName: urlComponents summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -72,6 +77,7 @@ methods: fullName: buildFullUrl() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -85,6 +91,7 @@ methods: fullName: 'constructor(config, path)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -105,6 +112,7 @@ methods: fullName: count(count) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -122,6 +130,7 @@ methods: fullName: 'create(content, callback)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -142,6 +151,7 @@ methods: fullName: del(callback) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -159,6 +169,7 @@ methods: fullName: delete(callback) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -176,6 +187,7 @@ methods: fullName: expand(properties) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -193,6 +205,7 @@ methods: fullName: filter(filterStr) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -210,6 +223,7 @@ methods: fullName: get(callback) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -227,6 +241,7 @@ methods: fullName: getStream(callback) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -244,6 +259,7 @@ methods: fullName: 'header(headerKey, headerValue)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -264,6 +280,7 @@ methods: fullName: headers(headers) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -287,6 +304,7 @@ methods: fullName: orderby(properties) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -304,6 +322,7 @@ methods: fullName: parsePath(rawPath) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -321,6 +340,7 @@ methods: fullName: 'patch(content, callback)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -341,6 +361,7 @@ methods: fullName: 'post(content, callback)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -361,6 +382,7 @@ methods: fullName: 'put(content, callback)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -381,6 +403,7 @@ methods: fullName: 'putStream(stream, callback)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -401,6 +424,7 @@ methods: fullName: query(queryDictionaryOrString) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -424,6 +448,7 @@ methods: fullName: responseType(responseType) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -441,6 +466,7 @@ methods: fullName: select(properties) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -458,6 +484,7 @@ methods: fullName: skip(n) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -475,6 +502,7 @@ methods: fullName: skipToken(token) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -492,6 +520,7 @@ methods: fullName: top(n) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -509,6 +538,7 @@ methods: fullName: 'update(content, callback)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -529,6 +559,7 @@ methods: fullName: version(v) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 5e79f83c..4953c421 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: HttpClient summary: HttpClient implements a basic set of features for performing REST operations against a generic service. remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `HttpClient` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: configurations summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -42,6 +45,7 @@ properties: fullName: serviceKey summary: The service key for HttpClient. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -60,6 +64,7 @@ methods: Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +96,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -122,6 +128,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index a87538c6..0614c245 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -9,6 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +41,7 @@ properties: fullName: flags summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -52,6 +55,7 @@ methods: fullName: initializeFlags() summary: Child classes should override this method to initialize the flags object. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index 63328c60..ef686d3b 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -10,6 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HttpClientResponse` class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ properties: fullName: bodyUsed summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ properties: fullName: headers summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -44,6 +47,7 @@ properties: fullName: nativeResponse summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -56,6 +60,7 @@ properties: fullName: ok summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -68,6 +73,7 @@ properties: fullName: status summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -80,6 +86,7 @@ properties: fullName: statusText summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -92,6 +99,7 @@ properties: fullName: type summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -104,6 +112,7 @@ properties: fullName: url summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -117,6 +126,7 @@ methods: fullName: arrayBuffer() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -130,6 +140,7 @@ methods: fullName: blob() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -143,6 +154,7 @@ methods: fullName: clone() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -158,6 +170,7 @@ methods: fullName: formData() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -171,6 +184,7 @@ methods: fullName: json() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -184,6 +198,7 @@ methods: fullName: text() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 80cd286d..d1e6bc9a 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 46468a04..48152dba 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -9,6 +9,7 @@ remarks: >- In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +example: [] isPreview: false isDeprecated: false type: interface @@ -21,6 +22,7 @@ properties: This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index 49f33114..65a00c23 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientOptions summary: Interface for overriding the default behavior of AadHttpClient. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: configuration summary: '' remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' @@ -28,6 +30,7 @@ properties: fullName: tokenProvider summary: '' remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' @@ -41,6 +44,7 @@ properties: fullName: useCachedToken summary: Allows the developer to specify if cached tokens should be use for the current request. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 22c5162a..79ee9cf5 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -13,6 +13,7 @@ remarks: >- AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL. +example: [] isPreview: false isDeprecated: false type: interface @@ -28,6 +29,7 @@ methods: An example of a resourceEndpoint would be https://sdfpilot.outlook.com remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +51,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +66,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquistion requires user action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index d82f4c30..66c7042a 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadTokenProviderConfiguration summary: Required strings for constructing an AadTokenProvider. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: aadInstanceUrl summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: aadSessionId summary: The current Azure Active Directory's session id. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: aadTenantId summary: The Azure Active Directory's tenant id. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +57,7 @@ properties: The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +72,7 @@ properties: The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -79,6 +85,7 @@ properties: fullName: servicePrincipalId summary: The client ID of the developer's Azure Active Directory application. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -93,6 +100,7 @@ properties: The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead @@ -109,6 +117,7 @@ properties: tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml index a98c74d8..7918d5bd 100644 --- a/SP-Framework/sp-http/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: IBeforeRedirectEventArgs summary: Represents arguments used before redirecting event. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index f286197a..43b68a33 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -13,6 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -26,6 +27,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -54,6 +56,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -69,6 +72,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -89,6 +93,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index 8949bae1..4071f3b9 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: IHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index c5606949..77f7e2b3 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -9,6 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +example: [] isPreview: false isDeprecated: false type: interface @@ -21,6 +22,7 @@ properties: This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index b447cd81..d5f7ca63 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -7,6 +7,7 @@ summary: Options for HttpClient remarks: >- This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index fbed7db9..8a3c049d 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchConfiguration summary: Flags interface for SPHttpClientBatchConfiguration. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 72045b57..13073937 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -9,6 +9,7 @@ remarks: >- class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +example: [] isPreview: true isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: fullName: v1 summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 54f9061c..b12fd531 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchCreationOptions summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 4a77681d..4e39f93b 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -7,6 +7,7 @@ summary: >- This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' +example: [] isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index 1512e15a..f9f21f72 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientCommonConfiguration summary: Flags interface for SPHttpClientCommonConfiguration remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -26,6 +27,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +47,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index efff553f..47c0f89d 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientConfiguration summary: Flags interface for SPHttpClientConfiguration. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -21,6 +22,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +43,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +62,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 5911cf8f..0d21272d 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -9,6 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) +example: [] isPreview: false isDeprecated: false type: interface @@ -24,6 +25,7 @@ properties: consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 68c63a68..2a35790a 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -7,6 +7,7 @@ summary: >- This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -22,6 +23,7 @@ properties: URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index 90a1d4ce..8b22569d 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: ITokenAcquisitionEventArgs summary: Represents arguments used for raising a token acquisiton failure event. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to interact with Azure AD. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 403e4a01..4c017214 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -17,6 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClient` class. +example: [] isPreview: false isDeprecated: false type: class @@ -33,6 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index a4eeb08d..1f6265a6 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientFactory` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: serviceKey summary: The service key for MSGraphClientFactory. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ methods: Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 357706a9..4a96308d 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: ODataVersion summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ properties: fullName: v3 summary: Represents version 3.0 for the "OData-Version" header remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: v4 summary: Represents version 4.0 for the "OData-Version" header remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -40,6 +43,7 @@ methods: fullName: toString() summary: 'Returns the "OData-Version" value, for example "4.0".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -55,6 +59,7 @@ methods: remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 0bde4bd1..ab624ee7 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -10,6 +10,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `SPHttpClient` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: serviceKey summary: The service key for SPHttpClient. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -62,6 +66,7 @@ methods: fullName: '_fetch(url, configuration, options)' summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -87,6 +92,7 @@ methods: fullName: beginBatch(batchCreationOptions) summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -127,6 +133,7 @@ methods: obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. + example: [] isPreview: false isDeprecated: false syntax: @@ -158,6 +165,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -200,6 +208,7 @@ methods: If the URL cannot be determined, an exception is thrown. + example: [] isPreview: false isDeprecated: false syntax: @@ -217,6 +226,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index dd1ae9ad..8d784750 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -15,6 +15,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPHttpClientBatch` class. +example: [] isPreview: true isDeprecated: false type: class @@ -25,6 +26,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -38,6 +40,7 @@ methods: fullName: execute() summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -67,6 +70,7 @@ methods: SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly. + example: [] isPreview: true isDeprecated: false syntax: @@ -98,6 +102,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''GET''.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -129,6 +134,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''POST''.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index d89b6929..90a5793b 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -9,6 +9,7 @@ remarks: >- SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method. +example: [] isPreview: true isDeprecated: false type: class @@ -21,6 +22,7 @@ constructors: Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +41,7 @@ properties: fullName: flags summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -52,6 +55,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -67,6 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 9976779c..35f29ea3 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpClientCommonConfiguration summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ constructors: remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: flags summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +61,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. + example: [] isPreview: false isDeprecated: false syntax: @@ -77,6 +81,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +95,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -105,6 +111,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 5f1ccbdc..4c28af0b 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -9,6 +9,7 @@ remarks: >- SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ constructors: Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +47,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +68,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials + example: [] isPreview: false isDeprecated: false syntax: @@ -77,6 +81,7 @@ properties: fullName: flags summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -95,6 +100,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. + example: [] isPreview: false isDeprecated: false syntax: @@ -108,6 +114,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -123,6 +130,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index fcfb6923..ce02fd35 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -8,6 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ constructors: fullName: (constructor)(response) summary: Constructs a new instance of the `SPHttpClientResponse` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ properties: The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header. + example: [] isPreview: true isDeprecated: false syntax: @@ -49,6 +52,7 @@ methods: fullName: clone() summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 58947dc5..f190da95 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpHeader summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' remarks: '' +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 12b922b3..d9aeafb8 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-http!' fullName: TokenAcquisitionEventArgs summary: Arguments for a token acquisition failure event. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ constructors: fullName: '(constructor)(message, redirectUrl)' summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -33,6 +35,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to perform Multi Factor Authentication remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 282f6941..74dcd821 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: IImageHelperRequest summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint. + example: [] isPreview: true isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: sourceUrl summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -42,6 +45,7 @@ properties: fullName: width summary: Width of the image requested. remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index bbcc094e..392656c6 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: ImageHelper summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. remarks: '' +example: [] isPreview: true isDeprecated: false type: class @@ -19,6 +20,7 @@ methods: - The url will be most performant if only a width is provided. If a height is provided, the image will take longer to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization. + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index afaff990..90c50b96 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -12,6 +12,7 @@ summary: >- In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and the current domain, site and web will be used. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -22,6 +23,7 @@ properties: fullName: callbacks summary: the list of callbacks remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -34,6 +36,7 @@ properties: fullName: domain summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -46,6 +49,7 @@ properties: fullName: listId summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -60,6 +64,7 @@ properties: The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current site will be used. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -74,6 +79,7 @@ properties: The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web will be used. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index 8d7a766d..517074d1 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: IListSubscription summary: A subscription to a SharePoint list resource. Contains the id of the subscription. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: id summary: The id of the subscription. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index e3bc71d8..54eecff9 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: ISubscriptionCallbacks summary: The callbacks that can be triggered by a subscription event. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: connect summary: The callback to invoke when a connection has been made to the list. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: disconnect summary: The callback to invoke when the subscription is disconnected from the list. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: notification summary: The callback to invoke when a change occurs in the list. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index 0c147391..712117d4 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -7,6 +7,7 @@ summary: >- Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the subscription to handle subscription events. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ constructors: fullName: (constructor)(component) summary: Constructs a new instance of the `ListSubscriptionFactory` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ methods: fullName: createSubscription(settings) summary: Creates a connection to the list specified by the site id and list id. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +52,7 @@ methods: fullName: deleteSubscription(subscription) summary: Deletes the subscription's connection to the resource. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index 8bdfd93f..8f06c70a 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -12,9 +12,19 @@ classes: - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' - '@microsoft/sp-listview-extensibility!RowAccessor:class' - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' interfaces: + - '@microsoft/sp-listview-extensibility!IColumn:interface' - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IFilter:interface' + - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - '@microsoft/sp-listview-extensibility!IList:interface' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + - '@microsoft/sp-listview-extensibility!IRow:interface' + - '@microsoft/sp-listview-extensibility!IView:interface' +enums: + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 1b157fff..22784ff8 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -10,6 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "FieldCustomizer". remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -23,6 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ methods: fullName: onDisposeCell(event) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +56,7 @@ methods: fullName: onRenderCell(event) summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 81ed0d8b..0807a241 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -12,6 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseListViewCommandSet` class. +example: [] isPreview: false isDeprecated: false type: class @@ -25,6 +26,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: false isDeprecated: false syntax: @@ -40,6 +42,7 @@ methods: This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -57,8 +60,10 @@ methods: fullName: onListViewUpdated(event) summary: This event occurs whenever the ListView state changes. virtual remarks: This event allows the implementor to tailor the visibility of the command. + example: [] isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: Use context.listView.listViewStateChangedEvent instead. syntax: content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' parameters: @@ -68,12 +73,27 @@ methods: return: type: void description: '' + - name: raiseOnChange() + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#raiseOnChange:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: raiseOnChange() + summary: Use this method to fire OnChange event and initialize a reflow of the ListView. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'raiseOnChange(): void;' + return: + type: void + description: '' - name: tryGetCommand(id) uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' package: '@microsoft/sp-listview-extensibility!' fullName: tryGetCommand(id) summary: Returns the command with the given id. Returns undefined if there is not command with the given id. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 8d62ec6f..6d3d387d 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -14,6 +14,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ColumnAccessor` class. +example: [] isPreview: false isDeprecated: false type: class @@ -24,6 +25,7 @@ properties: fullName: field summary: The server-side definition of the field. This property is read-only. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ properties: fullName: visible summary: Whether to show this column in the list view. This property is read-only. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 2b498d34..ba1fd744 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -11,6 +11,7 @@ remarks: >- [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. +example: [] isPreview: false isDeprecated: false type: class @@ -23,6 +24,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -37,6 +39,7 @@ properties: An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +52,7 @@ properties: fullName: id summary: Id of the command. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -68,6 +72,7 @@ properties: toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension. + example: [] isPreview: false isDeprecated: false syntax: @@ -80,6 +85,7 @@ properties: fullName: visible summary: True if the command is visible. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index d75ca01b..f2d89b85 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -7,6 +7,7 @@ summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FieldCustomizerContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ properties: fullName: field summary: Provides access to the SharePoint field that the customizer will operate on. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -34,6 +36,7 @@ methods: remarks: >- Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml new file mode 100644 index 00000000..1d74ee50 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -0,0 +1,118 @@ +### YamlMime:TSType +name: IColumn +uid: '@microsoft/sp-listview-extensibility!IColumn:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IColumn +summary: Provides information about the state of a column in the list view +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: clientSideComponentId + uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: clientSideComponentId + summary: The unique identifier of the client-side component associated with the field. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly clientSideComponentId: Guid | undefined;' + return: + type: ' | undefined' + - name: clientSideComponentProperties + uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentProperties:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: clientSideComponentProperties + summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. + remarks: >- + If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning + are defined by the client-side component. + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly clientSideComponentProperties: string;' + return: + type: string + - name: displayName + uid: '@microsoft/sp-listview-extensibility!IColumn#displayName:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: displayName + summary: The display name of the field. This name is shown as column name in UI. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly displayName: string;' + return: + type: string + - name: fieldType + uid: '@microsoft/sp-listview-extensibility!IColumn#fieldType:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: fieldType + summary: The type of the field represented as a string + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly fieldType: string;' + return: + type: string + - name: id + uid: '@microsoft/sp-listview-extensibility!IColumn#id:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: id + summary: The GUID identifier for this field. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: internalName + uid: '@microsoft/sp-listview-extensibility!IColumn#internalName:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: internalName + summary: The internal name of the field. This name is usually used to find the field. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly internalName: string;' + return: + type: string + - name: isRequired + uid: '@microsoft/sp-listview-extensibility!IColumn#isRequired:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: isRequired + summary: Whether the field is required for each list item in the list + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isRequired: boolean;' + return: + type: boolean + - name: isVisible + uid: '@microsoft/sp-listview-extensibility!IColumn#isVisible:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: isVisible + summary: Whether the column is visible in the view + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isVisible: boolean;' + return: + type: boolean diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index d81701e5..2a0262c1 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFieldCustomizerCellEventParameters summary: Event parameters for BaseFieldCustomizer.onRenderCell() remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: fieldValue summary: The value of the field being rendered. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: listItem summary: The list item being edited. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -56,6 +60,7 @@ properties: For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml new file mode 100644 index 00000000..61e4d636 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: IFilter +uid: '@microsoft/sp-listview-extensibility!IFilter:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IFilter +summary: Provides information about the state of the filters applied to the ListView. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: fieldName + uid: '@microsoft/sp-listview-extensibility!IFilter#fieldName:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: fieldName + summary: Field name to filter on. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly fieldName: string;' + return: + type: string + - name: values + uid: '@microsoft/sp-listview-extensibility!IFilter#values:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: values + summary: Values to filter on. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'values: ReadonlyArray;' + return: + type: ReadonlyArray<string> diff --git a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml new file mode 100644 index 00000000..c8b4e69c --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: IFolderInfo +uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IFolderInfo +summary: Provides information about the state of the folder in the ListView. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: folderPath + uid: '@microsoft/sp-listview-extensibility!IFolderInfo#folderPath:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: folderPath + summary: Folder path. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly folderPath: string;' + return: + type: string diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml new file mode 100644 index 00000000..a020e993 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: IList +uid: '@microsoft/sp-listview-extensibility!IList:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IList +summary: Provides information about the list rendered by the ListView. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: guid + uid: '@microsoft/sp-listview-extensibility!IList#guid:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: guid + summary: List id. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly guid: Guid;' + return: + type: '' + - name: serverRelativeUrl + uid: '@microsoft/sp-listview-extensibility!IList#serverRelativeUrl:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: serverRelativeUrl + summary: List server relative url. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: string + - name: title + uid: '@microsoft/sp-listview-extensibility!IList#title:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: title + summary: List title. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly title: string;' + return: + type: string diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml new file mode 100644 index 00000000..a2bdab47 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -0,0 +1,135 @@ +### YamlMime:TSType +name: IListViewAccessorState +uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IListViewAccessorState +summary: Provides information about the state of the ListView. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: appliedFilters + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: appliedFilters + summary: Applied filters information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: |- + readonly appliedFilters?: { + [fieldName: string]: IFilter; + }; + return: + type: |- + { + [fieldName: string]: ; + } + - name: columns + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: columns + summary: Columns information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly columns: ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + - name: folderInfo + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#folderInfo:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: folderInfo + summary: Current folder information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly folderInfo?: IFolderInfo;' + return: + type: '' + - name: list + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#list:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: list + summary: List information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly list?: IList;' + return: + type: '' + - name: rows + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: rows + summary: Rows information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly rows: ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + - name: selectedRows + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: Selected rows information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly selectedRows?: ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + - name: sortAscending + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortAscending:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: sortAscending + summary: Sort direction. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sortAscending?: boolean;' + return: + type: boolean + - name: sortField + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortField:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: sortField + summary: Sort field name. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sortField?: string;' + return: + type: string + - name: view + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#view:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: view + summary: View information. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly view?: IView;' + return: + type: '' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index badadd67..08711f5d 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -7,6 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index c95c3b25..1ef89678 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -7,6 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml new file mode 100644 index 00000000..1b0dbb62 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -0,0 +1,33 @@ +### YamlMime:TSType +name: IRow +uid: '@microsoft/sp-listview-extensibility!IRow:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IRow +summary: Provides information about the list item's state rendered by the ListView. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: values + uid: '@microsoft/sp-listview-extensibility!IRow#values:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: values + summary: >- + A map of column values for the row. They key is the column internal name and the value is its corresponding value + in the row. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: |- + readonly values: { + [columnInternalName: string]: Readonly; + }; + return: + type: |- + { + [columnInternalName: string]: Readonly<any>; + } diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml new file mode 100644 index 00000000..31bce495 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: IView +uid: '@microsoft/sp-listview-extensibility!IView:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IView +summary: Provides information about the view rendered by the ListView. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-listview-extensibility!IView#id:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: id + summary: View id. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: Guid;' + return: + type: '' + - name: title + uid: '@microsoft/sp-listview-extensibility!IView#title:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: title + summary: View title. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly title: string;' + return: + type: string + - name: url + uid: '@microsoft/sp-listview-extensibility!IView#url:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: url + summary: View server relative url. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'readonly url: string;' + return: + type: string diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 9074d0ee..6474d853 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -18,6 +18,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListItemAccessor` class. +example: [] isPreview: false isDeprecated: false type: class @@ -31,6 +32,7 @@ properties: The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type. + example: [] isPreview: false isDeprecated: false syntax: @@ -46,6 +48,7 @@ methods: Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +68,7 @@ methods: Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 8a12e559..2645ba6a 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -7,22 +7,134 @@ summary: Provides access to a SharePoint ListView control. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewAccessor` class. +example: [] isPreview: false isDeprecated: false type: class properties: + - name: appliedFilters + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#appliedFilters:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: appliedFilters + summary: Filters applied to the list view. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: |- + abstract get appliedFilters(): { + [fieldName: string]: IFilter; + } | undefined; + return: + type: |- + { + [fieldName: string]: ; + } | undefined - name: columns uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' package: '@microsoft/sp-listview-extensibility!' fullName: columns summary: 'The columns in associated with this view, including hidden columns.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: content: 'abstract get columns(): ReadonlyArray;' return: type: 'ReadonlyArray<>' + - name: folderInfo + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: folderInfo + summary: Folder information for the list view. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get folderInfo(): IFolderInfo | undefined;' + return: + type: ' | undefined' + - name: list + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#list:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: list + summary: Basic information about the list rendered by the list view. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get list(): IList | undefined;' + return: + type: ' | undefined' + - name: rows + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#rows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: rows + summary: Currently rendered rows in the list view. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get rows(): ReadonlyArray;' + return: + type: 'ReadonlyArray<>' + - name: selectedRows + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: selectedRows + summary: Selected rows in the list view. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get selectedRows(): ReadonlyArray | undefined;' + return: + type: 'ReadonlyArray<> | undefined' + - name: sortAscending + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortAscending:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: sortAscending + summary: Specifies whether the list view is sorted ascending or descending. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get sortAscending(): boolean | undefined;' + return: + type: boolean | undefined + - name: sortField + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortField:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: sortField + summary: Sort field name + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get sortField(): string | undefined;' + return: + type: string | undefined + - name: view + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#view:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: view + summary: Basic information about the view rendered by the list view. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'abstract get view(): IView | undefined;' + return: + type: ' | undefined' methods: - name: tryGetColumnByName(internalName) uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' @@ -32,6 +144,7 @@ methods: Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -44,12 +157,28 @@ methods: type: ' | undefined' description: '' events: + - name: listViewStateChangedEvent + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#listViewStateChangedEvent:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: listViewStateChangedEvent + summary: Event that gets raised every time the list view state changes. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'get listViewStateChangedEvent(): SPEvent;' + return: + type: >- + <> - name: selectedRowsChangedEvent uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' package: '@microsoft/sp-listview-extensibility!' fullName: selectedRowsChangedEvent summary: Event that gets raised every time the selected items in the list view change. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml new file mode 100644 index 00000000..50c4a954 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -0,0 +1,56 @@ +### YamlMime:TSEnum +name: ListViewAccessorStateChanges +uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListViewAccessorStateChanges +summary: Describes the type of list view state changes. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +fields: + - name: AppliedFilters + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.AppliedFilters:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '32' + - name: Columns + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Columns:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '4' + - name: FolderInfo + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.FolderInfo:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '128' + - name: List + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.List:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '1' + - name: None + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.None:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '0' + - name: Rows + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Rows:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '16' + - name: SelectedRows + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.SelectedRows:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '8' + - name: Sort + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Sort:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '64' + - name: View + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.View:member' + package: '@microsoft/sp-listview-extensibility!' + summary: '' + value: '2' diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index 66de710a..fdbd44da 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -7,6 +7,7 @@ summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewCommandSetContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -17,6 +18,7 @@ properties: fullName: listView summary: Provides access to the ListView control that the customizer will operate on. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml new file mode 100644 index 00000000..4cc180a6 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: ListViewStateChangedEventArgs +uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: ListViewStateChangedEventArgs +summary: Arguments for the list view state changed event. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: class +properties: + - name: prevState + uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#prevState:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: prevState + summary: Previous state of the ListView. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'prevState: Readonly;' + return: + type: 'Readonly<>' + - name: stateChanges + uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#stateChanges:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: stateChanges + summary: Changes that were made to the ListView state. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'stateChanges: ListViewAccessorStateChanges;' + return: + type: '' +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index a1792f06..8443c4b5 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -15,6 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RowAccessor` class. +example: [] isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 44757881..bf56480c 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: SelectedRowsChangedEventArgs summary: Arguments for the selected rows changed event. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ properties: fullName: selectedRows summary: The list of rows that were selected in the list view at the time when the event was fired. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index 8033ab61..72fc2f1b 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-loader!' fullName: ILoadScriptOptions summary: Options for the loadScript() method in ISPComponentLoader remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: globalExportsName summary: 'If set, the loaded script will be stored in a global variable under this name.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index a228d6d1..c8ed255f 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-loader!' fullName: SPComponentLoader summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -15,6 +16,7 @@ methods: fullName: getManifests() summary: Returns static copies of all the manifests. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -28,6 +30,7 @@ methods: fullName: loadComponent(manifest) summary: Loads a component from a manifest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +48,7 @@ methods: fullName: 'loadComponentById(id, version)' summary: 'Resolve a component id and version, and load it.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +71,7 @@ methods: fullName: loadCss(url) summary: Inserts a `` tag for a stylesheet. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -87,6 +92,7 @@ methods: If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not be propagated. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index cba5055e..0803ef19 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IAdaptiveCardExtensionManifest summary: '' remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: connectedSPFXAppId summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: connectedTeamsAppId summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: experimentalData summary: An untyped property bag for experimental flags not ready for production. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -61,6 +65,7 @@ properties: default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way. + example: [] isPreview: true isDeprecated: false syntax: @@ -112,6 +117,7 @@ properties: } }] ``` + example: [] isPreview: true isDeprecated: false syntax: @@ -126,6 +132,7 @@ properties: fullName: supportedHosts summary: 'Definition: An array defining what host types are supported' remarks: 'Usage: Use this array to define all hosts that are supported.' + example: [] isPreview: true isDeprecated: false syntax: @@ -142,6 +149,7 @@ properties: variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no ACEs support theme variants. + example: [] isPreview: true isDeprecated: false syntax: @@ -162,6 +170,7 @@ properties: By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized logic, then it is recommended to override onAfterPropertiesUpdatedExternally. + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index 21503b75..29840bc4 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -8,6 +8,7 @@ summary: >- pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -20,6 +21,7 @@ properties: Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes \["Medium", "Large"\] defined in the sp-adaptive-card-base project. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -49,6 +51,7 @@ properties: Example: `"1.0"` + example: [] isPreview: true isDeprecated: false syntax: @@ -85,6 +88,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` + example: [] isPreview: true isDeprecated: false syntax: @@ -103,6 +107,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` + example: [] isPreview: true isDeprecated: false syntax: @@ -130,6 +135,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + example: [] isPreview: true isDeprecated: false syntax: @@ -154,6 +160,7 @@ properties: Example: "graph" + example: [] isPreview: true isDeprecated: false syntax: @@ -178,6 +185,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` + example: [] isPreview: true isDeprecated: false syntax: @@ -193,6 +201,7 @@ properties: group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + example: [] isPreview: true isDeprecated: false syntax: @@ -229,6 +238,7 @@ properties: "zh": "我的 web 部件" } ``` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 9ac3e6ed..2c66fcb9 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideAssemblyManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: Supported values: any GUID Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 4c4573ce..774a0492 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -7,6 +7,7 @@ summary: >- This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. It contains all data for loading an entrypoint script and its dependency scripts. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -27,6 +28,7 @@ properties: Example: `"myApplication.bundle"` + example: [] isPreview: true isDeprecated: false syntax: @@ -57,6 +59,7 @@ properties: Example: `mySpWebpart` + example: [] isPreview: true isDeprecated: false syntax: @@ -92,6 +95,7 @@ properties: Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` + example: [] isPreview: true isDeprecated: false syntax: @@ -143,6 +147,7 @@ properties: } } ``` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index 97e12c09..acec9040 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -21,6 +21,7 @@ remarks: >- - The `'manifestVersion'` should be bumped for all small or big changes. +example: [] isPreview: false isDeprecated: false type: interface @@ -39,6 +40,7 @@ properties: Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` + example: [] isPreview: false isDeprecated: false syntax: @@ -61,6 +63,7 @@ properties: Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, `"AdaptiveCardExtension"` + example: [] isPreview: false isDeprecated: false syntax: @@ -78,6 +81,7 @@ properties: Usage: Loading a component. See `IClientSideComponentLoaderConfiguration` for more information and examples. + example: [] isPreview: true isDeprecated: false syntax: @@ -92,6 +96,7 @@ properties: This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts build after using spfx 1.1 don't need this. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -112,6 +117,7 @@ properties: Usage: Requires Custom Script to be allowed in order for this component to be installed and run. + example: [] isPreview: false isDeprecated: false syntax: @@ -124,6 +130,7 @@ properties: fullName: safeWithCustomScriptDisabled summary: This property is provided for backwards compatibility. It no longer has any effect. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. @@ -158,6 +165,7 @@ properties: Example: `"1.0.0"` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index c755266f..d4d7999b 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideExtensionManifest summary: This is the manifest for a client-side extension. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index 91c3bfe8..b030c628 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideLibraryManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index 87467a27..5990ff09 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideManifestBase summary: This interface defines members that are common between all deployable manifests. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -27,6 +28,7 @@ properties: Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +55,7 @@ properties: Example: `1` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 0dec5d01..ad229c00 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -12,6 +12,7 @@ remarks: >- some required properties in the manifest and some optional properties. Optional properties need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and functionality problems. +example: [] isPreview: false isDeprecated: false type: interface @@ -22,6 +23,7 @@ properties: fullName: canUpdateConfiguration summary: Indicates whether the web part uses the property pane to update the configuration of the web part. remarks: Default value is `true` if the property is not explicitly defined. + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ properties: remarks: >- Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If this flag is true, the web part will not appear in the classic page web part gallery. + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +54,7 @@ properties: Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts can be provisioned on pages though API or be added to the page in a pre configured way. + example: [] isPreview: false isDeprecated: false syntax: @@ -66,6 +70,7 @@ properties: Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module url + example: [] isPreview: false isDeprecated: false syntax: @@ -111,6 +116,7 @@ properties: } }] ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -128,6 +134,7 @@ properties: SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp cannot be used with TeamsTab or TeamsPersonalTab. + example: [] isPreview: false isDeprecated: false syntax: @@ -145,6 +152,7 @@ properties: Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed experiences require special treatment and testing. By default no web parts support full bleed experiences. + example: [] isPreview: false isDeprecated: false syntax: @@ -161,6 +169,7 @@ properties: variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no web parts support theme variants. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 2a58647d..5beb78e6 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -8,6 +8,7 @@ summary: >- instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -35,6 +36,7 @@ properties: Example: `"1.0"` + example: [] isPreview: false isDeprecated: false syntax: @@ -71,6 +73,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` + example: [] isPreview: false isDeprecated: false syntax: @@ -93,6 +96,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + example: [] isPreview: false isDeprecated: false syntax: @@ -107,6 +111,7 @@ properties: The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' + example: [] isPreview: true isDeprecated: false syntax: @@ -125,6 +130,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` + example: [] isPreview: true isDeprecated: false syntax: @@ -152,6 +158,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` + example: [] isPreview: false isDeprecated: false syntax: @@ -176,6 +183,7 @@ properties: Example: "graph" + example: [] isPreview: false isDeprecated: false syntax: @@ -200,6 +208,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` + example: [] isPreview: false isDeprecated: false syntax: @@ -214,6 +223,7 @@ properties: This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' + example: [] isPreview: true isDeprecated: false syntax: @@ -249,6 +259,7 @@ properties: "zh": "我的 web 部件" } ``` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 6ad4afcf..54671bd9 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideWebPartManifestInstance summary: Manifest that is relevant to a Web Part instance. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index 66f04a6c..26d3ff16 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -7,6 +7,7 @@ summary: >- Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -38,6 +40,7 @@ properties: manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). + example: [] isPreview: false isDeprecated: false syntax: @@ -50,6 +53,7 @@ properties: fullName: title summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -62,6 +66,7 @@ properties: fullName: type summary: Type of the item. Currently only "command" is allowed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index 37079bca..ec2fb4aa 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -7,6 +7,7 @@ summary: >- This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -33,6 +35,7 @@ properties: remarks: >- The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 7cdd4349..3be613d5 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -7,6 +7,7 @@ summary: >- This is the interface for a script module with the "component" type. Modules of this type will be provided via manifests. In order for the dependency to be loaded, the manifest must be available on the site. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -27,6 +28,7 @@ properties: Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` + example: [] isPreview: true isDeprecated: false syntax: @@ -42,6 +44,7 @@ properties: Supported values: string representing a component's ID. Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` + example: [] isPreview: true isDeprecated: false syntax: @@ -60,6 +63,7 @@ properties: Supported values: string representing a [semantic version](http://semver.org), or "latest". Example: `"2.2.4"` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 141e12be..e861720d 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -8,6 +8,7 @@ remarks: >- Modules of this type must be provided by the component developer. These script resources are similar to those of the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as "internal" modules are. +example: [] isPreview: true isDeprecated: false type: interface @@ -30,6 +31,7 @@ properties: Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` + example: [] isPreview: true isDeprecated: false syntax: @@ -67,6 +69,7 @@ properties: "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" } ``` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index 730fe2fc..bd2d777e 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -46,6 +46,7 @@ remarks: >- For more complex cases, run an appropriate expression to access your resource and return the string. +example: [] isPreview: false isDeprecated: false type: interface @@ -56,6 +57,7 @@ properties: fullName: default summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -68,6 +70,7 @@ properties: fullName: id summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index 5f85afd8..f2d0c35f 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfiguration summary: This is the base interface for a script module's definition. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -21,6 +22,7 @@ properties: Usage: Instructs the module loader to not preload this module. + example: [] isPreview: true isDeprecated: false syntax: @@ -46,6 +48,7 @@ properties: Example: `"localized"` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ipath.yml b/SP-Framework/sp-module-interfaces/ipath.yml index 267e5056..c59252f8 100644 --- a/SP-Framework/sp-module-interfaces/ipath.yml +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -7,6 +7,7 @@ summary: >- This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded in exactly the same way as any other internal path. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -25,6 +26,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` + example: [] isPreview: true isDeprecated: false syntax: @@ -45,6 +47,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index d1130505..9c813b4d 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -7,6 +7,7 @@ summary: >- This is the interface for a script module with the "path" type. Modules of this type must be provided by the component developer. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -30,6 +31,7 @@ properties: Example: `["jquery"]` + example: [] isPreview: true isDeprecated: false syntax: @@ -57,6 +59,7 @@ properties: Example: `"$"` + example: [] isPreview: true isDeprecated: false syntax: @@ -85,6 +88,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index 6625d178..c886cd6a 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: PredefinedGroup summary: Predefined web part group. remarks: '' +example: [] isPreview: true isDeprecated: false fields: @@ -32,6 +33,14 @@ fields: This group includes web parts that organize, group, and filter content to help users discover information. value: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' + - name: Local + uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Local:member' + package: '@microsoft/sp-module-interfaces!' + summary: |- + Other. + + This group includes local web parts. + value: '"8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"' - name: Other uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index dd06fd8d..982a63f3 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: NameId summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: NameIdIssuer summary: 'Example: `"urn:office:idp:activedirectory"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 18a5e692..898f9f8c 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataBasePermission summary: Data used for creating a SPPermission object. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: High summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: Low summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index b7bcf678..d1a7818a 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: StringValue summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index cec543b4..1914ab25 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: LibraryVersion summary: 'Example: `"16.0.4919.3000"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: SiteFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: SupportedSchemaVersions summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +57,7 @@ properties: fullName: WebFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 20a23cac..18eb0c2a 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: BaseTemplate summary: The list definition type on which the list is based. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: Created summary: 'Example: `"/Date(1453294804000)/"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: CurrentChangeToken summary: The change token that will be used in logging the next change to the list. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +57,7 @@ properties: fullName: Description summary: A description of the List. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +70,7 @@ properties: fullName: EntityTypeName summary: 'Example: `"MyListTitleList"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -79,6 +85,7 @@ properties: A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +98,7 @@ properties: fullName: Id summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -103,6 +111,7 @@ properties: fullName: LastItemDeletedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -115,6 +124,7 @@ properties: fullName: LastItemModifiedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -127,6 +137,7 @@ properties: fullName: ListItemEntityTypeFullName summary: 'Example: `"SP.Data.MyListTitleListItem"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -139,6 +150,7 @@ properties: fullName: ParentWebUrl summary: 'Example: `"/sites/PubSite"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -151,6 +163,7 @@ properties: fullName: TemplateFeatureId summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -163,6 +176,7 @@ properties: fullName: Title summary: 'Example: `"Pages"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 32f6a0c3..9dc55986 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: ContentTypeId summary: 'Example: `{ StringValue: "0x010100C5..." }`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: fullName: ID summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: Title summary: Title of the List Item remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: fullName: UniqueId summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 32bc1a50..7f9fd50d 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.NavigationNode object. [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: Children summary: Gets or sets an array of Navigation Nodes that are children to the current node. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: Id summary: Gets a value that specifies the identifier for the navigation node. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: IsDocLib summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -55,6 +59,7 @@ properties: Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +72,7 @@ properties: fullName: IsVisible summary: Gets or sets a value that specifies if the node navigation link should be visible. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -79,6 +85,7 @@ properties: fullName: Title summary: Gets or sets a value that specifies the anchor text for the node navigation link. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -93,6 +100,7 @@ properties: Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 30026142..ec5b1d3f 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: quickLaunch summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: topNav summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index a78453ec..cde911b1 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: fullName: Email summary: 'Example: `"someone@example.com"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: Id summary: '' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: IsSiteAdmin summary: Boolean value that specifies whether the user is a site collection administrator. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +57,7 @@ properties: fullName: LoginName summary: 'Example: `"i:0#.w|domain\user"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -78,6 +83,7 @@ properties: SharePointGroup: 8 All: 15 + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +96,7 @@ properties: fullName: Title summary: 'Example: `"DOMAIN\user"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -104,6 +111,7 @@ properties: Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index f83c9584..af02f1ab 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -8,6 +8,7 @@ summary: >- here: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: fullName: ClientSideComponentId summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -36,6 +38,7 @@ properties: Example: `"{ \"maxItemsToShow\": 123 }"` + example: [] isPreview: false isDeprecated: false syntax: @@ -50,6 +53,7 @@ properties: Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -62,6 +66,7 @@ properties: fullName: Description summary: Gets or sets the description of the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -76,6 +81,7 @@ properties: Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +96,7 @@ properties: Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -102,6 +109,7 @@ properties: fullName: ImageUrl summary: Gets or sets the URL of the image associated with the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -114,6 +122,7 @@ properties: fullName: Location summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -126,6 +135,7 @@ properties: fullName: RegistrationId summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -140,6 +150,7 @@ properties: remarks: >- Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4. + example: [] isPreview: false isDeprecated: false syntax: @@ -152,6 +163,7 @@ properties: fullName: Rights summary: Gets or sets the value that specifies the permissions needed for the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -164,6 +176,7 @@ properties: fullName: Scope summary: Gets a value that specifies the scope of the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -176,6 +189,7 @@ properties: fullName: ScriptBlock summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -188,6 +202,7 @@ properties: fullName: ScriptSrc summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -202,6 +217,7 @@ properties: Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -214,6 +230,7 @@ properties: fullName: Title summary: Gets or sets the display title of the custom action. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -226,6 +243,7 @@ properties: fullName: Url summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -238,6 +256,7 @@ properties: fullName: VersionOfUserCustomAction summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 9c878644..2bff7eea 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -7,6 +7,7 @@ summary: >- Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -20,6 +21,7 @@ properties: Example: `"/Date(2016,0,20,12,58,7,0)/"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -32,6 +34,7 @@ properties: fullName: CurrentChangeToken summary: Represents the unique sequential location of a change within the change log. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: fullName: Description summary: Gets or sets the description for the site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -74,6 +79,7 @@ properties: Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -86,6 +92,7 @@ properties: fullName: IsMultilingual summary: Value that represents if the web was remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -101,6 +108,7 @@ properties: Example: `1033` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -116,6 +124,7 @@ properties: Example: `"/Date(1453618828000)/"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -131,6 +140,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -143,6 +153,7 @@ properties: fullName: NoCrawl summary: Determines if a particular web will be crawled by search or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -155,6 +166,7 @@ properties: fullName: QuickLaunchEnabled summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -167,6 +179,7 @@ properties: fullName: RecycleBinEnabled summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -182,6 +195,7 @@ properties: Example: `"/sites/PubSite"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -194,6 +208,7 @@ properties: fullName: SiteLogoUrl summary: Gets the url for the logo of this particular site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -206,6 +221,7 @@ properties: fullName: Title summary: The title of the web. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -221,6 +237,7 @@ properties: Example: `15` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -236,6 +253,7 @@ properties: Example: `"http://example.com/sites/PubSite"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -251,6 +269,7 @@ properties: Example: `"BLANKINTERNET"` remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 9734254c..5a828f3e 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CultureInfo` class. +example: [] isPreview: false isDeprecated: false type: class @@ -26,6 +27,7 @@ properties: Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the date as 1/8 instead of 8/1. + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +45,7 @@ properties: Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to translate the word "hello" to "hola". + example: [] isPreview: false isDeprecated: false syntax: @@ -55,6 +58,7 @@ properties: fullName: isRightToLeft summary: This boolean represents the dominant direction of written text for the default user interface language. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index 56fcbdb8..b17520e3 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPSystemTime summary: Interface that represents a `SPSystemTime` structure. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: Day summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: DayOfWeek summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: Hour summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: Milliseconds summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -63,6 +68,7 @@ properties: fullName: Minute summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -75,6 +81,7 @@ properties: fullName: Month summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -87,6 +94,7 @@ properties: fullName: Second summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -99,6 +107,7 @@ properties: fullName: Year summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index af727df3..24c4dfaa 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPTimeZoneData summary: Interface that represents the data necessary to build an `TimeZone` object. remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: daylightDate summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: daylightOffset summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: description summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: id summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -63,6 +68,7 @@ properties: fullName: offset summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -75,6 +81,7 @@ properties: fullName: standardDate summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -87,6 +94,7 @@ properties: fullName: standardOffset summary: '' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 0d23aa1e..ad7057bb 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -8,6 +8,7 @@ remarks: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. +example: [] isPreview: false isDeprecated: false type: class @@ -18,6 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `PageContext` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +52,7 @@ properties: It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -61,6 +65,7 @@ properties: fullName: isInitialized summary: Returns whether the `PageContext` has been initialized. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -83,6 +88,7 @@ properties: NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object. + example: [] isPreview: false isDeprecated: false syntax: @@ -97,6 +103,7 @@ properties: Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -111,6 +118,7 @@ properties: Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -123,6 +131,7 @@ properties: fullName: serviceKey summary: The service key for PageContext. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -137,6 +146,7 @@ properties: fullName: site summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -151,6 +161,7 @@ properties: It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -163,6 +174,7 @@ properties: fullName: web summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 3bd78259..5c163c3f 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -11,6 +11,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPField` class. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -71,6 +76,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -83,6 +89,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -95,6 +102,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index b84bd9f7..97e758e5 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPList` class. +example: [] isPreview: false isDeprecated: false type: class @@ -21,6 +22,7 @@ properties: The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' + example: [] isPreview: false isDeprecated: false syntax: @@ -59,6 +63,7 @@ properties: fullName: title summary: Returns the title for this `SPList`. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 01613062..6a1d03ff 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPListItem` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: id summary: The number that identifies the `SPListItem` on the server. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 4bc23a46..86719860 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -10,6 +10,7 @@ remarks: >- For more information, see: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ constructors: fullName: (constructor)(value) summary: Constructs a new instance of the `SPPermission` class remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -37,6 +39,7 @@ properties: Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation–compatible editor. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +52,7 @@ properties: fullName: addDelPrivateWebParts summary: Add or remove personal web parts on a web part Page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -61,6 +65,7 @@ properties: fullName: addListItems summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -73,6 +78,7 @@ properties: fullName: applyStyleSheets summary: Apply a style sheet (.css file) to the Web site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -85,6 +91,7 @@ properties: fullName: applyThemeAndBorder summary: Apply a theme or borders to the entire Web site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -97,6 +104,7 @@ properties: fullName: approveItems summary: Approve a minor version of a list item or document. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -109,6 +117,7 @@ properties: fullName: browseDirectories summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -121,6 +130,7 @@ properties: fullName: browserUserInfo summary: View information about users of the Web site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -133,6 +143,7 @@ properties: fullName: cancelCheckout summary: Discard or check in a document which is checked out to another user. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -145,6 +156,7 @@ properties: fullName: createAlerts summary: Create e-mail alerts. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -157,6 +169,7 @@ properties: fullName: createGroups summary: Create a group of users that can be used anywhere within the site collection. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -169,6 +182,7 @@ properties: fullName: createSSCSite summary: Create a Web site using Self-Service Site Creation. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -181,6 +195,7 @@ properties: fullName: deleteListItems summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -193,6 +208,7 @@ properties: fullName: deleteVersions summary: Delete past versions of a list item or document. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -207,6 +223,7 @@ properties: Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -219,6 +236,7 @@ properties: fullName: editMyUserInfo summary: 'Allows a user to change his or her user information, such as adding a picture.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -231,6 +249,7 @@ properties: fullName: emptyMask summary: Has no permissions on the Web site. Not available through the user interface. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -243,6 +262,7 @@ properties: fullName: enumeratePermissions summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -255,6 +275,7 @@ properties: fullName: fullMask summary: Has all permissions on the Web site. Not available through the user interface. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -267,6 +288,7 @@ properties: fullName: layoutsPage summary: View the layouts page? remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -279,6 +301,7 @@ properties: fullName: manageAlerts summary: Manage alerts for all users of the Web site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -291,6 +314,7 @@ properties: fullName: manageLists summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -303,6 +327,7 @@ properties: fullName: managePermissions summary: Create and change permission levels on the Web site and assign permissions to users and groups. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -315,6 +340,7 @@ properties: fullName: managePersonalViews summary: 'Create, change, and delete personal views of lists.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -327,6 +353,7 @@ properties: fullName: manageSubwebs summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -344,6 +371,7 @@ properties: of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. + example: [] isPreview: false isDeprecated: false syntax: @@ -356,6 +384,7 @@ properties: fullName: open summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -368,6 +397,7 @@ properties: fullName: openItems summary: View the source of documents with server-side file handlers. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -380,6 +410,7 @@ properties: fullName: updatePersonalWebParts summary: Update web parts to display personalized information. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -392,6 +423,7 @@ properties: fullName: useClientIntegration summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -404,6 +436,7 @@ properties: fullName: useRemoteAPIs summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -416,6 +449,7 @@ properties: fullName: value summary: Returns the value of this SPPermission object remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -428,6 +462,7 @@ properties: fullName: viewFormPages summary: 'View forms, views, and application pages, and enumerate lists.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -440,6 +475,7 @@ properties: fullName: viewListItems summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -452,6 +488,7 @@ properties: fullName: viewPages summary: View pages in a Web site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -464,6 +501,7 @@ properties: fullName: viewUsageData summary: View reports on Web site usage. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -476,6 +514,7 @@ properties: fullName: viewVersions summary: View past versions of a list item or document. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -489,6 +528,7 @@ methods: fullName: hasAllPermissions(requestedPerms) summary: Function for testing whether a given permission mask has all of the requested permissions. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -506,6 +546,7 @@ methods: fullName: hasAnyPermissions(requestedPerms) summary: Function for testing whether a given permission mask has any of the requested permissions. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -523,6 +564,7 @@ methods: fullName: hasPermission(requestedPerm) summary: Function for testing whether a given permission mask has the requested permission. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index def2d2eb..f42ff584 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPSite` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: absoluteUrl summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: fullName: cdnPrefix summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +46,7 @@ properties: fullName: classification summary: Returns the classification of the site. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -55,6 +59,7 @@ properties: fullName: correlationId summary: Returns the correlation id to the current server request. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -69,6 +74,7 @@ properties: Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -81,6 +87,7 @@ properties: fullName: id summary: The GUID that identifies the SPSite on the server. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -93,6 +100,7 @@ properties: fullName: isNoScriptEnabled summary: Returns true if isNoScript has been enabled on the SPSite. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -105,6 +113,7 @@ properties: fullName: recycleBinItemCount summary: The amount of items in the recycle bin. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -117,6 +126,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' + example: [] isPreview: false isDeprecated: false syntax: @@ -129,6 +139,7 @@ properties: fullName: serverRequestPath summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' + example: [] isPreview: false isDeprecated: false syntax: @@ -141,6 +152,7 @@ properties: fullName: sitePagesEnabled summary: Returns true if SitePages are enabled on this SPSite. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 374e968c..932ac3ec 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -19,6 +19,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPTimeZone` class. +example: [] isPreview: true isDeprecated: false type: class @@ -29,6 +30,7 @@ properties: fullName: daylightDate summary: Gets the date on which daylight time begins for the time zone. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -43,6 +45,7 @@ properties: Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC). remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -55,6 +58,7 @@ properties: fullName: description summary: Gets the description for the time zone. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -67,6 +71,7 @@ properties: fullName: id summary: Gets the ID of the time zone. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -79,6 +84,7 @@ properties: fullName: offset summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -91,6 +97,7 @@ properties: fullName: standardDate summary: Gets the date on which standard time begins for the time zone. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -105,6 +112,7 @@ properties: Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC). remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 009c0cae..ab618111 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPUser` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: displayName summary: The display name for the current user. remarks: 'Example: `"John Doe"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: fullName: email summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -55,6 +59,7 @@ properties: fullName: isAnonymousGuestUser summary: Returns if the current user is an anonymous guest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +72,7 @@ properties: fullName: isExternalGuestUser summary: Returns true if the current user is an external guest. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -79,6 +85,7 @@ properties: fullName: loginName summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +98,7 @@ properties: fullName: preferUserTimeZone summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -103,6 +111,7 @@ properties: fullName: timeZoneInfo summary: Returns the user's regional timezone settings or undefined if they haven't been set. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 6a78b95e..8a9e9892 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPWeb` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: absoluteUrl summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: fullName: description summary: Returns the description of the current SPWeb. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -43,6 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -55,6 +59,7 @@ properties: fullName: id summary: The GUID that identifies the SPWeb on the server. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +72,7 @@ properties: fullName: isAppWeb summary: Returns true if this `SPWeb` the container web for an `SPApp`. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -79,6 +85,7 @@ properties: fullName: language summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +98,7 @@ properties: fullName: languageName summary: Returns the language name for the default language of the website. remarks: 'Example: en-US represents the English language in the US locale.' + example: [] isPreview: false isDeprecated: false syntax: @@ -103,6 +111,7 @@ properties: fullName: logoUrl summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' + example: [] isPreview: false isDeprecated: false syntax: @@ -117,6 +126,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -129,6 +139,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -143,6 +154,7 @@ properties: Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' + example: [] isPreview: false isDeprecated: false syntax: @@ -155,6 +167,7 @@ properties: fullName: timeZoneInfo summary: Returns the web's regional timezone settings or undefined if they haven't been set. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -167,6 +180,7 @@ properties: fullName: title summary: Returns the title of the current SPWeb. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 10530363..97df013f 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -45,6 +45,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Button on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -68,6 +69,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -91,6 +93,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -118,6 +121,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. + example: [] isPreview: true isDeprecated: false syntax: @@ -138,6 +142,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -161,6 +166,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -189,6 +195,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -212,6 +219,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' + example: [] isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' @@ -236,6 +244,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -248,6 +257,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Label on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -271,6 +281,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Link on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -294,6 +305,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -317,6 +329,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -340,6 +353,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 21b0ff56..186ec829 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 36677cef..60caae83 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: filters summary: Filters for the shared property. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index a568e853..c708a4a5 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -25,6 +26,7 @@ properties: When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index 84c97986..bd864d5a 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: filters summary: Filters for the shared source. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: default value - 'Connect to source' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index 221599b2..f4805c4b 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -28,6 +29,7 @@ properties: Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources. + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +55,7 @@ properties: The source id for a web part will be of the form WebPart.. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index 1467aac8..8c5cc183 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPopupWindowProps summary: Popup window props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: height summary: Height of pop up window. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: positionWindowPosition summary: The position of pop up window. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: title summary: Title of pop up window. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: width summary: Width of pop up window. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index eb8971e7..80baf21f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -18,6 +19,7 @@ properties: Besides the compound button, other button types will need more information provided to screen reader. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: fullName: ariaLabel summary: The aria label of the button for the benefit of screen readers. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -42,6 +45,7 @@ properties: fullName: buttonType summary: The type of button to render. Default value is ButtonType.normal. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -54,6 +58,7 @@ properties: fullName: description summary: Description of the action this button takes. Only used for compound buttons. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -66,6 +71,7 @@ properties: fullName: disabled summary: Whether the button is disabled. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -78,6 +84,7 @@ properties: fullName: icon summary: The button icon shown in command or hero type. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -93,6 +100,7 @@ properties: returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -105,6 +113,7 @@ properties: fullName: text summary: Display text of the element. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index 8b6e0f68..9b51c17f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: checked summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: disabled summary: Whether the property pane checkbox is disabled or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: text summary: Label to display next to the checkbox. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index 8c53fbbb..d4926fbc 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: ariaLabel summary: The aria label of the property pane choice group option for the benefit of screen readers. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ properties: Default value is false. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -42,6 +45,7 @@ properties: fullName: disabled summary: Whether the property pane choice group option is disabled or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -54,6 +58,7 @@ properties: fullName: iconProps summary: The Icon component props for choice field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -66,6 +71,7 @@ properties: fullName: imageSize summary: The width and height of the image in px for choice field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -86,6 +92,7 @@ properties: fullName: imageSrc summary: The src of image for choice field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -98,6 +105,7 @@ properties: fullName: key summary: A required key to uniquely identify the option. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -110,6 +118,7 @@ properties: fullName: selectedImageSrc summary: The src of image for choice field which is selected. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -122,6 +131,7 @@ properties: fullName: text summary: The text string for the option. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index 4f7bd524..4bfae47f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: officeFabricIconFontName summary: The name of the icon to use from the Office Fabric icon set. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index d93a8ad9..295550d2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: label summary: Descriptive label for the choice group. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: options summary: The options for the choice group. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index af4fcd70..432c2fbb 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: onShowPrimaryGroup summary: Callback when user clicks to show primary group. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: onShowSecondaryGroup summary: Callback when user clicks to show secondary group. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: primaryGroup summary: Primary group to show remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: secondaryGroup summary: Secondary group to show remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +68,7 @@ properties: fullName: showSecondaryGroup summary: Indicating whether the property pane should show primary group or the secondary group. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index a6ecfe2d..d39cbbb5 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: currentPage summary: Page to be displayed on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -31,6 +33,7 @@ properties: part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other properties will be unaffected. + example: [] isPreview: true isDeprecated: false syntax: @@ -43,6 +46,7 @@ properties: fullName: disableFocusTrap summary: Whether to disable trapping focus inside property pane. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -55,6 +59,7 @@ properties: fullName: loadingIndicatorDelayTime summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +72,7 @@ properties: fullName: pages summary: Total number of pages on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -86,6 +92,7 @@ properties: The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index 7ad1d67f..5f9fc1d8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +41,7 @@ properties: For more information, see the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +54,7 @@ properties: fullName: onDispose summary: This API is called when the component is unmounted from the host element. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +67,7 @@ properties: fullName: onRender summary: This API will be called once the custom field is mounted on the host element. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index 1cd10929..b44432bb 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDebounceProperty summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' remarks: '' +example: [] isPreview: true isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired for this property. remarks: The default value is 500. + example: [] isPreview: true isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: propertyName summary: Property to debounce. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index c38ba12b..ffd7d218 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: calloutMaxHeight summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index 79657fe2..f8c31b3b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: index summary: Index for this option. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: key summary: A key to uniquely identify this option. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: text summary: Text to render for this option. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: type summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index b5e8bcfe..36d8de4d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: ariaLabel summary: A description of the dropdown for the benefit of screen reader users. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: ariaSetSize summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -53,6 +57,7 @@ properties: fullName: calloutProps summary: Custom properties for Dropdown's Callout used to render options. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +70,7 @@ properties: fullName: disabled summary: Whether the property pane dropdown option is disabled or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -77,6 +83,7 @@ properties: fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -89,6 +96,7 @@ properties: fullName: label summary: Descriptive label for the Dropdown. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -101,6 +109,7 @@ properties: fullName: options summary: Collection of options for this Dropdown. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -113,6 +122,7 @@ properties: fullName: selectedKey summary: The key of the initially selected option. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index 6c575d36..fbe9c768 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: filters summary: Filters for the property pane dynamic field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the field.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -47,6 +50,7 @@ properties: the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field. + example: [] isPreview: false isDeprecated: false syntax: @@ -62,6 +66,7 @@ properties: default value - 'Connect to source' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 2f3eb31e..6ba03709 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: fields summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the property.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: sharedConfiguration summary: Configuration shared between all the entries of the set. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 33ad157f..8e898425 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' +example: [] isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' @@ -16,6 +17,7 @@ properties: fullName: ariaLabel summary: 'ARIA Label for text field, if any.' remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -28,6 +30,7 @@ properties: fullName: description summary: The text field input description. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -40,6 +43,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -57,6 +61,7 @@ properties: Make sure to set this only if you want to see an error message displayed for the text field. + example: [] isPreview: true isDeprecated: false syntax: @@ -69,6 +74,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -92,6 +98,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. + example: [] isPreview: true isDeprecated: false syntax: @@ -104,6 +111,7 @@ properties: fullName: placeholder summary: Placeholder text to be displayed in the text field. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -116,6 +124,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. + example: [] isPreview: true isDeprecated: false syntax: @@ -128,6 +137,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. + example: [] isPreview: true isDeprecated: false syntax: @@ -142,6 +152,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 193fe82f..2ad7e288 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: properties summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: shouldFocus summary: Whether this control should be focused. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: targetProperty summary: Target property from the web part's property bag. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: type summary: Type of the PropertyPane field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 34db3cfd..843087a8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: groupFields summary: List of PropertyPane fields. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: remarks: >- For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left empty, the group header will not render (not recommended for accordions). + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: isCollapsed summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -55,6 +59,7 @@ properties: remarks: >- The default value is false. Use this option to skip the rendering of group name to avoid empty group header being displayed. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index c365ee84..65e421ac 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: required summary: Whether the associated form field is required or not. remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: text summary: Display text fot the label. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 4421db5b..2e123827 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: disabled summary: Whether the property pane link is disabled or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: href summary: Location to which the link is targeted to. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: popupWindowProps summary: The props of pop up window. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -65,6 +69,7 @@ properties: \_top - Load the response into the original window. + example: [] isPreview: false isDeprecated: false syntax: @@ -77,6 +82,7 @@ properties: fullName: text summary: Display text for the link. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 7a2cbac6..76f583e9 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: displayGroupsAsAccordion summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: groups summary: List of groups to be displayed on the PropertyPane page. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -41,6 +44,7 @@ properties: fullName: header summary: PropertyPane page header. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index 73eac723..3c7d4728 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: description summary: Header to display. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: image summary: Image url for the background image. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This property is not used. diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index 03e61168..ca093fc1 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: ariaLabel summary: A description of the Slider for the benefit of screen readers. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: disabled summary: Whether or not the Slider is disabled. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: label summary: Description label of the Slider. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: max summary: The max value of the Slider. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +68,7 @@ properties: fullName: min summary: The min value of the Slider. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -75,6 +81,7 @@ properties: fullName: showValue summary: Whether to show the value on the right of the Slider. remarks: 'If you want to show the value by yourself, you may want to set this value to false.' + example: [] isPreview: false isDeprecated: false syntax: @@ -87,6 +94,7 @@ properties: fullName: step summary: The difference between the two adjacent values of the Slider. Defaults to 1. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -102,6 +110,7 @@ properties: Defaults to min. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -120,6 +129,7 @@ properties: ``` is specified, the value of the Slider has % after it. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index ef59e71b..a4cf23c0 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: ariaLabel summary: 'Aria Label for text field, if any.' remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: deferredValidationTime summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: description summary: The text field input description. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -68,6 +73,7 @@ properties: So, make sure to set this only if you want to see an error message displayed for the text field. + example: [] isPreview: false isDeprecated: false syntax: @@ -80,6 +86,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -112,6 +119,7 @@ properties: 2. The text length after each edit + example: [] isPreview: false isDeprecated: false syntax: @@ -132,6 +140,7 @@ properties: fullName: maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' + example: [] isPreview: false isDeprecated: false syntax: @@ -144,6 +153,7 @@ properties: fullName: multiline summary: Whether or not the text field is a multiline text field. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -167,6 +177,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. + example: [] isPreview: false isDeprecated: false syntax: @@ -179,6 +190,7 @@ properties: fullName: placeholder summary: placeholder text to be displayed in the text field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -191,6 +203,7 @@ properties: fullName: resizable summary: Whether or not the multiline text field is resizable. remarks: The default value is true. + example: [] isPreview: false isDeprecated: false syntax: @@ -203,6 +216,7 @@ properties: fullName: rows summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. + example: [] isPreview: false isDeprecated: false syntax: @@ -215,6 +229,7 @@ properties: fullName: underlined summary: Whether or not the text field is underlined. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -227,6 +242,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -239,6 +255,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -253,6 +270,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index dd4c3c93..e3c2aa91 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: checked summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' + example: [] isPreview: false isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: disabled summary: Optional disabled flag. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -39,6 +42,7 @@ properties: fullName: key summary: A key to uniquely identify the field. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -51,6 +55,7 @@ properties: fullName: label summary: A label for the toggle. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +68,7 @@ properties: fullName: offAriaLabel summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -75,6 +81,7 @@ properties: fullName: offText summary: Test display when toggle is OFF. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -87,6 +94,7 @@ properties: fullName: onAriaLabel summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -99,6 +107,7 @@ properties: fullName: onText summary: Text to display when toggle is ON. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index fa6c0ef0..181d60f3 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PopupWindowPosition summary: The position of pop up window. remarks: '' +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index 945c8d11..f6c1af58 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index e7d1ce3a..78062421 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -7,6 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). remarks: '' +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index fb871153..76f2de16 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -8,6 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 3e750439..f95a2a90 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -10,6 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "SearchQueryModifier". remarks: '' +example: [] isPreview: true isDeprecated: false type: class @@ -23,6 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: true isDeprecated: false syntax: @@ -37,6 +39,7 @@ properties: Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the original query will be used instead of the modified one. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -52,6 +55,7 @@ methods: fullName: 'modifySearchQuery(query, scenario)' summary: Returns a modified search query. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index f7bc45b7..034e43dc 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: IQuery summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. remarks: Additional properties can be added to the object to pass data between extensions. +example: [] isPreview: true isDeprecated: false type: interface @@ -15,6 +16,7 @@ properties: fullName: originalQueryText summary: Query text that the user provided. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: @@ -27,6 +29,7 @@ properties: fullName: queryText summary: Text of the query. remarks: '' + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index 8fbe58b8..ad471c5c 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryModifierContext summary: Context for the search query modifier extensions. remarks: '' +example: [] isPreview: true isDeprecated: false type: class diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index 7c12b98e..df857dc9 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryScenario summary: Scenario for the search query modifier. remarks: '' +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index cacbc988..9830ca7e 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -13,6 +13,7 @@ enums: - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' interfaces: - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' @@ -57,6 +58,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Button on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -83,6 +85,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -109,6 +112,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -139,6 +143,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. + example: [] isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -162,6 +167,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -188,6 +194,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -219,6 +226,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -245,6 +253,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' + example: [] isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -271,6 +280,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -286,6 +296,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Label on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -312,6 +323,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Link on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -338,6 +350,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -364,6 +377,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -390,6 +404,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 2923f4a5..8d525fb6 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -19,6 +19,7 @@ remarks: >- updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision. +example: [] isPreview: false isDeprecated: false type: class @@ -32,6 +33,7 @@ constructors: It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. + example: [] isPreview: false isDeprecated: false syntax: @@ -52,6 +54,7 @@ properties: returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. + example: [] isPreview: false isDeprecated: false syntax: @@ -67,6 +70,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: false isDeprecated: false syntax: @@ -81,6 +85,7 @@ properties: This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -98,6 +103,7 @@ properties: The default value is false. + example: [] isPreview: false isDeprecated: false syntax: @@ -114,6 +120,7 @@ properties: This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not. remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' + example: [] isPreview: false isDeprecated: false syntax: @@ -128,6 +135,7 @@ properties: This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -142,6 +150,7 @@ properties: remarks: >- Web parts should utilize this property to perform operations such as any conditional styling of components based on the initial available width for the web part. + example: [] isPreview: false isDeprecated: false syntax: @@ -155,6 +164,7 @@ methods: fullName: clearError() summary: This API should be used to clear the error message from the web part display area. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -172,6 +182,7 @@ methods: remarks: >- Web parts should utilize this method to perform operations such as potentially re-rendering components based on the new available width for the web part. + example: [] isPreview: false isDeprecated: false syntax: @@ -194,6 +205,7 @@ methods: The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. + example: [] isPreview: false isDeprecated: false syntax: @@ -217,6 +229,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. + example: [] isPreview: false isDeprecated: false syntax: @@ -234,6 +247,7 @@ methods: remarks: >- Developers sould not call render in overridden method. It can lead to unpredicted re-flow of the web part. render will be called from the base class when needed. + example: [] isPreview: false isDeprecated: false syntax: @@ -255,6 +269,7 @@ methods: This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -272,6 +287,7 @@ methods: initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -291,6 +307,7 @@ methods: This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index d868a252..47b883ee 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -7,6 +7,7 @@ summary: >- This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. remarks: '' +example: [] isPreview: false isDeprecated: false type: class @@ -20,6 +21,7 @@ constructors: It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. + example: [] isPreview: false isDeprecated: false syntax: @@ -34,6 +36,7 @@ properties: returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -49,6 +52,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. + example: [] isPreview: false isDeprecated: false syntax: @@ -63,6 +67,7 @@ properties: The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -75,6 +80,7 @@ properties: fullName: description summary: Description of the WebPart remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -97,6 +103,7 @@ properties: NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane button is clicked. + example: [] isPreview: false isDeprecated: false syntax: @@ -109,6 +116,7 @@ properties: fullName: displayMode summary: This property is the current display mode of the web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -124,6 +132,7 @@ properties: that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -136,6 +145,7 @@ properties: fullName: properties summary: This property is the pointer to the custom property bag of the web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -152,6 +162,7 @@ properties: remarks: >- See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more information about how to define metadata + example: [] isPreview: false isDeprecated: false syntax: @@ -164,6 +175,7 @@ properties: fullName: title summary: Title of the WebPart remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -186,6 +198,7 @@ methods: See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -209,6 +222,7 @@ methods: 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including 'loadPropertyPaneResources' promise. + example: [] isPreview: false isDeprecated: false syntax: @@ -235,6 +249,7 @@ methods: by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. + example: [] isPreview: false isDeprecated: false syntax: @@ -263,6 +278,7 @@ methods: This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -282,6 +298,7 @@ methods: some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. + example: [] isPreview: false isDeprecated: false syntax: @@ -297,6 +314,7 @@ methods: remarks: >- If the web part is initialized or re-initialized in a different display mode then this lifecycle method is not called. + example: [] isPreview: false isDeprecated: false syntax: @@ -318,6 +336,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. + example: [] isPreview: false isDeprecated: false syntax: @@ -334,6 +353,7 @@ methods: This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. + example: [] isPreview: false isDeprecated: false syntax: @@ -356,6 +376,7 @@ methods: - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - When the user switches web parts then the current web part gets this event. + example: [] isPreview: false isDeprecated: false syntax: @@ -374,6 +395,7 @@ methods: - When the PropertyPane is opened. - When the user switches web parts then the new web part gets this event. + example: [] isPreview: false isDeprecated: false syntax: @@ -389,6 +411,7 @@ methods: This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -415,6 +438,7 @@ methods: fullName: onPropertyPaneRendered() summary: This API is invoked when the PropertyPane is rendered. virtual remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 00acc2c4..a20a586b 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -12,6 +12,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseWebPartContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -24,18 +25,20 @@ properties: remarks: >- Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas. + example: [] isPreview: true isDeprecated: false syntax: content: 'get formFactor(): WebPartFormFactor;' return: - type: '' + type: '' - name: manifest uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' package: '@microsoft/sp-webpart-base!' fullName: manifest summary: Manifest for the client-side component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -48,6 +51,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -60,6 +64,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index addc7d13..600ff48c 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 18d97afd..40761f66 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -7,6 +7,7 @@ summary: >- Interface to be implemented by a component that should display the loading indicator and error messages for a web part. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ methods: fullName: clearError(domElement) summary: Clear the webpart error message. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -34,6 +36,7 @@ methods: fullName: clearLoadingIndicator(domElement) summary: Clear the loading indicator. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,16 +48,19 @@ methods: return: type: void description: '' - - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' + - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' + fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' summary: Display a loading spinner. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: - content: 'displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number): void;' + content: >- + displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number, clearDomElementCallback?: + ClearDomElementCallback): void; parameters: - id: domElement description: the web part container div. @@ -65,19 +71,27 @@ methods: - id: timeout description: timeout to render the loading indicator. Default is 1500ms. type: number + - id: clearDomElementCallback + description: >- + Callback to clear the dom node before rendering the indicator. Standard DOM API will be used after the + callback. + type: '' return: type: void description: '' - - name: 'renderError(domElement, error)' + - name: 'renderError(domElement, error, clearDomElementCallback)' uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'renderError(domElement, error)' + fullName: 'renderError(domElement, error, clearDomElementCallback)' summary: Render the provided error message in the webpart container div. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: - content: 'renderError(domElement: HTMLElement, error: Error | string): void;' + content: >- + renderError(domElement: HTMLElement, error: Error | string, clearDomElementCallback?: ClearDomElementCallback): + void; parameters: - id: domElement description: the web part container div. @@ -85,6 +99,11 @@ methods: - id: error description: the error message. type: Error | string + - id: clearDomElementCallback + description: >- + Callback to clear the dom node before rendering the error element. Standard DOM API will be used after the + callback. + type: '' return: type: void description: '' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index 161a032c..b251db60 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index af437a0f..76c11b78 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 55dffebc..8dec184b 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index 22b09022..a58567d1 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index e3b5f7a0..be17e1ae 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IMicrosoftTeams summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) + example: [] isPreview: false isDeprecated: false syntax: @@ -29,6 +31,7 @@ properties: fullName: teamsJs summary: Microsoft Teams SDK. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index dce54583..97778dc3 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -7,6 +7,7 @@ summary: >- Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -17,6 +18,7 @@ methods: fullName: close() summary: This API should be used to close the PropertyPane to help configure the web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -30,6 +32,7 @@ methods: fullName: isPropertyPaneOpen() summary: Returns true if the PropertyPane is open. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +48,7 @@ methods: remarks: >- For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. + example: [] isPreview: false isDeprecated: false syntax: @@ -58,6 +62,7 @@ methods: fullName: open() summary: This API should be used to open the PropertyPane to help configure the web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -71,6 +76,7 @@ methods: fullName: openDetails(context) summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' + example: [] isPreview: false isDeprecated: false syntax: @@ -90,6 +96,7 @@ methods: remarks: >- This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 37584cbb..e7cf9f6c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 19a9f4c8..cea9643d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 424f3c0c..2f4196c6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 547ee007..3e5942f2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 8c04c3f6..a4cfa04d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 138c23ac..20a3b896 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 3aa8169f..6972d5a0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 940eaed8..27168147 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 0c9f33b7..0df7e9ac 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index da82bb26..e53d1b59 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 5b80e09a..d22d661f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index d04615bc..28e5fea0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 09041671..7cb4d1f4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 4a2da7de..098e55e5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index e134e1c4..0ee57f36 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' +example: [] isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 869b3839..10976c2a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index 3ac0858a..9463e163 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index bc16d438..f343e4ee 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index da0ff22b..533f4891 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index 98b51f0e..fd99d165 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index cd3a9e30..d289960c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index b7f6ffae..1bd769eb 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 89f89913..1c29fea8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 05c48a56..bacb7353 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index 10fb2080..1e8f87c7 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: ISDKs summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -19,6 +20,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index f64fde7d..b901b0ca 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -7,6 +7,7 @@ summary: >- This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data. remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -26,6 +27,7 @@ properties: Example: `"1.0"` + example: [] isPreview: false isDeprecated: false syntax: @@ -50,6 +52,7 @@ properties: 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } ``` + example: [] isPreview: true isDeprecated: false syntax: @@ -80,6 +83,7 @@ properties: 'aBooleanProperty': true } ``` + example: [] isPreview: true isDeprecated: false syntax: @@ -106,6 +110,7 @@ properties: Example: `{ 'value': 'text value' }` + example: [] isPreview: false isDeprecated: false syntax: @@ -118,6 +123,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 0f7d8cfd..78dfb218 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -8,6 +8,7 @@ remarks: >- A "context" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -21,6 +22,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -33,6 +35,7 @@ properties: fullName: httpClient summary: HttpClient instance scoped to this web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -45,6 +48,7 @@ properties: fullName: instanceId summary: Web part instance id. This is a globally unique value. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -57,6 +61,7 @@ properties: fullName: manifest summary: Manifest for the client-side web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -69,6 +74,7 @@ properties: fullName: pageContext summary: SharePoint page context. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -81,6 +87,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -93,6 +100,7 @@ properties: fullName: spHttpClient summary: SPHttpClient instance scoped to this web part. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -105,6 +113,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -117,6 +126,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 8ad852eb..e597506b 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -8,6 +8,7 @@ remarks: >- When the `serialize()` API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize. +example: [] isPreview: false isDeprecated: false type: interface @@ -27,6 +28,7 @@ properties: Example: `"1.0"` + example: [] isPreview: false isDeprecated: false syntax: @@ -44,6 +46,7 @@ properties: Supported values: string with the description. Example: `"Text"` + example: [] isPreview: false isDeprecated: false syntax: @@ -73,6 +76,7 @@ properties: } ``` + example: [] isPreview: true isDeprecated: false syntax: @@ -103,6 +107,7 @@ properties: 'aBooleanProperty': true } ``` + example: [] isPreview: true isDeprecated: false syntax: @@ -121,6 +126,7 @@ properties: fullName: id summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' + example: [] isPreview: false isDeprecated: false syntax: @@ -138,6 +144,7 @@ properties: supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` + example: [] isPreview: false isDeprecated: false syntax: @@ -158,6 +165,7 @@ properties: Example: `{ 'value': 'text value' }` + example: [] isPreview: false isDeprecated: false syntax: @@ -170,6 +178,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -187,6 +196,7 @@ properties: Supported values: string less than 100 characters Example: `"Text"` + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index fb3050af..43b2f426 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -56,6 +56,7 @@ remarks: >- This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated. +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 3bf6ad55..274814b6 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IWebPartPropertyMetadata summary: This is the structure used for map values in `IWebPartPropertiesMetadata` remarks: '' +example: [] isPreview: false isDeprecated: false type: interface @@ -28,6 +29,7 @@ properties: Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index eda5002f..45622192 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -5,6 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index 90f13878..f8ca6168 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -7,6 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 9bbcb618..c9fe9146 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -8,6 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index d9f2cdf2..dd7e90f1 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -9,6 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebPartContext` class. +example: [] isPreview: false isDeprecated: false type: class @@ -19,6 +20,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -35,6 +37,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This function has been deprecated' @@ -48,6 +51,7 @@ properties: fullName: sdks summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -60,6 +64,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: @@ -74,6 +79,7 @@ properties: This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key. remarks: '' + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index efca261d..eb71fde2 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -5,25 +5,22 @@ package: '@microsoft/sp-webpart-base!' fullName: WebPartFormFactor summary: Form factor of the web part. remarks: >- - This will change based on how the web part is used, not by the web part - itself. In cases like web parts used in Teams tab or as App pages, it will - have full size form factor. If a web part is render in a canvas, with other - web parts, it will have a canvas web part form factor. + This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams + tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it + will have a canvas web part form factor. +example: [] isPreview: true isDeprecated: false fields: - name: FullSize uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' package: '@microsoft/sp-webpart-base!' - summary: >- - Full size form factor. This means the web part is rendered in full size, - taking all space available in the page. - numericValue: 1 + summary: 'Full size form factor. This means the web part is rendered in full size, taking all space available in the page.' + value: '1' - name: Standard uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' package: '@microsoft/sp-webpart-base!' summary: >- - Standard form factor. This means the web part is rendered in a canvas, - potentially with other web parts. In this case, the width is determined by - the container, and web part self-adjust for height. - numericValue: 0 + Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this + case, the width is determined by the container, and web part self-adjust for height. + value: '0' diff --git a/SP-Framework/toc.yml b/SP-Framework/toc.yml new file mode 100644 index 00000000..809eb39f --- /dev/null +++ b/SP-Framework/toc.yml @@ -0,0 +1,678 @@ +items: + - name: SharePoint Framework reference + href: ~/overview/sharepoint.md + items: + - name: decorators + uid: '@microsoft/decorators!' + - name: office-ui-fabric-react-bundle + uid: '@microsoft/office-ui-fabric-react-bundle!' + - name: sp-adaptive-card-extension-base + uid: '@microsoft/sp-adaptive-card-extension-base!' + items: + - name: AdaptiveCardExtensionContext + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - name: BaseAdaptiveCardExtension + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + - name: BaseAdaptiveCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + - name: BaseBasicCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + - name: BaseCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + - name: BaseImageCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + - name: BasePrimaryTextCardView + uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + - name: BaseView + uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + - name: IAdaptiveCardExtensionPropertiesMetadata + uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + - name: IAdaptiveCardExtensionPropertyMetadata + uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + - name: IAttachmentError + uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' + - name: IBaseActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + - name: IBaseActionErrorArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' + - name: IBaseCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + - name: IBasicCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + - name: ICachedLoadParameters + uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + - name: ICacheSettings + uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + - name: ICardButton + uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + - name: IConfirmationDialog + uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + - name: IExternalLinkCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + - name: IExternalLinkParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + - name: IGetLocationAction + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + - name: IGetLocationActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + - name: IGetLocationActionParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - name: IGetLocationCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + - name: IImageCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + - name: ILocation + uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - name: ILocationErrorArguments + uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' + - name: IPrimaryTextCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + - name: IQuickViewCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + - name: IQuickViewParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + - name: ISelectMediaAction + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + - name: ISelectMediaActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + - name: ISelectMediaActionErrorArguments + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' + - name: ISelectMediaActionParameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - name: ISelectMediaAttachment + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + - name: ISelectMediaCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + - name: IShowCardActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + - name: IShowLocationAction + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + - name: IShowLocationActionParameters + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - name: IShowLocationCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + - name: ISPFxAdaptiveCard + uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + - name: ISubmitActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + - name: ISubmitCardAction + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + - name: ISubmitCardParameters + uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + - name: MediaType + uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + - name: QuickViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + - name: ViewNavigator + uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + - name: sp-application-base + uid: '@microsoft/sp-application-base!' + items: + - name: ApplicationAccessor + uid: '@microsoft/sp-application-base!ApplicationAccessor:class' + - name: ApplicationCustomizerContext + uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + - name: BaseApplicationCustomizer + uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + - name: IPlaceholderCreateContentOptions + uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + - name: PlaceholderContent + uid: '@microsoft/sp-application-base!PlaceholderContent:class' + - name: PlaceholderName + uid: '@microsoft/sp-application-base!PlaceholderName:enum' + - name: PlaceholderProvider + uid: '@microsoft/sp-application-base!PlaceholderProvider:class' + - name: sp-component-base + uid: '@microsoft/sp-component-base!' + items: + - name: BaseComponent + uid: '@microsoft/sp-component-base!BaseComponent:class' + - name: BaseComponentContext + uid: '@microsoft/sp-component-base!BaseComponentContext:class' + - name: DynamicDataProvider + uid: '@microsoft/sp-component-base!DynamicDataProvider:class' + - name: DynamicDataSourceManager + uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' + - name: DynamicProperty + uid: '@microsoft/sp-component-base!DynamicProperty:class' + - name: IComponentPropertyMetadata + uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + - name: IReadonlyFontStyles + uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - name: IReadonlyTheme + uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + - name: ISerializedServerProcessedData + uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + - name: ITheme + uid: '@microsoft/sp-component-base!ITheme:interface' + - name: ThemeChangedEventArgs + uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + - name: ThemeProvider + uid: '@microsoft/sp-component-base!ThemeProvider:class' + - name: sp-core-library + uid: '@microsoft/sp-core-library!' + items: + - name: DisplayMode + uid: '@microsoft/sp-core-library!DisplayMode:enum' + - name: Environment + uid: '@microsoft/sp-core-library!Environment:class' + - name: EnvironmentType + uid: '@microsoft/sp-core-library!EnvironmentType:enum' + - name: Guid + uid: '@microsoft/sp-core-library!Guid:class' + - name: IDisposable + uid: '@microsoft/sp-core-library!IDisposable:interface' + - name: IRandomNumberGenerator + uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - name: IServiceCollection + uid: '@microsoft/sp-core-library!IServiceCollection:interface' + - name: ISPEventObserver + uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + - name: ITimeProvider + uid: '@microsoft/sp-core-library!ITimeProvider:interface' + - name: Log + uid: '@microsoft/sp-core-library!Log:class' + - name: RandomNumberGenerator + uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' + - name: ServiceKey + uid: '@microsoft/sp-core-library!ServiceKey:class' + - name: ServiceScope + uid: '@microsoft/sp-core-library!ServiceScope:class' + - name: Session + uid: '@microsoft/sp-core-library!Session:class' + - name: SPEvent + uid: '@microsoft/sp-core-library!SPEvent:class' + - name: SPEventArgs + uid: '@microsoft/sp-core-library!SPEventArgs:class' + - name: Text_2 + uid: '@microsoft/sp-core-library!Text_2:class' + - name: TimeProvider + uid: '@microsoft/sp-core-library!TimeProvider:class' + - name: UrlQueryParameterCollection + uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + - name: Validate + uid: '@microsoft/sp-core-library!Validate:class' + - name: Version + uid: '@microsoft/sp-core-library!Version:class' + - name: sp-diagnostics + uid: '@microsoft/sp-diagnostics!' + - name: sp-dialog + uid: '@microsoft/sp-dialog!' + items: + - name: BaseDialog + uid: '@microsoft/sp-dialog!BaseDialog:class' + - name: Dialog + uid: '@microsoft/sp-dialog!Dialog:class' + - name: IAlertOptions + uid: '@microsoft/sp-dialog!IAlertOptions:interface' + - name: IDialogConfiguration + uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' + - name: IDialogShowOptions + uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + - name: IPromptOptions + uid: '@microsoft/sp-dialog!IPromptOptions:interface' + - name: ISecondaryDialogProvider + uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' + - name: sp-dynamic-data + uid: '@microsoft/sp-dynamic-data!' + items: + - name: DynamicDataReference + uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' + - name: IDynamicDataAnnotatedPropertyValue + uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + - name: IDynamicDataCallables + uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - name: IDynamicDataEventDefinition + uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + - name: IDynamicDataPropertyDefinition + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + - name: IDynamicDataPropertyMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + - name: IDynamicDataPropertyValueMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + - name: IDynamicDataPropertyValueMetadataCollection + uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - name: IDynamicDataSource + uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + - name: IDynamicDataSourceMetadata + uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + - name: sp-extension-base + uid: '@microsoft/sp-extension-base!' + items: + - name: BaseExtension + uid: '@microsoft/sp-extension-base!BaseExtension:class' + - name: ExtensionContext + uid: '@microsoft/sp-extension-base!ExtensionContext:class' + - name: sp-http + uid: '@microsoft/sp-http!' + items: + - name: AadHttpClient + uid: '@microsoft/sp-http!AadHttpClient:class' + - name: AadHttpClientConfiguration + uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' + - name: AadHttpClientFactory + uid: '@microsoft/sp-http!AadHttpClientFactory:class' + - name: AadHttpClientResponse + uid: '@microsoft/sp-http!AadHttpClientResponse:class' + - name: AadTokenProvider + uid: '@microsoft/sp-http!AadTokenProvider:class' + - name: AadTokenProviderFactory + uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + - name: BeforeRedirectEventArgs + uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' + - name: DigestCache + uid: '@microsoft/sp-http!DigestCache:class' + - name: GraphRequest + uid: '@microsoft/sp-http!GraphRequest:interface' + - name: HttpClient + uid: '@microsoft/sp-http!HttpClient:class' + - name: HttpClientConfiguration + uid: '@microsoft/sp-http!HttpClientConfiguration:class' + - name: HttpClientResponse + uid: '@microsoft/sp-http!HttpClientResponse:class' + - name: IAadHttpClientConfiguration + uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - name: IAadHttpClientConfigurations + uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - name: IAadHttpClientOptions + uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' + - name: IAadTokenProvider + uid: '@microsoft/sp-http!IAadTokenProvider:interface' + - name: IAadTokenProviderConfiguration + uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - name: IBeforeRedirectEventArgs + uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' + - name: IDigestCache + uid: '@microsoft/sp-http!IDigestCache:interface' + - name: IHttpClientConfiguration + uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + - name: IHttpClientConfigurations + uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' + - name: IHttpClientOptions + uid: '@microsoft/sp-http!IHttpClientOptions:interface' + - name: ISPHttpClientBatchConfiguration + uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - name: ISPHttpClientBatchConfigurations + uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - name: ISPHttpClientBatchCreationOptions + uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - name: ISPHttpClientBatchOptions + uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - name: ISPHttpClientCommonConfiguration + uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - name: ISPHttpClientConfiguration + uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - name: ISPHttpClientConfigurations + uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - name: ISPHttpClientOptions + uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' + - name: ITokenAcquisitionEventArgs + uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + - name: MSGraphClient + uid: '@microsoft/sp-http!MSGraphClient:class' + - name: MSGraphClientFactory + uid: '@microsoft/sp-http!MSGraphClientFactory:class' + - name: ODataVersion + uid: '@microsoft/sp-http!ODataVersion:class' + - name: SPHttpClient + uid: '@microsoft/sp-http!SPHttpClient:class' + - name: SPHttpClientBatch + uid: '@microsoft/sp-http!SPHttpClientBatch:class' + - name: SPHttpClientBatchConfiguration + uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + - name: SPHttpClientCommonConfiguration + uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + - name: SPHttpClientConfiguration + uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' + - name: SPHttpClientResponse + uid: '@microsoft/sp-http!SPHttpClientResponse:class' + - name: SPHttpHeader + uid: '@microsoft/sp-http!SPHttpHeader:enum' + - name: TokenAcquisitionEventArgs + uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + - name: sp-image-helper + uid: '@microsoft/sp-image-helper!' + items: + - name: IImageHelperRequest + uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' + - name: ImageHelper + uid: '@microsoft/sp-image-helper!ImageHelper:class' + - name: sp-list-subscription + uid: '@microsoft/sp-list-subscription!' + items: + - name: ICreateSubscriptionSettings + uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - name: IListSubscription + uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + - name: ISubscriptionCallbacks + uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - name: ListSubscriptionFactory + uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' + - name: sp-listview-extensibility + uid: '@microsoft/sp-listview-extensibility!' + items: + - name: BaseFieldCustomizer + uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - name: BaseListViewCommandSet + uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + - name: ColumnAccessor + uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + - name: Command + uid: '@microsoft/sp-listview-extensibility!Command:class' + - name: FieldCustomizerContext + uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - name: IColumn + uid: '@microsoft/sp-listview-extensibility!IColumn:interface' + - name: IFieldCustomizerCellEventParameters + uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - name: IFilter + uid: '@microsoft/sp-listview-extensibility!IFilter:interface' + - name: IFolderInfo + uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - name: IList + uid: '@microsoft/sp-listview-extensibility!IList:interface' + - name: IListViewAccessorState + uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' + - name: IListViewCommandSetExecuteEventParameters + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - name: IListViewCommandSetListViewUpdatedParameters + uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + - name: IRow + uid: '@microsoft/sp-listview-extensibility!IRow:interface' + - name: IView + uid: '@microsoft/sp-listview-extensibility!IView:interface' + - name: ListItemAccessor + uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + - name: ListViewAccessor + uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + - name: ListViewAccessorStateChanges + uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' + - name: ListViewCommandSetContext + uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - name: ListViewStateChangedEventArgs + uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' + - name: RowAccessor + uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + - name: SelectedRowsChangedEventArgs + uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + - name: sp-loader + uid: '@microsoft/sp-loader!' + items: + - name: ILoadScriptOptions + uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + - name: SPComponentLoader + uid: '@microsoft/sp-loader!SPComponentLoader:class' + - name: sp-lodash-subset + uid: '@microsoft/sp-lodash-subset!' + - name: sp-module-interfaces + uid: '@microsoft/sp-module-interfaces!' + items: + - name: IAdaptiveCardExtensionManifest + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + - name: IAdaptiveCardExtensionManifestEntry + uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + - name: IClientSideAssemblyManifest + uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - name: IClientSideComponentLoaderConfiguration + uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - name: IClientSideComponentManifest + uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - name: IClientSideExtensionManifest + uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - name: IClientSideLibraryManifest + uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - name: IClientSideManifestBase + uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - name: IClientSideWebPartManifest + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - name: IClientSideWebPartManifestEntry + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - name: IClientSideWebPartManifestInstance + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - name: ICommandDefinition + uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - name: ICommandSetExtensionManifest + uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - name: IComponentModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - name: ILocalizedPathModuleConfiguration + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - name: ILocalizedString + uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - name: IModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' + - name: IPath + uid: '@microsoft/sp-module-interfaces!IPath:interface' + - name: IPathModuleConfiguration + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + - name: PredefinedGroup + uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + - name: sp-odata-types + uid: '@microsoft/sp-odata-types!' + items: + - name: _IODataUserId + uid: '@microsoft/sp-odata-types!_IODataUserId:interface' + - name: IODataBasePermission + uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + - name: IODataChangeToken + uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + - name: IODataContextWebInformation + uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - name: IODataList + uid: '@microsoft/sp-odata-types!IODataList:interface' + - name: IODataListItem + uid: '@microsoft/sp-odata-types!IODataListItem:interface' + - name: IODataNavigationNode + uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + - name: IODataNavigationNodeCollection + uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + - name: IODataUser + uid: '@microsoft/sp-odata-types!IODataUser:interface' + - name: IODataUserCustomAction + uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + - name: IODataWeb + uid: '@microsoft/sp-odata-types!IODataWeb:interface' + - name: sp-page-context + uid: '@microsoft/sp-page-context!' + items: + - name: CultureInfo + uid: '@microsoft/sp-page-context!CultureInfo:class' + - name: ISPSystemTime + uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + - name: ISPTimeZoneData + uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' + - name: PageContext + uid: '@microsoft/sp-page-context!PageContext:class' + - name: SPField + uid: '@microsoft/sp-page-context!SPField:class' + - name: SPList + uid: '@microsoft/sp-page-context!SPList:class' + - name: SPListItem + uid: '@microsoft/sp-page-context!SPListItem:class' + - name: SPPermission + uid: '@microsoft/sp-page-context!SPPermission:class' + - name: SPSite + uid: '@microsoft/sp-page-context!SPSite:class' + - name: SPTimeZone + uid: '@microsoft/sp-page-context!SPTimeZone:class' + - name: SPUser + uid: '@microsoft/sp-page-context!SPUser:class' + - name: SPWeb + uid: '@microsoft/sp-page-context!SPWeb:class' + - name: sp-property-pane + uid: '@microsoft/sp-property-pane!' + items: + - name: DynamicDataSharedDepth + uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - name: IDynamicDataSharedPropertyConfiguration + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + - name: IDynamicDataSharedPropertyFilters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - name: IDynamicDataSharedSourceConfiguration + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - name: IDynamicDataSharedSourceFilters + uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - name: IPopupWindowProps + uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - name: IPropertyPaneButtonProps + uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - name: IPropertyPaneCheckboxProps + uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - name: IPropertyPaneChoiceGroupOption + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - name: IPropertyPaneChoiceGroupOptionIconProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - name: IPropertyPaneChoiceGroupProps + uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - name: IPropertyPaneConditionalGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - name: IPropertyPaneConfiguration + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - name: IPropertyPaneCustomFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - name: IPropertyPaneDebounceProperty + uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - name: IPropertyPaneDropdownCalloutProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - name: IPropertyPaneDropdownOption + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - name: IPropertyPaneDropdownProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - name: IPropertyPaneDynamicFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - name: IPropertyPaneDynamicFieldSetProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - name: IPropertyPaneDynamicTextFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - name: IPropertyPaneField + uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - name: IPropertyPaneGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - name: IPropertyPaneLabelProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - name: IPropertyPaneLinkProps + uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - name: IPropertyPanePage + uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - name: IPropertyPanePageHeader + uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - name: IPropertyPaneSliderProps + uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - name: IPropertyPaneTextFieldProps + uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - name: IPropertyPaneToggleProps + uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - name: PopupWindowPosition + uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - name: PropertyPaneButtonType + uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - name: PropertyPaneDropdownOptionType + uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - name: PropertyPaneFieldType + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - name: sp-search-extensibility + uid: '@microsoft/sp-search-extensibility!' + items: + - name: BaseSearchQueryModifier + uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - name: IQuery + uid: '@microsoft/sp-search-extensibility!IQuery:interface' + - name: SearchQueryModifierContext + uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + - name: SearchQueryScenario + uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + - name: sp-webpart-base + uid: '@microsoft/sp-webpart-base!' + items: + - name: BaseClientSideWebPart + uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + - name: BaseWebPart + uid: '@microsoft/sp-webpart-base!BaseWebPart:class' + - name: BaseWebPartContext + uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' + - name: DynamicDataSharedDepth + uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + - name: IClientSideWebPartStatusRenderer + uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + - name: IDynamicDataSharedPropertyConfiguration + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + - name: IDynamicDataSharedPropertyFilters + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + - name: IDynamicDataSharedSourceConfiguration + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + - name: IDynamicDataSharedSourceFilters + uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + - name: IMicrosoftTeams + uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - name: IPropertyPaneAccessor + uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - name: IPropertyPaneButtonProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - name: IPropertyPaneCheckboxProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - name: IPropertyPaneChoiceGroupOption + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + - name: IPropertyPaneChoiceGroupOptionIconProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + - name: IPropertyPaneChoiceGroupProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - name: IPropertyPaneConditionalGroup + uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + - name: IPropertyPaneConfiguration + uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + - name: IPropertyPaneCustomFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - name: IPropertyPaneDropdownCalloutProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + - name: IPropertyPaneDropdownOption + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + - name: IPropertyPaneDropdownProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - name: IPropertyPaneDynamicFieldFilters + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + - name: IPropertyPaneDynamicFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - name: IPropertyPaneDynamicFieldSetProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - name: IPropertyPaneDynamicTextFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - name: IPropertyPaneField + uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + - name: IPropertyPaneGroup + uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + - name: IPropertyPaneLabelProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - name: IPropertyPaneLinkProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - name: IPropertyPanePage + uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + - name: IPropertyPanePageHeader + uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + - name: IPropertyPaneSliderProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - name: IPropertyPaneTextFieldProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - name: IPropertyPaneToggleProps + uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + - name: ISDKs + uid: '@microsoft/sp-webpart-base!ISDKs:interface' + - name: ISerializedWebPartData + uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + - name: IWebPartContext + uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' + - name: IWebPartData + uid: '@microsoft/sp-webpart-base!IWebPartData:interface' + - name: IWebPartPropertiesMetadata + uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + - name: IWebPartPropertyMetadata + uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' + - name: PropertyPaneButtonType + uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + - name: PropertyPaneDropdownOptionType + uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + - name: PropertyPaneFieldType + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + - name: WebPartContext + uid: '@microsoft/sp-webpart-base!WebPartContext:class' + - name: WebPartFormFactor + uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' From 92b103edba62cf3f3a95f7e3ffa1b200bb2a6eb2 Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Wed, 16 Feb 2022 15:57:16 -0500 Subject: [PATCH 50/55] 1.14.0 GA API Refernce --- .../sp-adaptive-card-extension-base.yml | 8 +++++ .../cardsize.yml | 11 +++++++ .../devicecontext.yml | 13 ++++++++ .../iactionarguments.yml | 19 ++++++++++++ .../iactionerror.yml | 14 +++++++++ .../iactionerrorarguments.yml | 20 ++++++++++++ .../icardaction.yml | 11 +++++++ .../iselectmediaactionarguments.yml | 13 ++++++++ .../rendertype.yml | 11 +++++++ SP-Framework/sp-component-base.yml | 2 ++ .../sp-component-base/ireadonlyrawstyle.yml | 11 +++++++ SP-Framework/sp-core-library.yml | 2 ++ .../sp-core-library/servicecreator.yml | 11 +++++++ .../sp-listview-extensibility/command.yml | 13 ++++++++ .../sp-listview-extensibility/icolumn.yml | 18 +++++------ .../sp-listview-extensibility/ifilter.yml | 6 ++-- .../sp-listview-extensibility/ifolderinfo.yml | 4 +-- .../sp-listview-extensibility/ilist.yml | 8 ++--- .../ilistviewaccessorstate.yml | 20 ++++++------ .../sp-listview-extensibility/irow.yml | 4 +-- .../sp-listview-extensibility/iview.yml | 8 ++--- .../listviewaccessor.yml | 18 +++++------ .../listviewaccessorstatechanges.yml | 2 +- .../listviewstatechangedeventargs.yml | 6 ++-- SP-Framework/sp-lodash-subset.yml | 3 ++ SP-Framework/sp-lodash-subset/cancelable.yml | 11 +++++++ .../sp-lodash-subset/throttlesettings.yml | 11 +++++++ SP-Framework/sp-module-interfaces.yml | 3 ++ .../sp-module-interfaces/componenttype.yml | 11 +++++++ .../sp-module-interfaces/extensiontype.yml | 13 ++++++++ SP-Framework/sp-page-context.yml | 2 ++ .../sp-page-context/spdayofweek-typealias.yml | 11 +++++++ SP-Framework/sp-property-pane.yml | 2 ++ .../ipropertypanedynamicfieldfilters.yml | 13 ++++++++ SP-Framework/toc.yml | 31 +++++++++++++++++++ 35 files changed, 317 insertions(+), 47 deletions(-) create mode 100644 SP-Framework/sp-adaptive-card-extension-base/cardsize.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/icardaction.yml create mode 100644 SP-Framework/sp-adaptive-card-extension-base/rendertype.yml create mode 100644 SP-Framework/sp-component-base/ireadonlyrawstyle.yml create mode 100644 SP-Framework/sp-core-library/servicecreator.yml create mode 100644 SP-Framework/sp-lodash-subset/cancelable.yml create mode 100644 SP-Framework/sp-lodash-subset/throttlesettings.yml create mode 100644 SP-Framework/sp-module-interfaces/componenttype.yml create mode 100644 SP-Framework/sp-module-interfaces/extensiontype.yml create mode 100644 SP-Framework/sp-page-context/spdayofweek-typealias.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml index 798dce3e..261cf273 100644 --- a/SP-Framework/sp-adaptive-card-extension-base.yml +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -14,6 +14,14 @@ classes: - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' +typeAliases: + - '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + - '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + - '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + - '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + - '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' + - '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + - '@microsoft/sp-adaptive-card-extension-base!RenderType:type' interfaces: - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' diff --git a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml new file mode 100644 index 00000000..1ee3299a --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: CardSize +uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: CardSize +summary: Size of the Card view. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type CardSize = 'Medium' | 'Large'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml new file mode 100644 index 00000000..aa5bac54 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: DeviceContext +uid: '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: DeviceContext +summary: >- + `WebView` indicates the Adaptive Card Extension is rendering through a web browser equivalent. `Mobile` indicates the + Adaptive Card Extension is rendering natively on a mobile platform. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml new file mode 100644 index 00000000..a8ccd0ac --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: IActionArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IActionArguments +summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an Adaptive + Card Action is executed. +remarks: >- + Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are + routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) + handler. +example: [] +isPreview: false +isDeprecated: false +syntax: >- + export declare type IActionArguments = ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments + | IGetLocationActionArguments; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml new file mode 100644 index 00000000..bee80041 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: IActionError +uid: '@microsoft/sp-adaptive-card-extension-base!IActionError:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IActionError +summary: '' +remarks: '' +example: [] +isPreview: true +isDeprecated: false +syntax: |- + export declare type IActionError = { + code: string; + }; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml new file mode 100644 index 00000000..03bdcaf6 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: IActionErrorArguments +uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: IActionErrorArguments +summary: >- + The object passed to + [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an + Adaptive Card Action is executed. +remarks: >- + Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are + routed to the + [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) + handler. +example: [] +isPreview: false +isDeprecated: false +syntax: >- + export declare type IActionErrorArguments = IBaseActionErrorArguments | ISelectMediaActionErrorArguments | + ILocationErrorArguments; diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml new file mode 100644 index 00000000..aec1683a --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ICardAction +uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: ICardAction +summary: Type of handler for when a button is pressed. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type ICardAction = IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index f86fc1eb..185353cb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -13,6 +13,19 @@ isPreview: false isDeprecated: false type: interface properties: + - name: data + uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#data:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: data + summary: Submit Action data that is passed to internal action handler to ensure forms do not clear. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'data: any;' + return: + type: any - name: media uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml new file mode 100644 index 00000000..46193b1d --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: RenderType +uid: '@microsoft/sp-adaptive-card-extension-base!RenderType:type' +package: '@microsoft/sp-adaptive-card-extension-base!' +fullName: RenderType +summary: '`Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.' +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type RenderType = 'Card' | 'QuickView'; diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 6d3eb5b9..7fc70c77 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -17,3 +17,5 @@ interfaces: - '@microsoft/sp-component-base!IReadonlyTheme:interface' - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' - '@microsoft/sp-component-base!ITheme:interface' +typeAliases: + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' diff --git a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml new file mode 100644 index 00000000..f43a9e83 --- /dev/null +++ b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: IReadonlyRawStyle +uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' +package: '@microsoft/sp-component-base!' +fullName: IReadonlyRawStyle +summary: '' +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type IReadonlyRawStyle = Readonly; diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index f8d2e87d..d0b933e4 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -27,3 +27,5 @@ interfaces: - '@microsoft/sp-core-library!IServiceCollection:interface' - '@microsoft/sp-core-library!ISPEventObserver:interface' - '@microsoft/sp-core-library!ITimeProvider:interface' +typeAliases: + - '@microsoft/sp-core-library!ServiceCreator:type' diff --git a/SP-Framework/sp-core-library/servicecreator.yml b/SP-Framework/sp-core-library/servicecreator.yml new file mode 100644 index 00000000..e81ec9e9 --- /dev/null +++ b/SP-Framework/sp-core-library/servicecreator.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ServiceCreator +uid: '@microsoft/sp-core-library!ServiceCreator:type' +package: '@microsoft/sp-core-library!' +fullName: ServiceCreator +summary: This is a callback that is used by ServiceKey.createCustom(). +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index ba1fd744..03bef4bc 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -31,6 +31,19 @@ properties: content: 'ariaLabel: string | undefined;' return: type: string | undefined + - name: disabled + uid: '@microsoft/sp-listview-extensibility!Command#disabled:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: disabled + summary: Whether the command is currently disabled. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'disabled: boolean | undefined;' + return: + type: boolean | undefined - name: iconImageUrl uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' package: '@microsoft/sp-listview-extensibility!' diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml index 1d74ee50..7796fa74 100644 --- a/SP-Framework/sp-listview-extensibility/icolumn.yml +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -6,7 +6,7 @@ fullName: IColumn summary: Provides information about the state of a column in the list view remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: The unique identifier of the client-side component associated with the field. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly clientSideComponentId: Guid | undefined;' @@ -32,7 +32,7 @@ properties: If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly clientSideComponentProperties: string;' @@ -45,7 +45,7 @@ properties: summary: The display name of the field. This name is shown as column name in UI. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly displayName: string;' @@ -58,7 +58,7 @@ properties: summary: The type of the field represented as a string remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly fieldType: string;' @@ -71,7 +71,7 @@ properties: summary: The GUID identifier for this field. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly id: Guid;' @@ -84,7 +84,7 @@ properties: summary: The internal name of the field. This name is usually used to find the field. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly internalName: string;' @@ -97,7 +97,7 @@ properties: summary: Whether the field is required for each list item in the list remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly isRequired: boolean;' @@ -110,7 +110,7 @@ properties: summary: Whether the column is visible in the view remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly isVisible: boolean;' diff --git a/SP-Framework/sp-listview-extensibility/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml index 61e4d636..16c0b7f3 100644 --- a/SP-Framework/sp-listview-extensibility/ifilter.yml +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -6,7 +6,7 @@ fullName: IFilter summary: Provides information about the state of the filters applied to the ListView. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: Field name to filter on. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly fieldName: string;' @@ -30,7 +30,7 @@ properties: summary: Values to filter on. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'values: ReadonlyArray;' diff --git a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml index c8b4e69c..0418a3f3 100644 --- a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -6,7 +6,7 @@ fullName: IFolderInfo summary: Provides information about the state of the folder in the ListView. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: Folder path. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly folderPath: string;' diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml index a020e993..6b76e9d6 100644 --- a/SP-Framework/sp-listview-extensibility/ilist.yml +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -6,7 +6,7 @@ fullName: IList summary: Provides information about the list rendered by the ListView. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: List id. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly guid: Guid;' @@ -30,7 +30,7 @@ properties: summary: List server relative url. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly serverRelativeUrl: string;' @@ -43,7 +43,7 @@ properties: summary: List title. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly title: string;' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml index a2bdab47..e3abce4c 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -6,7 +6,7 @@ fullName: IListViewAccessorState summary: Provides information about the state of the ListView. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: Applied filters information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: |- @@ -36,7 +36,7 @@ properties: summary: Columns information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly columns: ReadonlyArray;' @@ -49,7 +49,7 @@ properties: summary: Current folder information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly folderInfo?: IFolderInfo;' @@ -62,7 +62,7 @@ properties: summary: List information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly list?: IList;' @@ -75,7 +75,7 @@ properties: summary: Rows information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly rows: ReadonlyArray;' @@ -88,7 +88,7 @@ properties: summary: Selected rows information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly selectedRows?: ReadonlyArray;' @@ -101,7 +101,7 @@ properties: summary: Sort direction. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly sortAscending?: boolean;' @@ -114,7 +114,7 @@ properties: summary: Sort field name. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly sortField?: string;' @@ -127,7 +127,7 @@ properties: summary: View information. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly view?: IView;' diff --git a/SP-Framework/sp-listview-extensibility/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml index 1b0dbb62..292be738 100644 --- a/SP-Framework/sp-listview-extensibility/irow.yml +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -6,7 +6,7 @@ fullName: IRow summary: Provides information about the list item's state rendered by the ListView. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +19,7 @@ properties: in the row. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: |- diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml index 31bce495..52cc3cf2 100644 --- a/SP-Framework/sp-listview-extensibility/iview.yml +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -6,7 +6,7 @@ fullName: IView summary: Provides information about the view rendered by the ListView. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: View id. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly id: Guid;' @@ -30,7 +30,7 @@ properties: summary: View title. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly title: string;' @@ -43,7 +43,7 @@ properties: summary: View server relative url. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'readonly url: string;' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 2645ba6a..82db4243 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -19,7 +19,7 @@ properties: summary: Filters applied to the list view. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: |- @@ -51,7 +51,7 @@ properties: summary: Folder information for the list view. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get folderInfo(): IFolderInfo | undefined;' @@ -64,7 +64,7 @@ properties: summary: Basic information about the list rendered by the list view. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get list(): IList | undefined;' @@ -77,7 +77,7 @@ properties: summary: Currently rendered rows in the list view. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get rows(): ReadonlyArray;' @@ -90,7 +90,7 @@ properties: summary: Selected rows in the list view. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get selectedRows(): ReadonlyArray | undefined;' @@ -103,7 +103,7 @@ properties: summary: Specifies whether the list view is sorted ascending or descending. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get sortAscending(): boolean | undefined;' @@ -116,7 +116,7 @@ properties: summary: Sort field name remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get sortField(): string | undefined;' @@ -129,7 +129,7 @@ properties: summary: Basic information about the view rendered by the list view. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'abstract get view(): IView | undefined;' @@ -164,7 +164,7 @@ events: summary: Event that gets raised every time the list view state changes. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'get listViewStateChangedEvent(): SPEvent;' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml index 50c4a954..bfd43c03 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -6,7 +6,7 @@ fullName: ListViewAccessorStateChanges summary: Describes the type of list view state changes. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false fields: - name: AppliedFilters diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml index 4cc180a6..08bf585d 100644 --- a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -6,7 +6,7 @@ fullName: ListViewStateChangedEventArgs summary: Arguments for the list view state changed event. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: class properties: @@ -17,7 +17,7 @@ properties: summary: Previous state of the ListView. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'prevState: Readonly;' @@ -30,7 +30,7 @@ properties: summary: Changes that were made to the ListView state. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'stateChanges: ListViewAccessorStateChanges;' diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml index 313a6dfa..f19cad80 100644 --- a/SP-Framework/sp-lodash-subset.yml +++ b/SP-Framework/sp-lodash-subset.yml @@ -3,3 +3,6 @@ uid: '@microsoft/sp-lodash-subset!' name: '@microsoft/sp-lodash-subset' type: package summary: '' +typeAliases: + - '@microsoft/sp-lodash-subset!Cancelable:type' + - '@microsoft/sp-lodash-subset!ThrottleSettings:type' diff --git a/SP-Framework/sp-lodash-subset/cancelable.yml b/SP-Framework/sp-lodash-subset/cancelable.yml new file mode 100644 index 00000000..f9271d4e --- /dev/null +++ b/SP-Framework/sp-lodash-subset/cancelable.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Cancelable +uid: '@microsoft/sp-lodash-subset!Cancelable:type' +package: '@microsoft/sp-lodash-subset!' +fullName: Cancelable +summary: '' +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type Cancelable = Cancelable2; diff --git a/SP-Framework/sp-lodash-subset/throttlesettings.yml b/SP-Framework/sp-lodash-subset/throttlesettings.yml new file mode 100644 index 00000000..bac184b0 --- /dev/null +++ b/SP-Framework/sp-lodash-subset/throttlesettings.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ThrottleSettings +uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' +package: '@microsoft/sp-lodash-subset!' +fullName: ThrottleSettings +summary: '' +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type ThrottleSettings = ThrottleSettings2; diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index 43e6f38c..b71e9d66 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -3,6 +3,9 @@ uid: '@microsoft/sp-module-interfaces!' name: '@microsoft/sp-module-interfaces' type: package summary: '' +typeAliases: + - '@microsoft/sp-module-interfaces!ComponentType:type' + - '@microsoft/sp-module-interfaces!ExtensionType:type' interfaces: - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' diff --git a/SP-Framework/sp-module-interfaces/componenttype.yml b/SP-Framework/sp-module-interfaces/componenttype.yml new file mode 100644 index 00000000..4d28b44b --- /dev/null +++ b/SP-Framework/sp-module-interfaces/componenttype.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ComponentType +uid: '@microsoft/sp-module-interfaces!ComponentType:type' +package: '@microsoft/sp-module-interfaces!' +fullName: ComponentType +summary: Type of client-side component. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension'; diff --git a/SP-Framework/sp-module-interfaces/extensiontype.yml b/SP-Framework/sp-module-interfaces/extensiontype.yml new file mode 100644 index 00000000..14ff642a --- /dev/null +++ b/SP-Framework/sp-module-interfaces/extensiontype.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: ExtensionType +uid: '@microsoft/sp-module-interfaces!ExtensionType:type' +package: '@microsoft/sp-module-interfaces!' +fullName: ExtensionType +summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: >- + export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | 'ListViewCommandSet' | + 'SearchQueryModifier'; diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index 97eb8e6c..a3296b25 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -17,3 +17,5 @@ classes: interfaces: - '@microsoft/sp-page-context!ISPSystemTime:interface' - '@microsoft/sp-page-context!ISPTimeZoneData:interface' +typeAliases: + - '@microsoft/sp-page-context!SPDayOfWeek:type' diff --git a/SP-Framework/sp-page-context/spdayofweek-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml new file mode 100644 index 00000000..377eec5f --- /dev/null +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: SPDayOfWeek +uid: '@microsoft/sp-page-context!SPDayOfWeek:type' +package: '@microsoft/sp-page-context!' +fullName: SPDayOfWeek +summary: The type members represent the seven days of a week. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +syntax: 'export declare type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 97df013f..55a8a720 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -39,6 +39,8 @@ interfaces: - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' +typeAliases: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' functions: - name: 'PropertyPaneButton(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml new file mode 100644 index 00000000..01ed3eb6 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: IPropertyPaneDynamicFieldFilters +uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneDynamicFieldFilters +summary: Property pane dynamic field filters which is an intersection of both source and property filters. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +syntax: >- + export declare type IPropertyPaneDynamicFieldFilters = IDynamicDataSharedSourceFilters & + IDynamicDataSharedPropertyFilters; diff --git a/SP-Framework/toc.yml b/SP-Framework/toc.yml index 809eb39f..7a23fd43 100644 --- a/SP-Framework/toc.yml +++ b/SP-Framework/toc.yml @@ -25,6 +25,16 @@ items: uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' - name: BaseView uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + - name: CardSize + uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + - name: DeviceContext + uid: '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + - name: IActionArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + - name: IActionError + uid: '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + - name: IActionErrorArguments + uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' - name: IAdaptiveCardExtensionPropertiesMetadata uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' - name: IAdaptiveCardExtensionPropertyMetadata @@ -43,6 +53,8 @@ items: uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' - name: ICacheSettings uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + - name: ICardAction + uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' - name: ICardButton uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' - name: IConfirmationDialog @@ -103,6 +115,8 @@ items: uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' - name: QuickViewNavigator uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + - name: RenderType + uid: '@microsoft/sp-adaptive-card-extension-base!RenderType:type' - name: ViewNavigator uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' - name: sp-application-base @@ -139,6 +153,8 @@ items: uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' - name: IReadonlyFontStyles uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - name: IReadonlyRawStyle + uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' - name: IReadonlyTheme uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' - name: ISerializedServerProcessedData @@ -174,6 +190,8 @@ items: uid: '@microsoft/sp-core-library!Log:class' - name: RandomNumberGenerator uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' + - name: ServiceCreator + uid: '@microsoft/sp-core-library!ServiceCreator:type' - name: ServiceKey uid: '@microsoft/sp-core-library!ServiceKey:class' - name: ServiceScope @@ -404,9 +422,18 @@ items: uid: '@microsoft/sp-loader!SPComponentLoader:class' - name: sp-lodash-subset uid: '@microsoft/sp-lodash-subset!' + items: + - name: Cancelable + uid: '@microsoft/sp-lodash-subset!Cancelable:type' + - name: ThrottleSettings + uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' - name: sp-module-interfaces uid: '@microsoft/sp-module-interfaces!' items: + - name: ComponentType + uid: '@microsoft/sp-module-interfaces!ComponentType:type' + - name: ExtensionType + uid: '@microsoft/sp-module-interfaces!ExtensionType:type' - name: IAdaptiveCardExtensionManifest uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - name: IAdaptiveCardExtensionManifestEntry @@ -483,6 +510,8 @@ items: uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' - name: PageContext uid: '@microsoft/sp-page-context!PageContext:class' + - name: SPDayOfWeek (TypeAlias) + uid: '@microsoft/sp-page-context!SPDayOfWeek:type' - name: SPField uid: '@microsoft/sp-page-context!SPField:class' - name: SPList @@ -538,6 +567,8 @@ items: uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - name: IPropertyPaneDropdownProps uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - name: IPropertyPaneDynamicFieldFilters + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - name: IPropertyPaneDynamicFieldProps uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - name: IPropertyPaneDynamicFieldSetProps From ec22eb8508d8460cdac6801f3a7356b5108e427f Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Wed, 30 Mar 2022 14:13:09 -0700 Subject: [PATCH 51/55] Update for 1.15.0 beta.4 API --- .../adaptivecardextensioncontext.yml | 13 ++ .../basecardview.yml | 11 +- .../icardaction.yml | 4 +- .../igetlocationaction.yml | 4 +- .../igetlocationactionarguments.yml | 4 +- .../igetlocationactionparameters.yml | 4 +- .../igetlocationcardaction.yml | 6 +- .../ilocation.yml | 12 +- .../ilocationerrorarguments.yml | 4 +- .../iselectmediacardaction.yml | 4 +- .../ishowlocationaction.yml | 4 +- .../ishowlocationactionparameters.yml | 4 +- .../ishowlocationcardaction.yml | 6 +- .../sp-component-base/basecomponent.yml | 4 +- SP-Framework/sp-core-library.yml | 1 + .../sp-core-library/formdisplaymode.yml | 26 +++ .../sp-dialog/isecondarydialogprovider.yml | 4 +- SP-Framework/sp-http.yml | 1 + SP-Framework/sp-http/msgraphclientfactory.yml | 46 +++++- SP-Framework/sp-http/msgraphclientv3.yml | 48 ++++++ .../sp-image-helper/iimagehelperrequest.yml | 8 +- SP-Framework/sp-image-helper/imagehelper.yml | 4 +- SP-Framework/sp-listview-extensibility.yml | 4 + .../baseformcustomizer.yml | 118 +++++++++++++ .../sp-listview-extensibility/command.yml | 4 +- .../formcustomizercontext.yml | 99 +++++++++++ .../icontenttype.yml | 51 ++++++ .../iformcustomizercontext.yml | 77 +++++++++ SP-Framework/sp-loader/spcomponentloader.yml | 3 +- SP-Framework/sp-module-interfaces.yml | 5 +- .../iadaptivecardextensionmanifestentry.yml | 4 +- ...clientsidecomponentloaderconfiguration.yml | 2 +- .../iclientsidewebpartmanifestentry.yml | 4 +- .../icommanddefinition.yml | 2 +- .../icomponentmoduleconfiguration.yml | 19 ++- .../sp-module-interfaces/iintegritypath.yml | 40 +++++ .../ilocalizedpathmoduleconfiguration.yml | 23 ++- .../imoduleconfiguration.yml | 56 +------ .../imoduleconfigurationbase.yml | 57 +++++++ .../ipathmoduleconfiguration.yml | 19 ++- SP-Framework/sp-odata-types.yml | 2 + .../sp-odata-types/iodatacontenttype.yml | 156 ++++++++++++++++++ .../iodataformsclientsideconfiguration.yml | 129 +++++++++++++++ SP-Framework/sp-odata-types/iodatalist.yml | 1 + SP-Framework/sp-page-context/sppermission.yml | 2 +- SP-Framework/sp-property-pane.yml | 57 +++++++ SP-Framework/sp-property-pane/iguidset.yml | 64 +++++++ SP-Framework/sp-property-pane/imagefit.yml | 55 ++++++ .../ipropertypaneiconpickerprops.yml | 144 ++++++++++++++++ .../ipropertypanethumbnailpickerprops.yml | 144 ++++++++++++++++ SP-Framework/sp-property-pane/ithumbnail.yml | 11 ++ .../ithumbnailfabricreacticon.yml | 64 +++++++ .../ithumbnailiconsizeimage.yml | 64 +++++++ .../sp-property-pane/ithumbnailimage.yml | 77 +++++++++ .../propertypanefieldtype.yml | 10 ++ .../sp-property-pane/thumbnailtype.yml | 26 +++ .../sp-webpart-base/propertypanefieldtype.yml | 10 ++ SP-Framework/toc.yml | 42 ++++- 58 files changed, 1749 insertions(+), 118 deletions(-) create mode 100644 SP-Framework/sp-core-library/formdisplaymode.yml create mode 100644 SP-Framework/sp-http/msgraphclientv3.yml create mode 100644 SP-Framework/sp-listview-extensibility/baseformcustomizer.yml create mode 100644 SP-Framework/sp-listview-extensibility/formcustomizercontext.yml create mode 100644 SP-Framework/sp-listview-extensibility/icontenttype.yml create mode 100644 SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml create mode 100644 SP-Framework/sp-module-interfaces/iintegritypath.yml create mode 100644 SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml create mode 100644 SP-Framework/sp-odata-types/iodatacontenttype.yml create mode 100644 SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml create mode 100644 SP-Framework/sp-property-pane/iguidset.yml create mode 100644 SP-Framework/sp-property-pane/imagefit.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml create mode 100644 SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml create mode 100644 SP-Framework/sp-property-pane/ithumbnail.yml create mode 100644 SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml create mode 100644 SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml create mode 100644 SP-Framework/sp-property-pane/ithumbnailimage.yml create mode 100644 SP-Framework/sp-property-pane/thumbnailtype.yml diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index 05dff4e9..8d4784bc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -25,6 +25,19 @@ properties: content: 'get deviceContext(): DeviceContext;' return: type: '' + - name: location + uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location:member' + package: '@microsoft/sp-adaptive-card-extension-base!' + fullName: location + summary: Provides a promise that gets current location of the device + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'get location(): Promise;' + return: + type: 'Promise<>' - name: manifest uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index cb3ae69d..c5158482 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -73,11 +73,16 @@ properties: isPreview: false isDeprecated: false syntax: - content: |- + content: >- /** @virtual */ - get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | undefined; + + get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | ISelectMediaCardAction | + IGetLocationCardAction | IShowLocationCardAction | undefined; return: type: >- | | undefined + uid="@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface" /> | | | | undefined extends: '<TProperties, TState, TData> ' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml index aec1683a..9748d1ca 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -8,4 +8,6 @@ remarks: '' example: [] isPreview: false isDeprecated: false -syntax: export declare type ICardAction = IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction; +syntax: >- + export declare type ICardAction = IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction | + ISelectMediaCardAction | IGetLocationCardAction | IShowLocationCardAction; diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index d173d02b..da5ead5e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -17,7 +17,7 @@ properties: summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'parameters?: IGetLocationActionParameters;' @@ -30,7 +30,7 @@ properties: summary: Indicates this is a Viva Select Location button. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.GetLocation'';' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index d8269fe0..11f08291 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -20,7 +20,7 @@ properties: summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'location?: ILocation;' @@ -33,7 +33,7 @@ properties: summary: The type of Adaptive Card Action. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.GetLocation'';' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index 0902ab85..b26e3b57 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -6,7 +6,7 @@ fullName: IGetLocationActionParameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: API under active development and not ready for use. example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'chooseLocationOnMap?: boolean;' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index 409dfb0d..a2bf7f3d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -6,7 +6,7 @@ fullName: IGetLocationCardAction summary: Invoke an `VivaAction.GetLocation` event. remarks: API under active development and not ready for use. example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'parameters?: IGetLocationActionParameters;' @@ -30,7 +30,7 @@ properties: summary: Indicates this is a Viva Select Location button. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.GetLocation'';' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index 297edeb3..0d3fe670 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -4,9 +4,9 @@ uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocation summary: Interface for location coordinates -remarks: API under active development and is not ready for use. +remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: Accuracy of the location. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'accuracy?: number;' @@ -30,7 +30,7 @@ properties: summary: Latitude of the location. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'latitude: number;' @@ -43,7 +43,7 @@ properties: summary: Longitude of the location. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'longitude: number;' @@ -56,7 +56,7 @@ properties: summary: Timestamp remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'timestamp?: number;' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml index abe6553c..8a87e77e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -17,7 +17,7 @@ properties: summary: Error codes specific to the Get Location Error remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: |- @@ -36,7 +36,7 @@ properties: summary: Indicates this is a Viva Select Location button. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.GetLocation'';' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 017fca6d..52e0778d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -6,7 +6,7 @@ fullName: ISelectMediaCardAction summary: Invoke an `VivaAction.SelectMedia` event. remarks: API under active development and not ready for use. example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -30,7 +30,7 @@ properties: summary: Indicates this is a Viva Select Media button. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.SelectMedia'';' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index 5151f5cf..128ddaf2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -17,7 +17,7 @@ properties: summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'parameters?: IShowLocationActionParameters;' @@ -30,7 +30,7 @@ properties: summary: Indicates this is a Viva show Location button. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.ShowLocation'';' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index 5ab04acc..ef68fc7f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -6,7 +6,7 @@ fullName: IShowLocationActionParameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: API under active development and not ready for use. example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'locationCoordinates?: ILocation;' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 8cf3186e..5cd24b7d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -6,7 +6,7 @@ fullName: IShowLocationCardAction summary: Invoke an `VivaAction.ShowLocation` event. remarks: API under active development and not ready for use. example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +17,7 @@ properties: summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'parameters?: IShowLocationActionParameters;' @@ -30,7 +30,7 @@ properties: summary: Indicates this is a Viva show Location button. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'type: ''VivaAction.ShowLocation'';' diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 98ddabcf..32490a06 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -16,7 +16,7 @@ properties: uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' package: '@microsoft/sp-component-base!' fullName: componentId - summary: Returns the component identifier as defined in the component’s associated manifest. + summary: Returns the component identifier as defined in the component's associated manifest. remarks: >- Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string @@ -41,7 +41,7 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'protected context: BaseComponentContext;' + content: 'protected context?: BaseComponentContext;' return: type: '' - name: instanceId diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index d0b933e4..e2960d11 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -6,6 +6,7 @@ summary: SharePoint Framework core libraries. enums: - '@microsoft/sp-core-library!DisplayMode:enum' - '@microsoft/sp-core-library!EnvironmentType:enum' + - '@microsoft/sp-core-library!FormDisplayMode:enum' classes: - '@microsoft/sp-core-library!Environment:class' - '@microsoft/sp-core-library!Guid:class' diff --git a/SP-Framework/sp-core-library/formdisplaymode.yml b/SP-Framework/sp-core-library/formdisplaymode.yml new file mode 100644 index 00000000..2c0be707 --- /dev/null +++ b/SP-Framework/sp-core-library/formdisplaymode.yml @@ -0,0 +1,26 @@ +### YamlMime:TSEnum +name: FormDisplayMode +uid: '@microsoft/sp-core-library!FormDisplayMode:enum' +package: '@microsoft/sp-core-library!' +fullName: FormDisplayMode +summary: '' +remarks: '' +example: [] +isPreview: false +isDeprecated: false +fields: + - name: Display + uid: '@microsoft/sp-core-library!FormDisplayMode.Display:member' + package: '@microsoft/sp-core-library!' + summary: '' + value: '4' + - name: Edit + uid: '@microsoft/sp-core-library!FormDisplayMode.Edit:member' + package: '@microsoft/sp-core-library!' + summary: '' + value: '6' + - name: New + uid: '@microsoft/sp-core-library!FormDisplayMode.New:member' + package: '@microsoft/sp-core-library!' + summary: '' + value: '8' diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 277c1112..c5882bd7 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -57,7 +57,7 @@ methods: isPreview: false isDeprecated: false syntax: - content: 'prompt(message: string, options?: IPromptOptions): Promise;' + content: 'prompt(message: string, options?: IPromptOptions): Promise;' parameters: - id: message description: '' @@ -68,7 +68,7 @@ methods: [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. type: '' return: - type: Promise<string> + type: Promise<string | undefined> description: '' - name: 'show(dialog, options)' uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index d119d250..5c71328f 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -17,6 +17,7 @@ classes: - '@microsoft/sp-http!HttpClientResponse:class' - '@microsoft/sp-http!MSGraphClient:class' - '@microsoft/sp-http!MSGraphClientFactory:class' + - '@microsoft/sp-http!MSGraphClientV3:class' - '@microsoft/sp-http!ODataVersion:class' - '@microsoft/sp-http!SPHttpClient:class' - '@microsoft/sp-http!SPHttpClientBatch:class' diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 1f6265a6..fda63f07 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -36,13 +36,55 @@ methods: fullName: getClient() summary: >- Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service - Principal. + Principal. Returns version 1 by default. remarks: '' example: [] isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: 'Use getClient(''1'') instead, which has the same implementation but specifies the version explicitly.' syntax: content: 'getClient(): Promise;' return: type: 'Promise<>' description: '' + - name: getClient(version) + uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(2)' + package: '@microsoft/sp-http!' + fullName: getClient(version) + summary: |- + Returns an instance version 1 of the MSGraphClient communicates with the current tenant's configurable + + Service Principal. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'getClient(version: ''1''): Promise;' + parameters: + - id: version + description: '' + type: '''1''' + return: + type: 'Promise<>' + description: '' + - name: getClient(version) + uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(3)' + package: '@microsoft/sp-http!' + fullName: getClient(version) + summary: >- + Returns an instance of version 3 the MSGraphClient V3 that communicates with the current tenant's configurable + Service Principal. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'getClient(version: ''3''): Promise;' + parameters: + - id: version + description: '' + type: '''3''' + return: + type: 'Promise<>' + description: '' diff --git a/SP-Framework/sp-http/msgraphclientv3.yml b/SP-Framework/sp-http/msgraphclientv3.yml new file mode 100644 index 00000000..335e71f8 --- /dev/null +++ b/SP-Framework/sp-http/msgraphclientv3.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: MSGraphClientV3 +uid: '@microsoft/sp-http!MSGraphClientV3:class' +package: '@microsoft/sp-http!' +fullName: MSGraphClientV3 +summary: MSGraphClient is used to perform REST calls against Microsoft Graph. +remarks: >- + The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class + allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. + If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom + configuration for every request. + + + For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + + + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClientV3` class. +example: [] +isPreview: false +isDeprecated: false +type: class +methods: + - name: api(path) + uid: '@microsoft/sp-http!MSGraphClientV3#api:member(1)' + package: '@microsoft/sp-http!' + fullName: api(path) + summary: All calls to Microsoft Graph are chained together starting with the api function. + remarks: >- + Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* + https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship') + + + The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See + the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'api(path: string): GraphRequest;' + parameters: + - id: path + description: The path for the request to MSGraph. + type: string + return: + type: '' + description: '' diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 74dcd821..7a205135 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -6,7 +6,7 @@ fullName: IImageHelperRequest summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -20,7 +20,7 @@ properties: provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint. example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'height?: number;' @@ -33,7 +33,7 @@ properties: summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. remarks: '' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'sourceUrl: string;' @@ -46,7 +46,7 @@ properties: summary: Width of the image requested. remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'width: number;' diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 392656c6..034e548f 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -6,7 +6,7 @@ fullName: ImageHelper summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. remarks: '' example: [] -isPreview: true +isPreview: false isDeprecated: false type: class methods: @@ -21,7 +21,7 @@ methods: to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization. example: [] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'static convertToImageUrl(request: IImageHelperRequest): string;' diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index 8f06c70a..a8081299 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -5,10 +5,12 @@ type: package summary: SharePoint Framework support for customizing the list view. classes: - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - '@microsoft/sp-listview-extensibility!Command:class' - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' @@ -17,9 +19,11 @@ classes: - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' interfaces: - '@microsoft/sp-listview-extensibility!IColumn:interface' + - '@microsoft/sp-listview-extensibility!IContentType:interface' - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - '@microsoft/sp-listview-extensibility!IFilter:interface' - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' - '@microsoft/sp-listview-extensibility!IList:interface' - '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' diff --git a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml new file mode 100644 index 00000000..bb7df5eb --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -0,0 +1,118 @@ +### YamlMime:TSType +name: BaseFormCustomizer +uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: BaseFormCustomizer +summary: >- + This is the base class that third parties should extend when implementing a client-side extension that provides a + custom list form (display, new, edit) for a SharePoint list. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#context:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: context + summary: Use the context object to access common services and state associated with the component. + remarks: >- + Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a + read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside + the constructor), but child classes should redeclare it as readonly. + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly context: FormCustomizerContext;' + return: + type: '' + - name: displayMode + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#displayMode:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: displayMode + summary: 'Display mode of the form: Edit, Display or New.' + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'protected get displayMode(): FormDisplayMode;' + return: + type: '' + - name: domElement + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#domElement:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: domElement + summary: >- + This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole DOM + subtree of the form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'protected get domElement(): HTMLElement;' + return: + type: HTMLElement +methods: + - name: dispose() + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#dispose:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: dispose() + summary: Disposes the component. + remarks: 'Please, do not override this method. Override the `onDispose` method instead.' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'dispose(): void;' + return: + type: void + description: '' + - name: formClosed() + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formClosed:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: formClosed() + summary: Call this method after the form has been closed/cancelled to inform the application that the form has been closed. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'protected formClosed(): void;' + return: + type: void + description: '' + - name: formSaved() + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formSaved:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: formSaved() + summary: Call this method after the form has been saved to inform the application that the form has been saved. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'protected formSaved(): void;' + return: + type: void + description: '' + - name: render() + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#render:member(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: render() + summary: >- + This API is called to render the form. There is no base implementation of this API and the form is required to + override this API. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'protected abstract render(): void;' + return: + type: void + description: '' +extends: '<TProperties> ' diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 03bef4bc..8722ad8a 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -6,10 +6,10 @@ fullName: Command summary: Represents a command belonging to a command set. remarks: >- The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, - context menu items, etc. These commands are initially defined in the extension’s manifest file. At runtime, the + context menu items, etc. These commands are initially defined in the extension's manifest file. At runtime, the corresponding Command object can be obtained by calling [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command’s appearance can be customized by assigning its properties, for example to hide a command that is not + -->. The command's appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. example: [] isPreview: false diff --git a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml new file mode 100644 index 00000000..0238dd0f --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: FormCustomizerContext +uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' +package: '@microsoft/sp-listview-extensibility!' +fullName: FormCustomizerContext +summary: Form Customizer Context. This object contains contxtual services and properties for the form. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: class +constructors: + - name: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:constructor(1)' + package: '@microsoft/sp-listview-extensibility!' + fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + summary: Constructs a new instance of the `FormCustomizerContext` class + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: >- + constructor(extensionContextParameters: _IExtensionContextParameters, formCustomizerContextParameters: + IFormCustomizerContextParameters); + parameters: + - id: extensionContextParameters + description: '' + type: '' + - id: formCustomizerContextParameters + description: '' + type: '' +properties: + - name: contentType + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#contentType:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: contentType + summary: The content type associated with the form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'get contentType(): IContentType;' + return: + type: '' + - name: domElement + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#domElement:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: domElement + summary: The root DOM element of the form. This is a DIV element container for the custom form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'get domElement(): HTMLElement;' + return: + type: HTMLElement + - name: folderInfo + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#folderInfo:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: folderInfo + summary: The folder information where the item is located/should be created. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'get folderInfo(): IFolderInfo;' + return: + type: '' + - name: itemId + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#itemId:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: itemId + summary: The item id of the item being edited or viewed. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'get itemId(): number | undefined;' + return: + type: number | undefined + - name: list + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#list:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: list + summary: The list associated with the form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'get list(): IList;' + return: + type: '' +extends: '' diff --git a/SP-Framework/sp-listview-extensibility/icontenttype.yml b/SP-Framework/sp-listview-extensibility/icontenttype.yml new file mode 100644 index 00000000..7331bf81 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/icontenttype.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: IContentType +uid: '@microsoft/sp-listview-extensibility!IContentType:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IContentType +summary: Provides information about the content type +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: '@microsoft/sp-listview-extensibility!IContentType#id:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: id + summary: Content type string id + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: '@microsoft/sp-listview-extensibility!IContentType#name:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: name + summary: Content type name + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: schemaXml + uid: '@microsoft/sp-listview-extensibility!IContentType#schemaXml:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: schemaXml + summary: Content type schema XML + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly schemaXml: string | undefined;' + return: + type: string | undefined diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml new file mode 100644 index 00000000..88deb6bd --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: IFormCustomizerContext +uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' +package: '@microsoft/sp-listview-extensibility!' +fullName: IFormCustomizerContext +summary: FormCustomizerContext-specific properties. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: contentType + uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#contentType:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: contentType + summary: The content type associated with the form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly contentType: IContentType;' + return: + type: '' + - name: domElement + uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#domElement:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: domElement + summary: The root DOM element of the form. This is a DIV element container for the custom form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly domElement: HTMLElement;' + return: + type: HTMLElement + - name: folderInfo + uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#folderInfo:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: folderInfo + summary: The folder information where the item is located/should be created. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly folderInfo: IFolderInfo;' + return: + type: '' + - name: itemId + uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#itemId:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: itemId + summary: The item id of the item being edited or viewed. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly itemId?: number;' + return: + type: number + - name: list + uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#list:member' + package: '@microsoft/sp-listview-extensibility!' + fullName: list + summary: The list associated with the form. + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'readonly list: IList;' + return: + type: '' diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index c8ed255f..583aec40 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -18,7 +18,8 @@ methods: remarks: '' example: [] isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: this method will be removed in a future release. syntax: content: 'static getManifests(): IClientSideComponentManifest[];' return: diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index b71e9d66..c2d9da3d 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -6,6 +6,7 @@ summary: '' typeAliases: - '@microsoft/sp-module-interfaces!ComponentType:type' - '@microsoft/sp-module-interfaces!ExtensionType:type' + - '@microsoft/sp-module-interfaces!IModuleConfiguration:type' interfaces: - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' @@ -21,10 +22,10 @@ interfaces: - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!IIntegrityPath:interface' - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!IPath:interface' + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' enums: - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index 29840bc4..ebb55270 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -84,7 +84,7 @@ properties: { "default": "A tool for displaying neat information.", "en-us": "A tool for displaying neat information.", - "fr-fr": "Un outil d’affichage des informations soignées.", + "fr-fr": "Un outil d'affichage des informations soignées.", "zh": "用於顯示整潔資訊的工具。" } ``` @@ -127,7 +127,7 @@ properties: field does not have a value, this field must have a value. This value can be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file - will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 774a0492..3f20b018 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -158,5 +158,5 @@ properties: return: type: |- { - [name: string]: ; + [name: string]: ; } diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 5beb78e6..10fd2d30 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -69,7 +69,7 @@ properties: { "default": "A tool for displaying neat information.", "en-us": "A tool for displaying neat information.", - "fr-fr": "Un outil d’affichage des informations soignées.", + "fr-fr": "Un outil d'affichage des informations soignées.", "zh": "用於顯示整潔資訊的工具。" } ``` @@ -150,7 +150,7 @@ properties: field does not have a value, this field must have a value. This value can be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or a relative file path (e.g. `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file - will be copied to the deployment folder like an asset, and the output manifest’s iconImageUrl will be replaced + will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index 26d3ff16..b7bfd964 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -37,7 +37,7 @@ properties: remarks: >- This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input - manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest’s + manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). example: [] diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 3be613d5..588cc149 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -32,9 +32,9 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'failoverPath?: string | IPath;' + content: 'failoverPath?: string | IIntegrityPath;' return: - type: 'string | ' + type: 'string | ' - name: id uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' package: '@microsoft/sp-module-interfaces!' @@ -51,6 +51,19 @@ properties: content: 'id: string;' return: type: string + - name: type + uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type + summary: '' + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''component'';' + return: + type: '''component''' - name: version uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' package: '@microsoft/sp-module-interfaces!' @@ -70,4 +83,4 @@ properties: content: 'version: string;' return: type: string -extends: '' +extends: '' diff --git a/SP-Framework/sp-module-interfaces/iintegritypath.yml b/SP-Framework/sp-module-interfaces/iintegritypath.yml new file mode 100644 index 00000000..26aa101d --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iintegritypath.yml @@ -0,0 +1,40 @@ +### YamlMime:TSType +name: IIntegrityPath +uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IIntegrityPath +summary: A path with the subresource integrity hash of the resource. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: integrity + uid: '@microsoft/sp-module-interfaces!IIntegrityPath#integrity:member' + package: '@microsoft/sp-module-interfaces!' + fullName: integrity + summary: >- + The subresource integrity hash of the resource referenced in + [IIntegrityPath.path](xref:@microsoft/sp-module-interfaces!IIntegrityPath%23path:member). + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'integrity?: string;' + return: + type: string + - name: path + uid: '@microsoft/sp-module-interfaces!IIntegrityPath#path:member' + package: '@microsoft/sp-module-interfaces!' + fullName: path + summary: The path to the resource. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'path: string;' + return: + type: string diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index e861720d..2c6ccf86 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -35,9 +35,9 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'defaultPath: string | IPath;' + content: 'defaultPath: string | IIntegrityPath;' return: - type: 'string | ' + type: 'string | ' - name: paths uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' package: '@microsoft/sp-module-interfaces!' @@ -75,11 +75,24 @@ properties: syntax: content: |- paths?: { - [locale: string]: string | IPath; + [locale: string]: string | IIntegrityPath; }; return: type: |- { - [locale: string]: string | ; + [locale: string]: string | ; } -extends: '' + - name: type + uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type + summary: '' + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''localizedPath'';' + return: + type: '''localizedPath''' +extends: '' diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index f2d0c35f..7b077d49 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -1,57 +1,13 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: IModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' +uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:type' package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfiguration -summary: This is the base interface for a script module's definition. +summary: '' remarks: '' example: [] isPreview: true isDeprecated: false -type: interface -properties: - - name: shouldNotPreload - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member' - package: '@microsoft/sp-module-interfaces!' - fullName: shouldNotPreload - summary: 'If set to `true`, this module should not be preloaded when loading the component.' - remarks: >- - The most common case for setting this property to "true" is when a module is defined in a manifest, but is not - required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded - asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. - - - Usage: Instructs the module loader to not preload this module. - example: [] - isPreview: true - isDeprecated: false - syntax: - content: 'shouldNotPreload?: boolean;' - return: - type: boolean - - name: type - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type - summary: >- - The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules - must be available on the paths provided in the `"internalModuleBaseUrls"` field. - remarks: >- - Modules with the `"path"` type use the `IPathModuleConfiguration` interface. - - - Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the - "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. - - - Supported values: `"component"`, `"path"`, `"localizedPath"` - - - Example: `"localized"` - example: [] - isPreview: true - isDeprecated: false - syntax: - content: 'type: ''component'' | ''path'' | ''localizedPath'';' - return: - type: '''component'' | ''path'' | ''localizedPath''' +syntax: >- + export declare type IModuleConfiguration = IComponentModuleConfiguration | IPathModuleConfiguration | + ILocalizedPathModuleConfiguration; diff --git a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml new file mode 100644 index 00000000..6574d072 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -0,0 +1,57 @@ +### YamlMime:TSType +name: IModuleConfigurationBase +uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IModuleConfigurationBase +summary: This is the base interface for a script module's definition. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: shouldNotPreload + uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#shouldNotPreload:member' + package: '@microsoft/sp-module-interfaces!' + fullName: shouldNotPreload + summary: 'If set to `true`, this module should not be preloaded when loading the component.' + remarks: >- + The most common case for setting this property to "true" is when a module is defined in a manifest, but is not + required for the module referenced in "entryModuleId" to load. Modules may be defined that are loaded + asynchronously, and these modules do not need to be preloaded. This field implicitly defaults to `false`. + + + Usage: Instructs the module loader to not preload this module. + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'shouldNotPreload?: boolean;' + return: + type: boolean + - name: type + uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type + summary: >- + The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules + must be available on the paths provided in the `"internalModuleBaseUrls"` field. + remarks: >- + Modules with the `"path"` type use the `IPathModuleConfiguration` interface. + + + Modules with the `"component"` type use the `IComponentModuleConfiguration` interface. Modules with the + "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface. + + + Supported values: `"component"`, `"path"`, `"localizedPath"` + + + Example: `"localized"` + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''component'' | ''path'' | ''localizedPath'';' + return: + type: '''component'' | ''path'' | ''localizedPath''' diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 9c813b4d..f892b365 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -92,7 +92,20 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'path: string | IPath;' + content: 'path: string | IIntegrityPath;' return: - type: 'string | ' -extends: '' + type: 'string | ' + - name: type + uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#type:member' + package: '@microsoft/sp-module-interfaces!' + fullName: type + summary: '' + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ''path'';' + return: + type: '''path''' +extends: '' diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index 03cb92e3..1f4468ad 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -7,7 +7,9 @@ interfaces: - '@microsoft/sp-odata-types!_IODataUserId:interface' - '@microsoft/sp-odata-types!IODataBasePermission:interface' - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - '@microsoft/sp-odata-types!IODataContentType:interface' - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' - '@microsoft/sp-odata-types!IODataList:interface' - '@microsoft/sp-odata-types!IODataListItem:interface' - '@microsoft/sp-odata-types!IODataNavigationNode:interface' diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml new file mode 100644 index 00000000..2b18c53d --- /dev/null +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -0,0 +1,156 @@ +### YamlMime:TSType +name: IODataContentType +uid: '@microsoft/sp-odata-types!IODataContentType:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataContentType +summary: Represents OData SP.ContentType object. +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ClientFormCustomFormatter + uid: '@microsoft/sp-odata-types!IODataContentType#ClientFormCustomFormatter:member' + package: '@microsoft/sp-odata-types!' + fullName: ClientFormCustomFormatter + summary: Custom formatter (JSON) for the content type forms + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'ClientFormCustomFormatter: string;' + return: + type: string + - name: Description + uid: '@microsoft/sp-odata-types!IODataContentType#Description:member' + package: '@microsoft/sp-odata-types!' + fullName: Description + summary: Content type description + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'Description: string;' + return: + type: string + - name: DisplayFormUrl + uid: '@microsoft/sp-odata-types!IODataContentType#DisplayFormUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: DisplayFormUrl + summary: Content type display form URL + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'DisplayFormUrl: string;' + return: + type: string + - name: EditFormUrl + uid: '@microsoft/sp-odata-types!IODataContentType#EditFormUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: EditFormUrl + summary: Content type edit form URL + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'EditFormUrl: string;' + return: + type: string + - name: Group + uid: '@microsoft/sp-odata-types!IODataContentType#Group:member' + package: '@microsoft/sp-odata-types!' + fullName: Group + summary: Content type group + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'Group: string;' + return: + type: string + - name: Id + uid: '@microsoft/sp-odata-types!IODataContentType#Id:member' + package: '@microsoft/sp-odata-types!' + fullName: Id + summary: Content type ID + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'Id: IODataContentTypeId;' + return: + type: '' + - name: Name + uid: '@microsoft/sp-odata-types!IODataContentType#Name:member' + package: '@microsoft/sp-odata-types!' + fullName: Name + summary: Content type name + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'Name: string;' + return: + type: string + - name: NewFormUrl + uid: '@microsoft/sp-odata-types!IODataContentType#NewFormUrl:member' + package: '@microsoft/sp-odata-types!' + fullName: NewFormUrl + summary: Content type new form URL + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'NewFormUrl: string;' + return: + type: string + - name: ReadOnly + uid: '@microsoft/sp-odata-types!IODataContentType#ReadOnly:member' + package: '@microsoft/sp-odata-types!' + fullName: ReadOnly + summary: Specifies whether content type is read-only + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'ReadOnly: boolean;' + return: + type: boolean + - name: SchemaXml + uid: '@microsoft/sp-odata-types!IODataContentType#SchemaXml:member' + package: '@microsoft/sp-odata-types!' + fullName: SchemaXml + summary: Content type schema XML + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'SchemaXml: string;' + return: + type: string + - name: StringId + uid: '@microsoft/sp-odata-types!IODataContentType#StringId:member' + package: '@microsoft/sp-odata-types!' + fullName: StringId + summary: Content type string id + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'StringId: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml new file mode 100644 index 00000000..b328ab33 --- /dev/null +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -0,0 +1,129 @@ +### YamlMime:TSType +name: IODataFormsClientSideConfiguration +uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' +package: '@microsoft/sp-odata-types!' +fullName: IODataFormsClientSideConfiguration +summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' +remarks: '' +example: [] +isPreview: false +isDeprecated: false +type: interface +properties: + - name: DislpayFormClientSideDisplayTarget + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DislpayFormClientSideDisplayTarget:member' + package: '@microsoft/sp-odata-types!' + fullName: DislpayFormClientSideDisplayTarget + summary: 'Display Form display target (new tab, panel)' + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'DislpayFormClientSideDisplayTarget: string | undefined;' + return: + type: string | undefined + - name: DisplayFormClientSideComponentId + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentId:member' + package: '@microsoft/sp-odata-types!' + fullName: DisplayFormClientSideComponentId + summary: Display Form Customizer component id + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'DisplayFormClientSideComponentId: string | undefined;' + return: + type: string | undefined + - name: DisplayFormClientSideComponentProperties + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentProperties:member' + package: '@microsoft/sp-odata-types!' + fullName: DisplayFormClientSideComponentProperties + summary: Display Form Customizer component properties + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'DisplayFormClientSideComponentProperties: string | undefined;' + return: + type: string | undefined + - name: EditFormClientSideComponentId + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentId:member' + package: '@microsoft/sp-odata-types!' + fullName: EditFormClientSideComponentId + summary: Edit Form Customizer component id + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'EditFormClientSideComponentId: string | undefined;' + return: + type: string | undefined + - name: EditFormClientSideComponentProperties + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentProperties:member' + package: '@microsoft/sp-odata-types!' + fullName: EditFormClientSideComponentProperties + summary: Edit Form Customizer component properties + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'EditFormClientSideComponentProperties: string | undefined;' + return: + type: string | undefined + - name: EditFormClientSideDisplayTarget + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideDisplayTarget:member' + package: '@microsoft/sp-odata-types!' + fullName: EditFormClientSideDisplayTarget + summary: 'Edit Form display target (new tab, panel)' + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'EditFormClientSideDisplayTarget: string | undefined;' + return: + type: string | undefined + - name: NewFormClientSideComponentId + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentId:member' + package: '@microsoft/sp-odata-types!' + fullName: NewFormClientSideComponentId + summary: New Form Customizer component id + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'NewFormClientSideComponentId: string | undefined;' + return: + type: string | undefined + - name: NewFormClientSideComponentProperties + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentProperties:member' + package: '@microsoft/sp-odata-types!' + fullName: NewFormClientSideComponentProperties + summary: New Form Customizer component properties + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'NewFormClientSideComponentProperties: string | undefined;' + return: + type: string | undefined + - name: NewFormClientSideDisplayTarget + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideDisplayTarget:member' + package: '@microsoft/sp-odata-types!' + fullName: NewFormClientSideDisplayTarget + summary: 'New Form display target (new tab, panel)' + remarks: '' + example: [] + isPreview: false + isDeprecated: false + syntax: + content: 'NewFormClientSideDisplayTarget: string | undefined;' + return: + type: string | undefined diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 18eb0c2a..792fd292 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -183,3 +183,4 @@ properties: content: 'Title: string;' return: type: string +extends: '' diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 86719860..a35cd9fd 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -37,7 +37,7 @@ properties: fullName: addAndCustomizePages summary: >- Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint - Foundation–compatible editor. + Foundation-compatible editor. remarks: '' example: [] isPreview: false diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 55a8a720..a256227a 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -5,15 +5,18 @@ type: package summary: SharePoint Framework property pane. enums: - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - '@microsoft/sp-property-pane!ImageFit:enum' - '@microsoft/sp-property-pane!PopupWindowPosition:enum' - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - '@microsoft/sp-property-pane!ThumbnailType:enum' interfaces: - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-property-pane!IGuidSet:interface' - '@microsoft/sp-property-pane!IPopupWindowProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' @@ -32,15 +35,21 @@ interfaces: - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneField:interface' - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - '@microsoft/sp-property-pane!IPropertyPanePage:interface' - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' + - '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' + - '@microsoft/sp-property-pane!IThumbnailImage:interface' typeAliases: - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + - '@microsoft/sp-property-pane!IThumbnail:type' functions: - name: 'PropertyPaneButton(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' @@ -254,6 +263,30 @@ functions: return: type: '<void>' description: '' + - name: 'PropertyPaneIconPicker(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneIconPicker:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create an IconPicker on the PropertyPane. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneIconPicker(targetProperty: string, properties: + IPropertyPaneIconPickerProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the icon picker is associated to. + type: string + - id: properties + description: Strongly typed IconPicker properties. + type: '' + return: + type: >- + <> + description: '' - name: 'PropertyPaneLabel(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' package: '@microsoft/sp-property-pane!' @@ -350,6 +383,30 @@ functions: <> description: '' + - name: 'PropertyPaneThumbnailPicker(targetProperty, properties)' + uid: '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker:function(1)' + package: '@microsoft/sp-property-pane!' + summary: Helper method to create a ThumbnailPicker on the PropertyPane. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: >- + export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: + IPropertyPaneThumbnailPickerProps): IPropertyPaneField; + parameters: + - id: targetProperty + description: Target property the thumbnail picker is associated to. + type: string + - id: properties + description: Strongly typed ThumbnailPicker properties. + type: '' + return: + type: >- + <> + description: '' - name: 'PropertyPaneToggle(targetProperty, properties)' uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/iguidset.yml b/SP-Framework/sp-property-pane/iguidset.yml new file mode 100644 index 00000000..a03c22e6 --- /dev/null +++ b/SP-Framework/sp-property-pane/iguidset.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: IGuidSet +uid: '@microsoft/sp-property-pane!IGuidSet:interface' +package: '@microsoft/sp-property-pane!' +fullName: IGuidSet +summary: Set of GUIDs representing a list item. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: listId + uid: '@microsoft/sp-property-pane!IGuidSet#listId:member' + package: '@microsoft/sp-property-pane!' + fullName: listId + summary: List ID + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'listId: string;' + return: + type: string + - name: siteId + uid: '@microsoft/sp-property-pane!IGuidSet#siteId:member' + package: '@microsoft/sp-property-pane!' + fullName: siteId + summary: Site ID + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'siteId: string;' + return: + type: string + - name: uniqueId + uid: '@microsoft/sp-property-pane!IGuidSet#uniqueId:member' + package: '@microsoft/sp-property-pane!' + fullName: uniqueId + summary: Unique ID within the list + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'uniqueId: string;' + return: + type: string + - name: webId + uid: '@microsoft/sp-property-pane!IGuidSet#webId:member' + package: '@microsoft/sp-property-pane!' + fullName: webId + summary: Web ID + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'webId: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/imagefit.yml b/SP-Framework/sp-property-pane/imagefit.yml new file mode 100644 index 00000000..ea911f33 --- /dev/null +++ b/SP-Framework/sp-property-pane/imagefit.yml @@ -0,0 +1,55 @@ +### YamlMime:TSEnum +name: ImageFit +uid: '@microsoft/sp-property-pane!ImageFit:enum' +package: '@microsoft/sp-property-pane!' +fullName: ImageFit +summary: The possible methods that can be used to fit the image. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +fields: + - name: center + uid: '@microsoft/sp-property-pane!ImageFit.center:member' + package: '@microsoft/sp-property-pane!' + summary: The image is not scaled. The image is centered and cropped within the content box. + value: '0' + - name: centerContain + uid: '@microsoft/sp-property-pane!ImageFit.centerContain:member' + package: '@microsoft/sp-property-pane!' + summary: >- + The image will be centered horizontally and vertically within the frame and maintains its aspect ratio. It will + behave as ImageFit.center if the image's natural height and width is less than the Image frame's height and width, + but if either natural height or width are larger than the frame it will behave as ImageFit.contain. + value: '5' + - name: centerCover + uid: '@microsoft/sp-property-pane!ImageFit.centerCover:member' + package: '@microsoft/sp-property-pane!' + summary: >- + The image will be centered horizontally and vertically within the frame and maintains its aspect ratio. It will + behave as ImageFit.center if the image's natural height or width is less than the Image frame's height or width, + but if both natural height and width are larger than the frame it will behave as ImageFit.cover. + value: '4' + - name: contain + uid: '@microsoft/sp-property-pane!ImageFit.contain:member' + package: '@microsoft/sp-property-pane!' + summary: >- + The image is scaled to maintain its aspect ratio while being fully contained within the frame. The image will be + centered horizontally and vertically within the frame. The space in the top and bottom or in the sides of the + frame will be empty depending on the difference in aspect ratio between the image and the frame. + value: '1' + - name: cover + uid: '@microsoft/sp-property-pane!ImageFit.cover:member' + package: '@microsoft/sp-property-pane!' + summary: >- + The image is scaled to maintain its aspect ratio while filling the frame. Portions of the image will be cropped + from the top and bottom, or the sides, depending on the difference in aspect ratio between the image and the + frame. + value: '2' + - name: none + uid: '@microsoft/sp-property-pane!ImageFit.none:member' + package: '@microsoft/sp-property-pane!' + summary: >- + Neither the image nor the frame are scaled. If their sizes do not match, the image will either be cropped or the + frame will have empty space. + value: '3' diff --git a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml new file mode 100644 index 00000000..11c75dc4 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -0,0 +1,144 @@ +### YamlMime:TSType +name: IPropertyPaneIconPickerProps +uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneIconPickerProps +summary: PropertyPaneIconPicker component props +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: callerName + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#callerName:member' + package: '@microsoft/sp-property-pane!' + fullName: callerName + summary: Optional name of consuming component for telemetry purposes. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'callerName?: string;' + return: + type: string + - name: customIconSet + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customIconSet:member' + package: '@microsoft/sp-property-pane!' + fullName: customIconSet + summary: >- + The icon picker allows selection of Fabric MDL2 icons. This optional parameter allows the caller to override this + with a custom selection of icons. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'customIconSet?: Map;' + return: + type: 'Map<string, >' + - name: customSelectedIconName + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customSelectedIconName:member' + package: '@microsoft/sp-property-pane!' + fullName: customSelectedIconName + summary: 'When invoking with a custom icon set, this is the name of the currently selected icon.' + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'customSelectedIconName?: string;' + return: + type: string + - name: onItemChanged + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemChanged:member' + package: '@microsoft/sp-property-pane!' + fullName: onItemChanged + summary: Callback function for when an icon is selected. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'onItemChanged?: (iconName: string) => void;' + return: + type: '(iconName: string) => void' + - name: onItemDeleted + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemDeleted:member' + package: '@microsoft/sp-property-pane!' + fullName: onItemDeleted + summary: Callback function for when the Delete button is clicked. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'onItemDeleted?: () => void;' + return: + type: () => void + - name: previewFullWidth + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewFullWidth:member' + package: '@microsoft/sp-property-pane!' + fullName: previewFullWidth + summary: Whether to render the icon preview with full width or the default fixed aspect ratio. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'previewFullWidth?: boolean;' + return: + type: boolean + - name: previewGrayBackground + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewGrayBackground:member' + package: '@microsoft/sp-property-pane!' + fullName: previewGrayBackground + summary: Whether to render the icon with a gray background. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'previewGrayBackground?: boolean;' + return: + type: boolean + - name: thumbnail + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnail:member' + package: '@microsoft/sp-property-pane!' + fullName: thumbnail + summary: Thumbnail metadata of the currently selected icon. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'thumbnail?: IThumbnail;' + return: + type: '' + - name: thumbnailRendererIconClassName + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererIconClassName:member' + package: '@microsoft/sp-property-pane!' + fullName: thumbnailRendererIconClassName + summary: Optional CSS class name to apply to the icon preview. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'thumbnailRendererIconClassName?: string;' + return: + type: string + - name: thumbnailRendererWrapperClassName + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererWrapperClassName:member' + package: '@microsoft/sp-property-pane!' + fullName: thumbnailRendererWrapperClassName + summary: Optional CSS class name to apply to the icon preview wrapper. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'thumbnailRendererWrapperClassName?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml new file mode 100644 index 00000000..9e8dbcb0 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -0,0 +1,144 @@ +### YamlMime:TSType +name: IPropertyPaneThumbnailPickerProps +uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' +package: '@microsoft/sp-property-pane!' +fullName: IPropertyPaneThumbnailPickerProps +summary: PropertyPaneThumbnailPicker component props +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: callerName + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#callerName:member' + package: '@microsoft/sp-property-pane!' + fullName: callerName + summary: Optional name of consuming component for telemetry purposes. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'callerName?: string;' + return: + type: string + - name: forceFullUrl + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#forceFullUrl:member' + package: '@microsoft/sp-property-pane!' + fullName: forceFullUrl + summary: >- + If an asset from the current site is selected, the URL can be returned as a relative URL. This option forces the + URL to be returned as an absolute URL. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'forceFullUrl?: boolean;' + return: + type: boolean + - name: onItemChanged + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged:member' + package: '@microsoft/sp-property-pane!' + fullName: onItemChanged + summary: Callback function for when an image has been selected. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'onItemChanged: (url: string, guidSet: IGuidSet | undefined) => void;' + return: + type: '(url: string, guidSet: | undefined) => void' + - name: onItemDeleted + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemDeleted:member' + package: '@microsoft/sp-property-pane!' + fullName: onItemDeleted + summary: Callback for when the Delete button is clicked. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'onItemDeleted?: () => void;' + return: + type: () => void + - name: previewFullWidth + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewFullWidth:member' + package: '@microsoft/sp-property-pane!' + fullName: previewFullWidth + summary: 'For the preview image, display with full width as opposed to the default fixed ratio.' + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'previewFullWidth?: boolean;' + return: + type: boolean + - name: previewGrayBackground + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewGrayBackground:member' + package: '@microsoft/sp-property-pane!' + fullName: previewGrayBackground + summary: Whether to display a gray background when rendering an icon. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'previewGrayBackground?: boolean;' + return: + type: boolean + - name: serviceScope + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#serviceScope:member' + package: '@microsoft/sp-property-pane!' + fullName: serviceScope + summary: Service scope. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'serviceScope: ServiceScope;' + return: + type: '' + - name: thumbnail + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnail:member' + package: '@microsoft/sp-property-pane!' + fullName: thumbnail + summary: Thumbnail metadata of the currently selected thumbnail. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'thumbnail?: IThumbnail;' + return: + type: '' + - name: thumbnailRendererIconClassName + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererIconClassName:member' + package: '@microsoft/sp-property-pane!' + fullName: thumbnailRendererIconClassName + summary: Optional CSS class name to apply to the thumbnail preview when an icon is being rendered. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'thumbnailRendererIconClassName?: string;' + return: + type: string + - name: thumbnailRendererWrapperClassName + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererWrapperClassName:member' + package: '@microsoft/sp-property-pane!' + fullName: thumbnailRendererWrapperClassName + summary: Optional CSS class name to apply to the wrapper of the thumbnail preview. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'thumbnailRendererWrapperClassName?: string;' + return: + type: string diff --git a/SP-Framework/sp-property-pane/ithumbnail.yml b/SP-Framework/sp-property-pane/ithumbnail.yml new file mode 100644 index 00000000..e5670cd8 --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnail.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: IThumbnail +uid: '@microsoft/sp-property-pane!IThumbnail:type' +package: '@microsoft/sp-property-pane!' +fullName: IThumbnail +summary: The type of thumbnail image being configured. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +syntax: export declare type IThumbnail = IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage; diff --git a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml new file mode 100644 index 00000000..67ada762 --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: IThumbnailFabricReactIcon +uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' +package: '@microsoft/sp-property-pane!' +fullName: IThumbnailFabricReactIcon +summary: Options related to fabric icon thumbnail. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: altText + uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#altText:member' + package: '@microsoft/sp-property-pane!' + fullName: altText + summary: Alt text for the icon. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'altText: string;' + return: + type: string + - name: iconColor + uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconColor:member' + package: '@microsoft/sp-property-pane!' + fullName: iconColor + summary: The background color for the icon. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'iconColor?: string;' + return: + type: string + - name: iconName + uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconName:member' + package: '@microsoft/sp-property-pane!' + fullName: iconName + summary: The name of the icon to render. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'iconName: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#type:member' + package: '@microsoft/sp-property-pane!' + fullName: type + summary: Fabric icon type. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ThumbnailType.FabricReactIcon;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml new file mode 100644 index 00000000..3744aa1f --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: IThumbnailIconSizeImage +uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' +package: '@microsoft/sp-property-pane!' +fullName: IThumbnailIconSizeImage +summary: Options related to icon sized image thumbnail. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: altText + uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#altText:member' + package: '@microsoft/sp-property-pane!' + fullName: altText + summary: Alt text for the image. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'altText: string;' + return: + type: string + - name: iconColor + uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconColor:member' + package: '@microsoft/sp-property-pane!' + fullName: iconColor + summary: Background color to use for the icon. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'iconColor?: string;' + return: + type: string + - name: iconUrl + uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconUrl:member' + package: '@microsoft/sp-property-pane!' + fullName: iconUrl + summary: URL pointing to the icon-size image. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'iconUrl: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#type:member' + package: '@microsoft/sp-property-pane!' + fullName: type + summary: Image type. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ThumbnailType.IconSizeImage;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/ithumbnailimage.yml b/SP-Framework/sp-property-pane/ithumbnailimage.yml new file mode 100644 index 00000000..7a476525 --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: IThumbnailImage +uid: '@microsoft/sp-property-pane!IThumbnailImage:interface' +package: '@microsoft/sp-property-pane!' +fullName: IThumbnailImage +summary: Options related to image thumbnail. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +type: interface +properties: + - name: altText + uid: '@microsoft/sp-property-pane!IThumbnailImage#altText:member' + package: '@microsoft/sp-property-pane!' + fullName: altText + summary: Alt text for the image. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'altText: string;' + return: + type: string + - name: backupImageUrl + uid: '@microsoft/sp-property-pane!IThumbnailImage#backupImageUrl:member' + package: '@microsoft/sp-property-pane!' + fullName: backupImageUrl + summary: Optional backup image URL if the original image URL fails to load. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'backupImageUrl: string | undefined;' + return: + type: string | undefined + - name: imageFit + uid: '@microsoft/sp-property-pane!IThumbnailImage#imageFit:member' + package: '@microsoft/sp-property-pane!' + fullName: imageFit + summary: How the image should fit. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'imageFit: ImageFit | undefined;' + return: + type: ' | undefined' + - name: imageUrl + uid: '@microsoft/sp-property-pane!IThumbnailImage#imageUrl:member' + package: '@microsoft/sp-property-pane!' + fullName: imageUrl + summary: URL pointing to the image. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'imageUrl: string;' + return: + type: string + - name: type + uid: '@microsoft/sp-property-pane!IThumbnailImage#type:member' + package: '@microsoft/sp-property-pane!' + fullName: type + summary: Image type. + remarks: '' + example: [] + isPreview: true + isDeprecated: false + syntax: + content: 'type: ThumbnailType.Image;' + return: + type: '' diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 76f2de16..44cdb99d 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -62,6 +62,11 @@ fields: package: '@microsoft/sp-property-pane!' summary: Horizontal Rule field. value: '12' + - name: IconPicker + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.IconPicker:member' + package: '@microsoft/sp-property-pane!' + summary: Icon picker field. + value: '19' - name: Label uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' package: '@microsoft/sp-property-pane!' @@ -82,6 +87,11 @@ fields: package: '@microsoft/sp-property-pane!' summary: TextField field. value: '3' + - name: ThumbnailPicker + uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ThumbnailPicker:member' + package: '@microsoft/sp-property-pane!' + summary: Thumbnail picker field. + value: '18' - name: Toggle uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/thumbnailtype.yml b/SP-Framework/sp-property-pane/thumbnailtype.yml new file mode 100644 index 00000000..20bd46a6 --- /dev/null +++ b/SP-Framework/sp-property-pane/thumbnailtype.yml @@ -0,0 +1,26 @@ +### YamlMime:TSEnum +name: ThumbnailType +uid: '@microsoft/sp-property-pane!ThumbnailType:enum' +package: '@microsoft/sp-property-pane!' +fullName: ThumbnailType +summary: Supported thumbnail image types. +remarks: '' +example: [] +isPreview: true +isDeprecated: false +fields: + - name: FabricReactIcon + uid: '@microsoft/sp-property-pane!ThumbnailType.FabricReactIcon:member' + package: '@microsoft/sp-property-pane!' + summary: Name of a supported icon. + value: '2' + - name: IconSizeImage + uid: '@microsoft/sp-property-pane!ThumbnailType.IconSizeImage:member' + package: '@microsoft/sp-property-pane!' + summary: Link to an icon-sized image. + value: '3' + - name: Image + uid: '@microsoft/sp-property-pane!ThumbnailType.Image:member' + package: '@microsoft/sp-property-pane!' + summary: Link to an image. + value: '1' diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index c9fe9146..5339bf08 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -63,6 +63,11 @@ fields: package: '@microsoft/sp-webpart-base!' summary: Horizontal Rule field. value: '12' + - name: IconPicker + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.IconPicker:member' + package: '@microsoft/sp-webpart-base!' + summary: Icon picker field. + value: '19' - name: Label uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' package: '@microsoft/sp-webpart-base!' @@ -83,6 +88,11 @@ fields: package: '@microsoft/sp-webpart-base!' summary: TextField field. value: '3' + - name: ThumbnailPicker + uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ThumbnailPicker:member' + package: '@microsoft/sp-webpart-base!' + summary: Thumbnail picker field. + value: '18' - name: Toggle uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/toc.yml b/SP-Framework/toc.yml index 7a23fd43..45e0301f 100644 --- a/SP-Framework/toc.yml +++ b/SP-Framework/toc.yml @@ -174,6 +174,8 @@ items: uid: '@microsoft/sp-core-library!Environment:class' - name: EnvironmentType uid: '@microsoft/sp-core-library!EnvironmentType:enum' + - name: FormDisplayMode + uid: '@microsoft/sp-core-library!FormDisplayMode:enum' - name: Guid uid: '@microsoft/sp-core-library!Guid:class' - name: IDisposable @@ -330,6 +332,8 @@ items: uid: '@microsoft/sp-http!MSGraphClient:class' - name: MSGraphClientFactory uid: '@microsoft/sp-http!MSGraphClientFactory:class' + - name: MSGraphClientV3 + uid: '@microsoft/sp-http!MSGraphClientV3:class' - name: ODataVersion uid: '@microsoft/sp-http!ODataVersion:class' - name: SPHttpClient @@ -371,6 +375,8 @@ items: items: - name: BaseFieldCustomizer uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - name: BaseFormCustomizer + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' - name: BaseListViewCommandSet uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - name: ColumnAccessor @@ -379,14 +385,20 @@ items: uid: '@microsoft/sp-listview-extensibility!Command:class' - name: FieldCustomizerContext uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - name: FormCustomizerContext + uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' - name: IColumn uid: '@microsoft/sp-listview-extensibility!IColumn:interface' + - name: IContentType + uid: '@microsoft/sp-listview-extensibility!IContentType:interface' - name: IFieldCustomizerCellEventParameters uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - name: IFilter uid: '@microsoft/sp-listview-extensibility!IFilter:interface' - name: IFolderInfo uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - name: IFormCustomizerContext + uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' - name: IList uid: '@microsoft/sp-listview-extensibility!IList:interface' - name: IListViewAccessorState @@ -462,14 +474,16 @@ items: uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - name: IComponentModuleConfiguration uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - name: IIntegrityPath + uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' - name: ILocalizedPathModuleConfiguration uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - name: ILocalizedString uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' - name: IModuleConfiguration - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface' - - name: IPath - uid: '@microsoft/sp-module-interfaces!IPath:interface' + uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:type' + - name: IModuleConfigurationBase + uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' - name: IPathModuleConfiguration uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' - name: PredefinedGroup @@ -483,8 +497,12 @@ items: uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' - name: IODataChangeToken uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + - name: IODataContentType + uid: '@microsoft/sp-odata-types!IODataContentType:interface' - name: IODataContextWebInformation uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - name: IODataFormsClientSideConfiguration + uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' - name: IODataList uid: '@microsoft/sp-odata-types!IODataList:interface' - name: IODataListItem @@ -541,6 +559,10 @@ items: uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - name: IDynamicDataSharedSourceFilters uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - name: IGuidSet + uid: '@microsoft/sp-property-pane!IGuidSet:interface' + - name: ImageFit + uid: '@microsoft/sp-property-pane!ImageFit:enum' - name: IPopupWindowProps uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' - name: IPropertyPaneButtonProps @@ -579,6 +601,8 @@ items: uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' - name: IPropertyPaneGroup uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - name: IPropertyPaneIconPickerProps + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' - name: IPropertyPaneLabelProps uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - name: IPropertyPaneLinkProps @@ -591,8 +615,18 @@ items: uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - name: IPropertyPaneTextFieldProps uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - name: IPropertyPaneThumbnailPickerProps + uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' - name: IPropertyPaneToggleProps uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - name: IThumbnail + uid: '@microsoft/sp-property-pane!IThumbnail:type' + - name: IThumbnailFabricReactIcon + uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' + - name: IThumbnailIconSizeImage + uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' + - name: IThumbnailImage + uid: '@microsoft/sp-property-pane!IThumbnailImage:interface' - name: PopupWindowPosition uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' - name: PropertyPaneButtonType @@ -601,6 +635,8 @@ items: uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - name: PropertyPaneFieldType uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - name: ThumbnailType + uid: '@microsoft/sp-property-pane!ThumbnailType:enum' - name: sp-search-extensibility uid: '@microsoft/sp-search-extensibility!' items: From a58074da56be241256f07cd110956ab0dadf6b83 Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Wed, 30 Mar 2022 14:16:15 -0700 Subject: [PATCH 52/55] removed example:[] --- SP-Framework/decorators.yml | 6 +- .../office-ui-fabric-react-bundle.yml | 2 +- .../adaptivecardextensioncontext.yml | 10 +-- .../baseadaptivecardextension.yml | 72 ++++++++-------- .../baseadaptivecardview.yml | 10 +-- .../basebasiccardview.yml | 4 +- .../basecardview.yml | 10 +-- .../baseimagecardview.yml | 4 +- .../baseprimarytextcardview.yml | 4 +- .../baseview.yml | 26 +++--- .../cardsize.yml | 2 +- .../devicecontext.yml | 2 +- .../iactionarguments.yml | 2 +- .../iactionerror.yml | 2 +- .../iactionerrorarguments.yml | 2 +- ...daptivecardextensionpropertiesmetadata.yml | 2 +- ...iadaptivecardextensionpropertymetadata.yml | 2 +- .../iattachmenterror.yml | 4 +- .../ibaseactionarguments.yml | 6 +- .../ibaseactionerrorarguments.yml | 8 +- .../ibasecardparameters.yml | 8 +- .../ibasiccardparameters.yml | 4 +- .../icachedloadparameters.yml | 6 +- .../icachesettings.yml | 8 +- .../icardaction.yml | 2 +- .../icardbutton.yml | 10 +-- .../iconfirmationdialog.yml | 6 +- .../iexternallinkcardaction.yml | 6 +- .../iexternallinkparameters.yml | 6 +- .../igetlocationaction.yml | 6 +- .../igetlocationactionarguments.yml | 6 +- .../igetlocationactionparameters.yml | 4 +- .../igetlocationcardaction.yml | 6 +- .../iimagecardparameters.yml | 6 +- .../ilocation.yml | 10 +-- .../ilocationerrorarguments.yml | 6 +- .../iprimarytextcardparameters.yml | 6 +- .../iquickviewcardaction.yml | 6 +- .../iquickviewparameters.yml | 4 +- .../iselectmediaaction.yml | 6 +- .../iselectmediaactionarguments.yml | 8 +- .../iselectmediaactionerrorarguments.yml | 8 +- .../iselectmediaactionparameters.yml | 10 +-- .../iselectmediaattachment.yml | 8 +- .../iselectmediacardaction.yml | 6 +- .../ishowcardactionarguments.yml | 4 +- .../ishowlocationaction.yml | 6 +- .../ishowlocationactionparameters.yml | 4 +- .../ishowlocationcardaction.yml | 6 +- .../ispfxadaptivecard.yml | 4 +- .../isubmitactionarguments.yml | 6 +- .../isubmitcardaction.yml | 8 +- .../isubmitcardparameters.yml | 2 +- .../mediatype.yml | 2 +- .../quickviewnavigator.yml | 4 +- .../rendertype.yml | 2 +- .../viewnavigator.yml | 16 ++-- .../applicationaccessor.yml | 6 +- .../applicationcustomizercontext.yml | 8 +- .../baseapplicationcustomizer.yml | 8 +- .../iplaceholdercreatecontentoptions.yml | 4 +- .../placeholdercontent.yml | 12 +-- .../sp-application-base/placeholdername.yml | 2 +- .../placeholderprovider.yml | 12 +-- .../sp-component-base/basecomponent.yml | 16 ++-- .../basecomponentcontext.yml | 30 +++---- .../sp-component-base/dynamicdataprovider.yml | 22 ++--- .../dynamicdatasourcemanager.yml | 16 ++-- .../sp-component-base/dynamicproperty.yml | 28 +++---- .../icomponentpropertymetadata.yml | 12 +-- .../sp-component-base/ireadonlyfontstyles.yml | 2 +- .../sp-component-base/ireadonlyrawstyle.yml | 2 +- .../sp-component-base/ireadonlytheme.yml | 2 +- .../iserializedserverprocesseddata.yml | 10 +-- SP-Framework/sp-component-base/itheme.yml | 2 +- .../themechangedeventargs.yml | 4 +- .../sp-component-base/themeprovider.yml | 10 +-- SP-Framework/sp-core-library/displaymode.yml | 2 +- SP-Framework/sp-core-library/environment.yml | 4 +- .../sp-core-library/environmenttype.yml | 2 +- .../sp-core-library/formdisplaymode.yml | 2 +- SP-Framework/sp-core-library/guid.yml | 16 ++-- SP-Framework/sp-core-library/idisposable.yml | 6 +- .../irandomnumbergenerator.yml | 4 +- .../sp-core-library/iservicecollection.yml | 4 +- .../sp-core-library/ispeventobserver.yml | 6 +- .../sp-core-library/itimeprovider.yml | 6 +- SP-Framework/sp-core-library/log.yml | 10 +-- .../sp-core-library/randomnumbergenerator.yml | 8 +- .../sp-core-library/servicecreator.yml | 2 +- SP-Framework/sp-core-library/servicekey.yml | 12 +-- SP-Framework/sp-core-library/servicescope.yml | 22 ++--- SP-Framework/sp-core-library/session.yml | 8 +- SP-Framework/sp-core-library/spevent.yml | 6 +- SP-Framework/sp-core-library/speventargs.yml | 2 +- SP-Framework/sp-core-library/text_2.yml | 6 +- SP-Framework/sp-core-library/timeprovider.yml | 10 +-- .../urlqueryparametercollection.yml | 8 +- SP-Framework/sp-core-library/validate.yml | 10 +-- SP-Framework/sp-core-library/version.yml | 28 +++---- SP-Framework/sp-dialog/basedialog.yml | 24 +++--- SP-Framework/sp-dialog/dialog.yml | 6 +- SP-Framework/sp-dialog/ialertoptions.yml | 2 +- .../sp-dialog/idialogconfiguration.yml | 4 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 4 +- SP-Framework/sp-dialog/ipromptoptions.yml | 4 +- .../sp-dialog/isecondarydialogprovider.yml | 8 +- .../sp-dynamic-data/dynamicdatareference.yml | 12 +-- .../idynamicdataannotatedpropertyvalue.yml | 6 +- .../sp-dynamic-data/idynamicdatacallables.yml | 12 +-- .../idynamicdataeventdefinition.yml | 6 +- .../idynamicdatapropertydefinition.yml | 4 +- .../idynamicdatapropertymetadata.yml | 6 +- .../idynamicdatapropertyvaluemetadata.yml | 4 +- ...micdatapropertyvaluemetadatacollection.yml | 2 +- .../sp-dynamic-data/idynamicdatasource.yml | 22 ++--- .../idynamicdatasourcemetadata.yml | 12 +-- .../sp-extension-base/baseextension.yml | 8 +- .../sp-extension-base/extensioncontext.yml | 2 +- SP-Framework/sp-http/aadhttpclient.yml | 12 +-- .../sp-http/aadhttpclientconfiguration.yml | 8 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 6 +- .../sp-http/aadhttpclientresponse.yml | 4 +- SP-Framework/sp-http/aadtokenprovider.yml | 8 +- .../sp-http/aadtokenproviderfactory.yml | 6 +- .../sp-http/beforeredirecteventargs.yml | 8 +- SP-Framework/sp-http/digestcache.yml | 14 ++-- SP-Framework/sp-http/graphrequest.yml | 62 +++++++------- SP-Framework/sp-http/httpclient.yml | 14 ++-- .../sp-http/httpclientconfiguration.yml | 10 +-- SP-Framework/sp-http/httpclientresponse.yml | 30 +++---- .../sp-http/iaadhttpclientconfiguration.yml | 2 +- .../sp-http/iaadhttpclientconfigurations.yml | 4 +- .../sp-http/iaadhttpclientoptions.yml | 8 +- SP-Framework/sp-http/iaadtokenprovider.yml | 8 +- .../iaadtokenproviderconfiguration.yml | 18 ++-- .../sp-http/ibeforeredirecteventargs.yml | 6 +- SP-Framework/sp-http/idigestcache.yml | 10 +-- .../sp-http/ihttpclientconfiguration.yml | 2 +- .../sp-http/ihttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/ihttpclientoptions.yml | 2 +- .../isphttpclientbatchconfiguration.yml | 2 +- .../isphttpclientbatchconfigurations.yml | 4 +- .../isphttpclientbatchcreationoptions.yml | 4 +- .../sp-http/isphttpclientbatchoptions.yml | 2 +- .../isphttpclientcommonconfiguration.yml | 6 +- .../sp-http/isphttpclientconfiguration.yml | 8 +- .../sp-http/isphttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/isphttpclientoptions.yml | 4 +- .../sp-http/itokenacquisitioneventargs.yml | 6 +- SP-Framework/sp-http/msgraphclient.yml | 4 +- SP-Framework/sp-http/msgraphclientfactory.yml | 10 +-- SP-Framework/sp-http/msgraphclientv3.yml | 4 +- SP-Framework/sp-http/odataversion.yml | 10 +-- SP-Framework/sp-http/sphttpclient.yml | 20 ++--- SP-Framework/sp-http/sphttpclientbatch.yml | 12 +-- .../sphttpclientbatchconfiguration.yml | 10 +-- .../sphttpclientcommonconfiguration.yml | 14 ++-- .../sp-http/sphttpclientconfiguration.yml | 16 ++-- SP-Framework/sp-http/sphttpclientresponse.yml | 8 +- SP-Framework/sp-http/sphttpheader.yml | 2 +- .../sp-http/tokenacquisitioneventargs.yml | 8 +- .../sp-image-helper/iimagehelperrequest.yml | 8 +- SP-Framework/sp-image-helper/imagehelper.yml | 4 +- .../icreatesubscriptionsettings.yml | 12 +-- .../ilistsubscription.yml | 4 +- .../isubscriptioncallbacks.yml | 8 +- .../listsubscriptionfactory.yml | 8 +- .../basefieldcustomizer.yml | 8 +- .../baseformcustomizer.yml | 16 ++-- .../baselistviewcommandset.yml | 12 +-- .../columnaccessor.yml | 6 +- .../sp-listview-extensibility/command.yml | 14 ++-- .../fieldcustomizercontext.yml | 6 +- .../formcustomizercontext.yml | 14 ++-- .../sp-listview-extensibility/icolumn.yml | 18 ++-- .../icontenttype.yml | 8 +- .../ifieldcustomizercelleventparameters.yml | 10 +-- .../sp-listview-extensibility/ifilter.yml | 6 +- .../sp-listview-extensibility/ifolderinfo.yml | 4 +- .../iformcustomizercontext.yml | 12 +-- .../sp-listview-extensibility/ilist.yml | 8 +- .../ilistviewaccessorstate.yml | 20 ++--- ...stviewcommandsetexecuteeventparameters.yml | 6 +- ...iewcommandsetlistviewupdatedparameters.yml | 4 +- .../sp-listview-extensibility/irow.yml | 4 +- .../sp-listview-extensibility/iview.yml | 8 +- .../listitemaccessor.yml | 8 +- .../listviewaccessor.yml | 26 +++--- .../listviewaccessorstatechanges.yml | 2 +- .../listviewcommandsetcontext.yml | 6 +- .../listviewstatechangedeventargs.yml | 6 +- .../sp-listview-extensibility/rowaccessor.yml | 2 +- .../selectedrowschangedeventargs.yml | 4 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 4 +- SP-Framework/sp-loader/spcomponentloader.yml | 12 +-- SP-Framework/sp-lodash-subset/cancelable.yml | 2 +- .../sp-lodash-subset/throttlesettings.yml | 2 +- .../sp-module-interfaces/componenttype.yml | 2 +- .../sp-module-interfaces/extensiontype.yml | 2 +- .../iadaptivecardextensionmanifest.yml | 18 ++-- .../iadaptivecardextensionmanifestentry.yml | 20 ++--- .../iclientsideassemblymanifest.yml | 4 +- ...clientsidecomponentloaderconfiguration.yml | 10 +-- .../iclientsidecomponentmanifest.yml | 16 ++-- .../iclientsideextensionmanifest.yml | 4 +- .../iclientsidelibrarymanifest.yml | 2 +- .../iclientsidemanifestbase.yml | 6 +- .../iclientsidewebpartmanifest.yml | 18 ++-- .../iclientsidewebpartmanifestentry.yml | 22 ++--- .../iclientsidewebpartmanifestinstance.yml | 2 +- .../icommanddefinition.yml | 10 +-- .../icommandsetextensionmanifest.yml | 6 +- .../icomponentmoduleconfiguration.yml | 10 +-- .../sp-module-interfaces/iintegritypath.yml | 6 +- .../ilocalizedpathmoduleconfiguration.yml | 8 +- .../sp-module-interfaces/ilocalizedstring.yml | 6 +- .../imoduleconfiguration.yml | 2 +- .../imoduleconfigurationbase.yml | 6 +- SP-Framework/sp-module-interfaces/ipath.yml | 6 +- .../ipathmoduleconfiguration.yml | 10 +-- .../sp-module-interfaces/predefinedgroup.yml | 2 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 6 +- .../sp-odata-types/iodatabasepermission.yml | 6 +- .../sp-odata-types/iodatachangetoken.yml | 4 +- .../sp-odata-types/iodatacontenttype.yml | 24 +++--- .../iodatacontextwebinformation.yml | 10 +-- .../iodataformsclientsideconfiguration.yml | 20 ++--- SP-Framework/sp-odata-types/iodatalist.yml | 28 +++---- .../sp-odata-types/iodatalistitem.yml | 10 +-- .../sp-odata-types/iodatanavigationnode.yml | 16 ++-- .../iodatanavigationnodecollection.yml | 6 +- SP-Framework/sp-odata-types/iodatauser.yml | 16 ++-- .../sp-odata-types/iodatausercustomaction.yml | 38 ++++----- SP-Framework/sp-odata-types/iodataweb.yml | 38 ++++----- SP-Framework/sp-page-context/cultureinfo.yml | 8 +- .../sp-page-context/ispsystemtime.yml | 18 ++-- .../sp-page-context/isptimezonedata.yml | 16 ++-- SP-Framework/sp-page-context/pagecontext.yml | 24 +++--- .../sp-page-context/spdayofweek-typealias.yml | 2 +- SP-Framework/sp-page-context/spfield.yml | 16 ++-- SP-Framework/sp-page-context/splist.yml | 10 +-- SP-Framework/sp-page-context/splistitem.yml | 4 +- SP-Framework/sp-page-context/sppermission.yml | 84 +++++++++---------- SP-Framework/sp-page-context/spsite.yml | 24 +++--- SP-Framework/sp-page-context/sptimezone.yml | 16 ++-- SP-Framework/sp-page-context/spuser.yml | 18 ++-- SP-Framework/sp-page-context/spweb.yml | 28 +++---- SP-Framework/sp-property-pane.yml | 32 +++---- .../dynamicdatashareddepth.yml | 2 +- ...dynamicdatasharedpropertyconfiguration.yml | 4 +- .../idynamicdatasharedpropertyfilters.yml | 4 +- .../idynamicdatasharedsourceconfiguration.yml | 6 +- .../idynamicdatasharedsourcefilters.yml | 6 +- SP-Framework/sp-property-pane/iguidset.yml | 10 +-- SP-Framework/sp-property-pane/imagefit.yml | 2 +- .../sp-property-pane/ipopupwindowprops.yml | 10 +-- .../ipropertypanebuttonprops.yml | 18 ++-- .../ipropertypanecheckboxprops.yml | 8 +- .../ipropertypanechoicegroupoption.yml | 20 ++--- ...propertypanechoicegroupoptioniconprops.yml | 4 +- .../ipropertypanechoicegroupprops.yml | 6 +- .../ipropertypaneconditionalgroup.yml | 12 +-- .../ipropertypaneconfiguration.yml | 14 ++-- .../ipropertypanecustomfieldprops.yml | 10 +-- .../ipropertypanedebounceproperty.yml | 6 +- .../ipropertypanedropdowncalloutprops.yml | 4 +- .../ipropertypanedropdownoption.yml | 10 +-- .../ipropertypanedropdownprops.yml | 20 ++--- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 10 +-- .../ipropertypanedynamicfieldsetprops.yml | 8 +- .../ipropertypanedynamictextfieldprops.yml | 22 ++--- .../sp-property-pane/ipropertypanefield.yml | 10 +-- .../sp-property-pane/ipropertypanegroup.yml | 10 +-- .../ipropertypaneiconpickerprops.yml | 22 ++--- .../ipropertypanelabelprops.yml | 6 +- .../ipropertypanelinkprops.yml | 12 +-- .../sp-property-pane/ipropertypanepage.yml | 8 +- .../ipropertypanepageheader.yml | 6 +- .../ipropertypanesliderprops.yml | 20 ++--- .../ipropertypanetextfieldprops.yml | 36 ++++---- .../ipropertypanethumbnailpickerprops.yml | 22 ++--- .../ipropertypanetoggleprops.yml | 18 ++-- SP-Framework/sp-property-pane/ithumbnail.yml | 2 +- .../ithumbnailfabricreacticon.yml | 10 +-- .../ithumbnailiconsizeimage.yml | 10 +-- .../sp-property-pane/ithumbnailimage.yml | 12 +-- .../sp-property-pane/popupwindowposition.yml | 2 +- .../propertypanebuttontype.yml | 2 +- .../propertypanedropdownoptiontype.yml | 2 +- .../propertypanefieldtype.yml | 2 +- .../sp-property-pane/thumbnailtype.yml | 2 +- .../basesearchquerymodifier.yml | 8 +- .../sp-search-extensibility/iquery.yml | 6 +- .../searchquerymodifiercontext.yml | 2 +- .../searchqueryscenario.yml | 2 +- SP-Framework/sp-webpart-base.yml | 28 +++---- .../sp-webpart-base/baseclientsidewebpart.yml | 34 ++++---- SP-Framework/sp-webpart-base/basewebpart.yml | 48 +++++------ .../sp-webpart-base/basewebpartcontext.yml | 10 +-- .../dynamicdatashareddepth.yml | 2 +- .../iclientsidewebpartstatusrenderer.yml | 10 +-- ...dynamicdatasharedpropertyconfiguration.yml | 2 +- .../idynamicdatasharedpropertyfilters.yml | 2 +- .../idynamicdatasharedsourceconfiguration.yml | 2 +- .../idynamicdatasharedsourcefilters.yml | 2 +- .../sp-webpart-base/imicrosoftteams.yml | 6 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 14 ++-- .../ipropertypanebuttonprops.yml | 2 +- .../ipropertypanecheckboxprops.yml | 2 +- .../ipropertypanechoicegroupoption.yml | 2 +- ...propertypanechoicegroupoptioniconprops.yml | 2 +- .../ipropertypanechoicegroupprops.yml | 2 +- .../ipropertypaneconditionalgroup.yml | 2 +- .../ipropertypaneconfiguration.yml | 2 +- .../ipropertypanecustomfieldprops.yml | 2 +- .../ipropertypanedropdowncalloutprops.yml | 2 +- .../ipropertypanedropdownoption.yml | 2 +- .../ipropertypanedropdownprops.yml | 2 +- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 2 +- .../ipropertypanedynamicfieldsetprops.yml | 2 +- .../ipropertypanedynamictextfieldprops.yml | 2 +- .../sp-webpart-base/ipropertypanefield.yml | 2 +- .../sp-webpart-base/ipropertypanegroup.yml | 2 +- .../ipropertypanelabelprops.yml | 2 +- .../ipropertypanelinkprops.yml | 2 +- .../sp-webpart-base/ipropertypanepage.yml | 2 +- .../ipropertypanepageheader.yml | 2 +- .../ipropertypanesliderprops.yml | 2 +- .../ipropertypanetextfieldprops.yml | 2 +- .../ipropertypanetoggleprops.yml | 2 +- SP-Framework/sp-webpart-base/isdks.yml | 4 +- .../iserializedwebpartdata.yml | 12 +-- .../sp-webpart-base/iwebpartcontext.yml | 20 ++--- SP-Framework/sp-webpart-base/iwebpartdata.yml | 20 ++--- .../iwebpartpropertiesmetadata.yml | 2 +- .../iwebpartpropertymetadata.yml | 4 +- .../propertypanebuttontype.yml | 2 +- .../propertypanedropdownoptiontype.yml | 2 +- .../sp-webpart-base/propertypanefieldtype.yml | 2 +- .../sp-webpart-base/webpartcontext.yml | 12 +-- .../sp-webpart-base/webpartformfactor.yml | 2 +- 344 files changed, 1556 insertions(+), 1556 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 7aa0222c..2d1e8098 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -13,7 +13,7 @@ functions: -->virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ functions: inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ functions: definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml index 8d507768..c7606359 100644 --- a/SP-Framework/office-ui-fabric-react-bundle.yml +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -9,7 +9,7 @@ functions: package: '@microsoft/office-ui-fabric-react-bundle!' summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index 8d4784bc..89203738 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -7,7 +7,7 @@ summary: Adaptive Card Extension context object. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AdaptiveCardExtensionContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: deviceContext summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: location summary: Provides a promise that gets current location of the device remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: manifest summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: propertyPane summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index abaed17e..6920fa19 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardExtension summary: Base class for Adaptive Card Extensions. remarks: Adaptive Card Extensions must inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: (constructor)() summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -28,7 +28,7 @@ properties: fullName: _iconProperty summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: _title summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: cardNavigator summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: cardSize summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ properties: fullName: context summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -97,7 +97,7 @@ properties: The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to manage versioning of the Adaptive Card Extension. remarks: The default version is 1.0. - example: [] + isPreview: false isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: fullName: description summary: The description of the Adaptive Card Extension defined in the manifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: fullName: displayMode summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -136,7 +136,7 @@ properties: fullName: iconProperty summary: The icon url used to render an icon on the Card view. remarks: 'By default, this will return the iconImageUrl defined in the manifest.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: remarks: >- This method should be called after a card view has been registered. Otherwise visibility change will not be applied to the Adaptive Card. - example: [] + isPreview: false isDeprecated: false syntax: @@ -174,7 +174,7 @@ properties: is `QuickView` then returns [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). - example: [] + isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ properties: fullName: properties summary: 'The custom, persisted properties of the Adaptive Card Extension.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -207,7 +207,7 @@ properties: See [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) for more information about how to define metadata. - example: [] + isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ properties: [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ properties: Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default state. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -256,7 +256,7 @@ properties: fullName: renderedOnce summary: Indicates whether the Adaptive Card Extension has initially rendered. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ properties: fullName: renderType summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -285,7 +285,7 @@ properties: If this property is not initialized, [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) cannot be called. - example: [] + isPreview: false isDeprecated: false syntax: @@ -303,7 +303,7 @@ properties: This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also displayed as the Property Pane title. remarks: 'By default, this will return the title defined in the manifest.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -319,7 +319,7 @@ methods: fullName: getCachedState(state) summary: This virtual method returns a subset of the state object that will be cached by the client. remarks: 'If not overriden, this will return an empty object.' - example: [] + isPreview: true isDeprecated: false syntax: @@ -339,7 +339,7 @@ methods: fullName: getCacheSettings() summary: Override the default cache settings. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -360,7 +360,7 @@ methods: Property Pane resources can be defer loaded to reduce bundle size. See [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). - example: [] + isPreview: false isDeprecated: false syntax: @@ -378,7 +378,7 @@ methods: remarks: >- No Property Pane events will be raised until this method resolves except for `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. - example: [] + isPreview: false isDeprecated: false syntax: @@ -403,7 +403,7 @@ methods: was serialized by an older version of the Adaptive Card Extension that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - example: [] + isPreview: false isDeprecated: false syntax: @@ -434,7 +434,7 @@ methods: Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than the property pane (except for isolated Adaptive Card Extensions). remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -454,7 +454,7 @@ methods: fullName: onBeforeSerialize() summary: Lifecycle method called before serialization. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -470,7 +470,7 @@ methods: fullName: onDisplayModeChanged(oldDisplayMode) summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -490,7 +490,7 @@ methods: fullName: onDispose() summary: Lifecycle method called before disposing the Adaptive Card Extension. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -508,7 +508,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - example: [] + isPreview: false isDeprecated: false syntax: @@ -526,7 +526,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - example: [] + isPreview: true isDeprecated: false syntax: @@ -550,7 +550,7 @@ methods: fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' summary: Lifecycle method called when a Property Pane field is changed. remarks: This is invoked for reactive Property Panes. - example: [] + isPreview: false isDeprecated: false syntax: @@ -581,7 +581,7 @@ methods: Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) changes. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -601,7 +601,7 @@ methods: fullName: renderCard() summary: The id of the initial Card view. remarks: 'By default, this returns undefined and will render a default Card view.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -621,7 +621,7 @@ methods: must have been initialized before calling [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml index 6d23abe3..aaf21156 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardView summary: Base class for an Adaptive Card view. remarks: Views used to render the Quick view must inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: data summary: The data used to render the Adaptive Card. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: externalLink summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: template summary: The Adaptive Card template rendered by the view. remarks: The format of the template must be valid Adaptive Card JSON. - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: remarks: >- If not overriden, the title displayed will be [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index c8653ee6..c7b7c869 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -7,7 +7,7 @@ summary: Base class for a Basic Card view. remarks: >- The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the `Medium` Card size, two buttons in the `Large` Card size -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index c5158482..05487e0f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party Card views should inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: remarks: >- Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the documentation for the respective base Card View class for specific details. - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: remarks: >- The available data to display is dependent on the Card view template and its respective base Card view class. See the documentation for the Card View class for specific details. - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: isCacheEnabled summary: 'If true, this Card view will be cached and rendered at next load.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: onCardSelection summary: Action to invoke when the card is selected. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index 2d1740b0..ab1d8a7d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -7,7 +7,7 @@ summary: Base class for an Image Card view. remarks: >- The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml index c1781b0f..15348edc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -7,7 +7,7 @@ summary: Base class for a Primary Text Card view. remarks: >- The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml index 58bd6408..d8d63da6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party views should inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ properties: [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: data summary: The data used to render the View. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -101,7 +101,7 @@ properties: [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -119,7 +119,7 @@ properties: [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: fullName: template summary: The Adaptive Card template used to render the view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ methods: fullName: onAction(action) summary: Action handler for Adaptive Card Actions. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -166,7 +166,7 @@ methods: fullName: onActionError(error) summary: Error handler for Adaptive Card Actions. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -189,7 +189,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -210,7 +210,7 @@ methods: [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml index 1ee3299a..5bf41796 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: CardSize summary: Size of the Card view. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type CardSize = 'Medium' | 'Large'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml index aa5bac54..2f43e2bf 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml @@ -7,7 +7,7 @@ summary: >- `WebView` indicates the Adaptive Card Extension is rendering through a web browser equivalent. `Mobile` indicates the Adaptive Card Extension is rendering natively on a mobile platform. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml index a8ccd0ac..0392e926 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml @@ -11,7 +11,7 @@ remarks: >- Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml index bee80041..5c4044e6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IActionError summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: |- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml index 03bdcaf6..ff94f913 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml @@ -12,7 +12,7 @@ remarks: >- routed to the [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) handler. -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml index 67bd2069..38ea8f56 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -7,7 +7,7 @@ summary: >- This structure is used to define metadata for Adaptive Card Extension properties as a map of string to `IAdaptiveCardExtensionPropertiesMetadata` remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index 88bf5c21..cffa820c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAdaptiveCardExtensionPropertyMetadata summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml index 6be15035..ac2835cd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAttachmentError summary: This object represents error associated with a single attachment remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: errorCode summary: Error code associated with a particular attachment remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml index 143a9b10..c29bbb17 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -10,7 +10,7 @@ summary: >- remarks: >- Only `Submit` and `ShowCard` actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. -example: [] + isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml index b1f8beaa..2baf78f6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an Adaptive Card OnActionError is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: error summary: The error thrown by the action remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: type summary: The type of Adaptive Card Action thsat caused the error. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml index df28b94e..efa7a0de 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IBaseCardParameters summary: The primitive data parameters for every Card view. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: iconAltText summary: The icon alt text. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconProperty summary: The icon to display. remarks: The value is a URL to an icon. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: The title to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index e1a132c1..4101e4a6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml index f0c24e98..c475afc2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICachedLoadParameters summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: cardNavigatorState summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: state summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml index 4df2f958..16c9c33e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICacheSettings summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Returns the Card View used to generate the cached card. By default, the currently rendered Card View will be used to cache the card. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: expiryTimeInSeconds summary: 'Expiry time in seconds. Default: 86400 seconds (24 hours)' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: isEnabled summary: 'Whether cache is enabled. Default: true' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml index 9748d1ca..e8ce3619 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardAction summary: Type of handler for when a button is pressed. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 2d8d904a..290ef9fd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardButton summary: A button to display on a Card View. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: action summary: The type of the button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: id summary: Unique Id of the button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: style summary: Controls the style of the button. remarks: The destructive Action style is not supported in Card views - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: title summary: Text displayed on the button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml index 7f5a449c..78ad9a11 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IConfirmationDialog summary: Confirmation Dialog option that is passed through `Submit` Action is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: message summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: title summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index ddfb6f81..e7f5e217 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkCardAction summary: Open an external link. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the external link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is an external link button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml index e238f58a..1f477abc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkParameters summary: Parameters for opening an external link. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: isTeamsDeepLink summary: Indicates whether this is a Teams Deep Link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: target summary: The URL of the link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index da5ead5e..24a233ec 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationAction summary: Interface for Viva Get Location action remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 11f08291..54795285 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get location Action is executed. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: location summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index b26e3b57..bed10651 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationActionParameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: chooseLocationOnMap summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index a2bf7f3d..38f28644 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationCardAction summary: Invoke an `VivaAction.GetLocation` event. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index 66c89e57..3a804782 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: imageUrl summary: The image URL to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index 0d3fe670..797238f4 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocation summary: Interface for location coordinates remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: accuracy summary: Accuracy of the location. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: latitude summary: Latitude of the location. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: longitude summary: Longitude of the location. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: timestamp summary: Timestamp remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml index 8a87e77e..36ea9b96 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocationErrorArguments summary: This object represents the error data that the Location action can throw. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: error summary: Error codes specific to the Get Location Error remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml index 8b1957b2..328c40f1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: description summary: The description to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index b024b3f8..f072dbe3 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewCardAction summary: Open the quick view. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the quick view opened by this action remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this action opens the quick view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml index 0b4a1ba2..43b12c49 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewParameters summary: Parameters for opening a Quick view. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: view summary: The view of the Quick view to open. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index 73c146ad..da34ac07 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAction summary: Interface for new Viva Select Media action remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be provided to the ISelectMedia Action remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index 185353cb..ef82a403 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `SelectMedia` Action is executed. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: data summary: Submit Action data that is passed to internal action handler to ensure forms do not clear. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml index 61f576e1..a7147d51 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionErrorArguments summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: error summary: Error codes specific to the Select Media Action. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml index 758f97ce..cc40544d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionParameters summary: Parameters that can be supplied with the Viva Select Media Action. remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: allowMultipleCapture summary: Allow multiple images to be selected. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: maxSizePerFile summary: Max file size that can be uploaded. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: mediaType summary: Specify the specific media type that should be selected remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: supportedFileFormats summary: File formats supported for upload. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index a9d3b142..3a9072c6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAttachment summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: content summary: Content of the file represented as base64Strings remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: error summary: Error associated with attachment remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: fileName summary: The names of the selected files. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 52e0778d..8760d915 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaCardAction summary: Invoke an `VivaAction.SelectMedia` event. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the Select Media Action remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Media button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index 35272400..750f2b26 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` Action is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index 128ddaf2..a291b0a0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationAction summary: Interface for Viva Show Location action remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index ef68fc7f..1ee051a8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationActionParameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: locationCoordinates summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 5cd24b7d..62f7eb94 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationCardAction summary: Invoke an `VivaAction.ShowLocation` event. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index d0096adb..15e06000 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISPFxAdaptiveCard summary: SPFx Adaptive Card Extension schema for Adaptive Cards. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: actions summary: Types of actions being exposed remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index 2c6b58f9..bf9691a0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` Action is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: data summary: The data object defined in the Adaptive Card template remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index 70c67960..c8fa935d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardAction summary: Invoke an `Action.Submit` event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: confirmationDialog summary: Confirmation dialog option passed to the submit handler. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: parameters summary: Parameters passed to the Submit event handler. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: type summary: Indicates this is a Submit button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml index 3c9c622a..7ee1c485 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardParameters summary: Parameters for submit card action. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml index 8b1a7ec5..398a8974 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: MediaType summary: Enum value to specify the type of media. remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index 672f6c29..d1853e83 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -10,7 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `QuickViewNavigator` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ methods: fullName: close() summary: Closes the View. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml index 46193b1d..6d5e51fa 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: RenderType summary: '`Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type RenderType = 'Card' | 'QuickView'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index ff4fd497..7738b592 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ViewNavigator summary: Manages a stack of views. remarks: The top of the stack represents the currently rendered view. -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' summary: Constructs a new instance of the `ViewNavigator` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: currentId summary: Get the id of the currently rendered View from the top of the View stack remarks: 'If the stack is empty, this will return undefined' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: size summary: Current size of the View stack. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ methods: fullName: 'register(id, initializer)' summary: Registers a new view. remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' - example: [] + isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 3b12e5c0..8c314cb6 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -14,7 +14,7 @@ remarks: >- The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications. -example: [] + isPreview: false isDeprecated: false type: class @@ -31,7 +31,7 @@ constructors: context, for example [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ events: remarks: >- This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has navigated to a new page. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 42efb081..beeddf8e 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: application summary: Provides access to the client-side application that is currently running. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: fullName: dispose() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index da70bb21..d86e6f84 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -12,7 +12,7 @@ remarks: >- Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. -example: [] + isPreview: false isDeprecated: false type: class @@ -23,7 +23,7 @@ properties: fullName: context summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ methods: remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the method. - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index 2222f824..0af8fb9d 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -8,7 +8,7 @@ summary: >- [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) method. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 83af8427..f79b33e8 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderContent` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: If the caller needs to be notified when the DOM element is disposed, use the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback. - example: [] + isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: fullName: isDisposed summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: fullName: name summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: application when the containing placeholder is disposed. Calling dispose() invokes the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index e4bf15c7..1a858e28 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- For more information about placeholders, see [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index cd43c1ad..f69809bd 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -23,7 +23,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderProvider` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ properties: fullName: isDisposed summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: fullName: placeholderNames summary: Returns the names of the currently available placeholders. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ methods: fullName: dispose() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ methods: The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ events: The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 32490a06..6fa0a6a4 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -7,7 +7,7 @@ summary: The base class for client-side components such as BaseClientSideWebPart remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponent` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: isDisposed summary: Returns true if the component has been already disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: fullName: manifest summary: Provides access to the manifest for the client-side component. virtual remarks: Child classes can override this with more specialized manifest types. - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 70d9865c..31aa9387 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponentContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -23,7 +23,7 @@ properties: fullName: aadHttpClientFactory summary: The instance of AadHttpClientFactory created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: fullName: aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: fullName: dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: fullName: dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -75,7 +75,7 @@ properties: fullName: httpClient summary: The instance of HttpClient created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ properties: fullName: isDisposed summary: Returns true if the context is disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: fullName: isServedFromLocalhost summary: Returns true if the solution is being served from localhost remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ properties: fullName: msGraphClientFactory summary: The instance of MSGraphClientFactory created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -158,7 +158,7 @@ properties: The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -171,7 +171,7 @@ properties: fullName: serviceScope summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. - example: [] + isPreview: false isDeprecated: false syntax: @@ -184,7 +184,7 @@ properties: fullName: spHttpClient summary: The instance of SpHttpClient created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: fullName: dispose() summary: Disposes the base component context. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index d2a74da9..177d049e 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -7,7 +7,7 @@ summary: >- The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: isDisposed summary: Returns true if the Dynamic Data Provider is disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: dispose() summary: Disposes the Dynamic Data Provider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ methods: fullName: getAvailableSources() summary: Returns a list with all available Dynamic Data Sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: registerAvailableSourcesChanged(callback) summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -78,7 +78,7 @@ methods: fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' summary: Registers a callback for updates when a property is changed in a Dynamic Data source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ methods: Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -125,7 +125,7 @@ methods: fullName: tryGetSource(id) summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ methods: fullName: unregisterAvailableSourcesChanged(callback) summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -161,7 +161,7 @@ methods: fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -185,7 +185,7 @@ methods: fullName: 'unregisterSourceChanged(sourceId, callback)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index fda94fd6..a93e86d9 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -8,7 +8,7 @@ summary: >- of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ properties: fullName: isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: fullName: dispose() summary: Disposes the resources held by the Dynamic Data source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ methods: fullName: initializeSource(callableFunctions) summary: Initializes the Dynamic Data Source for the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ methods: Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 7333568c..bde0034a 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -8,7 +8,7 @@ remarks: >- This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: '(constructor)(provider, callback)' summary: Create a new DynamicProperty object. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ methods: fullName: hasDefaultCallback() summary: Returns true if the object has a default callback. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -97,7 +97,7 @@ methods: fullName: register(callback) summary: Registers a callback function for updates on the associated DynamicDataSource. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -115,7 +115,7 @@ methods: fullName: removeDefaultCallback() summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. - example: [] + isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ methods: Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: fullName: setValue(value) summary: Sets a static value in the DynamicProperty. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ methods: Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ methods: NOTE: This api will never return an array. To retrieve an array value, use the [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. - example: [] + isPreview: false isDeprecated: false syntax: @@ -210,7 +210,7 @@ methods: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. - example: [] + isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ methods: Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml index cdec3d93..12adbb24 100644 --- a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IComponentPropertyMetadata summary: This is the structure used for map values for component properties metadata. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -35,7 +35,7 @@ properties: Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 42894413..32fe6003 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyFontStyles summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml index f43a9e83..3ba7fbeb 100644 --- a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml +++ b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyRawStyle summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type IReadonlyRawStyle = Readonly; diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 82d6865d..12ae0647 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyTheme summary: Immutable ITheme. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml index fe67d541..3ce83b32 100644 --- a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ISerializedServerProcessedData summary: Contains collections of data that can be processed by server side services like search index and link fixup remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: 'myImage2': 'https://res.contoso.com/someName.jpg' } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: 'myFileLink': 'https://res.contoso.com/file.docx' } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: } ``` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index e6ebbf1c..a1b25c49 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ITheme summary: 'Collection of theme values, which can be used to programatically style components.' remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index f492c2e0..d8906823 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ThemeChangedEventArgs summary: The object passed when the IThemeProvider.themeChangedEvent is raised. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: theme summary: 'The new theme. If the value is undefined, then the theme was cleared.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index e4b2dccf..a54d1ec1 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -7,7 +7,7 @@ summary: >- The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: '(constructor)(serviceScope, theme)' summary: Construct a new instance of the ThemeProvider class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: serviceKey summary: The service key for ThemeProvider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ methods: fullName: tryGetTheme() summary: 'If set, get the current scoped theme.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ events: fullName: themeChangedEvent summary: Raised when the theme changes with the new theme as an argument. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 4a3bdea5..3f2446ae 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: DisplayMode summary: Indicates whether a visual control should display itself for reading or for editing. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index 5f63daa7..eecbb771 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Environment summary: Information about the system environment where the SharePoint Framework is running. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: type summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index d0c0f3e9..2ea474b2 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -7,7 +7,7 @@ summary: Indicates the general type of environment where the SharePoint Framewor remarks: >- This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It provides a way to distinguish environments where certain functionality may be limited or disabled. -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/formdisplaymode.yml b/SP-Framework/sp-core-library/formdisplaymode.yml index 2c0be707..13f288c4 100644 --- a/SP-Framework/sp-core-library/formdisplaymode.yml +++ b/SP-Framework/sp-core-library/formdisplaymode.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: FormDisplayMode summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index a6d81f68..6a93ba06 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -11,7 +11,7 @@ remarks: >- See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: empty summary: Returns a new empty Guid instance. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: fullName: equals(guid) summary: Compare this instance to another Guid instance remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -121,7 +121,7 @@ methods: fullName: toString() summary: Returns a string representation of the GUID remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index d9ccbd42..21e9582c 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IDisposable summary: Implemented by an object that supports a disposal lifecycle. remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 93916995..c762740e 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -12,7 +12,7 @@ remarks: >- default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable. -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index d0f81a16..fbf6d5c9 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IServiceCollection summary: A shorthand pattern for extracting well-known services from a ServiceScope. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -19,7 +19,7 @@ properties: fullName: serviceScope summary: Returns the underlying ServiceScope that the members belong to. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 465c9b32..78371800 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -11,7 +11,7 @@ remarks: >- SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements. -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: fullName: componentId summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: instanceId summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 2f0f6c0d..2d699790 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -9,7 +9,7 @@ remarks: >- [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index a08a630d..0a0b5371 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -8,7 +8,7 @@ remarks: >- The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ methods: fullName: 'error(source, error, scope)' summary: Logs an error. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: fullName: 'info(source, message, scope)' summary: Logs a general informational message. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -75,7 +75,7 @@ methods: fullName: 'verbose(source, message, scope)' summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ methods: fullName: 'warn(source, message, scope)' summary: Logs a warning. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index f11546a5..5cb2553b 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -8,7 +8,7 @@ summary: >- [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls Math.random(). remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `RandomNumberGenerator` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: serviceKey summary: The service key for IRandomNumberGenerator. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicecreator.yml b/SP-Framework/sp-core-library/servicecreator.yml index e81ec9e9..44bd57c6 100644 --- a/SP-Framework/sp-core-library/servicecreator.yml +++ b/SP-Framework/sp-core-library/servicecreator.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: ServiceCreator summary: This is a callback that is used by ServiceKey.createCustom(). remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 409b6de2..11f6e3e3 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -11,7 +11,7 @@ remarks: >- root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: defaultCreator summary: A callback function that constructs the default instance of this service. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes. - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: The system does not assume that this string is unique. Instead, the [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ methods: remarks: >- If you want to specify custom constructor parameters, use [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ methods: fullName: 'createCustom(name, defaultCreator)' summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 09fa004d..7727ee51 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -43,7 +43,7 @@ remarks: >- worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished(). -example: [] + isPreview: false isDeprecated: false type: class @@ -54,7 +54,7 @@ constructors: fullName: (constructor)(parent) summary: Constructs a new instance of the `ServiceScope` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ methods: Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ methods: This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ methods: fullName: getParent() summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -179,7 +179,7 @@ methods: remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. - example: [] + isPreview: false isDeprecated: false syntax: @@ -202,7 +202,7 @@ methods: remarks: >- The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. - example: [] + isPreview: false isDeprecated: false syntax: @@ -218,7 +218,7 @@ methods: Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ methods: NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 284ab208..56ed22f2 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Session summary: Provides access to the application's browser session and active page. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions. - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: clientSideApplicationId summary: The id of the currently running application remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: The concept of a page is subjective and defined by the router for a particular application. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index d7aa82d2..5ee2fa6c 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -22,7 +22,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPEvent` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -36,7 +36,7 @@ methods: The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: 'remove(observer, eventHandler)' summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 0c0d6c54..2068956c 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: SPEventArgs summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' -example: [] + isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 2eaf1dee..43d8decd 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Text_2 summary: Operations for working with strings that contain text. remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' -example: [] + isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ methods: `Text.format("hello {0}!", "world")` will return `"hello world!"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ methods: fullName: 'replaceAll(input, searchValue, replaceValue)' summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 6dd98724..3ad72aa4 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -7,7 +7,7 @@ summary: >- This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that simply calls the real browser APIs. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `TimeProvider` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: serviceKey summary: The service key for ITimeProvider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 76e091aa..84dd8eda 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -16,7 +16,7 @@ remarks: >- Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. @@ -28,7 +28,7 @@ constructors: fullName: (constructor)(url) summary: Constructs a new instance of the `UrlQueryParameterCollection` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: getValue('debug') ---> 'false' getValue('lost') ---> undefined ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -84,7 +84,7 @@ methods: getValues('debug') ---> ['false'] getValues('lost') ---> undefined ``` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 643ac440..39cf943f 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -8,7 +8,7 @@ remarks: >- This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ methods: fullName: 'isNonemptyString(value, variableName)' summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ methods: fullName: 'isNotDisposed(value, className)' summary: Throws an exception if the specified object has been disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ methods: fullName: 'isNotNullOrUndefined(value, variableName)' summary: Throws an exception if the specified value is null or undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ methods: fullName: 'isTrue(value, variableName)' summary: Throws an exception if the specified value is not true. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 54955dc2..905d760b 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -11,7 +11,7 @@ remarks: >- Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: major summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases. - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: remarks: >- Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the "build" number. - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: remarks: >- This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers. - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ methods: fullName: 'compare(v1, v2)' summary: Compares two Version objects to determine which version is newer. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -137,7 +137,7 @@ methods: 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -155,7 +155,7 @@ methods: fullName: isValid(versionString) summary: Test whether a string is a valid version specifier. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -181,7 +181,7 @@ methods: 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -199,7 +199,7 @@ methods: fullName: parse(versionString) summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -237,7 +237,7 @@ methods: 1.0.0 satisfies 1.1.0 -> false ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -257,7 +257,7 @@ methods: remarks: >- The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged. - example: [] + isPreview: false isDeprecated: false syntax: @@ -273,7 +273,7 @@ methods: Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index e5897c2c..f8dfcc71 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -12,7 +12,7 @@ remarks: >- controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -47,7 +47,7 @@ constructors: // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: remarks: >- See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on rendering. - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ properties: remarks: >- This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -95,7 +95,7 @@ properties: If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: fullName: isSecondary summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - example: [] + isPreview: false isDeprecated: false syntax: @@ -142,7 +142,7 @@ methods: remarks: >- This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - example: [] + isPreview: false isDeprecated: false syntax: @@ -160,7 +160,7 @@ methods: the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - example: [] + isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ methods: This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. virtual remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. - example: [] + isPreview: false isDeprecated: false syntax: @@ -203,7 +203,7 @@ methods: you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. - example: [] + isPreview: false isDeprecated: false syntax: @@ -217,7 +217,7 @@ methods: fullName: show(options) summary: Request the framework to show this dialog. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index a9ca2e75..037b859a 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: Dialog summary: A static class for showing stock dialogs such as an alert or prompt. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index a714c2a7..f0776d09 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IAlertOptions summary: Options for showing an alert dialog remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 1a4913ce..506c535c 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogConfiguration summary: The interface for dialog configuration remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: isBlocking summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 60ebd707..c457dc9b 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogShowOptions summary: Options for showing a dialog remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 8fad9614..db80e8c2 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IPromptOptions summary: Options for showing a prompt dialog remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: defaultValue summary: The default value for the input text field of prompt dialog remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index c5882bd7..44923ea8 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -15,7 +15,7 @@ remarks: >- See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for how to use this. -example: [] + isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ methods: Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ methods: Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ methods: is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index aaa803e4..eb51d395 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -10,7 +10,7 @@ remarks: |- The reference string is of the form `:` or `::` Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(reference) summary: Constructs a new instance of the `DynamicDataReference` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: property summary: Returns the referred property of the Dynamic Data. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: propertyPath summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: reference summary: Returns the full reference of the Dynamic Data object as a string. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: sourceId summary: Returns the referred id of the Dynamic Data Source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index 00df95c9..f81c472a 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -7,7 +7,7 @@ summary: >- Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: sampleValue summary: Sample value of a property remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 82c2f04d..526a4c6d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -7,7 +7,7 @@ summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ methods: If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -39,7 +39,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ methods: fullName: getPropertyDefinitions() summary: Returns all the property definitions that the DataSource will provide. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: getPropertyValue(propertyId) summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index cb99692e..23349ff8 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -8,7 +8,7 @@ summary: |- It includes the name of the event and description to be seen and used by end users. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the event.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: name summary: Event name remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 2f979708..eb901142 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -7,7 +7,7 @@ summary: >- Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index 865b79fc..e6ba2a97 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyMetadata summary: Metadata of a property remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index cec346ee..2baf4fb8 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyValueMetadata summary: Metadata describing the sample value of the property. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index ad72cc5e..9aa2d027 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -74,7 +74,7 @@ remarks: >- } } ``` -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 36f0d714..f345518d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -7,7 +7,7 @@ summary: >- Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: id summary: Id of the Dynamic Data Source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: metadata summary: Metadata of the Dynamic Data Source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ methods: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' @@ -89,7 +89,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' @@ -126,7 +126,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' @@ -165,7 +165,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -188,7 +188,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 046d071c..0db149ad 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataSourceMetadata summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the Dynamic Data Source.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ properties: User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 982619f7..16429f5f 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -7,7 +7,7 @@ summary: The base class for all client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseExtension` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization. - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ methods: fullName: onInit() summary: This event method is called when the client-side extension is first activated on the page. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index be76c4b0..b2819763 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -7,7 +7,7 @@ summary: The base class for context objects for client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtensionContext` class. -example: [] + isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 642b915d..6e71a276 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -10,7 +10,7 @@ remarks: >- For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: '(constructor)(serviceScope, resourceEndpoint, options)' summary: Constructs a new instance of the `AadHttpClient` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: fullName: configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - example: [] + isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 3a830c3f..0217cb90 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 4e2199ce..6b60d00f 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadHttpClientFactory` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: serviceKey summary: The service key for AadHttpClientFactory. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml index 9ec22382..997a3597 100644 --- a/SP-Framework/sp-http/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -7,7 +7,7 @@ summary: >- The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends HttpClientResponse adding additional functionality specific to the AadHttpClient. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: '(constructor)(response, tokenFetchRequestTime)' summary: Constructs a new instance of the `AadHttpClientResponse` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 7cb10f04..7f2be121 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -15,7 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadTokenProvider` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -29,7 +29,7 @@ methods: The OAuth2 token should not be cached by the caller since it is already cached by the method itself. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquisition requires user action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 17c2b48c..82e5a24b 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: AadTokenProviderFactory summary: Returns a preinitialized version of the AadTokenProviderFactory. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: serviceKey summary: The service key for AadTokenProviderFactory. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml index e24f3a38..0ba7695c 100644 --- a/SP-Framework/sp-http/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: BeforeRedirectEventArgs summary: Arguments for before redirecting for a full page authentication remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(redirectUrl, cancel)' summary: Constructs a new instance of the `BeforeRedirectEventArgs` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index e164b71a..43ac3d4e 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -13,7 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `DigestCache` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: fullName: serviceKey summary: The service key for IDigestCache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -125,7 +125,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 0799d982..78ca70c2 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -7,7 +7,7 @@ summary: >- Typings for the GraphRequest Object For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: _headers summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: _responseType summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: config summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: urlComponents summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ methods: fullName: buildFullUrl() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ methods: fullName: 'constructor(config, path)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: fullName: count(count) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ methods: fullName: 'create(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -151,7 +151,7 @@ methods: fullName: del(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ methods: fullName: delete(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -187,7 +187,7 @@ methods: fullName: expand(properties) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -205,7 +205,7 @@ methods: fullName: filter(filterStr) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ methods: fullName: get(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -241,7 +241,7 @@ methods: fullName: getStream(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -259,7 +259,7 @@ methods: fullName: 'header(headerKey, headerValue)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -280,7 +280,7 @@ methods: fullName: headers(headers) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -304,7 +304,7 @@ methods: fullName: orderby(properties) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -322,7 +322,7 @@ methods: fullName: parsePath(rawPath) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ methods: fullName: 'patch(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -361,7 +361,7 @@ methods: fullName: 'post(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -382,7 +382,7 @@ methods: fullName: 'put(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -403,7 +403,7 @@ methods: fullName: 'putStream(stream, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -424,7 +424,7 @@ methods: fullName: query(queryDictionaryOrString) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -448,7 +448,7 @@ methods: fullName: responseType(responseType) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -466,7 +466,7 @@ methods: fullName: select(properties) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -484,7 +484,7 @@ methods: fullName: skip(n) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -502,7 +502,7 @@ methods: fullName: skipToken(token) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -520,7 +520,7 @@ methods: fullName: top(n) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -538,7 +538,7 @@ methods: fullName: 'update(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -559,7 +559,7 @@ methods: fullName: version(v) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 4953c421..b8694933 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: HttpClient summary: HttpClient implements a basic set of features for performing REST operations against a generic service. remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `HttpClient` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: configurations summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: serviceKey summary: The service key for HttpClient. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -128,7 +128,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index 0614c245..a8d61ac7 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: initializeFlags() summary: Child classes should override this method to initialize the flags object. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index ef686d3b..c49dd71f 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -10,7 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HttpClientResponse` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: fullName: bodyUsed summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: headers summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: fullName: nativeResponse summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: fullName: ok summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: fullName: status summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -86,7 +86,7 @@ properties: fullName: statusText summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -99,7 +99,7 @@ properties: fullName: type summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ properties: fullName: url summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ methods: fullName: arrayBuffer() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ methods: fullName: blob() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -154,7 +154,7 @@ methods: fullName: clone() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -170,7 +170,7 @@ methods: fullName: formData() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -184,7 +184,7 @@ methods: fullName: json() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: fullName: text() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index d1e6bc9a..6b613b33 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 48152dba..559c95b4 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index 65a00c23..0282510f 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientOptions summary: Interface for overriding the default behavior of AadHttpClient. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: configuration summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' @@ -30,7 +30,7 @@ properties: fullName: tokenProvider summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' @@ -44,7 +44,7 @@ properties: fullName: useCachedToken summary: Allows the developer to specify if cached tokens should be use for the current request. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 79ee9cf5..0eefea69 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -13,7 +13,7 @@ remarks: >- AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL. -example: [] + isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ methods: An example of a resourceEndpoint would be https://sdfpilot.outlook.com remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquistion requires user action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index 66c7042a..02ebbf22 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadTokenProviderConfiguration summary: Required strings for constructing an AadTokenProvider. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: aadInstanceUrl summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: aadSessionId summary: The current Azure Active Directory's session id. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: aadTenantId summary: The Azure Active Directory's tenant id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: servicePrincipalId summary: The client ID of the developer's Azure Active Directory application. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead @@ -117,7 +117,7 @@ properties: tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml index 7918d5bd..f71a0693 100644 --- a/SP-Framework/sp-http/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IBeforeRedirectEventArgs summary: Represents arguments used before redirecting event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 43b68a33..6b93c457 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -13,7 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index 4071f3b9..c47153d4 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 77f7e2b3..f0134853 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index d5f7ca63..806932f9 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -7,7 +7,7 @@ summary: Options for HttpClient remarks: >- This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 8a3c049d..682b36c3 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchConfiguration summary: Flags interface for SPHttpClientBatchConfiguration. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 13073937..cd02fa14 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: true isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: fullName: v1 summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index b12fd531..2c4eeeec 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchCreationOptions summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 4e39f93b..d2ac62c7 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -7,7 +7,7 @@ summary: >- This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index f9f21f72..07fb8754 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientCommonConfiguration summary: Flags interface for SPHttpClientCommonConfiguration remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 47c0f89d..c6029b69 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientConfiguration summary: Flags interface for SPHttpClientConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - example: [] + isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 0d21272d..3f373dd9 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: false isDeprecated: false type: interface @@ -25,7 +25,7 @@ properties: consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 2a35790a..93b34554 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -7,7 +7,7 @@ summary: >- This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index 8b22569d..ca0939ca 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ITokenAcquisitionEventArgs summary: Represents arguments used for raising a token acquisiton failure event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to interact with Azure AD. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 4c017214..5fa26570 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -17,7 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClient` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index fda63f07..6e028471 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientFactory` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: serviceKey summary: The service key for MSGraphClientFactory. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. Returns version 1 by default. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: 'Use getClient(''1'') instead, which has the same implementation but specifies the version explicitly.' @@ -56,7 +56,7 @@ methods: Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: Returns an instance of version 3 the MSGraphClient V3 that communicates with the current tenant's configurable Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientv3.yml b/SP-Framework/sp-http/msgraphclientv3.yml index 335e71f8..b496ed36 100644 --- a/SP-Framework/sp-http/msgraphclientv3.yml +++ b/SP-Framework/sp-http/msgraphclientv3.yml @@ -17,7 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientV3` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 4a96308d..bf4b584b 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ODataVersion summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: v3 summary: Represents version 3.0 for the "OData-Version" header remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: v4 summary: Represents version 4.0 for the "OData-Version" header remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ methods: fullName: toString() summary: 'Returns the "OData-Version" value, for example "4.0".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ methods: remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index ab624ee7..44f274cd 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -10,7 +10,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `SPHttpClient` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: serviceKey summary: The service key for SPHttpClient. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ methods: fullName: '_fetch(url, configuration, options)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ methods: fullName: beginBatch(batchCreationOptions) summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -133,7 +133,7 @@ methods: obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -165,7 +165,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ methods: If the URL cannot be determined, an exception is thrown. - example: [] + isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 8d784750..0ca41b92 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -15,7 +15,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPHttpClientBatch` class. -example: [] + isPreview: true isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -40,7 +40,7 @@ methods: fullName: execute() summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ methods: SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly. - example: [] + isPreview: true isDeprecated: false syntax: @@ -102,7 +102,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''GET''.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -134,7 +134,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''POST''.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 90a5793b..9a05ba91 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method. -example: [] + isPreview: true isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 35f29ea3..9656a10a 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpClientCommonConfiguration summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - example: [] + isPreview: false isDeprecated: false syntax: @@ -95,7 +95,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 4c28af0b..f8d01b40 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -114,7 +114,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index ce02fd35..8f41cee5 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(response) summary: Constructs a new instance of the `SPHttpClientResponse` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header. - example: [] + isPreview: true isDeprecated: false syntax: @@ -52,7 +52,7 @@ methods: fullName: clone() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index f190da95..94b346d7 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpHeader summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index d9aeafb8..04f4ed44 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: TokenAcquisitionEventArgs summary: Arguments for a token acquisition failure event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(message, redirectUrl)' summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to perform Multi Factor Authentication remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 7a205135..16d864be 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: IImageHelperRequest summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint. - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: sourceUrl summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: width summary: Width of the image requested. remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 034e548f..3b69fa35 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: ImageHelper summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ methods: - The url will be most performant if only a width is provided. If a height is provided, the image will take longer to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 90c50b96..0a25ab34 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -12,7 +12,7 @@ summary: >- In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and the current domain, site and web will be used. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: fullName: callbacks summary: the list of callbacks remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: fullName: domain summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: fullName: listId summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current site will be used. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web will be used. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index 517074d1..fd55ce35 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: IListSubscription summary: A subscription to a SharePoint list resource. Contains the id of the subscription. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: The id of the subscription. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index 54eecff9..cc1390b0 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: ISubscriptionCallbacks summary: The callbacks that can be triggered by a subscription event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: connect summary: The callback to invoke when a connection has been made to the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disconnect summary: The callback to invoke when the subscription is disconnected from the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: notification summary: The callback to invoke when a change occurs in the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index 712117d4..abee5bb4 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -7,7 +7,7 @@ summary: >- Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the subscription to handle subscription events. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: (constructor)(component) summary: Constructs a new instance of the `ListSubscriptionFactory` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: fullName: createSubscription(settings) summary: Creates a connection to the list specified by the site id and list id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ methods: fullName: deleteSubscription(subscription) summary: Deletes the subscription's connection to the resource. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 22784ff8..73e9f567 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -10,7 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "FieldCustomizer". remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: fullName: onDisposeCell(event) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: fullName: onRenderCell(event) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml index bb7df5eb..53d57dce 100644 --- a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -7,7 +7,7 @@ summary: >- This is the base class that third parties should extend when implementing a client-side extension that provides a custom list form (display, new, edit) for a SharePoint list. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: displayMode summary: 'Display mode of the form: Edit, Display or New.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole DOM subtree of the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ methods: fullName: dispose() summary: Disposes the component. remarks: 'Please, do not override this method. Override the `onDispose` method instead.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ methods: fullName: formClosed() summary: Call this method after the form has been closed/cancelled to inform the application that the form has been closed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ methods: fullName: formSaved() summary: Call this method after the form has been saved to inform the application that the form has been saved. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ methods: This API is called to render the form. There is no base implementation of this API and the form is required to override this API. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 0807a241..16dbae19 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseListViewCommandSet` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ methods: This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: onListViewUpdated(event) summary: This event occurs whenever the ListView state changes. virtual remarks: This event allows the implementor to tailor the visibility of the command. - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: Use context.listView.listViewStateChangedEvent instead. @@ -79,7 +79,7 @@ methods: fullName: raiseOnChange() summary: Use this method to fire OnChange event and initialize a reflow of the ListView. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: fullName: tryGetCommand(id) summary: Returns the command with the given id. Returns undefined if there is not command with the given id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 6d3d387d..d1be986f 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -14,7 +14,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ColumnAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: fullName: field summary: The server-side definition of the field. This property is read-only. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: fullName: visible summary: Whether to show this column in the list view. This property is read-only. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 8722ad8a..03b18054 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -11,7 +11,7 @@ remarks: >- [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command's appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. -example: [] + isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: disabled summary: Whether the command is currently disabled. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: id summary: Id of the command. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension. - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: visible summary: True if the command is visible. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index f2d89b85..990d6cae 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -7,7 +7,7 @@ summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FieldCustomizerContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: field summary: Provides access to the SharePoint field that the customizer will operate on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: remarks: >- Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml index 0238dd0f..9ffe940d 100644 --- a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: FormCustomizerContext summary: Form Customizer Context. This object contains contxtual services and properties for the form. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' summary: Constructs a new instance of the `FormCustomizerContext` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: contentType summary: The content type associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: domElement summary: The root DOM element of the form. This is a DIV element container for the custom form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: folderInfo summary: The folder information where the item is located/should be created. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: itemId summary: The item id of the item being edited or viewed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: list summary: The list associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml index 7796fa74..787a6227 100644 --- a/SP-Framework/sp-listview-extensibility/icolumn.yml +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IColumn summary: Provides information about the state of a column in the list view remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: isVisible summary: Whether the column is visible in the view remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icontenttype.yml b/SP-Framework/sp-listview-extensibility/icontenttype.yml index 7331bf81..3dc6a33e 100644 --- a/SP-Framework/sp-listview-extensibility/icontenttype.yml +++ b/SP-Framework/sp-listview-extensibility/icontenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IContentType summary: Provides information about the content type remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: Content type string id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: name summary: Content type name remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: schemaXml summary: Content type schema XML remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 2a0262c1..1eb002d9 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFieldCustomizerCellEventParameters summary: Event parameters for BaseFieldCustomizer.onRenderCell() remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: fieldValue summary: The value of the field being rendered. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: listItem summary: The list item being edited. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml index 16c0b7f3..2740cd14 100644 --- a/SP-Framework/sp-listview-extensibility/ifilter.yml +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFilter summary: Provides information about the state of the filters applied to the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: fieldName summary: Field name to filter on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: values summary: Values to filter on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml index 0418a3f3..39ec33a1 100644 --- a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFolderInfo summary: Provides information about the state of the folder in the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: folderPath summary: Folder path. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml index 88deb6bd..2aaceb35 100644 --- a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFormCustomizerContext summary: FormCustomizerContext-specific properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: contentType summary: The content type associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: domElement summary: The root DOM element of the form. This is a DIV element container for the custom form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: folderInfo summary: The folder information where the item is located/should be created. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: itemId summary: The item id of the item being edited or viewed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: list summary: The list associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml index 6b76e9d6..2bdb14be 100644 --- a/SP-Framework/sp-listview-extensibility/ilist.yml +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IList summary: Provides information about the list rendered by the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: guid summary: List id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: serverRelativeUrl summary: List server relative url. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: List title. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml index e3abce4c..27199457 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IListViewAccessorState summary: Provides information about the state of the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: appliedFilters summary: Applied filters information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: columns summary: Columns information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: folderInfo summary: Current folder information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: fullName: list summary: List information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: rows summary: Rows information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: selectedRows summary: Selected rows information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: sortAscending summary: Sort direction. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: sortField summary: Sort field name. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: view summary: View information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index 08711f5d..d4e72488 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -7,7 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 1ef89678..7ddfaee6 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -7,7 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml index 292be738..2ef0cf5f 100644 --- a/SP-Framework/sp-listview-extensibility/irow.yml +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IRow summary: Provides information about the list item's state rendered by the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: A map of column values for the row. They key is the column internal name and the value is its corresponding value in the row. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml index 52cc3cf2..76fc06f1 100644 --- a/SP-Framework/sp-listview-extensibility/iview.yml +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IView summary: Provides information about the view rendered by the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: View id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: title summary: View title. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: url summary: View server relative url. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 6474d853..f60ab4d0 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -18,7 +18,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListItemAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -32,7 +32,7 @@ properties: The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type. - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ methods: Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 82db4243..2b2f2241 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -7,7 +7,7 @@ summary: Provides access to a SharePoint ListView control. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: appliedFilters summary: Filters applied to the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: columns summary: 'The columns in associated with this view, including hidden columns.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: folderInfo summary: Folder information for the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: list summary: Basic information about the list rendered by the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: rows summary: Currently rendered rows in the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: selectedRows summary: Selected rows in the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -102,7 +102,7 @@ properties: fullName: sortAscending summary: Specifies whether the list view is sorted ascending or descending. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -115,7 +115,7 @@ properties: fullName: sortField summary: Sort field name remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -128,7 +128,7 @@ properties: fullName: view summary: Basic information about the view rendered by the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ methods: Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ events: fullName: listViewStateChangedEvent summary: Event that gets raised every time the list view state changes. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -178,7 +178,7 @@ events: fullName: selectedRowsChangedEvent summary: Event that gets raised every time the selected items in the list view change. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml index bfd43c03..5051434f 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewAccessorStateChanges summary: Describes the type of list view state changes. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index fdbd44da..ab7fcfbe 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -7,7 +7,7 @@ summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewCommandSetContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: listView summary: Provides access to the ListView control that the customizer will operate on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml index 08bf585d..d63dfa05 100644 --- a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewStateChangedEventArgs summary: Arguments for the list view state changed event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: prevState summary: Previous state of the ListView. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: stateChanges summary: Changes that were made to the ListView state. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 8443c4b5..8f09316c 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -15,7 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RowAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index bf56480c..a67de530 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: SelectedRowsChangedEventArgs summary: Arguments for the selected rows changed event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: selectedRows summary: The list of rows that were selected in the list view at the time when the event was fired. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index 72fc2f1b..b514a0e5 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: ILoadScriptOptions summary: Options for the loadScript() method in ISPComponentLoader remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: globalExportsName summary: 'If set, the loaded script will be stored in a global variable under this name.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index 583aec40..a0de13b8 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: SPComponentLoader summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ methods: fullName: getManifests() summary: Returns static copies of all the manifests. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: this method will be removed in a future release. @@ -31,7 +31,7 @@ methods: fullName: loadComponent(manifest) summary: Loads a component from a manifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ methods: fullName: 'loadComponentById(id, version)' summary: 'Resolve a component id and version, and load it.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ methods: fullName: loadCss(url) summary: Inserts a `` tag for a stylesheet. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not be propagated. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-lodash-subset/cancelable.yml b/SP-Framework/sp-lodash-subset/cancelable.yml index f9271d4e..587f3078 100644 --- a/SP-Framework/sp-lodash-subset/cancelable.yml +++ b/SP-Framework/sp-lodash-subset/cancelable.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-lodash-subset!' fullName: Cancelable summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type Cancelable = Cancelable2; diff --git a/SP-Framework/sp-lodash-subset/throttlesettings.yml b/SP-Framework/sp-lodash-subset/throttlesettings.yml index bac184b0..4b3aa96b 100644 --- a/SP-Framework/sp-lodash-subset/throttlesettings.yml +++ b/SP-Framework/sp-lodash-subset/throttlesettings.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-lodash-subset!' fullName: ThrottleSettings summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type ThrottleSettings = ThrottleSettings2; diff --git a/SP-Framework/sp-module-interfaces/componenttype.yml b/SP-Framework/sp-module-interfaces/componenttype.yml index 4d28b44b..e424082d 100644 --- a/SP-Framework/sp-module-interfaces/componenttype.yml +++ b/SP-Framework/sp-module-interfaces/componenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: ComponentType summary: Type of client-side component. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension'; diff --git a/SP-Framework/sp-module-interfaces/extensiontype.yml b/SP-Framework/sp-module-interfaces/extensiontype.yml index 14ff642a..6a9709e1 100644 --- a/SP-Framework/sp-module-interfaces/extensiontype.yml +++ b/SP-Framework/sp-module-interfaces/extensiontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: ExtensionType summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index 0803ef19..9495db4c 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IAdaptiveCardExtensionManifest summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: connectedSPFXAppId summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: connectedTeamsAppId summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: experimentalData summary: An untyped property bag for experimental flags not ready for production. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way. - example: [] + isPreview: true isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: } }] ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: fullName: supportedHosts summary: 'Definition: An array defining what host types are supported' remarks: 'Usage: Use this array to define all hosts that are supported.' - example: [] + isPreview: true isDeprecated: false syntax: @@ -149,7 +149,7 @@ properties: variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no ACEs support theme variants. - example: [] + isPreview: true isDeprecated: false syntax: @@ -170,7 +170,7 @@ properties: By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized logic, then it is recommended to override onAfterPropertiesUpdatedExternally. - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index ebb55270..bacd9f22 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -8,7 +8,7 @@ summary: >- pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes \["Medium", "Large"\] defined in the sp-adaptive-card-base project. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -160,7 +160,7 @@ properties: Example: "graph" - example: [] + isPreview: true isDeprecated: false syntax: @@ -185,7 +185,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -201,7 +201,7 @@ properties: group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - example: [] + isPreview: true isDeprecated: false syntax: @@ -238,7 +238,7 @@ properties: "zh": "我的 web 部件" } ``` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 2c66fcb9..47f1ef75 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideAssemblyManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: Supported values: any GUID Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 3f20b018..1e47ead0 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. It contains all data for loading an entrypoint script and its dependency scripts. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"myApplication.bundle"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Example: `mySpWebpart` - example: [] + isPreview: true isDeprecated: false syntax: @@ -95,7 +95,7 @@ properties: Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` - example: [] + isPreview: true isDeprecated: false syntax: @@ -147,7 +147,7 @@ properties: } } ``` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index acec9040..bdc313ef 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -21,7 +21,7 @@ remarks: >- - The `'manifestVersion'` should be bumped for all small or big changes. -example: [] + isPreview: false isDeprecated: false type: interface @@ -40,7 +40,7 @@ properties: Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, `"AdaptiveCardExtension"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: Usage: Loading a component. See `IClientSideComponentLoaderConfiguration` for more information and examples. - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts build after using spfx 1.1 don't need this. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: Usage: Requires Custom Script to be allowed in order for this component to be installed and run. - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: safeWithCustomScriptDisabled summary: This property is provided for backwards compatibility. It no longer has any effect. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. @@ -165,7 +165,7 @@ properties: Example: `"1.0.0"` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index d4d7999b..26180f8c 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideExtensionManifest summary: This is the manifest for a client-side extension. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index b030c628..ef8494c0 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideLibraryManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index 5990ff09..18cb0af2 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideManifestBase summary: This interface defines members that are common between all deployable manifests. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: Example: `1` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index ad229c00..66580cc8 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -12,7 +12,7 @@ remarks: >- some required properties in the manifest and some optional properties. Optional properties need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and functionality problems. -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: fullName: canUpdateConfiguration summary: Indicates whether the web part uses the property pane to update the configuration of the web part. remarks: Default value is `true` if the property is not explicitly defined. - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: remarks: >- Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If this flag is true, the web part will not appear in the classic page web part gallery. - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts can be provisioned on pages though API or be added to the page in a pre configured way. - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module url - example: [] + isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ properties: } }] ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -134,7 +134,7 @@ properties: SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp cannot be used with TeamsTab or TeamsPersonalTab. - example: [] + isPreview: false isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed experiences require special treatment and testing. By default no web parts support full bleed experiences. - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ properties: variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no web parts support theme variants. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 10fd2d30..f494d54a 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -8,7 +8,7 @@ summary: >- instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -36,7 +36,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' - example: [] + isPreview: true isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -158,7 +158,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -183,7 +183,7 @@ properties: Example: "graph" - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ properties: This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - example: [] + isPreview: true isDeprecated: false syntax: @@ -259,7 +259,7 @@ properties: "zh": "我的 web 部件" } ``` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 54671bd9..27835310 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideWebPartManifestInstance summary: Manifest that is relevant to a Web Part instance. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index b7bfd964..fe94cf0b 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -7,7 +7,7 @@ summary: >- Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: fullName: title summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: type summary: Type of the item. Currently only "command" is allowed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index ec2fb4aa..b2d29568 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -7,7 +7,7 @@ summary: >- This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: remarks: >- The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 588cc149..1b9d4f6b 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This is the interface for a script module with the "component" type. Modules of this type will be provided via manifests. In order for the dependency to be loaded, the manifest must be available on the site. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: Supported values: string representing a component's ID. Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: type summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: Supported values: string representing a [semantic version](http://semver.org), or "latest". Example: `"2.2.4"` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iintegritypath.yml b/SP-Framework/sp-module-interfaces/iintegritypath.yml index 26aa101d..8cc60747 100644 --- a/SP-Framework/sp-module-interfaces/iintegritypath.yml +++ b/SP-Framework/sp-module-interfaces/iintegritypath.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IIntegrityPath summary: A path with the subresource integrity hash of the resource. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: The subresource integrity hash of the resource referenced in [IIntegrityPath.path](xref:@microsoft/sp-module-interfaces!IIntegrityPath%23path:member). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: path summary: The path to the resource. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 2c6ccf86..c43eb21d 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -8,7 +8,7 @@ remarks: >- Modules of this type must be provided by the component developer. These script resources are similar to those of the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as "internal" modules are. -example: [] + isPreview: true isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: fullName: type summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index bd2d777e..e97eb4c8 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -46,7 +46,7 @@ remarks: >- For more complex cases, run an appropriate expression to access your resource and return the string. -example: [] + isPreview: false isDeprecated: false type: interface @@ -57,7 +57,7 @@ properties: fullName: default summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: id summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index 7b077d49..ba7c1e51 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfiguration summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml index 6574d072..2b78f22e 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfigurationBase summary: This is the base interface for a script module's definition. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: Usage: Instructs the module loader to not preload this module. - example: [] + isPreview: true isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: Example: `"localized"` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ipath.yml b/SP-Framework/sp-module-interfaces/ipath.yml index c59252f8..546a6790 100644 --- a/SP-Framework/sp-module-interfaces/ipath.yml +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -7,7 +7,7 @@ summary: >- This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are loaded in exactly the same way as any other internal path. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -26,7 +26,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_18182c39.debug.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index f892b365..24aef5fe 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This is the interface for a script module with the "path" type. Modules of this type must be provided by the component developer. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: Example: `["jquery"]` - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Example: `"$"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -101,7 +101,7 @@ properties: fullName: type summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index c886cd6a..f16746fc 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: PredefinedGroup summary: Predefined web part group. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 982a63f3..52a34924 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: NameId summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: NameIdIssuer summary: 'Example: `"urn:office:idp:activedirectory"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 898f9f8c..064cd12b 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataBasePermission summary: Data used for creating a SPPermission object. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: High summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: Low summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index d1a7818a..6166cb38 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: StringValue summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml index 2b18c53d..2313fd7c 100644 --- a/SP-Framework/sp-odata-types/iodatacontenttype.yml +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataContentType summary: Represents OData SP.ContentType object. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ClientFormCustomFormatter summary: Custom formatter (JSON) for the content type forms remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: Description summary: Content type description remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: DisplayFormUrl summary: Content type display form URL remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: EditFormUrl summary: Content type edit form URL remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: Group summary: Content type group remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: Id summary: Content type ID remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: Name summary: Content type name remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: NewFormUrl summary: Content type new form URL remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: fullName: ReadOnly summary: Specifies whether content type is read-only remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -133,7 +133,7 @@ properties: fullName: SchemaXml summary: Content type schema XML remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ properties: fullName: StringId summary: Content type string id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 1914ab25..1e6e60f5 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: LibraryVersion summary: 'Example: `"16.0.4919.3000"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: SiteFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: SupportedSchemaVersions summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: WebFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml index b328ab33..ad16f5b2 100644 --- a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataFormsClientSideConfiguration summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: DislpayFormClientSideDisplayTarget summary: 'Display Form display target (new tab, panel)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: DisplayFormClientSideComponentId summary: Display Form Customizer component id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: DisplayFormClientSideComponentProperties summary: Display Form Customizer component properties remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: EditFormClientSideComponentId summary: Edit Form Customizer component id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: EditFormClientSideComponentProperties summary: Edit Form Customizer component properties remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: EditFormClientSideDisplayTarget summary: 'Edit Form display target (new tab, panel)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: NewFormClientSideComponentId summary: New Form Customizer component id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: NewFormClientSideComponentProperties summary: New Form Customizer component properties remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: fullName: NewFormClientSideDisplayTarget summary: 'New Form display target (new tab, panel)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 792fd292..d0289260 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: BaseTemplate summary: The list definition type on which the list is based. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Created summary: 'Example: `"/Date(1453294804000)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: CurrentChangeToken summary: The change token that will be used in logging the next change to the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: Description summary: A description of the List. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: EntityTypeName summary: 'Example: `"MyListTitleList"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: Id summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: LastItemDeletedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: fullName: LastItemModifiedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -137,7 +137,7 @@ properties: fullName: ListItemEntityTypeFullName summary: 'Example: `"SP.Data.MyListTitleListItem"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: fullName: ParentWebUrl summary: 'Example: `"/sites/PubSite"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ properties: fullName: TemplateFeatureId summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ properties: fullName: Title summary: 'Example: `"Pages"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 9dc55986..e5fdedfa 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: ContentTypeId summary: 'Example: `{ StringValue: "0x010100C5..." }`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: ID summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: Title summary: Title of the List Item remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: UniqueId summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 7f9fd50d..22b8eccf 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.NavigationNode object. [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: Children summary: Gets or sets an array of Navigation Nodes that are children to the current node. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Id summary: Gets a value that specifies the identifier for the navigation node. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: IsDocLib summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: IsVisible summary: Gets or sets a value that specifies if the node navigation link should be visible. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: Title summary: Gets or sets a value that specifies the anchor text for the node navigation link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index ec5b1d3f..16073e68 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: quickLaunch summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: topNav summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index cde911b1..df984001 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: Email summary: 'Example: `"someone@example.com"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Id summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: IsSiteAdmin summary: Boolean value that specifies whether the user is a site collection administrator. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: LoginName summary: 'Example: `"i:0#.w|domain\user"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: SharePointGroup: 8 All: 15 - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: Title summary: 'Example: `"DOMAIN\user"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index af02f1ab..b6830dd1 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -8,7 +8,7 @@ summary: >- here: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: ClientSideComponentId summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: Example: `"{ \"maxItemsToShow\": 123 }"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: Description summary: Gets or sets the description of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: ImageUrl summary: Gets or sets the URL of the image associated with the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: Location summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: RegistrationId summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: remarks: >- Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4. - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ properties: fullName: Rights summary: Gets or sets the value that specifies the permissions needed for the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ properties: fullName: Scope summary: Gets a value that specifies the scope of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ properties: fullName: ScriptBlock summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -202,7 +202,7 @@ properties: fullName: ScriptSrc summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -217,7 +217,7 @@ properties: Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -230,7 +230,7 @@ properties: fullName: Title summary: Gets or sets the display title of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ properties: fullName: Url summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -256,7 +256,7 @@ properties: fullName: VersionOfUserCustomAction summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 2bff7eea..2fb1f356 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: Example: `"/Date(2016,0,20,12,58,7,0)/"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: CurrentChangeToken summary: Represents the unique sequential location of a change within the change log. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: Description summary: Gets or sets the description for the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: fullName: IsMultilingual summary: Value that represents if the web was remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: Example: `1033` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: Example: `"/Date(1453618828000)/"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: fullName: NoCrawl summary: Determines if a particular web will be crawled by search or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -166,7 +166,7 @@ properties: fullName: QuickLaunchEnabled summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -179,7 +179,7 @@ properties: fullName: RecycleBinEnabled summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -195,7 +195,7 @@ properties: Example: `"/sites/PubSite"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: fullName: SiteLogoUrl summary: Gets the url for the logo of this particular site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -221,7 +221,7 @@ properties: fullName: Title summary: The title of the web. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -237,7 +237,7 @@ properties: Example: `15` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -253,7 +253,7 @@ properties: Example: `"http://example.com/sites/PubSite"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ properties: Example: `"BLANKINTERNET"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 5a828f3e..6c4e493f 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CultureInfo` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -27,7 +27,7 @@ properties: Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the date as 1/8 instead of 8/1. - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to translate the word "hello" to "hola". - example: [] + isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: isRightToLeft summary: This boolean represents the dominant direction of written text for the default user interface language. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index b17520e3..f32298e2 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPSystemTime summary: Interface that represents a `SPSystemTime` structure. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: Day summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: DayOfWeek summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: Hour summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: Milliseconds summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: Minute summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: Month summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: Second summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: Year summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 24c4dfaa..16f17551 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPTimeZoneData summary: Interface that represents the data necessary to build an `TimeZone` object. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: daylightDate summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: daylightOffset summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: description summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: id summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: offset summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: standardDate summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: standardOffset summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index ad7057bb..6c91922f 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -8,7 +8,7 @@ remarks: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `PageContext` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: isInitialized summary: Returns whether the `PageContext` has been initialized. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object. - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -118,7 +118,7 @@ properties: Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ properties: fullName: serviceKey summary: The service key for PageContext. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ properties: fullName: site summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -161,7 +161,7 @@ properties: It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -174,7 +174,7 @@ properties: fullName: web summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spdayofweek-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml index 377eec5f..d5853a3d 100644 --- a/SP-Framework/sp-page-context/spdayofweek-typealias.yml +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: SPDayOfWeek summary: The type members represent the seven days of a week. remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: 'export declare type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 5c163c3f..8885dcdb 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -11,7 +11,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPField` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -102,7 +102,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 97e758e5..6d78d688 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPList` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: title summary: Returns the title for this `SPList`. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 6a1d03ff..47b0ce7c 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPListItem` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: id summary: The number that identifies the `SPListItem` on the server. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index a35cd9fd..3ba1704a 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -10,7 +10,7 @@ remarks: >- For more information, see: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(value) summary: Constructs a new instance of the `SPPermission` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation-compatible editor. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: fullName: addDelPrivateWebParts summary: Add or remove personal web parts on a web part Page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: addListItems summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -78,7 +78,7 @@ properties: fullName: applyStyleSheets summary: Apply a style sheet (.css file) to the Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ properties: fullName: applyThemeAndBorder summary: Apply a theme or borders to the entire Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ properties: fullName: approveItems summary: Approve a minor version of a list item or document. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: fullName: browseDirectories summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: browserUserInfo summary: View information about users of the Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ properties: fullName: cancelCheckout summary: Discard or check in a document which is checked out to another user. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -156,7 +156,7 @@ properties: fullName: createAlerts summary: Create e-mail alerts. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ properties: fullName: createGroups summary: Create a group of users that can be used anywhere within the site collection. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -182,7 +182,7 @@ properties: fullName: createSSCSite summary: Create a Web site using Self-Service Site Creation. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -195,7 +195,7 @@ properties: fullName: deleteListItems summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: fullName: deleteVersions summary: Delete past versions of a list item or document. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ properties: Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -236,7 +236,7 @@ properties: fullName: editMyUserInfo summary: 'Allows a user to change his or her user information, such as adding a picture.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -249,7 +249,7 @@ properties: fullName: emptyMask summary: Has no permissions on the Web site. Not available through the user interface. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -262,7 +262,7 @@ properties: fullName: enumeratePermissions summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -275,7 +275,7 @@ properties: fullName: fullMask summary: Has all permissions on the Web site. Not available through the user interface. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -288,7 +288,7 @@ properties: fullName: layoutsPage summary: View the layouts page? remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -301,7 +301,7 @@ properties: fullName: manageAlerts summary: Manage alerts for all users of the Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -314,7 +314,7 @@ properties: fullName: manageLists summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -327,7 +327,7 @@ properties: fullName: managePermissions summary: Create and change permission levels on the Web site and assign permissions to users and groups. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ properties: fullName: managePersonalViews summary: 'Create, change, and delete personal views of lists.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -353,7 +353,7 @@ properties: fullName: manageSubwebs summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -371,7 +371,7 @@ properties: of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. - example: [] + isPreview: false isDeprecated: false syntax: @@ -384,7 +384,7 @@ properties: fullName: open summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -397,7 +397,7 @@ properties: fullName: openItems summary: View the source of documents with server-side file handlers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -410,7 +410,7 @@ properties: fullName: updatePersonalWebParts summary: Update web parts to display personalized information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -423,7 +423,7 @@ properties: fullName: useClientIntegration summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -436,7 +436,7 @@ properties: fullName: useRemoteAPIs summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -449,7 +449,7 @@ properties: fullName: value summary: Returns the value of this SPPermission object remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -462,7 +462,7 @@ properties: fullName: viewFormPages summary: 'View forms, views, and application pages, and enumerate lists.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -475,7 +475,7 @@ properties: fullName: viewListItems summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -488,7 +488,7 @@ properties: fullName: viewPages summary: View pages in a Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -501,7 +501,7 @@ properties: fullName: viewUsageData summary: View reports on Web site usage. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -514,7 +514,7 @@ properties: fullName: viewVersions summary: View past versions of a list item or document. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -528,7 +528,7 @@ methods: fullName: hasAllPermissions(requestedPerms) summary: Function for testing whether a given permission mask has all of the requested permissions. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -546,7 +546,7 @@ methods: fullName: hasAnyPermissions(requestedPerms) summary: Function for testing whether a given permission mask has any of the requested permissions. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -564,7 +564,7 @@ methods: fullName: hasPermission(requestedPerm) summary: Function for testing whether a given permission mask has the requested permission. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index f42ff584..ce9786e7 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPSite` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: absoluteUrl summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: cdnPrefix summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: classification summary: Returns the classification of the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: correlationId summary: Returns the correlation id to the current server request. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: id summary: The GUID that identifies the SPSite on the server. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: isNoScriptEnabled summary: Returns true if isNoScript has been enabled on the SPSite. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: recycleBinItemCount summary: The amount of items in the recycle bin. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ properties: fullName: serverRequestPath summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: fullName: sitePagesEnabled summary: Returns true if SitePages are enabled on this SPSite. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 932ac3ec..dd7fba10 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -19,7 +19,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPTimeZone` class. -example: [] + isPreview: true isDeprecated: false type: class @@ -30,7 +30,7 @@ properties: fullName: daylightDate summary: Gets the date on which daylight time begins for the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: description summary: Gets the description for the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: id summary: Gets the ID of the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -84,7 +84,7 @@ properties: fullName: offset summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -97,7 +97,7 @@ properties: fullName: standardDate summary: Gets the date on which standard time begins for the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -112,7 +112,7 @@ properties: Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index ab618111..7aee725b 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPUser` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: displayName summary: The display name for the current user. remarks: 'Example: `"John Doe"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: email summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: isAnonymousGuestUser summary: Returns if the current user is an anonymous guest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: isExternalGuestUser summary: Returns true if the current user is an external guest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: loginName summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: preferUserTimeZone summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: timeZoneInfo summary: Returns the user's regional timezone settings or undefined if they haven't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 8a9e9892..d83c54d6 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPWeb` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: absoluteUrl summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: description summary: Returns the description of the current SPWeb. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: id summary: The GUID that identifies the SPWeb on the server. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: isAppWeb summary: Returns true if this `SPWeb` the container web for an `SPApp`. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: language summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: languageName summary: Returns the language name for the default language of the website. remarks: 'Example: en-US represents the English language in the US locale.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: logoUrl summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -154,7 +154,7 @@ properties: Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -167,7 +167,7 @@ properties: fullName: timeZoneInfo summary: Returns the web's regional timezone settings or undefined if they haven't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -180,7 +180,7 @@ properties: fullName: title summary: Returns the title of the current SPWeb. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index a256227a..4fb83f74 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -56,7 +56,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Button on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - example: [] + isPreview: true isDeprecated: false syntax: @@ -153,7 +153,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -177,7 +177,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -206,7 +206,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -230,7 +230,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' @@ -255,7 +255,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -268,7 +268,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create an IconPicker on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -292,7 +292,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Label on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -316,7 +316,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Link on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -364,7 +364,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -388,7 +388,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a ThumbnailPicker on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -412,7 +412,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 186ec829..977268fc 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 60caae83..9f1934a9 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the shared property. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index c708a4a5..1487dafa 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -26,7 +26,7 @@ properties: When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index bd864d5a..471efee3 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the shared source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: default value - 'Connect to source' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index f4805c4b..6e3b0a6f 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ properties: Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources. - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: The source id for a web part will be of the form WebPart.. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/iguidset.yml b/SP-Framework/sp-property-pane/iguidset.yml index a03c22e6..55d52f99 100644 --- a/SP-Framework/sp-property-pane/iguidset.yml +++ b/SP-Framework/sp-property-pane/iguidset.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IGuidSet summary: Set of GUIDs representing a list item. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: listId summary: List ID remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: siteId summary: Site ID remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: uniqueId summary: Unique ID within the list remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: webId summary: Web ID remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/imagefit.yml b/SP-Framework/sp-property-pane/imagefit.yml index ea911f33..9e3c5f0f 100644 --- a/SP-Framework/sp-property-pane/imagefit.yml +++ b/SP-Framework/sp-property-pane/imagefit.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: ImageFit summary: The possible methods that can be used to fit the image. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index 8c5cc183..c2d4b542 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPopupWindowProps summary: Popup window props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: height summary: Height of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: positionWindowPosition summary: The position of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: Title of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: width summary: Width of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index 80baf21f..e2dc3b1d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: Besides the compound button, other button types will need more information provided to screen reader. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: ariaLabel summary: The aria label of the button for the benefit of screen readers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: buttonType summary: The type of button to render. Default value is ButtonType.normal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: description summary: Description of the action this button takes. Only used for compound buttons. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: disabled summary: Whether the button is disabled. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -84,7 +84,7 @@ properties: fullName: icon summary: The button icon shown in command or hero type. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: text summary: Display text of the element. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index 9b51c17f..d9128e5a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: checked summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Whether the property pane checkbox is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: text summary: Label to display next to the checkbox. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index d4926fbc..d45f88b7 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: The aria label of the property pane choice group option for the benefit of screen readers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: Default value is false. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: disabled summary: Whether the property pane choice group option is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: iconProps summary: The Icon component props for choice field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: imageSize summary: The width and height of the image in px for choice field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: fullName: imageSrc summary: The src of image for choice field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -105,7 +105,7 @@ properties: fullName: key summary: A required key to uniquely identify the option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -118,7 +118,7 @@ properties: fullName: selectedImageSrc summary: The src of image for choice field which is selected. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ properties: fullName: text summary: The text string for the option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index 4bfae47f..e5f71b77 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: officeFabricIconFontName summary: The name of the icon to use from the Office Fabric icon set. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 295550d2..0a407d31 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: label summary: Descriptive label for the choice group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: options summary: The options for the choice group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index 432c2fbb..f7ec8cc1 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: onShowPrimaryGroup summary: Callback when user clicks to show primary group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: onShowSecondaryGroup summary: Callback when user clicks to show secondary group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: primaryGroup summary: Primary group to show remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: secondaryGroup summary: Secondary group to show remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: showSecondaryGroup summary: Indicating whether the property pane should show primary group or the secondary group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index d39cbbb5..783a42f1 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: currentPage summary: Page to be displayed on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other properties will be unaffected. - example: [] + isPreview: true isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: disableFocusTrap summary: Whether to disable trapping focus inside property pane. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: loadingIndicatorDelayTime summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: pages summary: Total number of pages on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index 5f9fc1d8..067bbf8d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: For more information, see the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: onDispose summary: This API is called when the component is unmounted from the host element. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: fullName: onRender summary: This API will be called once the custom field is mounted on the host element. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index b44432bb..54493568 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDebounceProperty summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired for this property. remarks: The default value is 500. - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: propertyName summary: Property to debounce. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index ffd7d218..2db0cbbc 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: calloutMaxHeight summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index f8c31b3b..c8d4154a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: index summary: Index for this option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: key summary: A key to uniquely identify this option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: text summary: Text to render for this option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index 36d8de4d..f1ce19ff 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: A description of the dropdown for the benefit of screen reader users. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: ariaSetSize summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: calloutProps summary: Custom properties for Dropdown's Callout used to render options. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: disabled summary: Whether the property pane dropdown option is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: label summary: Descriptive label for the Dropdown. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: options summary: Collection of options for this Dropdown. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: selectedKey summary: The key of the initially selected option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml index 01ed3eb6..befafec8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index fbe9c768..30c5b877 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the property pane dynamic field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the field.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field. - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: default value - 'Connect to source' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 6ba03709..307f3001 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: fields summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the property.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: sharedConfiguration summary: Configuration shared between all the entries of the set. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 8e898425..7da99657 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' -example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' @@ -17,7 +17,7 @@ properties: fullName: ariaLabel summary: 'ARIA Label for text field, if any.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -30,7 +30,7 @@ properties: fullName: description summary: The text field input description. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: Make sure to set this only if you want to see an error message displayed for the text field. - example: [] + isPreview: true isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - example: [] + isPreview: true isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: placeholder summary: Placeholder text to be displayed in the text field. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - example: [] + isPreview: true isDeprecated: false syntax: @@ -137,7 +137,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. - example: [] + isPreview: true isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 2ad7e288..15f655a2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: properties summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: shouldFocus summary: Whether this control should be focused. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: targetProperty summary: Target property from the web part's property bag. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Type of the PropertyPane field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 843087a8..c2b495d1 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: groupFields summary: List of PropertyPane fields. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: remarks: >- For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left empty, the group header will not render (not recommended for accordions). - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: isCollapsed summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: remarks: >- The default value is false. Use this option to skip the rendering of group name to avoid empty group header being displayed. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml index 11c75dc4..926012a9 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneIconPickerProps summary: PropertyPaneIconPicker component props remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: callerName summary: Optional name of consuming component for telemetry purposes. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: The icon picker allows selection of Fabric MDL2 icons. This optional parameter allows the caller to override this with a custom selection of icons. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: customSelectedIconName summary: 'When invoking with a custom icon set, this is the name of the currently selected icon.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: onItemChanged summary: Callback function for when an icon is selected. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: onItemDeleted summary: Callback function for when the Delete button is clicked. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: previewFullWidth summary: Whether to render the icon preview with full width or the default fixed aspect ratio. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: previewGrayBackground summary: Whether to render the icon with a gray background. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: thumbnail summary: Thumbnail metadata of the currently selected icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: thumbnailRendererIconClassName summary: Optional CSS class name to apply to the icon preview. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: thumbnailRendererWrapperClassName summary: Optional CSS class name to apply to the icon preview wrapper. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index 65e421ac..640a3b8f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: required summary: Whether the associated form field is required or not. remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: text summary: Display text fot the label. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 2e123827..36cebdab 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: disabled summary: Whether the property pane link is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: href summary: Location to which the link is targeted to. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: popupWindowProps summary: The props of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: \_top - Load the response into the original window. - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ properties: fullName: text summary: Display text for the link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 76f583e9..acca1669 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: displayGroupsAsAccordion summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: groups summary: List of groups to be displayed on the PropertyPane page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: header summary: PropertyPane page header. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index 3c7d4728..b2c1f373 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: description summary: Header to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: image summary: Image url for the background image. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This property is not used. diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index ca093fc1..c7826e7f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: A description of the Slider for the benefit of screen readers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Whether or not the Slider is disabled. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: label summary: Description label of the Slider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: max summary: The max value of the Slider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: min summary: The min value of the Slider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: showValue summary: Whether to show the value on the right of the Slider. remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: step summary: The difference between the two adjacent values of the Slider. Defaults to 1. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: Defaults to min. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -129,7 +129,7 @@ properties: ``` is specified, the value of the Slider has % after it. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index a4cf23c0..9317b875 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: 'Aria Label for text field, if any.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: deferredValidationTime summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: description summary: The text field input description. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: So, make sure to set this only if you want to see an error message displayed for the text field. - example: [] + isPreview: false isDeprecated: false syntax: @@ -86,7 +86,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -119,7 +119,7 @@ properties: 2. The text length after each edit - example: [] + isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ properties: fullName: maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: fullName: multiline summary: Whether or not the text field is a multiline text field. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -177,7 +177,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - example: [] + isPreview: false isDeprecated: false syntax: @@ -190,7 +190,7 @@ properties: fullName: placeholder summary: placeholder text to be displayed in the text field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -203,7 +203,7 @@ properties: fullName: resizable summary: Whether or not the multiline text field is resizable. remarks: The default value is true. - example: [] + isPreview: false isDeprecated: false syntax: @@ -216,7 +216,7 @@ properties: fullName: rows summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. - example: [] + isPreview: false isDeprecated: false syntax: @@ -229,7 +229,7 @@ properties: fullName: underlined summary: Whether or not the text field is underlined. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -242,7 +242,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -255,7 +255,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -270,7 +270,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml index 9e8dbcb0..afa840b9 100644 --- a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneThumbnailPickerProps summary: PropertyPaneThumbnailPicker component props remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: callerName summary: Optional name of consuming component for telemetry purposes. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: If an asset from the current site is selected, the URL can be returned as a relative URL. This option forces the URL to be returned as an absolute URL. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: onItemChanged summary: Callback function for when an image has been selected. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: onItemDeleted summary: Callback for when the Delete button is clicked. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: previewFullWidth summary: 'For the preview image, display with full width as opposed to the default fixed ratio.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: previewGrayBackground summary: Whether to display a gray background when rendering an icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: serviceScope summary: Service scope. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: thumbnail summary: Thumbnail metadata of the currently selected thumbnail. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: thumbnailRendererIconClassName summary: Optional CSS class name to apply to the thumbnail preview when an icon is being rendered. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: thumbnailRendererWrapperClassName summary: Optional CSS class name to apply to the wrapper of the thumbnail preview. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index e3c2aa91..ca90e3ec 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: checked summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Optional disabled flag. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: key summary: A key to uniquely identify the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: label summary: A label for the toggle. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: offAriaLabel summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: offText summary: Test display when toggle is OFF. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: onAriaLabel summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: onText summary: Text to display when toggle is ON. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnail.yml b/SP-Framework/sp-property-pane/ithumbnail.yml index e5670cd8..639c639b 100644 --- a/SP-Framework/sp-property-pane/ithumbnail.yml +++ b/SP-Framework/sp-property-pane/ithumbnail.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnail summary: The type of thumbnail image being configured. remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: export declare type IThumbnail = IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage; diff --git a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml index 67ada762..8d2dad84 100644 --- a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailFabricReactIcon summary: Options related to fabric icon thumbnail. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconColor summary: The background color for the icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: iconName summary: The name of the icon to render. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Fabric icon type. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml index 3744aa1f..75bc6e19 100644 --- a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailIconSizeImage summary: Options related to icon sized image thumbnail. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconColor summary: Background color to use for the icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: iconUrl summary: URL pointing to the icon-size image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Image type. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnailimage.yml b/SP-Framework/sp-property-pane/ithumbnailimage.yml index 7a476525..f52b101c 100644 --- a/SP-Framework/sp-property-pane/ithumbnailimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailImage summary: Options related to image thumbnail. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: backupImageUrl summary: Optional backup image URL if the original image URL fails to load. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: imageFit summary: How the image should fit. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: imageUrl summary: URL pointing to the image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: type summary: Image type. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index 181d60f3..c21c4d0c 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PopupWindowPosition summary: The position of pop up window. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index f6c1af58..b28f7aba 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 78062421..5bad4681 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -7,7 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 44cdb99d..2a4fba58 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -8,7 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/thumbnailtype.yml b/SP-Framework/sp-property-pane/thumbnailtype.yml index 20bd46a6..90495bd3 100644 --- a/SP-Framework/sp-property-pane/thumbnailtype.yml +++ b/SP-Framework/sp-property-pane/thumbnailtype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: ThumbnailType summary: Supported thumbnail image types. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index f95a2a90..8a59dd11 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -10,7 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "SearchQueryModifier". remarks: '' -example: [] + isPreview: true isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: true isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the original query will be used instead of the modified one. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: 'modifySearchQuery(query, scenario)' summary: Returns a modified search query. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index 034e43dc..20c25567 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: IQuery summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. remarks: Additional properties can be added to the object to pass data between extensions. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: originalQueryText summary: Query text that the user provided. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: queryText summary: Text of the query. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index ad471c5c..f2b0828b 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryModifierContext summary: Context for the search query modifier extensions. remarks: '' -example: [] + isPreview: true isDeprecated: false type: class diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index df857dc9..1cd79378 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryScenario summary: Scenario for the search query modifier. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 9830ca7e..18b36010 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -58,7 +58,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Button on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -85,7 +85,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -112,7 +112,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -143,7 +143,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -167,7 +167,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -194,7 +194,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -226,7 +226,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -253,7 +253,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -280,7 +280,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -296,7 +296,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Label on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -323,7 +323,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Link on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -350,7 +350,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -377,7 +377,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -404,7 +404,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 8d525fb6..1c58e87f 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -19,7 +19,7 @@ remarks: >- updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision. -example: [] + isPreview: false isDeprecated: false type: class @@ -33,7 +33,7 @@ constructors: It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not. remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: remarks: >- Web parts should utilize this property to perform operations such as any conditional styling of components based on the initial available width for the web part. - example: [] + isPreview: false isDeprecated: false syntax: @@ -164,7 +164,7 @@ methods: fullName: clearError() summary: This API should be used to clear the error message from the web part display area. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -182,7 +182,7 @@ methods: remarks: >- Web parts should utilize this method to perform operations such as potentially re-rendering components based on the new available width for the web part. - example: [] + isPreview: false isDeprecated: false syntax: @@ -205,7 +205,7 @@ methods: The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. - example: [] + isPreview: false isDeprecated: false syntax: @@ -229,7 +229,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - example: [] + isPreview: false isDeprecated: false syntax: @@ -247,7 +247,7 @@ methods: remarks: >- Developers sould not call render in overridden method. It can lead to unpredicted re-flow of the web part. render will be called from the base class when needed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ methods: This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -287,7 +287,7 @@ methods: initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -307,7 +307,7 @@ methods: This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 47b883ee..9da9ec0d 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -7,7 +7,7 @@ summary: >- This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ properties: fullName: description summary: Description of the WebPart remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane button is clicked. - example: [] + isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ properties: fullName: displayMode summary: This property is the current display mode of the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -145,7 +145,7 @@ properties: fullName: properties summary: This property is the pointer to the custom property bag of the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -162,7 +162,7 @@ properties: remarks: >- See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more information about how to define metadata - example: [] + isPreview: false isDeprecated: false syntax: @@ -175,7 +175,7 @@ properties: fullName: title summary: Title of the WebPart remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -222,7 +222,7 @@ methods: 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including 'loadPropertyPaneResources' promise. - example: [] + isPreview: false isDeprecated: false syntax: @@ -249,7 +249,7 @@ methods: by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - example: [] + isPreview: false isDeprecated: false syntax: @@ -278,7 +278,7 @@ methods: This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -298,7 +298,7 @@ methods: some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. - example: [] + isPreview: false isDeprecated: false syntax: @@ -314,7 +314,7 @@ methods: remarks: >- If the web part is initialized or re-initialized in a different display mode then this lifecycle method is not called. - example: [] + isPreview: false isDeprecated: false syntax: @@ -336,7 +336,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - example: [] + isPreview: false isDeprecated: false syntax: @@ -353,7 +353,7 @@ methods: This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. - example: [] + isPreview: false isDeprecated: false syntax: @@ -376,7 +376,7 @@ methods: - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - When the user switches web parts then the current web part gets this event. - example: [] + isPreview: false isDeprecated: false syntax: @@ -395,7 +395,7 @@ methods: - When the PropertyPane is opened. - When the user switches web parts then the new web part gets this event. - example: [] + isPreview: false isDeprecated: false syntax: @@ -411,7 +411,7 @@ methods: This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -438,7 +438,7 @@ methods: fullName: onPropertyPaneRendered() summary: This API is invoked when the PropertyPane is rendered. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index a20a586b..ce02474f 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -12,7 +12,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseWebPartContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: remarks: >- Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas. - example: [] + isPreview: true isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 600ff48c..7b4efcba 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 40761f66..37f37142 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -7,7 +7,7 @@ summary: >- Interface to be implemented by a component that should display the loading indicator and error messages for a web part. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ methods: fullName: clearError(domElement) summary: Clear the webpart error message. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: fullName: clearLoadingIndicator(domElement) summary: Clear the loading indicator. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ methods: fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' summary: Display a loading spinner. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: fullName: 'renderError(domElement, error, clearDomElementCallback)' summary: Render the provided error message in the webpart container div. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index b251db60..c1d3dc4d 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index 76c11b78..b2785cc7 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 8dec184b..f247b9c0 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index a58567d1..a62c555e 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index be17e1ae..f2fdae3b 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IMicrosoftTeams summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: teamsJs summary: Microsoft Teams SDK. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 97778dc3..6396ea40 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -7,7 +7,7 @@ summary: >- Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ methods: fullName: close() summary: This API should be used to close the PropertyPane to help configure the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: isPropertyPaneOpen() summary: Returns true if the PropertyPane is open. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: remarks: >- For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ methods: fullName: open() summary: This API should be used to open the PropertyPane to help configure the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: fullName: openDetails(context) summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: remarks: >- This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index e7cf9f6c..6de500f5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index cea9643d..0380065f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 2f4196c6..340b6219 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 3e5942f2..345e8d5f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index a4cfa04d..5d6eca1c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 20a3b896..293f8e6d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 6972d5a0..c37e1f69 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 27168147..be0046fc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 0df7e9ac..baea865f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index e53d1b59..8758beed 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index d22d661f..2dbcd2af 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 28e5fea0..088a650b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 7cb4d1f4..2db3752f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 098e55e5..16573536 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 0ee57f36..cf66c4cc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' -example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 10976c2a..e72daa91 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index 9463e163..b379133d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index f343e4ee..a989e640 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 533f4891..9c42be76 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index fd99d165..e9345fa8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index d289960c..fd82e384 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index 1bd769eb..4dfa04d0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 1c29fea8..ee8fa3f6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index bacb7353..13981c98 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index 1e8f87c7..c9c5eae9 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: ISDKs summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index b901b0ca..74f83a20 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -7,7 +7,7 @@ summary: >- This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: 'aBooleanProperty': true } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: Example: `{ 'value': 'text value' }` - example: [] + isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 78dfb218..ca01b289 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -8,7 +8,7 @@ remarks: >- A "context" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -22,7 +22,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: httpClient summary: HttpClient instance scoped to this web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: instanceId summary: Web part instance id. This is a globally unique value. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: fullName: manifest summary: Manifest for the client-side web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: pageContext summary: SharePoint page context. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: spHttpClient summary: SPHttpClient instance scoped to this web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index e597506b..20f9f523 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -8,7 +8,7 @@ remarks: >- When the `serialize()` API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize. -example: [] + isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: Supported values: string with the description. Example: `"Text"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: 'aBooleanProperty': true } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: id summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ properties: supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` - example: [] + isPreview: false isDeprecated: false syntax: @@ -165,7 +165,7 @@ properties: Example: `{ 'value': 'text value' }` - example: [] + isPreview: false isDeprecated: false syntax: @@ -178,7 +178,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -196,7 +196,7 @@ properties: Supported values: string less than 100 characters Example: `"Text"` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 43b2f426..258717de 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -56,7 +56,7 @@ remarks: >- This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated. -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 274814b6..3d58f18f 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IWebPartPropertyMetadata summary: This is the structure used for map values in `IWebPartPropertiesMetadata` remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ properties: Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 45622192..34b40ca1 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index f8ca6168..c8e3ba6b 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -7,7 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 5339bf08..cfb7e8bd 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -8,7 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index dd7e90f1..97e4d38a 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebPartContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This function has been deprecated' @@ -51,7 +51,7 @@ properties: fullName: sdks summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index eb71fde2..7a048b2f 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -8,7 +8,7 @@ remarks: >- This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor. -example: [] + isPreview: true isDeprecated: false fields: From cea5fddba31a24eb03b493d7a822a89b36a77744 Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Fri, 1 Apr 2022 14:00:35 -0400 Subject: [PATCH 53/55] beta.5 --- SP-Framework/decorators.yml | 6 +- .../office-ui-fabric-react-bundle.yml | 2 +- .../adaptivecardextensioncontext.yml | 10 +-- .../baseadaptivecardextension.yml | 72 ++++++++-------- .../baseadaptivecardview.yml | 10 +-- .../basebasiccardview.yml | 4 +- .../basecardview.yml | 10 +-- .../baseimagecardview.yml | 4 +- .../baseprimarytextcardview.yml | 4 +- .../baseview.yml | 26 +++--- .../cardsize.yml | 2 +- .../devicecontext.yml | 2 +- .../iactionarguments.yml | 2 +- .../iactionerror.yml | 2 +- .../iactionerrorarguments.yml | 2 +- ...daptivecardextensionpropertiesmetadata.yml | 2 +- ...iadaptivecardextensionpropertymetadata.yml | 2 +- .../iattachmenterror.yml | 4 +- .../ibaseactionarguments.yml | 6 +- .../ibaseactionerrorarguments.yml | 8 +- .../ibasecardparameters.yml | 8 +- .../ibasiccardparameters.yml | 4 +- .../icachedloadparameters.yml | 6 +- .../icachesettings.yml | 8 +- .../icardaction.yml | 2 +- .../icardbutton.yml | 10 +-- .../iconfirmationdialog.yml | 6 +- .../iexternallinkcardaction.yml | 6 +- .../iexternallinkparameters.yml | 6 +- .../igetlocationaction.yml | 6 +- .../igetlocationactionarguments.yml | 6 +- .../igetlocationactionparameters.yml | 4 +- .../igetlocationcardaction.yml | 6 +- .../iimagecardparameters.yml | 6 +- .../ilocation.yml | 10 +-- .../ilocationerrorarguments.yml | 6 +- .../iprimarytextcardparameters.yml | 6 +- .../iquickviewcardaction.yml | 6 +- .../iquickviewparameters.yml | 4 +- .../iselectmediaaction.yml | 6 +- .../iselectmediaactionarguments.yml | 8 +- .../iselectmediaactionerrorarguments.yml | 8 +- .../iselectmediaactionparameters.yml | 10 +-- .../iselectmediaattachment.yml | 8 +- .../iselectmediacardaction.yml | 6 +- .../ishowcardactionarguments.yml | 4 +- .../ishowlocationaction.yml | 6 +- .../ishowlocationactionparameters.yml | 4 +- .../ishowlocationcardaction.yml | 6 +- .../ispfxadaptivecard.yml | 4 +- .../isubmitactionarguments.yml | 6 +- .../isubmitcardaction.yml | 8 +- .../isubmitcardparameters.yml | 2 +- .../mediatype.yml | 2 +- .../quickviewnavigator.yml | 4 +- .../rendertype.yml | 2 +- .../viewnavigator.yml | 16 ++-- .../applicationaccessor.yml | 6 +- .../applicationcustomizercontext.yml | 8 +- .../baseapplicationcustomizer.yml | 8 +- .../iplaceholdercreatecontentoptions.yml | 4 +- .../placeholdercontent.yml | 12 +-- .../sp-application-base/placeholdername.yml | 2 +- .../placeholderprovider.yml | 12 +-- .../sp-component-base/basecomponent.yml | 16 ++-- .../basecomponentcontext.yml | 30 +++---- .../sp-component-base/dynamicdataprovider.yml | 22 ++--- .../dynamicdatasourcemanager.yml | 16 ++-- .../sp-component-base/dynamicproperty.yml | 28 +++---- .../icomponentpropertymetadata.yml | 12 +-- .../sp-component-base/ireadonlyfontstyles.yml | 2 +- .../sp-component-base/ireadonlyrawstyle.yml | 2 +- .../sp-component-base/ireadonlytheme.yml | 2 +- .../iserializedserverprocesseddata.yml | 10 +-- SP-Framework/sp-component-base/itheme.yml | 2 +- .../themechangedeventargs.yml | 4 +- .../sp-component-base/themeprovider.yml | 10 +-- SP-Framework/sp-core-library/displaymode.yml | 2 +- SP-Framework/sp-core-library/environment.yml | 4 +- .../sp-core-library/environmenttype.yml | 2 +- .../sp-core-library/formdisplaymode.yml | 2 +- SP-Framework/sp-core-library/guid.yml | 16 ++-- SP-Framework/sp-core-library/idisposable.yml | 6 +- .../irandomnumbergenerator.yml | 4 +- .../sp-core-library/iservicecollection.yml | 4 +- .../sp-core-library/ispeventobserver.yml | 6 +- .../sp-core-library/itimeprovider.yml | 6 +- SP-Framework/sp-core-library/log.yml | 10 +-- .../sp-core-library/randomnumbergenerator.yml | 8 +- .../sp-core-library/servicecreator.yml | 2 +- SP-Framework/sp-core-library/servicekey.yml | 12 +-- SP-Framework/sp-core-library/servicescope.yml | 22 ++--- SP-Framework/sp-core-library/session.yml | 8 +- SP-Framework/sp-core-library/spevent.yml | 6 +- SP-Framework/sp-core-library/speventargs.yml | 2 +- SP-Framework/sp-core-library/text_2.yml | 6 +- SP-Framework/sp-core-library/timeprovider.yml | 10 +-- .../urlqueryparametercollection.yml | 8 +- SP-Framework/sp-core-library/validate.yml | 10 +-- SP-Framework/sp-core-library/version.yml | 28 +++---- SP-Framework/sp-dialog/basedialog.yml | 24 +++--- SP-Framework/sp-dialog/dialog.yml | 6 +- SP-Framework/sp-dialog/ialertoptions.yml | 2 +- .../sp-dialog/idialogconfiguration.yml | 4 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 4 +- SP-Framework/sp-dialog/ipromptoptions.yml | 4 +- .../sp-dialog/isecondarydialogprovider.yml | 8 +- .../sp-dynamic-data/dynamicdatareference.yml | 12 +-- .../idynamicdataannotatedpropertyvalue.yml | 6 +- .../sp-dynamic-data/idynamicdatacallables.yml | 12 +-- .../idynamicdataeventdefinition.yml | 6 +- .../idynamicdatapropertydefinition.yml | 4 +- .../idynamicdatapropertymetadata.yml | 6 +- .../idynamicdatapropertyvaluemetadata.yml | 4 +- ...micdatapropertyvaluemetadatacollection.yml | 2 +- .../sp-dynamic-data/idynamicdatasource.yml | 22 ++--- .../idynamicdatasourcemetadata.yml | 12 +-- .../sp-extension-base/baseextension.yml | 8 +- .../sp-extension-base/extensioncontext.yml | 2 +- SP-Framework/sp-http/aadhttpclient.yml | 12 +-- .../sp-http/aadhttpclientconfiguration.yml | 8 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 6 +- .../sp-http/aadhttpclientresponse.yml | 4 +- SP-Framework/sp-http/aadtokenprovider.yml | 8 +- .../sp-http/aadtokenproviderfactory.yml | 6 +- .../sp-http/beforeredirecteventargs.yml | 8 +- SP-Framework/sp-http/digestcache.yml | 14 ++-- SP-Framework/sp-http/graphrequest.yml | 62 +++++++------- SP-Framework/sp-http/httpclient.yml | 14 ++-- .../sp-http/httpclientconfiguration.yml | 10 +-- SP-Framework/sp-http/httpclientresponse.yml | 30 +++---- .../sp-http/iaadhttpclientconfiguration.yml | 2 +- .../sp-http/iaadhttpclientconfigurations.yml | 4 +- .../sp-http/iaadhttpclientoptions.yml | 8 +- SP-Framework/sp-http/iaadtokenprovider.yml | 8 +- .../iaadtokenproviderconfiguration.yml | 18 ++-- .../sp-http/ibeforeredirecteventargs.yml | 6 +- SP-Framework/sp-http/idigestcache.yml | 10 +-- .../sp-http/ihttpclientconfiguration.yml | 2 +- .../sp-http/ihttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/ihttpclientoptions.yml | 2 +- .../isphttpclientbatchconfiguration.yml | 2 +- .../isphttpclientbatchconfigurations.yml | 4 +- .../isphttpclientbatchcreationoptions.yml | 4 +- .../sp-http/isphttpclientbatchoptions.yml | 2 +- .../isphttpclientcommonconfiguration.yml | 6 +- .../sp-http/isphttpclientconfiguration.yml | 8 +- .../sp-http/isphttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/isphttpclientoptions.yml | 4 +- .../sp-http/itokenacquisitioneventargs.yml | 6 +- SP-Framework/sp-http/msgraphclient.yml | 4 +- SP-Framework/sp-http/msgraphclientfactory.yml | 10 +-- SP-Framework/sp-http/msgraphclientv3.yml | 4 +- SP-Framework/sp-http/odataversion.yml | 10 +-- SP-Framework/sp-http/sphttpclient.yml | 20 ++--- SP-Framework/sp-http/sphttpclientbatch.yml | 12 +-- .../sphttpclientbatchconfiguration.yml | 10 +-- .../sphttpclientcommonconfiguration.yml | 14 ++-- .../sp-http/sphttpclientconfiguration.yml | 16 ++-- SP-Framework/sp-http/sphttpclientresponse.yml | 8 +- SP-Framework/sp-http/sphttpheader.yml | 2 +- .../sp-http/tokenacquisitioneventargs.yml | 8 +- .../sp-image-helper/iimagehelperrequest.yml | 8 +- SP-Framework/sp-image-helper/imagehelper.yml | 4 +- .../icreatesubscriptionsettings.yml | 12 +-- .../ilistsubscription.yml | 4 +- .../isubscriptioncallbacks.yml | 8 +- .../listsubscriptionfactory.yml | 8 +- .../basefieldcustomizer.yml | 8 +- .../baseformcustomizer.yml | 16 ++-- .../baselistviewcommandset.yml | 12 +-- .../columnaccessor.yml | 6 +- .../sp-listview-extensibility/command.yml | 14 ++-- .../fieldcustomizercontext.yml | 6 +- .../formcustomizercontext.yml | 14 ++-- .../sp-listview-extensibility/icolumn.yml | 18 ++-- .../icontenttype.yml | 8 +- .../ifieldcustomizercelleventparameters.yml | 10 +-- .../sp-listview-extensibility/ifilter.yml | 6 +- .../sp-listview-extensibility/ifolderinfo.yml | 4 +- .../iformcustomizercontext.yml | 12 +-- .../sp-listview-extensibility/ilist.yml | 8 +- .../ilistviewaccessorstate.yml | 20 ++--- ...stviewcommandsetexecuteeventparameters.yml | 6 +- ...iewcommandsetlistviewupdatedparameters.yml | 4 +- .../sp-listview-extensibility/irow.yml | 4 +- .../sp-listview-extensibility/iview.yml | 8 +- .../listitemaccessor.yml | 8 +- .../listviewaccessor.yml | 26 +++--- .../listviewaccessorstatechanges.yml | 2 +- .../listviewcommandsetcontext.yml | 6 +- .../listviewstatechangedeventargs.yml | 6 +- .../sp-listview-extensibility/rowaccessor.yml | 2 +- .../selectedrowschangedeventargs.yml | 4 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 4 +- SP-Framework/sp-loader/spcomponentloader.yml | 12 +-- SP-Framework/sp-lodash-subset/cancelable.yml | 2 +- .../sp-lodash-subset/throttlesettings.yml | 2 +- .../sp-module-interfaces/componenttype.yml | 2 +- .../sp-module-interfaces/extensiontype.yml | 2 +- .../iadaptivecardextensionmanifest.yml | 18 ++-- .../iadaptivecardextensionmanifestentry.yml | 20 ++--- .../iclientsideassemblymanifest.yml | 4 +- ...clientsidecomponentloaderconfiguration.yml | 10 +-- .../iclientsidecomponentmanifest.yml | 16 ++-- .../iclientsideextensionmanifest.yml | 4 +- .../iclientsidelibrarymanifest.yml | 2 +- .../iclientsidemanifestbase.yml | 6 +- .../iclientsidewebpartmanifest.yml | 18 ++-- .../iclientsidewebpartmanifestentry.yml | 22 ++--- .../iclientsidewebpartmanifestinstance.yml | 2 +- .../icommanddefinition.yml | 10 +-- .../icommandsetextensionmanifest.yml | 6 +- .../icomponentmoduleconfiguration.yml | 10 +-- .../sp-module-interfaces/iintegritypath.yml | 6 +- .../ilocalizedpathmoduleconfiguration.yml | 8 +- .../sp-module-interfaces/ilocalizedstring.yml | 6 +- .../imoduleconfiguration.yml | 2 +- .../imoduleconfigurationbase.yml | 6 +- .../ipathmoduleconfiguration.yml | 10 +-- .../sp-module-interfaces/predefinedgroup.yml | 2 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 6 +- .../sp-odata-types/iodatabasepermission.yml | 6 +- .../sp-odata-types/iodatachangetoken.yml | 4 +- .../sp-odata-types/iodatacontenttype.yml | 24 +++--- .../iodatacontextwebinformation.yml | 10 +-- .../iodataformsclientsideconfiguration.yml | 20 ++--- SP-Framework/sp-odata-types/iodatalist.yml | 28 +++---- .../sp-odata-types/iodatalistitem.yml | 10 +-- .../sp-odata-types/iodatanavigationnode.yml | 16 ++-- .../iodatanavigationnodecollection.yml | 6 +- SP-Framework/sp-odata-types/iodatauser.yml | 16 ++-- .../sp-odata-types/iodatausercustomaction.yml | 38 ++++----- SP-Framework/sp-odata-types/iodataweb.yml | 38 ++++----- SP-Framework/sp-page-context/cultureinfo.yml | 8 +- .../sp-page-context/ispsystemtime.yml | 18 ++-- .../sp-page-context/isptimezonedata.yml | 16 ++-- SP-Framework/sp-page-context/pagecontext.yml | 24 +++--- .../sp-page-context/spdayofweek-typealias.yml | 2 +- SP-Framework/sp-page-context/spfield.yml | 16 ++-- SP-Framework/sp-page-context/splist.yml | 10 +-- SP-Framework/sp-page-context/splistitem.yml | 4 +- SP-Framework/sp-page-context/sppermission.yml | 84 +++++++++---------- SP-Framework/sp-page-context/spsite.yml | 24 +++--- SP-Framework/sp-page-context/sptimezone.yml | 16 ++-- SP-Framework/sp-page-context/spuser.yml | 18 ++-- SP-Framework/sp-page-context/spweb.yml | 28 +++---- SP-Framework/sp-property-pane.yml | 32 +++---- .../dynamicdatashareddepth.yml | 2 +- ...dynamicdatasharedpropertyconfiguration.yml | 4 +- .../idynamicdatasharedpropertyfilters.yml | 4 +- .../idynamicdatasharedsourceconfiguration.yml | 6 +- .../idynamicdatasharedsourcefilters.yml | 6 +- SP-Framework/sp-property-pane/iguidset.yml | 10 +-- SP-Framework/sp-property-pane/imagefit.yml | 2 +- .../sp-property-pane/ipopupwindowprops.yml | 10 +-- .../ipropertypanebuttonprops.yml | 18 ++-- .../ipropertypanecheckboxprops.yml | 8 +- .../ipropertypanechoicegroupoption.yml | 20 ++--- ...propertypanechoicegroupoptioniconprops.yml | 4 +- .../ipropertypanechoicegroupprops.yml | 6 +- .../ipropertypaneconditionalgroup.yml | 12 +-- .../ipropertypaneconfiguration.yml | 14 ++-- .../ipropertypanecustomfieldprops.yml | 10 +-- .../ipropertypanedebounceproperty.yml | 6 +- .../ipropertypanedropdowncalloutprops.yml | 4 +- .../ipropertypanedropdownoption.yml | 10 +-- .../ipropertypanedropdownprops.yml | 20 ++--- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 10 +-- .../ipropertypanedynamicfieldsetprops.yml | 8 +- .../ipropertypanedynamictextfieldprops.yml | 22 ++--- .../sp-property-pane/ipropertypanefield.yml | 10 +-- .../sp-property-pane/ipropertypanegroup.yml | 10 +-- .../ipropertypaneiconpickerprops.yml | 22 ++--- .../ipropertypanelabelprops.yml | 6 +- .../ipropertypanelinkprops.yml | 12 +-- .../sp-property-pane/ipropertypanepage.yml | 8 +- .../ipropertypanepageheader.yml | 6 +- .../ipropertypanesliderprops.yml | 20 ++--- .../ipropertypanetextfieldprops.yml | 36 ++++---- .../ipropertypanethumbnailpickerprops.yml | 22 ++--- .../ipropertypanetoggleprops.yml | 18 ++-- SP-Framework/sp-property-pane/ithumbnail.yml | 2 +- .../ithumbnailfabricreacticon.yml | 10 +-- .../ithumbnailiconsizeimage.yml | 10 +-- .../sp-property-pane/ithumbnailimage.yml | 12 +-- .../sp-property-pane/popupwindowposition.yml | 2 +- .../propertypanebuttontype.yml | 2 +- .../propertypanedropdownoptiontype.yml | 2 +- .../propertypanefieldtype.yml | 2 +- .../sp-property-pane/thumbnailtype.yml | 2 +- .../basesearchquerymodifier.yml | 8 +- .../sp-search-extensibility/iquery.yml | 6 +- .../searchquerymodifiercontext.yml | 2 +- .../searchqueryscenario.yml | 2 +- SP-Framework/sp-webpart-base.yml | 28 +++---- .../sp-webpart-base/baseclientsidewebpart.yml | 38 +++++---- SP-Framework/sp-webpart-base/basewebpart.yml | 57 +++++++------ .../sp-webpart-base/basewebpartcontext.yml | 10 +-- .../dynamicdatashareddepth.yml | 2 +- .../iclientsidewebpartstatusrenderer.yml | 10 +-- ...dynamicdatasharedpropertyconfiguration.yml | 2 +- .../idynamicdatasharedpropertyfilters.yml | 2 +- .../idynamicdatasharedsourceconfiguration.yml | 2 +- .../idynamicdatasharedsourcefilters.yml | 2 +- .../sp-webpart-base/imicrosoftteams.yml | 6 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 14 ++-- .../ipropertypanebuttonprops.yml | 2 +- .../ipropertypanecheckboxprops.yml | 2 +- .../ipropertypanechoicegroupoption.yml | 2 +- ...propertypanechoicegroupoptioniconprops.yml | 2 +- .../ipropertypanechoicegroupprops.yml | 2 +- .../ipropertypaneconditionalgroup.yml | 2 +- .../ipropertypaneconfiguration.yml | 2 +- .../ipropertypanecustomfieldprops.yml | 2 +- .../ipropertypanedropdowncalloutprops.yml | 2 +- .../ipropertypanedropdownoption.yml | 2 +- .../ipropertypanedropdownprops.yml | 2 +- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 2 +- .../ipropertypanedynamicfieldsetprops.yml | 2 +- .../ipropertypanedynamictextfieldprops.yml | 2 +- .../sp-webpart-base/ipropertypanefield.yml | 2 +- .../sp-webpart-base/ipropertypanegroup.yml | 2 +- .../ipropertypanelabelprops.yml | 2 +- .../ipropertypanelinkprops.yml | 2 +- .../sp-webpart-base/ipropertypanepage.yml | 2 +- .../ipropertypanepageheader.yml | 2 +- .../ipropertypanesliderprops.yml | 2 +- .../ipropertypanetextfieldprops.yml | 2 +- .../ipropertypanetoggleprops.yml | 2 +- SP-Framework/sp-webpart-base/isdks.yml | 4 +- .../iserializedwebpartdata.yml | 12 +-- .../sp-webpart-base/iwebpartcontext.yml | 20 ++--- SP-Framework/sp-webpart-base/iwebpartdata.yml | 20 ++--- .../iwebpartpropertiesmetadata.yml | 2 +- .../iwebpartpropertymetadata.yml | 4 +- .../propertypanebuttontype.yml | 2 +- .../propertypanedropdownoptiontype.yml | 2 +- .../sp-webpart-base/propertypanefieldtype.yml | 2 +- .../sp-webpart-base/webpartcontext.yml | 12 +-- .../sp-webpart-base/webpartformfactor.yml | 2 +- 343 files changed, 1564 insertions(+), 1555 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 2d1e8098..7aa0222c 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -13,7 +13,7 @@ functions: -->virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ functions: inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ functions: definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml index c7606359..8d507768 100644 --- a/SP-Framework/office-ui-fabric-react-bundle.yml +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -9,7 +9,7 @@ functions: package: '@microsoft/office-ui-fabric-react-bundle!' summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index 89203738..8d4784bc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -7,7 +7,7 @@ summary: Adaptive Card Extension context object. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AdaptiveCardExtensionContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: deviceContext summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: location summary: Provides a promise that gets current location of the device remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: manifest summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: propertyPane summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index 6920fa19..abaed17e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardExtension summary: Base class for Adaptive Card Extensions. remarks: Adaptive Card Extensions must inherit from this class. - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: (constructor)() summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -28,7 +28,7 @@ properties: fullName: _iconProperty summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: _title summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: cardNavigator summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: cardSize summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ properties: fullName: context summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -97,7 +97,7 @@ properties: The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to manage versioning of the Adaptive Card Extension. remarks: The default version is 1.0. - + example: [] isPreview: false isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: fullName: description summary: The description of the Adaptive Card Extension defined in the manifest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: fullName: displayMode summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -136,7 +136,7 @@ properties: fullName: iconProperty summary: The icon url used to render an icon on the Card view. remarks: 'By default, this will return the iconImageUrl defined in the manifest.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: remarks: >- This method should be called after a card view has been registered. Otherwise visibility change will not be applied to the Adaptive Card. - + example: [] isPreview: false isDeprecated: false syntax: @@ -174,7 +174,7 @@ properties: is `QuickView` then returns [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). - + example: [] isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ properties: fullName: properties summary: 'The custom, persisted properties of the Adaptive Card Extension.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -207,7 +207,7 @@ properties: See [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) for more information about how to define metadata. - + example: [] isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ properties: [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ properties: Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default state. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -256,7 +256,7 @@ properties: fullName: renderedOnce summary: Indicates whether the Adaptive Card Extension has initially rendered. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ properties: fullName: renderType summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -285,7 +285,7 @@ properties: If this property is not initialized, [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) cannot be called. - + example: [] isPreview: false isDeprecated: false syntax: @@ -303,7 +303,7 @@ properties: This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also displayed as the Property Pane title. remarks: 'By default, this will return the title defined in the manifest.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -319,7 +319,7 @@ methods: fullName: getCachedState(state) summary: This virtual method returns a subset of the state object that will be cached by the client. remarks: 'If not overriden, this will return an empty object.' - + example: [] isPreview: true isDeprecated: false syntax: @@ -339,7 +339,7 @@ methods: fullName: getCacheSettings() summary: Override the default cache settings. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -360,7 +360,7 @@ methods: Property Pane resources can be defer loaded to reduce bundle size. See [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). - + example: [] isPreview: false isDeprecated: false syntax: @@ -378,7 +378,7 @@ methods: remarks: >- No Property Pane events will be raised until this method resolves except for `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. - + example: [] isPreview: false isDeprecated: false syntax: @@ -403,7 +403,7 @@ methods: was serialized by an older version of the Adaptive Card Extension that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - + example: [] isPreview: false isDeprecated: false syntax: @@ -434,7 +434,7 @@ methods: Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than the property pane (except for isolated Adaptive Card Extensions). remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -454,7 +454,7 @@ methods: fullName: onBeforeSerialize() summary: Lifecycle method called before serialization. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -470,7 +470,7 @@ methods: fullName: onDisplayModeChanged(oldDisplayMode) summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -490,7 +490,7 @@ methods: fullName: onDispose() summary: Lifecycle method called before disposing the Adaptive Card Extension. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -508,7 +508,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - + example: [] isPreview: false isDeprecated: false syntax: @@ -526,7 +526,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - + example: [] isPreview: true isDeprecated: false syntax: @@ -550,7 +550,7 @@ methods: fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' summary: Lifecycle method called when a Property Pane field is changed. remarks: This is invoked for reactive Property Panes. - + example: [] isPreview: false isDeprecated: false syntax: @@ -581,7 +581,7 @@ methods: Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) changes. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -601,7 +601,7 @@ methods: fullName: renderCard() summary: The id of the initial Card view. remarks: 'By default, this returns undefined and will render a default Card view.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -621,7 +621,7 @@ methods: must have been initialized before calling [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml index aaf21156..6d23abe3 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardView summary: Base class for an Adaptive Card view. remarks: Views used to render the Quick view must inherit from this class. - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: data summary: The data used to render the Adaptive Card. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: externalLink summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: template summary: The Adaptive Card template rendered by the view. remarks: The format of the template must be valid Adaptive Card JSON. - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: remarks: >- If not overriden, the title displayed will be [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index c7b7c869..c8653ee6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -7,7 +7,7 @@ summary: Base class for a Basic Card view. remarks: >- The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the `Medium` Card size, two buttons in the `Large` Card size - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index 05487e0f..c5158482 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party Card views should inherit from this class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: remarks: >- Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the documentation for the respective base Card View class for specific details. - + example: [] isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: remarks: >- The available data to display is dependent on the Card view template and its respective base Card view class. See the documentation for the Card View class for specific details. - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: isCacheEnabled summary: 'If true, this Card view will be cached and rendered at next load.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: onCardSelection summary: Action to invoke when the card is selected. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index ab1d8a7d..2d1740b0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -7,7 +7,7 @@ summary: Base class for an Image Card view. remarks: >- The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml index 15348edc..c1781b0f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -7,7 +7,7 @@ summary: Base class for a Primary Text Card view. remarks: >- The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml index d8d63da6..58bd6408 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party views should inherit from this class. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ properties: [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: data summary: The data used to render the View. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -101,7 +101,7 @@ properties: [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -119,7 +119,7 @@ properties: [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: fullName: template summary: The Adaptive Card template used to render the view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ methods: fullName: onAction(action) summary: Action handler for Adaptive Card Actions. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -166,7 +166,7 @@ methods: fullName: onActionError(error) summary: Error handler for Adaptive Card Actions. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -189,7 +189,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -210,7 +210,7 @@ methods: [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml index 5bf41796..1ee3299a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: CardSize summary: Size of the Card view. remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type CardSize = 'Medium' | 'Large'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml index 2f43e2bf..aa5bac54 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml @@ -7,7 +7,7 @@ summary: >- `WebView` indicates the Adaptive Card Extension is rendering through a web browser equivalent. `Mobile` indicates the Adaptive Card Extension is rendering natively on a mobile platform. remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml index 0392e926..a8ccd0ac 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml @@ -11,7 +11,7 @@ remarks: >- Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. - +example: [] isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml index 5c4044e6..bee80041 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IActionError summary: '' remarks: '' - +example: [] isPreview: true isDeprecated: false syntax: |- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml index ff94f913..03bdcaf6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml @@ -12,7 +12,7 @@ remarks: >- routed to the [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) handler. - +example: [] isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml index 38ea8f56..67bd2069 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -7,7 +7,7 @@ summary: >- This structure is used to define metadata for Adaptive Card Extension properties as a map of string to `IAdaptiveCardExtensionPropertiesMetadata` remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index cffa820c..88bf5c21 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAdaptiveCardExtensionPropertyMetadata summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml index ac2835cd..6be15035 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAttachmentError summary: This object represents error associated with a single attachment remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: errorCode summary: Error code associated with a particular attachment remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml index c29bbb17..143a9b10 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -10,7 +10,7 @@ summary: >- remarks: >- Only `Submit` and `ShowCard` actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. - +example: [] isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml index 2baf78f6..b1f8beaa 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an Adaptive Card OnActionError is executed. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: error summary: The error thrown by the action remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: type summary: The type of Adaptive Card Action thsat caused the error. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml index efa7a0de..df28b94e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IBaseCardParameters summary: The primitive data parameters for every Card view. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: iconAltText summary: The icon alt text. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconProperty summary: The icon to display. remarks: The value is a URL to an icon. - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: The title to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index 4101e4a6..e1a132c1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml index c475afc2..f0c24e98 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICachedLoadParameters summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load remarks: API under active development and not ready for use. - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: cardNavigatorState summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: state summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml index 16c9c33e..4df2f958 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICacheSettings summary: '' remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Returns the Card View used to generate the cached card. By default, the currently rendered Card View will be used to cache the card. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: expiryTimeInSeconds summary: 'Expiry time in seconds. Default: 86400 seconds (24 hours)' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: isEnabled summary: 'Whether cache is enabled. Default: true' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml index e8ce3619..9748d1ca 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardAction summary: Type of handler for when a button is pressed. remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 290ef9fd..2d8d904a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardButton summary: A button to display on a Card View. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: action summary: The type of the button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: id summary: Unique Id of the button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: style summary: Controls the style of the button. remarks: The destructive Action style is not supported in Card views - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: title summary: Text displayed on the button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml index 78ad9a11..7f5a449c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IConfirmationDialog summary: Confirmation Dialog option that is passed through `Submit` Action is executed. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: message summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: title summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index e7f5e217..ddfb6f81 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkCardAction summary: Open an external link. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the external link. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is an external link button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml index 1f477abc..e238f58a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkParameters summary: Parameters for opening an external link. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: isTeamsDeepLink summary: Indicates whether this is a Teams Deep Link. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: target summary: The URL of the link. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index 24a233ec..da5ead5e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationAction summary: Interface for Viva Get Location action remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 54795285..11f08291 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get location Action is executed. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: location summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index bed10651..b26e3b57 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationActionParameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: chooseLocationOnMap summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index 38f28644..a2bf7f3d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationCardAction summary: Invoke an `VivaAction.GetLocation` event. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index 3a804782..66c89e57 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: imageUrl summary: The image URL to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index 797238f4..0d3fe670 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocation summary: Interface for location coordinates remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: accuracy summary: Accuracy of the location. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: latitude summary: Latitude of the location. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: longitude summary: Longitude of the location. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: timestamp summary: Timestamp remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml index 36ea9b96..8a87e77e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocationErrorArguments summary: This object represents the error data that the Location action can throw. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: error summary: Error codes specific to the Get Location Error remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml index 328c40f1..8b1957b2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: description summary: The description to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index f072dbe3..b024b3f8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewCardAction summary: Open the quick view. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the quick view opened by this action remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this action opens the quick view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml index 43b12c49..0b4a1ba2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewParameters summary: Parameters for opening a Quick view. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: view summary: The view of the Quick view to open. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index da34ac07..73c146ad 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAction summary: Interface for new Viva Select Media action remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be provided to the ISelectMedia Action remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index ef82a403..185353cb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `SelectMedia` Action is executed. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: data summary: Submit Action data that is passed to internal action handler to ensure forms do not clear. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml index a7147d51..61f576e1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionErrorArguments summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: error summary: Error codes specific to the Select Media Action. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml index cc40544d..758f97ce 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionParameters summary: Parameters that can be supplied with the Viva Select Media Action. remarks: API under active development and not ready for use. - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: allowMultipleCapture summary: Allow multiple images to be selected. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: maxSizePerFile summary: Max file size that can be uploaded. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: mediaType summary: Specify the specific media type that should be selected remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: supportedFileFormats summary: File formats supported for upload. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index 3a9072c6..a9d3b142 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAttachment summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: content summary: Content of the file represented as base64Strings remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: error summary: Error associated with attachment remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: fileName summary: The names of the selected files. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 8760d915..52e0778d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaCardAction summary: Invoke an `VivaAction.SelectMedia` event. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the Select Media Action remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Media button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index 750f2b26..35272400 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` Action is executed. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index a291b0a0..128ddaf2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationAction summary: Interface for Viva Show Location action remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index 1ee051a8..ef68fc7f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationActionParameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: locationCoordinates summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 62f7eb94..5cd24b7d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationCardAction summary: Invoke an `VivaAction.ShowLocation` event. remarks: API under active development and not ready for use. - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index 15e06000..d0096adb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISPFxAdaptiveCard summary: SPFx Adaptive Card Extension schema for Adaptive Cards. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: actions summary: Types of actions being exposed remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index bf9691a0..2c6b58f9 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` Action is executed. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: data summary: The data object defined in the Adaptive Card template remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index c8fa935d..70c67960 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardAction summary: Invoke an `Action.Submit` event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: confirmationDialog summary: Confirmation dialog option passed to the submit handler. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: parameters summary: Parameters passed to the Submit event handler. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: type summary: Indicates this is a Submit button. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml index 7ee1c485..3c9c622a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardParameters summary: Parameters for submit card action. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml index 398a8974..8b1a7ec5 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: MediaType summary: Enum value to specify the type of media. remarks: API under active development and not ready for use. - +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index d1853e83..672f6c29 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -10,7 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `QuickViewNavigator` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ methods: fullName: close() summary: Closes the View. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml index 6d5e51fa..46193b1d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: RenderType summary: '`Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.' remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type RenderType = 'Card' | 'QuickView'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index 7738b592..ff4fd497 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ViewNavigator summary: Manages a stack of views. remarks: The top of the stack represents the currently rendered view. - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' summary: Constructs a new instance of the `ViewNavigator` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: currentId summary: Get the id of the currently rendered View from the top of the View stack remarks: 'If the stack is empty, this will return undefined' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: size summary: Current size of the View stack. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ methods: fullName: 'register(id, initializer)' summary: Registers a new view. remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' - + example: [] isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 8c314cb6..3b12e5c0 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -14,7 +14,7 @@ remarks: >- The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications. - +example: [] isPreview: false isDeprecated: false type: class @@ -31,7 +31,7 @@ constructors: context, for example [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). - + example: [] isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ events: remarks: >- This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has navigated to a new page. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index beeddf8e..42efb081 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: application summary: Provides access to the client-side application that is currently running. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: fullName: dispose() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index d86e6f84..da70bb21 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -12,7 +12,7 @@ remarks: >- Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. - +example: [] isPreview: false isDeprecated: false type: class @@ -23,7 +23,7 @@ properties: fullName: context summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ methods: remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the method. - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index 0af8fb9d..2222f824 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -8,7 +8,7 @@ summary: >- [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) method. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index f79b33e8..83af8427 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderContent` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: If the caller needs to be notified when the DOM element is disposed, use the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback. - + example: [] isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: fullName: isDisposed summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: fullName: name summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: application when the containing placeholder is disposed. Calling dispose() invokes the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index 1a858e28..e4bf15c7 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- For more information about placeholders, see [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index f69809bd..cd43c1ad 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -23,7 +23,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderProvider` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ properties: fullName: isDisposed summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: fullName: placeholderNames summary: Returns the names of the currently available placeholders. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ methods: fullName: dispose() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ methods: The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. - + example: [] isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ events: The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 6fa0a6a4..32490a06 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -7,7 +7,7 @@ summary: The base class for client-side components such as BaseClientSideWebPart remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponent` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value. - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - + example: [] isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: isDisposed summary: Returns true if the component has been already disposed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: fullName: manifest summary: Provides access to the manifest for the client-side component. virtual remarks: Child classes can override this with more specialized manifest types. - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. - + example: [] isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 31aa9387..70d9865c 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponentContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -23,7 +23,7 @@ properties: fullName: aadHttpClientFactory summary: The instance of AadHttpClientFactory created for this instance of component remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: fullName: aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: fullName: dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: fullName: dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -75,7 +75,7 @@ properties: fullName: httpClient summary: The instance of HttpClient created for this instance of component remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - + example: [] isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ properties: fullName: isDisposed summary: Returns true if the context is disposed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: fullName: isServedFromLocalhost summary: Returns true if the solution is being served from localhost remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ properties: fullName: msGraphClientFactory summary: The instance of MSGraphClientFactory created for this instance of component remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -158,7 +158,7 @@ properties: The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -171,7 +171,7 @@ properties: fullName: serviceScope summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. - + example: [] isPreview: false isDeprecated: false syntax: @@ -184,7 +184,7 @@ properties: fullName: spHttpClient summary: The instance of SpHttpClient created for this instance of component remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: fullName: dispose() summary: Disposes the base component context. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 177d049e..d2a74da9 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -7,7 +7,7 @@ summary: >- The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: isDisposed summary: Returns true if the Dynamic Data Provider is disposed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: dispose() summary: Disposes the Dynamic Data Provider. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ methods: fullName: getAvailableSources() summary: Returns a list with all available Dynamic Data Sources. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: registerAvailableSourcesChanged(callback) summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -78,7 +78,7 @@ methods: fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' summary: Registers a callback for updates when a property is changed in a Dynamic Data source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ methods: Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -125,7 +125,7 @@ methods: fullName: tryGetSource(id) summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ methods: fullName: unregisterAvailableSourcesChanged(callback) summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -161,7 +161,7 @@ methods: fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -185,7 +185,7 @@ methods: fullName: 'unregisterSourceChanged(sourceId, callback)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index a93e86d9..fda94fd6 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -8,7 +8,7 @@ summary: >- of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ properties: fullName: isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: fullName: dispose() summary: Disposes the resources held by the Dynamic Data source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ methods: fullName: initializeSource(callableFunctions) summary: Initializes the Dynamic Data Source for the component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ methods: Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index bde0034a..7333568c 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -8,7 +8,7 @@ remarks: >- This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically. - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: '(constructor)(provider, callback)' summary: Create a new DynamicProperty object. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ methods: fullName: hasDefaultCallback() summary: Returns true if the object has a default callback. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -97,7 +97,7 @@ methods: fullName: register(callback) summary: Registers a callback function for updates on the associated DynamicDataSource. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -115,7 +115,7 @@ methods: fullName: removeDefaultCallback() summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. - + example: [] isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ methods: Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: fullName: setValue(value) summary: Sets a static value in the DynamicProperty. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ methods: Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ methods: NOTE: This api will never return an array. To retrieve an array value, use the [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. - + example: [] isPreview: false isDeprecated: false syntax: @@ -210,7 +210,7 @@ methods: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. - + example: [] isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ methods: Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml index 12adbb24..cdec3d93 100644 --- a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IComponentPropertyMetadata summary: This is the structure used for map values for component properties metadata. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -35,7 +35,7 @@ properties: Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. - + example: [] isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 32fe6003..42894413 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyFontStyles summary: '' remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml index 3ba7fbeb..f43a9e83 100644 --- a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml +++ b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyRawStyle summary: '' remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type IReadonlyRawStyle = Readonly; diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 12ae0647..82d6865d 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyTheme summary: Immutable ITheme. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml index 3ce83b32..fe67d541 100644 --- a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ISerializedServerProcessedData summary: Contains collections of data that can be processed by server side services like search index and link fixup remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: } ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: 'myImage2': 'https://res.contoso.com/someName.jpg' } ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: 'myFileLink': 'https://res.contoso.com/file.docx' } ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: } ``` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index a1b25c49..e6ebbf1c 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ITheme summary: 'Collection of theme values, which can be used to programatically style components.' remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index d8906823..f492c2e0 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ThemeChangedEventArgs summary: The object passed when the IThemeProvider.themeChangedEvent is raised. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: theme summary: 'The new theme. If the value is undefined, then the theme was cleared.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index a54d1ec1..e4b2dccf 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -7,7 +7,7 @@ summary: >- The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: '(constructor)(serviceScope, theme)' summary: Construct a new instance of the ThemeProvider class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: serviceKey summary: The service key for ThemeProvider. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ methods: fullName: tryGetTheme() summary: 'If set, get the current scoped theme.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ events: fullName: themeChangedEvent summary: Raised when the theme changes with the new theme as an argument. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 3f2446ae..4a3bdea5 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: DisplayMode summary: Indicates whether a visual control should display itself for reading or for editing. remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index eecbb771..5f63daa7 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Environment summary: Information about the system environment where the SharePoint Framework is running. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: type summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 2ea474b2..d0c0f3e9 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -7,7 +7,7 @@ summary: Indicates the general type of environment where the SharePoint Framewor remarks: >- This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It provides a way to distinguish environments where certain functionality may be limited or disabled. - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/formdisplaymode.yml b/SP-Framework/sp-core-library/formdisplaymode.yml index 13f288c4..2c0be707 100644 --- a/SP-Framework/sp-core-library/formdisplaymode.yml +++ b/SP-Framework/sp-core-library/formdisplaymode.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: FormDisplayMode summary: '' remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 6a93ba06..a6d81f68 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -11,7 +11,7 @@ remarks: >- See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: empty summary: Returns a new empty Guid instance. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: fullName: equals(guid) summary: Compare this instance to another Guid instance remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -121,7 +121,7 @@ methods: fullName: toString() summary: Returns a string representation of the GUID remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 21e9582c..d9ccbd42 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IDisposable summary: Implemented by an object that supports a disposal lifecycle. remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index c762740e..93916995 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -12,7 +12,7 @@ remarks: >- default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable. - +example: [] isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index fbf6d5c9..d0f81a16 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IServiceCollection summary: A shorthand pattern for extracting well-known services from a ServiceScope. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -19,7 +19,7 @@ properties: fullName: serviceScope summary: Returns the underlying ServiceScope that the members belong to. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 78371800..465c9b32 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -11,7 +11,7 @@ remarks: >- SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements. - +example: [] isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: fullName: componentId summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: instanceId summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 2d699790..2f0f6c0d 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -9,7 +9,7 @@ remarks: >- [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. - +example: [] isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index 0a0b5371..a08a630d 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -8,7 +8,7 @@ remarks: >- The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ methods: fullName: 'error(source, error, scope)' summary: Logs an error. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: fullName: 'info(source, message, scope)' summary: Logs a general informational message. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -75,7 +75,7 @@ methods: fullName: 'verbose(source, message, scope)' summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ methods: fullName: 'warn(source, message, scope)' summary: Logs a warning. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 5cb2553b..f11546a5 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -8,7 +8,7 @@ summary: >- [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls Math.random(). remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `RandomNumberGenerator` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: serviceKey summary: The service key for IRandomNumberGenerator. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicecreator.yml b/SP-Framework/sp-core-library/servicecreator.yml index 44bd57c6..e81ec9e9 100644 --- a/SP-Framework/sp-core-library/servicecreator.yml +++ b/SP-Framework/sp-core-library/servicecreator.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: ServiceCreator summary: This is a callback that is used by ServiceKey.createCustom(). remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 11f6e3e3..409b6de2 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -11,7 +11,7 @@ remarks: >- root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: defaultCreator summary: A callback function that constructs the default instance of this service. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes. - + example: [] isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: The system does not assume that this string is unique. Instead, the [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. - + example: [] isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ methods: remarks: >- If you want to specify custom constructor parameters, use [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. - + example: [] isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ methods: fullName: 'createCustom(name, defaultCreator)' summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 7727ee51..09fa004d 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -43,7 +43,7 @@ remarks: >- worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished(). - +example: [] isPreview: false isDeprecated: false type: class @@ -54,7 +54,7 @@ constructors: fullName: (constructor)(parent) summary: Constructs a new instance of the `ServiceScope` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ methods: Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. - + example: [] isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ methods: This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. - + example: [] isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ methods: fullName: getParent() summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -179,7 +179,7 @@ methods: remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. - + example: [] isPreview: false isDeprecated: false syntax: @@ -202,7 +202,7 @@ methods: remarks: >- The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. - + example: [] isPreview: false isDeprecated: false syntax: @@ -218,7 +218,7 @@ methods: Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ methods: NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 56ed22f2..284ab208 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Session summary: Provides access to the application's browser session and active page. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions. - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: clientSideApplicationId summary: The id of the currently running application remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: The concept of a page is subjective and defined by the router for a particular application. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index 5ee2fa6c..d7aa82d2 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -22,7 +22,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPEvent` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -36,7 +36,7 @@ methods: The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: 'remove(observer, eventHandler)' summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 2068956c..0c0d6c54 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: SPEventArgs summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' - +example: [] isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 43d8decd..2eaf1dee 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Text_2 summary: Operations for working with strings that contain text. remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' - +example: [] isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ methods: `Text.format("hello {0}!", "world")` will return `"hello world!"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ methods: fullName: 'replaceAll(input, searchValue, replaceValue)' summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 3ad72aa4..6dd98724 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -7,7 +7,7 @@ summary: >- This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that simply calls the real browser APIs. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `TimeProvider` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: serviceKey summary: The service key for ITimeProvider. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 84dd8eda..76e091aa 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -16,7 +16,7 @@ remarks: >- Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. @@ -28,7 +28,7 @@ constructors: fullName: (constructor)(url) summary: Constructs a new instance of the `UrlQueryParameterCollection` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: getValue('debug') ---> 'false' getValue('lost') ---> undefined ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -84,7 +84,7 @@ methods: getValues('debug') ---> ['false'] getValues('lost') ---> undefined ``` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 39cf943f..643ac440 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -8,7 +8,7 @@ remarks: >- This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance. - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ methods: fullName: 'isNonemptyString(value, variableName)' summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ methods: fullName: 'isNotDisposed(value, className)' summary: Throws an exception if the specified object has been disposed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ methods: fullName: 'isNotNullOrUndefined(value, variableName)' summary: Throws an exception if the specified value is null or undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ methods: fullName: 'isTrue(value, variableName)' summary: Throws an exception if the specified value is not true. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 905d760b..54955dc2 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -11,7 +11,7 @@ remarks: >- Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: major summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases. - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: remarks: >- Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the "build" number. - + example: [] isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: remarks: >- This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers. - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ methods: fullName: 'compare(v1, v2)' summary: Compares two Version objects to determine which version is newer. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -137,7 +137,7 @@ methods: 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -155,7 +155,7 @@ methods: fullName: isValid(versionString) summary: Test whether a string is a valid version specifier. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -181,7 +181,7 @@ methods: 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -199,7 +199,7 @@ methods: fullName: parse(versionString) summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -237,7 +237,7 @@ methods: 1.0.0 satisfies 1.1.0 -> false ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -257,7 +257,7 @@ methods: remarks: >- The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged. - + example: [] isPreview: false isDeprecated: false syntax: @@ -273,7 +273,7 @@ methods: Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index f8dfcc71..e5897c2c 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -12,7 +12,7 @@ remarks: >- controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class. - +example: [] isPreview: false isDeprecated: false type: class @@ -47,7 +47,7 @@ constructors: // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() } ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: remarks: >- See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on rendering. - + example: [] isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ properties: remarks: >- This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - + example: [] isPreview: false isDeprecated: false syntax: @@ -95,7 +95,7 @@ properties: If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: fullName: isSecondary summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - + example: [] isPreview: false isDeprecated: false syntax: @@ -142,7 +142,7 @@ methods: remarks: >- This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - + example: [] isPreview: false isDeprecated: false syntax: @@ -160,7 +160,7 @@ methods: the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - + example: [] isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ methods: This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. virtual remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. - + example: [] isPreview: false isDeprecated: false syntax: @@ -203,7 +203,7 @@ methods: you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. - + example: [] isPreview: false isDeprecated: false syntax: @@ -217,7 +217,7 @@ methods: fullName: show(options) summary: Request the framework to show this dialog. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 037b859a..a9ca2e75 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: Dialog summary: A static class for showing stock dialogs such as an alert or prompt. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index f0776d09..a714c2a7 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IAlertOptions summary: Options for showing an alert dialog remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 506c535c..1a4913ce 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogConfiguration summary: The interface for dialog configuration remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: isBlocking summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index c457dc9b..60ebd707 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogShowOptions summary: Options for showing a dialog remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index db80e8c2..8fad9614 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IPromptOptions summary: Options for showing a prompt dialog remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: defaultValue summary: The default value for the input text field of prompt dialog remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 44923ea8..c5882bd7 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -15,7 +15,7 @@ remarks: >- See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for how to use this. - +example: [] isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ methods: Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ methods: Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ methods: is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index eb51d395..aaa803e4 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -10,7 +10,7 @@ remarks: |- The reference string is of the form `:` or `::` Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(reference) summary: Constructs a new instance of the `DynamicDataReference` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: property summary: Returns the referred property of the Dynamic Data. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: propertyPath summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: reference summary: Returns the full reference of the Dynamic Data object as a string. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: sourceId summary: Returns the referred id of the Dynamic Data Source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index f81c472a..00df95c9 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -7,7 +7,7 @@ summary: >- Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: sampleValue summary: Sample value of a property remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 526a4c6d..82c2f04d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -7,7 +7,7 @@ summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ methods: If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -39,7 +39,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ methods: fullName: getPropertyDefinitions() summary: Returns all the property definitions that the DataSource will provide. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: getPropertyValue(propertyId) summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 23349ff8..cb99692e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -8,7 +8,7 @@ summary: |- It includes the name of the event and description to be seen and used by end users. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the event.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: name summary: Event name remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index eb901142..2f979708 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -7,7 +7,7 @@ summary: >- Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index e6ba2a97..865b79fc 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyMetadata summary: Metadata of a property remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 2baf4fb8..cec346ee 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyValueMetadata summary: Metadata describing the sample value of the property. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index 9aa2d027..ad72cc5e 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -74,7 +74,7 @@ remarks: >- } } ``` - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index f345518d..36f0d714 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -7,7 +7,7 @@ summary: >- Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: id summary: Id of the Dynamic Data Source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: metadata summary: Metadata of the Dynamic Data Source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ methods: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' @@ -89,7 +89,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' @@ -126,7 +126,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' @@ -165,7 +165,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -188,7 +188,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 0db149ad..046d071c 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataSourceMetadata summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the Dynamic Data Source.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ properties: User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 16429f5f..982619f7 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -7,7 +7,7 @@ summary: The base class for all client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseExtension` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization. - + example: [] isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ methods: fullName: onInit() summary: This event method is called when the client-side extension is first activated on the page. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index b2819763..be76c4b0 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -7,7 +7,7 @@ summary: The base class for context objects for client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtensionContext` class. - +example: [] isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 6e71a276..642b915d 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -10,7 +10,7 @@ remarks: >- For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: '(constructor)(serviceScope, resourceEndpoint, options)' summary: Constructs a new instance of the `AadHttpClient` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: fullName: configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - + example: [] isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 0217cb90..3a830c3f 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 6b60d00f..4e2199ce 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadHttpClientFactory` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: serviceKey summary: The service key for AadHttpClientFactory. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml index 997a3597..9ec22382 100644 --- a/SP-Framework/sp-http/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -7,7 +7,7 @@ summary: >- The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends HttpClientResponse adding additional functionality specific to the AadHttpClient. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: '(constructor)(response, tokenFetchRequestTime)' summary: Constructs a new instance of the `AadHttpClientResponse` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 7f2be121..7cb10f04 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -15,7 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadTokenProvider` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -29,7 +29,7 @@ methods: The OAuth2 token should not be cached by the caller since it is already cached by the method itself. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquisition requires user action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 82e5a24b..17c2b48c 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: AadTokenProviderFactory summary: Returns a preinitialized version of the AadTokenProviderFactory. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: serviceKey summary: The service key for AadTokenProviderFactory. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml index 0ba7695c..e24f3a38 100644 --- a/SP-Framework/sp-http/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: BeforeRedirectEventArgs summary: Arguments for before redirecting for a full page authentication remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(redirectUrl, cancel)' summary: Constructs a new instance of the `BeforeRedirectEventArgs` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 43ac3d4e..e164b71a 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -13,7 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `DigestCache` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: fullName: serviceKey summary: The service key for IDigestCache. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -125,7 +125,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 78ca70c2..0799d982 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -7,7 +7,7 @@ summary: >- Typings for the GraphRequest Object For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: _headers summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: _responseType summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: config summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: urlComponents summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ methods: fullName: buildFullUrl() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ methods: fullName: 'constructor(config, path)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: fullName: count(count) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ methods: fullName: 'create(content, callback)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -151,7 +151,7 @@ methods: fullName: del(callback) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ methods: fullName: delete(callback) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -187,7 +187,7 @@ methods: fullName: expand(properties) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -205,7 +205,7 @@ methods: fullName: filter(filterStr) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ methods: fullName: get(callback) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -241,7 +241,7 @@ methods: fullName: getStream(callback) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -259,7 +259,7 @@ methods: fullName: 'header(headerKey, headerValue)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -280,7 +280,7 @@ methods: fullName: headers(headers) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -304,7 +304,7 @@ methods: fullName: orderby(properties) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -322,7 +322,7 @@ methods: fullName: parsePath(rawPath) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ methods: fullName: 'patch(content, callback)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -361,7 +361,7 @@ methods: fullName: 'post(content, callback)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -382,7 +382,7 @@ methods: fullName: 'put(content, callback)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -403,7 +403,7 @@ methods: fullName: 'putStream(stream, callback)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -424,7 +424,7 @@ methods: fullName: query(queryDictionaryOrString) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -448,7 +448,7 @@ methods: fullName: responseType(responseType) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -466,7 +466,7 @@ methods: fullName: select(properties) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -484,7 +484,7 @@ methods: fullName: skip(n) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -502,7 +502,7 @@ methods: fullName: skipToken(token) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -520,7 +520,7 @@ methods: fullName: top(n) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -538,7 +538,7 @@ methods: fullName: 'update(content, callback)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -559,7 +559,7 @@ methods: fullName: version(v) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index b8694933..4953c421 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: HttpClient summary: HttpClient implements a basic set of features for performing REST operations against a generic service. remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `HttpClient` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: configurations summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: serviceKey summary: The service key for HttpClient. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -128,7 +128,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index a8d61ac7..0614c245 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: initializeFlags() summary: Child classes should override this method to initialize the flags object. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index c49dd71f..ef686d3b 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -10,7 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HttpClientResponse` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: fullName: bodyUsed summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: headers summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: fullName: nativeResponse summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: fullName: ok summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: fullName: status summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -86,7 +86,7 @@ properties: fullName: statusText summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -99,7 +99,7 @@ properties: fullName: type summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ properties: fullName: url summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ methods: fullName: arrayBuffer() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ methods: fullName: blob() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -154,7 +154,7 @@ methods: fullName: clone() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -170,7 +170,7 @@ methods: fullName: formData() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -184,7 +184,7 @@ methods: fullName: json() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: fullName: text() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 6b613b33..d1e6bc9a 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 559c95b4..48152dba 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - +example: [] isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index 0282510f..65a00c23 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientOptions summary: Interface for overriding the default behavior of AadHttpClient. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: configuration summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' @@ -30,7 +30,7 @@ properties: fullName: tokenProvider summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' @@ -44,7 +44,7 @@ properties: fullName: useCachedToken summary: Allows the developer to specify if cached tokens should be use for the current request. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 0eefea69..79ee9cf5 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -13,7 +13,7 @@ remarks: >- AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL. - +example: [] isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ methods: An example of a resourceEndpoint would be https://sdfpilot.outlook.com remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquistion requires user action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index 02ebbf22..66c7042a 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadTokenProviderConfiguration summary: Required strings for constructing an AadTokenProvider. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: aadInstanceUrl summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: aadSessionId summary: The current Azure Active Directory's session id. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: aadTenantId summary: The Azure Active Directory's tenant id. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: servicePrincipalId summary: The client ID of the developer's Azure Active Directory application. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead @@ -117,7 +117,7 @@ properties: tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml index f71a0693..7918d5bd 100644 --- a/SP-Framework/sp-http/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IBeforeRedirectEventArgs summary: Represents arguments used before redirecting event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 6b93c457..43b68a33 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -13,7 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index c47153d4..4071f3b9 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index f0134853..77f7e2b3 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - +example: [] isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index 806932f9..d5f7ca63 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -7,7 +7,7 @@ summary: Options for HttpClient remarks: >- This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 682b36c3..8a3c049d 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchConfiguration summary: Flags interface for SPHttpClientBatchConfiguration. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index cd02fa14..13073937 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - +example: [] isPreview: true isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: fullName: v1 summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 2c4eeeec..b12fd531 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchCreationOptions summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index d2ac62c7..4e39f93b 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -7,7 +7,7 @@ summary: >- This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index 07fb8754..f9f21f72 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientCommonConfiguration summary: Flags interface for SPHttpClientCommonConfiguration remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index c6029b69..47c0f89d 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientConfiguration summary: Flags interface for SPHttpClientConfiguration. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - + example: [] isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - + example: [] isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 3f373dd9..0d21272d 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - +example: [] isPreview: false isDeprecated: false type: interface @@ -25,7 +25,7 @@ properties: consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 93b34554..2a35790a 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -7,7 +7,7 @@ summary: >- This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index ca0939ca..8b22569d 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ITokenAcquisitionEventArgs summary: Represents arguments used for raising a token acquisiton failure event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to interact with Azure AD. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 5fa26570..4c017214 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -17,7 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClient` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 6e028471..fda63f07 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientFactory` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: serviceKey summary: The service key for MSGraphClientFactory. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. Returns version 1 by default. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: 'Use getClient(''1'') instead, which has the same implementation but specifies the version explicitly.' @@ -56,7 +56,7 @@ methods: Service Principal. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: Returns an instance of version 3 the MSGraphClient V3 that communicates with the current tenant's configurable Service Principal. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientv3.yml b/SP-Framework/sp-http/msgraphclientv3.yml index b496ed36..335e71f8 100644 --- a/SP-Framework/sp-http/msgraphclientv3.yml +++ b/SP-Framework/sp-http/msgraphclientv3.yml @@ -17,7 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientV3` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index bf4b584b..4a96308d 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ODataVersion summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: v3 summary: Represents version 3.0 for the "OData-Version" header remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: v4 summary: Represents version 4.0 for the "OData-Version" header remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ methods: fullName: toString() summary: 'Returns the "OData-Version" value, for example "4.0".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ methods: remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 44f274cd..ab624ee7 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -10,7 +10,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `SPHttpClient` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: serviceKey summary: The service key for SPHttpClient. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ methods: fullName: '_fetch(url, configuration, options)' summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ methods: fullName: beginBatch(batchCreationOptions) summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -133,7 +133,7 @@ methods: obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -165,7 +165,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ methods: If the URL cannot be determined, an exception is thrown. - + example: [] isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 0ca41b92..8d784750 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -15,7 +15,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPHttpClientBatch` class. - +example: [] isPreview: true isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -40,7 +40,7 @@ methods: fullName: execute() summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ methods: SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly. - + example: [] isPreview: true isDeprecated: false syntax: @@ -102,7 +102,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''GET''.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -134,7 +134,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''POST''.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 9a05ba91..90a5793b 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method. - +example: [] isPreview: true isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 9656a10a..35f29ea3 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpClientCommonConfiguration summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: flags summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - + example: [] isPreview: false isDeprecated: false syntax: @@ -95,7 +95,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index f8d01b40..4c28af0b 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: flags summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - + example: [] isPreview: false isDeprecated: false syntax: @@ -114,7 +114,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index 8f41cee5..ce02fd35 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(response) summary: Constructs a new instance of the `SPHttpClientResponse` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header. - + example: [] isPreview: true isDeprecated: false syntax: @@ -52,7 +52,7 @@ methods: fullName: clone() summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 94b346d7..f190da95 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpHeader summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' remarks: '' - +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 04f4ed44..d9aeafb8 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: TokenAcquisitionEventArgs summary: Arguments for a token acquisition failure event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(message, redirectUrl)' summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to perform Multi Factor Authentication remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 16d864be..7a205135 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: IImageHelperRequest summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint. - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: sourceUrl summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: width summary: Width of the image requested. remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 3b69fa35..034e548f 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: ImageHelper summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ methods: - The url will be most performant if only a width is provided. If a height is provided, the image will take longer to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 0a25ab34..90c50b96 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -12,7 +12,7 @@ summary: >- In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and the current domain, site and web will be used. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: fullName: callbacks summary: the list of callbacks remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: fullName: domain summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: fullName: listId summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current site will be used. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web will be used. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index fd55ce35..517074d1 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: IListSubscription summary: A subscription to a SharePoint list resource. Contains the id of the subscription. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: The id of the subscription. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index cc1390b0..54eecff9 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: ISubscriptionCallbacks summary: The callbacks that can be triggered by a subscription event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: connect summary: The callback to invoke when a connection has been made to the list. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disconnect summary: The callback to invoke when the subscription is disconnected from the list. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: notification summary: The callback to invoke when a change occurs in the list. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index abee5bb4..712117d4 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -7,7 +7,7 @@ summary: >- Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the subscription to handle subscription events. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: (constructor)(component) summary: Constructs a new instance of the `ListSubscriptionFactory` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: fullName: createSubscription(settings) summary: Creates a connection to the list specified by the site id and list id. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ methods: fullName: deleteSubscription(subscription) summary: Deletes the subscription's connection to the resource. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 73e9f567..22784ff8 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -10,7 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "FieldCustomizer". remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: fullName: onDisposeCell(event) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: fullName: onRenderCell(event) summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml index 53d57dce..bb7df5eb 100644 --- a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -7,7 +7,7 @@ summary: >- This is the base class that third parties should extend when implementing a client-side extension that provides a custom list form (display, new, edit) for a SharePoint list. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: displayMode summary: 'Display mode of the form: Edit, Display or New.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole DOM subtree of the form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ methods: fullName: dispose() summary: Disposes the component. remarks: 'Please, do not override this method. Override the `onDispose` method instead.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ methods: fullName: formClosed() summary: Call this method after the form has been closed/cancelled to inform the application that the form has been closed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ methods: fullName: formSaved() summary: Call this method after the form has been saved to inform the application that the form has been saved. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ methods: This API is called to render the form. There is no base implementation of this API and the form is required to override this API. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 16dbae19..0807a241 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseListViewCommandSet` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ methods: This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: onListViewUpdated(event) summary: This event occurs whenever the ListView state changes. virtual remarks: This event allows the implementor to tailor the visibility of the command. - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: Use context.listView.listViewStateChangedEvent instead. @@ -79,7 +79,7 @@ methods: fullName: raiseOnChange() summary: Use this method to fire OnChange event and initialize a reflow of the ListView. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: fullName: tryGetCommand(id) summary: Returns the command with the given id. Returns undefined if there is not command with the given id. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index d1be986f..6d3d387d 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -14,7 +14,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ColumnAccessor` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: fullName: field summary: The server-side definition of the field. This property is read-only. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: fullName: visible summary: Whether to show this column in the list view. This property is read-only. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 03b18054..8722ad8a 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -11,7 +11,7 @@ remarks: >- [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command's appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. - +example: [] isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: disabled summary: Whether the command is currently disabled. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. - + example: [] isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: id summary: Id of the command. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension. - + example: [] isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: visible summary: True if the command is visible. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 990d6cae..f2d89b85 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -7,7 +7,7 @@ summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FieldCustomizerContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: field summary: Provides access to the SharePoint field that the customizer will operate on. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: remarks: >- Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml index 9ffe940d..0238dd0f 100644 --- a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: FormCustomizerContext summary: Form Customizer Context. This object contains contxtual services and properties for the form. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' summary: Constructs a new instance of the `FormCustomizerContext` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: contentType summary: The content type associated with the form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: domElement summary: The root DOM element of the form. This is a DIV element container for the custom form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: folderInfo summary: The folder information where the item is located/should be created. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: itemId summary: The item id of the item being edited or viewed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: list summary: The list associated with the form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml index 787a6227..7796fa74 100644 --- a/SP-Framework/sp-listview-extensibility/icolumn.yml +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IColumn summary: Provides information about the state of a column in the list view remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: isVisible summary: Whether the column is visible in the view remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icontenttype.yml b/SP-Framework/sp-listview-extensibility/icontenttype.yml index 3dc6a33e..7331bf81 100644 --- a/SP-Framework/sp-listview-extensibility/icontenttype.yml +++ b/SP-Framework/sp-listview-extensibility/icontenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IContentType summary: Provides information about the content type remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: Content type string id remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: name summary: Content type name remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: schemaXml summary: Content type schema XML remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 1eb002d9..2a0262c1 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFieldCustomizerCellEventParameters summary: Event parameters for BaseFieldCustomizer.onRenderCell() remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: fieldValue summary: The value of the field being rendered. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: listItem summary: The list item being edited. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml index 2740cd14..16c0b7f3 100644 --- a/SP-Framework/sp-listview-extensibility/ifilter.yml +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFilter summary: Provides information about the state of the filters applied to the ListView. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: fieldName summary: Field name to filter on. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: values summary: Values to filter on. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml index 39ec33a1..0418a3f3 100644 --- a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFolderInfo summary: Provides information about the state of the folder in the ListView. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: folderPath summary: Folder path. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml index 2aaceb35..88deb6bd 100644 --- a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFormCustomizerContext summary: FormCustomizerContext-specific properties. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: contentType summary: The content type associated with the form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: domElement summary: The root DOM element of the form. This is a DIV element container for the custom form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: folderInfo summary: The folder information where the item is located/should be created. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: itemId summary: The item id of the item being edited or viewed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: list summary: The list associated with the form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml index 2bdb14be..6b76e9d6 100644 --- a/SP-Framework/sp-listview-extensibility/ilist.yml +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IList summary: Provides information about the list rendered by the ListView. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: guid summary: List id. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: serverRelativeUrl summary: List server relative url. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: List title. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml index 27199457..e3abce4c 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IListViewAccessorState summary: Provides information about the state of the ListView. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: appliedFilters summary: Applied filters information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: columns summary: Columns information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: folderInfo summary: Current folder information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: fullName: list summary: List information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: rows summary: Rows information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: selectedRows summary: Selected rows information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: sortAscending summary: Sort direction. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: sortField summary: Sort field name. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: view summary: View information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index d4e72488..08711f5d 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -7,7 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 7ddfaee6..1ef89678 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -7,7 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml index 2ef0cf5f..292be738 100644 --- a/SP-Framework/sp-listview-extensibility/irow.yml +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IRow summary: Provides information about the list item's state rendered by the ListView. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: A map of column values for the row. They key is the column internal name and the value is its corresponding value in the row. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml index 76fc06f1..52cc3cf2 100644 --- a/SP-Framework/sp-listview-extensibility/iview.yml +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IView summary: Provides information about the view rendered by the ListView. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: View id. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: title summary: View title. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: url summary: View server relative url. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index f60ab4d0..6474d853 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -18,7 +18,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListItemAccessor` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -32,7 +32,7 @@ properties: The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type. - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ methods: Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 2b2f2241..82db4243 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -7,7 +7,7 @@ summary: Provides access to a SharePoint ListView control. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewAccessor` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: appliedFilters summary: Filters applied to the list view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: columns summary: 'The columns in associated with this view, including hidden columns.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: folderInfo summary: Folder information for the list view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: list summary: Basic information about the list rendered by the list view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: rows summary: Currently rendered rows in the list view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: selectedRows summary: Selected rows in the list view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -102,7 +102,7 @@ properties: fullName: sortAscending summary: Specifies whether the list view is sorted ascending or descending. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -115,7 +115,7 @@ properties: fullName: sortField summary: Sort field name remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -128,7 +128,7 @@ properties: fullName: view summary: Basic information about the view rendered by the list view. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ methods: Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ events: fullName: listViewStateChangedEvent summary: Event that gets raised every time the list view state changes. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -178,7 +178,7 @@ events: fullName: selectedRowsChangedEvent summary: Event that gets raised every time the selected items in the list view change. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml index 5051434f..bfd43c03 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewAccessorStateChanges summary: Describes the type of list view state changes. remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index ab7fcfbe..fdbd44da 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -7,7 +7,7 @@ summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewCommandSetContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: listView summary: Provides access to the ListView control that the customizer will operate on. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml index d63dfa05..08bf585d 100644 --- a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewStateChangedEventArgs summary: Arguments for the list view state changed event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: prevState summary: Previous state of the ListView. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: stateChanges summary: Changes that were made to the ListView state. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 8f09316c..8443c4b5 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -15,7 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RowAccessor` class. - +example: [] isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index a67de530..bf56480c 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: SelectedRowsChangedEventArgs summary: Arguments for the selected rows changed event. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: selectedRows summary: The list of rows that were selected in the list view at the time when the event was fired. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index b514a0e5..72fc2f1b 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: ILoadScriptOptions summary: Options for the loadScript() method in ISPComponentLoader remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: globalExportsName summary: 'If set, the loaded script will be stored in a global variable under this name.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index a0de13b8..583aec40 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: SPComponentLoader summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ methods: fullName: getManifests() summary: Returns static copies of all the manifests. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: this method will be removed in a future release. @@ -31,7 +31,7 @@ methods: fullName: loadComponent(manifest) summary: Loads a component from a manifest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ methods: fullName: 'loadComponentById(id, version)' summary: 'Resolve a component id and version, and load it.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ methods: fullName: loadCss(url) summary: Inserts a `` tag for a stylesheet. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not be propagated. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-lodash-subset/cancelable.yml b/SP-Framework/sp-lodash-subset/cancelable.yml index 587f3078..f9271d4e 100644 --- a/SP-Framework/sp-lodash-subset/cancelable.yml +++ b/SP-Framework/sp-lodash-subset/cancelable.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-lodash-subset!' fullName: Cancelable summary: '' remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type Cancelable = Cancelable2; diff --git a/SP-Framework/sp-lodash-subset/throttlesettings.yml b/SP-Framework/sp-lodash-subset/throttlesettings.yml index 4b3aa96b..bac184b0 100644 --- a/SP-Framework/sp-lodash-subset/throttlesettings.yml +++ b/SP-Framework/sp-lodash-subset/throttlesettings.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-lodash-subset!' fullName: ThrottleSettings summary: '' remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type ThrottleSettings = ThrottleSettings2; diff --git a/SP-Framework/sp-module-interfaces/componenttype.yml b/SP-Framework/sp-module-interfaces/componenttype.yml index e424082d..4d28b44b 100644 --- a/SP-Framework/sp-module-interfaces/componenttype.yml +++ b/SP-Framework/sp-module-interfaces/componenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: ComponentType summary: Type of client-side component. remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension'; diff --git a/SP-Framework/sp-module-interfaces/extensiontype.yml b/SP-Framework/sp-module-interfaces/extensiontype.yml index 6a9709e1..14ff642a 100644 --- a/SP-Framework/sp-module-interfaces/extensiontype.yml +++ b/SP-Framework/sp-module-interfaces/extensiontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: ExtensionType summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index 9495db4c..0803ef19 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IAdaptiveCardExtensionManifest summary: '' remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: connectedSPFXAppId summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: connectedTeamsAppId summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: experimentalData summary: An untyped property bag for experimental flags not ready for production. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way. - + example: [] isPreview: true isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: } }] ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: fullName: supportedHosts summary: 'Definition: An array defining what host types are supported' remarks: 'Usage: Use this array to define all hosts that are supported.' - + example: [] isPreview: true isDeprecated: false syntax: @@ -149,7 +149,7 @@ properties: variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no ACEs support theme variants. - + example: [] isPreview: true isDeprecated: false syntax: @@ -170,7 +170,7 @@ properties: By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized logic, then it is recommended to override onAfterPropertiesUpdatedExternally. - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index bacd9f22..ebb55270 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -8,7 +8,7 @@ summary: >- pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes \["Medium", "Large"\] defined in the sp-adaptive-card-base project. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: Example: `"1.0"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -160,7 +160,7 @@ properties: Example: "graph" - + example: [] isPreview: true isDeprecated: false syntax: @@ -185,7 +185,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -201,7 +201,7 @@ properties: group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - + example: [] isPreview: true isDeprecated: false syntax: @@ -238,7 +238,7 @@ properties: "zh": "我的 web 部件" } ``` - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 47f1ef75..2c66fcb9 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideAssemblyManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: Supported values: any GUID Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 1e47ead0..3f20b018 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. It contains all data for loading an entrypoint script and its dependency scripts. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"myApplication.bundle"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Example: `mySpWebpart` - + example: [] isPreview: true isDeprecated: false syntax: @@ -95,7 +95,7 @@ properties: Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` - + example: [] isPreview: true isDeprecated: false syntax: @@ -147,7 +147,7 @@ properties: } } ``` - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index bdc313ef..acec9040 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -21,7 +21,7 @@ remarks: >- - The `'manifestVersion'` should be bumped for all small or big changes. - +example: [] isPreview: false isDeprecated: false type: interface @@ -40,7 +40,7 @@ properties: Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, `"AdaptiveCardExtension"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: Usage: Loading a component. See `IClientSideComponentLoaderConfiguration` for more information and examples. - + example: [] isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts build after using spfx 1.1 don't need this. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: Usage: Requires Custom Script to be allowed in order for this component to be installed and run. - + example: [] isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: safeWithCustomScriptDisabled summary: This property is provided for backwards compatibility. It no longer has any effect. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. @@ -165,7 +165,7 @@ properties: Example: `"1.0.0"` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index 26180f8c..d4d7999b 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideExtensionManifest summary: This is the manifest for a client-side extension. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index ef8494c0..b030c628 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideLibraryManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index 18cb0af2..5990ff09 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideManifestBase summary: This interface defines members that are common between all deployable manifests. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: Example: `1` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 66580cc8..ad229c00 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -12,7 +12,7 @@ remarks: >- some required properties in the manifest and some optional properties. Optional properties need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and functionality problems. - +example: [] isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: fullName: canUpdateConfiguration summary: Indicates whether the web part uses the property pane to update the configuration of the web part. remarks: Default value is `true` if the property is not explicitly defined. - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: remarks: >- Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If this flag is true, the web part will not appear in the classic page web part gallery. - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts can be provisioned on pages though API or be added to the page in a pre configured way. - + example: [] isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module url - + example: [] isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ properties: } }] ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -134,7 +134,7 @@ properties: SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp cannot be used with TeamsTab or TeamsPersonalTab. - + example: [] isPreview: false isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed experiences require special treatment and testing. By default no web parts support full bleed experiences. - + example: [] isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ properties: variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no web parts support theme variants. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index f494d54a..10fd2d30 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -8,7 +8,7 @@ summary: >- instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -36,7 +36,7 @@ properties: Example: `"1.0"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' - + example: [] isPreview: true isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -158,7 +158,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -183,7 +183,7 @@ properties: Example: "graph" - + example: [] isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ properties: This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - + example: [] isPreview: true isDeprecated: false syntax: @@ -259,7 +259,7 @@ properties: "zh": "我的 web 部件" } ``` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 27835310..54671bd9 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideWebPartManifestInstance summary: Manifest that is relevant to a Web Part instance. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index fe94cf0b..b7bfd964 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -7,7 +7,7 @@ summary: >- Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). - + example: [] isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: fullName: title summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: type summary: Type of the item. Currently only "command" is allowed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index b2d29568..ec2fb4aa 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -7,7 +7,7 @@ summary: >- This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: remarks: >- The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 1b9d4f6b..588cc149 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This is the interface for a script module with the "component" type. Modules of this type will be provided via manifests. In order for the dependency to be loaded, the manifest must be available on the site. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: Supported values: string representing a component's ID. Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: type summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: Supported values: string representing a [semantic version](http://semver.org), or "latest". Example: `"2.2.4"` - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iintegritypath.yml b/SP-Framework/sp-module-interfaces/iintegritypath.yml index 8cc60747..26aa101d 100644 --- a/SP-Framework/sp-module-interfaces/iintegritypath.yml +++ b/SP-Framework/sp-module-interfaces/iintegritypath.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IIntegrityPath summary: A path with the subresource integrity hash of the resource. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: The subresource integrity hash of the resource referenced in [IIntegrityPath.path](xref:@microsoft/sp-module-interfaces!IIntegrityPath%23path:member). remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: path summary: The path to the resource. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index c43eb21d..2c6ccf86 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -8,7 +8,7 @@ remarks: >- Modules of this type must be provided by the component developer. These script resources are similar to those of the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as "internal" modules are. - +example: [] isPreview: true isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" } ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: fullName: type summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index e97eb4c8..bd2d777e 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -46,7 +46,7 @@ remarks: >- For more complex cases, run an appropriate expression to access your resource and return the string. - +example: [] isPreview: false isDeprecated: false type: interface @@ -57,7 +57,7 @@ properties: fullName: default summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: id summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index ba7c1e51..7b077d49 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfiguration summary: '' remarks: '' - +example: [] isPreview: true isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml index 2b78f22e..6574d072 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfigurationBase summary: This is the base interface for a script module's definition. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: Usage: Instructs the module loader to not preload this module. - + example: [] isPreview: true isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: Example: `"localized"` - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 24aef5fe..f892b365 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This is the interface for a script module with the "path" type. Modules of this type must be provided by the component developer. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: Example: `["jquery"]` - + example: [] isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Example: `"$"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - + example: [] isPreview: true isDeprecated: false syntax: @@ -101,7 +101,7 @@ properties: fullName: type summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index f16746fc..c886cd6a 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: PredefinedGroup summary: Predefined web part group. remarks: '' - +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 52a34924..982a63f3 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: NameId summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: NameIdIssuer summary: 'Example: `"urn:office:idp:activedirectory"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 064cd12b..898f9f8c 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataBasePermission summary: Data used for creating a SPPermission object. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: High summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: Low summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index 6166cb38..d1a7818a 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: StringValue summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml index 2313fd7c..2b18c53d 100644 --- a/SP-Framework/sp-odata-types/iodatacontenttype.yml +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataContentType summary: Represents OData SP.ContentType object. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ClientFormCustomFormatter summary: Custom formatter (JSON) for the content type forms remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: Description summary: Content type description remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: DisplayFormUrl summary: Content type display form URL remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: EditFormUrl summary: Content type edit form URL remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: Group summary: Content type group remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: Id summary: Content type ID remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: Name summary: Content type name remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: NewFormUrl summary: Content type new form URL remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: fullName: ReadOnly summary: Specifies whether content type is read-only remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -133,7 +133,7 @@ properties: fullName: SchemaXml summary: Content type schema XML remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ properties: fullName: StringId summary: Content type string id remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 1e6e60f5..1914ab25 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: LibraryVersion summary: 'Example: `"16.0.4919.3000"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: SiteFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: SupportedSchemaVersions summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: WebFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml index ad16f5b2..b328ab33 100644 --- a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataFormsClientSideConfiguration summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: DislpayFormClientSideDisplayTarget summary: 'Display Form display target (new tab, panel)' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: DisplayFormClientSideComponentId summary: Display Form Customizer component id remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: DisplayFormClientSideComponentProperties summary: Display Form Customizer component properties remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: EditFormClientSideComponentId summary: Edit Form Customizer component id remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: EditFormClientSideComponentProperties summary: Edit Form Customizer component properties remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: EditFormClientSideDisplayTarget summary: 'Edit Form display target (new tab, panel)' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: NewFormClientSideComponentId summary: New Form Customizer component id remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: NewFormClientSideComponentProperties summary: New Form Customizer component properties remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: fullName: NewFormClientSideDisplayTarget summary: 'New Form display target (new tab, panel)' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index d0289260..792fd292 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: BaseTemplate summary: The list definition type on which the list is based. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Created summary: 'Example: `"/Date(1453294804000)/"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: CurrentChangeToken summary: The change token that will be used in logging the next change to the list. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: Description summary: A description of the List. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: EntityTypeName summary: 'Example: `"MyListTitleList"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: Id summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: LastItemDeletedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: fullName: LastItemModifiedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -137,7 +137,7 @@ properties: fullName: ListItemEntityTypeFullName summary: 'Example: `"SP.Data.MyListTitleListItem"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: fullName: ParentWebUrl summary: 'Example: `"/sites/PubSite"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ properties: fullName: TemplateFeatureId summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ properties: fullName: Title summary: 'Example: `"Pages"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index e5fdedfa..9dc55986 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: ContentTypeId summary: 'Example: `{ StringValue: "0x010100C5..." }`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: ID summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: Title summary: Title of the List Item remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: UniqueId summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 22b8eccf..7f9fd50d 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.NavigationNode object. [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: Children summary: Gets or sets an array of Navigation Nodes that are children to the current node. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Id summary: Gets a value that specifies the identifier for the navigation node. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: IsDocLib summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: IsVisible summary: Gets or sets a value that specifies if the node navigation link should be visible. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: Title summary: Gets or sets a value that specifies the anchor text for the node navigation link. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 16073e68..ec5b1d3f 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: quickLaunch summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: topNav summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index df984001..cde911b1 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: Email summary: 'Example: `"someone@example.com"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Id summary: '' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: IsSiteAdmin summary: Boolean value that specifies whether the user is a site collection administrator. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: LoginName summary: 'Example: `"i:0#.w|domain\user"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: SharePointGroup: 8 All: 15 - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: Title summary: 'Example: `"DOMAIN\user"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index b6830dd1..af02f1ab 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -8,7 +8,7 @@ summary: >- here: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: ClientSideComponentId summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: Example: `"{ \"maxItemsToShow\": 123 }"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: Description summary: Gets or sets the description of the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: ImageUrl summary: Gets or sets the URL of the image associated with the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: Location summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: RegistrationId summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: remarks: >- Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4. - + example: [] isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ properties: fullName: Rights summary: Gets or sets the value that specifies the permissions needed for the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ properties: fullName: Scope summary: Gets a value that specifies the scope of the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ properties: fullName: ScriptBlock summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -202,7 +202,7 @@ properties: fullName: ScriptSrc summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -217,7 +217,7 @@ properties: Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -230,7 +230,7 @@ properties: fullName: Title summary: Gets or sets the display title of the custom action. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ properties: fullName: Url summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -256,7 +256,7 @@ properties: fullName: VersionOfUserCustomAction summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 2fb1f356..2bff7eea 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: Example: `"/Date(2016,0,20,12,58,7,0)/"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: CurrentChangeToken summary: Represents the unique sequential location of a change within the change log. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: Description summary: Gets or sets the description for the site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: fullName: IsMultilingual summary: Value that represents if the web was remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: Example: `1033` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: Example: `"/Date(1453618828000)/"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: fullName: NoCrawl summary: Determines if a particular web will be crawled by search or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -166,7 +166,7 @@ properties: fullName: QuickLaunchEnabled summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -179,7 +179,7 @@ properties: fullName: RecycleBinEnabled summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -195,7 +195,7 @@ properties: Example: `"/sites/PubSite"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: fullName: SiteLogoUrl summary: Gets the url for the logo of this particular site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -221,7 +221,7 @@ properties: fullName: Title summary: The title of the web. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -237,7 +237,7 @@ properties: Example: `15` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -253,7 +253,7 @@ properties: Example: `"http://example.com/sites/PubSite"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ properties: Example: `"BLANKINTERNET"` remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 6c4e493f..5a828f3e 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CultureInfo` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -27,7 +27,7 @@ properties: Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the date as 1/8 instead of 8/1. - + example: [] isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to translate the word "hello" to "hola". - + example: [] isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: isRightToLeft summary: This boolean represents the dominant direction of written text for the default user interface language. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index f32298e2..b17520e3 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPSystemTime summary: Interface that represents a `SPSystemTime` structure. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: Day summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: DayOfWeek summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: Hour summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: Milliseconds summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: Minute summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: Month summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: Second summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: Year summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 16f17551..24c4dfaa 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPTimeZoneData summary: Interface that represents the data necessary to build an `TimeZone` object. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: daylightDate summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: daylightOffset summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: description summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: id summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: offset summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: standardDate summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: standardOffset summary: '' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 6c91922f..ad7057bb 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -8,7 +8,7 @@ remarks: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. - +example: [] isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `PageContext` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: isInitialized summary: Returns whether the `PageContext` has been initialized. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object. - + example: [] isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -118,7 +118,7 @@ properties: Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ properties: fullName: serviceKey summary: The service key for PageContext. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ properties: fullName: site summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -161,7 +161,7 @@ properties: It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -174,7 +174,7 @@ properties: fullName: web summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spdayofweek-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml index d5853a3d..377eec5f 100644 --- a/SP-Framework/sp-page-context/spdayofweek-typealias.yml +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: SPDayOfWeek summary: The type members represent the seven days of a week. remarks: '' - +example: [] isPreview: true isDeprecated: false syntax: 'export declare type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 8885dcdb..5c163c3f 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -11,7 +11,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPField` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -102,7 +102,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 6d78d688..97e758e5 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPList` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' - + example: [] isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: title summary: Returns the title for this `SPList`. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 47b0ce7c..6a1d03ff 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPListItem` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: id summary: The number that identifies the `SPListItem` on the server. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 3ba1704a..a35cd9fd 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -10,7 +10,7 @@ remarks: >- For more information, see: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(value) summary: Constructs a new instance of the `SPPermission` class remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation-compatible editor. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: fullName: addDelPrivateWebParts summary: Add or remove personal web parts on a web part Page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: addListItems summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -78,7 +78,7 @@ properties: fullName: applyStyleSheets summary: Apply a style sheet (.css file) to the Web site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ properties: fullName: applyThemeAndBorder summary: Apply a theme or borders to the entire Web site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ properties: fullName: approveItems summary: Approve a minor version of a list item or document. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: fullName: browseDirectories summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: browserUserInfo summary: View information about users of the Web site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ properties: fullName: cancelCheckout summary: Discard or check in a document which is checked out to another user. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -156,7 +156,7 @@ properties: fullName: createAlerts summary: Create e-mail alerts. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ properties: fullName: createGroups summary: Create a group of users that can be used anywhere within the site collection. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -182,7 +182,7 @@ properties: fullName: createSSCSite summary: Create a Web site using Self-Service Site Creation. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -195,7 +195,7 @@ properties: fullName: deleteListItems summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: fullName: deleteVersions summary: Delete past versions of a list item or document. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ properties: Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -236,7 +236,7 @@ properties: fullName: editMyUserInfo summary: 'Allows a user to change his or her user information, such as adding a picture.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -249,7 +249,7 @@ properties: fullName: emptyMask summary: Has no permissions on the Web site. Not available through the user interface. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -262,7 +262,7 @@ properties: fullName: enumeratePermissions summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -275,7 +275,7 @@ properties: fullName: fullMask summary: Has all permissions on the Web site. Not available through the user interface. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -288,7 +288,7 @@ properties: fullName: layoutsPage summary: View the layouts page? remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -301,7 +301,7 @@ properties: fullName: manageAlerts summary: Manage alerts for all users of the Web site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -314,7 +314,7 @@ properties: fullName: manageLists summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -327,7 +327,7 @@ properties: fullName: managePermissions summary: Create and change permission levels on the Web site and assign permissions to users and groups. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ properties: fullName: managePersonalViews summary: 'Create, change, and delete personal views of lists.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -353,7 +353,7 @@ properties: fullName: manageSubwebs summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -371,7 +371,7 @@ properties: of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. - + example: [] isPreview: false isDeprecated: false syntax: @@ -384,7 +384,7 @@ properties: fullName: open summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -397,7 +397,7 @@ properties: fullName: openItems summary: View the source of documents with server-side file handlers. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -410,7 +410,7 @@ properties: fullName: updatePersonalWebParts summary: Update web parts to display personalized information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -423,7 +423,7 @@ properties: fullName: useClientIntegration summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -436,7 +436,7 @@ properties: fullName: useRemoteAPIs summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -449,7 +449,7 @@ properties: fullName: value summary: Returns the value of this SPPermission object remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -462,7 +462,7 @@ properties: fullName: viewFormPages summary: 'View forms, views, and application pages, and enumerate lists.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -475,7 +475,7 @@ properties: fullName: viewListItems summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -488,7 +488,7 @@ properties: fullName: viewPages summary: View pages in a Web site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -501,7 +501,7 @@ properties: fullName: viewUsageData summary: View reports on Web site usage. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -514,7 +514,7 @@ properties: fullName: viewVersions summary: View past versions of a list item or document. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -528,7 +528,7 @@ methods: fullName: hasAllPermissions(requestedPerms) summary: Function for testing whether a given permission mask has all of the requested permissions. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -546,7 +546,7 @@ methods: fullName: hasAnyPermissions(requestedPerms) summary: Function for testing whether a given permission mask has any of the requested permissions. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -564,7 +564,7 @@ methods: fullName: hasPermission(requestedPerm) summary: Function for testing whether a given permission mask has the requested permission. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index ce9786e7..f42ff584 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPSite` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: absoluteUrl summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: cdnPrefix summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: classification summary: Returns the classification of the site. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: correlationId summary: Returns the correlation id to the current server request. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: id summary: The GUID that identifies the SPSite on the server. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: isNoScriptEnabled summary: Returns true if isNoScript has been enabled on the SPSite. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: recycleBinItemCount summary: The amount of items in the recycle bin. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' - + example: [] isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ properties: fullName: serverRequestPath summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' - + example: [] isPreview: false isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: fullName: sitePagesEnabled summary: Returns true if SitePages are enabled on this SPSite. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index dd7fba10..932ac3ec 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -19,7 +19,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPTimeZone` class. - +example: [] isPreview: true isDeprecated: false type: class @@ -30,7 +30,7 @@ properties: fullName: daylightDate summary: Gets the date on which daylight time begins for the time zone. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC). remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: description summary: Gets the description for the time zone. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: id summary: Gets the ID of the time zone. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -84,7 +84,7 @@ properties: fullName: offset summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -97,7 +97,7 @@ properties: fullName: standardDate summary: Gets the date on which standard time begins for the time zone. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -112,7 +112,7 @@ properties: Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC). remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 7aee725b..ab618111 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPUser` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: displayName summary: The display name for the current user. remarks: 'Example: `"John Doe"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: email summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: isAnonymousGuestUser summary: Returns if the current user is an anonymous guest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: isExternalGuestUser summary: Returns true if the current user is an external guest. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: loginName summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: preferUserTimeZone summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: timeZoneInfo summary: Returns the user's regional timezone settings or undefined if they haven't been set. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index d83c54d6..8a9e9892 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPWeb` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: absoluteUrl summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: description summary: Returns the description of the current SPWeb. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: id summary: The GUID that identifies the SPWeb on the server. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: isAppWeb summary: Returns true if this `SPWeb` the container web for an `SPApp`. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: language summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: languageName summary: Returns the language name for the default language of the website. remarks: 'Example: en-US represents the English language in the US locale.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: logoUrl summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -154,7 +154,7 @@ properties: Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -167,7 +167,7 @@ properties: fullName: timeZoneInfo summary: Returns the web's regional timezone settings or undefined if they haven't been set. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -180,7 +180,7 @@ properties: fullName: title summary: Returns the title of the current SPWeb. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 4fb83f74..a256227a 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -56,7 +56,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Button on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - + example: [] isPreview: true isDeprecated: false syntax: @@ -153,7 +153,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -177,7 +177,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -206,7 +206,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -230,7 +230,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' - + example: [] isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' @@ -255,7 +255,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -268,7 +268,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create an IconPicker on the PropertyPane. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -292,7 +292,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Label on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -316,7 +316,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Link on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -364,7 +364,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -388,7 +388,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a ThumbnailPicker on the PropertyPane. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -412,7 +412,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 977268fc..186ec829 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 9f1934a9..60caae83 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the shared property. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index 1487dafa..c708a4a5 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -26,7 +26,7 @@ properties: When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index 471efee3..bd864d5a 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the shared source. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: default value - 'Connect to source' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index 6e3b0a6f..f4805c4b 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ properties: Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources. - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: The source id for a web part will be of the form WebPart.. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/iguidset.yml b/SP-Framework/sp-property-pane/iguidset.yml index 55d52f99..a03c22e6 100644 --- a/SP-Framework/sp-property-pane/iguidset.yml +++ b/SP-Framework/sp-property-pane/iguidset.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IGuidSet summary: Set of GUIDs representing a list item. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: listId summary: List ID remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: siteId summary: Site ID remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: uniqueId summary: Unique ID within the list remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: webId summary: Web ID remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/imagefit.yml b/SP-Framework/sp-property-pane/imagefit.yml index 9e3c5f0f..ea911f33 100644 --- a/SP-Framework/sp-property-pane/imagefit.yml +++ b/SP-Framework/sp-property-pane/imagefit.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: ImageFit summary: The possible methods that can be used to fit the image. remarks: '' - +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index c2d4b542..8c5cc183 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPopupWindowProps summary: Popup window props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: height summary: Height of pop up window. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: positionWindowPosition summary: The position of pop up window. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: Title of pop up window. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: width summary: Width of pop up window. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index e2dc3b1d..80baf21f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: Besides the compound button, other button types will need more information provided to screen reader. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: ariaLabel summary: The aria label of the button for the benefit of screen readers. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: buttonType summary: The type of button to render. Default value is ButtonType.normal. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: description summary: Description of the action this button takes. Only used for compound buttons. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: disabled summary: Whether the button is disabled. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -84,7 +84,7 @@ properties: fullName: icon summary: The button icon shown in command or hero type. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: text summary: Display text of the element. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index d9128e5a..9b51c17f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: checked summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Whether the property pane checkbox is disabled or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: text summary: Label to display next to the checkbox. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index d45f88b7..d4926fbc 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: The aria label of the property pane choice group option for the benefit of screen readers. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: Default value is false. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: disabled summary: Whether the property pane choice group option is disabled or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: iconProps summary: The Icon component props for choice field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: imageSize summary: The width and height of the image in px for choice field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: fullName: imageSrc summary: The src of image for choice field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -105,7 +105,7 @@ properties: fullName: key summary: A required key to uniquely identify the option. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -118,7 +118,7 @@ properties: fullName: selectedImageSrc summary: The src of image for choice field which is selected. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ properties: fullName: text summary: The text string for the option. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index e5f71b77..4bfae47f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: officeFabricIconFontName summary: The name of the icon to use from the Office Fabric icon set. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 0a407d31..295550d2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: label summary: Descriptive label for the choice group. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: options summary: The options for the choice group. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index f7ec8cc1..432c2fbb 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: onShowPrimaryGroup summary: Callback when user clicks to show primary group. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: onShowSecondaryGroup summary: Callback when user clicks to show secondary group. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: primaryGroup summary: Primary group to show remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: secondaryGroup summary: Secondary group to show remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: showSecondaryGroup summary: Indicating whether the property pane should show primary group or the secondary group. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 783a42f1..d39cbbb5 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: currentPage summary: Page to be displayed on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other properties will be unaffected. - + example: [] isPreview: true isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: disableFocusTrap summary: Whether to disable trapping focus inside property pane. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: loadingIndicatorDelayTime summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. - + example: [] isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: pages summary: Total number of pages on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index 067bbf8d..5f9fc1d8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: For more information, see the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: onDispose summary: This API is called when the component is unmounted from the host element. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: fullName: onRender summary: This API will be called once the custom field is mounted on the host element. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index 54493568..b44432bb 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDebounceProperty summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired for this property. remarks: The default value is 500. - + example: [] isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: propertyName summary: Property to debounce. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index 2db0cbbc..ffd7d218 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: calloutMaxHeight summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index c8d4154a..f8c31b3b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: index summary: Index for this option. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: key summary: A key to uniquely identify this option. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: text summary: Text to render for this option. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index f1ce19ff..36d8de4d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: A description of the dropdown for the benefit of screen reader users. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: ariaSetSize summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: calloutProps summary: Custom properties for Dropdown's Callout used to render options. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: disabled summary: Whether the property pane dropdown option is disabled or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: label summary: Descriptive label for the Dropdown. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: options summary: Collection of options for this Dropdown. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: selectedKey summary: The key of the initially selected option. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml index befafec8..01ed3eb6 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' - +example: [] isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index 30c5b877..fbe9c768 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the property pane dynamic field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the field.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field. - + example: [] isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: default value - 'Connect to source' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 307f3001..6ba03709 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: fields summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the property.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: sharedConfiguration summary: Configuration shared between all the entries of the set. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 7da99657..8e898425 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' - +example: [] isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' @@ -17,7 +17,7 @@ properties: fullName: ariaLabel summary: 'ARIA Label for text field, if any.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -30,7 +30,7 @@ properties: fullName: description summary: The text field input description. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: Make sure to set this only if you want to see an error message displayed for the text field. - + example: [] isPreview: true isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - + example: [] isPreview: true isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: placeholder summary: Placeholder text to be displayed in the text field. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - + example: [] isPreview: true isDeprecated: false syntax: @@ -137,7 +137,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. - + example: [] isPreview: true isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 15f655a2..2ad7e288 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: properties summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: shouldFocus summary: Whether this control should be focused. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: targetProperty summary: Target property from the web part's property bag. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Type of the PropertyPane field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index c2b495d1..843087a8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: groupFields summary: List of PropertyPane fields. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: remarks: >- For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left empty, the group header will not render (not recommended for accordions). - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: isCollapsed summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: remarks: >- The default value is false. Use this option to skip the rendering of group name to avoid empty group header being displayed. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml index 926012a9..11c75dc4 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneIconPickerProps summary: PropertyPaneIconPicker component props remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: callerName summary: Optional name of consuming component for telemetry purposes. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: The icon picker allows selection of Fabric MDL2 icons. This optional parameter allows the caller to override this with a custom selection of icons. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: customSelectedIconName summary: 'When invoking with a custom icon set, this is the name of the currently selected icon.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: onItemChanged summary: Callback function for when an icon is selected. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: onItemDeleted summary: Callback function for when the Delete button is clicked. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: previewFullWidth summary: Whether to render the icon preview with full width or the default fixed aspect ratio. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: previewGrayBackground summary: Whether to render the icon with a gray background. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: thumbnail summary: Thumbnail metadata of the currently selected icon. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: thumbnailRendererIconClassName summary: Optional CSS class name to apply to the icon preview. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: thumbnailRendererWrapperClassName summary: Optional CSS class name to apply to the icon preview wrapper. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index 640a3b8f..65e421ac 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: required summary: Whether the associated form field is required or not. remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: text summary: Display text fot the label. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 36cebdab..2e123827 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: disabled summary: Whether the property pane link is disabled or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: href summary: Location to which the link is targeted to. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: popupWindowProps summary: The props of pop up window. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: \_top - Load the response into the original window. - + example: [] isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ properties: fullName: text summary: Display text for the link. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index acca1669..76f583e9 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: displayGroupsAsAccordion summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: groups summary: List of groups to be displayed on the PropertyPane page. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: header summary: PropertyPane page header. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index b2c1f373..3c7d4728 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: description summary: Header to display. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: image summary: Image url for the background image. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This property is not used. diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index c7826e7f..ca093fc1 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: A description of the Slider for the benefit of screen readers. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Whether or not the Slider is disabled. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: label summary: Description label of the Slider. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: max summary: The max value of the Slider. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: min summary: The min value of the Slider. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: showValue summary: Whether to show the value on the right of the Slider. remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: step summary: The difference between the two adjacent values of the Slider. Defaults to 1. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: Defaults to min. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -129,7 +129,7 @@ properties: ``` is specified, the value of the Slider has % after it. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index 9317b875..a4cf23c0 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: 'Aria Label for text field, if any.' remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: deferredValidationTime summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: description summary: The text field input description. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: So, make sure to set this only if you want to see an error message displayed for the text field. - + example: [] isPreview: false isDeprecated: false syntax: @@ -86,7 +86,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -119,7 +119,7 @@ properties: 2. The text length after each edit - + example: [] isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ properties: fullName: maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: fullName: multiline summary: Whether or not the text field is a multiline text field. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -177,7 +177,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - + example: [] isPreview: false isDeprecated: false syntax: @@ -190,7 +190,7 @@ properties: fullName: placeholder summary: placeholder text to be displayed in the text field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -203,7 +203,7 @@ properties: fullName: resizable summary: Whether or not the multiline text field is resizable. remarks: The default value is true. - + example: [] isPreview: false isDeprecated: false syntax: @@ -216,7 +216,7 @@ properties: fullName: rows summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. - + example: [] isPreview: false isDeprecated: false syntax: @@ -229,7 +229,7 @@ properties: fullName: underlined summary: Whether or not the text field is underlined. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -242,7 +242,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -255,7 +255,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -270,7 +270,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml index afa840b9..9e8dbcb0 100644 --- a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneThumbnailPickerProps summary: PropertyPaneThumbnailPicker component props remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: callerName summary: Optional name of consuming component for telemetry purposes. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: If an asset from the current site is selected, the URL can be returned as a relative URL. This option forces the URL to be returned as an absolute URL. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: onItemChanged summary: Callback function for when an image has been selected. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: onItemDeleted summary: Callback for when the Delete button is clicked. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: previewFullWidth summary: 'For the preview image, display with full width as opposed to the default fixed ratio.' remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: previewGrayBackground summary: Whether to display a gray background when rendering an icon. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: serviceScope summary: Service scope. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: thumbnail summary: Thumbnail metadata of the currently selected thumbnail. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: thumbnailRendererIconClassName summary: Optional CSS class name to apply to the thumbnail preview when an icon is being rendered. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: thumbnailRendererWrapperClassName summary: Optional CSS class name to apply to the wrapper of the thumbnail preview. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index ca90e3ec..e3c2aa91 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: checked summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Optional disabled flag. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: key summary: A key to uniquely identify the field. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: label summary: A label for the toggle. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: offAriaLabel summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: offText summary: Test display when toggle is OFF. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: onAriaLabel summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: onText summary: Text to display when toggle is ON. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnail.yml b/SP-Framework/sp-property-pane/ithumbnail.yml index 639c639b..e5670cd8 100644 --- a/SP-Framework/sp-property-pane/ithumbnail.yml +++ b/SP-Framework/sp-property-pane/ithumbnail.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnail summary: The type of thumbnail image being configured. remarks: '' - +example: [] isPreview: true isDeprecated: false syntax: export declare type IThumbnail = IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage; diff --git a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml index 8d2dad84..67ada762 100644 --- a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailFabricReactIcon summary: Options related to fabric icon thumbnail. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the icon. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconColor summary: The background color for the icon. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: iconName summary: The name of the icon to render. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Fabric icon type. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml index 75bc6e19..3744aa1f 100644 --- a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailIconSizeImage summary: Options related to icon sized image thumbnail. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the image. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconColor summary: Background color to use for the icon. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: iconUrl summary: URL pointing to the icon-size image. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Image type. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnailimage.yml b/SP-Framework/sp-property-pane/ithumbnailimage.yml index f52b101c..7a476525 100644 --- a/SP-Framework/sp-property-pane/ithumbnailimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailImage summary: Options related to image thumbnail. remarks: '' - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the image. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: backupImageUrl summary: Optional backup image URL if the original image URL fails to load. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: imageFit summary: How the image should fit. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: imageUrl summary: URL pointing to the image. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: type summary: Image type. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index c21c4d0c..181d60f3 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PopupWindowPosition summary: The position of pop up window. remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index b28f7aba..f6c1af58 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 5bad4681..78062421 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -7,7 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 2a4fba58..44cdb99d 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -8,7 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' - +example: [] isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/thumbnailtype.yml b/SP-Framework/sp-property-pane/thumbnailtype.yml index 90495bd3..20bd46a6 100644 --- a/SP-Framework/sp-property-pane/thumbnailtype.yml +++ b/SP-Framework/sp-property-pane/thumbnailtype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: ThumbnailType summary: Supported thumbnail image types. remarks: '' - +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 8a59dd11..f95a2a90 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -10,7 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "SearchQueryModifier". remarks: '' - +example: [] isPreview: true isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: true isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the original query will be used instead of the modified one. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: 'modifySearchQuery(query, scenario)' summary: Returns a modified search query. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index 20c25567..034e43dc 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: IQuery summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. remarks: Additional properties can be added to the object to pass data between extensions. - +example: [] isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: originalQueryText summary: Query text that the user provided. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: queryText summary: Text of the query. remarks: '' - + example: [] isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index f2b0828b..ad471c5c 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryModifierContext summary: Context for the search query modifier extensions. remarks: '' - +example: [] isPreview: true isDeprecated: false type: class diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index 1cd79378..df857dc9 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryScenario summary: Scenario for the search query modifier. remarks: '' - +example: [] isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 18b36010..9830ca7e 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -58,7 +58,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Button on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -85,7 +85,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -112,7 +112,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -143,7 +143,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - + example: [] isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -167,7 +167,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -194,7 +194,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -226,7 +226,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -253,7 +253,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' - + example: [] isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -280,7 +280,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -296,7 +296,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Label on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -323,7 +323,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Link on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -350,7 +350,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -377,7 +377,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -404,7 +404,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 1c58e87f..9ca02294 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -19,7 +19,7 @@ remarks: >- updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision. - +example: [] isPreview: false isDeprecated: false type: class @@ -33,7 +33,7 @@ constructors: It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. - + example: [] isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: The default value is false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not. remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: remarks: >- Web parts should utilize this property to perform operations such as any conditional styling of components based on the initial available width for the web part. - + example: [] isPreview: false isDeprecated: false syntax: @@ -164,7 +164,7 @@ methods: fullName: clearError() summary: This API should be used to clear the error message from the web part display area. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -182,7 +182,7 @@ methods: remarks: >- Web parts should utilize this method to perform operations such as potentially re-rendering components based on the new available width for the web part. - + example: [] isPreview: false isDeprecated: false syntax: @@ -205,7 +205,11 @@ methods: The default implementation of this API calls the web part render method to re-render the web part with the new display mode. If a web part developer does not want a full re-render to happen on display mode change, they can override this API and perform specific updates to the web part DOM to switch its display mode. - + + + If the web part is initialized or re-initialized when switching to a different display mode then this lifecycle + method is not called. Example: SharePoint Site Page. + example: [] isPreview: false isDeprecated: false syntax: @@ -229,7 +233,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - + example: [] isPreview: false isDeprecated: false syntax: @@ -247,7 +251,7 @@ methods: remarks: >- Developers sould not call render in overridden method. It can lead to unpredicted re-flow of the web part. render will be called from the base class when needed. - + example: [] isPreview: false isDeprecated: false syntax: @@ -269,7 +273,7 @@ methods: This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -287,7 +291,7 @@ methods: initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -307,7 +311,7 @@ methods: This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 9da9ec0d..5f396e40 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -7,7 +7,7 @@ summary: >- This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. remarks: '' - +example: [] isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. - + example: [] isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - + example: [] isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ properties: fullName: description summary: Description of the WebPart remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane button is clicked. - + example: [] isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ properties: fullName: displayMode summary: This property is the current display mode of the web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -145,7 +145,7 @@ properties: fullName: properties summary: This property is the pointer to the custom property bag of the web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -162,7 +162,7 @@ properties: remarks: >- See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more information about how to define metadata - + example: [] isPreview: false isDeprecated: false syntax: @@ -175,7 +175,7 @@ properties: fullName: title summary: Title of the WebPart remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -222,7 +222,7 @@ methods: 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including 'loadPropertyPaneResources' promise. - + example: [] isPreview: false isDeprecated: false syntax: @@ -249,7 +249,7 @@ methods: by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - + example: [] isPreview: false isDeprecated: false syntax: @@ -278,7 +278,7 @@ methods: This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -298,7 +298,7 @@ methods: some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. - + example: [] isPreview: false isDeprecated: false syntax: @@ -312,9 +312,14 @@ methods: fullName: onDisplayModeChanged(oldDisplayMode) summary: This event method is called when the display mode of a web part is changed. virtual remarks: >- - If the web part is initialized or re-initialized in a different display mode then this lifecycle method is not - called. - + The default implementation of this API calls the web part render method to re-render the web part with the new + display mode. If a web part developer does not want a full re-render to happen on display mode change, they can + override this API and perform specific updates to the web part DOM to switch its display mode. + + + If the web part is initialized or re-initialized when switching to a different display mode then this lifecycle + method is not called. Example: SharePoint Site Page. + example: [] isPreview: false isDeprecated: false syntax: @@ -336,7 +341,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - + example: [] isPreview: false isDeprecated: false syntax: @@ -353,7 +358,7 @@ methods: This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. - + example: [] isPreview: false isDeprecated: false syntax: @@ -376,7 +381,7 @@ methods: - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - When the user switches web parts then the current web part gets this event. - + example: [] isPreview: false isDeprecated: false syntax: @@ -395,7 +400,7 @@ methods: - When the PropertyPane is opened. - When the user switches web parts then the new web part gets this event. - + example: [] isPreview: false isDeprecated: false syntax: @@ -411,7 +416,7 @@ methods: This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -438,7 +443,7 @@ methods: fullName: onPropertyPaneRendered() summary: This API is invoked when the PropertyPane is rendered. virtual remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index ce02474f..a20a586b 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -12,7 +12,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseWebPartContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: remarks: >- Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas. - + example: [] isPreview: true isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 7b4efcba..600ff48c 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 37f37142..40761f66 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -7,7 +7,7 @@ summary: >- Interface to be implemented by a component that should display the loading indicator and error messages for a web part. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ methods: fullName: clearError(domElement) summary: Clear the webpart error message. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: fullName: clearLoadingIndicator(domElement) summary: Clear the loading indicator. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ methods: fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' summary: Display a loading spinner. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: fullName: 'renderError(domElement, error, clearDomElementCallback)' summary: Render the provided error message in the webpart container div. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index c1d3dc4d..b251db60 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index b2785cc7..76c11b78 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index f247b9c0..8dec184b 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index a62c555e..a58567d1 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index f2fdae3b..be17e1ae 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IMicrosoftTeams summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) - + example: [] isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: teamsJs summary: Microsoft Teams SDK. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 6396ea40..97778dc3 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -7,7 +7,7 @@ summary: >- Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ methods: fullName: close() summary: This API should be used to close the PropertyPane to help configure the web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: isPropertyPaneOpen() summary: Returns true if the PropertyPane is open. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: remarks: >- For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. - + example: [] isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ methods: fullName: open() summary: This API should be used to open the PropertyPane to help configure the web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: fullName: openDetails(context) summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' - + example: [] isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: remarks: >- This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 6de500f5..e7cf9f6c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 0380065f..cea9643d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 340b6219..2f4196c6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 345e8d5f..3e5942f2 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 5d6eca1c..a4cfa04d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 293f8e6d..20a3b896 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index c37e1f69..6972d5a0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index be0046fc..27168147 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index baea865f..0df7e9ac 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 8758beed..e53d1b59 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 2dbcd2af..d22d661f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 088a650b..28e5fea0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 2db3752f..7cb4d1f4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 16573536..098e55e5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index cf66c4cc..0ee57f36 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' - +example: [] isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index e72daa91..10976c2a 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index b379133d..9463e163 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index a989e640..f343e4ee 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 9c42be76..533f4891 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index e9345fa8..fd99d165 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index fd82e384..d289960c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index 4dfa04d0..1bd769eb 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index ee8fa3f6..1c29fea8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 13981c98..bacb7353 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index c9c5eae9..1e8f87c7 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: ISDKs summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index 74f83a20..b901b0ca 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -7,7 +7,7 @@ summary: >- This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data. remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ properties: Example: `"1.0"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: 'aBooleanProperty': true } ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: Example: `{ 'value': 'text value' }` - + example: [] isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index ca01b289..78dfb218 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -8,7 +8,7 @@ remarks: >- A "context" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -22,7 +22,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: httpClient summary: HttpClient instance scoped to this web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: instanceId summary: Web part instance id. This is a globally unique value. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: fullName: manifest summary: Manifest for the client-side web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: pageContext summary: SharePoint page context. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: spHttpClient summary: SPHttpClient instance scoped to this web part. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 20f9f523..e597506b 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -8,7 +8,7 @@ remarks: >- When the `serialize()` API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize. - +example: [] isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"1.0"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: Supported values: string with the description. Example: `"Text"` - + example: [] isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: } ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: 'aBooleanProperty': true } ``` - + example: [] isPreview: true isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: id summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' - + example: [] isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ properties: supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` - + example: [] isPreview: false isDeprecated: false syntax: @@ -165,7 +165,7 @@ properties: Example: `{ 'value': 'text value' }` - + example: [] isPreview: false isDeprecated: false syntax: @@ -178,7 +178,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -196,7 +196,7 @@ properties: Supported values: string less than 100 characters Example: `"Text"` - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 258717de..43b2f426 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -56,7 +56,7 @@ remarks: >- This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated. - +example: [] isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 3d58f18f..274814b6 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IWebPartPropertyMetadata summary: This is the structure used for map values in `IWebPartPropertiesMetadata` remarks: '' - +example: [] isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ properties: Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 34b40ca1..45622192 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index c8e3ba6b..f8ca6168 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -7,7 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index cfb7e8bd..5339bf08 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -8,7 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' - +example: [] isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 97e4d38a..dd7e90f1 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebPartContext` class. - +example: [] isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - + example: [] isPreview: false isDeprecated: true customDeprecatedMessage: '- This function has been deprecated' @@ -51,7 +51,7 @@ properties: fullName: sdks summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key. remarks: '' - + example: [] isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index 7a048b2f..eb71fde2 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -8,7 +8,7 @@ remarks: >- This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor. - +example: [] isPreview: true isDeprecated: false fields: From 2da24a8b329a644189e72e5c70080ad02649dcf7 Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Fri, 1 Apr 2022 14:02:06 -0400 Subject: [PATCH 54/55] remove example: [] --- SP-Framework/decorators.yml | 6 +- .../office-ui-fabric-react-bundle.yml | 2 +- .../adaptivecardextensioncontext.yml | 10 +-- .../baseadaptivecardextension.yml | 72 ++++++++-------- .../baseadaptivecardview.yml | 10 +-- .../basebasiccardview.yml | 4 +- .../basecardview.yml | 10 +-- .../baseimagecardview.yml | 4 +- .../baseprimarytextcardview.yml | 4 +- .../baseview.yml | 26 +++--- .../cardsize.yml | 2 +- .../devicecontext.yml | 2 +- .../iactionarguments.yml | 2 +- .../iactionerror.yml | 2 +- .../iactionerrorarguments.yml | 2 +- ...daptivecardextensionpropertiesmetadata.yml | 2 +- ...iadaptivecardextensionpropertymetadata.yml | 2 +- .../iattachmenterror.yml | 4 +- .../ibaseactionarguments.yml | 6 +- .../ibaseactionerrorarguments.yml | 8 +- .../ibasecardparameters.yml | 8 +- .../ibasiccardparameters.yml | 4 +- .../icachedloadparameters.yml | 6 +- .../icachesettings.yml | 8 +- .../icardaction.yml | 2 +- .../icardbutton.yml | 10 +-- .../iconfirmationdialog.yml | 6 +- .../iexternallinkcardaction.yml | 6 +- .../iexternallinkparameters.yml | 6 +- .../igetlocationaction.yml | 6 +- .../igetlocationactionarguments.yml | 6 +- .../igetlocationactionparameters.yml | 4 +- .../igetlocationcardaction.yml | 6 +- .../iimagecardparameters.yml | 6 +- .../ilocation.yml | 10 +-- .../ilocationerrorarguments.yml | 6 +- .../iprimarytextcardparameters.yml | 6 +- .../iquickviewcardaction.yml | 6 +- .../iquickviewparameters.yml | 4 +- .../iselectmediaaction.yml | 6 +- .../iselectmediaactionarguments.yml | 8 +- .../iselectmediaactionerrorarguments.yml | 8 +- .../iselectmediaactionparameters.yml | 10 +-- .../iselectmediaattachment.yml | 8 +- .../iselectmediacardaction.yml | 6 +- .../ishowcardactionarguments.yml | 4 +- .../ishowlocationaction.yml | 6 +- .../ishowlocationactionparameters.yml | 4 +- .../ishowlocationcardaction.yml | 6 +- .../ispfxadaptivecard.yml | 4 +- .../isubmitactionarguments.yml | 6 +- .../isubmitcardaction.yml | 8 +- .../isubmitcardparameters.yml | 2 +- .../mediatype.yml | 2 +- .../quickviewnavigator.yml | 4 +- .../rendertype.yml | 2 +- .../viewnavigator.yml | 16 ++-- .../applicationaccessor.yml | 6 +- .../applicationcustomizercontext.yml | 8 +- .../baseapplicationcustomizer.yml | 8 +- .../iplaceholdercreatecontentoptions.yml | 4 +- .../placeholdercontent.yml | 12 +-- .../sp-application-base/placeholdername.yml | 2 +- .../placeholderprovider.yml | 12 +-- .../sp-component-base/basecomponent.yml | 16 ++-- .../basecomponentcontext.yml | 30 +++---- .../sp-component-base/dynamicdataprovider.yml | 22 ++--- .../dynamicdatasourcemanager.yml | 16 ++-- .../sp-component-base/dynamicproperty.yml | 28 +++---- .../icomponentpropertymetadata.yml | 12 +-- .../sp-component-base/ireadonlyfontstyles.yml | 2 +- .../sp-component-base/ireadonlyrawstyle.yml | 2 +- .../sp-component-base/ireadonlytheme.yml | 2 +- .../iserializedserverprocesseddata.yml | 10 +-- SP-Framework/sp-component-base/itheme.yml | 2 +- .../themechangedeventargs.yml | 4 +- .../sp-component-base/themeprovider.yml | 10 +-- SP-Framework/sp-core-library/displaymode.yml | 2 +- SP-Framework/sp-core-library/environment.yml | 4 +- .../sp-core-library/environmenttype.yml | 2 +- .../sp-core-library/formdisplaymode.yml | 2 +- SP-Framework/sp-core-library/guid.yml | 16 ++-- SP-Framework/sp-core-library/idisposable.yml | 6 +- .../irandomnumbergenerator.yml | 4 +- .../sp-core-library/iservicecollection.yml | 4 +- .../sp-core-library/ispeventobserver.yml | 6 +- .../sp-core-library/itimeprovider.yml | 6 +- SP-Framework/sp-core-library/log.yml | 10 +-- .../sp-core-library/randomnumbergenerator.yml | 8 +- .../sp-core-library/servicecreator.yml | 2 +- SP-Framework/sp-core-library/servicekey.yml | 12 +-- SP-Framework/sp-core-library/servicescope.yml | 22 ++--- SP-Framework/sp-core-library/session.yml | 8 +- SP-Framework/sp-core-library/spevent.yml | 6 +- SP-Framework/sp-core-library/speventargs.yml | 2 +- SP-Framework/sp-core-library/text_2.yml | 6 +- SP-Framework/sp-core-library/timeprovider.yml | 10 +-- .../urlqueryparametercollection.yml | 8 +- SP-Framework/sp-core-library/validate.yml | 10 +-- SP-Framework/sp-core-library/version.yml | 28 +++---- SP-Framework/sp-dialog/basedialog.yml | 24 +++--- SP-Framework/sp-dialog/dialog.yml | 6 +- SP-Framework/sp-dialog/ialertoptions.yml | 2 +- .../sp-dialog/idialogconfiguration.yml | 4 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 4 +- SP-Framework/sp-dialog/ipromptoptions.yml | 4 +- .../sp-dialog/isecondarydialogprovider.yml | 8 +- .../sp-dynamic-data/dynamicdatareference.yml | 12 +-- .../idynamicdataannotatedpropertyvalue.yml | 6 +- .../sp-dynamic-data/idynamicdatacallables.yml | 12 +-- .../idynamicdataeventdefinition.yml | 6 +- .../idynamicdatapropertydefinition.yml | 4 +- .../idynamicdatapropertymetadata.yml | 6 +- .../idynamicdatapropertyvaluemetadata.yml | 4 +- ...micdatapropertyvaluemetadatacollection.yml | 2 +- .../sp-dynamic-data/idynamicdatasource.yml | 22 ++--- .../idynamicdatasourcemetadata.yml | 12 +-- .../sp-extension-base/baseextension.yml | 8 +- .../sp-extension-base/extensioncontext.yml | 2 +- SP-Framework/sp-http/aadhttpclient.yml | 12 +-- .../sp-http/aadhttpclientconfiguration.yml | 8 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 6 +- .../sp-http/aadhttpclientresponse.yml | 4 +- SP-Framework/sp-http/aadtokenprovider.yml | 8 +- .../sp-http/aadtokenproviderfactory.yml | 6 +- .../sp-http/beforeredirecteventargs.yml | 8 +- SP-Framework/sp-http/digestcache.yml | 14 ++-- SP-Framework/sp-http/graphrequest.yml | 62 +++++++------- SP-Framework/sp-http/httpclient.yml | 14 ++-- .../sp-http/httpclientconfiguration.yml | 10 +-- SP-Framework/sp-http/httpclientresponse.yml | 30 +++---- .../sp-http/iaadhttpclientconfiguration.yml | 2 +- .../sp-http/iaadhttpclientconfigurations.yml | 4 +- .../sp-http/iaadhttpclientoptions.yml | 8 +- SP-Framework/sp-http/iaadtokenprovider.yml | 8 +- .../iaadtokenproviderconfiguration.yml | 18 ++-- .../sp-http/ibeforeredirecteventargs.yml | 6 +- SP-Framework/sp-http/idigestcache.yml | 10 +-- .../sp-http/ihttpclientconfiguration.yml | 2 +- .../sp-http/ihttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/ihttpclientoptions.yml | 2 +- .../isphttpclientbatchconfiguration.yml | 2 +- .../isphttpclientbatchconfigurations.yml | 4 +- .../isphttpclientbatchcreationoptions.yml | 4 +- .../sp-http/isphttpclientbatchoptions.yml | 2 +- .../isphttpclientcommonconfiguration.yml | 6 +- .../sp-http/isphttpclientconfiguration.yml | 8 +- .../sp-http/isphttpclientconfigurations.yml | 4 +- SP-Framework/sp-http/isphttpclientoptions.yml | 4 +- .../sp-http/itokenacquisitioneventargs.yml | 6 +- SP-Framework/sp-http/msgraphclient.yml | 4 +- SP-Framework/sp-http/msgraphclientfactory.yml | 10 +-- SP-Framework/sp-http/msgraphclientv3.yml | 4 +- SP-Framework/sp-http/odataversion.yml | 10 +-- SP-Framework/sp-http/sphttpclient.yml | 20 ++--- SP-Framework/sp-http/sphttpclientbatch.yml | 12 +-- .../sphttpclientbatchconfiguration.yml | 10 +-- .../sphttpclientcommonconfiguration.yml | 14 ++-- .../sp-http/sphttpclientconfiguration.yml | 16 ++-- SP-Framework/sp-http/sphttpclientresponse.yml | 8 +- SP-Framework/sp-http/sphttpheader.yml | 2 +- .../sp-http/tokenacquisitioneventargs.yml | 8 +- .../sp-image-helper/iimagehelperrequest.yml | 8 +- SP-Framework/sp-image-helper/imagehelper.yml | 4 +- .../icreatesubscriptionsettings.yml | 12 +-- .../ilistsubscription.yml | 4 +- .../isubscriptioncallbacks.yml | 8 +- .../listsubscriptionfactory.yml | 8 +- .../basefieldcustomizer.yml | 8 +- .../baseformcustomizer.yml | 16 ++-- .../baselistviewcommandset.yml | 12 +-- .../columnaccessor.yml | 6 +- .../sp-listview-extensibility/command.yml | 14 ++-- .../fieldcustomizercontext.yml | 6 +- .../formcustomizercontext.yml | 14 ++-- .../sp-listview-extensibility/icolumn.yml | 18 ++-- .../icontenttype.yml | 8 +- .../ifieldcustomizercelleventparameters.yml | 10 +-- .../sp-listview-extensibility/ifilter.yml | 6 +- .../sp-listview-extensibility/ifolderinfo.yml | 4 +- .../iformcustomizercontext.yml | 12 +-- .../sp-listview-extensibility/ilist.yml | 8 +- .../ilistviewaccessorstate.yml | 20 ++--- ...stviewcommandsetexecuteeventparameters.yml | 6 +- ...iewcommandsetlistviewupdatedparameters.yml | 4 +- .../sp-listview-extensibility/irow.yml | 4 +- .../sp-listview-extensibility/iview.yml | 8 +- .../listitemaccessor.yml | 8 +- .../listviewaccessor.yml | 26 +++--- .../listviewaccessorstatechanges.yml | 2 +- .../listviewcommandsetcontext.yml | 6 +- .../listviewstatechangedeventargs.yml | 6 +- .../sp-listview-extensibility/rowaccessor.yml | 2 +- .../selectedrowschangedeventargs.yml | 4 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 4 +- SP-Framework/sp-loader/spcomponentloader.yml | 12 +-- SP-Framework/sp-lodash-subset/cancelable.yml | 2 +- .../sp-lodash-subset/throttlesettings.yml | 2 +- .../sp-module-interfaces/componenttype.yml | 2 +- .../sp-module-interfaces/extensiontype.yml | 2 +- .../iadaptivecardextensionmanifest.yml | 18 ++-- .../iadaptivecardextensionmanifestentry.yml | 20 ++--- .../iclientsideassemblymanifest.yml | 4 +- ...clientsidecomponentloaderconfiguration.yml | 10 +-- .../iclientsidecomponentmanifest.yml | 16 ++-- .../iclientsideextensionmanifest.yml | 4 +- .../iclientsidelibrarymanifest.yml | 2 +- .../iclientsidemanifestbase.yml | 6 +- .../iclientsidewebpartmanifest.yml | 18 ++-- .../iclientsidewebpartmanifestentry.yml | 22 ++--- .../iclientsidewebpartmanifestinstance.yml | 2 +- .../icommanddefinition.yml | 10 +-- .../icommandsetextensionmanifest.yml | 6 +- .../icomponentmoduleconfiguration.yml | 10 +-- .../sp-module-interfaces/iintegritypath.yml | 6 +- .../ilocalizedpathmoduleconfiguration.yml | 8 +- .../sp-module-interfaces/ilocalizedstring.yml | 6 +- .../imoduleconfiguration.yml | 2 +- .../imoduleconfigurationbase.yml | 6 +- .../ipathmoduleconfiguration.yml | 10 +-- .../sp-module-interfaces/predefinedgroup.yml | 2 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 6 +- .../sp-odata-types/iodatabasepermission.yml | 6 +- .../sp-odata-types/iodatachangetoken.yml | 4 +- .../sp-odata-types/iodatacontenttype.yml | 24 +++--- .../iodatacontextwebinformation.yml | 10 +-- .../iodataformsclientsideconfiguration.yml | 20 ++--- SP-Framework/sp-odata-types/iodatalist.yml | 28 +++---- .../sp-odata-types/iodatalistitem.yml | 10 +-- .../sp-odata-types/iodatanavigationnode.yml | 16 ++-- .../iodatanavigationnodecollection.yml | 6 +- SP-Framework/sp-odata-types/iodatauser.yml | 16 ++-- .../sp-odata-types/iodatausercustomaction.yml | 38 ++++----- SP-Framework/sp-odata-types/iodataweb.yml | 38 ++++----- SP-Framework/sp-page-context/cultureinfo.yml | 8 +- .../sp-page-context/ispsystemtime.yml | 18 ++-- .../sp-page-context/isptimezonedata.yml | 16 ++-- SP-Framework/sp-page-context/pagecontext.yml | 24 +++--- .../sp-page-context/spdayofweek-typealias.yml | 2 +- SP-Framework/sp-page-context/spfield.yml | 16 ++-- SP-Framework/sp-page-context/splist.yml | 10 +-- SP-Framework/sp-page-context/splistitem.yml | 4 +- SP-Framework/sp-page-context/sppermission.yml | 84 +++++++++---------- SP-Framework/sp-page-context/spsite.yml | 24 +++--- SP-Framework/sp-page-context/sptimezone.yml | 16 ++-- SP-Framework/sp-page-context/spuser.yml | 18 ++-- SP-Framework/sp-page-context/spweb.yml | 28 +++---- SP-Framework/sp-property-pane.yml | 32 +++---- .../dynamicdatashareddepth.yml | 2 +- ...dynamicdatasharedpropertyconfiguration.yml | 4 +- .../idynamicdatasharedpropertyfilters.yml | 4 +- .../idynamicdatasharedsourceconfiguration.yml | 6 +- .../idynamicdatasharedsourcefilters.yml | 6 +- SP-Framework/sp-property-pane/iguidset.yml | 10 +-- SP-Framework/sp-property-pane/imagefit.yml | 2 +- .../sp-property-pane/ipopupwindowprops.yml | 10 +-- .../ipropertypanebuttonprops.yml | 18 ++-- .../ipropertypanecheckboxprops.yml | 8 +- .../ipropertypanechoicegroupoption.yml | 20 ++--- ...propertypanechoicegroupoptioniconprops.yml | 4 +- .../ipropertypanechoicegroupprops.yml | 6 +- .../ipropertypaneconditionalgroup.yml | 12 +-- .../ipropertypaneconfiguration.yml | 14 ++-- .../ipropertypanecustomfieldprops.yml | 10 +-- .../ipropertypanedebounceproperty.yml | 6 +- .../ipropertypanedropdowncalloutprops.yml | 4 +- .../ipropertypanedropdownoption.yml | 10 +-- .../ipropertypanedropdownprops.yml | 20 ++--- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 10 +-- .../ipropertypanedynamicfieldsetprops.yml | 8 +- .../ipropertypanedynamictextfieldprops.yml | 22 ++--- .../sp-property-pane/ipropertypanefield.yml | 10 +-- .../sp-property-pane/ipropertypanegroup.yml | 10 +-- .../ipropertypaneiconpickerprops.yml | 22 ++--- .../ipropertypanelabelprops.yml | 6 +- .../ipropertypanelinkprops.yml | 12 +-- .../sp-property-pane/ipropertypanepage.yml | 8 +- .../ipropertypanepageheader.yml | 6 +- .../ipropertypanesliderprops.yml | 20 ++--- .../ipropertypanetextfieldprops.yml | 36 ++++---- .../ipropertypanethumbnailpickerprops.yml | 22 ++--- .../ipropertypanetoggleprops.yml | 18 ++-- SP-Framework/sp-property-pane/ithumbnail.yml | 2 +- .../ithumbnailfabricreacticon.yml | 10 +-- .../ithumbnailiconsizeimage.yml | 10 +-- .../sp-property-pane/ithumbnailimage.yml | 12 +-- .../sp-property-pane/popupwindowposition.yml | 2 +- .../propertypanebuttontype.yml | 2 +- .../propertypanedropdownoptiontype.yml | 2 +- .../propertypanefieldtype.yml | 2 +- .../sp-property-pane/thumbnailtype.yml | 2 +- .../basesearchquerymodifier.yml | 8 +- .../sp-search-extensibility/iquery.yml | 6 +- .../searchquerymodifiercontext.yml | 2 +- .../searchqueryscenario.yml | 2 +- SP-Framework/sp-webpart-base.yml | 28 +++---- .../sp-webpart-base/baseclientsidewebpart.yml | 34 ++++---- SP-Framework/sp-webpart-base/basewebpart.yml | 48 +++++------ .../sp-webpart-base/basewebpartcontext.yml | 10 +-- .../dynamicdatashareddepth.yml | 2 +- .../iclientsidewebpartstatusrenderer.yml | 10 +-- ...dynamicdatasharedpropertyconfiguration.yml | 2 +- .../idynamicdatasharedpropertyfilters.yml | 2 +- .../idynamicdatasharedsourceconfiguration.yml | 2 +- .../idynamicdatasharedsourcefilters.yml | 2 +- .../sp-webpart-base/imicrosoftteams.yml | 6 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 14 ++-- .../ipropertypanebuttonprops.yml | 2 +- .../ipropertypanecheckboxprops.yml | 2 +- .../ipropertypanechoicegroupoption.yml | 2 +- ...propertypanechoicegroupoptioniconprops.yml | 2 +- .../ipropertypanechoicegroupprops.yml | 2 +- .../ipropertypaneconditionalgroup.yml | 2 +- .../ipropertypaneconfiguration.yml | 2 +- .../ipropertypanecustomfieldprops.yml | 2 +- .../ipropertypanedropdowncalloutprops.yml | 2 +- .../ipropertypanedropdownoption.yml | 2 +- .../ipropertypanedropdownprops.yml | 2 +- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 2 +- .../ipropertypanedynamicfieldsetprops.yml | 2 +- .../ipropertypanedynamictextfieldprops.yml | 2 +- .../sp-webpart-base/ipropertypanefield.yml | 2 +- .../sp-webpart-base/ipropertypanegroup.yml | 2 +- .../ipropertypanelabelprops.yml | 2 +- .../ipropertypanelinkprops.yml | 2 +- .../sp-webpart-base/ipropertypanepage.yml | 2 +- .../ipropertypanepageheader.yml | 2 +- .../ipropertypanesliderprops.yml | 2 +- .../ipropertypanetextfieldprops.yml | 2 +- .../ipropertypanetoggleprops.yml | 2 +- SP-Framework/sp-webpart-base/isdks.yml | 4 +- .../iserializedwebpartdata.yml | 12 +-- .../sp-webpart-base/iwebpartcontext.yml | 20 ++--- SP-Framework/sp-webpart-base/iwebpartdata.yml | 20 ++--- .../iwebpartpropertiesmetadata.yml | 2 +- .../iwebpartpropertymetadata.yml | 4 +- .../propertypanebuttontype.yml | 2 +- .../propertypanedropdownoptiontype.yml | 2 +- .../sp-webpart-base/propertypanefieldtype.yml | 2 +- .../sp-webpart-base/webpartcontext.yml | 12 +-- .../sp-webpart-base/webpartformfactor.yml | 2 +- 343 files changed, 1553 insertions(+), 1553 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 7aa0222c..2d1e8098 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -13,7 +13,7 @@ functions: -->virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ functions: inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ functions: definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml index 8d507768..c7606359 100644 --- a/SP-Framework/office-ui-fabric-react-bundle.yml +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -9,7 +9,7 @@ functions: package: '@microsoft/office-ui-fabric-react-bundle!' summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index 8d4784bc..89203738 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -7,7 +7,7 @@ summary: Adaptive Card Extension context object. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AdaptiveCardExtensionContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: deviceContext summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: location summary: Provides a promise that gets current location of the device remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: manifest summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: propertyPane summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index abaed17e..6920fa19 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardExtension summary: Base class for Adaptive Card Extensions. remarks: Adaptive Card Extensions must inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: (constructor)() summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -28,7 +28,7 @@ properties: fullName: _iconProperty summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: _title summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: cardNavigator summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: cardSize summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ properties: fullName: context summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -97,7 +97,7 @@ properties: The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to manage versioning of the Adaptive Card Extension. remarks: The default version is 1.0. - example: [] + isPreview: false isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: fullName: description summary: The description of the Adaptive Card Extension defined in the manifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: fullName: displayMode summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -136,7 +136,7 @@ properties: fullName: iconProperty summary: The icon url used to render an icon on the Card view. remarks: 'By default, this will return the iconImageUrl defined in the manifest.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: remarks: >- This method should be called after a card view has been registered. Otherwise visibility change will not be applied to the Adaptive Card. - example: [] + isPreview: false isDeprecated: false syntax: @@ -174,7 +174,7 @@ properties: is `QuickView` then returns [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). - example: [] + isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ properties: fullName: properties summary: 'The custom, persisted properties of the Adaptive Card Extension.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -207,7 +207,7 @@ properties: See [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) for more information about how to define metadata. - example: [] + isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ properties: [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ properties: Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default state. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -256,7 +256,7 @@ properties: fullName: renderedOnce summary: Indicates whether the Adaptive Card Extension has initially rendered. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ properties: fullName: renderType summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -285,7 +285,7 @@ properties: If this property is not initialized, [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) cannot be called. - example: [] + isPreview: false isDeprecated: false syntax: @@ -303,7 +303,7 @@ properties: This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also displayed as the Property Pane title. remarks: 'By default, this will return the title defined in the manifest.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -319,7 +319,7 @@ methods: fullName: getCachedState(state) summary: This virtual method returns a subset of the state object that will be cached by the client. remarks: 'If not overriden, this will return an empty object.' - example: [] + isPreview: true isDeprecated: false syntax: @@ -339,7 +339,7 @@ methods: fullName: getCacheSettings() summary: Override the default cache settings. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -360,7 +360,7 @@ methods: Property Pane resources can be defer loaded to reduce bundle size. See [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). - example: [] + isPreview: false isDeprecated: false syntax: @@ -378,7 +378,7 @@ methods: remarks: >- No Property Pane events will be raised until this method resolves except for `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. - example: [] + isPreview: false isDeprecated: false syntax: @@ -403,7 +403,7 @@ methods: was serialized by an older version of the Adaptive Card Extension that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - example: [] + isPreview: false isDeprecated: false syntax: @@ -434,7 +434,7 @@ methods: Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than the property pane (except for isolated Adaptive Card Extensions). remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -454,7 +454,7 @@ methods: fullName: onBeforeSerialize() summary: Lifecycle method called before serialization. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -470,7 +470,7 @@ methods: fullName: onDisplayModeChanged(oldDisplayMode) summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -490,7 +490,7 @@ methods: fullName: onDispose() summary: Lifecycle method called before disposing the Adaptive Card Extension. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -508,7 +508,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - example: [] + isPreview: false isDeprecated: false syntax: @@ -526,7 +526,7 @@ methods: remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - example: [] + isPreview: true isDeprecated: false syntax: @@ -550,7 +550,7 @@ methods: fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' summary: Lifecycle method called when a Property Pane field is changed. remarks: This is invoked for reactive Property Panes. - example: [] + isPreview: false isDeprecated: false syntax: @@ -581,7 +581,7 @@ methods: Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) changes. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -601,7 +601,7 @@ methods: fullName: renderCard() summary: The id of the initial Card view. remarks: 'By default, this returns undefined and will render a default Card view.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -621,7 +621,7 @@ methods: must have been initialized before calling [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml index 6d23abe3..aaf21156 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: BaseAdaptiveCardView summary: Base class for an Adaptive Card view. remarks: Views used to render the Quick view must inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: data summary: The data used to render the Adaptive Card. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: externalLink summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: template summary: The Adaptive Card template rendered by the view. remarks: The format of the template must be valid Adaptive Card JSON. - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: remarks: >- If not overriden, the title displayed will be [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index c8653ee6..c7b7c869 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -7,7 +7,7 @@ summary: Base class for a Basic Card view. remarks: >- The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the `Medium` Card size, two buttons in the `Large` Card size -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index c5158482..05487e0f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party Card views should inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: remarks: >- Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the documentation for the respective base Card View class for specific details. - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: remarks: >- The available data to display is dependent on the Card view template and its respective base Card view class. See the documentation for the Card View class for specific details. - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: isCacheEnabled summary: 'If true, this Card view will be cached and rendered at next load.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: onCardSelection summary: Action to invoke when the card is selected. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index 2d1740b0..ab1d8a7d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -7,7 +7,7 @@ summary: Base class for an Image Card view. remarks: >- The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml index c1781b0f..15348edc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -7,7 +7,7 @@ summary: Base class for a Primary Text Card view. remarks: >- The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: Returns the Adaptive Card template for the [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml index 58bd6408..d8d63da6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. No third-party views should inherit from this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ properties: [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: fullName: data summary: The data used to render the View. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -101,7 +101,7 @@ properties: [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -119,7 +119,7 @@ properties: [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: fullName: template summary: The Adaptive Card template used to render the view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ methods: fullName: onAction(action) summary: Action handler for Adaptive Card Actions. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -166,7 +166,7 @@ methods: fullName: onActionError(error) summary: Error handler for Adaptive Card Actions. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -189,7 +189,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -210,7 +210,7 @@ methods: [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml index 1ee3299a..5bf41796 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: CardSize summary: Size of the Card view. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type CardSize = 'Medium' | 'Large'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml index aa5bac54..2f43e2bf 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml @@ -7,7 +7,7 @@ summary: >- `WebView` indicates the Adaptive Card Extension is rendering through a web browser equivalent. `Mobile` indicates the Adaptive Card Extension is rendering natively on a mobile platform. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml index a8ccd0ac..0392e926 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml @@ -11,7 +11,7 @@ remarks: >- Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml index bee80041..5c4044e6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IActionError summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: |- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml index 03bdcaf6..ff94f913 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml @@ -12,7 +12,7 @@ remarks: >- routed to the [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) handler. -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml index 67bd2069..38ea8f56 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -7,7 +7,7 @@ summary: >- This structure is used to define metadata for Adaptive Card Extension properties as a map of string to `IAdaptiveCardExtensionPropertiesMetadata` remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index 88bf5c21..cffa820c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAdaptiveCardExtensionPropertyMetadata summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml index 6be15035..ac2835cd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IAttachmentError summary: This object represents error associated with a single attachment remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: errorCode summary: Error code associated with a particular attachment remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml index 143a9b10..c29bbb17 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -10,7 +10,7 @@ summary: >- remarks: >- Only `Submit` and `ShowCard` actions are routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. -example: [] + isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml index b1f8beaa..2baf78f6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an Adaptive Card OnActionError is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: error summary: The error thrown by the action remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: id summary: The id specified in the Adaptive Card template remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: type summary: The type of Adaptive Card Action thsat caused the error. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml index df28b94e..efa7a0de 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IBaseCardParameters summary: The primitive data parameters for every Card view. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: iconAltText summary: The icon alt text. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconProperty summary: The icon to display. remarks: The value is a URL to an icon. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: The title to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index e1a132c1..4101e4a6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml index f0c24e98..c475afc2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICachedLoadParameters summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: cardNavigatorState summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: state summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml index 4df2f958..16c9c33e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICacheSettings summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Returns the Card View used to generate the cached card. By default, the currently rendered Card View will be used to cache the card. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: expiryTimeInSeconds summary: 'Expiry time in seconds. Default: 86400 seconds (24 hours)' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: isEnabled summary: 'Whether cache is enabled. Default: true' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml index 9748d1ca..e8ce3619 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardAction summary: Type of handler for when a button is pressed. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 2d8d904a..290ef9fd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardButton summary: A button to display on a Card View. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: action summary: The type of the button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: id summary: Unique Id of the button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: style summary: Controls the style of the button. remarks: The destructive Action style is not supported in Card views - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: title summary: Text displayed on the button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml index 7f5a449c..78ad9a11 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IConfirmationDialog summary: Confirmation Dialog option that is passed through `Submit` Action is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: message summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: title summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index ddfb6f81..e7f5e217 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkCardAction summary: Open an external link. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the external link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is an external link button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml index e238f58a..1f477abc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IExternalLinkParameters summary: Parameters for opening an external link. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: isTeamsDeepLink summary: Indicates whether this is a Teams Deep Link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: target summary: The URL of the link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index da5ead5e..24a233ec 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationAction summary: Interface for Viva Get Location action remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 11f08291..54795285 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get location Action is executed. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: location summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index b26e3b57..bed10651 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationActionParameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: chooseLocationOnMap summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index a2bf7f3d..38f28644 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IGetLocationCardAction summary: Invoke an `VivaAction.GetLocation` event. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Get Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index 66c89e57..3a804782 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: imageUrl summary: The image URL to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index 0d3fe670..797238f4 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocation summary: Interface for location coordinates remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: accuracy summary: Accuracy of the location. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: latitude summary: Latitude of the location. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: longitude summary: Longitude of the location. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: timestamp summary: Timestamp remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml index 8a87e77e..36ea9b96 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ILocationErrorArguments summary: This object represents the error data that the Location action can throw. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: error summary: Error codes specific to the Get Location Error remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml index 8b1957b2..328c40f1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -7,7 +7,7 @@ summary: >- The data parameters for [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: description summary: The description to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: primaryText summary: The primary text to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index b024b3f8..f072dbe3 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewCardAction summary: Open the quick view. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the quick view opened by this action remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this action opens the quick view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml index 0b4a1ba2..43b12c49 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IQuickViewParameters summary: Parameters for opening a Quick view. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: view summary: The view of the Quick view to open. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index 73c146ad..da34ac07 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAction summary: Interface for new Viva Select Media action remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be provided to the ISelectMedia Action remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Location button. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index 185353cb..ef82a403 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `SelectMedia` Action is executed. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: data summary: Submit Action data that is passed to internal action handler to ensure forms do not clear. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml index 61f576e1..a7147d51 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionErrorArguments summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: error summary: Error codes specific to the Select Media Action. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: media summary: media object returned media picker API remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml index 758f97ce..cc40544d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaActionParameters summary: Parameters that can be supplied with the Viva Select Media Action. remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: allowMultipleCapture summary: Allow multiple images to be selected. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: maxSizePerFile summary: Max file size that can be uploaded. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: mediaType summary: Specify the specific media type that should be selected remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: supportedFileFormats summary: File formats supported for upload. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index a9d3b142..3a9072c6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaAttachment summary: This object represents the data returned by the native media picker API. remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: content summary: Content of the file represented as base64Strings remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: error summary: Error associated with attachment remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: fileName summary: The names of the selected files. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 52e0778d..8760d915 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISelectMediaCardAction summary: Invoke an `VivaAction.SelectMedia` event. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters for the Select Media Action remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva Select Media button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index 35272400..750f2b26 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` Action is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index 128ddaf2..a291b0a0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationAction summary: Interface for Viva Show Location action remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index ef68fc7f..1ee051a8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationActionParameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: locationCoordinates summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 5cd24b7d..62f7eb94 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: IShowLocationCardAction summary: Invoke an `VivaAction.ShowLocation` event. remarks: API under active development and not ready for use. -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: parameters summary: Parameters that can be supplied with the Viva Show Location Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: type summary: Indicates this is a Viva show Location button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index d0096adb..15e06000 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISPFxAdaptiveCard summary: SPFx Adaptive Card Extension schema for Adaptive Cards. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: actions summary: Types of actions being exposed remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index 2c6b58f9..bf9691a0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -8,7 +8,7 @@ summary: >- [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` Action is executed. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: data summary: The data object defined in the Adaptive Card template remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: type summary: The type of Adaptive Card Action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index 70c67960..c8fa935d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardAction summary: Invoke an `Action.Submit` event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: confirmationDialog summary: Confirmation dialog option passed to the submit handler. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: parameters summary: Parameters passed to the Submit event handler. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: type summary: Indicates this is a Submit button. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml index 3c9c622a..7ee1c485 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ISubmitCardParameters summary: Parameters for submit card action. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml index 8b1a7ec5..398a8974 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: MediaType summary: Enum value to specify the type of media. remarks: API under active development and not ready for use. -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index 672f6c29..d1853e83 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -10,7 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `QuickViewNavigator` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ methods: fullName: close() summary: Closes the View. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml index 46193b1d..6d5e51fa 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: RenderType summary: '`Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type RenderType = 'Card' | 'QuickView'; diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index ff4fd497..7738b592 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ViewNavigator summary: Manages a stack of views. remarks: The top of the stack represents the currently rendered view. -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' summary: Constructs a new instance of the `ViewNavigator` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: currentId summary: Get the id of the currently rendered View from the top of the View stack remarks: 'If the stack is empty, this will return undefined' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: size summary: Current size of the View stack. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ methods: fullName: 'register(id, initializer)' summary: Registers a new view. remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' - example: [] + isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ methods: [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 3b12e5c0..8c314cb6 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -14,7 +14,7 @@ remarks: >- The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to ensure that extensibility components only rely on interactions that would be portable across all applications. -example: [] + isPreview: false isDeprecated: false type: class @@ -31,7 +31,7 @@ constructors: context, for example [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ events: remarks: >- This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has navigated to a new page. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 42efb081..beeddf8e 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApplicationCustomizerContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: application summary: Provides access to the client-side application that is currently running. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: placeholderProvider summary: Exposes a collection of content placeholders for use by third parties. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: fullName: dispose() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index da70bb21..d86e6f84 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -12,7 +12,7 @@ remarks: >- Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. -example: [] + isPreview: false isDeprecated: false type: class @@ -23,7 +23,7 @@ properties: fullName: context summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ methods: remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the method. - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index 2222f824..0af8fb9d 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -8,7 +8,7 @@ summary: >- [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) method. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index 83af8427..f79b33e8 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderContent` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: If the caller needs to be notified when the DOM element is disposed, use the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback. - example: [] + isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: fullName: isDisposed summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: fullName: name summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: application when the containing placeholder is disposed. Calling dispose() invokes the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index e4bf15c7..1a858e28 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- For more information about placeholders, see [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index cd43c1ad..f69809bd 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -23,7 +23,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlaceholderProvider` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ properties: fullName: isDisposed summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: fullName: placeholderNames summary: Returns the names of the currently available placeholders. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ methods: fullName: dispose() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ methods: The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ events: The application can change its list of available placeholders at any time. This means that the existing placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when they appear. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 32490a06..6fa0a6a4 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -7,7 +7,7 @@ summary: The base class for client-side components such as BaseClientSideWebPart remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponent` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: isDisposed summary: Returns true if the component has been already disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: fullName: manifest summary: Provides access to the manifest for the client-side component. virtual remarks: Child classes can override this with more specialized manifest types. - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 70d9865c..31aa9387 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseComponentContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -23,7 +23,7 @@ properties: fullName: aadHttpClientFactory summary: The instance of AadHttpClientFactory created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: fullName: aadTokenProviderFactory summary: The instance of AadTokenProviderFactory created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: fullName: dynamicDataProvider summary: Returns the Dynamic Data Provider associated with the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: fullName: dynamicDataSourceManager summary: Returns the Dynamic Data Source Manager associated with the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -75,7 +75,7 @@ properties: fullName: httpClient summary: The instance of HttpClient created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ properties: A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ properties: fullName: isDisposed summary: Returns true if the context is disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: fullName: isServedFromLocalhost summary: Returns true if the solution is being served from localhost remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ properties: fullName: msGraphClientFactory summary: The instance of MSGraphClientFactory created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -158,7 +158,7 @@ properties: The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -171,7 +171,7 @@ properties: fullName: serviceScope summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. - example: [] + isPreview: false isDeprecated: false syntax: @@ -184,7 +184,7 @@ properties: fullName: spHttpClient summary: The instance of SpHttpClient created for this instance of component remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: fullName: dispose() summary: Disposes the base component context. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index d2a74da9..177d049e 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -7,7 +7,7 @@ summary: >- The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: isDisposed summary: Returns true if the Dynamic Data Provider is disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: dispose() summary: Disposes the Dynamic Data Provider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ methods: fullName: getAvailableSources() summary: Returns a list with all available Dynamic Data Sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: registerAvailableSourcesChanged(callback) summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -78,7 +78,7 @@ methods: fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' summary: Registers a callback for updates when a property is changed in a Dynamic Data source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ methods: Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -125,7 +125,7 @@ methods: fullName: tryGetSource(id) summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ methods: fullName: unregisterAvailableSourcesChanged(callback) summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -161,7 +161,7 @@ methods: fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -185,7 +185,7 @@ methods: fullName: 'unregisterSourceChanged(sourceId, callback)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index fda94fd6..a93e86d9 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -8,7 +8,7 @@ summary: >- of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ properties: fullName: isDisposed summary: Returns true if the DynamicDataSourceManager is disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: fullName: dispose() summary: Disposes the resources held by the Dynamic Data source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ methods: fullName: initializeSource(callableFunctions) summary: Initializes the Dynamic Data Source for the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ methods: When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ methods: Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 7333568c..bde0034a 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -8,7 +8,7 @@ remarks: >- This is built for usage in web part properties, and modified through the property pane. Can be initialized with a default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in the DynamicProperty will re-render the web part automatically. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: '(constructor)(provider, callback)' summary: Create a new DynamicProperty object. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ methods: fullName: hasDefaultCallback() summary: Returns true if the object has a default callback. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -97,7 +97,7 @@ methods: fullName: register(callback) summary: Registers a callback function for updates on the associated DynamicDataSource. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -115,7 +115,7 @@ methods: fullName: removeDefaultCallback() summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. - example: [] + isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ methods: Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: fullName: setValue(value) summary: Sets a static value in the DynamicProperty. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ methods: Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ methods: NOTE: This api will never return an array. To retrieve an array value, use the [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. - example: [] + isPreview: false isDeprecated: false syntax: @@ -210,7 +210,7 @@ methods: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. - example: [] + isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ methods: Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml index cdec3d93..12adbb24 100644 --- a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IComponentPropertyMetadata summary: This is the structure used for map values for component properties metadata. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -35,7 +35,7 @@ properties: Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 42894413..32fe6003 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyFontStyles summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml index f43a9e83..3ba7fbeb 100644 --- a/SP-Framework/sp-component-base/ireadonlyrawstyle.yml +++ b/SP-Framework/sp-component-base/ireadonlyrawstyle.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyRawStyle summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type IReadonlyRawStyle = Readonly; diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 82d6865d..12ae0647 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: IReadonlyTheme summary: Immutable ITheme. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml index fe67d541..3ce83b32 100644 --- a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ISerializedServerProcessedData summary: Contains collections of data that can be processed by server side services like search index and link fixup remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: 'myImage2': 'https://res.contoso.com/someName.jpg' } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: 'myFileLink': 'https://res.contoso.com/file.docx' } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: } ``` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index e6ebbf1c..a1b25c49 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ITheme summary: 'Collection of theme values, which can be used to programatically style components.' remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index f492c2e0..d8906823 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-component-base!' fullName: ThemeChangedEventArgs summary: The object passed when the IThemeProvider.themeChangedEvent is raised. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: theme summary: 'The new theme. If the value is undefined, then the theme was cleared.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index e4b2dccf..a54d1ec1 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -7,7 +7,7 @@ summary: >- The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: '(constructor)(serviceScope, theme)' summary: Construct a new instance of the ThemeProvider class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: serviceKey summary: The service key for ThemeProvider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ methods: fullName: tryGetTheme() summary: 'If set, get the current scoped theme.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ events: fullName: themeChangedEvent summary: Raised when the theme changes with the new theme as an argument. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 4a3bdea5..3f2446ae 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: DisplayMode summary: Indicates whether a visual control should display itself for reading or for editing. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index 5f63daa7..eecbb771 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Environment summary: Information about the system environment where the SharePoint Framework is running. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: type summary: Indicates the general type of environment where the SharePoint Framework is running. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index d0c0f3e9..2ea474b2 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -7,7 +7,7 @@ summary: Indicates the general type of environment where the SharePoint Framewor remarks: >- This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It provides a way to distinguish environments where certain functionality may be limited or disabled. -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/formdisplaymode.yml b/SP-Framework/sp-core-library/formdisplaymode.yml index 2c0be707..13f288c4 100644 --- a/SP-Framework/sp-core-library/formdisplaymode.yml +++ b/SP-Framework/sp-core-library/formdisplaymode.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: FormDisplayMode summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index a6d81f68..6a93ba06 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -11,7 +11,7 @@ remarks: >- See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: empty summary: Returns a new empty Guid instance. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: fullName: equals(guid) summary: Compare this instance to another Guid instance remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -121,7 +121,7 @@ methods: fullName: toString() summary: Returns a string representation of the GUID remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index d9ccbd42..21e9582c 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IDisposable summary: Implemented by an object that supports a disposal lifecycle. remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: dispose() summary: This method is called to permanently dispose the object. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index 93916995..c762740e 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -12,7 +12,7 @@ remarks: >- default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures are always repeatable. -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index d0f81a16..fbf6d5c9 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: IServiceCollection summary: A shorthand pattern for extracting well-known services from a ServiceScope. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -19,7 +19,7 @@ properties: fullName: serviceScope summary: Returns the underlying ServiceScope that the members belong to. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 465c9b32..78371800 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -11,7 +11,7 @@ remarks: >- SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements. -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: fullName: componentId summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: instanceId summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 2f0f6c0d..2d699790 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -9,7 +9,7 @@ remarks: >- [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index a08a630d..0a0b5371 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -8,7 +8,7 @@ remarks: >- The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and with context information. Context information helps identify which component generated the messages and allows for filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ methods: fullName: 'error(source, error, scope)' summary: Logs an error. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: fullName: 'info(source, message, scope)' summary: Logs a general informational message. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -75,7 +75,7 @@ methods: fullName: 'verbose(source, message, scope)' summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ methods: fullName: 'warn(source, message, scope)' summary: Logs a warning. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index f11546a5..5cb2553b 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -8,7 +8,7 @@ summary: >- [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls Math.random(). remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `RandomNumberGenerator` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: serviceKey summary: The service key for IRandomNumberGenerator. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ methods: fullName: generate() summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicecreator.yml b/SP-Framework/sp-core-library/servicecreator.yml index e81ec9e9..44bd57c6 100644 --- a/SP-Framework/sp-core-library/servicecreator.yml +++ b/SP-Framework/sp-core-library/servicecreator.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: ServiceCreator summary: This is a callback that is used by ServiceKey.createCustom(). remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 409b6de2..11f6e3e3 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -11,7 +11,7 @@ remarks: >- root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the new dependency. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: defaultCreator summary: A callback function that constructs the default instance of this service. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes. - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: The system does not assume that this string is unique. Instead, the [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ methods: remarks: >- If you want to specify custom constructor parameters, use [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ methods: fullName: 'createCustom(name, defaultCreator)' summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 09fa004d..7727ee51 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -43,7 +43,7 @@ remarks: >- worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when working with components that were contributed by various third parties without any coordination.) To avoid mistakes, it's best to always call consume() inside a callback from serviceScope.whenFinished(). -example: [] + isPreview: false isDeprecated: false type: class @@ -54,7 +54,7 @@ constructors: fullName: (constructor)(parent) summary: Constructs a new instance of the `ServiceScope` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ methods: Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ methods: This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -149,7 +149,7 @@ methods: inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ methods: fullName: getParent() summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -179,7 +179,7 @@ methods: remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. - example: [] + isPreview: false isDeprecated: false syntax: @@ -202,7 +202,7 @@ methods: remarks: >- The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. - example: [] + isPreview: false isDeprecated: false syntax: @@ -218,7 +218,7 @@ methods: Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ methods: NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 284ab208..56ed22f2 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Session summary: Provides access to the application's browser session and active page. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions. - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: clientSideApplicationId summary: The id of the currently running application remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: The concept of a page is subjective and defined by the router for a particular application. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index d7aa82d2..5ee2fa6c 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -22,7 +22,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPEvent` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -36,7 +36,7 @@ methods: The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: 'remove(observer, eventHandler)' summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 0c0d6c54..2068956c 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: SPEventArgs summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' -example: [] + isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 2eaf1dee..43d8decd 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-core-library!' fullName: Text_2 summary: Operations for working with strings that contain text. remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' -example: [] + isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ methods: `Text.format("hello {0}!", "world")` will return `"hello world!"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ methods: fullName: 'replaceAll(input, searchValue, replaceValue)' summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 6dd98724..3ad72aa4 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -7,7 +7,7 @@ summary: >- This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that simply calls the real browser APIs. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `TimeProvider` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: serviceKey summary: The service key for ITimeProvider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ methods: fullName: getDate() summary: 'Returns the current date/time, similar to the Date class constructor.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: fullName: getTimestamp() summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 76e091aa..84dd8eda 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -16,7 +16,7 @@ remarks: >- Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param with only equals (www.example.com/?=&debug=on stores empty string key and value -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. @@ -28,7 +28,7 @@ constructors: fullName: (constructor)(url) summary: Constructs a new instance of the `UrlQueryParameterCollection` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: getValue('debug') ---> 'false' getValue('lost') ---> undefined ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -84,7 +84,7 @@ methods: getValues('debug') ---> ['false'] getValues('lost') ---> undefined ``` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 643ac440..39cf943f 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -8,7 +8,7 @@ remarks: >- This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, Validate checks are always performed and will always throw an error, even in a production release. As such, be careful not to overuse these checks in a way that might impact performance. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ methods: fullName: 'isNonemptyString(value, variableName)' summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ methods: fullName: 'isNotDisposed(value, className)' summary: Throws an exception if the specified object has been disposed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ methods: fullName: 'isNotNullOrUndefined(value, variableName)' summary: Throws an exception if the specified value is null or undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ methods: fullName: 'isTrue(value, variableName)' summary: Throws an exception if the specified value is not true. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 54955dc2..905d760b 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -11,7 +11,7 @@ remarks: >- Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: major summary: Returns the first component of the version string. remarks: Typically a change in the major version number indicates a compatibility break with previous versions. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- Typically a change in the minor version number indicates that new features were added, while remaining backwards compatible with previous releases. - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: remarks: >- Typically a change in the patch version number indicates a small fix that does not affect the compatibility contract for the library. For a .NET System.Version object, this is referred to as the "build" number. - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: remarks: >- This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET version numbers. - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ methods: fullName: 'compare(v1, v2)' summary: Compares two Version objects to determine which version is newer. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -137,7 +137,7 @@ methods: 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -155,7 +155,7 @@ methods: fullName: isValid(versionString) summary: Test whether a string is a valid version specifier. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -181,7 +181,7 @@ methods: 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -199,7 +199,7 @@ methods: fullName: parse(versionString) summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -237,7 +237,7 @@ methods: 1.0.0 satisfies 1.1.0 -> false ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -257,7 +257,7 @@ methods: remarks: >- The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged. - example: [] + isPreview: false isDeprecated: false syntax: @@ -273,7 +273,7 @@ methods: Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index e5897c2c..f8dfcc71 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -12,7 +12,7 @@ remarks: >- controlled by this class by implementing the render method, the framework can decide when to show the dialog and how to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer to the documentation of the individual methods and properties to learn more about how to extend and use this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -47,7 +47,7 @@ constructors: // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: remarks: >- See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on rendering. - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ properties: remarks: >- This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -95,7 +95,7 @@ properties: If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: fullName: isSecondary summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - example: [] + isPreview: false isDeprecated: false syntax: @@ -142,7 +142,7 @@ methods: remarks: >- This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - example: [] + isPreview: false isDeprecated: false syntax: @@ -160,7 +160,7 @@ methods: the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - example: [] + isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ methods: This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. virtual remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. - example: [] + isPreview: false isDeprecated: false syntax: @@ -203,7 +203,7 @@ methods: you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. - example: [] + isPreview: false isDeprecated: false syntax: @@ -217,7 +217,7 @@ methods: fullName: show(options) summary: Request the framework to show this dialog. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index a9ca2e75..037b859a 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: Dialog summary: A static class for showing stock dialogs such as an alert or prompt. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index a714c2a7..f0776d09 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IAlertOptions summary: Options for showing an alert dialog remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 1a4913ce..506c535c 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogConfiguration summary: The interface for dialog configuration remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: isBlocking summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index 60ebd707..c457dc9b 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IDialogShowOptions summary: Options for showing a dialog remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 8fad9614..db80e8c2 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dialog!' fullName: IPromptOptions summary: Options for showing a prompt dialog remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: defaultValue summary: The default value for the input text field of prompt dialog remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index c5882bd7..44923ea8 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -15,7 +15,7 @@ remarks: >- See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for how to use this. -example: [] + isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ methods: Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ methods: Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ methods: is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index aaa803e4..eb51d395 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -10,7 +10,7 @@ remarks: |- The reference string is of the form `:` or `::` Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(reference) summary: Constructs a new instance of the `DynamicDataReference` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: property summary: Returns the referred property of the Dynamic Data. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: propertyPath summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: reference summary: Returns the full reference of the Dynamic Data object as a string. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: sourceId summary: Returns the referred id of the Dynamic Data Source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index 00df95c9..f81c472a 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -7,7 +7,7 @@ summary: >- Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: sampleValue summary: Sample value of a property remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 82c2f04d..526a4c6d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -7,7 +7,7 @@ summary: >- Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ methods: If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -39,7 +39,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ methods: fullName: getPropertyDefinitions() summary: Returns all the property definitions that the DataSource will provide. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: getPropertyValue(propertyId) summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index cb99692e..23349ff8 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -8,7 +8,7 @@ summary: |- It includes the name of the event and description to be seen and used by end users. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the event.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: name summary: Event name remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 2f979708..eb901142 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -7,7 +7,7 @@ summary: >- Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index 865b79fc..e6ba2a97 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyMetadata summary: Metadata of a property remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index cec346ee..2baf4fb8 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataPropertyValueMetadata summary: Metadata describing the sample value of the property. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: metadata summary: Metadata describing the sample value of the property. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index ad72cc5e..9aa2d027 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -74,7 +74,7 @@ remarks: >- } } ``` -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 36f0d714..f345518d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -7,7 +7,7 @@ summary: >- Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: id summary: Id of the Dynamic Data Source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: metadata summary: Metadata of the Dynamic Data Source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ methods: If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' @@ -89,7 +89,7 @@ methods: Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' @@ -126,7 +126,7 @@ methods: Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' @@ -165,7 +165,7 @@ methods: Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -188,7 +188,7 @@ methods: Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 046d071c..0db149ad 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-dynamic-data!' fullName: IDynamicDataSourceMetadata summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: description summary: 'User-friendly, localized description of the Dynamic Data Source.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ properties: User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 982619f7..16429f5f 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -7,7 +7,7 @@ summary: The base class for all client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseExtension` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization. - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ methods: fullName: onInit() summary: This event method is called when the client-side extension is first activated on the page. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index be76c4b0..b2819763 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -7,7 +7,7 @@ summary: The base class for context objects for client-side extensions. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtensionContext` class. -example: [] + isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 642b915d..6e71a276 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -10,7 +10,7 @@ remarks: >- For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: '(constructor)(serviceScope, resourceEndpoint, options)' summary: Constructs a new instance of the `AadHttpClient` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: fullName: configurations summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - example: [] + isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 3a830c3f..0217cb90 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 4e2199ce..6b60d00f 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadHttpClientFactory` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: serviceKey summary: The service key for AadHttpClientFactory. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml index 9ec22382..997a3597 100644 --- a/SP-Framework/sp-http/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -7,7 +7,7 @@ summary: >- The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends HttpClientResponse adding additional functionality specific to the AadHttpClient. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: '(constructor)(response, tokenFetchRequestTime)' summary: Constructs a new instance of the `AadHttpClientResponse` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 7cb10f04..7f2be121 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -15,7 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AadTokenProvider` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -29,7 +29,7 @@ methods: The OAuth2 token should not be cached by the caller since it is already cached by the method itself. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquisition requires user action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 17c2b48c..82e5a24b 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: AadTokenProviderFactory summary: Returns a preinitialized version of the AadTokenProviderFactory. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: serviceKey summary: The service key for AadTokenProviderFactory. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml index e24f3a38..0ba7695c 100644 --- a/SP-Framework/sp-http/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: BeforeRedirectEventArgs summary: Arguments for before redirecting for a full page authentication remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(redirectUrl, cancel)' summary: Constructs a new instance of the `BeforeRedirectEventArgs` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index e164b71a..43ac3d4e 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -13,7 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `DigestCache` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: fullName: serviceKey summary: The service key for IDigestCache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -125,7 +125,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 0799d982..78ca70c2 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -7,7 +7,7 @@ summary: >- Typings for the GraphRequest Object For more information: [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: _headers summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: _responseType summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: config summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: urlComponents summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ methods: fullName: buildFullUrl() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ methods: fullName: 'constructor(config, path)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ methods: fullName: count(count) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ methods: fullName: 'create(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -151,7 +151,7 @@ methods: fullName: del(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ methods: fullName: delete(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -187,7 +187,7 @@ methods: fullName: expand(properties) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -205,7 +205,7 @@ methods: fullName: filter(filterStr) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ methods: fullName: get(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -241,7 +241,7 @@ methods: fullName: getStream(callback) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -259,7 +259,7 @@ methods: fullName: 'header(headerKey, headerValue)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -280,7 +280,7 @@ methods: fullName: headers(headers) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -304,7 +304,7 @@ methods: fullName: orderby(properties) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -322,7 +322,7 @@ methods: fullName: parsePath(rawPath) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ methods: fullName: 'patch(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -361,7 +361,7 @@ methods: fullName: 'post(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -382,7 +382,7 @@ methods: fullName: 'put(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -403,7 +403,7 @@ methods: fullName: 'putStream(stream, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -424,7 +424,7 @@ methods: fullName: query(queryDictionaryOrString) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -448,7 +448,7 @@ methods: fullName: responseType(responseType) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -466,7 +466,7 @@ methods: fullName: select(properties) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -484,7 +484,7 @@ methods: fullName: skip(n) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -502,7 +502,7 @@ methods: fullName: skipToken(token) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -520,7 +520,7 @@ methods: fullName: top(n) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -538,7 +538,7 @@ methods: fullName: 'update(content, callback)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -559,7 +559,7 @@ methods: fullName: version(v) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index 4953c421..b8694933 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: HttpClient summary: HttpClient implements a basic set of features for performing REST operations against a generic service. remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `HttpClient` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: configurations summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: serviceKey summary: The service key for HttpClient. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -128,7 +128,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index 0614c245..a8d61ac7 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the predefined defaults from HttpClientConfigurations, however switches can also be changed via the HttpClientConfiguration.overrideWith() method. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: initializeFlags() summary: Child classes should override this method to initialize the flags object. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index ef686d3b..c49dd71f 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -10,7 +10,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HttpClientResponse` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: fullName: bodyUsed summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: headers summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: fullName: nativeResponse summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: fullName: ok summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: fullName: status summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -86,7 +86,7 @@ properties: fullName: statusText summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -99,7 +99,7 @@ properties: fullName: type summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -112,7 +112,7 @@ properties: fullName: url summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ methods: fullName: arrayBuffer() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ methods: fullName: blob() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -154,7 +154,7 @@ methods: fullName: clone() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -170,7 +170,7 @@ methods: fullName: formData() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -184,7 +184,7 @@ methods: fullName: json() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: fullName: text() summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index d1e6bc9a..6b613b33 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 48152dba..559c95b4 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index 65a00c23..0282510f 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadHttpClientOptions summary: Interface for overriding the default behavior of AadHttpClient. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: configuration summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' @@ -30,7 +30,7 @@ properties: fullName: tokenProvider summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' @@ -44,7 +44,7 @@ properties: fullName: useCachedToken summary: Allows the developer to specify if cached tokens should be use for the current request. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 79ee9cf5..0eefea69 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -13,7 +13,7 @@ remarks: >- AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to MSAL. -example: [] + isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ methods: An example of a resourceEndpoint would be https://sdfpilot.outlook.com remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ events: fullName: onBeforeRedirectEvent summary: Notifies the developer before a full page redirect occurs. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ events: fullName: tokenAcquisitionEvent summary: Notifies the developer when Token Acquistion requires user action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index 66c7042a..02ebbf22 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IAadTokenProviderConfiguration summary: Required strings for constructing an AadTokenProvider. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: aadInstanceUrl summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: aadSessionId summary: The current Azure Active Directory's session id. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: aadTenantId summary: The Azure Active Directory's tenant id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: servicePrincipalId summary: The client ID of the developer's Azure Active Directory application. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead @@ -117,7 +117,7 @@ properties: tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml index 7918d5bd..f71a0693 100644 --- a/SP-Framework/sp-http/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IBeforeRedirectEventArgs summary: Represents arguments used before redirecting event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: cancel summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page to redirect to if automatic redirect is cancelled remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 43b68a33..6b93c457 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -13,7 +13,7 @@ summary: >- For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ methods: automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: fullName: clearAllDigests() summary: Clears all values from the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ methods: Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index 4071f3b9..c47153d4 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: IHttpClientConfiguration summary: Flags interface for HttpClientConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index 77f7e2b3..f0134853 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index d5f7ca63..806932f9 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -7,7 +7,7 @@ summary: Options for HttpClient remarks: >- This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 8a3c049d..682b36c3 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchConfiguration summary: Flags interface for SPHttpClientBatchConfiguration. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index 13073937..cd02fa14 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- class. In general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: true isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: fullName: v1 summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index b12fd531..2c4eeeec 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientBatchCreationOptions summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index 4e39f93b..d2ac62c7 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -7,7 +7,7 @@ summary: >- This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index f9f21f72..07fb8754 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientCommonConfiguration summary: Flags interface for SPHttpClientCommonConfiguration remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index 47c0f89d..c6029b69 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ISPHttpClientConfiguration summary: Flags interface for SPHttpClientConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - example: [] + isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 0d21272d..3f373dd9 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -9,7 +9,7 @@ remarks: >- general, clients should choose the latest available version number, which enables all the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) -example: [] + isPreview: false isDeprecated: false type: interface @@ -25,7 +25,7 @@ properties: consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 2a35790a..93b34554 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -7,7 +7,7 @@ summary: >- This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index 8b22569d..ca0939ca 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ITokenAcquisitionEventArgs summary: Represents arguments used for raising a token acquisiton failure event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to interact with Azure AD. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 4c017214..5fa26570 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -17,7 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClient` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index fda63f07..6e028471 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientFactory` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: serviceKey summary: The service key for MSGraphClientFactory. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. Returns version 1 by default. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: 'Use getClient(''1'') instead, which has the same implementation but specifies the version explicitly.' @@ -56,7 +56,7 @@ methods: Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: Returns an instance of version 3 the MSGraphClient V3 that communicates with the current tenant's configurable Service Principal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/msgraphclientv3.yml b/SP-Framework/sp-http/msgraphclientv3.yml index 335e71f8..b496ed36 100644 --- a/SP-Framework/sp-http/msgraphclientv3.yml +++ b/SP-Framework/sp-http/msgraphclientv3.yml @@ -17,7 +17,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MSGraphClientV3` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -34,7 +34,7 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index 4a96308d..bf4b584b 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: ODataVersion summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: v3 summary: Represents version 3.0 for the "OData-Version" header remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: v4 summary: Represents version 4.0 for the "OData-Version" header remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -43,7 +43,7 @@ methods: fullName: toString() summary: 'Returns the "OData-Version" value, for example "4.0".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ methods: remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index ab624ee7..44f274cd 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -10,7 +10,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `SPHttpClient` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: serviceKey summary: The service key for SPHttpClient. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ methods: fullName: '_fetch(url, configuration, options)' summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ methods: fullName: beginBatch(batchCreationOptions) summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -133,7 +133,7 @@ methods: obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -165,7 +165,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "GET".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ methods: If the URL cannot be determined, an exception is thrown. - example: [] + isPreview: false isDeprecated: false syntax: @@ -226,7 +226,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to "POST".' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 8d784750..0ca41b92 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -15,7 +15,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPHttpClientBatch` class. -example: [] + isPreview: true isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: fullName: configurations summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -40,7 +40,7 @@ methods: fullName: execute() summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ methods: SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly. - example: [] + isPreview: true isDeprecated: false syntax: @@ -102,7 +102,7 @@ methods: fullName: 'get(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''GET''.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -134,7 +134,7 @@ methods: fullName: 'post(url, configuration, options)' summary: 'Calls fetch(), but sets the method to ''POST''.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 90a5793b..9a05ba91 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method. -example: [] + isPreview: true isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -71,7 +71,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 35f29ea3..9656a10a 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpClientCommonConfiguration summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - example: [] + isPreview: false isDeprecated: false syntax: @@ -95,7 +95,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index 4c28af0b..f8d01b40 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -9,7 +9,7 @@ remarks: >- SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ constructors: Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -47,7 +47,7 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: flags summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -114,7 +114,7 @@ methods: fullName: initializeFlags() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ methods: fullName: overrideWith(sourceFlags) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index ce02fd35..8f41cee5 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -8,7 +8,7 @@ remarks: |- This class is marked as `@sealed`. Subclasses should not extend it. This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(response) summary: Constructs a new instance of the `SPHttpClientResponse` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header. - example: [] + isPreview: true isDeprecated: false syntax: @@ -52,7 +52,7 @@ methods: fullName: clone() summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index f190da95..94b346d7 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: SPHttpHeader summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index d9aeafb8..04f4ed44 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-http!' fullName: TokenAcquisitionEventArgs summary: Arguments for a token acquisition failure event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(message, redirectUrl)' summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: message summary: The message returned from ADAL fails to retrieve a token from Azure AD. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: redirectUrl summary: The url of the page for the end user to perform Multi Factor Authentication remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 7a205135..16d864be 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: IImageHelperRequest summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint. - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: sourceUrl summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: width summary: Width of the image requested. remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 034e548f..3b69fa35 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-image-helper!' fullName: ImageHelper summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ methods: - The url will be most performant if only a width is provided. If a height is provided, the image will take longer to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 90c50b96..0a25ab34 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -12,7 +12,7 @@ summary: >- In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and the current domain, site and web will be used. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: fullName: callbacks summary: the list of callbacks remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: fullName: domain summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: fullName: listId summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current site will be used. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web will be used. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index 517074d1..fd55ce35 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: IListSubscription summary: A subscription to a SharePoint list resource. Contains the id of the subscription. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: The id of the subscription. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index 54eecff9..cc1390b0 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-list-subscription!' fullName: ISubscriptionCallbacks summary: The callbacks that can be triggered by a subscription event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: connect summary: The callback to invoke when a connection has been made to the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disconnect summary: The callback to invoke when the subscription is disconnected from the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: notification summary: The callback to invoke when a change occurs in the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index 712117d4..abee5bb4 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -7,7 +7,7 @@ summary: >- Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the subscription to handle subscription events. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ constructors: fullName: (constructor)(component) summary: Constructs a new instance of the `ListSubscriptionFactory` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: fullName: createSubscription(settings) summary: Creates a connection to the list specified by the site id and list id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ methods: fullName: deleteSubscription(subscription) summary: Deletes the subscription's connection to the resource. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 22784ff8..73e9f567 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -10,7 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "FieldCustomizer". remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ methods: fullName: onDisposeCell(event) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -56,7 +56,7 @@ methods: fullName: onRenderCell(event) summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml index bb7df5eb..53d57dce 100644 --- a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -7,7 +7,7 @@ summary: >- This is the base class that third parties should extend when implementing a client-side extension that provides a custom list form (display, new, edit) for a SharePoint list. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: displayMode summary: 'Display mode of the form: Edit, Display or New.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ properties: This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole DOM subtree of the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ methods: fullName: dispose() summary: Disposes the component. remarks: 'Please, do not override this method. Override the `onDispose` method instead.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -77,7 +77,7 @@ methods: fullName: formClosed() summary: Call this method after the form has been closed/cancelled to inform the application that the form has been closed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ methods: fullName: formSaved() summary: Call this method after the form has been saved to inform the application that the form has been saved. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ methods: This API is called to render the form. There is no base implementation of this API and the form is required to override this API. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 0807a241..16dbae19 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -12,7 +12,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseListViewCommandSet` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -26,7 +26,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ methods: This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ methods: fullName: onListViewUpdated(event) summary: This event occurs whenever the ListView state changes. virtual remarks: This event allows the implementor to tailor the visibility of the command. - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: Use context.listView.listViewStateChangedEvent instead. @@ -79,7 +79,7 @@ methods: fullName: raiseOnChange() summary: Use this method to fire OnChange event and initialize a reflow of the ListView. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: fullName: tryGetCommand(id) summary: Returns the command with the given id. Returns undefined if there is not command with the given id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 6d3d387d..d1be986f 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -14,7 +14,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ColumnAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: fullName: field summary: The server-side definition of the field. This property is read-only. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: fullName: visible summary: Whether to show this column in the list view. This property is read-only. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 8722ad8a..03b18054 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -11,7 +11,7 @@ remarks: >- [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command's appearance can be customized by assigning its properties, for example to hide a command that is not contextually relevant, or to pluralize the title based on the number of selected items. -example: [] + isPreview: false isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: disabled summary: Whether the command is currently disabled. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: id summary: Id of the command. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension. - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: visible summary: True if the command is visible. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index f2d89b85..990d6cae 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -7,7 +7,7 @@ summary: This object provides contextual information for BaseFieldCustomizer. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FieldCustomizerContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: field summary: Provides access to the SharePoint field that the customizer will operate on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: remarks: >- Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml index 0238dd0f..9ffe940d 100644 --- a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: FormCustomizerContext summary: Form Customizer Context. This object contains contxtual services and properties for the form. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ constructors: fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' summary: Constructs a new instance of the `FormCustomizerContext` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: contentType summary: The content type associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: domElement summary: The root DOM element of the form. This is a DIV element container for the custom form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: folderInfo summary: The folder information where the item is located/should be created. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: itemId summary: The item id of the item being edited or viewed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: list summary: The list associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml index 7796fa74..787a6227 100644 --- a/SP-Framework/sp-listview-extensibility/icolumn.yml +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IColumn summary: Provides information about the state of a column in the list view remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: isVisible summary: Whether the column is visible in the view remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/icontenttype.yml b/SP-Framework/sp-listview-extensibility/icontenttype.yml index 7331bf81..3dc6a33e 100644 --- a/SP-Framework/sp-listview-extensibility/icontenttype.yml +++ b/SP-Framework/sp-listview-extensibility/icontenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IContentType summary: Provides information about the content type remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: Content type string id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: name summary: Content type name remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: schemaXml summary: Content type schema XML remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 2a0262c1..1eb002d9 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFieldCustomizerCellEventParameters summary: Event parameters for BaseFieldCustomizer.onRenderCell() remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: fieldValue summary: The value of the field being rendered. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: listItem summary: The list item being edited. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -60,7 +60,7 @@ properties: For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml index 16c0b7f3..2740cd14 100644 --- a/SP-Framework/sp-listview-extensibility/ifilter.yml +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFilter summary: Provides information about the state of the filters applied to the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: fieldName summary: Field name to filter on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: values summary: Values to filter on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml index 0418a3f3..39ec33a1 100644 --- a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFolderInfo summary: Provides information about the state of the folder in the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: folderPath summary: Folder path. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml index 88deb6bd..2aaceb35 100644 --- a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IFormCustomizerContext summary: FormCustomizerContext-specific properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: contentType summary: The content type associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: domElement summary: The root DOM element of the form. This is a DIV element container for the custom form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: folderInfo summary: The folder information where the item is located/should be created. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: itemId summary: The item id of the item being edited or viewed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: list summary: The list associated with the form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml index 6b76e9d6..2bdb14be 100644 --- a/SP-Framework/sp-listview-extensibility/ilist.yml +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IList summary: Provides information about the list rendered by the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: guid summary: List id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: serverRelativeUrl summary: List server relative url. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: List title. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml index e3abce4c..27199457 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IListViewAccessorState summary: Provides information about the state of the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: appliedFilters summary: Applied filters information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: columns summary: Columns information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: folderInfo summary: Current folder information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: fullName: list summary: List information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: rows summary: Rows information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: selectedRows summary: Selected rows information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: sortAscending summary: Sort direction. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: sortField summary: Sort field name. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: view summary: View information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index 08711f5d..d4e72488 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -7,7 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 1ef89678..7ddfaee6 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -7,7 +7,7 @@ summary: >- Parameters for [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: selectedRows summary: 'The currently selected ListView rows, at the time when the event occurred.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml index 292be738..2ef0cf5f 100644 --- a/SP-Framework/sp-listview-extensibility/irow.yml +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IRow summary: Provides information about the list item's state rendered by the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: A map of column values for the row. They key is the column internal name and the value is its corresponding value in the row. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml index 52cc3cf2..76fc06f1 100644 --- a/SP-Framework/sp-listview-extensibility/iview.yml +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: IView summary: Provides information about the view rendered by the ListView. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: id summary: View id. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: title summary: View title. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: url summary: View server relative url. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 6474d853..f60ab4d0 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -18,7 +18,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListItemAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -32,7 +32,7 @@ properties: The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type. - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ methods: Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 82db4243..2b2f2241 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -7,7 +7,7 @@ summary: Provides access to a SharePoint ListView control. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: appliedFilters summary: Filters applied to the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: columns summary: 'The columns in associated with this view, including hidden columns.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: folderInfo summary: Folder information for the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: list summary: Basic information about the list rendered by the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: rows summary: Currently rendered rows in the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: selectedRows summary: Selected rows in the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -102,7 +102,7 @@ properties: fullName: sortAscending summary: Specifies whether the list view is sorted ascending or descending. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -115,7 +115,7 @@ properties: fullName: sortField summary: Sort field name remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -128,7 +128,7 @@ properties: fullName: view summary: Basic information about the view rendered by the list view. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ methods: Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ events: fullName: listViewStateChangedEvent summary: Event that gets raised every time the list view state changes. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -178,7 +178,7 @@ events: fullName: selectedRowsChangedEvent summary: Event that gets raised every time the selected items in the list view change. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml index bfd43c03..5051434f 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewAccessorStateChanges summary: Describes the type of list view state changes. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index fdbd44da..ab7fcfbe 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -7,7 +7,7 @@ summary: This object provides contextual information for BaseListViewCommandSet. remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ListViewCommandSetContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -18,7 +18,7 @@ properties: fullName: listView summary: Provides access to the ListView control that the customizer will operate on. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml index 08bf585d..d63dfa05 100644 --- a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: ListViewStateChangedEventArgs summary: Arguments for the list view state changed event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: prevState summary: Previous state of the ListView. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: stateChanges summary: Changes that were made to the ListView state. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 8443c4b5..8f09316c 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -15,7 +15,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RowAccessor` class. -example: [] + isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index bf56480c..a67de530 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-listview-extensibility!' fullName: SelectedRowsChangedEventArgs summary: Arguments for the selected rows changed event. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ properties: fullName: selectedRows summary: The list of rows that were selected in the list view at the time when the event was fired. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index 72fc2f1b..b514a0e5 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: ILoadScriptOptions summary: Options for the loadScript() method in ISPComponentLoader remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: globalExportsName summary: 'If set, the loaded script will be stored in a global variable under this name.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index 583aec40..a0de13b8 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-loader!' fullName: SPComponentLoader summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -16,7 +16,7 @@ methods: fullName: getManifests() summary: Returns static copies of all the manifests. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: this method will be removed in a future release. @@ -31,7 +31,7 @@ methods: fullName: loadComponent(manifest) summary: Loads a component from a manifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -49,7 +49,7 @@ methods: fullName: 'loadComponentById(id, version)' summary: 'Resolve a component id and version, and load it.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ methods: fullName: loadCss(url) summary: Inserts a `` tag for a stylesheet. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -93,7 +93,7 @@ methods: If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not be propagated. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-lodash-subset/cancelable.yml b/SP-Framework/sp-lodash-subset/cancelable.yml index f9271d4e..587f3078 100644 --- a/SP-Framework/sp-lodash-subset/cancelable.yml +++ b/SP-Framework/sp-lodash-subset/cancelable.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-lodash-subset!' fullName: Cancelable summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type Cancelable = Cancelable2; diff --git a/SP-Framework/sp-lodash-subset/throttlesettings.yml b/SP-Framework/sp-lodash-subset/throttlesettings.yml index bac184b0..4b3aa96b 100644 --- a/SP-Framework/sp-lodash-subset/throttlesettings.yml +++ b/SP-Framework/sp-lodash-subset/throttlesettings.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-lodash-subset!' fullName: ThrottleSettings summary: '' remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type ThrottleSettings = ThrottleSettings2; diff --git a/SP-Framework/sp-module-interfaces/componenttype.yml b/SP-Framework/sp-module-interfaces/componenttype.yml index 4d28b44b..e424082d 100644 --- a/SP-Framework/sp-module-interfaces/componenttype.yml +++ b/SP-Framework/sp-module-interfaces/componenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: ComponentType summary: Type of client-side component. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension'; diff --git a/SP-Framework/sp-module-interfaces/extensiontype.yml b/SP-Framework/sp-module-interfaces/extensiontype.yml index 14ff642a..6a9709e1 100644 --- a/SP-Framework/sp-module-interfaces/extensiontype.yml +++ b/SP-Framework/sp-module-interfaces/extensiontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: ExtensionType summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index 0803ef19..9495db4c 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IAdaptiveCardExtensionManifest summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: connectedSPFXAppId summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: connectedTeamsAppId summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: experimentalData summary: An untyped property bag for experimental flags not ready for production. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way. - example: [] + isPreview: true isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: } }] ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: fullName: supportedHosts summary: 'Definition: An array defining what host types are supported' remarks: 'Usage: Use this array to define all hosts that are supported.' - example: [] + isPreview: true isDeprecated: false syntax: @@ -149,7 +149,7 @@ properties: variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no ACEs support theme variants. - example: [] + isPreview: true isDeprecated: false syntax: @@ -170,7 +170,7 @@ properties: By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized logic, then it is recommended to override onAfterPropertiesUpdatedExternally. - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index ebb55270..bacd9f22 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -8,7 +8,7 @@ summary: >- pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes \["Medium", "Large"\] defined in the sp-adaptive-card-base project. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -160,7 +160,7 @@ properties: Example: "graph" - example: [] + isPreview: true isDeprecated: false syntax: @@ -185,7 +185,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -201,7 +201,7 @@ properties: group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - example: [] + isPreview: true isDeprecated: false syntax: @@ -238,7 +238,7 @@ properties: "zh": "我的 web 部件" } ``` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 2c66fcb9..47f1ef75 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideAssemblyManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: Supported values: any GUID Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 3f20b018..1e47ead0 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. It contains all data for loading an entrypoint script and its dependency scripts. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"myApplication.bundle"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Example: `mySpWebpart` - example: [] + isPreview: true isDeprecated: false syntax: @@ -95,7 +95,7 @@ properties: Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` - example: [] + isPreview: true isDeprecated: false syntax: @@ -147,7 +147,7 @@ properties: } } ``` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index acec9040..bdc313ef 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -21,7 +21,7 @@ remarks: >- - The `'manifestVersion'` should be bumped for all small or big changes. -example: [] + isPreview: false isDeprecated: false type: interface @@ -40,7 +40,7 @@ properties: Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, `"AdaptiveCardExtension"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: Usage: Loading a component. See `IClientSideComponentLoaderConfiguration` for more information and examples. - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts build after using spfx 1.1 don't need this. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: Usage: Requires Custom Script to be allowed in order for this component to be installed and run. - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: safeWithCustomScriptDisabled summary: This property is provided for backwards compatibility. It no longer has any effect. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. @@ -165,7 +165,7 @@ properties: Example: `"1.0.0"` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index d4d7999b..26180f8c 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideExtensionManifest summary: This is the manifest for a client-side extension. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index b030c628..ef8494c0 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideLibraryManifest summary: A library is defined by this manifest. Libraries currently do not have any additional properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index 5990ff09..18cb0af2 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideManifestBase summary: This interface defines members that are common between all deployable manifests. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: Example: `1` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index ad229c00..66580cc8 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -12,7 +12,7 @@ remarks: >- some required properties in the manifest and some optional properties. Optional properties need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and functionality problems. -example: [] + isPreview: false isDeprecated: false type: interface @@ -23,7 +23,7 @@ properties: fullName: canUpdateConfiguration summary: Indicates whether the web part uses the property pane to update the configuration of the web part. remarks: Default value is `true` if the property is not explicitly defined. - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: remarks: >- Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If this flag is true, the web part will not appear in the classic page web part gallery. - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts can be provisioned on pages though API or be added to the page in a pre configured way. - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module url - example: [] + isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ properties: } }] ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -134,7 +134,7 @@ properties: SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp cannot be used with TeamsTab or TeamsPersonalTab. - example: [] + isPreview: false isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed experiences require special treatment and testing. By default no web parts support full bleed experiences. - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ properties: variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no web parts support theme variants. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 10fd2d30..f494d54a 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -8,7 +8,7 @@ summary: >- instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -36,7 +36,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' - example: [] + isPreview: true isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -158,7 +158,7 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -183,7 +183,7 @@ properties: Example: "graph" - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ properties: This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - example: [] + isPreview: true isDeprecated: false syntax: @@ -259,7 +259,7 @@ properties: "zh": "我的 web 部件" } ``` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 54671bd9..27835310 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IClientSideWebPartManifestInstance summary: Manifest that is relevant to a Web Part instance. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index b7bfd964..fe94cf0b 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -7,7 +7,7 @@ summary: >- Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -40,7 +40,7 @@ properties: manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: fullName: title summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: type summary: Type of the item. Currently only "command" is allowed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index ec2fb4aa..b2d29568 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -7,7 +7,7 @@ summary: >- This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: remarks: >- The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 588cc149..1b9d4f6b 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This is the interface for a script module with the "component" type. Modules of this type will be provided via manifests. In order for the dependency to be loaded, the manifest must be available on the site. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: Supported values: string representing a component's ID. Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: type summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: Supported values: string representing a [semantic version](http://semver.org), or "latest". Example: `"2.2.4"` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iintegritypath.yml b/SP-Framework/sp-module-interfaces/iintegritypath.yml index 26aa101d..8cc60747 100644 --- a/SP-Framework/sp-module-interfaces/iintegritypath.yml +++ b/SP-Framework/sp-module-interfaces/iintegritypath.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IIntegrityPath summary: A path with the subresource integrity hash of the resource. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: The subresource integrity hash of the resource referenced in [IIntegrityPath.path](xref:@microsoft/sp-module-interfaces!IIntegrityPath%23path:member). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: path summary: The path to the resource. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 2c6ccf86..c43eb21d 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -8,7 +8,7 @@ remarks: >- Modules of this type must be provided by the component developer. These script resources are similar to those of the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as "internal" modules are. -example: [] + isPreview: true isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: fullName: type summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index bd2d777e..e97eb4c8 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -46,7 +46,7 @@ remarks: >- For more complex cases, run an appropriate expression to access your resource and return the string. -example: [] + isPreview: false isDeprecated: false type: interface @@ -57,7 +57,7 @@ properties: fullName: default summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: id summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index 7b077d49..ba7c1e51 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfiguration summary: '' remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml index 6574d072..2b78f22e 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: IModuleConfigurationBase summary: This is the base interface for a script module's definition. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -22,7 +22,7 @@ properties: Usage: Instructs the module loader to not preload this module. - example: [] + isPreview: true isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: Example: `"localized"` - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index f892b365..24aef5fe 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -7,7 +7,7 @@ summary: >- This is the interface for a script module with the "path" type. Modules of this type must be provided by the component developer. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -31,7 +31,7 @@ properties: Example: `["jquery"]` - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Example: `"$"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - example: [] + isPreview: true isDeprecated: false syntax: @@ -101,7 +101,7 @@ properties: fullName: type summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index c886cd6a..f16746fc 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-module-interfaces!' fullName: PredefinedGroup summary: Predefined web part group. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 982a63f3..52a34924 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: NameId summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: NameIdIssuer summary: 'Example: `"urn:office:idp:activedirectory"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 898f9f8c..064cd12b 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataBasePermission summary: Data used for creating a SPPermission object. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: High summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: Low summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index d1a7818a..6166cb38 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ChangeToken object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: StringValue summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml index 2b18c53d..2313fd7c 100644 --- a/SP-Framework/sp-odata-types/iodatacontenttype.yml +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataContentType summary: Represents OData SP.ContentType object. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ClientFormCustomFormatter summary: Custom formatter (JSON) for the content type forms remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: Description summary: Content type description remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: DisplayFormUrl summary: Content type display form URL remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: EditFormUrl summary: Content type edit form URL remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: Group summary: Content type group remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: Id summary: Content type ID remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: Name summary: Content type name remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: NewFormUrl summary: Content type new form URL remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: fullName: ReadOnly summary: Specifies whether content type is read-only remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -133,7 +133,7 @@ properties: fullName: SchemaXml summary: Content type schema XML remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ properties: fullName: StringId summary: Content type string id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 1914ab25..1e6e60f5 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ContextWebInformation object. For more information about this object, see [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: LibraryVersion summary: 'Example: `"16.0.4919.3000"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: SiteFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: SupportedSchemaVersions summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: WebFullUrl summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml index b328ab33..ad16f5b2 100644 --- a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-odata-types!' fullName: IODataFormsClientSideConfiguration summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: DislpayFormClientSideDisplayTarget summary: 'Display Form display target (new tab, panel)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: DisplayFormClientSideComponentId summary: Display Form Customizer component id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: DisplayFormClientSideComponentProperties summary: Display Form Customizer component properties remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: EditFormClientSideComponentId summary: Edit Form Customizer component id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: EditFormClientSideComponentProperties summary: Edit Form Customizer component properties remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: EditFormClientSideDisplayTarget summary: 'Edit Form display target (new tab, panel)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: NewFormClientSideComponentId summary: New Form Customizer component id remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: NewFormClientSideComponentProperties summary: New Form Customizer component properties remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: fullName: NewFormClientSideDisplayTarget summary: 'New Form display target (new tab, panel)' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 792fd292..d0289260 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.List object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: BaseTemplate summary: The list definition type on which the list is based. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Created summary: 'Example: `"/Date(1453294804000)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: CurrentChangeToken summary: The change token that will be used in logging the next change to the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: Description summary: A description of the List. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: EntityTypeName summary: 'Example: `"MyListTitleList"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: Id summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: LastItemDeletedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: fullName: LastItemModifiedDate summary: 'Example: `"/Date(1453294809000)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -137,7 +137,7 @@ properties: fullName: ListItemEntityTypeFullName summary: 'Example: `"SP.Data.MyListTitleListItem"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: fullName: ParentWebUrl summary: 'Example: `"/sites/PubSite"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ properties: fullName: TemplateFeatureId summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ properties: fullName: Title summary: 'Example: `"Pages"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index 9dc55986..e5fdedfa 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: ContentTypeId summary: 'Example: `{ StringValue: "0x010100C5..." }`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: fullName: ID summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: Title summary: Title of the List Item remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: UniqueId summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 7f9fd50d..22b8eccf 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.NavigationNode object. [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: Children summary: Gets or sets an array of Navigation Nodes that are children to the current node. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Id summary: Gets a value that specifies the identifier for the navigation node. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: IsDocLib summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: IsVisible summary: Gets or sets a value that specifies if the node navigation link should be visible. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: Title summary: Gets or sets a value that specifies the anchor text for the node navigation link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index ec5b1d3f..16073e68 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: quickLaunch summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: topNav summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index cde911b1..df984001 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.User object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: fullName: Email summary: 'Example: `"someone@example.com"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: Id summary: '' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: IsSiteAdmin summary: Boolean value that specifies whether the user is a site collection administrator. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: LoginName summary: 'Example: `"i:0#.w|domain\user"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: SharePointGroup: 8 All: 15 - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: Title summary: 'Example: `"DOMAIN\user"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index af02f1ab..b6830dd1 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -8,7 +8,7 @@ summary: >- here: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: fullName: ClientSideComponentId summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: Example: `"{ \"maxItemsToShow\": 123 }"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -53,7 +53,7 @@ properties: Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: fullName: Description summary: Gets or sets the description of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: ImageUrl summary: Gets or sets the URL of the image associated with the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: Location summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: RegistrationId summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: remarks: >- Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4. - example: [] + isPreview: false isDeprecated: false syntax: @@ -163,7 +163,7 @@ properties: fullName: Rights summary: Gets or sets the value that specifies the permissions needed for the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -176,7 +176,7 @@ properties: fullName: Scope summary: Gets a value that specifies the scope of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -189,7 +189,7 @@ properties: fullName: ScriptBlock summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -202,7 +202,7 @@ properties: fullName: ScriptSrc summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -217,7 +217,7 @@ properties: Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -230,7 +230,7 @@ properties: fullName: Title summary: Gets or sets the display title of the custom action. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -243,7 +243,7 @@ properties: fullName: Url summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -256,7 +256,7 @@ properties: fullName: VersionOfUserCustomAction summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 2bff7eea..2fb1f356 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -7,7 +7,7 @@ summary: >- Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -21,7 +21,7 @@ properties: Example: `"/Date(2016,0,20,12,58,7,0)/"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -34,7 +34,7 @@ properties: fullName: CurrentChangeToken summary: Represents the unique sequential location of a change within the change log. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: Description summary: Gets or sets the description for the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: fullName: IsMultilingual summary: Value that represents if the web was remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -108,7 +108,7 @@ properties: Example: `1033` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: Example: `"/Date(1453618828000)/"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ properties: Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: fullName: NoCrawl summary: Determines if a particular web will be crawled by search or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -166,7 +166,7 @@ properties: fullName: QuickLaunchEnabled summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -179,7 +179,7 @@ properties: fullName: RecycleBinEnabled summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -195,7 +195,7 @@ properties: Example: `"/sites/PubSite"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: fullName: SiteLogoUrl summary: Gets the url for the logo of this particular site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -221,7 +221,7 @@ properties: fullName: Title summary: The title of the web. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -237,7 +237,7 @@ properties: Example: `15` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -253,7 +253,7 @@ properties: Example: `"http://example.com/sites/PubSite"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -269,7 +269,7 @@ properties: Example: `"BLANKINTERNET"` remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 5a828f3e..6c4e493f 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CultureInfo` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -27,7 +27,7 @@ properties: Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the date as 1/8 instead of 8/1. - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to translate the word "hello" to "hola". - example: [] + isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: isRightToLeft summary: This boolean represents the dominant direction of written text for the default user interface language. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index b17520e3..f32298e2 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPSystemTime summary: Interface that represents a `SPSystemTime` structure. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: Day summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: DayOfWeek summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: Hour summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: Milliseconds summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: Minute summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: Month summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: Second summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: Year summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 24c4dfaa..16f17551 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: ISPTimeZoneData summary: Interface that represents the data necessary to build an `TimeZone` object. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: daylightDate summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: daylightOffset summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: description summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: id summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: offset summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: standardDate summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: standardOffset summary: '' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index ad7057bb..6c91922f 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -8,7 +8,7 @@ remarks: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. Typically the data is fetched via REST queries when navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. -example: [] + isPreview: false isDeprecated: false type: class @@ -19,7 +19,7 @@ constructors: fullName: (constructor)(serviceScope) summary: Constructs a new instance of the `PageContext` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: isInitialized summary: Returns whether the `PageContext` has been initialized. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -88,7 +88,7 @@ properties: NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object. - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -118,7 +118,7 @@ properties: Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ properties: fullName: serviceKey summary: The service key for PageContext. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -146,7 +146,7 @@ properties: fullName: site summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -161,7 +161,7 @@ properties: It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -174,7 +174,7 @@ properties: fullName: web summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spdayofweek-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml index 377eec5f..d5853a3d 100644 --- a/SP-Framework/sp-page-context/spdayofweek-typealias.yml +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-page-context!' fullName: SPDayOfWeek summary: The type members represent the seven days of a week. remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: 'export declare type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 5c163c3f..8885dcdb 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -11,7 +11,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPField` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: fullName: clientSideComponentId summary: The unique identifier of the client-side component associated with the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: displayName summary: The display name of the field. This name is shown as column name in UI. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: fieldType summary: The type of the field represented as a string remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: fullName: id summary: The GUID identifier for this field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -89,7 +89,7 @@ properties: fullName: internalName summary: The internal name of the field. This name is usually used to find the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -102,7 +102,7 @@ properties: fullName: isRequired summary: Whether the field is required for each list item in the list remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 97e758e5..6d78d688 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPList` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -22,7 +22,7 @@ properties: The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -63,7 +63,7 @@ properties: fullName: title summary: Returns the title for this `SPList`. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 6a1d03ff..47b0ce7c 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPListItem` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: id summary: The number that identifies the `SPListItem` on the server. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index a35cd9fd..3ba1704a 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -10,7 +10,7 @@ remarks: >- For more information, see: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: fullName: (constructor)(value) summary: Constructs a new instance of the `SPPermission` class remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation-compatible editor. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: fullName: addDelPrivateWebParts summary: Add or remove personal web parts on a web part Page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ properties: fullName: addListItems summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -78,7 +78,7 @@ properties: fullName: applyStyleSheets summary: Apply a style sheet (.css file) to the Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -91,7 +91,7 @@ properties: fullName: applyThemeAndBorder summary: Apply a theme or borders to the entire Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ properties: fullName: approveItems summary: Approve a minor version of a list item or document. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -117,7 +117,7 @@ properties: fullName: browseDirectories summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -130,7 +130,7 @@ properties: fullName: browserUserInfo summary: View information about users of the Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -143,7 +143,7 @@ properties: fullName: cancelCheckout summary: Discard or check in a document which is checked out to another user. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -156,7 +156,7 @@ properties: fullName: createAlerts summary: Create e-mail alerts. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -169,7 +169,7 @@ properties: fullName: createGroups summary: Create a group of users that can be used anywhere within the site collection. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -182,7 +182,7 @@ properties: fullName: createSSCSite summary: Create a Web site using Self-Service Site Creation. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -195,7 +195,7 @@ properties: fullName: deleteListItems summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -208,7 +208,7 @@ properties: fullName: deleteVersions summary: Delete past versions of a list item or document. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -223,7 +223,7 @@ properties: Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -236,7 +236,7 @@ properties: fullName: editMyUserInfo summary: 'Allows a user to change his or her user information, such as adding a picture.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -249,7 +249,7 @@ properties: fullName: emptyMask summary: Has no permissions on the Web site. Not available through the user interface. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -262,7 +262,7 @@ properties: fullName: enumeratePermissions summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -275,7 +275,7 @@ properties: fullName: fullMask summary: Has all permissions on the Web site. Not available through the user interface. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -288,7 +288,7 @@ properties: fullName: layoutsPage summary: View the layouts page? remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -301,7 +301,7 @@ properties: fullName: manageAlerts summary: Manage alerts for all users of the Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -314,7 +314,7 @@ properties: fullName: manageLists summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -327,7 +327,7 @@ properties: fullName: managePermissions summary: Create and change permission levels on the Web site and assign permissions to users and groups. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ properties: fullName: managePersonalViews summary: 'Create, change, and delete personal views of lists.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -353,7 +353,7 @@ properties: fullName: manageSubwebs summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -371,7 +371,7 @@ properties: of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. - example: [] + isPreview: false isDeprecated: false syntax: @@ -384,7 +384,7 @@ properties: fullName: open summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -397,7 +397,7 @@ properties: fullName: openItems summary: View the source of documents with server-side file handlers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -410,7 +410,7 @@ properties: fullName: updatePersonalWebParts summary: Update web parts to display personalized information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -423,7 +423,7 @@ properties: fullName: useClientIntegration summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -436,7 +436,7 @@ properties: fullName: useRemoteAPIs summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -449,7 +449,7 @@ properties: fullName: value summary: Returns the value of this SPPermission object remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -462,7 +462,7 @@ properties: fullName: viewFormPages summary: 'View forms, views, and application pages, and enumerate lists.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -475,7 +475,7 @@ properties: fullName: viewListItems summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -488,7 +488,7 @@ properties: fullName: viewPages summary: View pages in a Web site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -501,7 +501,7 @@ properties: fullName: viewUsageData summary: View reports on Web site usage. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -514,7 +514,7 @@ properties: fullName: viewVersions summary: View past versions of a list item or document. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -528,7 +528,7 @@ methods: fullName: hasAllPermissions(requestedPerms) summary: Function for testing whether a given permission mask has all of the requested permissions. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -546,7 +546,7 @@ methods: fullName: hasAnyPermissions(requestedPerms) summary: Function for testing whether a given permission mask has any of the requested permissions. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -564,7 +564,7 @@ methods: fullName: hasPermission(requestedPerm) summary: Function for testing whether a given permission mask has the requested permission. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index f42ff584..ce9786e7 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPSite` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: absoluteUrl summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: cdnPrefix summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: classification summary: Returns the classification of the site. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: correlationId summary: Returns the correlation id to the current server request. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: id summary: The GUID that identifies the SPSite on the server. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: isNoScriptEnabled summary: Returns true if isNoScript has been enabled on the SPSite. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: recycleBinItemCount summary: The amount of items in the recycle bin. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ properties: fullName: serverRequestPath summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' - example: [] + isPreview: false isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: fullName: sitePagesEnabled summary: Returns true if SitePages are enabled on this SPSite. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 932ac3ec..dd7fba10 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -19,7 +19,7 @@ remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPTimeZone` class. -example: [] + isPreview: true isDeprecated: false type: class @@ -30,7 +30,7 @@ properties: fullName: daylightDate summary: Gets the date on which daylight time begins for the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: description summary: Gets the description for the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: id summary: Gets the ID of the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -84,7 +84,7 @@ properties: fullName: offset summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -97,7 +97,7 @@ properties: fullName: standardDate summary: Gets the date on which standard time begins for the time zone. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -112,7 +112,7 @@ properties: Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC). remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index ab618111..7aee725b 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPUser` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: displayName summary: The display name for the current user. remarks: 'Example: `"John Doe"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: email summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: isAnonymousGuestUser summary: Returns if the current user is an anonymous guest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: isExternalGuestUser summary: Returns true if the current user is an external guest. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: loginName summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: preferUserTimeZone summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: timeZoneInfo summary: Returns the user's regional timezone settings or undefined if they haven't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index 8a9e9892..d83c54d6 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SPWeb` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: absoluteUrl summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: fullName: description summary: Returns the description of the current SPWeb. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: firstDayOfWeek summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: id summary: The GUID that identifies the SPWeb on the server. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: isAppWeb summary: Returns true if this `SPWeb` the container web for an `SPApp`. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: fullName: language summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: fullName: languageName summary: Returns the language name for the default language of the website. remarks: 'Example: en-US represents the English language in the US locale.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: logoUrl summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -139,7 +139,7 @@ properties: fullName: serverRelativeUrl summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -154,7 +154,7 @@ properties: Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -167,7 +167,7 @@ properties: fullName: timeZoneInfo summary: Returns the web's regional timezone settings or undefined if they haven't been set. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -180,7 +180,7 @@ properties: fullName: title summary: Returns the title of the current SPWeb. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index a256227a..4fb83f74 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -56,7 +56,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Button on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -104,7 +104,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - example: [] + isPreview: true isDeprecated: false syntax: @@ -153,7 +153,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -177,7 +177,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -206,7 +206,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -230,7 +230,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' @@ -255,7 +255,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -268,7 +268,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create an IconPicker on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -292,7 +292,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Label on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -316,7 +316,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Link on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -340,7 +340,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -364,7 +364,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -388,7 +388,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a ThumbnailPicker on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -412,7 +412,7 @@ functions: package: '@microsoft/sp-property-pane!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 186ec829..977268fc 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 60caae83..9f1934a9 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the shared property. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index c708a4a5..1487dafa 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -26,7 +26,7 @@ properties: When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index bd864d5a..471efee3 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the shared source. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: default value - 'Connect to source' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index f4805c4b..6e3b0a6f 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ properties: Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources. - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: The source id for a web part will be of the form WebPart.. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/iguidset.yml b/SP-Framework/sp-property-pane/iguidset.yml index a03c22e6..55d52f99 100644 --- a/SP-Framework/sp-property-pane/iguidset.yml +++ b/SP-Framework/sp-property-pane/iguidset.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IGuidSet summary: Set of GUIDs representing a list item. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: listId summary: List ID remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: siteId summary: Site ID remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: uniqueId summary: Unique ID within the list remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: webId summary: Web ID remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/imagefit.yml b/SP-Framework/sp-property-pane/imagefit.yml index ea911f33..9e3c5f0f 100644 --- a/SP-Framework/sp-property-pane/imagefit.yml +++ b/SP-Framework/sp-property-pane/imagefit.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: ImageFit summary: The possible methods that can be used to fit the image. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index 8c5cc183..c2d4b542 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPopupWindowProps summary: Popup window props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: height summary: Height of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: positionWindowPosition summary: The position of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: title summary: Title of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: width summary: Width of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index 80baf21f..e2dc3b1d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -19,7 +19,7 @@ properties: Besides the compound button, other button types will need more information provided to screen reader. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: fullName: ariaLabel summary: The aria label of the button for the benefit of screen readers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: buttonType summary: The type of button to render. Default value is ButtonType.normal. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: description summary: Description of the action this button takes. Only used for compound buttons. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: disabled summary: Whether the button is disabled. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -84,7 +84,7 @@ properties: fullName: icon summary: The button icon shown in command or hero type. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: text summary: Display text of the element. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index 9b51c17f..d9128e5a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: checked summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Whether the property pane checkbox is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: text summary: Label to display next to the checkbox. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index d4926fbc..d45f88b7 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: The aria label of the property pane choice group option for the benefit of screen readers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: Default value is false. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -45,7 +45,7 @@ properties: fullName: disabled summary: Whether the property pane choice group option is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -58,7 +58,7 @@ properties: fullName: iconProps summary: The Icon component props for choice field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -71,7 +71,7 @@ properties: fullName: imageSize summary: The width and height of the image in px for choice field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: fullName: imageSrc summary: The src of image for choice field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -105,7 +105,7 @@ properties: fullName: key summary: A required key to uniquely identify the option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -118,7 +118,7 @@ properties: fullName: selectedImageSrc summary: The src of image for choice field which is selected. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -131,7 +131,7 @@ properties: fullName: text summary: The text string for the option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index 4bfae47f..e5f71b77 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: officeFabricIconFontName summary: The name of the icon to use from the Office Fabric icon set. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 295550d2..0a407d31 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: label summary: Descriptive label for the choice group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: options summary: The options for the choice group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index 432c2fbb..f7ec8cc1 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: onShowPrimaryGroup summary: Callback when user clicks to show primary group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: onShowSecondaryGroup summary: Callback when user clicks to show secondary group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: primaryGroup summary: Primary group to show remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: secondaryGroup summary: Secondary group to show remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: showSecondaryGroup summary: Indicating whether the property pane should show primary group or the secondary group. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index d39cbbb5..783a42f1 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: currentPage summary: Page to be displayed on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -33,7 +33,7 @@ properties: part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other properties will be unaffected. - example: [] + isPreview: true isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: fullName: disableFocusTrap summary: Whether to disable trapping focus inside property pane. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: fullName: loadingIndicatorDelayTime summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. - example: [] + isPreview: false isDeprecated: false syntax: @@ -72,7 +72,7 @@ properties: fullName: pages summary: Total number of pages on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -92,7 +92,7 @@ properties: The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index 5f9fc1d8..067bbf8d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -41,7 +41,7 @@ properties: For more information, see the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: fullName: onDispose summary: This API is called when the component is unmounted from the host element. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: fullName: onRender summary: This API will be called once the custom field is mounted on the host element. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index b44432bb..54493568 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDebounceProperty summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired for this property. remarks: The default value is 500. - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: propertyName summary: Property to debounce. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index ffd7d218..2db0cbbc 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: calloutMaxHeight summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index f8c31b3b..c8d4154a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: index summary: Index for this option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: key summary: A key to uniquely identify this option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: text summary: Text to render for this option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index 36d8de4d..f1ce19ff 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: A description of the dropdown for the benefit of screen reader users. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: ariaSetSize summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: calloutProps summary: Custom properties for Dropdown's Callout used to render options. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: disabled summary: Whether the property pane dropdown option is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: errorMessage summary: 'If set, this will be displayed as an error message.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: label summary: Descriptive label for the Dropdown. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: options summary: Collection of options for this Dropdown. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: selectedKey summary: The key of the initially selected option. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml index 01ed3eb6..befafec8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' -example: [] + isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index fbe9c768..30c5b877 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: filters summary: Filters for the property pane dynamic field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the field.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -50,7 +50,7 @@ properties: the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field. - example: [] + isPreview: false isDeprecated: false syntax: @@ -66,7 +66,7 @@ properties: default value - 'Connect to source' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 6ba03709..307f3001 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: fields summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: label summary: 'User-friendly, localized label to identify the property.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: sharedConfiguration summary: Configuration shared between all the entries of the set. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 8e898425..7da99657 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' -example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' @@ -17,7 +17,7 @@ properties: fullName: ariaLabel summary: 'ARIA Label for text field, if any.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -30,7 +30,7 @@ properties: fullName: description summary: The text field input description. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -43,7 +43,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: Make sure to set this only if you want to see an error message displayed for the text field. - example: [] + isPreview: true isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -98,7 +98,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - example: [] + isPreview: true isDeprecated: false syntax: @@ -111,7 +111,7 @@ properties: fullName: placeholder summary: Placeholder text to be displayed in the text field. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -124,7 +124,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - example: [] + isPreview: true isDeprecated: false syntax: @@ -137,7 +137,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. - example: [] + isPreview: true isDeprecated: false syntax: @@ -152,7 +152,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 2ad7e288..15f655a2 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: properties summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: shouldFocus summary: Whether this control should be focused. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: targetProperty summary: Target property from the web part's property bag. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Type of the PropertyPane field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 843087a8..c2b495d1 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: groupFields summary: List of PropertyPane fields. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: remarks: >- For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left empty, the group header will not render (not recommended for accordions). - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: isCollapsed summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -59,7 +59,7 @@ properties: remarks: >- The default value is false. Use this option to skip the rendering of group name to avoid empty group header being displayed. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml index 11c75dc4..926012a9 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneIconPickerProps summary: PropertyPaneIconPicker component props remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: callerName summary: Optional name of consuming component for telemetry purposes. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: The icon picker allows selection of Fabric MDL2 icons. This optional parameter allows the caller to override this with a custom selection of icons. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: customSelectedIconName summary: 'When invoking with a custom icon set, this is the name of the currently selected icon.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: onItemChanged summary: Callback function for when an icon is selected. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: onItemDeleted summary: Callback function for when the Delete button is clicked. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: previewFullWidth summary: Whether to render the icon preview with full width or the default fixed aspect ratio. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: previewGrayBackground summary: Whether to render the icon with a gray background. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: thumbnail summary: Thumbnail metadata of the currently selected icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: thumbnailRendererIconClassName summary: Optional CSS class name to apply to the icon preview. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: thumbnailRendererWrapperClassName summary: Optional CSS class name to apply to the icon preview wrapper. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index 65e421ac..640a3b8f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: required summary: Whether the associated form field is required or not. remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: text summary: Display text fot the label. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 2e123827..36cebdab 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: disabled summary: Whether the property pane link is disabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: href summary: Location to which the link is targeted to. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: popupWindowProps summary: The props of pop up window. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -69,7 +69,7 @@ properties: \_top - Load the response into the original window. - example: [] + isPreview: false isDeprecated: false syntax: @@ -82,7 +82,7 @@ properties: fullName: text summary: Display text for the link. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 76f583e9..acca1669 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: displayGroupsAsAccordion summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: groups summary: List of groups to be displayed on the PropertyPane page. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: header summary: PropertyPane page header. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index 3c7d4728..b2c1f373 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: description summary: Header to display. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: image summary: Image url for the background image. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This property is not used. diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index ca093fc1..c7826e7f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: A description of the Slider for the benefit of screen readers. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Whether or not the Slider is disabled. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: label summary: Description label of the Slider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: max summary: The max value of the Slider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: min summary: The min value of the Slider. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: showValue summary: Whether to show the value on the right of the Slider. remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: step summary: The difference between the two adjacent values of the Slider. Defaults to 1. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: Defaults to min. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -129,7 +129,7 @@ properties: ``` is specified, the value of the Slider has % after it. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index a4cf23c0..9317b875 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: ariaLabel summary: 'Aria Label for text field, if any.' remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: deferredValidationTime summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: description summary: The text field input description. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: disabled summary: Whether the property pane text field is enabled or not. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -73,7 +73,7 @@ properties: So, make sure to set this only if you want to see an error message displayed for the text field. - example: [] + isPreview: false isDeprecated: false syntax: @@ -86,7 +86,7 @@ properties: fullName: label summary: Label for the text field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -119,7 +119,7 @@ properties: 2. The text length after each edit - example: [] + isPreview: false isDeprecated: false syntax: @@ -140,7 +140,7 @@ properties: fullName: maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -153,7 +153,7 @@ properties: fullName: multiline summary: Whether or not the text field is a multiline text field. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -177,7 +177,7 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - example: [] + isPreview: false isDeprecated: false syntax: @@ -190,7 +190,7 @@ properties: fullName: placeholder summary: placeholder text to be displayed in the text field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -203,7 +203,7 @@ properties: fullName: resizable summary: Whether or not the multiline text field is resizable. remarks: The default value is true. - example: [] + isPreview: false isDeprecated: false syntax: @@ -216,7 +216,7 @@ properties: fullName: rows summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. - example: [] + isPreview: false isDeprecated: false syntax: @@ -229,7 +229,7 @@ properties: fullName: underlined summary: Whether or not the text field is underlined. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -242,7 +242,7 @@ properties: fullName: validateOnFocusIn summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -255,7 +255,7 @@ properties: fullName: validateOnFocusOut summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -270,7 +270,7 @@ properties: Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml index 9e8dbcb0..afa840b9 100644 --- a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneThumbnailPickerProps summary: PropertyPaneThumbnailPicker component props remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: callerName summary: Optional name of consuming component for telemetry purposes. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: If an asset from the current site is selected, the URL can be returned as a relative URL. This option forces the URL to be returned as an absolute URL. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -44,7 +44,7 @@ properties: fullName: onItemChanged summary: Callback function for when an image has been selected. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -57,7 +57,7 @@ properties: fullName: onItemDeleted summary: Callback for when the Delete button is clicked. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: fullName: previewFullWidth summary: 'For the preview image, display with full width as opposed to the default fixed ratio.' remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: fullName: previewGrayBackground summary: Whether to display a gray background when rendering an icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -96,7 +96,7 @@ properties: fullName: serviceScope summary: Service scope. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -109,7 +109,7 @@ properties: fullName: thumbnail summary: Thumbnail metadata of the currently selected thumbnail. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: fullName: thumbnailRendererIconClassName summary: Optional CSS class name to apply to the thumbnail preview when an icon is being rendered. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: fullName: thumbnailRendererWrapperClassName summary: Optional CSS class name to apply to the wrapper of the thumbnail preview. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index e3c2aa91..ca90e3ec 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: checked summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: disabled summary: Optional disabled flag. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: key summary: A key to uniquely identify the field. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: label summary: A label for the toggle. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: offAriaLabel summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -81,7 +81,7 @@ properties: fullName: offText summary: Test display when toggle is OFF. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -94,7 +94,7 @@ properties: fullName: onAriaLabel summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: fullName: onText summary: Text to display when toggle is ON. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnail.yml b/SP-Framework/sp-property-pane/ithumbnail.yml index e5670cd8..639c639b 100644 --- a/SP-Framework/sp-property-pane/ithumbnail.yml +++ b/SP-Framework/sp-property-pane/ithumbnail.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnail summary: The type of thumbnail image being configured. remarks: '' -example: [] + isPreview: true isDeprecated: false syntax: export declare type IThumbnail = IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage; diff --git a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml index 67ada762..8d2dad84 100644 --- a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailFabricReactIcon summary: Options related to fabric icon thumbnail. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconColor summary: The background color for the icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: iconName summary: The name of the icon to render. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Fabric icon type. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml index 3744aa1f..75bc6e19 100644 --- a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailIconSizeImage summary: Options related to icon sized image thumbnail. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: iconColor summary: Background color to use for the icon. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: iconUrl summary: URL pointing to the icon-size image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: type summary: Image type. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ithumbnailimage.yml b/SP-Framework/sp-property-pane/ithumbnailimage.yml index 7a476525..f52b101c 100644 --- a/SP-Framework/sp-property-pane/ithumbnailimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: IThumbnailImage summary: Options related to image thumbnail. remarks: '' -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: altText summary: Alt text for the image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: backupImageUrl summary: Optional backup image URL if the original image URL fails to load. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -42,7 +42,7 @@ properties: fullName: imageFit summary: How the image should fit. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ properties: fullName: imageUrl summary: URL pointing to the image. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -68,7 +68,7 @@ properties: fullName: type summary: Image type. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index 181d60f3..c21c4d0c 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PopupWindowPosition summary: The position of pop up window. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index f6c1af58..b28f7aba 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 78062421..5bad4681 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -7,7 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 44cdb99d..2a4fba58 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -8,7 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' -example: [] + isPreview: false isDeprecated: false fields: diff --git a/SP-Framework/sp-property-pane/thumbnailtype.yml b/SP-Framework/sp-property-pane/thumbnailtype.yml index 20bd46a6..90495bd3 100644 --- a/SP-Framework/sp-property-pane/thumbnailtype.yml +++ b/SP-Framework/sp-property-pane/thumbnailtype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-property-pane!' fullName: ThumbnailType summary: Supported thumbnail image types. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index f95a2a90..8a59dd11 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -10,7 +10,7 @@ summary: >- In the component manifest, the "extensionType" should be set to "SearchQueryModifier". remarks: '' -example: [] + isPreview: true isDeprecated: false type: class @@ -24,7 +24,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: true isDeprecated: false syntax: @@ -39,7 +39,7 @@ properties: Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the original query will be used instead of the modified one. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -55,7 +55,7 @@ methods: fullName: 'modifySearchQuery(query, scenario)' summary: Returns a modified search query. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index 034e43dc..20c25567 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: IQuery summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. remarks: Additional properties can be added to the object to pass data between extensions. -example: [] + isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ properties: fullName: originalQueryText summary: Query text that the user provided. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: @@ -29,7 +29,7 @@ properties: fullName: queryText summary: Text of the query. remarks: '' - example: [] + isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index ad471c5c..f2b0828b 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryModifierContext summary: Context for the search query modifier extensions. remarks: '' -example: [] + isPreview: true isDeprecated: false type: class diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index df857dc9..1cd79378 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-search-extensibility!' fullName: SearchQueryScenario summary: Scenario for the search query modifier. remarks: '' -example: [] + isPreview: true isDeprecated: false fields: diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 9830ca7e..18b36010 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -58,7 +58,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Button on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -85,7 +85,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Checkbox on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -112,7 +112,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Choice Group on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -143,7 +143,7 @@ functions: PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -167,7 +167,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dropdown on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -194,7 +194,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -226,7 +226,7 @@ functions: These fields can possibly share the same property based on the associated filters. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -253,7 +253,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic TextField on the PropertyPane. remarks: '' - example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: >- @@ -280,7 +280,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Horizontal Rule on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -296,7 +296,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Label on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -323,7 +323,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Link on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -350,7 +350,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Slider on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -377,7 +377,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a TextField on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -404,7 +404,7 @@ functions: package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Toggle on the PropertyPane. remarks: '' - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 9ca02294..030ac280 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -19,7 +19,7 @@ remarks: >- updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please refer to the documentation of the individual APIs to make the right decision. -example: [] + isPreview: false isDeprecated: false type: class @@ -33,7 +33,7 @@ constructors: It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ properties: returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. - example: [] + isPreview: false isDeprecated: false syntax: @@ -70,7 +70,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ properties: This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: The default value is false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -120,7 +120,7 @@ properties: This property indicates whether the web part was rendered from the persisted data (serialized state from the last time that the web part was saved) or not. remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -135,7 +135,7 @@ properties: This property indicates whether the web part has been rendered once or not. After the first time rendering, the value of this property is always true until a full re-render of the web part happens. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -150,7 +150,7 @@ properties: remarks: >- Web parts should utilize this property to perform operations such as any conditional styling of components based on the initial available width for the web part. - example: [] + isPreview: false isDeprecated: false syntax: @@ -164,7 +164,7 @@ methods: fullName: clearError() summary: This API should be used to clear the error message from the web part display area. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -182,7 +182,7 @@ methods: remarks: >- Web parts should utilize this method to perform operations such as potentially re-rendering components based on the new available width for the web part. - example: [] + isPreview: false isDeprecated: false syntax: @@ -209,7 +209,7 @@ methods: If the web part is initialized or re-initialized when switching to a different display mode then this lifecycle method is not called. Example: SharePoint Site Page. - example: [] + isPreview: false isDeprecated: false syntax: @@ -233,7 +233,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - example: [] + isPreview: false isDeprecated: false syntax: @@ -251,7 +251,7 @@ methods: remarks: >- Developers sould not call render in overridden method. It can lead to unpredicted re-flow of the web part. render will be called from the base class when needed. - example: [] + isPreview: false isDeprecated: false syntax: @@ -273,7 +273,7 @@ methods: This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -291,7 +291,7 @@ methods: initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -311,7 +311,7 @@ methods: This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index 5f396e40..c99cd52c 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -7,7 +7,7 @@ summary: >- This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow a common core between 2D and MR WebParts. remarks: '' -example: [] + isPreview: false isDeprecated: false type: class @@ -21,7 +21,7 @@ constructors: It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - example: [] + isPreview: false isDeprecated: false syntax: @@ -67,7 +67,7 @@ properties: The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -80,7 +80,7 @@ properties: fullName: description summary: Description of the WebPart remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -103,7 +103,7 @@ properties: NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane button is clicked. - example: [] + isPreview: false isDeprecated: false syntax: @@ -116,7 +116,7 @@ properties: fullName: displayMode summary: This property is the current display mode of the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -132,7 +132,7 @@ properties: that want to provide a valid preview image url need to override this API. The preview image url can be used to create a preview of the web part or of the page on which the web part is present. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -145,7 +145,7 @@ properties: fullName: properties summary: This property is the pointer to the custom property bag of the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -162,7 +162,7 @@ properties: remarks: >- See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more information about how to define metadata - example: [] + isPreview: false isDeprecated: false syntax: @@ -175,7 +175,7 @@ properties: fullName: title summary: Title of the WebPart remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -198,7 +198,7 @@ methods: See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -222,7 +222,7 @@ methods: 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including 'loadPropertyPaneResources' promise. - example: [] + isPreview: false isDeprecated: false syntax: @@ -249,7 +249,7 @@ methods: by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - example: [] + isPreview: false isDeprecated: false syntax: @@ -278,7 +278,7 @@ methods: This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -298,7 +298,7 @@ methods: some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. - example: [] + isPreview: false isDeprecated: false syntax: @@ -319,7 +319,7 @@ methods: If the web part is initialized or re-initialized when switching to a different display mode then this lifecycle method is not called. Example: SharePoint Site Page. - example: [] + isPreview: false isDeprecated: false syntax: @@ -341,7 +341,7 @@ methods: resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - example: [] + isPreview: false isDeprecated: false syntax: @@ -358,7 +358,7 @@ methods: This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. - example: [] + isPreview: false isDeprecated: false syntax: @@ -381,7 +381,7 @@ methods: - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - When the user switches web parts then the current web part gets this event. - example: [] + isPreview: false isDeprecated: false syntax: @@ -400,7 +400,7 @@ methods: - When the PropertyPane is opened. - When the user switches web parts then the new web part gets this event. - example: [] + isPreview: false isDeprecated: false syntax: @@ -416,7 +416,7 @@ methods: This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -443,7 +443,7 @@ methods: fullName: onPropertyPaneRendered() summary: This API is invoked when the PropertyPane is rendered. virtual remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index a20a586b..ce02474f 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -12,7 +12,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BaseWebPartContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: remarks: >- Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas. - example: [] + isPreview: true isDeprecated: false syntax: @@ -38,7 +38,7 @@ properties: fullName: manifest summary: Manifest for the client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 600ff48c..7b4efcba 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: DynamicDataSharedDepth summary: Enum for the possible values of shared depth of the dynamic data reference. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 40761f66..37f37142 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -7,7 +7,7 @@ summary: >- Interface to be implemented by a component that should display the loading indicator and error messages for a web part. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ methods: fullName: clearError(domElement) summary: Clear the webpart error message. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ methods: fullName: clearLoadingIndicator(domElement) summary: Clear the loading indicator. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -54,7 +54,7 @@ methods: fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' summary: Display a loading spinner. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -85,7 +85,7 @@ methods: fullName: 'renderError(domElement, error, clearDomElementCallback)' summary: Render the provided error message in the webpart container div. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index b251db60..c1d3dc4d 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyConfiguration summary: Configuration related to a shared property. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index 76c11b78..b2785cc7 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedPropertyFilters summary: Property pane dynamic data property filters. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 8dec184b..f247b9c0 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceConfiguration summary: Configuration related to a shared source. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index a58567d1..a62c555e 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IDynamicDataSharedSourceFilters summary: Property pane dynamic data source filters. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index be17e1ae..f2fdae3b 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IMicrosoftTeams summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) - example: [] + isPreview: false isDeprecated: false syntax: @@ -31,7 +31,7 @@ properties: fullName: teamsJs summary: Microsoft Teams SDK. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 97778dc3..6396ea40 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -7,7 +7,7 @@ summary: >- Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -18,7 +18,7 @@ methods: fullName: close() summary: This API should be used to close the PropertyPane to help configure the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ methods: fullName: isPropertyPaneOpen() summary: Returns true if the PropertyPane is open. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ methods: remarks: >- For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. - example: [] + isPreview: false isDeprecated: false syntax: @@ -62,7 +62,7 @@ methods: fullName: open() summary: This API should be used to open the PropertyPane to help configure the web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ methods: fullName: openDetails(context) summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' - example: [] + isPreview: false isDeprecated: false syntax: @@ -96,7 +96,7 @@ methods: remarks: >- This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index e7cf9f6c..6de500f5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneButtonProps summary: PropertyPane button props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index cea9643d..0380065f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCheckboxProps summary: PropertyPane CheckBox component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 2f4196c6..340b6219 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOption summary: PropertyPane ChoiceGroup option props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 3e5942f2..345e8d5f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupOptionIconProps summary: PropertyPane ChoiceGroup icon props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index a4cfa04d..5d6eca1c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneChoiceGroupProps summary: PropertyPane ChoiceGroup props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 20a3b896..293f8e6d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConditionalGroup summary: Property pane conditional group. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 6972d5a0..c37e1f69 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneConfiguration summary: Web part configuration settings remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index 27168147..be0046fc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneCustomFieldProps summary: PropertyPane CustomPropertyField props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 0df7e9ac..baea865f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownCalloutProps summary: PropertyPane dropdown callout properties. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index e53d1b59..8758beed 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownOption summary: PropertyPane drop down options. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index d22d661f..2dbcd2af 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDropdownProps summary: PropertyPane drop down component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 28e5fea0..088a650b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldFilters summary: Property pane dynamic field filters which is an intersection of both source and property filters. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 7cb4d1f4..2db3752f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldProps summary: PropertyPaneDynamicField props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 098e55e5..16573536 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicFieldSetProps summary: PropertyPane DynamicFieldSet props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index 0ee57f36..cf66c4cc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneDynamicTextFieldProps summary: '`PropertyPaneDynamicData` component props.' remarks: '' -example: [] + isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index 10976c2a..e72daa91 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneField summary: PropertyPane field. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index 9463e163..b379133d 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneGroup summary: PropertyPane group. Group is part of the PropertyPanePage. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index f343e4ee..a989e640 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLabelProps summary: PropertyPaneLabel component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 533f4891..9c42be76 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneLinkProps summary: PropertyPaneLink component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index fd99d165..e9345fa8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePage summary: PropertyPanePage interface. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index d289960c..fd82e384 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPanePageHeader summary: PropertyPane header. This header remains same for all the pages. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index 1bd769eb..4dfa04d0 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneSliderProps summary: PropertyPaneSliderProps component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index 1c29fea8..ee8fa3f6 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneTextFieldProps summary: PropertyPaneTextField component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index bacb7353..13981c98 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IPropertyPaneToggleProps summary: PropertyPaneToggle component props. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index 1e8f87c7..c9c5eae9 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: ISDKs summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -20,7 +20,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index b901b0ca..74f83a20 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -7,7 +7,7 @@ summary: >- This structure represents the part of the serialized state of a web part which is controlled by the web part. It is extended by IWebPartData which contains additional data added by the framework to the serialized data. remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -27,7 +27,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -52,7 +52,7 @@ properties: 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -83,7 +83,7 @@ properties: 'aBooleanProperty': true } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -110,7 +110,7 @@ properties: Example: `{ 'value': 'text value' }` - example: [] + isPreview: false isDeprecated: false syntax: @@ -123,7 +123,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index 78dfb218..ca01b289 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -8,7 +8,7 @@ remarks: >- A "context" object is a collection of well-known services and other objects that are likely to be needed by any business logic working with a component. Each component type has its own specialized extension of this interface, e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: >- @@ -22,7 +22,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -35,7 +35,7 @@ properties: fullName: httpClient summary: HttpClient instance scoped to this web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -48,7 +48,7 @@ properties: fullName: instanceId summary: Web part instance id. This is a globally unique value. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -61,7 +61,7 @@ properties: fullName: manifest summary: Manifest for the client-side web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -74,7 +74,7 @@ properties: fullName: pageContext summary: SharePoint page context. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -87,7 +87,7 @@ properties: fullName: propertyPane summary: Accessor for common web part property pane operations. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -100,7 +100,7 @@ properties: fullName: spHttpClient summary: SPHttpClient instance scoped to this web part. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -113,7 +113,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: webPartTag summary: Web part tag to be used for logging and telemetry. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index e597506b..20f9f523 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -8,7 +8,7 @@ remarks: >- When the `serialize()` API is called on a web part, the output should be this structure. The structure of the 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of properties it wants to serialize. -example: [] + isPreview: false isDeprecated: false type: interface @@ -28,7 +28,7 @@ properties: Example: `"1.0"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -46,7 +46,7 @@ properties: Supported values: string with the description. Example: `"Text"` - example: [] + isPreview: false isDeprecated: false syntax: @@ -76,7 +76,7 @@ properties: } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -107,7 +107,7 @@ properties: 'aBooleanProperty': true } ``` - example: [] + isPreview: true isDeprecated: false syntax: @@ -126,7 +126,7 @@ properties: fullName: id summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' - example: [] + isPreview: false isDeprecated: false syntax: @@ -144,7 +144,7 @@ properties: supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` - example: [] + isPreview: false isDeprecated: false syntax: @@ -165,7 +165,7 @@ properties: Example: `{ 'value': 'text value' }` - example: [] + isPreview: false isDeprecated: false syntax: @@ -178,7 +178,7 @@ properties: fullName: serverProcessedContent summary: The collections of data that can be processed by server side services like search index and link fixup remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -196,7 +196,7 @@ properties: Supported values: string less than 100 characters Example: `"Text"` - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 43b2f426..258717de 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -56,7 +56,7 @@ remarks: >- This will make SharePoint servers aware of the content of your properties and run services such as search indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web part property bag is automatically updated. -example: [] + isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 274814b6..3d58f18f 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: IWebPartPropertyMetadata summary: This is the structure used for map values in `IWebPartPropertiesMetadata` remarks: '' -example: [] + isPreview: false isDeprecated: false type: interface @@ -29,7 +29,7 @@ properties: Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 45622192..34b40ca1 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -5,7 +5,7 @@ package: '@microsoft/sp-webpart-base!' fullName: PropertyPaneButtonType summary: Enum for all the supported button types. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index f8ca6168..c8e3ba6b 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -7,7 +7,7 @@ summary: >- Specifies the type of option in a dropdown menu rendered by [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index 5339bf08..cfb7e8bd 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -8,7 +8,7 @@ summary: |- Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. remarks: '' -example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index dd7e90f1..97e4d38a 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -9,7 +9,7 @@ summary: >- remarks: >- The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebPartContext` class. -example: [] + isPreview: false isDeprecated: false type: class @@ -20,7 +20,7 @@ properties: fullName: domElement summary: Reference to the DOM element that hosts this client-side component. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -37,7 +37,7 @@ properties: remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - example: [] + isPreview: false isDeprecated: true customDeprecatedMessage: '- This function has been deprecated' @@ -51,7 +51,7 @@ properties: fullName: sdks summary: Conditional set of SDKs provided by SPFx dependent on the environment. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ properties: fullName: statusRenderer summary: Web part status renderer. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: @@ -79,7 +79,7 @@ properties: This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key. remarks: '' - example: [] + isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index eb71fde2..7a048b2f 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -8,7 +8,7 @@ remarks: >- This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor. -example: [] + isPreview: true isDeprecated: false fields: From 5be3280e269380a3ca345ef338beb8d9b1048d85 Mon Sep 17 00:00:00 2001 From: Alex Terentiev Date: Wed, 18 May 2022 13:41:21 -0700 Subject: [PATCH 55/55] beta.8 API --- SP-Framework/decorators.yml | 134 ++- .../office-ui-fabric-react-bundle.yml | 32 +- .../sp-adaptive-card-extension-base.yml | 243 +++- .../adaptivecardextensioncontext.yml | 138 ++- .../baseadaptivecardextension.yml | 1025 ++++++++++------- .../baseadaptivecardview.yml | 110 +- .../basebasiccardview.yml | 78 +- .../basecardview.yml | 166 ++- .../baseimagecardview.yml | 78 +- .../baseprimarytextcardview.yml | 78 +- .../baseview.yml | 381 +++--- .../cardsize.yml | 26 +- .../devicecontext.yml | 30 +- .../iactionarguments.yml | 66 +- .../iactionerror.yml | 35 +- .../iactionerrorarguments.yml | 63 +- ...daptivecardextensionpropertiesmetadata.yml | 25 +- ...iadaptivecardextensionpropertymetadata.yml | 29 +- .../iattachmenterror.yml | 39 +- .../ibaseactionarguments.yml | 68 +- .../ibaseactionerrorarguments.yml | 81 +- .../ibasecardparameters.yml | 74 +- .../ibasiccardparameters.yml | 51 +- .../icachedloadparameters.yml | 59 +- .../icachesettings.yml | 82 +- .../icardaction.yml | 67 +- .../icardbutton.yml | 97 +- .../iconfirmationdialog.yml | 55 +- .../iexternallinkcardaction.yml | 60 +- .../iexternallinkparameters.yml | 57 +- .../igetlocationaction.yml | 68 +- .../igetlocationactionarguments.yml | 96 +- .../igetlocationactionparameters.yml | 40 +- .../igetlocationcardaction.yml | 61 +- .../iimagecardparameters.yml | 69 +- .../ilocation.yml | 93 +- .../ilocationerrorarguments.yml | 94 +- .../iprimarytextcardparameters.yml | 69 +- .../iquickviewcardaction.yml | 60 +- .../iquickviewparameters.yml | 39 +- .../iselectmediaaction.yml | 66 +- .../iselectmediaactionarguments.yml | 118 +- .../iselectmediaactionerrorarguments.yml | 118 +- .../iselectmediaactionparameters.yml | 94 +- .../iselectmediaattachment.yml | 77 +- .../iselectmediacardaction.yml | 60 +- .../ishowcardactionarguments.yml | 53 +- .../ishowlocationaction.yml | 68 +- .../ishowlocationactionparameters.yml | 43 +- .../ishowlocationcardaction.yml | 61 +- .../ispfxadaptivecard.yml | 114 +- .../isubmitactionarguments.yml | 71 +- .../isubmitcardaction.yml | 80 +- .../isubmitcardparameters.yml | 21 +- .../mediatype.yml | 50 +- .../quickviewnavigator.yml | 54 +- .../rendertype.yml | 26 +- .../viewnavigator.yml | 215 ++-- SP-Framework/sp-application-base.yml | 47 +- .../applicationaccessor.yml | 93 +- .../applicationcustomizercontext.yml | 106 +- .../baseapplicationcustomizer.yml | 108 +- .../iplaceholdercreatecontentoptions.yml | 56 +- .../placeholdercontent.yml | 148 +-- .../sp-application-base/placeholdername.yml | 53 +- .../placeholderprovider.yml | 224 ++-- SP-Framework/sp-component-base.yml | 75 +- .../sp-component-base/basecomponent.yml | 175 +-- .../basecomponentcontext.yml | 316 ++--- .../sp-component-base/dynamicdataprovider.yml | 322 +++--- .../dynamicdatasourcemanager.yml | 215 ++-- .../sp-component-base/dynamicproperty.yml | 333 +++--- .../icomponentpropertymetadata.yml | 108 +- .../sp-component-base/ireadonlyfontstyles.yml | 50 +- .../sp-component-base/ireadonlyrawstyle.yml | 40 +- .../sp-component-base/ireadonlytheme.yml | 51 +- .../iserializedserverprocesseddata.yml | 113 +- SP-Framework/sp-component-base/itheme.yml | 29 +- .../themechangedeventargs.yml | 56 +- .../sp-component-base/themeprovider.yml | 159 ++- SP-Framework/sp-core-library.yml | 116 +- SP-Framework/sp-core-library/displaymode.yml | 44 +- SP-Framework/sp-core-library/environment.yml | 42 +- .../sp-core-library/environmenttype.yml | 77 +- .../sp-core-library/formdisplaymode.yml | 58 +- SP-Framework/sp-core-library/guid.yml | 210 ++-- SP-Framework/sp-core-library/idisposable.yml | 69 +- .../irandomnumbergenerator.yml | 54 +- .../sp-core-library/iservicecollection.yml | 49 +- .../sp-core-library/ispeventobserver.yml | 76 +- .../sp-core-library/itimeprovider.yml | 71 +- SP-Framework/sp-core-library/log.yml | 170 +-- .../sp-core-library/randomnumbergenerator.yml | 115 +- .../sp-core-library/servicecreator.yml | 40 +- SP-Framework/sp-core-library/servicekey.yml | 263 +++-- SP-Framework/sp-core-library/servicescope.yml | 407 ++++--- SP-Framework/sp-core-library/session.yml | 76 +- SP-Framework/sp-core-library/spevent.yml | 111 +- SP-Framework/sp-core-library/speventargs.yml | 22 +- SP-Framework/sp-core-library/text_2.yml | 84 +- SP-Framework/sp-core-library/timeprovider.yml | 133 ++- .../urlqueryparametercollection.yml | 109 +- SP-Framework/sp-core-library/validate.yml | 151 +-- SP-Framework/sp-core-library/version.yml | 388 ++++--- SP-Framework/sp-diagnostics.yml | 46 +- SP-Framework/sp-dialog.yml | 52 +- SP-Framework/sp-dialog/basedialog.yml | 321 +++--- SP-Framework/sp-dialog/dialog.yml | 102 +- SP-Framework/sp-dialog/ialertoptions.yml | 29 +- .../sp-dialog/idialogconfiguration.yml | 39 +- SP-Framework/sp-dialog/idialogshowoptions.yml | 38 +- SP-Framework/sp-dialog/ipromptoptions.yml | 47 +- .../sp-dialog/isecondarydialogprovider.yml | 164 ++- SP-Framework/sp-dynamic-data.yml | 61 +- .../sp-dynamic-data/dynamicdatareference.yml | 122 +- .../idynamicdataannotatedpropertyvalue.yml | 64 +- .../sp-dynamic-data/idynamicdatacallables.yml | 178 +-- .../idynamicdataeventdefinition.yml | 60 +- .../idynamicdatapropertydefinition.yml | 51 +- .../idynamicdatapropertymetadata.yml | 57 +- .../idynamicdatapropertyvaluemetadata.yml | 49 +- ...micdatapropertyvaluemetadatacollection.yml | 124 +- .../sp-dynamic-data/idynamicdatasource.yml | 355 +++--- .../idynamicdatasourcemetadata.yml | 111 +- SP-Framework/sp-extension-base.yml | 25 +- .../sp-extension-base/baseextension.yml | 108 +- .../sp-extension-base/extensioncontext.yml | 34 +- SP-Framework/sp-http.yml | 195 +++- SP-Framework/sp-http/aadhttpclient.yml | 230 ++-- .../sp-http/aadhttpclientconfiguration.yml | 109 +- SP-Framework/sp-http/aadhttpclientfactory.yml | 112 +- .../sp-http/aadhttpclientresponse.yml | 58 +- SP-Framework/sp-http/aadtokenprovider.yml | 147 ++- .../sp-http/aadtokenproviderfactory.yml | 97 +- .../sp-http/beforeredirecteventargs.yml | 89 +- SP-Framework/sp-http/digestcache.yml | 214 ++-- SP-Framework/sp-http/graphrequest.yml | 881 ++++++++------ SP-Framework/sp-http/httpclient.yml | 275 +++-- .../sp-http/httpclientconfiguration.yml | 123 +- SP-Framework/sp-http/httpclientresponse.yml | 415 ++++--- .../sp-http/iaadhttpclientconfiguration.yml | 29 +- .../sp-http/iaadhttpclientconfigurations.yml | 52 +- .../sp-http/iaadhttpclientoptions.yml | 83 +- SP-Framework/sp-http/iaadtokenprovider.yml | 143 ++- .../iaadtokenproviderconfiguration.yml | 167 +-- .../sp-http/ibeforeredirecteventargs.yml | 65 +- SP-Framework/sp-http/idigestcache.yml | 147 ++- .../sp-http/ihttpclientconfiguration.yml | 21 +- .../sp-http/ihttpclientconfigurations.yml | 52 +- SP-Framework/sp-http/ihttpclientoptions.yml | 34 +- .../isphttpclientbatchconfiguration.yml | 34 +- .../isphttpclientbatchconfigurations.yml | 52 +- .../isphttpclientbatchcreationoptions.yml | 39 +- .../sp-http/isphttpclientbatchoptions.yml | 38 +- .../isphttpclientcommonconfiguration.yml | 63 +- .../sp-http/isphttpclientconfiguration.yml | 86 +- .../sp-http/isphttpclientconfigurations.yml | 52 +- SP-Framework/sp-http/isphttpclientoptions.yml | 54 +- .../sp-http/itokenacquisitioneventargs.yml | 65 +- SP-Framework/sp-http/msgraphclient.yml | 72 +- SP-Framework/sp-http/msgraphclientfactory.yml | 187 ++- SP-Framework/sp-http/msgraphclientv3.yml | 66 +- SP-Framework/sp-http/odataversion.yml | 129 ++- SP-Framework/sp-http/sphttpclient.yml | 423 ++++--- SP-Framework/sp-http/sphttpclientbatch.yml | 259 +++-- .../sphttpclientbatchconfiguration.yml | 129 ++- .../sphttpclientcommonconfiguration.yml | 164 +-- .../sp-http/sphttpclientconfiguration.yml | 197 ++-- SP-Framework/sp-http/sphttpclientresponse.yml | 113 +- SP-Framework/sp-http/sphttpheader.yml | 34 +- .../sp-http/tokenacquisitioneventargs.yml | 89 +- SP-Framework/sp-image-helper.yml | 40 +- .../sp-image-helper/iimagehelperrequest.yml | 73 +- SP-Framework/sp-image-helper/imagehelper.yml | 51 +- SP-Framework/sp-list-subscription.yml | 37 +- .../icreatesubscriptionsettings.yml | 126 +- .../ilistsubscription.yml | 42 +- .../isubscriptioncallbacks.yml | 75 +- .../listsubscriptionfactory.yml | 118 +- SP-Framework/sp-listview-extensibility.yml | 123 +- .../basefieldcustomizer.yml | 111 +- .../baseformcustomizer.yml | 180 +-- .../baselistviewcommandset.yml | 166 +-- .../columnaccessor.yml | 71 +- .../sp-listview-extensibility/command.yml | 140 +-- .../fieldcustomizercontext.yml | 85 +- .../formcustomizercontext.yml | 163 +-- .../sp-listview-extensibility/icolumn.yml | 176 +-- .../icontenttype.yml | 75 +- .../ifieldcustomizercelleventparameters.yml | 97 +- .../sp-listview-extensibility/ifilter.yml | 67 +- .../sp-listview-extensibility/ifolderinfo.yml | 39 +- .../iformcustomizercontext.yml | 120 +- .../sp-listview-extensibility/ilist.yml | 78 +- .../ilistviewaccessorstate.yml | 260 +++-- ...stviewcommandsetexecuteeventparameters.yml | 76 +- ...iewcommandsetlistviewupdatedparameters.yml | 58 +- .../sp-listview-extensibility/irow.yml | 64 +- .../sp-listview-extensibility/iview.yml | 78 +- .../listitemaccessor.yml | 128 +- .../listviewaccessor.yml | 415 ++++--- .../listviewaccessorstatechanges.yml | 137 ++- .../listviewcommandsetcontext.yml | 78 +- .../listviewstatechangedeventargs.yml | 81 +- .../sp-listview-extensibility/rowaccessor.yml | 42 +- .../selectedrowschangedeventargs.yml | 61 +- SP-Framework/sp-loader.yml | 29 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 39 +- SP-Framework/sp-loader/spcomponentloader.yml | 200 ++-- SP-Framework/sp-lodash-subset.yml | 24 +- SP-Framework/sp-lodash-subset/cancelable.yml | 28 +- .../sp-lodash-subset/throttlesettings.yml | 28 +- SP-Framework/sp-module-interfaces.yml | 110 +- .../sp-module-interfaces/componenttype.yml | 28 +- .../sp-module-interfaces/extensiontype.yml | 30 +- .../iadaptivecardextensionmanifest.yml | 193 ++-- .../iadaptivecardextensionmanifestentry.yml | 197 ++-- .../iclientsideassemblymanifest.yml | 50 +- ...clientsidecomponentloaderconfiguration.yml | 115 +- .../iclientsidecomponentmanifest.yml | 177 +-- .../iclientsideextensionmanifest.yml | 53 +- .../iclientsidelibrarymanifest.yml | 33 +- .../iclientsidemanifestbase.yml | 56 +- .../iclientsidewebpartmanifest.yml | 205 ++-- .../iclientsidewebpartmanifestentry.yml | 218 ++-- .../iclientsidewebpartmanifestinstance.yml | 36 +- .../icommanddefinition.yml | 99 +- .../icommandsetextensionmanifest.yml | 100 +- .../icomponentmoduleconfiguration.yml | 109 +- .../sp-module-interfaces/iintegritypath.yml | 56 +- .../ilocalizedpathmoduleconfiguration.yml | 124 +- .../sp-module-interfaces/ilocalizedstring.yml | 102 +- .../imoduleconfiguration.yml | 48 +- .../imoduleconfigurationbase.yml | 54 +- .../ipathmoduleconfiguration.yml | 109 +- .../sp-module-interfaces/predefinedgroup.yml | 125 +- SP-Framework/sp-odata-types.yml | 73 +- SP-Framework/sp-odata-types/_iodatauserid.yml | 61 +- .../sp-odata-types/iodatabasepermission.yml | 55 +- .../sp-odata-types/iodatachangetoken.yml | 43 +- .../sp-odata-types/iodatacontenttype.yml | 229 ++-- .../iodatacontextwebinformation.yml | 97 +- .../iodataformsclientsideconfiguration.yml | 183 ++- SP-Framework/sp-odata-types/iodatalist.yml | 269 ++--- .../sp-odata-types/iodatalistitem.yml | 102 +- .../sp-odata-types/iodatanavigationnode.yml | 160 +-- .../iodatanavigationnodecollection.yml | 80 +- SP-Framework/sp-odata-types/iodatauser.yml | 152 +-- .../sp-odata-types/iodatausercustomaction.yml | 349 +++--- SP-Framework/sp-odata-types/iodataweb.yml | 352 +++--- SP-Framework/sp-page-context.yml | 106 +- SP-Framework/sp-page-context/cultureinfo.yml | 82 +- .../sp-page-context/ispsystemtime.yml | 166 +-- .../sp-page-context/isptimezonedata.yml | 151 +-- SP-Framework/sp-page-context/pagecontext.yml | 276 +++-- .../sp-page-context/spdayofweek-typealias.yml | 44 +- SP-Framework/sp-page-context/spfield.yml | 167 +-- SP-Framework/sp-page-context/splist.yml | 106 +- SP-Framework/sp-page-context/splistitem.yml | 48 +- SP-Framework/sp-page-context/sppermission.yml | 853 +++++++------- SP-Framework/sp-page-context/spsite.yml | 237 ++-- SP-Framework/sp-page-context/sptimezone.yml | 163 +-- SP-Framework/sp-page-context/spuser.yml | 188 +-- SP-Framework/sp-page-context/spweb.yml | 280 +++-- SP-Framework/sp-property-pane.yml | 888 +++++++++----- .../dynamicdatashareddepth.yml | 56 +- ...dynamicdatasharedpropertyconfiguration.yml | 42 +- .../idynamicdatasharedpropertyfilters.yml | 38 +- .../idynamicdatasharedsourceconfiguration.yml | 60 +- .../idynamicdatasharedsourcefilters.yml | 58 +- SP-Framework/sp-property-pane/iguidset.yml | 90 +- SP-Framework/sp-property-pane/imagefit.yml | 99 +- .../sp-property-pane/ipopupwindowprops.yml | 96 +- .../ipropertypanebuttonprops.yml | 168 +-- .../ipropertypanecheckboxprops.yml | 74 +- .../ipropertypanechoicegroupoption.yml | 194 ++-- ...propertypanechoicegroupoptioniconprops.yml | 39 +- .../ipropertypanechoicegroupprops.yml | 67 +- .../ipropertypaneconditionalgroup.yml | 114 +- .../ipropertypaneconfiguration.yml | 143 ++- .../ipropertypanecustomfieldprops.yml | 122 +- .../ipropertypanedebounceproperty.yml | 55 +- .../ipropertypanedropdowncalloutprops.yml | 39 +- .../ipropertypanedropdownoption.yml | 96 +- .../ipropertypanedropdownprops.yml | 194 ++-- .../ipropertypanedynamicfieldfilters.yml | 43 +- .../ipropertypanedynamicfieldprops.yml | 95 +- .../ipropertypanedynamicfieldsetprops.yml | 140 ++- .../ipropertypanedynamictextfieldprops.yml | 203 ++-- .../sp-property-pane/ipropertypanefield.yml | 97 +- .../sp-property-pane/ipropertypanegroup.yml | 100 +- .../ipropertypaneiconpickerprops.yml | 209 ++-- .../ipropertypanelabelprops.yml | 56 +- .../ipropertypanelinkprops.yml | 113 +- .../sp-property-pane/ipropertypanepage.yml | 96 +- .../ipropertypanepageheader.yml | 60 +- .../ipropertypanesliderprops.yml | 181 +-- .../ipropertypanetextfieldprops.yml | 336 +++--- .../ipropertypanethumbnailpickerprops.yml | 208 ++-- .../ipropertypanetoggleprops.yml | 174 +-- SP-Framework/sp-property-pane/ithumbnail.yml | 45 +- .../ithumbnailfabricreacticon.yml | 93 +- .../ithumbnailiconsizeimage.yml | 93 +- .../sp-property-pane/ithumbnailimage.yml | 119 +- .../sp-property-pane/popupwindowposition.yml | 80 +- .../propertypanebuttontype.yml | 109 +- .../propertypanedropdownoptiontype.yml | 60 +- .../propertypanefieldtype.yml | 235 ++-- .../sp-property-pane/thumbnailtype.yml | 60 +- SP-Framework/sp-search-extensibility.yml | 35 +- .../basesearchquerymodifier.yml | 139 ++- .../sp-search-extensibility/iquery.yml | 57 +- .../searchquerymodifiercontext.yml | 34 +- .../searchqueryscenario.yml | 47 +- SP-Framework/sp-webpart-base.yml | 906 ++++++++++----- .../sp-webpart-base/baseclientsidewebpart.yml | 428 +++---- SP-Framework/sp-webpart-base/basewebpart.yml | 557 +++++---- .../sp-webpart-base/basewebpartcontext.yml | 123 +- .../dynamicdatashareddepth.yml | 61 +- .../iclientsidewebpartstatusrenderer.yml | 165 +-- ...dynamicdatasharedpropertyconfiguration.yml | 52 +- .../idynamicdatasharedpropertyfilters.yml | 52 +- .../idynamicdatasharedsourceconfiguration.yml | 52 +- .../idynamicdatasharedsourcefilters.yml | 52 +- .../sp-webpart-base/imicrosoftteams.yml | 68 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 138 +-- .../ipropertypanebuttonprops.yml | 52 +- .../ipropertypanecheckboxprops.yml | 52 +- .../ipropertypanechoicegroupoption.yml | 52 +- ...propertypanechoicegroupoptioniconprops.yml | 52 +- .../ipropertypanechoicegroupprops.yml | 52 +- .../ipropertypaneconditionalgroup.yml | 52 +- .../ipropertypaneconfiguration.yml | 52 +- .../ipropertypanecustomfieldprops.yml | 52 +- .../ipropertypanedropdowncalloutprops.yml | 52 +- .../ipropertypanedropdownoption.yml | 52 +- .../ipropertypanedropdownprops.yml | 52 +- .../ipropertypanedynamicfieldfilters.yml | 52 +- .../ipropertypanedynamicfieldprops.yml | 52 +- .../ipropertypanedynamicfieldsetprops.yml | 52 +- .../ipropertypanedynamictextfieldprops.yml | 49 +- .../sp-webpart-base/ipropertypanefield.yml | 55 +- .../sp-webpart-base/ipropertypanegroup.yml | 52 +- .../ipropertypanelabelprops.yml | 52 +- .../ipropertypanelinkprops.yml | 52 +- .../sp-webpart-base/ipropertypanepage.yml | 52 +- .../ipropertypanepageheader.yml | 52 +- .../ipropertypanesliderprops.yml | 52 +- .../ipropertypanetextfieldprops.yml | 52 +- .../ipropertypanetoggleprops.yml | 52 +- SP-Framework/sp-webpart-base/isdks.yml | 41 +- .../iserializedwebpartdata.yml | 126 +- .../sp-webpart-base/iwebpartcontext.yml | 219 ++-- SP-Framework/sp-webpart-base/iwebpartdata.yml | 195 ++-- .../iwebpartpropertiesmetadata.yml | 81 +- .../iwebpartpropertymetadata.yml | 46 +- .../propertypanebuttontype.yml | 114 +- .../propertypanedropdownoptiontype.yml | 65 +- .../sp-webpart-base/propertypanefieldtype.yml | 240 ++-- .../sp-webpart-base/webpartcontext.yml | 147 ++- .../sp-webpart-base/webpartformfactor.yml | 55 +- 361 files changed, 25039 insertions(+), 17556 deletions(-) diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 2d1e8098..29d1904e 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -1,84 +1,132 @@ -### YamlMime:TSPackage -uid: '@microsoft/decorators!' -name: '@microsoft/decorators' -type: package -summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. -functions: - - name: 'override(target, propertyKey, descriptor)' - uid: '@microsoft/decorators!override:function(1)' - package: '@microsoft/decorators!' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/decorators!' + summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. + remarks: >- + This package provides a small set of decorators that enable more rigorous specification of API contracts when + using the TypeScript language. The intent is to better document expected behaviors and catch common mistakes. This + package is not intended to be a general toolkit of language extensions or helpful macros. + name: '@microsoft/decorators' + fullName: '@microsoft/decorators' + langs: + - typeScript + type: package + children: + - '@microsoft/decorators!override:function(1)' + - '@microsoft/decorators!sealed:function(1)' + - '@microsoft/decorators!virtual:function(1)' + - uid: '@microsoft/decorators!override:function(1)' summary: >- This decorator is applied to a class's member function or property. It indicates that the definition overrides another defintion (of the same name) from the base class. The base class definition must be marked as @virtual. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'override(target, propertyKey, descriptor)' + fullName: 'override(target, propertyKey, descriptor)' + langs: + - typeScript + type: function syntax: content: >- export declare function override(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void; + return: + type: + - void + description: '' parameters: - id: target description: '' - type: Object + type: + - '!Object:interface' + optional: false - id: propertyKey description: '' - type: string | symbol + type: + - string | symbol + optional: false - id: descriptor description: '' - type: TypedPropertyDescriptor<any> - return: - type: void - description: '' - - name: sealed(target) - uid: '@microsoft/decorators!sealed:function(1)' - package: '@microsoft/decorators!' + type: + - '@microsoft/decorators!override~0:complex' + optional: false + - uid: '@microsoft/decorators!sealed:function(1)' summary: >- This decorator is applied to a class (but NOT member function or property). It indicates that subclasses must not inherit from this class. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. - remarks: '' - - isPreview: false - isDeprecated: false + name: sealed(target) + fullName: sealed(target) + langs: + - typeScript + type: function syntax: content: 'export declare function sealed(target: Function): void;' + return: + type: + - void + description: '' parameters: - id: target description: '' - type: Function - return: - type: void - description: '' - - name: 'virtual(target, propertyKey, descriptor)' - uid: '@microsoft/decorators!virtual:function(1)' - package: '@microsoft/decorators!' + type: + - '!Function:interface' + optional: false + - uid: '@microsoft/decorators!virtual:function(1)' summary: >- This decorator is applied to a class's member function or property. It indicates that the definition may optionally be overridden in a child class. Conversely, if the @virtual decorator is NOT applied to a definition, then child classes may NOT override it. This decorator is currently used for documentation purposes only. In the future, it may be enforced at runtime. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'virtual(target, propertyKey, descriptor)' + fullName: 'virtual(target, propertyKey, descriptor)' + langs: + - typeScript + type: function syntax: content: >- export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor): void; + return: + type: + - void + description: '' parameters: - id: target description: '' - type: Object + type: + - '!Object:interface' + optional: false - id: propertyKey description: '' - type: string | symbol + type: + - string | symbol + optional: false - id: descriptor description: '' - type: TypedPropertyDescriptor<any> - return: - type: void - description: '' + type: + - '@microsoft/decorators!virtual~0:complex' + optional: false +references: + - uid: '!Object:interface' + name: Object + - uid: '@microsoft/decorators!override~0:complex' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + spec.typeScript: + - uid: '!TypedPropertyDescriptor:interface' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + - name: + fullName: + - uid: '!Function:interface' + name: Function + - uid: '@microsoft/decorators!virtual~0:complex' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + spec.typeScript: + - uid: '!TypedPropertyDescriptor:interface' + name: TypedPropertyDescriptor + fullName: TypedPropertyDescriptor + - name: + fullName: diff --git a/SP-Framework/office-ui-fabric-react-bundle.yml b/SP-Framework/office-ui-fabric-react-bundle.yml index c7606359..3af127fd 100644 --- a/SP-Framework/office-ui-fabric-react-bundle.yml +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -1,19 +1,23 @@ -### YamlMime:TSPackage -uid: '@microsoft/office-ui-fabric-react-bundle!' -name: '@microsoft/office-ui-fabric-react-bundle' -type: package -summary: '' -functions: - - name: initializeIcons() - uid: '@microsoft/office-ui-fabric-react-bundle!initializeIcons:function(1)' - package: '@microsoft/office-ui-fabric-react-bundle!' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/office-ui-fabric-react-bundle!' + name: '@microsoft/office-ui-fabric-react-bundle' + fullName: '@microsoft/office-ui-fabric-react-bundle' + langs: + - typeScript + type: package + children: + - '@microsoft/office-ui-fabric-react-bundle!initializeIcons:function(1)' + - uid: '@microsoft/office-ui-fabric-react-bundle!initializeIcons:function(1)' summary: Export a fake "initializeIcons" function to satisfy external dependencies that call initializeIcons(); - remarks: '' - - isPreview: false - isDeprecated: false + name: initializeIcons() + fullName: initializeIcons() + langs: + - typeScript + type: function syntax: content: 'export declare function initializeIcons(): void;' return: - type: void + type: + - void description: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml index 261cf273..b2d387d7 100644 --- a/SP-Framework/sp-adaptive-card-extension-base.yml +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -1,64 +1,179 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-adaptive-card-extension-base!' -name: '@microsoft/sp-adaptive-card-extension-base' -type: package -summary: SharePoint Framwork Adaptive Card Extensions -classes: - - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' - - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' - - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' - - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' -typeAliases: - - '@microsoft/sp-adaptive-card-extension-base!CardSize:type' - - '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' - - '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' - - '@microsoft/sp-adaptive-card-extension-base!IActionError:type' - - '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' - - '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' - - '@microsoft/sp-adaptive-card-extension-base!RenderType:type' -interfaces: - - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' - - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' - - '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' - - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' - - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' - - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' - - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' - - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' - - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' -enums: - - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!' + summary: SharePoint Framwork Adaptive Card Extensions + remarks: >- + This package defines the APIs for creating SPFx Adaptive Card Extensions. Adaptive Card Extensions are lightweight + data focused components, which utilize Adaptive Cards to deliver rich, native experiences. + name: '@microsoft/sp-adaptive-card-extension-base' + fullName: '@microsoft/sp-adaptive-card-extension-base' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + - '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + - '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + - '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + - '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + - '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' + - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + - '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + - '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + - '@microsoft/sp-adaptive-card-extension-base!RenderType:type' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + name: AdaptiveCardExtensionContext + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + name: BaseAdaptiveCardExtension + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + name: BaseAdaptiveCardView + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + name: BaseBasicCardView + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + name: BaseCardView + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + name: BaseImageCardView + - uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + name: BasePrimaryTextCardView + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + name: BaseView + - uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + name: CardSize + - uid: '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + name: DeviceContext + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + name: IActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + name: IActionError + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' + name: IActionErrorArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + name: IAdaptiveCardExtensionPropertiesMetadata + - uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + name: IAdaptiveCardExtensionPropertyMetadata + - uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' + name: IAttachmentError + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + name: IBaseActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' + name: IBaseActionErrorArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + name: IBaseCardParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + name: IBasicCardParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + name: ICachedLoadParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + name: ICacheSettings + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + name: ICardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + name: ICardButton + - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + name: IConfirmationDialog + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + name: IExternalLinkCardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + name: IExternalLinkParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + name: IGetLocationAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + name: IGetLocationActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + name: IGetLocationActionParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + name: IGetLocationCardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + name: IImageCardParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + name: ILocation + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' + name: ILocationErrorArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + name: IPrimaryTextCardParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + name: IQuickViewCardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + name: IQuickViewParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + name: ISelectMediaAction + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + name: ISelectMediaActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' + name: ISelectMediaActionErrorArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + name: ISelectMediaActionParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + name: ISelectMediaAttachment + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + name: ISelectMediaCardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + name: IShowCardActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + name: IShowLocationAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + name: IShowLocationActionParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + name: IShowLocationCardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + name: ISPFxAdaptiveCard + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + name: ISubmitActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + name: ISubmitCardAction + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + name: ISubmitCardParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + name: MediaType + - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + name: QuickViewNavigator + - uid: '@microsoft/sp-adaptive-card-extension-base!RenderType:type' + name: RenderType + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + name: ViewNavigator diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index 89203738..4e1957c1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -1,67 +1,107 @@ -### YamlMime:TSType -name: AdaptiveCardExtensionContext -uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: AdaptiveCardExtensionContext -summary: Adaptive Card Extension context object. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AdaptiveCardExtensionContext` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: deviceContext - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#deviceContext:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + summary: Adaptive Card Extension context object. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AdaptiveCardExtensionContext` class. + name: AdaptiveCardExtensionContext + fullName: AdaptiveCardExtensionContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-component-base!BaseComponentContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' package: '@microsoft/sp-adaptive-card-extension-base!' + children: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#deviceContext:member' + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location:member' + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#deviceContext:member' + name: deviceContext fullName: deviceContext - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'get deviceContext(): DeviceContext;' return: - type: '' - - name: location - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: location + type: + - '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location:member' summary: Provides a promise that gets current location of the device - remarks: '' - isPreview: true - isDeprecated: false + name: location + fullName: location + langs: + - typeScript + type: property syntax: content: 'get location(): Promise;' return: - type: 'Promise<>' - - name: manifest - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: manifest + type: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' - remarks: '' - - isPreview: false - isDeprecated: false + name: manifest + fullName: manifest + langs: + - typeScript + type: property syntax: content: 'readonly manifest: IAdaptiveCardExtensionManifest;' return: - type: '<unknown>' - - name: propertyPane - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: propertyPane + type: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' - remarks: '' - - isPreview: false - isDeprecated: false + name: propertyPane + fullName: propertyPane + langs: + - typeScript + type: property syntax: content: 'get propertyPane(): IPropertyPaneAccessor | undefined;' return: - type: ' | undefined' -extends: '' + type: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane~0:complex' +references: + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + name: DeviceContext + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + name: ILocation + fullName: ILocation + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest~0:complex' + name: IAdaptiveCardExtensionManifest + fullName: IAdaptiveCardExtensionManifest + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + name: IAdaptiveCardExtensionManifest + fullName: IAdaptiveCardExtensionManifest + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane~0:complex' + name: IPropertyPaneAccessor | undefined + fullName: IPropertyPaneAccessor | undefined + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + name: IPropertyPaneAccessor + fullName: IPropertyPaneAccessor + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index 6920fa19..f9f81f15 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -1,358 +1,201 @@ -### YamlMime:TSType -name: BaseAdaptiveCardExtension -uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseAdaptiveCardExtension -summary: Base class for Adaptive Card Extensions. -remarks: Adaptive Card Extensions must inherit from this class. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: (constructor)() - summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: constructor(); -properties: - - name: _iconProperty - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member' - package: '@microsoft/sp-adaptive-card-extension-base!' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class' + summary: Base class for Adaptive Card Extensions. + remarks: Adaptive Card Extensions must inherit from this class. + name: BaseAdaptiveCardExtension + fullName: BaseAdaptiveCardExtension + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-component-base!BaseComponent:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' + package: '@microsoft/sp-adaptive-card-extension-base!' + children: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' + - >- + @microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1) + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(2)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member' + name: _iconProperty fullName: _iconProperty - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected _iconProperty: string;' return: - type: string - - name: _title - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' + name: _title fullName: _title - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected _title: string;' return: - type: string - - name: cardNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardNavigator + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)' + summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class + name: (constructor)() + fullName: (constructor)() + langs: + - typeScript + type: constructor + syntax: + content: constructor(); + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' - remarks: '' - - isPreview: false - isDeprecated: false + name: cardNavigator + fullName: cardNavigator + langs: + - typeScript + type: property syntax: content: 'get cardNavigator(): ViewNavigator>;' return: - type: >- - <<TProperties, TState>> - - name: cardSize - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardSize + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' - remarks: '' - - isPreview: false - isDeprecated: false + name: cardSize + fullName: cardSize + langs: + - typeScript + type: property syntax: content: 'protected get cardSize(): CardSize;' return: - type: '' - - name: context - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: context + type: + - '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' - remarks: '' - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'protected context: AdaptiveCardExtensionContext;' return: - type: '' - - name: dataVersion - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: dataVersion + type: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' summary: >- The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to manage versioning of the Adaptive Card Extension. remarks: The default version is 1.0. - - isPreview: false - isDeprecated: false + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property syntax: content: 'protected get dataVersion(): Version;' return: - type: '' - - name: description - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: description + type: + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' summary: The description of the Adaptive Card Extension defined in the manifest. - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'protected get description(): string;' return: - type: string - - name: displayMode - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: displayMode + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' - remarks: '' - - isPreview: false - isDeprecated: false + name: displayMode + fullName: displayMode + langs: + - typeScript + type: property syntax: content: 'get displayMode(): DisplayMode;' return: - type: '' - - name: iconProperty - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: iconProperty - summary: The icon url used to render an icon on the Card view. - remarks: 'By default, this will return the iconImageUrl defined in the manifest.' - - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected get iconProperty(): string; - return: - type: string - - name: isVisible - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isVisible - summary: Sets the visibility of the Adaptive Card Extension and re-render - remarks: >- - This method should be called after a card view has been registered. Otherwise visibility change will not be - applied to the Adaptive Card. - - isPreview: false - isDeprecated: false - syntax: - content: |- - get isVisible(): boolean; - - set isVisible(value: boolean); - return: - type: boolean - - name: navigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: navigator - summary: 'The current [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class).' - remarks: >- - If the current - [BaseAdaptiveCardExtension.renderType](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23renderType:member) - is `QuickView` then returns - [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). - - isPreview: false - isDeprecated: false - syntax: - content: 'get navigator(): ViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: properties - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: properties - summary: 'The custom, persisted properties of the Adaptive Card Extension.' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get properties(): TProperties;' - return: - type: TProperties - - name: propertiesMetadata - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: propertiesMetadata - summary: >- - This property defines metadata for the Adaptive Card Extension property bag. The metadata can help SharePoint - understand the content of the properties better and perform relevant services on the data. - remarks: >- - See - [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) - for more information about how to define metadata. - - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined; - return: - type: >- - | - undefined - - name: quickViewNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: quickViewNavigator - summary: >- - [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a - [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get quickViewNavigator(): QuickViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: renderedFromPersistedData - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderedFromPersistedData - summary: >- - Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default - state. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get renderedFromPersistedData(): boolean;' - return: - type: boolean - - name: renderedOnce - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderedOnce - summary: Indicates whether the Adaptive Card Extension has initially rendered. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get renderedOnce(): boolean;' - return: - type: boolean - - name: renderType - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderType - summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get renderType(): RenderType;' - return: - type: '' - - name: state - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: state - summary: Gets the custom state of the Adaptive Card Extension. - remarks: >- - If this property is not initialized, - [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) - cannot be called. - - isPreview: false - isDeprecated: false - syntax: - content: |- - protected get state(): Readonly; - - protected set state(initialState: Readonly); - return: - type: Readonly<TState> - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title - summary: >- - This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also - displayed as the Property Pane title. - remarks: 'By default, this will return the title defined in the manifest.' - - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get title(): string; - return: - type: string -methods: - - name: getCachedState(state) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: getCachedState(state) + type: + - '@microsoft/sp-core-library!DisplayMode:enum' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState:member(1)' summary: This virtual method returns a subset of the state object that will be cached by the client. remarks: 'If not overriden, this will return an empty object.' - isPreview: true - isDeprecated: false + name: getCachedState(state) + fullName: getCachedState(state) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected getCachedState(state: TState): Partial; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState~0:complex' + description: '' parameters: - id: state description: A shallow clone of the AdaptiveCardExtension state object. - type: TState - return: - type: Partial<TState> - description: '' - - name: getCacheSettings() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: getCacheSettings() + type: + - TState + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings:member(1)' summary: Override the default cache settings. - remarks: '' - isPreview: true - isDeprecated: false + name: getCacheSettings() + fullName: getCacheSettings() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected getCacheSettings(): Partial; return: - type: 'Partial<>' + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings~0:complex' description: '' - - name: getPropertyPaneConfiguration() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: getPropertyPaneConfiguration() + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' summary: >- Get the Property Pane configuration for this Adaptive Card Extension. If an Adaptive Card Extension wants to use the Property Pane, then this method must be overriden. @@ -360,38 +203,89 @@ methods: Property Pane resources can be defer loaded to reduce bundle size. See [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). - - isPreview: false - isDeprecated: false + name: getPropertyPaneConfiguration() + fullName: getPropertyPaneConfiguration() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration; return: - type: '' + type: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' description: '' - - name: loadPropertyPaneResources() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: loadPropertyPaneResources() + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' + summary: The icon url used to render an icon on the Card view. + remarks: 'By default, this will return the iconImageUrl defined in the manifest.' + name: iconProperty + fullName: iconProperty + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + protected get iconProperty(): string; + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member' + summary: Sets the visibility of the Adaptive Card Extension and re-render + remarks: >- + This method should be called after a card view has been registered. Otherwise visibility change will not be + applied to the Adaptive Card. + name: isVisible + fullName: isVisible + langs: + - typeScript + type: property + syntax: + content: |- + get isVisible(): boolean; + + set isVisible(value: boolean); + return: + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' summary: API to enable asynchronous loading of Property Pane related resources of the Adaptive Card Extension. remarks: >- No Property Pane events will be raised until this method resolves except for `PropertyPaneConfigurationComplete`, which can be used to clean up any pending resources. - - isPreview: false - isDeprecated: false + name: loadPropertyPaneResources() + fullName: loadPropertyPaneResources() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected loadPropertyPaneResources(): Promise; return: - type: Promise<void> + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources~0:complex' description: '' - - name: 'onAfterDeserialize(deserializedProperties, dataVersion)' - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator:member' + summary: 'The current [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class).' + remarks: >- + If the current + [BaseAdaptiveCardExtension.renderType](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23renderType:member) + is `QuickView` then returns + [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). + name: navigator + fullName: navigator + langs: + - typeScript + type: property + syntax: + content: 'get navigator(): ViewNavigator>;' + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' summary: Lifecycle method called before the property bag is populated with the deserialized property object. remarks: >- The default implementation is a no-op. An Adaptive Card Extension developer can override this API if the @@ -403,136 +297,148 @@ methods: was serialized by an older version of the Adaptive Card Extension that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - - isPreview: false - isDeprecated: false + name: 'onAfterDeserialize(deserializedProperties, dataVersion)' + fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)' + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onAfterDeserialize(deserializedProperties: any, dataVersion: Version): TProperties; + return: + type: + - TProperties + description: The property bag of the Adaptive Card Extension parameters: - id: deserializedProperties description: >- The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the Adaptive Card Extension - type: any + type: + - any + optional: false - id: dataVersion description: >- The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older Adaptive Card Extension. Adaptive Card Extensions can define their data version by overriding the dataVersion property. - type: '' - return: - type: TProperties - description: The property bag of the Adaptive Card Extension - - name: onAfterPropertiesUpdatedExternally(prevProperties) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onAfterPropertiesUpdatedExternally(prevProperties) + type: + - '@microsoft/sp-core-library!Version:class' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1)' summary: >- Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than the property pane (except for isolated Adaptive Card Extensions). remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`.' - - isPreview: false - isDeprecated: false + name: onAfterPropertiesUpdatedExternally(prevProperties) + fullName: onAfterPropertiesUpdatedExternally(prevProperties) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ onAfterPropertiesUpdatedExternally(prevProperties: TProperties): void; + return: + type: + - void + description: '' parameters: - id: prevProperties description: The Adaptive Card Extension properties before the update. - type: TProperties - return: - type: void - description: '' - - name: onBeforeSerialize() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onBeforeSerialize() + type: + - TProperties + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' summary: Lifecycle method called before serialization. - remarks: '' - - isPreview: false - isDeprecated: false + name: onBeforeSerialize() + fullName: onBeforeSerialize() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ onBeforeSerialize(): void; return: - type: void + type: + - void description: '' - - name: onDisplayModeChanged(oldDisplayMode) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onDisplayModeChanged(oldDisplayMode) + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' - remarks: '' - - isPreview: false - isDeprecated: false + name: onDisplayModeChanged(oldDisplayMode) + fullName: onDisplayModeChanged(oldDisplayMode) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; + return: + type: + - void + description: '' parameters: - id: oldDisplayMode description: The old display mode. - type: '' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onDispose() + type: + - '@microsoft/sp-core-library!DisplayMode:enum' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' summary: Lifecycle method called before disposing the Adaptive Card Extension. - remarks: '' - - isPreview: false - isDeprecated: false + name: onDispose() + fullName: onDispose() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ onDispose(): void; return: - type: void + type: + - void description: '' - - name: onInit() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onInit() + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)' summary: Lifecycle method called during initialization. remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - - isPreview: false - isDeprecated: false + name: onInit() + fullName: onInit() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ onInit(): Promise; return: - type: Promise<void> + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit~0:complex' description: '' - - name: onInit(cachedLoadParameters) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(2)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onInit(cachedLoadParameters) + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(2)' summary: Lifecycle method called during initialization. remarks: >- Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result or, if resolved immediately, a fetching data state can be rendered. - isPreview: true - isDeprecated: false + name: onInit(cachedLoadParameters) + fullName: onInit(cachedLoadParameters) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ onInit(cachedLoadParameters?: ICachedLoadParameters): Promise; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit~1:complex' + description: '' parameters: - id: cachedLoadParameters description: >- @@ -540,97 +446,360 @@ methods: [BaseAdaptiveCardExtension.getCachedState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23getCachedState:member(1))), which can be used to rehydrate the AdaptiveCardExtension. If undefined, the AdaptiveCardExtension was not cached or the cache expired. - type: '' - return: - type: Promise<void> - description: '' - - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + type: + - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + optional: true + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' summary: Lifecycle method called when a Property Pane field is changed. remarks: This is invoked for reactive Property Panes. - - isPreview: false - isDeprecated: false + name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void; + return: + type: + - void + description: '' parameters: - id: propertyPath description: >- JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of `__CustomField_`. - type: string + type: + - string + optional: false - id: oldValue description: Old value of the property. This value could be undefined/empty in the case of custom field. - type: any + type: + - any + optional: false - id: newValue description: New value of the property. This value could be undefined/empty in the case of custom field. - type: any - return: - type: void - description: '' - - name: onRenderTypeChanged(oldRenderType) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onRenderTypeChanged(oldRenderType) + type: + - any + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)' summary: >- Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type) changes. - remarks: '' - - isPreview: false - isDeprecated: false + name: onRenderTypeChanged(oldRenderType) + fullName: onRenderTypeChanged(oldRenderType) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onRenderTypeChanged(oldRenderType: RenderType): void; + return: + type: + - void + description: '' parameters: - id: oldRenderType description: 'The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' - type: '' + type: + - '@microsoft/sp-adaptive-card-extension-base!RenderType:type' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' + summary: 'The custom, persisted properties of the Adaptive Card Extension.' + name: properties + fullName: properties + langs: + - typeScript + type: property + syntax: + content: 'protected get properties(): TProperties;' return: - type: void - description: '' - - name: renderCard() - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: renderCard() + type: + - TProperties + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member' + summary: >- + This property defines metadata for the Adaptive Card Extension property bag. The metadata can help SharePoint + understand the content of the properties better and perform relevant services on the data. + remarks: >- + See + [IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface) + for more information about how to define metadata. + name: propertiesMetadata + fullName: propertiesMetadata + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member' + summary: >- + [QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a + [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view. + name: quickViewNavigator + fullName: quickViewNavigator + langs: + - typeScript + type: property + syntax: + content: 'get quickViewNavigator(): QuickViewNavigator>;' + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)' summary: The id of the initial Card view. remarks: 'By default, this returns undefined and will render a default Card view.' - - isPreview: false - isDeprecated: false + name: renderCard() + fullName: renderCard() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected renderCard(): string | undefined; return: - type: string | undefined + type: + - string | undefined description: '' - - name: setState(newState) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: setState(newState) + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member' + summary: >- + Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default + state. + name: renderedFromPersistedData + fullName: renderedFromPersistedData + langs: + - typeScript + type: property + syntax: + content: 'protected get renderedFromPersistedData(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member' + summary: Indicates whether the Adaptive Card Extension has initially rendered. + name: renderedOnce + fullName: renderedOnce + langs: + - typeScript + type: property + syntax: + content: 'get renderedOnce(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' + summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' + name: renderType + fullName: renderType + langs: + - typeScript + type: property + syntax: + content: 'get renderType(): RenderType;' + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!RenderType:type' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)' summary: Update the state of the Adaptive Card Extension and re-render. remarks: >- [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member) must have been initialized before calling [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - - isPreview: false - isDeprecated: false + name: setState(newState) + fullName: setState(newState) + langs: + - typeScript + type: method syntax: content: 'setState(newState?: Partial): void;' + return: + type: + - void + description: '' parameters: - id: newState description: '' - type: Partial<TState> + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState~0:complex' + optional: true + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' + summary: Gets the custom state of the Adaptive Card Extension. + remarks: >- + If this property is not initialized, + [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)) + cannot be called. + name: state + fullName: state + langs: + - typeScript + type: property + syntax: + content: |- + protected get state(): Readonly; + + protected set state(initialState: Readonly); return: - type: void - description: '' -extends: '' + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member' + summary: >- + This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also + displayed as the Property Pane title. + remarks: 'By default, this will return the title defined in the manifest.' + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get title(): string; + return: + type: + - string +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator~0:complex' + name: 'ViewNavigator>' + fullName: 'ViewNavigator>' + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + name: ViewNavigator + fullName: ViewNavigator + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + name: BaseCardView + fullName: BaseCardView + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + name: CardSize + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + name: AdaptiveCardExtensionContext + - uid: '@microsoft/sp-core-library!Version:class' + name: Version + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + name: DisplayMode + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState~0:complex' + name: Partial + fullName: Partial + spec.typeScript: + - uid: '!Partial:type' + name: Partial + fullName: Partial + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings~0:complex' + name: Partial + fullName: Partial + spec.typeScript: + - uid: '!Partial:type' + name: Partial + fullName: Partial + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + name: ICacheSettings + fullName: ICacheSettings + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator~0:complex' + name: 'ViewNavigator>' + fullName: 'ViewNavigator>' + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + name: ViewNavigator + fullName: ViewNavigator + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + name: BaseView + fullName: BaseView + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit~1:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + name: ICachedLoadParameters + - uid: '@microsoft/sp-adaptive-card-extension-base!RenderType:type' + name: RenderType + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata~0:complex' + name: IAdaptiveCardExtensionPropertiesMetadata | undefined + fullName: IAdaptiveCardExtensionPropertiesMetadata | undefined + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + name: IAdaptiveCardExtensionPropertiesMetadata + fullName: IAdaptiveCardExtensionPropertiesMetadata + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator~0:complex' + name: 'QuickViewNavigator>' + fullName: 'QuickViewNavigator>' + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + name: QuickViewNavigator + fullName: QuickViewNavigator + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + name: BaseAdaptiveCardView + fullName: BaseAdaptiveCardView + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState~0:complex' + name: Partial + fullName: Partial + spec.typeScript: + - uid: '!Partial:type' + name: Partial + fullName: Partial + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: + fullName: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml index aaf21156..43bfa5d4 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -1,75 +1,95 @@ -### YamlMime:TSType -name: BaseAdaptiveCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseAdaptiveCardView -summary: Base class for an Adaptive Card view. -remarks: Views used to render the Quick view must inherit from this class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#data:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + summary: Base class for an Adaptive Card view. + remarks: Views used to render the Quick view must inherit from this class. + name: BaseAdaptiveCardView + fullName: BaseAdaptiveCardView + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data + children: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#data:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#template:member' + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#title:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#data:member' summary: The data used to render the Adaptive Card. - remarks: '' - - isPreview: false - isDeprecated: false + name: data + fullName: data + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ get data(): TData; return: - type: TData - - name: externalLink - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: externalLink + type: + - TData + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink:member' summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' - - isPreview: false - isDeprecated: false + name: externalLink + fullName: externalLink + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ get externalLink(): IExternalLinkParameters | undefined; return: - type: ' | undefined' - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#template:member' summary: The Adaptive Card template rendered by the view. remarks: The format of the template must be valid Adaptive Card JSON. - - isPreview: false - isDeprecated: false + name: template + fullName: template + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ abstract get template(): ISPFxAdaptiveCard; return: - type: '' - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title + type: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#title:member' summary: An optional title to be displayed in the navigation bar above the Adaptive Card. remarks: >- If not overriden, the title displayed will be [BaseAdaptiveCardExtension.title](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23title:member) - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ get title(): string; return: - type: string -extends: '<TProperties, TState, TData> ' + type: + - string +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + name: BaseView + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView#externalLink~0:complex' + name: IExternalLinkParameters | undefined + fullName: IExternalLinkParameters | undefined + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + name: IExternalLinkParameters + fullName: IExternalLinkParameters + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + name: ISPFxAdaptiveCard diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index c7b7c869..cbad079f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -1,34 +1,62 @@ -### YamlMime:TSType -name: BaseBasicCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseBasicCardView -summary: Base class for a Basic Card view. -remarks: >- - The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the - `Medium` Card size, two buttons in the `Large` Card size - -isPreview: false -isDeprecated: false -type: class -properties: - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView#template:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class' + summary: Base class for a Basic Card view. + remarks: >- + The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the + `Medium` Card size, two buttons in the `Large` Card size + name: BaseBasicCardView + fullName: BaseBasicCardView + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template + children: + - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView#template:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView#template:member' summary: >- Returns the Adaptive Card template for the [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). - remarks: '' - - isPreview: false - isDeprecated: false + name: template + fullName: template + langs: + - typeScript + type: property syntax: content: |- /** @sealed */ get template(): ISPFxAdaptiveCard; return: - type: '' -extends: >- - <TProperties, TState, > + type: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView~0:complex' + name: 'BaseCardView- Some Card view templates will restrict how many buttons can be displayed depending on various factors. See the documentation for the respective base Card View class for specific details. - - isPreview: false - isDeprecated: false + name: cardButtons + fullName: cardButtons + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ get cardButtons(): [ICardButton] | [ICardButton, ICardButton] | undefined; return: - type: >- - [] | [, ] | undefined - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#data:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseCardView#cardButtons~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#data:member' summary: The data used to render the Card view. remarks: >- The available data to display is dependent on the Card view template and its respective base Card view class. See the documentation for the Card View class for specific details. - - isPreview: false - isDeprecated: false + name: data + fullName: data + langs: + - typeScript + type: property syntax: content: 'abstract get data(): TData;' return: - type: TData - - name: isCacheEnabled - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#isCacheEnabled:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isCacheEnabled + type: + - TData + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#isCacheEnabled:member' summary: 'If true, this Card view will be cached and rendered at next load.' - remarks: '' - - isPreview: false - isDeprecated: false + name: isCacheEnabled + fullName: isCacheEnabled + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ get isCacheEnabled(): boolean; return: - type: boolean - - name: onCardSelection - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onCardSelection + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection:member' summary: Action to invoke when the card is selected. - remarks: '' - - isPreview: false - isDeprecated: false + name: onCardSelection + fullName: onCardSelection + langs: + - typeScript + type: property syntax: content: >- /** @virtual */ @@ -79,10 +81,62 @@ properties: get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | ISelectMediaCardAction | IGetLocationCardAction | IShowLocationCardAction | undefined; return: - type: >- - | | | | | undefined -extends: '<TProperties, TState, TData> ' + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection~0:complex' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + name: BaseView + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#cardButtons~0:complex' + name: '[ICardButton] | [ICardButton, ICardButton] | undefined' + fullName: '[ICardButton] | [ICardButton, ICardButton] | undefined' + spec.typeScript: + - name: '[' + fullName: '[' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + name: ICardButton + fullName: ICardButton + - name: '] | [' + fullName: '] | [' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + name: ICardButton + fullName: ICardButton + - name: ', ' + fullName: ', ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + name: ICardButton + fullName: ICardButton + - name: '] | undefined' + fullName: '] | undefined' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection~0:complex' + name: >- + IQuickViewCardAction | IExternalLinkCardAction | ISelectMediaCardAction | IGetLocationCardAction | + IShowLocationCardAction | undefined + fullName: >- + IQuickViewCardAction | IExternalLinkCardAction | ISelectMediaCardAction | IGetLocationCardAction | + IShowLocationCardAction | undefined + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + name: IQuickViewCardAction + fullName: IQuickViewCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + name: IExternalLinkCardAction + fullName: IExternalLinkCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + name: ISelectMediaCardAction + fullName: ISelectMediaCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + name: IGetLocationCardAction + fullName: IGetLocationCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + name: IShowLocationCardAction + fullName: IShowLocationCardAction + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index ab1d8a7d..e324e3d2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -1,34 +1,62 @@ -### YamlMime:TSType -name: BaseImageCardView -uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: BaseImageCardView -summary: Base class for an Image Card view. -remarks: >- - The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero - buttons in the `Medium` Card size, up to two buttons in `Large` Card size - -isPreview: false -isDeprecated: false -type: class -properties: - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView#template:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class' + summary: Base class for an Image Card view. + remarks: >- + The Image Card view displays the following: - Card title - Card icon - One image - One primary text field - Zero + buttons in the `Medium` Card size, up to two buttons in `Large` Card size + name: BaseImageCardView + fullName: BaseImageCardView + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template + children: + - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView#template:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView#template:member' summary: >- Returns the Adaptive Card template for the [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). - remarks: '' - - isPreview: false - isDeprecated: false + name: template + fullName: template + langs: + - typeScript + type: property syntax: content: |- /** @sealed */ get template(): ISPFxAdaptiveCard; return: - type: '' -extends: >- - <TProperties, TState, > + type: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView~0:complex' + name: 'BaseCardView- - The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One description - text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size - -isPreview: false -isDeprecated: false -type: class -properties: - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView#template:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class' + summary: Base class for a Primary Text Card view. + remarks: >- + The Primary Text Card view displays the following: - Card Title - Card Icon - One primary text field - One + description text field - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size + name: BasePrimaryTextCardView + fullName: BasePrimaryTextCardView + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template + children: + - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView#template:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView#template:member' summary: >- Returns the Adaptive Card template for the [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). - remarks: '' - - isPreview: false - isDeprecated: false + name: template + fullName: template + langs: + - typeScript + type: property syntax: content: |- /** @sealed */ get template(): ISPFxAdaptiveCard; return: - type: '' -extends: >- - <TProperties, TState, > + type: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView~0:complex' + name: 'BaseCardView- See [BaseAdaptiveCardExtension.cardNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardNavigator:member). - remarks: '' - - isPreview: false - isDeprecated: false + name: cardNavigator + fullName: cardNavigator + langs: + - typeScript + type: property syntax: content: 'get cardNavigator(): ViewNavigator>;' return: - type: >- - <<TProperties, TState>> - - name: cardSize - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardSize:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardSize + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseView#cardNavigator~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardSize:member' summary: >- See [BaseAdaptiveCardExtension.cardSize](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23cardSize:member). - remarks: '' - - isPreview: false - isDeprecated: false + name: cardSize + fullName: cardSize + langs: + - typeScript + type: property syntax: content: 'get cardSize(): CardSize;' return: - type: '' - - name: context - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#context:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: context + type: + - '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#context:member' summary: >- See [BaseAdaptiveCardExtension.context](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23context:member). - remarks: '' - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'get context(): AdaptiveCardExtensionContext;' return: - type: '' - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#data:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data + type: + - '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#data:member' summary: The data used to render the View. - remarks: '' - - isPreview: false - isDeprecated: false + name: data + fullName: data + langs: + - typeScript + type: property syntax: content: 'abstract get data(): TData | undefined;' return: - type: TData | undefined - - name: properties - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#properties:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: properties - summary: >- - See - [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get properties(): TProperties;' - return: - type: TProperties - - name: quickViewNavigator - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: quickViewNavigator - summary: >- - See - [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get quickViewNavigator(): QuickViewNavigator>;' - return: - type: >- - <<TProperties, TState>> - - name: state - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#state:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: state - summary: >- - See - [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get state(): Readonly;' - return: - type: Readonly<TState> - - name: template - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#template:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: template - summary: The Adaptive Card template used to render the view. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get template(): ISPFxAdaptiveCard;' - return: - type: '' -methods: - - name: onAction(action) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onAction:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onAction(action) + type: + - TData | undefined + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onAction:member(1)' summary: Action handler for Adaptive Card Actions. - remarks: '' - - isPreview: false - isDeprecated: false + name: onAction(action) + fullName: onAction(action) + langs: + - typeScript + type: method syntax: content: 'onAction(action: IActionArguments): void;' + return: + type: + - void + description: '' parameters: - id: action description: >- The [IActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionArguments:type) for the current event. - type: '' - return: - type: void - description: '' - - name: onActionError(error) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onActionError:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: onActionError(error) + type: + - '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onActionError:member(1)' summary: Error handler for Adaptive Card Actions. - remarks: '' - isPreview: true - isDeprecated: false + name: onActionError(error) + fullName: onActionError(error) + langs: + - typeScript + type: method syntax: content: 'onActionError(error: IActionErrorArguments): void;' + return: + type: + - void + description: '' parameters: - id: error description: >- The [IActionErrorArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type) for the current event. - type: '' + type: + - '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#properties:member' + summary: >- + See + [BaseAdaptiveCardExtension.properties](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23properties:member). + name: properties + fullName: properties + langs: + - typeScript + type: property + syntax: + content: 'get properties(): TProperties;' return: - type: void - description: '' - - name: setState(newState) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: setState(newState) + type: + - TProperties + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator:member' + summary: >- + See + [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). + name: quickViewNavigator + fullName: quickViewNavigator + langs: + - typeScript + type: property + syntax: + content: 'get quickViewNavigator(): QuickViewNavigator>;' + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState:member(1)' summary: >- See [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). - remarks: '' - - isPreview: false - isDeprecated: false + name: setState(newState) + fullName: setState(newState) + langs: + - typeScript + type: method syntax: content: 'setState(newState?: Partial): void;' + return: + type: + - void + description: '' parameters: - id: newState description: '' - type: Partial<TState> - return: - type: void - description: '' - - name: setVisibility(isVisible) - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setVisibility:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: setVisibility(isVisible) + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseView#setState~0:complex' + optional: true + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setVisibility:member(1)' summary: >- Sets visibility to false and rerenders the card. See [BaseAdaptiveCardExtension.isVisible](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23isVisible:member). - remarks: '' - - isPreview: false - isDeprecated: false + name: setVisibility(isVisible) + fullName: setVisibility(isVisible) + langs: + - typeScript + type: method syntax: content: 'setVisibility(isVisible: boolean): void;' + return: + type: + - void + description: '' parameters: - id: isVisible description: '' - type: boolean + type: + - boolean + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#state:member' + summary: >- + See + [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member). + name: state + fullName: state + langs: + - typeScript + type: property + syntax: + content: 'get state(): Readonly;' return: - type: void - description: '' + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseView#state~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#template:member' + summary: The Adaptive Card template used to render the view. + name: template + fullName: template + langs: + - typeScript + type: property + syntax: + content: 'abstract get template(): ISPFxAdaptiveCard;' + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#cardNavigator~0:complex' + name: 'ViewNavigator>' + fullName: 'ViewNavigator>' + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + name: ViewNavigator + fullName: ViewNavigator + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + name: BaseCardView + fullName: BaseCardView + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + name: CardSize + - uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class' + name: AdaptiveCardExtensionContext + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + name: IActionArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' + name: IActionErrorArguments + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#quickViewNavigator~0:complex' + name: 'QuickViewNavigator>' + fullName: 'QuickViewNavigator>' + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + name: QuickViewNavigator + fullName: QuickViewNavigator + - name: < + fullName: < + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardView:class' + name: BaseAdaptiveCardView + fullName: BaseAdaptiveCardView + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#setState~0:complex' + name: Partial + fullName: Partial + spec.typeScript: + - uid: '!Partial:type' + name: Partial + fullName: Partial + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#state~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: + fullName: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + name: ISPFxAdaptiveCard diff --git a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml index 5bf41796..54e3bbea 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml @@ -1,11 +1,15 @@ -### YamlMime:TSTypeAlias -name: CardSize -uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: CardSize -summary: Size of the Card view. -remarks: '' - -isPreview: false -isDeprecated: false -syntax: export declare type CardSize = 'Medium' | 'Large'; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!CardSize:type' + summary: Size of the Card view. + name: CardSize + fullName: CardSize + langs: + - typeScript + type: typealias + syntax: + content: export declare type CardSize = 'Medium' | 'Large'; + return: + type: + - '''Medium'' | ''Large''' + package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml index 2f43e2bf..3868e404 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml @@ -1,13 +1,17 @@ -### YamlMime:TSTypeAlias -name: DeviceContext -uid: '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: DeviceContext -summary: >- - `WebView` indicates the Adaptive Card Extension is rendering through a web browser equivalent. `Mobile` indicates the - Adaptive Card Extension is rendering natively on a mobile platform. -remarks: '' - -isPreview: false -isDeprecated: false -syntax: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop'; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type' + summary: >- + `WebView` indicates the Adaptive Card Extension is rendering through a web browser equivalent. `Mobile` indicates + the Adaptive Card Extension is rendering natively on a mobile platform. + name: DeviceContext + fullName: DeviceContext + langs: + - typeScript + type: typealias + syntax: + content: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop'; + return: + type: + - '''WebView'' | ''Mobile'' | ''TeamsDesktop''' + package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml index 0392e926..8ec8ba7c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml @@ -1,19 +1,47 @@ -### YamlMime:TSTypeAlias -name: IActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an Adaptive - Card Action is executed. -remarks: >- - Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are - routed to the [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) - handler. - -isPreview: false -isDeprecated: false -syntax: >- - export declare type IActionArguments = ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments - | IGetLocationActionArguments; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type' + summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an + Adaptive Card Action is executed. + remarks: >- + Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions + are routed to the + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. + name: IActionArguments + fullName: IActionArguments + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type IActionArguments = ISubmitActionArguments | IShowCardActionArguments | + ISelectMediaActionArguments | IGetLocationActionArguments; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!IActionArguments~0:complex' + package: '@microsoft/sp-adaptive-card-extension-base!' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments~0:complex' + name: ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments | IGetLocationActionArguments + fullName: ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments | IGetLocationActionArguments + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + name: ISubmitActionArguments + fullName: ISubmitActionArguments + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + name: IShowCardActionArguments + fullName: IShowCardActionArguments + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + name: ISelectMediaActionArguments + fullName: ISelectMediaActionArguments + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + name: IGetLocationActionArguments + fullName: IGetLocationActionArguments diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml index 5c4044e6..368a80ca 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml @@ -1,14 +1,21 @@ -### YamlMime:TSTypeAlias -name: IActionError -uid: '@microsoft/sp-adaptive-card-extension-base!IActionError:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IActionError -summary: '' -remarks: '' - -isPreview: true -isDeprecated: false -syntax: |- - export declare type IActionError = { - code: string; - }; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + isPreview: true + name: IActionError + fullName: IActionError + langs: + - typeScript + type: typealias + syntax: + content: |- + export declare type IActionError = { + code: string; + }; + return: + type: + - |- + { + code: string; + } + package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml index ff94f913..9151a15b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml @@ -1,20 +1,43 @@ -### YamlMime:TSTypeAlias -name: IActionErrorArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IActionErrorArguments -summary: >- - The object passed to - [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an - Adaptive Card Action is executed. -remarks: >- - Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions are - routed to the - [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) - handler. - -isPreview: false -isDeprecated: false -syntax: >- - export declare type IActionErrorArguments = IBaseActionErrorArguments | ISelectMediaActionErrorArguments | - ILocationErrorArguments; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type' + summary: >- + The object passed to + [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) + when an Adaptive Card Action is executed. + remarks: >- + Only `Submit`, `ShowCard`, 'Viva.SelectMedia', 'Viva.GetLocation' and 'Viva.ShowLocation; actions + are routed to the + [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) + handler. + name: IActionErrorArguments + fullName: IActionErrorArguments + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type IActionErrorArguments = IBaseActionErrorArguments | ISelectMediaActionErrorArguments | + ILocationErrorArguments; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments~0:complex' + package: '@microsoft/sp-adaptive-card-extension-base!' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments~0:complex' + name: IBaseActionErrorArguments | ISelectMediaActionErrorArguments | ILocationErrorArguments + fullName: IBaseActionErrorArguments | ISelectMediaActionErrorArguments | ILocationErrorArguments + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' + name: IBaseActionErrorArguments + fullName: IBaseActionErrorArguments + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments:interface' + name: ISelectMediaActionErrorArguments + fullName: ISelectMediaActionErrorArguments + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' + name: ILocationErrorArguments + fullName: ILocationErrorArguments diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml index 38ea8f56..c3d26288 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -1,13 +1,12 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionPropertiesMetadata -uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IAdaptiveCardExtensionPropertiesMetadata -summary: >- - This structure is used to define metadata for Adaptive Card Extension properties as a map of string to - `IAdaptiveCardExtensionPropertiesMetadata` -remarks: '' - -isPreview: false -isDeprecated: false -type: interface +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface' + summary: >- + This structure is used to define metadata for Adaptive Card Extension properties as a map of string to + `IAdaptiveCardExtensionPropertiesMetadata` + name: IAdaptiveCardExtensionPropertiesMetadata + fullName: IAdaptiveCardExtensionPropertiesMetadata + langs: + - typeScript + type: interface + package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index cffa820c..f71788fb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -1,12 +1,17 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionPropertyMetadata -uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IAdaptiveCardExtensionPropertyMetadata -summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface' + summary: This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`. + name: IAdaptiveCardExtensionPropertyMetadata + fullName: IAdaptiveCardExtensionPropertyMetadata + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + inheritance: + - type: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + package: '@microsoft/sp-adaptive-card-extension-base!' +references: + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + name: IComponentPropertyMetadata diff --git a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml index ac2835cd..552c2cf8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml @@ -1,25 +1,26 @@ -### YamlMime:TSType -name: IAttachmentError -uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IAttachmentError -summary: This object represents error associated with a single attachment -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: errorCode - uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError#errorCode:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' + summary: This object represents error associated with a single attachment + remarks: API under active development and not ready for use. + name: IAttachmentError + fullName: IAttachmentError + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: errorCode + children: + - '@microsoft/sp-adaptive-card-extension-base!IAttachmentError#errorCode:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError#errorCode:member' summary: Error code associated with a particular attachment - remarks: '' - isPreview: true - isDeprecated: false + name: errorCode + fullName: errorCode + langs: + - typeScript + type: property syntax: content: 'errorCode: ''FileTooLarge'' | ''IncorrectFileFormat'';' return: - type: '''FileTooLarge'' | ''IncorrectFileFormat''' + type: + - '''FileTooLarge'' | ''IncorrectFileFormat''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml index c29bbb17..305ca470 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -1,43 +1,43 @@ -### YamlMime:TSType -name: IBaseActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBaseActionArguments -summary: >- - Base object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an Adaptive - Card Action is executed. -remarks: >- - Only `Submit` and `ShowCard` actions are routed to the - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + summary: >- + Base object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when an + Adaptive Card Action is executed. + remarks: >- + Only `Submit` and `ShowCard` actions are routed to the + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) handler. + name: IBaseActionArguments + fullName: IBaseActionArguments + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: id + children: + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#id:member' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#id:member' summary: The id specified in the Adaptive Card template - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id?: string;' return: - type: string - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' summary: The type of Adaptive Card Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''Submit'' | ''ShowCard'';' return: - type: '''Submit'' | ''ShowCard''' + type: + - '''Submit'' | ''ShowCard''' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml index 2baf78f6..22dbea62 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -1,54 +1,59 @@ -### YamlMime:TSType -name: IBaseActionErrorArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBaseActionErrorArguments -summary: >- - Base object passed to - [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) when an - Adaptive Card OnActionError is executed. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: error - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#error:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface' + summary: >- + Base object passed to + [BaseView.onActionError()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onActionError:member(1)) + when an Adaptive Card OnActionError is executed. + name: IBaseActionErrorArguments + fullName: IBaseActionErrorArguments + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: error + children: + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#error:member' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#id:member' + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#error:member' summary: The error thrown by the action - remarks: '' - isPreview: true - isDeprecated: false + name: error + fullName: error + langs: + - typeScript + type: property syntax: content: 'error: IActionError;' return: - type: '' - - name: id - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#id:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: id + type: + - '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#id:member' summary: The id specified in the Adaptive Card template - remarks: '' - isPreview: true - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id?: string;' return: - type: string - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#type:member' summary: The type of Adaptive Card Action thsat caused the error. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''Submit'' | ''ShowCard'' | ''VivaAction.SelectMedia'' | ''VivaAction.GetLocation'' | ''VivaAction.ShowLocation'';' return: - type: '''Submit'' | ''ShowCard'' | ''VivaAction.SelectMedia'' | ''VivaAction.GetLocation'' | ''VivaAction.ShowLocation''' + type: + - '''Submit'' | ''ShowCard'' | ''VivaAction.SelectMedia'' | ''VivaAction.GetLocation'' | ''VivaAction.ShowLocation''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IActionError:type' + name: IActionError diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml index efa7a0de..6e3ca5eb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -1,51 +1,51 @@ -### YamlMime:TSType -name: IBaseCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBaseCardParameters -summary: The primitive data parameters for every Card view. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: iconAltText - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconAltText:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + summary: The primitive data parameters for every Card view. + name: IBaseCardParameters + fullName: IBaseCardParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: iconAltText + children: + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconAltText:member' + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconProperty:member' + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconAltText:member' summary: The icon alt text. - remarks: '' - - isPreview: false - isDeprecated: false + name: iconAltText + fullName: iconAltText + langs: + - typeScript + type: property syntax: content: 'iconAltText?: string;' return: - type: string - - name: iconProperty - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconProperty:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: iconProperty + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#iconProperty:member' summary: The icon to display. remarks: The value is a URL to an icon. - - isPreview: false - isDeprecated: false + name: iconProperty + fullName: iconProperty + langs: + - typeScript + type: property syntax: content: 'iconProperty?: string;' return: - type: string - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' summary: The title to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index 4101e4a6..dbca635c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -1,28 +1,33 @@ -### YamlMime:TSType -name: IBasicCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IBasicCardParameters -summary: >- - The data parameters for - [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: primaryText - uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters#primaryText:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface' + summary: >- + The data parameters for + [BaseBasicCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class). + name: IBasicCardParameters + fullName: IBasicCardParameters + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: primaryText + children: + - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters#primaryText:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters#primaryText:member' summary: The primary text to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: primaryText + fullName: primaryText + langs: + - typeScript + type: property syntax: content: 'primaryText: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + name: IBaseCardParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml index c475afc2..67944d50 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -1,38 +1,39 @@ -### YamlMime:TSType -name: ICachedLoadParameters -uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ICachedLoadParameters -summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load -remarks: API under active development and not ready for use. - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: cardNavigatorState - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#cardNavigatorState:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface' + summary: Parameters used to rehydrate the AdaptiveCardExtension during a cached load + remarks: API under active development and not ready for use. + isPreview: true + name: ICachedLoadParameters + fullName: ICachedLoadParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cardNavigatorState - summary: '' - remarks: '' - + children: + - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#cardNavigatorState:member' + - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#state:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#cardNavigatorState:member' isPreview: true - isDeprecated: false + name: cardNavigatorState + fullName: cardNavigatorState + langs: + - typeScript + type: property syntax: content: 'cardNavigatorState: string[];' return: - type: 'string[]' - - name: state - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#state:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: state - summary: '' - remarks: '' - + type: + - 'string[]' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#state:member' isPreview: true - isDeprecated: false + name: state + fullName: state + langs: + - typeScript + type: property syntax: content: 'state: any;' return: - type: any + type: + - any diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml index 16c9c33e..dc0b095f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -1,53 +1,65 @@ -### YamlMime:TSType -name: ICacheSettings -uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ICacheSettings -summary: '' -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: cachedCardView - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#cachedCardView:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface' + isPreview: true + name: ICacheSettings + fullName: ICacheSettings + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: cachedCardView + children: + - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#cachedCardView:member' + - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#expiryTimeInSeconds:member' + - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#isEnabled:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#cachedCardView:member' summary: >- Returns the Card View used to generate the cached card. By default, the currently rendered Card View will be used to cache the card. - remarks: '' - isPreview: true - isDeprecated: false + name: cachedCardView + fullName: cachedCardView + langs: + - typeScript + type: property syntax: content: 'cachedCardView?: () => BaseCardView;' return: - type: '() => ' - - name: expiryTimeInSeconds - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#expiryTimeInSeconds:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: expiryTimeInSeconds + type: + - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#cachedCardView~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#expiryTimeInSeconds:member' summary: 'Expiry time in seconds. Default: 86400 seconds (24 hours)' - remarks: '' - isPreview: true - isDeprecated: false + name: expiryTimeInSeconds + fullName: expiryTimeInSeconds + langs: + - typeScript + type: property syntax: content: 'expiryTimeInSeconds: number;' return: - type: number - - name: isEnabled - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#isEnabled:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isEnabled + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#isEnabled:member' summary: 'Whether cache is enabled. Default: true' - remarks: '' - isPreview: true - isDeprecated: false + name: isEnabled + fullName: isEnabled + langs: + - typeScript + type: property syntax: content: 'isEnabled: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#cachedCardView~0:complex' + name: () => BaseCardView + fullName: () => BaseCardView + spec.typeScript: + - name: '() => ' + fullName: '() => ' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class' + name: BaseCardView + fullName: BaseCardView diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml index e8ce3619..5c07c5fb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -1,13 +1,54 @@ -### YamlMime:TSTypeAlias -name: ICardAction -uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ICardAction -summary: Type of handler for when a button is pressed. -remarks: '' - -isPreview: false -isDeprecated: false -syntax: >- - export declare type ICardAction = IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction | - ISelectMediaCardAction | IGetLocationCardAction | IShowLocationCardAction; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + summary: Type of handler for when a button is pressed. + name: ICardAction + fullName: ICardAction + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type ICardAction = IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction | + ISelectMediaCardAction | IGetLocationCardAction | IShowLocationCardAction; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!ICardAction~0:complex' + package: '@microsoft/sp-adaptive-card-extension-base!' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction~0:complex' + name: >- + IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction | ISelectMediaCardAction | + IGetLocationCardAction | IShowLocationCardAction + fullName: >- + IQuickViewCardAction | IExternalLinkCardAction | ISubmitCardAction | ISelectMediaCardAction | + IGetLocationCardAction | IShowLocationCardAction + spec.typeScript: + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + name: IQuickViewCardAction + fullName: IQuickViewCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + name: IExternalLinkCardAction + fullName: IExternalLinkCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + name: ISubmitCardAction + fullName: ISubmitCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + name: ISelectMediaCardAction + fullName: ISelectMediaCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface' + name: IGetLocationCardAction + fullName: IGetLocationCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + name: IShowLocationCardAction + fullName: IShowLocationCardAction diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 290ef9fd..c73a9804 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -1,64 +1,69 @@ -### YamlMime:TSType -name: ICardButton -uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ICardButton -summary: A button to display on a Card View. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: action - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#action:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface' + summary: A button to display on a Card View. + name: ICardButton + fullName: ICardButton + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: action + children: + - '@microsoft/sp-adaptive-card-extension-base!ICardButton#action:member' + - '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' + - '@microsoft/sp-adaptive-card-extension-base!ICardButton#style:member' + - '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#action:member' summary: The type of the button. - remarks: '' - - isPreview: false - isDeprecated: false + name: action + fullName: action + langs: + - typeScript + type: property syntax: content: 'action: ICardAction;' return: - type: '' - - name: id - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: id + type: + - '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' summary: Unique Id of the button. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id?: string;' return: - type: string - - name: style - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#style:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: style + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#style:member' summary: Controls the style of the button. remarks: The destructive Action style is not supported in Card views - - isPreview: false - isDeprecated: false + name: style + fullName: style + langs: + - typeScript + type: property syntax: content: 'style?: ActionStyle;' return: - type: '' - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: title + type: + - 'adaptivecards!ActionStyle:class' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' summary: Text displayed on the button. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + name: ICardAction + - uid: 'adaptivecards!ActionStyle:class' + name: ActionStyle diff --git a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml index 78ad9a11..a65efca5 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -1,38 +1,35 @@ -### YamlMime:TSType -name: IConfirmationDialog -uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IConfirmationDialog -summary: Confirmation Dialog option that is passed through `Submit` Action is executed. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: message - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#message:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + summary: Confirmation Dialog option that is passed through `Submit` Action is executed. + name: IConfirmationDialog + fullName: IConfirmationDialog + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' + children: + - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#message:member' + - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#message:member' + name: message fullName: message - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'message: string;' return: - type: string - - name: title - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' - package: '@microsoft/sp-adaptive-card-extension-base!' + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' + name: title fullName: title - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index e7f5e217..da63c8eb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -1,38 +1,40 @@ -### YamlMime:TSType -name: IExternalLinkCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IExternalLinkCardAction -summary: Open an external link. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction:interface' + summary: Open an external link. + name: IExternalLinkCardAction + fullName: IExternalLinkCardAction + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#parameters:member' summary: Parameters for the external link. - remarks: '' - - isPreview: false - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters: IExternalLinkParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' summary: Indicates this is an external link button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''ExternalLink'';' return: - type: '''ExternalLink''' + type: + - '''ExternalLink''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + name: IExternalLinkParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml index 1f477abc..b73a6910 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -1,38 +1,37 @@ -### YamlMime:TSType -name: IExternalLinkParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IExternalLinkParameters -summary: Parameters for opening an external link. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isTeamsDeepLink - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#isTeamsDeepLink:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters:interface' + summary: Parameters for opening an external link. + name: IExternalLinkParameters + fullName: IExternalLinkParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: isTeamsDeepLink + children: + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#isTeamsDeepLink:member' + - '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#isTeamsDeepLink:member' summary: Indicates whether this is a Teams Deep Link. - remarks: '' - - isPreview: false - isDeprecated: false + name: isTeamsDeepLink + fullName: isTeamsDeepLink + langs: + - typeScript + type: property syntax: content: 'isTeamsDeepLink?: boolean;' return: - type: boolean - - name: target - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: target + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' summary: The URL of the link. - remarks: '' - - isPreview: false - isDeprecated: false + name: target + fullName: target + langs: + - typeScript + type: property syntax: content: 'target: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index 24a233ec..192bc710 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -1,39 +1,47 @@ -### YamlMime:TSType -name: IGetLocationAction -uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IGetLocationAction -summary: Interface for Viva Get Location action -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + summary: Interface for Viva Get Location action + remarks: API under active development and not ready for use. + name: IGetLocationAction + fullName: IGetLocationAction + langs: + - typeScript + type: interface + extends: + - 'adaptivecards!IAction:interface' + inheritance: + - type: 'adaptivecards!IAction:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#parameters:member' summary: Parameters that can be supplied with the Viva Get Location Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters?: IGetLocationActionParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' summary: Indicates this is a Viva Select Location button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.GetLocation'';' return: - type: '''VivaAction.GetLocation''' -extends: '' + type: + - '''VivaAction.GetLocation''' +references: + - uid: 'adaptivecards!IAction:interface' + name: IAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + name: IGetLocationActionParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 54795285..dedc5c15 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -1,42 +1,72 @@ -### YamlMime:TSType -name: IGetLocationActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IGetLocationActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get - location Action is executed. -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: location - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface' + summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a Get + location Action is executed. + remarks: API under active development and not ready for use. + name: IGetLocationActionArguments + fullName: IGetLocationActionArguments + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: location + children: + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' - remarks: '' - - isPreview: false - isDeprecated: false + name: location + fullName: location + langs: + - typeScript + type: property syntax: content: 'location?: ILocation;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' summary: The type of Adaptive Card Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.GetLocation'';' return: - type: '''VivaAction.GetLocation''' -extends: 'Omit<, ''type''> ' + type: + - '''VivaAction.GetLocation''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments~0:complex' + name: Omit' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#type:member' summary: Indicates this is a Viva Select Location button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.GetLocation'';' return: - type: '''VivaAction.GetLocation''' + type: + - '''VivaAction.GetLocation''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface' + name: IGetLocationActionParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index 3a804782..52821e3e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -1,41 +1,46 @@ -### YamlMime:TSType -name: IImageCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IImageCardParameters -summary: >- - The data parameters for - [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: imageUrl - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#imageUrl:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface' + summary: >- + The data parameters for + [BaseImageCardView](xref:@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class). + name: IImageCardParameters + fullName: IImageCardParameters + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: imageUrl + children: + - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#imageUrl:member' + - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#imageUrl:member' summary: The image URL to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: imageUrl + fullName: imageUrl + langs: + - typeScript + type: property syntax: content: 'imageUrl: string;' return: - type: string - - name: primaryText - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: primaryText + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' summary: The primary text to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: primaryText + fullName: primaryText + langs: + - typeScript + type: property syntax: content: 'primaryText: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + name: IBaseCardParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml index 797238f4..8857007b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -1,64 +1,63 @@ -### YamlMime:TSType -name: ILocation -uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ILocation -summary: Interface for location coordinates -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: accuracy - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#accuracy:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + summary: Interface for location coordinates + name: ILocation + fullName: ILocation + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: accuracy + children: + - '@microsoft/sp-adaptive-card-extension-base!ILocation#accuracy:member' + - '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' + - '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' + - '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#accuracy:member' summary: Accuracy of the location. - remarks: '' - - isPreview: false - isDeprecated: false + name: accuracy + fullName: accuracy + langs: + - typeScript + type: property syntax: content: 'accuracy?: number;' return: - type: number - - name: latitude - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: latitude + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' summary: Latitude of the location. - remarks: '' - - isPreview: false - isDeprecated: false + name: latitude + fullName: latitude + langs: + - typeScript + type: property syntax: content: 'latitude: number;' return: - type: number - - name: longitude - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: longitude + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' summary: Longitude of the location. - remarks: '' - - isPreview: false - isDeprecated: false + name: longitude + fullName: longitude + langs: + - typeScript + type: property syntax: content: 'longitude: number;' return: - type: number - - name: timestamp - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: timestamp + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' summary: Timestamp - remarks: '' - - isPreview: false - isDeprecated: false + name: timestamp + fullName: timestamp + langs: + - typeScript + type: property syntax: content: 'timestamp?: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml index 36ea9b96..20b10ccc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -1,45 +1,73 @@ -### YamlMime:TSType -name: ILocationErrorArguments -uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ILocationErrorArguments -summary: This object represents the error data that the Location action can throw. -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: error - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#error:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface' + summary: This object represents the error data that the Location action can throw. + remarks: API under active development and not ready for use. + name: ILocationErrorArguments + fullName: ILocationErrorArguments + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: error + children: + - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#error:member' + - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#error:member' summary: Error codes specific to the Get Location Error - remarks: '' - - isPreview: false - isDeprecated: false + name: error + fullName: error + langs: + - typeScript + type: property syntax: content: |- error: { code: 'InternalError' | 'PermissionDenied'; }; return: - type: |- - { - code: 'InternalError' | 'PermissionDenied'; - } - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - |- + { + code: 'InternalError' | 'PermissionDenied'; + } + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#type:member' summary: Indicates this is a Viva Select Location button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.GetLocation'';' return: - type: '''VivaAction.GetLocation''' -extends: 'Omit<, ''type''> ' + type: + - '''VivaAction.GetLocation''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments~0:complex' + name: Omit- - The data parameters for - [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#description:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface' + summary: >- + The data parameters for + [BasePrimaryTextCardView](xref:@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class). + name: IPrimaryTextCardParameters + fullName: IPrimaryTextCardParameters + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: description + children: + - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#description:member' + - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#description:member' summary: The description to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description: string;' return: - type: string - - name: primaryText - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: primaryText + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' summary: The primary text to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: primaryText + fullName: primaryText + langs: + - typeScript + type: property syntax: content: 'primaryText: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface' + name: IBaseCardParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index f072dbe3..a18367bf 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -1,38 +1,40 @@ -### YamlMime:TSType -name: IQuickViewCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IQuickViewCardAction -summary: Open the quick view. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction:interface' + summary: Open the quick view. + name: IQuickViewCardAction + fullName: IQuickViewCardAction + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#parameters:member' summary: Parameters for the quick view opened by this action - remarks: '' - - isPreview: false - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters: IQuickViewParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' summary: Indicates this action opens the quick view. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''QuickView'';' return: - type: '''QuickView''' + type: + - '''QuickView''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + name: IQuickViewParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml index 43b12c49..f9d69609 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -1,25 +1,24 @@ -### YamlMime:TSType -name: IQuickViewParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IQuickViewParameters -summary: Parameters for opening a Quick view. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: view - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters#view:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters:interface' + summary: Parameters for opening a Quick view. + name: IQuickViewParameters + fullName: IQuickViewParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: view + children: + - '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters#view:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewParameters#view:member' summary: The view of the Quick view to open. - remarks: '' - - isPreview: false - isDeprecated: false + name: view + fullName: view + langs: + - typeScript + type: property syntax: content: 'view: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index da34ac07..604ef56d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -1,39 +1,49 @@ -### YamlMime:TSType -name: ISelectMediaAction -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaAction -summary: Interface for new Viva Select Media action -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + summary: Interface for new Viva Select Media action + remarks: API under active development and not ready for use. + name: ISelectMediaAction + fullName: ISelectMediaAction + langs: + - typeScript + type: interface + extends: + - 'adaptivecards!IAction:interface' + inheritance: + - type: 'adaptivecards!IAction:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#parameters:member' summary: Parameters that can be provided to the ISelectMedia Action - remarks: '' - isPreview: true - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters: ISelectMediaActionParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' summary: Indicates this is a Viva Select Location button. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.SelectMedia'';' return: - type: '''VivaAction.SelectMedia''' -extends: '' + type: + - '''VivaAction.SelectMedia''' +references: + - uid: 'adaptivecards!IAction:interface' + name: IAction + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + name: ISelectMediaActionParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index ef82a403..c6821d0d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -1,55 +1,95 @@ -### YamlMime:TSType -name: ISelectMediaActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a - `SelectMedia` Action is executed. -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#data:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments:interface' + summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a + `SelectMedia` Action is executed. + remarks: API under active development and not ready for use. + name: ISelectMediaActionArguments + fullName: ISelectMediaActionArguments + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data + children: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#data:member' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#data:member' summary: Submit Action data that is passed to internal action handler to ensure forms do not clear. - remarks: '' - isPreview: true - isDeprecated: false + name: data + fullName: data + langs: + - typeScript + type: property syntax: content: 'data: any;' return: - type: any - - name: media - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: media + type: + - any + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' summary: media object returned media picker API - remarks: '' - isPreview: true - isDeprecated: false + name: media + fullName: media + langs: + - typeScript + type: property syntax: content: 'media: ISelectMediaAttachment[];' return: - type: '[]' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' summary: The type of Adaptive Card Action. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.SelectMedia'';' return: - type: '''VivaAction.SelectMedia''' -extends: 'Omit<, ''type''> ' + type: + - '''VivaAction.SelectMedia''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments~0:complex' + name: Omit[] | undefined' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#media~0:complex' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#type:member' summary: The type of Adaptive Card Action. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.SelectMedia'';' return: - type: '''VivaAction.SelectMedia''' -extends: 'Omit<, ''type''> ' + type: + - '''VivaAction.SelectMedia''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments~0:complex' + name: Omit' - - name: supportedFileFormats - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#supportedFileFormats:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: supportedFileFormats + type: + - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#supportedFileFormats:member' summary: File formats supported for upload. - remarks: '' - isPreview: true - isDeprecated: false + name: supportedFileFormats + fullName: supportedFileFormats + langs: + - typeScript + type: property syntax: content: 'supportedFileFormats?: string[];' return: - type: 'string[]' + type: + - 'string[]' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + name: MediaType diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index 3a9072c6..a50afed6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -1,51 +1,58 @@ -### YamlMime:TSType -name: ISelectMediaAttachment -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaAttachment -summary: This object represents the data returned by the native media picker API. -remarks: API under active development and not ready for use. - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: content - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#content:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment:interface' + summary: This object represents the data returned by the native media picker API. + remarks: API under active development and not ready for use. + isPreview: true + name: ISelectMediaAttachment + fullName: ISelectMediaAttachment + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: content + children: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#content:member' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#error:member' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#content:member' summary: Content of the file represented as base64Strings - remarks: '' - isPreview: true - isDeprecated: false + name: content + fullName: content + langs: + - typeScript + type: property syntax: content: 'content: string;' return: - type: string - - name: error - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#error:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: error + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#error:member' summary: Error associated with attachment - remarks: '' - isPreview: true - isDeprecated: false + name: error + fullName: error + langs: + - typeScript + type: property syntax: content: 'error?: IAttachmentError;' return: - type: '' - - name: fileName - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: fileName + type: + - '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' summary: The names of the selected files. - remarks: '' - isPreview: true - isDeprecated: false + name: fileName + fullName: fileName + langs: + - typeScript + type: property syntax: content: 'fileName: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface' + name: IAttachmentError diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 8760d915..02609af1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -1,38 +1,42 @@ -### YamlMime:TSType -name: ISelectMediaCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISelectMediaCardAction -summary: Invoke an `VivaAction.SelectMedia` event. -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface' + summary: Invoke an `VivaAction.SelectMedia` event. + remarks: API under active development and not ready for use. + name: ISelectMediaCardAction + fullName: ISelectMediaCardAction + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#parameters:member' summary: Parameters for the Select Media Action - remarks: '' - isPreview: true - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters: ISelectMediaActionParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' summary: Indicates this is a Viva Select Media button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.SelectMedia'';' return: - type: '''VivaAction.SelectMedia''' + type: + - '''VivaAction.SelectMedia''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters:interface' + name: ISelectMediaActionParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index 750f2b26..735044d8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -1,29 +1,34 @@ -### YamlMime:TSType -name: IShowCardActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowCardActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `ShowCard` - Action is executed. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments#type:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface' + summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a + `ShowCard` Action is executed. + name: IShowCardActionArguments + fullName: IShowCardActionArguments + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + children: + - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments#type:member' summary: The type of Adaptive Card Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''ShowCard'';' return: - type: '''ShowCard''' -extends: '' + type: + - '''ShowCard''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + name: IBaseActionArguments diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index a291b0a0..8d6fac66 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -1,39 +1,47 @@ -### YamlMime:TSType -name: IShowLocationAction -uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowLocationAction -summary: Interface for Viva Show Location action -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + summary: Interface for Viva Show Location action + remarks: API under active development and not ready for use. + name: IShowLocationAction + fullName: IShowLocationAction + langs: + - typeScript + type: interface + extends: + - 'adaptivecards!IAction:interface' + inheritance: + - type: 'adaptivecards!IAction:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#parameters:member' summary: Parameters that can be supplied with the Viva Show Location Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters?: IShowLocationActionParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' summary: Indicates this is a Viva show Location button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.ShowLocation'';' return: - type: '''VivaAction.ShowLocation''' -extends: '' + type: + - '''VivaAction.ShowLocation''' +references: + - uid: 'adaptivecards!IAction:interface' + name: IAction + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + name: IShowLocationActionParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index 1ee051a8..b533b6f6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -1,25 +1,28 @@ -### YamlMime:TSType -name: IShowLocationActionParameters -uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowLocationActionParameters -summary: Parameters that can be supplied with the Viva Show Location Action. -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: locationCoordinates - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + summary: Parameters that can be supplied with the Viva Show Location Action. + remarks: API under active development and not ready for use. + name: IShowLocationActionParameters + fullName: IShowLocationActionParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: locationCoordinates + children: + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' - remarks: '' - - isPreview: false - isDeprecated: false + name: locationCoordinates + fullName: locationCoordinates + langs: + - typeScript + type: property syntax: content: 'locationCoordinates?: ILocation;' return: - type: '' + type: + - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation:interface' + name: ILocation diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 62f7eb94..118dbf26 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -1,38 +1,41 @@ -### YamlMime:TSType -name: IShowLocationCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: IShowLocationCardAction -summary: Invoke an `VivaAction.ShowLocation` event. -remarks: API under active development and not ready for use. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#parameters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface' + summary: Invoke an `VivaAction.ShowLocation` event. + remarks: API under active development and not ready for use. + name: IShowLocationCardAction + fullName: IShowLocationCardAction + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + children: + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#parameters:member' summary: Parameters that can be supplied with the Viva Show Location Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters?: IShowLocationActionParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' summary: Indicates this is a Viva show Location button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''VivaAction.ShowLocation'';' return: - type: '''VivaAction.ShowLocation''' + type: + - '''VivaAction.ShowLocation''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface' + name: IShowLocationActionParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index 15e06000..c9351296 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -1,33 +1,95 @@ -### YamlMime:TSType -name: ISPFxAdaptiveCard -uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISPFxAdaptiveCard -summary: SPFx Adaptive Card Extension schema for Adaptive Cards. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: actions - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard#actions:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface' + summary: SPFx Adaptive Card Extension schema for Adaptive Cards. + name: ISPFxAdaptiveCard + fullName: ISPFxAdaptiveCard + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard~0:complex' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard~1:complex' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: actions + children: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard#actions:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard#actions:member' summary: Types of actions being exposed - remarks: '' - - isPreview: false - isDeprecated: false + name: actions + fullName: actions + langs: + - typeScript + type: property syntax: content: >- actions?: (ISubmitAction | IOpenUrlAction | IShowCardAction | ISelectMediaAction | IGetLocationAction | IShowLocationAction)[]; return: - type: >- - ( | - | | | | )[] -extends: 'Omit<, ''actions''> ' + type: + - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard#actions~0:complex' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard~0:complex' + name: Omit- + (ISubmitAction | IOpenUrlAction | IShowCardAction | ISelectMediaAction | IGetLocationAction | + IShowLocationAction)[] + fullName: >- + (ISubmitAction | IOpenUrlAction | IShowCardAction | ISelectMediaAction | IGetLocationAction | + IShowLocationAction)[] + spec.typeScript: + - name: ( + fullName: ( + - uid: 'adaptivecards!ISubmitAction:interface' + name: ISubmitAction + fullName: ISubmitAction + - name: ' | ' + fullName: ' | ' + - uid: 'adaptivecards!IOpenUrlAction:interface' + name: IOpenUrlAction + fullName: IOpenUrlAction + - name: ' | ' + fullName: ' | ' + - uid: 'adaptivecards!IShowCardAction:interface' + name: IShowCardAction + fullName: IShowCardAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface' + name: ISelectMediaAction + fullName: ISelectMediaAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction:interface' + name: IGetLocationAction + fullName: IGetLocationAction + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface' + name: IShowLocationAction + fullName: IShowLocationAction + - name: ')[]' + fullName: ')[]' diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index bf9691a0..cf697b89 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -1,42 +1,47 @@ -### YamlMime:TSType -name: ISubmitActionArguments -uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISubmitActionArguments -summary: >- - The object passed to - [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a `Submit` - Action is executed. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: data - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#data:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments:interface' + summary: >- + The object passed to + [BaseView.onAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseView%23onAction:member(1)) when a + `Submit` Action is executed. + name: ISubmitActionArguments + fullName: ISubmitActionArguments + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: data + children: + - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#data:member' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#data:member' summary: The data object defined in the Adaptive Card template - remarks: '' - - isPreview: false - isDeprecated: false + name: data + fullName: data + langs: + - typeScript + type: property syntax: content: 'data: any;' return: - type: any - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - any + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' summary: The type of Adaptive Card Action. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''Submit'';' return: - type: '''Submit''' -extends: '' + type: + - '''Submit''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface' + name: IBaseActionArguments diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index c8fa935d..d6fdcc22 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -1,51 +1,55 @@ -### YamlMime:TSType -name: ISubmitCardAction -uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISubmitCardAction -summary: Invoke an `Action.Submit` event. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: confirmationDialog - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#confirmationDialog:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction:interface' + summary: Invoke an `Action.Submit` event. + name: ISubmitCardAction + fullName: ISubmitCardAction + langs: + - typeScript + type: interface package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: confirmationDialog + children: + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#confirmationDialog:member' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#confirmationDialog:member' summary: Confirmation dialog option passed to the submit handler. - remarks: '' - - isPreview: false - isDeprecated: false + name: confirmationDialog + fullName: confirmationDialog + langs: + - typeScript + type: property syntax: content: 'confirmationDialog?: IConfirmationDialog;' return: - type: '' - - name: parameters - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: parameters + type: + - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' summary: Parameters passed to the Submit event handler. - remarks: '' - - isPreview: false - isDeprecated: false + name: parameters + fullName: parameters + langs: + - typeScript + type: property syntax: content: 'parameters: ISubmitCardParameters;' return: - type: '' - - name: type - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: type + type: + - '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' summary: Indicates this is a Submit button. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''Submit'';' return: - type: '''Submit''' + type: + - '''Submit''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface' + name: IConfirmationDialog + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + name: ISubmitCardParameters diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml index 7ee1c485..21761718 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -1,11 +1,10 @@ -### YamlMime:TSType -name: ISubmitCardParameters -uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ISubmitCardParameters -summary: Parameters for submit card action. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardParameters:interface' + summary: Parameters for submit card action. + name: ISubmitCardParameters + fullName: ISubmitCardParameters + langs: + - typeScript + type: interface + package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml index 398a8974..e7f23520 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -1,21 +1,31 @@ -### YamlMime:TSEnum -name: MediaType -uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: MediaType -summary: Enum value to specify the type of media. -remarks: API under active development and not ready for use. - -isPreview: true -isDeprecated: false -fields: - - name: Audio - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Audio:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType:enum' + summary: Enum value to specify the type of media. + remarks: API under active development and not ready for use. + isPreview: true + name: MediaType + fullName: MediaType + langs: + - typeScript + type: enum package: '@microsoft/sp-adaptive-card-extension-base!' - summary: '' - value: '4' - - name: Image - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Image:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - summary: '' - value: '1' + children: + - '@microsoft/sp-adaptive-card-extension-base!MediaType.Audio:member' + - '@microsoft/sp-adaptive-card-extension-base!MediaType.Image:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Audio:member' + isPreview: true + name: Audio + fullName: Audio + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-adaptive-card-extension-base!MediaType.Image:member' + isPreview: true + name: Image + fullName: Image + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index d1853e83..e61538b8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -1,32 +1,38 @@ -### YamlMime:TSType -name: QuickViewNavigator -uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: QuickViewNavigator -summary: Manages a stack of Adaptive Card views for the Quick view. -remarks: >- - The top of the stack is the currently rendered view. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class' + summary: Manages a stack of Adaptive Card views for the Quick view. + remarks: >- + The top of the stack is the currently rendered view. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `QuickViewNavigator` class. - -isPreview: false -isDeprecated: false -type: class -methods: - - name: close() - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator#close:member(1)' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `QuickViewNavigator` class. + name: QuickViewNavigator + fullName: QuickViewNavigator + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + inheritance: + - type: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: close() + children: + - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator#close:member(1)' + - uid: '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator#close:member(1)' summary: Closes the View. - remarks: '' - - isPreview: false - isDeprecated: false + name: close() + fullName: close() + langs: + - typeScript + type: method syntax: content: 'close(): void;' return: - type: void + type: + - void description: '' -extends: '<TView> ' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + name: ViewNavigator diff --git a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml index 6d5e51fa..1a862a9d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml @@ -1,11 +1,15 @@ -### YamlMime:TSTypeAlias -name: RenderType -uid: '@microsoft/sp-adaptive-card-extension-base!RenderType:type' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: RenderType -summary: '`Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.' -remarks: '' - -isPreview: false -isDeprecated: false -syntax: export declare type RenderType = 'Card' | 'QuickView'; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!RenderType:type' + summary: '`Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.' + name: RenderType + fullName: RenderType + langs: + - typeScript + type: typealias + syntax: + content: export declare type RenderType = 'Card' | 'QuickView'; + return: + type: + - '''Card'' | ''QuickView''' + package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index 7738b592..0a3bd8ed 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -1,24 +1,29 @@ -### YamlMime:TSType -name: ViewNavigator -uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' -package: '@microsoft/sp-adaptive-card-extension-base!' -fullName: ViewNavigator -summary: Manages a stack of views. -remarks: The top of the stack represents the currently rendered view. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class' + summary: Manages a stack of views. + remarks: The top of the stack represents the currently rendered view. + name: ViewNavigator + fullName: ViewNavigator + langs: + - typeScript + type: class package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + children: + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#currentId:member' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#pop:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#size:member' + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' summary: Constructs a new instance of the `ViewNavigator` class - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + langs: + - typeScript + type: constructor syntax: content: >- constructor(_handleStackChangedCallback: (skipUpdate: boolean) => void, _handleInitializeCallback: (view: @@ -26,131 +31,155 @@ constructors: parameters: - id: _handleStackChangedCallback description: '' - type: '(skipUpdate: boolean) => void' + type: + - '(skipUpdate: boolean) => void' + optional: false - id: _handleInitializeCallback description: '' - type: '(view: ) => void' -properties: - - name: currentId - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#currentId:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: currentId + type: + - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator~0:complex' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#currentId:member' summary: Get the id of the currently rendered View from the top of the View stack remarks: 'If the stack is empty, this will return undefined' - - isPreview: false - isDeprecated: false + name: currentId + fullName: currentId + langs: + - typeScript + type: property syntax: content: 'get currentId(): string | undefined;' return: - type: string | undefined - - name: size - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#size:member' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: size - summary: Current size of the View stack. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get size(): number;' - return: - type: number -methods: - - name: pop(skipUpdate) - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#pop:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: pop(skipUpdate) + type: + - string | undefined + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#pop:member(1)' summary: >- If there is more than one View, pops the top View from the View stack. [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. - remarks: '' - - isPreview: false - isDeprecated: false + name: pop(skipUpdate) + fullName: pop(skipUpdate) + langs: + - typeScript + type: method syntax: content: 'pop(skipUpdate?: boolean): void;' + return: + type: + - void + description: '' parameters: - id: skipUpdate description: Whether to skip the update (and re-render) after popping the current View. - type: boolean - return: - type: void - description: '' - - name: 'push(id, skipUpdate)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'push(id, skipUpdate)' + type: + - boolean + optional: true + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' summary: >- Pushes a new view to the top of the view stack. [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'push(id, skipUpdate)' + fullName: 'push(id, skipUpdate)' + langs: + - typeScript + type: method syntax: content: 'push(id: string, skipUpdate?: boolean): void;' + return: + type: + - void + description: '' parameters: - id: id description: Unique identifier for the view. - type: string + type: + - string + optional: false - id: skipUpdate description: Whether to skip the update (and re-render) after pushing the new view. - type: boolean - return: - type: void - description: '' - - name: 'register(id, initializer)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'register(id, initializer)' + type: + - boolean + optional: true + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' summary: Registers a new view. remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' - - isPreview: false - isDeprecated: false + name: 'register(id, initializer)' + fullName: 'register(id, initializer)' + langs: + - typeScript + type: method syntax: content: 'register(id: string, initializer: () => TView): void;' + return: + type: + - void + description: '' parameters: - id: id description: Unique identifier for the view. - type: string + type: + - string + optional: false - id: initializer description: 'Function that returns a new view, which is only called if no view with the `id` already exists.' - type: () => TView - return: - type: void - description: '' - - name: 'replace(id, skipUpdate)' - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' - package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'replace(id, skipUpdate)' + type: + - () => TView + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' summary: >- Replaces the top view with a new view. [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)), which will also trigger a render. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'replace(id, skipUpdate)' + fullName: 'replace(id, skipUpdate)' + langs: + - typeScript + type: method syntax: content: 'replace(id: string, skipUpdate?: boolean): void;' + return: + type: + - void + description: '' parameters: - id: id description: Unique identifier for the view. - type: string + type: + - string + optional: false - id: skipUpdate description: Whether to skip the update (and re-render) after replacing the current view. - type: boolean + type: + - boolean + optional: true + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#size:member' + summary: Current size of the View stack. + name: size + fullName: size + langs: + - typeScript + type: property + syntax: + content: 'get size(): number;' return: - type: void - description: '' + type: + - number +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator~0:complex' + name: '(view: BaseView) => void' + fullName: '(view: BaseView) => void' + spec.typeScript: + - name: '(view: ' + fullName: '(view: ' + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView:class' + name: BaseView + fullName: BaseView + - name: ) => void + fullName: ) => void diff --git a/SP-Framework/sp-application-base.yml b/SP-Framework/sp-application-base.yml index 7cc99cd3..94cdbe8c 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -1,15 +1,32 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-application-base!' -name: '@microsoft/sp-application-base' -type: package -summary: SharePoint Framework support for building and extending client-side applications. -classes: - - '@microsoft/sp-application-base!ApplicationAccessor:class' - - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' - - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' - - '@microsoft/sp-application-base!PlaceholderContent:class' - - '@microsoft/sp-application-base!PlaceholderProvider:class' -interfaces: - - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' -enums: - - '@microsoft/sp-application-base!PlaceholderName:enum' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!' + summary: SharePoint Framework support for building and extending client-side applications. + name: '@microsoft/sp-application-base' + fullName: '@microsoft/sp-application-base' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-application-base!ApplicationAccessor:class' + - '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + - '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + - '@microsoft/sp-application-base!PlaceholderContent:class' + - '@microsoft/sp-application-base!PlaceholderName:enum' + - '@microsoft/sp-application-base!PlaceholderProvider:class' +references: + - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' + name: ApplicationAccessor + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + name: ApplicationCustomizerContext + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + name: BaseApplicationCustomizer + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + name: IPlaceholderCreateContentOptions + - uid: '@microsoft/sp-application-base!PlaceholderContent:class' + name: PlaceholderContent + - uid: '@microsoft/sp-application-base!PlaceholderName:enum' + name: PlaceholderName + - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' + name: PlaceholderProvider diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 8c314cb6..1e7028c2 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -1,28 +1,29 @@ -### YamlMime:TSType -name: ApplicationAccessor -uid: '@microsoft/sp-application-base!ApplicationAccessor:class' -package: '@microsoft/sp-application-base!' -fullName: ApplicationAccessor -summary: Provides access to the client-side application that is currently running. -remarks: >- - The client-side application determines the user experience for an entire web page. (It is a client-side component with - a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side - applications at this time.) Within a web page, at most one client-side application will be running at a time. Certain - in-place navigation transitions can cause the application to be unloaded and replaced by a different application. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!ApplicationAccessor:class' + summary: Provides access to the client-side application that is currently running. + remarks: >- + The client-side application determines the user experience for an entire web page. (It is a client-side component + with a manifest; however, the SharePoint Framework does not enable third parties to create their own client-side + applications at this time.) Within a web page, at most one client-side application will be running at a time. + Certain in-place navigation transitions can cause the application to be unloaded and replaced by a different + application. - The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with the - currently running application. It acts as a proxy for the real application object (the BaseApplication subclass), to - ensure that extensibility components only rely on interactions that would be portable across all applications. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' + The ApplicationAccessor class enables extensibility components such as extensions and web parts to interact with + the currently running application. It acts as a proxy for the real application object (the BaseApplication + subclass), to ensure that extensibility components only rely on interactions that would be portable across all + applications. + name: ApplicationAccessor + fullName: ApplicationAccessor + langs: + - typeScript + type: class package: '@microsoft/sp-application-base!' - fullName: (constructor)(serviceScope) + children: + - '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' + - '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' + - uid: '@microsoft/sp-application-base!ApplicationAccessor:constructor(1)' summary: >- Constructs a new instance of the [ApplicationAccessor](xref:@microsoft/sp-application-base!ApplicationAccessor:class) class. @@ -31,30 +32,48 @@ constructors: context, for example [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). - - isPreview: false - isDeprecated: false + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: '' -events: - - name: navigatedEvent - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' - package: '@microsoft/sp-application-base!' - fullName: navigatedEvent + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' summary: An event that is fired when the application's top-level page context navigates to a new page. remarks: >- This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has navigated to a new page. - - isPreview: false - isDeprecated: false + name: navigatedEvent + fullName: navigatedEvent + langs: + - typeScript + type: event syntax: content: 'get navigatedEvent(): SPEvent;' return: - type: >- - <> + type: + - '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent~0:complex' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + fullName: SPEventArgs + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index beeddf8e..8ec3c950 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -1,60 +1,70 @@ -### YamlMime:TSType -name: ApplicationCustomizerContext -uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' -package: '@microsoft/sp-application-base!' -fullName: ApplicationCustomizerContext -summary: >- - The component context for - [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ApplicationCustomizerContext` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: application - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext:class' + summary: >- + The component context for + [BaseApplicationCustomizer](xref:@microsoft/sp-application-base!BaseApplicationCustomizer:class). + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ApplicationCustomizerContext` class. + name: ApplicationCustomizerContext + fullName: ApplicationCustomizerContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' package: '@microsoft/sp-application-base!' - fullName: application + children: + - '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' + - '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' + - '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#application:member' summary: Provides access to the client-side application that is currently running. - remarks: '' - - isPreview: false - isDeprecated: false + name: application + fullName: application + langs: + - typeScript + type: property syntax: content: 'get application(): ApplicationAccessor;' return: - type: '' - - name: placeholderProvider - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' - package: '@microsoft/sp-application-base!' - fullName: placeholderProvider - summary: Exposes a collection of content placeholders for use by third parties. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get placeholderProvider(): PlaceholderProvider;' - return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' - package: '@microsoft/sp-application-base!' + type: + - '@microsoft/sp-application-base!default:class' + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' + name: dispose() fullName: dispose() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- /** @override */ dispose(): void; return: - type: void + type: + - void description: '' -extends: '' + - uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' + summary: Exposes a collection of content placeholders for use by third parties. + name: placeholderProvider + fullName: placeholderProvider + langs: + - typeScript + type: property + syntax: + content: 'get placeholderProvider(): PlaceholderProvider;' + return: + type: + - '@microsoft/sp-application-base!default:class' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-application-base!default:class' + name: ApplicationAccessor diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index d86e6f84..b851e2a5 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -1,70 +1,84 @@ -### YamlMime:TSType -name: BaseApplicationCustomizer -uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' -package: '@microsoft/sp-application-base!' -fullName: BaseApplicationCustomizer -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that runs when an - application is first starting. -remarks: >- - In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer:class' + summary: >- + This is the base class that third parties should extend when implementing a client-side extension that runs when + an application is first starting. + remarks: >- + In the component manifest, the "extensionType" should be set to "ApplicationCustomizer". - Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint - content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period. -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' + Example usage scenarios for an application customizer might include: rendering custom UI elements inside a + SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a + certain time period. + name: BaseApplicationCustomizer + fullName: BaseApplicationCustomizer + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-application-base!' + children: + - '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' + - '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' + - '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#context:member' + name: context fullName: context - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected readonly context: ApplicationCustomizerContext;' return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() + type: + - '@microsoft/sp-application-base!default:class' + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' summary: Disposes the component. remarks: >- Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the method. - - isPreview: false - isDeprecated: false + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method syntax: content: 'dispose(): void;' return: - type: void + type: + - void description: '' - - name: onPlaceholdersChanged(placeholderProvider) - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' - package: '@microsoft/sp-application-base!' - fullName: onPlaceholdersChanged(placeholderProvider) + - uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#onPlaceholdersChanged:member(1)' summary: >- This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: onPlaceholdersChanged(placeholderProvider) + fullName: onPlaceholdersChanged(placeholderProvider) + langs: + - typeScript + type: method syntax: content: 'protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;' + return: + type: + - void + description: '' parameters: - id: placeholderProvider description: '' - type: '' - return: - type: void - description: '' -extends: '<TProperties> ' + type: + - '@microsoft/sp-application-base!default:class' + optional: false +references: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-application-base!default:class' + name: ApplicationCustomizerContext diff --git a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index 0af8fb9d..18d82c71 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -1,31 +1,43 @@ -### YamlMime:TSType -name: IPlaceholderCreateContentOptions -uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' -package: '@microsoft/sp-application-base!' -fullName: IPlaceholderCreateContentOptions -summary: >- - Options for the - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) - method. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: onDispose - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + summary: >- + Options for the + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) + method. + name: IPlaceholderCreateContentOptions + fullName: IPlaceholderCreateContentOptions + langs: + - typeScript + type: interface package: '@microsoft/sp-application-base!' - fullName: onDispose + children: + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose:member' summary: An optional callback that will be invoked when the PlaceholderContent object is disposed. remarks: >- To avoid a resource leak, use this callback to free any resources that were allocated when the placeholder content was rendered. For example, if ReactDOM.render() was used to mount a React component, then the onDispose handler might call ReactDOM.unmountComponentAtNode() to unmount it. - - isPreview: false - isDeprecated: false + name: onDispose + fullName: onDispose + langs: + - typeScript + type: property syntax: content: 'onDispose?: (placeholderContent: PlaceholderContent) => void;' return: - type: '(placeholderContent: ) => void' + type: + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose~0:complex' +references: + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions#onDispose~0:complex' + name: '(placeholderContent: PlaceholderContent) => void' + fullName: '(placeholderContent: default) => void' + spec.typeScript: + - name: '(placeholderContent: ' + fullName: '(placeholderContent: ' + - uid: '@microsoft/sp-application-base!default:class' + name: PlaceholderContent + fullName: default + - name: ) => void + fullName: ) => void diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index f79b33e8..e08eee41 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -1,95 +1,105 @@ -### YamlMime:TSType -name: PlaceholderContent -uid: '@microsoft/sp-application-base!PlaceholderContent:class' -package: '@microsoft/sp-application-base!' -fullName: PlaceholderContent -summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. -remarks: >- - This object is returned by - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!PlaceholderContent:class' + summary: Represents custom content that is rendered inside a placeholder on a SharePoint page. + remarks: >- + This object is returned by + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)). It provides access to a Document Object Model (DOM) element where the owner can render its custom content. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `PlaceholderContent` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: domElement - uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderContent` class. + name: PlaceholderContent + fullName: PlaceholderContent + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-application-base!' - fullName: domElement + children: + - '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' + - '@microsoft/sp-application-base!PlaceholderContent#domElement:member' + - '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' + - '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' + - '@microsoft/sp-application-base!PlaceholderContent#name:member' + - uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' + summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. + remarks: >- + This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the + application when the containing placeholder is disposed. Calling dispose() invokes the + [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) + callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-application-base!PlaceholderContent#domElement:member' summary: The Document Object Model (DOM) element where the owner should render its custom content. remarks: >- If the caller needs to be notified when the DOM element is disposed, use the [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) callback. - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'get domElement(): HTMLDivElement;' return: - type: HTMLDivElement - - name: isDisposed - uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' - package: '@microsoft/sp-application-base!' + type: + - '!HTMLDivElement:interface' + - uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' + name: isDisposed fullName: isDisposed - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'get isDisposed(): boolean;' return: - type: boolean - - name: isVisible - uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' - package: '@microsoft/sp-application-base!' - fullName: isVisible + type: + - boolean + - uid: '@microsoft/sp-application-base!PlaceholderContent#isVisible:member' summary: >- Return true if this PlacholderContent object is visible. If you create a placeholder and the host page isn't displaying it, this will return false. - remarks: '' - - isPreview: false - isDeprecated: false + name: isVisible + fullName: isVisible + langs: + - typeScript + type: property syntax: content: 'get isVisible(): boolean;' return: - type: boolean - - name: name - uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' - package: '@microsoft/sp-application-base!' - fullName: name + type: + - boolean + - uid: '@microsoft/sp-application-base!PlaceholderContent#name:member' summary: Identifies the placeholder that this content was added to. remarks: 'Example: PlaceholderName.Top' - - isPreview: false - isDeprecated: false + name: name + fullName: name + langs: + - typeScript + type: property syntax: content: 'get name(): PlaceholderName;' return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() - summary: Disposes the PlaceholderContent object and removes its attached DOM element from the page. - remarks: >- - This method can be called to immediately dispose the attached DOM element. Otherwise, it will be disposed by the - application when the containing placeholder is disposed. Calling dispose() invokes the - [IPlaceholderCreateContentOptions.onDispose](xref:@microsoft/sp-application-base!IPlaceholderCreateContentOptions%23onDispose:member) - callback, removes the associated DOM element from the page, and disposes the PlaceholderContent object. - - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' + type: + - '@microsoft/sp-application-base!~PlaceholderName:enum' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '!HTMLDivElement:interface' + name: HTMLDivElement + - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' + name: PlaceholderName diff --git a/SP-Framework/sp-application-base/placeholdername.yml b/SP-Framework/sp-application-base/placeholdername.yml index 1a858e28..f46b2010 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -1,25 +1,34 @@ -### YamlMime:TSEnum -name: PlaceholderName -uid: '@microsoft/sp-application-base!PlaceholderName:enum' -package: '@microsoft/sp-application-base!' -fullName: PlaceholderName -summary: >- - The identifier for a content placeholder, which is a region on the page where third-party extensibility components can - render custom content. -remarks: >- - For more information about placeholders, see - [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). - -isPreview: false -isDeprecated: false -fields: - - name: Bottom - uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!PlaceholderName:enum' + summary: >- + The identifier for a content placeholder, which is a region on the page where third-party extensibility components + can render custom content. + remarks: >- + For more information about placeholders, see + [PlaceholderProvider](xref:@microsoft/sp-application-base!PlaceholderProvider:class). + name: PlaceholderName + fullName: PlaceholderName + langs: + - typeScript + type: enum package: '@microsoft/sp-application-base!' + children: + - '@microsoft/sp-application-base!PlaceholderName.Bottom:member' + - '@microsoft/sp-application-base!PlaceholderName.Top:member' + - uid: '@microsoft/sp-application-base!PlaceholderName.Bottom:member' summary: A region at the bottom of the page. - value: '2' - - name: Top - uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' - package: '@microsoft/sp-application-base!' + name: Bottom + fullName: Bottom + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-application-base!PlaceholderName.Top:member' summary: A region at the top of the page. - value: '1' + name: Top + fullName: Top + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index f69809bd..8a574547 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -1,78 +1,92 @@ -### YamlMime:TSType -name: PlaceholderProvider -uid: '@microsoft/sp-application-base!PlaceholderProvider:class' -package: '@microsoft/sp-application-base!' -fullName: PlaceholderProvider -summary: >- - Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party components - to render custom content into designated regions on the page. -remarks: >- - Placeholders are designated regions on the page, identified by one of the predefined - [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and - pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with the - page, for example via in-place navigation. Third-party components should not assume that a given placeholder will - always be available. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-application-base!PlaceholderProvider:class' + summary: >- + Allows third-party components to discover and use SharePoint placeholders. Placeholders enable third-party + components to render custom content into designated regions on the page. + remarks: >- + Placeholders are designated regions on the page, identified by one of the predefined + [PlaceholderName](xref:@microsoft/sp-application-base!PlaceholderName:enum) constants. Different applications and + pages might support different placeholder names. Placeholders can appear and disappear as the user interacts with + the page, for example via in-place navigation. Third-party components should not assume that a given placeholder + will always be available. - Use - [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) - to test whether a placeholder is available and add content to it. Use the - [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider%23changedEvent:member) - event to discover when new placeholders appear. + Use + [PlaceholderProvider.tryCreateContent()](xref:@microsoft/sp-application-base!PlaceholderProvider%23tryCreateContent:member(1)) + to test whether a placeholder is available and add content to it. Use the + [PlaceholderProvider.changedEvent](xref:@microsoft/sp-application-base!PlaceholderProvider%23changedEvent:member) + event to discover when new placeholders appear. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `PlaceholderProvider` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: isDisposed - uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `PlaceholderProvider` class. + name: PlaceholderProvider + fullName: PlaceholderProvider + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-application-base!' + children: + - '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' + - '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' + - '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' + - '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' + - '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' + summary: This event is raised when the list of currently available placeholders is changed. + remarks: >- + The application can change its list of available placeholders at any time. This means that the existing + placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when + they appear. + name: changedEvent + fullName: changedEvent + langs: + - typeScript + type: event + syntax: + content: 'get changedEvent(): SPEvent;' + return: + type: + - '@microsoft/sp-application-base!PlaceholderProvider#changedEvent~0:complex' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member' + name: isDisposed fullName: isDisposed - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'get isDisposed(): boolean;' return: - type: boolean - - name: placeholderNames - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' - package: '@microsoft/sp-application-base!' - fullName: placeholderNames + type: + - boolean + - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' summary: Returns the names of the currently available placeholders. - remarks: '' - - isPreview: false - isDeprecated: false + name: placeholderNames + fullName: placeholderNames + langs: + - typeScript + type: property syntax: content: 'get placeholderNames(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' -methods: - - name: dispose() - uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' - package: '@microsoft/sp-application-base!' - fullName: dispose() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: 'tryCreateContent(name, options)' - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' - package: '@microsoft/sp-application-base!' - fullName: 'tryCreateContent(name, options)' + type: + - '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames~0:complex' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' summary: >- Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder. @@ -80,39 +94,71 @@ methods: The host application makes no guarantees about the availability of a given placeholder. In situations where an expected placeholder is not available, the third-party extension must handle it gracefully, e.g. by not rendering anything, or by choosing an alternative placeholder. - - isPreview: false - isDeprecated: false + name: 'tryCreateContent(name, options)' + fullName: 'tryCreateContent(name, options)' + langs: + - typeScript + type: method syntax: content: >- tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined; + return: + type: + - '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent~0:complex' + description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' parameters: - id: name description: The requested placeholder - type: '' + type: + - '@microsoft/sp-application-base!~PlaceholderName:enum' + optional: false - id: options description: 'Additional options, for example to detect when the placeholder is disposed.' - type: '' - return: - type: ' | undefined' - description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' -events: - - name: changedEvent - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' - package: '@microsoft/sp-application-base!' - fullName: changedEvent - summary: This event is raised when the list of currently available placeholders is changed. - remarks: >- - The application can change its list of available placeholders at any time. This means that the existing - placeholders may get disposed or new placeholders may be added. Use this event to discover new placeholders when - they appear. - - isPreview: false - isDeprecated: false - syntax: - content: 'get changedEvent(): SPEvent;' - return: - type: >- - <> + type: + - '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + optional: true +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + fullName: SPEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' + name: PlaceholderName + fullName: PlaceholderName + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent~0:complex' + name: PlaceholderContent | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-application-base!default:class' + name: PlaceholderContent + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-application-base!~PlaceholderName:enum' + name: PlaceholderName + - uid: '@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface' + name: IPlaceholderCreateContentOptions diff --git a/SP-Framework/sp-component-base.yml b/SP-Framework/sp-component-base.yml index 7fc70c77..36cfa4e0 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -1,21 +1,54 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-component-base!' -name: '@microsoft/sp-component-base' -type: package -summary: SharePoint Framework support for building client-side components -classes: - - '@microsoft/sp-component-base!BaseComponent:class' - - '@microsoft/sp-component-base!BaseComponentContext:class' - - '@microsoft/sp-component-base!DynamicDataProvider:class' - - '@microsoft/sp-component-base!DynamicDataSourceManager:class' - - '@microsoft/sp-component-base!DynamicProperty:class' - - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' - - '@microsoft/sp-component-base!ThemeProvider:class' -interfaces: - - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' - - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' - - '@microsoft/sp-component-base!IReadonlyTheme:interface' - - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' - - '@microsoft/sp-component-base!ITheme:interface' -typeAliases: - - '@microsoft/sp-component-base!IReadonlyRawStyle:type' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!' + summary: SharePoint Framework support for building client-side components + remarks: >- + This package supports development of client-side components (e.g. web parts, client-side extensions, and + applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality + that is common across all client-side component types. + name: '@microsoft/sp-component-base' + fullName: '@microsoft/sp-component-base' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-component-base!BaseComponent:class' + - '@microsoft/sp-component-base!BaseComponentContext:class' + - '@microsoft/sp-component-base!DynamicDataProvider:class' + - '@microsoft/sp-component-base!DynamicDataSourceManager:class' + - '@microsoft/sp-component-base!DynamicProperty:class' + - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + - '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + - '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - '@microsoft/sp-component-base!IReadonlyTheme:interface' + - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + - '@microsoft/sp-component-base!ITheme:interface' + - '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + - '@microsoft/sp-component-base!ThemeProvider:class' +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' + name: DynamicDataProvider + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' + name: DynamicDataSourceManager + - uid: '@microsoft/sp-component-base!DynamicProperty:class' + name: DynamicProperty + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + name: IComponentPropertyMetadata + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + name: IReadonlyFontStyles + - uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' + name: IReadonlyRawStyle + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + name: IReadonlyTheme + - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + name: ISerializedServerProcessedData + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + name: ThemeChangedEventArgs + - uid: '@microsoft/sp-component-base!ThemeProvider:class' + name: ThemeProvider diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index 6fa0a6a4..dab320f4 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -1,122 +1,135 @@ -### YamlMime:TSType -name: BaseComponent -uid: '@microsoft/sp-component-base!BaseComponent:class' -package: '@microsoft/sp-component-base!' -fullName: BaseComponent -summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseComponent` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: componentId - uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + summary: The base class for client-side components such as BaseClientSideWebPart or BaseExtension. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponent` class. + name: BaseComponent + fullName: BaseComponent + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!ISPEventObserver:interface' package: '@microsoft/sp-component-base!' - fullName: componentId + children: + - '@microsoft/sp-component-base!BaseComponent#componentId:member' + - '@microsoft/sp-component-base!BaseComponent#context:member' + - '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' + - '@microsoft/sp-component-base!BaseComponent#instanceId:member' + - '@microsoft/sp-component-base!BaseComponent#isDisposed:member' + - '@microsoft/sp-component-base!BaseComponent#manifest:member' + - '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' + - uid: '@microsoft/sp-component-base!BaseComponent#componentId:member' summary: Returns the component identifier as defined in the component's associated manifest. remarks: >- Each client-side component has an associated manifest that is used by the sp-loader to load its scripts, and which may include additional metadata about the component. The manifest is uniquely identified using a text string containing a lower case GUID value. - - isPreview: false - isDeprecated: false + name: componentId + fullName: componentId + langs: + - typeScript + type: property syntax: content: 'get componentId(): string;' return: - type: string - - name: context - uid: '@microsoft/sp-component-base!BaseComponent#context:member' - package: '@microsoft/sp-component-base!' - fullName: context + type: + - string + - uid: '@microsoft/sp-component-base!BaseComponent#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'protected context?: BaseComponentContext;' return: - type: '' - - name: instanceId - uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' - package: '@microsoft/sp-component-base!' - fullName: instanceId + type: + - '@microsoft/sp-component-base!~BaseComponentContext:class' + - uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' + summary: Disposes the component. + remarks: >- + Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends + for a web part or extension. To perform custom cleanup when your component is disposed, override the + [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' summary: A unique identifier for the instance of the component. remarks: >- A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - - isPreview: false - isDeprecated: false + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property syntax: content: 'get instanceId(): string;' return: - type: string - - name: isDisposed - uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed + type: + - string + - uid: '@microsoft/sp-component-base!BaseComponent#isDisposed:member' summary: Returns true if the component has been already disposed. - remarks: '' - - isPreview: false - isDeprecated: false + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property syntax: content: 'get isDisposed(): boolean;' return: - type: boolean - - name: manifest - uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' - package: '@microsoft/sp-component-base!' - fullName: manifest + type: + - boolean + - uid: '@microsoft/sp-component-base!BaseComponent#manifest:member' summary: Provides access to the manifest for the client-side component. virtual remarks: Child classes can override this with more specialized manifest types. - - isPreview: false - isDeprecated: false + name: manifest + fullName: manifest + langs: + - typeScript + type: property syntax: content: 'get manifest(): IClientSideComponentManifest;' return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: Disposes the component. - remarks: >- - Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends - for a web part or extension. To perform custom cleanup when your component is disposed, override the - [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. - - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: onDispose() + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - uid: '@microsoft/sp-component-base!BaseComponent#onDispose:member(1)' summary: >- This event method is called at the end of the component's lifecycle. It provides an opportunity to release any associated resources, cancel any outstanding requests, etc. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: onDispose() + fullName: onDispose() + langs: + - typeScript + type: method syntax: content: 'protected onDispose(): void;' return: - type: void + type: + - void description: '' +references: + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + name: ISPEventObserver + - uid: '@microsoft/sp-component-base!~BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 31aa9387..d1afc269 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -1,208 +1,232 @@ -### YamlMime:TSType -name: BaseComponentContext -uid: '@microsoft/sp-component-base!BaseComponentContext:class' -package: '@microsoft/sp-component-base!' -fullName: BaseComponentContext -summary: The base class for context objects for client-side components. -remarks: >- - A "context" object is a collection of well-known services and other objects that are likely to be needed by business - logic that interacts with a associated component. Each component type has its own specialized subclass of - BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + summary: The base class for context objects for client-side components. + remarks: >- + A "context" object is a collection of well-known services and other objects that are likely to be needed by + business logic that interacts with a associated component. Each component type has its own specialized subclass of + BaseComponentContext, e.g. WebPartContext for web parts, ExtensionContext for client-side extensions, and so on. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseComponentContext` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: aadHttpClientFactory - uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseComponentContext` class. + name: BaseComponentContext + fullName: BaseComponentContext + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-component-base!' - fullName: aadHttpClientFactory + children: + - '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' + - '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' + - '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' + - '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' + - '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' + - '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' + - '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' + - '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' + - '@microsoft/sp-component-base!BaseComponentContext#isServedFromLocalhost:member' + - '@microsoft/sp-component-base!BaseComponentContext#manifest:member' + - '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' + - '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' + - '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' + - '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' + - uid: '@microsoft/sp-component-base!BaseComponentContext#aadHttpClientFactory:member' summary: The instance of AadHttpClientFactory created for this instance of component - remarks: '' - - isPreview: false - isDeprecated: false + name: aadHttpClientFactory + fullName: aadHttpClientFactory + langs: + - typeScript + type: property syntax: content: 'get aadHttpClientFactory(): AadHttpClientFactory;' return: - type: '' - - name: aadTokenProviderFactory - uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' - package: '@microsoft/sp-component-base!' - fullName: aadTokenProviderFactory + type: + - '@microsoft/sp-http!AadHttpClientFactory:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' summary: The instance of AadTokenProviderFactory created for this instance of component - remarks: '' - - isPreview: false - isDeprecated: false + name: aadTokenProviderFactory + fullName: aadTokenProviderFactory + langs: + - typeScript + type: property syntax: content: 'get aadTokenProviderFactory(): AadTokenProviderFactory;' return: - type: '' - - name: dynamicDataProvider - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' - package: '@microsoft/sp-component-base!' - fullName: dynamicDataProvider + type: + - '@microsoft/sp-http!AadTokenProviderFactory:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' + summary: Disposes the base component context. + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' summary: Returns the Dynamic Data Provider associated with the component. - remarks: '' - - isPreview: false - isDeprecated: false + name: dynamicDataProvider + fullName: dynamicDataProvider + langs: + - typeScript + type: property syntax: content: 'get dynamicDataProvider(): DynamicDataProvider;' return: - type: '' - - name: dynamicDataSourceManager - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' - package: '@microsoft/sp-component-base!' - fullName: dynamicDataSourceManager + type: + - '@microsoft/sp-component-base!default:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' summary: Returns the Dynamic Data Source Manager associated with the component. - remarks: '' - - isPreview: false - isDeprecated: false + name: dynamicDataSourceManager + fullName: dynamicDataSourceManager + langs: + - typeScript + type: property syntax: content: 'get dynamicDataSourceManager(): DynamicDataSourceManager;' return: - type: '' - - name: httpClient - uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' - package: '@microsoft/sp-component-base!' - fullName: httpClient + type: + - '@microsoft/sp-component-base!default:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' summary: The instance of HttpClient created for this instance of component - remarks: '' - - isPreview: false - isDeprecated: false + name: httpClient + fullName: httpClient + langs: + - typeScript + type: property syntax: content: 'get httpClient(): HttpClient;' return: - type: '' - - name: instanceId - uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' - package: '@microsoft/sp-component-base!' - fullName: instanceId + type: + - '@microsoft/sp-http!HttpClient:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' summary: A unique identifier for the instance of the component. remarks: >- A component implementation can be loaded multiple times on the page. For example, if the component is a charting web part, multiple instances of this web part could be added to the SharePoint canvas. The instanceId uniquely identifies each of these instances. - - isPreview: false - isDeprecated: false + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property syntax: content: 'get instanceId(): string;' return: - type: string - - name: isDisposed - uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed + type: + - string + - uid: '@microsoft/sp-component-base!BaseComponentContext#isDisposed:member' summary: Returns true if the context is disposed. - remarks: '' - - isPreview: false - isDeprecated: false + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property syntax: content: 'get isDisposed(): boolean;' return: - type: boolean - - name: isServedFromLocalhost - uid: '@microsoft/sp-component-base!BaseComponentContext#isServedFromLocalhost:member' - package: '@microsoft/sp-component-base!' - fullName: isServedFromLocalhost + type: + - boolean + - uid: '@microsoft/sp-component-base!BaseComponentContext#isServedFromLocalhost:member' summary: Returns true if the solution is being served from localhost - remarks: '' - - isPreview: false - isDeprecated: false + name: isServedFromLocalhost + fullName: isServedFromLocalhost + langs: + - typeScript + type: property syntax: content: 'get isServedFromLocalhost(): boolean;' return: - type: boolean - - name: manifest - uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' - package: '@microsoft/sp-component-base!' - fullName: manifest + type: + - boolean + - uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' summary: Manifest for the client-side component. - remarks: '' - - isPreview: false - isDeprecated: false + name: manifest + fullName: manifest + langs: + - typeScript + type: property syntax: content: 'readonly manifest: IClientSideComponentManifest;' return: - type: '' - - name: msGraphClientFactory - uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' - package: '@microsoft/sp-component-base!' - fullName: msGraphClientFactory + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' summary: The instance of MSGraphClientFactory created for this instance of component - remarks: '' - - isPreview: false - isDeprecated: false + name: msGraphClientFactory + fullName: msGraphClientFactory + langs: + - typeScript + type: property syntax: content: 'get msGraphClientFactory(): MSGraphClientFactory;' return: - type: '' - - name: pageContext - uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' - package: '@microsoft/sp-component-base!' - fullName: pageContext + type: + - '@microsoft/sp-http!MSGraphClientFactory:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' summary: >- The page context provides standard definitions for common SharePoint objects that need to be shared between the client-side application, web parts, and other components. - remarks: '' - - isPreview: false - isDeprecated: false + name: pageContext + fullName: pageContext + langs: + - typeScript + type: property syntax: content: 'get pageContext(): PageContext;' return: - type: '' - - name: serviceScope - uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' - package: '@microsoft/sp-component-base!' - fullName: serviceScope + type: + - '@microsoft/sp-page-context!PageContext:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' remarks: A child service scope is created for each client-side component. - - isPreview: false - isDeprecated: false + name: serviceScope + fullName: serviceScope + langs: + - typeScript + type: property syntax: content: 'get serviceScope(): ServiceScope;' return: - type: '' - - name: spHttpClient - uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' - package: '@microsoft/sp-component-base!' - fullName: spHttpClient + type: + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' summary: The instance of SpHttpClient created for this instance of component - remarks: '' - - isPreview: false - isDeprecated: false + name: spHttpClient + fullName: spHttpClient + langs: + - typeScript + type: property syntax: content: 'get spHttpClient(): SPHttpClient;' return: - type: '' -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: Disposes the base component context. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' + type: + - '@microsoft/sp-http!SPHttpClient:class' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-http!AadHttpClientFactory:class' + name: AadHttpClientFactory + - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + name: AadTokenProviderFactory + - uid: '@microsoft/sp-component-base!default:class' + name: DynamicDataProvider + - uid: '@microsoft/sp-http!HttpClient:class' + name: HttpClient + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-http!MSGraphClientFactory:class' + name: MSGraphClientFactory + - uid: '@microsoft/sp-page-context!PageContext:class' + name: PageContext + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!SPHttpClient:class' + name: SPHttpClient diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index 177d049e..53c3e1c5 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -1,202 +1,254 @@ -### YamlMime:TSType -name: DynamicDataProvider -uid: '@microsoft/sp-component-base!DynamicDataProvider:class' -package: '@microsoft/sp-component-base!' -fullName: DynamicDataProvider -summary: >- - The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data - sources and register/unregister to those. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: isDisposed - uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: Returns true if the Dynamic Data Provider is disposed. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!DynamicDataProvider:class' + summary: >- + The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data + sources and register/unregister to those. + name: DynamicDataProvider + fullName: DynamicDataProvider + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-component-base!' - fullName: dispose() + children: + - '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' + - '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' + - uid: '@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)' summary: Disposes the Dynamic Data Provider. - remarks: '' - - isPreview: false - isDeprecated: false + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method syntax: content: 'dispose(): void;' return: - type: void + type: + - void description: '' - - name: getAvailableSources() - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' - package: '@microsoft/sp-component-base!' - fullName: getAvailableSources() + - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' summary: Returns a list with all available Dynamic Data Sources. - remarks: '' - - isPreview: false - isDeprecated: false + name: getAvailableSources() + fullName: getAvailableSources() + langs: + - typeScript + type: method syntax: content: 'getAvailableSources(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: + - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' description: Read-only array with all available sources. - - name: registerAvailableSourcesChanged(callback) - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: registerAvailableSourcesChanged(callback) + - uid: '@microsoft/sp-component-base!DynamicDataProvider#isDisposed:member' + summary: Returns true if the Dynamic Data Provider is disposed. + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property + syntax: + content: 'get isDisposed(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' summary: Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated. - remarks: '' - - isPreview: false - isDeprecated: false + name: registerAvailableSourcesChanged(callback) + fullName: registerAvailableSourcesChanged(callback) + langs: + - typeScript + type: method syntax: content: 'registerAvailableSourcesChanged(callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: callback description: Function to execute when the sources are updated. - type: () => void - return: - type: void - description: '' - - name: 'registerPropertyChanged(sourceId, propertyId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' + type: + - () => void + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' summary: Registers a callback for updates when a property is changed in a Dynamic Data source. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'registerPropertyChanged(sourceId, propertyId, callback)' + fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' + langs: + - typeScript + type: method syntax: content: 'registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: string + type: + - string + optional: false - id: propertyId description: Id of the property of the source. - type: string + type: + - string + optional: false - id: callback description: Function to execute when the source updates its data. - type: () => void - return: - type: void - description: '' - - name: 'registerSourceChanged(sourceId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'registerSourceChanged(sourceId, callback)' + type: + - () => void + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' summary: >- Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'registerSourceChanged(sourceId, callback)' + fullName: 'registerSourceChanged(sourceId, callback)' + langs: + - typeScript + type: method syntax: content: 'registerSourceChanged(sourceId: string, callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: string + type: + - string + optional: false - id: callback description: Function to execute when the source updates its data. - type: () => void - return: - type: void - description: '' - - name: tryGetSource(id) - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetSource(id) + type: + - () => void + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' - remarks: '' - - isPreview: false - isDeprecated: false + name: tryGetSource(id) + fullName: tryGetSource(id) + langs: + - typeScript + type: method syntax: content: 'tryGetSource(id: string): IDynamicDataSource | undefined;' + return: + type: + - '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource~0:complex' + description: '' parameters: - id: id description: Id of the Dynamic Data Source. - type: string - return: - type: ' | undefined' - description: '' - - name: unregisterAvailableSourcesChanged(callback) - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: unregisterAvailableSourcesChanged(callback) + type: + - string + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' summary: Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated. - remarks: '' - - isPreview: false - isDeprecated: false + name: unregisterAvailableSourcesChanged(callback) + fullName: unregisterAvailableSourcesChanged(callback) + langs: + - typeScript + type: method syntax: content: 'unregisterAvailableSourcesChanged(callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: callback description: Function to remove from the registration. Must be the same it was registered with. - type: () => void - return: - type: void - description: '' - - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + type: + - () => void + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + langs: + - typeScript + type: method syntax: content: 'unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: string + type: + - string + optional: false - id: propertyId description: Id of the property of the source. - type: string + type: + - string + optional: false - id: callback description: Function to remove from the registration. Must be the same it was registered with. - type: () => void - return: - type: void - description: '' - - name: 'unregisterSourceChanged(sourceId, callback)' - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: 'unregisterSourceChanged(sourceId, callback)' + type: + - () => void + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' summary: Unregisters a callback for updates when a Dynamic Data source is changed. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'unregisterSourceChanged(sourceId, callback)' + fullName: 'unregisterSourceChanged(sourceId, callback)' + langs: + - typeScript + type: method syntax: content: 'unregisterSourceChanged(sourceId: string, callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: sourceId description: Id of the Dynamic Data Source. - type: string + type: + - string + optional: false - id: callback description: Function to remove from the registration. Must be the same it was registered with. - type: () => void - return: - type: void - description: '' + type: + - () => void + optional: false +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + fullName: IDynamicDataSource + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource~0:complex' + name: IDynamicDataSource | undefined + fullName: IDynamicDataSource | undefined + spec.typeScript: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + fullName: IDynamicDataSource + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index a93e86d9..0e3727cd 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -1,138 +1,163 @@ -### YamlMime:TSType -name: DynamicDataSourceManager -uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' -package: '@microsoft/sp-component-base!' -fullName: DynamicDataSourceManager -summary: >- - The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization - of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been - updated. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: isDisposed - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed - summary: Returns true if the DynamicDataSourceManager is disposed. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get isDisposed(): boolean;' - return: - type: boolean - - name: sourceId - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' - package: '@microsoft/sp-component-base!' - fullName: sourceId +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager:class' summary: >- - Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it - returns an empty string. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get sourceId(): string;' - return: - type: string -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' + The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing + initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify + when data has been updated. + name: DynamicDataSourceManager + fullName: DynamicDataSourceManager + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-component-base!' - fullName: dispose() + children: + - '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' + - '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' + - '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' + - '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)' summary: Disposes the resources held by the Dynamic Data source. - remarks: '' - - isPreview: false - isDeprecated: false + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method syntax: content: 'dispose(): void;' return: - type: void + type: + - void description: '' - - name: initializeSource(callableFunctions) - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' - package: '@microsoft/sp-component-base!' - fullName: initializeSource(callableFunctions) + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' summary: Initializes the Dynamic Data Source for the component. - remarks: '' - - isPreview: false - isDeprecated: false + name: initializeSource(callableFunctions) + fullName: initializeSource(callableFunctions) + langs: + - typeScript + type: method syntax: content: 'initializeSource(callableFunctions: IDynamicDataCallables): void;' + return: + type: + - void + description: '' parameters: - id: callableFunctions description: Set of methods that are exposed through the Dynamic Data Source - type: '' + type: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member' + summary: Returns true if the DynamicDataSourceManager is disposed. + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property + syntax: + content: 'get isDisposed(): boolean;' return: - type: void - description: '' - - name: notifyPropertyChanged(propertyId) - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: notifyPropertyChanged(propertyId) + type: + - boolean + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifyPropertyChanged:member(1)' summary: >- Notifies that this source has updated a specific property. When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. - remarks: '' - - isPreview: false - isDeprecated: false + name: notifyPropertyChanged(propertyId) + fullName: notifyPropertyChanged(propertyId) + langs: + - typeScript + type: method syntax: content: 'notifyPropertyChanged(propertyId: string): void;' + return: + type: + - void + description: '' parameters: - id: propertyId description: Id of the updated property in the source. - type: string - return: - type: void - description: '' - - name: notifySourceChanged() - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' - package: '@microsoft/sp-component-base!' - fullName: notifySourceChanged() + type: + - string + optional: false + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#notifySourceChanged:member(1)' summary: >- Notifies that this source has updated its properties. When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source. - remarks: '' - - isPreview: false - isDeprecated: false + name: notifySourceChanged() + fullName: notifySourceChanged() + langs: + - typeScript + type: method syntax: content: 'notifySourceChanged(): void;' return: - type: void + type: + - void description: '' - - name: updateMetadata(metadata) - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' - package: '@microsoft/sp-component-base!' - fullName: updateMetadata(metadata) + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#sourceId:member' + summary: >- + Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it + returns an empty string. + name: sourceId + fullName: sourceId + langs: + - typeScript + type: property + syntax: + content: 'get sourceId(): string;' + return: + type: + - string + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata:member(1)' summary: >- Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated. - remarks: '' - - isPreview: false - isDeprecated: false + name: updateMetadata(metadata) + fullName: updateMetadata(metadata) + langs: + - typeScript + type: method syntax: content: 'updateMetadata(metadata: Partial): void;' + return: + type: + - void + description: '' parameters: - id: metadata description: Partial of the metadata. - type: 'Partial<>' - return: - type: void - description: '' + type: + - '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata~0:complex' + optional: false +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + name: IDynamicDataCallables + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#updateMetadata~0:complex' + name: Partial + fullName: Partial + spec.typeScript: + - uid: '!Partial:type' + name: Partial + fullName: Partial + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + name: IDynamicDataSourceMetadata + fullName: IDynamicDataSourceMetadata + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index bde0034a..885a286d 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -1,186 +1,199 @@ -### YamlMime:TSType -name: DynamicProperty -uid: '@microsoft/sp-component-base!DynamicProperty:class' -package: '@microsoft/sp-component-base!' -fullName: DynamicProperty -summary: Serializable object that simplifies usage of a DynamicProperty. -remarks: >- - This is built for usage in web part properties, and modified through the property pane. Can be initialized with a - default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change in - the DynamicProperty will re-render the web part automatically. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(provider, callback)' - uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!DynamicProperty:class' + summary: Serializable object that simplifies usage of a DynamicProperty. + remarks: >- + This is built for usage in web part properties, and modified through the property pane. Can be initialized with a + default callback. Web parts initialize with the render method so if the 3rd party developer does nothing, a change + in the DynamicProperty will re-render the web part automatically. + name: DynamicProperty + fullName: DynamicProperty + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-component-base!' - fullName: '(constructor)(provider, callback)' + children: + - '@microsoft/sp-component-base!DynamicProperty:constructor(1)' + - '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' + - '@microsoft/sp-component-base!DynamicProperty#reference:member' + - '@microsoft/sp-component-base!DynamicProperty#register:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' + - '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' + - uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' summary: Create a new DynamicProperty object. - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(provider, callback)' + fullName: '(constructor)(provider, callback)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' parameters: - id: provider description: DynamicDataProvider. - type: '' + type: + - '@microsoft/sp-component-base!default:class' + optional: false - id: callback description: Optional. Default callback to be registered for updates in the DynamicDataSource. - type: () => void -properties: - - name: isDisposed - uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' - package: '@microsoft/sp-component-base!' - fullName: isDisposed + type: + - () => void + optional: true + - uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' + summary: This method is called to permanently dispose the object. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' + summary: Returns true if the object has a default callback. + name: hasDefaultCallback() + fullName: hasDefaultCallback() + langs: + - typeScript + type: method + syntax: + content: 'hasDefaultCallback(): boolean;' + return: + type: + - boolean + description: '' + - uid: '@microsoft/sp-component-base!DynamicProperty#isDisposed:member' summary: >- Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - - isPreview: false - isDeprecated: false + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property syntax: content: 'get isDisposed(): boolean;' return: - type: boolean - - name: reference - uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' - package: '@microsoft/sp-component-base!' - fullName: reference + type: + - boolean + - uid: '@microsoft/sp-component-base!DynamicProperty#reference:member' summary: >- DynamicDataReference string that the DynamicProperty object points to. The reference is of the form `::`. remarks: 'If the DynamicProperty is set up with static data, this returns undefined.' - - isPreview: false - isDeprecated: false + name: reference + fullName: reference + langs: + - typeScript + type: property syntax: content: 'get reference(): string | undefined;' return: - type: string | undefined -methods: - - name: dispose() - uid: '@microsoft/sp-component-base!DynamicProperty#dispose:member(1)' - package: '@microsoft/sp-component-base!' - fullName: dispose() - summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' - - name: hasDefaultCallback() - uid: '@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)' - package: '@microsoft/sp-component-base!' - fullName: hasDefaultCallback() - summary: Returns true if the object has a default callback. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'hasDefaultCallback(): boolean;' - return: - type: boolean - description: '' - - name: register(callback) - uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' - package: '@microsoft/sp-component-base!' - fullName: register(callback) + type: + - string | undefined + - uid: '@microsoft/sp-component-base!DynamicProperty#register:member(1)' summary: Registers a callback function for updates on the associated DynamicDataSource. - remarks: '' - - isPreview: false - isDeprecated: false + name: register(callback) + fullName: register(callback) + langs: + - typeScript + type: method syntax: content: 'register(callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: callback description: Callback function to register. - type: () => void - return: - type: void - description: '' - - name: removeDefaultCallback() - uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' - package: '@microsoft/sp-component-base!' - fullName: removeDefaultCallback() + type: + - () => void + optional: false + - uid: '@microsoft/sp-component-base!DynamicProperty#removeDefaultCallback:member(1)' summary: Removes the registration for the default callback. remarks: This can be useful for advanced users who only want their custom callbacks. - - isPreview: false - isDeprecated: false + name: removeDefaultCallback() + fullName: removeDefaultCallback() + langs: + - typeScript + type: method syntax: content: 'removeDefaultCallback(): void;' return: - type: void + type: + - void description: '' - - name: setReference(reference) - uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' - package: '@microsoft/sp-component-base!' - fullName: setReference(reference) + - uid: '@microsoft/sp-component-base!DynamicProperty#setReference:member(1)' summary: >- Sets the value of the DynamicProperty to be a reference to a DynamicDynamicSource and property. The reference is of the form `::`. - remarks: '' - - isPreview: false - isDeprecated: false + name: setReference(reference) + fullName: setReference(reference) + langs: + - typeScript + type: method syntax: content: 'setReference(reference: string): void;' + return: + type: + - void + description: '' parameters: - id: reference description: Id of the DynamicDataSource and property. - type: string - return: - type: void - description: '' - - name: setValue(value) - uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' - package: '@microsoft/sp-component-base!' - fullName: setValue(value) + type: + - string + optional: false + - uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' summary: Sets a static value in the DynamicProperty. - remarks: '' - - isPreview: false - isDeprecated: false + name: setValue(value) + fullName: setValue(value) + langs: + - typeScript + type: method syntax: content: 'setValue(value: TValue): void;' + return: + type: + - void + description: '' parameters: - id: value description: Value for the DynamicProperty. - type: TValue - return: - type: void - description: '' - - name: tryGetSource() - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetSource() + type: + - TValue + optional: false + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource:member(1)' summary: >- Returns the DynamicDataSource that the DynamicProperty object refers to. Returns undefined if the source doesn't exist. - remarks: '' - - isPreview: false - isDeprecated: false + name: tryGetSource() + fullName: tryGetSource() + langs: + - typeScript + type: method syntax: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: - type: ' | undefined' + type: + - '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' description: '' - - name: tryGetValue() - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetValue() + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' summary: Returns the value of the object. remarks: >- If the value is an array, then the first element of the array is returned; otherwise, the value itself is @@ -189,18 +202,18 @@ methods: NOTE: This api will never return an array. To retrieve an array value, use the [DynamicProperty.tryGetValues()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValues:member(1)) API. - - isPreview: false - isDeprecated: false + name: tryGetValue() + fullName: tryGetValue() + langs: + - typeScript + type: method syntax: content: 'tryGetValue(): TValue | undefined;' return: - type: TValue | undefined + type: + - TValue | undefined description: the value associated with the dynamic property or undefined if the source or the data doesn't exist. - - name: tryGetValues() - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetValues() + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValues:member(1)' summary: Returns the value of the object. remarks: >- If the value is NOT an array, then an array is returned with the value being the single entry; otherwise, the @@ -210,31 +223,49 @@ methods: NOTE: This api will always return an array and it assumes that the array is homogeneous. To retrieve a non-array value, use the [DynamicProperty.tryGetValue()](xref:@microsoft/sp-component-base!DynamicProperty%23tryGetValue:member(1)) API. - - isPreview: false - isDeprecated: false + name: tryGetValues() + fullName: tryGetValues() + langs: + - typeScript + type: method syntax: content: 'tryGetValues(): TValue[];' return: - type: 'TValue[]' + type: + - 'TValue[]' description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - - name: unregister(callback) - uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' - package: '@microsoft/sp-component-base!' - fullName: unregister(callback) + - uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' summary: >- Unregisters a callback function for updates on the associated DynamicDataSource. The callback function must be the same it was registered with. - remarks: '' - - isPreview: false - isDeprecated: false + name: unregister(callback) + fullName: unregister(callback) + langs: + - typeScript + type: method syntax: content: 'unregister(callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: callback description: Callback function to unregister. - type: () => void - return: - type: void - description: '' + type: + - () => void + optional: false +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-component-base!default:class' + name: DynamicDataProvider + - uid: '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' + name: IDynamicDataSource | undefined + fullName: IDynamicDataSource | undefined + spec.typeScript: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + fullName: IDynamicDataSource + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml index 12adbb24..1b9b7d54 100644 --- a/SP-Framework/sp-component-base/icomponentpropertymetadata.yml +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -1,19 +1,20 @@ -### YamlMime:TSType -name: IComponentPropertyMetadata -uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' -package: '@microsoft/sp-component-base!' -fullName: IComponentPropertyMetadata -summary: This is the structure used for map values for component properties metadata. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isHtmlString - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isHtmlString:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + summary: This is the structure used for map values for component properties metadata. + name: IComponentPropertyMetadata + fullName: IComponentPropertyMetadata + langs: + - typeScript + type: interface package: '@microsoft/sp-component-base!' - fullName: isHtmlString + children: + - '@microsoft/sp-component-base!IComponentPropertyMetadata#isHtmlString:member' + - '@microsoft/sp-component-base!IComponentPropertyMetadata#isImageSource:member' + - '@microsoft/sp-component-base!IComponentPropertyMetadata#isLink:member' + - '@microsoft/sp-component-base!IComponentPropertyMetadata#isSearchablePlainText:member' + - '@microsoft/sp-component-base!IComponentPropertyMetadata#shouldNotPersist:member' + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isHtmlString:member' summary: Indicates whether the property should be serialized as HTML. remarks: >- This flag instructs framework to store the value as HTML, so that SharePoint can perform the following services on @@ -35,47 +36,45 @@ properties: Only enable this flag for HTML content where these modifications are acceptable. If non-HTML content is provided, SharePoint framework might make modifications to convert it to HTML valid. For plain text content that simply needs to be exposed to the search index (without any rewriting), use the `isSearchablePlainText` flag instead. - - isPreview: false - isDeprecated: false + name: isHtmlString + fullName: isHtmlString + langs: + - typeScript + type: property syntax: content: 'isHtmlString?: boolean;' return: - type: boolean - - name: isImageSource - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isImageSource:member' - package: '@microsoft/sp-component-base!' - fullName: isImageSource + type: + - boolean + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isImageSource:member' summary: >- Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc. - remarks: '' - - isPreview: false - isDeprecated: false + name: isImageSource + fullName: isImageSource + langs: + - typeScript + type: property syntax: content: 'isImageSource?: boolean;' return: - type: boolean - - name: isLink - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isLink:member' - package: '@microsoft/sp-component-base!' - fullName: isLink + type: + - boolean + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isLink:member' summary: >- Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc. - remarks: '' - - isPreview: false - isDeprecated: false + name: isLink + fullName: isLink + langs: + - typeScript + type: property syntax: content: 'isLink?: boolean;' return: - type: boolean - - name: isSearchablePlainText - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isSearchablePlainText:member' - package: '@microsoft/sp-component-base!' - fullName: isSearchablePlainText + type: + - boolean + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#isSearchablePlainText:member' summary: Indicates if the property contains plain text that should be search-indexed by SharePoint. remarks: >- This flag instructs the framework to store the property in a representation that supports search indexing. The @@ -85,17 +84,17 @@ properties: Security note: For security reasons, never assign a plain text string to `Element.innerHTML`. - - isPreview: false - isDeprecated: false + name: isSearchablePlainText + fullName: isSearchablePlainText + langs: + - typeScript + type: property syntax: content: 'isSearchablePlainText?: boolean;' return: - type: boolean - - name: shouldNotPersist - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#shouldNotPersist:member' - package: '@microsoft/sp-component-base!' - fullName: shouldNotPersist + type: + - boolean + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata#shouldNotPersist:member' summary: Indicates if the framework should persist the property on the server. remarks: >- Use this for properties that are only important in run-time, and do not need to persist on the server. This can @@ -108,10 +107,13 @@ properties: Note that if the property path refers to a property that has a complex object as the value, the whole object will be removed from the persisted data. - - isPreview: false - isDeprecated: false + name: shouldNotPersist + fullName: shouldNotPersist + langs: + - typeScript + type: property syntax: content: 'shouldNotPersist?: boolean;' return: - type: boolean + type: + - boolean diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index 32fe6003..ec8b6a94 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -1,12 +1,38 @@ -### YamlMime:TSType -name: IReadonlyFontStyles -uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' -package: '@microsoft/sp-component-base!' -fullName: IReadonlyFontStyles -summary: '' -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: 'Readonly<> ' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles:interface' + name: IReadonlyFontStyles + fullName: IReadonlyFontStyles + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-component-base!IReadonlyFontStyles~0:complex' + inheritance: + - type: '@microsoft/sp-component-base!IReadonlyFontStyles~1:complex' + package: '@microsoft/sp-component-base!' +references: + - uid: '@microsoft/sp-component-base!IReadonlyFontStyles~0:complex' + name: Readonly; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' + name: IReadonlyRawStyle + fullName: IReadonlyRawStyle + langs: + - typeScript + type: typealias + syntax: + content: export declare type IReadonlyRawStyle = Readonly; + return: + type: + - '@microsoft/sp-component-base!IReadonlyRawStyle~0:complex' + package: '@microsoft/sp-component-base!' +references: + - uid: '@microsoft/sp-component-base!IReadonlyRawStyle~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@uifabric/merge-styles!IRawStyle:interface' + name: IRawStyle + fullName: IRawStyle + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index 12ae0647..be8058b0 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -1,12 +1,39 @@ -### YamlMime:TSType -name: IReadonlyTheme -uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' -package: '@microsoft/sp-component-base!' -fullName: IReadonlyTheme -summary: Immutable ITheme. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: 'Readonly<> ' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + summary: Immutable ITheme. + name: IReadonlyTheme + fullName: IReadonlyTheme + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-component-base!IReadonlyTheme~0:complex' + inheritance: + - type: '@microsoft/sp-component-base!IReadonlyTheme~1:complex' + package: '@microsoft/sp-component-base!' +references: + - uid: '@microsoft/sp-component-base!IReadonlyTheme~0:complex' + name: Readonly- SharePoint servers treat the values as HTML content and run services like safety checks, search index and link @@ -31,23 +31,23 @@ properties: } ``` - - isPreview: false - isDeprecated: false + name: htmlStrings + fullName: htmlStrings + langs: + - typeScript + type: property syntax: content: |- htmlStrings?: { [key: string]: string; }; return: - type: |- - { - [key: string]: string; - } - - name: imageSources - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#imageSources:member' - package: '@microsoft/sp-component-base!' - fullName: imageSources + type: + - |- + { + [key: string]: string; + } + - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#imageSources:member' summary: A key-value map where keys are string identifiers and values are image sources. remarks: |- SharePoint servers treat the values as image sources and run services like search index and link fixup on them. @@ -60,23 +60,23 @@ properties: 'myImage2': 'https://res.contoso.com/someName.jpg' } ``` - - isPreview: false - isDeprecated: false + name: imageSources + fullName: imageSources + langs: + - typeScript + type: property syntax: content: |- imageSources?: { [key: string]: string; }; return: - type: |- - { - [key: string]: string; - } - - name: links - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#links:member' - package: '@microsoft/sp-component-base!' - fullName: links + type: + - |- + { + [key: string]: string; + } + - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#links:member' summary: A key-value map where keys are string identifiers and values are links. remarks: |- SharePoint servers treat the values as links and run services like link fixup on them. @@ -89,23 +89,23 @@ properties: 'myFileLink': 'https://res.contoso.com/file.docx' } ``` - - isPreview: false - isDeprecated: false + name: links + fullName: links + langs: + - typeScript + type: property syntax: content: |- links?: { [key: string]: string; }; return: - type: |- - { - [key: string]: string; - } - - name: searchablePlainTexts - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#searchablePlainTexts:member' - package: '@microsoft/sp-component-base!' - fullName: searchablePlainTexts + type: + - |- + { + [key: string]: string; + } + - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData#searchablePlainTexts:member' summary: A key-value map where keys are string identifiers and values are strings that should be search indexed. remarks: >- The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, @@ -123,16 +123,19 @@ properties: } ``` - - isPreview: false - isDeprecated: false + name: searchablePlainTexts + fullName: searchablePlainTexts + langs: + - typeScript + type: property syntax: content: |- searchablePlainTexts?: { [key: string]: string; }; return: - type: |- - { - [key: string]: string; - } + type: + - |- + { + [key: string]: string; + } diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index a1b25c49..8d3418f1 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -1,12 +1,17 @@ -### YamlMime:TSType -name: ITheme -uid: '@microsoft/sp-component-base!ITheme:interface' -package: '@microsoft/sp-component-base!' -fullName: ITheme -summary: 'Collection of theme values, which can be used to programatically style components.' -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!ITheme:interface' + summary: 'Collection of theme values, which can be used to programatically style components.' + name: ITheme + fullName: ITheme + langs: + - typeScript + type: interface + extends: + - '@fluentui/theme!IPartialTheme:interface' + inheritance: + - type: '@fluentui/theme!IPartialTheme:interface' + package: '@microsoft/sp-component-base!' +references: + - uid: '@fluentui/theme!IPartialTheme:interface' + name: IPartialTheme diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index d8906823..fbbc3b73 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -1,26 +1,40 @@ -### YamlMime:TSType -name: ThemeChangedEventArgs -uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' -package: '@microsoft/sp-component-base!' -fullName: ThemeChangedEventArgs -summary: The object passed when the IThemeProvider.themeChangedEvent is raised. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: theme - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + summary: The object passed when the IThemeProvider.themeChangedEvent is raised. + name: ThemeChangedEventArgs + fullName: ThemeChangedEventArgs + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-component-base!' - fullName: theme + children: + - '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' summary: 'The new theme. If the value is undefined, then the theme was cleared.' - remarks: '' - - isPreview: false - isDeprecated: false + name: theme + fullName: theme + langs: + - typeScript + type: property syntax: content: 'readonly theme: ITheme | undefined;' return: - type: ' | undefined' -extends: '' + type: + - '@microsoft/sp-component-base!ThemeChangedEventArgs#theme~0:complex' +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme~0:complex' + name: ITheme | undefined + fullName: ITheme | undefined + spec.typeScript: + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + fullName: ITheme + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index a54d1ec1..1f272711 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -1,79 +1,116 @@ -### YamlMime:TSType -name: ThemeProvider -uid: '@microsoft/sp-component-base!ThemeProvider:class' -package: '@microsoft/sp-component-base!' -fullName: ThemeProvider -summary: >- - The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in - different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(serviceScope, theme)' - uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-base!ThemeProvider:class' + summary: >- + The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided + in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts. + name: ThemeProvider + fullName: ThemeProvider + langs: + - typeScript + type: class package: '@microsoft/sp-component-base!' - fullName: '(constructor)(serviceScope, theme)' + children: + - '@microsoft/sp-component-base!ThemeProvider:constructor(1)' + - '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' + - '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' + - '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' + - uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' summary: Construct a new instance of the ThemeProvider class. - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(serviceScope, theme)' + fullName: '(constructor)(serviceScope, theme)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' parameters: - id: serviceScope description: The current service scope. - type: '' + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false - id: theme description: Theme to provide. - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' - package: '@microsoft/sp-component-base!' - fullName: serviceKey + type: + - '@microsoft/sp-component-base!ITheme:interface' + optional: true + - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' summary: The service key for ThemeProvider. - remarks: '' - - isPreview: false - isDeprecated: false + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property syntax: content: 'static readonly serviceKey: ServiceKey;' return: - type: >- - <> -methods: - - name: tryGetTheme() - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' - package: '@microsoft/sp-component-base!' - fullName: tryGetTheme() + type: + - '@microsoft/sp-component-base!ThemeProvider.serviceKey~0:complex' + - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' + summary: Raised when the theme changes with the new theme as an argument. + name: themeChangedEvent + fullName: themeChangedEvent + langs: + - typeScript + type: event + syntax: + content: 'readonly themeChangedEvent: SPEvent;' + return: + type: + - '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent~0:complex' + - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' summary: 'If set, get the current scoped theme.' - remarks: '' - - isPreview: false - isDeprecated: false + name: tryGetTheme() + fullName: tryGetTheme() + langs: + - typeScript + type: method syntax: content: 'tryGetTheme(): IReadonlyTheme | undefined;' return: - type: ' | undefined' + type: + - '@microsoft/sp-component-base!ThemeProvider#tryGetTheme~0:complex' description: '' -events: - - name: themeChangedEvent - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent:member' - package: '@microsoft/sp-component-base!' - fullName: themeChangedEvent - summary: Raised when the theme changes with the new theme as an argument. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'readonly themeChangedEvent: SPEvent;' - return: - type: >- - <> +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-component-base!ITheme:interface' + name: ITheme + - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ThemeProvider:class' + name: ThemeProvider + fullName: ThemeProvider + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!ThemeProvider#themeChangedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-component-base!ThemeChangedEventArgs:class' + name: ThemeChangedEventArgs + fullName: ThemeChangedEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme~0:complex' + name: IReadonlyTheme | undefined + fullName: IReadonlyTheme | undefined + spec.typeScript: + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + name: IReadonlyTheme + fullName: IReadonlyTheme + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-core-library.yml b/SP-Framework/sp-core-library.yml index e2960d11..de2d8aa0 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -1,32 +1,84 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-core-library!' -name: '@microsoft/sp-core-library' -type: package -summary: SharePoint Framework core libraries. -enums: - - '@microsoft/sp-core-library!DisplayMode:enum' - - '@microsoft/sp-core-library!EnvironmentType:enum' - - '@microsoft/sp-core-library!FormDisplayMode:enum' -classes: - - '@microsoft/sp-core-library!Environment:class' - - '@microsoft/sp-core-library!Guid:class' - - '@microsoft/sp-core-library!Log:class' - - '@microsoft/sp-core-library!RandomNumberGenerator:class' - - '@microsoft/sp-core-library!ServiceKey:class' - - '@microsoft/sp-core-library!ServiceScope:class' - - '@microsoft/sp-core-library!Session:class' - - '@microsoft/sp-core-library!SPEvent:class' - - '@microsoft/sp-core-library!SPEventArgs:class' - - '@microsoft/sp-core-library!Text_2:class' - - '@microsoft/sp-core-library!TimeProvider:class' - - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' - - '@microsoft/sp-core-library!Validate:class' - - '@microsoft/sp-core-library!Version:class' -interfaces: - - '@microsoft/sp-core-library!IDisposable:interface' - - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' - - '@microsoft/sp-core-library!IServiceCollection:interface' - - '@microsoft/sp-core-library!ISPEventObserver:interface' - - '@microsoft/sp-core-library!ITimeProvider:interface' -typeAliases: - - '@microsoft/sp-core-library!ServiceCreator:type' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!' + summary: SharePoint Framework core libraries. + remarks: >- + This package provides a foundation of core classes that ensure a consistent character across all the other + SharePoint Framework APIs. Because this package is a dependency of every other package, its design prioritizes + small code size and broad applicability, versus flexibility or richness of features. + name: '@microsoft/sp-core-library' + fullName: '@microsoft/sp-core-library' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-core-library!DisplayMode:enum' + - '@microsoft/sp-core-library!Environment:class' + - '@microsoft/sp-core-library!EnvironmentType:enum' + - '@microsoft/sp-core-library!FormDisplayMode:enum' + - '@microsoft/sp-core-library!Guid:class' + - '@microsoft/sp-core-library!IDisposable:interface' + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + - '@microsoft/sp-core-library!IServiceCollection:interface' + - '@microsoft/sp-core-library!ISPEventObserver:interface' + - '@microsoft/sp-core-library!ITimeProvider:interface' + - '@microsoft/sp-core-library!Log:class' + - '@microsoft/sp-core-library!RandomNumberGenerator:class' + - '@microsoft/sp-core-library!ServiceCreator:type' + - '@microsoft/sp-core-library!ServiceKey:class' + - '@microsoft/sp-core-library!ServiceScope:class' + - '@microsoft/sp-core-library!Session:class' + - '@microsoft/sp-core-library!SPEvent:class' + - '@microsoft/sp-core-library!SPEventArgs:class' + - '@microsoft/sp-core-library!Text_2:class' + - '@microsoft/sp-core-library!TimeProvider:class' + - '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + - '@microsoft/sp-core-library!Validate:class' + - '@microsoft/sp-core-library!Version:class' +references: + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + name: DisplayMode + - uid: '@microsoft/sp-core-library!Environment:class' + name: Environment + - uid: '@microsoft/sp-core-library!EnvironmentType:enum' + name: EnvironmentType + - uid: '@microsoft/sp-core-library!FormDisplayMode:enum' + name: FormDisplayMode + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + - uid: '@microsoft/sp-core-library!IServiceCollection:interface' + name: IServiceCollection + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + name: ISPEventObserver + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + name: ITimeProvider + - uid: '@microsoft/sp-core-library!Log:class' + name: Log + - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' + name: RandomNumberGenerator + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + name: ServiceCreator + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-core-library!Session:class' + name: Session + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + - uid: '@microsoft/sp-core-library!Text_2:class' + name: Text_2 + - uid: '@microsoft/sp-core-library!TimeProvider:class' + name: TimeProvider + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + name: UrlQueryParameterCollection + - uid: '@microsoft/sp-core-library!Validate:class' + name: Validate + - uid: '@microsoft/sp-core-library!Version:class' + name: Version diff --git a/SP-Framework/sp-core-library/displaymode.yml b/SP-Framework/sp-core-library/displaymode.yml index 3f2446ae..2ff32dec 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -1,25 +1,33 @@ -### YamlMime:TSEnum -name: DisplayMode -uid: '@microsoft/sp-core-library!DisplayMode:enum' -package: '@microsoft/sp-core-library!' -fullName: DisplayMode -summary: Indicates whether a visual control should display itself for reading or for editing. -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: Edit - uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + summary: Indicates whether a visual control should display itself for reading or for editing. + name: DisplayMode + fullName: DisplayMode + langs: + - typeScript + type: enum package: '@microsoft/sp-core-library!' + children: + - '@microsoft/sp-core-library!DisplayMode.Edit:member' + - '@microsoft/sp-core-library!DisplayMode.Read:member' + - uid: '@microsoft/sp-core-library!DisplayMode.Edit:member' summary: >- The page, control, or editing surface is in a mode intended for authoring new content. It may display editing panels or other controls that are not part of the normal reading experience. - value: '2' - - name: Read - uid: '@microsoft/sp-core-library!DisplayMode.Read:member' - package: '@microsoft/sp-core-library!' + name: Edit + fullName: Edit + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-core-library!DisplayMode.Read:member' summary: >- The page, control, or editing surface is in a mode intended for reading. It may have some interactive features, but the authoring controls are not enabled. - value: '1' + name: Read + fullName: Read + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index eecbb771..a1e21053 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -1,25 +1,27 @@ -### YamlMime:TSType -name: Environment -uid: '@microsoft/sp-core-library!Environment:class' -package: '@microsoft/sp-core-library!' -fullName: Environment -summary: Information about the system environment where the SharePoint Framework is running. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: type - uid: '@microsoft/sp-core-library!Environment.type:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Environment:class' + summary: Information about the system environment where the SharePoint Framework is running. + name: Environment + fullName: Environment + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: type + children: + - '@microsoft/sp-core-library!Environment.type:member' + - uid: '@microsoft/sp-core-library!Environment.type:member' summary: Indicates the general type of environment where the SharePoint Framework is running. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'static get type(): EnvironmentType;' return: - type: '' + type: + - '@microsoft/sp-core-library!EnvironmentType:enum' +references: + - uid: '@microsoft/sp-core-library!EnvironmentType:enum' + name: EnvironmentType diff --git a/SP-Framework/sp-core-library/environmenttype.yml b/SP-Framework/sp-core-library/environmenttype.yml index 2ea474b2..b3036ca7 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -1,43 +1,64 @@ -### YamlMime:TSEnum -name: EnvironmentType -uid: '@microsoft/sp-core-library!EnvironmentType:enum' -package: '@microsoft/sp-core-library!' -fullName: EnvironmentType -summary: Indicates the general type of environment where the SharePoint Framework is running. -remarks: >- - This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It - provides a way to distinguish environments where certain functionality may be limited or disabled. - -isPreview: false -isDeprecated: false -fields: - - name: ClassicSharePoint - uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!EnvironmentType:enum' + summary: Indicates the general type of environment where the SharePoint Framework is running. + remarks: >- + This enum is used by the [Environment.type](xref:@microsoft/sp-core-library!Environment.type:member) property. It + provides a way to distinguish environments where certain functionality may be limited or disabled. + name: EnvironmentType + fullName: EnvironmentType + langs: + - typeScript + type: enum package: '@microsoft/sp-core-library!' + children: + - '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' + - '@microsoft/sp-core-library!EnvironmentType.Local:member' + - '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' + - '@microsoft/sp-core-library!EnvironmentType.Test:member' + - uid: '@microsoft/sp-core-library!EnvironmentType.ClassicSharePoint:member' summary: >- Indicates that the framework was hosted by a classic server-rendered SharePoint page. Some functionality may be limited, e.g. various extensibility APIs may not be supported. - value: '3' - - name: Local - uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' - package: '@microsoft/sp-core-library!' + name: ClassicSharePoint + fullName: ClassicSharePoint + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-core-library!EnvironmentType.Local:member' summary: >- Indicates that the SharePoint Framework is running on a page from a "localhost" web server, for example the SharePoint Workbench when hosted via "gulp serve". SharePoint REST API calls will not be available, and in general network access may not authenticate properly. Certain page context information may be using mock values for testing. - value: '1' - - name: SharePoint - uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' - package: '@microsoft/sp-core-library!' + deprecated: + content: >- + The local workbench has been removed. Use + [EnvironmentType.SharePoint](xref:@microsoft/sp-core-library!EnvironmentType.SharePoint:member) instead. + name: Local + fullName: Local + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-core-library!EnvironmentType.SharePoint:member' summary: >- Indicates that the SharePoint Framework is running on a modern SharePoint web page, with full framework functionality. This is the normal usage scenario. - value: '2' - - name: Test - uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' - package: '@microsoft/sp-core-library!' + name: SharePoint + fullName: SharePoint + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-core-library!EnvironmentType.Test:member' summary: >- Indicates that the SharePoint Framework is running inside a test harness, e.g. a unit test. There may be no user interaction at all, and network access in general may be disabled. - value: '0' + name: Test + fullName: Test + langs: + - typeScript + type: field + numericValue: '0' diff --git a/SP-Framework/sp-core-library/formdisplaymode.yml b/SP-Framework/sp-core-library/formdisplaymode.yml index 13f288c4..740ff6a1 100644 --- a/SP-Framework/sp-core-library/formdisplaymode.yml +++ b/SP-Framework/sp-core-library/formdisplaymode.yml @@ -1,26 +1,34 @@ -### YamlMime:TSEnum -name: FormDisplayMode -uid: '@microsoft/sp-core-library!FormDisplayMode:enum' -package: '@microsoft/sp-core-library!' -fullName: FormDisplayMode -summary: '' -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: Display - uid: '@microsoft/sp-core-library!FormDisplayMode.Display:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!FormDisplayMode:enum' + name: FormDisplayMode + fullName: FormDisplayMode + langs: + - typeScript + type: enum package: '@microsoft/sp-core-library!' - summary: '' - value: '4' - - name: Edit - uid: '@microsoft/sp-core-library!FormDisplayMode.Edit:member' - package: '@microsoft/sp-core-library!' - summary: '' - value: '6' - - name: New - uid: '@microsoft/sp-core-library!FormDisplayMode.New:member' - package: '@microsoft/sp-core-library!' - summary: '' - value: '8' + children: + - '@microsoft/sp-core-library!FormDisplayMode.Display:member' + - '@microsoft/sp-core-library!FormDisplayMode.Edit:member' + - '@microsoft/sp-core-library!FormDisplayMode.New:member' + - uid: '@microsoft/sp-core-library!FormDisplayMode.Display:member' + name: Display + fullName: Display + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-core-library!FormDisplayMode.Edit:member' + name: Edit + fullName: Edit + langs: + - typeScript + type: field + numericValue: '6' + - uid: '@microsoft/sp-core-library!FormDisplayMode.New:member' + name: New + fullName: New + langs: + - typeScript + type: field + numericValue: '8' diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 6a93ba06..99f55cf9 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -1,97 +1,103 @@ -### YamlMime:TSType -name: Guid -uid: '@microsoft/sp-core-library!Guid:class' -package: '@microsoft/sp-core-library!' -fullName: Guid -summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' -remarks: >- - The input string is normalized and validated, which provides important guarantees that simplify other code that works - with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the - uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some applications. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Guid:class' + summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' + remarks: >- + The input string is normalized and validated, which provides important guarantees that simplify other code that + works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware + that the uniqueness depends on the browser's `Math.random()` function and may be not be suitable for some + applications. - See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: empty - uid: '@microsoft/sp-core-library!Guid.empty:member' + See [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) for more information. + name: Guid + fullName: Guid + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: empty + children: + - '@microsoft/sp-core-library!Guid.empty:member' + - '@microsoft/sp-core-library!Guid#equals:member(1)' + - '@microsoft/sp-core-library!Guid.isValid:member(1)' + - '@microsoft/sp-core-library!Guid.newGuid:member(1)' + - '@microsoft/sp-core-library!Guid.parse:member(1)' + - '@microsoft/sp-core-library!Guid#toString:member(1)' + - '@microsoft/sp-core-library!Guid.tryParse:member(1)' + - uid: '@microsoft/sp-core-library!Guid.empty:member' summary: Returns a new empty Guid instance. - remarks: '' - - isPreview: false - isDeprecated: false + name: empty + fullName: empty + langs: + - typeScript + type: property syntax: content: 'static readonly empty: Guid;' return: - type: '' -methods: - - name: equals(guid) - uid: '@microsoft/sp-core-library!Guid#equals:member(1)' - package: '@microsoft/sp-core-library!' - fullName: equals(guid) + type: + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Guid#equals:member(1)' summary: Compare this instance to another Guid instance - remarks: '' - - isPreview: false - isDeprecated: false + name: equals(guid) + fullName: equals(guid) + langs: + - typeScript + type: method syntax: content: 'equals(guid: Guid): boolean;' + return: + type: + - boolean + description: True if this instance and the specified Guid object represent the same value. parameters: - id: guid description: '' - type: '' - return: - type: boolean - description: True if this instance and the specified Guid object represent the same value. - - name: isValid(guid) - uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' - package: '@microsoft/sp-core-library!' - fullName: isValid(guid) + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!Guid.isValid:member(1)' summary: >- Indicates whether a GUID is valid, i.e. whether it would be successfully parsed by `Guid.tryParse()`. This function is cheaper than `Guid.tryParse()` because it does not construct a Guid object. - remarks: '' - - isPreview: false - isDeprecated: false + name: isValid(guid) + fullName: isValid(guid) + langs: + - typeScript + type: method syntax: content: 'static isValid(guid: string | undefined | null): boolean;' + return: + type: + - boolean + description: 'true, if the Guid is valid.' parameters: - id: guid description: The input string. - type: string | undefined | null - return: - type: boolean - description: 'true, if the Guid is valid.' - - name: newGuid(randomNumberGenerator) - uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' - package: '@microsoft/sp-core-library!' - fullName: newGuid(randomNumberGenerator) + type: + - string | undefined | null + optional: false + - uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' summary: >- Returns a new Guid instance with a pseudo-randomly generated GUID, according to the version 4 UUID algorithm from RFC 4122. - remarks: '' - - isPreview: false - isDeprecated: false + name: newGuid(randomNumberGenerator) + fullName: newGuid(randomNumberGenerator) + langs: + - typeScript + type: method syntax: content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' + return: + type: + - '@microsoft/sp-core-library!default:class' + description: A new unique Guid object parameters: - id: randomNumberGenerator description: '' - type: '' - return: - type: '' - description: A new unique Guid object - - name: parse(guidString) - uid: '@microsoft/sp-core-library!Guid.parse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: parse(guidString) + type: + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + optional: true + - uid: '@microsoft/sp-core-library!Guid.parse:member(1)' summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' remarks: |- Example syntaxes accepted by this function: @@ -103,39 +109,40 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - - isPreview: false - isDeprecated: false + name: parse(guidString) + fullName: parse(guidString) + langs: + - typeScript + type: method syntax: content: 'static parse(guidString: string | undefined | null): Guid;' + return: + type: + - '@microsoft/sp-core-library!default:class' + description: A valid Guid object parameters: - id: guidString description: '' - type: string | undefined | null - return: - type: '' - description: A valid Guid object - - name: toString() - uid: '@microsoft/sp-core-library!Guid#toString:member(1)' - package: '@microsoft/sp-core-library!' - fullName: toString() + type: + - string | undefined | null + optional: false + - uid: '@microsoft/sp-core-library!Guid#toString:member(1)' summary: Returns a string representation of the GUID - remarks: '' - - isPreview: false - isDeprecated: false + name: toString() + fullName: toString() + langs: + - typeScript + type: method syntax: content: 'toString(): string;' return: - type: string + type: + - string description: |- The GUID value in lowercase hexadecimal without braces. Example: `'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'` - - name: tryParse(guid) - uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: tryParse(guid) + - uid: '@microsoft/sp-core-library!Guid.tryParse:member(1)' summary: >- Attempts to parse the input string to construct a new Guid object. If the string cannot be parsed, then undefined is returned. @@ -149,15 +156,34 @@ methods: - `"{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"` - `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"` - - isPreview: false - isDeprecated: false + name: tryParse(guid) + fullName: tryParse(guid) + langs: + - typeScript + type: method syntax: content: 'static tryParse(guid: string | undefined | null): Guid | undefined;' + return: + type: + - '@microsoft/sp-core-library!Guid.tryParse~0:complex' + description: 'The Guid object, or undefined if the string could not be parsed.' parameters: - id: guid description: The input string. - type: string | undefined | null - return: - type: ' | undefined' - description: 'The Guid object, or undefined if the string could not be parsed.' + type: + - string | undefined | null + optional: false +references: + - uid: '@microsoft/sp-core-library!default:class' + name: Guid + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + - uid: '@microsoft/sp-core-library!Guid.tryParse~0:complex' + name: Guid | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: Guid + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 21e9582c..41872079 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -1,42 +1,43 @@ -### YamlMime:TSType -name: IDisposable -uid: '@microsoft/sp-core-library!IDisposable:interface' -package: '@microsoft/sp-core-library!' -fullName: IDisposable -summary: Implemented by an object that supports a disposal lifecycle. -remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isDisposed - uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + summary: Implemented by an object that supports a disposal lifecycle. + remarks: The dispose event allows an object to free any resources that it allocated before its lifecycle ends. + name: IDisposable + fullName: IDisposable + langs: + - typeScript + type: interface package: '@microsoft/sp-core-library!' - fullName: isDisposed + children: + - '@microsoft/sp-core-library!IDisposable#dispose:member(1)' + - '@microsoft/sp-core-library!IDisposable#isDisposed:member' + - uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' + summary: This method is called to permanently dispose the object. + remarks: 'After the object has been disposed, do not call its methods or access its properties.' + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-core-library!IDisposable#isDisposed:member' summary: >- Returns true if the dispose() method has been called. Once an object is disposed, it remains in this state permanently. remarks: 'After the object has been disposed, do not call its methods or access its properties.' - - isPreview: false - isDeprecated: false + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property syntax: content: 'isDisposed: boolean;' return: - type: boolean -methods: - - name: dispose() - uid: '@microsoft/sp-core-library!IDisposable#dispose:member(1)' - package: '@microsoft/sp-core-library!' - fullName: dispose() - summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' - - isPreview: false - isDeprecated: false - syntax: - content: 'dispose(): void;' - return: - type: void - description: '' + type: + - boolean diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index c762740e..01d02eaf 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -1,33 +1,33 @@ -### YamlMime:TSType -name: IRandomNumberGenerator -uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' -package: '@microsoft/sp-core-library!' -fullName: IRandomNumberGenerator -summary: >- - This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom - random numbers. -remarks: >- - This interface abstracts the functionality of the system Math.random() API for usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the - default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a mock - implementation that always returns the same sequence of random numbers, in order to ensure that test failures are - always repeatable. - -isPreview: false -isDeprecated: false -type: interface -methods: - - name: generate() - uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + summary: >- + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for generating pseudorandom + random numbers. + remarks: >- + This interface abstracts the functionality of the system Math.random() API for usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace + the default [RandomNumberGenerator](xref:@microsoft/sp-core-library!RandomNumberGenerator:class) service with a + mock implementation that always returns the same sequence of random numbers, in order to ensure that test failures + are always repeatable. + name: IRandomNumberGenerator + fullName: IRandomNumberGenerator + langs: + - typeScript + type: interface package: '@microsoft/sp-core-library!' - fullName: generate() + children: + - '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' - remarks: '' - - isPreview: false - isDeprecated: false + name: generate() + fullName: generate() + langs: + - typeScript + type: method syntax: content: 'generate(): number;' return: - type: number + type: + - number description: '' diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index fbf6d5c9..e4cfacf8 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -1,28 +1,31 @@ -### YamlMime:TSType -name: IServiceCollection -uid: '@microsoft/sp-core-library!IServiceCollection:interface' -package: '@microsoft/sp-core-library!' -fullName: IServiceCollection -summary: A shorthand pattern for extracting well-known services from a ServiceScope. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future - release. -type: interface -properties: - - name: serviceScope - uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!IServiceCollection:interface' + summary: A shorthand pattern for extracting well-known services from a ServiceScope. + deprecated: + content: >- + This pattern has been superceded by the BaseComponentContext pattern. This interface will be removed in a future + release. + name: IServiceCollection + fullName: IServiceCollection + langs: + - typeScript + type: interface package: '@microsoft/sp-core-library!' - fullName: serviceScope + children: + - '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' + - uid: '@microsoft/sp-core-library!IServiceCollection#serviceScope:member' summary: Returns the underlying ServiceScope that the members belong to. - remarks: '' - - isPreview: false - isDeprecated: false + name: serviceScope + fullName: serviceScope + langs: + - typeScript + type: property syntax: content: 'readonly serviceScope: ServiceScope;' return: - type: '' + type: + - '@microsoft/sp-core-library!default:class' +references: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index 78371800..98e52327 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -1,45 +1,53 @@ -### YamlMime:TSType -name: ISPEventObserver -uid: '@microsoft/sp-core-library!ISPEventObserver:interface' -package: '@microsoft/sp-core-library!' -fullName: ISPEventObserver -summary: >- - Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by - components that can subscribe to events. -remarks: >- - ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a - SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must - have a way to notify the event system when the component is disposed, so that its handlers can be automatically - removed. Other objects may implement this contract, as long as they meet these requirements. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: componentId - uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + summary: >- + Used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) system, this interface is implemented by + components that can subscribe to events. + remarks: >- + ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a + SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it + must have a way to notify the event system when the component is disposed, so that its handlers can be + automatically removed. Other objects may implement this contract, as long as they meet these requirements. + name: ISPEventObserver + fullName: ISPEventObserver + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-core-library!IDisposable:interface' + inheritance: + - type: '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-core-library!' - fullName: componentId + children: + - '@microsoft/sp-core-library!ISPEventObserver#componentId:member' + - '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' + - uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' summary: 'The component identifier, from the component''s manifest.' remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - - isPreview: false - isDeprecated: false + name: componentId + fullName: componentId + langs: + - typeScript + type: property syntax: content: 'readonly componentId: string;' return: - type: string - - name: instanceId - uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' - package: '@microsoft/sp-core-library!' - fullName: instanceId + type: + - string + - uid: '@microsoft/sp-core-library!ISPEventObserver#instanceId:member' summary: The instance identifier for the component. remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' - - isPreview: false - isDeprecated: false + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property syntax: content: 'readonly instanceId: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 2d699790..6cf5fea3 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -1,44 +1,49 @@ -### YamlMime:TSType -name: ITimeProvider -uid: '@microsoft/sp-core-library!ITimeProvider:interface' -package: '@microsoft/sp-core-library!' -fullName: ITimeProvider -summary: 'This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system clock.' -remarks: >- - This interface abstracts the functionality of the system time APIs for usage with a - [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the - default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation that - follows a manually incremented timeline, in order to ensure that test failures are always repeatable. - -isPreview: false -isDeprecated: false -type: interface -methods: - - name: getDate() - uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + summary: >- + This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system + clock. + remarks: >- + This interface abstracts the functionality of the system time APIs for usage with a + [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace + the default [TimeProvider](xref:@microsoft/sp-core-library!TimeProvider:class) service with a mock implementation + that follows a manually incremented timeline, in order to ensure that test failures are always repeatable. + name: ITimeProvider + fullName: ITimeProvider + langs: + - typeScript + type: interface package: '@microsoft/sp-core-library!' - fullName: getDate() + children: + - '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' + - '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' + - uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' summary: 'Returns the current date/time, similar to the Date class constructor.' - remarks: '' - - isPreview: false - isDeprecated: false + name: getDate() + fullName: getDate() + langs: + - typeScript + type: method syntax: content: 'getDate(): Date;' return: - type: Date + type: + - '!Date:interface' description: '' - - name: getTimestamp() - uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getTimestamp() + - uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' - remarks: '' - - isPreview: false - isDeprecated: false + name: getTimestamp() + fullName: getTimestamp() + langs: + - typeScript + type: method syntax: content: 'getTimestamp(): number;' return: - type: number + type: + - number description: '' +references: + - uid: '!Date:interface' + name: Date diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index 0a0b5371..3bb158c4 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -1,127 +1,157 @@ -### YamlMime:TSType -name: Log -uid: '@microsoft/sp-core-library!Log:class' -package: '@microsoft/sp-core-library!' -fullName: Log -summary: A basic redirectable logging system. -remarks: >- - The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and - with context information. Context information helps identify which component generated the messages and allows for - filtering of log events. In a SharePoint Framework application, these messages will appear on the developer dashboard. - -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'error(source, error, scope)' - uid: '@microsoft/sp-core-library!Log.error:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Log:class' + summary: A basic redirectable logging system. + remarks: >- + The Log class provides static methods for logging messages at different levels (verbose, info, warning, error) and + with context information. Context information helps identify which component generated the messages and allows for + filtering of log events. In a SharePoint Framework application, these messages will appear on the developer + dashboard. + name: Log + fullName: Log + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: 'error(source, error, scope)' + children: + - '@microsoft/sp-core-library!Log.error:member(1)' + - '@microsoft/sp-core-library!Log.info:member(1)' + - '@microsoft/sp-core-library!Log.verbose:member(1)' + - '@microsoft/sp-core-library!Log.warn:member(1)' + - uid: '@microsoft/sp-core-library!Log.error:member(1)' summary: Logs an error. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'error(source, error, scope)' + fullName: 'error(source, error, scope)' + langs: + - typeScript + type: method syntax: content: 'static error(source: string, error: Error, scope?: ServiceScope): void;' + return: + type: + - void + description: '' parameters: - id: source description: >- the source from where the error is logged, e.g., the class name. The source provides context information for the logged error. If the source's length is more than 20, only the first 20 characters are kept. - type: string + type: + - string + optional: false - id: error description: the error to be logged - type: Error + type: + - '!Error:interface' + optional: false - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged error. - type: '' - return: - type: void - description: '' - - name: 'info(source, message, scope)' - uid: '@microsoft/sp-core-library!Log.info:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'info(source, message, scope)' + type: + - '@microsoft/sp-core-library!default:class' + optional: true + - uid: '@microsoft/sp-core-library!Log.info:member(1)' summary: Logs a general informational message. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'info(source, message, scope)' + fullName: 'info(source, message, scope)' + langs: + - typeScript + type: method syntax: content: 'static info(source: string, message: string, scope?: ServiceScope): void;' + return: + type: + - void + description: '' parameters: - id: source description: >- the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: string + type: + - string + optional: false - id: message description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: string + type: + - string + optional: false - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. - type: '' - return: - type: void - description: '' - - name: 'verbose(source, message, scope)' - uid: '@microsoft/sp-core-library!Log.verbose:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'verbose(source, message, scope)' + type: + - '@microsoft/sp-core-library!default:class' + optional: true + - uid: '@microsoft/sp-core-library!Log.verbose:member(1)' summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'verbose(source, message, scope)' + fullName: 'verbose(source, message, scope)' + langs: + - typeScript + type: method syntax: content: 'static verbose(source: string, message: string, scope?: ServiceScope): void;' + return: + type: + - void + description: '' parameters: - id: source description: >- the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: string + type: + - string + optional: false - id: message description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: string + type: + - string + optional: false - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. - type: '' - return: - type: void - description: '' - - name: 'warn(source, message, scope)' - uid: '@microsoft/sp-core-library!Log.warn:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'warn(source, message, scope)' + type: + - '@microsoft/sp-core-library!default:class' + optional: true + - uid: '@microsoft/sp-core-library!Log.warn:member(1)' summary: Logs a warning. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'warn(source, message, scope)' + fullName: 'warn(source, message, scope)' + langs: + - typeScript + type: method syntax: content: 'static warn(source: string, message: string, scope?: ServiceScope): void;' + return: + type: + - void + description: '' parameters: - id: source description: >- the source from where the message is logged, e.g., the class name. The source provides context information for the logged message. If the source's length is more than 20, only the first 20 characters are kept. - type: string + type: + - string + optional: false - id: message description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' - type: string + type: + - string + optional: false - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. - type: '' - return: - type: void - description: '' + type: + - '@microsoft/sp-core-library!default:class' + optional: true +references: + - uid: '!Error:interface' + name: Error + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 5cb2553b..c7edc187 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -1,61 +1,78 @@ -### YamlMime:TSType -name: RandomNumberGenerator -uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' -package: '@microsoft/sp-core-library!' -fullName: RandomNumberGenerator -summary: >- - This is the default implementation of - [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls - Math.random(). -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!RandomNumberGenerator:class' + summary: >- + This is the default implementation of + [IRandomNumberGenerator](xref:@microsoft/sp-core-library!IRandomNumberGenerator:interface) that simply calls + Math.random(). + name: RandomNumberGenerator + fullName: RandomNumberGenerator + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IRandomNumberGenerator:interface' package: '@microsoft/sp-core-library!' - fullName: (constructor)(serviceScope) + children: + - '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' + - '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' + - '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' + - uid: '@microsoft/sp-core-library!RandomNumberGenerator:constructor(1)' summary: Constructs a new instance of the `RandomNumberGenerator` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' - package: '@microsoft/sp-core-library!' - fullName: serviceKey - summary: The service key for IRandomNumberGenerator. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: generate() - uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' - package: '@microsoft/sp-core-library!' - fullName: generate() + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' - remarks: '' - - isPreview: false - isDeprecated: false + name: generate() + fullName: generate() + langs: + - typeScript + type: method syntax: content: 'generate(): number;' return: - type: number + type: + - number description: '' + - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' + summary: The service key for IRandomNumberGenerator. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + - uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!IRandomNumberGenerator:interface' + name: IRandomNumberGenerator + fullName: IRandomNumberGenerator + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-core-library/servicecreator.yml b/SP-Framework/sp-core-library/servicecreator.yml index 44bd57c6..8d647750 100644 --- a/SP-Framework/sp-core-library/servicecreator.yml +++ b/SP-Framework/sp-core-library/servicecreator.yml @@ -1,11 +1,29 @@ -### YamlMime:TSTypeAlias -name: ServiceCreator -uid: '@microsoft/sp-core-library!ServiceCreator:type' -package: '@microsoft/sp-core-library!' -fullName: ServiceCreator -summary: This is a callback that is used by ServiceKey.createCustom(). -remarks: '' - -isPreview: false -isDeprecated: false -syntax: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + summary: This is a callback that is used by ServiceKey.createCustom(). + name: ServiceCreator + fullName: ServiceCreator + langs: + - typeScript + type: typealias + syntax: + content: 'export declare type ServiceCreator = (serviceScope: ServiceScope) => T;' + typeParameters: + - id: T + return: + type: + - '@microsoft/sp-core-library!ServiceCreator~0:complex' + package: '@microsoft/sp-core-library!' +references: + - uid: '@microsoft/sp-core-library!ServiceCreator~0:complex' + name: '(serviceScope: ServiceScope) => T' + fullName: '(serviceScope: default) => T' + spec.typeScript: + - name: '(serviceScope: ' + fullName: '(serviceScope: ' + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: ) => T + fullName: ) => T diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 11f6e3e3..c2049be9 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -1,38 +1,99 @@ -### YamlMime:TSType -name: ServiceKey -uid: '@microsoft/sp-core-library!ServiceKey:class' -package: '@microsoft/sp-core-library!' -fullName: ServiceKey -summary: >- - The ServiceKey is a lookup key that is used when calling - [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope%23consume:member(1)) to fetch a dependency. -remarks: >- - Every service key also provides a default implementation of the dependency, which will be automatically created in the - root scope if the dependency is not found. Providing a default implementation ensures that new dependencies can be - safely introduced without inadvertently breaking components that are loaded by an older host that does not provide the - new dependency. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: defaultCreator - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + summary: >- + The ServiceKey is a lookup key that is used when calling + [ServiceScope.consume()](xref:@microsoft/sp-core-library!ServiceScope%23consume:member(1)) to fetch a dependency. + remarks: >- + Every service key also provides a default implementation of the dependency, which will be automatically created in + the root scope if the dependency is not found. Providing a default implementation ensures that new dependencies + can be safely introduced without inadvertently breaking components that are loaded by an older host that does not + provide the new dependency. + name: ServiceKey + fullName: ServiceKey + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: defaultCreator + children: + - '@microsoft/sp-core-library!ServiceKey.create:member(1)' + - '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' + - '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' + - '@microsoft/sp-core-library!ServiceKey#id:member' + - '@microsoft/sp-core-library!ServiceKey#name:member' + - uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' + summary: >- + Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts + the standard constructor parameter. + remarks: >- + If you want to specify custom constructor parameters, use + [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. + name: 'create(name, serviceClass)' + fullName: 'create(name, serviceClass)' + langs: + - typeScript + type: method + syntax: + content: |- + static create(name: string, serviceClass: { + new (serviceScope: ServiceScope): TKey; + }): ServiceKey; + return: + type: + - '@microsoft/sp-core-library!ServiceKey.create~0:complex' + description: the newly created ServiceKey + parameters: + - id: name + description: A name such as "my-package.IMyService" which should be unique across packages. + type: + - string + optional: false + - id: serviceClass + description: the TypeScript class that implements the service. + type: + - '@microsoft/sp-core-library!ServiceKey.create~1:complex' + optional: false + typeParameters: + - id: TKey + - uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' + summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. + name: 'createCustom(name, defaultCreator)' + fullName: 'createCustom(name, defaultCreator)' + langs: + - typeScript + type: method + syntax: + content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' + return: + type: + - '@microsoft/sp-core-library!ServiceKey.createCustom~0:complex' + description: the newly created service key + parameters: + - id: name + description: A name such as "my-package.IMyService" which should be unique across packages. + type: + - string + optional: false + - id: defaultCreator + description: a callback that returns an object that implements the T interface + type: + - '@microsoft/sp-core-library!ServiceKey.createCustom~1:complex' + optional: false + typeParameters: + - id: TKey + - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' summary: A callback function that constructs the default instance of this service. - remarks: '' - - isPreview: false - isDeprecated: false + name: defaultCreator + fullName: defaultCreator + langs: + - typeScript + type: property syntax: content: 'readonly defaultCreator: ServiceCreator;' return: - type: '<T>' - - name: id - uid: '@microsoft/sp-core-library!ServiceKey#id:member' - package: '@microsoft/sp-core-library!' - fullName: id + type: + - '@microsoft/sp-core-library!ServiceKey#defaultCreator~0:complex' + - uid: '@microsoft/sp-core-library!ServiceKey#id:member' summary: A unique identifier for this service key. remarks: >- This identifier is an automatically generated string that will be unique for the lifetime of the page. Callers @@ -45,17 +106,17 @@ properties: was passed to ServiceKey.create(). This is because each call to ServiceKey.create() could potentially provide a different defaultCreator implementation, whereas one of the design goals of ServiceScope is that the order in which libraries are loaded should never affect the resulting tree of scopes. - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: string;' return: - type: string - - name: name - uid: '@microsoft/sp-core-library!ServiceKey#name:member' - package: '@microsoft/sp-core-library!' - fullName: name + type: + - string + - uid: '@microsoft/sp-core-library!ServiceKey#name:member' summary: The name of the service. remarks: >- This name is used for logging and diagnostic purposes only. To make it unique, the recommended convention is the @@ -64,63 +125,75 @@ properties: The system does not assume that this string is unique. Instead, the [ServiceKey.id](xref:@microsoft/sp-core-library!ServiceKey%23id:member) is used wherever a lookup key is needed. - - isPreview: false - isDeprecated: false + name: name + fullName: name + langs: + - typeScript + type: property syntax: content: 'readonly name: string;' return: - type: string -methods: - - name: 'create(name, serviceClass)' - uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'create(name, serviceClass)' - summary: >- - Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts - the standard constructor parameter. - remarks: >- - If you want to specify custom constructor parameters, use - [ServiceKey.createCustom()](xref:@microsoft/sp-core-library!ServiceKey.createCustom:member(1)) instead. - - isPreview: false - isDeprecated: false - syntax: - content: |- - static create(name: string, serviceClass: { - new (serviceScope: ServiceScope): TKey; - }): ServiceKey; - parameters: - - id: name - description: A name such as "my-package.IMyService" which should be unique across packages. - type: string - - id: serviceClass - description: the TypeScript class that implements the service. - type: |- - { - new (serviceScope: ): TKey; - } - return: - type: '<TKey>' - description: the newly created ServiceKey - - name: 'createCustom(name, defaultCreator)' - uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'createCustom(name, defaultCreator)' - summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static createCustom(name: string, defaultCreator: ServiceCreator): ServiceKey;' - parameters: - - id: name - description: A name such as "my-package.IMyService" which should be unique across packages. - type: string - - id: defaultCreator - description: a callback that returns an object that implements the T interface - type: '<TKey>' - return: - type: '<TKey>' - description: the newly created service key + type: + - string +references: + - uid: '@microsoft/sp-core-library!ServiceKey.create~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceKey.create~1:complex' + name: |- + { + new (serviceScope: ServiceScope): TKey; + } + fullName: |- + { + new (serviceScope: default): TKey; + } + spec.typeScript: + - name: |- + { + new (serviceScope: + fullName: |- + { + new (serviceScope: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: |- + ): TKey; + } + fullName: |- + ): TKey; + } + - uid: '@microsoft/sp-core-library!ServiceKey.createCustom~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceKey.createCustom~1:complex' + name: ServiceCreator + fullName: ServiceCreator + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + name: ServiceCreator + fullName: ServiceCreator + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator~0:complex' + name: ServiceCreator + fullName: ServiceCreator + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceCreator:type' + name: ServiceCreator + fullName: ServiceCreator + - name: + fullName: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 7727ee51..f2b952cc 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -1,143 +1,161 @@ -### YamlMime:TSType -name: ServiceScope -uid: '@microsoft/sp-core-library!ServiceScope:class' -package: '@microsoft/sp-core-library!' -fullName: ServiceScope -summary: The service locator pattern used by the SharePoint Framework. -remarks: >- - ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to enable - different implementations to be registered in different scopes. This improves modularity by decoupling components from - their dependencies in an extensible way. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + summary: The service locator pattern used by the SharePoint Framework. + remarks: >- + ServiceScope provides a formalized way for components to register and consume dependencies ("services"), and to + enable different implementations to be registered in different scopes. This improves modularity by decoupling + components from their dependencies in an extensible way. - For example, suppose that various components need access to an IPageManager instance. We could simply make the - PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog that - requires a second PageManager instance. A better solution would be to add the PageManager as a constructor parameter - for each component that requires it, however then we immediately face the problem that any code that calls these - constructors also needs a PageManager parameter. In an application with many such dependencies, business logic that - ties together many subsystems would eventually pick up a constructor parameter for every possible dependency, which is - awkward. A natural solution would be to move all the dependencies into a class with name like "ApplicationContext", - and then pass this around as our constructor parameter. This enables the PageManager to be passed to classes that need - it without cluttering the intermediary classes that don't. However, it still has a design problem that - "ApplicationContext" has hard-coded dependencies on many unrelated things. A more flexible approach is to make it a - dictionary that can look up items for consumers/providers who know the right lookup key (i.e. ServiceKey). This is the - popular "service locator" design pattern, familiar from the SPContext API in classic SharePoint. + For example, suppose that various components need access to an IPageManager instance. We could simply make the + PageManager a singleton (i.e. global variable), but this will not work e.g. if we need to create a pop-up dialog + that requires a second PageManager instance. A better solution would be to add the PageManager as a constructor + parameter for each component that requires it, however then we immediately face the problem that any code that + calls these constructors also needs a PageManager parameter. In an application with many such dependencies, + business logic that ties together many subsystems would eventually pick up a constructor parameter for every + possible dependency, which is awkward. A natural solution would be to move all the dependencies into a class with + name like "ApplicationContext", and then pass this around as our constructor parameter. This enables the + PageManager to be passed to classes that need it without cluttering the intermediary classes that don't. However, + it still has a design problem that "ApplicationContext" has hard-coded dependencies on many unrelated things. A + more flexible approach is to make it a dictionary that can look up items for consumers/providers who know the + right lookup key (i.e. ServiceKey). This is the popular "service locator" design pattern, familiar from the + SPContext API in classic SharePoint. - ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that e.g. - if we have two different pages, they can each provide a unique PageManager instance while still sharing other common - dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. This is - important for API stability in our modular client-side environment: For example, suppose that version 2.0 of our - application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to consume. If the - version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by requiring each - consumer to check for any missing dependencies and handle that case, but it would require a lot of checks. A better - solution is to ensure that a default implementation always exists, perhaps just a trivial behavior, so that components - can assume that consume() will always return some object that implements the contract. + ServiceScope takes this idea a step further in two important ways: First, it provides a scoping mechanism so that + e.g. if we have two different pages, they can each provide a unique PageManager instance while still sharing other + common dependencies. Secondly, it allows for a ServiceKey to provide a default implementation of the dependency. + This is important for API stability in our modular client-side environment: For example, suppose that version 2.0 + of our application introduced a new IDiagnosticTracing interface that a version 2.0 component will expect to + consume. If the version 2.0 component gets loaded by an older 1.0 application, it would fail. We could fix this by + requiring each consumer to check for any missing dependencies and handle that case, but it would require a lot of + checks. A better solution is to ensure that a default implementation always exists, perhaps just a trivial + behavior, so that components can assume that consume() will always return some object that implements the + contract. - Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or - ServiceScope.startNewChild(). They are initially in an "unfinished" state, during which provide() can be called to - register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed and - provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result for the - same key, and does not depend on order of initialization. It also allows us to support circular dependencies without - worrying about infinite loops. (Circular dependencies are best avoided, however this is difficult to guarantee when - working with components that were contributed by various third parties without any coordination.) To avoid mistakes, - it's best to always call consume() inside a callback from serviceScope.whenFinished(). -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(parent) - uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' + Usage: ServiceScope instances are created by calling either ServiceScope.startNewRoot() or + ServiceScope.startNewChild(). They are initially in an "unfinished" state, during which provide() can be called to + register service keys, but consume() is disallowed. After ServiceScope.finish() is called, consume() is allowed + and provide() is now disallowed. These semantics ensure that ServiceScope.consume() always returns the same result + for the same key, and does not depend on order of initialization. It also allows us to support circular + dependencies without worrying about infinite loops. (Circular dependencies are best avoided, however this is + difficult to guarantee when working with components that were contributed by various third parties without any + coordination.) To avoid mistakes, it's best to always call consume() inside a callback from + serviceScope.whenFinished(). + name: ServiceScope + fullName: ServiceScope + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: (constructor)(parent) + children: + - '@microsoft/sp-core-library!ServiceScope:constructor(1)' + - '@microsoft/sp-core-library!ServiceScope#consume:member(1)' + - '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' + - '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' + - '@microsoft/sp-core-library!ServiceScope#finish:member(1)' + - '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' + - '@microsoft/sp-core-library!ServiceScope#provide:member(1)' + - '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' + - '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' + - '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' + - uid: '@microsoft/sp-core-library!ServiceScope:constructor(1)' summary: Constructs a new instance of the `ServiceScope` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(parent) + fullName: (constructor)(parent) + langs: + - typeScript + type: constructor syntax: content: 'protected constructor(parent: ServiceScope | undefined);' parameters: - id: parent description: '' - type: ' | undefined' -methods: - - name: consume(serviceKey) - uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' - package: '@microsoft/sp-core-library!' - fullName: consume(serviceKey) + type: + - '@microsoft/sp-core-library!ServiceScope~0:complex' + optional: false + - uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' summary: Consumes a service from the service scope. remarks: >- Components should call this function to "consume" a dependency, i.e. look up the serviceKey and return the registered service instance. If the instance cannot be found, then a default instance will be automatically created and registered with the root ServiceScope. - - isPreview: false - isDeprecated: false + name: consume(serviceKey) + fullName: consume(serviceKey) + langs: + - typeScript + type: method syntax: content: 'consume(serviceKey: ServiceKey): T;' + return: + type: + - T + description: the service instance parameters: - id: serviceKey description: the key that was used when provide() was called to register the service - type: '<T>' - return: - type: T - description: the service instance - - name: 'createAndProvide(serviceKey, simpleServiceClass)' - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'createAndProvide(serviceKey, simpleServiceClass)' + type: + - '@microsoft/sp-core-library!ServiceScope#consume~0:complex' + optional: false + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' summary: >- This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). - remarks: '' - - isPreview: false - isDeprecated: false + name: 'createAndProvide(serviceKey, simpleServiceClass)' + fullName: 'createAndProvide(serviceKey, simpleServiceClass)' + langs: + - typeScript + type: method syntax: content: |- createAndProvide(serviceKey: ServiceKey, simpleServiceClass: { new (serviceScope: ServiceScope): T; }): T; + return: + type: + - T + description: a newly constructed instance of simpleServiceClass parameters: - id: serviceKey description: the key that can be used later to consume the service - type: '<T>' + type: + - '@microsoft/sp-core-library!ServiceScope#createAndProvide~0:complex' + optional: false - id: simpleServiceClass description: the TypeScript class to be constructed - type: |- - { - new (serviceScope: ): T; - } - return: - type: T - description: a newly constructed instance of simpleServiceClass - - name: createDefaultAndProvide(serviceKey) - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' - package: '@microsoft/sp-core-library!' - fullName: createDefaultAndProvide(serviceKey) + type: + - '@microsoft/sp-core-library!ServiceScope#createAndProvide~1:complex' + optional: false + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide:member(1)' summary: >- This is a shorthand function that constructs the default implementation of the specified serviceKey, and then registers it by calling ServiceScope.provide(). - remarks: '' - - isPreview: false - isDeprecated: false + name: createDefaultAndProvide(serviceKey) + fullName: createDefaultAndProvide(serviceKey) + langs: + - typeScript + type: method syntax: content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' + return: + type: + - T + description: a service instance that was constructed using ServiceKey.defaultCreator parameters: - id: serviceKey description: the key that can be used later to consume the service - type: '<T>' - return: - type: T - description: a service instance that was constructed using ServiceKey.defaultCreator - - name: finish() - uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' - package: '@microsoft/sp-core-library!' - fullName: finish() + type: + - '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide~0:complex' + optional: false + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#finish:member(1)' summary: Completes the initialization sequence for a service scope. remarks: >- When a ServiceScope is first started, it is in an "unfinished" state where provide() is allowed but consume() is @@ -149,87 +167,91 @@ methods: inheritance) before Scope2.provide() is called with A2, then a subsequent call to Scope2.consume() might return a different result than the previous call. This nondeterminism could cause unpredictable results that are difficult to diagnose. - - isPreview: false - isDeprecated: false + name: finish() + fullName: finish() + langs: + - typeScript + type: method syntax: content: 'finish(): void;' return: - type: void + type: + - void description: '' - - name: getParent() - uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getParent() + - uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' - remarks: '' - - isPreview: false - isDeprecated: false + name: getParent() + fullName: getParent() + langs: + - typeScript + type: method syntax: content: 'getParent(): ServiceScope | undefined;' return: - type: ' | undefined' + type: + - '@microsoft/sp-core-library!ServiceScope#getParent~0:complex' description: the parent service scope - - name: 'provide(serviceKey, service)' - uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'provide(serviceKey, service)' + - uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' summary: Add a new service to a service scope. remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope. It may only be used when the ServiceScope is in an "unfinished" state, i.e. before finish() has been called. - - isPreview: false - isDeprecated: false + name: 'provide(serviceKey, service)' + fullName: 'provide(serviceKey, service)' + langs: + - typeScript + type: method syntax: content: 'provide(serviceKey: ServiceKey, service: T): T;' + return: + type: + - T + description: the same object that was passed as the "service" parameter parameters: - id: serviceKey description: the key that will later be used to consume the service - type: '<T>' + type: + - '@microsoft/sp-core-library!ServiceScope#provide~0:complex' + optional: false - id: service description: the service instance that is being registered - type: T - return: - type: T - description: the same object that was passed as the "service" parameter - - name: startNewChild() - uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' - package: '@microsoft/sp-core-library!' - fullName: startNewChild() + type: + - T + optional: false + typeParameters: + - id: T + - uid: '@microsoft/sp-core-library!ServiceScope#startNewChild:member(1)' summary: Constructs a new ServiceScope that is a child of the current scope. remarks: >- The service scopes form a tree structure, such that when consuming a service, if the key is not explicitly provided by a child scope, the parent hierarchy will be consulted. - - isPreview: false - isDeprecated: false + name: startNewChild() + fullName: startNewChild() + langs: + - typeScript + type: method syntax: content: 'startNewChild(): ServiceScope;' return: - type: '' + type: + - '@microsoft/sp-core-library!default:class' description: the newly created root ServiceScope - - name: startNewRoot() - uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' - package: '@microsoft/sp-core-library!' - fullName: startNewRoot() + - uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' summary: >- Create a new root-level ServiceScope. Only root-level scopes have the ability to autocreate default implementations of ServiceKeys. - remarks: '' - - isPreview: false - isDeprecated: false + name: startNewRoot() + fullName: startNewRoot() + langs: + - typeScript + type: method syntax: content: 'static startNewRoot(): ServiceScope;' return: - type: '' + type: + - '@microsoft/sp-core-library!default:class' description: the newly created root ServiceScope - - name: whenFinished(callback) - uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' - package: '@microsoft/sp-core-library!' - fullName: whenFinished(callback) + - uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' summary: >- Defer an operation until after [ServiceScope.finish()](xref:@microsoft/sp-core-library!ServiceScope%23finish:member(1)) has completed. @@ -243,15 +265,102 @@ methods: NOTE: This is not an asynchronous callback. ServiceScope initialization is typically inexpensive and short lived. However, the control flow often threads through numerous constructors and base classes, which can be simplified using whenFinished(). - - isPreview: false - isDeprecated: false + name: whenFinished(callback) + fullName: whenFinished(callback) + langs: + - typeScript + type: method syntax: content: 'whenFinished(callback: () => void): void;' + return: + type: + - void + description: '' parameters: - id: callback description: A block of code that needs to call ServiceScope.consume() - type: () => void - return: - type: void - description: '' + type: + - () => void + optional: false +references: + - uid: '@microsoft/sp-core-library!ServiceScope~0:complex' + name: ServiceScope | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!ServiceScope#consume~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide~1:complex' + name: |- + { + new (serviceScope: ServiceScope): T; + } + fullName: |- + { + new (serviceScope: default): T; + } + spec.typeScript: + - name: |- + { + new (serviceScope: + fullName: |- + { + new (serviceScope: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: |- + ): T; + } + fullName: |- + ): T; + } + - uid: '@microsoft/sp-core-library!ServiceScope#createDefaultAndProvide~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!ServiceScope#getParent~0:complex' + name: ServiceScope | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!ServiceScope#provide~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: + fullName: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 56ed22f2..4962d0c7 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -1,19 +1,18 @@ -### YamlMime:TSType -name: Session -uid: '@microsoft/sp-core-library!Session:class' -package: '@microsoft/sp-core-library!' -fullName: Session -summary: Provides access to the application's browser session and active page. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: applicationId - uid: '@microsoft/sp-core-library!Session.applicationId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Session:class' + summary: Provides access to the application's browser session and active page. + name: Session + fullName: Session + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: applicationId + children: + - '@microsoft/sp-core-library!Session.applicationId:member' + - '@microsoft/sp-core-library!Session.clientSideApplicationId:member' + - '@microsoft/sp-core-library!Session.pageId:member' + - uid: '@microsoft/sp-core-library!Session.applicationId:member' summary: A unique identifier for the current instance of the client-side application. remarks: >- A unique identifier used to correlate logging and other diagnostic information. Its lifetime persists for the @@ -21,30 +20,29 @@ properties: and ends e.g. when the browser tab is closed or F5 is pressed to reload the page. Note that if the application's router supports in-place navigation (via the history.pushState() API), the application session persists across these transitions. - - isPreview: false - isDeprecated: false + name: applicationId + fullName: applicationId + langs: + - typeScript + type: property syntax: content: 'static get applicationId(): Guid;' return: - type: '' - - name: clientSideApplicationId - uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' - package: '@microsoft/sp-core-library!' - fullName: clientSideApplicationId + type: + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' summary: The id of the currently running application - remarks: '' - - isPreview: false - isDeprecated: false + name: clientSideApplicationId + fullName: clientSideApplicationId + langs: + - typeScript + type: property syntax: content: 'static get clientSideApplicationId(): string;' return: - type: string - - name: pageId - uid: '@microsoft/sp-core-library!Session.pageId:member' - package: '@microsoft/sp-core-library!' - fullName: pageId + type: + - string + - uid: '@microsoft/sp-core-library!Session.pageId:member' summary: A unique identifier for the current page within the client-side application. remarks: >- A unique identifier used to correlate logging and other diagnostic information. Whereas the @@ -60,10 +58,16 @@ properties: The concept of a page is subjective and defined by the router for a particular application. - - isPreview: false - isDeprecated: false + name: pageId + fullName: pageId + langs: + - typeScript + type: property syntax: content: 'static get pageId(): Guid;' return: - type: '' + type: + - '@microsoft/sp-core-library!default:class' +references: + - uid: '@microsoft/sp-core-library!default:class' + name: Guid diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index 5ee2fa6c..8c753e53 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -1,77 +1,92 @@ -### YamlMime:TSType -name: SPEvent -uid: '@microsoft/sp-core-library!SPEvent:class' -package: '@microsoft/sp-core-library!' -fullName: SPEvent -summary: Represents a framework event that components can subscribe to. -remarks: >- - Examples of events in a web application might include: the user clicking a button, the system navigating to another - page, or an item being added/removed from an abstract collection. The SharePoint Framework represents events using - instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed as a property of - an associated class (e.g. the button that can be clicked). When a component is interested in an event, it calls add() - to register an event handler callback that will be invoked each time the event occurs. The handler receives an - SPEventArgs parameter that may provide additional details about what happened. This is analogous to the browser's - Document Object Model (DOM) events. The main difference is the ISPEventObserver feature, which tracks which component - subscribed to each event, and automatically unsubscribes the handler when the component is disposed. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!SPEvent:class' + summary: Represents a framework event that components can subscribe to. + remarks: >- + Examples of events in a web application might include: the user clicking a button, the system navigating to + another page, or an item being added/removed from an abstract collection. The SharePoint Framework represents + events using instances of the SPEvent object, one for each kind of event. The SPEvent object is typically exposed + as a property of an associated class (e.g. the button that can be clicked). When a component is interested in an + event, it calls add() to register an event handler callback that will be invoked each time the event occurs. The + handler receives an SPEventArgs parameter that may provide additional details about what happened. This is + analogous to the browser's Document Object Model (DOM) events. The main difference is the ISPEventObserver + feature, which tracks which component subscribed to each event, and automatically unsubscribes the handler when + the component is disposed. - When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is - unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught exception - will not prevent other handlers from executing, but it will be reported as a problem with the associated component. + When an event is raised, all handlers are invoked synchronously. The order in which event handlers are called is + unspecified. The event handler callback must catch any exceptions that occur during processing; an uncaught + exception will not prevent other handlers from executing, but it will be reported as a problem with the associated + component. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPEvent` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'add(observer, eventHandler)' - uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPEvent` class. + name: SPEvent + fullName: SPEvent + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: 'add(observer, eventHandler)' + children: + - '@microsoft/sp-core-library!SPEvent#add:member(1)' + - '@microsoft/sp-core-library!SPEvent#remove:member(1)' + - uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' summary: Registers a callback that will be invoked whenever the event occurs. remarks: >- The same object can add multiple event handlers to the same event. Since BaseComponent implements the ISPEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event handler to be automatically unsubscribed when the web part or extension is disposed. - - isPreview: false - isDeprecated: false + name: 'add(observer, eventHandler)' + fullName: 'add(observer, eventHandler)' + langs: + - typeScript + type: method syntax: content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + return: + type: + - void + description: '' parameters: - id: observer description: >- Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception. - type: '' + type: + - '@microsoft/sp-core-library!ISPEventObserver:interface' + optional: false - id: eventHandler description: A callback function that will be invoked whenever the event occurs - type: '(eventArgs: TEventArgs) => void' - return: - type: void - description: '' - - name: 'remove(observer, eventHandler)' - uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'remove(observer, eventHandler)' + type: + - '(eventArgs: TEventArgs) => void' + optional: false + - uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' summary: Unregisters a callback that was registered using add(). remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' - - isPreview: false - isDeprecated: false + name: 'remove(observer, eventHandler)' + fullName: 'remove(observer, eventHandler)' + langs: + - typeScript + type: method syntax: content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + return: + type: + - void + description: '' parameters: - id: observer description: This must be the same observer that was passed to the add() function. - type: '' + type: + - '@microsoft/sp-core-library!ISPEventObserver:interface' + optional: false - id: eventHandler description: The event handler to remove; this must be the same object instance that was passed to the add() function. - type: '(eventArgs: TEventArgs) => void' - return: - type: void - description: '' + type: + - '(eventArgs: TEventArgs) => void' + optional: false +references: + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + name: ISPEventObserver diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index 2068956c..cdd91e77 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -1,11 +1,11 @@ -### YamlMime:TSType -name: SPEventArgs -uid: '@microsoft/sp-core-library!SPEventArgs:class' -package: '@microsoft/sp-core-library!' -fullName: SPEventArgs -summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' -remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' - -isPreview: false -isDeprecated: false -type: class +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' + remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' + name: SPEventArgs + fullName: SPEventArgs + langs: + - typeScript + type: class + package: '@microsoft/sp-core-library!' diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 43d8decd..35ae2eba 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -1,19 +1,18 @@ -### YamlMime:TSType -name: Text_2 -uid: '@microsoft/sp-core-library!Text_2:class' -package: '@microsoft/sp-core-library!' -fullName: Text_2 -summary: Operations for working with strings that contain text. -remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' - -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'format(s, values)' - uid: '@microsoft/sp-core-library!Text_2.format:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Text_2:class' + summary: Operations for working with strings that contain text. + remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' + name: Text_2 + fullName: Text_2 + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: 'format(s, values)' + children: + - '@microsoft/sp-core-library!Text_2.format:member(1)' + - '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' + - uid: '@microsoft/sp-core-library!Text_2.format:member(1)' summary: Format a string by substituting parameters. remarks: >- This function replaces template parameters such as `"{0}"` or `"{1}"` with the corresponding argument. If the @@ -25,42 +24,55 @@ methods: `Text.format("hello {0}!", "world")` will return `"hello world!"` - - isPreview: false - isDeprecated: false + name: 'format(s, values)' + fullName: 'format(s, values)' + langs: + - typeScript + type: method syntax: content: 'static format(s: string, ...values: unknown[]): string;' + return: + type: + - string + description: '' parameters: - id: s description: '' - type: string + type: + - string + optional: false - id: values description: '' - type: 'unknown[]' - return: - type: string - description: '' - - name: 'replaceAll(input, searchValue, replaceValue)' - uid: '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'replaceAll(input, searchValue, replaceValue)' + type: + - 'unknown[]' + optional: false + - uid: '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' - - isPreview: false - isDeprecated: false + name: 'replaceAll(input, searchValue, replaceValue)' + fullName: 'replaceAll(input, searchValue, replaceValue)' + langs: + - typeScript + type: method syntax: content: 'static replaceAll(input: string, searchValue: string, replaceValue: string): string;' + return: + type: + - string + description: '' parameters: - id: input description: The string to be modified - type: string + type: + - string + optional: false - id: searchValue description: The value to search for - type: string + type: + - string + optional: false - id: replaceValue description: The replacement text - type: string - return: - type: string - description: '' + type: + - string + optional: false diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 3ad72aa4..f6f25c68 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -1,74 +1,93 @@ -### YamlMime:TSType -name: TimeProvider -uid: '@microsoft/sp-core-library!TimeProvider:class' -package: '@microsoft/sp-core-library!' -fullName: TimeProvider -summary: >- - This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) that - simply calls the real browser APIs. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!TimeProvider:class' + summary: >- + This is the default implementation of [ITimeProvider](xref:@microsoft/sp-core-library!ITimeProvider:interface) + that simply calls the real browser APIs. + name: TimeProvider + fullName: TimeProvider + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!ITimeProvider:interface' package: '@microsoft/sp-core-library!' - fullName: (constructor)(serviceScope) + children: + - '@microsoft/sp-core-library!TimeProvider:constructor(1)' + - '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' + - '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' + - '@microsoft/sp-core-library!TimeProvider.serviceKey:member' + - uid: '@microsoft/sp-core-library!TimeProvider:constructor(1)' summary: Constructs a new instance of the `TimeProvider` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' - package: '@microsoft/sp-core-library!' - fullName: serviceKey - summary: The service key for ITimeProvider. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getDate() - uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getDate() + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' summary: 'Returns the current date/time, similar to the Date class constructor.' - remarks: '' - - isPreview: false - isDeprecated: false + name: getDate() + fullName: getDate() + langs: + - typeScript + type: method syntax: content: 'getDate(): Date;' return: - type: Date + type: + - '!Date:interface' description: '' - - name: getTimestamp() - uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getTimestamp() + - uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' - remarks: '' - - isPreview: false - isDeprecated: false + name: getTimestamp() + fullName: getTimestamp() + langs: + - typeScript + type: method syntax: content: 'getTimestamp(): number;' return: - type: number + type: + - number description: '' + - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' + summary: The service key for ITimeProvider. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - '@microsoft/sp-core-library!TimeProvider.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + name: ITimeProvider + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceScope + - uid: '!Date:interface' + name: Date + - uid: '@microsoft/sp-core-library!TimeProvider.serviceKey~0:complex' + name: ServiceKey + fullName: default + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: ServiceKey + fullName: default + - name: < + fullName: < + - uid: '@microsoft/sp-core-library!ITimeProvider:interface' + name: ITimeProvider + fullName: ITimeProvider + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 84dd8eda..2df5047c 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -1,47 +1,47 @@ -### YamlMime:TSType -name: UrlQueryParameterCollection -uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' -package: '@microsoft/sp-core-library!' -fullName: UrlQueryParameterCollection -summary: Provides features for storing and retrieving URL query parameters. -remarks: >- - The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with "?" - to indicate the first query parameter and use "&" for all subsequent parameters. The class also supports - fragments. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:class' + summary: Provides features for storing and retrieving URL query parameters. + remarks: >- + The URL can be server-relative, and it can also be an empty or null string. The query parameters must start with + "?" to indicate the first query parameter and use "&" for all subsequent parameters. The class also supports + fragments. - Edge case behavior: + Edge case behavior: - Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) stores - key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value Query param - with only equals (www.example.com/?=&debug=on stores empty string key and value - -isPreview: false -isDeprecated: true -customDeprecatedMessage: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. -type: class -constructors: - - name: (constructor)(url) - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' + Empty value (www.example.com/?test=) stores key and empty value No equals in queryParam (www.example.com/?test) + stores key and undefined value Empty queryParam (www.example.com/?&debug=on) stores undefined key and value + Query param with only equals (www.example.com/?=&debug=on stores empty string key and value + deprecated: + content: Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers. + name: UrlQueryParameterCollection + fullName: UrlQueryParameterCollection + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: (constructor)(url) + children: + - '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' + - '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' + - '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection:constructor(1)' summary: Constructs a new instance of the `UrlQueryParameterCollection` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(url) + fullName: (constructor)(url) + langs: + - typeScript + type: constructor syntax: content: 'constructor(url: string);' parameters: - id: url description: '' - type: string -methods: - - name: getValue(param) - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getValue(param) + type: + - string + optional: false + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValue:member(1)' summary: Returns the value of the first matching query parameter or undefined if the key doesn't exist. remarks: |- Examples: @@ -55,22 +55,24 @@ methods: getValue('debug') ---> 'false' getValue('lost') ---> undefined ``` - - isPreview: false - isDeprecated: false + name: getValue(param) + fullName: getValue(param) + langs: + - typeScript + type: method syntax: content: 'getValue(param: string): string | undefined;' + return: + type: + - string | undefined + description: '' parameters: - id: param description: the case insensitive key for the desired query parameter value. - type: string - return: - type: string | undefined - description: '' - - name: getValues(param) - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' - package: '@microsoft/sp-core-library!' - fullName: getValues(param) + type: + - string + optional: false + - uid: '@microsoft/sp-core-library!UrlQueryParameterCollection#getValues:member(1)' summary: Returns the values of all of the matching query parameters or undefined if the key doesn't exist. remarks: |- Examples: @@ -84,15 +86,20 @@ methods: getValues('debug') ---> ['false'] getValues('lost') ---> undefined ``` - - isPreview: false - isDeprecated: false + name: getValues(param) + fullName: getValues(param) + langs: + - typeScript + type: method syntax: content: 'getValues(param: string): (string | undefined)[] | undefined;' + return: + type: + - '(string | undefined)[] | undefined' + description: '' parameters: - id: param description: the case insensitive key for the desired query parameter value. - type: string - return: - type: '(string | undefined)[] | undefined' - description: '' + type: + - string + optional: false diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 39cf943f..ce5d9825 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -1,99 +1,118 @@ -### YamlMime:TSType -name: Validate -uid: '@microsoft/sp-core-library!Validate:class' -package: '@microsoft/sp-core-library!' -fullName: Validate -summary: Performs common validation tests for properties and function parameters. -remarks: >- - This class implements provides a standard way to validate properties and function parameters. Unlike debug assertions, - Validate checks are always performed and will always throw an error, even in a production release. As such, be careful - not to overuse these checks in a way that might impact performance. - -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'isNonemptyString(value, variableName)' - uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Validate:class' + summary: Performs common validation tests for properties and function parameters. + remarks: >- + This class implements provides a standard way to validate properties and function parameters. Unlike debug + assertions, Validate checks are always performed and will always throw an error, even in a production release. As + such, be careful not to overuse these checks in a way that might impact performance. + name: Validate + fullName: Validate + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: 'isNonemptyString(value, variableName)' + children: + - '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' + - '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' + - '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' + - '@microsoft/sp-core-library!Validate.isTrue:member(1)' + - uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' - remarks: '' - - isPreview: false - isDeprecated: false + name: 'isNonemptyString(value, variableName)' + fullName: 'isNonemptyString(value, variableName)' + langs: + - typeScript + type: method syntax: content: 'static isNonemptyString(value: string | undefined | null, variableName: string): void;' + return: + type: + - void + description: '' parameters: - id: value description: the value to check - type: string | undefined | null + type: + - string | undefined | null + optional: false - id: variableName description: 'the program variable name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' - - name: 'isNotDisposed(value, className)' - uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isNotDisposed(value, className)' + type: + - string + optional: false + - uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' summary: Throws an exception if the specified object has been disposed. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'isNotDisposed(value, className)' + fullName: 'isNotDisposed(value, className)' + langs: + - typeScript + type: method syntax: content: 'static isNotDisposed(value: IDisposable, className: string): void;' + return: + type: + - void + description: '' parameters: - id: value description: the value to check - type: '' + type: + - '@microsoft/sp-core-library!IDisposable:interface' + optional: false - id: className description: 'the class name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' - - name: 'isNotNullOrUndefined(value, variableName)' - uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isNotNullOrUndefined(value, variableName)' + type: + - string + optional: false + - uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' summary: Throws an exception if the specified value is null or undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'isNotNullOrUndefined(value, variableName)' + fullName: 'isNotNullOrUndefined(value, variableName)' + langs: + - typeScript + type: method syntax: content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' + return: + type: + - void + description: '' parameters: - id: value description: the value to check - type: any + type: + - any + optional: false - id: variableName description: 'the program variable name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' - - name: 'isTrue(value, variableName)' - uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' - package: '@microsoft/sp-core-library!' - fullName: 'isTrue(value, variableName)' + type: + - string + optional: false + - uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' summary: Throws an exception if the specified value is not true. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'isTrue(value, variableName)' + fullName: 'isTrue(value, variableName)' + langs: + - typeScript + type: method syntax: content: 'static isTrue(value: boolean | undefined | null, variableName: string): void;' + return: + type: + - void + description: '' parameters: - id: value description: the value to check - type: boolean | undefined | null + type: + - boolean | undefined | null + optional: false - id: variableName description: 'the program variable name, which will be mentioned in the error message' - type: string - return: - type: void - description: '' + type: + - string + optional: false +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index 905d760b..b7a548a8 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -1,107 +1,61 @@ -### YamlMime:TSType -name: Version -uid: '@microsoft/sp-core-library!Version:class' -package: '@microsoft/sp-core-library!' -fullName: Version -summary: 'Represents a version number with two, three, or four parts.' -remarks: >- - This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, - MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, but - they are discarded. Missing parts are treated as zeroes for comparisons. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!Version:class' + summary: 'Represents a version number with two, three, or four parts.' + remarks: >- + This class represents versions that follow the string format of `MAJOR.MINOR[.PATCH[.REVISION]]` where the MAJOR, + MINOR, PATCH and REVISION parts are integers. PATCH and REVISION are optional. Leading zero digits are allowed, + but they are discarded. Missing parts are treated as zeroes for comparisons. - Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` -isPreview: false -isDeprecated: false -type: class -properties: - - name: major - uid: '@microsoft/sp-core-library!Version#major:member' - package: '@microsoft/sp-core-library!' - fullName: major - summary: Returns the first component of the version string. - remarks: Typically a change in the major version number indicates a compatibility break with previous versions. - - isPreview: false - isDeprecated: false - syntax: - content: 'get major(): number;' - return: - type: number - - name: minor - uid: '@microsoft/sp-core-library!Version#minor:member' - package: '@microsoft/sp-core-library!' - fullName: minor - summary: Returns the second component of the version string. - remarks: >- - Typically a change in the minor version number indicates that new features were added, while remaining backwards - compatible with previous releases. - - isPreview: false - isDeprecated: false - syntax: - content: 'get minor(): number;' - return: - type: number - - name: patch - uid: '@microsoft/sp-core-library!Version#patch:member' - package: '@microsoft/sp-core-library!' - fullName: patch - summary: 'The third number in the version string, or undefined if unspecified.' - remarks: >- - Typically a change in the patch version number indicates a small fix that does not affect the compatibility - contract for the library. For a .NET System.Version object, this is referred to as the "build" number. - - isPreview: false - isDeprecated: false - syntax: - content: 'get patch(): number | undefined;' - return: - type: number | undefined - - name: revision - uid: '@microsoft/sp-core-library!Version#revision:member' - package: '@microsoft/sp-core-library!' - fullName: revision - summary: 'The fourth number in the version string, or undefined if unspecified.' - remarks: >- - This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET - version numbers. - - isPreview: false - isDeprecated: false - syntax: - content: 'get revision(): number | undefined;' - return: - type: number | undefined -methods: - - name: 'compare(v1, v2)' - uid: '@microsoft/sp-core-library!Version.compare:member(1)' + Examples: `1.0`, `1.0.0`, `1.0.0.0`, `1.01`, `01.02.03`, `001.002.003.004` + name: Version + fullName: Version + langs: + - typeScript + type: class package: '@microsoft/sp-core-library!' - fullName: 'compare(v1, v2)' + children: + - '@microsoft/sp-core-library!Version.compare:member(1)' + - '@microsoft/sp-core-library!Version#equals:member(1)' + - '@microsoft/sp-core-library!Version#greaterThan:member(1)' + - '@microsoft/sp-core-library!Version.isValid:member(1)' + - '@microsoft/sp-core-library!Version#lessThan:member(1)' + - '@microsoft/sp-core-library!Version#major:member' + - '@microsoft/sp-core-library!Version#minor:member' + - '@microsoft/sp-core-library!Version.parse:member(1)' + - '@microsoft/sp-core-library!Version#patch:member' + - '@microsoft/sp-core-library!Version#revision:member' + - '@microsoft/sp-core-library!Version#satisfies:member(1)' + - '@microsoft/sp-core-library!Version#toString:member(1)' + - '@microsoft/sp-core-library!Version.tryParse:member(1)' + - uid: '@microsoft/sp-core-library!Version.compare:member(1)' summary: Compares two Version objects to determine which version is newer. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'compare(v1, v2)' + fullName: 'compare(v1, v2)' + langs: + - typeScript + type: method syntax: content: 'static compare(v1: Version, v2: Version): number;' + return: + type: + - number + description: >- + -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if + the first input is greater than the second input. parameters: - id: v1 description: The first version class for comparison - type: '' + type: + - '@microsoft/sp-core-library!default:class' + optional: false - id: v2 description: The second version class for comparison - type: '' - return: - type: number - description: >- - -1 if the first input is less than the second input; 0 if the first input is equal to the second input; 1 if - the first input is greater than the second input. - - name: equals(compareWith) - uid: '@microsoft/sp-core-library!Version#equals:member(1)' - package: '@microsoft/sp-core-library!' - fullName: equals(compareWith) + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!Version#equals:member(1)' summary: Tests whether this version is equal to the input parameter. remarks: |- Examples: @@ -112,22 +66,24 @@ methods: 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true ``` - - isPreview: false - isDeprecated: false + name: equals(compareWith) + fullName: equals(compareWith) + langs: + - typeScript + type: method syntax: content: 'equals(compareWith: Version): boolean;' + return: + type: + - boolean + description: A boolean indicating if this version is equal to the input parameter parameters: - id: compareWith description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is equal to the input parameter - - name: greaterThan(compareWith) - uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' - package: '@microsoft/sp-core-library!' - fullName: greaterThan(compareWith) + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!Version#greaterThan:member(1)' summary: Tests whether this version is greater than (i.e. newer than) the input parameter. remarks: |- Examples: @@ -137,40 +93,43 @@ methods: 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true ``` - - isPreview: false - isDeprecated: false + name: greaterThan(compareWith) + fullName: greaterThan(compareWith) + langs: + - typeScript + type: method syntax: content: 'greaterThan(compareWith: Version): boolean;' + return: + type: + - boolean + description: A boolean indicating if this version is greater than the input parameter parameters: - id: compareWith description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is greater than the input parameter - - name: isValid(versionString) - uid: '@microsoft/sp-core-library!Version.isValid:member(1)' - package: '@microsoft/sp-core-library!' - fullName: isValid(versionString) + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!Version.isValid:member(1)' summary: Test whether a string is a valid version specifier. - remarks: '' - - isPreview: false - isDeprecated: false + name: isValid(versionString) + fullName: isValid(versionString) + langs: + - typeScript + type: method syntax: content: 'static isValid(versionString: string | undefined | null): boolean;' + return: + type: + - boolean + description: true if the versionString is a valid version specifier parameters: - id: versionString description: The version string - type: string | undefined | null - return: - type: boolean - description: true if the versionString is a valid version specifier - - name: lessThan(compareWith) - uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' - package: '@microsoft/sp-core-library!' - fullName: lessThan(compareWith) + type: + - string | undefined | null + optional: false + - uid: '@microsoft/sp-core-library!Version#lessThan:member(1)' summary: Tests whether this version is less than (i.e. older than) the input parameter. remarks: |- Examples: @@ -181,40 +140,101 @@ methods: 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false ``` - - isPreview: false - isDeprecated: false + name: lessThan(compareWith) + fullName: lessThan(compareWith) + langs: + - typeScript + type: method syntax: content: 'lessThan(compareWith: Version): boolean;' + return: + type: + - boolean + description: A boolean indicating if this version is less than the input parameter parameters: - id: compareWith description: The version to compare with - type: '' + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!Version#major:member' + summary: Returns the first component of the version string. + remarks: Typically a change in the major version number indicates a compatibility break with previous versions. + name: major + fullName: major + langs: + - typeScript + type: property + syntax: + content: 'get major(): number;' return: - type: boolean - description: A boolean indicating if this version is less than the input parameter - - name: parse(versionString) - uid: '@microsoft/sp-core-library!Version.parse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: parse(versionString) + type: + - number + - uid: '@microsoft/sp-core-library!Version#minor:member' + summary: Returns the second component of the version string. + remarks: >- + Typically a change in the minor version number indicates that new features were added, while remaining backwards + compatible with previous releases. + name: minor + fullName: minor + langs: + - typeScript + type: property + syntax: + content: 'get minor(): number;' + return: + type: + - number + - uid: '@microsoft/sp-core-library!Version.parse:member(1)' summary: Constructs a new Version instance using the version string. An exception is thrown if the string cannot be parsed. - remarks: '' - - isPreview: false - isDeprecated: false + name: parse(versionString) + fullName: parse(versionString) + langs: + - typeScript + type: method syntax: content: 'static parse(versionString: string | undefined | null): Version;' + return: + type: + - '@microsoft/sp-core-library!default:class' + description: a new Version object parameters: - id: versionString description: A version string - type: string | undefined | null + type: + - string | undefined | null + optional: false + - uid: '@microsoft/sp-core-library!Version#patch:member' + summary: 'The third number in the version string, or undefined if unspecified.' + remarks: >- + Typically a change in the patch version number indicates a small fix that does not affect the compatibility + contract for the library. For a .NET System.Version object, this is referred to as the "build" number. + name: patch + fullName: patch + langs: + - typeScript + type: property + syntax: + content: 'get patch(): number | undefined;' return: - type: '' - description: a new Version object - - name: satisfies(compareWith) - uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' - package: '@microsoft/sp-core-library!' - fullName: satisfies(compareWith) + type: + - number | undefined + - uid: '@microsoft/sp-core-library!Version#revision:member' + summary: 'The fourth number in the version string, or undefined if unspecified.' + remarks: >- + This number is not part of the Semantic Versioning (SemVer) standard used in JavaScript, but it is used by .NET + version numbers. + name: revision + fullName: revision + langs: + - typeScript + type: property + syntax: + content: 'get revision(): number | undefined;' + return: + type: + - number | undefined + - uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' summary: >- Tests whether this version satisfies the compatibility requirements of the input version, i.e. is backwards compatible. @@ -237,51 +257,69 @@ methods: 1.0.0 satisfies 1.1.0 -> false ``` - - isPreview: false - isDeprecated: false + name: satisfies(compareWith) + fullName: satisfies(compareWith) + langs: + - typeScript + type: method syntax: content: 'satisfies(compareWith: Version): boolean;' + return: + type: + - boolean + description: A boolean indicating if this version is compatible with the input parameter parameters: - id: compareWith description: The version to compare with - type: '' - return: - type: boolean - description: A boolean indicating if this version is compatible with the input parameter - - name: toString() - uid: '@microsoft/sp-core-library!Version#toString:member(1)' - package: '@microsoft/sp-core-library!' - fullName: toString() + type: + - '@microsoft/sp-core-library!default:class' + optional: false + - uid: '@microsoft/sp-core-library!Version#toString:member(1)' summary: Returns a string representation of the version. remarks: >- The value is normalized and may be different from the original string (e.g. leading zeroes may be removed). However, the number of version parts will be unchanged. - - isPreview: false - isDeprecated: false + name: toString() + fullName: toString() + langs: + - typeScript + type: method syntax: content: 'toString(): string;' return: - type: string + type: + - string description: '' - - name: tryParse(versionString) - uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' - package: '@microsoft/sp-core-library!' - fullName: tryParse(versionString) + - uid: '@microsoft/sp-core-library!Version.tryParse:member(1)' summary: >- Attempts to parse the input string to construct a new Version object. If the string cannot be parsed, then undefined is returned. - remarks: '' - - isPreview: false - isDeprecated: false + name: tryParse(versionString) + fullName: tryParse(versionString) + langs: + - typeScript + type: method syntax: content: 'static tryParse(versionString: string | undefined | null): Version | undefined;' + return: + type: + - '@microsoft/sp-core-library!Version.tryParse~0:complex' + description: 'The Version object, or undefined if the string could not be parsed.' parameters: - id: versionString description: A version string - type: string | undefined | null - return: - type: ' | undefined' - description: 'The Version object, or undefined if the string could not be parsed.' + type: + - string | undefined | null + optional: false +references: + - uid: '@microsoft/sp-core-library!default:class' + name: Version + - uid: '@microsoft/sp-core-library!Version.tryParse~0:complex' + name: Version | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!default:class' + name: Version + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-diagnostics.yml b/SP-Framework/sp-diagnostics.yml index f668b495..106d66bc 100644 --- a/SP-Framework/sp-diagnostics.yml +++ b/SP-Framework/sp-diagnostics.yml @@ -1,7 +1,39 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-diagnostics!' -name: '@microsoft/sp-diagnostics' -type: package -summary: >- - This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, user - engagement and performance logging. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-diagnostics!' + summary: >- + This package defines the internal diagnostics tools for the SharePoint Framework, including monitoring, trace, + user engagement and performance logging. + name: '@microsoft/sp-diagnostics' + fullName: '@microsoft/sp-diagnostics' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-diagnostics!_logSourceServiceKey:var' + - uid: '@microsoft/sp-diagnostics!_logSourceServiceKey:var' + name: _logSourceServiceKey + fullName: _logSourceServiceKey + langs: + - typeScript + type: variable + syntax: + content: 'logSourceServiceKey: ServiceKey' + return: + type: + - '@microsoft/sp-diagnostics!_logSourceServiceKey~0:complex' +references: + - uid: '@microsoft/sp-diagnostics!_logSourceServiceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-diagnostics!default:class' + name: LogSource + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-dialog.yml b/SP-Framework/sp-dialog.yml index e3af49b4..5b84ac58 100644 --- a/SP-Framework/sp-dialog.yml +++ b/SP-Framework/sp-dialog.yml @@ -1,14 +1,38 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-dialog!' -name: '@microsoft/sp-dialog' -type: package -summary: SharePoint Framework support for displaying pop-up dialog boxes. -classes: - - '@microsoft/sp-dialog!BaseDialog:class' - - '@microsoft/sp-dialog!Dialog:class' -interfaces: - - '@microsoft/sp-dialog!IAlertOptions:interface' - - '@microsoft/sp-dialog!IDialogConfiguration:interface' - - '@microsoft/sp-dialog!IDialogShowOptions:interface' - - '@microsoft/sp-dialog!IPromptOptions:interface' - - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!' + summary: SharePoint Framework support for displaying pop-up dialog boxes. + remarks: >- + This library provides simple stock dialogs such as + [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)) and + [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)), along with a general framework for + building custom dialog boxes that participate in the focus management system for SharePoint Framework + applications. + name: '@microsoft/sp-dialog' + fullName: '@microsoft/sp-dialog' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-dialog!BaseDialog:class' + - '@microsoft/sp-dialog!Dialog:class' + - '@microsoft/sp-dialog!IAlertOptions:interface' + - '@microsoft/sp-dialog!IDialogConfiguration:interface' + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + - '@microsoft/sp-dialog!IPromptOptions:interface' + - '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' +references: + - uid: '@microsoft/sp-dialog!BaseDialog:class' + name: BaseDialog + - uid: '@microsoft/sp-dialog!Dialog:class' + name: Dialog + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' + name: IAlertOptions + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' + name: IDialogConfiguration + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' + name: IPromptOptions + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' + name: ISecondaryDialogProvider diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index f8dfcc71..e2a5ad0c 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -1,26 +1,35 @@ -### YamlMime:TSType -name: BaseDialog -uid: '@microsoft/sp-dialog!BaseDialog:class' -package: '@microsoft/sp-dialog!' -fullName: BaseDialog -summary: >- - The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs to - the user inside SharePoint Framework components. -remarks: >- - Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the - framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is - controlled by this class by implementing the render method, the framework can decide when to show the dialog and how - to render the overlay and modal. The application on the page can also have control on allowing dialogs to show. Refer - to the documentation of the individual methods and properties to learn more about how to extend and use this class. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(config) - uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!BaseDialog:class' + summary: >- + The base class for implementing dialogs in SharePoint Framework. This provides a supported way for showing dialogs + to the user inside SharePoint Framework components. + remarks: >- + Extend this class to create dialogs for SharePoint Framework. By following the guidelines in implementation, the + framework can ensure that the dialogs are shown in a user-friendly manner. While the content of the dialog is + controlled by this class by implementing the render method, the framework can decide when to show the dialog and + how to render the overlay and modal. The application on the page can also have control on allowing dialogs to + show. Refer to the documentation of the individual methods and properties to learn more about how to extend and + use this class. + name: BaseDialog + fullName: BaseDialog + langs: + - typeScript + type: class package: '@microsoft/sp-dialog!' - fullName: (constructor)(config) + children: + - '@microsoft/sp-dialog!BaseDialog:constructor(1)' + - '@microsoft/sp-dialog!BaseDialog#close:member(1)' + - '@microsoft/sp-dialog!BaseDialog#domElement:member' + - '@microsoft/sp-dialog!BaseDialog#isHidden:member' + - '@microsoft/sp-dialog!BaseDialog#isOpen:member' + - '@microsoft/sp-dialog!BaseDialog#isSecondary:member' + - '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' + - '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' + - '@microsoft/sp-dialog!BaseDialog#render:member(1)' + - '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' + - '@microsoft/sp-dialog!BaseDialog#show:member(1)' + - uid: '@microsoft/sp-dialog!BaseDialog:constructor(1)' summary: Constructor for the `BaseDialog` class. remarks: >- It is important to keep the constructor lightweight. Use `onBeforeOpen()` for doing heavy-weight initialization @@ -47,149 +56,128 @@ constructors: // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() } ``` - - isPreview: false - isDeprecated: false + name: (constructor)(config) + fullName: (constructor)(config) + langs: + - typeScript + type: constructor syntax: content: 'constructor(config?: IDialogConfiguration);' parameters: - id: config description: the dialog configuration that affects how the dialog is displayed \* - type: '' -properties: - - name: domElement - uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' - package: '@microsoft/sp-dialog!' - fullName: domElement + type: + - '@microsoft/sp-dialog!IDialogConfiguration:interface' + optional: true + - uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' + summary: Close the dialog. + remarks: >- + This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to + avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. + name: close() + fullName: close() + langs: + - typeScript + type: method + syntax: + content: 'close(): Promise;' + return: + type: + - '@microsoft/sp-dialog!BaseDialog#close~0:complex' + description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' + - uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' summary: Use this property to access the container element provided by the framework for rendering. remarks: >- See [BaseDialog.render()](xref:@microsoft/sp-dialog!BaseDialog%23render:member(1)) for more information on rendering. - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'protected get domElement(): HTMLElement;' return: - type: HTMLElement - - name: isHidden - uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' - package: '@microsoft/sp-dialog!' - fullName: isHidden + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-dialog!BaseDialog#isHidden:member' summary: If the dialog is visually hidden. remarks: >- This happens when the dialog goes behind a secondary dialog. Note that this is different from closed, because the dialog still has the permission to show and will eventually unhide. This returns false if the dialog is closed. - - isPreview: false - isDeprecated: false + name: isHidden + fullName: isHidden + langs: + - typeScript + type: property syntax: content: 'get isHidden(): boolean;' return: - type: boolean - - name: isOpen - uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' - package: '@microsoft/sp-dialog!' - fullName: isOpen + type: + - boolean + - uid: '@microsoft/sp-dialog!BaseDialog#isOpen:member' summary: >- If the dialog is visually open. This returns true during onBeforeOpen() because there is a visual component. It returns false when the dialog is hidden. - remarks: '' - - isPreview: false - isDeprecated: false + name: isOpen + fullName: isOpen + langs: + - typeScript + type: property syntax: content: 'get isOpen(): boolean;' return: - type: boolean - - name: isSecondary - uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' - package: '@microsoft/sp-dialog!' - fullName: isSecondary + type: + - boolean + - uid: '@microsoft/sp-dialog!BaseDialog#isSecondary:member' summary: If the dialog is a secondary dialog. This means that there is another dialog hidden behind this dialog. - remarks: '' - - isPreview: false - isDeprecated: false + name: isSecondary + fullName: isSecondary + langs: + - typeScript + type: property syntax: content: 'get isSecondary(): boolean;' return: - type: boolean - - name: secondaryDialogProvider - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' - package: '@microsoft/sp-dialog!' - fullName: secondaryDialogProvider - summary: >- - An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs - are permitted. - remarks: >- - Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show - a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a - secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. - - isPreview: false - isDeprecated: false - syntax: - content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' - return: - type: ' | undefined' -methods: - - name: close() - uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' - package: '@microsoft/sp-dialog!' - fullName: close() - summary: Close the dialog. - remarks: >- - This will void the permission to show for this dialog. Every dialog should have a mechanism to eventually close to - avoid blocking the user interface. If called on an inactive dialog it will abort the request to show. - - isPreview: false - isDeprecated: false - syntax: - content: 'close(): Promise;' - return: - type: Promise<void> - description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' - - name: onAfterClose() - uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' - package: '@microsoft/sp-dialog!' - fullName: onAfterClose() + type: + - boolean + - uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' summary: This method is called after the dialog is visually closed and gives an opportunity for doing clean up. remarks: >- The dialog lifecycle completes after closing and there should be no resources left inside the object. Even though the dialog may be revived again for a new lifecycle using show() method, this is considered a whole new lifecycle that should reallocate its own resources. If there are any resources that you would like to keep for multiple lifecycles, consider allocating it outside the dialog object and passing its reference to the dialog constructor. - - isPreview: false - isDeprecated: false + name: onAfterClose() + fullName: onAfterClose() + langs: + - typeScript + type: method syntax: content: 'protected onAfterClose(): void;' return: - type: void + type: + - void description: '' - - name: onBeforeOpen() - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' - package: '@microsoft/sp-dialog!' - fullName: onBeforeOpen() + - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen:member(1)' summary: >- This method is called before the render method and can be overridden to make preparations for rendering. The loading indicator is displayed during the lifetime of this method. virtual remarks: All resource allocations in onBeforeOpen() should be properly disposed in `onAfterClose()` to a avoid memory leak. - - isPreview: false - isDeprecated: false + name: onBeforeOpen() + fullName: onBeforeOpen() + langs: + - typeScript + type: method syntax: content: 'protected onBeforeOpen(): Promise;' return: - type: Promise<void> + type: + - '@microsoft/sp-dialog!BaseDialog#onBeforeOpen~0:complex' description: >- A promise that resolves when the operations are done and the dialog is ready to render. If the promise is rejected, the dialog will not be rendered and `onAfterClose()` will not be called. - - name: render() - uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' - package: '@microsoft/sp-dialog!' - fullName: render() + - uid: '@microsoft/sp-dialog!BaseDialog#render:member(1)' summary: Renders the contents of the dialog. remarks: >- The `render` method must be implemented to render the content of the dialog in the container element provided by @@ -203,33 +191,98 @@ methods: you choose to do your initialization or other costly operations inside render method, make sure to have a friendly UI so the user is informed about the state of your dialog. Otherwise, an empty element is shown to the user which is a bad user experience practice. - - isPreview: false - isDeprecated: false + name: render() + fullName: render() + langs: + - typeScript + type: method syntax: content: 'protected abstract render(): void;' return: - type: void + type: + - void description: '' - - name: show(options) - uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' - package: '@microsoft/sp-dialog!' - fullName: show(options) + - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider:member' + summary: >- + An active dialog is permitted to show a secondary dialog on top of itself. By design, only two layers of dialogs + are permitted. + remarks: >- + Secondary dialogs do not have to wait for permission and will immediately be shown or rejected. All calls to show + a secondary dialog reject while there is already a secondary dialog showing. This property may be undefined if a + secondary dialog is not available i.e. the current dialog is secondary itself or the dialog is not active. + name: secondaryDialogProvider + fullName: secondaryDialogProvider + langs: + - typeScript + type: property + syntax: + content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' + return: + type: + - '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider~0:complex' + - uid: '@microsoft/sp-dialog!BaseDialog#show:member(1)' summary: Request the framework to show this dialog. - remarks: '' - - isPreview: false - isDeprecated: false + name: show(options) + fullName: show(options) + langs: + - typeScript + type: method syntax: content: 'show(options?: IDialogShowOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!BaseDialog#show~0:complex' + description: >- + A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the + request is rejected or aborted. parameters: - id: options description: >- Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' - return: - type: Promise<void> - description: >- - A promise that resolves once the dialog is successfully closed (after being shown). The promise rejects if the - request is rejected or aborted. + type: + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + optional: true +references: + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' + name: IDialogConfiguration + - uid: '@microsoft/sp-dialog!BaseDialog#close~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-dialog!BaseDialog#onBeforeOpen~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!BaseDialog#secondaryDialogProvider~0:complex' + name: ISecondaryDialogProvider | undefined + fullName: ISecondaryDialogProvider | undefined + spec.typeScript: + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' + name: ISecondaryDialogProvider + fullName: ISecondaryDialogProvider + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-dialog!BaseDialog#show~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index 037b859a..0fb30fa6 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -1,19 +1,17 @@ -### YamlMime:TSType -name: Dialog -uid: '@microsoft/sp-dialog!Dialog:class' -package: '@microsoft/sp-dialog!' -fullName: Dialog -summary: A static class for showing stock dialogs such as an alert or prompt. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'alert(message, options)' - uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!Dialog:class' + summary: A static class for showing stock dialogs such as an alert or prompt. + name: Dialog + fullName: Dialog + langs: + - typeScript + type: class package: '@microsoft/sp-dialog!' - fullName: 'alert(message, options)' + children: + - '@microsoft/sp-dialog!Dialog.alert:member(1)' + - '@microsoft/sp-dialog!Dialog.prompt:member(1)' + - uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' summary: >- Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog. @@ -21,25 +19,29 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - - isPreview: false - isDeprecated: false + name: 'alert(message, options)' + fullName: 'alert(message, options)' + langs: + - typeScript + type: method syntax: content: 'static alert(message: string, options?: IAlertOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!Dialog.alert~0:complex' + description: '' parameters: - id: message description: The message to alert - type: string + type: + - string + optional: false - id: options description: '' - type: '' - return: - type: Promise<void> - description: '' - - name: 'prompt(message, options)' - uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'prompt(message, options)' + type: + - '@microsoft/sp-dialog!IAlertOptions:interface' + optional: true + - uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' summary: >- Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog. @@ -47,18 +49,48 @@ methods: There might be a delay until the dialog is approved and shown by the application, for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is successfully shown and closed. The promise rejects if the application rejects the request for any reason. - - isPreview: false - isDeprecated: false + name: 'prompt(message, options)' + fullName: 'prompt(message, options)' + langs: + - typeScript + type: method syntax: content: 'static prompt(message: string, options?: IPromptOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!Dialog.prompt~0:complex' + description: The input string or undefined if the dialog was canceled parameters: - id: message description: The message for prompt dialog - type: string + type: + - string + optional: false - id: options description: '' - type: '' - return: - type: Promise<string | undefined> - description: The input string or undefined if the dialog was canceled + type: + - '@microsoft/sp-dialog!IPromptOptions:interface' + optional: true +references: + - uid: '@microsoft/sp-dialog!Dialog.alert~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' + name: IAlertOptions + - uid: '@microsoft/sp-dialog!Dialog.prompt~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' + name: IPromptOptions diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index f0776d09..b1e708f8 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -1,12 +1,17 @@ -### YamlMime:TSType -name: IAlertOptions -uid: '@microsoft/sp-dialog!IAlertOptions:interface' -package: '@microsoft/sp-dialog!' -fullName: IAlertOptions -summary: Options for showing an alert dialog -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' + summary: Options for showing an alert dialog + name: IAlertOptions + fullName: IAlertOptions + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + inheritance: + - type: '@microsoft/sp-dialog!IDialogShowOptions:interface' + package: '@microsoft/sp-dialog!' +references: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dialog/idialogconfiguration.yml b/SP-Framework/sp-dialog/idialogconfiguration.yml index 506c535c..f5ad498b 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -1,25 +1,24 @@ -### YamlMime:TSType -name: IDialogConfiguration -uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' -package: '@microsoft/sp-dialog!' -fullName: IDialogConfiguration -summary: The interface for dialog configuration -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isBlocking - uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' + summary: The interface for dialog configuration + name: IDialogConfiguration + fullName: IDialogConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-dialog!' - fullName: isBlocking + children: + - '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' + - uid: '@microsoft/sp-dialog!IDialogConfiguration#isBlocking:member' summary: Whether the dialog can be closed by clicking outside the dialog (on the overlay). - remarks: '' - - isPreview: false - isDeprecated: false + name: isBlocking + fullName: isBlocking + langs: + - typeScript + type: property syntax: content: 'isBlocking?: boolean;' return: - type: boolean + type: + - boolean diff --git a/SP-Framework/sp-dialog/idialogshowoptions.yml b/SP-Framework/sp-dialog/idialogshowoptions.yml index c457dc9b..9f9d920b 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -1,19 +1,16 @@ -### YamlMime:TSType -name: IDialogShowOptions -uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' -package: '@microsoft/sp-dialog!' -fullName: IDialogShowOptions -summary: Options for showing a dialog -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: confirmOpen - uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + summary: Options for showing a dialog + name: IDialogShowOptions + fullName: IDialogShowOptions + langs: + - typeScript + type: interface package: '@microsoft/sp-dialog!' - fullName: confirmOpen + children: + - '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' + - uid: '@microsoft/sp-dialog!IDialogShowOptions#confirmOpen:member' summary: A callback that is invoked immediately before the dialog receives focus. remarks: >- Provide this callback if there is a case when you want to abort showing the dialog before it's approved by the @@ -21,10 +18,13 @@ properties: requesting the dialog is disposed and you don't want to show the dialog anymore. It is important to keep this callback lightweight so the framework can resolve it quickly and the user interface does not have to wait a long time for it. - - isPreview: false - isDeprecated: false + name: confirmOpen + fullName: confirmOpen + langs: + - typeScript + type: property syntax: content: 'confirmOpen?: () => boolean;' return: - type: () => boolean + type: + - () => boolean diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index db80e8c2..99101ec1 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -1,26 +1,31 @@ -### YamlMime:TSType -name: IPromptOptions -uid: '@microsoft/sp-dialog!IPromptOptions:interface' -package: '@microsoft/sp-dialog!' -fullName: IPromptOptions -summary: Options for showing a prompt dialog -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: defaultValue - uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' + summary: Options for showing a prompt dialog + name: IPromptOptions + fullName: IPromptOptions + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + inheritance: + - type: '@microsoft/sp-dialog!IDialogShowOptions:interface' package: '@microsoft/sp-dialog!' - fullName: defaultValue + children: + - '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' + - uid: '@microsoft/sp-dialog!IPromptOptions#defaultValue:member' summary: The default value for the input text field of prompt dialog - remarks: '' - - isPreview: false - isDeprecated: false + name: defaultValue + fullName: defaultValue + langs: + - typeScript + type: property syntax: content: 'defaultValue?: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 44923ea8..4f76a2fe 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -1,98 +1,146 @@ -### YamlMime:TSType -name: ISecondaryDialogProvider -uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' -package: '@microsoft/sp-dialog!' -fullName: ISecondaryDialogProvider -summary: >- - This interface handles calls to show a secondary dialog. It's only available by calling this.secondaryManagerProvider - inside a dialog. -remarks: >- - Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has - permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide until - the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to show more - secondary dialogs are rejected. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider:interface' + summary: >- + This interface handles calls to show a secondary dialog. It's only available by calling + this.secondaryManagerProvider inside a dialog. + remarks: >- + Secondary dialogs do not need to request permission from dialog manager, because the primary dialog already has + permission. Therefore, the secondary dialog will be immediately shown. This causes the primary dialog to hide + until the secondary dialog is closed. There can be only one secondary dialog at a time. Additional requests to + show more secondary dialogs are rejected. - See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) for - how to use this. -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'alert(message, options)' - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' + See [BaseDialog.secondaryDialogProvider](xref:@microsoft/sp-dialog!BaseDialog%23secondaryDialogProvider:member) + for how to use this. + name: ISecondaryDialogProvider + fullName: ISecondaryDialogProvider + langs: + - typeScript + type: interface package: '@microsoft/sp-dialog!' - fullName: 'alert(message, options)' + children: + - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' + - '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' + - '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' summary: >- Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'alert(message, options)' + fullName: 'alert(message, options)' + langs: + - typeScript + type: method syntax: content: 'alert(message: string, options?: IAlertOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' + description: '' parameters: - id: message description: '' - type: string + type: + - string + optional: false - id: options description: >- Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' - return: - type: Promise<void> - description: '' - - name: 'prompt(message, options)' - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'prompt(message, options)' + type: + - '@microsoft/sp-dialog!IAlertOptions:interface' + optional: true + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' summary: >- Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'prompt(message, options)' + fullName: 'prompt(message, options)' + langs: + - typeScript + type: method syntax: content: 'prompt(message: string, options?: IPromptOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt~0:complex' + description: '' parameters: - id: message description: '' - type: string + type: + - string + optional: false - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' - return: - type: Promise<string | undefined> - description: '' - - name: 'show(dialog, options)' - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' - package: '@microsoft/sp-dialog!' - fullName: 'show(dialog, options)' + type: + - '@microsoft/sp-dialog!IPromptOptions:interface' + optional: true + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' summary: >- Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog%23show:member(1)). The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'show(dialog, options)' + fullName: 'show(dialog, options)' + langs: + - typeScript + type: method syntax: content: 'show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!ISecondaryDialogProvider#show~0:complex' + description: '' parameters: - id: dialog description: '' - type: '' + type: + - '@microsoft/sp-dialog!default:class' + optional: false - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' - return: - type: Promise<void> - description: '' + type: + - '@microsoft/sp-dialog!IDialogShowOptions:interface' + optional: true +references: + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' + name: IAlertOptions + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' + name: IPromptOptions + - uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dialog!default:class' + name: BaseDialog + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' + name: IDialogShowOptions diff --git a/SP-Framework/sp-dynamic-data.yml b/SP-Framework/sp-dynamic-data.yml index 1721daaa..6de54b03 100644 --- a/SP-Framework/sp-dynamic-data.yml +++ b/SP-Framework/sp-dynamic-data.yml @@ -1,17 +1,44 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-dynamic-data!' -name: '@microsoft/sp-dynamic-data' -type: package -summary: SharePoint Framework support for dynamic data bindings. -classes: - - '@microsoft/sp-dynamic-data!DynamicDataReference:class' -interfaces: - - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' - - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!' + summary: SharePoint Framework support for dynamic data bindings. + remarks: >- + This package provides the necessary infrastructure classes and public APIs necessary to run dynamic data, and + implement components that use it. + name: '@microsoft/sp-dynamic-data' + fullName: '@microsoft/sp-dynamic-data' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-dynamic-data!DynamicDataReference:class' + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' +references: + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' + name: DynamicDataReference + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + name: IDynamicDataCallables + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + name: IDynamicDataEventDefinition + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + name: IDynamicDataPropertyMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + name: IDynamicDataPropertyValueMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + name: IDynamicDataPropertyValueMetadataCollection + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + name: IDynamicDataSource + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + name: IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml index eb51d395..f3fba494 100644 --- a/SP-Framework/sp-dynamic-data/dynamicdatareference.yml +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -1,85 +1,85 @@ -### YamlMime:TSType -name: DynamicDataReference -uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' -package: '@microsoft/sp-dynamic-data!' -fullName: DynamicDataReference -summary: >- - Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) - of Dynamic Data -remarks: |- - The reference string is of the form `:` or `::` +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:class' + summary: >- + Class that contains the Dynamic Data reference. This includes the source, property, and property path (if + applicable) of Dynamic Data + remarks: |- + The reference string is of the form `:` or `::` - Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(reference) - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' + Examples of references are: `WebPart..:myComplexProperty:myArray[0].lastName` + name: DynamicDataReference + fullName: DynamicDataReference + langs: + - typeScript + type: class package: '@microsoft/sp-dynamic-data!' - fullName: (constructor)(reference) + children: + - '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' + - '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' + - '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' + - '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' + - '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference:constructor(1)' summary: Constructs a new instance of the `DynamicDataReference` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(reference) + fullName: (constructor)(reference) + langs: + - typeScript + type: constructor syntax: content: 'constructor(reference: string);' parameters: - id: reference description: '' - type: string -properties: - - name: property - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' - package: '@microsoft/sp-dynamic-data!' - fullName: property + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' summary: Returns the referred property of the Dynamic Data. - remarks: '' - - isPreview: false - isDeprecated: false + name: property + fullName: property + langs: + - typeScript + type: property syntax: content: 'get property(): string;' return: - type: string - - name: propertyPath - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' - package: '@microsoft/sp-dynamic-data!' - fullName: propertyPath + type: + - string + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#propertyPath:member' summary: Returns the referred property path of the Dynamic Data. Returns undefined if there is no property path. - remarks: '' - - isPreview: false - isDeprecated: false + name: propertyPath + fullName: propertyPath + langs: + - typeScript + type: property syntax: content: 'get propertyPath(): string | undefined;' return: - type: string | undefined - - name: reference - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' - package: '@microsoft/sp-dynamic-data!' - fullName: reference + type: + - string | undefined + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#reference:member' summary: Returns the full reference of the Dynamic Data object as a string. - remarks: '' - - isPreview: false - isDeprecated: false + name: reference + fullName: reference + langs: + - typeScript + type: property syntax: content: 'get reference(): string;' return: - type: string - - name: sourceId - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' - package: '@microsoft/sp-dynamic-data!' - fullName: sourceId + type: + - string + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#sourceId:member' summary: Returns the referred id of the Dynamic Data Source. - remarks: '' - - isPreview: false - isDeprecated: false + name: sourceId + fullName: sourceId + langs: + - typeScript + type: property syntax: content: 'get sourceId(): string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index f81c472a..b761577d 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -1,40 +1,42 @@ -### YamlMime:TSType -name: IDynamicDataAnnotatedPropertyValue -uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataAnnotatedPropertyValue -summary: >- - Describes the value and the structure of a property value. It contains sample value of the property and the metadata - describing the structure of that value. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: metadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + summary: >- + Describes the value and the structure of a property value. It contains sample value of the property and the + metadata describing the structure of that value. + name: IDynamicDataAnnotatedPropertyValue + fullName: IDynamicDataAnnotatedPropertyValue + langs: + - typeScript + type: interface package: '@microsoft/sp-dynamic-data!' - fullName: metadata + children: + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member' summary: Metadata describing the sample value of the property. - remarks: '' - - isPreview: false - isDeprecated: false + name: metadata + fullName: metadata + langs: + - typeScript + type: property syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: '' - - name: sampleValue - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' - package: '@microsoft/sp-dynamic-data!' - fullName: sampleValue + type: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' summary: Sample value of a property - remarks: '' - - isPreview: false - isDeprecated: false + name: sampleValue + fullName: sampleValue + langs: + - typeScript + type: property syntax: content: 'sampleValue: any;' return: - type: any + type: + - any +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + name: IDynamicDataPropertyValueMetadataCollection diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 526a4c6d..6a4ca1dc 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -1,111 +1,159 @@ -### YamlMime:TSType -name: IDynamicDataCallables -uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataCallables -summary: >- - Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with - state, or a set of loose functions that returns the data. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -methods: - - name: allowedEvents() - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables:interface' + summary: >- + Interface for components to implement in order to be dynamic data sources. This can be implemented as an object + with state, or a set of loose functions that returns the data. + name: IDynamicDataCallables + fullName: IDynamicDataCallables + langs: + - typeScript + type: interface package: '@microsoft/sp-dynamic-data!' - fullName: allowedEvents() + children: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents:member(1)' summary: |- Returns list of allowed events on the dynamic data source. When this function returns a non-empty result, then source must define 'sendEvent' api. If this api is not defined or returns an empty array, then no consumer will be able to talk to this source. - remarks: '' - isPreview: true - isDeprecated: false + name: allowedEvents() + fullName: allowedEvents() + langs: + - typeScript + type: method syntax: content: 'allowedEvents?(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' description: '' - - name: getAnnotatedPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getAnnotatedPropertyValue(propertyId) + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' summary: >- Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' returns as the sample value and metadata would be undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: getAnnotatedPropertyValue(propertyId) + fullName: getAnnotatedPropertyValue(propertyId) + langs: + - typeScript + type: method syntax: content: 'getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue~0:complex' + description: '' parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. - type: string - return: - type: ' | undefined' - description: '' - - name: getPropertyDefinitions() - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyDefinitions() + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' summary: Returns all the property definitions that the DataSource will provide. - remarks: '' - - isPreview: false - isDeprecated: false + name: getPropertyDefinitions() + fullName: getPropertyDefinitions() + langs: + - typeScript + type: method syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' description: '' - - name: getPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyValue(propertyId) + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' summary: 'Given a property id, returns the value of the property.' remarks: 'It is assumed that when this function returns an array, it is homogeneous.' - - isPreview: false - isDeprecated: false + name: getPropertyValue(propertyId) + fullName: getPropertyValue(propertyId) + langs: + - typeScript + type: method syntax: content: 'getPropertyValue(propertyId: string): any;' + return: + type: + - any + description: '' parameters: - id: propertyId description: '' - type: string - return: - type: any - description: '' - - name: 'sendEvent(eventName, data)' - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: 'sendEvent(eventName, data)' + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' summary: >- If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly. Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. - remarks: '' - isPreview: true - isDeprecated: false + name: 'sendEvent(eventName, data)' + fullName: 'sendEvent(eventName, data)' + langs: + - typeScript + type: method syntax: content: 'sendEvent?(eventName: string, data: any): void;' + return: + type: + - void + description: '' parameters: - id: eventName description: A case-sensitive string representing the name of the event. - type: string + type: + - string + optional: false - id: data description: Data to be sent to the dynamic data source. - type: any - return: - type: void - description: '' + type: + - any + optional: false +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + name: IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue~0:complex' + name: IDynamicDataAnnotatedPropertyValue | undefined + fullName: IDynamicDataAnnotatedPropertyValue | undefined + spec.typeScript: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + fullName: IDynamicDataAnnotatedPropertyValue + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 23349ff8..5ff4f010 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -1,41 +1,43 @@ -### YamlMime:TSType -name: IDynamicDataEventDefinition -uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataEventDefinition -summary: |- - Definition of an event which a dynamic data source accepts. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + summary: |- + Definition of an event which a dynamic data source accepts. - It includes the name of the event and description to be seen and used by end users. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' + It includes the name of the event and description to be seen and used by end users. + isPreview: true + name: IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition + langs: + - typeScript + type: interface package: '@microsoft/sp-dynamic-data!' - fullName: description + children: + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' + - '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' summary: 'User-friendly, localized description of the event.' - remarks: '' - isPreview: true - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: name - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' - package: '@microsoft/sp-dynamic-data!' - fullName: name + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' summary: Event name - remarks: '' - isPreview: true - isDeprecated: false + name: name + fullName: name + langs: + - typeScript + type: property syntax: content: 'name: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index eb901142..3c584110 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -1,30 +1,35 @@ -### YamlMime:TSType -name: IDynamicDataPropertyDefinition -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyDefinition -summary: >- - Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, - localized title and description to be seen and used by end users. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + summary: >- + Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, + localized title and description to be seen and used by end users. + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + inheritance: + - type: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' package: '@microsoft/sp-dynamic-data!' - fullName: id + children: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition#id:member' summary: >- Id of the property. This can only contains letters, numbers, dashes and underscores. Example: "myFiles" or "time\_in\_24-hour\_clock" - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + name: IDynamicDataPropertyMetadata diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml index e6ba2a97..d3c87555 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -1,42 +1,41 @@ -### YamlMime:TSType -name: IDynamicDataPropertyMetadata -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyMetadata -summary: Metadata of a property -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + summary: Metadata of a property + name: IDynamicDataPropertyMetadata + fullName: IDynamicDataPropertyMetadata + langs: + - typeScript + type: interface package: '@microsoft/sp-dynamic-data!' - fullName: description + children: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#description:member' summary: >- User-friendly, localized description of the property. Example: "Contains a list of ids with the files of the current user" - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: title - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' - package: '@microsoft/sp-dynamic-data!' - fullName: title + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata#title:member' summary: >- User-friendly, localized title of the property. Example: "My files" / "Mis archivos" (depending of current language) - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index 2baf4fb8..09a560ac 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -1,26 +1,33 @@ -### YamlMime:TSType -name: IDynamicDataPropertyValueMetadata -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyValueMetadata -summary: Metadata describing the sample value of the property. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: metadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface' + summary: Metadata describing the sample value of the property. + name: IDynamicDataPropertyValueMetadata + fullName: IDynamicDataPropertyValueMetadata + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + inheritance: + - type: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' package: '@microsoft/sp-dynamic-data!' - fullName: metadata + children: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member' summary: Metadata describing the sample value of the property. - remarks: '' - - isPreview: false - isDeprecated: false + name: metadata + fullName: metadata + langs: + - typeScript + type: property syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: '' -extends: '' + type: + - '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface' + name: IDynamicDataPropertyMetadata + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + name: IDynamicDataPropertyValueMetadataCollection diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index 9aa2d027..1772c297 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -1,80 +1,80 @@ -### YamlMime:TSType -name: IDynamicDataPropertyValueMetadataCollection -uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataPropertyValueMetadataCollection -summary: >- - A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the - metadata describing the 'key' and its value. -remarks: >- - Important note: +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface' + summary: >- + A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the + metadata describing the 'key' and its value. + remarks: >- + Important note: - 1. Key in the metadata should match the key in the sample value object. + 1. Key in the metadata should match the key in the sample value object. - 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below example - for more details. + 2. For arrays, metadataCollection would be same as describing the element of the array, only once. See below + example for more details. - For example: + For example: - ``` + ``` - case 1: With simple values - Sample Property Id value - { - firstName: 'Bob', - lastName: 'Smith', - age: 30 - } - - MetadataCollection for the above object would be - - metadataCollection: { - 'firstName': { title: 'First Name' }, - 'lastName': { title: 'Last Name' }, - 'age': { title: 'Age' } - } - - Case 2: With complex values - Sample Property Id value - { - person: { - firstName: 'Bob', - lastName: 'Smith', - age: 30 - }, - visitedLocations: [ - { - city: 'Redmond', - state: 'WA' - }, - { - city: 'New York City', - state: 'NY' + case 1: With simple values + Sample Property Id value - { + firstName: 'Bob', + lastName: 'Smith', + age: 30 } - ] - } - MetadataCollection for the above object would be - - metadataCollection: { - 'person': { - title: 'Person', + MetadataCollection for the above object would be - metadataCollection: { 'firstName': { title: 'First Name' }, 'lastName': { title: 'Last Name' }, 'age': { title: 'Age' } } - }, - 'vistedLocations': { - title: 'Visted Locations', - metadataCollection: { - 'city': { title: 'City' }, - 'state': { title: 'State' } + + Case 2: With complex values + Sample Property Id value - { + person: { + firstName: 'Bob', + lastName: 'Smith', + age: 30 + }, + visitedLocations: [ + { + city: 'Redmond', + state: 'WA' + }, + { + city: 'New York City', + state: 'NY' + } + ] } - } - } - ``` -isPreview: false -isDeprecated: false -type: interface + MetadataCollection for the above object would be - + metadataCollection: { + 'person': { + title: 'Person', + metadataCollection: { + 'firstName': { title: 'First Name' }, + 'lastName': { title: 'Last Name' }, + 'age': { title: 'Age' } + } + }, + 'vistedLocations': { + title: 'Visted Locations', + metadataCollection: { + 'city': { title: 'City' }, + 'state': { title: 'State' } + } + } + } + ``` + name: IDynamicDataPropertyValueMetadataCollection + fullName: IDynamicDataPropertyValueMetadataCollection + langs: + - typeScript + type: interface + package: '@microsoft/sp-dynamic-data!' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index f345518d..435f5685 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -1,205 +1,296 @@ -### YamlMime:TSType -name: IDynamicDataSource -uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataSource -summary: >- - Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to - get the data. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' - package: '@microsoft/sp-dynamic-data!' - fullName: id - summary: Id of the Dynamic Data Source. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'id: string;' - return: - type: string - - name: metadata - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' - package: '@microsoft/sp-dynamic-data!' - fullName: metadata - summary: Metadata of the Dynamic Data Source. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'metadata: IDynamicDataSourceMetadata;' - return: - type: '' -methods: - - name: allowedEventsAsync() - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface' + summary: >- + Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API + to get the data. + name: IDynamicDataSource + fullName: IDynamicDataSource + langs: + - typeScript + type: interface package: '@microsoft/sp-dynamic-data!' - fullName: allowedEventsAsync() + children: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' summary: >- Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source must define 'sendData' api. If this api is not defined or returns an empty map, then no consumer will be able to talk to this source. - remarks: '' - isPreview: true - isDeprecated: false + name: allowedEventsAsync() + fullName: allowedEventsAsync() + langs: + - typeScript + type: method syntax: content: 'allowedEventsAsync?(): Promise>;' return: - type: >- - Promise<ReadonlyArray<>> + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' description: '' - - name: getAnnotatedPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getAnnotatedPropertyValue(propertyId) + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)' summary: >- Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' + deprecated: + content: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`' + name: getAnnotatedPropertyValue(propertyId) + fullName: getAnnotatedPropertyValue(propertyId) + langs: + - typeScript + type: method syntax: content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + description: '' parameters: - id: propertyId description: One of the property ids exposed from the dynamic data source. - type: string - return: - type: '' - description: '' - - name: getAnnotatedPropertyValueAsync(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getAnnotatedPropertyValueAsync(propertyId) + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' summary: >- Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls back to whatever 'getPropertyValue' as the sample value and metadata would be undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: getAnnotatedPropertyValueAsync(propertyId) + fullName: getAnnotatedPropertyValueAsync(propertyId) + langs: + - typeScript + type: method syntax: content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync~0:complex' + description: '' parameters: - id: propertyId description: Property id for which the value is requested. - type: string - return: - type: 'Promise<>' - description: '' - - name: getPropertyDefinitions() - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyDefinitions() + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' summary: >- Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' + deprecated: + content: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`' + name: getPropertyDefinitions() + fullName: getPropertyDefinitions() + langs: + - typeScript + type: method syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' description: '' - - name: getPropertyDefinitionsAsync() - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyDefinitionsAsync() + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' summary: >- Returns all the property definitions for dynamic data. This needs to be overriden by the implementation of the component. - remarks: '' - - isPreview: false - isDeprecated: false + name: getPropertyDefinitionsAsync() + fullName: getPropertyDefinitionsAsync() + langs: + - typeScript + type: method syntax: content: 'getPropertyDefinitionsAsync(): Promise>;' return: - type: >- - Promise<ReadonlyArray<>> + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync~0:complex' description: '' - - name: getPropertyValue(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyValue(propertyId) + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)' summary: >- Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' + deprecated: + content: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`' + name: getPropertyValue(propertyId) + fullName: getPropertyValue(propertyId) + langs: + - typeScript + type: method syntax: content: 'getPropertyValue(propertyId: string): any;' + return: + type: + - any + description: '' parameters: - id: propertyId description: Property id for which the value is requested. - type: string - return: - type: any - description: '' - - name: getPropertyValueAsync(propertyId) - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: getPropertyValueAsync(propertyId) + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)' summary: >- Given a property id, returns the value of the property. This needs to be overriden by the implementation of the component. - remarks: '' - - isPreview: false - isDeprecated: false + name: getPropertyValueAsync(propertyId) + fullName: getPropertyValueAsync(propertyId) + langs: + - typeScript + type: method syntax: content: 'getPropertyValueAsync(propertyId: string): Promise;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync~0:complex' + description: '' parameters: - id: propertyId description: Property id for which the value is requested. - type: string + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member' + summary: Id of the Dynamic Data Source. + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id: string;' return: - type: Promise<any> - description: '' - - name: 'sendEvent(eventName, data)' - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' - package: '@microsoft/sp-dynamic-data!' - fullName: 'sendEvent(eventName, data)' + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member' + summary: Metadata of the Dynamic Data Source. + name: metadata + fullName: metadata + langs: + - typeScript + type: property + syntax: + content: 'metadata: IDynamicDataSourceMetadata;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' summary: >- If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly. Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source. - remarks: '' - isPreview: true - isDeprecated: false + name: 'sendEvent(eventName, data)' + fullName: 'sendEvent(eventName, data)' + langs: + - typeScript + type: method syntax: content: 'sendEvent?(eventName: string, data: any): void;' + return: + type: + - void + description: '' parameters: - id: eventName description: A case-sensitive string representing the name of the event. - type: string + type: + - string + optional: false - id: data description: Data to be sent to the dynamic data source. - type: any - return: - type: void - description: '' + type: + - any + optional: false +references: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' + name: Promise> + fullName: Promise> + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface' + name: IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition + - name: '>>' + fullName: '>>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface' + name: IDynamicDataAnnotatedPropertyValue + fullName: IDynamicDataAnnotatedPropertyValue + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync~0:complex' + name: Promise> + fullName: Promise> + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface' + name: IDynamicDataPropertyDefinition + fullName: IDynamicDataPropertyDefinition + - name: '>>' + fullName: '>>' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + name: IDynamicDataSourceMetadata diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 0db149ad..3aa4bd14 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -1,86 +1,85 @@ -### YamlMime:TSType -name: IDynamicDataSourceMetadata -uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' -package: '@microsoft/sp-dynamic-data!' -fullName: IDynamicDataSourceMetadata -summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: alias - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface' + summary: Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources. + name: IDynamicDataSourceMetadata + fullName: IDynamicDataSourceMetadata + langs: + - typeScript + type: interface package: '@microsoft/sp-dynamic-data!' - fullName: alias + children: + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' + - '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#alias:member' summary: >- Alias of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - remarks: '' - - isPreview: false - isDeprecated: false + name: alias + fullName: alias + langs: + - typeScript + type: property syntax: content: 'alias?: string;' return: - type: string - - name: componentId - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' - package: '@microsoft/sp-dynamic-data!' - fullName: componentId + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#componentId:member' summary: >- Id of the component that the Dynamic Data Source refers to. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - remarks: '' - - isPreview: false - isDeprecated: false + name: componentId + fullName: componentId + langs: + - typeScript + type: property syntax: content: 'componentId?: string;' return: - type: string - - name: description - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' - package: '@microsoft/sp-dynamic-data!' - fullName: description + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' summary: 'User-friendly, localized description of the Dynamic Data Source.' - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: instanceId - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' - package: '@microsoft/sp-dynamic-data!' - fullName: instanceId + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#instanceId:member' summary: >- Id of the instance of the component that the Dynamic Data Source refers to. This allows to distinguish, for example, between two web parts with the same type. It can be undefined when the sources doesn't come from a component, for example framework level data sources. - remarks: '' - - isPreview: false - isDeprecated: false + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property syntax: content: 'instanceId?: string;' return: - type: string - - name: title - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' - package: '@microsoft/sp-dynamic-data!' - fullName: title + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#title:member' summary: >- User-friendly, localized title of the Dynamic Data Source. This can be customized by the component it refers to. By default it's the alias of the component. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index e151167a..95d38cc3 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -1,8 +1,17 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-extension-base!' -name: '@microsoft/sp-extension-base' -type: package -summary: SharePoint Framework support for building client-side extensions. -classes: - - '@microsoft/sp-extension-base!BaseExtension:class' - - '@microsoft/sp-extension-base!ExtensionContext:class' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-extension-base!' + summary: SharePoint Framework support for building client-side extensions. + name: '@microsoft/sp-extension-base' + fullName: '@microsoft/sp-extension-base' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-extension-base!BaseExtension:class' + - '@microsoft/sp-extension-base!ExtensionContext:class' +references: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 16429f5f..5edddc9c 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -1,62 +1,80 @@ -### YamlMime:TSType -name: BaseExtension -uid: '@microsoft/sp-extension-base!BaseExtension:class' -package: '@microsoft/sp-extension-base!' -fullName: BaseExtension -summary: The base class for all client-side extensions. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseExtension` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-extension-base!BaseExtension#context:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + summary: The base class for all client-side extensions. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseExtension` class. + name: BaseExtension + fullName: BaseExtension + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-component-base!BaseComponent:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-extension-base!' - fullName: context + children: + - '@microsoft/sp-extension-base!BaseExtension#context:member' + - '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' + - '@microsoft/sp-extension-base!BaseExtension#properties:member' + - uid: '@microsoft/sp-extension-base!BaseExtension#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'protected readonly context: ExtensionContext;' return: - type: '' - - name: properties - uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' - package: '@microsoft/sp-extension-base!' - fullName: properties + type: + - '@microsoft/sp-extension-base!default:class' + - uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' + summary: This event method is called when the client-side extension is first activated on the page. virtual + name: onInit() + fullName: onInit() + langs: + - typeScript + type: method + syntax: + content: 'protected onInit(): Promise;' + return: + type: + - '@microsoft/sp-extension-base!BaseExtension#onInit~0:complex' + description: '' + - uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' summary: Extension properties is a JavaScript object that are passed in by the application that initializes the extension. remarks: >- Properties can be used in the extension code to define configurable behaviors. The application has control over what properties to provide to an instance of the extension, however the most common way would be to have it stored on the server as JSON and pass it as is to the extension on initialization. - - isPreview: false - isDeprecated: false + name: properties + fullName: properties + langs: + - typeScript + type: property syntax: content: 'protected get properties(): TProperties;' return: - type: TProperties -methods: - - name: onInit() - uid: '@microsoft/sp-extension-base!BaseExtension#onInit:member(1)' - package: '@microsoft/sp-extension-base!' - fullName: onInit() - summary: This event method is called when the client-side extension is first activated on the page. virtual - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected onInit(): Promise;' - return: - type: Promise<void> - description: '' -extends: '' + type: + - TProperties +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-extension-base!default:class' + name: ExtensionContext + - uid: '@microsoft/sp-extension-base!BaseExtension#onInit~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index b2819763..1c7a0a04 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -1,14 +1,20 @@ -### YamlMime:TSType -name: ExtensionContext -uid: '@microsoft/sp-extension-base!ExtensionContext:class' -package: '@microsoft/sp-extension-base!' -fullName: ExtensionContext -summary: The base class for context objects for client-side extensions. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ExtensionContext` class. - -isPreview: false -isDeprecated: false -type: class -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + summary: The base class for context objects for client-side extensions. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ExtensionContext` class. + name: ExtensionContext + fullName: ExtensionContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-component-base!BaseComponentContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-extension-base!' +references: + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext diff --git a/SP-Framework/sp-http.yml b/SP-Framework/sp-http.yml index 5c71328f..729b7fa7 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -1,51 +1,144 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-http!' -name: '@microsoft/sp-http' -type: package -summary: Base communication layer for the SharePoint Framework -classes: - - '@microsoft/sp-http!AadHttpClient:class' - - '@microsoft/sp-http!AadHttpClientConfiguration:class' - - '@microsoft/sp-http!AadHttpClientFactory:class' - - '@microsoft/sp-http!AadHttpClientResponse:class' - - '@microsoft/sp-http!AadTokenProvider:class' - - '@microsoft/sp-http!AadTokenProviderFactory:class' - - '@microsoft/sp-http!BeforeRedirectEventArgs:class' - - '@microsoft/sp-http!DigestCache:class' - - '@microsoft/sp-http!HttpClient:class' - - '@microsoft/sp-http!HttpClientConfiguration:class' - - '@microsoft/sp-http!HttpClientResponse:class' - - '@microsoft/sp-http!MSGraphClient:class' - - '@microsoft/sp-http!MSGraphClientFactory:class' - - '@microsoft/sp-http!MSGraphClientV3:class' - - '@microsoft/sp-http!ODataVersion:class' - - '@microsoft/sp-http!SPHttpClient:class' - - '@microsoft/sp-http!SPHttpClientBatch:class' - - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' - - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' - - '@microsoft/sp-http!SPHttpClientConfiguration:class' - - '@microsoft/sp-http!SPHttpClientResponse:class' - - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' -interfaces: - - '@microsoft/sp-http!GraphRequest:interface' - - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' - - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' - - '@microsoft/sp-http!IAadHttpClientOptions:interface' - - '@microsoft/sp-http!IAadTokenProvider:interface' - - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' - - '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' - - '@microsoft/sp-http!IDigestCache:interface' - - '@microsoft/sp-http!IHttpClientConfiguration:interface' - - '@microsoft/sp-http!IHttpClientConfigurations:interface' - - '@microsoft/sp-http!IHttpClientOptions:interface' - - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' - - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' - - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' - - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' - - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' - - '@microsoft/sp-http!ISPHttpClientOptions:interface' - - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' -enums: - - '@microsoft/sp-http!SPHttpHeader:enum' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!' + summary: Base communication layer for the SharePoint Framework + remarks: >- + This package defines the base communication layer for the SharePoint Framework. For REST calls, it handles + authentication, logging, diagnostics, and batching. It also simplifies requests by adding default headers that + follow the recommended best practices. + name: '@microsoft/sp-http' + fullName: '@microsoft/sp-http' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-http!AadHttpClient:class' + - '@microsoft/sp-http!AadHttpClientConfiguration:class' + - '@microsoft/sp-http!AadHttpClientFactory:class' + - '@microsoft/sp-http!AadHttpClientResponse:class' + - '@microsoft/sp-http!AadTokenProvider:class' + - '@microsoft/sp-http!AadTokenProviderFactory:class' + - '@microsoft/sp-http!BeforeRedirectEventArgs:class' + - '@microsoft/sp-http!DigestCache:class' + - '@microsoft/sp-http!GraphRequest:interface' + - '@microsoft/sp-http!HttpClient:class' + - '@microsoft/sp-http!HttpClientConfiguration:class' + - '@microsoft/sp-http!HttpClientResponse:class' + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - '@microsoft/sp-http!IAadHttpClientOptions:interface' + - '@microsoft/sp-http!IAadTokenProvider:interface' + - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' + - '@microsoft/sp-http!IDigestCache:interface' + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - '@microsoft/sp-http!IHttpClientConfigurations:interface' + - '@microsoft/sp-http!IHttpClientOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + - '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + - '@microsoft/sp-http!MSGraphClient:class' + - '@microsoft/sp-http!MSGraphClientFactory:class' + - '@microsoft/sp-http!MSGraphClientV3:class' + - '@microsoft/sp-http!ODataVersion:class' + - '@microsoft/sp-http!SPHttpClient:class' + - '@microsoft/sp-http!SPHttpClientBatch:class' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + - '@microsoft/sp-http!SPHttpClientConfiguration:class' + - '@microsoft/sp-http!SPHttpClientResponse:class' + - '@microsoft/sp-http!SPHttpHeader:enum' + - '@microsoft/sp-http!TokenAcquisitionEventArgs:class' +references: + - uid: '@microsoft/sp-http!AadHttpClient:class' + name: AadHttpClient + - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' + name: AadHttpClientConfiguration + - uid: '@microsoft/sp-http!AadHttpClientFactory:class' + name: AadHttpClientFactory + - uid: '@microsoft/sp-http!AadHttpClientResponse:class' + name: AadHttpClientResponse + - uid: '@microsoft/sp-http!AadTokenProvider:class' + name: AadTokenProvider + - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + name: AadTokenProviderFactory + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' + name: BeforeRedirectEventArgs + - uid: '@microsoft/sp-http!DigestCache:class' + name: DigestCache + - uid: '@microsoft/sp-http!GraphRequest:interface' + name: GraphRequest + - uid: '@microsoft/sp-http!HttpClient:class' + name: HttpClient + - uid: '@microsoft/sp-http!HttpClientConfiguration:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!HttpClientResponse:class' + name: HttpClientResponse + - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + name: IAadHttpClientConfiguration + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + name: IAadHttpClientConfigurations + - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' + name: IAadHttpClientOptions + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' + name: IAadTokenProvider + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + name: IAadTokenProviderConfiguration + - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' + name: IBeforeRedirectEventArgs + - uid: '@microsoft/sp-http!IDigestCache:interface' + name: IDigestCache + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' + name: IHttpClientConfigurations + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + name: ISPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + name: ISPHttpClientBatchConfigurations + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + name: ISPHttpClientBatchCreationOptions + - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + name: ISPHttpClientBatchOptions + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + name: ISPHttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + name: ISPHttpClientConfigurations + - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' + name: ISPHttpClientOptions + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + name: ITokenAcquisitionEventArgs + - uid: '@microsoft/sp-http!MSGraphClient:class' + name: MSGraphClient + - uid: '@microsoft/sp-http!MSGraphClientFactory:class' + name: MSGraphClientFactory + - uid: '@microsoft/sp-http!MSGraphClientV3:class' + name: MSGraphClientV3 + - uid: '@microsoft/sp-http!ODataVersion:class' + name: ODataVersion + - uid: '@microsoft/sp-http!SPHttpClient:class' + name: SPHttpClient + - uid: '@microsoft/sp-http!SPHttpClientBatch:class' + name: SPHttpClientBatch + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + name: SPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + name: SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' + name: SPHttpClientConfiguration + - uid: '@microsoft/sp-http!SPHttpClientResponse:class' + name: SPHttpClientResponse + - uid: '@microsoft/sp-http!SPHttpHeader:enum' + name: SPHttpHeader + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + name: TokenAcquisitionEventArgs diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml index 6e71a276..902172ab 100644 --- a/SP-Framework/sp-http/aadhttpclient.yml +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -1,140 +1,216 @@ -### YamlMime:TSType -name: AadHttpClient -uid: '@microsoft/sp-http!AadHttpClient:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClient -summary: AadHttpClient is used to perform REST calls against an Azure AD Application. -remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!AadHttpClient:class' + summary: AadHttpClient is used to perform REST calls against an Azure AD Application. + remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. - For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead. - For communicating with Microsoft Graph, use the [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(serviceScope, resourceEndpoint, options)' - uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' + For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class + instead. For communicating with Microsoft Graph, use the + [MSGraphClient](xref:@microsoft/sp-http!MSGraphClient:class) class. + name: AadHttpClient + fullName: AadHttpClient + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: '(constructor)(serviceScope, resourceEndpoint, options)' + children: + - '@microsoft/sp-http!AadHttpClient:constructor(1)' + - '@microsoft/sp-http!AadHttpClient.configurations:member' + - '@microsoft/sp-http!AadHttpClient#fetch:member(1)' + - '@microsoft/sp-http!AadHttpClient#get:member(1)' + - '@microsoft/sp-http!AadHttpClient#post:member(1)' + - uid: '@microsoft/sp-http!AadHttpClient:constructor(1)' summary: Constructs a new instance of the `AadHttpClient` class - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(serviceScope, resourceEndpoint, options)' + fullName: '(constructor)(serviceScope, resourceEndpoint, options)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);' parameters: - id: serviceScope description: The service scope is needed to retrieve some of the class's internal components. - type: '' + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false - id: resourceEndpoint description: '' - type: string + type: + - string + optional: false - id: options description: Configuration options for the request to get an access token. - type: '' -properties: - - name: configurations - uid: '@microsoft/sp-http!AadHttpClient.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations + type: + - '@microsoft/sp-http!IAadHttpClientOptions:interface' + optional: true + - uid: '@microsoft/sp-http!AadHttpClient.configurations:member' summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. - remarks: '' - - isPreview: false - isDeprecated: false + name: configurations + fullName: configurations + langs: + - typeScript + type: property syntax: content: 'static readonly configurations: IAadHttpClientConfigurations;' return: - type: '' -methods: - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' + type: + - '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + - uid: '@microsoft/sp-http!AadHttpClient#fetch:member(1)' summary: Performs a REST service call. remarks: >- Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - - isPreview: false - isDeprecated: false + name: 'fetch(url, configuration, options)' + fullName: 'fetch(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!AadHttpClient#fetch~0:complex' + description: A promise that will return the result. parameters: - id: url description: The endpoint URL that fetch will be called on. - type: string + type: + - string + optional: false - id: configuration description: >- Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: Additional options that affect the request. - type: '' - return: - type: 'Promise<>' - description: A promise that will return the result. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' + type: + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!AadHttpClient#get:member(1)' summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - - isPreview: false - isDeprecated: false + name: 'get(url, configuration, options)' + fullName: 'get(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!AadHttpClient#get~0:complex' + description: A promise that will return the result. parameters: - id: url description: The endpoint URL that fetch will be called on. - type: string + type: + - string + optional: false - id: configuration description: >- Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: Additional options that affect the request. - type: '' - return: - type: 'Promise<>' - description: A promise that will return the result. - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' + type: + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: true + - uid: '@microsoft/sp-http!AadHttpClient#post:member(1)' summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - - isPreview: false - isDeprecated: false + name: 'post(url, configuration, options)' + fullName: 'post(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!AadHttpClient#post~0:complex' + description: A promise that will return the result. parameters: - id: url description: The endpoint URL that fetch will be called on. - type: string + type: + - string + optional: false - id: configuration description: >- Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: Additional options that affect the request. - type: '' - return: - type: 'Promise<>' - description: A promise that will return the result. + type: + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: false +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' + name: IAadHttpClientOptions + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + name: IAadHttpClientConfigurations + - uid: '@microsoft/sp-http!AadHttpClient#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '@microsoft/sp-http!AadHttpClient#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadHttpClient#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/aadhttpclientconfiguration.yml b/SP-Framework/sp-http/aadhttpclientconfiguration.yml index 0217cb90..357c2c98 100644 --- a/SP-Framework/sp-http/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -1,72 +1,83 @@ -### YamlMime:TSType -name: AadHttpClientConfiguration -uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClientConfiguration -summary: Configuration for HttpClient. -remarks: >- - The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the - predefined defaults from HttpClientConfigurations, however switches can also be changed via the - HttpClientConfiguration.overrideWith() method. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!AadHttpClientConfiguration:class' + summary: Configuration for HttpClient. + remarks: >- + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. + name: AadHttpClientConfiguration + fullName: AadHttpClientConfiguration + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' + implements: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' + children: + - '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' + - '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' + - '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!AadHttpClientConfiguration:constructor(1)' summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' parameters: - id: flags description: '' - type: '' + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + optional: false - id: overrideFlags description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' - package: '@microsoft/sp-http!' + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' + name: flags fullName: flags - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected flags: IAadHttpClientConfiguration;' return: - type: '' -methods: - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' + name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- /** @override */ overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' parameters: - id: sourceFlags description: '' - type: '' - return: - type: '' - description: '' -extends: '' + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + optional: false +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + name: IAadHttpClientConfiguration diff --git a/SP-Framework/sp-http/aadhttpclientfactory.yml b/SP-Framework/sp-http/aadhttpclientfactory.yml index 6b60d00f..ef255a16 100644 --- a/SP-Framework/sp-http/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -1,52 +1,80 @@ -### YamlMime:TSType -name: AadHttpClientFactory -uid: '@microsoft/sp-http!AadHttpClientFactory:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClientFactory -summary: >- - Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: - [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AadHttpClientFactory` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: serviceKey - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for AadHttpClientFactory. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getClient(resourceEndpoint) - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!AadHttpClientFactory:class' + summary: >- + Returns a preinitialized version of the AadHttpClient for a given resource url. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient) + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AadHttpClientFactory` class. + name: AadHttpClientFactory + fullName: AadHttpClientFactory + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: getClient(resourceEndpoint) + children: + - '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' + - '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' + - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient:member(1)' summary: >- Returns an instance of the AadHttpClient that communicates with the current tenant's configurable Service Principal. - remarks: '' - - isPreview: false - isDeprecated: false + name: getClient(resourceEndpoint) + fullName: getClient(resourceEndpoint) + langs: + - typeScript + type: method syntax: content: 'getClient(resourceEndpoint: string): Promise;' + return: + type: + - '@microsoft/sp-http!AadHttpClientFactory#getClient~0:complex' + description: '' parameters: - id: resourceEndpoint description: The target AAD application's resource endpoint. - type: string + type: + - string + optional: false + - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey:member' + summary: The service key for AadHttpClientFactory. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' return: - type: 'Promise<>' - description: '' + type: + - '@microsoft/sp-http!AadHttpClientFactory.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!AadHttpClientFactory#getClient~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClient + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadHttpClientFactory.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClientFactory + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/aadhttpclientresponse.yml b/SP-Framework/sp-http/aadhttpclientresponse.yml index 997a3597..530bcb47 100644 --- a/SP-Framework/sp-http/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -1,33 +1,43 @@ -### YamlMime:TSType -name: AadHttpClientResponse -uid: '@microsoft/sp-http!AadHttpClientResponse:class' -package: '@microsoft/sp-http!' -fullName: AadHttpClientResponse -summary: >- - The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends - HttpClientResponse adding additional functionality specific to the AadHttpClient. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(response, tokenFetchRequestTime)' - uid: '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!AadHttpClientResponse:class' + summary: >- + The Response subclass returned by methods such as `AadHttpClient.fetch()`. Class that extends + HttpClientResponse adding additional functionality specific to the AadHttpClient. + name: AadHttpClientResponse + fullName: AadHttpClientResponse + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' package: '@microsoft/sp-http!' - fullName: '(constructor)(response, tokenFetchRequestTime)' + children: + - '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' + - uid: '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' summary: Constructs a new instance of the `AadHttpClientResponse` class - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(response, tokenFetchRequestTime)' + fullName: '(constructor)(response, tokenFetchRequestTime)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(response: Response, tokenFetchRequestTime: number);' parameters: - id: response description: '' - type: Response + type: + - '!Response:interface' + optional: false - id: tokenFetchRequestTime description: '' - type: number -extends: '' + type: + - number + optional: false +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + - uid: '!Response:interface' + name: Response diff --git a/SP-Framework/sp-http/aadtokenprovider.yml b/SP-Framework/sp-http/aadtokenprovider.yml index 7f2be121..c4f839ed 100644 --- a/SP-Framework/sp-http/aadtokenprovider.yml +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -1,79 +1,120 @@ -### YamlMime:TSType -name: AadTokenProvider -uid: '@microsoft/sp-http!AadTokenProvider:class' -package: '@microsoft/sp-http!' -fullName: AadTokenProvider -summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!AadTokenProvider:class' + summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. -remarks: >- - This class is marked as `@sealed`. Subclasses should not extend it. + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. + remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `AadTokenProvider` class. - -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'getToken(resourceEndpoint, useCachedToken)' - uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `AadTokenProvider` class. + name: AadTokenProvider + fullName: AadTokenProvider + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-http!IInternalAadTokenProvider:interface' package: '@microsoft/sp-http!' - fullName: 'getToken(resourceEndpoint, useCachedToken)' + children: + - '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' + - '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' + - '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' + - uid: '@microsoft/sp-http!AadTokenProvider#getToken:member(1)' summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. The OAuth2 token should not be cached by the caller since it is already cached by the method itself. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'getToken(resourceEndpoint, useCachedToken)' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + langs: + - typeScript + type: method syntax: content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' + return: + type: + - '@microsoft/sp-http!AadTokenProvider#getToken~0:complex' + description: A promise that will be fullfiled with the token or that will reject with an error message parameters: - id: resourceEndpoint description: the resource for which the token should be obtained - type: string + type: + - string + optional: false - id: useCachedToken description: >- Allows the developer to specify if cached tokens should be returned. An example of a resourceEndpoint would be https://graph.microsoft.com - type: boolean - return: - type: Promise<string> - description: A promise that will be fullfiled with the token or that will reject with an error message -events: - - name: onBeforeRedirectEvent - uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' - package: '@microsoft/sp-http!' - fullName: onBeforeRedirectEvent + type: + - boolean + optional: true + - uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' summary: Notifies the developer before a full page redirect occurs. - remarks: '' - - isPreview: false - isDeprecated: false + name: onBeforeRedirectEvent + fullName: onBeforeRedirectEvent + langs: + - typeScript + type: event syntax: content: 'readonly onBeforeRedirectEvent: SPEvent;' return: - type: >- - <> - - name: tokenAcquisitionEvent - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' - package: '@microsoft/sp-http!' - fullName: tokenAcquisitionEvent + type: + - '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent~0:complex' + - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent:member' summary: Notifies the developer when Token Acquisition requires user action. - remarks: '' - - isPreview: false - isDeprecated: false + name: tokenAcquisitionEvent + fullName: tokenAcquisitionEvent + langs: + - typeScript + type: event syntax: content: 'get tokenAcquisitionEvent(): SPEvent;' return: - type: >- - <> + type: + - '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent~0:complex' +references: + - uid: '@microsoft/sp-http!IInternalAadTokenProvider:interface' + name: IInternalAadTokenProvider + - uid: '@microsoft/sp-http!AadTokenProvider#getToken~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' + name: BeforeRedirectEventArgs + fullName: BeforeRedirectEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadTokenProvider#tokenAcquisitionEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + name: TokenAcquisitionEventArgs + fullName: TokenAcquisitionEventArgs + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/aadtokenproviderfactory.yml b/SP-Framework/sp-http/aadtokenproviderfactory.yml index 82e5a24b..9b9dce4c 100644 --- a/SP-Framework/sp-http/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -1,44 +1,69 @@ -### YamlMime:TSType -name: AadTokenProviderFactory -uid: '@microsoft/sp-http!AadTokenProviderFactory:class' -package: '@microsoft/sp-http!' -fullName: AadTokenProviderFactory -summary: Returns a preinitialized version of the AadTokenProviderFactory. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: serviceKey - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!AadTokenProviderFactory:class' + summary: Returns a preinitialized version of the AadTokenProviderFactory. + name: AadTokenProviderFactory + fullName: AadTokenProviderFactory + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for AadTokenProviderFactory. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getTokenProvider() - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' - package: '@microsoft/sp-http!' - fullName: getTokenProvider() + children: + - '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' + - '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' + - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider:member(1)' summary: >- Returns an instance of the AadTokenProvider that communicates with the current tenant's configurable Service Principal. - remarks: '' - - isPreview: false - isDeprecated: false + name: getTokenProvider() + fullName: getTokenProvider() + langs: + - typeScript + type: method syntax: content: 'getTokenProvider(): Promise;' return: - type: 'Promise<>' + type: + - '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider~0:complex' description: '' + - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member' + summary: The service key for AadTokenProviderFactory. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' + return: + type: + - '@microsoft/sp-http!AadTokenProviderFactory.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!AadTokenProviderFactory#getTokenProvider~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadTokenProvider + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!AadTokenProviderFactory.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: AadTokenProviderFactory + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/beforeredirecteventargs.yml b/SP-Framework/sp-http/beforeredirecteventargs.yml index 0ba7695c..2a31e3bb 100644 --- a/SP-Framework/sp-http/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -1,58 +1,65 @@ -### YamlMime:TSType -name: BeforeRedirectEventArgs -uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' -package: '@microsoft/sp-http!' -fullName: BeforeRedirectEventArgs -summary: Arguments for before redirecting for a full page authentication -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(redirectUrl, cancel)' - uid: '@microsoft/sp-http!BeforeRedirectEventArgs:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs:class' + summary: Arguments for before redirecting for a full page authentication + name: BeforeRedirectEventArgs + fullName: BeforeRedirectEventArgs + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-http!' - fullName: '(constructor)(redirectUrl, cancel)' + children: + - '@microsoft/sp-http!BeforeRedirectEventArgs:constructor(1)' + - '@microsoft/sp-http!BeforeRedirectEventArgs#cancel:member' + - '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs:constructor(1)' summary: Constructs a new instance of the `BeforeRedirectEventArgs` class - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(redirectUrl, cancel)' + fullName: '(constructor)(redirectUrl, cancel)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(redirectUrl: string, cancel: () => void);' parameters: - id: redirectUrl description: '' - type: string + type: + - string + optional: false - id: cancel description: '' - type: () => void -properties: - - name: cancel - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#cancel:member' - package: '@microsoft/sp-http!' - fullName: cancel + type: + - () => void + optional: false + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#cancel:member' summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. - remarks: '' - - isPreview: false - isDeprecated: false + name: cancel + fullName: cancel + langs: + - typeScript + type: property syntax: content: 'cancel: () => void;' return: - type: () => void - - name: redirectUrl - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl + type: + - () => void + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' summary: The url of the page to redirect to if automatic redirect is cancelled - remarks: '' - - isPreview: false - isDeprecated: false + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property syntax: content: 'redirectUrl: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs diff --git a/SP-Framework/sp-http/digestcache.yml b/SP-Framework/sp-http/digestcache.yml index 43ac3d4e..7ab05dd3 100644 --- a/SP-Framework/sp-http/digestcache.yml +++ b/SP-Framework/sp-http/digestcache.yml @@ -1,139 +1,175 @@ -### YamlMime:TSType -name: DigestCache -uid: '@microsoft/sp-http!DigestCache:class' -package: '@microsoft/sp-http!' -fullName: DigestCache -summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A - request digest is a security token that the SharePoint server requires for for any REST write operation, specified via - the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after - a server configurable amount of time. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!DigestCache:class' + summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb + URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, + specified via the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, + and expires after a server configurable amount of time. - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-http!DigestCache:constructor(1)' + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + name: DigestCache + fullName: DigestCache + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-http!IDigestCache:interface' package: '@microsoft/sp-http!' - fullName: (constructor)(serviceScope) + children: + - '@microsoft/sp-http!DigestCache:constructor(1)' + - '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' + - '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' + - '@microsoft/sp-http!DigestCache#clearDigest:member(1)' + - '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' + - '@microsoft/sp-http!DigestCache.serviceKey:member' + - uid: '@microsoft/sp-http!DigestCache:constructor(1)' summary: Constructs a new instance of the `DigestCache` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: '' -properties: - - name: serviceKey - uid: '@microsoft/sp-http!DigestCache.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for IDigestCache. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' - package: '@microsoft/sp-http!' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - uid: '@microsoft/sp-http!DigestCache#addDigestToCache:member(1)' summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + langs: + - typeScript + type: method syntax: content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' + return: + type: + - void + description: '' parameters: - id: webUrl description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string + type: + - string + optional: false - id: digestValue description: >- The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" - type: string + type: + - string + optional: false - id: expirationTimestamp description: >- A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration "5 seconds from right now", use performance.now()+5000. - type: number - return: - type: void - description: '' - - name: clearAllDigests() - uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' - package: '@microsoft/sp-http!' - fullName: clearAllDigests() + type: + - number + optional: false + - uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' summary: Clears all values from the cache. - remarks: '' - - isPreview: false - isDeprecated: false + name: clearAllDigests() + fullName: clearAllDigests() + langs: + - typeScript + type: method syntax: content: 'clearAllDigests(): void;' return: - type: void + type: + - void description: '' - - name: clearDigest(webUrl) - uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: clearDigest(webUrl) + - uid: '@microsoft/sp-http!DigestCache#clearDigest:member(1)' summary: >- Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. - remarks: '' - - isPreview: false - isDeprecated: false + name: clearDigest(webUrl) + fullName: clearDigest(webUrl) + langs: + - typeScript + type: method syntax: content: 'clearDigest(webUrl: string): boolean;' + return: + type: + - boolean + description: Returns true if a cache entry was found and deleted; false otherwise. parameters: - id: webUrl description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. - type: string - return: - type: boolean - description: Returns true if a cache entry was found and deleted; false otherwise. - - name: fetchDigest(webUrl) - uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: fetchDigest(webUrl) + type: + - string + optional: false + - uid: '@microsoft/sp-http!DigestCache#fetchDigest:member(1)' summary: >- Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. - remarks: '' - - isPreview: false - isDeprecated: false + name: fetchDigest(webUrl) + fullName: fetchDigest(webUrl) + langs: + - typeScript + type: method syntax: content: 'fetchDigest(webUrl: string): Promise;' + return: + type: + - '@microsoft/sp-http!DigestCache#fetchDigest~0:complex' + description: A promise that is fulfilled with the digest value. parameters: - id: webUrl description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string + type: + - string + optional: false + - uid: '@microsoft/sp-http!DigestCache.serviceKey:member' + summary: The service key for IDigestCache. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' return: - type: Promise<string> - description: A promise that is fulfilled with the digest value. + type: + - '@microsoft/sp-http!DigestCache.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!IDigestCache:interface' + name: IDigestCache + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!DigestCache#fetchDigest~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!DigestCache.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!IDigestCache:interface' + name: IDigestCache + fullName: IDigestCache + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml index 78ca70c2..8496e2c0 100644 --- a/SP-Framework/sp-http/graphrequest.yml +++ b/SP-Framework/sp-http/graphrequest.yml @@ -1,573 +1,688 @@ -### YamlMime:TSType -name: GraphRequest -uid: '@microsoft/sp-http!GraphRequest:interface' -package: '@microsoft/sp-http!' -fullName: GraphRequest -summary: >- - Typings for the GraphRequest Object For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: _headers - uid: '@microsoft/sp-http!GraphRequest#_headers:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!GraphRequest:interface' + summary: >- + Typings for the GraphRequest Object For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + name: GraphRequest + fullName: GraphRequest + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' + children: + - '@microsoft/sp-http!GraphRequest#_headers:member' + - '@microsoft/sp-http!GraphRequest#_responseType:member' + - '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' + - '@microsoft/sp-http!GraphRequest#config:member' + - '@microsoft/sp-http!GraphRequest#constructor:member(1)' + - '@microsoft/sp-http!GraphRequest#count:member(1)' + - '@microsoft/sp-http!GraphRequest#create:member(1)' + - '@microsoft/sp-http!GraphRequest#del:member(1)' + - '@microsoft/sp-http!GraphRequest#delete:member(1)' + - '@microsoft/sp-http!GraphRequest#expand:member(1)' + - '@microsoft/sp-http!GraphRequest#filter:member(1)' + - '@microsoft/sp-http!GraphRequest#get:member(1)' + - '@microsoft/sp-http!GraphRequest#getStream:member(1)' + - '@microsoft/sp-http!GraphRequest#header:member(1)' + - '@microsoft/sp-http!GraphRequest#headers:member(1)' + - '@microsoft/sp-http!GraphRequest#orderby:member(1)' + - '@microsoft/sp-http!GraphRequest#parsePath:member(1)' + - '@microsoft/sp-http!GraphRequest#patch:member(1)' + - '@microsoft/sp-http!GraphRequest#post:member(1)' + - '@microsoft/sp-http!GraphRequest#put:member(1)' + - '@microsoft/sp-http!GraphRequest#putStream:member(1)' + - '@microsoft/sp-http!GraphRequest#query:member(1)' + - '@microsoft/sp-http!GraphRequest#responseType:member(1)' + - '@microsoft/sp-http!GraphRequest#select:member(1)' + - '@microsoft/sp-http!GraphRequest#skip:member(1)' + - '@microsoft/sp-http!GraphRequest#skipToken:member(1)' + - '@microsoft/sp-http!GraphRequest#top:member(1)' + - '@microsoft/sp-http!GraphRequest#update:member(1)' + - '@microsoft/sp-http!GraphRequest#urlComponents:member' + - '@microsoft/sp-http!GraphRequest#version:member(1)' + - uid: '@microsoft/sp-http!GraphRequest#_headers:member' + name: _headers fullName: _headers - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: |- _headers: { [key: string]: string | number; }; return: - type: |- - { - [key: string]: string | number; - } - - name: _responseType - uid: '@microsoft/sp-http!GraphRequest#_responseType:member' - package: '@microsoft/sp-http!' + type: + - |- + { + [key: string]: string | number; + } + - uid: '@microsoft/sp-http!GraphRequest#_responseType:member' + name: _responseType fullName: _responseType - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: '_responseType: string;' return: - type: string - - name: config - uid: '@microsoft/sp-http!GraphRequest#config:member' - package: '@microsoft/sp-http!' - fullName: config - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'config: Options;' - return: - type: '' - - name: urlComponents - uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' - package: '@microsoft/sp-http!' - fullName: urlComponents - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'urlComponents: URLComponents;' - return: - type: '' -methods: - - name: buildFullUrl() - uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' - package: '@microsoft/sp-http!' + type: + - string + - uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' + name: buildFullUrl() fullName: buildFullUrl() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'buildFullUrl(): string;' return: - type: string + type: + - string description: '' - - name: 'constructor(config, path)' - uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' - package: '@microsoft/sp-http!' + - uid: '@microsoft/sp-http!GraphRequest#config:member' + name: config + fullName: config + langs: + - typeScript + type: property + syntax: + content: 'config: Options;' + return: + type: + - '@microsoft/microsoft-graph-client!Options:interface' + - uid: '@microsoft/sp-http!GraphRequest#constructor:member(1)' + name: 'constructor(config, path)' fullName: 'constructor(config, path)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'constructor(config: Options, path: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: config description: '' - type: '' + type: + - '@microsoft/microsoft-graph-client!Options:interface' + optional: false - id: path description: '' - type: string - return: - type: '' - description: '' - - name: count(count) - uid: '@microsoft/sp-http!GraphRequest#count:member(1)' - package: '@microsoft/sp-http!' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#count:member(1)' + name: count(count) fullName: count(count) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'count(count: boolean): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: count description: '' - type: boolean - return: - type: '' - description: '' - - name: 'create(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#create:member(1)' - package: '@microsoft/sp-http!' + type: + - boolean + optional: false + - uid: '@microsoft/sp-http!GraphRequest#create:member(1)' + name: 'create(content, callback)' fullName: 'create(content, callback)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'create(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#create~0:complex' + description: '' parameters: - id: content description: '' - type: any + type: + - any + optional: false - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: del(callback) - uid: '@microsoft/sp-http!GraphRequest#del:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#del:member(1)' + name: del(callback) fullName: del(callback) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'del(callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#del~0:complex' + description: '' parameters: - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: delete(callback) - uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' + name: delete(callback) fullName: delete(callback) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'delete(callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#delete~0:complex' + description: '' parameters: - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: expand(properties) - uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' + name: expand(properties) fullName: expand(properties) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'expand(properties: string | string[]): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: properties description: '' - type: 'string | string[]' - return: - type: '' - description: '' - - name: filter(filterStr) - uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' - package: '@microsoft/sp-http!' + type: + - 'string | string[]' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' + name: filter(filterStr) fullName: filter(filterStr) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'filter(filterStr: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: filterStr description: '' - type: string - return: - type: '' - description: '' - - name: get(callback) - uid: '@microsoft/sp-http!GraphRequest#get:member(1)' - package: '@microsoft/sp-http!' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#get:member(1)' + name: get(callback) fullName: get(callback) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'get(callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#get~0:complex' + description: '' parameters: - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: getStream(callback) - uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' + name: getStream(callback) fullName: getStream(callback) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'getStream(callback: GraphRequestCallback): void;' + return: + type: + - void + description: '' parameters: - id: callback description: '' - type: '' - return: - type: void - description: '' - - name: 'header(headerKey, headerValue)' - uid: '@microsoft/sp-http!GraphRequest#header:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#header:member(1)' + name: 'header(headerKey, headerValue)' fullName: 'header(headerKey, headerValue)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'header(headerKey: string, headerValue: string): this;' + return: + type: + - this + description: '' parameters: - id: headerKey description: '' - type: string + type: + - string + optional: false - id: headerValue description: '' - type: string - return: - type: this - description: '' - - name: headers(headers) - uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' - package: '@microsoft/sp-http!' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' + name: headers(headers) fullName: headers(headers) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- headers(headers: { [key: string]: string | number; }): this; + return: + type: + - this + description: '' parameters: - id: headers description: '' - type: |- - { - [key: string]: string | number; - } - return: - type: this - description: '' - - name: orderby(properties) - uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' - package: '@microsoft/sp-http!' + type: + - |- + { + [key: string]: string | number; + } + optional: false + - uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' + name: orderby(properties) fullName: orderby(properties) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'orderby(properties: string | string[]): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: properties description: '' - type: 'string | string[]' - return: - type: '' - description: '' - - name: parsePath(rawPath) - uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' - package: '@microsoft/sp-http!' + type: + - 'string | string[]' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' + name: parsePath(rawPath) fullName: parsePath(rawPath) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'parsePath(rawPath: string): void;' + return: + type: + - void + description: '' parameters: - id: rawPath description: '' - type: string - return: - type: void - description: '' - - name: 'patch(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' - package: '@microsoft/sp-http!' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' + name: 'patch(content, callback)' fullName: 'patch(content, callback)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'patch(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#patch~0:complex' + description: '' parameters: - id: content description: '' - type: any + type: + - any + optional: false - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: 'post(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#post:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#post:member(1)' + name: 'post(content, callback)' fullName: 'post(content, callback)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'post(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#post~0:complex' + description: '' parameters: - id: content description: '' - type: any + type: + - any + optional: false - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: 'put(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#put:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#put:member(1)' + name: 'put(content, callback)' fullName: 'put(content, callback)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'put(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#put~0:complex' + description: '' parameters: - id: content description: '' - type: any + type: + - any + optional: false - id: callback description: '' - type: '' - return: - type: Promise<any> - description: '' - - name: 'putStream(stream, callback)' - uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#putStream:member(1)' + name: 'putStream(stream, callback)' fullName: 'putStream(stream, callback)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'putStream(stream: any, callback: GraphRequestCallback): void;' + return: + type: + - void + description: '' parameters: - id: stream description: '' - type: any + type: + - any + optional: false - id: callback description: '' - type: '' - return: - type: void - description: '' - - name: query(queryDictionaryOrString) - uid: '@microsoft/sp-http!GraphRequest#query:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#query:member(1)' + name: query(queryDictionaryOrString) fullName: query(queryDictionaryOrString) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- query(queryDictionaryOrString: string | { [key: string]: string | number; }): IGraphRequest; + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: queryDictionaryOrString description: '' - type: |- - string | { - [key: string]: string | number; - } - return: - type: '' - description: '' - - name: responseType(responseType) - uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' - package: '@microsoft/sp-http!' + type: + - |- + string | { + [key: string]: string | number; + } + optional: false + - uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' + name: responseType(responseType) fullName: responseType(responseType) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'responseType(responseType: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: responseType description: '' - type: string - return: - type: '' - description: '' - - name: select(properties) - uid: '@microsoft/sp-http!GraphRequest#select:member(1)' - package: '@microsoft/sp-http!' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#select:member(1)' + name: select(properties) fullName: select(properties) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'select(properties: string | string[]): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: properties description: '' - type: 'string | string[]' - return: - type: '' - description: '' - - name: skip(n) - uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' - package: '@microsoft/sp-http!' + type: + - 'string | string[]' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' + name: skip(n) fullName: skip(n) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'skip(n: number): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: 'n' description: '' - type: number - return: - type: '' - description: '' - - name: skipToken(token) - uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' - package: '@microsoft/sp-http!' + type: + - number + optional: false + - uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' + name: skipToken(token) fullName: skipToken(token) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'skipToken(token: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: token description: '' - type: string - return: - type: '' - description: '' - - name: top(n) - uid: '@microsoft/sp-http!GraphRequest#top:member(1)' - package: '@microsoft/sp-http!' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#top:member(1)' + name: top(n) fullName: top(n) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'top(n: number): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: 'n' description: '' - type: number - return: - type: '' - description: '' - - name: 'update(content, callback)' - uid: '@microsoft/sp-http!GraphRequest#update:member(1)' - package: '@microsoft/sp-http!' + type: + - number + optional: false + - uid: '@microsoft/sp-http!GraphRequest#update:member(1)' + name: 'update(content, callback)' fullName: 'update(content, callback)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'update(content: any, callback?: GraphRequestCallback): Promise;' + return: + type: + - '@microsoft/sp-http!GraphRequest#update~0:complex' + description: '' parameters: - id: content description: '' - type: any + type: + - any + optional: false - id: callback description: '' - type: '' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#urlComponents:member' + name: urlComponents + fullName: urlComponents + langs: + - typeScript + type: property + syntax: + content: 'urlComponents: URLComponents;' return: - type: Promise<any> - description: '' - - name: version(v) - uid: '@microsoft/sp-http!GraphRequest#version:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/microsoft-graph-client!URLComponents:interface' + - uid: '@microsoft/sp-http!GraphRequest#version:member(1)' + name: version(v) fullName: version(v) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'version(v: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: v description: '' - type: string - return: - type: '' - description: '' + type: + - string + optional: false +references: + - uid: '@microsoft/microsoft-graph-client!Options:interface' + name: Options + - uid: '@microsoft/sp-http!IGraphRequest:interface' + name: IGraphRequest + - uid: '@microsoft/sp-http!GraphRequest#create~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + name: GraphRequestCallback + - uid: '@microsoft/sp-http!GraphRequest#del~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#delete~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#patch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#put~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!GraphRequest#update~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/microsoft-graph-client!URLComponents:interface' + name: URLComponents diff --git a/SP-Framework/sp-http/httpclient.yml b/SP-Framework/sp-http/httpclient.yml index b8694933..7b85eeca 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -1,156 +1,239 @@ -### YamlMime:TSType -name: HttpClient -uid: '@microsoft/sp-http!HttpClient:class' -package: '@microsoft/sp-http!' -fullName: HttpClient -summary: HttpClient implements a basic set of features for performing REST operations against a generic service. -remarks: 'For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class instead.' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-http!HttpClient:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!HttpClient:class' + summary: HttpClient implements a basic set of features for performing REST operations against a generic service. + remarks: >- + For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class) class + instead. + name: HttpClient + fullName: HttpClient + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: (constructor)(serviceScope) + children: + - '@microsoft/sp-http!HttpClient:constructor(1)' + - '@microsoft/sp-http!HttpClient.configurations:member' + - '@microsoft/sp-http!HttpClient#fetch:member(1)' + - '@microsoft/sp-http!HttpClient#get:member(1)' + - '@microsoft/sp-http!HttpClient#post:member(1)' + - '@microsoft/sp-http!HttpClient.serviceKey:member' + - uid: '@microsoft/sp-http!HttpClient:constructor(1)' summary: Constructs a new instance of the `HttpClient` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: '' -properties: - - name: configurations - uid: '@microsoft/sp-http!HttpClient.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - uid: '@microsoft/sp-http!HttpClient.configurations:member' summary: The standard predefined HttpClientConfiguration objects for use with the HttpClient class. - remarks: '' - - isPreview: false - isDeprecated: false + name: configurations + fullName: configurations + langs: + - typeScript + type: property syntax: content: 'static readonly configurations: IHttpClientConfigurations;' return: - type: '' - - name: serviceKey - uid: '@microsoft/sp-http!HttpClient.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for HttpClient. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' + type: + - '@microsoft/sp-http!IHttpClientConfigurations:interface' + - uid: '@microsoft/sp-http!HttpClient#fetch:member(1)' summary: Performs a REST service call. remarks: >- Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here: https://fetch.spec.whatwg.org/ - - isPreview: false - isDeprecated: false + name: 'fetch(url, configuration, options)' + fullName: 'fetch(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!HttpClient#fetch~0:complex' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' + type: + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!HttpClient#get:member(1)' + summary: 'Calls fetch(), but sets the method to "GET".' + name: 'get(url, configuration, options)' + fullName: 'get(url, configuration, options)' + langs: + - typeScript + type: method + syntax: + content: >- + get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): + Promise; return: - type: 'Promise<>' + type: + - '@microsoft/sp-http!HttpClient#get~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!HttpClient#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: >- - get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): - Promise; parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' + type: + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: true + - uid: '@microsoft/sp-http!HttpClient#post:member(1)' + summary: 'Calls fetch(), but sets the method to "POST".' + name: 'post(url, configuration, options)' + fullName: 'post(url, configuration, options)' + langs: + - typeScript + type: method + syntax: + content: >- + post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): + Promise; return: - type: 'Promise<>' + type: + - '@microsoft/sp-http!HttpClient#post~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!HttpClient#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: >- - post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): - Promise; parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' + type: + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!HttpClient.serviceKey:member' + summary: The service key for HttpClient. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. + type: + - '@microsoft/sp-http!HttpClient.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' + name: IHttpClientConfigurations + - uid: '@microsoft/sp-http!HttpClient#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '@microsoft/sp-http!HttpClient#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!HttpClient#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!HttpClient.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: HttpClient + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/httpclientconfiguration.yml b/SP-Framework/sp-http/httpclientconfiguration.yml index a8d61ac7..5f80f636 100644 --- a/SP-Framework/sp-http/httpclientconfiguration.yml +++ b/SP-Framework/sp-http/httpclientconfiguration.yml @@ -1,87 +1,96 @@ -### YamlMime:TSType -name: HttpClientConfiguration -uid: '@microsoft/sp-http!HttpClientConfiguration:class' -package: '@microsoft/sp-http!' -fullName: HttpClientConfiguration -summary: Configuration for HttpClient. -remarks: >- - The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the - predefined defaults from HttpClientConfigurations, however switches can also be changed via the - HttpClientConfiguration.overrideWith() method. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!HttpClientConfiguration:class' + summary: Configuration for HttpClient. + remarks: >- + The HttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + HttpClient class. Normally these switches are set (e.g. when calling HttpClient.fetch()) by providing one of the + predefined defaults from HttpClientConfigurations, however switches can also be changed via the + HttpClientConfiguration.overrideWith() method. + name: HttpClientConfiguration + fullName: HttpClientConfiguration + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' + children: + - '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' + - '@microsoft/sp-http!HttpClientConfiguration#flags:member' + - '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!HttpClientConfiguration:constructor(1)' summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(flags: IHttpClientConfiguration, overrideFlags?: IHttpClientConfiguration);' parameters: - id: flags description: '' - type: '' + type: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + optional: false - id: overrideFlags description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' - package: '@microsoft/sp-http!' + type: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' + name: flags fullName: flags - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected flags: IHttpClientConfiguration;' return: - type: '' -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() + type: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!HttpClientConfiguration#initializeFlags:member(1)' summary: Child classes should override this method to initialize the flags object. - remarks: '' - - isPreview: false - isDeprecated: false + name: initializeFlags() + fullName: initializeFlags() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected initializeFlags(): void; return: - type: void + type: + - void description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) + - uid: '@microsoft/sp-http!HttpClientConfiguration#overrideWith:member(1)' summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' - remarks: '' - - isPreview: false - isDeprecated: false + name: overrideWith(sourceFlags) + fullName: overrideWith(sourceFlags) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' parameters: - id: sourceFlags description: '' - type: '' - return: - type: '' - description: '' + type: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + optional: false +references: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration diff --git a/SP-Framework/sp-http/httpclientresponse.yml b/SP-Framework/sp-http/httpclientresponse.yml index c49dd71f..2058543e 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -1,208 +1,279 @@ -### YamlMime:TSType -name: HttpClientResponse -uid: '@microsoft/sp-http!HttpClientResponse:class' -package: '@microsoft/sp-http!' -fullName: HttpClientResponse -summary: The Response subclass returned by methods such as HttpClient.fetch(). -remarks: >- - This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!HttpClientResponse:class' + summary: The Response subclass returned by methods such as HttpClient.fetch(). + remarks: >- + This is a placeholder. In the future, additional HttpClient-specific functionality may be added to this class. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `HttpClientResponse` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: bodyUsed - uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `HttpClientResponse` class. + name: HttpClientResponse + fullName: HttpClientResponse + langs: + - typeScript + type: class + implements: + - '!Response:interface' + - '!Body:interface' package: '@microsoft/sp-http!' - fullName: bodyUsed + children: + - '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' + - '@microsoft/sp-http!HttpClientResponse#blob:member(1)' + - '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' + - '@microsoft/sp-http!HttpClientResponse#clone:member(1)' + - '@microsoft/sp-http!HttpClientResponse#formData:member(1)' + - '@microsoft/sp-http!HttpClientResponse#headers:member' + - '@microsoft/sp-http!HttpClientResponse#json:member(1)' + - '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' + - '@microsoft/sp-http!HttpClientResponse#ok:member' + - '@microsoft/sp-http!HttpClientResponse#status:member' + - '@microsoft/sp-http!HttpClientResponse#statusText:member' + - '@microsoft/sp-http!HttpClientResponse#text:member(1)' + - '@microsoft/sp-http!HttpClientResponse#type:member' + - '@microsoft/sp-http!HttpClientResponse#url:member' + - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get bodyUsed(): boolean;' - return: - type: boolean - - name: headers - uid: '@microsoft/sp-http!HttpClientResponse#headers:member' - package: '@microsoft/sp-http!' - fullName: headers - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get headers(): Headers;' - return: - type: Headers - - name: nativeResponse - uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' - package: '@microsoft/sp-http!' - fullName: nativeResponse - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected nativeResponse: Response;' - return: - type: Response - - name: ok - uid: '@microsoft/sp-http!HttpClientResponse#ok:member' - package: '@microsoft/sp-http!' - fullName: ok - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get ok(): boolean;' - return: - type: boolean - - name: status - uid: '@microsoft/sp-http!HttpClientResponse#status:member' - package: '@microsoft/sp-http!' - fullName: status - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get status(): number;' - return: - type: number - - name: statusText - uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' - package: '@microsoft/sp-http!' - fullName: statusText - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get statusText(): string;' - return: - type: string - - name: type - uid: '@microsoft/sp-http!HttpClientResponse#type:member' - package: '@microsoft/sp-http!' - fullName: type - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get type(): ResponseType;' - return: - type: ResponseType - - name: url - uid: '@microsoft/sp-http!HttpClientResponse#url:member' - package: '@microsoft/sp-http!' - fullName: url - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get url(): string;' - return: - type: string -methods: - - name: arrayBuffer() - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer:member(1)' - package: '@microsoft/sp-http!' + name: arrayBuffer() fullName: arrayBuffer() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'arrayBuffer(): Promise;' return: - type: Promise<ArrayBuffer> + type: + - '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' description: '' - - name: blob() - uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' - package: '@microsoft/sp-http!' - fullName: blob() + - uid: '@microsoft/sp-http!HttpClientResponse#blob:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - - isPreview: false - isDeprecated: false + name: blob() + fullName: blob() + langs: + - typeScript + type: method syntax: content: 'blob(): Promise;' return: - type: Promise<Blob> + type: + - '@microsoft/sp-http!HttpClientResponse#blob~0:complex' description: '' - - name: clone() - uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' - package: '@microsoft/sp-http!' + - uid: '@microsoft/sp-http!HttpClientResponse#bodyUsed:member' + summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + name: bodyUsed + fullName: bodyUsed + langs: + - typeScript + type: property + syntax: + content: 'get bodyUsed(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' + name: clone() fullName: clone() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ clone(): HttpClientResponse; return: - type: '' + type: + - '@microsoft/sp-http!default:class' description: '' - - name: formData() - uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' - package: '@microsoft/sp-http!' - fullName: formData() + - uid: '@microsoft/sp-http!HttpClientResponse#formData:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - - isPreview: false - isDeprecated: false + name: formData() + fullName: formData() + langs: + - typeScript + type: method syntax: content: 'formData(): Promise;' return: - type: Promise<FormData> + type: + - '@microsoft/sp-http!HttpClientResponse#formData~0:complex' description: '' - - name: json() - uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' - package: '@microsoft/sp-http!' - fullName: json() + - uid: '@microsoft/sp-http!HttpClientResponse#headers:member' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + name: headers + fullName: headers + langs: + - typeScript + type: property + syntax: + content: 'get headers(): Headers;' + return: + type: + - '!Headers:interface' + - uid: '@microsoft/sp-http!HttpClientResponse#json:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - - isPreview: false - isDeprecated: false + name: json() + fullName: json() + langs: + - typeScript + type: method syntax: content: 'json(): Promise;' return: - type: Promise<any> + type: + - '@microsoft/sp-http!HttpClientResponse#json~0:complex' description: '' - - name: text() - uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' - package: '@microsoft/sp-http!' - fullName: text() + - uid: '@microsoft/sp-http!HttpClientResponse#nativeResponse:member' + name: nativeResponse + fullName: nativeResponse + langs: + - typeScript + type: property + syntax: + content: 'protected nativeResponse: Response;' + return: + type: + - '!Response:interface' + - uid: '@microsoft/sp-http!HttpClientResponse#ok:member' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + name: ok + fullName: ok + langs: + - typeScript + type: property + syntax: + content: 'get ok(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-http!HttpClientResponse#status:member' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + name: status + fullName: status + langs: + - typeScript + type: property + syntax: + content: 'get status(): number;' + return: + type: + - number + - uid: '@microsoft/sp-http!HttpClientResponse#statusText:member' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + name: statusText + fullName: statusText + langs: + - typeScript + type: property + syntax: + content: 'get statusText(): string;' + return: + type: + - string + - uid: '@microsoft/sp-http!HttpClientResponse#text:member(1)' summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' - remarks: '' - - isPreview: false - isDeprecated: false + name: text() + fullName: text() + langs: + - typeScript + type: method syntax: content: 'text(): Promise;' return: - type: Promise<string> + type: + - '@microsoft/sp-http!HttpClientResponse#text~0:complex' description: '' + - uid: '@microsoft/sp-http!HttpClientResponse#type:member' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'get type(): ResponseType;' + return: + type: + - '!ResponseType:type' + - uid: '@microsoft/sp-http!HttpClientResponse#url:member' + summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + name: url + fullName: url + langs: + - typeScript + type: property + syntax: + content: 'get url(): string;' + return: + type: + - string +references: + - uid: '!Response:interface' + name: Response + - uid: '!Body:interface' + name: Body + - uid: '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!ArrayBuffer:interface' + name: ArrayBuffer + fullName: ArrayBuffer + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!HttpClientResponse#blob~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!Blob:interface' + name: Blob + fullName: Blob + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + - uid: '@microsoft/sp-http!HttpClientResponse#formData~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '!FormData:interface' + name: FormData + fullName: FormData + - name: '>' + fullName: '>' + - uid: '!Headers:interface' + name: Headers + - uid: '@microsoft/sp-http!HttpClientResponse#json~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!HttpClientResponse#text~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '!ResponseType:type' + name: ResponseType diff --git a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml index 6b613b33..d3af564c 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -1,12 +1,17 @@ -### YamlMime:TSType -name: IAadHttpClientConfiguration -uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: IAadHttpClientConfiguration -summary: Flags interface for HttpClientConfiguration. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + summary: Flags interface for HttpClientConfiguration. + name: IAadHttpClientConfiguration + fullName: IAadHttpClientConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' +references: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml index 559c95b4..0fa3e4d1 100644 --- a/SP-Framework/sp-http/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -1,31 +1,35 @@ -### YamlMime:TSType -name: IAadHttpClientConfigurations -uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: IAadHttpClientConfigurations -summary: Standard configurations for AadHttpClient. -remarks: >- - This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class. - In general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations:interface' + summary: Standard configurations for AadHttpClient. + remarks: >- + This interface provides standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient + class. In general, clients should choose the latest available version number, which enables all the switches that + are recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was + tested.) + name: IAadHttpClientConfigurations + fullName: IAadHttpClientConfigurations + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: v1 + children: + - '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' + - uid: '@microsoft/sp-http!IAadHttpClientConfigurations#v1:member' summary: >- This configuration turns off every feature switch for AadHttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - remarks: '' - - isPreview: false - isDeprecated: false + name: v1 + fullName: v1 + langs: + - typeScript + type: property syntax: content: 'readonly v1: AadHttpClientConfiguration;' return: - type: '' + type: + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: AadHttpClientConfiguration diff --git a/SP-Framework/sp-http/iaadhttpclientoptions.yml b/SP-Framework/sp-http/iaadhttpclientoptions.yml index 0282510f..75b5cb8a 100644 --- a/SP-Framework/sp-http/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -1,53 +1,58 @@ -### YamlMime:TSType -name: IAadHttpClientOptions -uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' -package: '@microsoft/sp-http!' -fullName: IAadHttpClientOptions -summary: Interface for overriding the default behavior of AadHttpClient. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: configuration - uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IAadHttpClientOptions:interface' + summary: Interface for overriding the default behavior of AadHttpClient. + name: IAadHttpClientOptions + fullName: IAadHttpClientOptions + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' + children: + - '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' + - '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' + - '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' + - uid: '@microsoft/sp-http!IAadHttpClientOptions#configuration:member' + deprecated: + content: '- AadHttpClient''s configuration cannot be altered' + name: configuration fullName: configuration - summary: '' - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- AadHttpClient''s configuration cannot be altered' + langs: + - typeScript + type: property syntax: content: 'configuration?: IAadTokenProviderConfiguration;' return: - type: '' - - name: tokenProvider - uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' - package: '@microsoft/sp-http!' + type: + - '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + - uid: '@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member' + deprecated: + content: '- AadHttpClient does not support a custom tokenProvider.' + name: tokenProvider fullName: tokenProvider - summary: '' - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- AadHttpClient does not support a custom tokenProvider.' + langs: + - typeScript + type: property syntax: content: 'tokenProvider?: IAadTokenProvider;' return: - type: '' - - name: useCachedToken - uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' - package: '@microsoft/sp-http!' - fullName: useCachedToken + type: + - '@microsoft/sp-http!IAadTokenProvider:interface' + - uid: '@microsoft/sp-http!IAadHttpClientOptions#useCachedToken:member' summary: Allows the developer to specify if cached tokens should be use for the current request. - remarks: '' - isPreview: true - isDeprecated: false + name: useCachedToken + fullName: useCachedToken + langs: + - typeScript + type: property syntax: content: 'useCachedToken?: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + name: IAadTokenProviderConfiguration + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' + name: IAadTokenProvider diff --git a/SP-Framework/sp-http/iaadtokenprovider.yml b/SP-Framework/sp-http/iaadtokenprovider.yml index 0eefea69..3ac91c64 100644 --- a/SP-Framework/sp-http/iaadtokenprovider.yml +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -1,77 +1,114 @@ -### YamlMime:TSType -name: IAadTokenProvider -uid: '@microsoft/sp-http!IAadTokenProvider:interface' -package: '@microsoft/sp-http!' -fullName: IAadTokenProvider -summary: >- - This class allows a developer to obtain OAuth2 tokens from Azure AD. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IAadTokenProvider:interface' + summary: >- + This class allows a developer to obtain OAuth2 tokens from Azure AD. - OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, - Exchange, Yammer, etc. -remarks: >- - AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some - point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will switch to - MSAL. - -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'getToken(resourceEndpoint, useCachedToken)' - uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' + OAuth2 tokens are used to authenticate the user from the SharePoint page to other services such as PowerBI, Sway, + Exchange, Yammer, etc. + remarks: >- + AadTokenProvider is replacing the /\_api.SP.OAuth.Token/Acquire endpoint for authentication with ADAL.js. At some + point in the near future, when Azure AD v2.0 can support the same scenarios as the original version, we will + switch to MSAL. + name: IAadTokenProvider + fullName: IAadTokenProvider + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: 'getToken(resourceEndpoint, useCachedToken)' + children: + - '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' + - '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' + - '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' + - uid: '@microsoft/sp-http!IAadTokenProvider#getToken:member(1)' summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. The OAuth2 token SHOULD NOT be cached by the caller since it is already cached by the method itself. An example of a resourceEndpoint would be https://sdfpilot.outlook.com - remarks: '' - - isPreview: false - isDeprecated: false + name: 'getToken(resourceEndpoint, useCachedToken)' + fullName: 'getToken(resourceEndpoint, useCachedToken)' + langs: + - typeScript + type: method syntax: content: 'getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise;' + return: + type: + - '@microsoft/sp-http!IAadTokenProvider#getToken~0:complex' + description: A promise that will be fullfiled with the token or that will reject with an error message parameters: - id: resourceEndpoint description: the resource for which the token should be obtained - type: string + type: + - string + optional: false - id: useCachedToken description: Allows the developer to specify if cached tokens should be returned. - type: boolean - return: - type: Promise<string> - description: A promise that will be fullfiled with the token or that will reject with an error message -events: - - name: onBeforeRedirectEvent - uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' - package: '@microsoft/sp-http!' - fullName: onBeforeRedirectEvent + type: + - boolean + optional: true + - uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' summary: Notifies the developer before a full page redirect occurs. - remarks: '' - - isPreview: false - isDeprecated: false + name: onBeforeRedirectEvent + fullName: onBeforeRedirectEvent + langs: + - typeScript + type: event syntax: content: 'readonly onBeforeRedirectEvent: SPEvent;' return: - type: >- - <> - - name: tokenAcquisitionEvent - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' - package: '@microsoft/sp-http!' - fullName: tokenAcquisitionEvent + type: + - '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent~0:complex' + - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent:member' summary: Notifies the developer when Token Acquistion requires user action. - remarks: '' - - isPreview: false - isDeprecated: false + name: tokenAcquisitionEvent + fullName: tokenAcquisitionEvent + langs: + - typeScript + type: event syntax: content: 'readonly tokenAcquisitionEvent: SPEvent;' return: - type: >- - <> + type: + - '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent~0:complex' +references: + - uid: '@microsoft/sp-http!IAadTokenProvider#getToken~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' + name: IBeforeRedirectEventArgs + fullName: IBeforeRedirectEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!IAadTokenProvider#tokenAcquisitionEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + name: ITokenAcquisitionEventArgs + fullName: ITokenAcquisitionEventArgs + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml index 02ebbf22..2cefb0c2 100644 --- a/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -1,126 +1,127 @@ -### YamlMime:TSType -name: IAadTokenProviderConfiguration -uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: IAadTokenProviderConfiguration -summary: Required strings for constructing an AadTokenProvider. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: aadInstanceUrl - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration:interface' + summary: Required strings for constructing an AadTokenProvider. + name: IAadTokenProviderConfiguration + fullName: IAadTokenProviderConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: aadInstanceUrl + children: + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' + - '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadInstanceUrl:member' summary: The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden. - remarks: '' - - isPreview: false - isDeprecated: false + name: aadInstanceUrl + fullName: aadInstanceUrl + langs: + - typeScript + type: property syntax: content: 'aadInstanceUrl: string;' return: - type: string - - name: aadSessionId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' - package: '@microsoft/sp-http!' - fullName: aadSessionId + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' summary: The current Azure Active Directory's session id. - remarks: '' - isPreview: true - isDeprecated: false + name: aadSessionId + fullName: aadSessionId + langs: + - typeScript + type: property syntax: content: 'aadSessionId: string;' return: - type: string - - name: aadTenantId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' - package: '@microsoft/sp-http!' - fullName: aadTenantId + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' summary: The Azure Active Directory's tenant id. - remarks: '' - - isPreview: false - isDeprecated: false + name: aadTenantId + fullName: aadTenantId + langs: + - typeScript + type: property syntax: content: 'aadTenantId: string;' return: - type: string - - name: aadUserId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' - package: '@microsoft/sp-http!' - fullName: aadUserId + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadUserId:member' summary: >- The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user. - remarks: '' - - isPreview: false - isDeprecated: false + name: aadUserId + fullName: aadUserId + langs: + - typeScript + type: property syntax: content: 'aadUserId?: string;' return: - type: string - - name: redirectUri - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' - package: '@microsoft/sp-http!' - fullName: redirectUri + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#redirectUri:member' summary: >- The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris. - remarks: '' - - isPreview: false - isDeprecated: false + name: redirectUri + fullName: redirectUri + langs: + - typeScript + type: property syntax: content: 'redirectUri: string;' return: - type: string - - name: servicePrincipalId - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' - package: '@microsoft/sp-http!' - fullName: servicePrincipalId + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member' summary: The client ID of the developer's Azure Active Directory application. - remarks: '' - - isPreview: false - isDeprecated: false + name: servicePrincipalId + fullName: servicePrincipalId + langs: + - typeScript + type: property syntax: content: 'servicePrincipalId: string;' return: - type: string - - name: userEmail - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' - package: '@microsoft/sp-http!' - fullName: userEmail + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userEmail:member' summary: >- The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: This parameter will be ignored. Use userPrincipalName instead + deprecated: + content: This parameter will be ignored. Use userPrincipalName instead + name: userEmail + fullName: userEmail + langs: + - typeScript + type: property syntax: content: 'userEmail?: string;' return: - type: string - - name: userPrincipalName - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' - package: '@microsoft/sp-http!' - fullName: userPrincipalName + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#userPrincipalName:member' summary: >- The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error. - remarks: '' - - isPreview: false - isDeprecated: false + name: userPrincipalName + fullName: userPrincipalName + langs: + - typeScript + type: property syntax: content: 'userPrincipalName?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml index f71a0693..34bac608 100644 --- a/SP-Framework/sp-http/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -1,39 +1,44 @@ -### YamlMime:TSType -name: IBeforeRedirectEventArgs -uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' -package: '@microsoft/sp-http!' -fullName: IBeforeRedirectEventArgs -summary: Represents arguments used before redirecting event. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: cancel - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#cancel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs:interface' + summary: Represents arguments used before redirecting event. + name: IBeforeRedirectEventArgs + fullName: IBeforeRedirectEventArgs + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-http!' - fullName: cancel + children: + - '@microsoft/sp-http!IBeforeRedirectEventArgs#cancel:member' + - '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' + - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#cancel:member' summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. - remarks: '' - - isPreview: false - isDeprecated: false + name: cancel + fullName: cancel + langs: + - typeScript + type: property syntax: content: 'cancel: () => void;' return: - type: () => void - - name: redirectUrl - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl + type: + - () => void + - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' summary: The url of the page to redirect to if automatic redirect is cancelled - remarks: '' - - isPreview: false - isDeprecated: false + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property syntax: content: 'redirectUrl: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs diff --git a/SP-Framework/sp-http/idigestcache.yml b/SP-Framework/sp-http/idigestcache.yml index 6b93c457..936140db 100644 --- a/SP-Framework/sp-http/idigestcache.yml +++ b/SP-Framework/sp-http/idigestcache.yml @@ -1,107 +1,126 @@ -### YamlMime:TSType -name: IDigestCache -uid: '@microsoft/sp-http!IDigestCache:interface' -package: '@microsoft/sp-http!' -fullName: IDigestCache -summary: >- - IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb URL. A - request digest is a security token that the SharePoint server requires for for any REST write operation, specified via - the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, and expires after - a server configurable amount of time. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IDigestCache:interface' + summary: >- + IDigestCache is an internal service used by SPHttpClient to maintain a cache of request digests for each SPWeb + URL. A request digest is a security token that the SharePoint server requires for for any REST write operation, + specified via the "X-RequestDigest" HTTP header. It is obtained by calling the "/\_api/contextinfo" REST endpoint, + and expires after a server configurable amount of time. - For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST - endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' - uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' + For more information, see the MSDN article ["Complete basic operations using SharePoint 2013 REST + endpoints"](https://msdn.microsoft.com/en-us/library/office/jj164022.aspx) + name: IDigestCache + fullName: IDigestCache + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + children: + - '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' + - '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' + - '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' + - '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' + - uid: '@microsoft/sp-http!IDigestCache#addDigestToCache:member(1)' summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios addDigestToCache() can be used to avoid the overhead of the REST call. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + langs: + - typeScript + type: method syntax: content: 'addDigestToCache(webUrl: string, digestValue: string, expirationTimestamp: number): void;' + return: + type: + - void + description: '' parameters: - id: webUrl description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string + type: + - string + optional: false - id: digestValue description: >- The digest value, which is an opaque that must be generated by the SharePoint server. The syntax will look something like this: "0x0B85...2EAC,29 Jan 2016 01:23:45 -0000" - type: string + type: + - string + optional: false - id: expirationTimestamp description: >- A future point in time, as measured by performance.now(), after which the digest value will no longer be valid. NOTE: The expirationTime is a DOMHighResTimeStamp value whose units are fractional milliseconds; for example, to specify an expiration "5 seconds from right now", use performance.now()+5000. - type: number - return: - type: void - description: '' - - name: clearAllDigests() - uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' - package: '@microsoft/sp-http!' - fullName: clearAllDigests() + type: + - number + optional: false + - uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' summary: Clears all values from the cache. - remarks: '' - - isPreview: false - isDeprecated: false + name: clearAllDigests() + fullName: clearAllDigests() + langs: + - typeScript + type: method syntax: content: 'clearAllDigests(): void;' return: - type: void + type: + - void description: '' - - name: clearDigest(webUrl) - uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: clearDigest(webUrl) + - uid: '@microsoft/sp-http!IDigestCache#clearDigest:member(1)' summary: >- Clears the cached digest for the specified SPWeb URL. This operation is useful e.g. if an error indicates that a digest was invalidated prior to its expiration time. - remarks: '' - - isPreview: false - isDeprecated: false + name: clearDigest(webUrl) + fullName: clearDigest(webUrl) + langs: + - typeScript + type: method syntax: content: 'clearDigest(webUrl: string): boolean;' + return: + type: + - boolean + description: Returns true if a cache entry was found and deleted; false otherwise. parameters: - id: webUrl description: The URL of the SPWeb whose digest should be cleared. This may be a server-relative or absolute URL. - type: string - return: - type: boolean - description: Returns true if a cache entry was found and deleted; false otherwise. - - name: fetchDigest(webUrl) - uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' - package: '@microsoft/sp-http!' - fullName: fetchDigest(webUrl) + type: + - string + optional: false + - uid: '@microsoft/sp-http!IDigestCache#fetchDigest:member(1)' summary: >- Returns a digest string for the specified SPWeb URL. If the cache already contains a usable value, the promise is fulfilled immediately. Otherwise, the promise will be pending and resolve after an HTTP request obtains the digest, which will be added to the cache. - remarks: '' - - isPreview: false - isDeprecated: false + name: fetchDigest(webUrl) + fullName: fetchDigest(webUrl) + langs: + - typeScript + type: method syntax: content: 'fetchDigest(webUrl: string): Promise;' + return: + type: + - '@microsoft/sp-http!IDigestCache#fetchDigest~0:complex' + description: A promise that is fulfilled with the digest value. parameters: - id: webUrl description: The URL of the SPWeb that the API call will be issued to. This may be a server-relative or absolute URL. - type: string - return: - type: Promise<string> - description: A promise that is fulfilled with the digest value. + type: + - string + optional: false +references: + - uid: '@microsoft/sp-http!IDigestCache#fetchDigest~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index c47153d4..5e5dae70 100644 --- a/SP-Framework/sp-http/ihttpclientconfiguration.yml +++ b/SP-Framework/sp-http/ihttpclientconfiguration.yml @@ -1,11 +1,10 @@ -### YamlMime:TSType -name: IHttpClientConfiguration -uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: IHttpClientConfiguration -summary: Flags interface for HttpClientConfiguration. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + summary: Flags interface for HttpClientConfiguration. + name: IHttpClientConfiguration + fullName: IHttpClientConfiguration + langs: + - typeScript + type: interface + package: '@microsoft/sp-http!' diff --git a/SP-Framework/sp-http/ihttpclientconfigurations.yml b/SP-Framework/sp-http/ihttpclientconfigurations.yml index f0134853..2bc42ed5 100644 --- a/SP-Framework/sp-http/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http/ihttpclientconfigurations.yml @@ -1,31 +1,35 @@ -### YamlMime:TSType -name: IHttpClientConfigurations -uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: IHttpClientConfigurations -summary: Standard configurations for HttpClient. -remarks: >- - This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In - general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IHttpClientConfigurations:interface' + summary: Standard configurations for HttpClient. + remarks: >- + This interface provides standard predefined HttpClientConfiguration objects for use with the HttpClient class. In + general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was + tested.) + name: IHttpClientConfigurations + fullName: IHttpClientConfigurations + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: v1 + children: + - '@microsoft/sp-http!IHttpClientConfigurations#v1:member' + - uid: '@microsoft/sp-http!IHttpClientConfigurations#v1:member' summary: >- This configuration turns off every feature switch for HttpClient. The fetch() behavior will be essentially identical to the WHATWG standard API that is documented here: https://fetch.spec.whatwg.org/ - remarks: '' - - isPreview: false - isDeprecated: false + name: v1 + fullName: v1 + langs: + - typeScript + type: property syntax: content: 'readonly v1: HttpClientConfiguration;' return: - type: '' + type: + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration diff --git a/SP-Framework/sp-http/ihttpclientoptions.yml b/SP-Framework/sp-http/ihttpclientoptions.yml index 806932f9..49fc4ffc 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -1,14 +1,20 @@ -### YamlMime:TSType -name: IHttpClientOptions -uid: '@microsoft/sp-http!IHttpClientOptions:interface' -package: '@microsoft/sp-http!' -fullName: IHttpClientOptions -summary: Options for HttpClient -remarks: >- - This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based on - the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ - -isPreview: false -isDeprecated: false -type: interface -extends: RequestInit +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + summary: Options for HttpClient + remarks: >- + This interface defines the options for the HttpClient operations such as get(), post(), fetch(), etc. It is based + on the whatwg API standard parameters that are documented here: https://fetch.spec.whatwg.org/ + name: IHttpClientOptions + fullName: IHttpClientOptions + langs: + - typeScript + type: interface + extends: + - '!RequestInit:interface' + inheritance: + - type: '!RequestInit:interface' + package: '@microsoft/sp-http!' +references: + - uid: '!RequestInit:interface' + name: RequestInit diff --git a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml index 682b36c3..fbff5992 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -1,12 +1,22 @@ -### YamlMime:TSType -name: ISPHttpClientBatchConfiguration -uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchConfiguration -summary: Flags interface for SPHttpClientBatchConfiguration. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + summary: Flags interface for SPHttpClientBatchConfiguration. + isPreview: true + name: ISPHttpClientBatchConfiguration + fullName: ISPHttpClientBatchConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' + package: '@microsoft/sp-http!' +references: + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml index cd02fa14..2e88baac 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfigurations.yml @@ -1,29 +1,35 @@ -### YamlMime:TSType -name: ISPHttpClientBatchConfigurations -uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchConfigurations -summary: Standard configurations for SPHttpClient. -remarks: >- - This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the SPHttpClientBatch - class. In general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + summary: Standard configurations for SPHttpClient. + remarks: >- + This interface provides standard predefined SPHttpClientBatchConfiguration objects for use with the + SPHttpClientBatch class. In general, clients should choose the latest available version number, which enables all + the switches that are recommended for typical scenarios. (If new switches are introduced in the future, a new + version number will be introduced, which ensures that existing code will continue to function the way it did at + the time when it was tested.) + isPreview: true + name: ISPHttpClientBatchConfigurations + fullName: ISPHttpClientBatchConfigurations + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: v1 + children: + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations#v1:member' summary: 'Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true' - remarks: '' - isPreview: true - isDeprecated: false + name: v1 + fullName: v1 + langs: + - typeScript + type: property syntax: content: 'readonly v1: SPHttpClientBatchConfiguration;' return: - type: '' + type: + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml index 2c4eeeec..77834e6d 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -1,29 +1,30 @@ -### YamlMime:TSType -name: ISPHttpClientBatchCreationOptions -uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchCreationOptions -summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: webUrl - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + summary: This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch. + isPreview: true + name: ISPHttpClientBatchCreationOptions + fullName: ISPHttpClientBatchCreationOptions + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: webUrl + children: + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions#webUrl:member' summary: >- SPHttpClientBatch will need to perform its POST to an endpoint such as "http://example.com/sites/sample/\_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option. - remarks: '' - isPreview: true - isDeprecated: false + name: webUrl + fullName: webUrl + langs: + - typeScript + type: property syntax: content: 'webUrl?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-http/isphttpclientbatchoptions.yml b/SP-Framework/sp-http/isphttpclientbatchoptions.yml index d2ac62c7..422829a6 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -1,14 +1,24 @@ -### YamlMime:TSType -name: ISPHttpClientBatchOptions -uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientBatchOptions -summary: >- - This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is based on - the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + summary: >- + This interface defines the options for an individual REST request that is part of an SPHttpClientBatch. It is + based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ + isPreview: true + name: ISPHttpClientBatchOptions + fullName: ISPHttpClientBatchOptions + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '!RequestInit:interface' + package: '@microsoft/sp-http!' +references: + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '!RequestInit:interface' + name: RequestInit diff --git a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml index 07fb8754..cff46a69 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -1,19 +1,21 @@ -### YamlMime:TSType -name: ISPHttpClientCommonConfiguration -uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientCommonConfiguration -summary: Flags interface for SPHttpClientCommonConfiguration -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: jsonRequest - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + summary: Flags interface for SPHttpClientCommonConfiguration + name: ISPHttpClientCommonConfiguration + fullName: ISPHttpClientCommonConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' package: '@microsoft/sp-http!' - fullName: jsonRequest + children: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonRequest:member' summary: Automatically configure the "Content-Type" header for a JSON payload. remarks: >- When this switch is true: @@ -27,17 +29,17 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - - isPreview: false - isDeprecated: false + name: jsonRequest + fullName: jsonRequest + langs: + - typeScript + type: property syntax: content: 'jsonRequest?: boolean;' return: - type: boolean - - name: jsonResponse - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' - package: '@microsoft/sp-http!' - fullName: jsonResponse + type: + - boolean + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration#jsonResponse:member' summary: Automatically configure the "Accept" header for a JSON payload. remarks: |- When this switch is true: @@ -47,11 +49,16 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - - isPreview: false - isDeprecated: false + name: jsonResponse + fullName: jsonResponse + langs: + - typeScript + type: property syntax: content: 'jsonResponse?: boolean;' return: - type: boolean -extends: '' + type: + - boolean +references: + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientconfiguration.yml b/SP-Framework/sp-http/isphttpclientconfiguration.yml index c6029b69..769ca429 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -1,19 +1,24 @@ -### YamlMime:TSType -name: ISPHttpClientConfiguration -uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientConfiguration -summary: Flags interface for SPHttpClientConfiguration. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: defaultODataVersion - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + summary: Flags interface for SPHttpClientConfiguration. + name: ISPHttpClientConfiguration + fullName: ISPHttpClientConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientConfiguration:interface' package: '@microsoft/sp-http!' - fullName: defaultODataVersion + children: + - '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' + - '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' + - '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultODataVersion:member' summary: Automatically configure the "OData-Version" header. remarks: >- When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the @@ -22,17 +27,17 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - - isPreview: false - isDeprecated: false + name: defaultODataVersion + fullName: defaultODataVersion + langs: + - typeScript + type: property syntax: content: 'defaultODataVersion?: ODataVersion;' return: - type: '' - - name: defaultSameOriginCredentials - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' - package: '@microsoft/sp-http!' - fullName: defaultSameOriginCredentials + type: + - '@microsoft/sp-http!default:class' + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' summary: Automatically configure the RequestInit.credentials. remarks: >- When this switch is true: @@ -43,17 +48,17 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - - isPreview: false - isDeprecated: false + name: defaultSameOriginCredentials + fullName: defaultSameOriginCredentials + langs: + - typeScript + type: property syntax: content: 'defaultSameOriginCredentials?: boolean;' return: - type: boolean - - name: requestDigest - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' - package: '@microsoft/sp-http!' - fullName: requestDigest + type: + - boolean + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration#requestDigest:member' summary: Automatically provide an "X-RequestDigest" header for authentication. remarks: >- When this switch is true: @@ -62,11 +67,20 @@ properties: If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - - isPreview: false - isDeprecated: false + name: requestDigest + fullName: requestDigest + langs: + - typeScript + type: property syntax: content: 'requestDigest?: boolean;' return: - type: boolean -extends: '' + type: + - boolean +references: + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!IHttpClientConfiguration:interface' + name: IHttpClientConfiguration + - uid: '@microsoft/sp-http!default:class' + name: ODataVersion diff --git a/SP-Framework/sp-http/isphttpclientconfigurations.yml b/SP-Framework/sp-http/isphttpclientconfigurations.yml index 3f373dd9..8a319dc5 100644 --- a/SP-Framework/sp-http/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http/isphttpclientconfigurations.yml @@ -1,34 +1,38 @@ -### YamlMime:TSType -name: ISPHttpClientConfigurations -uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientConfigurations -summary: Standard configurations for SPHttpClient. -remarks: >- - This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. In - general, clients should choose the latest available version number, which enables all the switches that are - recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be - introduced, which ensures that existing code will continue to function the way it did at the time when it was tested.) - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: v1 - uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + summary: Standard configurations for SPHttpClient. + remarks: >- + This interface provides standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. + In general, clients should choose the latest available version number, which enables all the switches that are + recommended for typical scenarios. (If new switches are introduced in the future, a new version number will be + introduced, which ensures that existing code will continue to function the way it did at the time when it was + tested.) + name: ISPHttpClientConfigurations + fullName: ISPHttpClientConfigurations + langs: + - typeScript + type: interface package: '@microsoft/sp-http!' - fullName: v1 + children: + - '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations#v1:member' summary: >- Version 1 enables these switches: consoleLogging = true; jsonRequest = true; jsonResponse = true; defaultSameOriginCredentials = true; defaultODataVersion = ODataVersion.v4; requestDigest = true - remarks: '' - - isPreview: false - isDeprecated: false + name: v1 + fullName: v1 + langs: + - typeScript + type: property syntax: content: 'readonly v1: SPHttpClientConfiguration;' return: - type: '' + type: + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientConfiguration diff --git a/SP-Framework/sp-http/isphttpclientoptions.yml b/SP-Framework/sp-http/isphttpclientoptions.yml index 93b34554..7766f09b 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -1,21 +1,24 @@ -### YamlMime:TSType -name: ISPHttpClientOptions -uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' -package: '@microsoft/sp-http!' -fullName: ISPHttpClientOptions -summary: >- - This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is based on - the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: webUrl - uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' + summary: >- + This interface defines the options for the SPHttpClient operations such as get(), post(), fetch(), etc. It is + based on the WHATWG API standard parameters that are documented here: https://fetch.spec.whatwg.org/ + name: ISPHttpClientOptions + fullName: ISPHttpClientOptions + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '@microsoft/sp-http!IHttpClientOptions:interface' + inheritance: + - type: '!RequestInit:interface' package: '@microsoft/sp-http!' - fullName: webUrl + children: + - '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' + - uid: '@microsoft/sp-http!ISPHttpClientOptions#webUrl:member' summary: Configure the SPWeb URL for authentication. remarks: >- For a write operation, SPHttpClient will automatically add the "X-RequestDigest" header, which may need to be @@ -23,11 +26,18 @@ properties: URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "\_api" in the original REST query, however certain REST endpoints do not contain a reserved URL segment; in this case, the webUrl can be explicitly specified using this option. - - isPreview: false - isDeprecated: false + name: webUrl + fullName: webUrl + langs: + - typeScript + type: property syntax: content: 'webUrl?: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-http!IHttpClientOptions:interface' + name: IHttpClientOptions + - uid: '!RequestInit:interface' + name: RequestInit diff --git a/SP-Framework/sp-http/itokenacquisitioneventargs.yml b/SP-Framework/sp-http/itokenacquisitioneventargs.yml index ca0939ca..cee1e7da 100644 --- a/SP-Framework/sp-http/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -1,39 +1,44 @@ -### YamlMime:TSType -name: ITokenAcquisitionEventArgs -uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' -package: '@microsoft/sp-http!' -fullName: ITokenAcquisitionEventArgs -summary: Represents arguments used for raising a token acquisiton failure event. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: message - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs:interface' + summary: Represents arguments used for raising a token acquisiton failure event. + name: ITokenAcquisitionEventArgs + fullName: ITokenAcquisitionEventArgs + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-http!' - fullName: message + children: + - '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' + - '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#message:member' summary: The message returned from ADAL fails to retrieve a token from Azure AD. - remarks: '' - - isPreview: false - isDeprecated: false + name: message + fullName: message + langs: + - typeScript + type: property syntax: content: 'message: string;' return: - type: string - - name: redirectUrl - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl + type: + - string + - uid: '@microsoft/sp-http!ITokenAcquisitionEventArgs#redirectUrl:member' summary: The url of the page for the end user to interact with Azure AD. - remarks: '' - - isPreview: false - isDeprecated: false + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property syntax: content: 'redirectUrl?: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs diff --git a/SP-Framework/sp-http/msgraphclient.yml b/SP-Framework/sp-http/msgraphclient.yml index 5fa26570..89ef8020 100644 --- a/SP-Framework/sp-http/msgraphclient.yml +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -1,31 +1,29 @@ -### YamlMime:TSType -name: MSGraphClient -uid: '@microsoft/sp-http!MSGraphClient:class' -package: '@microsoft/sp-http!' -fullName: MSGraphClient -summary: MSGraphClient is used to perform REST calls against Microsoft Graph. -remarks: >- - The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class - allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. - If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom - configuration for every request. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!MSGraphClient:class' + summary: MSGraphClient is used to perform REST calls against Microsoft Graph. + remarks: >- + The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class + allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client + library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that + custom configuration for every request. - For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClient` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'api(path, config)' - uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClient` class. + name: MSGraphClient + fullName: MSGraphClient + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: 'api(path, config)' + children: + - '@microsoft/sp-http!MSGraphClient#api:member(1)' + - uid: '@microsoft/sp-http!MSGraphClient#api:member(1)' summary: All calls to Microsoft Graph are chained together starting with the api function. remarks: >- Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* @@ -34,18 +32,30 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - - isPreview: false - isDeprecated: false + name: 'api(path, config)' + fullName: 'api(path, config)' + langs: + - typeScript + type: method syntax: content: 'api(path: string, config?: Options): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' parameters: - id: path description: The path for the request to MSGraph. - type: string + type: + - string + optional: false - id: config description: Sets the configuration for this request. - type: '' - return: - type: '' - description: '' + type: + - '@microsoft/microsoft-graph-client!Options:interface' + optional: true +references: + - uid: '@microsoft/sp-http!IGraphRequest:interface' + name: IGraphRequest + - uid: '@microsoft/microsoft-graph-client!Options:interface' + name: Options diff --git a/SP-Framework/sp-http/msgraphclientfactory.yml b/SP-Framework/sp-http/msgraphclientfactory.yml index 6e028471..2ba9c754 100644 --- a/SP-Framework/sp-http/msgraphclientfactory.yml +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -1,90 +1,149 @@ -### YamlMime:TSType -name: MSGraphClientFactory -uid: '@microsoft/sp-http!MSGraphClientFactory:class' -package: '@microsoft/sp-http!' -fullName: MSGraphClientFactory -summary: >- - Returns a preinitialized version of the MSGraphClient. For more information: - [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClientFactory` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: serviceKey - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for MSGraphClientFactory. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: getClient() - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!MSGraphClientFactory:class' + summary: >- + Returns a preinitialized version of the MSGraphClient. For more information: + [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph) + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClientFactory` class. + name: MSGraphClientFactory + fullName: MSGraphClientFactory + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: getClient() + children: + - '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' + - '@microsoft/sp-http!MSGraphClientFactory#getClient:member(2)' + - '@microsoft/sp-http!MSGraphClientFactory#getClient:member(3)' + - '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(1)' summary: >- Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Principal. Returns version 1 by default. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: 'Use getClient(''1'') instead, which has the same implementation but specifies the version explicitly.' + deprecated: + content: 'Use getClient(''1'') instead, which has the same implementation but specifies the version explicitly.' + name: getClient() + fullName: getClient() + langs: + - typeScript + type: method syntax: content: 'getClient(): Promise;' return: - type: 'Promise<>' + type: + - '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' description: '' - - name: getClient(version) - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(2)' - package: '@microsoft/sp-http!' - fullName: getClient(version) + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(2)' summary: |- Returns an instance version 1 of the MSGraphClient communicates with the current tenant's configurable Service Principal. - remarks: '' - - isPreview: false - isDeprecated: false + name: getClient(version) + fullName: getClient(version) + langs: + - typeScript + type: method syntax: content: 'getClient(version: ''1''): Promise;' + return: + type: + - '@microsoft/sp-http!MSGraphClientFactory#getClient~1:complex' + description: '' parameters: - id: version description: '' - type: '''1''' - return: - type: 'Promise<>' - description: '' - - name: getClient(version) - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(3)' - package: '@microsoft/sp-http!' - fullName: getClient(version) + type: + - '''1''' + optional: false + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient:member(3)' summary: >- Returns an instance of version 3 the MSGraphClient V3 that communicates with the current tenant's configurable Service Principal. - remarks: '' - - isPreview: false - isDeprecated: false + name: getClient(version) + fullName: getClient(version) + langs: + - typeScript + type: method syntax: content: 'getClient(version: ''3''): Promise;' + return: + type: + - '@microsoft/sp-http!MSGraphClientFactory#getClient~2:complex' + description: '' parameters: - id: version description: '' - type: '''3''' + type: + - '''3''' + optional: false + - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey:member' + summary: The service key for MSGraphClientFactory. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' return: - type: 'Promise<>' - description: '' + type: + - '@microsoft/sp-http!MSGraphClientFactory.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: MSGraphClient + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient~1:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: MSGraphClient + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!MSGraphClientFactory#getClient~2:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: MSGraphClientV3 + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!MSGraphClientFactory.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: MSGraphClientFactory + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/msgraphclientv3.yml b/SP-Framework/sp-http/msgraphclientv3.yml index b496ed36..f15e0ddf 100644 --- a/SP-Framework/sp-http/msgraphclientv3.yml +++ b/SP-Framework/sp-http/msgraphclientv3.yml @@ -1,31 +1,29 @@ -### YamlMime:TSType -name: MSGraphClientV3 -uid: '@microsoft/sp-http!MSGraphClientV3:class' -package: '@microsoft/sp-http!' -fullName: MSGraphClientV3 -summary: MSGraphClient is used to perform REST calls against Microsoft Graph. -remarks: >- - The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class - allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library. - If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom - configuration for every request. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!MSGraphClientV3:class' + summary: MSGraphClient is used to perform REST calls against Microsoft Graph. + remarks: >- + The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class + allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client + library. If a custom configuration is desired, the MSGraphClient api function needs to be provided with that + custom configuration for every request. - For more information: - [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) + For more information: + [https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript) - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `MSGraphClientV3` class. -isPreview: false -isDeprecated: false -type: class -methods: - - name: api(path) - uid: '@microsoft/sp-http!MSGraphClientV3#api:member(1)' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `MSGraphClientV3` class. + name: MSGraphClientV3 + fullName: MSGraphClientV3 + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: api(path) + children: + - '@microsoft/sp-http!MSGraphClientV3#api:member(1)' + - uid: '@microsoft/sp-http!MSGraphClientV3#api:member(1)' summary: All calls to Microsoft Graph are chained together starting with the api function. remarks: >- Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* @@ -34,15 +32,23 @@ methods: The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript - - isPreview: false - isDeprecated: false + name: api(path) + fullName: api(path) + langs: + - typeScript + type: method syntax: content: 'api(path: string): GraphRequest;' + return: + type: + - '@microsoft/microsoft-graph-client!GraphRequest:class' + description: '' parameters: - id: path description: The path for the request to MSGraph. - type: string - return: - type: '' - description: '' + type: + - string + optional: false +references: + - uid: '@microsoft/microsoft-graph-client!GraphRequest:class' + name: GraphRequest diff --git a/SP-Framework/sp-http/odataversion.yml b/SP-Framework/sp-http/odataversion.yml index bf4b584b..efcdba5b 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -1,73 +1,88 @@ -### YamlMime:TSType -name: ODataVersion -uid: '@microsoft/sp-http!ODataVersion:class' -package: '@microsoft/sp-http!' -fullName: ODataVersion -summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: v3 - uid: '@microsoft/sp-http!ODataVersion.v3:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!ODataVersion:class' + summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' + name: ODataVersion + fullName: ODataVersion + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: v3 - summary: Represents version 3.0 for the "OData-Version" header - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static v3: ODataVersion;' - return: - type: '' - - name: v4 - uid: '@microsoft/sp-http!ODataVersion.v4:member' - package: '@microsoft/sp-http!' - fullName: v4 - summary: Represents version 4.0 for the "OData-Version" header - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static v4: ODataVersion;' - return: - type: '' -methods: - - name: toString() - uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' - package: '@microsoft/sp-http!' - fullName: toString() + children: + - '@microsoft/sp-http!ODataVersion#toString:member(1)' + - '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' + - '@microsoft/sp-http!ODataVersion.v3:member' + - '@microsoft/sp-http!ODataVersion.v4:member' + - uid: '@microsoft/sp-http!ODataVersion#toString:member(1)' summary: 'Returns the "OData-Version" value, for example "4.0".' - remarks: '' - - isPreview: false - isDeprecated: false + name: toString() + fullName: toString() + langs: + - typeScript + type: method syntax: content: 'toString(): string;' return: - type: string + type: + - string description: '' - - name: tryParseFromHeaders(headers) - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' - package: '@microsoft/sp-http!' - fullName: tryParseFromHeaders(headers) + - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders:member(1)' summary: Attempt to parse the "OData-Version" header. remarks: >- If the "OData-Version" header is present, this returns the corresponding ODataVersion constant. An error is thrown if the version number is not supported. If the header is missing, then undefined is returned. - - isPreview: false - isDeprecated: false + name: tryParseFromHeaders(headers) + fullName: tryParseFromHeaders(headers) + langs: + - typeScript + type: method syntax: content: 'static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' + return: + type: + - '@microsoft/sp-http!ODataVersion.tryParseFromHeaders~0:complex' + description: '' parameters: - id: headers description: '' - type: Headers + type: + - '!Headers:interface' + optional: false + - uid: '@microsoft/sp-http!ODataVersion.v3:member' + summary: Represents version 3.0 for the "OData-Version" header + name: v3 + fullName: v3 + langs: + - typeScript + type: property + syntax: + content: 'static v3: ODataVersion;' return: - type: ' | undefined' - description: '' + type: + - '@microsoft/sp-http!default:class' + - uid: '@microsoft/sp-http!ODataVersion.v4:member' + summary: Represents version 4.0 for the "OData-Version" header + name: v4 + fullName: v4 + langs: + - typeScript + type: property + syntax: + content: 'static v4: ODataVersion;' + return: + type: + - '@microsoft/sp-http!default:class' +references: + - uid: '@microsoft/sp-http!ODataVersion.tryParseFromHeaders~0:complex' + name: ODataVersion | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-http!default:class' + name: ODataVersion + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '!Headers:interface' + name: Headers + - uid: '@microsoft/sp-http!default:class' + name: ODataVersion diff --git a/SP-Framework/sp-http/sphttpclient.yml b/SP-Framework/sp-http/sphttpclient.yml index 44f274cd..dfc05dd2 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -1,115 +1,112 @@ -### YamlMime:TSType -name: SPHttpClient -uid: '@microsoft/sp-http!SPHttpClient:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClient -summary: >- - SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed for - writes, and collects telemetry that helps the service to monitor the performance of an application. -remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. - - For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) class. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' - package: '@microsoft/sp-http!' - fullName: (constructor)(serviceScope) - summary: Constructs a new instance of the `SPHttpClient` class - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'constructor(serviceScope: ServiceScope);' - parameters: - - id: serviceScope - description: '' - type: '' -properties: - - name: configurations - uid: '@microsoft/sp-http!SPHttpClient.configurations:member' - package: '@microsoft/sp-http!' - fullName: configurations - summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly configurations: ISPHttpClientConfigurations;' - return: - type: '' - - name: serviceKey - uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' - package: '@microsoft/sp-http!' - fullName: serviceKey - summary: The service key for SPHttpClient. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'static readonly serviceKey: ServiceKey;' - return: - type: >- - <> -methods: - - name: '_fetch(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#_fetch:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpClient:class' + summary: >- + SPHttpClient is used to perform REST calls against SharePoint. It adds default headers, manages the digest needed + for writes, and collects telemetry that helps the service to monitor the performance of an application. + remarks: >- + This class is marked as `@sealed`. Subclasses should not extend it. + + + For communicating with other internet services, use the [HttpClient](xref:@microsoft/sp-http!HttpClient:class) + class. + name: SPHttpClient + fullName: SPHttpClient + langs: + - typeScript + type: class package: '@microsoft/sp-http!' + children: + - '@microsoft/sp-http!SPHttpClient#_fetch:member(1)' + - '@microsoft/sp-http!SPHttpClient:constructor(1)' + - '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' + - '@microsoft/sp-http!SPHttpClient.configurations:member' + - '@microsoft/sp-http!SPHttpClient#fetch:member(1)' + - '@microsoft/sp-http!SPHttpClient#get:member(1)' + - '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' + - '@microsoft/sp-http!SPHttpClient#isNavigate:member' + - '@microsoft/sp-http!SPHttpClient#post:member(1)' + - '@microsoft/sp-http!SPHttpClient.serviceKey:member' + - uid: '@microsoft/sp-http!SPHttpClient#_fetch:member(1)' + name: '_fetch(url, configuration, options)' fullName: '_fetch(url, configuration, options)' - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: >- protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!SPHttpClient#_fetch~0:complex' + description: '' parameters: - id: url description: '' - type: string + type: + - string + optional: false - id: configuration description: '' - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: '' - type: '' - return: - type: 'Promise<>' - description: '' - - name: beginBatch(batchCreationOptions) - uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' - package: '@microsoft/sp-http!' - fullName: beginBatch(batchCreationOptions) + type: + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClient:constructor(1)' + summary: Constructs a new instance of the `SPHttpClient` class + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - uid: '@microsoft/sp-http!SPHttpClient#beginBatch:member(1)' summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' - remarks: '' - isPreview: true - isDeprecated: false + name: beginBatch(batchCreationOptions) + fullName: beginBatch(batchCreationOptions) + langs: + - typeScript + type: method syntax: content: 'beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;' - parameters: - - id: batchCreationOptions - description: '' - type: '' return: - type: '' + type: + - '@microsoft/sp-http!default:class' description: >- An [SPHttpClientBatch](xref:@microsoft/sp-http!SPHttpClientBatch:class) object used to manage the batch operation. - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' + parameters: + - id: batchCreationOptions + description: '' + type: + - '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClient.configurations:member' + summary: The standard predefined SPHttpClientConfiguration objects for use with the SPHttpClient class. + name: configurations + fullName: configurations + langs: + - typeScript + type: property + syntax: + content: 'static readonly configurations: ISPHttpClientConfigurations;' + return: + type: + - '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + - uid: '@microsoft/sp-http!SPHttpClient#fetch:member(1)' summary: Perform a REST service call. remarks: >- Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API @@ -133,68 +130,79 @@ methods: obtained by issuing a separate request such as "https://example.com/sites/sample/\_api/contextinfo". Typically the appropriate SPWeb URL can be guessed by looking for a reserved URL segment such as "\_api" in the original URL passed to fetch(); if not, use ISPHttpClientOptions.webUrl to specify it explicitly. - - isPreview: false - isDeprecated: false + name: 'fetch(url, configuration, options)' + fullName: 'fetch(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!SPHttpClient#fetch~0:complex' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' + type: + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' + summary: 'Calls fetch(), but sets the method to "GET".' + name: 'get(url, configuration, options)' + fullName: 'get(url, configuration, options)' + langs: + - typeScript + type: method + syntax: + content: >- + get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): + Promise; return: - type: 'Promise<>' + type: + - '@microsoft/sp-http!SPHttpClient#get~0:complex' description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: >- - get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): - Promise; parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: getWebUrlFromRequestUrl(requestUrl) - uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' - package: '@microsoft/sp-http!' - fullName: getWebUrlFromRequestUrl(requestUrl) + type: + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClient.getWebUrlFromRequestUrl:member(1)' summary: Use a heuristic to infer the base URL for authentication. remarks: >- Attempts to infer the SPWeb URL associated with the provided REST URL, by looking for common SharePoint path @@ -208,47 +216,166 @@ methods: If the URL cannot be determined, an exception is thrown. - - isPreview: false - isDeprecated: false + name: getWebUrlFromRequestUrl(requestUrl) + fullName: getWebUrlFromRequestUrl(requestUrl) + langs: + - typeScript + type: method syntax: content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' + return: + type: + - string + description: the inferred SPWeb URL parameters: - id: requestUrl description: The URL for a SharePoint REST service - type: string + type: + - string + optional: false + - uid: '@microsoft/sp-http!SPHttpClient#isNavigate:member' + name: isNavigate + fullName: isNavigate + langs: + - typeScript + type: property + syntax: + content: |- + get isNavigate(): Boolean; + + set isNavigate(isNavigate: Boolean); return: - type: string - description: the inferred SPWeb URL - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' + type: + - '!Boolean:interface' + - uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' summary: 'Calls fetch(), but sets the method to "POST".' - remarks: '' - - isPreview: false - isDeprecated: false + name: 'post(url, configuration, options)' + fullName: 'post(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise; + return: + type: + - '@microsoft/sp-http!SPHttpClient#post~0:complex' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' + type: + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' + summary: The service key for SPHttpClient. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + syntax: + content: 'static readonly serviceKey: ServiceKey;' return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. + type: + - '@microsoft/sp-http!SPHttpClient.serviceKey~0:complex' +references: + - uid: '@microsoft/sp-http!SPHttpClient#_fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientOptions:interface' + name: ISPHttpClientOptions + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface' + name: ISPHttpClientBatchCreationOptions + - uid: '@microsoft/sp-http!ISPHttpClientConfigurations:interface' + name: ISPHttpClientConfigurations + - uid: '@microsoft/sp-http!SPHttpClient#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClient#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '!Boolean:interface' + name: Boolean + - uid: '@microsoft/sp-http!SPHttpClient#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClient.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClient + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/sphttpclientbatch.yml b/SP-Framework/sp-http/sphttpclientbatch.yml index 0ca41b92..639e617e 100644 --- a/SP-Framework/sp-http/sphttpclientbatch.yml +++ b/SP-Framework/sp-http/sphttpclientbatch.yml @@ -1,57 +1,59 @@ -### YamlMime:TSType -name: SPHttpClientBatch -uid: '@microsoft/sp-http!SPHttpClientBatch:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientBatch -summary: >- - The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. - This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpClientBatch:class' + summary: >- + The SPHttpClientBatch class accumulates a number of REST service calls and transmits them as a single ODATA batch. + This protocol is documented here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html - The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call - SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves when - the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an - SPHttpClientResponse object for that particular request. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPHttpClientBatch` class. -isPreview: true -isDeprecated: false -type: class -properties: - - name: configurations - uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' + The usage is to call SPHttpClientBatch.fetch() to queue each individual request, and then call + SPHttpClientBatch.execute() to execute the batch operation. The execute() method returns a promise that resolves + when the real REST call has completed. Each call to fetch() also returns a promise that will resolve with an + SPHttpClientResponse object for that particular request. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPHttpClientBatch` class. + isPreview: true + name: SPHttpClientBatch + fullName: SPHttpClientBatch + langs: + - typeScript + type: class package: '@microsoft/sp-http!' - fullName: configurations + children: + - '@microsoft/sp-http!SPHttpClientBatch.configurations:member' + - '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' + - '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' + - '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' + - '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' + - uid: '@microsoft/sp-http!SPHttpClientBatch.configurations:member' summary: The standard predefined SPHttpClientBatchConfigurations objects for use with the SPHttpClientBatch class. - remarks: '' - isPreview: true - isDeprecated: false + name: configurations + fullName: configurations + langs: + - typeScript + type: property syntax: content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: - type: '' -methods: - - name: execute() - uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' - package: '@microsoft/sp-http!' - fullName: execute() + type: + - '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatch#execute:member(1)' summary: Executes the batched queries that were queued using SPHttpClientBatch.fetch(). - remarks: '' - isPreview: true - isDeprecated: false + name: execute() + fullName: execute() + langs: + - typeScript + type: method syntax: content: 'execute(): Promise;' return: - type: 'Promise<>' + type: + - '@microsoft/sp-http!SPHttpClientBatch#execute~0:complex' description: '' - - name: 'fetch(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' - package: '@microsoft/sp-http!' - fullName: 'fetch(url, configuration, options)' + - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch:member(1)' summary: >- Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed). @@ -70,93 +72,178 @@ methods: SPHttpClientBatch can successfully guess the appropriate SPWeb URL by looking for a reserved URL segment such as "\_api" in the first URL passed to fetch(). If not, use ISPHttpClientBatchCreationOptions.webUrl to specify it explicitly. - isPreview: true - isDeprecated: false + name: 'fetch(url, configuration, options)' + fullName: 'fetch(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise; + return: + type: + - '@microsoft/sp-http!SPHttpClientBatch#fetch~0:complex' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'get(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' - package: '@microsoft/sp-http!' - fullName: 'get(url, configuration, options)' + type: + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientBatch#get:member(1)' summary: 'Calls fetch(), but sets the method to ''GET''.' - remarks: '' - isPreview: true - isDeprecated: false + name: 'get(url, configuration, options)' + fullName: 'get(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise; + return: + type: + - '@microsoft/sp-http!SPHttpClientBatch#get~0:complex' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. - - name: 'post(url, configuration, options)' - uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' - package: '@microsoft/sp-http!' - fullName: 'post(url, configuration, options)' + type: + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientBatch#post:member(1)' summary: 'Calls fetch(), but sets the method to ''POST''.' - remarks: '' - isPreview: true - isDeprecated: false + name: 'post(url, configuration, options)' + fullName: 'post(url, configuration, options)' + langs: + - typeScript + type: method syntax: content: >- post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise; + return: + type: + - '@microsoft/sp-http!SPHttpClientBatch#post~0:complex' + description: >- + A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with + [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status + codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent + communication with the server. parameters: - id: url description: the URL to fetch - type: string + type: + - string + optional: false - id: configuration description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations - type: '' + type: + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request - type: '' - return: - type: 'Promise<>' - description: >- - A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with - [HttpClientResponse.ok](xref:@microsoft/sp-http!HttpClientResponse%23ok:member) being false) for error status - codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent - communication with the server. + type: + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + optional: false +references: + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface' + name: ISPHttpClientBatchConfigurations + - uid: '@microsoft/sp-http!SPHttpClientBatch#execute~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatch + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClientBatch#fetch~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + name: ISPHttpClientBatchOptions + - uid: '@microsoft/sp-http!SPHttpClientBatch#get~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-http!SPHttpClientBatch#post~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientResponse + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml index 9a05ba91..d518eaab 100644 --- a/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientbatchconfiguration.yml @@ -1,88 +1,103 @@ -### YamlMime:TSType -name: SPHttpClientBatchConfiguration -uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientBatchConfiguration -summary: Configuration for SPHttpClientBatch. -remarks: >- - The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the - SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing - one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the - SPHttpClientBatchConfiguration.overrideWith() method. - -isPreview: true -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:class' + summary: Configuration for SPHttpClientBatch. + remarks: >- + The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of + the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by + providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be + changed via the SPHttpClientBatchConfiguration.overrideWith() method. + isPreview: true + name: SPHttpClientBatchConfiguration + fullName: SPHttpClientBatchConfiguration + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' + implements: + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' + children: + - '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration:constructor(1)' summary: >- Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - isPreview: true - isDeprecated: false + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(flags: ISPHttpClientBatchConfiguration, overrideFlags?: ISPHttpClientBatchConfiguration);' parameters: - id: flags description: '' - type: '' + type: + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + optional: false - id: overrideFlags description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' - package: '@microsoft/sp-http!' - fullName: flags - summary: '' - remarks: '' - + type: + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' isPreview: true - isDeprecated: false + name: flags + fullName: flags + langs: + - typeScript + type: property syntax: content: 'protected flags: ISPHttpClientBatchConfiguration;' return: - type: '' -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() - summary: '' - remarks: '' - + type: + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' isPreview: true - isDeprecated: false + name: initializeFlags() + fullName: initializeFlags() + langs: + - typeScript + type: method syntax: content: |- /** @override */ protected initializeFlags(): void; return: - type: void + type: + - void description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' - fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' isPreview: true - isDeprecated: false + name: overrideWith(sourceFlags) + fullName: overrideWith(sourceFlags) + langs: + - typeScript + type: method syntax: content: |- /** @override */ overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' parameters: - id: sourceFlags description: '' - type: '' - return: - type: '' - description: '' -extends: '' + type: + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + optional: false +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + name: ISPHttpClientBatchConfiguration diff --git a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml index 9656a10a..f946ef6c 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -1,53 +1,75 @@ -### YamlMime:TSType -name: SPHttpClientCommonConfiguration -uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientCommonConfiguration -summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' + summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. + name: SPHttpClientCommonConfiguration + fullName: SPHttpClientCommonConfiguration + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' + implements: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' + children: + - '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' + - '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:constructor(1)' summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - - isPreview: false - isDeprecated: false + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);' parameters: - id: flags description: '' - type: '' + type: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + optional: false - id: overrideFlags description: '' - type: '' -properties: - - name: flags - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' - package: '@microsoft/sp-http!' + type: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' + name: flags fullName: flags - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected flags: ISPHttpClientCommonConfiguration;' return: - type: '' - - name: jsonRequest - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' - package: '@microsoft/sp-http!' - fullName: jsonRequest + type: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' + name: initializeFlags() + fullName: initializeFlags() + langs: + - typeScript + type: method + syntax: + content: |- + /** @override */ + protected initializeFlags(): void; + return: + type: + - void + description: '' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonRequest:member' summary: Automatically configure the "Content-Type" header for a JSON payload. remarks: >- When this switch is true: @@ -61,17 +83,17 @@ properties: For OData 4.0, the value is 'application/json;charset=utf-8'. - - isPreview: false - isDeprecated: false + name: jsonRequest + fullName: jsonRequest + langs: + - typeScript + type: property syntax: content: 'get jsonRequest(): boolean;' return: - type: boolean - - name: jsonResponse - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' - package: '@microsoft/sp-http!' - fullName: jsonResponse + type: + - boolean + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#jsonResponse:member' summary: Automatically configure the "Accept" header for a JSON payload. remarks: |- When this switch is true: @@ -81,48 +103,38 @@ properties: For OData 3.0, the value is 'application/json'. For OData 4.0, the value is 'application/json;odata.metadata=minimal'. - - isPreview: false - isDeprecated: false + name: jsonResponse + fullName: jsonResponse + langs: + - typeScript + type: property syntax: content: 'get jsonResponse(): boolean;' return: - type: boolean -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' - fullName: initializeFlags() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - protected initializeFlags(): void; - return: - type: void - description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' + type: + - boolean + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' + name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- /** @override */ overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' parameters: - id: sourceFlags description: '' - type: '' - return: - type: '' - description: '' -extends: '' + type: + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + optional: false +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + name: ISPHttpClientCommonConfiguration diff --git a/SP-Framework/sp-http/sphttpclientconfiguration.yml b/SP-Framework/sp-http/sphttpclientconfiguration.yml index f8d01b40..13130e18 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -1,44 +1,55 @@ -### YamlMime:TSType -name: SPHttpClientConfiguration -uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientConfiguration -summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' -remarks: >- - The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the - SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the - predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the - SPHttpClientConfiguration.overrideWith() method. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(flags, overrideFlags)' - uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpClientConfiguration:class' + summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class).' + remarks: >- + The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the + SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of + the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the + SPHttpClientConfiguration.overrideWith() method. + name: SPHttpClientConfiguration + fullName: SPHttpClientConfiguration + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' + implements: + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' package: '@microsoft/sp-http!' - fullName: '(constructor)(flags, overrideFlags)' + children: + - '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' + - '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' + - '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' + - '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' + - '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' + - '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' + - '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration:constructor(1)' summary: >- Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);' parameters: - id: flags description: '' - type: '' + type: + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + optional: false - id: overrideFlags description: '' - type: '' -properties: - - name: defaultODataVersion - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' - package: '@microsoft/sp-http!' - fullName: defaultODataVersion + type: + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultODataVersion:member' summary: Automatically configure the "OData-Version" header. remarks: >- When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the @@ -47,17 +58,17 @@ properties: NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0. - - isPreview: false - isDeprecated: false + name: defaultODataVersion + fullName: defaultODataVersion + langs: + - typeScript + type: property syntax: content: 'get defaultODataVersion(): ODataVersion;' return: - type: '' - - name: defaultSameOriginCredentials - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' - package: '@microsoft/sp-http!' - fullName: defaultSameOriginCredentials + type: + - '@microsoft/sp-http!default:class' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#defaultSameOriginCredentials:member' summary: Automatically configure the RequestInit.credentials. remarks: >- When this switch is true: @@ -68,80 +79,82 @@ properties: For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials - - isPreview: false - isDeprecated: false + name: defaultSameOriginCredentials + fullName: defaultSameOriginCredentials + langs: + - typeScript + type: property syntax: content: 'get defaultSameOriginCredentials(): boolean;' return: - type: boolean - - name: flags - uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' - package: '@microsoft/sp-http!' + type: + - boolean + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' + name: flags fullName: flags - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'protected flags: ISPHttpClientConfiguration;' return: - type: '' - - name: requestDigest - uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' - package: '@microsoft/sp-http!' - fullName: requestDigest - summary: Automatically provide an "X-RequestDigest" header for authentication. - remarks: >- - When this switch is true: - - - If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the - request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is - managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. - - isPreview: false - isDeprecated: false - syntax: - content: 'get requestDigest(): boolean;' - return: - type: boolean -methods: - - name: initializeFlags() - uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' - package: '@microsoft/sp-http!' + type: + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' + name: initializeFlags() fullName: initializeFlags() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- /** @override */ protected initializeFlags(): void; return: - type: void + type: + - void description: '' - - name: overrideWith(sourceFlags) - uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' - package: '@microsoft/sp-http!' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' + name: overrideWith(sourceFlags) fullName: overrideWith(sourceFlags) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: |- /** @override */ overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' parameters: - id: sourceFlags description: '' - type: '' + type: + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#requestDigest:member' + summary: Automatically provide an "X-RequestDigest" header for authentication. + remarks: >- + When this switch is true: + + + If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the + request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is + managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed. + name: requestDigest + fullName: requestDigest + langs: + - typeScript + type: property + syntax: + content: 'get requestDigest(): boolean;' return: - type: '' - description: '' -extends: '' + type: + - boolean +references: + - uid: '@microsoft/sp-http!default:class' + name: SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + name: ISPHttpClientConfiguration diff --git a/SP-Framework/sp-http/sphttpclientresponse.yml b/SP-Framework/sp-http/sphttpclientresponse.yml index 8f41cee5..09d4b387 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -1,65 +1,82 @@ -### YamlMime:TSType -name: SPHttpClientResponse -uid: '@microsoft/sp-http!SPHttpClientResponse:class' -package: '@microsoft/sp-http!' -fullName: SPHttpClientResponse -summary: The Response subclass returned by methods such as SPHttpClient.fetch(). -remarks: |- - This class is marked as `@sealed`. Subclasses should not extend it. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpClientResponse:class' + summary: The Response subclass returned by methods such as SPHttpClient.fetch(). + remarks: |- + This class is marked as `@sealed`. Subclasses should not extend it. - This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(response) - uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' + This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class. + name: SPHttpClientResponse + fullName: SPHttpClientResponse + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' package: '@microsoft/sp-http!' - fullName: (constructor)(response) + children: + - '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' + - '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' + - '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' + - uid: '@microsoft/sp-http!SPHttpClientResponse:constructor(1)' summary: Constructs a new instance of the `SPHttpClientResponse` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(response) + fullName: (constructor)(response) + langs: + - typeScript + type: constructor syntax: content: 'constructor(response: Response);' parameters: - id: response description: '' - type: Response -properties: - - name: correlationId - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' - package: '@microsoft/sp-http!' - fullName: correlationId + type: + - '!Response:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' + name: clone() + fullName: clone() + langs: + - typeScript + type: method + syntax: + content: |- + /** @override */ + clone(): SPHttpClientResponse; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' + - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId:member' summary: Returns the SharePoint correlation ID. remarks: >- The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header. - isPreview: true - isDeprecated: false + name: correlationId + fullName: correlationId + langs: + - typeScript + type: property syntax: content: 'get correlationId(): Guid | undefined;' return: - type: ' | undefined' -methods: - - name: clone() - uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' - package: '@microsoft/sp-http!' - fullName: clone() - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: |- - /** @override */ - clone(): SPHttpClientResponse; - return: - type: '' - description: '' -extends: '' + type: + - '@microsoft/sp-http!SPHttpClientResponse#correlationId~0:complex' +references: + - uid: '@microsoft/sp-http!default:class' + name: HttpClientResponse + - uid: '!Response:interface' + name: Response + - uid: '@microsoft/sp-http!SPHttpClientResponse#correlationId~0:complex' + name: Guid | undefined + fullName: Guid | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + fullName: Guid + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-http/sphttpheader.yml b/SP-Framework/sp-http/sphttpheader.yml index 94b346d7..45eb0a18 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -1,19 +1,25 @@ -### YamlMime:TSEnum -name: SPHttpHeader -uid: '@microsoft/sp-http!SPHttpHeader:enum' -package: '@microsoft/sp-http!' -fullName: SPHttpHeader -summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' -remarks: '' - -isPreview: true -isDeprecated: false -fields: - - name: SPRequestGuid - uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!SPHttpHeader:enum' + summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http!SPHttpClient:class)' + isPreview: true + name: SPHttpHeader + fullName: SPHttpHeader + langs: + - typeScript + type: enum package: '@microsoft/sp-http!' + children: + - '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' + - uid: '@microsoft/sp-http!SPHttpHeader.SPRequestGuid:member' summary: |- SharePoint uses the 'SPRequestGuid' header to return the server's correlation ID for a request. Example value: "9417279e-40e1-0000-2465-306ba786bfd7" - value: '"SPRequestGuid"' + isPreview: true + name: SPRequestGuid + fullName: SPRequestGuid + langs: + - typeScript + type: field + numericValue: '"SPRequestGuid"' diff --git a/SP-Framework/sp-http/tokenacquisitioneventargs.yml b/SP-Framework/sp-http/tokenacquisitioneventargs.yml index 04f4ed44..84893cab 100644 --- a/SP-Framework/sp-http/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -1,58 +1,65 @@ -### YamlMime:TSType -name: TokenAcquisitionEventArgs -uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' -package: '@microsoft/sp-http!' -fullName: TokenAcquisitionEventArgs -summary: Arguments for a token acquisition failure event. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(message, redirectUrl)' - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + summary: Arguments for a token acquisition failure event. + name: TokenAcquisitionEventArgs + fullName: TokenAcquisitionEventArgs + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-http!' - fullName: '(constructor)(message, redirectUrl)' + children: + - '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' + - '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' + - '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)' summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(message, redirectUrl)' + fullName: '(constructor)(message, redirectUrl)' + langs: + - typeScript + type: constructor syntax: content: 'constructor(message: string, redirectUrl?: string);' parameters: - id: message description: '' - type: string + type: + - string + optional: false - id: redirectUrl description: '' - type: string -properties: - - name: message - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' - package: '@microsoft/sp-http!' - fullName: message + type: + - string + optional: true + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#message:member' summary: The message returned from ADAL fails to retrieve a token from Azure AD. - remarks: '' - - isPreview: false - isDeprecated: false + name: message + fullName: message + langs: + - typeScript + type: property syntax: content: 'message: string;' return: - type: string - - name: redirectUrl - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' - package: '@microsoft/sp-http!' - fullName: redirectUrl + type: + - string + - uid: '@microsoft/sp-http!TokenAcquisitionEventArgs#redirectUrl:member' summary: The url of the page for the end user to perform Multi Factor Authentication - remarks: '' - - isPreview: false - isDeprecated: false + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property syntax: content: 'redirectUrl?: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs diff --git a/SP-Framework/sp-image-helper.yml b/SP-Framework/sp-image-helper.yml index 6c5b2219..78bad61a 100644 --- a/SP-Framework/sp-image-helper.yml +++ b/SP-Framework/sp-image-helper.yml @@ -1,9 +1,31 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-image-helper!' -name: '@microsoft/sp-image-helper' -type: package -summary: SharePoint Framework helper library to generate image urls optimized for delivery. -interfaces: - - '@microsoft/sp-image-helper!IImageHelperRequest:interface' -classes: - - '@microsoft/sp-image-helper!ImageHelper:class' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-image-helper!' + summary: SharePoint Framework helper library to generate image urls optimized for delivery. + name: '@microsoft/sp-image-helper' + fullName: '@microsoft/sp-image-helper' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-image-helper!_ThumbnailUrlGenerator:var' + - '@microsoft/sp-image-helper!IImageHelperRequest:interface' + - '@microsoft/sp-image-helper!ImageHelper:class' + - uid: '@microsoft/sp-image-helper!_ThumbnailUrlGenerator:var' + name: _ThumbnailUrlGenerator + fullName: _ThumbnailUrlGenerator + langs: + - typeScript + type: variable + syntax: + content: '_default: _ThumbnailUrlGenerator' + return: + type: + - '@microsoft/sp-image-helper!_ThumbnailUrlGenerator:class' +references: + - uid: '@microsoft/sp-image-helper!_ThumbnailUrlGenerator:class' + name: _ThumbnailUrlGenerator + - uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' + name: IImageHelperRequest + - uid: '@microsoft/sp-image-helper!ImageHelper:class' + name: ImageHelper diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 16d864be..31437a57 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -1,54 +1,55 @@ -### YamlMime:TSType -name: IImageHelperRequest -uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' -package: '@microsoft/sp-image-helper!' -fullName: IImageHelperRequest -summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: height - uid: '@microsoft/sp-image-helper!IImageHelperRequest#height:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' + summary: Interface for constructing a request to create an optimized image url from a file on SharePoint. + name: IImageHelperRequest + fullName: IImageHelperRequest + langs: + - typeScript + type: interface package: '@microsoft/sp-image-helper!' - fullName: height + children: + - '@microsoft/sp-image-helper!IImageHelperRequest#height:member' + - '@microsoft/sp-image-helper!IImageHelperRequest#sourceUrl:member' + - '@microsoft/sp-image-helper!IImageHelperRequest#width:member' + - uid: '@microsoft/sp-image-helper!IImageHelperRequest#height:member' summary: Optional height of the image requested remarks: >- By default, the image height would be based on the width while maintaining the aspect ratio for the image. (This provides the image with the quickest response.) When the height is specified, the width is not adjusted to the nearest larger resolution breakpoint. - - isPreview: false - isDeprecated: false + name: height + fullName: height + langs: + - typeScript + type: property syntax: content: 'height?: number;' return: - type: number - - name: sourceUrl - uid: '@microsoft/sp-image-helper!IImageHelperRequest#sourceUrl:member' - package: '@microsoft/sp-image-helper!' - fullName: sourceUrl + type: + - number + - uid: '@microsoft/sp-image-helper!IImageHelperRequest#sourceUrl:member' summary: The url to the item to be retrieved as an image. This can be an absolute url or a relative url. - remarks: '' - - isPreview: false - isDeprecated: false + name: sourceUrl + fullName: sourceUrl + langs: + - typeScript + type: property syntax: content: 'sourceUrl: string;' return: - type: string - - name: width - uid: '@microsoft/sp-image-helper!IImageHelperRequest#width:member' - package: '@microsoft/sp-image-helper!' - fullName: width + type: + - string + - uid: '@microsoft/sp-image-helper!IImageHelperRequest#width:member' summary: Width of the image requested. remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' - - isPreview: false - isDeprecated: false + name: width + fullName: width + langs: + - typeScript + type: property syntax: content: 'width: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 3b69fa35..24ea14bd 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -1,36 +1,41 @@ -### YamlMime:TSType -name: ImageHelper -uid: '@microsoft/sp-image-helper!ImageHelper:class' -package: '@microsoft/sp-image-helper!' -fullName: ImageHelper -summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -methods: - - name: convertToImageUrl(request) - uid: '@microsoft/sp-image-helper!ImageHelper.convertToImageUrl:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-image-helper!ImageHelper:class' + summary: ImageHelper exposes the ability to convert a SharePoint url to an optimized thumbnail url. + name: ImageHelper + fullName: ImageHelper + langs: + - typeScript + type: class package: '@microsoft/sp-image-helper!' - fullName: convertToImageUrl(request) + children: + - '@microsoft/sp-image-helper!ImageHelper.convertToImageUrl:member(1)' + - uid: '@microsoft/sp-image-helper!ImageHelper.convertToImageUrl:member(1)' summary: Convert a url to a file or page on SharePoint into an optimized image url. remarks: >- - If width and height are provided, then the resulting image will be scaled to the minimum of the width or height. - The url will be most performant if only a width is provided. If a height is provided, the image will take longer to download due to the scaling. - Only use this url at rendering time. It may contain an expiration token. Continue to use the original file's url for serialization. - - isPreview: false - isDeprecated: false + name: convertToImageUrl(request) + fullName: convertToImageUrl(request) + langs: + - typeScript + type: method syntax: content: 'static convertToImageUrl(request: IImageHelperRequest): string;' - parameters: - - id: request - description: IImageHelperRequest for the bundled parameters. - type: '' return: - type: string + type: + - string description: >- A full url string for the image of the file. If no optimized url can be created (i.e. an external url or an unsupported file type), the original sourceUrl is returned. + parameters: + - id: request + description: IImageHelperRequest for the bundled parameters. + type: + - '@microsoft/sp-image-helper!IImageHelperRequest:interface' + optional: false +references: + - uid: '@microsoft/sp-image-helper!IImageHelperRequest:interface' + name: IImageHelperRequest diff --git a/SP-Framework/sp-list-subscription.yml b/SP-Framework/sp-list-subscription.yml index 8fd3ea01..41ef4b57 100644 --- a/SP-Framework/sp-list-subscription.yml +++ b/SP-Framework/sp-list-subscription.yml @@ -1,11 +1,26 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-list-subscription!' -name: '@microsoft/sp-list-subscription' -type: package -summary: This package provides developer support for subscribing to changes in a SharePoint document library. -interfaces: - - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' - - '@microsoft/sp-list-subscription!IListSubscription:interface' - - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' -classes: - - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!' + summary: This package provides developer support for subscribing to changes in a SharePoint document library. + remarks: >- + This package creates and manages subscriptions to SharePoint document libraries. It registers callbacks provided + by the developer with the subscription to handle subscription events. + name: '@microsoft/sp-list-subscription' + fullName: '@microsoft/sp-list-subscription' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + - '@microsoft/sp-list-subscription!IListSubscription:interface' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' +references: + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + name: ICreateSubscriptionSettings + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + name: IListSubscription + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + name: ISubscriptionCallbacks + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' + name: ListSubscriptionFactory diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index 0a25ab34..1617f163 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -1,88 +1,92 @@ -### YamlMime:TSType -name: ICreateSubscriptionSettings -uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' -package: '@microsoft/sp-list-subscription!' -fullName: ICreateSubscriptionSettings -summary: >- - A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a web, - you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you will need - to provide it as well. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + summary: >- + A list subscription requires at least a site ID and list ID. If the list is not contained in the root site of a + web, you need to pass in the subweb id. If the domain you are accessing is different than the current domain, you + will need to provide it as well. - In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, and - the current domain, site and web will be used. -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: callbacks - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' + In the simple case (say a teamsite document library) in the current site, you can simply provide the library ID, + and the current domain, site and web will be used. + name: ICreateSubscriptionSettings + fullName: ICreateSubscriptionSettings + langs: + - typeScript + type: interface package: '@microsoft/sp-list-subscription!' - fullName: callbacks + children: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#callbacks:member' summary: the list of callbacks - remarks: '' - - isPreview: false - isDeprecated: false + name: callbacks + fullName: callbacks + langs: + - typeScript + type: property syntax: content: 'callbacks: ISubscriptionCallbacks;' return: - type: '' - - name: domain - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' - package: '@microsoft/sp-list-subscription!' - fullName: domain + type: + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' - remarks: '' - - isPreview: false - isDeprecated: false + name: domain + fullName: domain + langs: + - typeScript + type: property syntax: content: 'domain?: string;' return: - type: string - - name: listId - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' - package: '@microsoft/sp-list-subscription!' - fullName: listId + type: + - string + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' - remarks: '' - - isPreview: false - isDeprecated: false + name: listId + fullName: listId + langs: + - typeScript + type: property syntax: content: 'listId?: Guid;' return: - type: '' - - name: siteId - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' - package: '@microsoft/sp-list-subscription!' - fullName: siteId + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' summary: >- The SharePoint Site Id (assuming it is not the current site) If the siteId parameter is not provided, the current site will be used. - remarks: '' - - isPreview: false - isDeprecated: false + name: siteId + fullName: siteId + langs: + - typeScript + type: property syntax: content: 'siteId?: Guid;' return: - type: '' - - name: webId - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' - package: '@microsoft/sp-list-subscription!' - fullName: webId + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' summary: >- The SharePoint Web Id (assuming it is not the current web) If the webId parameter is not provided, the current web will be used. - remarks: '' - - isPreview: false - isDeprecated: false + name: webId + fullName: webId + langs: + - typeScript + type: property syntax: content: 'webId?: Guid;' return: - type: '' + type: + - '@microsoft/sp-core-library!Guid:class' +references: + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + name: ISubscriptionCallbacks + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index fd55ce35..6a89fefa 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -1,25 +1,27 @@ -### YamlMime:TSType -name: IListSubscription -uid: '@microsoft/sp-list-subscription!IListSubscription:interface' -package: '@microsoft/sp-list-subscription!' -fullName: IListSubscription -summary: A subscription to a SharePoint list resource. Contains the id of the subscription. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + summary: A subscription to a SharePoint list resource. Contains the id of the subscription. + name: IListSubscription + fullName: IListSubscription + langs: + - typeScript + type: interface package: '@microsoft/sp-list-subscription!' - fullName: id + children: + - '@microsoft/sp-list-subscription!IListSubscription#id:member' + - uid: '@microsoft/sp-list-subscription!IListSubscription#id:member' summary: The id of the subscription. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: Guid;' return: - type: '' + type: + - '@microsoft/sp-core-library!Guid:class' +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml index cc1390b0..4e0aa4bb 100644 --- a/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml +++ b/SP-Framework/sp-list-subscription/isubscriptioncallbacks.yml @@ -1,51 +1,50 @@ -### YamlMime:TSType -name: ISubscriptionCallbacks -uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' -package: '@microsoft/sp-list-subscription!' -fullName: ISubscriptionCallbacks -summary: The callbacks that can be triggered by a subscription event. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: connect - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks:interface' + summary: The callbacks that can be triggered by a subscription event. + name: ISubscriptionCallbacks + fullName: ISubscriptionCallbacks + langs: + - typeScript + type: interface package: '@microsoft/sp-list-subscription!' - fullName: connect + children: + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' + - '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#connect:member' summary: The callback to invoke when a connection has been made to the list. - remarks: '' - - isPreview: false - isDeprecated: false + name: connect + fullName: connect + langs: + - typeScript + type: property syntax: content: 'connect?: () => void;' return: - type: () => void - - name: disconnect - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' - package: '@microsoft/sp-list-subscription!' - fullName: disconnect + type: + - () => void + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#disconnect:member' summary: The callback to invoke when the subscription is disconnected from the list. - remarks: '' - - isPreview: false - isDeprecated: false + name: disconnect + fullName: disconnect + langs: + - typeScript + type: property syntax: content: 'disconnect?: (reason: string) => void;' return: - type: '(reason: string) => void' - - name: notification - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' - package: '@microsoft/sp-list-subscription!' - fullName: notification + type: + - '(reason: string) => void' + - uid: '@microsoft/sp-list-subscription!ISubscriptionCallbacks#notification:member' summary: The callback to invoke when a change occurs in the list. - remarks: '' - - isPreview: false - isDeprecated: false + name: notification + fullName: notification + langs: + - typeScript + type: property syntax: content: 'notification: () => void;' return: - type: () => void + type: + - () => void diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index abee5bb4..cf2c796f 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -1,66 +1,90 @@ -### YamlMime:TSType -name: ListSubscriptionFactory -uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' -package: '@microsoft/sp-list-subscription!' -fullName: ListSubscriptionFactory -summary: >- - Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the - subscription to handle subscription events. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(component) - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:class' + summary: >- + Creates and manages subscriptions to list resources. Registers callbacks provided by the developer with the + subscription to handle subscription events. + name: ListSubscriptionFactory + fullName: ListSubscriptionFactory + langs: + - typeScript + type: class package: '@microsoft/sp-list-subscription!' - fullName: (constructor)(component) + children: + - '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' + - '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' + - '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory:constructor(1)' summary: Constructs a new instance of the `ListSubscriptionFactory` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(component) + fullName: (constructor)(component) + langs: + - typeScript + type: constructor syntax: content: 'constructor(component: BaseComponent);' parameters: - id: component description: '' - type: '' -methods: - - name: createSubscription(settings) - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' - package: '@microsoft/sp-list-subscription!' - fullName: createSubscription(settings) + type: + - '@microsoft/sp-component-base!BaseComponent:class' + optional: false + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' summary: Creates a connection to the list specified by the site id and list id. - remarks: '' - - isPreview: false - isDeprecated: false + name: createSubscription(settings) + fullName: createSubscription(settings) + langs: + - typeScript + type: method syntax: content: 'createSubscription(settings: ICreateSubscriptionSettings): Promise;' + return: + type: + - '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription~0:complex' + description: Promise of the subscription to the list. parameters: - id: settings description: The various parameters - type: '' - return: - type: 'Promise<>' - description: Promise of the subscription to the list. - - name: deleteSubscription(subscription) - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' - package: '@microsoft/sp-list-subscription!' - fullName: deleteSubscription(subscription) + type: + - '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + optional: false + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' summary: Deletes the subscription's connection to the resource. - remarks: '' - - isPreview: false - isDeprecated: false + name: deleteSubscription(subscription) + fullName: deleteSubscription(subscription) + langs: + - typeScript + type: method syntax: content: 'deleteSubscription(subscription: IListSubscription): void;' + return: + type: + - void + description: '' parameters: - id: subscription description: The subscription to delete. - type: '' - return: - type: void - description: '' + type: + - '@microsoft/sp-list-subscription!IListSubscription:interface' + optional: false +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + name: IListSubscription + fullName: IListSubscription + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings:interface' + name: ICreateSubscriptionSettings + - uid: '@microsoft/sp-list-subscription!IListSubscription:interface' + name: IListSubscription diff --git a/SP-Framework/sp-listview-extensibility.yml b/SP-Framework/sp-listview-extensibility.yml index a8081299..cde7192c 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -1,34 +1,89 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-listview-extensibility!' -name: '@microsoft/sp-listview-extensibility' -type: package -summary: SharePoint Framework support for customizing the list view. -classes: - - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' - - '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' - - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' - - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' - - '@microsoft/sp-listview-extensibility!Command:class' - - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' - - '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' - - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' - - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' - - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' - - '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' - - '@microsoft/sp-listview-extensibility!RowAccessor:class' - - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' -interfaces: - - '@microsoft/sp-listview-extensibility!IColumn:interface' - - '@microsoft/sp-listview-extensibility!IContentType:interface' - - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' - - '@microsoft/sp-listview-extensibility!IFilter:interface' - - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' - - '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' - - '@microsoft/sp-listview-extensibility!IList:interface' - - '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' - - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' - - '@microsoft/sp-listview-extensibility!IRow:interface' - - '@microsoft/sp-listview-extensibility!IView:interface' -enums: - - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!' + summary: SharePoint Framework support for customizing the list view. + name: '@microsoft/sp-listview-extensibility' + fullName: '@microsoft/sp-listview-extensibility' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + - '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + - '@microsoft/sp-listview-extensibility!Command:class' + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' + - '@microsoft/sp-listview-extensibility!IColumn:interface' + - '@microsoft/sp-listview-extensibility!IContentType:interface' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IFilter:interface' + - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' + - '@microsoft/sp-listview-extensibility!IList:interface' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + - '@microsoft/sp-listview-extensibility!IRow:interface' + - '@microsoft/sp-listview-extensibility!IView:interface' + - '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + - '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' + - '@microsoft/sp-listview-extensibility!RowAccessor:class' + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' +references: + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + name: BaseFieldCustomizer + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' + name: BaseFormCustomizer + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + name: BaseListViewCommandSet + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + name: ColumnAccessor + - uid: '@microsoft/sp-listview-extensibility!Command:class' + name: Command + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + name: FieldCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' + name: FormCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!IColumn:interface' + name: IColumn + - uid: '@microsoft/sp-listview-extensibility!IContentType:interface' + name: IContentType + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + name: IFieldCustomizerCellEventParameters + - uid: '@microsoft/sp-listview-extensibility!IFilter:interface' + name: IFilter + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + name: IFolderInfo + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' + name: IFormCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!IList:interface' + name: IList + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' + name: IListViewAccessorState + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + name: IListViewCommandSetExecuteEventParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + name: IListViewCommandSetListViewUpdatedParameters + - uid: '@microsoft/sp-listview-extensibility!IRow:interface' + name: IRow + - uid: '@microsoft/sp-listview-extensibility!IView:interface' + name: IView + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + name: ListItemAccessor + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + name: ListViewAccessor + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' + name: ListViewAccessorStateChanges + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + name: ListViewCommandSetContext + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' + name: ListViewStateChangedEventArgs + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + name: SelectedRowsChangedEventArgs diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 73e9f567..cd6e7cf6 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -1,71 +1,86 @@ -### YamlMime:TSType -name: BaseFieldCustomizer -uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: BaseFieldCustomizer -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that customizes the - appearance of fields in a SharePoint ListView. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' + summary: >- + This is the base class that third parties should extend when implementing a client-side extension that customizes + the appearance of fields in a SharePoint ListView. - In the component manifest, the "extensionType" should be set to "FieldCustomizer". -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' + In the component manifest, the "extensionType" should be set to "FieldCustomizer". + name: BaseFieldCustomizer + fullName: BaseFieldCustomizer + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-listview-extensibility!' - fullName: context + children: + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' + - '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'protected readonly context: FieldCustomizerContext;' return: - type: '' -methods: - - name: onDisposeCell(event) - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' - package: '@microsoft/sp-listview-extensibility!' + type: + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' + name: onDisposeCell(event) fullName: onDisposeCell(event) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' + return: + type: + - void + description: '' parameters: - id: event description: '' - type: '' - return: - type: void - description: '' - - name: onRenderCell(event) - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' - package: '@microsoft/sp-listview-extensibility!' + type: + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + optional: false + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' + name: onRenderCell(event) fullName: onRenderCell(event) - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: method syntax: content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' + return: + type: + - void + description: '' parameters: - id: event description: '' - type: '' - return: - type: void - description: '' -extends: '<TProperties> ' + type: + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + optional: false +references: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: FieldCustomizerContext + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + name: IFieldCustomizerCellEventParameters diff --git a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml index 53d57dce..7fa88c9f 100644 --- a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -1,118 +1,134 @@ -### YamlMime:TSType -name: BaseFormCustomizer -uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: BaseFormCustomizer -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that provides a - custom list form (display, new, edit) for a SharePoint list. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#context:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' + summary: >- + This is the base class that third parties should extend when implementing a client-side extension that provides a + custom list form (display, new, edit) for a SharePoint list. + name: BaseFormCustomizer + fullName: BaseFormCustomizer + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-listview-extensibility!' - fullName: context + children: + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#context:member' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#displayMode:member' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#dispose:member(1)' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#domElement:member' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formClosed:member(1)' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formSaved:member(1)' + - '@microsoft/sp-listview-extensibility!BaseFormCustomizer#render:member(1)' + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'readonly context: FormCustomizerContext;' return: - type: '' - - name: displayMode - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#displayMode:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: displayMode + type: + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#displayMode:member' summary: 'Display mode of the form: Edit, Display or New.' - remarks: '' - - isPreview: false - isDeprecated: false + name: displayMode + fullName: displayMode + langs: + - typeScript + type: property syntax: content: 'protected get displayMode(): FormDisplayMode;' return: - type: '' - - name: domElement - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#domElement:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: domElement - summary: >- - This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole DOM - subtree of the form. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get domElement(): HTMLElement;' - return: - type: HTMLElement -methods: - - name: dispose() - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#dispose:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: dispose() + type: + - '@microsoft/sp-core-library!FormDisplayMode:enum' + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#dispose:member(1)' summary: Disposes the component. remarks: 'Please, do not override this method. Override the `onDispose` method instead.' - - isPreview: false - isDeprecated: false + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method syntax: content: 'dispose(): void;' return: - type: void + type: + - void description: '' - - name: formClosed() - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formClosed:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: formClosed() + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#domElement:member' + summary: >- + This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole DOM + subtree of the form. + name: domElement + fullName: domElement + langs: + - typeScript + type: property + syntax: + content: 'protected get domElement(): HTMLElement;' + return: + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formClosed:member(1)' summary: Call this method after the form has been closed/cancelled to inform the application that the form has been closed. - remarks: '' - - isPreview: false - isDeprecated: false + name: formClosed() + fullName: formClosed() + langs: + - typeScript + type: method syntax: content: 'protected formClosed(): void;' return: - type: void + type: + - void description: '' - - name: formSaved() - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formSaved:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: formSaved() + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#formSaved:member(1)' summary: Call this method after the form has been saved to inform the application that the form has been saved. - remarks: '' - - isPreview: false - isDeprecated: false + name: formSaved() + fullName: formSaved() + langs: + - typeScript + type: method syntax: content: 'protected formSaved(): void;' return: - type: void + type: + - void description: '' - - name: render() - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#render:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: render() + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#render:member(1)' summary: >- This API is called to render the form. There is no base implementation of this API and the form is required to override this API. - remarks: '' - - isPreview: false - isDeprecated: false + name: render() + fullName: render() + langs: + - typeScript + type: method syntax: content: 'protected abstract render(): void;' return: - type: void + type: + - void description: '' -extends: '<TProperties> ' +references: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: FormCustomizerContext + - uid: '@microsoft/sp-core-library!FormDisplayMode:enum' + name: FormDisplayMode + - uid: '!HTMLElement:interface' + name: HTMLElement diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index 16dbae19..03d32eaa 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -1,108 +1,132 @@ -### YamlMime:TSType -name: BaseListViewCommandSet -uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: BaseListViewCommandSet -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that provides a - command set for a SharePoint list view. -remarks: >- - In the component manifest, the "extensionType" should be set to "ListViewCommandSet". - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet:class' + summary: >- + This is the base class that third parties should extend when implementing a client-side extension that provides a + command set for a SharePoint list view. + remarks: >- + In the component manifest, the "extensionType" should be set to "ListViewCommandSet". - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseListViewCommandSet` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseListViewCommandSet` class. + name: BaseListViewCommandSet + fullName: BaseListViewCommandSet + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-listview-extensibility!' - fullName: context + children: + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#raiseOnChange:member(1)' + - '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'readonly context: ListViewCommandSetContext;' return: - type: '' -methods: - - name: onExecute(event) - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: onExecute(event) + type: + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' summary: >- This event occurs when the command is invoked, e.g. because the user clicked on the toolbar button or menu item. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: onExecute(event) + fullName: onExecute(event) + langs: + - typeScript + type: method syntax: content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' + return: + type: + - void + description: '' parameters: - id: event description: '' - type: '' - return: - type: void - description: '' - - name: onListViewUpdated(event) - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: onListViewUpdated(event) + type: + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + optional: false + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onListViewUpdated:member(1)' summary: This event occurs whenever the ListView state changes. virtual remarks: This event allows the implementor to tailor the visibility of the command. - - isPreview: false - isDeprecated: true - customDeprecatedMessage: Use context.listView.listViewStateChangedEvent instead. + deprecated: + content: Use context.listView.listViewStateChangedEvent instead. + name: onListViewUpdated(event) + fullName: onListViewUpdated(event) + langs: + - typeScript + type: method syntax: content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' + return: + type: + - void + description: '' parameters: - id: event description: '' - type: '' - return: - type: void - description: '' - - name: raiseOnChange() - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#raiseOnChange:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: raiseOnChange() + type: + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + optional: false + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#raiseOnChange:member(1)' summary: Use this method to fire OnChange event and initialize a reflow of the ListView. - remarks: '' - - isPreview: false - isDeprecated: false + name: raiseOnChange() + fullName: raiseOnChange() + langs: + - typeScript + type: method syntax: content: 'raiseOnChange(): void;' return: - type: void + type: + - void description: '' - - name: tryGetCommand(id) - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: tryGetCommand(id) + - uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#tryGetCommand:member(1)' summary: Returns the command with the given id. Returns undefined if there is not command with the given id. - remarks: '' - - isPreview: false - isDeprecated: false + name: tryGetCommand(id) + fullName: tryGetCommand(id) + langs: + - typeScript + type: method syntax: content: 'tryGetCommand(id: string): Command;' + return: + type: + - '@microsoft/sp-listview-extensibility!default:class' + description: '' parameters: - id: id description: Id of the command - type: string - return: - type: '' - description: '' -extends: '<TProperties> ' + type: + - string + optional: false +references: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: ListViewCommandSetContext + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + name: IListViewCommandSetExecuteEventParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + name: IListViewCommandSetListViewUpdatedParameters diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index d1be986f..c800016e 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -1,47 +1,50 @@ -### YamlMime:TSType -name: ColumnAccessor -uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ColumnAccessor -summary: 'Provides access to a ListView column, which is the visual presentation of a field.' -remarks: >- - A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item represents a - document, then the field is sometimes called a "property".) +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + summary: 'Provides access to a ListView column, which is the visual presentation of a field.' + remarks: >- + A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item + represents a document, then the field is sometimes called a "property".) - A "column" is the visual presentation of a field, when displayed by the ListView. + A "column" is the visual presentation of a field, when displayed by the ListView. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ColumnAccessor` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: field - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ColumnAccessor` class. + name: ColumnAccessor + fullName: ColumnAccessor + langs: + - typeScript + type: class package: '@microsoft/sp-listview-extensibility!' - fullName: field + children: + - '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' + - '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#field:member' summary: The server-side definition of the field. This property is read-only. - remarks: '' - - isPreview: false - isDeprecated: false + name: field + fullName: field + langs: + - typeScript + type: property syntax: content: 'abstract get field(): SPField;' return: - type: '' - - name: visible - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: visible + type: + - '@microsoft/sp-page-context!SPField:class' + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' summary: Whether to show this column in the list view. This property is read-only. - remarks: '' - - isPreview: false - isDeprecated: false + name: visible + fullName: visible + langs: + - typeScript + type: property syntax: content: 'abstract get visible(): boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index 03b18054..c557be36 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -1,81 +1,81 @@ -### YamlMime:TSType -name: Command -uid: '@microsoft/sp-listview-extensibility!Command:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: Command -summary: Represents a command belonging to a command set. -remarks: >- - The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, - context menu items, etc. These commands are initially defined in the extension's manifest file. At runtime, the - corresponding Command object can be obtained by calling - [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command's appearance can be customized by assigning its properties, for example to hide a command that is not - contextually relevant, or to pluralize the title based on the number of selected items. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: ariaLabel - uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!Command:class' + summary: Represents a command belonging to a command set. + remarks: >- + The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons, + context menu items, etc. These commands are initially defined in the extension's manifest file. At runtime, the + corresponding Command object can be obtained by calling + [BaseListViewCommandSet.tryGetCommand()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23tryGetCommand:member(1)). The command's appearance can be customized by assigning its properties, for example to hide a command that is + not contextually relevant, or to pluralize the title based on the number of selected items. + name: Command + fullName: Command + langs: + - typeScript + type: class package: '@microsoft/sp-listview-extensibility!' - fullName: ariaLabel + children: + - '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' + - '@microsoft/sp-listview-extensibility!Command#disabled:member' + - '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' + - '@microsoft/sp-listview-extensibility!Command#id:member' + - '@microsoft/sp-listview-extensibility!Command#title:member' + - '@microsoft/sp-listview-extensibility!Command#visible:member' + - uid: '@microsoft/sp-listview-extensibility!Command#ariaLabel:member' summary: >- Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel: string | undefined;' return: - type: string | undefined - - name: disabled - uid: '@microsoft/sp-listview-extensibility!Command#disabled:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: disabled + type: + - string | undefined + - uid: '@microsoft/sp-listview-extensibility!Command#disabled:member' summary: Whether the command is currently disabled. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled: boolean | undefined;' return: - type: boolean | undefined - - name: iconImageUrl - uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: iconImageUrl + type: + - boolean | undefined + - uid: '@microsoft/sp-listview-extensibility!Command#iconImageUrl:member' summary: >- An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. remarks: This must be a absolute URL. - - isPreview: false - isDeprecated: false + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property syntax: content: 'iconImageUrl: string | undefined;' return: - type: string | undefined - - name: id - uid: '@microsoft/sp-listview-extensibility!Command#id:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: id + type: + - string | undefined + - uid: '@microsoft/sp-listview-extensibility!Command#id:member' summary: Id of the command. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: string;' return: - type: string - - name: title - uid: '@microsoft/sp-listview-extensibility!Command#title:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: title + type: + - string + - uid: '@microsoft/sp-listview-extensibility!Command#title:member' summary: 'A short label to be displayed by the associated button, menu item, etc.' remarks: >- Example: "Show information" @@ -85,23 +85,25 @@ properties: toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically alters the meaning of the command, because administrators should be able to examine the extension manifest to understand which commands are being implemented by a given extension. - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string - - name: visible - uid: '@microsoft/sp-listview-extensibility!Command#visible:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: visible + type: + - string + - uid: '@microsoft/sp-listview-extensibility!Command#visible:member' summary: True if the command is visible. - remarks: '' - - isPreview: false - isDeprecated: false + name: visible + fullName: visible + langs: + - typeScript + type: property syntax: content: 'visible: boolean;' return: - type: boolean + type: + - boolean diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 990d6cae..2c8cfde3 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -1,47 +1,68 @@ -### YamlMime:TSType -name: FieldCustomizerContext -uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: FieldCustomizerContext -summary: This object provides contextual information for BaseFieldCustomizer. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `FieldCustomizerContext` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: field - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext:class' + summary: This object provides contextual information for BaseFieldCustomizer. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `FieldCustomizerContext` class. + name: FieldCustomizerContext + fullName: FieldCustomizerContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' package: '@microsoft/sp-listview-extensibility!' - fullName: field + children: + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#field:member' summary: Provides access to the SharePoint field that the customizer will operate on. - remarks: '' - - isPreview: false - isDeprecated: false + name: field + fullName: field + langs: + - typeScript + type: property syntax: content: 'get field(): SPField;' return: - type: '' -methods: - - name: tryGetListView() - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: tryGetListView() + type: + - '@microsoft/sp-page-context!SPField:class' + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' summary: >- If the field customizer is bounded to the SharePoint list view, this provides access to the list view specific functionality; otherwise the value is undefined. remarks: >- Although the SharePoint list view is the main usage scenario, field customizers can be used by other user interface surfaces. For example, in the future SharePoint may support field customizers on a display/edit form. - - isPreview: false - isDeprecated: false + name: tryGetListView() + fullName: tryGetListView() + langs: + - typeScript + type: method syntax: content: 'tryGetListView(): ListViewAccessor | undefined;' return: - type: ' | undefined' + type: + - '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView~0:complex' description: 'the SharePoint list view, or undefined if there is none.' -extends: '' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField + - uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView~0:complex' + name: ListViewAccessor | undefined + fullName: ListViewAccessor | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + name: ListViewAccessor + fullName: ListViewAccessor + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml index 9ffe940d..b8951e03 100644 --- a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -1,24 +1,35 @@ -### YamlMime:TSType -name: FormCustomizerContext -uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: FormCustomizerContext -summary: Form Customizer Context. This object contains contxtual services and properties for the form. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:class' + summary: Form Customizer Context. This object contains contxtual services and properties for the form. + name: FormCustomizerContext + fullName: FormCustomizerContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + implements: + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' package: '@microsoft/sp-listview-extensibility!' - fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + children: + - '@microsoft/sp-listview-extensibility!FormCustomizerContext:constructor(1)' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext#contentType:member' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext#domElement:member' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext#folderInfo:member' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext#itemId:member' + - '@microsoft/sp-listview-extensibility!FormCustomizerContext#list:member' + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:constructor(1)' summary: Constructs a new instance of the `FormCustomizerContext` class - remarks: '' - - isPreview: false - isDeprecated: false + name: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + langs: + - typeScript + type: constructor syntax: content: >- constructor(extensionContextParameters: _IExtensionContextParameters, formCustomizerContextParameters: @@ -26,74 +37,90 @@ constructors: parameters: - id: extensionContextParameters description: '' - type: '' + type: + - '@microsoft/sp-extension-base!_IExtensionContextParameters:interface' + optional: false - id: formCustomizerContextParameters description: '' - type: '' -properties: - - name: contentType - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#contentType:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: contentType + type: + - '@microsoft/sp-listview-extensibility!IFormCustomizerContextParameters:interface' + optional: false + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#contentType:member' summary: The content type associated with the form. - remarks: '' - - isPreview: false - isDeprecated: false + name: contentType + fullName: contentType + langs: + - typeScript + type: property syntax: content: 'get contentType(): IContentType;' return: - type: '' - - name: domElement - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#domElement:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: domElement + type: + - '@microsoft/sp-listview-extensibility!IContentType:interface' + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#domElement:member' summary: The root DOM element of the form. This is a DIV element container for the custom form. - remarks: '' - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'get domElement(): HTMLElement;' return: - type: HTMLElement - - name: folderInfo - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#folderInfo:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: folderInfo + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#folderInfo:member' summary: The folder information where the item is located/should be created. - remarks: '' - - isPreview: false - isDeprecated: false + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property syntax: content: 'get folderInfo(): IFolderInfo;' return: - type: '' - - name: itemId - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#itemId:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: itemId + type: + - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#itemId:member' summary: The item id of the item being edited or viewed. - remarks: '' - - isPreview: false - isDeprecated: false + name: itemId + fullName: itemId + langs: + - typeScript + type: property syntax: content: 'get itemId(): number | undefined;' return: - type: number | undefined - - name: list - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#list:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: list + type: + - number | undefined + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#list:member' summary: The list associated with the form. - remarks: '' - - isPreview: false - isDeprecated: false + name: list + fullName: list + langs: + - typeScript + type: property syntax: content: 'get list(): IList;' return: - type: '' -extends: '' + type: + - '@microsoft/sp-listview-extensibility!IList:interface' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' + name: IFormCustomizerContext + - uid: '@microsoft/sp-extension-base!_IExtensionContextParameters:interface' + name: _IExtensionContextParameters + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContextParameters:interface' + name: IFormCustomizerContextParameters + - uid: '@microsoft/sp-listview-extensibility!IContentType:interface' + name: IContentType + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + name: IFolderInfo + - uid: '@microsoft/sp-listview-extensibility!IList:interface' + name: IList diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml index 787a6227..55e472f5 100644 --- a/SP-Framework/sp-listview-extensibility/icolumn.yml +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -1,118 +1,130 @@ -### YamlMime:TSType -name: IColumn -uid: '@microsoft/sp-listview-extensibility!IColumn:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IColumn -summary: Provides information about the state of a column in the list view -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: clientSideComponentId - uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IColumn:interface' + summary: Provides information about the state of a column in the list view + name: IColumn + fullName: IColumn + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: clientSideComponentId + children: + - '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId:member' + - '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentProperties:member' + - '@microsoft/sp-listview-extensibility!IColumn#displayName:member' + - '@microsoft/sp-listview-extensibility!IColumn#fieldType:member' + - '@microsoft/sp-listview-extensibility!IColumn#id:member' + - '@microsoft/sp-listview-extensibility!IColumn#internalName:member' + - '@microsoft/sp-listview-extensibility!IColumn#isRequired:member' + - '@microsoft/sp-listview-extensibility!IColumn#isVisible:member' + - uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId:member' summary: The unique identifier of the client-side component associated with the field. - remarks: '' - - isPreview: false - isDeprecated: false + name: clientSideComponentId + fullName: clientSideComponentId + langs: + - typeScript + type: property syntax: content: 'readonly clientSideComponentId: Guid | undefined;' return: - type: ' | undefined' - - name: clientSideComponentProperties - uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentProperties:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: clientSideComponentProperties + type: + - '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentProperties:member' summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - - isPreview: false - isDeprecated: false + name: clientSideComponentProperties + fullName: clientSideComponentProperties + langs: + - typeScript + type: property syntax: content: 'readonly clientSideComponentProperties: string;' return: - type: string - - name: displayName - uid: '@microsoft/sp-listview-extensibility!IColumn#displayName:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: displayName + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IColumn#displayName:member' summary: The display name of the field. This name is shown as column name in UI. - remarks: '' - - isPreview: false - isDeprecated: false + name: displayName + fullName: displayName + langs: + - typeScript + type: property syntax: content: 'readonly displayName: string;' return: - type: string - - name: fieldType - uid: '@microsoft/sp-listview-extensibility!IColumn#fieldType:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: fieldType + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IColumn#fieldType:member' summary: The type of the field represented as a string - remarks: '' - - isPreview: false - isDeprecated: false + name: fieldType + fullName: fieldType + langs: + - typeScript + type: property syntax: content: 'readonly fieldType: string;' return: - type: string - - name: id - uid: '@microsoft/sp-listview-extensibility!IColumn#id:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: id + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IColumn#id:member' summary: The GUID identifier for this field. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: Guid;' return: - type: '' - - name: internalName - uid: '@microsoft/sp-listview-extensibility!IColumn#internalName:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: internalName + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-listview-extensibility!IColumn#internalName:member' summary: The internal name of the field. This name is usually used to find the field. - remarks: '' - - isPreview: false - isDeprecated: false + name: internalName + fullName: internalName + langs: + - typeScript + type: property syntax: content: 'readonly internalName: string;' return: - type: string - - name: isRequired - uid: '@microsoft/sp-listview-extensibility!IColumn#isRequired:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: isRequired + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IColumn#isRequired:member' summary: Whether the field is required for each list item in the list - remarks: '' - - isPreview: false - isDeprecated: false + name: isRequired + fullName: isRequired + langs: + - typeScript + type: property syntax: content: 'readonly isRequired: boolean;' return: - type: boolean - - name: isVisible - uid: '@microsoft/sp-listview-extensibility!IColumn#isVisible:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: isVisible + type: + - boolean + - uid: '@microsoft/sp-listview-extensibility!IColumn#isVisible:member' summary: Whether the column is visible in the view - remarks: '' - - isPreview: false - isDeprecated: false + name: isVisible + fullName: isVisible + langs: + - typeScript + type: property syntax: content: 'readonly isVisible: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId~0:complex' + name: Guid | undefined + fullName: Guid | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + fullName: Guid + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-listview-extensibility/icontenttype.yml b/SP-Framework/sp-listview-extensibility/icontenttype.yml index 3dc6a33e..9d178396 100644 --- a/SP-Framework/sp-listview-extensibility/icontenttype.yml +++ b/SP-Framework/sp-listview-extensibility/icontenttype.yml @@ -1,51 +1,50 @@ -### YamlMime:TSType -name: IContentType -uid: '@microsoft/sp-listview-extensibility!IContentType:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IContentType -summary: Provides information about the content type -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-listview-extensibility!IContentType#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IContentType:interface' + summary: Provides information about the content type + name: IContentType + fullName: IContentType + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: id + children: + - '@microsoft/sp-listview-extensibility!IContentType#id:member' + - '@microsoft/sp-listview-extensibility!IContentType#name:member' + - '@microsoft/sp-listview-extensibility!IContentType#schemaXml:member' + - uid: '@microsoft/sp-listview-extensibility!IContentType#id:member' summary: Content type string id - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: string;' return: - type: string - - name: name - uid: '@microsoft/sp-listview-extensibility!IContentType#name:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: name + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IContentType#name:member' summary: Content type name - remarks: '' - - isPreview: false - isDeprecated: false + name: name + fullName: name + langs: + - typeScript + type: property syntax: content: 'readonly name: string;' return: - type: string - - name: schemaXml - uid: '@microsoft/sp-listview-extensibility!IContentType#schemaXml:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: schemaXml + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IContentType#schemaXml:member' summary: Content type schema XML - remarks: '' - - isPreview: false - isDeprecated: false + name: schemaXml + fullName: schemaXml + langs: + - typeScript + type: property syntax: content: 'readonly schemaXml: string | undefined;' return: - type: string | undefined + type: + - string | undefined diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index 1eb002d9..259f3c2e 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -1,69 +1,74 @@ -### YamlMime:TSType -name: IFieldCustomizerCellEventParameters -uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IFieldCustomizerCellEventParameters -summary: Event parameters for BaseFieldCustomizer.onRenderCell() -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: domElement - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + summary: Event parameters for BaseFieldCustomizer.onRenderCell() + name: IFieldCustomizerCellEventParameters + fullName: IFieldCustomizerCellEventParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: domElement + children: + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#domElement:member' summary: >- The HTML "div" element that the extension will take ownership of. This ownership will end when onDisposeCell() is called. - remarks: '' - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'readonly domElement: HTMLDivElement;' return: - type: HTMLDivElement - - name: fieldValue - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: fieldValue + type: + - '!HTMLDivElement:interface' + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member' summary: The value of the field being rendered. - remarks: '' - - isPreview: false - isDeprecated: false + name: fieldValue + fullName: fieldValue + langs: + - typeScript + type: property syntax: content: 'readonly fieldValue: any;' return: - type: any - - name: listItem - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: listItem + type: + - any + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member' summary: The list item being edited. - remarks: '' - - isPreview: false - isDeprecated: false + name: listItem + fullName: listItem + langs: + - typeScript + type: property syntax: content: 'readonly listItem: ListItemAccessor;' return: - type: '' - - name: userData - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: userData + type: + - '@microsoft/sp-listview-extensibility!default:class' + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' summary: An implementation defined storage property. remarks: >- For example, suppose that resources need to be allocated during rendering (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc). The onRenderCell() implementation could store a key or handle in this property, and then onDisposeCell() can use this key to find the resource to be freed. - - isPreview: false - isDeprecated: false + name: userData + fullName: userData + langs: + - typeScript + type: property syntax: content: 'userData: any;' return: - type: any + type: + - any +references: + - uid: '!HTMLDivElement:interface' + name: HTMLDivElement + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: ListItemAccessor diff --git a/SP-Framework/sp-listview-extensibility/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml index 2740cd14..1aa3c920 100644 --- a/SP-Framework/sp-listview-extensibility/ifilter.yml +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -1,38 +1,47 @@ -### YamlMime:TSType -name: IFilter -uid: '@microsoft/sp-listview-extensibility!IFilter:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IFilter -summary: Provides information about the state of the filters applied to the ListView. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: fieldName - uid: '@microsoft/sp-listview-extensibility!IFilter#fieldName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IFilter:interface' + summary: Provides information about the state of the filters applied to the ListView. + name: IFilter + fullName: IFilter + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: fieldName + children: + - '@microsoft/sp-listview-extensibility!IFilter#fieldName:member' + - '@microsoft/sp-listview-extensibility!IFilter#values:member' + - uid: '@microsoft/sp-listview-extensibility!IFilter#fieldName:member' summary: Field name to filter on. - remarks: '' - - isPreview: false - isDeprecated: false + name: fieldName + fullName: fieldName + langs: + - typeScript + type: property syntax: content: 'readonly fieldName: string;' return: - type: string - - name: values - uid: '@microsoft/sp-listview-extensibility!IFilter#values:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: values + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IFilter#values:member' summary: Values to filter on. - remarks: '' - - isPreview: false - isDeprecated: false + name: values + fullName: values + langs: + - typeScript + type: property syntax: content: 'values: ReadonlyArray;' return: - type: ReadonlyArray<string> + type: + - '@microsoft/sp-listview-extensibility!IFilter#values~0:complex' +references: + - uid: '@microsoft/sp-listview-extensibility!IFilter#values~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: + fullName: diff --git a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml index 39ec33a1..cf7e7f57 100644 --- a/SP-Framework/sp-listview-extensibility/ifolderinfo.yml +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -1,25 +1,24 @@ -### YamlMime:TSType -name: IFolderInfo -uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IFolderInfo -summary: Provides information about the state of the folder in the ListView. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: folderPath - uid: '@microsoft/sp-listview-extensibility!IFolderInfo#folderPath:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + summary: Provides information about the state of the folder in the ListView. + name: IFolderInfo + fullName: IFolderInfo + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: folderPath + children: + - '@microsoft/sp-listview-extensibility!IFolderInfo#folderPath:member' + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo#folderPath:member' summary: Folder path. - remarks: '' - - isPreview: false - isDeprecated: false + name: folderPath + fullName: folderPath + langs: + - typeScript + type: property syntax: content: 'readonly folderPath: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml index 2aaceb35..272cf27b 100644 --- a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -1,77 +1,85 @@ -### YamlMime:TSType -name: IFormCustomizerContext -uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IFormCustomizerContext -summary: FormCustomizerContext-specific properties. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: contentType - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#contentType:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext:interface' + summary: FormCustomizerContext-specific properties. + name: IFormCustomizerContext + fullName: IFormCustomizerContext + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: contentType + children: + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext#contentType:member' + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext#domElement:member' + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext#folderInfo:member' + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext#itemId:member' + - '@microsoft/sp-listview-extensibility!IFormCustomizerContext#list:member' + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#contentType:member' summary: The content type associated with the form. - remarks: '' - - isPreview: false - isDeprecated: false + name: contentType + fullName: contentType + langs: + - typeScript + type: property syntax: content: 'readonly contentType: IContentType;' return: - type: '' - - name: domElement - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#domElement:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: domElement + type: + - '@microsoft/sp-listview-extensibility!IContentType:interface' + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#domElement:member' summary: The root DOM element of the form. This is a DIV element container for the custom form. - remarks: '' - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'readonly domElement: HTMLElement;' return: - type: HTMLElement - - name: folderInfo - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#folderInfo:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: folderInfo + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#folderInfo:member' summary: The folder information where the item is located/should be created. - remarks: '' - - isPreview: false - isDeprecated: false + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property syntax: content: 'readonly folderInfo: IFolderInfo;' return: - type: '' - - name: itemId - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#itemId:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: itemId + type: + - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#itemId:member' summary: The item id of the item being edited or viewed. - remarks: '' - - isPreview: false - isDeprecated: false + name: itemId + fullName: itemId + langs: + - typeScript + type: property syntax: content: 'readonly itemId?: number;' return: - type: number - - name: list - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#list:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: list + type: + - number + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#list:member' summary: The list associated with the form. - remarks: '' - - isPreview: false - isDeprecated: false + name: list + fullName: list + langs: + - typeScript + type: property syntax: content: 'readonly list: IList;' return: - type: '' + type: + - '@microsoft/sp-listview-extensibility!IList:interface' +references: + - uid: '@microsoft/sp-listview-extensibility!IContentType:interface' + name: IContentType + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + name: IFolderInfo + - uid: '@microsoft/sp-listview-extensibility!IList:interface' + name: IList diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml index 2bdb14be..0e41bab3 100644 --- a/SP-Framework/sp-listview-extensibility/ilist.yml +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -1,51 +1,53 @@ -### YamlMime:TSType -name: IList -uid: '@microsoft/sp-listview-extensibility!IList:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IList -summary: Provides information about the list rendered by the ListView. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: guid - uid: '@microsoft/sp-listview-extensibility!IList#guid:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IList:interface' + summary: Provides information about the list rendered by the ListView. + name: IList + fullName: IList + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: guid + children: + - '@microsoft/sp-listview-extensibility!IList#guid:member' + - '@microsoft/sp-listview-extensibility!IList#serverRelativeUrl:member' + - '@microsoft/sp-listview-extensibility!IList#title:member' + - uid: '@microsoft/sp-listview-extensibility!IList#guid:member' summary: List id. - remarks: '' - - isPreview: false - isDeprecated: false + name: guid + fullName: guid + langs: + - typeScript + type: property syntax: content: 'readonly guid: Guid;' return: - type: '' - - name: serverRelativeUrl - uid: '@microsoft/sp-listview-extensibility!IList#serverRelativeUrl:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: serverRelativeUrl + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-listview-extensibility!IList#serverRelativeUrl:member' summary: List server relative url. - remarks: '' - - isPreview: false - isDeprecated: false + name: serverRelativeUrl + fullName: serverRelativeUrl + langs: + - typeScript + type: property syntax: content: 'readonly serverRelativeUrl: string;' return: - type: string - - name: title - uid: '@microsoft/sp-listview-extensibility!IList#title:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: title + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IList#title:member' summary: List title. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'readonly title: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml index 27199457..cf3b0654 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -1,135 +1,205 @@ -### YamlMime:TSType -name: IListViewAccessorState -uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IListViewAccessorState -summary: Provides information about the state of the ListView. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: appliedFilters - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' + summary: Provides information about the state of the ListView. + name: IListViewAccessorState + fullName: IListViewAccessorState + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: appliedFilters + children: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#folderInfo:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#list:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortAscending:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortField:member' + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#view:member' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters:member' summary: Applied filters information. - remarks: '' - - isPreview: false - isDeprecated: false + name: appliedFilters + fullName: appliedFilters + langs: + - typeScript + type: property syntax: content: |- readonly appliedFilters?: { [fieldName: string]: IFilter; }; return: - type: |- - { - [fieldName: string]: ; - } - - name: columns - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: columns + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns:member' summary: Columns information. - remarks: '' - - isPreview: false - isDeprecated: false + name: columns + fullName: columns + langs: + - typeScript + type: property syntax: content: 'readonly columns: ReadonlyArray;' return: - type: 'ReadonlyArray<>' - - name: folderInfo - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#folderInfo:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: folderInfo + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#folderInfo:member' summary: Current folder information. - remarks: '' - - isPreview: false - isDeprecated: false + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property syntax: content: 'readonly folderInfo?: IFolderInfo;' return: - type: '' - - name: list - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#list:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: list + type: + - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#list:member' summary: List information. - remarks: '' - - isPreview: false - isDeprecated: false + name: list + fullName: list + langs: + - typeScript + type: property syntax: content: 'readonly list?: IList;' return: - type: '' - - name: rows - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: rows + type: + - '@microsoft/sp-listview-extensibility!IList:interface' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows:member' summary: Rows information. - remarks: '' - - isPreview: false - isDeprecated: false + name: rows + fullName: rows + langs: + - typeScript + type: property syntax: content: 'readonly rows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows:member' summary: Selected rows information. - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property syntax: content: 'readonly selectedRows?: ReadonlyArray;' return: - type: 'ReadonlyArray<>' - - name: sortAscending - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortAscending:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: sortAscending + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortAscending:member' summary: Sort direction. - remarks: '' - - isPreview: false - isDeprecated: false + name: sortAscending + fullName: sortAscending + langs: + - typeScript + type: property syntax: content: 'readonly sortAscending?: boolean;' return: - type: boolean - - name: sortField - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortField:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: sortField + type: + - boolean + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortField:member' summary: Sort field name. - remarks: '' - - isPreview: false - isDeprecated: false + name: sortField + fullName: sortField + langs: + - typeScript + type: property syntax: content: 'readonly sortField?: string;' return: - type: string - - name: view - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#view:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: view + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#view:member' summary: View information. - remarks: '' - - isPreview: false - isDeprecated: false + name: view + fullName: view + langs: + - typeScript + type: property syntax: content: 'readonly view?: IView;' return: - type: '' + type: + - '@microsoft/sp-listview-extensibility!IView:interface' +references: + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters~0:complex' + name: |- + { + [fieldName: string]: IFilter; + } + fullName: |- + { + [fieldName: string]: IFilter; + } + spec.typeScript: + - name: |- + { + [fieldName: string]: + fullName: |- + { + [fieldName: string]: + - uid: '@microsoft/sp-listview-extensibility!IFilter:interface' + name: IFilter + fullName: IFilter + - name: |- + ; + } + fullName: |- + ; + } + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!IColumn:interface' + name: IColumn + fullName: IColumn + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + name: IFolderInfo + - uid: '@microsoft/sp-listview-extensibility!IList:interface' + name: IList + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!IRow:interface' + name: IRow + fullName: IRow + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!IRow:interface' + name: IRow + fullName: IRow + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!IView:interface' + name: IView diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index d4e72488..f763d95b 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,42 +1,56 @@ -### YamlMime:TSType -name: IListViewCommandSetExecuteEventParameters -uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IListViewCommandSetExecuteEventParameters -summary: >- - Parameters for - [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: itemId - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + summary: >- + Parameters for + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) + name: IListViewCommandSetExecuteEventParameters + fullName: IListViewCommandSetExecuteEventParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: itemId + children: + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#itemId:member' summary: >- The unique identifier for the command. This is specified as ICommandDefinition.commandId in the component manifest. - remarks: '' - - isPreview: false - isDeprecated: false + name: itemId + fullName: itemId + langs: + - typeScript + type: property syntax: content: 'readonly itemId: string;' return: - type: string - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' summary: 'The currently selected ListView rows, at the time when the event occurred.' - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property syntax: content: 'readonly selectedRows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: + - '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows~0:complex' +references: + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index 7ddfaee6..25b29ca8 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -1,27 +1,41 @@ -### YamlMime:TSType -name: IListViewCommandSetListViewUpdatedParameters -uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IListViewCommandSetListViewUpdatedParameters -summary: >- - Parameters for - [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' + summary: >- + Parameters for + [BaseListViewCommandSet.onListViewUpdated()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onListViewUpdated:member(1)) + name: IListViewCommandSetListViewUpdatedParameters + fullName: IListViewCommandSetListViewUpdatedParameters + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows + children: + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' summary: 'The currently selected ListView rows, at the time when the event occurred.' - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property syntax: content: 'readonly selectedRows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: + - '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows~0:complex' +references: + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-listview-extensibility/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml index 2ef0cf5f..2a27bc8e 100644 --- a/SP-Framework/sp-listview-extensibility/irow.yml +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -1,33 +1,55 @@ -### YamlMime:TSType -name: IRow -uid: '@microsoft/sp-listview-extensibility!IRow:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IRow -summary: Provides information about the list item's state rendered by the ListView. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: values - uid: '@microsoft/sp-listview-extensibility!IRow#values:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IRow:interface' + summary: Provides information about the list item's state rendered by the ListView. + name: IRow + fullName: IRow + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: values + children: + - '@microsoft/sp-listview-extensibility!IRow#values:member' + - uid: '@microsoft/sp-listview-extensibility!IRow#values:member' summary: >- A map of column values for the row. They key is the column internal name and the value is its corresponding value in the row. - remarks: '' - - isPreview: false - isDeprecated: false + name: values + fullName: values + langs: + - typeScript + type: property syntax: content: |- readonly values: { [columnInternalName: string]: Readonly; }; return: - type: |- + type: + - '@microsoft/sp-listview-extensibility!IRow#values~0:complex' +references: + - uid: '@microsoft/sp-listview-extensibility!IRow#values~0:complex' + name: |- + { + [columnInternalName: string]: Readonly; + } + fullName: |- + { + [columnInternalName: string]: Readonly; + } + spec.typeScript: + - name: |- { - [columnInternalName: string]: Readonly<any>; + [columnInternalName: string]: + fullName: |- + { + [columnInternalName: string]: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: |- + ; + } + fullName: |- + ; } diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml index 76fc06f1..f03265fd 100644 --- a/SP-Framework/sp-listview-extensibility/iview.yml +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -1,51 +1,53 @@ -### YamlMime:TSType -name: IView -uid: '@microsoft/sp-listview-extensibility!IView:interface' -package: '@microsoft/sp-listview-extensibility!' -fullName: IView -summary: Provides information about the view rendered by the ListView. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-listview-extensibility!IView#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!IView:interface' + summary: Provides information about the view rendered by the ListView. + name: IView + fullName: IView + langs: + - typeScript + type: interface package: '@microsoft/sp-listview-extensibility!' - fullName: id + children: + - '@microsoft/sp-listview-extensibility!IView#id:member' + - '@microsoft/sp-listview-extensibility!IView#title:member' + - '@microsoft/sp-listview-extensibility!IView#url:member' + - uid: '@microsoft/sp-listview-extensibility!IView#id:member' summary: View id. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: Guid;' return: - type: '' - - name: title - uid: '@microsoft/sp-listview-extensibility!IView#title:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: title + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-listview-extensibility!IView#title:member' summary: View title. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'readonly title: string;' return: - type: string - - name: url - uid: '@microsoft/sp-listview-extensibility!IView#url:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: url + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IView#url:member' summary: View server relative url. - remarks: '' - - isPreview: false - isDeprecated: false + name: url + fullName: url + langs: + - typeScript + type: property syntax: content: 'readonly url: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index f60ab4d0..7f34fba4 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -1,82 +1,104 @@ -### YamlMime:TSType -name: ListItemAccessor -uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListItemAccessor -summary: >- - When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated - SharePoint list item. -remarks: >- - ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and - retrieve the current values for those fields. In the future, it may also support validation and editing operations. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor:class' + summary: >- + When a field customizer extension is rendering a field, the ListItemAccessor provides access to the associated + SharePoint list item. + remarks: >- + ListItemAccessor allows a field customizer extension to determine which fields are available in the editor and + retrieve the current values for those fields. In the future, it may also support validation and editing + operations. - When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the - ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether the - associated table row is selected or not. + When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor subclass instead of the + ListItemAccessor base class. This allows additional functionality to be exposed, for example determining whether + the associated table row is selected or not. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListItemAccessor` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: fields - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListItemAccessor` class. + name: ListItemAccessor + fullName: ListItemAccessor + langs: + - typeScript + type: class package: '@microsoft/sp-listview-extensibility!' - fullName: fields + children: + - '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' + - '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' + - '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields:member' summary: The SharePoint fields that are currently available in the editor for this list item. remarks: >- The set of available fields depends on the editing context. For example, if a list view column is hidden, the corresponding field definition may not be loaded. Field customizers should not assume that a given field will be available, even if it is defined in the content type. - - isPreview: false - isDeprecated: false + name: fields + fullName: fields + langs: + - typeScript + type: property syntax: content: 'abstract get fields(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' -methods: - - name: getValue(field) - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: getValue(field) + type: + - '@microsoft/sp-listview-extensibility!ListItemAccessor#fields~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' summary: >- Retrieves the current data value for the specified field. The value will be a primitive JavaScript object such as a string, number, etc. - remarks: '' - - isPreview: false - isDeprecated: false + name: getValue(field) + fullName: getValue(field) + langs: + - typeScript + type: method syntax: content: 'abstract getValue(field: SPField): any;' + return: + type: + - any + description: '' parameters: - id: field description: '' - type: '' - return: - type: any - description: '' - - name: getValueByName(internalName) - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: getValueByName(internalName) + type: + - '@microsoft/sp-page-context!SPField:class' + optional: false + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValueByName:member(1)' summary: >- Retrieves the current data value for the field with the specified internal name. The value will be a primitive JavaScript object such as a string, number, etc. - remarks: '' - - isPreview: false - isDeprecated: false + name: getValueByName(internalName) + fullName: getValueByName(internalName) + langs: + - typeScript + type: method syntax: content: 'abstract getValueByName(internalName: string): any;' + return: + type: + - any + description: '' parameters: - id: internalName description: '' - type: string - return: - type: any - description: '' + type: + - string + optional: false +references: + - uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#fields~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField + fullName: SPField + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 2b2f2241..2298e1e7 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -1,189 +1,318 @@ -### YamlMime:TSType -name: ListViewAccessor -uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListViewAccessor -summary: Provides access to a SharePoint ListView control. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListViewAccessor` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: appliedFilters - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#appliedFilters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' + summary: Provides access to a SharePoint ListView control. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListViewAccessor` class. + name: ListViewAccessor + fullName: ListViewAccessor + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-core-library!IDisposable:interface' package: '@microsoft/sp-listview-extensibility!' - fullName: appliedFilters + children: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#appliedFilters:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#list:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#listViewStateChangedEvent:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#rows:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#sortAscending:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#sortField:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' + - '@microsoft/sp-listview-extensibility!ListViewAccessor#view:member' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#appliedFilters:member' summary: Filters applied to the list view. - remarks: '' - - isPreview: false - isDeprecated: false + name: appliedFilters + fullName: appliedFilters + langs: + - typeScript + type: property syntax: content: |- abstract get appliedFilters(): { [fieldName: string]: IFilter; } | undefined; return: - type: |- - { - [fieldName: string]: ; - } | undefined - - name: columns - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: columns + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#appliedFilters~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' summary: 'The columns in associated with this view, including hidden columns.' - remarks: '' - - isPreview: false - isDeprecated: false + name: columns + fullName: columns + langs: + - typeScript + type: property syntax: content: 'abstract get columns(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' - - name: folderInfo - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: folderInfo + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo:member' summary: Folder information for the list view. - remarks: '' - - isPreview: false - isDeprecated: false + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property syntax: content: 'abstract get folderInfo(): IFolderInfo | undefined;' return: - type: ' | undefined' - - name: list - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#list:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: list + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#list:member' summary: Basic information about the list rendered by the list view. - remarks: '' - - isPreview: false - isDeprecated: false + name: list + fullName: list + langs: + - typeScript + type: property syntax: content: 'abstract get list(): IList | undefined;' return: - type: ' | undefined' - - name: rows - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#rows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: rows + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#list~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#listViewStateChangedEvent:member' + summary: Event that gets raised every time the list view state changes. + name: listViewStateChangedEvent + fullName: listViewStateChangedEvent + langs: + - typeScript + type: event + syntax: + content: 'get listViewStateChangedEvent(): SPEvent;' + return: + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#listViewStateChangedEvent~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#rows:member' summary: Currently rendered rows in the list view. - remarks: '' - - isPreview: false - isDeprecated: false + name: rows + fullName: rows + langs: + - typeScript + type: property syntax: content: 'abstract get rows(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#rows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows:member' summary: Selected rows in the list view. - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property syntax: content: 'abstract get selectedRows(): ReadonlyArray | undefined;' return: - type: 'ReadonlyArray<> | undefined' - - name: sortAscending - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortAscending:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: sortAscending + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' + summary: Event that gets raised every time the selected items in the list view change. + name: selectedRowsChangedEvent + fullName: selectedRowsChangedEvent + langs: + - typeScript + type: event + syntax: + content: 'get selectedRowsChangedEvent(): SPEvent;' + return: + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortAscending:member' summary: Specifies whether the list view is sorted ascending or descending. - remarks: '' - - isPreview: false - isDeprecated: false + name: sortAscending + fullName: sortAscending + langs: + - typeScript + type: property syntax: content: 'abstract get sortAscending(): boolean | undefined;' return: - type: boolean | undefined - - name: sortField - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortField:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: sortField + type: + - boolean | undefined + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortField:member' summary: Sort field name - remarks: '' - - isPreview: false - isDeprecated: false + name: sortField + fullName: sortField + langs: + - typeScript + type: property syntax: content: 'abstract get sortField(): string | undefined;' return: - type: string | undefined - - name: view - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#view:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: view - summary: Basic information about the view rendered by the list view. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'abstract get view(): IView | undefined;' - return: - type: ' | undefined' -methods: - - name: tryGetColumnByName(internalName) - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' - package: '@microsoft/sp-listview-extensibility!' - fullName: tryGetColumnByName(internalName) + type: + - string | undefined + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' summary: >- Returns the list view column corresponding to the field with the specified internal name, or undefined if none is found. - remarks: '' - - isPreview: false - isDeprecated: false + name: tryGetColumnByName(internalName) + fullName: tryGetColumnByName(internalName) + langs: + - typeScript + type: method syntax: content: 'abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' + return: + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName~0:complex' + description: '' parameters: - id: internalName description: '' - type: string - return: - type: ' | undefined' - description: '' -events: - - name: listViewStateChangedEvent - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#listViewStateChangedEvent:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: listViewStateChangedEvent - summary: Event that gets raised every time the list view state changes. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get listViewStateChangedEvent(): SPEvent;' - return: - type: >- - <> - - name: selectedRowsChangedEvent - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRowsChangedEvent - summary: Event that gets raised every time the selected items in the list view change. - remarks: '' - - isPreview: false - isDeprecated: false + type: + - string + optional: false + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#view:member' + summary: Basic information about the view rendered by the list view. + name: view + fullName: view + langs: + - typeScript + type: property syntax: - content: 'get selectedRowsChangedEvent(): SPEvent;' + content: 'abstract get view(): IView | undefined;' return: - type: >- - <> + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#view~0:complex' +references: + - uid: '@microsoft/sp-core-library!IDisposable:interface' + name: IDisposable + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#appliedFilters~0:complex' + name: |- + { + [fieldName: string]: IFilter; + } | undefined + fullName: |- + { + [fieldName: string]: IFilter; + } | undefined + spec.typeScript: + - name: |- + { + [fieldName: string]: + fullName: |- + { + [fieldName: string]: + - uid: '@microsoft/sp-listview-extensibility!IFilter:interface' + name: IFilter + fullName: IFilter + - name: |- + ; + } | undefined + fullName: |- + ; + } | undefined + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + name: ColumnAccessor + fullName: ColumnAccessor + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo~0:complex' + name: IFolderInfo | undefined + fullName: IFolderInfo | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + name: IFolderInfo + fullName: IFolderInfo + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#list~0:complex' + name: IList | undefined + fullName: IList | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!IList:interface' + name: IList + fullName: IList + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#listViewStateChangedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' + name: ListViewStateChangedEventArgs + fullName: ListViewStateChangedEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#rows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows~0:complex' + name: ReadonlyArray | undefined + fullName: ReadonlyArray | undefined + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '> | undefined' + fullName: '> | undefined' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRowsChangedEvent~0:complex' + name: SPEvent + fullName: SPEvent + spec.typeScript: + - uid: '@microsoft/sp-core-library!SPEvent:class' + name: SPEvent + fullName: SPEvent + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + name: SelectedRowsChangedEventArgs + fullName: SelectedRowsChangedEventArgs + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName~0:complex' + name: ColumnAccessor | undefined + fullName: ColumnAccessor | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' + name: ColumnAccessor + fullName: ColumnAccessor + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#view~0:complex' + name: IView | undefined + fullName: IView | undefined + spec.typeScript: + - uid: '@microsoft/sp-listview-extensibility!IView:interface' + name: IView + fullName: IView + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml index 5051434f..513fc82a 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -1,56 +1,83 @@ -### YamlMime:TSEnum -name: ListViewAccessorStateChanges -uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListViewAccessorStateChanges -summary: Describes the type of list view state changes. -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: AppliedFilters - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.AppliedFilters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' + summary: Describes the type of list view state changes. + name: ListViewAccessorStateChanges + fullName: ListViewAccessorStateChanges + langs: + - typeScript + type: enum package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '32' - - name: Columns - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Columns:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '4' - - name: FolderInfo - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.FolderInfo:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '128' - - name: List - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.List:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '1' - - name: None - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.None:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '0' - - name: Rows - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Rows:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '16' - - name: SelectedRows - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.SelectedRows:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '8' - - name: Sort - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Sort:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '64' - - name: View - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.View:member' - package: '@microsoft/sp-listview-extensibility!' - summary: '' - value: '2' + children: + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.AppliedFilters:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Columns:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.FolderInfo:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.List:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.None:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Rows:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.SelectedRows:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Sort:member' + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.View:member' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.AppliedFilters:member' + name: AppliedFilters + fullName: AppliedFilters + langs: + - typeScript + type: field + numericValue: '32' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Columns:member' + name: Columns + fullName: Columns + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.FolderInfo:member' + name: FolderInfo + fullName: FolderInfo + langs: + - typeScript + type: field + numericValue: '128' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.List:member' + name: List + fullName: List + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.None:member' + name: None + fullName: None + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Rows:member' + name: Rows + fullName: Rows + langs: + - typeScript + type: field + numericValue: '16' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.SelectedRows:member' + name: SelectedRows + fullName: SelectedRows + langs: + - typeScript + type: field + numericValue: '8' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.Sort:member' + name: Sort + fullName: Sort + langs: + - typeScript + type: field + numericValue: '64' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges.View:member' + name: View + fullName: View + langs: + - typeScript + type: field + numericValue: '2' diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index ab7fcfbe..dbcb86e7 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -1,41 +1,55 @@ -### YamlMime:TSType -name: ListViewCommandSetContext -uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListViewCommandSetContext -summary: This object provides contextual information for BaseListViewCommandSet. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `ListViewCommandSetContext` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: listView - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' + summary: This object provides contextual information for BaseListViewCommandSet. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `ListViewCommandSetContext` class. + name: ListViewCommandSetContext + fullName: ListViewCommandSetContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' package: '@microsoft/sp-listview-extensibility!' - fullName: listView + children: + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' + - '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#listView:member' summary: Provides access to the ListView control that the customizer will operate on. - remarks: '' - - isPreview: false - isDeprecated: false + name: listView + fullName: listView + langs: + - typeScript + type: property syntax: content: 'get listView(): ListViewAccessor;' return: - type: '' - - name: manifest - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: manifest + type: + - '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' summary: Manifest for the client-side component. - remarks: '' - - isPreview: false - isDeprecated: false + name: manifest + fullName: manifest + langs: + - typeScript + type: property syntax: content: 'readonly manifest: ICommandSetExtensionManifest;' return: - type: '' -extends: '' + type: + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + name: ListViewAccessor + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + name: ICommandSetExtensionManifest diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml index d63dfa05..9e879552 100644 --- a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -1,39 +1,60 @@ -### YamlMime:TSType -name: ListViewStateChangedEventArgs -uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: ListViewStateChangedEventArgs -summary: Arguments for the list view state changed event. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: prevState - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#prevState:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' + summary: Arguments for the list view state changed event. + name: ListViewStateChangedEventArgs + fullName: ListViewStateChangedEventArgs + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-listview-extensibility!' - fullName: prevState + children: + - '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#prevState:member' + - '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#stateChanges:member' + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#prevState:member' summary: Previous state of the ListView. - remarks: '' - - isPreview: false - isDeprecated: false + name: prevState + fullName: prevState + langs: + - typeScript + type: property syntax: content: 'prevState: Readonly;' return: - type: 'Readonly<>' - - name: stateChanges - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#stateChanges:member' - package: '@microsoft/sp-listview-extensibility!' - fullName: stateChanges + type: + - '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#prevState~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#stateChanges:member' summary: Changes that were made to the ListView state. - remarks: '' - - isPreview: false - isDeprecated: false + name: stateChanges + fullName: stateChanges + langs: + - typeScript + type: property syntax: content: 'stateChanges: ListViewAccessorStateChanges;' return: - type: '' -extends: '' + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#prevState~0:complex' + name: Readonly + fullName: Readonly + spec.typeScript: + - uid: '!Readonly:type' + name: Readonly + fullName: Readonly + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState:interface' + name: IListViewAccessorState + fullName: IListViewAccessorState + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' + name: ListViewAccessorStateChanges diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 8f09316c..90ecb9b7 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -1,22 +1,28 @@ -### YamlMime:TSType -name: RowAccessor -uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: RowAccessor -summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' -remarks: >- - A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an array of - values for the associated fields. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' + remarks: >- + A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an + array of values for the associated fields. - A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell values - for the associated columns. + A "row" is the visual presentation of a list item, when displayed by the ListView; it stores an array of cell + values for the associated columns. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `RowAccessor` class. - -isPreview: false -isDeprecated: false -type: class -extends: '' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `RowAccessor` class. + name: RowAccessor + fullName: RowAccessor + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-listview-extensibility!default:class' + inheritance: + - type: '@microsoft/sp-listview-extensibility!default:class' + package: '@microsoft/sp-listview-extensibility!' +references: + - uid: '@microsoft/sp-listview-extensibility!default:class' + name: ListItemAccessor diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index a67de530..9388761f 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -1,26 +1,45 @@ -### YamlMime:TSType -name: SelectedRowsChangedEventArgs -uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' -package: '@microsoft/sp-listview-extensibility!' -fullName: SelectedRowsChangedEventArgs -summary: Arguments for the selected rows changed event. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -properties: - - name: selectedRows - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class' + summary: Arguments for the selected rows changed event. + name: SelectedRowsChangedEventArgs + fullName: SelectedRowsChangedEventArgs + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-core-library!SPEventArgs:class' + inheritance: + - type: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-listview-extensibility!' - fullName: selectedRows + children: + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows:member' summary: The list of rows that were selected in the list view at the time when the event was fired. - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property syntax: content: 'selectedRows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' -extends: '' + type: + - '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows~0:complex' +references: + - uid: '@microsoft/sp-core-library!SPEventArgs:class' + name: SPEventArgs + - uid: '@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs#selectedRows~0:complex' + name: ReadonlyArray + fullName: ReadonlyArray + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: < + fullName: < + - uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' + name: RowAccessor + fullName: RowAccessor + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-loader.yml b/SP-Framework/sp-loader.yml index 95d6a09c..5cc39342 100644 --- a/SP-Framework/sp-loader.yml +++ b/SP-Framework/sp-loader.yml @@ -1,9 +1,20 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-loader!' -name: '@microsoft/sp-loader' -type: package -summary: The SharePoint Framework loader -interfaces: - - '@microsoft/sp-loader!ILoadScriptOptions:interface' -classes: - - '@microsoft/sp-loader!SPComponentLoader:class' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-loader!' + summary: The SharePoint Framework loader + remarks: >- + Built on familiar standards such as RequireJS and WebPack, the loader is the first part of the SharePoint + Framework to load on a page. It manages versioning and loading of client-side components. + name: '@microsoft/sp-loader' + fullName: '@microsoft/sp-loader' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-loader!ILoadScriptOptions:interface' + - '@microsoft/sp-loader!SPComponentLoader:class' +references: + - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + name: ILoadScriptOptions + - uid: '@microsoft/sp-loader!SPComponentLoader:class' + name: SPComponentLoader diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index b514a0e5..90b727f9 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -1,25 +1,24 @@ -### YamlMime:TSType -name: ILoadScriptOptions -uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' -package: '@microsoft/sp-loader!' -fullName: ILoadScriptOptions -summary: Options for the loadScript() method in ISPComponentLoader -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: globalExportsName - uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + summary: Options for the loadScript() method in ISPComponentLoader + name: ILoadScriptOptions + fullName: ILoadScriptOptions + langs: + - typeScript + type: interface package: '@microsoft/sp-loader!' - fullName: globalExportsName + children: + - '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' + - uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' summary: 'If set, the loaded script will be stored in a global variable under this name.' - remarks: '' - - isPreview: false - isDeprecated: false + name: globalExportsName + fullName: globalExportsName + langs: + - typeScript + type: property syntax: content: 'globalExportsName?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index a0de13b8..0c67e4b0 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -1,112 +1,172 @@ -### YamlMime:TSType -name: SPComponentLoader -uid: '@microsoft/sp-loader!SPComponentLoader:class' -package: '@microsoft/sp-loader!' -fullName: SPComponentLoader -summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -methods: - - name: getManifests() - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-loader!SPComponentLoader:class' + summary: Component loader. Needs to be initialized with an implemented `ISPComponentLoader`. + name: SPComponentLoader + fullName: SPComponentLoader + langs: + - typeScript + type: class package: '@microsoft/sp-loader!' - fullName: getManifests() + children: + - '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' + - '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' + - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests:member(1)' summary: Returns static copies of all the manifests. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: this method will be removed in a future release. + deprecated: + content: this method will be removed in a future release. + name: getManifests() + fullName: getManifests() + langs: + - typeScript + type: method syntax: content: 'static getManifests(): IClientSideComponentManifest[];' return: - type: '[]' + type: + - '@microsoft/sp-loader!SPComponentLoader.getManifests~0:complex' description: '' - - name: loadComponent(manifest) - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' - package: '@microsoft/sp-loader!' - fullName: loadComponent(manifest) + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' summary: Loads a component from a manifest. - remarks: '' - - isPreview: false - isDeprecated: false + name: loadComponent(manifest) + fullName: loadComponent(manifest) + langs: + - typeScript + type: method syntax: content: 'static loadComponent(manifest: IClientSideComponentManifest): Promise;' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.loadComponent~0:complex' + description: A promise containing the loaded module. parameters: - id: manifest description: Manifest of the module to load. - type: '' - return: - type: Promise<TComponent> - description: A promise containing the loaded module. - - name: 'loadComponentById(id, version)' - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' - package: '@microsoft/sp-loader!' - fullName: 'loadComponentById(id, version)' + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + optional: false + typeParameters: + - id: TComponent + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' summary: 'Resolve a component id and version, and load it.' - remarks: '' - - isPreview: false - isDeprecated: false + name: 'loadComponentById(id, version)' + fullName: 'loadComponentById(id, version)' + langs: + - typeScript + type: method syntax: content: 'static loadComponentById(id: string, version?: string): Promise;' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.loadComponentById~0:complex' + description: A promise containing the loaded module. parameters: - id: id description: The id of the component to load. - type: string + type: + - string + optional: false - id: version description: >- The version of the component to load. If version is not defined, the method will load any version of the component. - type: string - return: - type: Promise<TComponent> - description: A promise containing the loaded module. - - name: loadCss(url) - uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' - package: '@microsoft/sp-loader!' - fullName: loadCss(url) + type: + - string + optional: true + typeParameters: + - id: TComponent + - uid: '@microsoft/sp-loader!SPComponentLoader.loadCss:member(1)' summary: Inserts a `` tag for a stylesheet. - remarks: '' - - isPreview: false - isDeprecated: false + name: loadCss(url) + fullName: loadCss(url) + langs: + - typeScript + type: method syntax: content: 'static loadCss(url: string): void;' + return: + type: + - void + description: '' parameters: - id: url description: The CSS file URL. - type: string - return: - type: void - description: '' - - name: 'loadScript(url, options)' - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' - package: '@microsoft/sp-loader!' - fullName: 'loadScript(url, options)' + type: + - string + optional: false + - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' summary: 'Given a URL, load a script.' remarks: >- If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not be propagated. - - isPreview: false - isDeprecated: false + name: 'loadScript(url, options)' + fullName: 'loadScript(url, options)' + langs: + - typeScript + type: method syntax: content: 'static loadScript(url: string, options?: ILoadScriptOptions): Promise;' + return: + type: + - '@microsoft/sp-loader!SPComponentLoader.loadScript~0:complex' + description: A promise containing the loaded module. parameters: - id: url description: The script URL. - type: string + type: + - string + optional: false - id: options description: >- globalExportsName: If the script isn't an AMD module and loads a global member on the page, specify the global member's name. - type: '' - return: - type: Promise<TModule> - description: A promise containing the loaded module. + type: + - '@microsoft/sp-loader!ILoadScriptOptions:interface' + optional: true + typeParameters: + - id: TModule +references: + - uid: '@microsoft/sp-loader!SPComponentLoader.getManifests~0:complex' + name: 'IClientSideComponentManifest[]' + fullName: 'IClientSideComponentManifest[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + fullName: IClientSideComponentManifest + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-loader!SPComponentLoader.loadScript~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-loader!ILoadScriptOptions:interface' + name: ILoadScriptOptions diff --git a/SP-Framework/sp-lodash-subset.yml b/SP-Framework/sp-lodash-subset.yml index f19cad80..9347bef2 100644 --- a/SP-Framework/sp-lodash-subset.yml +++ b/SP-Framework/sp-lodash-subset.yml @@ -1,8 +1,16 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-lodash-subset!' -name: '@microsoft/sp-lodash-subset' -type: package -summary: '' -typeAliases: - - '@microsoft/sp-lodash-subset!Cancelable:type' - - '@microsoft/sp-lodash-subset!ThrottleSettings:type' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-lodash-subset!' + name: '@microsoft/sp-lodash-subset' + fullName: '@microsoft/sp-lodash-subset' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-lodash-subset!Cancelable:type' + - '@microsoft/sp-lodash-subset!ThrottleSettings:type' +references: + - uid: '@microsoft/sp-lodash-subset!Cancelable:type' + name: Cancelable + - uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' + name: ThrottleSettings diff --git a/SP-Framework/sp-lodash-subset/cancelable.yml b/SP-Framework/sp-lodash-subset/cancelable.yml index 587f3078..26a2fda9 100644 --- a/SP-Framework/sp-lodash-subset/cancelable.yml +++ b/SP-Framework/sp-lodash-subset/cancelable.yml @@ -1,11 +1,17 @@ -### YamlMime:TSTypeAlias -name: Cancelable -uid: '@microsoft/sp-lodash-subset!Cancelable:type' -package: '@microsoft/sp-lodash-subset!' -fullName: Cancelable -summary: '' -remarks: '' - -isPreview: false -isDeprecated: false -syntax: export declare type Cancelable = Cancelable2; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-lodash-subset!Cancelable:type' + name: Cancelable + fullName: Cancelable + langs: + - typeScript + type: typealias + syntax: + content: export declare type Cancelable = Cancelable2; + return: + type: + - '@types/lodash!~"\"../index\"".Cancelable:interface' + package: '@microsoft/sp-lodash-subset!' +references: + - uid: '@types/lodash!~"\"../index\"".Cancelable:interface' + name: Cancelable2 diff --git a/SP-Framework/sp-lodash-subset/throttlesettings.yml b/SP-Framework/sp-lodash-subset/throttlesettings.yml index 4b3aa96b..5f176720 100644 --- a/SP-Framework/sp-lodash-subset/throttlesettings.yml +++ b/SP-Framework/sp-lodash-subset/throttlesettings.yml @@ -1,11 +1,17 @@ -### YamlMime:TSTypeAlias -name: ThrottleSettings -uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' -package: '@microsoft/sp-lodash-subset!' -fullName: ThrottleSettings -summary: '' -remarks: '' - -isPreview: false -isDeprecated: false -syntax: export declare type ThrottleSettings = ThrottleSettings2; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-lodash-subset!ThrottleSettings:type' + name: ThrottleSettings + fullName: ThrottleSettings + langs: + - typeScript + type: typealias + syntax: + content: export declare type ThrottleSettings = ThrottleSettings2; + return: + type: + - '@types/lodash!~"\"../index\"".ThrottleSettings:interface' + package: '@microsoft/sp-lodash-subset!' +references: + - uid: '@types/lodash!~"\"../index\"".ThrottleSettings:interface' + name: ThrottleSettings2 diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index c2d9da3d..233d13c0 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -1,31 +1,79 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-module-interfaces!' -name: '@microsoft/sp-module-interfaces' -type: package -summary: '' -typeAliases: - - '@microsoft/sp-module-interfaces!ComponentType:type' - - '@microsoft/sp-module-interfaces!ExtensionType:type' - - '@microsoft/sp-module-interfaces!IModuleConfiguration:type' -interfaces: - - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' - - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' - - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' - - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' - - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' - - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' - - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!IIntegrityPath:interface' - - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' - - '@microsoft/sp-module-interfaces!ILocalizedString:interface' - - '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' - - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' -enums: - - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!' + name: '@microsoft/sp-module-interfaces' + fullName: '@microsoft/sp-module-interfaces' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-module-interfaces!ComponentType:type' + - '@microsoft/sp-module-interfaces!ExtensionType:type' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + - '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - '@microsoft/sp-module-interfaces!IModuleConfiguration:type' + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + - '@microsoft/sp-module-interfaces!PredefinedGroup:enum' +references: + - uid: '@microsoft/sp-module-interfaces!ComponentType:type' + name: ComponentType + - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' + name: ExtensionType + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + name: IAdaptiveCardExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + name: IAdaptiveCardExtensionManifestEntry + - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + name: IClientSideAssemblyManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + name: IClientSideComponentLoaderConfiguration + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + name: IClientSideExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + name: IClientSideLibraryManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + name: IClientSideWebPartManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + name: IClientSideWebPartManifestEntry + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + name: IClientSideWebPartManifestInstance + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + name: ICommandDefinition + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + name: ICommandSetExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + name: IComponentModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + name: IIntegrityPath + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + name: ILocalizedPathModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:type' + name: IModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + name: IModuleConfigurationBase + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + name: IPathModuleConfiguration + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + name: PredefinedGroup diff --git a/SP-Framework/sp-module-interfaces/componenttype.yml b/SP-Framework/sp-module-interfaces/componenttype.yml index e424082d..8170fb50 100644 --- a/SP-Framework/sp-module-interfaces/componenttype.yml +++ b/SP-Framework/sp-module-interfaces/componenttype.yml @@ -1,11 +1,17 @@ -### YamlMime:TSTypeAlias -name: ComponentType -uid: '@microsoft/sp-module-interfaces!ComponentType:type' -package: '@microsoft/sp-module-interfaces!' -fullName: ComponentType -summary: Type of client-side component. -remarks: '' - -isPreview: false -isDeprecated: false -syntax: export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension'; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ComponentType:type' + summary: Type of client-side component. + name: ComponentType + fullName: ComponentType + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | + 'AdaptiveCardExtension'; + return: + type: + - '''Application'' | ''WebPart'' | ''Library'' | ''Extension'' | ''AdaptiveCardExtension''' + package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/extensiontype.yml b/SP-Framework/sp-module-interfaces/extensiontype.yml index 6a9709e1..2a0d7e68 100644 --- a/SP-Framework/sp-module-interfaces/extensiontype.yml +++ b/SP-Framework/sp-module-interfaces/extensiontype.yml @@ -1,13 +1,17 @@ -### YamlMime:TSTypeAlias -name: ExtensionType -uid: '@microsoft/sp-module-interfaces!ExtensionType:type' -package: '@microsoft/sp-module-interfaces!' -fullName: ExtensionType -summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. -remarks: '' - -isPreview: false -isDeprecated: false -syntax: >- - export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | 'ListViewCommandSet' | - 'SearchQueryModifier'; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' + summary: The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. + name: ExtensionType + fullName: ExtensionType + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | + 'ListViewCommandSet' | 'SearchQueryModifier'; + return: + type: + - '''Unknown'' | ''ApplicationCustomizer'' | ''FieldCustomizer'' | ''ListViewCommandSet'' | ''SearchQueryModifier''' + package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index 9495db4c..bd779c6d 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -1,81 +1,95 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionManifest -uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IAdaptiveCardExtensionManifest -summary: '' -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: connectedSPFXAppId - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' + isPreview: true + name: IAdaptiveCardExtensionManifest + fullName: IAdaptiveCardExtensionManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + syntax: + typeParameters: + - id: TProperties package: '@microsoft/sp-module-interfaces!' - fullName: connectedSPFXAppId + children: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportsThemeVariants:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#useFallbackWhenPropertiesUpdatedExternally:member' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member' summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required - remarks: '' - isPreview: true - isDeprecated: false + name: connectedSPFXAppId + fullName: connectedSPFXAppId + langs: + - typeScript + type: property syntax: content: 'connectedSPFXAppId?: string;' return: - type: string - - name: connectedTeamsAppId - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: connectedTeamsAppId + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member' summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required - remarks: '' - isPreview: true - isDeprecated: false + name: connectedTeamsAppId + fullName: connectedTeamsAppId + langs: + - typeScript + type: property syntax: content: 'connectedTeamsAppId?: string;' return: - type: string - - name: experimentalData - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' - package: '@microsoft/sp-module-interfaces!' - fullName: experimentalData + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' summary: An untyped property bag for experimental flags not ready for production. - remarks: '' - isPreview: true - isDeprecated: false + name: experimentalData + fullName: experimentalData + langs: + - typeScript + type: property syntax: content: |- experimentalData?: { [key: string]: any; }; return: - type: |- - { - [key: string]: any; - } - - name: hiddenFromToolbox - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' - package: '@microsoft/sp-module-interfaces!' - fullName: hiddenFromToolbox + type: + - |- + { + [key: string]: any; + } + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' summary: 'If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.' remarks: >- Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way. - isPreview: true - isDeprecated: false + name: hiddenFromToolbox + fullName: hiddenFromToolbox + langs: + - typeScript + type: property syntax: content: 'hiddenFromToolbox?: boolean;' return: - type: boolean - - name: preconfiguredEntries - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries:member' - package: '@microsoft/sp-module-interfaces!' - fullName: preconfiguredEntries + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries:member' summary: >- A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, officeFabricIconFontName, toolbox group name and AdaptiveCardExtension specific custom properties. And there can @@ -117,49 +131,50 @@ properties: } }] ``` - isPreview: true - isDeprecated: false + name: preconfiguredEntries + fullName: preconfiguredEntries + langs: + - typeScript + type: property syntax: content: 'preconfiguredEntries: IAdaptiveCardExtensionManifestEntry[];' return: - type: >- - <TProperties>[] - - name: supportedHosts - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportedHosts + type: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries~0:complex' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts:member' summary: 'Definition: An array defining what host types are supported' remarks: 'Usage: Use this array to define all hosts that are supported.' - isPreview: true - isDeprecated: false + name: supportedHosts + fullName: supportedHosts + langs: + - typeScript + type: property syntax: content: 'supportedHosts?: ReadonlyArray<''Dashboard''>;' return: - type: ReadonlyArray<'Dashboard'> - - name: supportsThemeVariants - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportsThemeVariants:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportsThemeVariants + type: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts~0:complex' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportsThemeVariants:member' summary: 'Definition: If true, this ACE supports and has been tested for theme variants experience.' remarks: >- Usage: Use this flag if a ACE supports theme variants and has been tested as such. In order to support theme variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no ACEs support theme variants. - isPreview: true - isDeprecated: false + name: supportsThemeVariants + fullName: supportsThemeVariants + langs: + - typeScript + type: property syntax: content: 'supportsThemeVariants?: boolean;' return: - type: boolean - - name: useFallbackWhenPropertiesUpdatedExternally - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#useFallbackWhenPropertiesUpdatedExternally:member' - package: '@microsoft/sp-module-interfaces!' - fullName: useFallbackWhenPropertiesUpdatedExternally + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#useFallbackWhenPropertiesUpdatedExternally:member' summary: >- Definition: - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source. - If false, the AdaptiveCardExtension data will be deserialized and the @@ -170,11 +185,37 @@ properties: By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized logic, then it is recommended to override onAfterPropertiesUpdatedExternally. - isPreview: true - isDeprecated: false + name: useFallbackWhenPropertiesUpdatedExternally + fullName: useFallbackWhenPropertiesUpdatedExternally + langs: + - typeScript + type: property syntax: content: 'useFallbackWhenPropertiesUpdatedExternally?: boolean;' return: - type: boolean -extends: '' + type: + - boolean +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#preconfiguredEntries~0:complex' + name: 'IAdaptiveCardExtensionManifestEntry[]' + fullName: 'IAdaptiveCardExtensionManifestEntry[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + name: IAdaptiveCardExtensionManifestEntry + fullName: IAdaptiveCardExtensionManifestEntry + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#supportedHosts~0:complex' + name: ReadonlyArray<'Dashboard'> + fullName: ReadonlyArray<'Dashboard'> + spec.typeScript: + - uid: '!ReadonlyArray:interface' + name: ReadonlyArray + fullName: ReadonlyArray + - name: <'Dashboard'> + fullName: <'Dashboard'> diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index bacd9f22..d664a2de 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -1,37 +1,46 @@ -### YamlMime:TSType -name: IAdaptiveCardExtensionManifestEntry -uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IAdaptiveCardExtensionManifestEntry -summary: >- - This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each - pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and - content authors can modify these properties on a need basis. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: cardSize - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + summary: >- + This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. + Each pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization + admins and content authors can modify these properties on a need basis. + isPreview: true + name: IAdaptiveCardExtensionManifestEntry + fullName: IAdaptiveCardExtensionManifestEntry + langs: + - typeScript + type: interface + syntax: + typeParameters: + - id: TProperties package: '@microsoft/sp-module-interfaces!' - fullName: cardSize + children: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member' + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member' summary: >- Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes \["Medium", "Large"\] defined in the sp-adaptive-card-base project. - remarks: '' - isPreview: true - isDeprecated: false + name: cardSize + fullName: cardSize + langs: + - typeScript + type: property syntax: content: 'cardSize: string;' return: - type: string - - name: dataVersion - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member' - package: '@microsoft/sp-module-interfaces!' - fullName: dataVersion + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member' summary: >- Definition: Use this field to specify the data version of the pre-configured data provided to the AdaptiveCardExtension. Note that data version is different from the version field in the manifest. @@ -51,17 +60,18 @@ properties: Example: `"1.0"` - isPreview: true - isDeprecated: false + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property syntax: content: 'dataVersion?: string;' return: - type: string - - name: description - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member' - package: '@microsoft/sp-module-interfaces!' - fullName: description + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member' summary: >- Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and @@ -88,17 +98,18 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - isPreview: true - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description: ILocalizedString;' return: - type: '' - - name: groupId - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: groupId + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' summary: >- The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If @@ -107,17 +118,18 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - isPreview: true - isDeprecated: false + name: groupId + fullName: groupId + langs: + - typeScript + type: property syntax: content: 'groupId: PredefinedGroup | string;' return: - type: ' | string' - - name: iconImageUrl - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: iconImageUrl + type: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId~0:complex' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' summary: >- The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). @@ -135,17 +147,18 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - isPreview: true - isDeprecated: false + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property syntax: content: 'iconImageUrl?: string;' return: - type: string - - name: officeFabricIconFontName - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: officeFabricIconFontName + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member' summary: >- The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file. @@ -160,17 +173,18 @@ properties: Example: "graph" - isPreview: true - isDeprecated: false + name: officeFabricIconFontName + fullName: officeFabricIconFontName + langs: + - typeScript + type: property syntax: content: 'officeFabricIconFontName?: string;' return: - type: string - - name: properties - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member' - package: '@microsoft/sp-module-interfaces!' - fullName: properties + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member' summary: >- Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and @@ -185,33 +199,35 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - isPreview: true - isDeprecated: false + name: properties + fullName: properties + langs: + - typeScript + type: property syntax: content: 'properties: TProperties;' return: - type: TProperties - - name: tags - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member' - package: '@microsoft/sp-module-interfaces!' - fullName: tags + type: + - TProperties + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member' summary: >- This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - isPreview: true - isDeprecated: false + name: tags + fullName: tags + langs: + - typeScript + type: property syntax: content: 'tags?: ILocalizedString[];' return: - type: '[]' - - name: title - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' - package: '@microsoft/sp-module-interfaces!' - fullName: title + type: + - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags~0:complex' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' summary: >- Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox. @@ -238,10 +254,35 @@ properties: "zh": "我的 web 部件" } ``` - isPreview: true - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: ILocalizedString;' return: - type: '' + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' +references: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId~0:complex' + name: PredefinedGroup | string + fullName: PredefinedGroup | string + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + name: PredefinedGroup + fullName: PredefinedGroup + - name: ' | string' + fullName: ' | string' + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags~0:complex' + name: 'ILocalizedString[]' + fullName: 'ILocalizedString[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + fullName: ILocalizedString + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 47f1ef75..6adee7f3 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -1,29 +1,39 @@ -### YamlMime:TSType -name: IClientSideAssemblyManifest -uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideAssemblyManifest -summary: A library is defined by this manifest. Libraries currently do not have any additional properties. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: rootComponentId - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' + summary: A library is defined by this manifest. Libraries currently do not have any additional properties. + name: IClientSideAssemblyManifest + fullName: IClientSideAssemblyManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: rootComponentId + children: + - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest#rootComponentId:member' summary: The ID of the component from which the assembly is built. remarks: |- Supported values: any GUID Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" - - isPreview: false - isDeprecated: false + name: rootComponentId + fullName: rootComponentId + langs: + - typeScript + type: property syntax: content: 'rootComponentId: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 1e47ead0..80942a6c 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -1,21 +1,22 @@ -### YamlMime:TSType -name: IClientSideComponentLoaderConfiguration -uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideComponentLoaderConfiguration -summary: >- - This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. - It contains all data for loading an entrypoint script and its dependency scripts. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: entryModuleId - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + summary: >- + This interface describes how a client-side component is to be loaded and initialized by a SharePoint client + framework. It contains all data for loading an entrypoint script and its dependency scripts. + isPreview: true + name: IClientSideComponentLoaderConfiguration + fullName: IClientSideComponentLoaderConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-module-interfaces!' - fullName: entryModuleId + children: + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#entryModuleId:member' summary: This is the ID of one of the entries in the "scriptResources" dictionary. remarks: >- The loader will download and evaluate the script resource referenced in this field, resolve all dependencies @@ -28,17 +29,18 @@ properties: Example: `"myApplication.bundle"` - isPreview: true - isDeprecated: false + name: entryModuleId + fullName: entryModuleId + langs: + - typeScript + type: property syntax: content: 'entryModuleId: string;' return: - type: string - - name: exportName - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: exportName + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#exportName:member' summary: The module referenced by the "entryModuleId" field may export an object with several fields. remarks: >- This value optionally references the name of a field on the object exported by the module referenced by the @@ -59,17 +61,18 @@ properties: Example: `mySpWebpart` - isPreview: true - isDeprecated: false + name: exportName + fullName: exportName + langs: + - typeScript + type: property syntax: content: 'exportName?: string;' return: - type: string - - name: internalModuleBaseUrls - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' - package: '@microsoft/sp-module-interfaces!' - fullName: internalModuleBaseUrls + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#internalModuleBaseUrls:member' summary: >- This is an array of fully-qualified paths to be prepended to each of the script resource paths with the "internal" or "localized" type. If one fails to load, the loader will attempt to load from the next until there are no base @@ -95,17 +98,18 @@ properties: Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]` - isPreview: true - isDeprecated: false + name: internalModuleBaseUrls + fullName: internalModuleBaseUrls + langs: + - typeScript + type: property syntax: content: 'internalModuleBaseUrls: string[];' return: - type: 'string[]' - - name: scriptResources - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' - package: '@microsoft/sp-module-interfaces!' - fullName: scriptResources + type: + - 'string[]' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' summary: >- This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each other and `manifest` modules are expected to be provided by the framework runtime. The resource named in the `entryModuleId` @@ -147,16 +151,43 @@ properties: } } ``` - isPreview: true - isDeprecated: false + name: scriptResources + fullName: scriptResources + langs: + - typeScript + type: property syntax: content: |- scriptResources: { [name: string]: IModuleConfiguration; }; return: - type: |- + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources~0:complex' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources~0:complex' + name: |- + { + [name: string]: IModuleConfiguration; + } + fullName: |- + { + [name: string]: IModuleConfiguration; + } + spec.typeScript: + - name: |- + { + [name: string]: + fullName: |- { - [name: string]: ; + [name: string]: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:type' + name: IModuleConfiguration + fullName: IModuleConfiguration + - name: |- + ; + } + fullName: |- + ; } diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index bdc313ef..02427be6 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -1,35 +1,43 @@ -### YamlMime:TSType -name: IClientSideComponentManifest -uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideComponentManifest -summary: >- - All client-side components built on the SharePoint framework need a valid component manifest. This interface - represents properties that are required by all types of client-side components like Applications and Web Parts. - Component specific manifests will extend this interface to add properties required by that component type. -remarks: >- - The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing - this schema. This set of rules can also be called the "manifest upgrade rules". - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + summary: >- + All client-side components built on the SharePoint framework need a valid component manifest. This interface + represents properties that are required by all types of client-side components like Applications and Web Parts. + Component specific manifests will extend this interface to add properties required by that component type. + remarks: >- + The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing + this schema. This set of rules can also be called the "manifest upgrade rules". - - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that - processes the manifest should be able to handle the absence of those new properties. + - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code that + processes the manifest should be able to handle the absence of those new properties. - - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they impose a - migration cost on developers. + - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they + impose a migration cost on developers. - - The `'manifestVersion'` should be bumped for all small or big changes. -isPreview: false -isDeprecated: false -type: interface -properties: - - name: alias - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' + - The `'manifestVersion'` should be bumped for all small or big changes. + name: IClientSideComponentManifest + fullName: IClientSideComponentManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: alias + children: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#alias:member' summary: >- A short name usually given by developer. It does not need to be localized and is expected to stay the same through the lifetime of the component. If an application overrides the `ClientSideApplication.alias` property, @@ -40,17 +48,17 @@ properties: Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters. Example: `"NewFeed"` - - isPreview: false - isDeprecated: false + name: alias + fullName: alias + langs: + - typeScript + type: property syntax: content: 'alias: string;' return: - type: string - - name: componentType - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' - package: '@microsoft/sp-module-interfaces!' - fullName: componentType + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#componentType:member' summary: >- Type of client-side component. Components with the "Application" type are defined by the "IClientSideApplicationManifest" interface. Components with the "WebPart" type are defined by the @@ -63,17 +71,17 @@ properties: Supported values: `"Application"`, `"WebPart"`, `"Library"`, `"Extension"`, `"AdaptiveCardExtension"` - - isPreview: false - isDeprecated: false + name: componentType + fullName: componentType + langs: + - typeScript + type: property syntax: content: 'componentType: ComponentType;' return: - type: '' - - name: loaderConfig - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' - package: '@microsoft/sp-module-interfaces!' - fullName: loaderConfig + type: + - '@microsoft/sp-module-interfaces!ComponentType:type' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loaderConfig:member' summary: >- This portion of the configuration describes how the component is to be loaded and initialized by a client. It contains an enumeration of scripts that the component requires along with a single entry point script. @@ -81,32 +89,32 @@ properties: Usage: Loading a component. See `IClientSideComponentLoaderConfiguration` for more information and examples. - isPreview: true - isDeprecated: false + name: loaderConfig + fullName: loaderConfig + langs: + - typeScript + type: property syntax: content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' return: - type: '' - - name: loadLegacyFabricCss - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' - package: '@microsoft/sp-module-interfaces!' - fullName: loadLegacyFabricCss + type: + - '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' summary: >- This property is used to keep older components that don't explicitly use fabric CSS. For the most part, webparts build after using spfx 1.1 don't need this. - remarks: '' - - isPreview: false - isDeprecated: false + name: loadLegacyFabricCss + fullName: loadLegacyFabricCss + langs: + - typeScript + type: property syntax: content: 'loadLegacyFabricCss?: boolean;' return: - type: boolean - - name: requiresCustomScript - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' - package: '@microsoft/sp-module-interfaces!' - fullName: requiresCustomScript + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' summary: >- If true, the component can only be installed on sites where Custom Script is enabled. This should be set to true if the component allows authors to execute arbitrary scripts on the page. @@ -117,31 +125,31 @@ properties: Usage: Requires Custom Script to be allowed in order for this component to be installed and run. - - isPreview: false - isDeprecated: false + name: requiresCustomScript + fullName: requiresCustomScript + langs: + - typeScript + type: property syntax: content: 'requiresCustomScript?: boolean;' return: - type: boolean - - name: safeWithCustomScriptDisabled - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' - package: '@microsoft/sp-module-interfaces!' - fullName: safeWithCustomScriptDisabled + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#safeWithCustomScriptDisabled:member' summary: This property is provided for backwards compatibility. It no longer has any effect. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: Use requiresCustomScript instead of safeWithCustomScriptDisabled. + deprecated: + content: Use requiresCustomScript instead of safeWithCustomScriptDisabled. + name: safeWithCustomScriptDisabled + fullName: safeWithCustomScriptDisabled + langs: + - typeScript + type: property syntax: content: 'safeWithCustomScriptDisabled?: boolean;' return: - type: boolean - - name: version - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' - package: '@microsoft/sp-module-interfaces!' - fullName: version + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#version:member' summary: >- Client-side component version. The value of this field is expected to be controlled by the developer of the client-side component. @@ -165,11 +173,20 @@ properties: Example: `"1.0.0"` - - isPreview: false - isDeprecated: false + name: version + fullName: version + langs: + - typeScript + type: property syntax: content: 'version: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!ComponentType:type' + name: ComponentType + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration:interface' + name: IClientSideComponentLoaderConfiguration diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index 26180f8c..1a788a84 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -1,28 +1,39 @@ -### YamlMime:TSType -name: IClientSideExtensionManifest -uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideExtensionManifest -summary: This is the manifest for a client-side extension. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: extensionType - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + summary: This is the manifest for a client-side extension. + name: IClientSideExtensionManifest + fullName: IClientSideExtensionManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: extensionType + children: + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest#extensionType:member' summary: >- Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. - remarks: '' - - isPreview: false - isDeprecated: false + name: extensionType + fullName: extensionType + langs: + - typeScript + type: property syntax: content: 'extensionType: ExtensionType;' return: - type: '' -extends: '' + type: + - '@microsoft/sp-module-interfaces!ExtensionType:type' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!ExtensionType:type' + name: ExtensionType diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index ef8494c0..81336afc 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -1,12 +1,21 @@ -### YamlMime:TSType -name: IClientSideLibraryManifest -uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideLibraryManifest -summary: A library is defined by this manifest. Libraries currently do not have any additional properties. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideLibraryManifest:interface' + summary: A library is defined by this manifest. Libraries currently do not have any additional properties. + name: IClientSideLibraryManifest + fullName: IClientSideLibraryManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + package: '@microsoft/sp-module-interfaces!' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase diff --git a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml index 18cb0af2..3f85b038 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemanifestbase.yml @@ -1,19 +1,17 @@ -### YamlMime:TSType -name: IClientSideManifestBase -uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideManifestBase -summary: This interface defines members that are common between all deployable manifests. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + summary: This interface defines members that are common between all deployable manifests. + name: IClientSideManifestBase + fullName: IClientSideManifestBase + langs: + - typeScript + type: interface package: '@microsoft/sp-module-interfaces!' - fullName: id + children: + - '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' + - '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#id:member' summary: >- A universally unique component id. Each client-side component is required to have this id. Once an id has been used for a component, it cannot be changed. A change in this value is treated same as the creation of a new @@ -27,18 +25,17 @@ properties: Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"` - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: string;' return: - type: string - - name: manifestVersion - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' - package: '@microsoft/sp-module-interfaces!' - fullName: manifestVersion + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase#manifestVersion:member' summary: >- Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this field is to help manage upgrades of the component manifest schema. @@ -55,10 +52,13 @@ properties: Example: `1` - - isPreview: false - isDeprecated: false + name: manifestVersion + fullName: manifestVersion + langs: + - typeScript + type: property syntax: content: 'manifestVersion: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 66580cc8..e94f385d 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -1,86 +1,100 @@ -### YamlMime:TSType -name: IClientSideWebPartManifest -uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideWebPartManifest -summary: >- - The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a - manifest. -remarks: >- - The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to identify, - load and process a Web Part. The schema for this manifest is completely owned and versioned by Microsoft. There are - some required properties in the manifest and some optional properties. Optional properties need to be provided only if - the Web Part needs the specific functionality. An invalid manifest could lead to issues with Web Part loading and - functionality problems. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: canUpdateConfiguration - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest:interface' + summary: >- + The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a + manifest. + remarks: >- + The manifest is a schematized JSON blob that is used in multiple parts of the SharePoint infrastructure to + identify, load and process a Web Part. The schema for this manifest is completely owned and versioned by + Microsoft. There are some required properties in the manifest and some optional properties. Optional properties + need to be provided only if the Web Part needs the specific functionality. An invalid manifest could lead to + issues with Web Part loading and functionality problems. + name: IClientSideWebPartManifest + fullName: IClientSideWebPartManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + syntax: + typeParameters: + - id: TProperties package: '@microsoft/sp-module-interfaces!' - fullName: canUpdateConfiguration + children: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' summary: Indicates whether the web part uses the property pane to update the configuration of the web part. remarks: Default value is `true` if the property is not explicitly defined. - - isPreview: false - isDeprecated: false + name: canUpdateConfiguration + fullName: canUpdateConfiguration + langs: + - typeScript + type: property syntax: content: 'canUpdateConfiguration?: boolean;' return: - type: boolean - - name: disabledOnClassicSharepoint - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' - package: '@microsoft/sp-module-interfaces!' - fullName: disabledOnClassicSharepoint + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' summary: 'If true, this web part is disabled on SharePoint classic pages' remarks: >- Certain web parts may not be required on or apply to SharePoint classic pages. This flag helps control that. If this flag is true, the web part will not appear in the classic page web part gallery. - - isPreview: false - isDeprecated: false + name: disabledOnClassicSharepoint + fullName: disabledOnClassicSharepoint + langs: + - typeScript + type: property syntax: content: 'disabledOnClassicSharepoint?: boolean;' return: - type: boolean - - name: hiddenFromToolbox - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' - package: '@microsoft/sp-module-interfaces!' - fullName: hiddenFromToolbox + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' remarks: >- Usage: Use this flag if it is not appropriate to display a web part in the modern toolbox. This property is not used in Classic SharePoint. By default, all web parts are enabled to be displayed in the toolbox. Such web parts can be provisioned on pages though API or be added to the page in a pre configured way. - - isPreview: false - isDeprecated: false + name: hiddenFromToolbox + fullName: hiddenFromToolbox + langs: + - typeScript + type: property syntax: content: 'hiddenFromToolbox?: boolean;' return: - type: boolean - - name: imagePreviewUrl - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: imagePreviewUrl + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#imagePreviewUrl:member' summary: 'Definition: Url of the image image used for preview' remarks: >- Usage: Use this string to specify that a preview image should be used instead of a preview rendering of the web part. This can either be a absolute url or a relative URL which will be resolved based on the internal base module url - - isPreview: false - isDeprecated: false + name: imagePreviewUrl + fullName: imagePreviewUrl + langs: + - typeScript + type: property syntax: content: 'imagePreviewUrl?: string;' return: - type: string - - name: preconfiguredEntries - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' - package: '@microsoft/sp-module-interfaces!' - fullName: preconfiguredEntries + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries:member' summary: >- A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part specific custom properties. And there can be multiple instances of these pre-configured properties. @@ -116,17 +130,17 @@ properties: } }] ``` - - isPreview: false - isDeprecated: false + name: preconfiguredEntries + fullName: preconfiguredEntries + langs: + - typeScript + type: property syntax: content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' return: - type: '<TProperties>[]' - - name: supportedHosts - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportedHosts + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' summary: 'Definition: An array defining what host types are supported' remarks: >- Usage: Use this array to define all hosts that are supported. The default value is SharePointWebPart if nothing is @@ -134,46 +148,71 @@ properties: SharePointWebPart is added the solution will be available when adding webparts to a page. If TeamsTab, TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp cannot be used with TeamsTab or TeamsPersonalTab. - - isPreview: false - isDeprecated: false + name: supportedHosts + fullName: supportedHosts + langs: + - typeScript + type: property syntax: content: >- supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'>; return: - type: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> - - name: supportsFullBleed - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportsFullBleed + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsFullBleed:member' summary: 'Definition: If true, this web part supports and has been tested for full bleed experience.' remarks: >- Usage: Use this flag if a web part supports full bleed experience and has been tested as such. In this context, full bleed is a term used to denote that the web part takes the whole width of the containing page. Full bleed experiences require special treatment and testing. By default no web parts support full bleed experiences. - - isPreview: false - isDeprecated: false + name: supportsFullBleed + fullName: supportsFullBleed + langs: + - typeScript + type: property syntax: content: 'supportsFullBleed?: boolean;' return: - type: boolean - - name: supportsThemeVariants - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' - package: '@microsoft/sp-module-interfaces!' - fullName: supportsThemeVariants + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportsThemeVariants:member' summary: 'Definition: If true, this web part supports and has been tested for theme variants experience.' remarks: >- Usage: Use this flag if a web part supports theme variants and has been tested as such. In order to support theme variants, web parts must have the capability to render correctly in the context of a theme variant. A web part may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no web parts support theme variants. - - isPreview: false - isDeprecated: false + name: supportsThemeVariants + fullName: supportsThemeVariants + langs: + - typeScript + type: property syntax: content: 'supportsThemeVariants?: boolean;' return: - type: boolean -extends: '' + type: + - boolean +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#preconfiguredEntries~0:complex' + name: 'IClientSideWebPartManifestEntry[]' + fullName: 'IClientSideWebPartManifestEntry[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + name: IClientSideWebPartManifestEntry + fullName: IClientSideWebPartManifestEntry + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts~0:complex' + name: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> + fullName: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> + spec.typeScript: + - uid: '!Array:interface' + name: Array + fullName: Array + - name: <'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> + fullName: <'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | 'TeamsMeetingApp'> diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index f494d54a..0ef6f5dc 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -1,22 +1,31 @@ -### YamlMime:TSType -name: IClientSideWebPartManifestEntry -uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideWebPartManifestEntry -summary: >- - This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured - instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify - these properties on a need basis. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dataVersion - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry:interface' + summary: >- + This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each + pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content + authors can modify these properties on a need basis. + name: IClientSideWebPartManifestEntry + fullName: IClientSideWebPartManifestEntry + langs: + - typeScript + type: interface + syntax: + typeParameters: + - id: TProperties package: '@microsoft/sp-module-interfaces!' - fullName: dataVersion + children: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#dataVersion:member' summary: >- Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note that data version is different from the version field in the manifest. @@ -36,17 +45,17 @@ properties: Example: `"1.0"` - - isPreview: false - isDeprecated: false + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property syntax: content: 'dataVersion?: string;' return: - type: string - - name: description - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' - package: '@microsoft/sp-module-interfaces!' - fullName: description + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#description:member' summary: >- Description of the web part represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display @@ -73,17 +82,17 @@ properties: "zh": "用於顯示整潔資訊的工具。" } ``` - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description: ILocalizedString;' return: - type: '' - - name: fullPageAppIconImageUrl - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: fullPageAppIconImageUrl + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' summary: The icon for the Application pages. remarks: >- If this field is not defined, then the iconimageurl is used instead as the icon for Full Page apps. This value can @@ -96,32 +105,33 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - - isPreview: false - isDeprecated: false + name: fullPageAppIconImageUrl + fullName: fullPageAppIconImageUrl + langs: + - typeScript + type: property syntax: content: 'fullPageAppIconImageUrl?: string;' return: - type: string - - name: group - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' - package: '@microsoft/sp-module-interfaces!' - fullName: group + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#group:member' summary: >- The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group. remarks: 'Example: `{ "default": "Media and Content" }`' - isPreview: true - isDeprecated: false + name: group + fullName: group + langs: + - typeScript + type: property syntax: content: 'group?: ILocalizedString;' return: - type: '' - - name: groupId - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' - package: '@microsoft/sp-module-interfaces!' - fullName: groupId + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' summary: >- The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an @@ -130,17 +140,18 @@ properties: Supported values: the GUID from PredefinedGroup list Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"` - isPreview: true - isDeprecated: false + name: groupId + fullName: groupId + langs: + - typeScript + type: property syntax: content: 'groupId: PredefinedGroup | string;' return: - type: ' | string' - - name: iconImageUrl - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: iconImageUrl + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' summary: >- The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image). @@ -158,17 +169,17 @@ properties: Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"` - - isPreview: false - isDeprecated: false + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property syntax: content: 'iconImageUrl?: string;' return: - type: string - - name: officeFabricIconFontName - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: officeFabricIconFontName + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#officeFabricIconFontName:member' summary: >- The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file. @@ -183,17 +194,17 @@ properties: Example: "graph" - - isPreview: false - isDeprecated: false + name: officeFabricIconFontName + fullName: officeFabricIconFontName + langs: + - typeScript + type: property syntax: content: 'officeFabricIconFontName?: string;' return: - type: string - - name: properties - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' - package: '@microsoft/sp-module-interfaces!' - fullName: properties + type: + - string + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#properties:member' summary: >- Every web part is expected to have some custom properties. For example, an image web part might define properties for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so @@ -208,32 +219,33 @@ properties: Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"` - - isPreview: false - isDeprecated: false + name: properties + fullName: properties + langs: + - typeScript + type: property syntax: content: 'properties: TProperties;' return: - type: TProperties - - name: tags - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' - package: '@microsoft/sp-module-interfaces!' - fullName: tags + type: + - TProperties + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags:member' summary: >- This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox. remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`' - isPreview: true - isDeprecated: false + name: tags + fullName: tags + langs: + - typeScript + type: property syntax: content: 'tags?: ILocalizedString[];' return: - type: '[]' - - name: title - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' - package: '@microsoft/sp-module-interfaces!' - fullName: title + type: + - '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags~0:complex' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' summary: >- Title of the web part represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox. @@ -259,10 +271,34 @@ properties: "zh": "我的 web 部件" } ``` - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: ILocalizedString;' return: - type: '' + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' +references: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId~0:complex' + name: PredefinedGroup | string + fullName: PredefinedGroup | string + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + name: PredefinedGroup + fullName: PredefinedGroup + - name: ' | string' + fullName: ' | string' + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#tags~0:complex' + name: 'ILocalizedString[]' + fullName: 'ILocalizedString[]' + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString + fullName: ILocalizedString + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 27835310..7e88f7a6 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -1,12 +1,24 @@ -### YamlMime:TSType -name: IClientSideWebPartManifestInstance -uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IClientSideWebPartManifestInstance -summary: Manifest that is relevant to a Web Part instance. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + summary: Manifest that is relevant to a Web Part instance. + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-module-interfaces!' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index fe94cf0b..05532fcb 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -1,36 +1,35 @@ -### YamlMime:TSType -name: ICommandDefinition -uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ICommandDefinition -summary: >- - Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, - etc. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + summary: >- + Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool + bar, etc. + name: ICommandDefinition + fullName: ICommandDefinition + langs: + - typeScript + type: interface package: '@microsoft/sp-module-interfaces!' - fullName: ariaLabel + children: + - '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' + - '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' + - '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' + - '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#ariaLabel:member' summary: >- Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property will be used by default. Example: "Show information. Press ENTER to select." - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: ILocalizedString;' return: - type: '' - - name: iconImageUrl - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' - package: '@microsoft/sp-module-interfaces!' - fullName: iconImageUrl + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' summary: >- An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all. @@ -40,36 +39,40 @@ properties: manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property). - - isPreview: false - isDeprecated: false + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property syntax: content: 'iconImageUrl?: string;' return: - type: string - - name: title - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' - package: '@microsoft/sp-module-interfaces!' - fullName: title + type: + - string + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#title:member' summary: 'A short label to be displayed by the associated button, menu item, etc. Example: "Show information"' - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: ILocalizedString;' return: - type: '' - - name: type - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type + type: + - '@microsoft/sp-module-interfaces!ILocalizedString:interface' + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' summary: Type of the item. Currently only "command" is allowed. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''command'';' return: - type: '''command''' + type: + - '''command''' +references: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + name: ILocalizedString diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index b2d29568..9229a6b6 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -1,51 +1,87 @@ -### YamlMime:TSType -name: ICommandSetExtensionManifest -uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ICommandSetExtensionManifest -summary: >- - This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, - tool bar, etc. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: extensionType - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface' + summary: >- + This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a + menu, tool bar, etc. + name: ICommandSetExtensionManifest + fullName: ICommandSetExtensionManifest + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: extensionType + children: + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#extensionType:member' summary: >- Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest. - remarks: '' - - isPreview: false - isDeprecated: false + name: extensionType + fullName: extensionType + langs: + - typeScript + type: property syntax: content: 'extensionType: ''ListViewCommandSet'';' return: - type: '''ListViewCommandSet''' - - name: items - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' - package: '@microsoft/sp-module-interfaces!' - fullName: items + type: + - '''ListViewCommandSet''' + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items:member' summary: A table of items defined by this command set. The object key is the Item ID. remarks: >- The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: "SHOW\_INFO" - - isPreview: false - isDeprecated: false + name: items + fullName: items + langs: + - typeScript + type: property syntax: content: |- items: { [itemId: string]: ICommandDefinition; }; return: - type: |- + type: + - '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items~0:complex' +references: + - uid: '@microsoft/sp-module-interfaces!IClientSideExtensionManifest:interface' + name: IClientSideExtensionManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface' + name: IClientSideComponentManifest + - uid: '@microsoft/sp-module-interfaces!IClientSideManifestBase:interface' + name: IClientSideManifestBase + - uid: '@microsoft/sp-module-interfaces!ICommandSetExtensionManifest#items~0:complex' + name: |- + { + [itemId: string]: ICommandDefinition; + } + fullName: |- + { + [itemId: string]: ICommandDefinition; + } + spec.typeScript: + - name: |- { - [itemId: string]: ; + [itemId: string]: + fullName: |- + { + [itemId: string]: + - uid: '@microsoft/sp-module-interfaces!ICommandDefinition:interface' + name: ICommandDefinition + fullName: ICommandDefinition + - name: |- + ; + } + fullName: |- + ; } -extends: '' diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index 1b9d4f6b..8e2cea61 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -1,21 +1,26 @@ -### YamlMime:TSType -name: IComponentModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IComponentModuleConfiguration -summary: >- - This is the interface for a script module with the "component" type. Modules of this type will be provided via - manifests. In order for the dependency to be loaded, the manifest must be available on the site. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: failoverPath - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + summary: >- + This is the interface for a script module with the "component" type. Modules of this type will be provided via + manifests. In order for the dependency to be loaded, the manifest must be available on the site. + isPreview: true + name: IComponentModuleConfiguration + fullName: IComponentModuleConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: failoverPath + children: + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#type:member' + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath:member' summary: A path to the framework-supplied component in case the framework fails to load the requested version. remarks: >- This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls` @@ -28,46 +33,47 @@ properties: Example: `"https://code.jquery.com/jquery-2.2.4.min.js"` - isPreview: true - isDeprecated: false + name: failoverPath + fullName: failoverPath + langs: + - typeScript + type: property syntax: content: 'failoverPath?: string | IIntegrityPath;' return: - type: 'string | ' - - name: id - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' - package: '@microsoft/sp-module-interfaces!' - fullName: id + type: + - '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath~0:complex' + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' summary: The ID of the framework-supplied component to be loaded. remarks: |- Supported values: string representing a component's ID. Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"` - isPreview: true - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: string;' return: - type: string - - name: type - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type - summary: '' - remarks: '' - + type: + - string + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#type:member' isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''component'';' return: - type: '''component''' - - name: version - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' - package: '@microsoft/sp-module-interfaces!' - fullName: version + type: + - '''component''' + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#version:member' summary: >- The version of the framework-supplied component to be loaded. For framework runtime component such as `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was @@ -76,11 +82,26 @@ properties: Supported values: string representing a [semantic version](http://semver.org), or "latest". Example: `"2.2.4"` - isPreview: true - isDeprecated: false + name: version + fullName: version + langs: + - typeScript + type: property syntax: content: 'version: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + name: IModuleConfigurationBase + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#failoverPath~0:complex' + name: string | IIntegrityPath + fullName: string | IIntegrityPath + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + name: IIntegrityPath + fullName: IIntegrityPath diff --git a/SP-Framework/sp-module-interfaces/iintegritypath.yml b/SP-Framework/sp-module-interfaces/iintegritypath.yml index 8cc60747..60547de6 100644 --- a/SP-Framework/sp-module-interfaces/iintegritypath.yml +++ b/SP-Framework/sp-module-interfaces/iintegritypath.yml @@ -1,40 +1,42 @@ -### YamlMime:TSType -name: IIntegrityPath -uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IIntegrityPath -summary: A path with the subresource integrity hash of the resource. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: integrity - uid: '@microsoft/sp-module-interfaces!IIntegrityPath#integrity:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + summary: A path with the subresource integrity hash of the resource. + isPreview: true + name: IIntegrityPath + fullName: IIntegrityPath + langs: + - typeScript + type: interface package: '@microsoft/sp-module-interfaces!' - fullName: integrity + children: + - '@microsoft/sp-module-interfaces!IIntegrityPath#integrity:member' + - '@microsoft/sp-module-interfaces!IIntegrityPath#path:member' + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath#integrity:member' summary: >- The subresource integrity hash of the resource referenced in [IIntegrityPath.path](xref:@microsoft/sp-module-interfaces!IIntegrityPath%23path:member). - remarks: '' - isPreview: true - isDeprecated: false + name: integrity + fullName: integrity + langs: + - typeScript + type: property syntax: content: 'integrity?: string;' return: - type: string - - name: path - uid: '@microsoft/sp-module-interfaces!IIntegrityPath#path:member' - package: '@microsoft/sp-module-interfaces!' - fullName: path + type: + - string + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath#path:member' summary: The path to the resource. - remarks: '' - isPreview: true - isDeprecated: false + name: path + fullName: path + langs: + - typeScript + type: property syntax: content: 'path: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index c43eb21d..e2c1e516 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -1,22 +1,27 @@ -### YamlMime:TSType -name: ILocalizedPathModuleConfiguration -uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ILocalizedPathModuleConfiguration -summary: This is the interface for a script module with the "localizedPath" type. -remarks: >- - Modules of this type must be provided by the component developer. These script resources are similar to those of the - "path" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in - this module type are loaded exactly the same way as "internal" modules are. - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: defaultPath - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + summary: This is the interface for a script module with the "localizedPath" type. + remarks: >- + Modules of this type must be provided by the component developer. These script resources are similar to those of + the "path" type, but they may be present at a number of different paths, to be selected by the user's locale. + Paths in this module type are loaded exactly the same way as "internal" modules are. + isPreview: true + name: ILocalizedPathModuleConfiguration + fullName: ILocalizedPathModuleConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: defaultPath + children: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#type:member' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath:member' summary: >- A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the paths provided in the "internalModuleBaseUrls" field. @@ -31,17 +36,18 @@ properties: Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"` - isPreview: true - isDeprecated: false + name: defaultPath + fullName: defaultPath + langs: + - typeScript + type: property syntax: content: 'defaultPath: string | IIntegrityPath;' return: - type: 'string | ' - - name: paths - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' - package: '@microsoft/sp-module-interfaces!' - fullName: paths + type: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath~0:complex' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' summary: >- This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale javascript resource either as a fully-qualified URL or as a path under the paths provided in the `"internalModuleBaseUrls"` field. @@ -69,30 +75,66 @@ properties: "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" } ``` - isPreview: true - isDeprecated: false + name: paths + fullName: paths + langs: + - typeScript + type: property syntax: content: |- paths?: { [locale: string]: string | IIntegrityPath; }; return: - type: |- - { - [locale: string]: string | ; - } - - name: type - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type - summary: '' - remarks: '' - + type: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#type:member' isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''localizedPath'';' return: - type: '''localizedPath''' -extends: '' + type: + - '''localizedPath''' +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + name: IModuleConfigurationBase + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#defaultPath~0:complex' + name: string | IIntegrityPath + fullName: string | IIntegrityPath + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + name: IIntegrityPath + fullName: IIntegrityPath + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' + name: |- + { + [locale: string]: string | IIntegrityPath; + } + fullName: |- + { + [locale: string]: string | IIntegrityPath; + } + spec.typeScript: + - name: |- + { + [locale: string]: string | + fullName: |- + { + [locale: string]: string | + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + name: IIntegrityPath + fullName: IIntegrityPath + - name: |- + ; + } + fullName: |- + ; + } diff --git a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml index e97eb4c8..fee348cf 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedstring.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -1,79 +1,77 @@ -### YamlMime:TSType -name: ILocalizedString -uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: ILocalizedString -summary: A set of localized strings. -remarks: >- - Supported values: +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!ILocalizedString:interface' + summary: A set of localized strings. + remarks: >- + Supported values: - - An Id referring to a localized resource. In this case it requires an 'id' key. + - An Id referring to a localized resource. In this case it requires an 'id' key. - - A dictionary of locale keys to strings. In this case it requires a 'default' key. + - A dictionary of locale keys to strings. In this case it requires a 'default' key. - ``` + ``` - Example 1: "My Application" - { - "id": "$myStrings:myStrings.MyApplication;" - } - Example 2: "My Application" - { - "default": "My Application" - "en-us": "My Application", - "fr-fr": "Ma demande", - "zh": "我的應用程式" - } - ``` + Example 1: "My Application" + { + "id": "$myStrings:myStrings.MyApplication;" + } + Example 2: "My Application" + { + "default": "My Application" + "en-us": "My Application", + "fr-fr": "Ma demande", + "zh": "我的應用程式" + } + ``` - Notes on string ids: + Notes on string ids: - - Ids have the following structure: `$:;` + - Ids have the following structure: `$:;` - - `resourceName` needs to be a `localizedResource` in the config.json. + - `resourceName` needs to be a `localizedResource` in the config.json. - - `expression` is an expression that will be evaluated to access the string from the resource module. + - `expression` is an expression that will be evaluated to access the string from the resource module. - If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or - `"$resource:resource[\"MyString\"];"` + If your resource is a dictionary, access it through `"$resource:resource.MyString;"` or + `"$resource:resource[\"MyString\"];"` - For more complex cases, run an appropriate expression to access your resource and return the string. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: default - uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' + For more complex cases, run an appropriate expression to access your resource and return the string. + name: ILocalizedString + fullName: ILocalizedString + langs: + - typeScript + type: interface package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!ILocalizedString#default:member' + - '@microsoft/sp-module-interfaces!ILocalizedString#id:member' + - uid: '@microsoft/sp-module-interfaces!ILocalizedString#default:member' + name: default fullName: default - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'default?: string;' return: - type: string - - name: id - uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' - package: '@microsoft/sp-module-interfaces!' + type: + - string + - uid: '@microsoft/sp-module-interfaces!ILocalizedString#id:member' + name: id fullName: id - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'id?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml index ba7c1e51..cf94680b 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -1,13 +1,35 @@ -### YamlMime:TSTypeAlias -name: IModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:type' -package: '@microsoft/sp-module-interfaces!' -fullName: IModuleConfiguration -summary: '' -remarks: '' - -isPreview: true -isDeprecated: false -syntax: >- - export declare type IModuleConfiguration = IComponentModuleConfiguration | IPathModuleConfiguration | - ILocalizedPathModuleConfiguration; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:type' + isPreview: true + name: IModuleConfiguration + fullName: IModuleConfiguration + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type IModuleConfiguration = IComponentModuleConfiguration | IPathModuleConfiguration | + ILocalizedPathModuleConfiguration; + return: + type: + - '@microsoft/sp-module-interfaces!IModuleConfiguration~0:complex' + package: '@microsoft/sp-module-interfaces!' +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfiguration~0:complex' + name: IComponentModuleConfiguration | IPathModuleConfiguration | ILocalizedPathModuleConfiguration + fullName: IComponentModuleConfiguration | IPathModuleConfiguration | ILocalizedPathModuleConfiguration + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration:interface' + name: IComponentModuleConfiguration + fullName: IComponentModuleConfiguration + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + name: IPathModuleConfiguration + fullName: IPathModuleConfiguration + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration:interface' + name: ILocalizedPathModuleConfiguration + fullName: ILocalizedPathModuleConfiguration diff --git a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml index 2b78f22e..7582aac2 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -1,19 +1,18 @@ -### YamlMime:TSType -name: IModuleConfigurationBase -uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IModuleConfigurationBase -summary: This is the base interface for a script module's definition. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: shouldNotPreload - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#shouldNotPreload:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + summary: This is the base interface for a script module's definition. + isPreview: true + name: IModuleConfigurationBase + fullName: IModuleConfigurationBase + langs: + - typeScript + type: interface package: '@microsoft/sp-module-interfaces!' - fullName: shouldNotPreload + children: + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase#shouldNotPreload:member' + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase#type:member' + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#shouldNotPreload:member' summary: 'If set to `true`, this module should not be preloaded when loading the component.' remarks: >- The most common case for setting this property to "true" is when a module is defined in a manifest, but is not @@ -22,17 +21,18 @@ properties: Usage: Instructs the module loader to not preload this module. - isPreview: true - isDeprecated: false + name: shouldNotPreload + fullName: shouldNotPreload + langs: + - typeScript + type: property syntax: content: 'shouldNotPreload?: boolean;' return: - type: boolean - - name: type - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type + type: + - boolean + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#type:member' summary: >- The type of the script block. `"component"` modules come from a component, `"path"` and `"localizedPath"` modules must be available on the paths provided in the `"internalModuleBaseUrls"` field. @@ -48,10 +48,14 @@ properties: Example: `"localized"` - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''component'' | ''path'' | ''localizedPath'';' return: - type: '''component'' | ''path'' | ''localizedPath''' + type: + - '''component'' | ''path'' | ''localizedPath''' diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 24aef5fe..aa190f0d 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -1,21 +1,26 @@ -### YamlMime:TSType -name: IPathModuleConfiguration -uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' -package: '@microsoft/sp-module-interfaces!' -fullName: IPathModuleConfiguration -summary: >- - This is the interface for a script module with the "path" type. Modules of this type must be provided by the component - developer. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: globalDependencies - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration:interface' + summary: >- + This is the interface for a script module with the "path" type. Modules of this type must be provided by the + component developer. + isPreview: true + name: IPathModuleConfiguration + fullName: IPathModuleConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + inheritance: + - type: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' package: '@microsoft/sp-module-interfaces!' - fullName: globalDependencies + children: + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#type:member' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalDependencies:member' summary: >- For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will ensure that those dependencies are already loaded. @@ -31,17 +36,18 @@ properties: Example: `["jquery"]` - isPreview: true - isDeprecated: false + name: globalDependencies + fullName: globalDependencies + langs: + - typeScript + type: property syntax: content: 'globalDependencies?: string[];' return: - type: 'string[]' - - name: globalName - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' - package: '@microsoft/sp-module-interfaces!' - fullName: globalName + type: + - 'string[]' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' summary: >- If this property is specified, this module is considered non-AMD and the module loader will not expect "define" or "require" to be called. @@ -59,17 +65,18 @@ properties: Example: `"$"` - isPreview: true - isDeprecated: false + name: globalName + fullName: globalName + langs: + - typeScript + type: property syntax: content: 'globalName?: string;' return: - type: string - - name: path - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' - package: '@microsoft/sp-module-interfaces!' - fullName: path + type: + - string + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path:member' summary: >- A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided in the `internalModuleBaseUrls` field. @@ -88,24 +95,38 @@ properties: Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"` - isPreview: true - isDeprecated: false + name: path + fullName: path + langs: + - typeScript + type: property syntax: content: 'path: string | IIntegrityPath;' return: - type: 'string | ' - - name: type - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#type:member' - package: '@microsoft/sp-module-interfaces!' - fullName: type - summary: '' - remarks: '' - + type: + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#type:member' isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ''path'';' return: - type: '''path''' -extends: '' + type: + - '''path''' +references: + - uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase:interface' + name: IModuleConfigurationBase + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' + name: string | IIntegrityPath + fullName: string | IIntegrityPath + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath:interface' + name: IIntegrityPath + fullName: IIntegrityPath diff --git a/SP-Framework/sp-module-interfaces/predefinedgroup.yml b/SP-Framework/sp-module-interfaces/predefinedgroup.yml index f16746fc..edf31797 100644 --- a/SP-Framework/sp-module-interfaces/predefinedgroup.yml +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -1,77 +1,118 @@ -### YamlMime:TSEnum -name: PredefinedGroup -uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' -package: '@microsoft/sp-module-interfaces!' -fullName: PredefinedGroup -summary: Predefined web part group. -remarks: '' - -isPreview: true -isDeprecated: false -fields: - - name: BusinessAndIntelligence - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup:enum' + summary: Predefined web part group. + isPreview: true + name: PredefinedGroup + fullName: PredefinedGroup + langs: + - typeScript + type: enum package: '@microsoft/sp-module-interfaces!' + children: + - '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.Local:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' + - '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.BusinessAndIntelligence:member' summary: |- Business and intelligence. This group includes web parts for tracking and analyzing data, and for integrating business flow with pages. - value: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' - - name: CommunicationAndCollaboration - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: BusinessAndIntelligence + fullName: BusinessAndIntelligence + langs: + - typeScript + type: field + numericValue: '"4aca9e90-eff5-4fa1-bac7-728f5f157b66"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.CommunicationAndCollaboration:member' summary: |- Communication and collaboration. This group includes web parts that facilitate information sharing, team work, and social interactions. - value: '"75e22ed5-fa14-4829-850a-c890608aca2d"' - - name: Discovery - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: CommunicationAndCollaboration + fullName: CommunicationAndCollaboration + langs: + - typeScript + type: field + numericValue: '"75e22ed5-fa14-4829-850a-c890608aca2d"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Discovery:member' summary: |- Discovery. This group includes web parts that organize, group, and filter content to help users discover information. - value: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' - - name: Local - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Local:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: Discovery + fullName: Discovery + langs: + - typeScript + type: field + numericValue: '"1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Local:member' summary: |- Other. This group includes local web parts. - value: '"8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"' - - name: Other - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: Local + fullName: Local + langs: + - typeScript + type: field + numericValue: '"8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.Other:member' summary: |- Other. This group includes web parts not in other groups. - value: '"5c03119e-3074-46fd-976b-c60198311f70"' - - name: PlanningAndProcess - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: Other + fullName: Other + langs: + - typeScript + type: field + numericValue: '"5c03119e-3074-46fd-976b-c60198311f70"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.PlanningAndProcess:member' summary: |- Planning and process. This group includes web parts that empower team productivity with the use of planning and process tools. - value: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' - - name: SiteTools - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: PlanningAndProcess + fullName: PlanningAndProcess + langs: + - typeScript + type: field + numericValue: '"1bc7927e-4a5e-4520-b540-71305c79c20a"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.SiteTools:member' summary: |- Site tools. This group includes web parts for site information and management. - value: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' - - name: TextMediaAndContent - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' - package: '@microsoft/sp-module-interfaces!' + isPreview: true + name: SiteTools + fullName: SiteTools + langs: + - typeScript + type: field + numericValue: '"070951d7-94da-4db8-b06e-9d581f1f55b1"' + - uid: '@microsoft/sp-module-interfaces!PredefinedGroup.TextMediaAndContent:member' summary: >- Text, media and content. This group includes web parts that display text, multi-media, documents, information from the web, and other rich content. - value: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' + isPreview: true + name: TextMediaAndContent + fullName: TextMediaAndContent + langs: + - typeScript + type: field + numericValue: '"cf066440-0614-43d6-98ae-0b31cf14c7c3"' diff --git a/SP-Framework/sp-odata-types.yml b/SP-Framework/sp-odata-types.yml index 1f4468ad..a3af166c 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -1,19 +1,54 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-odata-types!' -name: '@microsoft/sp-odata-types' -type: package -summary: TypeScript interfaces for working with SharePoint REST APIs. -interfaces: - - '@microsoft/sp-odata-types!_IODataUserId:interface' - - '@microsoft/sp-odata-types!IODataBasePermission:interface' - - '@microsoft/sp-odata-types!IODataChangeToken:interface' - - '@microsoft/sp-odata-types!IODataContentType:interface' - - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' - - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' - - '@microsoft/sp-odata-types!IODataList:interface' - - '@microsoft/sp-odata-types!IODataListItem:interface' - - '@microsoft/sp-odata-types!IODataNavigationNode:interface' - - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' - - '@microsoft/sp-odata-types!IODataUser:interface' - - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' - - '@microsoft/sp-odata-types!IODataWeb:interface' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!' + summary: TypeScript interfaces for working with SharePoint REST APIs. + remarks: >- + This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. + It is useful when implementing data layers that interpret these types. This package does not contain any runtime + code; it consists only of type definitions. + name: '@microsoft/sp-odata-types' + fullName: '@microsoft/sp-odata-types' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-odata-types!_IODataUserId:interface' + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - '@microsoft/sp-odata-types!IODataContentType:interface' + - '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + - '@microsoft/sp-odata-types!IODataList:interface' + - '@microsoft/sp-odata-types!IODataListItem:interface' + - '@microsoft/sp-odata-types!IODataNavigationNode:interface' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + - '@microsoft/sp-odata-types!IODataUser:interface' + - '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + - '@microsoft/sp-odata-types!IODataWeb:interface' +references: + - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' + name: _IODataUserId + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + name: IODataBasePermission + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + name: IODataChangeToken + - uid: '@microsoft/sp-odata-types!IODataContentType:interface' + name: IODataContentType + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + name: IODataContextWebInformation + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + name: IODataFormsClientSideConfiguration + - uid: '@microsoft/sp-odata-types!IODataList:interface' + name: IODataList + - uid: '@microsoft/sp-odata-types!IODataListItem:interface' + name: IODataListItem + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + name: IODataNavigationNodeCollection + - uid: '@microsoft/sp-odata-types!IODataUser:interface' + name: IODataUser + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + name: IODataUserCustomAction + - uid: '@microsoft/sp-odata-types!IODataWeb:interface' + name: IODataWeb diff --git a/SP-Framework/sp-odata-types/_iodatauserid.yml b/SP-Framework/sp-odata-types/_iodatauserid.yml index 52a34924..446fb384 100644 --- a/SP-Framework/sp-odata-types/_iodatauserid.yml +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -1,40 +1,39 @@ -### YamlMime:TSType -name: _IODataUserId -uid: '@microsoft/sp-odata-types!_IODataUserId:interface' -package: '@microsoft/sp-odata-types!' -fullName: _IODataUserId -summary: >- - Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: NameId - uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' + summary: >- + Represents an OData SP.UserId object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: _IODataUserId + fullName: _IODataUserId + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: NameId + children: + - '@microsoft/sp-odata-types!_IODataUserId#NameId:member' + - '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' + - uid: '@microsoft/sp-odata-types!_IODataUserId#NameId:member' summary: 'Example: `"s-1-5-21-2127521184-1604012920-1887927527-2632426"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: NameId + fullName: NameId + langs: + - typeScript + type: property syntax: content: 'NameId: string;' return: - type: string - - name: NameIdIssuer - uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' - package: '@microsoft/sp-odata-types!' - fullName: NameIdIssuer + type: + - string + - uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' summary: 'Example: `"urn:office:idp:activedirectory"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: NameIdIssuer + fullName: NameIdIssuer + langs: + - typeScript + type: property syntax: content: 'NameIdIssuer: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-odata-types/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 064cd12b..ad3379fd 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -1,38 +1,35 @@ -### YamlMime:TSType -name: IODataBasePermission -uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataBasePermission -summary: Data used for creating a SPPermission object. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: High - uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + summary: Data used for creating a SPPermission object. + name: IODataBasePermission + fullName: IODataBasePermission + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' + children: + - '@microsoft/sp-odata-types!IODataBasePermission#High:member' + - '@microsoft/sp-odata-types!IODataBasePermission#Low:member' + - uid: '@microsoft/sp-odata-types!IODataBasePermission#High:member' + name: High fullName: High - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'High: number;' return: - type: number - - name: Low - uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' - package: '@microsoft/sp-odata-types!' + type: + - number + - uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' + name: Low fullName: Low - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'Low: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-odata-types/iodatachangetoken.yml b/SP-Framework/sp-odata-types/iodatachangetoken.yml index 6166cb38..c9d15958 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -1,27 +1,26 @@ -### YamlMime:TSType -name: IODataChangeToken -uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataChangeToken -summary: >- - Represents an OData SP.ChangeToken object. For more information about this object, see - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: StringValue - uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + summary: >- + Represents an OData SP.ChangeToken object. For more information about this object, see + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: IODataChangeToken + fullName: IODataChangeToken + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: StringValue + children: + - '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' + - uid: '@microsoft/sp-odata-types!IODataChangeToken#StringValue:member' summary: 'Example: `{ StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }`' - remarks: '' - - isPreview: false - isDeprecated: false + name: StringValue + fullName: StringValue + langs: + - typeScript + type: property syntax: content: 'StringValue: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml index 2313fd7c..86b56a56 100644 --- a/SP-Framework/sp-odata-types/iodatacontenttype.yml +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -1,156 +1,163 @@ -### YamlMime:TSType -name: IODataContentType -uid: '@microsoft/sp-odata-types!IODataContentType:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataContentType -summary: Represents OData SP.ContentType object. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ClientFormCustomFormatter - uid: '@microsoft/sp-odata-types!IODataContentType#ClientFormCustomFormatter:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataContentType:interface' + summary: Represents OData SP.ContentType object. + name: IODataContentType + fullName: IODataContentType + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + inheritance: + - type: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' package: '@microsoft/sp-odata-types!' - fullName: ClientFormCustomFormatter + children: + - '@microsoft/sp-odata-types!IODataContentType#ClientFormCustomFormatter:member' + - '@microsoft/sp-odata-types!IODataContentType#Description:member' + - '@microsoft/sp-odata-types!IODataContentType#DisplayFormUrl:member' + - '@microsoft/sp-odata-types!IODataContentType#EditFormUrl:member' + - '@microsoft/sp-odata-types!IODataContentType#Group:member' + - '@microsoft/sp-odata-types!IODataContentType#Id:member' + - '@microsoft/sp-odata-types!IODataContentType#Name:member' + - '@microsoft/sp-odata-types!IODataContentType#NewFormUrl:member' + - '@microsoft/sp-odata-types!IODataContentType#ReadOnly:member' + - '@microsoft/sp-odata-types!IODataContentType#SchemaXml:member' + - '@microsoft/sp-odata-types!IODataContentType#StringId:member' + - uid: '@microsoft/sp-odata-types!IODataContentType#ClientFormCustomFormatter:member' summary: Custom formatter (JSON) for the content type forms - remarks: '' - - isPreview: false - isDeprecated: false + name: ClientFormCustomFormatter + fullName: ClientFormCustomFormatter + langs: + - typeScript + type: property syntax: content: 'ClientFormCustomFormatter: string;' return: - type: string - - name: Description - uid: '@microsoft/sp-odata-types!IODataContentType#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#Description:member' summary: Content type description - remarks: '' - - isPreview: false - isDeprecated: false + name: Description + fullName: Description + langs: + - typeScript + type: property syntax: content: 'Description: string;' return: - type: string - - name: DisplayFormUrl - uid: '@microsoft/sp-odata-types!IODataContentType#DisplayFormUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: DisplayFormUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#DisplayFormUrl:member' summary: Content type display form URL - remarks: '' - - isPreview: false - isDeprecated: false + name: DisplayFormUrl + fullName: DisplayFormUrl + langs: + - typeScript + type: property syntax: content: 'DisplayFormUrl: string;' return: - type: string - - name: EditFormUrl - uid: '@microsoft/sp-odata-types!IODataContentType#EditFormUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: EditFormUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#EditFormUrl:member' summary: Content type edit form URL - remarks: '' - - isPreview: false - isDeprecated: false + name: EditFormUrl + fullName: EditFormUrl + langs: + - typeScript + type: property syntax: content: 'EditFormUrl: string;' return: - type: string - - name: Group - uid: '@microsoft/sp-odata-types!IODataContentType#Group:member' - package: '@microsoft/sp-odata-types!' - fullName: Group + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#Group:member' summary: Content type group - remarks: '' - - isPreview: false - isDeprecated: false + name: Group + fullName: Group + langs: + - typeScript + type: property syntax: content: 'Group: string;' return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataContentType#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#Id:member' summary: Content type ID - remarks: '' - - isPreview: false - isDeprecated: false + name: Id + fullName: Id + langs: + - typeScript + type: property syntax: content: 'Id: IODataContentTypeId;' return: - type: '' - - name: Name - uid: '@microsoft/sp-odata-types!IODataContentType#Name:member' - package: '@microsoft/sp-odata-types!' - fullName: Name + type: + - '@microsoft/sp-odata-types!IODataContentTypeId:interface' + - uid: '@microsoft/sp-odata-types!IODataContentType#Name:member' summary: Content type name - remarks: '' - - isPreview: false - isDeprecated: false + name: Name + fullName: Name + langs: + - typeScript + type: property syntax: content: 'Name: string;' return: - type: string - - name: NewFormUrl - uid: '@microsoft/sp-odata-types!IODataContentType#NewFormUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: NewFormUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#NewFormUrl:member' summary: Content type new form URL - remarks: '' - - isPreview: false - isDeprecated: false + name: NewFormUrl + fullName: NewFormUrl + langs: + - typeScript + type: property syntax: content: 'NewFormUrl: string;' return: - type: string - - name: ReadOnly - uid: '@microsoft/sp-odata-types!IODataContentType#ReadOnly:member' - package: '@microsoft/sp-odata-types!' - fullName: ReadOnly + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#ReadOnly:member' summary: Specifies whether content type is read-only - remarks: '' - - isPreview: false - isDeprecated: false + name: ReadOnly + fullName: ReadOnly + langs: + - typeScript + type: property syntax: content: 'ReadOnly: boolean;' return: - type: boolean - - name: SchemaXml - uid: '@microsoft/sp-odata-types!IODataContentType#SchemaXml:member' - package: '@microsoft/sp-odata-types!' - fullName: SchemaXml + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataContentType#SchemaXml:member' summary: Content type schema XML - remarks: '' - - isPreview: false - isDeprecated: false + name: SchemaXml + fullName: SchemaXml + langs: + - typeScript + type: property syntax: content: 'SchemaXml: string;' return: - type: string - - name: StringId - uid: '@microsoft/sp-odata-types!IODataContentType#StringId:member' - package: '@microsoft/sp-odata-types!' - fullName: StringId + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#StringId:member' summary: Content type string id - remarks: '' - - isPreview: false - isDeprecated: false + name: StringId + fullName: StringId + langs: + - typeScript + type: property syntax: content: 'StringId: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + name: IODataFormsClientSideConfiguration + - uid: '@microsoft/sp-odata-types!IODataContentTypeId:interface' + name: IODataContentTypeId diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index 1e6e60f5..8efafecf 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -1,66 +1,65 @@ -### YamlMime:TSType -name: IODataContextWebInformation -uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataContextWebInformation -summary: >- - Represents an OData SP.ContextWebInformation object. For more information about this object, see - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: LibraryVersion - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' + summary: >- + Represents an OData SP.ContextWebInformation object. For more information about this object, see + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: IODataContextWebInformation + fullName: IODataContextWebInformation + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: LibraryVersion + children: + - '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' + - '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' + - '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' + - '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member' summary: 'Example: `"16.0.4919.3000"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: LibraryVersion + fullName: LibraryVersion + langs: + - typeScript + type: property syntax: content: 'LibraryVersion: string;' return: - type: string - - name: SiteFullUrl - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: SiteFullUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: SiteFullUrl + fullName: SiteFullUrl + langs: + - typeScript + type: property syntax: content: 'SiteFullUrl: string;' return: - type: string - - name: SupportedSchemaVersions - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' - package: '@microsoft/sp-odata-types!' - fullName: SupportedSchemaVersions + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' - remarks: '' - - isPreview: false - isDeprecated: false + name: SupportedSchemaVersions + fullName: SupportedSchemaVersions + langs: + - typeScript + type: property syntax: content: 'SupportedSchemaVersions: string[];' return: - type: 'string[]' - - name: WebFullUrl - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: WebFullUrl + type: + - 'string[]' + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: WebFullUrl + fullName: WebFullUrl + langs: + - typeScript + type: property syntax: content: 'WebFullUrl: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml index ad16f5b2..d52ab81b 100644 --- a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -1,129 +1,128 @@ -### YamlMime:TSType -name: IODataFormsClientSideConfiguration -uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataFormsClientSideConfiguration -summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: DislpayFormClientSideDisplayTarget - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DislpayFormClientSideDisplayTarget:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' + name: IODataFormsClientSideConfiguration + fullName: IODataFormsClientSideConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: DislpayFormClientSideDisplayTarget + children: + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DislpayFormClientSideDisplayTarget:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentId:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentProperties:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentId:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentProperties:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideDisplayTarget:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentId:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentProperties:member' + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideDisplayTarget:member' + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DislpayFormClientSideDisplayTarget:member' summary: 'Display Form display target (new tab, panel)' - remarks: '' - - isPreview: false - isDeprecated: false + name: DislpayFormClientSideDisplayTarget + fullName: DislpayFormClientSideDisplayTarget + langs: + - typeScript + type: property syntax: content: 'DislpayFormClientSideDisplayTarget: string | undefined;' return: - type: string | undefined - - name: DisplayFormClientSideComponentId - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentId:member' - package: '@microsoft/sp-odata-types!' - fullName: DisplayFormClientSideComponentId + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentId:member' summary: Display Form Customizer component id - remarks: '' - - isPreview: false - isDeprecated: false + name: DisplayFormClientSideComponentId + fullName: DisplayFormClientSideComponentId + langs: + - typeScript + type: property syntax: content: 'DisplayFormClientSideComponentId: string | undefined;' return: - type: string | undefined - - name: DisplayFormClientSideComponentProperties - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentProperties:member' - package: '@microsoft/sp-odata-types!' - fullName: DisplayFormClientSideComponentProperties + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentProperties:member' summary: Display Form Customizer component properties - remarks: '' - - isPreview: false - isDeprecated: false + name: DisplayFormClientSideComponentProperties + fullName: DisplayFormClientSideComponentProperties + langs: + - typeScript + type: property syntax: content: 'DisplayFormClientSideComponentProperties: string | undefined;' return: - type: string | undefined - - name: EditFormClientSideComponentId - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentId:member' - package: '@microsoft/sp-odata-types!' - fullName: EditFormClientSideComponentId + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentId:member' summary: Edit Form Customizer component id - remarks: '' - - isPreview: false - isDeprecated: false + name: EditFormClientSideComponentId + fullName: EditFormClientSideComponentId + langs: + - typeScript + type: property syntax: content: 'EditFormClientSideComponentId: string | undefined;' return: - type: string | undefined - - name: EditFormClientSideComponentProperties - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentProperties:member' - package: '@microsoft/sp-odata-types!' - fullName: EditFormClientSideComponentProperties + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentProperties:member' summary: Edit Form Customizer component properties - remarks: '' - - isPreview: false - isDeprecated: false + name: EditFormClientSideComponentProperties + fullName: EditFormClientSideComponentProperties + langs: + - typeScript + type: property syntax: content: 'EditFormClientSideComponentProperties: string | undefined;' return: - type: string | undefined - - name: EditFormClientSideDisplayTarget - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideDisplayTarget:member' - package: '@microsoft/sp-odata-types!' - fullName: EditFormClientSideDisplayTarget + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideDisplayTarget:member' summary: 'Edit Form display target (new tab, panel)' - remarks: '' - - isPreview: false - isDeprecated: false + name: EditFormClientSideDisplayTarget + fullName: EditFormClientSideDisplayTarget + langs: + - typeScript + type: property syntax: content: 'EditFormClientSideDisplayTarget: string | undefined;' return: - type: string | undefined - - name: NewFormClientSideComponentId - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentId:member' - package: '@microsoft/sp-odata-types!' - fullName: NewFormClientSideComponentId + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentId:member' summary: New Form Customizer component id - remarks: '' - - isPreview: false - isDeprecated: false + name: NewFormClientSideComponentId + fullName: NewFormClientSideComponentId + langs: + - typeScript + type: property syntax: content: 'NewFormClientSideComponentId: string | undefined;' return: - type: string | undefined - - name: NewFormClientSideComponentProperties - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentProperties:member' - package: '@microsoft/sp-odata-types!' - fullName: NewFormClientSideComponentProperties + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentProperties:member' summary: New Form Customizer component properties - remarks: '' - - isPreview: false - isDeprecated: false + name: NewFormClientSideComponentProperties + fullName: NewFormClientSideComponentProperties + langs: + - typeScript + type: property syntax: content: 'NewFormClientSideComponentProperties: string | undefined;' return: - type: string | undefined - - name: NewFormClientSideDisplayTarget - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideDisplayTarget:member' - package: '@microsoft/sp-odata-types!' - fullName: NewFormClientSideDisplayTarget + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideDisplayTarget:member' summary: 'New Form display target (new tab, panel)' - remarks: '' - - isPreview: false - isDeprecated: false + name: NewFormClientSideDisplayTarget + fullName: NewFormClientSideDisplayTarget + langs: + - typeScript + type: property syntax: content: 'NewFormClientSideDisplayTarget: string | undefined;' return: - type: string | undefined + type: + - string | undefined diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index d0289260..ec7b82e5 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -1,186 +1,193 @@ -### YamlMime:TSType -name: IODataList -uid: '@microsoft/sp-odata-types!IODataList:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataList -summary: >- - Represents an OData SP.List object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: BaseTemplate - uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataList:interface' + summary: >- + Represents an OData SP.List object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: IODataList + fullName: IODataList + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + inheritance: + - type: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' package: '@microsoft/sp-odata-types!' - fullName: BaseTemplate + children: + - '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' + - '@microsoft/sp-odata-types!IODataList#Created:member' + - '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' + - '@microsoft/sp-odata-types!IODataList#Description:member' + - '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' + - '@microsoft/sp-odata-types!IODataList#Hidden:member' + - '@microsoft/sp-odata-types!IODataList#Id:member' + - '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' + - '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' + - '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' + - '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' + - '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' + - '@microsoft/sp-odata-types!IODataList#Title:member' + - uid: '@microsoft/sp-odata-types!IODataList#BaseTemplate:member' summary: The list definition type on which the list is based. - remarks: '' - - isPreview: false - isDeprecated: false + name: BaseTemplate + fullName: BaseTemplate + langs: + - typeScript + type: property syntax: content: 'BaseTemplate: number;' return: - type: number - - name: Created - uid: '@microsoft/sp-odata-types!IODataList#Created:member' - package: '@microsoft/sp-odata-types!' - fullName: Created + type: + - number + - uid: '@microsoft/sp-odata-types!IODataList#Created:member' summary: 'Example: `"/Date(1453294804000)/"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: Created + fullName: Created + langs: + - typeScript + type: property syntax: content: 'Created: string;' return: - type: string - - name: CurrentChangeToken - uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' - package: '@microsoft/sp-odata-types!' - fullName: CurrentChangeToken + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#CurrentChangeToken:member' summary: The change token that will be used in logging the next change to the list. - remarks: '' - - isPreview: false - isDeprecated: false + name: CurrentChangeToken + fullName: CurrentChangeToken + langs: + - typeScript + type: property syntax: content: 'CurrentChangeToken: IODataChangeToken;' return: - type: '' - - name: Description - uid: '@microsoft/sp-odata-types!IODataList#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description + type: + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - uid: '@microsoft/sp-odata-types!IODataList#Description:member' summary: A description of the List. - remarks: '' - - isPreview: false - isDeprecated: false + name: Description + fullName: Description + langs: + - typeScript + type: property syntax: content: 'Description: string;' return: - type: string - - name: EntityTypeName - uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' - package: '@microsoft/sp-odata-types!' - fullName: EntityTypeName + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' summary: 'Example: `"MyListTitleList"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: EntityTypeName + fullName: EntityTypeName + langs: + - typeScript + type: property syntax: content: 'EntityTypeName: string;' return: - type: string - - name: Hidden - uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' - package: '@microsoft/sp-odata-types!' - fullName: Hidden + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#Hidden:member' summary: >- A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields. - remarks: '' - - isPreview: false - isDeprecated: false + name: Hidden + fullName: Hidden + langs: + - typeScript + type: property syntax: content: 'Hidden: boolean;' return: - type: boolean - - name: Id - uid: '@microsoft/sp-odata-types!IODataList#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataList#Id:member' summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: Id + fullName: Id + langs: + - typeScript + type: property syntax: content: 'Id: string;' return: - type: string - - name: LastItemDeletedDate - uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' - package: '@microsoft/sp-odata-types!' - fullName: LastItemDeletedDate + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' summary: 'Example: `"/Date(1453294809000)/"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: LastItemDeletedDate + fullName: LastItemDeletedDate + langs: + - typeScript + type: property syntax: content: 'LastItemDeletedDate: string;' return: - type: string - - name: LastItemModifiedDate - uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' - package: '@microsoft/sp-odata-types!' - fullName: LastItemModifiedDate + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' summary: 'Example: `"/Date(1453294809000)/"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: LastItemModifiedDate + fullName: LastItemModifiedDate + langs: + - typeScript + type: property syntax: content: 'LastItemModifiedDate: string;' return: - type: string - - name: ListItemEntityTypeFullName - uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' - package: '@microsoft/sp-odata-types!' - fullName: ListItemEntityTypeFullName + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' summary: 'Example: `"SP.Data.MyListTitleListItem"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: ListItemEntityTypeFullName + fullName: ListItemEntityTypeFullName + langs: + - typeScript + type: property syntax: content: 'ListItemEntityTypeFullName: string;' return: - type: string - - name: ParentWebUrl - uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: ParentWebUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' summary: 'Example: `"/sites/PubSite"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: ParentWebUrl + fullName: ParentWebUrl + langs: + - typeScript + type: property syntax: content: 'ParentWebUrl: string;' return: - type: string - - name: TemplateFeatureId - uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' - package: '@microsoft/sp-odata-types!' - fullName: TemplateFeatureId + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: TemplateFeatureId + fullName: TemplateFeatureId + langs: + - typeScript + type: property syntax: content: 'TemplateFeatureId: string;' return: - type: string - - name: Title - uid: '@microsoft/sp-odata-types!IODataList#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title + type: + - string + - uid: '@microsoft/sp-odata-types!IODataList#Title:member' summary: 'Example: `"Pages"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: Title + fullName: Title + langs: + - typeScript + type: property syntax: content: 'Title: string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + name: IODataFormsClientSideConfiguration + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + name: IODataChangeToken diff --git a/SP-Framework/sp-odata-types/iodatalistitem.yml b/SP-Framework/sp-odata-types/iodatalistitem.yml index e5fdedfa..3579d6a0 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -1,72 +1,70 @@ -### YamlMime:TSType -name: IODataListItem -uid: '@microsoft/sp-odata-types!IODataListItem:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataListItem -summary: >- - Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ContentTypeId - uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataListItem:interface' + summary: >- + Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: IODataListItem + fullName: IODataListItem + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: ContentTypeId + children: + - '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' + - '@microsoft/sp-odata-types!IODataListItem#ID:member' + - '@microsoft/sp-odata-types!IODataListItem#Title:member' + - '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' + - uid: '@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member' summary: 'Example: `{ StringValue: "0x010100C5..." }`' - remarks: '' - - isPreview: false - isDeprecated: false + name: ContentTypeId + fullName: ContentTypeId + langs: + - typeScript + type: property syntax: content: |- ContentTypeId: { StringValue: string; }; return: - type: |- - { - StringValue: string; - } - - name: ID - uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' - package: '@microsoft/sp-odata-types!' + type: + - |- + { + StringValue: string; + } + - uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' + name: ID fullName: ID - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'ID: number;' return: - type: number - - name: Title - uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title + type: + - number + - uid: '@microsoft/sp-odata-types!IODataListItem#Title:member' summary: Title of the List Item - remarks: '' - - isPreview: false - isDeprecated: false + name: Title + fullName: Title + langs: + - typeScript + type: property syntax: content: 'Title: string;' return: - type: string - - name: UniqueId - uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' - package: '@microsoft/sp-odata-types!' - fullName: UniqueId + type: + - string + - uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' summary: 'Example: `"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: UniqueId + fullName: UniqueId + langs: + - typeScript + type: property syntax: content: 'UniqueId: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 22b8eccf..bfe4eb27 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -1,109 +1,117 @@ -### YamlMime:TSType -name: IODataNavigationNode -uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataNavigationNode -summary: >- - Represents an OData SP.NavigationNode object. - [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: Children - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + summary: >- + Represents an OData SP.NavigationNode object. + [https://msdn.microsoft.com/en-us/library/office/jj246311.aspx](https://msdn.microsoft.com/en-us/library/office/jj246311.aspx) + name: IODataNavigationNode + fullName: IODataNavigationNode + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: Children + children: + - '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' + - '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children:member' summary: Gets or sets an array of Navigation Nodes that are children to the current node. - remarks: '' - - isPreview: false - isDeprecated: false + name: Children + fullName: Children + langs: + - typeScript + type: property syntax: content: 'Children?: IODataNavigationNode[];' return: - type: '[]' - - name: Id - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id + type: + - '@microsoft/sp-odata-types!IODataNavigationNode#Children~0:complex' + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' summary: Gets a value that specifies the identifier for the navigation node. - remarks: '' - - isPreview: false - isDeprecated: false + name: Id + fullName: Id + langs: + - typeScript + type: property syntax: content: 'Id?: number;' return: - type: number - - name: IsDocLib - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' - package: '@microsoft/sp-odata-types!' + type: + - number + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' + name: IsDocLib fullName: IsDocLib - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'IsDocLib?: boolean;' return: - type: boolean - - name: IsExternal - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' - package: '@microsoft/sp-odata-types!' - fullName: IsExternal + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsExternal:member' summary: >- Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection. - remarks: '' - - isPreview: false - isDeprecated: false + name: IsExternal + fullName: IsExternal + langs: + - typeScript + type: property syntax: content: 'IsExternal?: boolean;' return: - type: boolean - - name: IsVisible - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' - package: '@microsoft/sp-odata-types!' - fullName: IsVisible + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsVisible:member' summary: Gets or sets a value that specifies if the node navigation link should be visible. - remarks: '' - - isPreview: false - isDeprecated: false + name: IsVisible + fullName: IsVisible + langs: + - typeScript + type: property syntax: content: 'IsVisible?: boolean;' return: - type: boolean - - name: Title - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Title:member' summary: Gets or sets a value that specifies the anchor text for the node navigation link. - remarks: '' - - isPreview: false - isDeprecated: false + name: Title + fullName: Title + langs: + - typeScript + type: property syntax: content: 'Title?: string;' return: - type: string - - name: Url - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' - package: '@microsoft/sp-odata-types!' - fullName: Url + type: + - string + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Url:member' summary: >- Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form. - remarks: '' - - isPreview: false - isDeprecated: false + name: Url + fullName: Url + langs: + - typeScript + type: property syntax: content: 'Url?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#Children~0:complex' + name: 'IODataNavigationNode[]' + fullName: 'IODataNavigationNode[]' + spec.typeScript: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + fullName: IODataNavigationNode + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 16073e68..1a73ca6b 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -1,40 +1,58 @@ -### YamlMime:TSType -name: IODataNavigationNodeCollection -uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataNavigationNodeCollection -summary: >- - Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. - [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: quickLaunch - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection:interface' + summary: >- + Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. + [https://msdn.microsoft.com/en-us/library/office/ee557907.aspx](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) + name: IODataNavigationNodeCollection + fullName: IODataNavigationNodeCollection + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: quickLaunch + children: + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch:member' summary: Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site. - remarks: '' - - isPreview: false - isDeprecated: false + name: quickLaunch + fullName: quickLaunch + langs: + - typeScript + type: property syntax: content: 'quickLaunch: IODataNavigationNode[];' return: - type: '[]' - - name: topNav - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' - package: '@microsoft/sp-odata-types!' - fullName: topNav + type: + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch~0:complex' + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' summary: Gets an SPNavigationNode object that contains the nodes in the top link bar for the website. - remarks: '' - - isPreview: false - isDeprecated: false + name: topNav + fullName: topNav + langs: + - typeScript + type: property syntax: content: 'topNav: IODataNavigationNode[];' return: - type: '[]' + type: + - '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav~0:complex' +references: + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#quickLaunch~0:complex' + name: 'IODataNavigationNode[]' + fullName: 'IODataNavigationNode[]' + spec.typeScript: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + fullName: IODataNavigationNode + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav~0:complex' + name: 'IODataNavigationNode[]' + fullName: 'IODataNavigationNode[]' + spec.typeScript: + - uid: '@microsoft/sp-odata-types!IODataNavigationNode:interface' + name: IODataNavigationNode + fullName: IODataNavigationNode + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index df984001..b906f692 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -1,73 +1,71 @@ -### YamlMime:TSType -name: IODataUser -uid: '@microsoft/sp-odata-types!IODataUser:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataUser -summary: >- - Represents an OData SP.User object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: Email - uid: '@microsoft/sp-odata-types!IODataUser#Email:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataUser:interface' + summary: >- + Represents an OData SP.User object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: IODataUser + fullName: IODataUser + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: Email + children: + - '@microsoft/sp-odata-types!IODataUser#Email:member' + - '@microsoft/sp-odata-types!IODataUser#Id:member' + - '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' + - '@microsoft/sp-odata-types!IODataUser#LoginName:member' + - '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' + - '@microsoft/sp-odata-types!IODataUser#Title:member' + - '@microsoft/sp-odata-types!IODataUser#UserId:member' + - uid: '@microsoft/sp-odata-types!IODataUser#Email:member' summary: 'Example: `"someone@example.com"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: Email + fullName: Email + langs: + - typeScript + type: property syntax: content: 'Email: string;' return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataUser#Id:member' - package: '@microsoft/sp-odata-types!' + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUser#Id:member' + name: Id fullName: Id - summary: '' - remarks: '' - - isPreview: false - isDeprecated: false + langs: + - typeScript + type: property syntax: content: 'Id: number;' return: - type: number - - name: IsSiteAdmin - uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' - package: '@microsoft/sp-odata-types!' - fullName: IsSiteAdmin + type: + - number + - uid: '@microsoft/sp-odata-types!IODataUser#IsSiteAdmin:member' summary: Boolean value that specifies whether the user is a site collection administrator. - remarks: '' - - isPreview: false - isDeprecated: false + name: IsSiteAdmin + fullName: IsSiteAdmin + langs: + - typeScript + type: property syntax: content: 'IsSiteAdmin: boolean;' return: - type: boolean - - name: LoginName - uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' - package: '@microsoft/sp-odata-types!' - fullName: LoginName + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' summary: 'Example: `"i:0#.w|domain\user"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: LoginName + fullName: LoginName + langs: + - typeScript + type: property syntax: content: 'LoginName: string;' return: - type: string - - name: PrincipalType - uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' - package: '@microsoft/sp-odata-types!' - fullName: PrincipalType + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUser#PrincipalType:member' summary: This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. remarks: |- Values: @@ -83,38 +81,42 @@ properties: SharePointGroup: 8 All: 15 - - isPreview: false - isDeprecated: false + name: PrincipalType + fullName: PrincipalType + langs: + - typeScript + type: property syntax: content: 'PrincipalType: number;' return: - type: number - - name: Title - uid: '@microsoft/sp-odata-types!IODataUser#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title + type: + - number + - uid: '@microsoft/sp-odata-types!IODataUser#Title:member' summary: 'Example: `"DOMAIN\user"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: Title + fullName: Title + langs: + - typeScript + type: property syntax: content: 'Title: string;' return: - type: string - - name: UserId - uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' - package: '@microsoft/sp-odata-types!' - fullName: UserId + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUser#UserId:member' summary: >- Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier. - remarks: '' - - isPreview: false - isDeprecated: false + name: UserId + fullName: UserId + langs: + - typeScript + type: property syntax: content: 'UserId: IODataUserId;' return: - type: '' + type: + - '@microsoft/sp-odata-types!IODataUserId:interface' +references: + - uid: '@microsoft/sp-odata-types!IODataUserId:interface' + name: IODataUserId diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index b6830dd1..74421167 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -1,35 +1,49 @@ -### YamlMime:TSType -name: IODataUserCustomAction -uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataUserCustomAction -summary: >- - Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation - here: - [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ClientSideComponentId - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction:interface' + summary: >- + Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation + here: + [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx\#bk\_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) + name: IODataUserCustomAction + fullName: IODataUserCustomAction + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: ClientSideComponentId + children: + - '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' + - '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentId:member' summary: The unique identifier of the client-side component defined with SharePoint Framework remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' - - isPreview: false - isDeprecated: false + name: ClientSideComponentId + fullName: ClientSideComponentId + langs: + - typeScript + type: property syntax: content: 'ClientSideComponentId: string;' return: - type: string - - name: ClientSideComponentProperties - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' - package: '@microsoft/sp-odata-types!' - fullName: ClientSideComponentProperties + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ClientSideComponentProperties:member' summary: Custom initialization properties for the client-side component. remarks: >- This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string @@ -38,228 +52,221 @@ properties: Example: `"{ \"maxItemsToShow\": 123 }"` - - isPreview: false - isDeprecated: false + name: ClientSideComponentProperties + fullName: ClientSideComponentProperties + langs: + - typeScript + type: property syntax: content: 'ClientSideComponentProperties: string;' return: - type: string - - name: CommandUIExtension - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' - package: '@microsoft/sp-odata-types!' - fullName: CommandUIExtension + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#CommandUIExtension:member' summary: >- Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: CommandUIExtension + fullName: CommandUIExtension + langs: + - typeScript + type: property syntax: content: 'CommandUIExtension: string;' return: - type: string - - name: Description - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Description:member' summary: Gets or sets the description of the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: Description + fullName: Description + langs: + - typeScript + type: property syntax: content: 'Description: string;' return: - type: string - - name: Group - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' - package: '@microsoft/sp-odata-types!' - fullName: Group + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Group:member' summary: >- Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. - remarks: '' - - isPreview: false - isDeprecated: false + name: Group + fullName: Group + langs: + - typeScript + type: property syntax: content: 'Group: string;' return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Id:member' summary: >- Gets a value that specifies the identifier (GUID) of the custom action. Example: `"48309f28-53aa-43ed-b113-625120e5af6f"` - remarks: '' - - isPreview: false - isDeprecated: false + name: Id + fullName: Id + langs: + - typeScript + type: property syntax: content: 'Id: string;' return: - type: string - - name: ImageUrl - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: ImageUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ImageUrl:member' summary: Gets or sets the URL of the image associated with the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: ImageUrl + fullName: ImageUrl + langs: + - typeScript + type: property syntax: content: 'ImageUrl: string;' return: - type: string - - name: Location - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' - package: '@microsoft/sp-odata-types!' - fullName: Location + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Location:member' summary: Gets or sets the location of the custom action. remarks: 'Example: `"ClientSide.Application"`' - - isPreview: false - isDeprecated: false + name: Location + fullName: Location + langs: + - typeScript + type: property syntax: content: 'Location: string;' return: - type: string - - name: RegistrationId - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' - package: '@microsoft/sp-odata-types!' - fullName: RegistrationId + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationId:member' summary: Gets or sets the value that specifies the identifier of the object associated with the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: RegistrationId + fullName: RegistrationId + langs: + - typeScript + type: property syntax: content: 'RegistrationId: string;' return: - type: string - - name: RegistrationType - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' - package: '@microsoft/sp-odata-types!' - fullName: RegistrationType + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#RegistrationType:member' summary: Gets or sets the value that specifies the type of object associated with the custom action. remarks: >- Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4. - - isPreview: false - isDeprecated: false + name: RegistrationType + fullName: RegistrationType + langs: + - typeScript + type: property syntax: content: 'RegistrationType: number;' return: - type: number - - name: Rights - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' - package: '@microsoft/sp-odata-types!' - fullName: Rights + type: + - number + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Rights:member' summary: Gets or sets the value that specifies the permissions needed for the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: Rights + fullName: Rights + langs: + - typeScript + type: property syntax: content: 'Rights: IODataBasePermission;' return: - type: '' - - name: Scope - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' - package: '@microsoft/sp-odata-types!' - fullName: Scope + type: + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' summary: Gets a value that specifies the scope of the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: Scope + fullName: Scope + langs: + - typeScript + type: property syntax: content: 'Scope: number;' return: - type: number - - name: ScriptBlock - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' - package: '@microsoft/sp-odata-types!' - fullName: ScriptBlock + type: + - number + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptBlock:member' summary: Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. - remarks: '' - - isPreview: false - isDeprecated: false + name: ScriptBlock + fullName: ScriptBlock + langs: + - typeScript + type: property syntax: content: 'ScriptBlock: string;' return: - type: string - - name: ScriptSrc - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' - package: '@microsoft/sp-odata-types!' - fullName: ScriptSrc + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#ScriptSrc:member' summary: Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. - remarks: '' - - isPreview: false - isDeprecated: false + name: ScriptSrc + fullName: ScriptSrc + langs: + - typeScript + type: property syntax: content: 'ScriptSrc: string;' return: - type: string - - name: Sequence - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' - package: '@microsoft/sp-odata-types!' - fullName: Sequence + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Sequence:member' summary: >- Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. - remarks: '' - - isPreview: false - isDeprecated: false + name: Sequence + fullName: Sequence + langs: + - typeScript + type: property syntax: content: 'Sequence: number;' return: - type: number - - name: Title - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title + type: + - number + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Title:member' summary: Gets or sets the display title of the custom action. - remarks: '' - - isPreview: false - isDeprecated: false + name: Title + fullName: Title + langs: + - typeScript + type: property syntax: content: 'Title: string;' return: - type: string - - name: Url - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' - package: '@microsoft/sp-odata-types!' - fullName: Url + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' - remarks: '' - - isPreview: false - isDeprecated: false + name: Url + fullName: Url + langs: + - typeScript + type: property syntax: content: 'Url: string;' return: - type: string - - name: VersionOfUserCustomAction - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' - package: '@microsoft/sp-odata-types!' - fullName: VersionOfUserCustomAction + type: + - string + - uid: '@microsoft/sp-odata-types!IODataUserCustomAction#VersionOfUserCustomAction:member' summary: Gets a value that specifies an implementation specific version identifier. remarks: 'Example: `"16.0.1.0"`' - - isPreview: false - isDeprecated: false + name: VersionOfUserCustomAction + fullName: VersionOfUserCustomAction + langs: + - typeScript + type: property syntax: content: 'VersionOfUserCustomAction: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + name: IODataBasePermission diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 2fb1f356..e6352b65 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -1,278 +1,280 @@ -### YamlMime:TSType -name: IODataWeb -uid: '@microsoft/sp-odata-types!IODataWeb:interface' -package: '@microsoft/sp-odata-types!' -fullName: IODataWeb -summary: >- - Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: - [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: Created - uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-odata-types!IODataWeb:interface' + summary: >- + Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: + [https://msdn.microsoft.com/en-us/library/office/jj860569.aspx](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) + name: IODataWeb + fullName: IODataWeb + langs: + - typeScript + type: interface package: '@microsoft/sp-odata-types!' - fullName: Created + children: + - '@microsoft/sp-odata-types!IODataWeb#Created:member' + - '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' + - '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#Description:member' + - '@microsoft/sp-odata-types!IODataWeb#Id:member' + - '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' + - '@microsoft/sp-odata-types!IODataWeb#Language:member' + - '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' + - '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' + - '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' + - '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' + - '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' + - '@microsoft/sp-odata-types!IODataWeb#Title:member' + - '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' + - '@microsoft/sp-odata-types!IODataWeb#Url:member' + - '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' + - uid: '@microsoft/sp-odata-types!IODataWeb#Created:member' summary: |- Gets a value that specifies when the site was created. Example: `"/Date(2016,0,20,12,58,7,0)/"` - remarks: '' - - isPreview: false - isDeprecated: false + name: Created + fullName: Created + langs: + - typeScript + type: property syntax: content: 'Created?: string;' return: - type: string - - name: CurrentChangeToken - uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' - package: '@microsoft/sp-odata-types!' - fullName: CurrentChangeToken + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#CurrentChangeToken:member' summary: Represents the unique sequential location of a change within the change log. - remarks: '' - - isPreview: false - isDeprecated: false + name: CurrentChangeToken + fullName: CurrentChangeToken + langs: + - typeScript + type: property syntax: content: 'CurrentChangeToken?: IODataChangeToken;' return: - type: '' - - name: CustomMasterUrl - uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: CustomMasterUrl + type: + - '@microsoft/sp-odata-types!IODataChangeToken:interface' + - uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' summary: |- Gets or sets the URL for a custom master page file to apply to the website. Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` - remarks: '' - - isPreview: false - isDeprecated: false + name: CustomMasterUrl + fullName: CustomMasterUrl + langs: + - typeScript + type: property syntax: content: 'CustomMasterUrl?: string;' return: - type: string - - name: Description - uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' - package: '@microsoft/sp-odata-types!' - fullName: Description + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#Description:member' summary: Gets or sets the description for the site. - remarks: '' - - isPreview: false - isDeprecated: false + name: Description + fullName: Description + langs: + - typeScript + type: property syntax: content: 'Description?: string;' return: - type: string - - name: Id - uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' - package: '@microsoft/sp-odata-types!' - fullName: Id + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#Id:member' summary: |- Gets a value that specifies the site identifier for the site. Example: `"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/"` - remarks: '' - - isPreview: false - isDeprecated: false + name: Id + fullName: Id + langs: + - typeScript + type: property syntax: content: 'Id?: string;' return: - type: string - - name: IsMultilingual - uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' - package: '@microsoft/sp-odata-types!' - fullName: IsMultilingual + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member' summary: Value that represents if the web was - remarks: '' - - isPreview: false - isDeprecated: false + name: IsMultilingual + fullName: IsMultilingual + langs: + - typeScript + type: property syntax: content: 'IsMultilingual?: boolean;' return: - type: boolean - - name: Language - uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' - package: '@microsoft/sp-odata-types!' - fullName: Language + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataWeb#Language:member' summary: |- Gets a value that specifies the LCID for the language that is used on the site. Example: `1033` - remarks: '' - - isPreview: false - isDeprecated: false + name: Language + fullName: Language + langs: + - typeScript + type: property syntax: content: 'Language?: number;' return: - type: number - - name: LastItemModifiedDate - uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' - package: '@microsoft/sp-odata-types!' - fullName: LastItemModifiedDate + type: + - number + - uid: '@microsoft/sp-odata-types!IODataWeb#LastItemModifiedDate:member' summary: |- Gets a value that specifies when an item was last modified in the site. Example: `"/Date(1453618828000)/"` - remarks: '' - - isPreview: false - isDeprecated: false + name: LastItemModifiedDate + fullName: LastItemModifiedDate + langs: + - typeScript + type: property syntax: content: 'LastItemModifiedDate?: string;' return: - type: string - - name: MasterUrl - uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: MasterUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#MasterUrl:member' summary: |- Gets or sets the URL of the master page that is used for the website. Example: `"/sites/PubSite/_catalogs/masterpage/seattle.master"` - remarks: '' - - isPreview: false - isDeprecated: false + name: MasterUrl + fullName: MasterUrl + langs: + - typeScript + type: property syntax: content: 'MasterUrl?: string;' return: - type: string - - name: NoCrawl - uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' - package: '@microsoft/sp-odata-types!' - fullName: NoCrawl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#NoCrawl:member' summary: Determines if a particular web will be crawled by search or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: NoCrawl + fullName: NoCrawl + langs: + - typeScript + type: property syntax: content: 'NoCrawl?: boolean;' return: - type: boolean - - name: QuickLaunchEnabled - uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' - package: '@microsoft/sp-odata-types!' - fullName: QuickLaunchEnabled + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataWeb#QuickLaunchEnabled:member' summary: Gets or sets a value that specifies whether the Quick Launch area is enabled on the site. - remarks: '' - - isPreview: false - isDeprecated: false + name: QuickLaunchEnabled + fullName: QuickLaunchEnabled + langs: + - typeScript + type: property syntax: content: 'QuickLaunchEnabled?: boolean;' return: - type: boolean - - name: RecycleBinEnabled - uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' - package: '@microsoft/sp-odata-types!' - fullName: RecycleBinEnabled + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataWeb#RecycleBinEnabled:member' summary: Gets or sets a value that determines whether the recycle bin is enabled for the website. - remarks: '' - - isPreview: false - isDeprecated: false + name: RecycleBinEnabled + fullName: RecycleBinEnabled + langs: + - typeScript + type: property syntax: content: 'RecycleBinEnabled?: boolean;' return: - type: boolean - - name: ServerRelativeUrl - uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: ServerRelativeUrl + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataWeb#ServerRelativeUrl:member' summary: |- Gets or sets the server-relative URL for the Web site. Example: `"/sites/PubSite"` - remarks: '' - - isPreview: false - isDeprecated: false + name: ServerRelativeUrl + fullName: ServerRelativeUrl + langs: + - typeScript + type: property syntax: content: 'ServerRelativeUrl?: string;' return: - type: string - - name: SiteLogoUrl - uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' - package: '@microsoft/sp-odata-types!' - fullName: SiteLogoUrl + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member' summary: Gets the url for the logo of this particular site. - remarks: '' - - isPreview: false - isDeprecated: false + name: SiteLogoUrl + fullName: SiteLogoUrl + langs: + - typeScript + type: property syntax: content: 'SiteLogoUrl?: string;' return: - type: string - - name: Title - uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' - package: '@microsoft/sp-odata-types!' - fullName: Title + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#Title:member' summary: The title of the web. - remarks: '' - - isPreview: false - isDeprecated: false + name: Title + fullName: Title + langs: + - typeScript + type: property syntax: content: 'Title?: string;' return: - type: string - - name: UIVersion - uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' - package: '@microsoft/sp-odata-types!' - fullName: UIVersion + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#UIVersion:member' summary: |- Gets or sets the user interface (UI) version of the Web site. Example: `15` - remarks: '' - - isPreview: false - isDeprecated: false + name: UIVersion + fullName: UIVersion + langs: + - typeScript + type: property syntax: content: 'UIVersion?: number;' return: - type: number - - name: Url - uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' - package: '@microsoft/sp-odata-types!' - fullName: Url + type: + - number + - uid: '@microsoft/sp-odata-types!IODataWeb#Url:member' summary: |- Gets the absolute URL for the website. Example: `"http://example.com/sites/PubSite"` - remarks: '' - - isPreview: false - isDeprecated: false + name: Url + fullName: Url + langs: + - typeScript + type: property syntax: content: 'Url?: string;' return: - type: string - - name: WebTemplate - uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' - package: '@microsoft/sp-odata-types!' - fullName: WebTemplate + type: + - string + - uid: '@microsoft/sp-odata-types!IODataWeb#WebTemplate:member' summary: |- Gets the name of the site definition or site template that was used to create the site. Example: `"BLANKINTERNET"` - remarks: '' - - isPreview: false - isDeprecated: false + name: WebTemplate + fullName: WebTemplate + langs: + - typeScript + type: property syntax: content: 'WebTemplate?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-odata-types!IODataChangeToken:interface' + name: IODataChangeToken diff --git a/SP-Framework/sp-page-context.yml b/SP-Framework/sp-page-context.yml index a3296b25..dc8a9fc8 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -1,21 +1,85 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-page-context!' -name: '@microsoft/sp-page-context' -type: package -summary: Page context services for the SharePoint Framework -classes: - - '@microsoft/sp-page-context!CultureInfo:class' - - '@microsoft/sp-page-context!PageContext:class' - - '@microsoft/sp-page-context!SPField:class' - - '@microsoft/sp-page-context!SPList:class' - - '@microsoft/sp-page-context!SPListItem:class' - - '@microsoft/sp-page-context!SPPermission:class' - - '@microsoft/sp-page-context!SPSite:class' - - '@microsoft/sp-page-context!SPTimeZone:class' - - '@microsoft/sp-page-context!SPUser:class' - - '@microsoft/sp-page-context!SPWeb:class' -interfaces: - - '@microsoft/sp-page-context!ISPSystemTime:interface' - - '@microsoft/sp-page-context!ISPTimeZoneData:interface' -typeAliases: - - '@microsoft/sp-page-context!SPDayOfWeek:type' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!' + summary: Page context services for the SharePoint Framework + remarks: >- + The page context allows an application and its web parts to share common data about the current page, such as its + contents, URL, list, user, permissions, navigation menu, etc. + name: '@microsoft/sp-page-context' + fullName: '@microsoft/sp-page-context' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-page-context!CultureInfo:class' + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - '@microsoft/sp-page-context!ISPTimeZoneData:interface' + - '@microsoft/sp-page-context!PageContext:class' + - '@microsoft/sp-page-context!SPDayOfWeek:type' + - '@microsoft/sp-page-context!SPDayOfWeek:var' + - '@microsoft/sp-page-context!SPField:class' + - '@microsoft/sp-page-context!SPList:class' + - '@microsoft/sp-page-context!SPListItem:class' + - '@microsoft/sp-page-context!SPPermission:class' + - '@microsoft/sp-page-context!SPSite:class' + - '@microsoft/sp-page-context!SPTimeZone:class' + - '@microsoft/sp-page-context!SPUser:class' + - '@microsoft/sp-page-context!SPWeb:class' + - uid: '@microsoft/sp-page-context!SPDayOfWeek:var' + summary: The object members represent the seven days of a week. + isPreview: true + name: SPDayOfWeek + fullName: SPDayOfWeek + langs: + - typeScript + type: variable + syntax: + content: |- + SPDayOfWeek: { + readonly Sunday: 0; + readonly Monday: 1; + readonly Tuesday: 2; + readonly Wednesday: 3; + readonly Thursday: 4; + readonly Friday: 5; + readonly Saturday: 6; + } + return: + type: + - |- + { + readonly Sunday: 0; + readonly Monday: 1; + readonly Tuesday: 2; + readonly Wednesday: 3; + readonly Thursday: 4; + readonly Friday: 5; + readonly Saturday: 6; + } +references: + - uid: '@microsoft/sp-page-context!CultureInfo:class' + name: CultureInfo + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + name: ISPSystemTime + - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' + name: ISPTimeZoneData + - uid: '@microsoft/sp-page-context!PageContext:class' + name: PageContext + - uid: '@microsoft/sp-page-context!SPDayOfWeek:type' + name: SPDayOfWeek + - uid: '@microsoft/sp-page-context!SPField:class' + name: SPField + - uid: '@microsoft/sp-page-context!SPList:class' + name: SPList + - uid: '@microsoft/sp-page-context!SPListItem:class' + name: SPListItem + - uid: '@microsoft/sp-page-context!SPPermission:class' + name: SPPermission + - uid: '@microsoft/sp-page-context!SPSite:class' + name: SPSite + - uid: '@microsoft/sp-page-context!SPTimeZone:class' + name: SPTimeZone + - uid: '@microsoft/sp-page-context!SPUser:class' + name: SPUser + - uid: '@microsoft/sp-page-context!SPWeb:class' + name: SPWeb diff --git a/SP-Framework/sp-page-context/cultureinfo.yml b/SP-Framework/sp-page-context/cultureinfo.yml index 6c4e493f..76ac90ca 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -1,23 +1,23 @@ -### YamlMime:TSType -name: CultureInfo -uid: '@microsoft/sp-page-context!CultureInfo:class' -package: '@microsoft/sp-page-context!' -fullName: CultureInfo -summary: >- - This class is primarily used with the `PageContext` class. It provides culture info for the current user of the - application. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `CultureInfo` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: currentCultureName - uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!CultureInfo:class' + summary: >- + This class is primarily used with the `PageContext` class. It provides culture info for the current user of the + application. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `CultureInfo` class. + name: CultureInfo + fullName: CultureInfo + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: currentCultureName + children: + - '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' + - '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' + - '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' + - uid: '@microsoft/sp-page-context!CultureInfo#currentCultureName:member' summary: >- This string determines the language default format for dates, times, numbers, currency values, the sorting order of text, casing conventions, and string comparisons. @@ -27,17 +27,17 @@ properties: Example: If the currentCultureName is `"en-AU"` then the application could use this information to display the date as 1/8 instead of 8/1. - - isPreview: false - isDeprecated: false + name: currentCultureName + fullName: currentCultureName + langs: + - typeScript + type: property syntax: content: 'readonly currentCultureName: string;' return: - type: string - - name: currentUICultureName - uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' - package: '@microsoft/sp-page-context!' - fullName: currentUICultureName + type: + - string + - uid: '@microsoft/sp-page-context!CultureInfo#currentUICultureName:member' summary: This string determines the default user interface language. This used for localization and translation of text. remarks: >- This property may have an empty string, but will never be undefined. @@ -45,23 +45,25 @@ properties: Example: If the currentUICultureName is `"es-MX"`, then the application could use this information to translate the word "hello" to "hola". - - isPreview: false - isDeprecated: false + name: currentUICultureName + fullName: currentUICultureName + langs: + - typeScript + type: property syntax: content: 'readonly currentUICultureName: string;' return: - type: string - - name: isRightToLeft - uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' - package: '@microsoft/sp-page-context!' - fullName: isRightToLeft + type: + - string + - uid: '@microsoft/sp-page-context!CultureInfo#isRightToLeft:member' summary: This boolean represents the dominant direction of written text for the default user interface language. - remarks: '' - - isPreview: false - isDeprecated: false + name: isRightToLeft + fullName: isRightToLeft + langs: + - typeScript + type: property syntax: content: 'readonly isRightToLeft: boolean;' return: - type: boolean + type: + - boolean diff --git a/SP-Framework/sp-page-context/ispsystemtime.yml b/SP-Framework/sp-page-context/ispsystemtime.yml index f32298e2..183402af 100644 --- a/SP-Framework/sp-page-context/ispsystemtime.yml +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -1,116 +1,116 @@ -### YamlMime:TSType -name: ISPSystemTime -uid: '@microsoft/sp-page-context!ISPSystemTime:interface' -package: '@microsoft/sp-page-context!' -fullName: ISPSystemTime -summary: Interface that represents a `SPSystemTime` structure. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: Day - uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + summary: Interface that represents a `SPSystemTime` structure. + isPreview: true + name: ISPSystemTime + fullName: ISPSystemTime + langs: + - typeScript + type: interface package: '@microsoft/sp-page-context!' - fullName: Day - summary: '' - remarks: '' - + children: + - '@microsoft/sp-page-context!ISPSystemTime#Day:member' + - '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' + - '@microsoft/sp-page-context!ISPSystemTime#Hour:member' + - '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' + - '@microsoft/sp-page-context!ISPSystemTime#Minute:member' + - '@microsoft/sp-page-context!ISPSystemTime#Month:member' + - '@microsoft/sp-page-context!ISPSystemTime#Second:member' + - '@microsoft/sp-page-context!ISPSystemTime#Year:member' + - uid: '@microsoft/sp-page-context!ISPSystemTime#Day:member' isPreview: true - isDeprecated: false + name: Day + fullName: Day + langs: + - typeScript + type: property syntax: content: 'Day: number;' return: - type: number - - name: DayOfWeek - uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' - package: '@microsoft/sp-page-context!' - fullName: DayOfWeek - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' isPreview: true - isDeprecated: false + name: DayOfWeek + fullName: DayOfWeek + langs: + - typeScript + type: property syntax: content: 'DayOfWeek: number;' return: - type: number - - name: Hour - uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' - package: '@microsoft/sp-page-context!' - fullName: Hour - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' isPreview: true - isDeprecated: false + name: Hour + fullName: Hour + langs: + - typeScript + type: property syntax: content: 'Hour: number;' return: - type: number - - name: Milliseconds - uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' - package: '@microsoft/sp-page-context!' - fullName: Milliseconds - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' isPreview: true - isDeprecated: false + name: Milliseconds + fullName: Milliseconds + langs: + - typeScript + type: property syntax: content: 'Milliseconds: number;' return: - type: number - - name: Minute - uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' - package: '@microsoft/sp-page-context!' - fullName: Minute - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' isPreview: true - isDeprecated: false + name: Minute + fullName: Minute + langs: + - typeScript + type: property syntax: content: 'Minute: number;' return: - type: number - - name: Month - uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' - package: '@microsoft/sp-page-context!' - fullName: Month - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' isPreview: true - isDeprecated: false + name: Month + fullName: Month + langs: + - typeScript + type: property syntax: content: 'Month: number;' return: - type: number - - name: Second - uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' - package: '@microsoft/sp-page-context!' - fullName: Second - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' isPreview: true - isDeprecated: false + name: Second + fullName: Second + langs: + - typeScript + type: property syntax: content: 'Second: number;' return: - type: number - - name: Year - uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' - package: '@microsoft/sp-page-context!' - fullName: Year - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' isPreview: true - isDeprecated: false + name: Year + fullName: Year + langs: + - typeScript + type: property syntax: content: 'Year: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index 16f17551..d59a6b37 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -1,103 +1,106 @@ -### YamlMime:TSType -name: ISPTimeZoneData -uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' -package: '@microsoft/sp-page-context!' -fullName: ISPTimeZoneData -summary: Interface that represents the data necessary to build an `TimeZone` object. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: daylightDate - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!ISPTimeZoneData:interface' + summary: Interface that represents the data necessary to build an `TimeZone` object. + isPreview: true + name: ISPTimeZoneData + fullName: ISPTimeZoneData + langs: + - typeScript + type: interface package: '@microsoft/sp-page-context!' - fullName: daylightDate - summary: '' - remarks: '' - + children: + - '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#description:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#id:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' + - '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member' isPreview: true - isDeprecated: false + name: daylightDate + fullName: daylightDate + langs: + - typeScript + type: property syntax: content: 'daylightDate: ISPSystemTime;' return: - type: '' - - name: daylightOffset - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' - package: '@microsoft/sp-page-context!' - fullName: daylightOffset - summary: '' - remarks: '' - + type: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' isPreview: true - isDeprecated: false + name: daylightOffset + fullName: daylightOffset + langs: + - typeScript + type: property syntax: content: 'daylightOffset: number;' return: - type: number - - name: description - uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' - package: '@microsoft/sp-page-context!' - fullName: description - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' isPreview: true - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description: string;' return: - type: string - - name: id - uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' - package: '@microsoft/sp-page-context!' - fullName: id - summary: '' - remarks: '' - + type: + - string + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' isPreview: true - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: number;' return: - type: number - - name: offset - uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' - package: '@microsoft/sp-page-context!' - fullName: offset - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' isPreview: true - isDeprecated: false + name: offset + fullName: offset + langs: + - typeScript + type: property syntax: content: 'offset: number;' return: - type: number - - name: standardDate - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' - package: '@microsoft/sp-page-context!' - fullName: standardDate - summary: '' - remarks: '' - + type: + - number + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' isPreview: true - isDeprecated: false + name: standardDate + fullName: standardDate + langs: + - typeScript + type: property syntax: content: 'standardDate: ISPSystemTime;' return: - type: '' - - name: standardOffset - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' - package: '@microsoft/sp-page-context!' - fullName: standardOffset - summary: '' - remarks: '' - + type: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' isPreview: true - isDeprecated: false + name: standardOffset + fullName: standardOffset + langs: + - typeScript + type: property syntax: content: 'standardOffset: number;' return: - type: number + type: + - number +references: + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + name: ISPSystemTime diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 6c91922f..dc00db07 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -1,81 +1,86 @@ -### YamlMime:TSType -name: PageContext -uid: '@microsoft/sp-page-context!PageContext:class' -package: '@microsoft/sp-page-context!' -fullName: PageContext -summary: The SharePoint page context object. -remarks: >- - The page context provides standard definitions for common SharePoint objects that need to be shared between the - client-side application, web parts, and other components. Typically the data is fetched via REST queries when - navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application cache. - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(serviceScope) - uid: '@microsoft/sp-page-context!PageContext:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!PageContext:class' + summary: The SharePoint page context object. + remarks: >- + The page context provides standard definitions for common SharePoint objects that need to be shared between the + client-side application, web parts, and other components. Typically the data is fetched via REST queries when + navigating to a new page, but it can also be preloaded by the web server, or filled from a custom application + cache. + name: PageContext + fullName: PageContext + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: (constructor)(serviceScope) + children: + - '@microsoft/sp-page-context!PageContext:constructor(1)' + - '@microsoft/sp-page-context!PageContext#aadInfo:member' + - '@microsoft/sp-page-context!PageContext#cultureInfo:member' + - '@microsoft/sp-page-context!PageContext#isInitialized:member' + - '@microsoft/sp-page-context!PageContext#legacyPageContext:member' + - '@microsoft/sp-page-context!PageContext#list:member' + - '@microsoft/sp-page-context!PageContext#listItem:member' + - '@microsoft/sp-page-context!PageContext.serviceKey:member' + - '@microsoft/sp-page-context!PageContext#site:member' + - '@microsoft/sp-page-context!PageContext#user:member' + - '@microsoft/sp-page-context!PageContext#web:member' + - uid: '@microsoft/sp-page-context!PageContext:constructor(1)' summary: Constructs a new instance of the `PageContext` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) + langs: + - typeScript + type: constructor syntax: content: 'constructor(serviceScope: ServiceScope);' parameters: - id: serviceScope description: '' - type: '' -properties: - - name: aadInfo - uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' - package: '@microsoft/sp-page-context!' - fullName: aadInfo + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' summary: >- Contextual information for communicating with Azure Active Directory. If the current page doesn't have an associated Azure Active Directory tenant, this property will be undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: aadInfo + fullName: aadInfo + langs: + - typeScript + type: property syntax: content: 'get aadInfo(): AzureActiveDirectoryInfo | undefined;' return: - type: ' | undefined' - - name: cultureInfo - uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' - package: '@microsoft/sp-page-context!' - fullName: cultureInfo + type: + - '@microsoft/sp-page-context!PageContext#aadInfo~0:complex' + - uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' summary: >- It provides culture info for the current user of the application. This class is primarily used with the `PageContext` class. - remarks: '' - - isPreview: false - isDeprecated: false + name: cultureInfo + fullName: cultureInfo + langs: + - typeScript + type: property syntax: content: 'get cultureInfo(): CultureInfo;' return: - type: '' - - name: isInitialized - uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' - package: '@microsoft/sp-page-context!' - fullName: isInitialized + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' summary: Returns whether the `PageContext` has been initialized. - remarks: '' - - isPreview: false - isDeprecated: false + name: isInitialized + fullName: isInitialized + langs: + - typeScript + type: property syntax: content: 'get isInitialized(): boolean;' return: - type: boolean - - name: legacyPageContext - uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' - package: '@microsoft/sp-page-context!' - fullName: legacyPageContext + type: + - boolean + - uid: '@microsoft/sp-page-context!PageContext#legacyPageContext:member' summary: An object providing classic SharePoint properties that may be required by certain legacy scripts. remarks: >- This property is provided to facilitate migration of legacy code. It returns a JavaScript object whose contents @@ -88,96 +93,137 @@ properties: NOTE: If certain functionality is exposed in the `legacyPageContext` but does not seem to have a proper TypeScript API, please file an issue on GitHub. The intention is that no modern application should need to rely on the `legacyPageContext` object. - - isPreview: false - isDeprecated: false + name: legacyPageContext + fullName: legacyPageContext + langs: + - typeScript + type: property syntax: content: 'get legacyPageContext(): any;' return: - type: any - - name: list - uid: '@microsoft/sp-page-context!PageContext#list:member' - package: '@microsoft/sp-page-context!' - fullName: list + type: + - any + - uid: '@microsoft/sp-page-context!PageContext#list:member' summary: >- Contextual information for the SharePoint list that is hosting the page. If there is no list associated to the current page, this property will be undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: list + fullName: list + langs: + - typeScript + type: property syntax: content: 'get list(): SPList | undefined;' return: - type: ' | undefined' - - name: listItem - uid: '@microsoft/sp-page-context!PageContext#listItem:member' - package: '@microsoft/sp-page-context!' - fullName: listItem + type: + - '@microsoft/sp-page-context!PageContext#list~0:complex' + - uid: '@microsoft/sp-page-context!PageContext#listItem:member' summary: >- Contextual information for the SharePoint list item that is hosting the page. If there is no list item associated to the current page, this property will be undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: listItem + fullName: listItem + langs: + - typeScript + type: property syntax: content: 'get listItem(): SPListItem | undefined;' return: - type: ' | undefined' - - name: serviceKey - uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' - package: '@microsoft/sp-page-context!' - fullName: serviceKey + type: + - '@microsoft/sp-page-context!PageContext#listItem~0:complex' + - uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' summary: The service key for PageContext. - remarks: '' - - isPreview: false - isDeprecated: false + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property syntax: content: 'static readonly serviceKey: ServiceKey;' return: - type: >- - <> - - name: site - uid: '@microsoft/sp-page-context!PageContext#site:member' - package: '@microsoft/sp-page-context!' - fullName: site + type: + - '@microsoft/sp-page-context!PageContext.serviceKey~0:complex' + - uid: '@microsoft/sp-page-context!PageContext#site:member' summary: Contextual information for the SharePoint site collection ("SPSite") that is hosting the page. - remarks: '' - - isPreview: false - isDeprecated: false + name: site + fullName: site + langs: + - typeScript + type: property syntax: content: 'get site(): SPSite;' return: - type: '' - - name: user - uid: '@microsoft/sp-page-context!PageContext#user:member' - package: '@microsoft/sp-page-context!' - fullName: user + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!PageContext#user:member' summary: >- It provides contextual information for the SharePoint user that is accessing the page. This class is primarily used with the `PageContext` class. - remarks: '' - - isPreview: false - isDeprecated: false + name: user + fullName: user + langs: + - typeScript + type: property syntax: content: 'get user(): SPUser;' return: - type: '' - - name: web - uid: '@microsoft/sp-page-context!PageContext#web:member' - package: '@microsoft/sp-page-context!' - fullName: web + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!PageContext#web:member' summary: Contextual information for the SharePoint site ("SPWeb") that is hosting the page. - remarks: '' - - isPreview: false - isDeprecated: false + name: web + fullName: web + langs: + - typeScript + type: property syntax: content: 'get web(): SPWeb;' return: - type: '' + type: + - '@microsoft/sp-page-context!default:class' +references: + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-page-context!PageContext#aadInfo~0:complex' + name: AzureActiveDirectoryInfo | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: AzureActiveDirectoryInfo + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!default:class' + name: CultureInfo + - uid: '@microsoft/sp-page-context!PageContext#list~0:complex' + name: SPList | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPList + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!PageContext#listItem~0:complex' + name: SPListItem | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPListItem + fullName: default + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!PageContext.serviceKey~0:complex' + name: ServiceKey + fullName: ServiceKey + spec.typeScript: + - uid: '@microsoft/sp-core-library!ServiceKey:class' + name: ServiceKey + fullName: ServiceKey + - name: < + fullName: < + - uid: '@microsoft/sp-page-context!default:class' + name: PageContext + fullName: default + - name: '>' + fullName: '>' diff --git a/SP-Framework/sp-page-context/spdayofweek-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml index d5853a3d..0e73aadd 100644 --- a/SP-Framework/sp-page-context/spdayofweek-typealias.yml +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -1,11 +1,33 @@ -### YamlMime:TSTypeAlias -name: SPDayOfWeek -uid: '@microsoft/sp-page-context!SPDayOfWeek:type' -package: '@microsoft/sp-page-context!' -fullName: SPDayOfWeek -summary: The type members represent the seven days of a week. -remarks: '' - -isPreview: true -isDeprecated: false -syntax: 'export declare type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPDayOfWeek:type' + summary: The type members represent the seven days of a week. + isPreview: true + name: SPDayOfWeek + fullName: SPDayOfWeek + langs: + - typeScript + type: typealias + syntax: + content: 'export declare type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' + return: + type: + - '@microsoft/sp-page-context!SPDayOfWeek~0:complex' + package: '@microsoft/sp-page-context!' +references: + - uid: '@microsoft/sp-page-context!SPDayOfWeek~0:complex' + name: 'typeof SPDayOfWeek[keyof typeof SPDayOfWeek]' + fullName: 'typeof SPDayOfWeek[keyof typeof SPDayOfWeek]' + spec.typeScript: + - name: 'typeof ' + fullName: 'typeof ' + - uid: '@microsoft/sp-page-context!SPDayOfWeek:var' + name: SPDayOfWeek + fullName: SPDayOfWeek + - name: '[keyof typeof ' + fullName: '[keyof typeof ' + - uid: '@microsoft/sp-page-context!SPDayOfWeek:var' + name: SPDayOfWeek + fullName: SPDayOfWeek + - name: ']' + fullName: ']' diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 8885dcdb..2bfb06ba 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -1,111 +1,124 @@ -### YamlMime:TSType -name: SPField -uid: '@microsoft/sp-page-context!SPField:class' -package: '@microsoft/sp-page-context!' -fullName: SPField -summary: A field represents the data model for a column in SharePoint list view. -remarks: >- - This is the client-side equivalent for SharePoint `SPField` class. It is used with the - `@microsoft/sp-listview-extensibility` package. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPField:class' + summary: A field represents the data model for a column in SharePoint list view. + remarks: >- + This is the client-side equivalent for SharePoint `SPField` class. It is used with the + `@microsoft/sp-listview-extensibility` package. - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPField` class. -isPreview: false -isDeprecated: false -type: class -properties: - - name: clientSideComponentId - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPField` class. + name: SPField + fullName: SPField + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: clientSideComponentId + children: + - '@microsoft/sp-page-context!SPField#clientSideComponentId:member' + - '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' + - '@microsoft/sp-page-context!SPField#displayName:member' + - '@microsoft/sp-page-context!SPField#fieldType:member' + - '@microsoft/sp-page-context!SPField#id:member' + - '@microsoft/sp-page-context!SPField#internalName:member' + - '@microsoft/sp-page-context!SPField#isRequired:member' + - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId:member' summary: The unique identifier of the client-side component associated with the field. - remarks: '' - - isPreview: false - isDeprecated: false + name: clientSideComponentId + fullName: clientSideComponentId + langs: + - typeScript + type: property syntax: content: 'readonly clientSideComponentId: Guid | undefined;' return: - type: ' | undefined' - - name: clientSideComponentProperties - uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' - package: '@microsoft/sp-page-context!' - fullName: clientSideComponentProperties + type: + - '@microsoft/sp-page-context!SPField#clientSideComponentId~0:complex' + - uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' summary: This property is only used when a `ClientSideComponentId` is specified. It is optional. remarks: >- If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. - - isPreview: false - isDeprecated: false + name: clientSideComponentProperties + fullName: clientSideComponentProperties + langs: + - typeScript + type: property syntax: content: 'readonly clientSideComponentProperties: string;' return: - type: string - - name: displayName - uid: '@microsoft/sp-page-context!SPField#displayName:member' - package: '@microsoft/sp-page-context!' - fullName: displayName + type: + - string + - uid: '@microsoft/sp-page-context!SPField#displayName:member' summary: The display name of the field. This name is shown as column name in UI. - remarks: '' - - isPreview: false - isDeprecated: false + name: displayName + fullName: displayName + langs: + - typeScript + type: property syntax: content: 'readonly displayName: string;' return: - type: string - - name: fieldType - uid: '@microsoft/sp-page-context!SPField#fieldType:member' - package: '@microsoft/sp-page-context!' - fullName: fieldType + type: + - string + - uid: '@microsoft/sp-page-context!SPField#fieldType:member' summary: The type of the field represented as a string - remarks: '' - - isPreview: false - isDeprecated: false + name: fieldType + fullName: fieldType + langs: + - typeScript + type: property syntax: content: 'readonly fieldType: string;' return: - type: string - - name: id - uid: '@microsoft/sp-page-context!SPField#id:member' - package: '@microsoft/sp-page-context!' - fullName: id + type: + - string + - uid: '@microsoft/sp-page-context!SPField#id:member' summary: The GUID identifier for this field. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: Guid;' return: - type: '' - - name: internalName - uid: '@microsoft/sp-page-context!SPField#internalName:member' - package: '@microsoft/sp-page-context!' - fullName: internalName + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPField#internalName:member' summary: The internal name of the field. This name is usually used to find the field. - remarks: '' - - isPreview: false - isDeprecated: false + name: internalName + fullName: internalName + langs: + - typeScript + type: property syntax: content: 'readonly internalName: string;' return: - type: string - - name: isRequired - uid: '@microsoft/sp-page-context!SPField#isRequired:member' - package: '@microsoft/sp-page-context!' - fullName: isRequired + type: + - string + - uid: '@microsoft/sp-page-context!SPField#isRequired:member' summary: Whether the field is required for each list item in the list - remarks: '' - - isPreview: false - isDeprecated: false + name: isRequired + fullName: isRequired + langs: + - typeScript + type: property syntax: content: 'readonly isRequired: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-page-context!SPField#clientSideComponentId~0:complex' + name: Guid | undefined + fullName: Guid | undefined + spec.typeScript: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + fullName: Guid + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 6d78d688..7902dcfc 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -1,72 +1,78 @@ -### YamlMime:TSType -name: SPList -uid: '@microsoft/sp-page-context!SPList:class' -package: '@microsoft/sp-page-context!' -fullName: SPList -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list - that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPList` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: id - uid: '@microsoft/sp-page-context!SPList#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPList:class' + summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + list that hosts the page. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPList` class. + name: SPList + fullName: SPList + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: id + children: + - '@microsoft/sp-page-context!SPList#id:member' + - '@microsoft/sp-page-context!SPList#permissions:member' + - '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' + - '@microsoft/sp-page-context!SPList#title:member' + - uid: '@microsoft/sp-page-context!SPList#id:member' summary: >- The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: Guid;' return: - type: '' - - name: permissions - uid: '@microsoft/sp-page-context!SPList#permissions:member' - package: '@microsoft/sp-page-context!' - fullName: permissions + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPList#permissions:member' summary: >- Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list. - remarks: '' - - isPreview: false - isDeprecated: false + name: permissions + fullName: permissions + langs: + - typeScript + type: property syntax: content: 'readonly permissions: SPPermission;' return: - type: '' - - name: serverRelativeUrl - uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' - package: '@microsoft/sp-page-context!' - fullName: serverRelativeUrl + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' summary: Returns the server-relative URL for this `SPList`. remarks: 'Example: "/sites/PubSite"' - - isPreview: false - isDeprecated: false + name: serverRelativeUrl + fullName: serverRelativeUrl + langs: + - typeScript + type: property syntax: content: 'readonly serverRelativeUrl: string;' return: - type: string - - name: title - uid: '@microsoft/sp-page-context!SPList#title:member' - package: '@microsoft/sp-page-context!' - fullName: title + type: + - string + - uid: '@microsoft/sp-page-context!SPList#title:member' summary: Returns the title for this `SPList`. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'readonly title: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 47b0ce7c..dd81f8eb 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -1,29 +1,29 @@ -### YamlMime:TSType -name: SPListItem -uid: '@microsoft/sp-page-context!SPListItem:class' -package: '@microsoft/sp-page-context!' -fullName: SPListItem -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint list - item that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPListItem` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: id - uid: '@microsoft/sp-page-context!SPListItem#id:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPListItem:class' + summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + list item that hosts the page. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPListItem` class. + name: SPListItem + fullName: SPListItem + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: id + children: + - '@microsoft/sp-page-context!SPListItem#id:member' + - uid: '@microsoft/sp-page-context!SPListItem#id:member' summary: The number that identifies the `SPListItem` on the server. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index 3ba1704a..4ff58c7a 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -1,369 +1,438 @@ -### YamlMime:TSType -name: SPPermission -uid: '@microsoft/sp-page-context!SPPermission:class' -package: '@microsoft/sp-page-context!' -fullName: SPPermission -summary: Used to test whether the current user has a requested set of permissions. -remarks: >- - Specifies the built-in permissions available in SharePoint Foundation - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPPermission:class' + summary: Used to test whether the current user has a requested set of permissions. + remarks: >- + Specifies the built-in permissions available in SharePoint Foundation - For more information, see: - [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)(value) - uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' - package: '@microsoft/sp-page-context!' - fullName: (constructor)(value) + For more information, see: + [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spbasepermissions.aspx) + name: SPPermission + fullName: SPPermission + langs: + - typeScript + type: class + package: '@microsoft/sp-page-context!' + children: + - '@microsoft/sp-page-context!SPPermission:constructor(1)' + - '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' + - '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' + - '@microsoft/sp-page-context!SPPermission.addListItems:member' + - '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' + - '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' + - '@microsoft/sp-page-context!SPPermission.approveItems:member' + - '@microsoft/sp-page-context!SPPermission.browseDirectories:member' + - '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' + - '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' + - '@microsoft/sp-page-context!SPPermission.createAlerts:member' + - '@microsoft/sp-page-context!SPPermission.createGroups:member' + - '@microsoft/sp-page-context!SPPermission.createSSCSite:member' + - '@microsoft/sp-page-context!SPPermission.deleteListItems:member' + - '@microsoft/sp-page-context!SPPermission.deleteVersions:member' + - '@microsoft/sp-page-context!SPPermission.editListItems:member' + - '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' + - '@microsoft/sp-page-context!SPPermission.emptyMask:member' + - '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' + - '@microsoft/sp-page-context!SPPermission.fullMask:member' + - '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' + - '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' + - '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' + - '@microsoft/sp-page-context!SPPermission.layoutsPage:member' + - '@microsoft/sp-page-context!SPPermission.manageAlerts:member' + - '@microsoft/sp-page-context!SPPermission.manageLists:member' + - '@microsoft/sp-page-context!SPPermission.managePermissions:member' + - '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' + - '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' + - '@microsoft/sp-page-context!SPPermission.manageWeb:member' + - '@microsoft/sp-page-context!SPPermission.open:member' + - '@microsoft/sp-page-context!SPPermission.openItems:member' + - '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' + - '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' + - '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' + - '@microsoft/sp-page-context!SPPermission#value:member' + - '@microsoft/sp-page-context!SPPermission.viewFormPages:member' + - '@microsoft/sp-page-context!SPPermission.viewListItems:member' + - '@microsoft/sp-page-context!SPPermission.viewPages:member' + - '@microsoft/sp-page-context!SPPermission.viewUsageData:member' + - '@microsoft/sp-page-context!SPPermission.viewVersions:member' + - uid: '@microsoft/sp-page-context!SPPermission:constructor(1)' summary: Constructs a new instance of the `SPPermission` class - remarks: '' - - isPreview: false - isDeprecated: false + name: (constructor)(value) + fullName: (constructor)(value) + langs: + - typeScript + type: constructor syntax: content: 'constructor(value: IODataBasePermission);' parameters: - id: value description: '' - type: '' -properties: - - name: addAndCustomizePages - uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' - package: '@microsoft/sp-page-context!' - fullName: addAndCustomizePages + type: + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + optional: false + - uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' summary: >- Add, change, or delete HTML pages or web part Pages, and edit the Web site using a SharePoint Foundation-compatible editor. - remarks: '' - - isPreview: false - isDeprecated: false + name: addAndCustomizePages + fullName: addAndCustomizePages + langs: + - typeScript + type: property syntax: content: 'static readonly addAndCustomizePages: SPPermission;' return: - type: '' - - name: addDelPrivateWebParts - uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' - package: '@microsoft/sp-page-context!' - fullName: addDelPrivateWebParts + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' summary: Add or remove personal web parts on a web part Page. - remarks: '' - - isPreview: false - isDeprecated: false + name: addDelPrivateWebParts + fullName: addDelPrivateWebParts + langs: + - typeScript + type: property syntax: content: 'static readonly addDelPrivateWebParts: SPPermission;' return: - type: '' - - name: addListItems - uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' - package: '@microsoft/sp-page-context!' - fullName: addListItems + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' - remarks: '' - - isPreview: false - isDeprecated: false + name: addListItems + fullName: addListItems + langs: + - typeScript + type: property syntax: content: 'static readonly addListItems: SPPermission;' return: - type: '' - - name: applyStyleSheets - uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' - package: '@microsoft/sp-page-context!' - fullName: applyStyleSheets + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' summary: Apply a style sheet (.css file) to the Web site. - remarks: '' - - isPreview: false - isDeprecated: false + name: applyStyleSheets + fullName: applyStyleSheets + langs: + - typeScript + type: property syntax: content: 'static readonly applyStyleSheets: SPPermission;' return: - type: '' - - name: applyThemeAndBorder - uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' - package: '@microsoft/sp-page-context!' - fullName: applyThemeAndBorder + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' summary: Apply a theme or borders to the entire Web site. - remarks: '' - - isPreview: false - isDeprecated: false + name: applyThemeAndBorder + fullName: applyThemeAndBorder + langs: + - typeScript + type: property syntax: content: 'static readonly applyThemeAndBorder: SPPermission;' return: - type: '' - - name: approveItems - uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' - package: '@microsoft/sp-page-context!' - fullName: approveItems + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' summary: Approve a minor version of a list item or document. - remarks: '' - - isPreview: false - isDeprecated: false + name: approveItems + fullName: approveItems + langs: + - typeScript + type: property syntax: content: 'static readonly approveItems: SPPermission;' return: - type: '' - - name: browseDirectories - uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' - package: '@microsoft/sp-page-context!' - fullName: browseDirectories + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' summary: Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. - remarks: '' - - isPreview: false - isDeprecated: false + name: browseDirectories + fullName: browseDirectories + langs: + - typeScript + type: property syntax: content: 'static readonly browseDirectories: SPPermission;' return: - type: '' - - name: browserUserInfo - uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' - package: '@microsoft/sp-page-context!' - fullName: browserUserInfo + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' summary: View information about users of the Web site. - remarks: '' - - isPreview: false - isDeprecated: false + name: browserUserInfo + fullName: browserUserInfo + langs: + - typeScript + type: property syntax: content: 'static readonly browserUserInfo: SPPermission;' return: - type: '' - - name: cancelCheckout - uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' - package: '@microsoft/sp-page-context!' - fullName: cancelCheckout + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' summary: Discard or check in a document which is checked out to another user. - remarks: '' - - isPreview: false - isDeprecated: false + name: cancelCheckout + fullName: cancelCheckout + langs: + - typeScript + type: property syntax: content: 'static readonly cancelCheckout: SPPermission;' return: - type: '' - - name: createAlerts - uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' - package: '@microsoft/sp-page-context!' - fullName: createAlerts + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' summary: Create e-mail alerts. - remarks: '' - - isPreview: false - isDeprecated: false + name: createAlerts + fullName: createAlerts + langs: + - typeScript + type: property syntax: content: 'static readonly createAlerts: SPPermission;' return: - type: '' - - name: createGroups - uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' - package: '@microsoft/sp-page-context!' - fullName: createGroups + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' summary: Create a group of users that can be used anywhere within the site collection. - remarks: '' - - isPreview: false - isDeprecated: false + name: createGroups + fullName: createGroups + langs: + - typeScript + type: property syntax: content: 'static readonly createGroups: SPPermission;' return: - type: '' - - name: createSSCSite - uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' - package: '@microsoft/sp-page-context!' - fullName: createSSCSite + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' summary: Create a Web site using Self-Service Site Creation. - remarks: '' - - isPreview: false - isDeprecated: false + name: createSSCSite + fullName: createSSCSite + langs: + - typeScript + type: property syntax: content: 'static readonly createSSCSite: SPPermission;' return: - type: '' - - name: deleteListItems - uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' - package: '@microsoft/sp-page-context!' - fullName: deleteListItems + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' - remarks: '' - - isPreview: false - isDeprecated: false + name: deleteListItems + fullName: deleteListItems + langs: + - typeScript + type: property syntax: content: 'static readonly deleteListItems: SPPermission;' return: - type: '' - - name: deleteVersions - uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' - package: '@microsoft/sp-page-context!' - fullName: deleteVersions + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' summary: Delete past versions of a list item or document. - remarks: '' - - isPreview: false - isDeprecated: false + name: deleteVersions + fullName: deleteVersions + langs: + - typeScript + type: property syntax: content: 'static readonly deleteVersions: SPPermission;' return: - type: '' - - name: editListItems - uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' - package: '@microsoft/sp-page-context!' - fullName: editListItems + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' summary: >- Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize web part Pages in document libraries. - remarks: '' - - isPreview: false - isDeprecated: false + name: editListItems + fullName: editListItems + langs: + - typeScript + type: property syntax: content: 'static readonly editListItems: SPPermission;' return: - type: '' - - name: editMyUserInfo - uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' - package: '@microsoft/sp-page-context!' - fullName: editMyUserInfo + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' summary: 'Allows a user to change his or her user information, such as adding a picture.' - remarks: '' - - isPreview: false - isDeprecated: false + name: editMyUserInfo + fullName: editMyUserInfo + langs: + - typeScript + type: property syntax: content: 'static readonly editMyUserInfo: SPPermission;' return: - type: '' - - name: emptyMask - uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' - package: '@microsoft/sp-page-context!' - fullName: emptyMask + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' summary: Has no permissions on the Web site. Not available through the user interface. - remarks: '' - - isPreview: false - isDeprecated: false + name: emptyMask + fullName: emptyMask + langs: + - typeScript + type: property syntax: content: 'static readonly emptyMask: SPPermission;' return: - type: '' - - name: enumeratePermissions - uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' - package: '@microsoft/sp-page-context!' - fullName: enumeratePermissions + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' - remarks: '' - - isPreview: false - isDeprecated: false + name: enumeratePermissions + fullName: enumeratePermissions + langs: + - typeScript + type: property syntax: content: 'static readonly enumeratePermissions: SPPermission;' return: - type: '' - - name: fullMask - uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' - package: '@microsoft/sp-page-context!' - fullName: fullMask + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' summary: Has all permissions on the Web site. Not available through the user interface. - remarks: '' - - isPreview: false - isDeprecated: false + name: fullMask + fullName: fullMask + langs: + - typeScript + type: property syntax: content: 'static readonly fullMask: SPPermission;' return: - type: '' - - name: layoutsPage - uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' - package: '@microsoft/sp-page-context!' - fullName: layoutsPage + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' + summary: Function for testing whether a given permission mask has all of the requested permissions. + name: hasAllPermissions(requestedPerms) + fullName: hasAllPermissions(requestedPerms) + langs: + - typeScript + type: method + syntax: + content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' + return: + type: + - boolean + description: '' + parameters: + - id: requestedPerms + description: Any number of SPPermission objects to be compared against the original + type: + - '@microsoft/sp-page-context!SPPermission#hasAllPermissions~0:complex' + optional: false + - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' + summary: Function for testing whether a given permission mask has any of the requested permissions. + name: hasAnyPermissions(requestedPerms) + fullName: hasAnyPermissions(requestedPerms) + langs: + - typeScript + type: method + syntax: + content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' + return: + type: + - boolean + description: '' + parameters: + - id: requestedPerms + description: Any number of SPPermission objects to be compared against the original + type: + - '@microsoft/sp-page-context!SPPermission#hasAnyPermissions~0:complex' + optional: false + - uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' + summary: Function for testing whether a given permission mask has the requested permission. + name: hasPermission(requestedPerm) + fullName: hasPermission(requestedPerm) + langs: + - typeScript + type: method + syntax: + content: 'hasPermission(requestedPerm: SPPermission): boolean;' + return: + type: + - boolean + description: '' + parameters: + - id: requestedPerm + description: The SPPermission object to be compared against the original + type: + - '@microsoft/sp-page-context!default:class' + optional: false + - uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' summary: View the layouts page? - remarks: '' - - isPreview: false - isDeprecated: false + name: layoutsPage + fullName: layoutsPage + langs: + - typeScript + type: property syntax: content: 'static readonly layoutsPage: SPPermission;' return: - type: '' - - name: manageAlerts - uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' - package: '@microsoft/sp-page-context!' - fullName: manageAlerts + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' summary: Manage alerts for all users of the Web site. - remarks: '' - - isPreview: false - isDeprecated: false + name: manageAlerts + fullName: manageAlerts + langs: + - typeScript + type: property syntax: content: 'static readonly manageAlerts: SPPermission;' return: - type: '' - - name: manageLists - uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' - package: '@microsoft/sp-page-context!' - fullName: manageLists + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' - remarks: '' - - isPreview: false - isDeprecated: false + name: manageLists + fullName: manageLists + langs: + - typeScript + type: property syntax: content: 'static readonly manageLists: SPPermission;' return: - type: '' - - name: managePermissions - uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' - package: '@microsoft/sp-page-context!' - fullName: managePermissions + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' summary: Create and change permission levels on the Web site and assign permissions to users and groups. - remarks: '' - - isPreview: false - isDeprecated: false + name: managePermissions + fullName: managePermissions + langs: + - typeScript + type: property syntax: content: 'static readonly managePermissions: SPPermission;' return: - type: '' - - name: managePersonalViews - uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' - package: '@microsoft/sp-page-context!' - fullName: managePersonalViews + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' summary: 'Create, change, and delete personal views of lists.' - remarks: '' - - isPreview: false - isDeprecated: false + name: managePersonalViews + fullName: managePersonalViews + langs: + - typeScript + type: property syntax: content: 'static readonly managePersonalViews: SPPermission;' return: - type: '' - - name: manageSubwebs - uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' - package: '@microsoft/sp-page-context!' - fullName: manageSubwebs + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' - remarks: '' - - isPreview: false - isDeprecated: false + name: manageSubwebs + fullName: manageSubwebs + langs: + - typeScript + type: property syntax: content: 'static readonly manageSubwebs: SPPermission;' return: - type: '' - - name: manageWeb - uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' - package: '@microsoft/sp-page-context!' - fullName: manageWeb + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' summary: Grant the ability to perform all administration tasks for the Web site as well as manage content. remarks: >- Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user @@ -371,208 +440,168 @@ properties: of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. - - isPreview: false - isDeprecated: false + name: manageWeb + fullName: manageWeb + langs: + - typeScript + type: property syntax: content: 'static readonly manageWeb: SPPermission;' return: - type: '' - - name: open - uid: '@microsoft/sp-page-context!SPPermission.open:member' - package: '@microsoft/sp-page-context!' - fullName: open + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.open:member' summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' - remarks: '' - - isPreview: false - isDeprecated: false + name: open + fullName: open + langs: + - typeScript + type: property syntax: content: 'static readonly open: SPPermission;' return: - type: '' - - name: openItems - uid: '@microsoft/sp-page-context!SPPermission.openItems:member' - package: '@microsoft/sp-page-context!' - fullName: openItems + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.openItems:member' summary: View the source of documents with server-side file handlers. - remarks: '' - - isPreview: false - isDeprecated: false + name: openItems + fullName: openItems + langs: + - typeScript + type: property syntax: content: 'static readonly openItems: SPPermission;' return: - type: '' - - name: updatePersonalWebParts - uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' - package: '@microsoft/sp-page-context!' - fullName: updatePersonalWebParts + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' summary: Update web parts to display personalized information. - remarks: '' - - isPreview: false - isDeprecated: false + name: updatePersonalWebParts + fullName: updatePersonalWebParts + langs: + - typeScript + type: property syntax: content: 'static readonly updatePersonalWebParts: SPPermission;' return: - type: '' - - name: useClientIntegration - uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' - package: '@microsoft/sp-page-context!' - fullName: useClientIntegration + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' - remarks: '' - - isPreview: false - isDeprecated: false + name: useClientIntegration + fullName: useClientIntegration + langs: + - typeScript + type: property syntax: content: 'static readonly useClientIntegration: SPPermission;' return: - type: '' - - name: useRemoteAPIs - uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' - package: '@microsoft/sp-page-context!' - fullName: useRemoteAPIs + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' - remarks: '' - - isPreview: false - isDeprecated: false + name: useRemoteAPIs + fullName: useRemoteAPIs + langs: + - typeScript + type: property syntax: content: 'static readonly useRemoteAPIs: SPPermission;' return: - type: '' - - name: value - uid: '@microsoft/sp-page-context!SPPermission#value:member' - package: '@microsoft/sp-page-context!' - fullName: value + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission#value:member' summary: Returns the value of this SPPermission object - remarks: '' - - isPreview: false - isDeprecated: false + name: value + fullName: value + langs: + - typeScript + type: property syntax: content: 'get value(): IODataBasePermission;' return: - type: '' - - name: viewFormPages - uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' - package: '@microsoft/sp-page-context!' - fullName: viewFormPages + type: + - '@microsoft/sp-odata-types!IODataBasePermission:interface' + - uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' summary: 'View forms, views, and application pages, and enumerate lists.' - remarks: '' - - isPreview: false - isDeprecated: false + name: viewFormPages + fullName: viewFormPages + langs: + - typeScript + type: property syntax: content: 'static readonly viewFormPages: SPPermission;' return: - type: '' - - name: viewListItems - uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' - package: '@microsoft/sp-page-context!' - fullName: viewListItems + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' - remarks: '' - - isPreview: false - isDeprecated: false + name: viewListItems + fullName: viewListItems + langs: + - typeScript + type: property syntax: content: 'static readonly viewListItems: SPPermission;' return: - type: '' - - name: viewPages - uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' - package: '@microsoft/sp-page-context!' - fullName: viewPages + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' summary: View pages in a Web site. - remarks: '' - - isPreview: false - isDeprecated: false + name: viewPages + fullName: viewPages + langs: + - typeScript + type: property syntax: content: 'static readonly viewPages: SPPermission;' return: - type: '' - - name: viewUsageData - uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' - package: '@microsoft/sp-page-context!' - fullName: viewUsageData + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' summary: View reports on Web site usage. - remarks: '' - - isPreview: false - isDeprecated: false + name: viewUsageData + fullName: viewUsageData + langs: + - typeScript + type: property syntax: content: 'static readonly viewUsageData: SPPermission;' return: - type: '' - - name: viewVersions - uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' - package: '@microsoft/sp-page-context!' - fullName: viewVersions + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' summary: View past versions of a list item or document. - remarks: '' - - isPreview: false - isDeprecated: false + name: viewVersions + fullName: viewVersions + langs: + - typeScript + type: property syntax: content: 'static readonly viewVersions: SPPermission;' return: - type: '' -methods: - - name: hasAllPermissions(requestedPerms) - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' - package: '@microsoft/sp-page-context!' - fullName: hasAllPermissions(requestedPerms) - summary: Function for testing whether a given permission mask has all of the requested permissions. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' - parameters: - - id: requestedPerms - description: Any number of SPPermission objects to be compared against the original - type: '[]' - return: - type: boolean - description: '' - - name: hasAnyPermissions(requestedPerms) - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions:member(1)' - package: '@microsoft/sp-page-context!' - fullName: hasAnyPermissions(requestedPerms) - summary: Function for testing whether a given permission mask has any of the requested permissions. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' - parameters: - - id: requestedPerms - description: Any number of SPPermission objects to be compared against the original - type: '[]' - return: - type: boolean - description: '' - - name: hasPermission(requestedPerm) - uid: '@microsoft/sp-page-context!SPPermission#hasPermission:member(1)' - package: '@microsoft/sp-page-context!' - fullName: hasPermission(requestedPerm) - summary: Function for testing whether a given permission mask has the requested permission. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'hasPermission(requestedPerm: SPPermission): boolean;' - parameters: - - id: requestedPerm - description: The SPPermission object to be compared against the original - type: '' - return: - type: boolean - description: '' + type: + - '@microsoft/sp-page-context!default:class' +references: + - uid: '@microsoft/sp-odata-types!IODataBasePermission:interface' + name: IODataBasePermission + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + - uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions~0:complex' + name: 'SPPermission[]' + fullName: 'default[]' + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + fullName: default + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-page-context!SPPermission#hasAnyPermissions~0:complex' + name: 'SPPermission[]' + fullName: 'default[]' + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + fullName: default + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index ce9786e7..d59fabc0 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -1,161 +1,176 @@ -### YamlMime:TSType -name: SPSite -uid: '@microsoft/sp-page-context!SPSite:class' -package: '@microsoft/sp-page-context!' -fullName: SPSite -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site - collection ("SPSite") that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPSite` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: absoluteUrl - uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPSite:class' + summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + site collection ("SPSite") that hosts the page. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPSite` class. + name: SPSite + fullName: SPSite + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: absoluteUrl + children: + - '@microsoft/sp-page-context!SPSite#absoluteUrl:member' + - '@microsoft/sp-page-context!SPSite#cdnPrefix:member' + - '@microsoft/sp-page-context!SPSite#classification:member' + - '@microsoft/sp-page-context!SPSite#correlationId:member' + - '@microsoft/sp-page-context!SPSite#group:member' + - '@microsoft/sp-page-context!SPSite#id:member' + - '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' + - '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' + - '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' + - '@microsoft/sp-page-context!SPSite#serverRequestPath:member' + - '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' + - uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member' summary: Returns the absolute URL for this SPSite. remarks: 'Example: "https://example.com/sites/PubSite"' - - isPreview: false - isDeprecated: false + name: absoluteUrl + fullName: absoluteUrl + langs: + - typeScript + type: property syntax: content: 'readonly absoluteUrl: string;' return: - type: string - - name: cdnPrefix - uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' - package: '@microsoft/sp-page-context!' - fullName: cdnPrefix + type: + - string + - uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member' summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one. - remarks: '' - - isPreview: false - isDeprecated: false + name: cdnPrefix + fullName: cdnPrefix + langs: + - typeScript + type: property syntax: content: 'readonly cdnPrefix: string;' return: - type: string - - name: classification - uid: '@microsoft/sp-page-context!SPSite#classification:member' - package: '@microsoft/sp-page-context!' - fullName: classification + type: + - string + - uid: '@microsoft/sp-page-context!SPSite#classification:member' summary: Returns the classification of the site. - remarks: '' - - isPreview: false - isDeprecated: false + name: classification + fullName: classification + langs: + - typeScript + type: property syntax: content: 'readonly classification: string;' return: - type: string - - name: correlationId - uid: '@microsoft/sp-page-context!SPSite#correlationId:member' - package: '@microsoft/sp-page-context!' - fullName: correlationId + type: + - string + - uid: '@microsoft/sp-page-context!SPSite#correlationId:member' summary: Returns the correlation id to the current server request. - remarks: '' - - isPreview: false - isDeprecated: false + name: correlationId + fullName: correlationId + langs: + - typeScript + type: property syntax: content: 'readonly correlationId: Guid;' return: - type: '' - - name: group - uid: '@microsoft/sp-page-context!SPSite#group:member' - package: '@microsoft/sp-page-context!' - fullName: group + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPSite#group:member' summary: >- Contextual information about the O365 Group associated with this site. If there is no O365Group associated with the current site, this property will be undefined. - remarks: '' - - isPreview: false - isDeprecated: false + name: group + fullName: group + langs: + - typeScript + type: property syntax: content: 'readonly group: O365GroupAssociation | undefined;' return: - type: ' | undefined' - - name: id - uid: '@microsoft/sp-page-context!SPSite#id:member' - package: '@microsoft/sp-page-context!' - fullName: id + type: + - '@microsoft/sp-page-context!SPSite#group~0:complex' + - uid: '@microsoft/sp-page-context!SPSite#id:member' summary: The GUID that identifies the SPSite on the server. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: Guid;' return: - type: '' - - name: isNoScriptEnabled - uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' - package: '@microsoft/sp-page-context!' - fullName: isNoScriptEnabled + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' summary: Returns true if isNoScript has been enabled on the SPSite. - remarks: '' - - isPreview: false - isDeprecated: false + name: isNoScriptEnabled + fullName: isNoScriptEnabled + langs: + - typeScript + type: property syntax: content: 'readonly isNoScriptEnabled: boolean;' return: - type: boolean - - name: recycleBinItemCount - uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' - package: '@microsoft/sp-page-context!' - fullName: recycleBinItemCount + type: + - boolean + - uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' summary: The amount of items in the recycle bin. - remarks: '' - - isPreview: false - isDeprecated: false + name: recycleBinItemCount + fullName: recycleBinItemCount + langs: + - typeScript + type: property syntax: content: 'readonly recycleBinItemCount: number;' return: - type: number - - name: serverRelativeUrl - uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' - package: '@microsoft/sp-page-context!' - fullName: serverRelativeUrl + type: + - number + - uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member' summary: Returns the server-relative URL for this SPSite. remarks: 'Example: "/sites/PubSite"' - - isPreview: false - isDeprecated: false + name: serverRelativeUrl + fullName: serverRelativeUrl + langs: + - typeScript + type: property syntax: content: 'readonly serverRelativeUrl: string;' return: - type: string - - name: serverRequestPath - uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' - package: '@microsoft/sp-page-context!' - fullName: serverRequestPath + type: + - string + - uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member' summary: Returns serverRelativeUrl of the original request. remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"' - - isPreview: false - isDeprecated: false + name: serverRequestPath + fullName: serverRequestPath + langs: + - typeScript + type: property syntax: content: 'readonly serverRequestPath: string;' return: - type: string - - name: sitePagesEnabled - uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' - package: '@microsoft/sp-page-context!' - fullName: sitePagesEnabled + type: + - string + - uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member' summary: Returns true if SitePages are enabled on this SPSite. - remarks: '' - - isPreview: false - isDeprecated: false + name: sitePagesEnabled + fullName: sitePagesEnabled + langs: + - typeScript + type: property syntax: content: 'readonly sitePagesEnabled: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-page-context!SPSite#group~0:complex' + name: O365GroupAssociation | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: O365GroupAssociation + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index dd7fba10..3eb4babb 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -1,121 +1,132 @@ -### YamlMime:TSType -name: SPTimeZone -uid: '@microsoft/sp-page-context!SPTimeZone:class' -package: '@microsoft/sp-page-context!' -fullName: SPTimeZone -summary: >- - It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the - following formula. -remarks: >- - ``` - - isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPTimeZone:class' + summary: >- + It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using + the following formula. + remarks: >- + ``` - LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) + isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate - June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) + LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset) - ``` + June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes) - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPTimeZone` class. + ``` -isPreview: true -isDeprecated: false -type: class -properties: - - name: daylightDate - uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPTimeZone` class. + isPreview: true + name: SPTimeZone + fullName: SPTimeZone + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: daylightDate + children: + - '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' + - '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' + - '@microsoft/sp-page-context!SPTimeZone#description:member' + - '@microsoft/sp-page-context!SPTimeZone#id:member' + - '@microsoft/sp-page-context!SPTimeZone#offset:member' + - '@microsoft/sp-page-context!SPTimeZone#standardDate:member' + - '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' + - uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member' summary: Gets the date on which daylight time begins for the time zone. - remarks: '' - isPreview: true - isDeprecated: false + name: daylightDate + fullName: daylightDate + langs: + - typeScript + type: property syntax: content: 'readonly daylightDate: ISPSystemTime;' return: - type: '' - - name: daylightOffset - uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' - package: '@microsoft/sp-page-context!' - fullName: daylightOffset + type: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' summary: >- Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal Time (UTC). - remarks: '' - isPreview: true - isDeprecated: false + name: daylightOffset + fullName: daylightOffset + langs: + - typeScript + type: property syntax: content: 'readonly daylightOffset: number;' return: - type: number - - name: description - uid: '@microsoft/sp-page-context!SPTimeZone#description:member' - package: '@microsoft/sp-page-context!' - fullName: description + type: + - number + - uid: '@microsoft/sp-page-context!SPTimeZone#description:member' summary: Gets the description for the time zone. - remarks: '' - isPreview: true - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'readonly description: string;' return: - type: string - - name: id - uid: '@microsoft/sp-page-context!SPTimeZone#id:member' - package: '@microsoft/sp-page-context!' - fullName: id + type: + - string + - uid: '@microsoft/sp-page-context!SPTimeZone#id:member' summary: Gets the ID of the time zone. - remarks: '' - isPreview: true - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: number;' return: - type: number - - name: offset - uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' - package: '@microsoft/sp-page-context!' - fullName: offset + type: + - number + - uid: '@microsoft/sp-page-context!SPTimeZone#offset:member' summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC). - remarks: '' - isPreview: true - isDeprecated: false + name: offset + fullName: offset + langs: + - typeScript + type: property syntax: content: 'readonly offset: number;' return: - type: number - - name: standardDate - uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' - package: '@microsoft/sp-page-context!' - fullName: standardDate + type: + - number + - uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member' summary: Gets the date on which standard time begins for the time zone. - remarks: '' - isPreview: true - isDeprecated: false + name: standardDate + fullName: standardDate + langs: + - typeScript + type: property syntax: content: 'readonly standardDate: ISPSystemTime;' return: - type: '' - - name: standardOffset - uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' - package: '@microsoft/sp-page-context!' - fullName: standardOffset + type: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' summary: >- Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal time (UTC). - remarks: '' - isPreview: true - isDeprecated: false + name: standardOffset + fullName: standardOffset + langs: + - typeScript + type: property syntax: content: 'readonly standardOffset: number;' return: - type: number + type: + - number +references: + - uid: '@microsoft/sp-page-context!ISPSystemTime:interface' + name: ISPSystemTime diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index 7aee725b..f7174626 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -1,120 +1,144 @@ -### YamlMime:TSType -name: SPUser -uid: '@microsoft/sp-page-context!SPUser:class' -package: '@microsoft/sp-page-context!' -fullName: SPUser -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint user - that is accessing the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPUser` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: displayName - uid: '@microsoft/sp-page-context!SPUser#displayName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPUser:class' + summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + user that is accessing the page. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPUser` class. + name: SPUser + fullName: SPUser + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: displayName + children: + - '@microsoft/sp-page-context!SPUser#displayName:member' + - '@microsoft/sp-page-context!SPUser#email:member' + - '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' + - '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' + - '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' + - '@microsoft/sp-page-context!SPUser#loginName:member' + - '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' + - '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' + - uid: '@microsoft/sp-page-context!SPUser#displayName:member' summary: The display name for the current user. remarks: 'Example: `"John Doe"`' - - isPreview: false - isDeprecated: false + name: displayName + fullName: displayName + langs: + - typeScript + type: property syntax: content: 'readonly displayName: string;' return: - type: string - - name: email - uid: '@microsoft/sp-page-context!SPUser#email:member' - package: '@microsoft/sp-page-context!' - fullName: email + type: + - string + - uid: '@microsoft/sp-page-context!SPUser#email:member' summary: The email address for the current user. remarks: 'Example: `"example@contoso.com"`' - - isPreview: false - isDeprecated: false + name: email + fullName: email + langs: + - typeScript + type: property syntax: content: 'readonly email: string;' return: - type: string - - name: firstDayOfWeek - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' - package: '@microsoft/sp-page-context!' - fullName: firstDayOfWeek + type: + - string + - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek:member' summary: Returns the user's regional first day of week setting or undefined if it hasn't been set. - remarks: '' - isPreview: true - isDeprecated: false + name: firstDayOfWeek + fullName: firstDayOfWeek + langs: + - typeScript + type: property syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: ' | undefined' - - name: isAnonymousGuestUser - uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' - package: '@microsoft/sp-page-context!' - fullName: isAnonymousGuestUser + type: + - '@microsoft/sp-page-context!SPUser#firstDayOfWeek~0:complex' + - uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' summary: Returns if the current user is an anonymous guest. - remarks: '' - - isPreview: false - isDeprecated: false + name: isAnonymousGuestUser + fullName: isAnonymousGuestUser + langs: + - typeScript + type: property syntax: content: 'readonly isAnonymousGuestUser: boolean;' return: - type: boolean - - name: isExternalGuestUser - uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' - package: '@microsoft/sp-page-context!' - fullName: isExternalGuestUser + type: + - boolean + - uid: '@microsoft/sp-page-context!SPUser#isExternalGuestUser:member' summary: Returns true if the current user is an external guest. - remarks: '' - - isPreview: false - isDeprecated: false + name: isExternalGuestUser + fullName: isExternalGuestUser + langs: + - typeScript + type: property syntax: content: 'readonly isExternalGuestUser: boolean;' return: - type: boolean - - name: loginName - uid: '@microsoft/sp-page-context!SPUser#loginName:member' - package: '@microsoft/sp-page-context!' - fullName: loginName + type: + - boolean + - uid: '@microsoft/sp-page-context!SPUser#loginName:member' summary: The login name for current user. remarks: 'Example: on-premise user: `"domain\user"`, online user: `"user@domain.com"`' - - isPreview: false - isDeprecated: false + name: loginName + fullName: loginName + langs: + - typeScript + type: property syntax: content: 'readonly loginName: string;' return: - type: string - - name: preferUserTimeZone - uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' - package: '@microsoft/sp-page-context!' - fullName: preferUserTimeZone + type: + - string + - uid: '@microsoft/sp-page-context!SPUser#preferUserTimeZone:member' summary: This boolean represents if a the user or web's time zone settings should be used to display the current time. - remarks: '' - - isPreview: false - isDeprecated: false + name: preferUserTimeZone + fullName: preferUserTimeZone + langs: + - typeScript + type: property syntax: content: 'readonly preferUserTimeZone: boolean;' return: - type: boolean - - name: timeZoneInfo - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' - package: '@microsoft/sp-page-context!' - fullName: timeZoneInfo + type: + - boolean + - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo:member' summary: Returns the user's regional timezone settings or undefined if they haven't been set. - remarks: '' - isPreview: true - isDeprecated: false + name: timeZoneInfo + fullName: timeZoneInfo + langs: + - typeScript + type: property syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: ' | undefined' + type: + - '@microsoft/sp-page-context!SPUser#timeZoneInfo~0:complex' +references: + - uid: '@microsoft/sp-page-context!SPUser#firstDayOfWeek~0:complex' + name: SPDayOfWeek | undefined + fullName: SPDayOfWeek | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!SPDayOfWeek:type' + name: SPDayOfWeek + fullName: SPDayOfWeek + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-page-context!SPUser#timeZoneInfo~0:complex' + name: SPTimeZone | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPTimeZone + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index d83c54d6..00c4ce9b 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -1,189 +1,219 @@ -### YamlMime:TSType -name: SPWeb -uid: '@microsoft/sp-page-context!SPWeb:class' -package: '@microsoft/sp-page-context!' -fullName: SPWeb -summary: >- - This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site - ("SPWeb") that hosts the page. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `SPWeb` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: absoluteUrl - uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-page-context!SPWeb:class' + summary: >- + This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint + site ("SPWeb") that hosts the page. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `SPWeb` class. + name: SPWeb + fullName: SPWeb + langs: + - typeScript + type: class package: '@microsoft/sp-page-context!' - fullName: absoluteUrl + children: + - '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' + - '@microsoft/sp-page-context!SPWeb#description:member' + - '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' + - '@microsoft/sp-page-context!SPWeb#id:member' + - '@microsoft/sp-page-context!SPWeb#isAppWeb:member' + - '@microsoft/sp-page-context!SPWeb#language:member' + - '@microsoft/sp-page-context!SPWeb#languageName:member' + - '@microsoft/sp-page-context!SPWeb#logoUrl:member' + - '@microsoft/sp-page-context!SPWeb#permissions:member' + - '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' + - '@microsoft/sp-page-context!SPWeb#templateName:member' + - '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' + - '@microsoft/sp-page-context!SPWeb#title:member' + - uid: '@microsoft/sp-page-context!SPWeb#absoluteUrl:member' summary: 'Returns the absolute URL for this SPWeb. Example: `"https://example.com/sites/PubSite/SubWeb"`' - remarks: '' - - isPreview: false - isDeprecated: false + name: absoluteUrl + fullName: absoluteUrl + langs: + - typeScript + type: property syntax: content: 'readonly absoluteUrl: string;' return: - type: string - - name: description - uid: '@microsoft/sp-page-context!SPWeb#description:member' - package: '@microsoft/sp-page-context!' - fullName: description + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#description:member' summary: Returns the description of the current SPWeb. - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'readonly description: string;' return: - type: string - - name: firstDayOfWeek - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' - package: '@microsoft/sp-page-context!' - fullName: firstDayOfWeek + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek:member' summary: Returns the web's regional first day of week setting or undefined if it hasn't been set. - remarks: '' - isPreview: true - isDeprecated: false + name: firstDayOfWeek + fullName: firstDayOfWeek + langs: + - typeScript + type: property syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: ' | undefined' - - name: id - uid: '@microsoft/sp-page-context!SPWeb#id:member' - package: '@microsoft/sp-page-context!' - fullName: id + type: + - '@microsoft/sp-page-context!SPWeb#firstDayOfWeek~0:complex' + - uid: '@microsoft/sp-page-context!SPWeb#id:member' summary: The GUID that identifies the SPWeb on the server. - remarks: '' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'readonly id: Guid;' return: - type: '' - - name: isAppWeb - uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' - package: '@microsoft/sp-page-context!' - fullName: isAppWeb + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' summary: Returns true if this `SPWeb` the container web for an `SPApp`. - remarks: '' - - isPreview: false - isDeprecated: false + name: isAppWeb + fullName: isAppWeb + langs: + - typeScript + type: property syntax: content: 'readonly isAppWeb: boolean;' return: - type: boolean - - name: language - uid: '@microsoft/sp-page-context!SPWeb#language:member' - package: '@microsoft/sp-page-context!' - fullName: language + type: + - boolean + - uid: '@microsoft/sp-page-context!SPWeb#language:member' summary: Returns the locale identifier (LCID) for the default language of the website. remarks: 'Example: 1033 represents the locale identifier for en-US.' - - isPreview: false - isDeprecated: false + name: language + fullName: language + langs: + - typeScript + type: property syntax: content: 'readonly language: number;' return: - type: number - - name: languageName - uid: '@microsoft/sp-page-context!SPWeb#languageName:member' - package: '@microsoft/sp-page-context!' - fullName: languageName + type: + - number + - uid: '@microsoft/sp-page-context!SPWeb#languageName:member' summary: Returns the language name for the default language of the website. remarks: 'Example: en-US represents the English language in the US locale.' - - isPreview: false - isDeprecated: false + name: languageName + fullName: languageName + langs: + - typeScript + type: property syntax: content: 'readonly languageName: string;' return: - type: string - - name: logoUrl - uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' - package: '@microsoft/sp-page-context!' - fullName: logoUrl + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#logoUrl:member' summary: Returns the absolute URL of the website logo. remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' - - isPreview: false - isDeprecated: false + name: logoUrl + fullName: logoUrl + langs: + - typeScript + type: property syntax: content: 'readonly logoUrl: string;' return: - type: string - - name: permissions - uid: '@microsoft/sp-page-context!SPWeb#permissions:member' - package: '@microsoft/sp-page-context!' - fullName: permissions + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#permissions:member' summary: >- Return the SPPermission object that represents the set of permissions that the current user has for interacting with the web. - remarks: '' - - isPreview: false - isDeprecated: false + name: permissions + fullName: permissions + langs: + - typeScript + type: property syntax: content: 'readonly permissions: SPPermission;' return: - type: '' - - name: serverRelativeUrl - uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' - package: '@microsoft/sp-page-context!' - fullName: serverRelativeUrl + type: + - '@microsoft/sp-page-context!default:class' + - uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' summary: Returns the server-relative URL for this SPWeb. remarks: 'Example: `"/sites/PubSite/SubWeb"`' - - isPreview: false - isDeprecated: false + name: serverRelativeUrl + fullName: serverRelativeUrl + langs: + - typeScript + type: property syntax: content: 'readonly serverRelativeUrl: string;' return: - type: string - - name: templateName - uid: '@microsoft/sp-page-context!SPWeb#templateName:member' - package: '@microsoft/sp-page-context!' - fullName: templateName + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#templateName:member' summary: >- Returns the string representing the numeric identifier for the site definition or site template that was used to create the site. remarks: 'Example: `"1"` represents the team site template when creating a new site on SharePoint.' - - isPreview: false - isDeprecated: false + name: templateName + fullName: templateName + langs: + - typeScript + type: property syntax: content: 'readonly templateName: string;' return: - type: string - - name: timeZoneInfo - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' - package: '@microsoft/sp-page-context!' - fullName: timeZoneInfo + type: + - string + - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo:member' summary: Returns the web's regional timezone settings or undefined if they haven't been set. - remarks: '' - isPreview: true - isDeprecated: false + name: timeZoneInfo + fullName: timeZoneInfo + langs: + - typeScript + type: property syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: ' | undefined' - - name: title - uid: '@microsoft/sp-page-context!SPWeb#title:member' - package: '@microsoft/sp-page-context!' - fullName: title + type: + - '@microsoft/sp-page-context!SPWeb#timeZoneInfo~0:complex' + - uid: '@microsoft/sp-page-context!SPWeb#title:member' summary: Returns the title of the current SPWeb. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'readonly title: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-page-context!SPWeb#firstDayOfWeek~0:complex' + name: SPDayOfWeek | undefined + fullName: SPDayOfWeek | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!SPDayOfWeek:type' + name: SPDayOfWeek + fullName: SPDayOfWeek + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid + - uid: '@microsoft/sp-page-context!default:class' + name: SPPermission + - uid: '@microsoft/sp-page-context!SPWeb#timeZoneInfo~0:complex' + name: SPTimeZone | undefined + fullName: default | undefined + spec.typeScript: + - uid: '@microsoft/sp-page-context!default:class' + name: SPTimeZone + fullName: default + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index 4fb83f74..3bcc9f0d 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -1,433 +1,791 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-property-pane!' -name: '@microsoft/sp-property-pane' -type: package -summary: SharePoint Framework property pane. -enums: - - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' - - '@microsoft/sp-property-pane!ImageFit:enum' - - '@microsoft/sp-property-pane!PopupWindowPosition:enum' - - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' - - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' - - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' - - '@microsoft/sp-property-pane!ThumbnailType:enum' -interfaces: - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' - - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' - - '@microsoft/sp-property-pane!IGuidSet:interface' - - '@microsoft/sp-property-pane!IPopupWindowProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' - - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' - - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneField:interface' - - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' - - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' - - '@microsoft/sp-property-pane!IPropertyPanePage:interface' - - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' - - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' - - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' - - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' - - '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' - - '@microsoft/sp-property-pane!IThumbnailImage:interface' -typeAliases: - - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' - - '@microsoft/sp-property-pane!IThumbnail:type' -functions: - - name: 'PropertyPaneButton(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' - package: '@microsoft/sp-property-pane!' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!' + summary: SharePoint Framework property pane. + remarks: 'Helps create the property pane for the SharePoint components such as web parts, canvas etc.,' + name: '@microsoft/sp-property-pane' + fullName: '@microsoft/sp-property-pane' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-property-pane!IGuidSet:interface' + - '@microsoft/sp-property-pane!ImageFit:enum' + - '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneField:interface' + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-property-pane!IPropertyPanePage:interface' + - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-property-pane!IThumbnail:type' + - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' + - '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' + - '@microsoft/sp-property-pane!IThumbnailImage:interface' + - '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + - '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneIconPicker:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker:function(1)' + - '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' + - '@microsoft/sp-property-pane!ThumbnailType:enum' + - uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' summary: Helper method to create a Button on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneButton(targetProperty, properties)' + fullName: 'PropertyPaneButton(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneButton~0:complex' + description: '' parameters: - id: targetProperty description: Target property the Button is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Button properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneCheckbox(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' summary: Helper method to create a Checkbox on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneCheckbox(targetProperty, properties)' + fullName: 'PropertyPaneCheckbox(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneCheckbox~0:complex' + description: '' parameters: - id: targetProperty description: Target property the checkbox is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Checkbox properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' summary: Helper method to create a Choice Group on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneChoiceGroup~0:complex' + description: '' parameters: - id: targetProperty description: Target property the choice group is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Choice Group properties. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneCustomField(properties) - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField:function(1)' summary: Helper method to create a custom field on the PropertyPane. remarks: >- The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - isPreview: true - isDeprecated: false + name: PropertyPaneCustomField(properties) + fullName: PropertyPaneCustomField(properties) + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneCustomField~0:complex' + description: '' parameters: - id: properties description: Strongly typed Custom field properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDropdown(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' summary: Helper method to create a Dropdown on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneDropdown(targetProperty, properties)' + fullName: 'PropertyPaneDropdown(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDropdown~0:complex' + description: '' parameters: - id: targetProperty description: Target property the dropdown is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Dropdown properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicField(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneDynamicField(targetProperty, properties)' + fullName: 'PropertyPaneDynamicField(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDynamicField~0:complex' + description: '' parameters: - id: targetProperty description: Target property the Dynamic Data widget is associated to. - type: string + type: + - string + optional: false - id: properties description: '' - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneDynamicFieldSet(properties) - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet:function(1)' summary: >- Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source. These fields can possibly share the same property based on the associated filters. - remarks: '' - - isPreview: false - isDeprecated: false + name: PropertyPaneDynamicFieldSet(properties) + fullName: PropertyPaneDynamicFieldSet(properties) + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet~0:complex' + description: '' parameters: - id: properties description: >- Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' summary: Helper method to create a Dynamic TextField on the PropertyPane. - remarks: '' - + deprecated: + content: '- This has been replaced by PropertyPaneDynamicField' isPreview: true - isDeprecated: true - customDeprecatedMessage: '- This has been replaced by PropertyPaneDynamicField' + name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + fullName: 'PropertyPaneDynamicTextField(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneDynamicTextField~0:complex' + description: '' parameters: - id: targetProperty description: Target property the dynamic textfield is associated to. - type: string + type: + - string + optional: false - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneHorizontalRule() - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule:function(1)' summary: Helper method to create a Horizontal Rule on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: PropertyPaneHorizontalRule() + fullName: PropertyPaneHorizontalRule() + langs: + - typeScript + type: function syntax: content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' return: - type: '<void>' + type: + - '@microsoft/sp-property-pane!PropertyPaneHorizontalRule~0:complex' description: '' - - name: 'PropertyPaneIconPicker(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneIconPicker:function(1)' - package: '@microsoft/sp-property-pane!' + - uid: '@microsoft/sp-property-pane!PropertyPaneIconPicker:function(1)' summary: Helper method to create an IconPicker on the PropertyPane. - remarks: '' - isPreview: true - isDeprecated: false + name: 'PropertyPaneIconPicker(targetProperty, properties)' + fullName: 'PropertyPaneIconPicker(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneIconPicker~0:complex' + description: '' parameters: - id: targetProperty description: Target property the icon picker is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed IconPicker properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneLabel(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' summary: Helper method to create a Label on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneLabel(targetProperty, properties)' + fullName: 'PropertyPaneLabel(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneLabel~0:complex' + description: '' parameters: - id: targetProperty description: Target property the label is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Label properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneLink(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' summary: Helper method to create a Link on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneLink(targetProperty, properties)' + fullName: 'PropertyPaneLink(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneLink~0:complex' + description: '' parameters: - id: targetProperty description: Target property the Link is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Link properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneSlider(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' summary: Helper method to create a Slider on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneSlider(targetProperty, properties)' + fullName: 'PropertyPaneSlider(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneSlider~0:complex' + description: '' parameters: - id: targetProperty description: Target property the slider is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Slider properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneTextField(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' summary: Helper method to create a TextField on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneTextField(targetProperty, properties)' + fullName: 'PropertyPaneTextField(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneTextField~0:complex' + description: '' parameters: - id: targetProperty description: Target property the textfield is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed TextField properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneThumbnailPicker(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker:function(1)' summary: Helper method to create a ThumbnailPicker on the PropertyPane. - remarks: '' - isPreview: true - isDeprecated: false + name: 'PropertyPaneThumbnailPicker(targetProperty, properties)' + fullName: 'PropertyPaneThumbnailPicker(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker~0:complex' + description: '' parameters: - id: targetProperty description: Target property the thumbnail picker is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed ThumbnailPicker properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneToggle(targetProperty, properties)' - uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' - package: '@microsoft/sp-property-pane!' + type: + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' + optional: false + - uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' summary: Helper method to create a Toggle on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'PropertyPaneToggle(targetProperty, properties)' + fullName: 'PropertyPaneToggle(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-property-pane!PropertyPaneToggle~0:complex' + description: '' parameters: - id: targetProperty description: Target property the toggle is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Toggle properties. - type: '' - return: - type: >- - <> - description: '' + type: + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + optional: false +references: + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + name: DynamicDataSharedDepth + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-property-pane!IGuidSet:interface' + name: IGuidSet + - uid: '@microsoft/sp-property-pane!ImageFit:enum' + name: ImageFit + - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + name: IPopupWindowProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + name: IPropertyPaneDebounceProperty + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' + name: IPropertyPaneIconPickerProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' + name: IPropertyPaneThumbnailPickerProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + - uid: '@microsoft/sp-property-pane!IThumbnail:type' + name: IThumbnail + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' + name: IThumbnailFabricReactIcon + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' + name: IThumbnailIconSizeImage + - uid: '@microsoft/sp-property-pane!IThumbnailImage:interface' + name: IThumbnailImage + - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + name: PopupWindowPosition + - uid: '@microsoft/sp-property-pane!PropertyPaneButton~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + name: PropertyPaneButtonType + - uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneCustomField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdown~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + name: PropertyPaneDropdownOptionType + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicFieldSet~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + name: PropertyPaneFieldType + - uid: '@microsoft/sp-property-pane!PropertyPaneHorizontalRule~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: + fullName: + - uid: '@microsoft/sp-property-pane!PropertyPaneIconPicker~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' + name: IPropertyPaneIconPickerProps + fullName: IPropertyPaneIconPickerProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneLabel~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneLink~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneSlider~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' + name: IPropertyPaneThumbnailPickerProps + fullName: IPropertyPaneThumbnailPickerProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!PropertyPaneToggle~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-property-pane!ThumbnailType:enum' + name: ThumbnailType diff --git a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml index 977268fc..92cacf04 100644 --- a/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-property-pane/dynamicdatashareddepth.yml @@ -1,26 +1,38 @@ -### YamlMime:TSEnum -name: DynamicDataSharedDepth -uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' -package: '@microsoft/sp-property-pane!' -fullName: DynamicDataSharedDepth -summary: Enum for the possible values of shared depth of the dynamic data reference. -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: None - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + summary: Enum for the possible values of shared depth of the dynamic data reference. + name: DynamicDataSharedDepth + fullName: DynamicDataSharedDepth + langs: + - typeScript + type: enum package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' + - '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' + - '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.None:member' summary: Indicates that nothing is shared. - value: '0' - - name: Property - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' - package: '@microsoft/sp-property-pane!' + name: None + fullName: None + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Property:member' summary: Indicates that both the dynamic data source and the property are shared. - value: '2' - - name: Source - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' - package: '@microsoft/sp-property-pane!' + name: Property + fullName: Property + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth.Source:member' summary: Indicates that the dynamic data source is shared. - value: '1' + name: Source + fullName: Source + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml index 9f1934a9..a168e0b3 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyconfiguration.yml @@ -1,25 +1,27 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyConfiguration -uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedPropertyConfiguration -summary: Configuration related to a shared property. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: filters - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + summary: Configuration related to a shared property. + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: filters + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration#filters:member' summary: Filters for the shared property. - remarks: '' - - isPreview: false - isDeprecated: false + name: filters + fullName: filters + langs: + - typeScript + type: property syntax: content: 'filters?: IDynamicDataSharedPropertyFilters;' return: - type: '' + type: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' +references: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml index 1487dafa..066337f5 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedpropertyfilters.yml @@ -1,19 +1,16 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyFilters -uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedPropertyFilters -summary: Property pane dynamic data property filters. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: propertyId - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + summary: Property pane dynamic data property filters. + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: propertyId + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters#propertyId:member' summary: |- Property Id @@ -26,10 +23,13 @@ properties: When provided, the dynamic data properties dropdown is pre-selected to show the specific property, if avaialble. Otherwise the dropdown will fall back to show all the exposed properties from the source. If a property is pre-selected, the control will be disabled to ensure that authors can not change it. - - isPreview: false - isDeprecated: false + name: propertyId + fullName: propertyId + langs: + - typeScript + type: property syntax: content: 'propertyId?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index 471efee3..45375a47 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -1,41 +1,43 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceConfiguration -uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedSourceConfiguration -summary: Configuration related to a shared source. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: filters - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + summary: Configuration related to a shared source. + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: filters + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#filters:member' summary: Filters for the shared source. - remarks: '' - - isPreview: false - isDeprecated: false + name: filters + fullName: filters + langs: + - typeScript + type: property syntax: content: 'filters?: IDynamicDataSharedSourceFilters;' return: - type: '' - - name: sourcesLabel - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: sourcesLabel + type: + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' summary: |- User-friendly, localized label for the sources dropdown. default value - 'Connect to source' - remarks: '' - - isPreview: false - isDeprecated: false + name: sourcesLabel + fullName: sourcesLabel + langs: + - typeScript + type: property syntax: content: 'sourcesLabel?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index 6e3b0a6f..6bbdb6a7 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -1,19 +1,17 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceFilters -uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' -package: '@microsoft/sp-property-pane!' -fullName: IDynamicDataSharedSourceFilters -summary: Property pane dynamic data source filters. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: componentId - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + summary: Property pane dynamic data source filters. + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: componentId + children: + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' + - '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#componentId:member' summary: |- Component Id. @@ -29,17 +27,17 @@ properties: Example - If the document library web part component id is supplied, then the dynamic data sources dropdown only shows document library web parts on the page which are registered dynamic sources. - - isPreview: false - isDeprecated: false + name: componentId + fullName: componentId + langs: + - typeScript + type: property syntax: content: 'componentId?: Guid;' return: - type: '' - - name: sourceId - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' - package: '@microsoft/sp-property-pane!' - fullName: sourceId + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' summary: |- Source Id @@ -55,10 +53,16 @@ properties: The source id for a web part will be of the form WebPart.. - - isPreview: false - isDeprecated: false + name: sourceId + fullName: sourceId + langs: + - typeScript + type: property syntax: content: 'sourceId?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-core-library!Guid:class' + name: Guid diff --git a/SP-Framework/sp-property-pane/iguidset.yml b/SP-Framework/sp-property-pane/iguidset.yml index 55d52f99..16668f95 100644 --- a/SP-Framework/sp-property-pane/iguidset.yml +++ b/SP-Framework/sp-property-pane/iguidset.yml @@ -1,64 +1,68 @@ -### YamlMime:TSType -name: IGuidSet -uid: '@microsoft/sp-property-pane!IGuidSet:interface' -package: '@microsoft/sp-property-pane!' -fullName: IGuidSet -summary: Set of GUIDs representing a list item. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: listId - uid: '@microsoft/sp-property-pane!IGuidSet#listId:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IGuidSet:interface' + summary: Set of GUIDs representing a list item. + isPreview: true + name: IGuidSet + fullName: IGuidSet + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: listId + children: + - '@microsoft/sp-property-pane!IGuidSet#listId:member' + - '@microsoft/sp-property-pane!IGuidSet#siteId:member' + - '@microsoft/sp-property-pane!IGuidSet#uniqueId:member' + - '@microsoft/sp-property-pane!IGuidSet#webId:member' + - uid: '@microsoft/sp-property-pane!IGuidSet#listId:member' summary: List ID - remarks: '' - isPreview: true - isDeprecated: false + name: listId + fullName: listId + langs: + - typeScript + type: property syntax: content: 'listId: string;' return: - type: string - - name: siteId - uid: '@microsoft/sp-property-pane!IGuidSet#siteId:member' - package: '@microsoft/sp-property-pane!' - fullName: siteId + type: + - string + - uid: '@microsoft/sp-property-pane!IGuidSet#siteId:member' summary: Site ID - remarks: '' - isPreview: true - isDeprecated: false + name: siteId + fullName: siteId + langs: + - typeScript + type: property syntax: content: 'siteId: string;' return: - type: string - - name: uniqueId - uid: '@microsoft/sp-property-pane!IGuidSet#uniqueId:member' - package: '@microsoft/sp-property-pane!' - fullName: uniqueId + type: + - string + - uid: '@microsoft/sp-property-pane!IGuidSet#uniqueId:member' summary: Unique ID within the list - remarks: '' - isPreview: true - isDeprecated: false + name: uniqueId + fullName: uniqueId + langs: + - typeScript + type: property syntax: content: 'uniqueId: string;' return: - type: string - - name: webId - uid: '@microsoft/sp-property-pane!IGuidSet#webId:member' - package: '@microsoft/sp-property-pane!' - fullName: webId + type: + - string + - uid: '@microsoft/sp-property-pane!IGuidSet#webId:member' summary: Web ID - remarks: '' - isPreview: true - isDeprecated: false + name: webId + fullName: webId + langs: + - typeScript + type: property syntax: content: 'webId: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-property-pane/imagefit.yml b/SP-Framework/sp-property-pane/imagefit.yml index 9e3c5f0f..bdf1f892 100644 --- a/SP-Framework/sp-property-pane/imagefit.yml +++ b/SP-Framework/sp-property-pane/imagefit.yml @@ -1,55 +1,86 @@ -### YamlMime:TSEnum -name: ImageFit -uid: '@microsoft/sp-property-pane!ImageFit:enum' -package: '@microsoft/sp-property-pane!' -fullName: ImageFit -summary: The possible methods that can be used to fit the image. -remarks: '' - -isPreview: true -isDeprecated: false -fields: - - name: center - uid: '@microsoft/sp-property-pane!ImageFit.center:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!ImageFit:enum' + summary: The possible methods that can be used to fit the image. + isPreview: true + name: ImageFit + fullName: ImageFit + langs: + - typeScript + type: enum package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!ImageFit.center:member' + - '@microsoft/sp-property-pane!ImageFit.centerContain:member' + - '@microsoft/sp-property-pane!ImageFit.centerCover:member' + - '@microsoft/sp-property-pane!ImageFit.contain:member' + - '@microsoft/sp-property-pane!ImageFit.cover:member' + - '@microsoft/sp-property-pane!ImageFit.none:member' + - uid: '@microsoft/sp-property-pane!ImageFit.center:member' summary: The image is not scaled. The image is centered and cropped within the content box. - value: '0' - - name: centerContain - uid: '@microsoft/sp-property-pane!ImageFit.centerContain:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: center + fullName: center + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!ImageFit.centerContain:member' summary: >- The image will be centered horizontally and vertically within the frame and maintains its aspect ratio. It will behave as ImageFit.center if the image's natural height and width is less than the Image frame's height and width, but if either natural height or width are larger than the frame it will behave as ImageFit.contain. - value: '5' - - name: centerCover - uid: '@microsoft/sp-property-pane!ImageFit.centerCover:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: centerContain + fullName: centerContain + langs: + - typeScript + type: field + numericValue: '5' + - uid: '@microsoft/sp-property-pane!ImageFit.centerCover:member' summary: >- The image will be centered horizontally and vertically within the frame and maintains its aspect ratio. It will behave as ImageFit.center if the image's natural height or width is less than the Image frame's height or width, but if both natural height and width are larger than the frame it will behave as ImageFit.cover. - value: '4' - - name: contain - uid: '@microsoft/sp-property-pane!ImageFit.contain:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: centerCover + fullName: centerCover + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-property-pane!ImageFit.contain:member' summary: >- The image is scaled to maintain its aspect ratio while being fully contained within the frame. The image will be centered horizontally and vertically within the frame. The space in the top and bottom or in the sides of the frame will be empty depending on the difference in aspect ratio between the image and the frame. - value: '1' - - name: cover - uid: '@microsoft/sp-property-pane!ImageFit.cover:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: contain + fullName: contain + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-property-pane!ImageFit.cover:member' summary: >- The image is scaled to maintain its aspect ratio while filling the frame. Portions of the image will be cropped from the top and bottom, or the sides, depending on the difference in aspect ratio between the image and the frame. - value: '2' - - name: none - uid: '@microsoft/sp-property-pane!ImageFit.none:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: cover + fullName: cover + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!ImageFit.none:member' summary: >- Neither the image nor the frame are scaled. If their sizes do not match, the image will either be cropped or the frame will have empty space. - value: '3' + isPreview: true + name: none + fullName: none + langs: + - typeScript + type: field + numericValue: '3' diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index c2d4b542..e2680ac5 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -1,64 +1,66 @@ -### YamlMime:TSType -name: IPopupWindowProps -uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPopupWindowProps -summary: Popup window props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: height - uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + summary: Popup window props. + name: IPopupWindowProps + fullName: IPopupWindowProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: height + children: + - '@microsoft/sp-property-pane!IPopupWindowProps#height:member' + - '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' + - '@microsoft/sp-property-pane!IPopupWindowProps#title:member' + - '@microsoft/sp-property-pane!IPopupWindowProps#width:member' + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#height:member' summary: Height of pop up window. - remarks: '' - - isPreview: false - isDeprecated: false + name: height + fullName: height + langs: + - typeScript + type: property syntax: content: 'height: number;' return: - type: number - - name: positionWindowPosition - uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' - package: '@microsoft/sp-property-pane!' - fullName: positionWindowPosition + type: + - number + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#positionWindowPosition:member' summary: The position of pop up window. - remarks: '' - - isPreview: false - isDeprecated: false + name: positionWindowPosition + fullName: positionWindowPosition + langs: + - typeScript + type: property syntax: content: 'positionWindowPosition: PopupWindowPosition;' return: - type: '' - - name: title - uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' - package: '@microsoft/sp-property-pane!' - fullName: title + type: + - '@microsoft/sp-property-pane!PopupWindowPosition:enum' + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' summary: Title of pop up window. - remarks: '' - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string - - name: width - uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' - package: '@microsoft/sp-property-pane!' - fullName: width + type: + - string + - uid: '@microsoft/sp-property-pane!IPopupWindowProps#width:member' summary: Width of pop up window. - remarks: '' - - isPreview: false - isDeprecated: false + name: width + fullName: width + langs: + - typeScript + type: property syntax: content: 'width: number;' return: - type: number + type: + - number +references: + - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + name: PopupWindowPosition diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index e2dc3b1d..8d825701 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -1,122 +1,124 @@ -### YamlMime:TSType -name: IPropertyPaneButtonProps -uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneButtonProps -summary: PropertyPane button props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaDescription - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + summary: PropertyPane button props. + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: ariaDescription + children: + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' + - '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaDescription:member' summary: |- Detailed description of the button for the benefit of screen readers. Besides the compound button, other button types will need more information provided to screen reader. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaDescription + fullName: ariaDescription + langs: + - typeScript + type: property syntax: content: 'ariaDescription?: string;' return: - type: string - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaLabel + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#ariaLabel:member' summary: The aria label of the button for the benefit of screen readers. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: string;' return: - type: string - - name: buttonType - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' - package: '@microsoft/sp-property-pane!' - fullName: buttonType + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#buttonType:member' summary: The type of button to render. Default value is ButtonType.normal. - remarks: '' - - isPreview: false - isDeprecated: false + name: buttonType + fullName: buttonType + langs: + - typeScript + type: property syntax: content: 'buttonType?: PropertyPaneButtonType;' return: - type: '' - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description + type: + - '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' summary: Description of the action this button takes. Only used for compound buttons. - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#disabled:member' summary: Whether the button is disabled. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: icon - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' - package: '@microsoft/sp-property-pane!' - fullName: icon + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#icon:member' summary: The button icon shown in command or hero type. - remarks: '' - - isPreview: false - isDeprecated: false + name: icon + fullName: icon + langs: + - typeScript + type: property syntax: content: 'icon?: string;' return: - type: string - - name: onClick - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' - package: '@microsoft/sp-property-pane!' - fullName: onClick + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#onClick:member' summary: >- A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props. - remarks: '' - - isPreview: false - isDeprecated: false + name: onClick + fullName: onClick + langs: + - typeScript + type: property syntax: content: 'onClick: (value: any) => any;' return: - type: '(value: any) => any' - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text + type: + - '(value: any) => any' + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#text:member' summary: Display text of the element. - remarks: '' - - isPreview: false - isDeprecated: false + name: text + fullName: text + langs: + - typeScript + type: property syntax: content: 'text: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + name: PropertyPaneButtonType diff --git a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml index d9128e5a..10d3a43f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecheckboxprops.yml @@ -1,51 +1,51 @@ -### YamlMime:TSType -name: IPropertyPaneCheckboxProps -uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneCheckboxProps -summary: PropertyPane CheckBox component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: checked - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + summary: PropertyPane CheckBox component props. + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: checked + children: + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#checked:member' summary: Whether the property pane checkbox is checked or not. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: checked + fullName: checked + langs: + - typeScript + type: property syntax: content: 'checked?: boolean;' return: - type: boolean - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#disabled:member' summary: Whether the property pane checkbox is disabled or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps#text:member' summary: Label to display next to the checkbox. - remarks: '' - - isPreview: false - isDeprecated: false + name: text + fullName: text + langs: + - typeScript + type: property syntax: content: 'text?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index d45f88b7..af6823bc 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -1,79 +1,81 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOption -uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneChoiceGroupOption -summary: PropertyPane ChoiceGroup option props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + summary: PropertyPane ChoiceGroup option props. + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: ariaLabel + children: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#ariaLabel:member' summary: The aria label of the property pane choice group option for the benefit of screen readers. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: string;' return: - type: string - - name: checked - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' - package: '@microsoft/sp-property-pane!' - fullName: checked + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#checked:member' summary: |- Whether the property pane choice group option is checked or not. Default value is false. - remarks: '' - - isPreview: false - isDeprecated: false + name: checked + fullName: checked + langs: + - typeScript + type: property syntax: content: 'checked?: boolean;' return: - type: boolean - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#disabled:member' summary: Whether the property pane choice group option is disabled or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: iconProps - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' - package: '@microsoft/sp-property-pane!' - fullName: iconProps + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#iconProps:member' summary: The Icon component props for choice field. - remarks: '' - - isPreview: false - isDeprecated: false + name: iconProps + fullName: iconProps + langs: + - typeScript + type: property syntax: content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' return: - type: '' - - name: imageSize - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' - package: '@microsoft/sp-property-pane!' - fullName: imageSize + type: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSize:member' summary: The width and height of the image in px for choice field. - remarks: '' - - isPreview: false - isDeprecated: false + name: imageSize + fullName: imageSize + langs: + - typeScript + type: property syntax: content: |- imageSize?: { @@ -81,60 +83,60 @@ properties: height: number; }; return: - type: |- - { - width: number; - height: number; - } - - name: imageSrc - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' - package: '@microsoft/sp-property-pane!' - fullName: imageSrc + type: + - |- + { + width: number; + height: number; + } + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageSrc:member' summary: The src of image for choice field. - remarks: '' - - isPreview: false - isDeprecated: false + name: imageSrc + fullName: imageSrc + langs: + - typeScript + type: property syntax: content: 'imageSrc?: string;' return: - type: string - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#key:member' summary: A required key to uniquely identify the option. - remarks: '' - - isPreview: false - isDeprecated: false + name: key + fullName: key + langs: + - typeScript + type: property syntax: content: 'key: string | number;' return: - type: string | number - - name: selectedImageSrc - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' - package: '@microsoft/sp-property-pane!' - fullName: selectedImageSrc + type: + - string | number + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#selectedImageSrc:member' summary: The src of image for choice field which is selected. - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedImageSrc + fullName: selectedImageSrc + langs: + - typeScript + type: property syntax: content: 'selectedImageSrc?: string;' return: - type: string - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#text:member' summary: The text string for the option. - remarks: '' - - isPreview: false - isDeprecated: false + name: text + fullName: text + langs: + - typeScript + type: property syntax: content: 'text: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml index e5f71b77..e8eafbbb 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoptioniconprops.yml @@ -1,25 +1,24 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOptionIconProps -uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneChoiceGroupOptionIconProps -summary: PropertyPane ChoiceGroup icon props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: officeFabricIconFontName - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + summary: PropertyPane ChoiceGroup icon props. + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: officeFabricIconFontName + children: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps#officeFabricIconFontName:member' summary: The name of the icon to use from the Office Fabric icon set. - remarks: '' - - isPreview: false - isDeprecated: false + name: officeFabricIconFontName + fullName: officeFabricIconFontName + langs: + - typeScript + type: property syntax: content: 'officeFabricIconFontName?: string | null;' return: - type: string | null + type: + - string | null diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index 0a407d31..acd2d54a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -1,38 +1,47 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupProps -uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneChoiceGroupProps -summary: PropertyPane ChoiceGroup props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + summary: PropertyPane ChoiceGroup props. + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: label + children: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#label:member' summary: Descriptive label for the choice group. - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label?: string;' return: - type: string - - name: options - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' - package: '@microsoft/sp-property-pane!' - fullName: options + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options:member' summary: The options for the choice group. - remarks: '' - - isPreview: false - isDeprecated: false + name: options + fullName: options + langs: + - typeScript + type: property syntax: content: 'options: IPropertyPaneChoiceGroupOption[];' return: - type: '[]' + type: + - '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options~0:complex' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps#options~0:complex' + name: 'IPropertyPaneChoiceGroupOption[]' + fullName: 'IPropertyPaneChoiceGroupOption[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index f7ec8cc1..3d926779 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -1,77 +1,79 @@ -### YamlMime:TSType -name: IPropertyPaneConditionalGroup -uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneConditionalGroup -summary: Property pane conditional group. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: onShowPrimaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + summary: Property pane conditional group. + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: onShowPrimaryGroup + children: + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' + - '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowPrimaryGroup:member' summary: Callback when user clicks to show primary group. - remarks: '' - - isPreview: false - isDeprecated: false + name: onShowPrimaryGroup + fullName: onShowPrimaryGroup + langs: + - typeScript + type: property syntax: content: 'onShowPrimaryGroup?: () => void;' return: - type: () => void - - name: onShowSecondaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: onShowSecondaryGroup + type: + - () => void + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#onShowSecondaryGroup:member' summary: Callback when user clicks to show secondary group. - remarks: '' - - isPreview: false - isDeprecated: false + name: onShowSecondaryGroup + fullName: onShowSecondaryGroup + langs: + - typeScript + type: property syntax: content: 'onShowSecondaryGroup?: () => void;' return: - type: () => void - - name: primaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: primaryGroup + type: + - () => void + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#primaryGroup:member' summary: Primary group to show - remarks: '' - - isPreview: false - isDeprecated: false + name: primaryGroup + fullName: primaryGroup + langs: + - typeScript + type: property syntax: content: 'primaryGroup: IPropertyPaneGroup;' return: - type: '' - - name: secondaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: secondaryGroup + type: + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' summary: Secondary group to show - remarks: '' - - isPreview: false - isDeprecated: false + name: secondaryGroup + fullName: secondaryGroup + langs: + - typeScript + type: property syntax: content: 'secondaryGroup: IPropertyPaneGroup;' return: - type: '' - - name: showSecondaryGroup - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' - package: '@microsoft/sp-property-pane!' - fullName: showSecondaryGroup + type: + - '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' summary: Indicating whether the property pane should show primary group or the secondary group. - remarks: '' - - isPreview: false - isDeprecated: false + name: showSecondaryGroup + fullName: showSecondaryGroup + langs: + - typeScript + type: property syntax: content: 'showSecondaryGroup: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index 783a42f1..e529d07f 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -1,88 +1,89 @@ -### YamlMime:TSType -name: IPropertyPaneConfiguration -uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneConfiguration -summary: Web part configuration settings -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: currentPage - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + summary: Web part configuration settings + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: currentPage + children: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableFocusTrap:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#currentPage:member' summary: Page to be displayed on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: currentPage + fullName: currentPage + langs: + - typeScript + type: property syntax: content: 'currentPage?: number;' return: - type: number - - name: debounceProperties - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' - package: '@microsoft/sp-property-pane!' - fullName: debounceProperties + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties:member' summary: List of properties to debounce the `onPropertyPaneFieldChanged` event. remarks: >- If your property pane is reactive, the `onPropertyPaneFieldChanged` event will fire with any change to the web part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the `onPropertyPaneFieldChanged` event for the properties listed; other properties will be unaffected. - isPreview: true - isDeprecated: false + name: debounceProperties + fullName: debounceProperties + langs: + - typeScript + type: property syntax: content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' return: - type: '[]' - - name: disableFocusTrap - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableFocusTrap:member' - package: '@microsoft/sp-property-pane!' - fullName: disableFocusTrap + type: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableFocusTrap:member' summary: Whether to disable trapping focus inside property pane. - remarks: '' - isPreview: true - isDeprecated: false + name: disableFocusTrap + fullName: disableFocusTrap + langs: + - typeScript + type: property syntax: content: 'disableFocusTrap?: boolean;' return: - type: boolean - - name: loadingIndicatorDelayTime - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' - package: '@microsoft/sp-property-pane!' - fullName: loadingIndicatorDelayTime + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' summary: Number of milliseconds to be delayed before the loading indicator is shown on the property pane. remarks: The default value is 500. - - isPreview: false - isDeprecated: false + name: loadingIndicatorDelayTime + fullName: loadingIndicatorDelayTime + langs: + - typeScript + type: property syntax: content: 'loadingIndicatorDelayTime?: number;' return: - type: number - - name: pages - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' - package: '@microsoft/sp-property-pane!' - fullName: pages + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages:member' summary: Total number of pages on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: false + name: pages + fullName: pages + langs: + - typeScript + type: property syntax: content: 'pages: IPropertyPanePage[];' return: - type: '[]' - - name: showLoadingIndicator - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' - package: '@microsoft/sp-property-pane!' - fullName: showLoadingIndicator + type: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' summary: Indicates whether the loading indicator should be displayed on top of the property pane or not. remarks: >- This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay @@ -92,10 +93,32 @@ properties: The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user. - - isPreview: false - isDeprecated: false + name: showLoadingIndicator + fullName: showLoadingIndicator + langs: + - typeScript + type: property syntax: content: 'showLoadingIndicator?: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#debounceProperties~0:complex' + name: 'IPropertyPaneDebounceProperty[]' + fullName: 'IPropertyPaneDebounceProperty[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + name: IPropertyPaneDebounceProperty + fullName: IPropertyPaneDebounceProperty + - name: '[]' + fullName: '[]' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pages~0:complex' + name: 'IPropertyPanePage[]' + fullName: 'IPropertyPanePage[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + fullName: IPropertyPanePage + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml index 067bbf8d..c22de94d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanecustomfieldprops.yml @@ -1,34 +1,33 @@ -### YamlMime:TSType -name: IPropertyPaneCustomFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneCustomFieldProps -summary: PropertyPane CustomPropertyField props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: context - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + summary: PropertyPane CustomPropertyField props. + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: context + children: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#context:member' summary: >- Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information. - remarks: '' - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'context?: any;' return: - type: any - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key + type: + - any + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#key:member' summary: >- An UNIQUE key indicates the identity of this contorl. @@ -40,41 +39,66 @@ properties: For more information, see the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys). - remarks: '' - - isPreview: false - isDeprecated: false + name: key + fullName: key + langs: + - typeScript + type: property syntax: content: 'key: string;' return: - type: string - - name: onDispose - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' - package: '@microsoft/sp-property-pane!' - fullName: onDispose + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose:member' summary: This API is called when the component is unmounted from the host element. - remarks: '' - - isPreview: false - isDeprecated: false + name: onDispose + fullName: onDispose + langs: + - typeScript + type: property syntax: content: 'onDispose?: (domElement: HTMLElement, context?: any) => void;' return: - type: '(domElement: HTMLElement, context?: any) => void' - - name: onRender - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' - package: '@microsoft/sp-property-pane!' - fullName: onRender + type: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender:member' summary: This API will be called once the custom field is mounted on the host element. - remarks: '' - - isPreview: false - isDeprecated: false + name: onRender + fullName: onRender + langs: + - typeScript + type: property syntax: content: >- onRender: (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void; return: - type: >- - (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => - void) => void + type: + - '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender~0:complex' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onDispose~0:complex' + name: '(domElement: HTMLElement, context?: any) => void' + fullName: '(domElement: HTMLElement, context?: any) => void' + spec.typeScript: + - name: '(domElement: ' + fullName: '(domElement: ' + - uid: '!HTMLElement:interface' + name: HTMLElement + fullName: HTMLElement + - name: ', context?: any) => void' + fullName: ', context?: any) => void' + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps#onRender~0:complex' + name: >- + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => + void + fullName: >- + (domElement: HTMLElement, context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => + void + spec.typeScript: + - name: '(domElement: ' + fullName: '(domElement: ' + - uid: '!HTMLElement:interface' + name: HTMLElement + fullName: HTMLElement + - name: ', context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void' + fullName: ', context?: any, changeCallback?: (targetProperty?: string, newValue?: any) => void) => void' diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index 54493568..595ba5a3 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -1,40 +1,43 @@ -### YamlMime:TSType -name: IPropertyPaneDebounceProperty -uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDebounceProperty -summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: debouncePeriod - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' + summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' + isPreview: true + name: IPropertyPaneDebounceProperty + fullName: IPropertyPaneDebounceProperty + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: debouncePeriod + children: + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' + - '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#debouncePeriod:member' summary: >- Number of milliseconds to delay the next `onPropertyPaneFieldChanged` event since the last time the event fired for this property. remarks: The default value is 500. - isPreview: true - isDeprecated: false + name: debouncePeriod + fullName: debouncePeriod + langs: + - typeScript + type: property syntax: content: 'debouncePeriod?: number;' return: - type: number - - name: propertyName - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' - package: '@microsoft/sp-property-pane!' - fullName: propertyName + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty#propertyName:member' summary: Property to debounce. - remarks: '' - isPreview: true - isDeprecated: false + name: propertyName + fullName: propertyName + langs: + - typeScript + type: property syntax: content: 'propertyName: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml index 2db0cbbc..fc142f0d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdowncalloutprops.yml @@ -1,25 +1,24 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownCalloutProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDropdownCalloutProps -summary: PropertyPane dropdown callout properties. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: calloutMaxHeight - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + summary: PropertyPane dropdown callout properties. + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: calloutMaxHeight + children: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps#calloutMaxHeight:member' summary: Set max height of callout When not set the callout will expand with contents up to the bottom of the screen - remarks: '' - - isPreview: false - isDeprecated: false + name: calloutMaxHeight + fullName: calloutMaxHeight + langs: + - typeScript + type: property syntax: content: 'calloutMaxHeight?: number;' return: - type: number + type: + - number diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index c8d4154a..0ed49e01 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -1,64 +1,66 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownOption -uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDropdownOption -summary: PropertyPane drop down options. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: index - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + summary: PropertyPane drop down options. + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: index + children: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#index:member' summary: Index for this option. - remarks: '' - - isPreview: false - isDeprecated: false + name: index + fullName: index + langs: + - typeScript + type: property syntax: content: 'index?: number;' return: - type: number - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#key:member' summary: A key to uniquely identify this option. - remarks: '' - - isPreview: false - isDeprecated: false + name: key + fullName: key + langs: + - typeScript + type: property syntax: content: 'key: string | number;' return: - type: string | number - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text + type: + - string | number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#text:member' summary: Text to render for this option. - remarks: '' - - isPreview: false - isDeprecated: false + name: text + fullName: text + langs: + - typeScript + type: property syntax: content: 'text: string;' return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type?: PropertyPaneDropdownOptionType;' return: - type: '' + type: + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' +references: + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + name: PropertyPaneDropdownOptionType diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index f1ce19ff..670dc03a 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -1,131 +1,143 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDropdownProps -summary: PropertyPane drop down component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + summary: PropertyPane drop down component props. + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: ariaLabel + children: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaLabel:member' summary: A description of the dropdown for the benefit of screen reader users. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: string;' return: - type: string - - name: ariaPositionInSet - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaPositionInSet + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaPositionInSet:member' summary: >- Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaPositionInSet + fullName: ariaPositionInSet + langs: + - typeScript + type: property syntax: content: 'ariaPositionInSet?: number;' return: - type: number - - name: ariaSetSize - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' - package: '@microsoft/sp-property-pane!' - fullName: ariaSetSize + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#ariaSetSize:member' summary: Defines the number of items in the current set of controls. Maps to native aria-setsize attribute. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaSetSize + fullName: ariaSetSize + langs: + - typeScript + type: property syntax: content: 'ariaSetSize?: number;' return: - type: number - - name: calloutProps - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' - package: '@microsoft/sp-property-pane!' - fullName: calloutProps + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#calloutProps:member' summary: Custom properties for Dropdown's Callout used to render options. - remarks: '' - - isPreview: false - isDeprecated: false + name: calloutProps + fullName: calloutProps + langs: + - typeScript + type: property syntax: content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' return: - type: '' - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' summary: Whether the property pane dropdown option is disabled or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: errorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: errorMessage + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' summary: 'If set, this will be displayed as an error message.' - remarks: '' - isPreview: true - isDeprecated: false + name: errorMessage + fullName: errorMessage + langs: + - typeScript + type: property syntax: content: 'errorMessage?: string;' return: - type: string - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#label:member' summary: Descriptive label for the Dropdown. - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label: string;' return: - type: string - - name: options - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' - package: '@microsoft/sp-property-pane!' - fullName: options + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options:member' summary: Collection of options for this Dropdown. - remarks: '' - - isPreview: false - isDeprecated: false + name: options + fullName: options + langs: + - typeScript + type: property syntax: content: 'options?: IPropertyPaneDropdownOption[];' return: - type: '[]' - - name: selectedKey - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' - package: '@microsoft/sp-property-pane!' - fullName: selectedKey + type: + - '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' summary: The key of the initially selected option. - remarks: '' - - isPreview: false - isDeprecated: false + name: selectedKey + fullName: selectedKey + langs: + - typeScript + type: property syntax: content: 'selectedKey?: string | number;' return: - type: string | number + type: + - string | number +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#options~0:complex' + name: 'IPropertyPaneDropdownOption[]' + fullName: 'IPropertyPaneDropdownOption[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml index befafec8..bf5a2173 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml @@ -1,13 +1,30 @@ -### YamlMime:TSTypeAlias -name: IPropertyPaneDynamicFieldFilters -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicFieldFilters -summary: Property pane dynamic field filters which is an intersection of both source and property filters. -remarks: '' - -isPreview: false -isDeprecated: false -syntax: >- - export declare type IPropertyPaneDynamicFieldFilters = IDynamicDataSharedSourceFilters & - IDynamicDataSharedPropertyFilters; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + summary: Property pane dynamic field filters which is an intersection of both source and property filters. + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters + langs: + - typeScript + type: typealias + syntax: + content: >- + export declare type IPropertyPaneDynamicFieldFilters = IDynamicDataSharedSourceFilters & + IDynamicDataSharedPropertyFilters; + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters~0:complex' + package: '@microsoft/sp-property-pane!' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters~0:complex' + name: IDynamicDataSharedSourceFilters & IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedSourceFilters & IDynamicDataSharedPropertyFilters + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + - name: ' & ' + fullName: ' & ' + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index 30c5b877..fa38bd1d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -1,45 +1,43 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicFieldProps -summary: PropertyPaneDynamicField props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: filters - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + summary: PropertyPaneDynamicField props. + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: filters + children: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#filters:member' summary: Filters for the property pane dynamic field. - remarks: '' - - isPreview: false - isDeprecated: false + name: filters + fullName: filters + langs: + - typeScript + type: property syntax: content: 'filters?: IPropertyPaneDynamicFieldFilters;' return: - type: '' - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' summary: 'User-friendly, localized label to identify the field.' - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label: string;' return: - type: string - - name: propertyValueDepth - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' - package: '@microsoft/sp-property-pane!' - fullName: propertyValueDepth + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#propertyValueDepth:member' summary: |- Indicates to what depth of property values are shown on the property pane dynamic data widget. @@ -50,26 +48,31 @@ properties: the widget will display one level after the source and property for this field. - 2: Indicates that a depth of two levels of property value will be shown i.e., the widget will display two levels after the source and property for this field. - - isPreview: false - isDeprecated: false + name: propertyValueDepth + fullName: propertyValueDepth + langs: + - typeScript + type: property syntax: content: 'propertyValueDepth?: number;' return: - type: number - - name: sourcesLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: sourcesLabel + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#sourcesLabel:member' summary: |- User-friendly, localized label for the sources dropdown. default value - 'Connect to source' - remarks: '' - - isPreview: false - isDeprecated: false + name: sourcesLabel + fullName: sourcesLabel + langs: + - typeScript + type: property syntax: content: 'sourcesLabel?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 307f3001..7d1e0737 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -1,52 +1,48 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldSetProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicFieldSetProps -summary: PropertyPane DynamicFieldSet props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: fields - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + summary: PropertyPane DynamicFieldSet props. + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: fields + children: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields:member' summary: List of property pane dynamic fields to be configured on the Dynamic Data Widget. - remarks: '' - - isPreview: false - isDeprecated: false + name: fields + fullName: fields + langs: + - typeScript + type: property syntax: content: 'fields: IPropertyPaneField[];' return: - type: >- - <>[] - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' summary: 'User-friendly, localized label to identify the property.' - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label: string;' return: - type: string - - name: sharedConfiguration - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' - package: '@microsoft/sp-property-pane!' - fullName: sharedConfiguration + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration:member' summary: Configuration shared between all the entries of the set. - remarks: '' - - isPreview: false - isDeprecated: false + name: sharedConfiguration + fullName: sharedConfiguration + langs: + - typeScript + type: property syntax: content: |- sharedConfiguration?: { @@ -55,9 +51,67 @@ properties: property?: IDynamicDataSharedPropertyConfiguration; }; return: - type: |- + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration~0:complex' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#fields~0:complex' + name: 'IPropertyPaneField[]' + fullName: 'IPropertyPaneField[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - name: '>[]' + fullName: '>[]' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#sharedConfiguration~0:complex' + name: |- + { + depth: DynamicDataSharedDepth; + source?: IDynamicDataSharedSourceConfiguration; + property?: IDynamicDataSharedPropertyConfiguration; + } + fullName: |- + { + depth: DynamicDataSharedDepth; + source?: IDynamicDataSharedSourceConfiguration; + property?: IDynamicDataSharedPropertyConfiguration; + } + spec.typeScript: + - name: |- { - depth: ; - source?: ; - property?: ; + depth: + fullName: |- + { + depth: + - uid: '@microsoft/sp-property-pane!DynamicDataSharedDepth:enum' + name: DynamicDataSharedDepth + fullName: DynamicDataSharedDepth + - name: |- + ; + source?: + fullName: |- + ; + source?: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + - name: |- + ; + property?: + fullName: |- + ; + property?: + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + - name: |- + ; + } + fullName: |- + ; } diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 7da99657..31b12ecb 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -1,59 +1,67 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicTextFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneDynamicTextFieldProps -summary: '`PropertyPaneDynamicData` component props.' -remarks: '' - -isPreview: true -isDeprecated: true -customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + summary: '`PropertyPaneDynamicData` component props.' + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' + isPreview: true + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: ariaLabel + children: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' summary: 'ARIA Label for text field, if any.' - remarks: '' - isPreview: true - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: string;' return: - type: string - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#description:member' summary: The text field input description. - remarks: '' - isPreview: true - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#disabled:member' summary: Whether the property pane text field is enabled or not. - remarks: '' - isPreview: true - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: errorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: errorMessage + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' summary: 'If set, this will be displayed as an error message.' remarks: >- When `onGetErrorMessage` returns empty string, if this property has a value set then this will be displayed as the @@ -61,30 +69,31 @@ properties: Make sure to set this only if you want to see an error message displayed for the text field. - isPreview: true - isDeprecated: false + name: errorMessage + fullName: errorMessage + langs: + - typeScript + type: property syntax: content: 'errorMessage?: string;' return: - type: string - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#label:member' summary: Label for the text field. - remarks: '' - isPreview: true - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label?: string;' return: - type: string - - name: onGetErrorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: onGetErrorMessage + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage:member' summary: This method is used to get the validation error message and determine whether the input value is valid or not. remarks: |- When it returns string: @@ -98,64 +107,82 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - isPreview: true - isDeprecated: false + name: onGetErrorMessage + fullName: onGetErrorMessage + langs: + - typeScript + type: property syntax: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: - type: '(value: string) => string | Promise<string>' - - name: placeholder - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' - package: '@microsoft/sp-property-pane!' - fullName: placeholder + type: + - '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#placeholder:member' summary: Placeholder text to be displayed in the text field. - remarks: '' - isPreview: true - isDeprecated: false + name: placeholder + fullName: placeholder + langs: + - typeScript + type: property syntax: content: 'placeholder?: string;' return: - type: string - - name: validateOnFocusIn - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusIn + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusIn:member' summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - isPreview: true - isDeprecated: false + name: validateOnFocusIn + fullName: validateOnFocusIn + langs: + - typeScript + type: property syntax: content: 'validateOnFocusIn?: boolean;' return: - type: boolean - - name: validateOnFocusOut - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusOut + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#validateOnFocusOut:member' summary: Run validation when the `PropertyPaneTextField` is out of focus or on blur. remarks: The default value is false. - isPreview: true - isDeprecated: false + name: validateOnFocusOut + fullName: validateOnFocusOut + langs: + - typeScript + type: property syntax: content: 'validateOnFocusOut?: boolean;' return: - type: boolean - - name: value - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' - package: '@microsoft/sp-property-pane!' - fullName: value + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#value:member' summary: >- Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. - remarks: '' - isPreview: true - isDeprecated: false + name: value + fullName: value + langs: + - typeScript + type: property syntax: content: 'value?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#onGetErrorMessage~0:complex' + name: '(value: string) => string | Promise' + fullName: '(value: string) => string | Promise' + spec.typeScript: + - name: '(value: string) => string | ' + fullName: '(value: string) => string | ' + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 15f655a2..4ff2ea23 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -1,64 +1,71 @@ -### YamlMime:TSType -name: IPropertyPaneField -uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneField -summary: PropertyPane field. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: properties - uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + summary: PropertyPane field. + name: IPropertyPaneField + fullName: IPropertyPaneField + langs: + - typeScript + type: interface + syntax: + typeParameters: + - id: TProperties package: '@microsoft/sp-property-pane!' - fullName: properties + children: + - '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' + - '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' + - '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' + - '@microsoft/sp-property-pane!IPropertyPaneField#type:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#properties:member' summary: Strongly typed properties object. Specific to each field type. remarks: 'Example: Checkbox has ICheckboxProps, TextField has ITextField props.' - - isPreview: false - isDeprecated: false + name: properties + fullName: properties + langs: + - typeScript + type: property syntax: content: 'properties: TProperties;' return: - type: TProperties - - name: shouldFocus - uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' - package: '@microsoft/sp-property-pane!' - fullName: shouldFocus + type: + - TProperties + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#shouldFocus:member' summary: Whether this control should be focused. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: shouldFocus + fullName: shouldFocus + langs: + - typeScript + type: property syntax: content: 'shouldFocus?: boolean;' return: - type: boolean - - name: targetProperty - uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' - package: '@microsoft/sp-property-pane!' - fullName: targetProperty + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#targetProperty:member' summary: Target property from the web part's property bag. - remarks: '' - - isPreview: false - isDeprecated: false + name: targetProperty + fullName: targetProperty + langs: + - typeScript + type: property syntax: content: 'targetProperty: string;' return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneField#type:member' summary: Type of the PropertyPane field. - remarks: '' - - isPreview: false - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: PropertyPaneFieldType;' return: - type: '' + type: + - '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' +references: + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + name: PropertyPaneFieldType diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index c2b495d1..440c85de 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -1,68 +1,80 @@ -### YamlMime:TSType -name: IPropertyPaneGroup -uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneGroup -summary: PropertyPane group. Group is part of the PropertyPanePage. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: groupFields - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + summary: PropertyPane group. Group is part of the PropertyPanePage. + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: groupFields + children: + - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' + - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' + - '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' + - '@microsoft/sp-property-pane!IPropertyPaneGroup#isGroupNameHidden:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields:member' summary: List of PropertyPane fields. - remarks: '' - - isPreview: false - isDeprecated: false + name: groupFields + fullName: groupFields + langs: + - typeScript + type: property syntax: content: 'groupFields: IPropertyPaneField[];' return: - type: '<any>[]' - - name: groupName - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' - package: '@microsoft/sp-property-pane!' - fullName: groupName + type: + - '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' summary: Display name for the group. remarks: >- For performance reasons, it's highly recommended to keep this name unique within the property pane page. If left empty, the group header will not render (not recommended for accordions). - - isPreview: false - isDeprecated: false + name: groupName + fullName: groupName + langs: + - typeScript + type: property syntax: content: 'groupName?: string;' return: - type: string - - name: isCollapsed - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' - package: '@microsoft/sp-property-pane!' - fullName: isCollapsed + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isCollapsed:member' summary: Indicates whether the PropertyPane group is collapsed or not. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: isCollapsed + fullName: isCollapsed + langs: + - typeScript + type: property syntax: content: 'isCollapsed?: boolean;' return: - type: boolean - - name: isGroupNameHidden - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isGroupNameHidden:member' - package: '@microsoft/sp-property-pane!' - fullName: isGroupNameHidden + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#isGroupNameHidden:member' summary: Indicates whether group name should be hidden. remarks: >- The default value is false. Use this option to skip the rendering of group name to avoid empty group header being displayed. - - isPreview: false - isDeprecated: false + name: isGroupNameHidden + fullName: isGroupNameHidden + langs: + - typeScript + type: property syntax: content: 'isGroupNameHidden?: boolean;' return: - type: boolean + type: + - boolean +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupFields~0:complex' + name: 'IPropertyPaneField[]' + fullName: 'IPropertyPaneField[]' + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: '[]' + fullName: '[]' diff --git a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml index 926012a9..954491b9 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -1,144 +1,171 @@ -### YamlMime:TSType -name: IPropertyPaneIconPickerProps -uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneIconPickerProps -summary: PropertyPaneIconPicker component props -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: callerName - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#callerName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps:interface' + summary: PropertyPaneIconPicker component props + isPreview: true + name: IPropertyPaneIconPickerProps + fullName: IPropertyPaneIconPickerProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: callerName + children: + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#callerName:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customIconSet:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customSelectedIconName:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemChanged:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemDeleted:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewFullWidth:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewGrayBackground:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnail:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererIconClassName:member' + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererWrapperClassName:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#callerName:member' summary: Optional name of consuming component for telemetry purposes. - remarks: '' - isPreview: true - isDeprecated: false + name: callerName + fullName: callerName + langs: + - typeScript + type: property syntax: content: 'callerName?: string;' return: - type: string - - name: customIconSet - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customIconSet:member' - package: '@microsoft/sp-property-pane!' - fullName: customIconSet + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customIconSet:member' summary: >- The icon picker allows selection of Fabric MDL2 icons. This optional parameter allows the caller to override this with a custom selection of icons. - remarks: '' - isPreview: true - isDeprecated: false + name: customIconSet + fullName: customIconSet + langs: + - typeScript + type: property syntax: content: 'customIconSet?: Map;' return: - type: 'Map<string, >' - - name: customSelectedIconName - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customSelectedIconName:member' - package: '@microsoft/sp-property-pane!' - fullName: customSelectedIconName + type: + - '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customIconSet~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customSelectedIconName:member' summary: 'When invoking with a custom icon set, this is the name of the currently selected icon.' - remarks: '' - isPreview: true - isDeprecated: false + name: customSelectedIconName + fullName: customSelectedIconName + langs: + - typeScript + type: property syntax: content: 'customSelectedIconName?: string;' return: - type: string - - name: onItemChanged - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemChanged:member' - package: '@microsoft/sp-property-pane!' - fullName: onItemChanged + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemChanged:member' summary: Callback function for when an icon is selected. - remarks: '' - isPreview: true - isDeprecated: false + name: onItemChanged + fullName: onItemChanged + langs: + - typeScript + type: property syntax: content: 'onItemChanged?: (iconName: string) => void;' return: - type: '(iconName: string) => void' - - name: onItemDeleted - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemDeleted:member' - package: '@microsoft/sp-property-pane!' - fullName: onItemDeleted + type: + - '(iconName: string) => void' + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemDeleted:member' summary: Callback function for when the Delete button is clicked. - remarks: '' - isPreview: true - isDeprecated: false + name: onItemDeleted + fullName: onItemDeleted + langs: + - typeScript + type: property syntax: content: 'onItemDeleted?: () => void;' return: - type: () => void - - name: previewFullWidth - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewFullWidth:member' - package: '@microsoft/sp-property-pane!' - fullName: previewFullWidth + type: + - () => void + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewFullWidth:member' summary: Whether to render the icon preview with full width or the default fixed aspect ratio. - remarks: '' - isPreview: true - isDeprecated: false + name: previewFullWidth + fullName: previewFullWidth + langs: + - typeScript + type: property syntax: content: 'previewFullWidth?: boolean;' return: - type: boolean - - name: previewGrayBackground - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewGrayBackground:member' - package: '@microsoft/sp-property-pane!' - fullName: previewGrayBackground + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewGrayBackground:member' summary: Whether to render the icon with a gray background. - remarks: '' - isPreview: true - isDeprecated: false + name: previewGrayBackground + fullName: previewGrayBackground + langs: + - typeScript + type: property syntax: content: 'previewGrayBackground?: boolean;' return: - type: boolean - - name: thumbnail - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnail:member' - package: '@microsoft/sp-property-pane!' - fullName: thumbnail + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnail:member' summary: Thumbnail metadata of the currently selected icon. - remarks: '' - isPreview: true - isDeprecated: false + name: thumbnail + fullName: thumbnail + langs: + - typeScript + type: property syntax: content: 'thumbnail?: IThumbnail;' return: - type: '' - - name: thumbnailRendererIconClassName - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererIconClassName:member' - package: '@microsoft/sp-property-pane!' - fullName: thumbnailRendererIconClassName + type: + - '@microsoft/sp-property-pane!IThumbnail:type' + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererIconClassName:member' summary: Optional CSS class name to apply to the icon preview. - remarks: '' - isPreview: true - isDeprecated: false + name: thumbnailRendererIconClassName + fullName: thumbnailRendererIconClassName + langs: + - typeScript + type: property syntax: content: 'thumbnailRendererIconClassName?: string;' return: - type: string - - name: thumbnailRendererWrapperClassName - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererWrapperClassName:member' - package: '@microsoft/sp-property-pane!' - fullName: thumbnailRendererWrapperClassName + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererWrapperClassName:member' summary: Optional CSS class name to apply to the icon preview wrapper. - remarks: '' - isPreview: true - isDeprecated: false + name: thumbnailRendererWrapperClassName + fullName: thumbnailRendererWrapperClassName + langs: + - typeScript + type: property syntax: content: 'thumbnailRendererWrapperClassName?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customIconSet~0:complex' + name: 'Map' + fullName: 'Map' + spec.typeScript: + - uid: '!Map:interface' + name: Map + fullName: Map + - name: '' + fullName: '>' + - uid: '@microsoft/sp-property-pane!IThumbnail:type' + name: IThumbnail diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index 640a3b8f..16817056 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -1,38 +1,38 @@ -### YamlMime:TSType -name: IPropertyPaneLabelProps -uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneLabelProps -summary: PropertyPaneLabel component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: required - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + summary: PropertyPaneLabel component props. + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: required + children: + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' + - '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#required:member' summary: Whether the associated form field is required or not. remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' - - isPreview: false - isDeprecated: false + name: required + fullName: required + langs: + - typeScript + type: property syntax: content: 'required?: boolean;' return: - type: boolean - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps#text:member' summary: Display text fot the label. - remarks: '' - - isPreview: false - isDeprecated: false + name: text + fullName: text + langs: + - typeScript + type: property syntax: content: 'text: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 36cebdab..2115b190 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -1,58 +1,56 @@ -### YamlMime:TSType -name: IPropertyPaneLinkProps -uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneLinkProps -summary: PropertyPaneLink component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + summary: PropertyPaneLink component props. + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: disabled + children: + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' + - '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#disabled:member' summary: Whether the property pane link is disabled or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: href - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' - package: '@microsoft/sp-property-pane!' - fullName: href + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#href:member' summary: Location to which the link is targeted to. - remarks: '' - - isPreview: false - isDeprecated: false + name: href + fullName: href + langs: + - typeScript + type: property syntax: content: 'href: string;' return: - type: string - - name: popupWindowProps - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' - package: '@microsoft/sp-property-pane!' - fullName: popupWindowProps + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#popupWindowProps:member' summary: The props of pop up window. - remarks: '' - - isPreview: false - isDeprecated: false + name: popupWindowProps + fullName: popupWindowProps + langs: + - typeScript + type: property syntax: content: 'popupWindowProps?: IPopupWindowProps;' return: - type: '' - - name: target - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' - package: '@microsoft/sp-property-pane!' - fullName: target + type: + - '@microsoft/sp-property-pane!IPopupWindowProps:interface' + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' summary: This attribute specifies where to display the linked resource. remarks: >- Following values can be used: @@ -69,23 +67,28 @@ properties: \_top - Load the response into the original window. - - isPreview: false - isDeprecated: false + name: target + fullName: target + langs: + - typeScript + type: property syntax: content: 'target?: string;' return: - type: string - - name: text - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' - package: '@microsoft/sp-property-pane!' - fullName: text + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#text:member' summary: Display text for the link. - remarks: '' - - isPreview: false - isDeprecated: false + name: text + fullName: text + langs: + - typeScript + type: property syntax: content: 'text: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPopupWindowProps:interface' + name: IPopupWindowProps diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index acca1669..6ba4ef12 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -1,53 +1,69 @@ -### YamlMime:TSType -name: IPropertyPanePage -uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPanePage -summary: PropertyPanePage interface. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: displayGroupsAsAccordion - uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + summary: PropertyPanePage interface. + name: IPropertyPanePage + fullName: IPropertyPanePage + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: displayGroupsAsAccordion + children: + - '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' + - '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' + - '@microsoft/sp-property-pane!IPropertyPanePage#header:member' + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#displayGroupsAsAccordion:member' summary: Indicates whether the groups on the PropertyPanePage are displayed as accordion or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: displayGroupsAsAccordion + fullName: displayGroupsAsAccordion + langs: + - typeScript + type: property syntax: content: 'displayGroupsAsAccordion?: boolean;' return: - type: boolean - - name: groups - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' - package: '@microsoft/sp-property-pane!' - fullName: groups + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups:member' summary: List of groups to be displayed on the PropertyPane page. - remarks: '' - - isPreview: false - isDeprecated: false + name: groups + fullName: groups + langs: + - typeScript + type: property syntax: content: 'groups: (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[];' return: - type: >- - ( | )[] - - name: header - uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' - package: '@microsoft/sp-property-pane!' - fullName: header + type: + - '@microsoft/sp-property-pane!IPropertyPanePage#groups~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#header:member' summary: PropertyPane page header. - remarks: '' - - isPreview: false - isDeprecated: false + name: header + fullName: header + langs: + - typeScript + type: property syntax: content: 'header?: IPropertyPanePageHeader;' return: - type: '' + type: + - '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' +references: + - uid: '@microsoft/sp-property-pane!IPropertyPanePage#groups~0:complex' + name: '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' + fullName: '(IPropertyPaneGroup | IPropertyPaneConditionalGroup)[]' + spec.typeScript: + - name: ( + fullName: ( + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + - name: ')[]' + fullName: ')[]' + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader diff --git a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml index b2c1f373..333a240e 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepageheader.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -1,39 +1,39 @@ -### YamlMime:TSType -name: IPropertyPanePageHeader -uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPanePageHeader -summary: PropertyPane header. This header remains same for all the pages. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + summary: PropertyPane header. This header remains same for all the pages. + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: description + children: + - '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' + - '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#description:member' summary: Header to display. - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description: string;' return: - type: string - - name: image - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' - package: '@microsoft/sp-property-pane!' - fullName: image + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader#image:member' summary: Image url for the background image. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: This property is not used. + deprecated: + content: This property is not used. + name: image + fullName: image + langs: + - typeScript + type: property syntax: content: 'image?: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index c7826e7f..5b79e72f 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -1,126 +1,124 @@ -### YamlMime:TSType -name: IPropertyPaneSliderProps -uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneSliderProps -summary: PropertyPaneSliderProps component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + summary: PropertyPaneSliderProps component props. + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: ariaLabel + children: + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' + - '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#ariaLabel:member' summary: A description of the Slider for the benefit of screen readers. - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: string;' return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#disabled:member' summary: Whether or not the Slider is disabled. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#label:member' summary: Description label of the Slider. - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label?: string;' return: - type: string - - name: max - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' - package: '@microsoft/sp-property-pane!' - fullName: max + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#max:member' summary: The max value of the Slider. - remarks: '' - - isPreview: false - isDeprecated: false + name: max + fullName: max + langs: + - typeScript + type: property syntax: content: 'max: number;' return: - type: number - - name: min - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' - package: '@microsoft/sp-property-pane!' - fullName: min + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#min:member' summary: The min value of the Slider. - remarks: '' - - isPreview: false - isDeprecated: false + name: min + fullName: min + langs: + - typeScript + type: property syntax: content: 'min: number;' return: - type: number - - name: showValue - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' - package: '@microsoft/sp-property-pane!' - fullName: showValue + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#showValue:member' summary: Whether to show the value on the right of the Slider. remarks: 'If you want to show the value by yourself, you may want to set this value to false.' - - isPreview: false - isDeprecated: false + name: showValue + fullName: showValue + langs: + - typeScript + type: property syntax: content: 'showValue?: boolean;' return: - type: boolean - - name: step - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' - package: '@microsoft/sp-property-pane!' - fullName: step + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#step:member' summary: The difference between the two adjacent values of the Slider. Defaults to 1. - remarks: '' - - isPreview: false - isDeprecated: false + name: step + fullName: step + langs: + - typeScript + type: property syntax: content: 'step?: number;' return: - type: number - - name: value - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' - package: '@microsoft/sp-property-pane!' - fullName: value + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#value:member' summary: |- The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. Defaults to min. - remarks: '' - - isPreview: false - isDeprecated: false + name: value + fullName: value + langs: + - typeScript + type: property syntax: content: 'value?: number;' return: - type: number - - name: valueFormat - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' - package: '@microsoft/sp-property-pane!' - fullName: valueFormat + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps#valueFormat:member' summary: |- Callback to format the Slider value. For example, if @@ -128,11 +126,14 @@ properties: (value) => `${value}%` ``` is specified, the value of the Slider has % after it. - remarks: '' - isPreview: true - isDeprecated: false + name: valueFormat + fullName: valueFormat + langs: + - typeScript + type: property syntax: content: 'valueFormat?: (value: number) => string;' return: - type: '(value: number) => string' + type: + - '(value: number) => string' diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index 9317b875..cf4d64b9 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -1,71 +1,81 @@ -### YamlMime:TSType -name: IPropertyPaneTextFieldProps -uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneTextFieldProps -summary: PropertyPaneTextField component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: ariaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + summary: PropertyPaneTextField component props. + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: ariaLabel + children: + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' summary: 'Aria Label for text field, if any.' - remarks: '' - - isPreview: false - isDeprecated: false + name: ariaLabel + fullName: ariaLabel + langs: + - typeScript + type: property syntax: content: 'ariaLabel?: string;' return: - type: string - - name: deferredValidationTime - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' - package: '@microsoft/sp-property-pane!' - fullName: deferredValidationTime + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#deferredValidationTime:member' summary: Text field will start to validate after users stop typing for `deferredValidationTime` milliseconds. remarks: The default value is 200. - - isPreview: false - isDeprecated: false + name: deferredValidationTime + fullName: deferredValidationTime + langs: + - typeScript + type: property syntax: content: 'deferredValidationTime?: number;' return: - type: number - - name: description - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' - package: '@microsoft/sp-property-pane!' - fullName: description + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#description:member' summary: The text field input description. - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#disabled:member' summary: Whether the property pane text field is enabled or not. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: errorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: errorMessage + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' summary: 'If set, this will be displayed as an error message.' remarks: >- When onGetErrorMessage returns empty string, if this property has a value set then this will be displayed as the @@ -73,30 +83,29 @@ properties: So, make sure to set this only if you want to see an error message displayed for the text field. - - isPreview: false - isDeprecated: false + name: errorMessage + fullName: errorMessage + langs: + - typeScript + type: property syntax: content: 'errorMessage?: string;' return: - type: string - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#label:member' summary: Label for the text field. - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label?: string;' return: - type: string - - name: logName - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' - package: '@microsoft/sp-property-pane!' - fullName: logName + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#logName:member' summary: Name used to log `PropertyPaneTextField` value changes for engagement tracking. remarks: >- The messages will be logged with a format such as `.`. @@ -119,9 +128,11 @@ properties: 2. The text length after each edit - - isPreview: false - isDeprecated: false + name: logName + fullName: logName + langs: + - typeScript + type: property syntax: content: |- logName?: { @@ -129,41 +140,39 @@ properties: controlName: string; }; return: - type: |- - { - moduleName: string; - controlName: string; - } - - name: maxLength - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' - package: '@microsoft/sp-property-pane!' - fullName: maxLength + type: + - |- + { + moduleName: string; + controlName: string; + } + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#maxLength:member' summary: Maximum number of characters that the PropertyPaneTextField can have. remarks: 'If the value is set to a negative number, an exception will be thrown.' - - isPreview: false - isDeprecated: false + name: maxLength + fullName: maxLength + langs: + - typeScript + type: property syntax: content: 'maxLength?: number;' return: - type: number - - name: multiline - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' - package: '@microsoft/sp-property-pane!' - fullName: multiline + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#multiline:member' summary: Whether or not the text field is a multiline text field. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: multiline + fullName: multiline + langs: + - typeScript + type: property syntax: content: 'multiline?: boolean;' return: - type: boolean - - name: onGetErrorMessage - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' - package: '@microsoft/sp-property-pane!' - fullName: onGetErrorMessage + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage:member' summary: The method is used to get the validation error message and determine whether the input value is valid or not. remarks: |- When it returns string: @@ -177,103 +186,116 @@ properties: - The resolved value is display as error message. - The rejected, the value is thrown away. - - isPreview: false - isDeprecated: false + name: onGetErrorMessage + fullName: onGetErrorMessage + langs: + - typeScript + type: property syntax: content: 'onGetErrorMessage?: (value: string) => string | Promise;' return: - type: '(value: string) => string | Promise<string>' - - name: placeholder - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' - package: '@microsoft/sp-property-pane!' - fullName: placeholder + type: + - '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#placeholder:member' summary: placeholder text to be displayed in the text field. - remarks: '' - - isPreview: false - isDeprecated: false + name: placeholder + fullName: placeholder + langs: + - typeScript + type: property syntax: content: 'placeholder?: string;' return: - type: string - - name: resizable - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' - package: '@microsoft/sp-property-pane!' - fullName: resizable + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#resizable:member' summary: Whether or not the multiline text field is resizable. remarks: The default value is true. - - isPreview: false - isDeprecated: false + name: resizable + fullName: resizable + langs: + - typeScript + type: property syntax: content: 'resizable?: boolean;' return: - type: boolean - - name: rows - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' - package: '@microsoft/sp-property-pane!' - fullName: rows + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' remarks: This prop is used only when the multiline prop is set to true. - - isPreview: false - isDeprecated: false + name: rows + fullName: rows + langs: + - typeScript + type: property syntax: content: 'rows?: number;' return: - type: number - - name: underlined - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' - package: '@microsoft/sp-property-pane!' - fullName: underlined + type: + - number + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#underlined:member' summary: Whether or not the text field is underlined. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: underlined + fullName: underlined + langs: + - typeScript + type: property syntax: content: 'underlined?: boolean;' return: - type: boolean - - name: validateOnFocusIn - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusIn + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusIn:member' summary: Run validation when the PropertyPaneTextField is focused. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: validateOnFocusIn + fullName: validateOnFocusIn + langs: + - typeScript + type: property syntax: content: 'validateOnFocusIn?: boolean;' return: - type: boolean - - name: validateOnFocusOut - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' - package: '@microsoft/sp-property-pane!' - fullName: validateOnFocusOut + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#validateOnFocusOut:member' summary: Run validation when the PropertyPaneTextField is out of focus or on blur. remarks: The default value is false. - - isPreview: false - isDeprecated: false + name: validateOnFocusOut + fullName: validateOnFocusOut + langs: + - typeScript + type: property syntax: content: 'validateOnFocusOut?: boolean;' return: - type: boolean - - name: value - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' - package: '@microsoft/sp-property-pane!' - fullName: value + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#value:member' summary: >- Value to be displayed in the text field when the value of the targetProperty in the manifest's property bag is empty or contains null value. - remarks: '' - - isPreview: false - isDeprecated: false + name: value + fullName: value + langs: + - typeScript + type: property syntax: content: 'value?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#onGetErrorMessage~0:complex' + name: '(value: string) => string | Promise' + fullName: '(value: string) => string | Promise' + spec.typeScript: + - name: '(value: string) => string | ' + fullName: '(value: string) => string | ' + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: diff --git a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml index afa840b9..43fcf523 100644 --- a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -1,144 +1,170 @@ -### YamlMime:TSType -name: IPropertyPaneThumbnailPickerProps -uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneThumbnailPickerProps -summary: PropertyPaneThumbnailPicker component props -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: callerName - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#callerName:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps:interface' + summary: PropertyPaneThumbnailPicker component props + isPreview: true + name: IPropertyPaneThumbnailPickerProps + fullName: IPropertyPaneThumbnailPickerProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: callerName + children: + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#callerName:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#forceFullUrl:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemDeleted:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewFullWidth:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewGrayBackground:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#serviceScope:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnail:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererIconClassName:member' + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererWrapperClassName:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#callerName:member' summary: Optional name of consuming component for telemetry purposes. - remarks: '' - isPreview: true - isDeprecated: false + name: callerName + fullName: callerName + langs: + - typeScript + type: property syntax: content: 'callerName?: string;' return: - type: string - - name: forceFullUrl - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#forceFullUrl:member' - package: '@microsoft/sp-property-pane!' - fullName: forceFullUrl + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#forceFullUrl:member' summary: >- If an asset from the current site is selected, the URL can be returned as a relative URL. This option forces the URL to be returned as an absolute URL. - remarks: '' - isPreview: true - isDeprecated: false + name: forceFullUrl + fullName: forceFullUrl + langs: + - typeScript + type: property syntax: content: 'forceFullUrl?: boolean;' return: - type: boolean - - name: onItemChanged - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged:member' - package: '@microsoft/sp-property-pane!' - fullName: onItemChanged + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged:member' summary: Callback function for when an image has been selected. - remarks: '' - isPreview: true - isDeprecated: false + name: onItemChanged + fullName: onItemChanged + langs: + - typeScript + type: property syntax: content: 'onItemChanged: (url: string, guidSet: IGuidSet | undefined) => void;' return: - type: '(url: string, guidSet: | undefined) => void' - - name: onItemDeleted - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemDeleted:member' - package: '@microsoft/sp-property-pane!' - fullName: onItemDeleted + type: + - '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemDeleted:member' summary: Callback for when the Delete button is clicked. - remarks: '' - isPreview: true - isDeprecated: false + name: onItemDeleted + fullName: onItemDeleted + langs: + - typeScript + type: property syntax: content: 'onItemDeleted?: () => void;' return: - type: () => void - - name: previewFullWidth - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewFullWidth:member' - package: '@microsoft/sp-property-pane!' - fullName: previewFullWidth + type: + - () => void + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewFullWidth:member' summary: 'For the preview image, display with full width as opposed to the default fixed ratio.' - remarks: '' - isPreview: true - isDeprecated: false + name: previewFullWidth + fullName: previewFullWidth + langs: + - typeScript + type: property syntax: content: 'previewFullWidth?: boolean;' return: - type: boolean - - name: previewGrayBackground - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewGrayBackground:member' - package: '@microsoft/sp-property-pane!' - fullName: previewGrayBackground + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewGrayBackground:member' summary: Whether to display a gray background when rendering an icon. - remarks: '' - isPreview: true - isDeprecated: false + name: previewGrayBackground + fullName: previewGrayBackground + langs: + - typeScript + type: property syntax: content: 'previewGrayBackground?: boolean;' return: - type: boolean - - name: serviceScope - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#serviceScope:member' - package: '@microsoft/sp-property-pane!' - fullName: serviceScope + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#serviceScope:member' summary: Service scope. - remarks: '' - isPreview: true - isDeprecated: false + name: serviceScope + fullName: serviceScope + langs: + - typeScript + type: property syntax: content: 'serviceScope: ServiceScope;' return: - type: '' - - name: thumbnail - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnail:member' - package: '@microsoft/sp-property-pane!' - fullName: thumbnail + type: + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnail:member' summary: Thumbnail metadata of the currently selected thumbnail. - remarks: '' - isPreview: true - isDeprecated: false + name: thumbnail + fullName: thumbnail + langs: + - typeScript + type: property syntax: content: 'thumbnail?: IThumbnail;' return: - type: '' - - name: thumbnailRendererIconClassName - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererIconClassName:member' - package: '@microsoft/sp-property-pane!' - fullName: thumbnailRendererIconClassName + type: + - '@microsoft/sp-property-pane!IThumbnail:type' + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererIconClassName:member' summary: Optional CSS class name to apply to the thumbnail preview when an icon is being rendered. - remarks: '' - isPreview: true - isDeprecated: false + name: thumbnailRendererIconClassName + fullName: thumbnailRendererIconClassName + langs: + - typeScript + type: property syntax: content: 'thumbnailRendererIconClassName?: string;' return: - type: string - - name: thumbnailRendererWrapperClassName - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererWrapperClassName:member' - package: '@microsoft/sp-property-pane!' - fullName: thumbnailRendererWrapperClassName + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererWrapperClassName:member' summary: Optional CSS class name to apply to the wrapper of the thumbnail preview. - remarks: '' - isPreview: true - isDeprecated: false + name: thumbnailRendererWrapperClassName + fullName: thumbnailRendererWrapperClassName + langs: + - typeScript + type: property syntax: content: 'thumbnailRendererWrapperClassName?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged~0:complex' + name: '(url: string, guidSet: IGuidSet | undefined) => void' + fullName: '(url: string, guidSet: IGuidSet | undefined) => void' + spec.typeScript: + - name: '(url: string, guidSet: ' + fullName: '(url: string, guidSet: ' + - uid: '@microsoft/sp-property-pane!IGuidSet:interface' + name: IGuidSet + fullName: IGuidSet + - name: ' | undefined) => void' + fullName: ' | undefined) => void' + - uid: '@microsoft/sp-core-library!ServiceScope:class' + name: ServiceScope + - uid: '@microsoft/sp-property-pane!IThumbnail:type' + name: IThumbnail diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index ca90e3ec..5a9bccf1 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -1,116 +1,126 @@ -### YamlMime:TSType -name: IPropertyPaneToggleProps -uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' -package: '@microsoft/sp-property-pane!' -fullName: IPropertyPaneToggleProps -summary: PropertyPaneToggle component props. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: checked - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + summary: PropertyPaneToggle component props. + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: checked + children: + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' summary: Checked state of the toggle. remarks: 'If you are maintaining state yourself, use this property.' - - isPreview: false - isDeprecated: false + name: checked + fullName: checked + langs: + - typeScript + type: property syntax: content: 'checked?: boolean;' return: - type: boolean - - name: disabled - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' - package: '@microsoft/sp-property-pane!' - fullName: disabled + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#disabled:member' summary: Optional disabled flag. - remarks: '' - - isPreview: false - isDeprecated: false + name: disabled + fullName: disabled + langs: + - typeScript + type: property syntax: content: 'disabled?: boolean;' return: - type: boolean - - name: key - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' - package: '@microsoft/sp-property-pane!' - fullName: key + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#key:member' summary: A key to uniquely identify the field. - remarks: '' - - isPreview: false - isDeprecated: false + name: key + fullName: key + langs: + - typeScript + type: property syntax: content: 'key?: string | number;' return: - type: string | number - - name: label - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' - package: '@microsoft/sp-property-pane!' - fullName: label + type: + - string | number + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label:member' summary: A label for the toggle. - remarks: '' - - isPreview: false - isDeprecated: false + name: label + fullName: label + langs: + - typeScript + type: property syntax: content: 'label: string | React.ReactElement;' return: - type: 'string | ' - - name: offAriaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: offAriaLabel + type: + - '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label~0:complex' + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offAriaLabel:member' summary: Optional offAriaLabel flag. Text for screen-reader to announce when toggle is OFF. - remarks: '' - - isPreview: false - isDeprecated: false + name: offAriaLabel + fullName: offAriaLabel + langs: + - typeScript + type: property syntax: content: 'offAriaLabel?: string;' return: - type: string - - name: offText - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' - package: '@microsoft/sp-property-pane!' - fullName: offText + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#offText:member' summary: Test display when toggle is OFF. - remarks: '' - - isPreview: false - isDeprecated: false + name: offText + fullName: offText + langs: + - typeScript + type: property syntax: content: 'offText?: string;' return: - type: string - - name: onAriaLabel - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' - package: '@microsoft/sp-property-pane!' - fullName: onAriaLabel + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onAriaLabel:member' summary: Optional onAriaLabel flag. Text for screen-reader to announce when toggle is ON. - remarks: '' - - isPreview: false - isDeprecated: false + name: onAriaLabel + fullName: onAriaLabel + langs: + - typeScript + type: property syntax: content: 'onAriaLabel?: string;' return: - type: string - - name: onText - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' - package: '@microsoft/sp-property-pane!' - fullName: onText + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#onText:member' summary: Text to display when toggle is ON. - remarks: '' - - isPreview: false - isDeprecated: false + name: onText + fullName: onText + langs: + - typeScript + type: property syntax: content: 'onText?: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#label~0:complex' + name: string | React.ReactElement + fullName: string | React.ReactElement + spec.typeScript: + - name: 'string | ' + fullName: 'string | ' + - uid: '@types/react!~React.ReactElement:interface' + name: React.ReactElement + fullName: React.ReactElement diff --git a/SP-Framework/sp-property-pane/ithumbnail.yml b/SP-Framework/sp-property-pane/ithumbnail.yml index 639c639b..6bfdbff5 100644 --- a/SP-Framework/sp-property-pane/ithumbnail.yml +++ b/SP-Framework/sp-property-pane/ithumbnail.yml @@ -1,11 +1,34 @@ -### YamlMime:TSTypeAlias -name: IThumbnail -uid: '@microsoft/sp-property-pane!IThumbnail:type' -package: '@microsoft/sp-property-pane!' -fullName: IThumbnail -summary: The type of thumbnail image being configured. -remarks: '' - -isPreview: true -isDeprecated: false -syntax: export declare type IThumbnail = IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage; +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IThumbnail:type' + summary: The type of thumbnail image being configured. + isPreview: true + name: IThumbnail + fullName: IThumbnail + langs: + - typeScript + type: typealias + syntax: + content: export declare type IThumbnail = IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage; + return: + type: + - '@microsoft/sp-property-pane!IThumbnail~0:complex' + package: '@microsoft/sp-property-pane!' +references: + - uid: '@microsoft/sp-property-pane!IThumbnail~0:complex' + name: IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage + fullName: IThumbnailImage | IThumbnailFabricReactIcon | IThumbnailIconSizeImage + spec.typeScript: + - uid: '@microsoft/sp-property-pane!IThumbnailImage:interface' + name: IThumbnailImage + fullName: IThumbnailImage + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' + name: IThumbnailFabricReactIcon + fullName: IThumbnailFabricReactIcon + - name: ' | ' + fullName: ' | ' + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' + name: IThumbnailIconSizeImage + fullName: IThumbnailIconSizeImage diff --git a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml index 8d2dad84..76d0affc 100644 --- a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -1,64 +1,71 @@ -### YamlMime:TSType -name: IThumbnailFabricReactIcon -uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' -package: '@microsoft/sp-property-pane!' -fullName: IThumbnailFabricReactIcon -summary: Options related to fabric icon thumbnail. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: altText - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#altText:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon:interface' + summary: Options related to fabric icon thumbnail. + isPreview: true + name: IThumbnailFabricReactIcon + fullName: IThumbnailFabricReactIcon + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: altText + children: + - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#altText:member' + - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconColor:member' + - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconName:member' + - '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#type:member' + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#altText:member' summary: Alt text for the icon. - remarks: '' - isPreview: true - isDeprecated: false + name: altText + fullName: altText + langs: + - typeScript + type: property syntax: content: 'altText: string;' return: - type: string - - name: iconColor - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconColor:member' - package: '@microsoft/sp-property-pane!' - fullName: iconColor + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconColor:member' summary: The background color for the icon. - remarks: '' - isPreview: true - isDeprecated: false + name: iconColor + fullName: iconColor + langs: + - typeScript + type: property syntax: content: 'iconColor?: string;' return: - type: string - - name: iconName - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconName:member' - package: '@microsoft/sp-property-pane!' - fullName: iconName + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconName:member' summary: The name of the icon to render. - remarks: '' - isPreview: true - isDeprecated: false + name: iconName + fullName: iconName + langs: + - typeScript + type: property syntax: content: 'iconName: string;' return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#type:member' summary: Fabric icon type. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ThumbnailType.FabricReactIcon;' return: - type: '' + type: + - '@microsoft/sp-property-pane!ThumbnailType.FabricReactIcon:member' +references: + - uid: '@microsoft/sp-property-pane!ThumbnailType.FabricReactIcon:member' + name: FabricReactIcon diff --git a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml index 75bc6e19..ed985555 100644 --- a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -1,64 +1,71 @@ -### YamlMime:TSType -name: IThumbnailIconSizeImage -uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' -package: '@microsoft/sp-property-pane!' -fullName: IThumbnailIconSizeImage -summary: Options related to icon sized image thumbnail. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: altText - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#altText:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage:interface' + summary: Options related to icon sized image thumbnail. + isPreview: true + name: IThumbnailIconSizeImage + fullName: IThumbnailIconSizeImage + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: altText + children: + - '@microsoft/sp-property-pane!IThumbnailIconSizeImage#altText:member' + - '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconColor:member' + - '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconUrl:member' + - '@microsoft/sp-property-pane!IThumbnailIconSizeImage#type:member' + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#altText:member' summary: Alt text for the image. - remarks: '' - isPreview: true - isDeprecated: false + name: altText + fullName: altText + langs: + - typeScript + type: property syntax: content: 'altText: string;' return: - type: string - - name: iconColor - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconColor:member' - package: '@microsoft/sp-property-pane!' - fullName: iconColor + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconColor:member' summary: Background color to use for the icon. - remarks: '' - isPreview: true - isDeprecated: false + name: iconColor + fullName: iconColor + langs: + - typeScript + type: property syntax: content: 'iconColor?: string;' return: - type: string - - name: iconUrl - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconUrl:member' - package: '@microsoft/sp-property-pane!' - fullName: iconUrl + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconUrl:member' summary: URL pointing to the icon-size image. - remarks: '' - isPreview: true - isDeprecated: false + name: iconUrl + fullName: iconUrl + langs: + - typeScript + type: property syntax: content: 'iconUrl: string;' return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#type:member' summary: Image type. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ThumbnailType.IconSizeImage;' return: - type: '' + type: + - '@microsoft/sp-property-pane!ThumbnailType.IconSizeImage:member' +references: + - uid: '@microsoft/sp-property-pane!ThumbnailType.IconSizeImage:member' + name: IconSizeImage diff --git a/SP-Framework/sp-property-pane/ithumbnailimage.yml b/SP-Framework/sp-property-pane/ithumbnailimage.yml index f52b101c..2d3f30e0 100644 --- a/SP-Framework/sp-property-pane/ithumbnailimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -1,77 +1,94 @@ -### YamlMime:TSType -name: IThumbnailImage -uid: '@microsoft/sp-property-pane!IThumbnailImage:interface' -package: '@microsoft/sp-property-pane!' -fullName: IThumbnailImage -summary: Options related to image thumbnail. -remarks: '' - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: altText - uid: '@microsoft/sp-property-pane!IThumbnailImage#altText:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!IThumbnailImage:interface' + summary: Options related to image thumbnail. + isPreview: true + name: IThumbnailImage + fullName: IThumbnailImage + langs: + - typeScript + type: interface package: '@microsoft/sp-property-pane!' - fullName: altText + children: + - '@microsoft/sp-property-pane!IThumbnailImage#altText:member' + - '@microsoft/sp-property-pane!IThumbnailImage#backupImageUrl:member' + - '@microsoft/sp-property-pane!IThumbnailImage#imageFit:member' + - '@microsoft/sp-property-pane!IThumbnailImage#imageUrl:member' + - '@microsoft/sp-property-pane!IThumbnailImage#type:member' + - uid: '@microsoft/sp-property-pane!IThumbnailImage#altText:member' summary: Alt text for the image. - remarks: '' - isPreview: true - isDeprecated: false + name: altText + fullName: altText + langs: + - typeScript + type: property syntax: content: 'altText: string;' return: - type: string - - name: backupImageUrl - uid: '@microsoft/sp-property-pane!IThumbnailImage#backupImageUrl:member' - package: '@microsoft/sp-property-pane!' - fullName: backupImageUrl + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailImage#backupImageUrl:member' summary: Optional backup image URL if the original image URL fails to load. - remarks: '' - isPreview: true - isDeprecated: false + name: backupImageUrl + fullName: backupImageUrl + langs: + - typeScript + type: property syntax: content: 'backupImageUrl: string | undefined;' return: - type: string | undefined - - name: imageFit - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageFit:member' - package: '@microsoft/sp-property-pane!' - fullName: imageFit + type: + - string | undefined + - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageFit:member' summary: How the image should fit. - remarks: '' - isPreview: true - isDeprecated: false + name: imageFit + fullName: imageFit + langs: + - typeScript + type: property syntax: content: 'imageFit: ImageFit | undefined;' return: - type: ' | undefined' - - name: imageUrl - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageUrl:member' - package: '@microsoft/sp-property-pane!' - fullName: imageUrl + type: + - '@microsoft/sp-property-pane!IThumbnailImage#imageFit~0:complex' + - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageUrl:member' summary: URL pointing to the image. - remarks: '' - isPreview: true - isDeprecated: false + name: imageUrl + fullName: imageUrl + langs: + - typeScript + type: property syntax: content: 'imageUrl: string;' return: - type: string - - name: type - uid: '@microsoft/sp-property-pane!IThumbnailImage#type:member' - package: '@microsoft/sp-property-pane!' - fullName: type + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailImage#type:member' summary: Image type. - remarks: '' - isPreview: true - isDeprecated: false + name: type + fullName: type + langs: + - typeScript + type: property syntax: content: 'type: ThumbnailType.Image;' return: - type: '' + type: + - '@microsoft/sp-property-pane!ThumbnailType.Image:member' +references: + - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageFit~0:complex' + name: ImageFit | undefined + fullName: ImageFit | undefined + spec.typeScript: + - uid: '@microsoft/sp-property-pane!ImageFit:enum' + name: ImageFit + fullName: ImageFit + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-property-pane!ThumbnailType.Image:member' + name: Image diff --git a/SP-Framework/sp-property-pane/popupwindowposition.yml b/SP-Framework/sp-property-pane/popupwindowposition.yml index c21c4d0c..44974485 100644 --- a/SP-Framework/sp-property-pane/popupwindowposition.yml +++ b/SP-Framework/sp-property-pane/popupwindowposition.yml @@ -1,36 +1,56 @@ -### YamlMime:TSEnum -name: PopupWindowPosition -uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' -package: '@microsoft/sp-property-pane!' -fullName: PopupWindowPosition -summary: The position of pop up window. -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: center - uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PopupWindowPosition:enum' + summary: The position of pop up window. + name: PopupWindowPosition + fullName: PopupWindowPosition + langs: + - typeScript + type: enum package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PopupWindowPosition.center:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' + - '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.center:member' summary: PopupWindowPosition would be located in center of screen. - value: '0' - - name: leftBottom - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' - package: '@microsoft/sp-property-pane!' + name: center + fullName: center + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftBottom:member' summary: PopupWindowPosition would be located in left bottom of screen. - value: '4' - - name: leftTop - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' - package: '@microsoft/sp-property-pane!' + name: leftBottom + fullName: leftBottom + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.leftTop:member' summary: PopupWindowPosition would be located in left top of screen. - value: '2' - - name: rightBottom - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' - package: '@microsoft/sp-property-pane!' + name: leftTop + fullName: leftTop + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightBottom:member' summary: PopupWindowPosition would be located in right bottom of screen. - value: '3' - - name: rightTop - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' - package: '@microsoft/sp-property-pane!' + name: rightBottom + fullName: rightBottom + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!PopupWindowPosition.rightTop:member' summary: PopupWindowPosition would be located in right top of screen. - value: '1' + name: rightTop + fullName: rightTop + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-property-pane/propertypanebuttontype.yml b/SP-Framework/sp-property-pane/propertypanebuttontype.yml index b28f7aba..7d986c07 100644 --- a/SP-Framework/sp-property-pane/propertypanebuttontype.yml +++ b/SP-Framework/sp-property-pane/propertypanebuttontype.yml @@ -1,43 +1,84 @@ -### YamlMime:TSEnum -name: PropertyPaneButtonType -uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' -package: '@microsoft/sp-property-pane!' -fullName: PropertyPaneButtonType -summary: Enum for all the supported button types. -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: Command - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType:enum' + summary: Enum for all the supported button types. + name: PropertyPaneButtonType + fullName: PropertyPaneButtonType + langs: + - typeScript + type: enum package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' + - '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Command:member' summary: Optional actions. - value: '4' - - name: Compound - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' - package: '@microsoft/sp-property-pane!' + remarks: >- + Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command + bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts. + name: Command + fullName: Command + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Compound:member' summary: Always used as a set with both Standard and Primary compound buttons. - value: '3' - - name: Hero - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' - package: '@microsoft/sp-property-pane!' + remarks: >- + Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with + a possible significant time investment such as an email or a complex form + name: Compound + fullName: Compound + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Hero:member' summary: Hero button. - value: '2' - - name: Icon - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' - package: '@microsoft/sp-property-pane!' + name: Hero + fullName: Hero + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Icon:member' summary: >- Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar. - value: '5' - - name: Normal - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' - package: '@microsoft/sp-property-pane!' + remarks: >- + Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: + OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In + SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In + SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the + bottom of an event creation Callout when clicking inside an empty time range. + name: Icon + fullName: Icon + langs: + - typeScript + type: field + numericValue: '5' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Normal:member' summary: Optional completion action. - value: '0' - - name: Primary - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' - package: '@microsoft/sp-property-pane!' + remarks: >- + Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo + an action. Examples: "Done" button which closes a container but doesn't make a server call or an "Undo" button + when a user is uploading a file in OneDrive. + name: Normal + fullName: Normal + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-property-pane!PropertyPaneButtonType.Primary:member' summary: Preferred completion action when paired with a Standard button. - value: '1' + remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' + name: Primary + fullName: Primary + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml index 5bad4681..95db7051 100644 --- a/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-property-pane/propertypanedropdownoptiontype.yml @@ -1,28 +1,40 @@ -### YamlMime:TSEnum -name: PropertyPaneDropdownOptionType -uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' -package: '@microsoft/sp-property-pane!' -fullName: PropertyPaneDropdownOptionType -summary: >- - Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: Divider - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType:enum' + summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)). + name: PropertyPaneDropdownOptionType + fullName: PropertyPaneDropdownOptionType + langs: + - typeScript + type: enum package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' + - '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Divider:member' summary: Render a divider. - value: '1' - - name: Header - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' - package: '@microsoft/sp-property-pane!' + name: Divider + fullName: Divider + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Header:member' summary: Render menu item as a header. - value: '2' - - name: Normal - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' - package: '@microsoft/sp-property-pane!' + name: Header + fullName: Header + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PropertyPaneDropdownOptionType.Normal:member' summary: Render normal menu item. - value: '0' + name: Normal + fullName: Normal + langs: + - typeScript + type: field + numericValue: '0' diff --git a/SP-Framework/sp-property-pane/propertypanefieldtype.yml b/SP-Framework/sp-property-pane/propertypanefieldtype.yml index 2a4fba58..47c1a751 100644 --- a/SP-Framework/sp-property-pane/propertypanefieldtype.yml +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -1,99 +1,172 @@ -### YamlMime:TSEnum -name: PropertyPaneFieldType -uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' -package: '@microsoft/sp-property-pane!' -fullName: PropertyPaneFieldType -summary: |- - Enum for all the supported PropertyPane field types. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType:enum' + summary: |- + Enum for all the supported PropertyPane field types. - Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. -remarks: '' - -isPreview: false -isDeprecated: false -fields: - - name: Button - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' - package: '@microsoft/sp-property-pane!' + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. + name: PropertyPaneFieldType + fullName: PropertyPaneFieldType + langs: + - typeScript + type: enum + package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.IconPicker:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.ThumbnailPicker:member' + - '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Button:member' summary: Button field. - value: '11' - - name: CheckBox - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' - package: '@microsoft/sp-property-pane!' + name: Button + fullName: Button + langs: + - typeScript + type: field + numericValue: '11' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.CheckBox:member' summary: Checkbox field. - value: '2' - - name: ChoiceGroup - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' - package: '@microsoft/sp-property-pane!' + name: CheckBox + fullName: CheckBox + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ChoiceGroup:member' summary: Choice Group field. - value: '10' - - name: Custom - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' - package: '@microsoft/sp-property-pane!' + name: ChoiceGroup + fullName: ChoiceGroup + langs: + - typeScript + type: field + numericValue: '10' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Custom:member' summary: Custom field. - value: '1' - - name: Dropdown - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' - package: '@microsoft/sp-property-pane!' + name: Custom + fullName: Custom + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Dropdown:member' summary: Dropdown field. - value: '6' - - name: DynamicField - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' - package: '@microsoft/sp-property-pane!' + name: Dropdown + fullName: Dropdown + langs: + - typeScript + type: field + numericValue: '6' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicField:member' summary: Dynamic data field. - value: '14' - - name: DynamicFieldSet - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' - package: '@microsoft/sp-property-pane!' + name: DynamicField + fullName: DynamicField + langs: + - typeScript + type: field + numericValue: '14' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicFieldSet:member' summary: A set of dynamic fields. - value: '16' - - name: DynamicTextField - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' - package: '@microsoft/sp-property-pane!' + name: DynamicFieldSet + fullName: DynamicFieldSet + langs: + - typeScript + type: field + numericValue: '16' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.DynamicTextField:member' summary: Dynamic Text Field - value: '15' - - name: Heading - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' - package: '@microsoft/sp-property-pane!' + deprecated: + content: '- Please use DynamicField' + isPreview: true + name: DynamicTextField + fullName: DynamicTextField + langs: + - typeScript + type: field + numericValue: '15' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Heading:member' summary: Heading field. - value: '9' - - name: HorizontalRule - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' - package: '@microsoft/sp-property-pane!' + name: Heading + fullName: Heading + langs: + - typeScript + type: field + numericValue: '9' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.HorizontalRule:member' summary: Horizontal Rule field. - value: '12' - - name: IconPicker - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.IconPicker:member' - package: '@microsoft/sp-property-pane!' + name: HorizontalRule + fullName: HorizontalRule + langs: + - typeScript + type: field + numericValue: '12' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.IconPicker:member' summary: Icon picker field. - value: '19' - - name: Label - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: IconPicker + fullName: IconPicker + langs: + - typeScript + type: field + numericValue: '19' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Label:member' summary: Label field. - value: '7' - - name: Link - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' - package: '@microsoft/sp-property-pane!' + name: Label + fullName: Label + langs: + - typeScript + type: field + numericValue: '7' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Link:member' summary: Link field. - value: '13' - - name: Slider - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' - package: '@microsoft/sp-property-pane!' + name: Link + fullName: Link + langs: + - typeScript + type: field + numericValue: '13' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Slider:member' summary: Slider field. - value: '8' - - name: TextField - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' - package: '@microsoft/sp-property-pane!' + name: Slider + fullName: Slider + langs: + - typeScript + type: field + numericValue: '8' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.TextField:member' summary: TextField field. - value: '3' - - name: ThumbnailPicker - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ThumbnailPicker:member' - package: '@microsoft/sp-property-pane!' + name: TextField + fullName: TextField + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.ThumbnailPicker:member' summary: Thumbnail picker field. - value: '18' - - name: Toggle - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: ThumbnailPicker + fullName: ThumbnailPicker + langs: + - typeScript + type: field + numericValue: '18' + - uid: '@microsoft/sp-property-pane!PropertyPaneFieldType.Toggle:member' summary: Toggle field. - value: '5' + name: Toggle + fullName: Toggle + langs: + - typeScript + type: field + numericValue: '5' diff --git a/SP-Framework/sp-property-pane/thumbnailtype.yml b/SP-Framework/sp-property-pane/thumbnailtype.yml index 90495bd3..afad828c 100644 --- a/SP-Framework/sp-property-pane/thumbnailtype.yml +++ b/SP-Framework/sp-property-pane/thumbnailtype.yml @@ -1,26 +1,42 @@ -### YamlMime:TSEnum -name: ThumbnailType -uid: '@microsoft/sp-property-pane!ThumbnailType:enum' -package: '@microsoft/sp-property-pane!' -fullName: ThumbnailType -summary: Supported thumbnail image types. -remarks: '' - -isPreview: true -isDeprecated: false -fields: - - name: FabricReactIcon - uid: '@microsoft/sp-property-pane!ThumbnailType.FabricReactIcon:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-property-pane!ThumbnailType:enum' + summary: Supported thumbnail image types. + isPreview: true + name: ThumbnailType + fullName: ThumbnailType + langs: + - typeScript + type: enum package: '@microsoft/sp-property-pane!' + children: + - '@microsoft/sp-property-pane!ThumbnailType.FabricReactIcon:member' + - '@microsoft/sp-property-pane!ThumbnailType.IconSizeImage:member' + - '@microsoft/sp-property-pane!ThumbnailType.Image:member' + - uid: '@microsoft/sp-property-pane!ThumbnailType.FabricReactIcon:member' summary: Name of a supported icon. - value: '2' - - name: IconSizeImage - uid: '@microsoft/sp-property-pane!ThumbnailType.IconSizeImage:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: FabricReactIcon + fullName: FabricReactIcon + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-property-pane!ThumbnailType.IconSizeImage:member' summary: Link to an icon-sized image. - value: '3' - - name: Image - uid: '@microsoft/sp-property-pane!ThumbnailType.Image:member' - package: '@microsoft/sp-property-pane!' + isPreview: true + name: IconSizeImage + fullName: IconSizeImage + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-property-pane!ThumbnailType.Image:member' summary: Link to an image. - value: '1' + isPreview: true + name: Image + fullName: Image + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-search-extensibility.yml b/SP-Framework/sp-search-extensibility.yml index df221c4c..27501759 100644 --- a/SP-Framework/sp-search-extensibility.yml +++ b/SP-Framework/sp-search-extensibility.yml @@ -1,12 +1,23 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-search-extensibility!' -name: '@microsoft/sp-search-extensibility' -type: package -summary: SharePoint Framework developer support for customizing search. -classes: - - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' - - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' -interfaces: - - '@microsoft/sp-search-extensibility!IQuery:interface' -enums: - - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!' + summary: SharePoint Framework developer support for customizing search. + name: '@microsoft/sp-search-extensibility' + fullName: '@microsoft/sp-search-extensibility' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + - '@microsoft/sp-search-extensibility!IQuery:interface' + - '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' +references: + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + name: BaseSearchQueryModifier + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + name: IQuery + - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + name: SearchQueryModifierContext + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + name: SearchQueryScenario diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 8a59dd11..64124a37 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -1,75 +1,112 @@ -### YamlMime:TSType -name: BaseSearchQueryModifier -uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' -package: '@microsoft/sp-search-extensibility!' -fullName: BaseSearchQueryModifier -summary: >- - This is the base class that third parties should extend when implementing a client-side extension that can modify the - search query. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier:class' + summary: >- + This is the base class that third parties should extend when implementing a client-side extension that can modify + the search query. - In the component manifest, the "extensionType" should be set to "SearchQueryModifier". -remarks: '' -isPreview: true -isDeprecated: false -type: class -properties: - - name: context - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' + In the component manifest, the "extensionType" should be set to "SearchQueryModifier". + isPreview: true + name: BaseSearchQueryModifier + fullName: BaseSearchQueryModifier + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-extension-base!BaseExtension:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' package: '@microsoft/sp-search-extensibility!' - fullName: context + children: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - isPreview: true - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'protected readonly context: SearchQueryModifierContext;' return: - type: '' - - name: timeout - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' - package: '@microsoft/sp-search-extensibility!' - fullName: timeout - summary: >- - Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the - original query will be used instead of the modified one. - remarks: '' - - isPreview: true - isDeprecated: false - syntax: - content: |- - /** @virtual */ - get timeout(): number; - return: - type: number -methods: - - name: 'modifySearchQuery(query, scenario)' - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' - package: '@microsoft/sp-search-extensibility!' - fullName: 'modifySearchQuery(query, scenario)' + type: + - '@microsoft/sp-search-extensibility!default:class' + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' summary: Returns a modified search query. - remarks: '' - isPreview: true - isDeprecated: false + name: 'modifySearchQuery(query, scenario)' + fullName: 'modifySearchQuery(query, scenario)' + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise; + return: + type: + - '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery~0:complex' + description: Modified query. parameters: - id: query description: Query to modify. - type: '' + type: + - '@microsoft/sp-search-extensibility!IQuery:interface' + optional: false - id: scenario description: Search scenario. - type: '' + type: + - '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + optional: false + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' + summary: >- + Timeout for the search query modifier in milliseconds. If the execution takes longer than the timeout, the + original query will be used instead of the modified one. + isPreview: true + name: timeout + fullName: timeout + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get timeout(): number; return: - type: 'Promise<>' - description: Modified query. -extends: '<TProperties> ' + type: + - number +references: + - uid: '@microsoft/sp-extension-base!BaseExtension:class' + name: BaseExtension + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-search-extensibility!default:class' + name: SearchQueryModifierContext + - uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: < + fullName: < + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + name: IQuery + fullName: IQuery + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + name: IQuery + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + name: SearchQueryScenario diff --git a/SP-Framework/sp-search-extensibility/iquery.yml b/SP-Framework/sp-search-extensibility/iquery.yml index 20c25567..b8e69c1f 100644 --- a/SP-Framework/sp-search-extensibility/iquery.yml +++ b/SP-Framework/sp-search-extensibility/iquery.yml @@ -1,38 +1,41 @@ -### YamlMime:TSType -name: IQuery -uid: '@microsoft/sp-search-extensibility!IQuery:interface' -package: '@microsoft/sp-search-extensibility!' -fullName: IQuery -summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. -remarks: Additional properties can be added to the object to pass data between extensions. - -isPreview: true -isDeprecated: false -type: interface -properties: - - name: originalQueryText - uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!IQuery:interface' + summary: Query object. Includes the query text that will be used for search and exposed through dynamic data. + remarks: Additional properties can be added to the object to pass data between extensions. + isPreview: true + name: IQuery + fullName: IQuery + langs: + - typeScript + type: interface package: '@microsoft/sp-search-extensibility!' - fullName: originalQueryText + children: + - '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' + - '@microsoft/sp-search-extensibility!IQuery#queryText:member' + - uid: '@microsoft/sp-search-extensibility!IQuery#originalQueryText:member' summary: Query text that the user provided. - remarks: '' - isPreview: true - isDeprecated: false + name: originalQueryText + fullName: originalQueryText + langs: + - typeScript + type: property syntax: content: 'originalQueryText: string;' return: - type: string - - name: queryText - uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' - package: '@microsoft/sp-search-extensibility!' - fullName: queryText + type: + - string + - uid: '@microsoft/sp-search-extensibility!IQuery#queryText:member' summary: Text of the query. - remarks: '' - isPreview: true - isDeprecated: false + name: queryText + fullName: queryText + langs: + - typeScript + type: property syntax: content: 'queryText: string;' return: - type: string + type: + - string diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index f2b0828b..28df1f14 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -1,12 +1,22 @@ -### YamlMime:TSType -name: SearchQueryModifierContext -uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' -package: '@microsoft/sp-search-extensibility!' -fullName: SearchQueryModifierContext -summary: Context for the search query modifier extensions. -remarks: '' - -isPreview: true -isDeprecated: false -type: class -extends: '' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!SearchQueryModifierContext:class' + summary: Context for the search query modifier extensions. + isPreview: true + name: SearchQueryModifierContext + fullName: SearchQueryModifierContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-extension-base!ExtensionContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' + package: '@microsoft/sp-search-extensibility!' +references: + - uid: '@microsoft/sp-extension-base!ExtensionContext:class' + name: ExtensionContext + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext diff --git a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml index 1cd79378..c85b8db6 100644 --- a/SP-Framework/sp-search-extensibility/searchqueryscenario.yml +++ b/SP-Framework/sp-search-extensibility/searchqueryscenario.yml @@ -1,21 +1,32 @@ -### YamlMime:TSEnum -name: SearchQueryScenario -uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' -package: '@microsoft/sp-search-extensibility!' -fullName: SearchQueryScenario -summary: Scenario for the search query modifier. -remarks: '' - -isPreview: true -isDeprecated: false -fields: - - name: SearchResults - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario:enum' + summary: Scenario for the search query modifier. + isPreview: true + name: SearchQueryScenario + fullName: SearchQueryScenario + langs: + - typeScript + type: enum package: '@microsoft/sp-search-extensibility!' + children: + - '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' + - '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchResults:member' summary: Search results scenario. - value: '1' - - name: SearchSuggestions - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' - package: '@microsoft/sp-search-extensibility!' + isPreview: true + name: SearchResults + fullName: SearchResults + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-search-extensibility!SearchQueryScenario.SearchSuggestions:member' summary: Search suggestions scenario. - value: '2' + isPreview: true + name: SearchSuggestions + fullName: SearchSuggestions + langs: + - typeScript + type: field + numericValue: '2' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 18b36010..6907382f 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -1,428 +1,770 @@ -### YamlMime:TSPackage -uid: '@microsoft/sp-webpart-base!' -name: '@microsoft/sp-webpart-base' -type: package -summary: SharePoint Framework support for building web parts. -classes: - - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' - - '@microsoft/sp-webpart-base!BaseWebPart:class' - - '@microsoft/sp-webpart-base!BaseWebPartContext:class' - - '@microsoft/sp-webpart-base!WebPartContext:class' -enums: - - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' - - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' - - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' - - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' -interfaces: - - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' - - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' - - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' - - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' - - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' - - '@microsoft/sp-webpart-base!ISDKs:interface' - - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' - - '@microsoft/sp-webpart-base!IWebPartContext:interface' - - '@microsoft/sp-webpart-base!IWebPartData:interface' - - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' -functions: - - name: 'PropertyPaneButton(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' - package: '@microsoft/sp-webpart-base!' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!' + summary: SharePoint Framework support for building web parts. + remarks: >- + This package defines the APIs used by developers to create a custom web part. A web part is a reusable visual + object that a page author can add to their content, and customize using a property pane. Examples of web parts + include an embedded video player, a map, a group calendar, a chart, etc. + name: '@microsoft/sp-webpart-base' + fullName: '@microsoft/sp-webpart-base' + langs: + - typeScript + type: package + children: + - '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPart:class' + - '@microsoft/sp-webpart-base!BaseWebPartContext:class' + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + - '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + - '@microsoft/sp-webpart-base!ISDKs:interface' + - '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartContext:interface' + - '@microsoft/sp-webpart-base!IWebPartData:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' + - '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + - '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' + - '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' + - '@microsoft/sp-webpart-base!WebPartContext:class' + - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' summary: Helper method to create a Button on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneButton(targetProperty, properties)' + fullName: 'PropertyPaneButton(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' + description: '' parameters: - id: targetProperty description: Target property the Button is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Button properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneCheckbox(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' summary: Helper method to create a Checkbox on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneCheckbox(targetProperty, properties)' + fullName: 'PropertyPaneCheckbox(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' + description: '' parameters: - id: targetProperty description: Target property the checkbox is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Checkbox properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' summary: Helper method to create a Choice Group on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' + description: '' parameters: - id: targetProperty description: Target property the choice group is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Choice Group properties. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneCustomField(properties) - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField:function(1)' summary: Helper method to create a custom field on the PropertyPane. remarks: >- The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap. - + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. isPreview: true - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + name: PropertyPaneCustomField(properties) + fullName: PropertyPaneCustomField(properties) + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' + description: '' parameters: - id: properties description: Strongly typed Custom field properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDropdown(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' summary: Helper method to create a Dropdown on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneDropdown(targetProperty, properties)' + fullName: 'PropertyPaneDropdown(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' + description: '' parameters: - id: targetProperty description: Target property the dropdown is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Dropdown properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicField(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneDynamicField(targetProperty, properties)' + fullName: 'PropertyPaneDynamicField(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneDynamicField~0:complex' + description: '' parameters: - id: targetProperty description: Target property the Dynamic Data widget is associated to. - type: string + type: + - string + optional: false - id: properties description: '' - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneDynamicFieldSet(properties) - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet:function(1)' summary: >- Helper method to create a Dynamic Data widget on the Property Pane for a set of dynamic fields with a common data source. These fields can possibly share the same property based on the associated filters. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: PropertyPaneDynamicFieldSet(properties) + fullName: PropertyPaneDynamicFieldSet(properties) + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet~0:complex' + description: '' parameters: - id: properties description: >- Contains entries and options, described as below: entries - A set of entries to be configured by the widget. Each entry includes the target property and, optionally, the label to show. options - Options enabling customized values for callback, filters etc., for the given set of dynamic fields. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' summary: Helper method to create a Dynamic TextField on the PropertyPane. - remarks: '' - + deprecated: + content: >- + This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please + consume it from there. isPreview: true - isDeprecated: true - customDeprecatedMessage: >- - This has been replaced by PropertyPaneDynamicField and moved to `@microsoft/sp-property-pane`. Please - consume it from there. + name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + fullName: 'PropertyPaneDynamicTextField(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField~0:complex' + description: '' parameters: - id: targetProperty description: Target property the dynamic textfield is associated to. - type: string + type: + - string + optional: false - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: '' - return: - type: >- - <> - description: '' - - name: PropertyPaneHorizontalRule() - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule:function(1)' summary: Helper method to create a Horizontal Rule on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: PropertyPaneHorizontalRule() + fullName: PropertyPaneHorizontalRule() + langs: + - typeScript + type: function syntax: content: 'export declare function PropertyPaneHorizontalRule(): IPropertyPaneField;' return: - type: '<void>' + type: + - '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule~0:complex' description: '' - - name: 'PropertyPaneLabel(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' - package: '@microsoft/sp-webpart-base!' + - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' summary: Helper method to create a Label on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneLabel(targetProperty, properties)' + fullName: 'PropertyPaneLabel(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' + description: '' parameters: - id: targetProperty description: Target property the label is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Label properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneLink(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' summary: Helper method to create a Link on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneLink(targetProperty, properties)' + fullName: 'PropertyPaneLink(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' + description: '' parameters: - id: targetProperty description: Target property the Link is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Link properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneSlider(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' summary: Helper method to create a Slider on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneSlider(targetProperty, properties)' + fullName: 'PropertyPaneSlider(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' + description: '' parameters: - id: targetProperty description: Target property the slider is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Slider properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneTextField(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' summary: Helper method to create a TextField on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneTextField(targetProperty, properties)' + fullName: 'PropertyPaneTextField(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' + description: '' parameters: - id: targetProperty description: Target property the textfield is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed TextField properties. - type: '' - return: - type: >- - <> - description: '' - - name: 'PropertyPaneToggle(targetProperty, properties)' - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' - package: '@microsoft/sp-webpart-base!' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' summary: Helper method to create a Toggle on the PropertyPane. - remarks: '' - - isPreview: false - isDeprecated: true - customDeprecatedMessage: >- - This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it - from there. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: 'PropertyPaneToggle(targetProperty, properties)' + fullName: 'PropertyPaneToggle(targetProperty, properties)' + langs: + - typeScript + type: function syntax: content: >- export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField; + return: + type: + - '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' + description: '' parameters: - id: targetProperty description: Target property the toggle is associated to. - type: string + type: + - string + optional: false - id: properties description: Strongly typed Toggle properties. - type: '' - return: - type: >- - <> - description: '' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + optional: false +references: + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + name: BaseClientSideWebPart + - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' + name: BaseWebPart + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' + name: BaseWebPartContext + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + name: DynamicDataSharedDepth + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + name: IClientSideWebPartStatusRenderer + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + name: IMicrosoftTeams + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + name: IPropertyPaneAccessor + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + name: IPropertyPaneDynamicFieldFilters + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + name: IPropertyPanePage + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' + name: ISDKs + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + name: ISerializedWebPartData + - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' + name: IWebPartContext + - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' + name: IWebPartData + - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + name: IWebPartPropertiesMetadata + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' + name: IWebPartPropertyMetadata + - uid: '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + name: PropertyPaneButtonType + - uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + name: PropertyPaneDropdownOptionType + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicFieldSet~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + name: PropertyPaneFieldType + - uid: '@microsoft/sp-webpart-base!PropertyPaneHorizontalRule~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' + name: IPropertyPaneField + fullName: IPropertyPaneField + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - name: < + fullName: < + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + - name: '>' + fullName: '>' + - uid: '@microsoft/sp-webpart-base!WebPartContext:class' + name: WebPartContext + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + name: WebPartFormFactor diff --git a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml index 030ac280..58c4230e 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -1,48 +1,63 @@ -### YamlMime:TSType -name: BaseClientSideWebPart -uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' -package: '@microsoft/sp-webpart-base!' -fullName: BaseClientSideWebPart -summary: >- - This abstract class implements the the base functionality for a client-side web part. Every client-side web part needs - to inherit from this class. -remarks: >- - Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall in - two catagories. - +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' + summary: >- + This abstract class implements the the base functionality for a client-side web part. Every client-side web part + needs to inherit from this class. + remarks: >- + Along with the base functionality, this class provides some APIs that can be used by the web part. These APIs fall + in two catagories. - The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This API - should be used to access contextual data relevant to this web part instance. + The first category of APIs provide data and functionality. Example, the web part context (i.e. this.context). This + API should be used to access contextual data relevant to this web part instance. - The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an - updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web part. - All other life cycle APIs have a base implementation and can be overridden based on the needs of the web part. Please - refer to the documentation of the individual APIs to make the right decision. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' + The second category of APIs provide a base implementation for the web part lifecycle and can be overridden for an + updated implementation. The render() API is the only API that is mandatory to be implemented/overridden by a web + part. All other life cycle APIs have a base implementation and can be overridden based on the needs of the web + part. Please refer to the documentation of the individual APIs to make the right decision. + name: BaseClientSideWebPart + fullName: BaseClientSideWebPart + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-webpart-base!default:class' + inheritance: + - type: '@microsoft/sp-webpart-base!default:class' package: '@microsoft/sp-webpart-base!' - fullName: (constructor)() + children: + - '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onThemeChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#width:member' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:constructor(1)' summary: Constructor for the BaseClientSideWebPart class. remarks: >- It is highly recommended that the web part use the `onInit()` API to perform any web part specific initialization. Most of the web part features like this.context and `this.properties` are not available to be used before the the `onInit()` part of the web part loading lifecycle. - - isPreview: false - isDeprecated: false + name: (constructor)() + fullName: (constructor)() + langs: + - typeScript + type: constructor syntax: content: constructor(); -properties: - - name: canOpenPopupOnRender - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' - package: '@microsoft/sp-webpart-base!' - fullName: canOpenPopupOnRender + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#canOpenPopupOnRender:member' summary: This property indicates whether a web part can open a popup on initial render. remarks: >- In some environments the host re-renders the web parts frequently, and therefore opening popups during render will @@ -54,48 +69,60 @@ properties: returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render. - - isPreview: false - isDeprecated: false + name: canOpenPopupOnRender + fullName: canOpenPopupOnRender + langs: + - typeScript + type: property syntax: content: 'protected get canOpenPopupOnRender(): boolean;' return: - type: boolean - - name: context - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' - package: '@microsoft/sp-webpart-base!' - fullName: context + type: + - boolean + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' + summary: This API should be used to clear the error message from the web part display area. + name: clearError() + fullName: clearError() + langs: + - typeScript + type: method + syntax: + content: 'protected clearError(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'readonly context: WebPartContext;' return: - type: '' - - name: domElement - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' - package: '@microsoft/sp-webpart-base!' - fullName: domElement + type: + - '@microsoft/sp-webpart-base!default:class' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' summary: >- This property is a pointer to the root DOM element of the web part. This is a DIV element and contains the whole DOM subtree of the web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'protected get domElement(): HTMLElement;' return: - type: HTMLElement - - name: isRenderAsync - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' - package: '@microsoft/sp-webpart-base!' - fullName: isRenderAsync + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#isRenderAsync:member' summary: Indicates whether the web part is rendering in Async mode. remarks: >- If the web part overrides this field to return true, then it needs to call renderCompleted API after the web part @@ -103,103 +130,45 @@ properties: The default value is false. - - isPreview: false - isDeprecated: false + name: isRenderAsync + fullName: isRenderAsync + langs: + - typeScript + type: property syntax: content: |- /** @virtual */ protected get isRenderAsync(): boolean; return: - type: boolean - - name: renderedFromPersistedData - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' - package: '@microsoft/sp-webpart-base!' - fullName: renderedFromPersistedData - summary: >- - This property indicates whether the web part was rendered from the persisted data (serialized state from the last - time that the web part was saved) or not. - remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get renderedFromPersistedData(): boolean;' - return: - type: boolean - - name: renderedOnce - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' - package: '@microsoft/sp-webpart-base!' - fullName: renderedOnce - summary: >- - This property indicates whether the web part has been rendered once or not. After the first time rendering, the - value of this property is always true until a full re-render of the web part happens. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get renderedOnce(): boolean;' - return: - type: boolean - - name: width - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#width:member' - package: '@microsoft/sp-webpart-base!' - fullName: width - summary: This propery returns the width of the container for the web part. - remarks: >- - Web parts should utilize this property to perform operations such as any conditional styling of components based - on the initial available width for the web part. - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get width(): number;' - return: - type: number -methods: - - name: clearError() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#clearError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: clearError() - summary: This API should be used to clear the error message from the web part display area. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected clearError(): void;' - return: - type: void - description: '' - - name: onAfterResize(newWidth) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onAfterResize(newWidth) + type: + - boolean + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize:member(1)' summary: >- This API is invoked when the web part container dom element width is changed, e.g. when the browser browser window is resized and when the property pane is toggled open/closed. remarks: >- Web parts should utilize this method to perform operations such as potentially re-rendering components based on the new available width for the web part. - - isPreview: false - isDeprecated: false + name: onAfterResize(newWidth) + fullName: onAfterResize(newWidth) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onAfterResize(newWidth: number): void; + return: + type: + - void + description: '' parameters: - id: newWidth description: Width (in pixels) of the container for the web part after the resize event. - type: number - return: - type: void - description: '' - - name: onDisplayModeChanged(oldDisplayMode) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDisplayModeChanged(oldDisplayMode) + type: + - number + optional: false + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDisplayModeChanged:member(1)' summary: This event method is called when the display mode of a web part is changed. remarks: >- The default implementation of this API calls the web part render method to re-render the web part with the new @@ -209,118 +178,187 @@ methods: If the web part is initialized or re-initialized when switching to a different display mode then this lifecycle method is not called. Example: SharePoint Site Page. - - isPreview: false - isDeprecated: false + name: onDisplayModeChanged(oldDisplayMode) + fullName: onDisplayModeChanged(oldDisplayMode) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; + return: + type: + - void + description: '' parameters: - id: oldDisplayMode description: The old display mode. - type: '' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDispose() + type: + - '@microsoft/sp-core-library!DisplayMode:enum' + optional: false + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onDispose:member(1)' summary: This API should be used to refresh the contents of the PropertyPane. remarks: >- This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - - isPreview: false - isDeprecated: false + name: onDispose() + fullName: onDispose() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onDispose(): void; return: - type: void + type: + - void description: '' - - name: onThemeChanged(theme) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onThemeChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onThemeChanged(theme) + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onThemeChanged:member(1)' summary: This API is called when a theme is initialized or changed on the page or for the current section. remarks: >- Developers sould not call render in overridden method. It can lead to unpredicted re-flow of the web part. render will be called from the base class when needed. - - isPreview: false - isDeprecated: false + name: onThemeChanged(theme) + fullName: onThemeChanged(theme) + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected onThemeChanged(theme: IReadonlyTheme | undefined): void; + return: + type: + - void + description: '' parameters: - id: theme description: New theme for the page or section - type: ' | undefined' - return: - type: void - description: '' - - name: render() - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: render() + type: + - '@microsoft/sp-webpart-base!BaseClientSideWebPart#onThemeChanged~0:complex' + optional: false + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#render:member(1)' summary: >- This API is called to render the web part. There is no base implementation of this API and the web part is required to override this API. - remarks: '' - - isPreview: false - isDeprecated: false + name: render() + fullName: render() + langs: + - typeScript + type: method syntax: content: 'protected abstract render(): void;' return: - type: void + type: + - void description: '' - - name: renderCompleted(error) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: renderCompleted(error) + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' summary: >- This API should be called by web parts that perform Async rendering. Those web part are required to override the isRenderAsync API and return true. One such example is web parts that render content in an IFrame. The web part initiates the IFrame rendering in the `render()` API but the actual rendering is complete only after the iframe loading completes. - remarks: '' - - isPreview: false - isDeprecated: false + name: renderCompleted(error) + fullName: renderCompleted(error) + langs: + - typeScript + type: method syntax: content: 'protected renderCompleted(error?: Error): void;' + return: + type: + - void + description: '' parameters: - id: error description: '' - type: Error + type: + - '!Error:interface' + optional: true + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedFromPersistedData:member' + summary: >- + This property indicates whether the web part was rendered from the persisted data (serialized state from the last + time that the web part was saved) or not. + remarks: 'Example: When web part is added for the first time using toolbox then the value is false.' + name: renderedFromPersistedData + fullName: renderedFromPersistedData + langs: + - typeScript + type: property + syntax: + content: 'protected get renderedFromPersistedData(): boolean;' return: - type: void - description: '' - - name: renderError(error) - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: renderError(error) + type: + - boolean + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderedOnce:member' + summary: >- + This property indicates whether the web part has been rendered once or not. After the first time rendering, the + value of this property is always true until a full re-render of the web part happens. + name: renderedOnce + fullName: renderedOnce + langs: + - typeScript + type: property + syntax: + content: 'protected get renderedOnce(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderError:member(1)' summary: >- This API should be used to render an error message in the web part display area. Also logs the error message using the trace logger. - remarks: '' - - isPreview: false - isDeprecated: false + name: renderError(error) + fullName: renderError(error) + langs: + - typeScript + type: method syntax: content: 'protected renderError(error: Error): void;' + return: + type: + - void + description: '' parameters: - id: error description: An error object containing the error message to render. - type: Error + type: + - '!Error:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#width:member' + summary: This propery returns the width of the container for the web part. + remarks: >- + Web parts should utilize this property to perform operations such as any conditional styling of components based + on the initial available width for the web part. + name: width + fullName: width + langs: + - typeScript + type: property + syntax: + content: 'protected get width(): number;' return: - type: void - description: '' -extends: '<TProperties> ' + type: + - number +references: + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPart + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + name: DisplayMode + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onThemeChanged~0:complex' + name: IReadonlyTheme | undefined + fullName: IReadonlyTheme | undefined + spec.typeScript: + - uid: '@microsoft/sp-component-base!IReadonlyTheme:interface' + name: IReadonlyTheme + fullName: IReadonlyTheme + - name: ' | undefined' + fullName: ' | undefined' + - uid: '!Error:interface' + name: Error diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index c99cd52c..056705f1 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -1,96 +1,116 @@ -### YamlMime:TSType -name: BaseWebPart -uid: '@microsoft/sp-webpart-base!BaseWebPart:class' -package: '@microsoft/sp-webpart-base!' -fullName: BaseWebPart -summary: >- - This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to allow - a common core between 2D and MR WebParts. -remarks: '' - -isPreview: false -isDeprecated: false -type: class -constructors: - - name: (constructor)() - uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!BaseWebPart:class' + summary: >- + This abstract class implements the UI-agnostic base functionality for a client-side web part. The purpose is to + allow a common core between 2D and MR WebParts. + name: BaseWebPart + fullName: BaseWebPart + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-component-base!BaseComponent:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponent:class' + implements: + - '@microsoft/sp-property-pane!IPropertyPaneConsumer:interface' package: '@microsoft/sp-webpart-base!' - fullName: (constructor)() + children: + - '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' + - '@microsoft/sp-webpart-base!BaseWebPart#context:member' + - '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' + - '@microsoft/sp-webpart-base!BaseWebPart#description:member' + - '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' + - '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' + - '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' + - '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' + - '@microsoft/sp-webpart-base!BaseWebPart#properties:member' + - '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' + - '@microsoft/sp-webpart-base!BaseWebPart#title:member' + - uid: '@microsoft/sp-webpart-base!BaseWebPart:constructor(1)' summary: Constructor for the `BaseWebPart` class. remarks: >- It is highly recommended that the web part use the OnInit API to perform any web part specific initialization. Most of the web part features like this.context and this.properties are not available to be used before the the onInit part of the web part loading lifecycle. - - isPreview: false - isDeprecated: false + name: (constructor)() + fullName: (constructor)() + langs: + - typeScript + type: constructor syntax: content: constructor(); -properties: - - name: accessibleTitle - uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' - package: '@microsoft/sp-webpart-base!' - fullName: accessibleTitle + - uid: '@microsoft/sp-webpart-base!BaseWebPart#accessibleTitle:member' summary: >- This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: accessibleTitle + fullName: accessibleTitle + langs: + - typeScript + type: property syntax: content: 'protected get accessibleTitle(): string;' return: - type: string - - name: context - uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' - package: '@microsoft/sp-webpart-base!' - fullName: context + type: + - string + - uid: '@microsoft/sp-webpart-base!BaseWebPart#context:member' summary: Use the context object to access common services and state associated with the component. remarks: >- Child classes are expected to override this field by redeclaring it with a specialized type. It is meant to be a read-only property; the type cannot be declared as read-only in the base class (because it is initialized outside the constructor), but child classes should redeclare it as readonly. - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'readonly context: BaseWebPartContext;' return: - type: '' - - name: dataVersion - uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' - package: '@microsoft/sp-webpart-base!' - fullName: dataVersion + type: + - '@microsoft/sp-webpart-base!default:class' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' summary: >- The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0 - remarks: '' - - isPreview: false - isDeprecated: false + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property syntax: content: 'protected get dataVersion(): Version;' return: - type: '' - - name: description - uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' - package: '@microsoft/sp-webpart-base!' - fullName: description + type: + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' summary: Description of the WebPart - remarks: '' - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'protected get description(): string;' return: - type: string - - name: disableReactivePropertyChanges - uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' - package: '@microsoft/sp-webpart-base!' - fullName: disableReactivePropertyChanges + type: + - string + - uid: '@microsoft/sp-webpart-base!BaseWebPart#disableReactivePropertyChanges:member' summary: This property is used to change the web part's property pane interaction from Reactive to NonReactive. virtual remarks: >- The default behavior is Reactive. @@ -103,90 +123,29 @@ properties: NonReactive implies that the configuration changes are transmitted to the web part only after "Apply" PropertyPane button is clicked. - - isPreview: false - isDeprecated: false + name: disableReactivePropertyChanges + fullName: disableReactivePropertyChanges + langs: + - typeScript + type: property syntax: content: 'protected get disableReactivePropertyChanges(): boolean;' return: - type: boolean - - name: displayMode - uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' - package: '@microsoft/sp-webpart-base!' - fullName: displayMode + type: + - boolean + - uid: '@microsoft/sp-webpart-base!BaseWebPart#displayMode:member' summary: This property is the current display mode of the web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: displayMode + fullName: displayMode + langs: + - typeScript + type: property syntax: content: 'get displayMode(): DisplayMode;' return: - type: '' - - name: previewImageUrl - uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' - package: '@microsoft/sp-webpart-base!' - fullName: previewImageUrl - summary: >- - This property points to the preview image for the web part. The base implementation returns undefined. Web parts - that want to provide a valid preview image url need to override this API. The preview image url can be used to - create a preview of the web part or of the page on which the web part is present. virtual - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'get previewImageUrl(): string | undefined;' - return: - type: string | undefined - - name: properties - uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' - package: '@microsoft/sp-webpart-base!' - fullName: properties - summary: This property is the pointer to the custom property bag of the web part. - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get properties(): TProperties;' - return: - type: TProperties - - name: propertiesMetadata - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' - package: '@microsoft/sp-webpart-base!' - fullName: propertiesMetadata - summary: >- - This property defines metadata for the web part property bag. The metadata can help SharePoint understand the - content of the properties better and perform relevant services on the data. virtual - remarks: >- - See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more - information about how to define metadata - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;' - return: - type: ' | undefined' - - name: title - uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' - package: '@microsoft/sp-webpart-base!' - fullName: title - summary: Title of the WebPart - remarks: '' - - isPreview: false - isDeprecated: false - syntax: - content: 'protected get title(): string;' - return: - type: string -methods: - - name: getPropertyPaneConfiguration() - uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: getPropertyPaneConfiguration() + type: + - '@microsoft/sp-core-library!DisplayMode:enum' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#getPropertyPaneConfiguration:member(1)' summary: >- This API is used to ger the configuration to build the property pane for the web part. If the web part wants to use the PropertyPane for configuration, this API needs to be overridden and the web part needs to return the @@ -197,19 +156,18 @@ methods: See IPropertyPane and other PropertyPane integration wiki documentation for more details. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: getPropertyPaneConfiguration() + fullName: getPropertyPaneConfiguration() + langs: + - typeScript + type: method syntax: content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: - type: '' + type: + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' description: '' - - name: loadPropertyPaneResources() - uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: loadPropertyPaneResources() + - uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' summary: This API enables asynchronous loading of property pane related resources of the web part. remarks: >- If not overridden by the web part, base web part resolves the promise immediately. @@ -222,20 +180,20 @@ methods: 'PropertyPaneConfigurationComplete' event can be raised to clean up any pending resources including 'loadPropertyPaneResources' promise. - - isPreview: false - isDeprecated: false + name: loadPropertyPaneResources() + fullName: loadPropertyPaneResources() + langs: + - typeScript + type: method syntax: content: |- /** @virtual */ protected loadPropertyPaneResources(): Promise; return: - type: Promise<void> + type: + - '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources~0:complex' description: '' - - name: 'onAfterDeserialize(deserializedObject, dataVersion)' - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' summary: >- This API is called after the web part is deserialized to an object, right before the property bag is populated. virtual @@ -249,47 +207,50 @@ methods: by an older version of the web part that supported a different schema of the property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag. - - isPreview: false - isDeprecated: false + name: 'onAfterDeserialize(deserializedObject, dataVersion)' + fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' + langs: + - typeScript + type: method syntax: content: 'protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;' + return: + type: + - TProperties + description: The property bag of the web part parameters: - id: deserializedObject description: >- The object deserialized from the stored data. Note that the schema of this object is not necessarily consistent with the current property bag, because the serialization could have been done by an older version of the web part - type: any + type: + - any + optional: false - id: dataVersion description: >- The data version of the stored data being deserialized. You can use this value to determine if the data was serialized by an older web part. Web parts can define their data version by overriding the dataVersion property. - type: '' - return: - type: TProperties - description: The property bag of the web part - - name: onAfterPropertyPaneChangesApplied() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onAfterPropertyPaneChangesApplied() + type: + - '@microsoft/sp-core-library!Version:class' + optional: false + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterPropertyPaneChangesApplied:member(1)' summary: >- This API is invoked after the changes made on the PropertyPane are applied when the PropertyPane is used in Non-Reactive mode. This API is not invoked when the PropertyPane is used in Reactive mode. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: onAfterPropertyPaneChangesApplied() + fullName: onAfterPropertyPaneChangesApplied() + langs: + - typeScript + type: method syntax: content: 'protected onAfterPropertyPaneChangesApplied(): void;' return: - type: void + type: + - void description: '' - - name: onBeforeSerialize() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onBeforeSerialize() + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onBeforeSerialize:member(1)' summary: This event method is called before the web part is serialized. virtual remarks: >- The default implementation is a no-op. The serialization process serializes the web part property bag i.e. @@ -298,18 +259,18 @@ methods: some of that state, it needs to override this API and update the web part property bag to the latest state. If a web part updates the property bag with invalid property values, those will get persisted. So that should be avoided. The web part property bag should always contain valid property values. - - isPreview: false - isDeprecated: false + name: onBeforeSerialize() + fullName: onBeforeSerialize() + langs: + - typeScript + type: method syntax: content: 'protected onBeforeSerialize(): void;' return: - type: void + type: + - void description: '' - - name: onDisplayModeChanged(oldDisplayMode) - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDisplayModeChanged(oldDisplayMode) + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDisplayModeChanged:member(1)' summary: This event method is called when the display mode of a web part is changed. virtual remarks: >- The default implementation of this API calls the web part render method to re-render the web part with the new @@ -319,57 +280,59 @@ methods: If the web part is initialized or re-initialized when switching to a different display mode then this lifecycle method is not called. Example: SharePoint Site Page. - - isPreview: false - isDeprecated: false + name: onDisplayModeChanged(oldDisplayMode) + fullName: onDisplayModeChanged(oldDisplayMode) + langs: + - typeScript + type: method syntax: content: 'protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' + return: + type: + - void + description: '' parameters: - id: oldDisplayMode description: The old display mode. - type: '' - return: - type: void - description: '' - - name: onDispose() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onDispose() + type: + - '@microsoft/sp-core-library!DisplayMode:enum' + optional: false + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onDispose:member(1)' summary: This API should be used to refresh the contents of the PropertyPane. virtual remarks: >- This API is called at the end of the web part lifecycle on a page. It should be used to dispose any local resources (i.e. DOM elements) that the web part is holding onto. This API is expected to be called in scenarios like page navigation i.e. the host is transitioning from one page to another and disposes the page that is being transitioned out. - - isPreview: false - isDeprecated: false + name: onDispose() + fullName: onDispose() + langs: + - typeScript + type: method syntax: content: 'protected onDispose(): void;' return: - type: void + type: + - void description: '' - - name: onInit() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onInit() + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit:member(1)' summary: This event method is called when the web part is initialized. virtual remarks: >- This API should be overridden to perform long running operations e.g. data fetching from a remote service before the initial rendering of the web part. The loading indicator is displayed during the lifetime of this method. This API is called only once during the lifecycle of a web part. - - isPreview: false - isDeprecated: false + name: onInit() + fullName: onInit() + langs: + - typeScript + type: method syntax: content: 'protected onInit(): Promise;' return: - type: Promise<void> + type: + - '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' description: '' - - name: onPropertyPaneConfigurationComplete() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onPropertyPaneConfigurationComplete() + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationComplete:member(1)' summary: This API is invoked when the configuration is completed on the PropertyPane. virtual remarks: |- This event method is invoked in the following cases: @@ -381,18 +344,18 @@ methods: - When user clicks the 'Apply' button before the CONFIGURATION\_COMPLETE\_TIMEOUT elapses. - When the user switches web parts then the current web part gets this event. - - isPreview: false - isDeprecated: false + name: onPropertyPaneConfigurationComplete() + fullName: onPropertyPaneConfigurationComplete() + langs: + - typeScript + type: method syntax: content: 'protected onPropertyPaneConfigurationComplete(): void;' return: - type: void + type: + - void description: '' - - name: onPropertyPaneConfigurationStart() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onPropertyPaneConfigurationStart() + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneConfigurationStart:member(1)' summary: This event method is invoked when the configuration starts on the PropertyPane. virtual remarks: |- This event method is invoked in the following cases: @@ -400,55 +363,157 @@ methods: - When the PropertyPane is opened. - When the user switches web parts then the new web part gets this event. - - isPreview: false - isDeprecated: false + name: onPropertyPaneConfigurationStart() + fullName: onPropertyPaneConfigurationStart() + langs: + - typeScript + type: method syntax: content: 'protected onPropertyPaneConfigurationStart(): void;' return: - type: void + type: + - void description: '' - - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' summary: >- This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + langs: + - typeScript + type: method syntax: content: 'protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' + return: + type: + - void + description: '' parameters: - id: propertyPath description: >- JSON path of the property in the property bag. In the case of custom field, if no target property is provided then a custom value is assigned, which will be in the form of `__CustomField_`. - type: string + type: + - string + optional: false - id: oldValue description: Old value of the property. This value could be undefined/empty in the case of custom field. - type: any + type: + - any + optional: false - id: newValue description: New value of the property. This value could be undefined/empty in the case of custom field. - type: any - return: - type: void - description: '' - - name: onPropertyPaneRendered() - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: onPropertyPaneRendered() + type: + - any + optional: false + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' summary: This API is invoked when the PropertyPane is rendered. virtual - remarks: '' - - isPreview: false - isDeprecated: false + name: onPropertyPaneRendered() + fullName: onPropertyPaneRendered() + langs: + - typeScript + type: method syntax: content: 'protected onPropertyPaneRendered(): void;' return: - type: void + type: + - void description: '' -extends: '' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' + summary: >- + This property points to the preview image for the web part. The base implementation returns undefined. Web parts + that want to provide a valid preview image url need to override this API. The preview image url can be used to + create a preview of the web part or of the page on which the web part is present. virtual + name: previewImageUrl + fullName: previewImageUrl + langs: + - typeScript + type: property + syntax: + content: 'get previewImageUrl(): string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-webpart-base!BaseWebPart#properties:member' + summary: This property is the pointer to the custom property bag of the web part. + name: properties + fullName: properties + langs: + - typeScript + type: property + syntax: + content: 'protected get properties(): TProperties;' + return: + type: + - TProperties + - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata:member' + summary: >- + This property defines metadata for the web part property bag. The metadata can help SharePoint understand the + content of the properties better and perform relevant services on the data. virtual + remarks: >- + See [IWebPartPropertiesMetadata](xref:@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface) for more + information about how to define metadata + name: propertiesMetadata + fullName: propertiesMetadata + langs: + - typeScript + type: property + syntax: + content: 'protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;' + return: + type: + - '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata~0:complex' + - uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' + summary: Title of the WebPart + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'protected get title(): string;' + return: + type: + - string +references: + - uid: '@microsoft/sp-component-base!BaseComponent:class' + name: BaseComponent + - uid: '@microsoft/sp-property-pane!IPropertyPaneConsumer:interface' + name: IPropertyPaneConsumer + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPartContext + - uid: '@microsoft/sp-core-library!Version:class' + name: Version + - uid: '@microsoft/sp-core-library!DisplayMode:enum' + name: DisplayMode + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' + name: Promise + fullName: Promise + spec.typeScript: + - uid: '!Promise:interface' + name: Promise + fullName: Promise + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!BaseWebPart#propertiesMetadata~0:complex' + name: IWebPartPropertiesMetadata | undefined + fullName: IWebPartPropertiesMetadata | undefined + spec.typeScript: + - uid: '@microsoft/sp-webpart-base!~IWebPartPropertiesMetadata:interface' + name: IWebPartPropertiesMetadata + fullName: IWebPartPropertiesMetadata + - name: ' | undefined' + fullName: ' | undefined' diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index ce02474f..5f259127 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -1,74 +1,95 @@ -### YamlMime:TSType -name: BaseWebPartContext -uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' -package: '@microsoft/sp-webpart-base!' -fullName: BaseWebPartContext -summary: >- - Web part context object. This object contains the contextual services available to a web part. e.g. a contextual - instance to the http client. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext:class' + summary: >- + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. - This base is to be extended by UI-specific WebPart's base. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `BaseWebPartContext` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: formFactor - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' + This base is to be extended by UI-specific WebPart's base. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `BaseWebPartContext` class. + name: BaseWebPartContext + fullName: BaseWebPartContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-component-base!BaseComponentContext:class' + inheritance: + - type: '@microsoft/sp-component-base!BaseComponentContext:class' package: '@microsoft/sp-webpart-base!' - fullName: formFactor + children: + - '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' + - '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' + - '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' + - '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#formFactor:member' summary: Form factor of the web part. remarks: >- Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas. - isPreview: true - isDeprecated: false + name: formFactor + fullName: formFactor + langs: + - typeScript + type: property syntax: content: 'get formFactor(): WebPartFormFactor;' return: - type: '' - - name: manifest - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' - package: '@microsoft/sp-webpart-base!' - fullName: manifest + type: + - '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' summary: Manifest for the client-side component. - remarks: '' - - isPreview: false - isDeprecated: false + name: manifest + fullName: manifest + langs: + - typeScript + type: property syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: '<any>' - - name: propertyPane - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' - package: '@microsoft/sp-webpart-base!' - fullName: propertyPane + type: + - '@microsoft/sp-webpart-base!BaseWebPartContext#manifest~0:complex' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' summary: Accessor for common web part property pane operations. - remarks: '' - - isPreview: false - isDeprecated: false + name: propertyPane + fullName: propertyPane + langs: + - typeScript + type: property syntax: content: 'get propertyPane(): IPropertyPaneAccessor;' return: - type: '' - - name: webPartTag - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' - package: '@microsoft/sp-webpart-base!' - fullName: webPartTag + type: + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' summary: Web part tag to be used for logging and telemetry. - remarks: '' - - isPreview: false - isDeprecated: false + name: webPartTag + fullName: webPartTag + langs: + - typeScript + type: property syntax: content: 'get webPartTag(): string;' return: - type: string -extends: '' + type: + - string +references: + - uid: '@microsoft/sp-component-base!BaseComponentContext:class' + name: BaseComponentContext + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + name: WebPartFormFactor + - uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest~0:complex' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + - name: + fullName: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + name: IPropertyPaneAccessor diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml index 7b4efcba..a5e042ed 100644 --- a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -1,27 +1,42 @@ -### YamlMime:TSEnum -name: DynamicDataSharedDepth -uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' -package: '@microsoft/sp-webpart-base!' -fullName: DynamicDataSharedDepth -summary: Enum for the possible values of shared depth of the dynamic data reference. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: None - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth:enum' + summary: Enum for the possible values of shared depth of the dynamic data reference. + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. + name: DynamicDataSharedDepth + fullName: DynamicDataSharedDepth + langs: + - typeScript + type: enum package: '@microsoft/sp-webpart-base!' + children: + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' + - '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.None:member' summary: Indicates that nothing is shared. - value: '0' - - name: Property - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' - package: '@microsoft/sp-webpart-base!' + name: None + fullName: None + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Property:member' summary: Indicates that both the dynamic data source and the property are shared. - value: '2' - - name: Source - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' - package: '@microsoft/sp-webpart-base!' + name: Property + fullName: Property + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-webpart-base!DynamicDataSharedDepth.Source:member' summary: Indicates that the dynamic data source is shared. - value: '1' + name: Source + fullName: Source + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 37f37142..a25a2774 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -1,109 +1,142 @@ -### YamlMime:TSType -name: IClientSideWebPartStatusRenderer -uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IClientSideWebPartStatusRenderer -summary: >- - Interface to be implemented by a component that should display the loading indicator and error messages for a web - part. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -methods: - - name: clearError(domElement) - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface' + summary: >- + Interface to be implemented by a component that should display the loading indicator and error messages for a web + part. + name: IClientSideWebPartStatusRenderer + fullName: IClientSideWebPartStatusRenderer + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: clearError(domElement) + children: + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearError:member(1)' summary: Clear the webpart error message. - remarks: '' - - isPreview: false - isDeprecated: false + name: clearError(domElement) + fullName: clearError(domElement) + langs: + - typeScript + type: method syntax: content: 'clearError(domElement: HTMLElement): void;' + return: + type: + - void + description: '' parameters: - id: domElement description: the web part container div. - type: HTMLElement - return: - type: void - description: '' - - name: clearLoadingIndicator(domElement) - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: clearLoadingIndicator(domElement) + type: + - '!HTMLElement:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' summary: Clear the loading indicator. - remarks: '' - - isPreview: false - isDeprecated: false + name: clearLoadingIndicator(domElement) + fullName: clearLoadingIndicator(domElement) + langs: + - typeScript + type: method syntax: content: 'clearLoadingIndicator(domElement: Element): void;' + return: + type: + - void + description: '' parameters: - id: domElement description: the web part container div. - type: Element - return: - type: void - description: '' - - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' + type: + - '!Element:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' summary: Display a loading spinner. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' + fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' + langs: + - typeScript + type: method syntax: content: >- displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number, clearDomElementCallback?: ClearDomElementCallback): void; + return: + type: + - void + description: '' parameters: - id: domElement description: the web part container div. - type: Element + type: + - '!Element:interface' + optional: false - id: loadingMessage description: the message to be displayed when the loading spinner id displayed. - type: string + type: + - string + optional: false - id: timeout description: timeout to render the loading indicator. Default is 1500ms. - type: number + type: + - number + optional: true - id: clearDomElementCallback description: >- Callback to clear the dom node before rendering the indicator. Standard DOM API will be used after the callback. - type: '' - return: - type: void - description: '' - - name: 'renderError(domElement, error, clearDomElementCallback)' - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: 'renderError(domElement, error, clearDomElementCallback)' + type: + - '@microsoft/sp-webpart-base!ClearDomElementCallback:type' + optional: true + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' summary: Render the provided error message in the webpart container div. - remarks: '' - - isPreview: false - isDeprecated: false + name: 'renderError(domElement, error, clearDomElementCallback)' + fullName: 'renderError(domElement, error, clearDomElementCallback)' + langs: + - typeScript + type: method syntax: content: >- renderError(domElement: HTMLElement, error: Error | string, clearDomElementCallback?: ClearDomElementCallback): void; + return: + type: + - void + description: '' parameters: - id: domElement description: the web part container div. - type: HTMLElement + type: + - '!HTMLElement:interface' + optional: false - id: error description: the error message. - type: Error | string + type: + - '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError~0:complex' + optional: false - id: clearDomElementCallback description: >- Callback to clear the dom node before rendering the error element. Standard DOM API will be used after the callback. - type: '' - return: - type: void - description: '' + type: + - '@microsoft/sp-webpart-base!ClearDomElementCallback:type' + optional: true +references: + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '!Element:interface' + name: Element + - uid: '@microsoft/sp-webpart-base!ClearDomElementCallback:type' + name: ClearDomElementCallback + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError~0:complex' + name: Error | string + fullName: Error | string + spec.typeScript: + - uid: '!Error:interface' + name: Error + fullName: Error + - name: ' | string' + fullName: ' | string' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index c1d3dc4d..4ef2b1c9 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyConfiguration -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedPropertyConfiguration -summary: Configuration related to a shared property. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration:interface' + summary: Configuration related to a shared property. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~0:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + fullName: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyConfiguration~1:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + fullName: SPPropertyPane.IDynamicDataSharedPropertyConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface' + name: IDynamicDataSharedPropertyConfiguration + fullName: IDynamicDataSharedPropertyConfiguration diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index b2785cc7..fae699e2 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IDynamicDataSharedPropertyFilters -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedPropertyFilters -summary: Property pane dynamic data property filters. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters:interface' + summary: Property pane dynamic data property filters. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~0:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyFilters + fullName: SPPropertyPane.IDynamicDataSharedPropertyFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedPropertyFilters~1:complex' + name: SPPropertyPane.IDynamicDataSharedPropertyFilters + fullName: SPPropertyPane.IDynamicDataSharedPropertyFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface' + name: IDynamicDataSharedPropertyFilters + fullName: IDynamicDataSharedPropertyFilters diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index f247b9c0..1d990123 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceConfiguration -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedSourceConfiguration -summary: Configuration related to a shared source. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration:interface' + summary: Configuration related to a shared source. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~0:complex' + name: SPPropertyPane.IDynamicDataSharedSourceConfiguration + fullName: SPPropertyPane.IDynamicDataSharedSourceConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceConfiguration~1:complex' + name: SPPropertyPane.IDynamicDataSharedSourceConfiguration + fullName: SPPropertyPane.IDynamicDataSharedSourceConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface' + name: IDynamicDataSharedSourceConfiguration + fullName: IDynamicDataSharedSourceConfiguration diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index a62c555e..2ba51835 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IDynamicDataSharedSourceFilters -uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IDynamicDataSharedSourceFilters -summary: Property pane dynamic data source filters. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters:interface' + summary: Property pane dynamic data source filters. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~0:complex' + name: SPPropertyPane.IDynamicDataSharedSourceFilters + fullName: SPPropertyPane.IDynamicDataSharedSourceFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters + - uid: '@microsoft/sp-webpart-base!IDynamicDataSharedSourceFilters~1:complex' + name: SPPropertyPane.IDynamicDataSharedSourceFilters + fullName: SPPropertyPane.IDynamicDataSharedSourceFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface' + name: IDynamicDataSharedSourceFilters + fullName: IDynamicDataSharedSourceFilters diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index f2fdae3b..1e6f218b 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -1,40 +1,52 @@ -### YamlMime:TSType -name: IMicrosoftTeams -uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IMicrosoftTeams -summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: context - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams. + name: IMicrosoftTeams + fullName: IMicrosoftTeams + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: context + children: + - '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' + - '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#context:member' summary: Microsoft Teams' Context. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/microsoftteams.context?view=msteams-client-js-latest) - - isPreview: false - isDeprecated: false + name: context + fullName: context + langs: + - typeScript + type: property syntax: content: 'context: microsoftTeams.Context;' return: - type: microsoftTeams.Context - - name: teamsJs - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' - package: '@microsoft/sp-webpart-base!' - fullName: teamsJs + type: + - '!microsoftTeams.Context:interface' + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' summary: Microsoft Teams SDK. - remarks: '' - - isPreview: false - isDeprecated: false + name: teamsJs + fullName: teamsJs + langs: + - typeScript + type: property syntax: content: 'teamsJs: typeof microsoftTeams;' return: - type: typeof microsoftTeams + type: + - '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs~0:complex' +references: + - uid: '!microsoftTeams.Context:interface' + name: microsoftTeams.Context + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs~0:complex' + name: typeof microsoftTeams + fullName: typeof microsoftTeams + spec.typeScript: + - name: 'typeof ' + fullName: 'typeof ' + - uid: '!microsoftTeams:namespace' + name: microsoftTeams + fullName: microsoftTeams diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 6396ea40..a0e445fc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -1,106 +1,110 @@ -### YamlMime:TSType -name: IPropertyPaneAccessor -uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneAccessor -summary: >- - Web part context property pane accessor interface. Provides some most commonly used operations to access the property - pane. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -methods: - - name: close() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + summary: >- + Web part context property pane accessor interface. Provides some most commonly used operations to access the + property pane. + name: IPropertyPaneAccessor + fullName: IPropertyPaneAccessor + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: close() + children: + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#close:member(1)' summary: This API should be used to close the PropertyPane to help configure the web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: close() + fullName: close() + langs: + - typeScript + type: method syntax: content: 'close(): void;' return: - type: void + type: + - void description: '' - - name: isPropertyPaneOpen() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: isPropertyPaneOpen() + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)' summary: Returns true if the PropertyPane is open. - remarks: '' - - isPreview: false - isDeprecated: false + name: isPropertyPaneOpen() + fullName: isPropertyPaneOpen() + langs: + - typeScript + type: method syntax: content: 'isPropertyPaneOpen(): boolean;' return: - type: boolean + type: + - boolean description: '' - - name: isRenderedByWebPart() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: isRenderedByWebPart() + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#isRenderedByWebPart:member(1)' summary: Indicates whether the PropertyPane was initially opened by the web part. remarks: >- For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false. - - isPreview: false - isDeprecated: false + name: isRenderedByWebPart() + fullName: isRenderedByWebPart() + langs: + - typeScript + type: method syntax: content: 'isRenderedByWebPart(): boolean;' return: - type: boolean + type: + - boolean description: '' - - name: open() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: open() + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#open:member(1)' summary: This API should be used to open the PropertyPane to help configure the web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: open() + fullName: open() + langs: + - typeScript + type: method syntax: content: 'open(): void;' return: - type: void + type: + - void description: '' - - name: openDetails(context) - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: openDetails(context) + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#openDetails:member(1)' summary: This API should be used to open the Details PropertyPane to help configure the items in the web part. remarks: 'This API is mainly used for configuring Details, which is different from configuring the web part itself.' - - isPreview: false - isDeprecated: false + name: openDetails(context) + fullName: openDetails(context) + langs: + - typeScript + type: method syntax: content: 'openDetails(context?: any): void;' + return: + type: + - void + description: '' parameters: - id: context description: Add additional context for property pane - type: any - return: - type: void - description: '' - - name: refresh() - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' - package: '@microsoft/sp-webpart-base!' - fullName: refresh() + type: + - any + optional: true + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor#refresh:member(1)' summary: This API should be used to invoke the PropertyPane to help configure the web part. remarks: >- This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact. - - isPreview: false - isDeprecated: false + name: refresh() + fullName: refresh() + langs: + - typeScript + type: method syntax: content: 'refresh(): void;' return: - type: void + type: + - void description: '' diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 6de500f5..5dc9e106 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneButtonProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneButtonProps -summary: PropertyPane button props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface' + summary: PropertyPane button props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~0:complex' + name: SPPropertyPane.IPropertyPaneButtonProps + fullName: SPPropertyPane.IPropertyPaneButtonProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneButtonProps~1:complex' + name: SPPropertyPane.IPropertyPaneButtonProps + fullName: SPPropertyPane.IPropertyPaneButtonProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface' + name: IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index 0380065f..b033ef96 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneCheckboxProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneCheckboxProps -summary: PropertyPane CheckBox component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface' + summary: PropertyPane CheckBox component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~0:complex' + name: SPPropertyPane.IPropertyPaneCheckboxProps + fullName: SPPropertyPane.IPropertyPaneCheckboxProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps~1:complex' + name: SPPropertyPane.IPropertyPaneCheckboxProps + fullName: SPPropertyPane.IPropertyPaneCheckboxProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface' + name: IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 340b6219..017aa245 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOption -uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneChoiceGroupOption -summary: PropertyPane ChoiceGroup option props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption:interface' + summary: PropertyPane ChoiceGroup option props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~0:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOption + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOption~1:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOption + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface' + name: IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 345e8d5f..4d8e935b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupOptionIconProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneChoiceGroupOptionIconProps -summary: PropertyPane ChoiceGroup icon props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps:interface' + summary: PropertyPane ChoiceGroup icon props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~0:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupOptionIconProps~1:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupOptionIconProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface' + name: IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 5d6eca1c..67219ec4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneChoiceGroupProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneChoiceGroupProps -summary: PropertyPane ChoiceGroup props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface' + summary: PropertyPane ChoiceGroup props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~0:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps~1:complex' + name: SPPropertyPane.IPropertyPaneChoiceGroupProps + fullName: SPPropertyPane.IPropertyPaneChoiceGroupProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface' + name: IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 293f8e6d..a016b7df 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneConditionalGroup -uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneConditionalGroup -summary: Property pane conditional group. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + summary: Property pane conditional group. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~0:complex' + name: SPPropertyPane.IPropertyPaneConditionalGroup + fullName: SPPropertyPane.IPropertyPaneConditionalGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup~1:complex' + name: SPPropertyPane.IPropertyPaneConditionalGroup + fullName: SPPropertyPane.IPropertyPaneConditionalGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + fullName: IPropertyPaneConditionalGroup diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index c37e1f69..afd5af58 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneConfiguration -uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneConfiguration -summary: Web part configuration settings -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + summary: Web part configuration settings + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~0:complex' + name: SPPropertyPane.IPropertyPaneConfiguration + fullName: SPPropertyPane.IPropertyPaneConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConfiguration~1:complex' + name: SPPropertyPane.IPropertyPaneConfiguration + fullName: SPPropertyPane.IPropertyPaneConfiguration + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + name: IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index be0046fc..f72ac2a1 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneCustomFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneCustomFieldProps -summary: PropertyPane CustomPropertyField props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface' + summary: PropertyPane CustomPropertyField props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneCustomFieldProps + fullName: SPPropertyPane.IPropertyPaneCustomFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneCustomFieldProps + fullName: SPPropertyPane.IPropertyPaneCustomFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface' + name: IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index baea865f..77cc5300 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownCalloutProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDropdownCalloutProps -summary: PropertyPane dropdown callout properties. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + summary: PropertyPane dropdown callout properties. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~0:complex' + name: SPPropertyPane.IPropertyPaneDropdownCalloutProps + fullName: SPPropertyPane.IPropertyPaneDropdownCalloutProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps~1:complex' + name: SPPropertyPane.IPropertyPaneDropdownCalloutProps + fullName: SPPropertyPane.IPropertyPaneDropdownCalloutProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + fullName: IPropertyPaneDropdownCalloutProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index 8758beed..e805a06b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownOption -uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDropdownOption -summary: PropertyPane drop down options. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption:interface' + summary: PropertyPane drop down options. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~0:complex' + name: SPPropertyPane.IPropertyPaneDropdownOption + fullName: SPPropertyPane.IPropertyPaneDropdownOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownOption~1:complex' + name: SPPropertyPane.IPropertyPaneDropdownOption + fullName: SPPropertyPane.IPropertyPaneDropdownOption + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface' + name: IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 2dbcd2af..2e643bb7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDropdownProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDropdownProps -summary: PropertyPane drop down component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface' + summary: PropertyPane drop down component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~0:complex' + name: SPPropertyPane.IPropertyPaneDropdownProps + fullName: SPPropertyPane.IPropertyPaneDropdownProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownProps~1:complex' + name: SPPropertyPane.IPropertyPaneDropdownProps + fullName: SPPropertyPane.IPropertyPaneDropdownProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface' + name: IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 088a650b..5b01c226 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldFilters -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicFieldFilters -summary: Property pane dynamic field filters which is an intersection of both source and property filters. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters:interface' + summary: Property pane dynamic field filters which is an intersection of both source and property filters. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldFilters + fullName: SPPropertyPane.IPropertyPaneDynamicFieldFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldFilters~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldFilters + fullName: SPPropertyPane.IPropertyPaneDynamicFieldFilters + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + name: IPropertyPaneDynamicFieldFilters + fullName: IPropertyPaneDynamicFieldFilters diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 2db3752f..d55d8df8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicFieldProps -summary: PropertyPaneDynamicField props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface' + summary: PropertyPaneDynamicField props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface' + name: IPropertyPaneDynamicFieldProps + fullName: IPropertyPaneDynamicFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index 16573536..d6ca7df8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicFieldSetProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicFieldSetProps -summary: PropertyPane DynamicFieldSet props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface' + summary: PropertyPane DynamicFieldSet props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + fullName: SPPropertyPane.IPropertyPaneDynamicFieldSetProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface' + name: IPropertyPaneDynamicFieldSetProps + fullName: IPropertyPaneDynamicFieldSetProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index cf66c4cc..8e78b03b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -1,13 +1,36 @@ -### YamlMime:TSType -name: IPropertyPaneDynamicTextFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneDynamicTextFieldProps -summary: '`PropertyPaneDynamicData` component props.' -remarks: '' - -isPreview: true -isDeprecated: true -customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface' + summary: '`PropertyPaneDynamicData` component props.' + deprecated: + content: '- This has been replaced by IPropertyPaneDynamicFieldProps' + isPreview: true + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + fullName: SPPropertyPane.IPropertyPaneDynamicTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface' + name: IPropertyPaneDynamicTextFieldProps + fullName: IPropertyPaneDynamicTextFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index e72daa91..8a6e174e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -1,15 +1,40 @@ -### YamlMime:TSType -name: IPropertyPaneField -uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneField -summary: PropertyPane field. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.<TProperties> ' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField:interface' + summary: PropertyPane field. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneField + fullName: IPropertyPaneField + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' + syntax: + typeParameters: + - id: TProperties + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' + name: SPPropertyPane.IPropertyPaneField + fullName: SPPropertyPane.IPropertyPaneField + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField + - uid: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' + name: SPPropertyPane.IPropertyPaneField + fullName: SPPropertyPane.IPropertyPaneField + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneField:interface' + name: IPropertyPaneField + fullName: IPropertyPaneField diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index b379133d..b985779f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneGroup -uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneGroup -summary: PropertyPane group. Group is part of the PropertyPanePage. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup:interface' + summary: PropertyPane group. Group is part of the PropertyPanePage. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneGroup~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneGroup~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup~0:complex' + name: SPPropertyPane.IPropertyPaneGroup + fullName: SPPropertyPane.IPropertyPaneGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup + - uid: '@microsoft/sp-webpart-base!IPropertyPaneGroup~1:complex' + name: SPPropertyPane.IPropertyPaneGroup + fullName: SPPropertyPane.IPropertyPaneGroup + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneGroup:interface' + name: IPropertyPaneGroup + fullName: IPropertyPaneGroup diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index a989e640..18f19d3e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneLabelProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneLabelProps -summary: PropertyPaneLabel component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface' + summary: PropertyPaneLabel component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~0:complex' + name: SPPropertyPane.IPropertyPaneLabelProps + fullName: SPPropertyPane.IPropertyPaneLabelProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLabelProps~1:complex' + name: SPPropertyPane.IPropertyPaneLabelProps + fullName: SPPropertyPane.IPropertyPaneLabelProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface' + name: IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index 9c42be76..c67f348e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneLinkProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneLinkProps -summary: PropertyPaneLink component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface' + summary: PropertyPaneLink component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~0:complex' + name: SPPropertyPane.IPropertyPaneLinkProps + fullName: SPPropertyPane.IPropertyPaneLinkProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneLinkProps~1:complex' + name: SPPropertyPane.IPropertyPaneLinkProps + fullName: SPPropertyPane.IPropertyPaneLinkProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface' + name: IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index e9345fa8..cb73d7e8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPanePage -uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPanePage -summary: PropertyPanePage interface. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage:interface' + summary: PropertyPanePage interface. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPanePage + fullName: IPropertyPanePage + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPanePage~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPanePage~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage~0:complex' + name: SPPropertyPane.IPropertyPanePage + fullName: SPPropertyPane.IPropertyPanePage + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + fullName: IPropertyPanePage + - uid: '@microsoft/sp-webpart-base!IPropertyPanePage~1:complex' + name: SPPropertyPane.IPropertyPanePage + fullName: SPPropertyPane.IPropertyPanePage + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePage:interface' + name: IPropertyPanePage + fullName: IPropertyPanePage diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index fd82e384..e498c3aa 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPanePageHeader -uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPanePageHeader -summary: PropertyPane header. This header remains same for all the pages. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader:interface' + summary: PropertyPane header. This header remains same for all the pages. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPanePageHeader~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~0:complex' + name: SPPropertyPane.IPropertyPanePageHeader + fullName: SPPropertyPane.IPropertyPanePageHeader + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader + - uid: '@microsoft/sp-webpart-base!IPropertyPanePageHeader~1:complex' + name: SPPropertyPane.IPropertyPanePageHeader + fullName: SPPropertyPane.IPropertyPanePageHeader + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPanePageHeader:interface' + name: IPropertyPanePageHeader + fullName: IPropertyPanePageHeader diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index 4dfa04d0..d73275cf 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneSliderProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneSliderProps -summary: PropertyPaneSliderProps component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface' + summary: PropertyPaneSliderProps component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~0:complex' + name: SPPropertyPane.IPropertyPaneSliderProps + fullName: SPPropertyPane.IPropertyPaneSliderProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneSliderProps~1:complex' + name: SPPropertyPane.IPropertyPaneSliderProps + fullName: SPPropertyPane.IPropertyPaneSliderProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface' + name: IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index ee8fa3f6..7a252708 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneTextFieldProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneTextFieldProps -summary: PropertyPaneTextField component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface' + summary: PropertyPaneTextField component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~0:complex' + name: SPPropertyPane.IPropertyPaneTextFieldProps + fullName: SPPropertyPane.IPropertyPaneTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps~1:complex' + name: SPPropertyPane.IPropertyPaneTextFieldProps + fullName: SPPropertyPane.IPropertyPaneTextFieldProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface' + name: IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 13981c98..e6445ba8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -1,15 +1,37 @@ -### YamlMime:TSType -name: IPropertyPaneToggleProps -uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IPropertyPaneToggleProps -summary: PropertyPaneToggle component props. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from - there. -type: interface -extends: 'SPPropertyPane.' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + summary: PropertyPaneToggle component props. + deprecated: + content: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~1:complex' + package: '@microsoft/sp-webpart-base!' +references: + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~0:complex' + name: SPPropertyPane.IPropertyPaneToggleProps + fullName: SPPropertyPane.IPropertyPaneToggleProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps + - uid: '@microsoft/sp-webpart-base!IPropertyPaneToggleProps~1:complex' + name: SPPropertyPane.IPropertyPaneToggleProps + fullName: SPPropertyPane.IPropertyPaneToggleProps + spec.typeScript: + - name: SPPropertyPane. + fullName: SPPropertyPane. + - uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface' + name: IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index c9c5eae9..fcb1585a 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -1,29 +1,32 @@ -### YamlMime:TSType -name: ISDKs -uid: '@microsoft/sp-webpart-base!ISDKs:interface' -package: '@microsoft/sp-webpart-base!' -fullName: ISDKs -summary: Conditional set of SDKs provided by SPFx dependent on the environment. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: microsoftTeams - uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' + summary: Conditional set of SDKs provided by SPFx dependent on the environment. + name: ISDKs + fullName: ISDKs + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: microsoftTeams + children: + - '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' + - uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' summary: >- Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - - isPreview: false - isDeprecated: false + name: microsoftTeams + fullName: microsoftTeams + langs: + - typeScript + type: property syntax: content: 'microsoftTeams?: IMicrosoftTeams;' return: - type: '' + type: + - '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' +references: + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams:interface' + name: IMicrosoftTeams diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index 74f83a20..0fe906f3 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -1,21 +1,22 @@ -### YamlMime:TSType -name: ISerializedWebPartData -uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' -package: '@microsoft/sp-webpart-base!' -fullName: ISerializedWebPartData -summary: >- - This structure represents the part of the serialized state of a web part which is controlled by the web part. It is - extended by IWebPartData which contains additional data added by the framework to the serialized data. -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dataVersion - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData:interface' + summary: >- + This structure represents the part of the serialized state of a web part which is controlled by the web part. It + is extended by IWebPartData which contains additional data added by the framework to the serialized data. + name: ISerializedWebPartData + fullName: ISerializedWebPartData + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: dataVersion + children: + - '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' + - '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dataVersion:member' summary: Web part data version. remarks: >- Note that data version is different from the version field in the manifest. The manifest version is used to @@ -27,17 +28,17 @@ properties: Example: `"1.0"` - - isPreview: false - isDeprecated: false + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property syntax: content: 'dataVersion: Version;' return: - type: '' - - name: dynamicDataPaths - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataPaths + type: + - '@microsoft/sp-core-library!Version:class' + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' summary: Paths for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. remarks: |- The key is the path within the web part properties, and the value is the dynamic data internal id. @@ -52,23 +53,24 @@ properties: 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' } ``` - isPreview: true - isDeprecated: false + name: dynamicDataPaths + fullName: dynamicDataPaths + langs: + - typeScript + type: property syntax: content: |- dynamicDataPaths?: { [path: string]: string; }; return: - type: |- - { - [path: string]: string; - } - - name: dynamicDataValues - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataValues + type: + - |- + { + [path: string]: string; + } + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataValues:member' summary: >- Static values for the dynamic data. This is used to reconstruct the dynamic data objects when deserializing the web part. @@ -83,23 +85,24 @@ properties: 'aBooleanProperty': true } ``` - isPreview: true - isDeprecated: false + name: dynamicDataValues + fullName: dynamicDataValues + langs: + - typeScript + type: property syntax: content: |- dynamicDataValues?: { [path: string]: any; }; return: - type: |- - { - [path: string]: any; - } - - name: properties - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' - package: '@microsoft/sp-webpart-base!' - fullName: properties + type: + - |- + { + [path: string]: any; + } + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#properties:member' summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- Used by the web part to manage its internal metadata and config data. The framework code never touches these @@ -110,23 +113,30 @@ properties: Example: `{ 'value': 'text value' }` - - isPreview: false - isDeprecated: false + name: properties + fullName: properties + langs: + - typeScript + type: property syntax: content: 'properties?: any;' return: - type: any - - name: serverProcessedContent - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' - package: '@microsoft/sp-webpart-base!' - fullName: serverProcessedContent + type: + - any + - uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#serverProcessedContent:member' summary: The collections of data that can be processed by server side services like search index and link fixup. - remarks: '' - - isPreview: false - isDeprecated: false + name: serverProcessedContent + fullName: serverProcessedContent + langs: + - typeScript + type: property syntax: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: - type: '' + type: + - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' +references: + - uid: '@microsoft/sp-core-library!Version:class' + name: Version + - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + name: ISerializedServerProcessedData diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index ca01b289..3625e532 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -1,135 +1,158 @@ -### YamlMime:TSType -name: IWebPartContext -uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartContext -summary: The base context interface for client-side web parts. -remarks: >- - A "context" object is a collection of well-known services and other objects that are likely to be needed by any - business logic working with a component. Each component type has its own specialized extension of this interface, e.g. - IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. - -isPreview: false -isDeprecated: true -customDeprecatedMessage: >- - - This interface will be removed in an upcoming release. Use the - [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. -type: interface -properties: - - name: domElement - uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IWebPartContext:interface' + summary: The base context interface for client-side web parts. + remarks: >- + A "context" object is a collection of well-known services and other objects that are likely to be needed by any + business logic working with a component. Each component type has its own specialized extension of this interface, + e.g. IWebPartContext for web parts, IExtensionContext for client-side extensions, etc. + deprecated: + content: >- + - This interface will be removed in an upcoming release. Use the + [WebPartContext](xref:@microsoft/sp-webpart-base!WebPartContext:class) class instead. + name: IWebPartContext + fullName: IWebPartContext + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: domElement + children: + - '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' + - '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' + - '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' + - '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' + - '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' + - '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' + - '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' + - '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' + - '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#domElement:member' summary: Reference to the DOM element that hosts this client-side component. - remarks: '' - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'readonly domElement: HTMLElement;' return: - type: HTMLElement - - name: httpClient - uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' - package: '@microsoft/sp-webpart-base!' - fullName: httpClient + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' summary: HttpClient instance scoped to this web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: httpClient + fullName: httpClient + langs: + - typeScript + type: property syntax: content: 'readonly httpClient: HttpClient;' return: - type: '' - - name: instanceId - uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' - package: '@microsoft/sp-webpart-base!' - fullName: instanceId + type: + - '@microsoft/sp-http!HttpClient:class' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' summary: Web part instance id. This is a globally unique value. - remarks: '' - - isPreview: false - isDeprecated: false + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property syntax: content: 'readonly instanceId: string;' return: - type: string - - name: manifest - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' - package: '@microsoft/sp-webpart-base!' - fullName: manifest + type: + - string + - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' summary: Manifest for the client-side web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: manifest + fullName: manifest + langs: + - typeScript + type: property syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: '<any>' - - name: pageContext - uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' - package: '@microsoft/sp-webpart-base!' - fullName: pageContext + type: + - '@microsoft/sp-webpart-base!IWebPartContext#manifest~0:complex' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' summary: SharePoint page context. - remarks: '' - - isPreview: false - isDeprecated: false + name: pageContext + fullName: pageContext + langs: + - typeScript + type: property syntax: content: 'readonly pageContext: PageContext;' return: - type: '' - - name: propertyPane - uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' - package: '@microsoft/sp-webpart-base!' - fullName: propertyPane + type: + - '@microsoft/sp-page-context!PageContext:class' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' summary: Accessor for common web part property pane operations. - remarks: '' - - isPreview: false - isDeprecated: false + name: propertyPane + fullName: propertyPane + langs: + - typeScript + type: property syntax: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: - type: '' - - name: spHttpClient - uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' - package: '@microsoft/sp-webpart-base!' - fullName: spHttpClient + type: + - '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' summary: SPHttpClient instance scoped to this web part. - remarks: '' - - isPreview: false - isDeprecated: false + name: spHttpClient + fullName: spHttpClient + langs: + - typeScript + type: property syntax: content: 'readonly spHttpClient: SPHttpClient;' return: - type: '' - - name: statusRenderer - uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' - package: '@microsoft/sp-webpart-base!' - fullName: statusRenderer + type: + - '@microsoft/sp-http!SPHttpClient:class' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' summary: Web part status renderer. - remarks: '' - - isPreview: false - isDeprecated: false + name: statusRenderer + fullName: statusRenderer + langs: + - typeScript + type: property syntax: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: - type: '' - - name: webPartTag - uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' - package: '@microsoft/sp-webpart-base!' - fullName: webPartTag + type: + - '@microsoft/sp-webpart-base!default:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' summary: Web part tag to be used for logging and telemetry. - remarks: '' - - isPreview: false - isDeprecated: false + name: webPartTag + fullName: webPartTag + langs: + - typeScript + type: property syntax: content: 'readonly webPartTag: string;' return: - type: string + type: + - string +references: + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-http!HttpClient:class' + name: HttpClient + - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest~0:complex' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + spec.typeScript: + - uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface' + name: IClientSideWebPartManifestInstance + fullName: IClientSideWebPartManifestInstance + - name: + fullName: + - uid: '@microsoft/sp-page-context!PageContext:class' + name: PageContext + - uid: '@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface' + name: IPropertyPaneAccessor + - uid: '@microsoft/sp-http!SPHttpClient:class' + name: SPHttpClient + - uid: '@microsoft/sp-webpart-base!default:interface' + name: IClientSideWebPartStatusRenderer diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 20f9f523..67dce34d 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -1,22 +1,28 @@ -### YamlMime:TSType -name: IWebPartData -uid: '@microsoft/sp-webpart-base!IWebPartData:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartData -summary: This structure represents the serialized state of a web part. -remarks: >- - When the `serialize()` API is called on a web part, the output should be this structure. The structure of the - 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of - properties it wants to serialize. - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dataVersion - uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IWebPartData:interface' + summary: This structure represents the serialized state of a web part. + remarks: >- + When the `serialize()` API is called on a web part, the output should be this structure. The structure of the + 'properties' field is owned by the web part and is specific to the web part. Each web part can decide the set of + properties it wants to serialize. + name: IWebPartData + fullName: IWebPartData + langs: + - typeScript + type: interface package: '@microsoft/sp-webpart-base!' - fullName: dataVersion + children: + - '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' + - '@microsoft/sp-webpart-base!IWebPartData#description:member' + - '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' + - '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' + - '@microsoft/sp-webpart-base!IWebPartData#id:member' + - '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' + - '@microsoft/sp-webpart-base!IWebPartData#properties:member' + - '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' + - '@microsoft/sp-webpart-base!IWebPartData#title:member' + - uid: '@microsoft/sp-webpart-base!IWebPartData#dataVersion:member' summary: Web part data version remarks: >- Note that data version is different from the version field in the manifest. The manifest version is used to @@ -28,17 +34,17 @@ properties: Example: `"1.0"` - - isPreview: false - isDeprecated: false + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property syntax: content: 'dataVersion: string;' return: - type: string - - name: description - uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' - package: '@microsoft/sp-webpart-base!' - fullName: description + type: + - string + - uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' summary: Web part description remarks: |- Used to display the description of the web part. @@ -46,17 +52,17 @@ properties: Supported values: string with the description. Example: `"Text"` - - isPreview: false - isDeprecated: false + name: description + fullName: description + langs: + - typeScript + type: property syntax: content: 'description?: string;' return: - type: string - - name: dynamicDataPaths - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataPaths + type: + - string + - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' summary: Paths for the dynamic data. remarks: >- This is used to reconstruct the dynamic data objects when deserializing the web part. The key is the path within @@ -76,23 +82,24 @@ properties: } ``` - isPreview: true - isDeprecated: false + name: dynamicDataPaths + fullName: dynamicDataPaths + langs: + - typeScript + type: property syntax: content: |- dynamicDataPaths?: { [path: string]: string; }; return: - type: |- - { - [path: string]: string; - } - - name: dynamicDataValues - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' - package: '@microsoft/sp-webpart-base!' - fullName: dynamicDataValues + type: + - |- + { + [path: string]: string; + } + - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataValues:member' summary: >- Static values for the dynamic data.This is used to reconstruct the dynamic data objects when deserializing the web part. @@ -107,36 +114,37 @@ properties: 'aBooleanProperty': true } ``` - isPreview: true - isDeprecated: false + name: dynamicDataValues + fullName: dynamicDataValues + langs: + - typeScript + type: property syntax: content: |- dynamicDataValues?: { [path: string]: any; }; return: - type: |- - { - [path: string]: any; - } - - name: id - uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' - package: '@microsoft/sp-webpart-base!' - fullName: id + type: + - |- + { + [path: string]: any; + } + - uid: '@microsoft/sp-webpart-base!IWebPartData#id:member' summary: Universally unique web part Type id. remarks: 'Example: `"dbef608d-3ad5-4f8f-b139-d916f2f0a294"`' - - isPreview: false - isDeprecated: false + name: id + fullName: id + langs: + - typeScript + type: property syntax: content: 'id: string;' return: - type: string - - name: instanceId - uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' - package: '@microsoft/sp-webpart-base!' - fullName: instanceId + type: + - string + - uid: '@microsoft/sp-webpart-base!IWebPartData#instanceId:member' summary: >- Universally unique instance id of the web part. A web part can have multiple instances on a page. This id is expected to be universally unique across time and page boundaries. @@ -144,17 +152,17 @@ properties: supported values: a unique string. Could be GUID or other uniquely identifiable formats. example: `["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]` - - isPreview: false - isDeprecated: false + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property syntax: content: 'instanceId: string;' return: - type: string - - name: properties - uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' - package: '@microsoft/sp-webpart-base!' - fullName: properties + type: + - string + - uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' summary: Web part specific properties. The individual web part owns the definition of these properties. remarks: >- Used by the web part to manage its internal metadata and config data. The framework code never touches these @@ -165,30 +173,29 @@ properties: Example: `{ 'value': 'text value' }` - - isPreview: false - isDeprecated: false + name: properties + fullName: properties + langs: + - typeScript + type: property syntax: content: 'properties?: any;' return: - type: any - - name: serverProcessedContent - uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' - package: '@microsoft/sp-webpart-base!' - fullName: serverProcessedContent + type: + - any + - uid: '@microsoft/sp-webpart-base!IWebPartData#serverProcessedContent:member' summary: The collections of data that can be processed by server side services like search index and link fixup - remarks: '' - - isPreview: false - isDeprecated: false + name: serverProcessedContent + fullName: serverProcessedContent + langs: + - typeScript + type: property syntax: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: - type: '' - - name: title - uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' - package: '@microsoft/sp-webpart-base!' - fullName: title + type: + - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' summary: Web part title remarks: |- Used to display the name of the web part in the toolbox, web part gallery and the page. @@ -196,10 +203,16 @@ properties: Supported values: string less than 100 characters Example: `"Text"` - - isPreview: false - isDeprecated: false + name: title + fullName: title + langs: + - typeScript + type: property syntax: content: 'title: string;' return: - type: string + type: + - string +references: + - uid: '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + name: ISerializedServerProcessedData diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml index 258717de..71e029f2 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -1,62 +1,63 @@ -### YamlMime:TSType -name: IWebPartPropertiesMetadata -uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartPropertiesMetadata -summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` -remarks: >- - The key should be a JSON path to the property in web part properties. The JSON path supports the following operators: +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' + summary: This structure is used to define metadata for web part properties as a map of string to `IWebPartPropertyMetadata` + remarks: >- + The key should be a JSON path to the property in web part properties. The JSON path supports the following + operators: - - Dot `.` for selecting object members, for example `person.name` + - Dot `.` for selecting object members, for example `person.name` - - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` + - Brackets `[]` for selecting array items, for example `person.photoURLs[0]` - - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. + - Bracketed asterisk `[*]` for array elements wildcard, for example `person.websites[*]`. - You can make combinations of these operators, for example `person.websites[*].url` + You can make combinations of these operators, for example `person.websites[*].url` - Important Note: Only one wildcard per path is supported. + Important Note: Only one wildcard per path is supported. - Example: Let's assume we have a web part with properties that have the following schema: + Example: Let's assume we have a web part with properties that have the following schema: - ``` + ``` - { - title: string; - person: { - name: string; - bio: string; - photoURLs: string[]; - websites: { title: string; url: string; }[] - } - } + { + title: string; + person: { + name: string; + bio: string; + photoURLs: string[]; + websites: { title: string; url: string; }[] + } + } - ``` + ``` - We can define the metadata for the desired properties as following: + We can define the metadata for the desired properties as following: - ``` + ``` - { - 'person.bio': { isRichContent: true }, - 'person.photoURLs[*]': { isImageSource: true }, - 'person.websites[*].url': { isLink: true } - } + { + 'person.bio': { isRichContent: true }, + 'person.photoURLs[*]': { isImageSource: true }, + 'person.websites[*].url': { isLink: true } + } - ``` + ``` - This will make SharePoint servers aware of the content of your properties and run services such as search indexing, - link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link fix-up, the web - part property bag is automatically updated. - -isPreview: false -isDeprecated: false -type: interface + This will make SharePoint servers aware of the content of your properties and run services such as search + indexing, link fix-up, etc on the data. In case any of the values needs to update by these services, e.g link + fix-up, the web part property bag is automatically updated. + name: IWebPartPropertiesMetadata + fullName: IWebPartPropertiesMetadata + langs: + - typeScript + type: interface + package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 3d58f18f..11577621 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -1,19 +1,20 @@ -### YamlMime:TSType -name: IWebPartPropertyMetadata -uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' -package: '@microsoft/sp-webpart-base!' -fullName: IWebPartPropertyMetadata -summary: This is the structure used for map values in `IWebPartPropertiesMetadata` -remarks: '' - -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dynamicPropertyType - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' + summary: This is the structure used for map values in `IWebPartPropertiesMetadata` + name: IWebPartPropertyMetadata + fullName: IWebPartPropertyMetadata + langs: + - typeScript + type: interface + extends: + - '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + inheritance: + - type: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' package: '@microsoft/sp-webpart-base!' - fullName: dynamicPropertyType + children: + - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' + - uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' remarks: >- If a web part has properties that are dynamically configurable, then use this flag to declare the property as a @@ -29,11 +30,16 @@ properties: Note: Web parts should be able to type cast the resultant value from the `tryGetValue` to suit their needs. - - isPreview: false - isDeprecated: false + name: dynamicPropertyType + fullName: dynamicPropertyType + langs: + - typeScript + type: property syntax: content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' return: - type: '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' -extends: '' + type: + - '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' +references: + - uid: '@microsoft/sp-component-base!IComponentPropertyMetadata:interface' + name: IComponentPropertyMetadata diff --git a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml index 34b40ca1..aeda8e30 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -1,44 +1,88 @@ -### YamlMime:TSEnum -name: PropertyPaneButtonType -uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' -package: '@microsoft/sp-webpart-base!' -fullName: PropertyPaneButtonType -summary: Enum for all the supported button types. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: Command - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType:enum' + summary: Enum for all the supported button types. + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. + name: PropertyPaneButtonType + fullName: PropertyPaneButtonType + langs: + - typeScript + type: enum package: '@microsoft/sp-webpart-base!' + children: + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' + - '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Command:member' summary: Optional actions. - value: '4' - - name: Compound - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' - package: '@microsoft/sp-webpart-base!' + remarks: >- + Typically used in a command bar at the top of a view, panel and inside an inline command bar. Examples: Command + bar at the top of OneDrive, Outlook, SharePoint. Inline command bar on the top of SharePoint web parts. + name: Command + fullName: Command + langs: + - typeScript + type: field + numericValue: '4' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Compound:member' summary: Always used as a set with both Standard and Primary compound buttons. - value: '3' - - name: Hero - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' - package: '@microsoft/sp-webpart-base!' + remarks: >- + Typically used in a confirmation dialog. Examples: A confirmation dialog when a user discards a form or task with + a possible significant time investment such as an email or a complex form + name: Compound + fullName: Compound + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' summary: Hero button. - value: '2' - - name: Icon - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' - package: '@microsoft/sp-webpart-base!' + name: Hero + fullName: Hero + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Icon:member' summary: >- Same usage as Command button, when real estate does not allow for icons + labels or as secondary actions within the command bar. - value: '5' - - name: Normal - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' - package: '@microsoft/sp-webpart-base!' + remarks: >- + Typically used in Command bar in small and medium responsive web breakpoints. Also used on objects. Examples: + OneDrive small and medium responsive web breakpoint Command Bars and view icons within the Command Bar. In + SharePoint and OneDrive, Cards with social actions and images which allow users to access the image picker. In + SharePoint, formatting experiences such as formatting a story within the Authoring experience. In Calendar, in the + bottom of an event creation Callout when clicking inside an empty time range. + name: Icon + fullName: Icon + langs: + - typeScript + type: field + numericValue: '5' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Normal:member' summary: Optional completion action. - value: '0' - - name: Primary - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' - package: '@microsoft/sp-webpart-base!' + remarks: >- + Typically used at the end of a form or task when paired with the Primary button OR as a standalone button to undo + an action. Examples: "Done" button which closes a container but doesn't make a server call or an "Undo" button + when a user is uploading a file in OneDrive. + name: Normal + fullName: Normal + langs: + - typeScript + type: field + numericValue: '0' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Primary:member' summary: Preferred completion action when paired with a Standard button. - value: '1' + remarks: 'Typically used at the end of a task or form. Examples: "Create", "Save", "Send" which makes a server call.' + name: Primary + fullName: Primary + langs: + - typeScript + type: field + numericValue: '1' diff --git a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml index c8e3ba6b..5c32748a 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -1,29 +1,44 @@ -### YamlMime:TSEnum -name: PropertyPaneDropdownOptionType -uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' -package: '@microsoft/sp-webpart-base!' -fullName: PropertyPaneDropdownOptionType -summary: >- - Specifies the type of option in a dropdown menu rendered by - [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: Divider - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType:enum' + summary: >- + Specifies the type of option in a dropdown menu rendered by + [PropertyPaneDropdown()](xref:@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)). + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. + name: PropertyPaneDropdownOptionType + fullName: PropertyPaneDropdownOptionType + langs: + - typeScript + type: enum package: '@microsoft/sp-webpart-base!' + children: + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' + - '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Divider:member' summary: Render a divider. - value: '1' - - name: Header - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' - package: '@microsoft/sp-webpart-base!' + name: Divider + fullName: Divider + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Header:member' summary: Render menu item as a header. - value: '2' - - name: Normal - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' - package: '@microsoft/sp-webpart-base!' + name: Header + fullName: Header + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-webpart-base!PropertyPaneDropdownOptionType.Normal:member' summary: Render normal menu item. - value: '0' + name: Normal + fullName: Normal + langs: + - typeScript + type: field + numericValue: '0' diff --git a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml index cfb7e8bd..9fc87148 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -1,100 +1,176 @@ -### YamlMime:TSEnum -name: PropertyPaneFieldType -uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' -package: '@microsoft/sp-webpart-base!' -fullName: PropertyPaneFieldType -summary: |- - Enum for all the supported PropertyPane field types. +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType:enum' + summary: |- + Enum for all the supported PropertyPane field types. - Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. -remarks: '' - -isPreview: false -isDeprecated: true -customDeprecatedMessage: This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from there. -fields: - - name: Button - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' - package: '@microsoft/sp-webpart-base!' + Names should be consistent with those in office-ui-fabric-react, be careful to get letter casing correct. + deprecated: + content: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. + name: PropertyPaneFieldType + fullName: PropertyPaneFieldType + langs: + - typeScript + type: enum + package: '@microsoft/sp-webpart-base!' + children: + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.IconPicker:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.ThumbnailPicker:member' + - '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Button:member' summary: Button field. - value: '11' - - name: CheckBox - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' - package: '@microsoft/sp-webpart-base!' + name: Button + fullName: Button + langs: + - typeScript + type: field + numericValue: '11' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.CheckBox:member' summary: Checkbox field. - value: '2' - - name: ChoiceGroup - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' - package: '@microsoft/sp-webpart-base!' + name: CheckBox + fullName: CheckBox + langs: + - typeScript + type: field + numericValue: '2' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ChoiceGroup:member' summary: Choice Group field. - value: '10' - - name: Custom - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' - package: '@microsoft/sp-webpart-base!' + name: ChoiceGroup + fullName: ChoiceGroup + langs: + - typeScript + type: field + numericValue: '10' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Custom:member' summary: Custom field. - value: '1' - - name: Dropdown - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' - package: '@microsoft/sp-webpart-base!' + name: Custom + fullName: Custom + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Dropdown:member' summary: Dropdown field. - value: '6' - - name: DynamicField - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' - package: '@microsoft/sp-webpart-base!' + name: Dropdown + fullName: Dropdown + langs: + - typeScript + type: field + numericValue: '6' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicField:member' summary: Dynamic data field. - value: '14' - - name: DynamicFieldSet - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' - package: '@microsoft/sp-webpart-base!' + name: DynamicField + fullName: DynamicField + langs: + - typeScript + type: field + numericValue: '14' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicFieldSet:member' summary: A set of dynamic fields. - value: '16' - - name: DynamicTextField - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' - package: '@microsoft/sp-webpart-base!' + name: DynamicFieldSet + fullName: DynamicFieldSet + langs: + - typeScript + type: field + numericValue: '16' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.DynamicTextField:member' summary: Dynamic Text Field - value: '15' - - name: Heading - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' - package: '@microsoft/sp-webpart-base!' + deprecated: + content: '- Please use DynamicField' + isPreview: true + name: DynamicTextField + fullName: DynamicTextField + langs: + - typeScript + type: field + numericValue: '15' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Heading:member' summary: Heading field. - value: '9' - - name: HorizontalRule - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' - package: '@microsoft/sp-webpart-base!' + name: Heading + fullName: Heading + langs: + - typeScript + type: field + numericValue: '9' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.HorizontalRule:member' summary: Horizontal Rule field. - value: '12' - - name: IconPicker - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.IconPicker:member' - package: '@microsoft/sp-webpart-base!' + name: HorizontalRule + fullName: HorizontalRule + langs: + - typeScript + type: field + numericValue: '12' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.IconPicker:member' summary: Icon picker field. - value: '19' - - name: Label - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' - package: '@microsoft/sp-webpart-base!' + isPreview: true + name: IconPicker + fullName: IconPicker + langs: + - typeScript + type: field + numericValue: '19' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' summary: Label field. - value: '7' - - name: Link - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' - package: '@microsoft/sp-webpart-base!' + name: Label + fullName: Label + langs: + - typeScript + type: field + numericValue: '7' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Link:member' summary: Link field. - value: '13' - - name: Slider - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' - package: '@microsoft/sp-webpart-base!' + name: Link + fullName: Link + langs: + - typeScript + type: field + numericValue: '13' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Slider:member' summary: Slider field. - value: '8' - - name: TextField - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' - package: '@microsoft/sp-webpart-base!' + name: Slider + fullName: Slider + langs: + - typeScript + type: field + numericValue: '8' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.TextField:member' summary: TextField field. - value: '3' - - name: ThumbnailPicker - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ThumbnailPicker:member' - package: '@microsoft/sp-webpart-base!' + name: TextField + fullName: TextField + langs: + - typeScript + type: field + numericValue: '3' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ThumbnailPicker:member' summary: Thumbnail picker field. - value: '18' - - name: Toggle - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' - package: '@microsoft/sp-webpart-base!' + isPreview: true + name: ThumbnailPicker + fullName: ThumbnailPicker + langs: + - typeScript + type: field + numericValue: '18' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' summary: Toggle field. - value: '5' + name: Toggle + fullName: Toggle + langs: + - typeScript + type: field + numericValue: '5' diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index 97e4d38a..0cbd38a3 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -1,89 +1,114 @@ -### YamlMime:TSType -name: WebPartContext -uid: '@microsoft/sp-webpart-base!WebPartContext:class' -package: '@microsoft/sp-webpart-base!' -fullName: WebPartContext -summary: >- - Web part context object. This object contains the contextual services available to a web part. e.g. a contextual - instance to the http client. -remarks: >- - The constructor for this class is marked as internal. Third-party code should not call the constructor directly or - create subclasses that extend the `WebPartContext` class. - -isPreview: false -isDeprecated: false -type: class -properties: - - name: domElement - uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!WebPartContext:class' + summary: >- + Web part context object. This object contains the contextual services available to a web part. e.g. a contextual + instance to the http client. + remarks: >- + The constructor for this class is marked as internal. Third-party code should not call the constructor directly or + create subclasses that extend the `WebPartContext` class. + name: WebPartContext + fullName: WebPartContext + langs: + - typeScript + type: class + extends: + - '@microsoft/sp-webpart-base!default:class' + inheritance: + - type: '@microsoft/sp-webpart-base!default:class' package: '@microsoft/sp-webpart-base!' - fullName: domElement + children: + - '@microsoft/sp-webpart-base!WebPartContext#domElement:member' + - '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' + - '@microsoft/sp-webpart-base!WebPartContext#sdks:member' + - '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' + - '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' + - uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member' summary: Reference to the DOM element that hosts this client-side component. - remarks: '' - - isPreview: false - isDeprecated: false + name: domElement + fullName: domElement + langs: + - typeScript + type: property syntax: content: 'get domElement(): HTMLElement;' return: - type: HTMLElement - - name: microsoftTeams - uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' - package: '@microsoft/sp-webpart-base!' - fullName: microsoftTeams + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member' summary: >- Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams. remarks: >- For more information, please see: [https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest) - - isPreview: false - isDeprecated: true - customDeprecatedMessage: '- This function has been deprecated' + deprecated: + content: '- This function has been deprecated' + name: microsoftTeams + fullName: microsoftTeams + langs: + - typeScript + type: property syntax: content: 'get microsoftTeams(): typeof microsoftTeams | undefined;' return: - type: typeof microsoftTeams | undefined - - name: sdks - uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' - package: '@microsoft/sp-webpart-base!' - fullName: sdks + type: + - '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams~0:complex' + - uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member' summary: Conditional set of SDKs provided by SPFx dependent on the environment. - remarks: '' - - isPreview: false - isDeprecated: false + name: sdks + fullName: sdks + langs: + - typeScript + type: property syntax: content: 'get sdks(): ISDKs;' return: - type: '' - - name: statusRenderer - uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' - package: '@microsoft/sp-webpart-base!' - fullName: statusRenderer + type: + - '@microsoft/sp-webpart-base!ISDKs:interface' + - uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' summary: Web part status renderer. - remarks: '' - - isPreview: false - isDeprecated: false + name: statusRenderer + fullName: statusRenderer + langs: + - typeScript + type: property syntax: content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;' return: - type: '' - - name: widthCacheKey - uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' - package: '@microsoft/sp-webpart-base!' - fullName: widthCacheKey + type: + - '@microsoft/sp-webpart-base!default:interface' + - uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' summary: >- This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key. - remarks: '' - - isPreview: false - isDeprecated: false + name: widthCacheKey + fullName: widthCacheKey + langs: + - typeScript + type: property syntax: content: 'get widthCacheKey(): string | undefined;' return: - type: string | undefined -extends: '' + type: + - string | undefined +references: + - uid: '@microsoft/sp-webpart-base!default:class' + name: BaseWebPartContext + - uid: '!HTMLElement:interface' + name: HTMLElement + - uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams~0:complex' + name: typeof microsoftTeams | undefined + fullName: typeof microsoftTeams | undefined + spec.typeScript: + - name: 'typeof ' + fullName: 'typeof ' + - uid: '!microsoftTeams:namespace' + name: microsoftTeams + fullName: microsoftTeams + - name: ' | undefined' + fullName: ' | undefined' + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' + name: ISDKs + - uid: '@microsoft/sp-webpart-base!default:interface' + name: IClientSideWebPartStatusRenderer diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index 7a048b2f..9002fa19 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -1,26 +1,39 @@ -### YamlMime:TSEnum -name: WebPartFormFactor -uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' -package: '@microsoft/sp-webpart-base!' -fullName: WebPartFormFactor -summary: Form factor of the web part. -remarks: >- - This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams - tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it - will have a canvas web part form factor. - -isPreview: true -isDeprecated: false -fields: - - name: FullSize - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor:enum' + summary: Form factor of the web part. + remarks: >- + This will change based on how the web part is used, not by the web part itself. In cases like web parts used in + Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web + parts, it will have a canvas web part form factor. + isPreview: true + name: WebPartFormFactor + fullName: WebPartFormFactor + langs: + - typeScript + type: enum package: '@microsoft/sp-webpart-base!' + children: + - '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' + - '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' summary: 'Full size form factor. This means the web part is rendered in full size, taking all space available in the page.' - value: '1' - - name: Standard - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' - package: '@microsoft/sp-webpart-base!' + remarks: This is the case for Teams tabs or single web part App pages. + isPreview: true + name: FullSize + fullName: FullSize + langs: + - typeScript + type: field + numericValue: '1' + - uid: '@microsoft/sp-webpart-base!WebPartFormFactor.Standard:member' summary: >- Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts. In this case, the width is determined by the container, and web part self-adjust for height. - value: '0' + isPreview: true + name: Standard + fullName: Standard + langs: + - typeScript + type: field + numericValue: '0'